{ "components": { "schemas": { "ATS_addNoteToACandidate-v2026-01-01_Response_201": { "properties": { "data": { "$ref": "#/components/schemas/AtsCandidatesCandidateIdNotesPostResponsesContentApplicationJsonSchemaData", "description": "The created candidate note" } }, "required": [ "data" ], "title": "ATS_addNoteToACandidate-v2026-01-01_Response_201", "type": "object" }, "ATS_bulkTagUpsertions-v2026-06-12_Response_200": { "properties": { "data": { "$ref": "#/components/schemas/AtsUpsertionsBulkTagsPostResponsesContentApplicationJsonSchemaData", "description": "Resolved tags grouped by tag group." } }, "required": [ "data" ], "title": "ATS_bulkTagUpsertions-v2026-06-12_Response_200", "type": "object" }, "ATS_createAtsAttachmentFile-v2026-01-01_Response_201": { "properties": { "data": { "$ref": "#/components/schemas/AtsAttachmentsAttachableTypeSlugAttachableIdAttachmentTypeSlugPostResponsesContentApplicationJsonSchemaData" } }, "required": [ "data" ], "title": "ATS_createAtsAttachmentFile-v2026-01-01_Response_201", "type": "object" }, "ATS_createAtsCandidateAttachment-v2026-09-16_Response_201": { "properties": { "data": { "$ref": "#/components/schemas/AtsCandidatesCandidateIdAttachmentsPostResponsesContentApplicationJsonSchemaData" } }, "required": [ "data" ], "title": "ATS_createAtsCandidateAttachment-v2026-09-16_Response_201", "type": "object" }, "ATS_getInterviewTranscript-v2026-10-16_Response_200": { "properties": { "data": { "description": "Page of transcript segments, ordered by the time they were spoken.", "items": { "$ref": "#/components/schemas/AtsInterviewsInterviewIdTranscriptGetResponsesContentApplicationJsonSchemaDataItems" }, "type": "array" }, "has_more": { "description": "Whether more pages are available beyond the current page.", "type": "boolean" }, "next_cursor": { "description": "Cursor to fetch the next page; null when there are no more pages.", "type": [ "string", "null" ] }, "total_count": { "description": "Total number of transcript segments for this interview.", "type": "integer" } }, "required": [ "data", "has_more", "next_cursor", "total_count" ], "title": "ATS_getInterviewTranscript-v2026-10-16_Response_200", "type": "object" }, "ATS_listApplicationFeedbacks-v2026-07-02_Response_200": { "properties": { "data": { "description": "Page of application feedbacks.", "items": { "$ref": "#/components/schemas/AtsApplicationsApplicationIdFeedbacksGetResponsesContentApplicationJsonSchemaDataItems" }, "type": "array" }, "has_more": { "description": "Whether more pages are available beyond the current page.", "type": "boolean" }, "next_cursor": { "description": "Cursor to fetch the next page; null when there are no more pages.", "type": [ "string", "null" ] }, "total_count": { "description": "Total number of feedbacks for this application.", "type": "integer" } }, "required": [ "data", "has_more", "next_cursor", "total_count" ], "title": "ATS_listApplicationFeedbacks-v2026-07-02_Response_200", "type": "object" }, "ATS_listFeedbacks-v2026-09-18_Response_200": { "properties": { "data": { "description": "Page of feedback records.", "items": { "$ref": "#/components/schemas/AtsFeedbacksGetResponsesContentApplicationJsonSchemaDataItems" }, "type": "array" }, "has_more": { "description": "Whether more pages are available beyond the current page.", "type": "boolean" }, "next_cursor": { "description": "Cursor to fetch the next page; null when there are no more pages.", "type": [ "string", "null" ] }, "total_count": { "description": "Total number of feedback records matching the filters.", "type": "integer" } }, "required": [ "data", "has_more", "next_cursor", "total_count" ], "title": "ATS_listFeedbacks-v2026-09-18_Response_200", "type": "object" }, "ATS_listInterviews-v2026-06-03_Response_200": { "properties": { "data": { "description": "Page of interviews.", "items": { "$ref": "#/components/schemas/AtsInterviewsGetResponsesContentApplicationJsonSchemaDataItems" }, "type": "array" }, "has_more": { "description": "Whether more pages are available beyond the current page.", "type": "boolean" }, "next_cursor": { "description": "Cursor to fetch the next page; null when there are no more pages.", "type": [ "string", "null" ] }, "total_count": { "description": "Total number of interviews matching the filters.", "type": "integer" } }, "required": [ "data", "has_more", "next_cursor", "total_count" ], "title": "ATS_listInterviews-v2026-06-03_Response_200", "type": "object" }, "ATS_listJobInterviewPlanStages-v2026-09-18_Response_200": { "properties": { "data": { "description": "Stages of the job's interview plan, in pipeline order.", "items": { "$ref": "#/components/schemas/AtsJobsJobIdInterviewPlanStagesGetResponsesContentApplicationJsonSchemaDataItems" }, "type": "array" }, "has_more": { "description": "Always false; the list is not paginated.", "type": "boolean" }, "next_cursor": { "description": "Always null; the list is not paginated.", "type": [ "string", "null" ] }, "total_count": { "description": "Number of stages.", "type": "integer" } }, "required": [ "data", "has_more", "next_cursor", "total_count" ], "title": "ATS_listJobInterviewPlanStages-v2026-09-18_Response_200", "type": "object" }, "ATS_listOpenings-v2026-06-15_Response_200": { "properties": { "data": { "description": "Page of openings.", "items": { "$ref": "#/components/schemas/AtsOpeningsGetResponsesContentApplicationJsonSchemaDataItems" }, "type": "array" }, "has_more": { "description": "Whether more pages are available beyond the current page.", "type": "boolean" }, "next_cursor": { "description": "Cursor to fetch the next page; null when there are no more pages.", "type": [ "string", "null" ] }, "total_count": { "description": "Total number of openings matching the filters.", "type": "integer" } }, "required": [ "data", "has_more", "next_cursor", "total_count" ], "title": "ATS_listOpenings-v2026-06-15_Response_200", "type": "object" }, "ATS_retrieveAListOfAtsHires-v2026-10-01_Response_200": { "properties": { "data": { "description": "Page of application-to-HRIS-profile records, ordered by updated_at ascending.", "items": { "$ref": "#/components/schemas/AtsHiresGetResponsesContentApplicationJsonSchemaDataItems" }, "type": "array" }, "has_more": { "description": "Whether more pages are available beyond the current one.", "type": "boolean" }, "next_cursor": { "description": "Cursor to fetch the next page; null when there are no more pages.", "type": [ "string", "null" ] }, "total_count": { "description": "Total number of hires matching the filters.", "type": "integer" } }, "required": [ "data", "has_more", "next_cursor", "total_count" ], "title": "ATS_retrieveAListOfAtsHires-v2026-10-01_Response_200", "type": "object" }, "ATS_retrieveAListOfAtsJobBoards-v2026-02-09_Response_200": { "description": "Paginated list of job boards with cursor-based pagination", "properties": { "data": { "description": "Page of job boards", "items": { "$ref": "#/components/schemas/AtsJobBoardsGetResponsesContentApplicationJsonSchemaDataItems" }, "type": "array" }, "has_more": { "description": "Indicates if there are more job boards to fetch", "type": "boolean" }, "next_cursor": { "description": "Cursor for the next page of results", "type": [ "string", "null" ] }, "total_count": { "description": "Total number of job boards available", "type": "integer" } }, "required": [ "data", "has_more", "next_cursor", "total_count" ], "title": "ATS_retrieveAListOfAtsJobBoards-v2026-02-09_Response_200", "type": "object" }, "ATS_retrieveAListOfAtsTeams-v2026-06-24_Response_200": { "properties": { "data": { "description": "Page of resources.", "items": { "$ref": "#/components/schemas/AtsTeamsGetResponsesContentApplicationJsonSchemaDataItems" }, "type": "array" }, "has_more": { "description": "Indicates if there are more teams available", "type": "boolean" }, "next_cursor": { "description": "Cursor for pagination to get the next set of results", "type": [ "string", "null" ] }, "total_count": { "description": "Total number of teams available", "minimum": 0, "type": "integer" } }, "required": [ "data", "has_more", "next_cursor", "total_count" ], "title": "ATS_retrieveAListOfAtsTeams-v2026-06-24_Response_200", "type": "object" }, "ATS_retrieveAtsApplicationForm-v2026-01-01_Response_200": { "properties": { "data": { "$ref": "#/components/schemas/AtsApplicationFormsApplicationFormIdGetResponsesContentApplicationJsonSchemaData" } }, "required": [ "data" ], "title": "ATS_retrieveAtsApplicationForm-v2026-01-01_Response_200", "type": "object" }, "ATS_retrieveAtsCandidate-v2026-09-18_Response_200": { "properties": { "data": { "$ref": "#/components/schemas/AtsCandidatesCandidateIdGetResponsesContentApplicationJsonSchemaData", "description": "Candidate detail." } }, "required": [ "data" ], "title": "ATS_retrieveAtsCandidate-v2026-09-18_Response_200", "type": "object" }, "ATS_updateAtsApplication-v2026-09-17_Response_200": { "description": "Updated application response", "properties": { "data": { "$ref": "#/components/schemas/AtsApplicationsApplicationIdPatchResponsesContentApplicationJsonSchemaData" } }, "required": [ "data" ], "title": "ATS_updateAtsApplication-v2026-09-17_Response_200", "type": "object" }, "ATS_updateAtsCandidate-v2026-09-16_Response_200": { "properties": { "data": { "$ref": "#/components/schemas/AtsCandidatesCandidateIdPatchResponsesContentApplicationJsonSchemaData" } }, "required": [ "data" ], "title": "ATS_updateAtsCandidate-v2026-09-16_Response_200", "type": "object" }, "AcceptAContractAmendmentOnBehalfOfTheClient-v2026-01-01RequestBadRequestError": { "properties": { "errors": { "items": { "$ref": "#/components/schemas/EorContractsContractIdAmendmentsAmendmentIdAcceptPostResponsesContentApplicationJsonSchemaErrorsItems" }, "type": "array" } }, "required": [ "errors" ], "title": "AcceptAContractAmendmentOnBehalfOfTheClient-v2026-01-01RequestBadRequestError", "type": "object" }, "AcceptAContractAmendmentOnBehalfOfTheClient-v2026-01-01RequestInternalServerError": { "properties": { "errors": { "items": { "$ref": "#/components/schemas/EorContractsContractIdAmendmentsAmendmentIdAcceptPostResponsesContentApplicationJsonSchemaErrorsItems" }, "type": "array" } }, "required": [ "errors" ], "title": "AcceptAContractAmendmentOnBehalfOfTheClient-v2026-01-01RequestInternalServerError", "type": "object" }, "AcceptAContractAmendmentOnBehalfOfTheClient-v2026-01-01RequestNotFoundError": { "properties": { "errors": { "items": { "$ref": "#/components/schemas/EorContractsContractIdAmendmentsAmendmentIdAcceptPostResponsesContentApplicationJsonSchemaErrorsItems" }, "type": "array" } }, "required": [ "errors" ], "title": "AcceptAContractAmendmentOnBehalfOfTheClient-v2026-01-01RequestNotFoundError", "type": "object" }, "AcceptEorProjectAssignmentAsClient-v2026-01-01RequestBadRequestError": { "properties": { "errors": { "items": { "$ref": "#/components/schemas/EorContractsContractIdProjectAssignmentAcceptPostResponsesContentApplicationJsonSchemaErrorsItems" }, "type": "array" } }, "required": [ "errors" ], "title": "AcceptEorProjectAssignmentAsClient-v2026-01-01RequestBadRequestError", "type": "object" }, "AcceptEorProjectAssignmentAsClient-v2026-01-01RequestConflictError": { "properties": { "errors": { "items": { "$ref": "#/components/schemas/EorContractsContractIdProjectAssignmentAcceptPostResponsesContentApplicationJsonSchemaErrorsItems" }, "type": "array" } }, "required": [ "errors" ], "title": "AcceptEorProjectAssignmentAsClient-v2026-01-01RequestConflictError", "type": "object" }, "AcceptEorProjectAssignmentAsClient-v2026-01-01RequestInternalServerError": { "properties": { "errors": { "items": { "$ref": "#/components/schemas/EorContractsContractIdProjectAssignmentAcceptPostResponsesContentApplicationJsonSchemaErrorsItems" }, "type": "array" } }, "required": [ "errors" ], "title": "AcceptEorProjectAssignmentAsClient-v2026-01-01RequestInternalServerError", "type": "object" }, "Accounting_getBillingInvoiceDownloadLink-v2026-01-01_Response_200": { "properties": { "data": { "$ref": "#/components/schemas/InvoicesIdDownloadGetResponsesContentApplicationJsonSchemaData" } }, "required": [ "data" ], "title": "Accounting_getBillingInvoiceDownloadLink-v2026-01-01_Response_200", "type": "object" }, "Accounting_getInvoiceById-v2026-01-01_Response_200": { "properties": { "data": { "$ref": "#/components/schemas/InvoicesInvoiceIdGetResponsesContentApplicationJsonSchemaData", "description": "The invoice resource returned" } }, "title": "Accounting_getInvoiceById-v2026-01-01_Response_200", "type": "object" }, "Accounting_retrieveAPaymentBreakdown-v2026-01-01_Response_200": { "properties": { "data": { "items": { "$ref": "#/components/schemas/PaymentsPaymentIdBreakdownGetResponsesContentApplicationJsonSchemaDataItems" }, "type": "array" } }, "title": "Accounting_retrieveAPaymentBreakdown-v2026-01-01_Response_200", "type": "object" }, "Accounting_retrieveDeelInvoices-v2026-01-01_Response_200": { "properties": { "data": { "items": { "$ref": "#/components/schemas/InvoicesDeelGetResponsesContentApplicationJsonSchemaDataItems" }, "type": "array" }, "page": { "$ref": "#/components/schemas/InvoicesDeelGetResponsesContentApplicationJsonSchemaPage" } }, "required": [ "data", "page" ], "title": "Accounting_retrieveDeelInvoices-v2026-01-01_Response_200", "type": "object" }, "Accounting_retrieveInvoices-v2026-01-01_Response_200": { "properties": { "data": { "items": { "$ref": "#/components/schemas/InvoicesGetResponsesContentApplicationJsonSchemaDataItems" }, "type": "array" }, "page": { "$ref": "#/components/schemas/InvoicesGetResponsesContentApplicationJsonSchemaPage" } }, "required": [ "data", "page" ], "title": "Accounting_retrieveInvoices-v2026-01-01_Response_200", "type": "object" }, "Accounting_retrievePaymentReceipts-v2027-01-01_Response_200": { "properties": { "data": { "$ref": "#/components/schemas/PaymentsGetResponsesContentApplicationJsonSchemaData" } }, "title": "Accounting_retrievePaymentReceipts-v2027-01-01_Response_200", "type": "object" }, "Accounting_retrieveRefundStatements-v2026-04-30_Response_200": { "properties": { "data": { "$ref": "#/components/schemas/RefundStatementsGetResponsesContentApplicationJsonSchemaData" } }, "required": [ "data" ], "title": "Accounting_retrieveRefundStatements-v2026-04-30_Response_200", "type": "object" }, "AccountsPayableVendorBillsPostRequestBodyContentApplicationJsonSchemaData": { "properties": { "amount": { "description": "Total amount including VAT", "format": "double", "type": "number" }, "currency": { "description": "ISO 4217 currency code", "maxLength": 3, "minLength": 3, "pattern": "^[A-Z]{3}$", "type": "string" }, "date": { "description": "Invoice/bill date", "format": "date", "type": "string" }, "description": { "description": "General description of the vendor bill", "minLength": 1, "type": "string" }, "due_date": { "description": "Due date for payment", "format": "date", "type": "string" }, "external_id": { "description": "External system identifier (e.g., Brightflag ID)", "minLength": 1, "type": "string" }, "line_items": { "description": "Line items for the vendor bill", "items": { "$ref": "#/components/schemas/AccountsPayableVendorBillsPostRequestBodyContentApplicationJsonSchemaDataLineItemsItems" }, "type": "array" }, "reference": { "description": "Vendor bill reference", "maxLength": 100, "minLength": 1, "type": "string" }, "subsidiary_id": { "description": "Unique identifier for the Deel legal entity/subsidiary", "type": "string" }, "subtotal": { "description": "Subtotal amount excluding VAT", "format": "double", "type": "number" }, "vendor_id": { "description": "Unique identifier for the Vendor", "type": "string" } }, "required": [ "date", "amount", "currency", "due_date", "subtotal", "reference", "vendor_id", "line_items", "description", "external_id", "subsidiary_id" ], "title": "AccountsPayableVendorBillsPostRequestBodyContentApplicationJsonSchemaData", "type": "object" }, "AccountsPayableVendorBillsPostRequestBodyContentApplicationJsonSchemaDataLineItemsItems": { "properties": { "amount": { "description": "Total amount for this line item", "format": "double", "type": "number" }, "department_id": { "description": "Unique Identifier for the Financial department", "type": "string" }, "description": { "description": "Description of the line item", "minLength": 1, "type": "string" }, "expense_account_id": { "description": "Unique Identifier for the Expense account", "type": "string" }, "quantity": { "description": "Quantity of items", "format": "double", "type": "number" }, "unit_price": { "description": "Price per unit", "format": "double", "type": "number" }, "vat_amount": { "description": "VAT amount for this line item", "format": "double", "type": "number" }, "vat_code": { "description": "VAT Code name", "type": "string" }, "vat_rate": { "description": "VAT rate percentage", "format": "double", "minimum": 0, "type": "number" } }, "required": [ "amount", "quantity", "vat_rate", "unit_price", "description" ], "title": "AccountsPayableVendorBillsPostRequestBodyContentApplicationJsonSchemaDataLineItemsItems", "type": "object" }, "AccountsPayableVendorBillsPostResponsesContentApplicationJsonSchemaData": { "properties": { "amount": { "description": "Total amount including VAT", "format": "double", "type": "number" }, "created_at": { "description": "Creation timestamp", "format": "date-time", "type": "string" }, "currency": { "description": "ISO 4217 currency code", "type": "string" }, "date": { "description": "Invoice/bill date", "format": "date", "type": "string" }, "description": { "description": "General description of the vendor bill", "type": "string" }, "due_date": { "description": "Due date for payment", "format": "date", "type": "string" }, "exchange_rate": { "description": "Exchange rate to USD", "format": "double", "type": [ "number", "null" ] }, "external_id": { "description": "External system identifier (e.g., Brightflag ID)", "type": "string" }, "id": { "description": "Unique identifier for the vendor in the treasury system", "format": "uuid", "type": "string" }, "is_active": { "description": "Whether the vendor bill is active", "type": "boolean" }, "line_items": { "description": "Line items for the vendor bill", "items": { "$ref": "#/components/schemas/AccountsPayableVendorBillsPostResponsesContentApplicationJsonSchemaDataLineItemsItems" }, "type": "array" }, "reference": { "description": "Vendor bill reference", "type": "string" }, "subsidiary_id": { "description": "Unique identifier for the Deel legal entity/subsidiary", "type": "string" }, "subtotal": { "description": "Subtotal amount excluding VAT", "format": "double", "type": "number" }, "updated_at": { "description": "Last update timestamp", "format": "date-time", "type": "string" }, "vendor_id": { "description": "Vendor ID", "type": "string" } }, "required": [ "id", "date", "amount", "currency", "due_date", "subtotal", "is_active", "reference", "vendor_id", "created_at", "line_items", "updated_at", "description", "external_id", "exchange_rate", "subsidiary_id" ], "title": "AccountsPayableVendorBillsPostResponsesContentApplicationJsonSchemaData", "type": "object" }, "AccountsPayableVendorBillsPostResponsesContentApplicationJsonSchemaDataLineItemsItems": { "properties": { "amount": { "description": "Total amount for this line item", "format": "double", "type": "number" }, "created_at": { "description": "Creation timestamp", "format": "date-time", "type": "string" }, "department_id": { "description": "Unique identifier for the Financial department", "type": [ "string", "null" ] }, "description": { "description": "Description of the line item", "type": "string" }, "expense_account_id": { "description": "Unique identifier for the expense account", "type": [ "string", "null" ] }, "id": { "description": "Unique identifier of the line item", "format": "uuid", "type": "string" }, "quantity": { "description": "Quantity of items", "format": "double", "type": "number" }, "unit_price": { "description": "Price per unit", "format": "double", "type": "number" }, "updated_at": { "description": "Last update timestamp", "format": "date-time", "type": "string" }, "vat_amount": { "description": "VAT amount for this line item", "format": "double", "type": "number" }, "vat_code": { "description": "VAT code name", "type": [ "string", "null" ] }, "vat_rate": { "description": "VAT rate percentage", "format": "double", "type": "number" }, "vendor_bill_id": { "description": "Reference to parent vendor bill", "format": "uuid", "type": "string" } }, "required": [ "id", "amount", "quantity", "vat_rate", "created_at", "unit_price", "updated_at", "vat_amount", "description", "vendor_bill_id" ], "title": "AccountsPayableVendorBillsPostResponsesContentApplicationJsonSchemaDataLineItemsItems", "type": "object" }, "AccountsPayableVendorBillsPostResponsesContentApplicationJsonSchemaErrorsItems": { "properties": { "code": { "description": "Machine-readable error code", "type": "string" }, "message": { "description": "Human-readable explanation", "type": "string" } }, "required": [ "code", "message" ], "title": "AccountsPayableVendorBillsPostResponsesContentApplicationJsonSchemaErrorsItems", "type": "object" }, "AccountsPayableVendorBillsVendorBillIdAttachmentsPostRequestBodyContentMultipartFormDataSchemaData": { "properties": { "file": { "description": "PDF file to upload (max 8MB)", "format": "binary", "type": "string" } }, "title": "AccountsPayableVendorBillsVendorBillIdAttachmentsPostRequestBodyContentMultipartFormDataSchemaData", "type": "object" }, "AccountsPayableVendorBillsVendorBillIdAttachmentsPostResponsesContentApplicationJsonSchemaData": { "properties": { "created_at": { "description": "Creation timestamp", "format": "date-time", "type": "string" }, "id": { "description": "Unique identifier of the uploaded attachment", "format": "uuid", "type": "string" }, "updated_at": { "description": "Last update timestamp", "format": "date-time", "type": "string" } }, "required": [ "id", "created_at", "updated_at" ], "title": "AccountsPayableVendorBillsVendorBillIdAttachmentsPostResponsesContentApplicationJsonSchemaData", "type": "object" }, "AccountsPayableVendorBillsVendorBillIdAttachmentsPostResponsesContentApplicationJsonSchemaErrorsItems": { "properties": { "code": { "description": "Machine-readable error code", "type": "string" }, "message": { "description": "Human-readable explanation", "type": "string" } }, "required": [ "code", "message" ], "title": "AccountsPayableVendorBillsVendorBillIdAttachmentsPostResponsesContentApplicationJsonSchemaErrorsItems", "type": "object" }, "AcknowledgeAComplianceDocument-v2026-01-01RequestBadRequestError": { "properties": { "errors": { "items": { "$ref": "#/components/schemas/EorWorkersComplianceDocumentsDocumentIdAcknowledgementPostResponsesContentApplicationJsonSchemaErrorsItems" }, "type": "array" } }, "title": "AcknowledgeAComplianceDocument-v2026-01-01RequestBadRequestError", "type": "object" }, "AcknowledgeAComplianceDocument-v2026-01-01RequestInternalServerError": { "properties": { "errors": { "items": { "$ref": "#/components/schemas/EorWorkersComplianceDocumentsDocumentIdAcknowledgementPostResponsesContentApplicationJsonSchemaErrorsItems" }, "type": "array" } }, "title": "AcknowledgeAComplianceDocument-v2026-01-01RequestInternalServerError", "type": "object" }, "AcknowledgeAssignmentAgreement-v2026-01-01RequestBadRequestError": { "properties": { "code": { "description": "Machine-readable error code", "type": "string" }, "message": { "description": "A description of the returned error", "type": "string" } }, "title": "AcknowledgeAssignmentAgreement-v2026-01-01RequestBadRequestError", "type": "object" }, "AcknowledgeAssignmentAgreement-v2026-01-01RequestNotFoundError": { "properties": { "code": { "description": "Machine-readable error code", "type": "string" }, "message": { "description": "A description of the returned error", "type": "string" } }, "title": "AcknowledgeAssignmentAgreement-v2026-01-01RequestNotFoundError", "type": "object" }, "AddAdditionalInformation-v2026-01-01RequestBadRequestError": { "properties": { "errors": { "items": { "$ref": "#/components/schemas/EorWorkersContractsContractIdAdditionalInformationPostResponsesContentApplicationJsonSchemaErrorsItems" }, "type": "array" }, "translations": { "description": "Present when additional fields fail validation, to map internal field keys back to public API keys.", "items": { "$ref": "#/components/schemas/EorWorkersContractsContractIdAdditionalInformationPostResponsesContentApplicationJsonSchemaTranslationsItems" }, "type": "array" } }, "required": [ "errors" ], "title": "AddAdditionalInformation-v2026-01-01RequestBadRequestError", "type": "object" }, "AddAdditionalInformation-v2026-01-01RequestForbiddenError": { "properties": { "errors": { "items": { "$ref": "#/components/schemas/EorWorkersContractsContractIdAdditionalInformationPostResponsesContentApplicationJsonSchemaErrorsItems" }, "type": "array" } }, "required": [ "errors" ], "title": "AddAdditionalInformation-v2026-01-01RequestForbiddenError", "type": "object" }, "AddAdditionalInformation-v2026-01-01RequestInternalServerError": { "properties": { "errors": { "items": { "$ref": "#/components/schemas/EorWorkersContractsContractIdAdditionalInformationPostResponsesContentApplicationJsonSchemaErrorsItems" }, "type": "array" } }, "required": [ "errors" ], "title": "AddAdditionalInformation-v2026-01-01RequestInternalServerError", "type": "object" }, "AddAdditionalInformation-v2026-01-01RequestNotFoundError": { "properties": { "errors": { "items": { "$ref": "#/components/schemas/EorWorkersContractsContractIdAdditionalInformationPostResponsesContentApplicationJsonSchemaErrorsItems" }, "type": "array" } }, "required": [ "errors" ], "title": "AddAdditionalInformation-v2026-01-01RequestNotFoundError", "type": "object" }, "AddAdditionalInformation-v2026-01-01RequestTooManyRequestsError": { "properties": { "errors": { "items": { "$ref": "#/components/schemas/EorWorkersContractsContractIdAdditionalInformationPostResponsesContentApplicationJsonSchemaErrorsItems" }, "type": "array" } }, "required": [ "errors" ], "title": "AddAdditionalInformation-v2026-01-01RequestTooManyRequestsError", "type": "object" }, "AddAdditionalInformation-v2026-01-01RequestUnauthorizedError": { "properties": { "errors": { "items": { "$ref": "#/components/schemas/EorWorkersContractsContractIdAdditionalInformationPostResponsesContentApplicationJsonSchemaErrorsItems" }, "type": "array" } }, "required": [ "errors" ], "title": "AddAdditionalInformation-v2026-01-01RequestUnauthorizedError", "type": "object" }, "AddChildOrganizationAdmins-v2026-10-12RequestBadRequestError": { "properties": { "errors": { "items": { "$ref": "#/components/schemas/OrganizationsChildrenAdminsPostResponsesContentApplicationJsonSchemaErrorsItems" }, "type": "array" } }, "required": [ "errors" ], "title": "AddChildOrganizationAdmins-v2026-10-12RequestBadRequestError", "type": "object" }, "AddChildOrganizationAdmins-v2026-10-12RequestForbiddenError": { "properties": { "errors": { "items": { "$ref": "#/components/schemas/OrganizationsChildrenAdminsPostResponsesContentApplicationJsonSchemaErrorsItems" }, "type": "array" } }, "required": [ "errors" ], "title": "AddChildOrganizationAdmins-v2026-10-12RequestForbiddenError", "type": "object" }, "AddChildOrganizationAdmins-v2026-10-12RequestInternalServerError": { "properties": { "errors": { "items": { "$ref": "#/components/schemas/OrganizationsChildrenAdminsPostResponsesContentApplicationJsonSchemaErrorsItems" }, "type": "array" } }, "required": [ "errors" ], "title": "AddChildOrganizationAdmins-v2026-10-12RequestInternalServerError", "type": "object" }, "AddChildOrganizationAdmins-v2026-10-12RequestTooManyRequestsError": { "properties": { "errors": { "items": { "$ref": "#/components/schemas/OrganizationsChildrenAdminsPostResponsesContentApplicationJsonSchemaErrorsItems" }, "type": "array" } }, "required": [ "errors" ], "title": "AddChildOrganizationAdmins-v2026-10-12RequestTooManyRequestsError", "type": "object" }, "AddChildOrganizationAdmins-v2026-10-12RequestUnauthorizedError": { "properties": { "errors": { "items": { "$ref": "#/components/schemas/OrganizationsChildrenAdminsPostResponsesContentApplicationJsonSchemaErrorsItems" }, "type": "array" } }, "required": [ "errors" ], "title": "AddChildOrganizationAdmins-v2026-10-12RequestUnauthorizedError", "type": "object" }, "AddExternalId-v2026-01-01RequestNotFoundError": { "properties": { "errors": { "description": "Error messages", "items": { "$ref": "#/components/schemas/ContractsContractIdPatchResponsesContentApplicationJsonSchemaErrorsItems" }, "type": "array" }, "request": { "$ref": "#/components/schemas/ContractsContractIdPatchResponsesContentApplicationJsonSchemaRequest", "description": "Error request details" } }, "required": [ "errors" ], "title": "AddExternalId-v2026-01-01RequestNotFoundError", "type": "object" }, "AddGpContractBankAccount-v2026-09-17RequestBadRequestError": { "properties": { "errors": { "items": { "$ref": "#/components/schemas/GpContractsContractIdBanksPostResponsesContentApplicationJsonSchemaErrorsItems" }, "type": "array" } }, "title": "AddGpContractBankAccount-v2026-09-17RequestBadRequestError", "type": "object" }, "AddGpWorkersAdditionalInformation-v2026-01-01RequestBadRequestError": { "properties": { "errors": { "items": { "$ref": "#/components/schemas/GpWorkersContractsContractIdAdditionalInformationPostResponsesContentApplicationJsonSchemaErrorsItems" }, "type": "array" } }, "title": "AddGpWorkersAdditionalInformation-v2026-01-01RequestBadRequestError", "type": "object" }, "AddGpWorkersAdditionalInformation-v2026-01-01RequestInternalServerError": { "properties": { "errors": { "items": { "$ref": "#/components/schemas/GpWorkersContractsContractIdAdditionalInformationPostResponsesContentApplicationJsonSchemaErrorsItems" }, "type": "array" } }, "title": "AddGpWorkersAdditionalInformation-v2026-01-01RequestInternalServerError", "type": "object" }, "AddLegalEntityRegistrationDocumentFiles-v2026-08-17RequestBadRequestError": { "properties": { "errors": { "description": "List of errors that occurred while processing the request.", "items": { "$ref": "#/components/schemas/LegalEntitiesLegalEntityIdRegistrationDocumentsDocumentIdPatchResponsesContentApplicationJsonSchemaErrorsItems" }, "type": "array" } }, "required": [ "errors" ], "title": "AddLegalEntityRegistrationDocumentFiles-v2026-08-17RequestBadRequestError", "type": "object" }, "AddLegalEntityRegistrationDocumentFiles-v2026-08-17RequestForbiddenError": { "properties": { "errors": { "description": "List of errors that occurred while processing the request.", "items": { "$ref": "#/components/schemas/LegalEntitiesLegalEntityIdRegistrationDocumentsDocumentIdPatchResponsesContentApplicationJsonSchemaErrorsItems" }, "type": "array" } }, "required": [ "errors" ], "title": "AddLegalEntityRegistrationDocumentFiles-v2026-08-17RequestForbiddenError", "type": "object" }, "AddLegalEntityRegistrationDocumentFiles-v2026-08-17RequestNotFoundError": { "properties": { "errors": { "description": "List of errors that occurred while processing the request.", "items": { "$ref": "#/components/schemas/LegalEntitiesLegalEntityIdRegistrationDocumentsDocumentIdPatchResponsesContentApplicationJsonSchemaErrorsItems" }, "type": "array" } }, "required": [ "errors" ], "title": "AddLegalEntityRegistrationDocumentFiles-v2026-08-17RequestNotFoundError", "type": "object" }, "AddLegalEntityRegistrationDocumentFiles-v2026-08-17RequestUnauthorizedError": { "properties": { "errors": { "description": "List of errors that occurred while processing the request.", "items": { "$ref": "#/components/schemas/LegalEntitiesLegalEntityIdRegistrationDocumentsDocumentIdPatchResponsesContentApplicationJsonSchemaErrorsItems" }, "type": "array" } }, "required": [ "errors" ], "title": "AddLegalEntityRegistrationDocumentFiles-v2026-08-17RequestUnauthorizedError", "type": "object" }, "AddLegalEntityRegistrationDocumentFiles-v2026-08-17RequestUnprocessableEntityError": { "properties": { "errors": { "items": { "$ref": "#/components/schemas/LegalEntitiesLegalEntityIdRegistrationDocumentsDocumentIdPatchResponsesContentApplicationJsonSchemaErrorsItems" }, "type": "array" } }, "required": [ "errors" ], "title": "AddLegalEntityRegistrationDocumentFiles-v2026-08-17RequestUnprocessableEntityError", "type": "object" }, "AddNoteToACandidate-v2026-01-01RequestBadRequestError": { "properties": { "errors": { "description": "List of error objects", "items": { "$ref": "#/components/schemas/AtsCandidatesCandidateIdNotesPostResponsesContentApplicationJsonSchemaErrorsItems" }, "type": "array" } }, "required": [ "errors" ], "title": "AddNoteToACandidate-v2026-01-01RequestBadRequestError", "type": "object" }, "AddNoteToACandidate-v2026-01-01RequestForbiddenError": { "properties": { "errors": { "description": "List of error objects", "items": { "$ref": "#/components/schemas/AtsCandidatesCandidateIdNotesPostResponsesContentApplicationJsonSchemaErrorsItems" }, "type": "array" } }, "required": [ "errors" ], "title": "AddNoteToACandidate-v2026-01-01RequestForbiddenError", "type": "object" }, "AddNoteToACandidate-v2026-01-01RequestInternalServerError": { "properties": { "errors": { "description": "List of error objects", "items": { "$ref": "#/components/schemas/AtsCandidatesCandidateIdNotesPostResponsesContentApplicationJsonSchemaErrorsItems" }, "type": "array" } }, "required": [ "errors" ], "title": "AddNoteToACandidate-v2026-01-01RequestInternalServerError", "type": "object" }, "AddNoteToAnApplication-v2026-01-01RequestBadRequestError": { "properties": { "errors": { "description": "List of error objects", "items": { "$ref": "#/components/schemas/AtsApplicationsApplicationIdNotesPostResponsesContentApplicationJsonSchemaErrorsItems" }, "type": "array" } }, "required": [ "errors" ], "title": "AddNoteToAnApplication-v2026-01-01RequestBadRequestError", "type": "object" }, "AddNoteToAnApplication-v2026-01-01RequestForbiddenError": { "properties": { "errors": { "description": "List of error objects", "items": { "$ref": "#/components/schemas/AtsApplicationsApplicationIdNotesPostResponsesContentApplicationJsonSchemaErrorsItems" }, "type": "array" } }, "required": [ "errors" ], "title": "AddNoteToAnApplication-v2026-01-01RequestForbiddenError", "type": "object" }, "AddNoteToAnApplication-v2026-01-01RequestInternalServerError": { "properties": { "errors": { "description": "List of error objects", "items": { "$ref": "#/components/schemas/AtsApplicationsApplicationIdNotesPostResponsesContentApplicationJsonSchemaErrorsItems" }, "type": "array" } }, "required": [ "errors" ], "title": "AddNoteToAnApplication-v2026-01-01RequestInternalServerError", "type": "object" }, "AddOffCyclePayment-v2026-01-01RequestBadRequestError": { "properties": { "errors": { "description": "Validation or business rule errors describing why the off-cycle payment could not be created, such as invalid input or an unsupported contract type.", "items": { "$ref": "#/components/schemas/ContractsContractIdOffCyclePaymentsPostResponsesContentApplicationJsonSchemaErrorsItems" }, "type": "array" } }, "required": [ "errors" ], "title": "AddOffCyclePayment-v2026-01-01RequestBadRequestError", "type": "object" }, "AddOffCyclePayment-v2026-01-01RequestForbiddenError": { "properties": { "errors": { "description": "Errors describing why the off-cycle payment could not be created.", "items": { "$ref": "#/components/schemas/ContractsContractIdOffCyclePaymentsPostResponsesContentApplicationJsonSchemaErrorsItems" }, "type": "array" } }, "required": [ "errors" ], "title": "AddOffCyclePayment-v2026-01-01RequestForbiddenError", "type": "object" }, "AddOffCyclePayment-v2026-01-01RequestInternalServerError": { "properties": { "errors": { "description": "Generic upstream or internal errors emitted when the off-cycle payment cannot be created.", "items": { "$ref": "#/components/schemas/ContractsContractIdOffCyclePaymentsPostResponsesContentApplicationJsonSchemaErrorsItems" }, "type": "array" } }, "required": [ "errors" ], "title": "AddOffCyclePayment-v2026-01-01RequestInternalServerError", "type": "object" }, "AddOffCyclePayment-v2026-01-01RequestNotFoundError": { "properties": { "errors": { "description": "Errors describing why the contract could not be found.", "items": { "$ref": "#/components/schemas/ContractsContractIdOffCyclePaymentsPostResponsesContentApplicationJsonSchemaErrorsItems" }, "type": "array" } }, "required": [ "errors" ], "title": "AddOffCyclePayment-v2026-01-01RequestNotFoundError", "type": "object" }, "AdjustmentsCategoriesGetParametersContractTypesSchemaItems": { "enum": [ "peo", "global_payroll", "hris_direct_employee", "eor", "employee", "independent_contractor" ], "title": "AdjustmentsCategoriesGetParametersContractTypesSchemaItems", "type": "string" }, "AdjustmentsCategoriesGetResponsesContentApplicationJsonSchemaDataItems": { "properties": { "id": { "description": "Unique identifier of an adjustment category.", "type": "string" }, "label": { "description": "The label of the adjustment category.", "type": "string" }, "name": { "description": "The name of the adjustment category.", "type": "string" }, "unit_type": { "description": "The unit type of the adjustment category.", "type": "string" } }, "title": "AdjustmentsCategoriesGetResponsesContentApplicationJsonSchemaDataItems", "type": "object" }, "AdjustmentsIdDeleteResponsesContentApplicationJsonSchemaData": { "properties": { "deleted": { "description": "Confirms the deletion.", "type": "boolean" } }, "required": [ "deleted" ], "title": "AdjustmentsIdDeleteResponsesContentApplicationJsonSchemaData", "type": "object" }, "AdjustmentsIdGetResponsesContentApplicationJsonSchemaData": { "properties": { "actual_end_cycle_date": { "description": "The date of the actual end cycle date", "type": "string" }, "actual_start_cycle_date": { "description": "The date of the actual start cycle date", "type": "string" }, "adjustment_category_id": { "description": "The identifier of the adjustment category associated with the adjustment", "type": "string" }, "amount": { "description": "The amount of the adjustment", "type": "string" }, "contract_id": { "description": "The identifier of the contract associated with the adjustment", "type": "string" }, "created_at": { "description": "The date and time when the adjustment was created", "format": "date-time", "type": "string" }, "cycle_reference": { "description": "The reference to the cycle associated with the adjustment", "type": [ "string", "null" ] }, "date_of_adjustment": { "description": "The date of the adjustment", "format": "date-time", "type": "string" }, "description": { "description": "The description of the adjustment", "type": "string" }, "file": { "description": "Info about the attachment of adjustment", "oneOf": [ { "$ref": "#/components/schemas/AdjustmentsIdGetResponsesContentApplicationJsonSchemaDataFile" }, { "type": "null" } ] }, "id": { "description": "The unique identifier of the adjustment", "type": "string" }, "move_next_cycle": { "description": "If an adjustments can belong to another payroll cycle", "type": "boolean" }, "odp_only": { "description": "Whether the adjustment is restricted to on-demand payroll and never attached to a regular payroll cycle. Always false for contract types other than EOR", "type": "boolean" }, "status": { "$ref": "#/components/schemas/AdjustmentsIdGetResponsesContentApplicationJsonSchemaDataStatus", "description": "Adjustment status" }, "title": { "description": "The title of the adjustment", "type": "string" }, "updated_at": { "description": "The date and time when the adjustment was last updated", "format": "date-time", "type": "string" } }, "title": "AdjustmentsIdGetResponsesContentApplicationJsonSchemaData", "type": "object" }, "AdjustmentsIdGetResponsesContentApplicationJsonSchemaDataFile": { "description": "Info about the attachment of adjustment", "properties": { "fileType": { "description": "The type of the file", "type": "string" }, "id": { "description": "The unique identifier of the file", "type": "string" }, "name": { "description": "The name of the file", "type": "string" } }, "title": "AdjustmentsIdGetResponsesContentApplicationJsonSchemaDataFile", "type": "object" }, "AdjustmentsIdGetResponsesContentApplicationJsonSchemaDataStatus": { "description": "Adjustment status", "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" ], "title": "AdjustmentsIdGetResponsesContentApplicationJsonSchemaDataStatus", "type": "string" }, "AdjustmentsIdGetResponsesContentApplicationJsonSchemaErrorsItems": { "properties": { "message": { "description": "You must have access to the contract sent", "type": "string" } }, "title": "AdjustmentsIdGetResponsesContentApplicationJsonSchemaErrorsItems", "type": "object" }, "AdjustmentsIdPatchRequestBodyContentMultipartFormDataSchemaData": { "description": "Details of adjustment to update", "properties": { "adjustment_category_id": { "description": "Adjustment category id.", "minLength": 25, "type": "string" }, "amount": { "$ref": "#/components/schemas/AdjustmentsIdPatchRequestBodyContentMultipartFormDataSchemaDataAmount", "description": "Amount of adjustment." }, "country": { "description": "Country code.", "maxLength": 2, "minLength": 2, "pattern": "^[A-Z]{2}$", "type": "string" }, "date_of_adjustment": { "description": "Short date in format ISO-8601 (YYYY-MM-DD). For example: 2022-12-31.", "format": "date", "type": "string" }, "description": { "description": "Description of adjustment.", "maxLength": 255, "minLength": 3, "type": "string" }, "file": { "description": "File of adjustment. Accepted file types: JPEG, PNG, HEIC, WebP, GIF, BMP, TIFF, HEIF images and PDF documents.", "format": "binary", "minLength": 1, "type": "string" }, "odp_only": { "description": "EOR contracts only. Restrict the adjustment to on-demand payroll: when true it is never attached to a regular payroll cycle, and it is automatically denied if it is still not part of an on-demand payroll 30 days after creation. Sending it for any other contract type is rejected, because on-demand payroll does not exist there. Editable only through this API, and it forces move_next_cycle to false.", "type": "boolean" }, "title": { "description": "Title of adjustment.", "maxLength": 255, "minLength": 3, "type": "string" }, "vendor_name": { "description": "Vendor name of adjustment.", "maxLength": 255, "minLength": 1, "type": "string" } }, "title": "AdjustmentsIdPatchRequestBodyContentMultipartFormDataSchemaData", "type": "object" }, "AdjustmentsIdPatchRequestBodyContentMultipartFormDataSchemaDataAmount": { "description": "Amount of adjustment.", "oneOf": [ { "type": "string" }, { "format": "double", "type": "number" } ], "title": "AdjustmentsIdPatchRequestBodyContentMultipartFormDataSchemaDataAmount" }, "AdjustmentsIdPatchResponsesContentApplicationJsonSchemaData": { "properties": { "updated": { "description": "Confirms the update was successful.", "type": "boolean" } }, "required": [ "updated" ], "title": "AdjustmentsIdPatchResponsesContentApplicationJsonSchemaData", "type": "object" }, "AdjustmentsIdPatchResponsesContentApplicationJsonSchemaErrorsItems": { "properties": { "message": { "description": "Error message describing the validation or update failure", "type": "string" } }, "title": "AdjustmentsIdPatchResponsesContentApplicationJsonSchemaErrorsItems", "type": "object" }, "AdjustmentsPostRequestBodyContentApplicationJsonSchemaData": { "description": "Details of adjustment to create", "properties": { "adjustment_category_id": { "description": "Adjustment category id.", "minLength": 25, "type": "string" }, "amount": { "$ref": "#/components/schemas/AdjustmentsPostRequestBodyContentApplicationJsonSchemaDataAmount", "description": "Amount of adjustment." }, "contract_id": { "description": "The identifier of the contract associated with the adjustment", "minLength": 5, "type": "string" }, "country": { "description": "Country the expense was incurred in, which is not necessarily the contract country. Conditionally required: for adjustment categories configured to require a country, which is typically an expense category, and for Global Payroll contracts whenever the organization has the compliance check enabled, which applies to any category. Leave the field out entirely when it does not apply - sending it empty is rejected, because the pattern still applies to a value that is present.", "maxLength": 2, "minLength": 2, "pattern": "^[A-Z]{2}$", "type": "string" }, "cycle_reference": { "description": "Cycle reference of adjustment.", "type": "string" }, "date_of_adjustment": { "description": "Short date in format ISO-8601 (YYYY-MM-DD). For example: 2022-12-31.", "format": "date", "type": [ "string", "null" ] }, "description": { "description": "Description of adjustment.", "maxLength": 255, "minLength": 3, "type": "string" }, "move_next_cycle": { "description": "If an adjustments can belong to another payroll cycle.", "type": [ "boolean", "null" ] }, "odp_only": { "description": "EOR contracts only. Restrict the adjustment to on-demand payroll: when true it is never attached to a regular payroll cycle, and it is automatically denied if it is still not part of an on-demand payroll 30 days after creation. Sending it for any other contract type is rejected, because on-demand payroll does not exist there. Editable only through this API, and it forces move_next_cycle to false.", "type": "boolean" }, "submitter_profile_id": { "description": "The identifier of the profile that submits the adjustment. Must be a profile authorized on the target contract. When omitted, the adjustment is attributed to the profile resolved from the API token.", "minimum": 1, "type": [ "integer", "null" ] }, "title": { "description": "Title of adjustment.", "maxLength": 255, "minLength": 3, "type": "string" }, "vendor": { "description": "Vendor of adjustment. Conditionally required: for adjustment categories configured to require a vendor, which is typically an expense category, and for Global Payroll contracts whenever the organization has the compliance check enabled, which applies to any category. Leave the field out entirely when it does not apply - sending it empty is rejected, because the length constraint still applies to a value that is present.", "minLength": 3, "type": "string" } }, "required": [ "title", "amount", "contract_id", "description", "adjustment_category_id" ], "title": "AdjustmentsPostRequestBodyContentApplicationJsonSchemaData", "type": "object" }, "AdjustmentsPostRequestBodyContentApplicationJsonSchemaDataAmount": { "description": "Amount of adjustment.", "oneOf": [ { "minLength": 1, "type": "string" }, { "format": "double", "minimum": 1, "type": "number" } ], "title": "AdjustmentsPostRequestBodyContentApplicationJsonSchemaDataAmount" }, "AdjustmentsPostResponsesContentApplicationJsonSchemaData": { "properties": { "actual_end_cycle_date": { "description": "The date of the actual end cycle date", "type": "string" }, "actual_start_cycle_date": { "description": "The date of the actual start cycle date", "type": "string" }, "adjustment_category_id": { "description": "The identifier of the adjustment category associated with the adjustment", "type": "string" }, "amount": { "description": "The amount of the adjustment", "type": "string" }, "contract_id": { "description": "The identifier of the contract associated with the adjustment", "type": "string" }, "created_at": { "description": "The date and time when the adjustment was created", "format": "date-time", "type": "string" }, "cycle_reference": { "description": "The reference to the cycle associated with the adjustment", "type": [ "string", "null" ] }, "date_of_adjustment": { "description": "The date of the adjustment", "format": "date-time", "type": "string" }, "description": { "description": "The description of the adjustment", "type": "string" }, "file": { "description": "Adjustment attachment", "oneOf": [ { "$ref": "#/components/schemas/AdjustmentsPostResponsesContentApplicationJsonSchemaDataFile" }, { "type": "null" } ] }, "id": { "description": "The unique identifier of the adjustment", "type": "string" }, "move_next_cycle": { "description": "If an adjustments can belong to another payroll cycle", "type": "boolean" }, "odp_only": { "description": "Whether the adjustment is restricted to on-demand payroll and never attached to a regular payroll cycle. Always false for contract types other than EOR", "type": "boolean" }, "status": { "$ref": "#/components/schemas/AdjustmentsPostResponsesContentApplicationJsonSchemaDataStatus", "description": "The status of the adjustments" }, "title": { "description": "The title of the adjustment", "maxLength": 255, "minLength": 3, "type": "string" }, "updated_at": { "description": "The date and time when the adjustment was last updated", "format": "date-time", "type": "string" } }, "title": "AdjustmentsPostResponsesContentApplicationJsonSchemaData", "type": "object" }, "AdjustmentsPostResponsesContentApplicationJsonSchemaDataFile": { "description": "Adjustment attachment", "properties": { "fileType": { "description": "The type of the file", "type": "string" }, "id": { "description": "The unique identifier of the file", "type": "string" }, "name": { "description": "The name of the file", "type": "string" } }, "title": "AdjustmentsPostResponsesContentApplicationJsonSchemaDataFile", "type": "object" }, "AdjustmentsPostResponsesContentApplicationJsonSchemaDataStatus": { "description": "The status of the adjustments", "oneOf": [ { "$ref": "#/components/schemas/AdjustmentsPostResponsesContentApplicationJsonSchemaDataStatus0" }, { "$ref": "#/components/schemas/AdjustmentsPostResponsesContentApplicationJsonSchemaDataStatus1" } ], "title": "AdjustmentsPostResponsesContentApplicationJsonSchemaDataStatus" }, "AdjustmentsPostResponsesContentApplicationJsonSchemaDataStatus0": { "description": "Adjustment status (when contract type is GP)", "enum": [ "OPEN", "PENDING_APPROVAL", "OVERWRITTEN", "FAILED", "SUCCESS", "AI_CHECK_IN_PROGRESS" ], "title": "AdjustmentsPostResponsesContentApplicationJsonSchemaDataStatus0", "type": "string" }, "AdjustmentsPostResponsesContentApplicationJsonSchemaDataStatus1": { "description": "Adjustment status (when contract type is EOR)", "enum": [ "DRAFT", "PENDING", "ERRORS_FOUND", "APPROVED", "DENIED", "DISBURSE_SCHEDULED", "REIMBURSED", "UNDER_REVIEW", "PENDING_DEEL_REVIEW" ], "title": "AdjustmentsPostResponsesContentApplicationJsonSchemaDataStatus1", "type": "string" }, "AdjustmentsPostResponsesContentApplicationJsonSchemaErrorsItems": { "properties": { "message": { "type": "string" } }, "required": [ "message" ], "title": "AdjustmentsPostResponsesContentApplicationJsonSchemaErrorsItems", "type": "object" }, "AmendContract-v2026-01-01RequestBadRequestError": { "properties": { "errors": { "items": { "$ref": "#/components/schemas/ContractsContractIdAmendmentsPostResponsesContentApplicationJsonSchemaErrorsItems" }, "type": "array" } }, "title": "AmendContract-v2026-01-01RequestBadRequestError", "type": "object" }, "AmendContract-v2026-01-01RequestInternalServerError": { "properties": { "errors": { "items": { "$ref": "#/components/schemas/ContractsContractIdAmendmentsPostResponsesContentApplicationJsonSchemaErrorsItems" }, "type": "array" } }, "title": "AmendContract-v2026-01-01RequestInternalServerError", "type": "object" }, "AmlApiForWhitelabelDataRetrieval-v2026-01-01RequestBadRequestError": { "properties": { "errors": { "items": { "$ref": "#/components/schemas/ScreeningsAmlEntityTypeEntityIdGetResponsesContentApplicationJsonSchemaErrorsItems" }, "type": "array" } }, "title": "AmlApiForWhitelabelDataRetrieval-v2026-01-01RequestBadRequestError", "type": "object" }, "AmlApiForWhitelabelDataRetrieval-v2026-01-01RequestNotFoundError": { "properties": { "errors": { "items": { "$ref": "#/components/schemas/ScreeningsAmlEntityTypeEntityIdGetResponsesContentApplicationJsonSchemaErrorsItems" }, "type": "array" } }, "title": "AmlApiForWhitelabelDataRetrieval-v2026-01-01RequestNotFoundError", "type": "object" }, "AnswerLegalEntityKybEdd-v2026-10-16RequestBadRequestError": { "properties": { "errors": { "items": { "$ref": "#/components/schemas/LegalEntitiesLegalEntityIdKybEddPostResponsesContentApplicationJsonSchemaErrorsItems" }, "type": "array" } }, "required": [ "errors" ], "title": "AnswerLegalEntityKybEdd-v2026-10-16RequestBadRequestError", "type": "object" }, "AnswerLegalEntityKybEdd-v2026-10-16RequestConflictError": { "properties": { "errors": { "items": { "$ref": "#/components/schemas/LegalEntitiesLegalEntityIdKybEddPostResponsesContentApplicationJsonSchemaErrorsItems" }, "type": "array" } }, "required": [ "errors" ], "title": "AnswerLegalEntityKybEdd-v2026-10-16RequestConflictError", "type": "object" }, "AnswerLegalEntityKybEdd-v2026-10-16RequestForbiddenError": { "properties": { "errors": { "items": { "$ref": "#/components/schemas/LegalEntitiesLegalEntityIdKybEddPostResponsesContentApplicationJsonSchemaErrorsItems" }, "type": "array" } }, "required": [ "errors" ], "title": "AnswerLegalEntityKybEdd-v2026-10-16RequestForbiddenError", "type": "object" }, "AnswerLegalEntityKybEdd-v2026-10-16RequestNotFoundError": { "properties": { "errors": { "items": { "$ref": "#/components/schemas/LegalEntitiesLegalEntityIdKybEddPostResponsesContentApplicationJsonSchemaErrorsItems" }, "type": "array" } }, "required": [ "errors" ], "title": "AnswerLegalEntityKybEdd-v2026-10-16RequestNotFoundError", "type": "object" }, "AnswerLegalEntityKybEdd-v2026-10-16RequestServiceUnavailableError": { "properties": { "errors": { "items": { "$ref": "#/components/schemas/LegalEntitiesLegalEntityIdKybEddPostResponsesContentApplicationJsonSchemaErrorsItems" }, "type": "array" } }, "required": [ "errors" ], "title": "AnswerLegalEntityKybEdd-v2026-10-16RequestServiceUnavailableError", "type": "object" }, "AnswerLegalEntityKybEdd-v2026-10-16RequestUnauthorizedError": { "properties": { "errors": { "items": { "$ref": "#/components/schemas/LegalEntitiesLegalEntityIdKybEddPostResponsesContentApplicationJsonSchemaErrorsItems" }, "type": "array" } }, "required": [ "errors" ], "title": "AnswerLegalEntityKybEdd-v2026-10-16RequestUnauthorizedError", "type": "object" }, "AnswerLegalEntityKybEdd-v2026-10-16RequestUnprocessableEntityError": { "properties": { "errors": { "items": { "$ref": "#/components/schemas/LegalEntitiesLegalEntityIdKybEddPostResponsesContentApplicationJsonSchemaErrorsItems" }, "type": "array" } }, "required": [ "errors" ], "title": "AnswerLegalEntityKybEdd-v2026-10-16RequestUnprocessableEntityError", "type": "object" }, "ApiError": { "properties": { "message": { "description": "A description of the returned error", "type": "string" }, "path": { "description": "The JSON path where input validation failed", "type": "string" } }, "title": "ApiError", "type": "object" }, "ApiErrorContainer": { "properties": { "errors": { "items": { "$ref": "#/components/schemas/ApiError" }, "type": "array" }, "request": { "$ref": "#/components/schemas/ApiErrorRequest" } }, "title": "ApiErrorContainer", "type": "object" }, "ApiErrorRequest": { "properties": { "api_req_id": { "description": "The request ID of the failed request", "type": "string" }, "code": { "description": "The code of the source handler which produced the returned error", "format": "double", "type": "number" }, "docs": { "description": "A link to the official documentation for the requested endpoint resource", "type": "string" }, "method": { "description": "The HTTP method of the failed request", "type": "string" }, "source": { "description": "The source handler which produced the returned error", "type": "string" }, "status": { "description": "The status code of the response", "format": "double", "type": "number" }, "url": { "description": "The relative URL of the failed request", "type": "string" } }, "title": "ApiErrorRequest", "type": "object" }, "ApproveAnEquityExercise-v2026-01-01RequestForbiddenError": { "properties": { "errors": { "items": { "$ref": "#/components/schemas/EquityExercisePublicIdPatchResponsesContentApplicationJsonSchemaErrorsItems" }, "type": "array" } }, "required": [ "errors" ], "title": "ApproveAnEquityExercise-v2026-01-01RequestForbiddenError", "type": "object" }, "ApproveAnEquityExercise-v2026-01-01RequestInternalServerError": { "properties": { "errors": { "items": { "$ref": "#/components/schemas/EquityExercisePublicIdPatchResponsesContentApplicationJsonSchemaErrorsItems" }, "type": "array" } }, "required": [ "errors" ], "title": "ApproveAnEquityExercise-v2026-01-01RequestInternalServerError", "type": "object" }, "ApproveAnEquityExercise-v2026-01-01RequestNotFoundError": { "properties": { "errors": { "items": { "$ref": "#/components/schemas/EquityExercisePublicIdPatchResponsesContentApplicationJsonSchemaErrorsItems" }, "type": "array" } }, "required": [ "errors" ], "title": "ApproveAnEquityExercise-v2026-01-01RequestNotFoundError", "type": "object" }, "ApproveAnEquityExercise-v2026-01-01RequestTooManyRequestsError": { "properties": { "errors": { "items": { "$ref": "#/components/schemas/EquityExercisePublicIdPatchResponsesContentApplicationJsonSchemaErrorsItems" }, "type": "array" } }, "required": [ "errors" ], "title": "ApproveAnEquityExercise-v2026-01-01RequestTooManyRequestsError", "type": "object" }, "ApproveAnEquityExercise-v2026-01-01RequestUnauthorizedError": { "properties": { "errors": { "items": { "$ref": "#/components/schemas/EquityExercisePublicIdPatchResponsesContentApplicationJsonSchemaErrorsItems" }, "type": "array" } }, "required": [ "errors" ], "title": "ApproveAnEquityExercise-v2026-01-01RequestUnauthorizedError", "type": "object" }, "ApproveItOrder-v2026-09-30RequestBadRequestError": { "properties": { "errors": { "items": { "$ref": "#/components/schemas/ItOrdersOrderIdApprovePostResponsesContentApplicationJsonSchemaErrorsItems" }, "type": "array" } }, "required": [ "errors" ], "title": "ApproveItOrder-v2026-09-30RequestBadRequestError", "type": "object" }, "ApproveItOrder-v2026-09-30RequestConflictError": { "properties": { "errors": { "items": { "$ref": "#/components/schemas/ItOrdersOrderIdApprovePostResponsesContentApplicationJsonSchemaErrorsItems" }, "type": "array" } }, "required": [ "errors" ], "title": "ApproveItOrder-v2026-09-30RequestConflictError", "type": "object" }, "ApproveItOrder-v2026-09-30RequestForbiddenError": { "properties": { "errors": { "items": { "$ref": "#/components/schemas/ItOrdersOrderIdApprovePostResponsesContentApplicationJsonSchemaErrorsItems" }, "type": "array" } }, "required": [ "errors" ], "title": "ApproveItOrder-v2026-09-30RequestForbiddenError", "type": "object" }, "ApproveItOrder-v2026-09-30RequestInternalServerError": { "properties": { "errors": { "items": { "$ref": "#/components/schemas/ItOrdersOrderIdApprovePostResponsesContentApplicationJsonSchemaErrorsItems" }, "type": "array" } }, "required": [ "errors" ], "title": "ApproveItOrder-v2026-09-30RequestInternalServerError", "type": "object" }, "ApproveItOrder-v2026-09-30RequestNotFoundError": { "properties": { "errors": { "items": { "$ref": "#/components/schemas/ItOrdersOrderIdApprovePostResponsesContentApplicationJsonSchemaErrorsItems" }, "type": "array" } }, "required": [ "errors" ], "title": "ApproveItOrder-v2026-09-30RequestNotFoundError", "type": "object" }, "ApproveItOrder-v2026-09-30RequestUnauthorizedError": { "properties": { "errors": { "items": { "$ref": "#/components/schemas/ItOrdersOrderIdApprovePostResponsesContentApplicationJsonSchemaErrorsItems" }, "type": "array" } }, "required": [ "errors" ], "title": "ApproveItOrder-v2026-09-30RequestUnauthorizedError", "type": "object" }, "ApproveRejectTimeOffRequests-v2026-01-01RequestBadRequestError": { "properties": { "errors": { "items": { "$ref": "#/components/schemas/TimeOffsReviewPostResponsesContentApplicationJsonSchemaErrorsItems" }, "type": "array" }, "request": { "$ref": "#/components/schemas/TimeOffsReviewPostResponsesContentApplicationJsonSchemaRequest" } }, "title": "ApproveRejectTimeOffRequests-v2026-01-01RequestBadRequestError", "type": "object" }, "ApproveVisaApplicationQuote-v2026-10-14RequestBadRequestError": { "properties": { "errors": { "items": { "$ref": "#/components/schemas/ImmigrationVisaApplicationQuotesVisaApplicationQuoteIdApprovePostResponsesContentApplicationJsonSchemaErrorsItems" }, "type": "array" } }, "title": "ApproveVisaApplicationQuote-v2026-10-14RequestBadRequestError", "type": "object" }, "ApproveVisaApplicationQuote-v2026-10-14RequestInternalServerError": { "properties": { "errors": { "items": { "$ref": "#/components/schemas/ImmigrationVisaApplicationQuotesVisaApplicationQuoteIdApprovePostResponsesContentApplicationJsonSchemaErrorsItems" }, "type": "array" } }, "title": "ApproveVisaApplicationQuote-v2026-10-14RequestInternalServerError", "type": "object" }, "ArchiveAsset-v2026-09-17RequestBadRequestError": { "properties": { "errors": { "items": { "$ref": "#/components/schemas/ItAssetsAssetIdArchivePostResponsesContentApplicationJsonSchemaErrorsItems" }, "type": "array" } }, "required": [ "errors" ], "title": "ArchiveAsset-v2026-09-17RequestBadRequestError", "type": "object" }, "ArchiveAsset-v2026-09-17RequestConflictError": { "properties": { "errors": { "items": { "$ref": "#/components/schemas/ItAssetsAssetIdArchivePostResponsesContentApplicationJsonSchemaErrorsItems" }, "type": "array" } }, "required": [ "errors" ], "title": "ArchiveAsset-v2026-09-17RequestConflictError", "type": "object" }, "ArchiveAsset-v2026-09-17RequestForbiddenError": { "properties": { "errors": { "items": { "$ref": "#/components/schemas/ItAssetsAssetIdArchivePostResponsesContentApplicationJsonSchemaErrorsItems" }, "type": "array" } }, "required": [ "errors" ], "title": "ArchiveAsset-v2026-09-17RequestForbiddenError", "type": "object" }, "ArchiveAsset-v2026-09-17RequestInternalServerError": { "properties": { "errors": { "items": { "$ref": "#/components/schemas/ItAssetsAssetIdArchivePostResponsesContentApplicationJsonSchemaErrorsItems" }, "type": "array" } }, "required": [ "errors" ], "title": "ArchiveAsset-v2026-09-17RequestInternalServerError", "type": "object" }, "ArchiveAsset-v2026-09-17RequestUnauthorizedError": { "properties": { "errors": { "items": { "$ref": "#/components/schemas/ItAssetsAssetIdArchivePostResponsesContentApplicationJsonSchemaErrorsItems" }, "type": "array" } }, "required": [ "errors" ], "title": "ArchiveAsset-v2026-09-17RequestUnauthorizedError", "type": "object" }, "AssignCostCentersToAnEmploymentContract-v2026-01-01RequestBadRequestError": { "properties": { "errors": { "items": { "$ref": "#/components/schemas/ContractsContractIdCostCentersPostResponsesContentApplicationJsonSchemaErrorsItems" }, "type": "array" }, "request": { "$ref": "#/components/schemas/ContractsContractIdCostCentersPostResponsesContentApplicationJsonSchemaRequest" } }, "title": "AssignCostCentersToAnEmploymentContract-v2026-01-01RequestBadRequestError", "type": "object" }, "AssignWorkersToItHardwarePolicy-v2026-09-17RequestBadRequestError": { "properties": { "errors": { "items": { "$ref": "#/components/schemas/ItPoliciesItPolicyIdAssignPostResponsesContentApplicationJsonSchemaErrorsItems" }, "type": "array" } }, "required": [ "errors" ], "title": "AssignWorkersToItHardwarePolicy-v2026-09-17RequestBadRequestError", "type": "object" }, "AssignWorkersToItHardwarePolicy-v2026-09-17RequestConflictError": { "properties": { "errors": { "items": { "$ref": "#/components/schemas/ItPoliciesItPolicyIdAssignPostResponsesContentApplicationJsonSchemaErrorsItems" }, "type": "array" } }, "required": [ "errors" ], "title": "AssignWorkersToItHardwarePolicy-v2026-09-17RequestConflictError", "type": "object" }, "AssignWorkersToItHardwarePolicy-v2026-09-17RequestForbiddenError": { "properties": { "errors": { "items": { "$ref": "#/components/schemas/ItPoliciesItPolicyIdAssignPostResponsesContentApplicationJsonSchemaErrorsItems" }, "type": "array" } }, "required": [ "errors" ], "title": "AssignWorkersToItHardwarePolicy-v2026-09-17RequestForbiddenError", "type": "object" }, "AssignWorkersToItHardwarePolicy-v2026-09-17RequestInternalServerError": { "properties": { "errors": { "items": { "$ref": "#/components/schemas/ItPoliciesItPolicyIdAssignPostResponsesContentApplicationJsonSchemaErrorsItems" }, "type": "array" } }, "required": [ "errors" ], "title": "AssignWorkersToItHardwarePolicy-v2026-09-17RequestInternalServerError", "type": "object" }, "AssignWorkersToItHardwarePolicy-v2026-09-17RequestNotFoundError": { "properties": { "errors": { "items": { "$ref": "#/components/schemas/ItPoliciesItPolicyIdAssignPostResponsesContentApplicationJsonSchemaErrorsItems" }, "type": "array" } }, "required": [ "errors" ], "title": "AssignWorkersToItHardwarePolicy-v2026-09-17RequestNotFoundError", "type": "object" }, "AssignWorkersToItHardwarePolicy-v2026-09-17RequestUnauthorizedError": { "properties": { "errors": { "items": { "$ref": "#/components/schemas/ItPoliciesItPolicyIdAssignPostResponsesContentApplicationJsonSchemaErrorsItems" }, "type": "array" } }, "required": [ "errors" ], "title": "AssignWorkersToItHardwarePolicy-v2026-09-17RequestUnauthorizedError", "type": "object" }, "AssignWorkersToItSeats-v2026-09-24RequestBadRequestError": { "properties": { "errors": { "items": { "$ref": "#/components/schemas/ItSeatsAssignPostResponsesContentApplicationJsonSchemaErrorsItems" }, "type": "array" } }, "required": [ "errors" ], "title": "AssignWorkersToItSeats-v2026-09-24RequestBadRequestError", "type": "object" }, "AssignWorkersToItSeats-v2026-09-24RequestConflictError": { "properties": { "errors": { "items": { "$ref": "#/components/schemas/ItSeatsAssignPostResponsesContentApplicationJsonSchemaErrorsItems" }, "type": "array" } }, "required": [ "errors" ], "title": "AssignWorkersToItSeats-v2026-09-24RequestConflictError", "type": "object" }, "AssignWorkersToItSeats-v2026-09-24RequestForbiddenError": { "properties": { "errors": { "items": { "$ref": "#/components/schemas/ItSeatsAssignPostResponsesContentApplicationJsonSchemaErrorsItems" }, "type": "array" } }, "required": [ "errors" ], "title": "AssignWorkersToItSeats-v2026-09-24RequestForbiddenError", "type": "object" }, "AssignWorkersToItSeats-v2026-09-24RequestInternalServerError": { "properties": { "errors": { "items": { "$ref": "#/components/schemas/ItSeatsAssignPostResponsesContentApplicationJsonSchemaErrorsItems" }, "type": "array" } }, "required": [ "errors" ], "title": "AssignWorkersToItSeats-v2026-09-24RequestInternalServerError", "type": "object" }, "AssignWorkersToItSeats-v2026-09-24RequestNotFoundError": { "properties": { "errors": { "items": { "$ref": "#/components/schemas/ItSeatsAssignPostResponsesContentApplicationJsonSchemaErrorsItems" }, "type": "array" } }, "required": [ "errors" ], "title": "AssignWorkersToItSeats-v2026-09-24RequestNotFoundError", "type": "object" }, "AssignWorkersToItSeats-v2026-09-24RequestUnauthorizedError": { "properties": { "errors": { "items": { "$ref": "#/components/schemas/ItSeatsAssignPostResponsesContentApplicationJsonSchemaErrorsItems" }, "type": "array" } }, "required": [ "errors" ], "title": "AssignWorkersToItSeats-v2026-09-24RequestUnauthorizedError", "type": "object" }, "AssociateApplicationWithAnInterviewPlanStage-v2026-01-01RequestBadRequestError": { "properties": { "errors": { "description": "List of error objects", "items": { "$ref": "#/components/schemas/AtsApplicationsApplicationIdInterviewPlanStagesPostResponsesContentApplicationJsonSchemaErrorsItems" }, "type": "array" } }, "required": [ "errors" ], "title": "AssociateApplicationWithAnInterviewPlanStage-v2026-01-01RequestBadRequestError", "type": "object" }, "AssociateApplicationWithAnInterviewPlanStage-v2026-01-01RequestForbiddenError": { "properties": { "errors": { "description": "List of error objects", "items": { "$ref": "#/components/schemas/AtsApplicationsApplicationIdInterviewPlanStagesPostResponsesContentApplicationJsonSchemaErrorsItems" }, "type": "array" } }, "required": [ "errors" ], "title": "AssociateApplicationWithAnInterviewPlanStage-v2026-01-01RequestForbiddenError", "type": "object" }, "AssociateApplicationWithAnInterviewPlanStage-v2026-01-01RequestInternalServerError": { "properties": { "errors": { "description": "List of error objects", "items": { "$ref": "#/components/schemas/AtsApplicationsApplicationIdInterviewPlanStagesPostResponsesContentApplicationJsonSchemaErrorsItems" }, "type": "array" } }, "required": [ "errors" ], "title": "AssociateApplicationWithAnInterviewPlanStage-v2026-01-01RequestInternalServerError", "type": "object" }, "AtsApplicationFormsApplicationFormIdGetResponsesContentApplicationJsonSchemaData": { "properties": { "application_confirmation_email_template_id": { "description": "Unique identifier for the application confirmation email template", "format": "uuid", "type": [ "string", "null" ] }, "created_at": { "description": "Timestamp when the application form was created", "format": "date-time", "type": "string" }, "demographic_option_types": { "description": "Array of demographic option types for collecting diversity information", "items": { "$ref": "#/components/schemas/AtsApplicationFormsApplicationFormIdGetResponsesContentApplicationJsonSchemaDataDemographicOptionTypesItems" }, "type": "array" }, "demographic_section_helper_text": { "description": "Helper text for the demographic section", "type": [ "string", "null" ] }, "demographic_section_title": { "description": "Title for the demographic section", "type": [ "string", "null" ] }, "form_builder_form": { "description": "Form builder configuration", "oneOf": [ { "$ref": "#/components/schemas/AtsApplicationFormsApplicationFormIdGetResponsesContentApplicationJsonSchemaDataFormBuilderForm" }, { "type": "null" } ] }, "form_builder_form_id": { "description": "Unique identifier for the form builder form", "format": "uuid", "type": [ "string", "null" ] }, "form_builder_form_revision_id": { "description": "Unique identifier for the form builder form revision", "format": "uuid", "type": [ "string", "null" ] }, "has_show_resume_field": { "description": "Whether to show the resume field", "type": "boolean" }, "id": { "description": "Unique identifier for the application form", "format": "uuid", "type": "string" }, "is_linkedin_profile_url_required": { "description": "Whether the LinkedIn profile URL field is required", "type": "boolean" }, "is_location_city_field_required": { "description": "Whether the city field is required, which is only required alongside the country field", "type": "boolean" }, "is_location_country_field_required": { "description": "Whether the country field is required", "type": "boolean" }, "is_phone_number_required": { "description": "Whether the phone number field is required", "type": "boolean" }, "is_resume_required": { "description": "Whether the resume field is required", "type": "boolean" }, "organization_id": { "description": "Unique identifier for the organization", "format": "uuid", "type": "string" }, "resume_field_helper_text": { "description": "Helper text for the resume field", "type": [ "string", "null" ] }, "richtext_description": { "description": "Rich text description of the application form", "type": [ "string", "null" ] }, "sensitive_fields_ids": { "description": "Array of sensitive field IDs", "items": { "format": "uuid", "type": "string" }, "type": [ "array", "null" ] }, "should_show_location_city_field": { "description": "Whether to show the city field, which is only shown alongside the country field", "type": "boolean" }, "should_show_location_country_field": { "description": "Whether to show the country field", "type": "boolean" }, "status_enum": { "$ref": "#/components/schemas/AtsApplicationFormsApplicationFormIdGetResponsesContentApplicationJsonSchemaDataStatusEnum", "description": "Status of the application form" }, "title": { "description": "Title of the application form", "type": "string" }, "updated_at": { "description": "Timestamp when the application form was last updated", "format": "date-time", "type": "string" } }, "required": [ "id", "title", "created_at", "updated_at", "status_enum", "organization_id", "form_builder_form", "is_resume_required", "form_builder_form_id", "richtext_description", "sensitive_fields_ids", "has_show_resume_field", "is_phone_number_required", "resume_field_helper_text", "demographic_section_title", "form_builder_form_revision_id", "demographic_section_helper_text", "is_location_city_field_required", "should_show_location_city_field", "is_linkedin_profile_url_required", "is_location_country_field_required", "should_show_location_country_field", "application_confirmation_email_template_id" ], "title": "AtsApplicationFormsApplicationFormIdGetResponsesContentApplicationJsonSchemaData", "type": "object" }, "AtsApplicationFormsApplicationFormIdGetResponsesContentApplicationJsonSchemaDataDemographicOptionTypesItems": { "properties": { "helper_text": { "description": "Helper text for the option type", "type": [ "string", "null" ] }, "id": { "description": "Unique identifier for the demographic option type", "format": "uuid", "type": "string" }, "option_type_slug": { "description": "Slug for the option type", "type": "string" }, "options": { "description": "Array of available options for this demographic type", "items": { "$ref": "#/components/schemas/AtsApplicationFormsApplicationFormIdGetResponsesContentApplicationJsonSchemaDataDemographicOptionTypesItemsOptionsItems" }, "type": "array" } }, "title": "AtsApplicationFormsApplicationFormIdGetResponsesContentApplicationJsonSchemaDataDemographicOptionTypesItems", "type": "object" }, "AtsApplicationFormsApplicationFormIdGetResponsesContentApplicationJsonSchemaDataDemographicOptionTypesItemsOptionsItems": { "properties": { "id": { "description": "Unique identifier for the option", "format": "uuid", "type": "string" }, "value": { "description": "Value of the option", "type": "string" } }, "title": "AtsApplicationFormsApplicationFormIdGetResponsesContentApplicationJsonSchemaDataDemographicOptionTypesItemsOptionsItems", "type": "object" }, "AtsApplicationFormsApplicationFormIdGetResponsesContentApplicationJsonSchemaDataFormBuilderForm": { "description": "Form builder configuration", "properties": { "pages": { "description": "List of pages in the form", "items": { "$ref": "#/components/schemas/AtsApplicationFormsApplicationFormIdGetResponsesContentApplicationJsonSchemaDataFormBuilderFormPagesItems" }, "type": "array" } }, "required": [ "pages" ], "title": "AtsApplicationFormsApplicationFormIdGetResponsesContentApplicationJsonSchemaDataFormBuilderForm", "type": "object" }, "AtsApplicationFormsApplicationFormIdGetResponsesContentApplicationJsonSchemaDataFormBuilderFormPagesItems": { "description": "Pages in the form", "properties": { "sections": { "description": "Sections within the page", "items": { "$ref": "#/components/schemas/AtsApplicationFormsApplicationFormIdGetResponsesContentApplicationJsonSchemaDataFormBuilderFormPagesItemsSectionsItems" }, "type": "array" }, "title": { "description": "Title of the form page", "type": "string" } }, "required": [ "title", "sections" ], "title": "AtsApplicationFormsApplicationFormIdGetResponsesContentApplicationJsonSchemaDataFormBuilderFormPagesItems", "type": "object" }, "AtsApplicationFormsApplicationFormIdGetResponsesContentApplicationJsonSchemaDataFormBuilderFormPagesItemsSectionsItems": { "description": "Sections within the page", "properties": { "questions": { "description": "List of questions within the section", "items": { "$ref": "#/components/schemas/AtsApplicationFormsApplicationFormIdGetResponsesContentApplicationJsonSchemaDataFormBuilderFormPagesItemsSectionsItemsQuestionsItems" }, "type": "array" }, "subtitle": { "description": "Additional information shown at the top of the section", "type": "string" }, "title": { "description": "Title of the section", "type": "string" } }, "required": [ "title", "questions" ], "title": "AtsApplicationFormsApplicationFormIdGetResponsesContentApplicationJsonSchemaDataFormBuilderFormPagesItemsSectionsItems", "type": "object" }, "AtsApplicationFormsApplicationFormIdGetResponsesContentApplicationJsonSchemaDataFormBuilderFormPagesItemsSectionsItemsQuestionsItems": { "description": "List of questions within the section", "properties": { "date_limitation": { "description": "Limits date selection (e.g., blocking past dates). Will always be 'BLOCK_PAST' for now", "type": [ "string", "null" ] }, "default_value": { "description": "Default value to pre-fill in the form", "type": [ "string", "null" ] }, "has_request_validation": { "description": "Whether additional validation should be triggered for this field", "type": "boolean" }, "helper_text": { "description": "Additional information to assist the user", "type": [ "string", "null" ] }, "is_disabled": { "description": "If true, the field is disabled and cannot be edited", "type": "boolean" }, "is_multiple_selection": { "description": "Indicates if the user can select multiple values", "type": "boolean" }, "is_only_digits": { "description": "Restricts input to numeric characters only, for FreeText questions", "type": "boolean" }, "is_range": { "description": "Specifies whether a date picker allows range selection", "type": "boolean" }, "is_required": { "description": "Indicates if the question is required", "type": "boolean" }, "key": { "description": "Unique key identifier for the question", "type": "string" }, "max_length": { "description": "Maximum character length for text responses", "type": [ "integer", "null" ] }, "max_value": { "description": "Maximum value allowed", "format": "double", "type": [ "number", "null" ] }, "min_length": { "description": "Minimum character length for text responses", "type": [ "integer", "null" ] }, "min_value": { "description": "Minimum value allowed", "format": "double", "type": [ "number", "null" ] }, "number_type": { "description": "Used for number fields to define the unit or representation", "type": "string" }, "options": { "description": "List of selectable options for selection-type questions", "items": { "$ref": "#/components/schemas/AtsApplicationFormsApplicationFormIdGetResponsesContentApplicationJsonSchemaDataFormBuilderFormPagesItemsSectionsItemsQuestionsItemsOptionsItems" }, "type": [ "array", "null" ] }, "rules": { "description": "Validation rules for the question", "items": { "$ref": "#/components/schemas/AtsApplicationFormsApplicationFormIdGetResponsesContentApplicationJsonSchemaDataFormBuilderFormPagesItemsSectionsItemsQuestionsItemsRulesItems" }, "type": [ "array", "null" ] }, "source": { "description": "Defines dynamic data source for the question", "oneOf": [ { "$ref": "#/components/schemas/AtsApplicationFormsApplicationFormIdGetResponsesContentApplicationJsonSchemaDataFormBuilderFormPagesItemsSectionsItemsQuestionsItemsSource" }, { "type": "null" } ] }, "title": { "description": "Title of the question", "type": "string" }, "type": { "$ref": "#/components/schemas/AtsApplicationFormsApplicationFormIdGetResponsesContentApplicationJsonSchemaDataFormBuilderFormPagesItemsSectionsItemsQuestionsItemsType", "description": "Type of the question" } }, "required": [ "type", "title" ], "title": "AtsApplicationFormsApplicationFormIdGetResponsesContentApplicationJsonSchemaDataFormBuilderFormPagesItemsSectionsItemsQuestionsItems", "type": "object" }, "AtsApplicationFormsApplicationFormIdGetResponsesContentApplicationJsonSchemaDataFormBuilderFormPagesItemsSectionsItemsQuestionsItemsOptionsItems": { "properties": { "title": { "description": "Display text for the option", "type": "string" }, "value": { "description": "Value associated with the option", "type": [ "string", "null" ] } }, "required": [ "title" ], "title": "AtsApplicationFormsApplicationFormIdGetResponsesContentApplicationJsonSchemaDataFormBuilderFormPagesItemsSectionsItemsQuestionsItemsOptionsItems", "type": "object" }, "AtsApplicationFormsApplicationFormIdGetResponsesContentApplicationJsonSchemaDataFormBuilderFormPagesItemsSectionsItemsQuestionsItemsRulesItems": { "description": "Validation rules for the question", "properties": { "date_limitation": { "description": "Limits date selection (e.g., blocking past dates). Will always be 'BLOCK_PAST' for now", "type": [ "string", "null" ] }, "default_value": { "description": "Default value to pre-fill in the form", "type": [ "string", "null" ] }, "has_request_validation": { "description": "Whether additional validation should be triggered for this field", "type": "boolean" }, "helper_text": { "description": "Additional information to assist the user", "type": [ "string", "null" ] }, "is_disabled": { "description": "If true, the field is disabled and cannot be edited", "type": "boolean" }, "is_multiple_selection": { "description": "Indicates if the user can select multiple values", "type": "boolean" }, "is_only_digits": { "description": "Restricts input to numeric characters only, for FreeText questions", "type": "boolean" }, "is_range": { "description": "Specifies whether a date picker allows range selection", "type": "boolean" }, "is_required": { "description": "Indicates if the question is required", "type": "boolean" }, "max_length": { "description": "Maximum character length for text responses", "type": [ "integer", "null" ] }, "max_value": { "description": "Maximum value allowed", "format": "double", "type": [ "number", "null" ] }, "min_length": { "description": "Minimum character length for text responses", "type": [ "integer", "null" ] }, "min_value": { "description": "Minimum value allowed", "format": "double", "type": [ "number", "null" ] }, "number_type": { "description": "Used for number fields to define the unit or representation", "type": "string" }, "options": { "description": "List of selectable options for selection-type questions. Value may be of any type.", "items": { "description": "Any type" }, "type": [ "array", "null" ] }, "requires": { "description": "List of conditions that must be met for this rule to apply", "items": { "description": "Any type" }, "type": "array" }, "source": { "description": "Defines dynamic data source for the question", "oneOf": [ { "$ref": "#/components/schemas/AtsApplicationFormsApplicationFormIdGetResponsesContentApplicationJsonSchemaDataFormBuilderFormPagesItemsSectionsItemsQuestionsItemsRulesItemsSource" }, { "type": "null" } ] }, "title": { "description": "Title of the question", "type": "string" } }, "title": "AtsApplicationFormsApplicationFormIdGetResponsesContentApplicationJsonSchemaDataFormBuilderFormPagesItemsSectionsItemsQuestionsItemsRulesItems", "type": "object" }, "AtsApplicationFormsApplicationFormIdGetResponsesContentApplicationJsonSchemaDataFormBuilderFormPagesItemsSectionsItemsQuestionsItemsRulesItemsSource": { "description": "Defines dynamic data source for the question", "properties": { "definition": { "description": "Reference URL for API documentation", "type": "string" }, "description": { "description": "Description of the data source", "type": "string" }, "url": { "description": "API endpoint providing dynamic options", "type": "string" } }, "title": "AtsApplicationFormsApplicationFormIdGetResponsesContentApplicationJsonSchemaDataFormBuilderFormPagesItemsSectionsItemsQuestionsItemsRulesItemsSource", "type": "object" }, "AtsApplicationFormsApplicationFormIdGetResponsesContentApplicationJsonSchemaDataFormBuilderFormPagesItemsSectionsItemsQuestionsItemsSource": { "description": "Defines dynamic data source for the question", "properties": { "definition": { "description": "Reference URL for API documentation", "type": "string" }, "description": { "description": "Description of the data source", "type": "string" }, "url": { "description": "API endpoint providing dynamic options", "type": "string" } }, "title": "AtsApplicationFormsApplicationFormIdGetResponsesContentApplicationJsonSchemaDataFormBuilderFormPagesItemsSectionsItemsQuestionsItemsSource", "type": "object" }, "AtsApplicationFormsApplicationFormIdGetResponsesContentApplicationJsonSchemaDataFormBuilderFormPagesItemsSectionsItemsQuestionsItemsType": { "description": "Type of the question", "enum": [ "FREETEXT", "PARAGRAPH", "SINGLESELECTION", "MULTISELECTION", "ADDRESS", "PHONENUMBER", "DOCUMENTUPLOAD", "NUMBER", "DROPDOWN", "DATEPICKER", "EMAIL", "CUSTOMDROPDOWN", "PRESETDROPDOWN", "NESTED" ], "title": "AtsApplicationFormsApplicationFormIdGetResponsesContentApplicationJsonSchemaDataFormBuilderFormPagesItemsSectionsItemsQuestionsItemsType", "type": "string" }, "AtsApplicationFormsApplicationFormIdGetResponsesContentApplicationJsonSchemaDataStatusEnum": { "description": "Status of the application form", "enum": [ "DRAFT", "PUBLISHED", "ARCHIVED" ], "title": "AtsApplicationFormsApplicationFormIdGetResponsesContentApplicationJsonSchemaDataStatusEnum", "type": "string" }, "AtsApplicationFormsApplicationFormIdGetResponsesContentApplicationJsonSchemaErrorsItems": { "properties": { "code": { "description": "Machine-readable error code", "type": "string" }, "field": { "description": "Request field related to the error, if applicable", "type": "string" }, "message": { "description": "Human-readable error message", "type": "string" } }, "required": [ "code", "message" ], "title": "AtsApplicationFormsApplicationFormIdGetResponsesContentApplicationJsonSchemaErrorsItems", "type": "object" }, "AtsApplicationSourcesGetResponsesContentApplicationJsonSchemaDataItems": { "properties": { "created_at": { "description": "Timestamp of when the application source was created", "format": "date-time", "type": "string" }, "id": { "description": "Application source unique identifier", "format": "uuid", "type": "string" }, "slug": { "description": "Application source slug", "type": "string" }, "updated_at": { "description": "Timestamp of when the application source was last updated", "format": "date-time", "type": "string" } }, "required": [ "id", "slug", "created_at", "updated_at" ], "title": "AtsApplicationSourcesGetResponsesContentApplicationJsonSchemaDataItems", "type": "object" }, "AtsApplicationSourcesGetResponsesContentApplicationJsonSchemaErrorsItems": { "properties": { "code": { "description": "Machine-readable error code", "type": "string" }, "field": { "description": "Request field related to the error, if applicable", "type": "string" }, "message": { "description": "Human-readable error message", "type": "string" } }, "required": [ "code", "message" ], "title": "AtsApplicationSourcesGetResponsesContentApplicationJsonSchemaErrorsItems", "type": "object" }, "AtsApplicationsApplicationIdFeedbacksGetParametersStatus": { "enum": [ "SUBMITTED", "NOT_SUBMITTED", "DISMISSED", "REVOKED" ], "title": "AtsApplicationsApplicationIdFeedbacksGetParametersStatus", "type": "string" }, "AtsApplicationsApplicationIdFeedbacksGetParametersXBeta": { "default": "true", "enum": [ "true" ], "title": "AtsApplicationsApplicationIdFeedbacksGetParametersXBeta", "type": "string" }, "AtsApplicationsApplicationIdFeedbacksGetResponsesContentApplicationJsonSchemaDataItems": { "properties": { "activity_type": { "description": "Type slug of the interview activity.", "type": [ "string", "null" ] }, "application_activity_id": { "description": "Activity the feedback belongs to.", "format": "uuid", "type": "string" }, "created_at": { "description": "ISO 8601 datetime when the feedback record was created.", "format": "date-time", "type": "string" }, "dismissal_reason": { "description": "Reason the reviewer selected when dismissing the feedback request. Null when the request was dismissed from the reviewer's Deel Tasks list, which records no reason.", "oneOf": [ { "$ref": "#/components/schemas/AtsApplicationsApplicationIdFeedbacksGetResponsesContentApplicationJsonSchemaDataItemsDismissalReason" }, { "type": "null" } ] }, "dismissed_at": { "description": "ISO 8601 datetime when the reviewer dismissed the feedback request.", "format": "date-time", "type": [ "string", "null" ] }, "feedback_form": { "$ref": "#/components/schemas/AtsApplicationsApplicationIdFeedbacksGetResponsesContentApplicationJsonSchemaDataItemsFeedbackForm", "description": "Feedback form template used for this feedback." }, "form_responses": { "description": "Submitted form question/answer pairs from FormBuilder.", "items": { "$ref": "#/components/schemas/AtsApplicationsApplicationIdFeedbacksGetResponsesContentApplicationJsonSchemaDataItemsFormResponsesItems" }, "type": [ "array", "null" ] }, "id": { "description": "Unique identifier of the feedback record.", "format": "uuid", "type": "string" }, "overall_recommendation": { "description": "Overall recommendation selected by the reviewer.", "oneOf": [ { "$ref": "#/components/schemas/AtsApplicationsApplicationIdFeedbacksGetResponsesContentApplicationJsonSchemaDataItemsOverallRecommendation" }, { "type": "null" } ] }, "reviewer": { "$ref": "#/components/schemas/AtsApplicationsApplicationIdFeedbacksGetResponsesContentApplicationJsonSchemaDataItemsReviewer", "description": "Reviewer who provided the feedback." }, "revocation_reason_enum": { "description": "Why the system revoked the feedback request.", "oneOf": [ { "$ref": "#/components/schemas/AtsApplicationsApplicationIdFeedbacksGetResponsesContentApplicationJsonSchemaDataItemsRevocationReasonEnum" }, { "type": "null" } ] }, "revoked_at": { "description": "ISO 8601 datetime when the system revoked the feedback request.", "format": "date-time", "type": [ "string", "null" ] }, "scheduled_interview_id": { "description": "Scheduled interview the feedback was collected for (see GET /rest/ats/interviews); null for non-interview activities.", "format": "uuid", "type": [ "string", "null" ] }, "stage_name": { "description": "Name of the interview plan stage.", "type": [ "string", "null" ] }, "status": { "$ref": "#/components/schemas/AtsApplicationsApplicationIdFeedbacksGetResponsesContentApplicationJsonSchemaDataItemsStatus", "description": "Submission status of the feedback. DISMISSED means the reviewer dismissed the request with a reason. REVOKED means the system withdrew it because the job closed or the application reached a terminal stage." }, "submitted_at": { "description": "ISO 8601 datetime when the feedback was submitted.", "format": "date-time", "type": [ "string", "null" ] } }, "required": [ "id", "status", "reviewer", "created_at", "feedback_form", "scheduled_interview_id", "application_activity_id" ], "title": "AtsApplicationsApplicationIdFeedbacksGetResponsesContentApplicationJsonSchemaDataItems", "type": "object" }, "AtsApplicationsApplicationIdFeedbacksGetResponsesContentApplicationJsonSchemaDataItemsDismissalReason": { "description": "Reason the reviewer selected when dismissing the feedback request. Null when the request was dismissed from the reviewer's Deel Tasks list, which records no reason.", "properties": { "id": { "description": "Unique identifier of the reason.", "format": "uuid", "type": "string" }, "label": { "description": "Label of the reason.", "type": "string" } }, "title": "AtsApplicationsApplicationIdFeedbacksGetResponsesContentApplicationJsonSchemaDataItemsDismissalReason", "type": "object" }, "AtsApplicationsApplicationIdFeedbacksGetResponsesContentApplicationJsonSchemaDataItemsFeedbackForm": { "description": "Feedback form template used for this feedback.", "properties": { "id": { "description": "Unique identifier of the feedback form.", "format": "uuid", "type": "string" }, "title": { "description": "Title of the feedback form.", "type": "string" } }, "required": [ "id", "title" ], "title": "AtsApplicationsApplicationIdFeedbacksGetResponsesContentApplicationJsonSchemaDataItemsFeedbackForm", "type": "object" }, "AtsApplicationsApplicationIdFeedbacksGetResponsesContentApplicationJsonSchemaDataItemsFormResponsesItems": { "properties": { "answer": { "$ref": "#/components/schemas/AtsApplicationsApplicationIdFeedbacksGetResponsesContentApplicationJsonSchemaDataItemsFormResponsesItemsAnswer", "description": "Answer value; shape varies by question type (string, number, array, or object)." }, "question_text": { "description": "Text of the feedback form question.", "type": "string" }, "question_type": { "description": "Type of the question field.", "type": "string" } }, "required": [ "answer", "question_text", "question_type" ], "title": "AtsApplicationsApplicationIdFeedbacksGetResponsesContentApplicationJsonSchemaDataItemsFormResponsesItems", "type": "object" }, "AtsApplicationsApplicationIdFeedbacksGetResponsesContentApplicationJsonSchemaDataItemsFormResponsesItemsAnswer": { "description": "Answer value; shape varies by question type (string, number, array, or object).", "oneOf": [ { "type": "string" }, { "format": "double", "type": "number" }, { "type": "boolean" }, { "items": { "description": "Any type" }, "type": "array" }, { "additionalProperties": { "description": "Any type" }, "type": "object" } ], "title": "AtsApplicationsApplicationIdFeedbacksGetResponsesContentApplicationJsonSchemaDataItemsFormResponsesItemsAnswer" }, "AtsApplicationsApplicationIdFeedbacksGetResponsesContentApplicationJsonSchemaDataItemsOverallRecommendation": { "description": "Overall recommendation selected by the reviewer.", "properties": { "scale_item_id": { "description": "Unique identifier of the selected feedback scale item.", "format": "uuid", "type": "string" }, "scale_item_label": { "description": "Display label of the selected scale item.", "type": "string" }, "scale_title": { "description": "Title of the feedback scale.", "type": [ "string", "null" ] } }, "title": "AtsApplicationsApplicationIdFeedbacksGetResponsesContentApplicationJsonSchemaDataItemsOverallRecommendation", "type": "object" }, "AtsApplicationsApplicationIdFeedbacksGetResponsesContentApplicationJsonSchemaDataItemsReviewer": { "description": "Reviewer who provided the feedback.", "properties": { "participant_hris_organization_user_id": { "description": "HRIS organization user ID of the reviewer.", "format": "uuid", "type": "string" }, "reviewer_profile": { "oneOf": [ { "$ref": "#/components/schemas/AtsApplicationsApplicationIdFeedbacksGetResponsesContentApplicationJsonSchemaDataItemsReviewerReviewerProfile" }, { "type": "null" } ] } }, "required": [ "participant_hris_organization_user_id" ], "title": "AtsApplicationsApplicationIdFeedbacksGetResponsesContentApplicationJsonSchemaDataItemsReviewer", "type": "object" }, "AtsApplicationsApplicationIdFeedbacksGetResponsesContentApplicationJsonSchemaDataItemsReviewerReviewerProfile": { "properties": { "country": { "description": "ISO 3166-1 alpha-2 country code.", "type": [ "string", "null" ] }, "first_name": { "description": "First name.", "type": "string" }, "full_name": { "description": "Full name.", "type": "string" }, "hris_organization_user_id": { "description": "HRIS organization user ID.", "format": "uuid", "type": "string" }, "job_title": { "description": "Job title.", "type": [ "string", "null" ] }, "last_name": { "description": "Last name.", "type": "string" }, "pic_url": { "description": "Profile picture URL.", "type": [ "string", "null" ] }, "type": { "$ref": "#/components/schemas/AtsApplicationsApplicationIdFeedbacksGetResponsesContentApplicationJsonSchemaDataItemsReviewerReviewerProfileType", "description": "Participant type within the organization." }, "work_email": { "description": "Work email.", "format": "email", "type": [ "string", "null" ] } }, "title": "AtsApplicationsApplicationIdFeedbacksGetResponsesContentApplicationJsonSchemaDataItemsReviewerReviewerProfile", "type": "object" }, "AtsApplicationsApplicationIdFeedbacksGetResponsesContentApplicationJsonSchemaDataItemsReviewerReviewerProfileType": { "description": "Participant type within the organization.", "enum": [ "CLIENT", "WORKER" ], "title": "AtsApplicationsApplicationIdFeedbacksGetResponsesContentApplicationJsonSchemaDataItemsReviewerReviewerProfileType", "type": "string" }, "AtsApplicationsApplicationIdFeedbacksGetResponsesContentApplicationJsonSchemaDataItemsRevocationReasonEnum": { "description": "Why the system revoked the feedback request.", "enum": [ "JOB_CLOSED", "APPLICATION_COMPLETED" ], "title": "AtsApplicationsApplicationIdFeedbacksGetResponsesContentApplicationJsonSchemaDataItemsRevocationReasonEnum", "type": "string" }, "AtsApplicationsApplicationIdFeedbacksGetResponsesContentApplicationJsonSchemaDataItemsStatus": { "description": "Submission status of the feedback. DISMISSED means the reviewer dismissed the request with a reason. REVOKED means the system withdrew it because the job closed or the application reached a terminal stage.", "enum": [ "SUBMITTED", "NOT_SUBMITTED", "DISMISSED", "REVOKED" ], "title": "AtsApplicationsApplicationIdFeedbacksGetResponsesContentApplicationJsonSchemaDataItemsStatus", "type": "string" }, "AtsApplicationsApplicationIdFeedbacksGetResponsesContentApplicationJsonSchemaErrorsItems": { "properties": { "code": { "description": "Machine-readable error code", "type": "string" }, "field": { "description": "Request field related to the error, if applicable", "type": "string" }, "message": { "description": "Human-readable error message", "type": "string" } }, "required": [ "code", "message" ], "title": "AtsApplicationsApplicationIdFeedbacksGetResponsesContentApplicationJsonSchemaErrorsItems", "type": "object" }, "AtsApplicationsApplicationIdGetResponsesContentApplicationJsonSchemaData": { "description": "Complete application details", "properties": { "all_application_interview_plan_stages": { "description": "All interview plan stages", "items": { "$ref": "#/components/schemas/AtsApplicationsApplicationIdGetResponsesContentApplicationJsonSchemaDataAllApplicationInterviewPlanStagesItems" }, "type": "array" }, "application_automation_rule_executions": { "description": "Automation rule executions", "items": { "$ref": "#/components/schemas/AtsApplicationsApplicationIdGetResponsesContentApplicationJsonSchemaDataApplicationAutomationRuleExecutionsItems" }, "type": "array" }, "application_form_submission": { "description": "Application form submission data with mapped answers", "oneOf": [ { "$ref": "#/components/schemas/AtsApplicationsApplicationIdGetResponsesContentApplicationJsonSchemaDataApplicationFormSubmission" }, { "type": "null" } ] }, "application_job_criterias_matchings": { "description": "Job criteria matchings", "items": { "$ref": "#/components/schemas/AtsApplicationsApplicationIdGetResponsesContentApplicationJsonSchemaDataApplicationJobCriteriasMatchingsItems" }, "type": "array" }, "archivation_reason": { "description": "Archivation reason details; null unless archived", "oneOf": [ { "$ref": "#/components/schemas/AtsApplicationsApplicationIdGetResponsesContentApplicationJsonSchemaDataArchivationReason" }, { "type": "null" } ] }, "archivation_reason_id": { "description": "Reason the application was archived; null unless archived", "format": "uuid", "type": [ "string", "null" ] }, "candidate": { "$ref": "#/components/schemas/AtsApplicationsApplicationIdGetResponsesContentApplicationJsonSchemaDataCandidate", "description": "Candidate details" }, "created_at": { "description": "Timestamp when the application was created", "format": "date-time", "type": "string" }, "created_by": { "description": "Unique identifier for the HRIS organization user who created the application", "format": "uuid", "type": [ "string", "null" ] }, "current_application_interview_plan_stage": { "description": "Current interview plan stage for the application", "oneOf": [ { "$ref": "#/components/schemas/AtsApplicationsApplicationIdGetResponsesContentApplicationJsonSchemaDataCurrentApplicationInterviewPlanStage" }, { "type": "null" } ] }, "hired_at": { "description": "Timestamp when the application reached the hired stage; null otherwise", "format": "date-time", "type": [ "string", "null" ] }, "id": { "description": "Unique identifier for the application", "format": "uuid", "type": "string" }, "job": { "$ref": "#/components/schemas/AtsApplicationsApplicationIdGetResponsesContentApplicationJsonSchemaDataJob", "description": "Job details" }, "job_board": { "description": "Job board where application originated", "oneOf": [ { "$ref": "#/components/schemas/AtsApplicationsApplicationIdGetResponsesContentApplicationJsonSchemaDataJobBoard" }, { "type": "null" } ] }, "job_employment_type": { "description": "Employment type associated with the application", "oneOf": [ { "$ref": "#/components/schemas/AtsApplicationsApplicationIdGetResponsesContentApplicationJsonSchemaDataJobEmploymentType" }, { "type": "null" } ] }, "job_posting": { "description": "Job posting details", "oneOf": [ { "$ref": "#/components/schemas/AtsApplicationsApplicationIdGetResponsesContentApplicationJsonSchemaDataJobPosting" }, { "type": "null" } ] }, "job_posting_publication": { "description": "Job posting publication details", "oneOf": [ { "$ref": "#/components/schemas/AtsApplicationsApplicationIdGetResponsesContentApplicationJsonSchemaDataJobPostingPublication" }, { "type": "null" } ] }, "job_posting_publication_state": { "description": "Current state of job posting publication", "oneOf": [ { "$ref": "#/components/schemas/AtsApplicationsApplicationIdGetResponsesContentApplicationJsonSchemaDataJobPostingPublicationState" }, { "type": "null" } ] }, "moved_to_current_stage_at": { "description": "Timestamp when the application moved to the current stage", "format": "date-time", "type": "string" }, "notes": { "description": "Notes on application", "items": { "$ref": "#/components/schemas/AtsApplicationsApplicationIdGetResponsesContentApplicationJsonSchemaDataNotesItems" }, "type": "array" }, "numeric_id": { "description": "Numeric identifier for the application", "type": "integer" }, "referral_form_submission": { "$ref": "#/components/schemas/AtsApplicationsApplicationIdGetResponsesContentApplicationJsonSchemaDataReferralFormSubmission", "description": "Referral form submission metadata" }, "referred_by": { "description": "Unique identifier for the HRIS organization user who referred the candidate", "format": "uuid", "type": [ "string", "null" ] }, "source_slug": { "description": "Source slug", "type": [ "string", "null" ] }, "submitter_ip_address": { "description": "IP address of the applicant who submitted the application", "type": [ "string", "null" ] }, "submitter_user_agent": { "description": "User agent of the applicant who submitted the application", "type": [ "string", "null" ] }, "updated_at": { "description": "Timestamp when the application was last updated", "format": "date-time", "type": "string" } }, "required": [ "id", "job", "notes", "hired_at", "candidate", "job_board", "created_at", "created_by", "numeric_id", "updated_at", "job_posting", "referred_by", "source_slug", "archivation_reason", "job_employment_type", "archivation_reason_id", "job_posting_publication", "referral_form_submission", "moved_to_current_stage_at", "job_posting_publication_state", "application_job_criterias_matchings", "all_application_interview_plan_stages", "application_automation_rule_executions", "current_application_interview_plan_stage" ], "title": "AtsApplicationsApplicationIdGetResponsesContentApplicationJsonSchemaData", "type": "object" }, "AtsApplicationsApplicationIdGetResponsesContentApplicationJsonSchemaDataAllApplicationInterviewPlanStagesItems": { "properties": { "entered_at": { "description": "Timestamp when the application entered this stage", "format": "date-time", "type": "string" }, "exited_at": { "description": "Timestamp when the application left this stage; null while the application is still in it", "format": "date-time", "type": [ "string", "null" ] }, "id": { "description": "Unique identifier for the application interview plan stage", "format": "uuid", "type": "string" }, "interview_plan_stage": { "oneOf": [ { "$ref": "#/components/schemas/AtsApplicationsApplicationIdGetResponsesContentApplicationJsonSchemaDataAllApplicationInterviewPlanStagesItemsInterviewPlanStage" }, { "type": "null" } ] }, "is_current": { "description": "Whether this is the stage the application is currently in", "type": "boolean" }, "moved_by_hris_organization_user_id": { "description": "HRIS organization user who moved the application into this stage; null for automated moves", "format": "uuid", "type": [ "string", "null" ] }, "offers": { "description": "Array of offers associated with this stage", "items": { "$ref": "#/components/schemas/AtsApplicationsApplicationIdGetResponsesContentApplicationJsonSchemaDataAllApplicationInterviewPlanStagesItemsOffersItems" }, "type": "array" }, "updated_at": { "description": "Timestamp when the stage was last updated", "format": "date-time", "type": [ "string", "null" ] } }, "required": [ "id", "offers", "exited_at", "entered_at", "is_current", "updated_at", "interview_plan_stage", "moved_by_hris_organization_user_id" ], "title": "AtsApplicationsApplicationIdGetResponsesContentApplicationJsonSchemaDataAllApplicationInterviewPlanStagesItems", "type": "object" }, "AtsApplicationsApplicationIdGetResponsesContentApplicationJsonSchemaDataAllApplicationInterviewPlanStagesItemsInterviewPlanStage": { "properties": { "category_type_slug": { "description": "Category type slug", "type": "string" }, "default_type_slug": { "description": "Default type slug", "type": [ "string", "null" ] }, "id": { "description": "Interview plan stage unique identifier", "format": "uuid", "type": "string" }, "name": { "description": "Interview plan stage name", "type": "string" }, "position_number": { "description": "Position of the stage in the interview plan", "type": "integer" } }, "required": [ "id", "name", "position_number", "default_type_slug", "category_type_slug" ], "title": "AtsApplicationsApplicationIdGetResponsesContentApplicationJsonSchemaDataAllApplicationInterviewPlanStagesItemsInterviewPlanStage", "type": "object" }, "AtsApplicationsApplicationIdGetResponsesContentApplicationJsonSchemaDataAllApplicationInterviewPlanStagesItemsOffersItems": { "description": "Offer details", "properties": { "application_interview_plan_stage_id": { "description": "Unique identifier for the application interview plan stage", "format": "uuid", "type": "string" }, "approval_request_id": { "description": "Unique identifier for the approval request", "format": "uuid", "type": [ "string", "null" ] }, "approval_rule_id": { "description": "Unique identifier for the approval rule", "format": "uuid", "type": [ "string", "null" ] }, "attachment_id": { "description": "Unique identifier for the offer attachment", "format": "uuid", "type": [ "string", "null" ] }, "compensation_amount": { "description": "Compensation amount", "format": "double", "type": "number" }, "compensation_currency": { "description": "Currency code for compensation (ISO 4217)", "type": "string" }, "compensation_period_slug": { "description": "Compensation period", "oneOf": [ { "$ref": "#/components/schemas/AtsApplicationsApplicationIdGetResponsesContentApplicationJsonSchemaDataAllApplicationInterviewPlanStagesItemsOffersItemsCompensationPeriodSlug" }, { "type": "null" } ] }, "country_code": { "description": "Country code (ISO 3166-1 alpha-2)", "type": "string" }, "created_at": { "description": "Timestamp when the offer was created", "format": "date-time", "type": "string" }, "email": { "description": "Email message associated with the offer", "oneOf": [ { "$ref": "#/components/schemas/AtsApplicationsApplicationIdGetResponsesContentApplicationJsonSchemaDataAllApplicationInterviewPlanStagesItemsOffersItemsEmail" }, { "type": "null" } ] }, "id": { "description": "Unique identifier for the offer", "format": "uuid", "type": "string" }, "job_title": { "description": "Job title for the offer", "type": "string" }, "offer_status_enum": { "$ref": "#/components/schemas/AtsApplicationsApplicationIdGetResponsesContentApplicationJsonSchemaDataAllApplicationInterviewPlanStagesItemsOffersItemsOfferStatusEnum", "description": "Status of the offer" }, "rejection_reason_id": { "description": "Unique identifier for the rejection reason (if rejected)", "format": "uuid", "type": [ "string", "null" ] }, "start_date": { "description": "Start date for the position", "format": "date-time", "type": "string" }, "updated_at": { "description": "Timestamp when the offer was last updated", "format": "date-time", "type": "string" }, "worker_type_enum": { "$ref": "#/components/schemas/AtsApplicationsApplicationIdGetResponsesContentApplicationJsonSchemaDataAllApplicationInterviewPlanStagesItemsOffersItemsWorkerTypeEnum", "description": "Type of worker for the offer" } }, "required": [ "id", "job_title", "created_at", "start_date", "updated_at", "country_code", "attachment_id", "approval_rule_id", "worker_type_enum", "offer_status_enum", "approval_request_id", "compensation_amount", "rejection_reason_id", "compensation_currency", "compensation_period_slug", "application_interview_plan_stage_id" ], "title": "AtsApplicationsApplicationIdGetResponsesContentApplicationJsonSchemaDataAllApplicationInterviewPlanStagesItemsOffersItems", "type": "object" }, "AtsApplicationsApplicationIdGetResponsesContentApplicationJsonSchemaDataAllApplicationInterviewPlanStagesItemsOffersItemsCompensationPeriodSlug": { "description": "Compensation period", "enum": [ "ANNUALLY", "MONTHLY", "SEMIMONTHLY", "BIWEEKLY", "WEEKLY", "DAILY", "HOURLY" ], "title": "AtsApplicationsApplicationIdGetResponsesContentApplicationJsonSchemaDataAllApplicationInterviewPlanStagesItemsOffersItemsCompensationPeriodSlug", "type": "string" }, "AtsApplicationsApplicationIdGetResponsesContentApplicationJsonSchemaDataAllApplicationInterviewPlanStagesItemsOffersItemsEmail": { "description": "Email message associated with the offer", "properties": { "body_html": { "description": "HTML body of the email", "type": "string" }, "from_string": { "description": "Email sender address", "type": "string" }, "id": { "description": "Unique identifier for the email message", "format": "uuid", "type": "string" }, "recipients_bcc": { "description": "Array of BCC recipient email addresses", "items": { "type": "string" }, "type": "array" }, "recipients_cc": { "description": "Array of CC recipient email addresses", "items": { "type": "string" }, "type": "array" }, "recipients_to": { "description": "Array of recipient email addresses", "items": { "type": "string" }, "type": "array" }, "subject": { "description": "Email subject line", "type": "string" } }, "required": [ "id", "subject", "body_html", "from_string", "recipients_cc", "recipients_to", "recipients_bcc" ], "title": "AtsApplicationsApplicationIdGetResponsesContentApplicationJsonSchemaDataAllApplicationInterviewPlanStagesItemsOffersItemsEmail", "type": "object" }, "AtsApplicationsApplicationIdGetResponsesContentApplicationJsonSchemaDataAllApplicationInterviewPlanStagesItemsOffersItemsOfferStatusEnum": { "description": "Status of the offer", "enum": [ "CREATED", "WAITING_FOR_APPROVAL", "APPROVED", "NOT_APPROVED", "SENT", "EXPIRED", "ACCEPTED", "REJECTED" ], "title": "AtsApplicationsApplicationIdGetResponsesContentApplicationJsonSchemaDataAllApplicationInterviewPlanStagesItemsOffersItemsOfferStatusEnum", "type": "string" }, "AtsApplicationsApplicationIdGetResponsesContentApplicationJsonSchemaDataAllApplicationInterviewPlanStagesItemsOffersItemsWorkerTypeEnum": { "description": "Type of worker for the offer", "enum": [ "CONTRACTOR", "DIRECT_EMPLOYEE", "EOR_EMPLOYEE", "GLOBAL_PAYROLL_EMPLOYEE", "PEO_EMPLOYEE", "UNKNOWN" ], "title": "AtsApplicationsApplicationIdGetResponsesContentApplicationJsonSchemaDataAllApplicationInterviewPlanStagesItemsOffersItemsWorkerTypeEnum", "type": "string" }, "AtsApplicationsApplicationIdGetResponsesContentApplicationJsonSchemaDataApplicationAutomationRuleExecutionsItems": { "description": "Application automation rule execution", "properties": { "action_type_enum": { "$ref": "#/components/schemas/AtsApplicationsApplicationIdGetResponsesContentApplicationJsonSchemaDataApplicationAutomationRuleExecutionsItemsActionTypeEnum", "description": "Type of action to execute" }, "application_automation_rule_id": { "description": "Automation rule identifier", "format": "uuid", "type": "string" }, "evaluation_result": { "description": "Array of evaluation results", "items": { "$ref": "#/components/schemas/AtsApplicationsApplicationIdGetResponsesContentApplicationJsonSchemaDataApplicationAutomationRuleExecutionsItemsEvaluationResultItems" }, "type": "array" }, "id": { "description": "Unique identifier for the automation rule execution", "format": "uuid", "type": "string" } }, "required": [ "id", "action_type_enum", "evaluation_result", "application_automation_rule_id" ], "title": "AtsApplicationsApplicationIdGetResponsesContentApplicationJsonSchemaDataApplicationAutomationRuleExecutionsItems", "type": "object" }, "AtsApplicationsApplicationIdGetResponsesContentApplicationJsonSchemaDataApplicationAutomationRuleExecutionsItemsActionTypeEnum": { "description": "Type of action to execute", "enum": [ "ADD_CANDIDATE_TAG", "TRANSITION_APPLICATION" ], "title": "AtsApplicationsApplicationIdGetResponsesContentApplicationJsonSchemaDataApplicationAutomationRuleExecutionsItemsActionTypeEnum", "type": "string" }, "AtsApplicationsApplicationIdGetResponsesContentApplicationJsonSchemaDataApplicationAutomationRuleExecutionsItemsEvaluationResultItems": { "description": "Evaluation result for automation rule", "properties": { "comparison_value": { "description": "Value to compare against", "type": "string" }, "form_builder_question_data_binding_id": { "description": "Form builder question data binding identifier", "type": "string" }, "group_id": { "description": "Group identifier for the condition", "type": "integer" }, "id": { "description": "Unique identifier for the evaluation result", "format": "uuid", "type": "string" }, "is_condition_met": { "description": "Whether the condition is met", "type": "boolean" }, "operator_enum": { "$ref": "#/components/schemas/AtsApplicationsApplicationIdGetResponsesContentApplicationJsonSchemaDataApplicationAutomationRuleExecutionsItemsEvaluationResultItemsOperatorEnum", "description": "Comparison operator" } }, "required": [ "id", "group_id", "operator_enum", "comparison_value", "is_condition_met", "form_builder_question_data_binding_id" ], "title": "AtsApplicationsApplicationIdGetResponsesContentApplicationJsonSchemaDataApplicationAutomationRuleExecutionsItemsEvaluationResultItems", "type": "object" }, "AtsApplicationsApplicationIdGetResponsesContentApplicationJsonSchemaDataApplicationAutomationRuleExecutionsItemsEvaluationResultItemsOperatorEnum": { "description": "Comparison operator", "enum": [ "EQUALS", "NOT_EQUALS", "CONTAINS", "DOES_NOT_CONTAIN", "IS_EMPTY", "IS_NOT_EMPTY", "GREATER_THAN", "GREATER_THAN_OR_EQUAL", "LESS_THAN", "LESS_THAN_OR_EQUAL" ], "title": "AtsApplicationsApplicationIdGetResponsesContentApplicationJsonSchemaDataApplicationAutomationRuleExecutionsItemsEvaluationResultItemsOperatorEnum", "type": "string" }, "AtsApplicationsApplicationIdGetResponsesContentApplicationJsonSchemaDataApplicationFormSubmission": { "description": "Application form submission data with mapped answers", "properties": { "answers": { "description": "Array of question answers with parsed data", "items": { "$ref": "#/components/schemas/AtsApplicationsApplicationIdGetResponsesContentApplicationJsonSchemaDataApplicationFormSubmissionAnswersItems" }, "type": "array" }, "id": { "description": "Identifier of the application form submission", "format": "uuid", "type": "string" } }, "required": [ "id", "answers" ], "title": "AtsApplicationsApplicationIdGetResponsesContentApplicationJsonSchemaDataApplicationFormSubmission", "type": "object" }, "AtsApplicationsApplicationIdGetResponsesContentApplicationJsonSchemaDataApplicationFormSubmissionAnswersItems": { "description": "Form submission answer", "properties": { "answer": { "$ref": "#/components/schemas/AtsApplicationsApplicationIdGetResponsesContentApplicationJsonSchemaDataApplicationFormSubmissionAnswersItemsAnswer", "description": "The answer value" }, "data_binding_id": { "description": "Data binding identifier for the question", "type": "string" }, "question_text": { "description": "Text of the question", "type": "string" }, "question_type": { "$ref": "#/components/schemas/AtsApplicationsApplicationIdGetResponsesContentApplicationJsonSchemaDataApplicationFormSubmissionAnswersItemsQuestionType", "description": "Type of the question (uppercase)" } }, "required": [ "answer", "question_text", "question_type", "data_binding_id" ], "title": "AtsApplicationsApplicationIdGetResponsesContentApplicationJsonSchemaDataApplicationFormSubmissionAnswersItems", "type": "object" }, "AtsApplicationsApplicationIdGetResponsesContentApplicationJsonSchemaDataApplicationFormSubmissionAnswersItemsAnswer": { "description": "The answer value", "oneOf": [ { "type": "string" }, { "format": "double", "type": "number" } ], "title": "AtsApplicationsApplicationIdGetResponsesContentApplicationJsonSchemaDataApplicationFormSubmissionAnswersItemsAnswer" }, "AtsApplicationsApplicationIdGetResponsesContentApplicationJsonSchemaDataApplicationFormSubmissionAnswersItemsQuestionType": { "description": "Type of the question (uppercase)", "enum": [ "FREETEXT", "PARAGRAPH", "SINGLESELECTION", "MULTISELECTION", "DOCUMENTUPLOAD", "PRESETDROPDOWN", "CUSTOMDROPDOWN", "NUMBER", "DATEPICKER", "ADDRESS", "PHONENUMBER", "EMAIL" ], "title": "AtsApplicationsApplicationIdGetResponsesContentApplicationJsonSchemaDataApplicationFormSubmissionAnswersItemsQuestionType", "type": "string" }, "AtsApplicationsApplicationIdGetResponsesContentApplicationJsonSchemaDataApplicationJobCriteriasMatchingsItems": { "properties": { "description": { "description": "Match description", "type": "string" }, "id": { "description": "Job criteria matching identifier", "format": "uuid", "type": "string" }, "is_matched": { "$ref": "#/components/schemas/AtsApplicationsApplicationIdGetResponsesContentApplicationJsonSchemaDataApplicationJobCriteriasMatchingsItemsIsMatched", "description": "Match status" }, "job_criteria": { "$ref": "#/components/schemas/AtsApplicationsApplicationIdGetResponsesContentApplicationJsonSchemaDataApplicationJobCriteriasMatchingsItemsJobCriteria" } }, "required": [ "id", "is_matched", "description", "job_criteria" ], "title": "AtsApplicationsApplicationIdGetResponsesContentApplicationJsonSchemaDataApplicationJobCriteriasMatchingsItems", "type": "object" }, "AtsApplicationsApplicationIdGetResponsesContentApplicationJsonSchemaDataApplicationJobCriteriasMatchingsItemsIsMatched": { "description": "Match status", "enum": [ "MATCHED", "NOT_MATCHED", "UNDECIDED" ], "title": "AtsApplicationsApplicationIdGetResponsesContentApplicationJsonSchemaDataApplicationJobCriteriasMatchingsItemsIsMatched", "type": "string" }, "AtsApplicationsApplicationIdGetResponsesContentApplicationJsonSchemaDataApplicationJobCriteriasMatchingsItemsJobCriteria": { "properties": { "description": { "description": "Job criteria description", "type": "string" }, "id": { "description": "Job criteria identifier", "format": "uuid", "type": "string" }, "title": { "description": "Job criteria title", "type": "string" } }, "required": [ "id", "title", "description" ], "title": "AtsApplicationsApplicationIdGetResponsesContentApplicationJsonSchemaDataApplicationJobCriteriasMatchingsItemsJobCriteria", "type": "object" }, "AtsApplicationsApplicationIdGetResponsesContentApplicationJsonSchemaDataArchivationReason": { "description": "Archivation reason details; null unless archived", "properties": { "id": { "description": "Archivation reason identifier", "format": "uuid", "type": "string" }, "label": { "description": "Archivation reason label", "type": "string" } }, "required": [ "id", "label" ], "title": "AtsApplicationsApplicationIdGetResponsesContentApplicationJsonSchemaDataArchivationReason", "type": "object" }, "AtsApplicationsApplicationIdGetResponsesContentApplicationJsonSchemaDataCandidate": { "description": "Candidate details", "properties": { "attachments": { "description": "Array of attachments associated with the candidate (e.g., resume, cover letter)", "items": { "$ref": "#/components/schemas/AtsApplicationsApplicationIdGetResponsesContentApplicationJsonSchemaDataCandidateAttachmentsItems" }, "type": "array" }, "candidate_tags": { "description": "Tags associated with the candidate", "items": { "$ref": "#/components/schemas/AtsApplicationsApplicationIdGetResponsesContentApplicationJsonSchemaDataCandidateCandidateTagsItems" }, "type": "array" }, "city": { "description": "Candidate city", "type": [ "string", "null" ] }, "country_code": { "description": "Candidate country code (ISO 3166-1 alpha-2)", "type": [ "string", "null" ] }, "email": { "description": "Candidate email address", "format": "email", "type": "string" }, "first_name": { "description": "Candidate first name", "type": "string" }, "id": { "description": "Candidate unique identifier", "format": "uuid", "type": "string" }, "import_session_id": { "description": "Import session identifier if bulk imported", "type": [ "string", "null" ] }, "last_name": { "description": "Candidate last name", "type": "string" }, "phone_number": { "description": "Candidate phone number", "type": [ "string", "null" ] }, "profile_picture_url": { "description": "Candidate profile picture URL", "type": [ "string", "null" ] } }, "required": [ "id", "email", "last_name", "first_name", "attachments", "phone_number", "candidate_tags", "import_session_id", "profile_picture_url" ], "title": "AtsApplicationsApplicationIdGetResponsesContentApplicationJsonSchemaDataCandidate", "type": "object" }, "AtsApplicationsApplicationIdGetResponsesContentApplicationJsonSchemaDataCandidateAttachmentsItems": { "properties": { "ai_summary": { "description": "AI-generated summary of the attachment content", "type": [ "string", "null" ] }, "id": { "description": "Unique identifier for the attachment", "format": "uuid", "type": "string" } }, "required": [ "id", "ai_summary" ], "title": "AtsApplicationsApplicationIdGetResponsesContentApplicationJsonSchemaDataCandidateAttachmentsItems", "type": "object" }, "AtsApplicationsApplicationIdGetResponsesContentApplicationJsonSchemaDataCandidateCandidateTagsItems": { "description": "Candidate tag", "properties": { "id": { "description": "Unique identifier for the candidate tag", "format": "uuid", "type": "string" }, "tag": { "$ref": "#/components/schemas/AtsApplicationsApplicationIdGetResponsesContentApplicationJsonSchemaDataCandidateCandidateTagsItemsTag", "description": "Tag details" } }, "required": [ "id", "tag" ], "title": "AtsApplicationsApplicationIdGetResponsesContentApplicationJsonSchemaDataCandidateCandidateTagsItems", "type": "object" }, "AtsApplicationsApplicationIdGetResponsesContentApplicationJsonSchemaDataCandidateCandidateTagsItemsTag": { "description": "Tag details", "properties": { "id": { "description": "Unique identifier for the tag", "format": "uuid", "type": "string" }, "label": { "description": "Label of the tag", "type": "string" } }, "required": [ "id", "label" ], "title": "AtsApplicationsApplicationIdGetResponsesContentApplicationJsonSchemaDataCandidateCandidateTagsItemsTag", "type": "object" }, "AtsApplicationsApplicationIdGetResponsesContentApplicationJsonSchemaDataCurrentApplicationInterviewPlanStage": { "description": "Current interview plan stage for the application", "properties": { "id": { "description": "Identifier of the application interview plan stage record", "format": "uuid", "type": "string" }, "interview_plan_stage": { "oneOf": [ { "$ref": "#/components/schemas/AtsApplicationsApplicationIdGetResponsesContentApplicationJsonSchemaDataCurrentApplicationInterviewPlanStageInterviewPlanStage" }, { "type": "null" } ] } }, "required": [ "id", "interview_plan_stage" ], "title": "AtsApplicationsApplicationIdGetResponsesContentApplicationJsonSchemaDataCurrentApplicationInterviewPlanStage", "type": "object" }, "AtsApplicationsApplicationIdGetResponsesContentApplicationJsonSchemaDataCurrentApplicationInterviewPlanStageInterviewPlanStage": { "properties": { "category_type_slug": { "description": "Category type slug", "type": "string" }, "default_type_slug": { "description": "Default type slug", "type": [ "string", "null" ] }, "id": { "description": "Interview plan stage unique identifier", "format": "uuid", "type": "string" }, "name": { "description": "Interview plan stage name", "type": "string" }, "position_number": { "description": "Position of the stage in the interview plan", "type": "integer" } }, "required": [ "id", "name", "position_number", "default_type_slug", "category_type_slug" ], "title": "AtsApplicationsApplicationIdGetResponsesContentApplicationJsonSchemaDataCurrentApplicationInterviewPlanStageInterviewPlanStage", "type": "object" }, "AtsApplicationsApplicationIdGetResponsesContentApplicationJsonSchemaDataJob": { "description": "Job details", "properties": { "id": { "description": "Unique identifier for the job", "format": "uuid", "type": "string" }, "title": { "description": "Title of the job", "type": "string" } }, "required": [ "id", "title" ], "title": "AtsApplicationsApplicationIdGetResponsesContentApplicationJsonSchemaDataJob", "type": "object" }, "AtsApplicationsApplicationIdGetResponsesContentApplicationJsonSchemaDataJobBoard": { "description": "Job board where application originated", "properties": { "id": { "description": "Job board unique identifier", "format": "uuid", "type": "string" }, "type": { "$ref": "#/components/schemas/AtsApplicationsApplicationIdGetResponsesContentApplicationJsonSchemaDataJobBoardType", "description": "Type of job board" } }, "required": [ "id", "type" ], "title": "AtsApplicationsApplicationIdGetResponsesContentApplicationJsonSchemaDataJobBoard", "type": "object" }, "AtsApplicationsApplicationIdGetResponsesContentApplicationJsonSchemaDataJobBoardType": { "description": "Type of job board", "enum": [ "INTERNAL_CAREER_PAGE", "EXTERNAL_CAREER_PAGE", "LINKEDIN" ], "title": "AtsApplicationsApplicationIdGetResponsesContentApplicationJsonSchemaDataJobBoardType", "type": "string" }, "AtsApplicationsApplicationIdGetResponsesContentApplicationJsonSchemaDataJobEmploymentType": { "description": "Employment type associated with the application", "properties": { "employment_type": { "$ref": "#/components/schemas/AtsApplicationsApplicationIdGetResponsesContentApplicationJsonSchemaDataJobEmploymentTypeEmploymentType", "description": "Employment type metadata" }, "id": { "description": "Identifier of the job employment type record", "format": "uuid", "type": "string" } }, "required": [ "id", "employment_type" ], "title": "AtsApplicationsApplicationIdGetResponsesContentApplicationJsonSchemaDataJobEmploymentType", "type": "object" }, "AtsApplicationsApplicationIdGetResponsesContentApplicationJsonSchemaDataJobEmploymentTypeEmploymentType": { "description": "Employment type metadata", "properties": { "id": { "description": "Identifier of the employment type", "format": "uuid", "type": "string" }, "name": { "description": "Human readable employment type", "type": "string" } }, "required": [ "id", "name" ], "title": "AtsApplicationsApplicationIdGetResponsesContentApplicationJsonSchemaDataJobEmploymentTypeEmploymentType", "type": "object" }, "AtsApplicationsApplicationIdGetResponsesContentApplicationJsonSchemaDataJobPosting": { "description": "Job posting details", "properties": { "id": { "description": "Unique identifier for the job posting", "format": "uuid", "type": "string" }, "title": { "description": "Title of the job posting", "type": "string" } }, "required": [ "id", "title" ], "title": "AtsApplicationsApplicationIdGetResponsesContentApplicationJsonSchemaDataJobPosting", "type": "object" }, "AtsApplicationsApplicationIdGetResponsesContentApplicationJsonSchemaDataJobPostingPublication": { "description": "Job posting publication details", "properties": { "id": { "description": "Job posting publication unique identifier", "format": "uuid", "type": "string" } }, "required": [ "id" ], "title": "AtsApplicationsApplicationIdGetResponsesContentApplicationJsonSchemaDataJobPostingPublication", "type": "object" }, "AtsApplicationsApplicationIdGetResponsesContentApplicationJsonSchemaDataJobPostingPublicationState": { "description": "Current state of job posting publication", "properties": { "id": { "description": "Job posting publication state identifier", "format": "uuid", "type": "string" }, "state_slug": { "$ref": "#/components/schemas/AtsApplicationsApplicationIdGetResponsesContentApplicationJsonSchemaDataJobPostingPublicationStateStateSlug", "description": "State of job posting publication" } }, "required": [ "id", "state_slug" ], "title": "AtsApplicationsApplicationIdGetResponsesContentApplicationJsonSchemaDataJobPostingPublicationState", "type": "object" }, "AtsApplicationsApplicationIdGetResponsesContentApplicationJsonSchemaDataJobPostingPublicationStateStateSlug": { "description": "State of job posting publication", "enum": [ "PUBLISHED_BASIC", "PUBLISHED_PREMIUM", "UNPUBLISHED", "EXPIRED", "IN_PROGRESS", "FAILED" ], "title": "AtsApplicationsApplicationIdGetResponsesContentApplicationJsonSchemaDataJobPostingPublicationStateStateSlug", "type": "string" }, "AtsApplicationsApplicationIdGetResponsesContentApplicationJsonSchemaDataNotesItems": { "description": "Note associated with the application", "properties": { "created_at": { "description": "Timestamp when the note was created", "format": "date-time", "type": "string" }, "created_by": { "description": "Unique identifier for the user who created the note", "format": "uuid", "type": "string" }, "id": { "description": "Unique identifier for the note", "format": "uuid", "type": "string" }, "richtext_content": { "description": "Rich text content of the note", "type": "string" }, "updated_at": { "description": "Timestamp when the note was last updated", "format": "date-time", "type": "string" } }, "required": [ "id", "created_at", "created_by", "updated_at", "richtext_content" ], "title": "AtsApplicationsApplicationIdGetResponsesContentApplicationJsonSchemaDataNotesItems", "type": "object" }, "AtsApplicationsApplicationIdGetResponsesContentApplicationJsonSchemaDataReferralFormSubmission": { "description": "Referral form submission metadata", "properties": { "form_builder_stringified": { "description": "Stringified JSON data for the referral form submission", "type": [ "string", "null" ] }, "id": { "description": "Identifier of the referral form submission", "format": "uuid", "type": [ "string", "null" ] } }, "required": [ "id", "form_builder_stringified" ], "title": "AtsApplicationsApplicationIdGetResponsesContentApplicationJsonSchemaDataReferralFormSubmission", "type": "object" }, "AtsApplicationsApplicationIdGetResponsesContentApplicationJsonSchemaErrorsItems": { "properties": { "code": { "description": "Machine-readable error code", "type": "string" }, "field": { "description": "Request field related to the error, if applicable", "type": "string" }, "message": { "description": "Human-readable error message", "type": "string" } }, "required": [ "code", "message" ], "title": "AtsApplicationsApplicationIdGetResponsesContentApplicationJsonSchemaErrorsItems", "type": "object" }, "AtsApplicationsApplicationIdInterviewPlanStagesPostRequestBodyContentApplicationJsonSchemaData": { "properties": { "applicable_job_activities": { "description": "Optional array of job activities to trigger when associating the application with this stage. If not provided, all activities will be triggered. If an empty array is provided, no activities will be triggered.", "items": { "$ref": "#/components/schemas/AtsApplicationsApplicationIdInterviewPlanStagesPostRequestBodyContentApplicationJsonSchemaDataApplicableJobActivitiesItems" }, "type": "array" }, "candidate_archivation_email_template_id": { "description": "Optional ID of the rejection email template if the candidate is being archived", "format": "uuid", "type": "string" }, "candidate_archivation_reason_id": { "description": "Optional ID of the archivation reason if the candidate is being archived", "format": "uuid", "type": "string" }, "creator_id": { "description": "HRIS Organization User ID of the user creating the resource", "format": "uuid", "type": "string" }, "delay_amount": { "description": "The amount of time to delay the archivation email. Must be provided together with delay_unit. Cannot be used together with scheduled_send_at.", "maximum": 100, "minimum": 1, "type": "integer" }, "delay_unit": { "$ref": "#/components/schemas/AtsApplicationsApplicationIdInterviewPlanStagesPostRequestBodyContentApplicationJsonSchemaDataDelayUnit", "description": "The unit of time for the delay. Must be provided together with delay_amount. Cannot be used together with scheduled_send_at." }, "interview_plan_stage_id": { "description": "The ID of the interview plan stage to associate with the application", "format": "uuid", "type": "string" }, "is_current_stage": { "description": "When true, sets this stage as the application's current stage in the hiring workflow. When false, creates a historical record without changing the application's current stage.", "type": "boolean" }, "scheduled_send_at": { "description": "The exact future datetime to send the archivation email. Cannot be used together with delay_amount/delay_unit.", "format": "date-time", "type": "string" } }, "required": [ "creator_id", "is_current_stage", "interview_plan_stage_id" ], "title": "AtsApplicationsApplicationIdInterviewPlanStagesPostRequestBodyContentApplicationJsonSchemaData", "type": "object" }, "AtsApplicationsApplicationIdInterviewPlanStagesPostRequestBodyContentApplicationJsonSchemaDataApplicableJobActivitiesItems": { "properties": { "candidate_self_scheduling_email_template_id": { "description": "Optional custom email template ID for candidate self-scheduling (only applicable for interview scheduling activities)", "format": "uuid", "type": "string" }, "id": { "description": "The ID of the job activity to trigger", "format": "uuid", "type": "string" }, "participants": { "description": "Optional array of custom participants for this activity. If not provided, the default participants from the job activity template will be used.", "items": { "$ref": "#/components/schemas/AtsApplicationsApplicationIdInterviewPlanStagesPostRequestBodyContentApplicationJsonSchemaDataApplicableJobActivitiesItemsParticipantsItems" }, "type": "array" } }, "required": [ "id" ], "title": "AtsApplicationsApplicationIdInterviewPlanStagesPostRequestBodyContentApplicationJsonSchemaDataApplicableJobActivitiesItems", "type": "object" }, "AtsApplicationsApplicationIdInterviewPlanStagesPostRequestBodyContentApplicationJsonSchemaDataApplicableJobActivitiesItemsParticipantsItems": { "properties": { "participant_hris_organization_user_id": { "description": "The HRIS organization user ID of the participant", "format": "uuid", "type": "string" }, "role_slug": { "$ref": "#/components/schemas/AtsApplicationsApplicationIdInterviewPlanStagesPostRequestBodyContentApplicationJsonSchemaDataApplicableJobActivitiesItemsParticipantsItemsRoleSlug", "description": "The role of the participant in the activity" } }, "required": [ "role_slug", "participant_hris_organization_user_id" ], "title": "AtsApplicationsApplicationIdInterviewPlanStagesPostRequestBodyContentApplicationJsonSchemaDataApplicableJobActivitiesItemsParticipantsItems", "type": "object" }, "AtsApplicationsApplicationIdInterviewPlanStagesPostRequestBodyContentApplicationJsonSchemaDataApplicableJobActivitiesItemsParticipantsItemsRoleSlug": { "description": "The role of the participant in the activity", "enum": [ "REVIEWER", "INTERVIEWER" ], "title": "AtsApplicationsApplicationIdInterviewPlanStagesPostRequestBodyContentApplicationJsonSchemaDataApplicableJobActivitiesItemsParticipantsItemsRoleSlug", "type": "string" }, "AtsApplicationsApplicationIdInterviewPlanStagesPostRequestBodyContentApplicationJsonSchemaDataDelayUnit": { "description": "The unit of time for the delay. Must be provided together with delay_amount. Cannot be used together with scheduled_send_at.", "enum": [ "hours", "days", "weeks" ], "title": "AtsApplicationsApplicationIdInterviewPlanStagesPostRequestBodyContentApplicationJsonSchemaDataDelayUnit", "type": "string" }, "AtsApplicationsApplicationIdInterviewPlanStagesPostResponsesContentApplicationJsonSchemaData": { "description": "The created application interview plan stage record", "properties": { "created_at": { "description": "The timestamp when the record was created", "format": "date-time", "type": "string" }, "id": { "description": "The unique identifier of the created application interview plan stage record", "format": "uuid", "type": "string" }, "updated_at": { "description": "The timestamp when the record was last updated", "format": "date-time", "type": "string" } }, "required": [ "id", "created_at", "updated_at" ], "title": "AtsApplicationsApplicationIdInterviewPlanStagesPostResponsesContentApplicationJsonSchemaData", "type": "object" }, "AtsApplicationsApplicationIdInterviewPlanStagesPostResponsesContentApplicationJsonSchemaErrorsItems": { "properties": { "code": { "description": "Machine-readable error code", "type": "string" }, "field": { "description": "Request field related to the error, if applicable", "type": "string" }, "message": { "description": "Human-readable error message", "type": "string" } }, "required": [ "code", "message" ], "title": "AtsApplicationsApplicationIdInterviewPlanStagesPostResponsesContentApplicationJsonSchemaErrorsItems", "type": "object" }, "AtsApplicationsApplicationIdNotesPostRequestBodyContentApplicationJsonSchemaData": { "properties": { "author_id": { "description": "The UUID of the HRIS organization user creating the note", "format": "uuid", "type": "string" }, "richtext_content": { "description": "The content of the note in rich text HTML format", "type": "string" } }, "required": [ "author_id", "richtext_content" ], "title": "AtsApplicationsApplicationIdNotesPostRequestBodyContentApplicationJsonSchemaData", "type": "object" }, "AtsApplicationsApplicationIdNotesPostResponsesContentApplicationJsonSchemaData": { "description": "The created application note", "properties": { "created_at": { "description": "The timestamp when the application note was created", "format": "date-time", "type": "string" }, "id": { "description": "The unique identifier of the application note", "format": "uuid", "type": "string" }, "updated_at": { "description": "The timestamp when the application note was last updated", "format": "date-time", "type": "string" } }, "required": [ "id", "created_at", "updated_at" ], "title": "AtsApplicationsApplicationIdNotesPostResponsesContentApplicationJsonSchemaData", "type": "object" }, "AtsApplicationsApplicationIdNotesPostResponsesContentApplicationJsonSchemaErrorsItems": { "properties": { "code": { "description": "Machine-readable error code", "type": "string" }, "field": { "description": "Request field related to the error, if applicable", "type": "string" }, "message": { "description": "Human-readable error message", "type": "string" } }, "required": [ "code", "message" ], "title": "AtsApplicationsApplicationIdNotesPostResponsesContentApplicationJsonSchemaErrorsItems", "type": "object" }, "AtsApplicationsApplicationIdPatchRequestBodyContentApplicationJsonSchemaData": { "properties": { "source_slug": { "description": "The application source. Accepts any active source slug of the organization, e.g. SOURCED_INTERNALLY, SOURCED_EXTERNALLY, INTERNAL_REFERRAL_AWARE, INTERNAL_REFERRAL_NOT_AWARE, EXTERNAL_CAREER_PAGE or a custom source slug (case-insensitive)", "type": "string" } }, "required": [ "source_slug" ], "title": "AtsApplicationsApplicationIdPatchRequestBodyContentApplicationJsonSchemaData", "type": "object" }, "AtsApplicationsApplicationIdPatchResponsesContentApplicationJsonSchemaData": { "properties": { "id": { "description": "Application unique identifier", "format": "uuid", "type": "string" }, "source_slug": { "description": "The application source slug in uppercase", "type": [ "string", "null" ] }, "updated_at": { "description": "Last update timestamp", "format": "date-time", "type": "string" } }, "required": [ "id", "updated_at", "source_slug" ], "title": "AtsApplicationsApplicationIdPatchResponsesContentApplicationJsonSchemaData", "type": "object" }, "AtsApplicationsApplicationIdPatchResponsesContentApplicationJsonSchemaErrorsItems": { "properties": { "code": { "description": "Machine-readable error code", "type": "string" }, "field": { "description": "Request field related to the error, if applicable", "type": "string" }, "message": { "description": "Human-readable error message", "type": "string" } }, "required": [ "code", "message" ], "title": "AtsApplicationsApplicationIdPatchResponsesContentApplicationJsonSchemaErrorsItems", "type": "object" }, "AtsApplicationsGetParametersCandidateTagIdsOperator": { "enum": [ "ANY", "ALL" ], "title": "AtsApplicationsGetParametersCandidateTagIdsOperator", "type": "string" }, "AtsApplicationsGetParametersIncludeSchemaItems": { "enum": [ "STAGE_HISTORY" ], "title": "AtsApplicationsGetParametersIncludeSchemaItems", "type": "string" }, "AtsApplicationsGetParametersJobCriteriasMatchingsSchemaItems": { "properties": { "is_matched": { "$ref": "#/components/schemas/AtsApplicationsGetParametersJobCriteriasMatchingsSchemaItemsIsMatched" }, "job_criteria_id": { "format": "uuid", "type": "string" } }, "required": [ "is_matched", "job_criteria_id" ], "title": "AtsApplicationsGetParametersJobCriteriasMatchingsSchemaItems", "type": "object" }, "AtsApplicationsGetParametersJobCriteriasMatchingsSchemaItemsIsMatched": { "enum": [ "MATCHED", "NOT_MATCHED", "UNDECIDED" ], "title": "AtsApplicationsGetParametersJobCriteriasMatchingsSchemaItemsIsMatched", "type": "string" }, "AtsApplicationsGetParametersSortBy": { "enum": [ "APPLICATION_CREATION_DATE", "STAGE_CREATION_DATE" ], "title": "AtsApplicationsGetParametersSortBy", "type": "string" }, "AtsApplicationsGetParametersSortOrder": { "enum": [ "ASC", "DESC" ], "title": "AtsApplicationsGetParametersSortOrder", "type": "string" }, "AtsApplicationsGetResponsesContentApplicationJsonSchemaDataItems": { "description": "Application object", "properties": { "application_form_form_builder_form_submission_id": { "description": "Application form submission unique identifier", "format": "uuid", "type": [ "string", "null" ] }, "application_form_submission": { "description": "Application form submission data with parsed answers", "oneOf": [ { "$ref": "#/components/schemas/AtsApplicationsGetResponsesContentApplicationJsonSchemaDataItemsApplicationFormSubmission" }, { "type": "null" } ] }, "application_job_criterias_matchings": { "description": "AI-generated job criteria matching results for the application", "items": { "$ref": "#/components/schemas/AtsApplicationsGetResponsesContentApplicationJsonSchemaDataItemsApplicationJobCriteriasMatchingsItems" }, "type": "array" }, "archivation_reason_id": { "description": "Reason the application was archived; null unless archived", "format": "uuid", "type": [ "string", "null" ] }, "candidate": { "$ref": "#/components/schemas/AtsApplicationsGetResponsesContentApplicationJsonSchemaDataItemsCandidate", "description": "Candidate information associated with the application" }, "created_at": { "description": "Timestamp of when the application was created", "format": "date-time", "type": "string" }, "created_by_hris_organization_user_id": { "description": "User who created the application", "format": "uuid", "type": [ "string", "null" ] }, "current_application_interview_plan_stage": { "$ref": "#/components/schemas/AtsApplicationsGetResponsesContentApplicationJsonSchemaDataItemsCurrentApplicationInterviewPlanStage", "description": "Current interview plan stage information for the application" }, "current_application_interview_plan_stage_id": { "description": "Current interview plan stage unique identifier", "format": "uuid", "type": [ "string", "null" ] }, "hired_at": { "description": "Timestamp when the application reached the hired stage; null otherwise", "format": "date-time", "type": [ "string", "null" ] }, "id": { "description": "Application unique identifier", "format": "uuid", "type": "string" }, "job": { "$ref": "#/components/schemas/AtsApplicationsGetResponsesContentApplicationJsonSchemaDataItemsJob", "description": "Job information for the application" }, "job_employment_type": { "$ref": "#/components/schemas/AtsApplicationsGetResponsesContentApplicationJsonSchemaDataItemsJobEmploymentType", "description": "Employment type information for the job" }, "job_posting": { "description": "Job posting information (if application came through a posting)", "oneOf": [ { "$ref": "#/components/schemas/AtsApplicationsGetResponsesContentApplicationJsonSchemaDataItemsJobPosting" }, { "type": "null" } ] }, "moved_to_current_stage_at": { "description": "Timestamp of when the application moved to current stage", "format": "date-time", "type": "string" }, "numeric_id": { "description": "Application numeric identifier", "type": "integer" }, "source_slug": { "description": "Source of the application", "type": [ "string", "null" ] }, "stage_history": { "description": "Chronological stage timeline of the application. Present only when include=STAGE_HISTORY is requested.", "items": { "$ref": "#/components/schemas/AtsApplicationsGetResponsesContentApplicationJsonSchemaDataItemsStageHistoryItems" }, "type": "array" }, "submitter_ip_address": { "description": "IP address of the applicant who submitted the application", "type": [ "string", "null" ] }, "submitter_user_agent": { "description": "User agent of the applicant who submitted the application", "type": [ "string", "null" ] }, "updated_at": { "description": "Timestamp of when the application was last updated", "format": "date-time", "type": "string" } }, "required": [ "id", "created_at", "numeric_id", "moved_to_current_stage_at" ], "title": "AtsApplicationsGetResponsesContentApplicationJsonSchemaDataItems", "type": "object" }, "AtsApplicationsGetResponsesContentApplicationJsonSchemaDataItemsApplicationFormSubmission": { "description": "Application form submission data with parsed answers", "properties": { "answers": { "description": "Array of parsed form submission answers", "items": { "$ref": "#/components/schemas/AtsApplicationsGetResponsesContentApplicationJsonSchemaDataItemsApplicationFormSubmissionAnswersItems" }, "type": [ "array", "null" ] }, "id": { "description": "Identifier of the application form submission", "format": "uuid", "type": [ "string", "null" ] } }, "required": [ "id", "answers" ], "title": "AtsApplicationsGetResponsesContentApplicationJsonSchemaDataItemsApplicationFormSubmission", "type": "object" }, "AtsApplicationsGetResponsesContentApplicationJsonSchemaDataItemsApplicationFormSubmissionAnswersItems": { "description": "Parsed form submission answer", "properties": { "answer": { "$ref": "#/components/schemas/AtsApplicationsGetResponsesContentApplicationJsonSchemaDataItemsApplicationFormSubmissionAnswersItemsAnswer" }, "data_binding_id": { "description": "Data binding identifier for the question", "format": "uuid", "type": "string" }, "question_text": { "description": "Text of the question", "type": "string" }, "question_type": { "$ref": "#/components/schemas/AtsApplicationsGetResponsesContentApplicationJsonSchemaDataItemsApplicationFormSubmissionAnswersItemsQuestionType", "description": "Type of the question (uppercase)" } }, "required": [ "answer", "question_text", "question_type", "data_binding_id" ], "title": "AtsApplicationsGetResponsesContentApplicationJsonSchemaDataItemsApplicationFormSubmissionAnswersItems", "type": "object" }, "AtsApplicationsGetResponsesContentApplicationJsonSchemaDataItemsApplicationFormSubmissionAnswersItemsAnswer": { "oneOf": [ { "type": "string" }, { "format": "double", "type": "number" } ], "title": "AtsApplicationsGetResponsesContentApplicationJsonSchemaDataItemsApplicationFormSubmissionAnswersItemsAnswer" }, "AtsApplicationsGetResponsesContentApplicationJsonSchemaDataItemsApplicationFormSubmissionAnswersItemsQuestionType": { "description": "Type of the question (uppercase)", "enum": [ "FREETEXT", "PARAGRAPH", "SINGLESELECTION", "MULTISELECTION", "DOCUMENTUPLOAD", "PRESETDROPDOWN", "CUSTOMDROPDOWN", "NUMBER", "DATEPICKER", "ADDRESS", "PHONENUMBER", "EMAIL" ], "title": "AtsApplicationsGetResponsesContentApplicationJsonSchemaDataItemsApplicationFormSubmissionAnswersItemsQuestionType", "type": "string" }, "AtsApplicationsGetResponsesContentApplicationJsonSchemaDataItemsApplicationJobCriteriasMatchingsItems": { "description": "AI-generated job criteria matching result", "properties": { "description": { "description": "Job criteria matching description", "type": "string" }, "id": { "description": "Job criteria matching unique identifier", "format": "uuid", "type": "string" }, "is_matched": { "$ref": "#/components/schemas/AtsApplicationsGetResponsesContentApplicationJsonSchemaDataItemsApplicationJobCriteriasMatchingsItemsIsMatched", "description": "Whether the criteria is matched" }, "job_criteria_id": { "description": "Job criteria unique identifier", "format": "uuid", "type": "string" } }, "required": [ "id", "is_matched", "description", "job_criteria_id" ], "title": "AtsApplicationsGetResponsesContentApplicationJsonSchemaDataItemsApplicationJobCriteriasMatchingsItems", "type": "object" }, "AtsApplicationsGetResponsesContentApplicationJsonSchemaDataItemsApplicationJobCriteriasMatchingsItemsIsMatched": { "description": "Whether the criteria is matched", "enum": [ "MATCHED", "NOT_MATCHED", "UNDECIDED" ], "title": "AtsApplicationsGetResponsesContentApplicationJsonSchemaDataItemsApplicationJobCriteriasMatchingsItemsIsMatched", "type": "string" }, "AtsApplicationsGetResponsesContentApplicationJsonSchemaDataItemsCandidate": { "description": "Candidate information associated with the application", "properties": { "candidate_tags": { "description": "Tags associated with the candidate", "items": { "$ref": "#/components/schemas/AtsApplicationsGetResponsesContentApplicationJsonSchemaDataItemsCandidateCandidateTagsItems" }, "type": "array" }, "city": { "description": "Candidate city", "type": [ "string", "null" ] }, "country_code": { "description": "Candidate country code (ISO 3166-1 alpha-2)", "type": [ "string", "null" ] }, "email": { "description": "Candidate email address", "format": "email", "type": "string" }, "first_name": { "description": "Candidate first name", "type": "string" }, "id": { "description": "Candidate unique identifier", "format": "uuid", "type": "string" }, "last_name": { "description": "Candidate last name", "type": "string" }, "phone_number": { "description": "Candidate phone number (may be empty string or null)", "type": [ "string", "null" ] }, "pic_url": { "description": "Candidate profile picture URL", "type": [ "string", "null" ] } }, "required": [ "id", "email", "pic_url", "last_name", "first_name", "phone_number", "candidate_tags" ], "title": "AtsApplicationsGetResponsesContentApplicationJsonSchemaDataItemsCandidate", "type": "object" }, "AtsApplicationsGetResponsesContentApplicationJsonSchemaDataItemsCandidateCandidateTagsItems": { "description": "Candidate tag with label", "properties": { "id": { "description": "Candidate tag unique identifier", "format": "uuid", "type": "string" }, "tag": { "$ref": "#/components/schemas/AtsApplicationsGetResponsesContentApplicationJsonSchemaDataItemsCandidateCandidateTagsItemsTag" } }, "required": [ "id", "tag" ], "title": "AtsApplicationsGetResponsesContentApplicationJsonSchemaDataItemsCandidateCandidateTagsItems", "type": "object" }, "AtsApplicationsGetResponsesContentApplicationJsonSchemaDataItemsCandidateCandidateTagsItemsTag": { "properties": { "id": { "description": "Tag unique identifier", "format": "uuid", "type": "string" }, "label": { "description": "Tag label", "type": "string" } }, "required": [ "id", "label" ], "title": "AtsApplicationsGetResponsesContentApplicationJsonSchemaDataItemsCandidateCandidateTagsItemsTag", "type": "object" }, "AtsApplicationsGetResponsesContentApplicationJsonSchemaDataItemsCurrentApplicationInterviewPlanStage": { "description": "Current interview plan stage information for the application", "properties": { "application_id": { "description": "Application unique identifier", "format": "uuid", "type": "string" }, "id": { "description": "Application interview plan stage unique identifier", "format": "uuid", "type": "string" }, "interview_plan_stage": { "$ref": "#/components/schemas/AtsApplicationsGetResponsesContentApplicationJsonSchemaDataItemsCurrentApplicationInterviewPlanStageInterviewPlanStage" }, "interview_plan_stage_id": { "description": "Interview plan stage unique identifier", "format": "uuid", "type": "string" } }, "required": [ "id", "application_id", "interview_plan_stage", "interview_plan_stage_id" ], "title": "AtsApplicationsGetResponsesContentApplicationJsonSchemaDataItemsCurrentApplicationInterviewPlanStage", "type": "object" }, "AtsApplicationsGetResponsesContentApplicationJsonSchemaDataItemsCurrentApplicationInterviewPlanStageInterviewPlanStage": { "properties": { "category_type_slug": { "description": "Interview plan stage category type", "type": "string" }, "default_type_slug": { "description": "Interview plan stage default type slug", "type": [ "string", "null" ] }, "id": { "description": "Interview plan stage unique identifier", "format": "uuid", "type": "string" }, "name": { "description": "Interview plan stage name", "type": "string" }, "position_number": { "description": "Ordinal position of the stage in its job pipeline. Ranges are stable across organizations: below 2000 for lead stages, 2000 for application review, 2001-2998 for the customer-defined interview rounds, 2999 for offer, 3000 and above for hired and archived.", "type": [ "integer", "null" ] } }, "required": [ "id", "name", "position_number", "default_type_slug", "category_type_slug" ], "title": "AtsApplicationsGetResponsesContentApplicationJsonSchemaDataItemsCurrentApplicationInterviewPlanStageInterviewPlanStage", "type": "object" }, "AtsApplicationsGetResponsesContentApplicationJsonSchemaDataItemsJob": { "description": "Job information for the application", "properties": { "id": { "description": "Job unique identifier", "format": "uuid", "type": "string" }, "title": { "description": "Job title", "type": "string" } }, "required": [ "id", "title" ], "title": "AtsApplicationsGetResponsesContentApplicationJsonSchemaDataItemsJob", "type": "object" }, "AtsApplicationsGetResponsesContentApplicationJsonSchemaDataItemsJobEmploymentType": { "description": "Employment type information for the job", "properties": { "employment_type": { "$ref": "#/components/schemas/AtsApplicationsGetResponsesContentApplicationJsonSchemaDataItemsJobEmploymentTypeEmploymentType" }, "id": { "description": "Job employment type unique identifier", "format": "uuid", "type": "string" } }, "required": [ "id", "employment_type" ], "title": "AtsApplicationsGetResponsesContentApplicationJsonSchemaDataItemsJobEmploymentType", "type": "object" }, "AtsApplicationsGetResponsesContentApplicationJsonSchemaDataItemsJobEmploymentTypeEmploymentType": { "properties": { "id": { "description": "Employment type unique identifier", "format": "uuid", "type": "string" }, "name": { "description": "Employment type name", "type": "string" } }, "required": [ "id", "name" ], "title": "AtsApplicationsGetResponsesContentApplicationJsonSchemaDataItemsJobEmploymentTypeEmploymentType", "type": "object" }, "AtsApplicationsGetResponsesContentApplicationJsonSchemaDataItemsJobPosting": { "description": "Job posting information (if application came through a posting)", "properties": { "id": { "description": "Job posting unique identifier", "format": "uuid", "type": "string" }, "title": { "description": "Job posting title", "type": "string" } }, "required": [ "id", "title" ], "title": "AtsApplicationsGetResponsesContentApplicationJsonSchemaDataItemsJobPosting", "type": "object" }, "AtsApplicationsGetResponsesContentApplicationJsonSchemaDataItemsStageHistoryItems": { "description": "One visit of the application to an interview plan stage, in chronological order", "properties": { "entered_at": { "description": "Timestamp when the application entered this stage", "format": "date-time", "type": "string" }, "exited_at": { "description": "Timestamp when the application left this stage; null while the application is still in it", "format": "date-time", "type": [ "string", "null" ] }, "id": { "description": "Identifier of the stage history record", "format": "uuid", "type": "string" }, "interview_plan_stage": { "$ref": "#/components/schemas/AtsApplicationsGetResponsesContentApplicationJsonSchemaDataItemsStageHistoryItemsInterviewPlanStage", "description": "The interview plan stage this history record refers to" }, "is_current": { "description": "Whether this is the stage the application is currently in", "type": "boolean" }, "moved_by_hris_organization_user_id": { "description": "HRIS organization user who moved the application into this stage; null for automated moves", "format": "uuid", "type": [ "string", "null" ] } }, "required": [ "id", "exited_at", "entered_at", "is_current", "interview_plan_stage", "moved_by_hris_organization_user_id" ], "title": "AtsApplicationsGetResponsesContentApplicationJsonSchemaDataItemsStageHistoryItems", "type": "object" }, "AtsApplicationsGetResponsesContentApplicationJsonSchemaDataItemsStageHistoryItemsInterviewPlanStage": { "description": "The interview plan stage this history record refers to", "properties": { "category_type_slug": { "description": "Stage category: lead, active or completed", "type": "string" }, "default_type_slug": { "description": "System stage type (e.g. new_lead, application_review, offer, hired, archived); null for custom stages", "type": [ "string", "null" ] }, "id": { "description": "Interview plan stage identifier", "format": "uuid", "type": "string" }, "name": { "description": "Customer-defined stage name", "type": "string" }, "position_number": { "description": "Position of the stage in the interview plan", "type": "integer" } }, "required": [ "id", "name", "position_number", "default_type_slug", "category_type_slug" ], "title": "AtsApplicationsGetResponsesContentApplicationJsonSchemaDataItemsStageHistoryItemsInterviewPlanStage", "type": "object" }, "AtsApplicationsGetResponsesContentApplicationJsonSchemaErrorsItems": { "properties": { "code": { "description": "Machine-readable error code", "type": "string" }, "field": { "description": "Request field related to the error, if applicable", "type": "string" }, "message": { "description": "Human-readable error message", "type": "string" } }, "required": [ "code", "message" ], "title": "AtsApplicationsGetResponsesContentApplicationJsonSchemaErrorsItems", "type": "object" }, "AtsApplicationsPostRequestBodyContentApplicationJsonSchemaData": { "properties": { "application_form_submission_data": { "description": "Array of form submission answers", "items": { "$ref": "#/components/schemas/AtsApplicationsPostRequestBodyContentApplicationJsonSchemaDataApplicationFormSubmissionDataItems" }, "type": [ "array", "null" ] }, "candidate_id": { "description": "The ID of the candidate applying", "format": "uuid", "type": "string" }, "job_employment_type_id": { "description": "The ID of the employment type for this job", "format": "uuid", "type": "string" }, "job_id": { "description": "The ID of the job for this application", "format": "uuid", "type": "string" }, "job_posting_id": { "description": "The ID of the job posting (optional)", "format": "uuid", "type": [ "string", "null" ] }, "notes": { "description": "Array of notes to attach to the application", "items": { "$ref": "#/components/schemas/AtsApplicationsPostRequestBodyContentApplicationJsonSchemaDataNotesItems" }, "type": [ "array", "null" ] }, "source_slug": { "description": "The application source. Accepts any active source slug of the organization, e.g. SOURCED_INTERNALLY, SOURCED_EXTERNALLY, INTERNAL_REFERRAL_AWARE, INTERNAL_REFERRAL_NOT_AWARE, EXTERNAL_CAREER_PAGE or a custom source slug (case-insensitive). Defaults to the candidate origin source when omitted.", "type": "string" } }, "required": [ "job_id", "candidate_id", "job_employment_type_id" ], "title": "AtsApplicationsPostRequestBodyContentApplicationJsonSchemaData", "type": "object" }, "AtsApplicationsPostRequestBodyContentApplicationJsonSchemaDataApplicationFormSubmissionDataItems": { "oneOf": [ { "$ref": "#/components/schemas/AtsApplicationsPostRequestBodyContentApplicationJsonSchemaDataApplicationFormSubmissionDataItems0" }, { "$ref": "#/components/schemas/AtsApplicationsPostRequestBodyContentApplicationJsonSchemaDataApplicationFormSubmissionDataItems1" }, { "$ref": "#/components/schemas/AtsApplicationsPostRequestBodyContentApplicationJsonSchemaDataApplicationFormSubmissionDataItems2" }, { "$ref": "#/components/schemas/AtsApplicationsPostRequestBodyContentApplicationJsonSchemaDataApplicationFormSubmissionDataItems3" }, { "$ref": "#/components/schemas/AtsApplicationsPostRequestBodyContentApplicationJsonSchemaDataApplicationFormSubmissionDataItems4" }, { "$ref": "#/components/schemas/AtsApplicationsPostRequestBodyContentApplicationJsonSchemaDataApplicationFormSubmissionDataItems5" }, { "$ref": "#/components/schemas/AtsApplicationsPostRequestBodyContentApplicationJsonSchemaDataApplicationFormSubmissionDataItems6" }, { "$ref": "#/components/schemas/AtsApplicationsPostRequestBodyContentApplicationJsonSchemaDataApplicationFormSubmissionDataItems7" }, { "$ref": "#/components/schemas/AtsApplicationsPostRequestBodyContentApplicationJsonSchemaDataApplicationFormSubmissionDataItems8" }, { "$ref": "#/components/schemas/AtsApplicationsPostRequestBodyContentApplicationJsonSchemaDataApplicationFormSubmissionDataItems9" }, { "$ref": "#/components/schemas/AtsApplicationsPostRequestBodyContentApplicationJsonSchemaDataApplicationFormSubmissionDataItems10" }, { "$ref": "#/components/schemas/AtsApplicationsPostRequestBodyContentApplicationJsonSchemaDataApplicationFormSubmissionDataItems11" } ], "title": "AtsApplicationsPostRequestBodyContentApplicationJsonSchemaDataApplicationFormSubmissionDataItems" }, "AtsApplicationsPostRequestBodyContentApplicationJsonSchemaDataApplicationFormSubmissionDataItems0": { "properties": { "answer": { "description": "Text answer", "type": "string" }, "question_id": { "description": "Question identifier", "type": "string" }, "type": { "$ref": "#/components/schemas/AtsApplicationsPostRequestBodyContentApplicationJsonSchemaDataApplicationFormSubmissionDataItemsOneOf0Type", "description": "Question type this answer belongs to." } }, "required": [ "type", "answer", "question_id" ], "title": "AtsApplicationsPostRequestBodyContentApplicationJsonSchemaDataApplicationFormSubmissionDataItems0", "type": "object" }, "AtsApplicationsPostRequestBodyContentApplicationJsonSchemaDataApplicationFormSubmissionDataItems1": { "properties": { "answer": { "description": "Paragraph answer", "type": "string" }, "question_id": { "description": "Question identifier", "type": "string" }, "type": { "$ref": "#/components/schemas/AtsApplicationsPostRequestBodyContentApplicationJsonSchemaDataApplicationFormSubmissionDataItemsOneOf1Type", "description": "Question type this answer belongs to." } }, "required": [ "type", "answer", "question_id" ], "title": "AtsApplicationsPostRequestBodyContentApplicationJsonSchemaDataApplicationFormSubmissionDataItems1", "type": "object" }, "AtsApplicationsPostRequestBodyContentApplicationJsonSchemaDataApplicationFormSubmissionDataItems10": { "properties": { "phone_number": { "description": "Phone number", "type": "string" }, "question_id": { "description": "Question identifier", "type": "string" }, "type": { "$ref": "#/components/schemas/AtsApplicationsPostRequestBodyContentApplicationJsonSchemaDataApplicationFormSubmissionDataItemsOneOf10Type", "description": "Question type this answer belongs to." } }, "required": [ "type", "question_id", "phone_number" ], "title": "AtsApplicationsPostRequestBodyContentApplicationJsonSchemaDataApplicationFormSubmissionDataItems10", "type": "object" }, "AtsApplicationsPostRequestBodyContentApplicationJsonSchemaDataApplicationFormSubmissionDataItems11": { "properties": { "email": { "description": "Email address", "format": "email", "type": "string" }, "question_id": { "description": "Question identifier", "type": "string" }, "type": { "$ref": "#/components/schemas/AtsApplicationsPostRequestBodyContentApplicationJsonSchemaDataApplicationFormSubmissionDataItemsOneOf11Type", "description": "Question type this answer belongs to." } }, "required": [ "type", "email", "question_id" ], "title": "AtsApplicationsPostRequestBodyContentApplicationJsonSchemaDataApplicationFormSubmissionDataItems11", "type": "object" }, "AtsApplicationsPostRequestBodyContentApplicationJsonSchemaDataApplicationFormSubmissionDataItems2": { "properties": { "question_id": { "description": "Question identifier", "type": "string" }, "selected_option_id": { "description": "Selected option ID", "type": "string" }, "type": { "$ref": "#/components/schemas/AtsApplicationsPostRequestBodyContentApplicationJsonSchemaDataApplicationFormSubmissionDataItemsOneOf2Type", "description": "Question type this answer belongs to." } }, "required": [ "type", "question_id", "selected_option_id" ], "title": "AtsApplicationsPostRequestBodyContentApplicationJsonSchemaDataApplicationFormSubmissionDataItems2", "type": "object" }, "AtsApplicationsPostRequestBodyContentApplicationJsonSchemaDataApplicationFormSubmissionDataItems3": { "properties": { "question_id": { "description": "Question identifier", "type": "string" }, "selected_option_ids": { "description": "Selected option IDs", "items": { "type": "string" }, "type": "array" }, "type": { "$ref": "#/components/schemas/AtsApplicationsPostRequestBodyContentApplicationJsonSchemaDataApplicationFormSubmissionDataItemsOneOf3Type", "description": "Question type this answer belongs to." } }, "required": [ "type", "question_id", "selected_option_ids" ], "title": "AtsApplicationsPostRequestBodyContentApplicationJsonSchemaDataApplicationFormSubmissionDataItems3", "type": "object" }, "AtsApplicationsPostRequestBodyContentApplicationJsonSchemaDataApplicationFormSubmissionDataItems4": { "properties": { "document_ids": { "description": "Document IDs", "items": { "type": "string" }, "type": "array" }, "question_id": { "description": "Question identifier", "type": "string" }, "type": { "$ref": "#/components/schemas/AtsApplicationsPostRequestBodyContentApplicationJsonSchemaDataApplicationFormSubmissionDataItemsOneOf4Type", "description": "Question type this answer belongs to." } }, "required": [ "type", "question_id", "document_ids" ], "title": "AtsApplicationsPostRequestBodyContentApplicationJsonSchemaDataApplicationFormSubmissionDataItems4", "type": "object" }, "AtsApplicationsPostRequestBodyContentApplicationJsonSchemaDataApplicationFormSubmissionDataItems5": { "properties": { "preset": { "description": "Preset name", "type": "string" }, "question_id": { "description": "Question identifier", "type": "string" }, "selected_options": { "description": "Selected options", "items": { "type": "string" }, "type": "array" }, "type": { "$ref": "#/components/schemas/AtsApplicationsPostRequestBodyContentApplicationJsonSchemaDataApplicationFormSubmissionDataItemsOneOf5Type", "description": "Question type this answer belongs to." } }, "required": [ "type", "preset", "question_id", "selected_options" ], "title": "AtsApplicationsPostRequestBodyContentApplicationJsonSchemaDataApplicationFormSubmissionDataItems5", "type": "object" }, "AtsApplicationsPostRequestBodyContentApplicationJsonSchemaDataApplicationFormSubmissionDataItems6": { "properties": { "question_id": { "description": "Question identifier", "type": "string" }, "selected_option_ids": { "description": "Selected option IDs", "items": { "type": "string" }, "type": "array" }, "type": { "$ref": "#/components/schemas/AtsApplicationsPostRequestBodyContentApplicationJsonSchemaDataApplicationFormSubmissionDataItemsOneOf6Type", "description": "Question type this answer belongs to." } }, "required": [ "type", "question_id", "selected_option_ids" ], "title": "AtsApplicationsPostRequestBodyContentApplicationJsonSchemaDataApplicationFormSubmissionDataItems6", "type": "object" }, "AtsApplicationsPostRequestBodyContentApplicationJsonSchemaDataApplicationFormSubmissionDataItems7": { "properties": { "question_id": { "description": "Question identifier", "type": "string" }, "type": { "$ref": "#/components/schemas/AtsApplicationsPostRequestBodyContentApplicationJsonSchemaDataApplicationFormSubmissionDataItemsOneOf7Type", "description": "Question type this answer belongs to." }, "value": { "description": "Numeric value", "type": "string" } }, "required": [ "type", "value", "question_id" ], "title": "AtsApplicationsPostRequestBodyContentApplicationJsonSchemaDataApplicationFormSubmissionDataItems7", "type": "object" }, "AtsApplicationsPostRequestBodyContentApplicationJsonSchemaDataApplicationFormSubmissionDataItems8": { "properties": { "end_date": { "description": "End date (for ranges)", "type": "string" }, "question_id": { "description": "Question identifier", "type": "string" }, "start_date": { "description": "Start date", "type": "string" }, "type": { "$ref": "#/components/schemas/AtsApplicationsPostRequestBodyContentApplicationJsonSchemaDataApplicationFormSubmissionDataItemsOneOf8Type", "description": "Question type this answer belongs to." } }, "required": [ "type", "question_id" ], "title": "AtsApplicationsPostRequestBodyContentApplicationJsonSchemaDataApplicationFormSubmissionDataItems8", "type": "object" }, "AtsApplicationsPostRequestBodyContentApplicationJsonSchemaDataApplicationFormSubmissionDataItems9": { "properties": { "address_city": { "description": "City", "type": "string" }, "address_country": { "description": "Country", "type": "string" }, "address_number": { "description": "Street number", "type": "string" }, "address_state": { "description": "State", "type": "string" }, "address_street": { "description": "Street name", "type": "string" }, "address_zip_code": { "description": "ZIP code", "type": "string" }, "question_id": { "description": "Question identifier", "type": "string" }, "type": { "$ref": "#/components/schemas/AtsApplicationsPostRequestBodyContentApplicationJsonSchemaDataApplicationFormSubmissionDataItemsOneOf9Type", "description": "Question type this answer belongs to." } }, "required": [ "type", "question_id", "address_city", "address_state", "address_number", "address_street", "address_country", "address_zip_code" ], "title": "AtsApplicationsPostRequestBodyContentApplicationJsonSchemaDataApplicationFormSubmissionDataItems9", "type": "object" }, "AtsApplicationsPostRequestBodyContentApplicationJsonSchemaDataApplicationFormSubmissionDataItemsOneOf0Type": { "description": "Question type this answer belongs to.", "enum": [ "FREETEXT" ], "title": "AtsApplicationsPostRequestBodyContentApplicationJsonSchemaDataApplicationFormSubmissionDataItemsOneOf0Type", "type": "string" }, "AtsApplicationsPostRequestBodyContentApplicationJsonSchemaDataApplicationFormSubmissionDataItemsOneOf10Type": { "description": "Question type this answer belongs to.", "enum": [ "PHONENUMBER" ], "title": "AtsApplicationsPostRequestBodyContentApplicationJsonSchemaDataApplicationFormSubmissionDataItemsOneOf10Type", "type": "string" }, "AtsApplicationsPostRequestBodyContentApplicationJsonSchemaDataApplicationFormSubmissionDataItemsOneOf11Type": { "description": "Question type this answer belongs to.", "enum": [ "EMAIL" ], "title": "AtsApplicationsPostRequestBodyContentApplicationJsonSchemaDataApplicationFormSubmissionDataItemsOneOf11Type", "type": "string" }, "AtsApplicationsPostRequestBodyContentApplicationJsonSchemaDataApplicationFormSubmissionDataItemsOneOf1Type": { "description": "Question type this answer belongs to.", "enum": [ "PARAGRAPH" ], "title": "AtsApplicationsPostRequestBodyContentApplicationJsonSchemaDataApplicationFormSubmissionDataItemsOneOf1Type", "type": "string" }, "AtsApplicationsPostRequestBodyContentApplicationJsonSchemaDataApplicationFormSubmissionDataItemsOneOf2Type": { "description": "Question type this answer belongs to.", "enum": [ "SINGLESELECTION" ], "title": "AtsApplicationsPostRequestBodyContentApplicationJsonSchemaDataApplicationFormSubmissionDataItemsOneOf2Type", "type": "string" }, "AtsApplicationsPostRequestBodyContentApplicationJsonSchemaDataApplicationFormSubmissionDataItemsOneOf3Type": { "description": "Question type this answer belongs to.", "enum": [ "MULTISELECTION" ], "title": "AtsApplicationsPostRequestBodyContentApplicationJsonSchemaDataApplicationFormSubmissionDataItemsOneOf3Type", "type": "string" }, "AtsApplicationsPostRequestBodyContentApplicationJsonSchemaDataApplicationFormSubmissionDataItemsOneOf4Type": { "description": "Question type this answer belongs to.", "enum": [ "DOCUMENTUPLOAD" ], "title": "AtsApplicationsPostRequestBodyContentApplicationJsonSchemaDataApplicationFormSubmissionDataItemsOneOf4Type", "type": "string" }, "AtsApplicationsPostRequestBodyContentApplicationJsonSchemaDataApplicationFormSubmissionDataItemsOneOf5Type": { "description": "Question type this answer belongs to.", "enum": [ "PRESETDROPDOWN" ], "title": "AtsApplicationsPostRequestBodyContentApplicationJsonSchemaDataApplicationFormSubmissionDataItemsOneOf5Type", "type": "string" }, "AtsApplicationsPostRequestBodyContentApplicationJsonSchemaDataApplicationFormSubmissionDataItemsOneOf6Type": { "description": "Question type this answer belongs to.", "enum": [ "CUSTOMDROPDOWN" ], "title": "AtsApplicationsPostRequestBodyContentApplicationJsonSchemaDataApplicationFormSubmissionDataItemsOneOf6Type", "type": "string" }, "AtsApplicationsPostRequestBodyContentApplicationJsonSchemaDataApplicationFormSubmissionDataItemsOneOf7Type": { "description": "Question type this answer belongs to.", "enum": [ "NUMBER" ], "title": "AtsApplicationsPostRequestBodyContentApplicationJsonSchemaDataApplicationFormSubmissionDataItemsOneOf7Type", "type": "string" }, "AtsApplicationsPostRequestBodyContentApplicationJsonSchemaDataApplicationFormSubmissionDataItemsOneOf8Type": { "description": "Question type this answer belongs to.", "enum": [ "DATEPICKER" ], "title": "AtsApplicationsPostRequestBodyContentApplicationJsonSchemaDataApplicationFormSubmissionDataItemsOneOf8Type", "type": "string" }, "AtsApplicationsPostRequestBodyContentApplicationJsonSchemaDataApplicationFormSubmissionDataItemsOneOf9Type": { "description": "Question type this answer belongs to.", "enum": [ "ADDRESS" ], "title": "AtsApplicationsPostRequestBodyContentApplicationJsonSchemaDataApplicationFormSubmissionDataItemsOneOf9Type", "type": "string" }, "AtsApplicationsPostRequestBodyContentApplicationJsonSchemaDataNotesItems": { "properties": { "richtext_content": { "description": "The richtext content of the note", "type": "string" } }, "required": [ "richtext_content" ], "title": "AtsApplicationsPostRequestBodyContentApplicationJsonSchemaDataNotesItems", "type": "object" }, "AtsApplicationsPostResponsesContentApplicationJsonSchemaData": { "properties": { "candidate_id": { "description": "Candidate unique identifier", "format": "uuid", "type": "string" }, "created_at": { "description": "Creation timestamp", "format": "date-time", "type": "string" }, "current_application_interview_plan_stage_id": { "description": "Current interview plan stage identifier", "format": "uuid", "type": [ "string", "null" ] }, "id": { "description": "Application unique identifier", "format": "uuid", "type": "string" }, "job_employment_type_id": { "description": "Job employment type identifier", "format": "uuid", "type": [ "string", "null" ] }, "job_id": { "description": "Job unique identifier", "format": "uuid", "type": "string" }, "job_posting_id": { "description": "Job posting unique identifier", "format": "uuid", "type": [ "string", "null" ] }, "moved_to_current_stage_at": { "description": "When application moved to current stage", "format": "date-time", "type": [ "string", "null" ] }, "numeric_id": { "description": "Application numeric identifier", "type": "integer" }, "source_slug": { "description": "The application source slug in uppercase", "type": [ "string", "null" ] }, "updated_at": { "description": "Last update timestamp", "format": "date-time", "type": "string" } }, "required": [ "id", "job_id", "created_at", "numeric_id", "updated_at", "candidate_id", "job_posting_id", "job_employment_type_id", "moved_to_current_stage_at", "current_application_interview_plan_stage_id" ], "title": "AtsApplicationsPostResponsesContentApplicationJsonSchemaData", "type": "object" }, "AtsApplicationsPostResponsesContentApplicationJsonSchemaErrorsItems": { "properties": { "code": { "description": "Machine-readable error code", "type": "string" }, "field": { "description": "Request field related to the error, if applicable", "type": "string" }, "message": { "description": "Human-readable error message", "type": "string" } }, "required": [ "code", "message" ], "title": "AtsApplicationsPostResponsesContentApplicationJsonSchemaErrorsItems", "type": "object" }, "AtsAttachmentsAttachableTypeSlugAttachableIdAttachmentTypeSlugGetParametersAttachableTypeSlug": { "enum": [ "CANDIDATE", "CAREER_PAGE_SETTING", "JOB_POSTING", "NOTE", "OFFER", "SENT_CANDIDATE_EMAIL", "EMAIL_MESSAGE", "TEMPORARY", "EMAIL_TEMPLATE", "JOB_ACTIVITY" ], "title": "AtsAttachmentsAttachableTypeSlugAttachableIdAttachmentTypeSlugGetParametersAttachableTypeSlug", "type": "string" }, "AtsAttachmentsAttachableTypeSlugAttachableIdAttachmentTypeSlugGetParametersAttachmentTypeSlug": { "enum": [ "CV", "LOGO", "OFFER_LETTER", "OTHER" ], "title": "AtsAttachmentsAttachableTypeSlugAttachableIdAttachmentTypeSlugGetParametersAttachmentTypeSlug", "type": "string" }, "AtsAttachmentsAttachableTypeSlugAttachableIdAttachmentTypeSlugGetResponsesContentApplicationJsonSchemaDataItems": { "properties": { "ai_summary": { "description": "AI-generated summary of the attachment", "type": [ "string", "null" ] }, "attachable_id": { "description": "Unique identifier for the attachable entity", "format": "uuid", "type": "string" }, "attachable_type_slug": { "description": "Type of the attachable entity", "type": "string" }, "attachment_type_slug": { "description": "Type of the attachment", "type": "string" }, "created_at": { "description": "Timestamp when the attachment was created", "format": "date-time", "type": "string" }, "created_by_hris_organization_user_id": { "description": "User ID who created the attachment", "format": "uuid", "type": [ "string", "null" ] }, "file_content_type": { "description": "Content type of the file", "type": "string" }, "file_name": { "description": "Name of the file", "type": "string" }, "id": { "description": "Unique identifier for the attachment", "format": "uuid", "type": "string" }, "updated_at": { "description": "Timestamp when the attachment was last updated", "format": "date-time", "type": "string" }, "url": { "description": "URL of the attachment", "format": "url", "type": "string" } }, "required": [ "id", "file_name", "file_content_type", "attachable_type_slug", "attachment_type_slug" ], "title": "AtsAttachmentsAttachableTypeSlugAttachableIdAttachmentTypeSlugGetResponsesContentApplicationJsonSchemaDataItems", "type": "object" }, "AtsAttachmentsAttachableTypeSlugAttachableIdAttachmentTypeSlugGetResponsesContentApplicationJsonSchemaErrorsItems": { "properties": { "code": { "description": "Machine-readable error code", "type": "string" }, "field": { "description": "Request field related to the error, if applicable", "type": "string" }, "message": { "description": "Human-readable error message", "type": "string" } }, "required": [ "code", "message" ], "title": "AtsAttachmentsAttachableTypeSlugAttachableIdAttachmentTypeSlugGetResponsesContentApplicationJsonSchemaErrorsItems", "type": "object" }, "AtsAttachmentsAttachableTypeSlugAttachableIdAttachmentTypeSlugPostParametersAttachableTypeSlug": { "enum": [ "CANDIDATE", "OFFER", "JOB_ACTIVITY" ], "title": "AtsAttachmentsAttachableTypeSlugAttachableIdAttachmentTypeSlugPostParametersAttachableTypeSlug", "type": "string" }, "AtsAttachmentsAttachableTypeSlugAttachableIdAttachmentTypeSlugPostParametersAttachmentTypeSlug": { "enum": [ "CV", "LOGO", "OFFER_LETTER", "OTHER" ], "title": "AtsAttachmentsAttachableTypeSlugAttachableIdAttachmentTypeSlugPostParametersAttachmentTypeSlug", "type": "string" }, "AtsAttachmentsAttachableTypeSlugAttachableIdAttachmentTypeSlugPostParametersXBeta": { "default": "true", "enum": [ "true" ], "title": "AtsAttachmentsAttachableTypeSlugAttachableIdAttachmentTypeSlugPostParametersXBeta", "type": "string" }, "AtsAttachmentsAttachableTypeSlugAttachableIdAttachmentTypeSlugPostRequestBodyContentMultipartFormDataSchemaData": { "properties": { "file": { "description": "The file to attach, in binary format", "format": "binary", "type": "string" } }, "required": [ "file" ], "title": "AtsAttachmentsAttachableTypeSlugAttachableIdAttachmentTypeSlugPostRequestBodyContentMultipartFormDataSchemaData", "type": "object" }, "AtsAttachmentsAttachableTypeSlugAttachableIdAttachmentTypeSlugPostResponsesContentApplicationJsonSchemaData": { "properties": { "ai_summary": { "description": "AI-generated summary of the attachment", "type": [ "string", "null" ] }, "attachable_id": { "description": "Unique identifier of the entity the file is attached to", "format": "uuid", "type": "string" }, "attachable_type_slug": { "$ref": "#/components/schemas/AtsAttachmentsAttachableTypeSlugAttachableIdAttachmentTypeSlugPostResponsesContentApplicationJsonSchemaDataAttachableTypeSlug", "description": "Type of the entity the file is attached to" }, "attachment_type_slug": { "$ref": "#/components/schemas/AtsAttachmentsAttachableTypeSlugAttachableIdAttachmentTypeSlugPostResponsesContentApplicationJsonSchemaDataAttachmentTypeSlug", "description": "Type of the attachment" }, "created_at": { "description": "Timestamp when the attachment was created", "format": "date-time", "type": "string" }, "created_by_hris_organization_user_id": { "description": "User ID who created the attachment", "format": "uuid", "type": [ "string", "null" ] }, "file_content_type": { "description": "Content type of the attached file", "type": "string" }, "file_name": { "description": "Name of the attached file", "type": "string" }, "id": { "description": "Unique identifier for the attachment", "format": "uuid", "type": "string" }, "updated_at": { "description": "Timestamp when the attachment was last updated", "format": "date-time", "type": "string" } }, "required": [ "id", "file_name", "file_content_type", "attachable_type_slug", "attachment_type_slug" ], "title": "AtsAttachmentsAttachableTypeSlugAttachableIdAttachmentTypeSlugPostResponsesContentApplicationJsonSchemaData", "type": "object" }, "AtsAttachmentsAttachableTypeSlugAttachableIdAttachmentTypeSlugPostResponsesContentApplicationJsonSchemaDataAttachableTypeSlug": { "description": "Type of the entity the file is attached to", "enum": [ "CANDIDATE", "OFFER", "JOB_ACTIVITY" ], "title": "AtsAttachmentsAttachableTypeSlugAttachableIdAttachmentTypeSlugPostResponsesContentApplicationJsonSchemaDataAttachableTypeSlug", "type": "string" }, "AtsAttachmentsAttachableTypeSlugAttachableIdAttachmentTypeSlugPostResponsesContentApplicationJsonSchemaDataAttachmentTypeSlug": { "description": "Type of the attachment", "enum": [ "CV", "LOGO", "OFFER_LETTER", "OTHER" ], "title": "AtsAttachmentsAttachableTypeSlugAttachableIdAttachmentTypeSlugPostResponsesContentApplicationJsonSchemaDataAttachmentTypeSlug", "type": "string" }, "AtsAttachmentsAttachableTypeSlugAttachableIdAttachmentTypeSlugPostResponsesContentApplicationJsonSchemaErrorsItems": { "properties": { "code": { "description": "Machine-readable error code", "type": "string" }, "field": { "description": "Request field related to the error, if applicable", "type": "string" }, "message": { "description": "Human-readable error message", "type": "string" } }, "required": [ "code", "message" ], "title": "AtsAttachmentsAttachableTypeSlugAttachableIdAttachmentTypeSlugPostResponsesContentApplicationJsonSchemaErrorsItems", "type": "object" }, "AtsCandidatesCandidateIdAttachmentsPostRequestBodyContentMultipartFormDataSchemaData": { "properties": { "cv": { "description": "CV of the candidate in binary format", "format": "binary", "type": "string" } }, "required": [ "cv" ], "title": "AtsCandidatesCandidateIdAttachmentsPostRequestBodyContentMultipartFormDataSchemaData", "type": "object" }, "AtsCandidatesCandidateIdAttachmentsPostResponsesContentApplicationJsonSchemaData": { "properties": { "attachable_id": { "description": "Unique identifier of the entity the file is attached to", "format": "uuid", "type": "string" }, "attachable_type_slug": { "$ref": "#/components/schemas/AtsCandidatesCandidateIdAttachmentsPostResponsesContentApplicationJsonSchemaDataAttachableTypeSlug", "description": "Type of the entity the file is attached to" }, "attachment_type_slug": { "$ref": "#/components/schemas/AtsCandidatesCandidateIdAttachmentsPostResponsesContentApplicationJsonSchemaDataAttachmentTypeSlug", "description": "Type of the attachment" }, "created_at": { "description": "Timestamp when the attachment was created", "format": "date-time", "type": "string" }, "file_content_type": { "description": "Content type of the attached file", "type": [ "string", "null" ] }, "file_name": { "description": "Name of the attached file", "type": "string" }, "id": { "description": "Unique identifier for the attachment", "format": "uuid", "type": "string" }, "updated_at": { "description": "Timestamp when the attachment was last updated", "format": "date-time", "type": "string" } }, "required": [ "id", "file_name", "attachable_type_slug", "attachment_type_slug" ], "title": "AtsCandidatesCandidateIdAttachmentsPostResponsesContentApplicationJsonSchemaData", "type": "object" }, "AtsCandidatesCandidateIdAttachmentsPostResponsesContentApplicationJsonSchemaDataAttachableTypeSlug": { "description": "Type of the entity the file is attached to", "enum": [ "CANDIDATE" ], "title": "AtsCandidatesCandidateIdAttachmentsPostResponsesContentApplicationJsonSchemaDataAttachableTypeSlug", "type": "string" }, "AtsCandidatesCandidateIdAttachmentsPostResponsesContentApplicationJsonSchemaDataAttachmentTypeSlug": { "description": "Type of the attachment", "enum": [ "CV", "LOGO", "OFFER_LETTER", "OTHER" ], "title": "AtsCandidatesCandidateIdAttachmentsPostResponsesContentApplicationJsonSchemaDataAttachmentTypeSlug", "type": "string" }, "AtsCandidatesCandidateIdAttachmentsPostResponsesContentApplicationJsonSchemaErrorsItems": { "properties": { "code": { "description": "Machine-readable error code", "type": "string" }, "field": { "description": "Request field related to the error, if applicable", "type": "string" }, "message": { "description": "Human-readable error message", "type": "string" } }, "required": [ "code", "message" ], "title": "AtsCandidatesCandidateIdAttachmentsPostResponsesContentApplicationJsonSchemaErrorsItems", "type": "object" }, "AtsCandidatesCandidateIdGetResponsesContentApplicationJsonSchemaData": { "description": "Candidate detail.", "properties": { "anonymized_at": { "description": "When the candidate data was anonymized.", "format": "date-time", "type": [ "string", "null" ] }, "applications": { "description": "Applications of the candidate the authenticated user may see, newest first.", "items": { "$ref": "#/components/schemas/AtsCandidatesCandidateIdGetResponsesContentApplicationJsonSchemaDataApplicationsItems" }, "type": "array" }, "attachments": { "description": "Documents attached to the candidate, newest first.", "items": { "$ref": "#/components/schemas/AtsCandidatesCandidateIdGetResponsesContentApplicationJsonSchemaDataAttachmentsItems" }, "type": "array" }, "candidate_tags": { "description": "Tags applied to the candidate.", "items": { "$ref": "#/components/schemas/AtsCandidatesCandidateIdGetResponsesContentApplicationJsonSchemaDataCandidateTagsItems" }, "type": "array" }, "city": { "description": "City the candidate currently lives in", "type": [ "string", "null" ] }, "country_code": { "description": "ISO 3166-1 alpha-2 country the candidate currently lives in", "type": [ "string", "null" ] }, "created_at": { "description": "When the candidate was created.", "format": "date-time", "type": "string" }, "email": { "description": "Candidate's email address.", "format": "email", "type": "string" }, "final_archivation_at": { "description": "When the candidate was finally archived.", "format": "date-time", "type": [ "string", "null" ] }, "first_name": { "description": "Candidate's first name.", "type": "string" }, "id": { "description": "Candidate identifier.", "format": "uuid", "type": "string" }, "import_session_id": { "description": "Bulk import session the candidate came from.", "type": [ "string", "null" ] }, "imported_id": { "description": "External identifier from the import source.", "type": [ "string", "null" ] }, "last_name": { "description": "Candidate's last name.", "type": "string" }, "linkedin_profile_url": { "description": "Candidate's LinkedIn profile URL.", "type": [ "string", "null" ] }, "numeric_id": { "description": "Numeric identifier for the candidate.", "type": "integer" }, "origin_source_slug": { "description": "How the candidate first entered the ATS.", "type": [ "string", "null" ] }, "phone_number": { "description": "Candidate's phone number.", "type": [ "string", "null" ] }, "pic_url": { "description": "URL of the candidate's profile picture.", "type": [ "string", "null" ] }, "referred_by_hris_organization_user_id": { "description": "Employee who referred the candidate.", "format": "uuid", "type": [ "string", "null" ] }, "updated_at": { "description": "When the candidate was last updated.", "format": "date-time", "type": "string" } }, "required": [ "id", "email", "pic_url", "last_name", "created_at", "first_name", "numeric_id", "updated_at", "attachments", "applications", "phone_number", "candidate_tags", "origin_source_slug", "linkedin_profile_url" ], "title": "AtsCandidatesCandidateIdGetResponsesContentApplicationJsonSchemaData", "type": "object" }, "AtsCandidatesCandidateIdGetResponsesContentApplicationJsonSchemaDataApplicationsItems": { "description": "An application of the candidate.", "properties": { "archivation_reason_id": { "description": "Reason the application was archived; null unless archived.", "format": "uuid", "type": [ "string", "null" ] }, "created_at": { "description": "When the application was created.", "format": "date-time", "type": "string" }, "current_application_interview_plan_stage": { "description": "Where the application is now.", "oneOf": [ { "$ref": "#/components/schemas/AtsCandidatesCandidateIdGetResponsesContentApplicationJsonSchemaDataApplicationsItemsCurrentApplicationInterviewPlanStage" }, { "type": "null" } ] }, "hired_at": { "description": "When the application reached the hired stage; null otherwise.", "format": "date-time", "type": [ "string", "null" ] }, "id": { "description": "Application identifier.", "format": "uuid", "type": "string" }, "job": { "$ref": "#/components/schemas/AtsCandidatesCandidateIdGetResponsesContentApplicationJsonSchemaDataApplicationsItemsJob", "description": "Job of the application." }, "moved_to_current_stage_at": { "description": "When the application entered its current stage.", "format": "date-time", "type": "string" }, "numeric_id": { "description": "Application numeric identifier.", "type": "integer" }, "updated_at": { "description": "When the application was last updated.", "format": "date-time", "type": "string" } }, "required": [ "id", "job", "hired_at", "created_at", "numeric_id", "updated_at", "archivation_reason_id", "moved_to_current_stage_at", "current_application_interview_plan_stage" ], "title": "AtsCandidatesCandidateIdGetResponsesContentApplicationJsonSchemaDataApplicationsItems", "type": "object" }, "AtsCandidatesCandidateIdGetResponsesContentApplicationJsonSchemaDataApplicationsItemsCurrentApplicationInterviewPlanStage": { "description": "Where the application is now.", "properties": { "id": { "description": "Current application stage record.", "format": "uuid", "type": "string" }, "interview_plan_stage": { "description": "The current interview plan stage.", "oneOf": [ { "$ref": "#/components/schemas/AtsCandidatesCandidateIdGetResponsesContentApplicationJsonSchemaDataApplicationsItemsCurrentApplicationInterviewPlanStageInterviewPlanStage" }, { "type": "null" } ] } }, "required": [ "id", "interview_plan_stage" ], "title": "AtsCandidatesCandidateIdGetResponsesContentApplicationJsonSchemaDataApplicationsItemsCurrentApplicationInterviewPlanStage", "type": "object" }, "AtsCandidatesCandidateIdGetResponsesContentApplicationJsonSchemaDataApplicationsItemsCurrentApplicationInterviewPlanStageInterviewPlanStage": { "description": "The current interview plan stage.", "properties": { "category_type_slug": { "description": "Stage category: lead, active or completed.", "type": "string" }, "default_type_slug": { "description": "System stage type (new_lead, application_review, offer, hired, archived); null for custom stages.", "type": [ "string", "null" ] }, "id": { "description": "Interview plan stage identifier.", "format": "uuid", "type": "string" }, "name": { "description": "Customer-defined stage name.", "type": "string" }, "position_number": { "description": "Position of the stage in the interview plan.", "type": "integer" } }, "required": [ "id", "name", "position_number", "default_type_slug", "category_type_slug" ], "title": "AtsCandidatesCandidateIdGetResponsesContentApplicationJsonSchemaDataApplicationsItemsCurrentApplicationInterviewPlanStageInterviewPlanStage", "type": "object" }, "AtsCandidatesCandidateIdGetResponsesContentApplicationJsonSchemaDataApplicationsItemsJob": { "description": "Job of the application.", "properties": { "id": { "description": "Job identifier.", "format": "uuid", "type": "string" }, "status": { "description": "Job status.", "type": "string" }, "title": { "description": "Job title.", "type": "string" } }, "required": [ "id", "title", "status" ], "title": "AtsCandidatesCandidateIdGetResponsesContentApplicationJsonSchemaDataApplicationsItemsJob", "type": "object" }, "AtsCandidatesCandidateIdGetResponsesContentApplicationJsonSchemaDataAttachmentsItems": { "description": "A document attached to the candidate.", "properties": { "ai_summary": { "description": "AI-generated summary of the document (CVs only); null when not yet generated.", "type": [ "string", "null" ] }, "attachment_type_slug": { "$ref": "#/components/schemas/AtsCandidatesCandidateIdGetResponsesContentApplicationJsonSchemaDataAttachmentsItemsAttachmentTypeSlug", "description": "Kind of attachment." }, "created_at": { "description": "When the file was attached.", "format": "date-time", "type": [ "string", "null" ] }, "file_content_type": { "description": "MIME type of the file.", "type": "string" }, "file_name": { "description": "Original file name.", "type": "string" }, "id": { "description": "Attachment identifier (use GET /rest/ats/attachments for a download URL).", "format": "uuid", "type": "string" } }, "required": [ "id", "file_name", "ai_summary", "created_at", "file_content_type", "attachment_type_slug" ], "title": "AtsCandidatesCandidateIdGetResponsesContentApplicationJsonSchemaDataAttachmentsItems", "type": "object" }, "AtsCandidatesCandidateIdGetResponsesContentApplicationJsonSchemaDataAttachmentsItemsAttachmentTypeSlug": { "description": "Kind of attachment.", "enum": [ "CV", "LOGO", "OFFER_LETTER", "OTHER" ], "title": "AtsCandidatesCandidateIdGetResponsesContentApplicationJsonSchemaDataAttachmentsItemsAttachmentTypeSlug", "type": "string" }, "AtsCandidatesCandidateIdGetResponsesContentApplicationJsonSchemaDataCandidateTagsItems": { "description": "A tag applied to the candidate.", "properties": { "id": { "description": "Candidate tag record identifier.", "format": "uuid", "type": "string" }, "tag": { "$ref": "#/components/schemas/AtsCandidatesCandidateIdGetResponsesContentApplicationJsonSchemaDataCandidateTagsItemsTag", "description": "The tag." } }, "required": [ "id", "tag" ], "title": "AtsCandidatesCandidateIdGetResponsesContentApplicationJsonSchemaDataCandidateTagsItems", "type": "object" }, "AtsCandidatesCandidateIdGetResponsesContentApplicationJsonSchemaDataCandidateTagsItemsTag": { "description": "The tag.", "properties": { "id": { "description": "Tag identifier.", "format": "uuid", "type": "string" }, "label": { "description": "Tag label.", "type": "string" } }, "required": [ "id", "label" ], "title": "AtsCandidatesCandidateIdGetResponsesContentApplicationJsonSchemaDataCandidateTagsItemsTag", "type": "object" }, "AtsCandidatesCandidateIdGetResponsesContentApplicationJsonSchemaErrorsItems": { "properties": { "code": { "description": "Machine-readable error code", "type": "string" }, "field": { "description": "Request field related to the error, if applicable", "type": "string" }, "message": { "description": "Human-readable error message", "type": "string" } }, "required": [ "code", "message" ], "title": "AtsCandidatesCandidateIdGetResponsesContentApplicationJsonSchemaErrorsItems", "type": "object" }, "AtsCandidatesCandidateIdNotesPostParametersXBeta": { "default": "true", "enum": [ "true" ], "title": "AtsCandidatesCandidateIdNotesPostParametersXBeta", "type": "string" }, "AtsCandidatesCandidateIdNotesPostRequestBodyContentApplicationJsonSchemaData": { "properties": { "author_id": { "description": "The UUID of the HRIS organization user creating the note", "format": "uuid", "type": "string" }, "richtext_content": { "description": "The content of the note in rich text HTML format", "maxLength": 10000, "type": "string" } }, "required": [ "author_id", "richtext_content" ], "title": "AtsCandidatesCandidateIdNotesPostRequestBodyContentApplicationJsonSchemaData", "type": "object" }, "AtsCandidatesCandidateIdNotesPostResponsesContentApplicationJsonSchemaData": { "description": "The created candidate note", "properties": { "created_at": { "description": "The timestamp when the candidate note was created", "format": "date-time", "type": "string" }, "id": { "description": "The unique identifier of the candidate note", "format": "uuid", "type": "string" }, "updated_at": { "description": "The timestamp when the candidate note was last updated", "format": "date-time", "type": "string" } }, "required": [ "id", "created_at", "updated_at" ], "title": "AtsCandidatesCandidateIdNotesPostResponsesContentApplicationJsonSchemaData", "type": "object" }, "AtsCandidatesCandidateIdNotesPostResponsesContentApplicationJsonSchemaErrorsItems": { "properties": { "code": { "description": "Machine-readable error code", "type": "string" }, "field": { "description": "Request field related to the error, if applicable", "type": "string" }, "message": { "description": "Human-readable error message", "type": "string" } }, "required": [ "code", "message" ], "title": "AtsCandidatesCandidateIdNotesPostResponsesContentApplicationJsonSchemaErrorsItems", "type": "object" }, "AtsCandidatesCandidateIdPatchRequestBodyContentApplicationJsonSchemaData": { "properties": { "city": { "description": "City the candidate currently lives in", "type": [ "string", "null" ] }, "country_code": { "description": "ISO 3166-1 alpha-2 code of the country the candidate currently lives in", "type": [ "string", "null" ] }, "email": { "description": "The candidate's email address", "format": "email", "type": "string" }, "first_name": { "description": "The candidate's first name", "type": "string" }, "last_name": { "description": "The candidate's last name", "type": "string" }, "linkedin_profile_url": { "description": "The candidate's LinkedIn profile URL", "format": "uri", "type": "string" }, "origin_source_slug": { "description": "The candidate's origin source slug. Accepts any active source slug of the organization, e.g. sourced_internally, sourced_externally, external_career_page, linkedin_basic or a custom source slug (case-insensitive)", "type": "string" }, "phone_number": { "description": "The candidate's phone number", "type": "string" }, "pic_url": { "description": "The candidate's picture URL", "format": "uri", "type": "string" } }, "title": "AtsCandidatesCandidateIdPatchRequestBodyContentApplicationJsonSchemaData", "type": "object" }, "AtsCandidatesCandidateIdPatchResponsesContentApplicationJsonSchemaData": { "properties": { "anonymized_at": { "description": "Timestamp when the candidate was anonymized", "format": "date-time", "type": [ "string", "null" ] }, "city": { "description": "City the candidate currently lives in", "type": [ "string", "null" ] }, "country_code": { "description": "ISO 3166-1 alpha-2 country the candidate currently lives in", "type": [ "string", "null" ] }, "created_at": { "description": "Timestamp when the candidate was created", "format": "date-time", "type": "string" }, "email": { "description": "Email address of the candidate", "format": "email", "type": "string" }, "final_archivation_at": { "description": "Timestamp when the candidate was finally archived", "format": "date-time", "type": [ "string", "null" ] }, "first_name": { "description": "First name of the candidate", "type": "string" }, "id": { "description": "Unique identifier for the candidate", "format": "uuid", "type": "string" }, "import_session_id": { "description": "Import session identifier", "type": [ "string", "null" ] }, "imported_id": { "description": "Imported identifier", "type": [ "string", "null" ] }, "last_name": { "description": "Last name of the candidate", "type": "string" }, "linkedin_profile_url": { "description": "LinkedIn profile URL of the candidate", "type": [ "string", "null" ] }, "numeric_id": { "description": "Numeric identifier for the candidate", "type": "integer" }, "origin_source_slug": { "description": "Origin source slug of the candidate (e.g. sourced_internally, external_career_page or a custom source slug)", "type": [ "string", "null" ] }, "phone_number": { "description": "Phone number of the candidate", "type": [ "string", "null" ] }, "pic_url": { "description": "Profile picture URL of the candidate", "type": [ "string", "null" ] }, "source": { "description": "Source of the candidate", "type": [ "string", "null" ] }, "updated_at": { "description": "Timestamp when the candidate was last updated", "format": "date-time", "type": "string" } }, "required": [ "id", "email", "last_name", "created_at", "first_name", "numeric_id", "updated_at" ], "title": "AtsCandidatesCandidateIdPatchResponsesContentApplicationJsonSchemaData", "type": "object" }, "AtsCandidatesCandidateIdPatchResponsesContentApplicationJsonSchemaErrorsItems": { "properties": { "code": { "description": "Machine-readable error code", "type": "string" }, "field": { "description": "Request field related to the error, if applicable", "type": "string" }, "message": { "description": "Human-readable error message", "type": "string" } }, "required": [ "code", "message" ], "title": "AtsCandidatesCandidateIdPatchResponsesContentApplicationJsonSchemaErrorsItems", "type": "object" }, "AtsCandidatesCandidateIdTagsPostResponsesContentApplicationJsonSchemaDataItems": { "properties": { "candidate_id": { "description": "Unique identifier of the candidate.", "format": "uuid", "type": "string" }, "created_at": { "description": "When the association was created.", "format": "date-time", "type": "string" }, "id": { "description": "Unique identifier of the candidate-tag association.", "format": "uuid", "type": "string" }, "tag_id": { "description": "Unique identifier of the tag.", "format": "uuid", "type": "string" } }, "required": [ "id", "tag_id", "created_at", "candidate_id" ], "title": "AtsCandidatesCandidateIdTagsPostResponsesContentApplicationJsonSchemaDataItems", "type": "object" }, "AtsCandidatesCandidateIdTagsPostResponsesContentApplicationJsonSchemaErrorsItems": { "properties": { "code": { "description": "Machine-readable error code", "type": "string" }, "field": { "description": "Request field related to the error, if applicable", "type": "string" }, "message": { "description": "Human-readable error message", "type": "string" } }, "required": [ "code", "message" ], "title": "AtsCandidatesCandidateIdTagsPostResponsesContentApplicationJsonSchemaErrorsItems", "type": "object" }, "AtsCandidatesGetResponsesContentApplicationJsonSchemaDataItems": { "properties": { "anonymized_at": { "description": "Timestamp when the candidate was anonymized", "format": "date-time", "type": [ "string", "null" ] }, "applications": { "description": "Applications associated with the candidate", "items": { "$ref": "#/components/schemas/AtsCandidatesGetResponsesContentApplicationJsonSchemaDataItemsApplicationsItems" }, "type": "array" }, "candidate_tags": { "description": "Tags associated with the candidate", "items": { "$ref": "#/components/schemas/AtsCandidatesGetResponsesContentApplicationJsonSchemaDataItemsCandidateTagsItems" }, "type": [ "array", "null" ] }, "created_at": { "description": "Timestamp when the candidate was created", "format": "date-time", "type": "string" }, "email": { "description": "Candidate's email address", "format": "email", "type": "string" }, "final_archivation_at": { "description": "Timestamp of when the candidate was finally archived", "format": "date-time", "type": [ "string", "null" ] }, "first_name": { "description": "Candidate's first name", "type": "string" }, "id": { "description": "Unique identifier for the candidate", "format": "uuid", "type": "string" }, "import_session_id": { "description": "Import session identifier", "type": [ "string", "null" ] }, "imported_id": { "description": "Imported identifier", "type": [ "string", "null" ] }, "last_name": { "description": "Candidate's last name", "type": "string" }, "linkedin_profile_url": { "description": "URL of the candidate's LinkedIn profile", "type": [ "string", "null" ] }, "numeric_id": { "description": "Numeric identifier for the candidate", "format": "double", "type": "number" }, "origin_source_slug": { "description": "Origin source slug of the candidate (e.g. sourced_internally, external_career_page or a custom source slug)", "type": [ "string", "null" ] }, "phone_number": { "description": "Candidate's phone number", "type": [ "string", "null" ] }, "pic_url": { "description": "URL of the candidate's profile picture", "type": [ "string", "null" ] }, "source": { "description": "Source of the candidate", "type": [ "string", "null" ] }, "total_applications_count": { "description": "Total number of applications the candidate has", "format": "double", "type": "number" }, "updated_at": { "description": "Timestamp when the candidate was last updated", "format": "date-time", "type": "string" } }, "required": [ "id", "email", "last_name", "created_at", "first_name", "numeric_id", "updated_at" ], "title": "AtsCandidatesGetResponsesContentApplicationJsonSchemaDataItems", "type": "object" }, "AtsCandidatesGetResponsesContentApplicationJsonSchemaDataItemsApplicationsItems": { "properties": { "created_at": { "description": "Timestamp of when the application was created", "format": "date-time", "type": "string" }, "current_application_interview_plan_stage": { "oneOf": [ { "$ref": "#/components/schemas/AtsCandidatesGetResponsesContentApplicationJsonSchemaDataItemsApplicationsItemsCurrentApplicationInterviewPlanStage" }, { "type": "null" } ] }, "id": { "description": "Unique identifier for the application", "format": "uuid", "type": [ "string", "null" ] }, "job": { "$ref": "#/components/schemas/AtsCandidatesGetResponsesContentApplicationJsonSchemaDataItemsApplicationsItemsJob" } }, "title": "AtsCandidatesGetResponsesContentApplicationJsonSchemaDataItemsApplicationsItems", "type": "object" }, "AtsCandidatesGetResponsesContentApplicationJsonSchemaDataItemsApplicationsItemsCurrentApplicationInterviewPlanStage": { "properties": { "application_id": { "description": "Unique identifier for the application", "format": "uuid", "type": "string" }, "created_at": { "description": "Timestamp of when the current application interview plan stage was created", "format": "date-time", "type": "string" }, "id": { "description": "Unique identifier for the current application interview plan stage", "format": "uuid", "type": "string" }, "interview_plan_stage": { "oneOf": [ { "$ref": "#/components/schemas/AtsCandidatesGetResponsesContentApplicationJsonSchemaDataItemsApplicationsItemsCurrentApplicationInterviewPlanStageInterviewPlanStage" }, { "type": "null" } ] }, "interview_plan_stage_id": { "description": "Unique identifier for the interview plan stage", "format": "uuid", "type": "string" }, "status": { "$ref": "#/components/schemas/AtsCandidatesGetResponsesContentApplicationJsonSchemaDataItemsApplicationsItemsCurrentApplicationInterviewPlanStageStatus", "description": "Status of the current application interview plan stage" } }, "required": [ "id", "status", "created_at", "application_id", "interview_plan_stage_id" ], "title": "AtsCandidatesGetResponsesContentApplicationJsonSchemaDataItemsApplicationsItemsCurrentApplicationInterviewPlanStage", "type": "object" }, "AtsCandidatesGetResponsesContentApplicationJsonSchemaDataItemsApplicationsItemsCurrentApplicationInterviewPlanStageInterviewPlanStage": { "properties": { "category_type_slug": { "description": "Category type slug for the interview plan stage", "type": "string" }, "default_type_slug": { "description": "Default type slug for the interview plan stage", "type": [ "string", "null" ] }, "description": { "description": "Description of the interview plan stage", "type": [ "string", "null" ] }, "id": { "description": "Unique identifier for the interview plan stage", "format": "uuid", "type": "string" }, "interview_plan_id": { "description": "Unique identifier for the interview plan", "format": "uuid", "type": "string" }, "name": { "description": "Name of the interview plan stage", "type": "string" }, "stage_order": { "description": "Order of the stage in the interview plan", "format": "double", "type": "number" } }, "required": [ "id", "name", "stage_order", "interview_plan_id", "category_type_slug" ], "title": "AtsCandidatesGetResponsesContentApplicationJsonSchemaDataItemsApplicationsItemsCurrentApplicationInterviewPlanStageInterviewPlanStage", "type": "object" }, "AtsCandidatesGetResponsesContentApplicationJsonSchemaDataItemsApplicationsItemsCurrentApplicationInterviewPlanStageStatus": { "description": "Status of the current application interview plan stage", "enum": [ "ACTIVE", "COMPLETED", "PENDING", "REJECTED" ], "title": "AtsCandidatesGetResponsesContentApplicationJsonSchemaDataItemsApplicationsItemsCurrentApplicationInterviewPlanStageStatus", "type": "string" }, "AtsCandidatesGetResponsesContentApplicationJsonSchemaDataItemsApplicationsItemsJob": { "properties": { "id": { "description": "Unique identifier for the job", "format": "uuid", "type": "string" }, "title": { "description": "Job title", "type": "string" } }, "title": "AtsCandidatesGetResponsesContentApplicationJsonSchemaDataItemsApplicationsItemsJob", "type": "object" }, "AtsCandidatesGetResponsesContentApplicationJsonSchemaDataItemsCandidateTagsItems": { "properties": { "candidate_id": { "description": "Unique identifier for the candidate", "format": "uuid", "type": "string" }, "id": { "description": "Unique identifier for the candidate tag", "format": "uuid", "type": "string" }, "tag": { "oneOf": [ { "$ref": "#/components/schemas/AtsCandidatesGetResponsesContentApplicationJsonSchemaDataItemsCandidateTagsItemsTag" }, { "type": "null" } ] }, "tag_id": { "description": "Unique identifier for the tag", "format": "uuid", "type": "string" } }, "title": "AtsCandidatesGetResponsesContentApplicationJsonSchemaDataItemsCandidateTagsItems", "type": "object" }, "AtsCandidatesGetResponsesContentApplicationJsonSchemaDataItemsCandidateTagsItemsTag": { "properties": { "id": { "description": "Unique identifier for the tag", "format": "uuid", "type": "string" }, "label": { "description": "Label for the tag", "type": "string" } }, "title": "AtsCandidatesGetResponsesContentApplicationJsonSchemaDataItemsCandidateTagsItemsTag", "type": "object" }, "AtsCandidatesGetResponsesContentApplicationJsonSchemaErrorsItems": { "properties": { "code": { "description": "Machine-readable error code", "type": "string" }, "field": { "description": "Request field related to the error, if applicable", "type": "string" }, "message": { "description": "Human-readable error message", "type": "string" } }, "required": [ "code", "message" ], "title": "AtsCandidatesGetResponsesContentApplicationJsonSchemaErrorsItems", "type": "object" }, "AtsCandidatesPostRequestBodyContentApplicationJsonSchemaData": { "properties": { "city": { "description": "City the candidate currently lives in", "type": [ "string", "null" ] }, "country_code": { "description": "ISO 3166-1 alpha-2 code of the country the candidate currently lives in", "type": [ "string", "null" ] }, "email": { "description": "The candidate's email address", "format": "email", "type": "string" }, "first_name": { "description": "The candidate's first name", "type": "string" }, "last_name": { "description": "The candidate's last name", "type": "string" }, "linkedin_profile_url": { "description": "The candidate's LinkedIn profile URL", "format": "uri", "type": [ "string", "null" ] }, "origin_source_slug": { "description": "The candidate's origin source slug. Accepts any active source slug of the organization, e.g. sourced_internally, sourced_externally, external_career_page, linkedin_basic or a custom source slug (case-insensitive)", "type": "string" }, "phone_number": { "description": "The candidate's phone number", "type": [ "string", "null" ] }, "pic_url": { "description": "The candidate's picture URL", "format": "uri", "type": [ "string", "null" ] } }, "required": [ "email", "last_name", "first_name" ], "title": "AtsCandidatesPostRequestBodyContentApplicationJsonSchemaData", "type": "object" }, "AtsCandidatesPostResponsesContentApplicationJsonSchemaData": { "properties": { "anonymized_at": { "description": "Timestamp when the candidate was anonymized", "format": "date-time", "type": [ "string", "null" ] }, "city": { "description": "City the candidate currently lives in", "type": [ "string", "null" ] }, "country_code": { "description": "ISO 3166-1 alpha-2 country the candidate currently lives in", "type": [ "string", "null" ] }, "created_at": { "description": "Timestamp when the candidate was created", "format": "date-time", "type": "string" }, "email": { "description": "Email address of the candidate", "format": "email", "type": "string" }, "final_archivation_at": { "description": "Timestamp when the candidate was finally archived", "format": "date-time", "type": [ "string", "null" ] }, "first_name": { "description": "First name of the candidate", "type": "string" }, "id": { "description": "Unique identifier for the candidate", "format": "uuid", "type": "string" }, "import_session_id": { "description": "Import session identifier", "type": [ "string", "null" ] }, "imported_id": { "description": "Imported identifier", "type": [ "string", "null" ] }, "last_name": { "description": "Last name of the candidate", "type": "string" }, "linkedin_profile_url": { "description": "LinkedIn profile URL of the candidate", "type": [ "string", "null" ] }, "numeric_id": { "description": "Numeric identifier for the candidate", "type": "integer" }, "origin_source_slug": { "description": "Origin source slug of the candidate (e.g. sourced_internally, external_career_page or a custom source slug)", "type": [ "string", "null" ] }, "phone_number": { "description": "Phone number of the candidate", "type": [ "string", "null" ] }, "pic_url": { "description": "Profile picture URL of the candidate", "type": [ "string", "null" ] }, "source": { "description": "Source of the candidate", "type": [ "string", "null" ] }, "updated_at": { "description": "Timestamp when the candidate was last updated", "format": "date-time", "type": "string" } }, "required": [ "id", "email", "last_name", "created_at", "first_name", "numeric_id", "updated_at" ], "title": "AtsCandidatesPostResponsesContentApplicationJsonSchemaData", "type": "object" }, "AtsCandidatesPostResponsesContentApplicationJsonSchemaErrorsItems": { "properties": { "code": { "description": "Machine-readable error code", "type": "string" }, "field": { "description": "Request field related to the error, if applicable", "type": "string" }, "message": { "description": "Human-readable error message", "type": "string" } }, "required": [ "code", "message" ], "title": "AtsCandidatesPostResponsesContentApplicationJsonSchemaErrorsItems", "type": "object" }, "AtsDepartmentsGetResponsesContentApplicationJsonSchemaDataItems": { "properties": { "archived_at": { "description": "Timestamp when the department was archived; null while the department is active and selectable", "format": "date-time", "type": [ "string", "null" ] }, "created_at": { "description": "Timestamp when the department was created", "format": "date-time", "type": "string" }, "id": { "description": "Unique identifier for the department", "format": "uuid", "type": "string" }, "name": { "description": "Name of the department", "type": "string" }, "updated_at": { "description": "Timestamp when the department was last updated", "format": "date-time", "type": "string" } }, "required": [ "id", "name", "created_at", "updated_at" ], "title": "AtsDepartmentsGetResponsesContentApplicationJsonSchemaDataItems", "type": "object" }, "AtsDepartmentsGetResponsesContentApplicationJsonSchemaErrorsItems": { "properties": { "code": { "description": "Machine-readable error code", "type": "string" }, "field": { "description": "Request field related to the error, if applicable", "type": "string" }, "message": { "description": "Human-readable error message", "type": "string" } }, "required": [ "code", "message" ], "title": "AtsDepartmentsGetResponsesContentApplicationJsonSchemaErrorsItems", "type": "object" }, "AtsEmailTemplatesGetResponsesContentApplicationJsonSchemaDataItems": { "properties": { "created_at": { "description": "Timestamp of when the email template was created", "format": "date-time", "type": "string" }, "id": { "description": "Email template unique identifier", "format": "uuid", "type": "string" }, "title": { "description": "Email template title", "type": "string" }, "updated_at": { "description": "Timestamp of when the email template was last updated", "format": "date-time", "type": "string" } }, "required": [ "id", "title", "created_at", "updated_at" ], "title": "AtsEmailTemplatesGetResponsesContentApplicationJsonSchemaDataItems", "type": "object" }, "AtsEmailTemplatesGetResponsesContentApplicationJsonSchemaErrorsItems": { "properties": { "code": { "description": "Machine-readable error code", "type": "string" }, "field": { "description": "Request field related to the error, if applicable", "type": "string" }, "message": { "description": "Human-readable error message", "type": "string" } }, "required": [ "code", "message" ], "title": "AtsEmailTemplatesGetResponsesContentApplicationJsonSchemaErrorsItems", "type": "object" }, "AtsEmploymentTypesGetResponsesContentApplicationJsonSchemaDataItems": { "properties": { "created_at": { "description": "Timestamp when the employment type was created", "format": "date-time", "type": "string" }, "id": { "description": "Unique identifier for the employment type", "format": "uuid", "type": "string" }, "name": { "description": "Name of the employment type", "type": "string" }, "updated_at": { "description": "Timestamp when the employment type was last updated", "format": "date-time", "type": "string" } }, "required": [ "id", "name", "created_at", "updated_at" ], "title": "AtsEmploymentTypesGetResponsesContentApplicationJsonSchemaDataItems", "type": "object" }, "AtsEmploymentTypesGetResponsesContentApplicationJsonSchemaErrorsItems": { "properties": { "code": { "description": "Machine-readable error code", "type": "string" }, "field": { "description": "Request field related to the error, if applicable", "type": "string" }, "message": { "description": "Human-readable error message", "type": "string" } }, "required": [ "code", "message" ], "title": "AtsEmploymentTypesGetResponsesContentApplicationJsonSchemaErrorsItems", "type": "object" }, "AtsFeedbacksGetParametersActivityType": { "enum": [ "INTERVIEW_SCHEDULING", "APPLICATION_EVALUATION", "EXERCISE", "QUESTIONNAIRE" ], "title": "AtsFeedbacksGetParametersActivityType", "type": "string" }, "AtsFeedbacksGetParametersIncludeSchemaItems": { "enum": [ "FORM_RESPONSES" ], "title": "AtsFeedbacksGetParametersIncludeSchemaItems", "type": "string" }, "AtsFeedbacksGetParametersSortOrder": { "enum": [ "NEWEST_FIRST", "OLDEST_FIRST" ], "title": "AtsFeedbacksGetParametersSortOrder", "type": "string" }, "AtsFeedbacksGetParametersStatus": { "enum": [ "SUBMITTED", "NOT_SUBMITTED" ], "title": "AtsFeedbacksGetParametersStatus", "type": "string" }, "AtsFeedbacksGetResponsesContentApplicationJsonSchemaDataItems": { "properties": { "activity_type": { "description": "Kind of activity the feedback belongs to.", "oneOf": [ { "$ref": "#/components/schemas/AtsFeedbacksGetResponsesContentApplicationJsonSchemaDataItemsActivityType" }, { "type": "null" } ] }, "application": { "$ref": "#/components/schemas/AtsFeedbacksGetResponsesContentApplicationJsonSchemaDataItemsApplication", "description": "Application the feedback is about." }, "application_activity_id": { "description": "Activity the feedback belongs to.", "format": "uuid", "type": "string" }, "application_interview_plan_stage_id": { "description": "Application stage record the activity belongs to.", "format": "uuid", "type": [ "string", "null" ] }, "created_at": { "description": "When the feedback request was created.", "format": "date-time", "type": "string" }, "feedback_form": { "$ref": "#/components/schemas/AtsFeedbacksGetResponsesContentApplicationJsonSchemaDataItemsFeedbackForm", "description": "Scorecard template used." }, "form_responses": { "description": "Submitted scorecard answers. Present only when include=FORM_RESPONSES is requested; null when nothing was submitted.", "items": { "$ref": "#/components/schemas/AtsFeedbacksGetResponsesContentApplicationJsonSchemaDataItemsFormResponsesItems" }, "type": [ "array", "null" ] }, "id": { "description": "Unique identifier of the feedback record.", "format": "uuid", "type": "string" }, "interview_plan_stage": { "description": "Interview plan stage the activity belongs to.", "oneOf": [ { "$ref": "#/components/schemas/AtsFeedbacksGetResponsesContentApplicationJsonSchemaDataItemsInterviewPlanStage" }, { "type": "null" } ] }, "overall_recommendation": { "description": "The recommendation the reviewer selected; null while pending.", "oneOf": [ { "$ref": "#/components/schemas/AtsFeedbacksGetResponsesContentApplicationJsonSchemaDataItemsOverallRecommendation" }, { "type": "null" } ] }, "reviewer": { "$ref": "#/components/schemas/AtsFeedbacksGetResponsesContentApplicationJsonSchemaDataItemsReviewer", "description": "Reviewer who owes or provided the feedback." }, "scheduled_interview": { "description": "The interview the feedback was collected for; null for non-interview activities.", "oneOf": [ { "$ref": "#/components/schemas/AtsFeedbacksGetResponsesContentApplicationJsonSchemaDataItemsScheduledInterview" }, { "type": "null" } ] }, "status": { "$ref": "#/components/schemas/AtsFeedbacksGetResponsesContentApplicationJsonSchemaDataItemsStatus", "description": "Submission status." }, "submitted_at": { "description": "When the feedback was submitted; null while still owed.", "format": "date-time", "type": [ "string", "null" ] }, "updated_at": { "description": "When the feedback was last updated.", "format": "date-time", "type": "string" } }, "required": [ "id", "status", "reviewer", "created_at", "updated_at", "application", "submitted_at", "activity_type", "feedback_form", "scheduled_interview", "interview_plan_stage", "overall_recommendation", "application_activity_id", "application_interview_plan_stage_id" ], "title": "AtsFeedbacksGetResponsesContentApplicationJsonSchemaDataItems", "type": "object" }, "AtsFeedbacksGetResponsesContentApplicationJsonSchemaDataItemsActivityType": { "description": "Kind of activity the feedback belongs to.", "enum": [ "INTERVIEW_SCHEDULING", "APPLICATION_EVALUATION", "EXERCISE", "QUESTIONNAIRE", "EMAIL_SENDING" ], "title": "AtsFeedbacksGetResponsesContentApplicationJsonSchemaDataItemsActivityType", "type": "string" }, "AtsFeedbacksGetResponsesContentApplicationJsonSchemaDataItemsApplication": { "description": "Application the feedback is about.", "properties": { "candidate": { "$ref": "#/components/schemas/AtsFeedbacksGetResponsesContentApplicationJsonSchemaDataItemsApplicationCandidate", "description": "Candidate on the application." }, "current_application_interview_plan_stage": { "description": "Where the candidate is now.", "oneOf": [ { "$ref": "#/components/schemas/AtsFeedbacksGetResponsesContentApplicationJsonSchemaDataItemsApplicationCurrentApplicationInterviewPlanStage" }, { "type": "null" } ] }, "id": { "description": "Application identifier.", "format": "uuid", "type": "string" }, "job": { "$ref": "#/components/schemas/AtsFeedbacksGetResponsesContentApplicationJsonSchemaDataItemsApplicationJob", "description": "Job of the application." } }, "required": [ "id", "job", "candidate", "current_application_interview_plan_stage" ], "title": "AtsFeedbacksGetResponsesContentApplicationJsonSchemaDataItemsApplication", "type": "object" }, "AtsFeedbacksGetResponsesContentApplicationJsonSchemaDataItemsApplicationCandidate": { "description": "Candidate on the application.", "properties": { "email": { "description": "Candidate email.", "format": "email", "type": "string" }, "first_name": { "description": "Candidate first name.", "type": "string" }, "id": { "description": "Candidate identifier.", "format": "uuid", "type": "string" }, "last_name": { "description": "Candidate last name.", "type": "string" } }, "required": [ "id", "email", "last_name", "first_name" ], "title": "AtsFeedbacksGetResponsesContentApplicationJsonSchemaDataItemsApplicationCandidate", "type": "object" }, "AtsFeedbacksGetResponsesContentApplicationJsonSchemaDataItemsApplicationCurrentApplicationInterviewPlanStage": { "description": "Where the candidate is now.", "properties": { "id": { "description": "Current application stage record.", "format": "uuid", "type": "string" }, "interview_plan_stage": { "description": "The current interview plan stage.", "oneOf": [ { "$ref": "#/components/schemas/AtsFeedbacksGetResponsesContentApplicationJsonSchemaDataItemsApplicationCurrentApplicationInterviewPlanStageInterviewPlanStage" }, { "type": "null" } ] } }, "required": [ "id", "interview_plan_stage" ], "title": "AtsFeedbacksGetResponsesContentApplicationJsonSchemaDataItemsApplicationCurrentApplicationInterviewPlanStage", "type": "object" }, "AtsFeedbacksGetResponsesContentApplicationJsonSchemaDataItemsApplicationCurrentApplicationInterviewPlanStageInterviewPlanStage": { "description": "The current interview plan stage.", "properties": { "id": { "description": "Interview plan stage identifier.", "format": "uuid", "type": "string" }, "name": { "description": "Customer-defined stage name.", "type": "string" } }, "required": [ "id", "name" ], "title": "AtsFeedbacksGetResponsesContentApplicationJsonSchemaDataItemsApplicationCurrentApplicationInterviewPlanStageInterviewPlanStage", "type": "object" }, "AtsFeedbacksGetResponsesContentApplicationJsonSchemaDataItemsApplicationJob": { "description": "Job of the application.", "properties": { "id": { "description": "Job identifier.", "format": "uuid", "type": "string" }, "title": { "description": "Job title.", "type": "string" } }, "required": [ "id", "title" ], "title": "AtsFeedbacksGetResponsesContentApplicationJsonSchemaDataItemsApplicationJob", "type": "object" }, "AtsFeedbacksGetResponsesContentApplicationJsonSchemaDataItemsFeedbackForm": { "description": "Scorecard template used.", "properties": { "id": { "description": "Feedback form identifier.", "format": "uuid", "type": "string" }, "title": { "description": "Feedback form title.", "type": "string" } }, "required": [ "id", "title" ], "title": "AtsFeedbacksGetResponsesContentApplicationJsonSchemaDataItemsFeedbackForm", "type": "object" }, "AtsFeedbacksGetResponsesContentApplicationJsonSchemaDataItemsFormResponsesItems": { "properties": { "answer": { "$ref": "#/components/schemas/AtsFeedbacksGetResponsesContentApplicationJsonSchemaDataItemsFormResponsesItemsAnswer", "description": "Answer value; shape varies by question type (string, number, array, or object)." }, "question_text": { "description": "Text of the scorecard question.", "type": "string" }, "question_type": { "description": "Type of the question field.", "type": "string" } }, "required": [ "answer", "question_text", "question_type" ], "title": "AtsFeedbacksGetResponsesContentApplicationJsonSchemaDataItemsFormResponsesItems", "type": "object" }, "AtsFeedbacksGetResponsesContentApplicationJsonSchemaDataItemsFormResponsesItemsAnswer": { "description": "Answer value; shape varies by question type (string, number, array, or object).", "oneOf": [ { "type": "string" }, { "format": "double", "type": "number" }, { "type": "boolean" }, { "items": { "description": "Any type" }, "type": "array" }, { "additionalProperties": { "description": "Any type" }, "type": "object" } ], "title": "AtsFeedbacksGetResponsesContentApplicationJsonSchemaDataItemsFormResponsesItemsAnswer" }, "AtsFeedbacksGetResponsesContentApplicationJsonSchemaDataItemsInterviewPlanStage": { "description": "Interview plan stage the activity belongs to.", "properties": { "category_type_slug": { "description": "Stage category: lead, active or completed.", "type": "string" }, "id": { "description": "Interview plan stage identifier.", "format": "uuid", "type": "string" }, "name": { "description": "Customer-defined stage name.", "type": "string" } }, "required": [ "id", "name", "category_type_slug" ], "title": "AtsFeedbacksGetResponsesContentApplicationJsonSchemaDataItemsInterviewPlanStage", "type": "object" }, "AtsFeedbacksGetResponsesContentApplicationJsonSchemaDataItemsOverallRecommendation": { "description": "The recommendation the reviewer selected; null while pending.", "properties": { "scale_id": { "description": "Feedback scale identifier.", "format": "uuid", "type": "string" }, "scale_item_id": { "description": "Selected scale item.", "format": "uuid", "type": "string" }, "scale_item_label": { "description": "Label of the selected scale item.", "type": "string" }, "scale_item_position": { "description": "Zero-based position of the selected item within its scale, lowest first — comparable across labels.", "type": "integer" }, "scale_items_count": { "description": "Number of items in the scale.", "type": "integer" }, "scale_title": { "description": "Feedback scale title.", "type": [ "string", "null" ] } }, "required": [ "scale_id", "scale_title", "scale_item_id", "scale_item_label", "scale_items_count", "scale_item_position" ], "title": "AtsFeedbacksGetResponsesContentApplicationJsonSchemaDataItemsOverallRecommendation", "type": "object" }, "AtsFeedbacksGetResponsesContentApplicationJsonSchemaDataItemsReviewer": { "description": "Reviewer who owes or provided the feedback.", "properties": { "participant_hris_organization_user_id": { "description": "HRIS organization user ID of the reviewer.", "format": "uuid", "type": "string" }, "reviewer_profile": { "oneOf": [ { "$ref": "#/components/schemas/AtsFeedbacksGetResponsesContentApplicationJsonSchemaDataItemsReviewerReviewerProfile" }, { "type": "null" } ] } }, "required": [ "participant_hris_organization_user_id" ], "title": "AtsFeedbacksGetResponsesContentApplicationJsonSchemaDataItemsReviewer", "type": "object" }, "AtsFeedbacksGetResponsesContentApplicationJsonSchemaDataItemsReviewerReviewerProfile": { "properties": { "country": { "description": "ISO 3166-1 alpha-2 country code.", "type": [ "string", "null" ] }, "first_name": { "description": "First name.", "type": "string" }, "full_name": { "description": "Full name.", "type": "string" }, "hris_organization_user_id": { "description": "HRIS organization user ID.", "format": "uuid", "type": "string" }, "job_title": { "description": "Job title.", "type": [ "string", "null" ] }, "last_name": { "description": "Last name.", "type": "string" }, "pic_url": { "description": "Profile picture URL.", "type": [ "string", "null" ] }, "type": { "$ref": "#/components/schemas/AtsFeedbacksGetResponsesContentApplicationJsonSchemaDataItemsReviewerReviewerProfileType", "description": "Participant type within the organization." }, "work_email": { "description": "Work email.", "format": "email", "type": [ "string", "null" ] } }, "title": "AtsFeedbacksGetResponsesContentApplicationJsonSchemaDataItemsReviewerReviewerProfile", "type": "object" }, "AtsFeedbacksGetResponsesContentApplicationJsonSchemaDataItemsReviewerReviewerProfileType": { "description": "Participant type within the organization.", "enum": [ "CLIENT", "WORKER" ], "title": "AtsFeedbacksGetResponsesContentApplicationJsonSchemaDataItemsReviewerReviewerProfileType", "type": "string" }, "AtsFeedbacksGetResponsesContentApplicationJsonSchemaDataItemsScheduledInterview": { "description": "The interview the feedback was collected for; null for non-interview activities.", "properties": { "ends_at": { "description": "Interview end.", "format": "date-time", "type": [ "string", "null" ] }, "has_happened": { "description": "True when the interview took place; combine with status NOT_SUBMITTED to find overdue scorecards.", "type": "boolean" }, "id": { "description": "Scheduled interview identifier.", "format": "uuid", "type": "string" }, "starts_at": { "description": "Interview start.", "format": "date-time", "type": [ "string", "null" ] }, "status_enum": { "description": "Interview status.", "type": "string" } }, "required": [ "id", "ends_at", "starts_at", "status_enum", "has_happened" ], "title": "AtsFeedbacksGetResponsesContentApplicationJsonSchemaDataItemsScheduledInterview", "type": "object" }, "AtsFeedbacksGetResponsesContentApplicationJsonSchemaDataItemsStatus": { "description": "Submission status.", "enum": [ "SUBMITTED", "NOT_SUBMITTED" ], "title": "AtsFeedbacksGetResponsesContentApplicationJsonSchemaDataItemsStatus", "type": "string" }, "AtsFeedbacksGetResponsesContentApplicationJsonSchemaErrorsItems": { "properties": { "code": { "description": "Machine-readable error code", "type": "string" }, "field": { "description": "Request field related to the error, if applicable", "type": "string" }, "message": { "description": "Human-readable error message", "type": "string" } }, "required": [ "code", "message" ], "title": "AtsFeedbacksGetResponsesContentApplicationJsonSchemaErrorsItems", "type": "object" }, "AtsHiresGetParametersXBeta": { "default": "true", "enum": [ "true" ], "title": "AtsHiresGetParametersXBeta", "type": "string" }, "AtsHiresGetResponsesContentApplicationJsonSchemaDataItems": { "properties": { "application_id": { "description": "Identifier of the ATS application that was moved to HRIS", "format": "uuid", "type": "string" }, "candidate_id": { "description": "Identifier of the candidate the application belongs to", "format": "uuid", "type": "string" }, "draft_quote_id": { "description": "Identifier of the draft quote associated with this hire. Null when no draft quote exists.", "format": "uuid", "type": [ "string", "null" ] }, "hris_profile_id": { "description": "Numeric identifier of the HRIS profile the application was hired into. Null while the profile does not exist yet.", "type": [ "integer", "null" ] }, "hris_profile_public_id": { "description": "Public (UUID) identifier of the same HRIS profile as hris_profile_id. Null while the profile does not exist yet.", "format": "uuid", "type": [ "string", "null" ] }, "offer_id": { "description": "Identifier of the accepted offer the hire was created from", "format": "uuid", "type": "string" }, "organization_id": { "description": "Identifier of the organization that owns the record", "format": "uuid", "type": "string" }, "status_enum": { "$ref": "#/components/schemas/AtsHiresGetResponsesContentApplicationJsonSchemaDataItemsStatusEnum", "description": "State of the move to HRIS. DRAFT: a draft quote exists but no contract yet. CREATED: the HRIS profile and contract exist. DRAFT_DELETED: the draft was discarded." }, "updated_at": { "description": "Timestamp of the last change to the record. Records are returned oldest change first, so the last row of a drain is a safe watermark.", "format": "date-time", "type": "string" }, "worker_id": { "description": "Worker identifier of the same HRIS profile. Null while the profile does not exist yet.", "type": [ "integer", "null" ] } }, "required": [ "offer_id", "worker_id", "updated_at", "status_enum", "candidate_id", "application_id", "draft_quote_id", "hris_profile_id", "organization_id", "hris_profile_public_id" ], "title": "AtsHiresGetResponsesContentApplicationJsonSchemaDataItems", "type": "object" }, "AtsHiresGetResponsesContentApplicationJsonSchemaDataItemsStatusEnum": { "description": "State of the move to HRIS. DRAFT: a draft quote exists but no contract yet. CREATED: the HRIS profile and contract exist. DRAFT_DELETED: the draft was discarded.", "enum": [ "DRAFT", "DRAFT_DELETED", "CREATED" ], "title": "AtsHiresGetResponsesContentApplicationJsonSchemaDataItemsStatusEnum", "type": "string" }, "AtsHiresGetResponsesContentApplicationJsonSchemaErrorsItems": { "properties": { "code": { "description": "Machine-readable error code", "type": "string" }, "field": { "description": "Request field related to the error, if applicable", "type": "string" }, "message": { "description": "Human-readable error message", "type": "string" } }, "required": [ "code", "message" ], "title": "AtsHiresGetResponsesContentApplicationJsonSchemaErrorsItems", "type": "object" }, "AtsHiringMembersGetResponsesContentApplicationJsonSchemaDataItems": { "properties": { "created_at": { "description": "Creation timestamp", "format": "date-time", "type": "string" }, "first_name": { "description": "User's first name", "type": "string" }, "hris_organization_user_id": { "description": "Unique identifier for the HRIS organization user", "type": "string" }, "id": { "description": "Unique identifier", "format": "uuid", "type": "string" }, "job_title": { "description": "User's job title", "type": [ "string", "null" ] }, "last_name": { "description": "User's last name", "type": "string" }, "pic_url": { "description": "URL to the user's profile picture", "format": "uri", "type": [ "string", "null" ] }, "updated_at": { "description": "Last update timestamp", "format": "date-time", "type": [ "string", "null" ] }, "work_email": { "description": "User's work email address", "format": "email", "type": "string" } }, "required": [ "id", "last_name", "created_at", "first_name", "work_email", "hris_organization_user_id" ], "title": "AtsHiringMembersGetResponsesContentApplicationJsonSchemaDataItems", "type": "object" }, "AtsHiringMembersGetResponsesContentApplicationJsonSchemaErrorsItems": { "properties": { "code": { "description": "Machine-readable error code", "type": "string" }, "field": { "description": "Request field related to the error, if applicable", "type": "string" }, "message": { "description": "Human-readable error message", "type": "string" } }, "required": [ "code", "message" ], "title": "AtsHiringMembersGetResponsesContentApplicationJsonSchemaErrorsItems", "type": "object" }, "AtsInterviewsGetParametersSortOrder": { "enum": [ "SCHEDULED_FIRST", "NEWEST_FIRST", "OLDEST_FIRST", "LATEST_MEETING_FIRST" ], "title": "AtsInterviewsGetParametersSortOrder", "type": "string" }, "AtsInterviewsGetParametersStatusSchemaItems": { "enum": [ "SCHEDULE_NEEDED", "LINK_SENT", "SLOT_REQUEST_SENT", "SLOTS_SUBMITTED", "SCHEDULED", "RESCHEDULE_REQUESTED", "CANCELLED", "COMPLETED" ], "title": "AtsInterviewsGetParametersStatusSchemaItems", "type": "string" }, "AtsInterviewsGetResponsesContentApplicationJsonSchemaDataItems": { "properties": { "application": { "$ref": "#/components/schemas/AtsInterviewsGetResponsesContentApplicationJsonSchemaDataItemsApplication", "description": "Application linked to this interview." }, "application_activity": { "$ref": "#/components/schemas/AtsInterviewsGetResponsesContentApplicationJsonSchemaDataItemsApplicationActivity", "description": "Interview activity details including configuration and participants." }, "application_activity_id": { "description": "ID of the application activity linked to this interview.", "format": "uuid", "type": "string" }, "application_interview_plan_stage_id": { "description": "ID of the application stage record the interview belongs to.", "format": "uuid", "type": [ "string", "null" ] }, "cancellation_reason": { "description": "Free-text cancellation reason; null unless cancelled.", "type": [ "string", "null" ] }, "cancellation_reason_id": { "description": "Cancellation reason ID (see GET /rest/ats/reasons with reason_group_slug=INTERVIEW_CANCELLATION); null unless cancelled.", "format": "uuid", "type": [ "string", "null" ] }, "cancelled_at": { "description": "ISO 8601 datetime when the interview was cancelled; null unless cancelled.", "format": "date-time", "type": [ "string", "null" ] }, "created_at": { "description": "ISO 8601 datetime when the interview record was created.", "format": "date-time", "type": "string" }, "created_by_hris_organization_user_id": { "description": "HRIS organization user who created the interview.", "format": "uuid", "type": [ "string", "null" ] }, "ends_at": { "description": "ISO 8601 datetime when the interview ends.", "format": "date-time", "type": [ "string", "null" ] }, "has_happened": { "description": "True when the interview took place: status SCHEDULED or COMPLETED and the meeting end (or start, when no end is recorded) is in the past. False for cancelled interviews and interviews not yet held.", "type": "boolean" }, "id": { "description": "Unique identifier of the interview.", "format": "uuid", "type": "string" }, "interview_plan_stage": { "description": "The interview plan stage the interview belongs to, independent of the candidate's current stage.", "oneOf": [ { "$ref": "#/components/schemas/AtsInterviewsGetResponsesContentApplicationJsonSchemaDataItemsInterviewPlanStage" }, { "type": "null" } ] }, "meeting_url": { "description": "Video conferencing URL for the interview.", "type": [ "string", "null" ] }, "starts_at": { "description": "ISO 8601 datetime when the interview starts.", "format": "date-time", "type": [ "string", "null" ] }, "status_enum": { "$ref": "#/components/schemas/AtsInterviewsGetResponsesContentApplicationJsonSchemaDataItemsStatusEnum", "description": "Current status of the interview." }, "timezone": { "description": "IANA timezone of the interview.", "type": [ "string", "null" ] }, "updated_at": { "description": "ISO 8601 datetime when the interview record was last updated.", "format": "date-time", "type": "string" } }, "required": [ "id", "created_at", "updated_at", "application", "status_enum", "application_activity", "application_activity_id" ], "title": "AtsInterviewsGetResponsesContentApplicationJsonSchemaDataItems", "type": "object" }, "AtsInterviewsGetResponsesContentApplicationJsonSchemaDataItemsApplication": { "description": "Application linked to this interview.", "properties": { "candidate": { "$ref": "#/components/schemas/AtsInterviewsGetResponsesContentApplicationJsonSchemaDataItemsApplicationCandidate", "description": "Candidate being interviewed." }, "current_application_interview_plan_stage": { "description": "The stage the candidate is in now, which may differ from the stage the interview belongs to.", "oneOf": [ { "$ref": "#/components/schemas/AtsInterviewsGetResponsesContentApplicationJsonSchemaDataItemsApplicationCurrentApplicationInterviewPlanStage" }, { "type": "null" } ] }, "id": { "description": "Unique identifier of the application.", "format": "uuid", "type": "string" }, "job": { "$ref": "#/components/schemas/AtsInterviewsGetResponsesContentApplicationJsonSchemaDataItemsApplicationJob", "description": "Job linked to the application." } }, "required": [ "id", "job", "candidate" ], "title": "AtsInterviewsGetResponsesContentApplicationJsonSchemaDataItemsApplication", "type": "object" }, "AtsInterviewsGetResponsesContentApplicationJsonSchemaDataItemsApplicationActivity": { "description": "Interview activity details including configuration and participants.", "properties": { "application_activity_participations": { "description": "List of interviewers participating in this interview.", "items": { "$ref": "#/components/schemas/AtsInterviewsGetResponsesContentApplicationJsonSchemaDataItemsApplicationActivityApplicationActivityParticipationsItems" }, "type": "array" }, "interview_title": { "description": "Title of the interview stage.", "type": [ "string", "null" ] }, "length_in_minutes": { "description": "Planned interview duration in minutes.", "type": [ "integer", "null" ] } }, "title": "AtsInterviewsGetResponsesContentApplicationJsonSchemaDataItemsApplicationActivity", "type": "object" }, "AtsInterviewsGetResponsesContentApplicationJsonSchemaDataItemsApplicationActivityApplicationActivityParticipationsItems": { "properties": { "application_activity_feedbacks": { "description": "Feedback entries submitted by this participant for the interview.", "items": { "$ref": "#/components/schemas/AtsInterviewsGetResponsesContentApplicationJsonSchemaDataItemsApplicationActivityApplicationActivityParticipationsItemsApplicationActivityFeedbacksItems" }, "type": "array" }, "id": { "description": "Unique identifier of the participation record.", "format": "uuid", "type": "string" }, "participant_hris_organization_user_id": { "description": "HRIS organization user ID of the interviewer.", "format": "uuid", "type": "string" }, "participant_hris_organization_user_profile": { "oneOf": [ { "$ref": "#/components/schemas/AtsInterviewsGetResponsesContentApplicationJsonSchemaDataItemsApplicationActivityApplicationActivityParticipationsItemsParticipantHrisOrganizationUserProfile" }, { "type": "null" } ] } }, "required": [ "id", "participant_hris_organization_user_id" ], "title": "AtsInterviewsGetResponsesContentApplicationJsonSchemaDataItemsApplicationActivityApplicationActivityParticipationsItems", "type": "object" }, "AtsInterviewsGetResponsesContentApplicationJsonSchemaDataItemsApplicationActivityApplicationActivityParticipationsItemsApplicationActivityFeedbacksItems": { "properties": { "id": { "description": "Unique identifier of the feedback record.", "format": "uuid", "type": "string" }, "overall_recommendation": { "description": "The recommendation the interviewer selected (e.g. \"Strong Yes\"); null while pending or when the caller may only see their own recommendations.", "oneOf": [ { "$ref": "#/components/schemas/AtsInterviewsGetResponsesContentApplicationJsonSchemaDataItemsApplicationActivityApplicationActivityParticipationsItemsApplicationActivityFeedbacksItemsOverallRecommendation" }, { "type": "null" } ] }, "submitted_at": { "description": "ISO 8601 datetime when the feedback was submitted; null while it is still pending.", "format": "date-time", "type": [ "string", "null" ] } }, "required": [ "id" ], "title": "AtsInterviewsGetResponsesContentApplicationJsonSchemaDataItemsApplicationActivityApplicationActivityParticipationsItemsApplicationActivityFeedbacksItems", "type": "object" }, "AtsInterviewsGetResponsesContentApplicationJsonSchemaDataItemsApplicationActivityApplicationActivityParticipationsItemsApplicationActivityFeedbacksItemsOverallRecommendation": { "description": "The recommendation the interviewer selected (e.g. \"Strong Yes\"); null while pending or when the caller may only see their own recommendations.", "properties": { "scale_item_id": { "description": "Feedback scale item identifier.", "format": "uuid", "type": "string" }, "scale_item_label": { "description": "Feedback scale item label.", "type": "string" } }, "required": [ "scale_item_id", "scale_item_label" ], "title": "AtsInterviewsGetResponsesContentApplicationJsonSchemaDataItemsApplicationActivityApplicationActivityParticipationsItemsApplicationActivityFeedbacksItemsOverallRecommendation", "type": "object" }, "AtsInterviewsGetResponsesContentApplicationJsonSchemaDataItemsApplicationActivityApplicationActivityParticipationsItemsParticipantHrisOrganizationUserProfile": { "properties": { "country": { "description": "ISO 3166-1 alpha-2 country code.", "type": [ "string", "null" ] }, "first_name": { "description": "First name.", "type": "string" }, "full_name": { "description": "Full name.", "type": "string" }, "hris_organization_user_id": { "description": "HRIS organization user ID.", "format": "uuid", "type": "string" }, "job_title": { "description": "Job title.", "type": [ "string", "null" ] }, "last_name": { "description": "Last name.", "type": "string" }, "pic_url": { "description": "Profile picture URL.", "type": [ "string", "null" ] }, "type": { "$ref": "#/components/schemas/AtsInterviewsGetResponsesContentApplicationJsonSchemaDataItemsApplicationActivityApplicationActivityParticipationsItemsParticipantHrisOrganizationUserProfileType", "description": "Participant type within the organization." }, "work_email": { "description": "Work email.", "format": "email", "type": [ "string", "null" ] } }, "title": "AtsInterviewsGetResponsesContentApplicationJsonSchemaDataItemsApplicationActivityApplicationActivityParticipationsItemsParticipantHrisOrganizationUserProfile", "type": "object" }, "AtsInterviewsGetResponsesContentApplicationJsonSchemaDataItemsApplicationActivityApplicationActivityParticipationsItemsParticipantHrisOrganizationUserProfileType": { "description": "Participant type within the organization.", "enum": [ "CLIENT", "WORKER" ], "title": "AtsInterviewsGetResponsesContentApplicationJsonSchemaDataItemsApplicationActivityApplicationActivityParticipationsItemsParticipantHrisOrganizationUserProfileType", "type": "string" }, "AtsInterviewsGetResponsesContentApplicationJsonSchemaDataItemsApplicationCandidate": { "description": "Candidate being interviewed.", "properties": { "email": { "description": "Email address of the candidate.", "format": "email", "type": "string" }, "first_name": { "description": "First name of the candidate.", "type": "string" }, "id": { "description": "Unique identifier of the candidate.", "format": "uuid", "type": "string" }, "last_name": { "description": "Last name of the candidate.", "type": "string" }, "pic_url": { "description": "Profile picture URL of the candidate.", "type": [ "string", "null" ] } }, "required": [ "id", "email", "last_name", "first_name" ], "title": "AtsInterviewsGetResponsesContentApplicationJsonSchemaDataItemsApplicationCandidate", "type": "object" }, "AtsInterviewsGetResponsesContentApplicationJsonSchemaDataItemsApplicationCurrentApplicationInterviewPlanStage": { "description": "The stage the candidate is in now, which may differ from the stage the interview belongs to.", "properties": { "id": { "description": "Identifier of the current application stage record.", "format": "uuid", "type": "string" }, "interview_plan_stage": { "description": "The current interview plan stage.", "oneOf": [ { "$ref": "#/components/schemas/AtsInterviewsGetResponsesContentApplicationJsonSchemaDataItemsApplicationCurrentApplicationInterviewPlanStageInterviewPlanStage" }, { "type": "null" } ] } }, "required": [ "id", "interview_plan_stage" ], "title": "AtsInterviewsGetResponsesContentApplicationJsonSchemaDataItemsApplicationCurrentApplicationInterviewPlanStage", "type": "object" }, "AtsInterviewsGetResponsesContentApplicationJsonSchemaDataItemsApplicationCurrentApplicationInterviewPlanStageInterviewPlanStage": { "description": "The current interview plan stage.", "properties": { "id": { "description": "Interview plan stage identifier.", "format": "uuid", "type": "string" }, "name": { "description": "Customer-defined stage name.", "type": "string" } }, "required": [ "id", "name" ], "title": "AtsInterviewsGetResponsesContentApplicationJsonSchemaDataItemsApplicationCurrentApplicationInterviewPlanStageInterviewPlanStage", "type": "object" }, "AtsInterviewsGetResponsesContentApplicationJsonSchemaDataItemsApplicationJob": { "description": "Job linked to the application.", "properties": { "id": { "description": "Unique identifier of the job.", "format": "uuid", "type": "string" }, "title": { "description": "Title of the job position.", "type": "string" } }, "required": [ "id", "title" ], "title": "AtsInterviewsGetResponsesContentApplicationJsonSchemaDataItemsApplicationJob", "type": "object" }, "AtsInterviewsGetResponsesContentApplicationJsonSchemaDataItemsInterviewPlanStage": { "description": "The interview plan stage the interview belongs to, independent of the candidate's current stage.", "properties": { "category_type_slug": { "description": "Stage category: lead, active or completed.", "type": "string" }, "default_type_slug": { "description": "System stage type (e.g. new_lead, application_review, offer, hired, archived); null for custom stages.", "type": [ "string", "null" ] }, "id": { "description": "Interview plan stage identifier.", "format": "uuid", "type": "string" }, "name": { "description": "Customer-defined stage name.", "type": "string" }, "position_number": { "description": "Position of the stage in the interview plan.", "type": "integer" } }, "required": [ "id", "name", "position_number", "default_type_slug", "category_type_slug" ], "title": "AtsInterviewsGetResponsesContentApplicationJsonSchemaDataItemsInterviewPlanStage", "type": "object" }, "AtsInterviewsGetResponsesContentApplicationJsonSchemaDataItemsStatusEnum": { "description": "Current status of the interview.", "enum": [ "SCHEDULE_NEEDED", "LINK_SENT", "SLOT_REQUEST_SENT", "SLOTS_SUBMITTED", "SCHEDULED", "RESCHEDULE_REQUESTED", "CANCELLED", "COMPLETED" ], "title": "AtsInterviewsGetResponsesContentApplicationJsonSchemaDataItemsStatusEnum", "type": "string" }, "AtsInterviewsGetResponsesContentApplicationJsonSchemaErrorsItems": { "properties": { "code": { "description": "Machine-readable error code", "type": "string" }, "field": { "description": "Request field related to the error, if applicable", "type": "string" }, "message": { "description": "Human-readable error message", "type": "string" } }, "required": [ "code", "message" ], "title": "AtsInterviewsGetResponsesContentApplicationJsonSchemaErrorsItems", "type": "object" }, "AtsInterviewsInterviewIdTranscriptGetParametersXBeta": { "default": "true", "enum": [ "true" ], "title": "AtsInterviewsInterviewIdTranscriptGetParametersXBeta", "type": "string" }, "AtsInterviewsInterviewIdTranscriptGetResponsesContentApplicationJsonSchemaDataItems": { "properties": { "id": { "description": "Unique identifier of the transcript segment.", "format": "uuid", "type": "string" }, "is_meeting_host": { "description": "Whether the speaker was the meeting host.", "type": "boolean" }, "offset_seconds": { "description": "Seconds elapsed since the start of the interview when the segment was spoken.", "type": "integer" }, "speaker_name": { "description": "Name of the meeting participant who spoke this segment, as captured by the transcription bot.", "type": "string" }, "spoken_at": { "description": "ISO 8601 datetime when the segment was spoken.", "format": "date-time", "type": "string" }, "text": { "description": "Verbatim text of the spoken segment. May contain special-category data the candidate volunteered.", "type": "string" } }, "required": [ "id", "text", "spoken_at", "speaker_name", "offset_seconds", "is_meeting_host" ], "title": "AtsInterviewsInterviewIdTranscriptGetResponsesContentApplicationJsonSchemaDataItems", "type": "object" }, "AtsInterviewsInterviewIdTranscriptGetResponsesContentApplicationJsonSchemaErrorsItems": { "properties": { "code": { "description": "Machine-readable error code", "type": "string" }, "field": { "description": "Request field related to the error, if applicable", "type": "string" }, "message": { "description": "Human-readable error message", "type": "string" } }, "required": [ "code", "message" ], "title": "AtsInterviewsInterviewIdTranscriptGetResponsesContentApplicationJsonSchemaErrorsItems", "type": "object" }, "AtsJobBoardsGetResponsesContentApplicationJsonSchemaDataItems": { "description": "Job board with type, status, settings, and associated career page configuration if applicable", "properties": { "career_page_setting": { "description": "Career page settings associated with the job board", "oneOf": [ { "$ref": "#/components/schemas/AtsJobBoardsGetResponsesContentApplicationJsonSchemaDataItemsCareerPageSetting" }, { "type": "null" } ] }, "created_at": { "description": "Timestamp when the job board was created", "format": "date-time", "type": "string" }, "id": { "description": "Job board unique identifier", "format": "uuid", "type": "string" }, "settings_json": { "description": "Job board specific settings", "oneOf": [ { "$ref": "#/components/schemas/AtsJobBoardsGetResponsesContentApplicationJsonSchemaDataItemsSettingsJson" }, { "type": "null" } ] }, "status_enum": { "$ref": "#/components/schemas/AtsJobBoardsGetResponsesContentApplicationJsonSchemaDataItemsStatusEnum", "description": "Current status of the job board" }, "type_enum": { "$ref": "#/components/schemas/AtsJobBoardsGetResponsesContentApplicationJsonSchemaDataItemsTypeEnum", "description": "Type of the job board" }, "updated_at": { "description": "Timestamp when the job board was last updated", "format": "date-time", "type": "string" } }, "required": [ "id", "type_enum", "created_at", "updated_at", "status_enum", "settings_json" ], "title": "AtsJobBoardsGetResponsesContentApplicationJsonSchemaDataItems", "type": "object" }, "AtsJobBoardsGetResponsesContentApplicationJsonSchemaDataItemsCareerPageSetting": { "description": "Career page settings associated with the job board", "properties": { "banner_image_url": { "description": "URL for the banner image", "type": [ "string", "null" ] }, "dark_mode_color_primary_hexcode": { "description": "Primary color hex code for dark mode", "type": [ "string", "null" ] }, "dark_mode_logo_url": { "description": "URL for the logo in dark mode", "type": [ "string", "null" ] }, "description": { "description": "Description displayed on the career page", "type": [ "string", "null" ] }, "id": { "description": "Career page setting unique identifier", "format": "uuid", "type": "string" }, "is_primary": { "description": "Whether this is the primary career page setting", "type": "boolean" }, "light_mode_color_primary_hexcode": { "description": "Primary color hex code for light mode", "type": [ "string", "null" ] }, "light_mode_logo_url": { "description": "URL for the logo in light mode", "type": [ "string", "null" ] }, "organization_id": { "description": "Organization unique identifier", "format": "uuid", "type": "string" }, "preferred_organization_name": { "description": "Display name for the organization on the career page", "type": "string" }, "should_show_banner_on_job_details_page": { "description": "Whether to show the banner on job details page", "type": "boolean" }, "should_show_job_filters": { "description": "Whether to show job filtering options", "type": "boolean" }, "should_show_logo": { "description": "Whether to show the organization logo", "type": "boolean" }, "title": { "description": "Title displayed on the career page", "type": [ "string", "null" ] }, "url_slug": { "description": "URL slug for the career page", "type": "string" } }, "required": [ "id", "title", "url_slug", "is_primary", "description", "organization_id", "banner_image_url", "should_show_logo", "dark_mode_logo_url", "light_mode_logo_url", "should_show_job_filters", "preferred_organization_name", "dark_mode_color_primary_hexcode", "light_mode_color_primary_hexcode", "should_show_banner_on_job_details_page" ], "title": "AtsJobBoardsGetResponsesContentApplicationJsonSchemaDataItemsCareerPageSetting", "type": "object" }, "AtsJobBoardsGetResponsesContentApplicationJsonSchemaDataItemsSettingsJson": { "description": "Job board specific settings", "properties": { "company_id": { "description": "Company ID for external job boards (e.g., LinkedIn)", "type": "string" } }, "title": "AtsJobBoardsGetResponsesContentApplicationJsonSchemaDataItemsSettingsJson", "type": "object" }, "AtsJobBoardsGetResponsesContentApplicationJsonSchemaDataItemsStatusEnum": { "description": "Current status of the job board", "enum": [ "ENABLED", "DISABLED", "ARCHIVED" ], "title": "AtsJobBoardsGetResponsesContentApplicationJsonSchemaDataItemsStatusEnum", "type": "string" }, "AtsJobBoardsGetResponsesContentApplicationJsonSchemaDataItemsTypeEnum": { "description": "Type of the job board", "enum": [ "INTERNAL_CAREER_PAGE", "EXTERNAL_CAREER_PAGE", "LINKEDIN" ], "title": "AtsJobBoardsGetResponsesContentApplicationJsonSchemaDataItemsTypeEnum", "type": "string" }, "AtsJobBoardsGetResponsesContentApplicationJsonSchemaErrorsItems": { "properties": { "code": { "description": "Machine-readable error code", "type": "string" }, "field": { "description": "Request field related to the error, if applicable", "type": "string" }, "message": { "description": "Human-readable error message", "type": "string" } }, "required": [ "code", "message" ], "title": "AtsJobBoardsGetResponsesContentApplicationJsonSchemaErrorsItems", "type": "object" }, "AtsJobBoardsJobBoardIdJobPostingsGetResponsesContentApplicationJsonSchemaDataItems": { "description": "Job posting with nested job details and publication status.", "properties": { "application_form": { "description": "Application form assigned to the job posting", "oneOf": [ { "$ref": "#/components/schemas/AtsJobBoardsJobBoardIdJobPostingsGetResponsesContentApplicationJsonSchemaDataItemsApplicationForm" }, { "type": "null" } ] }, "created_at": { "description": "Creation timestamp", "format": "date-time", "type": "string" }, "id": { "description": "Unique identifier for the job posting", "format": "uuid", "type": "string" }, "is_compensation_visible": { "description": "Indicates if compensation details are visible to candidates", "type": "boolean" }, "job": { "$ref": "#/components/schemas/AtsJobBoardsJobBoardIdJobPostingsGetResponsesContentApplicationJsonSchemaDataItemsJob", "description": "Associated job information" }, "job_id": { "description": "Identifier of the underlying job this posting belongs to.", "format": "uuid", "type": "string" }, "publications": { "description": "Publication rows for this posting, one per job board integration, with current state.", "items": { "$ref": "#/components/schemas/AtsJobBoardsJobBoardIdJobPostingsGetResponsesContentApplicationJsonSchemaDataItemsPublicationsItems" }, "type": "array" }, "richtext_description": { "description": "Rich text description of the job posting", "type": [ "string", "null" ] }, "title": { "description": "Job posting title", "maxLength": 200, "type": "string" }, "updated_at": { "description": "Last update timestamp", "format": "date-time", "type": "string" } }, "required": [ "id", "job", "title", "job_id", "created_at", "updated_at", "publications", "richtext_description", "is_compensation_visible" ], "title": "AtsJobBoardsJobBoardIdJobPostingsGetResponsesContentApplicationJsonSchemaDataItems", "type": "object" }, "AtsJobBoardsJobBoardIdJobPostingsGetResponsesContentApplicationJsonSchemaDataItemsApplicationForm": { "description": "Application form assigned to the job posting", "properties": { "id": { "description": "Unique identifier for the application form", "format": "uuid", "type": "string" }, "title": { "description": "Title of the application form", "type": "string" } }, "required": [ "id", "title" ], "title": "AtsJobBoardsJobBoardIdJobPostingsGetResponsesContentApplicationJsonSchemaDataItemsApplicationForm", "type": "object" }, "AtsJobBoardsJobBoardIdJobPostingsGetResponsesContentApplicationJsonSchemaDataItemsJob": { "description": "Associated job information", "properties": { "compensation": { "description": "Compensation information for the job", "oneOf": [ { "$ref": "#/components/schemas/AtsJobBoardsJobBoardIdJobPostingsGetResponsesContentApplicationJsonSchemaDataItemsJobCompensation" }, { "type": "null" } ] }, "id": { "description": "Unique identifier for the job", "format": "uuid", "type": "string" }, "job_departments": { "description": "Departments associated with the job", "items": { "$ref": "#/components/schemas/AtsJobBoardsJobBoardIdJobPostingsGetResponsesContentApplicationJsonSchemaDataItemsJobJobDepartmentsItems" }, "type": [ "array", "null" ] }, "job_employment_types": { "description": "Employment types associated with the job", "items": { "$ref": "#/components/schemas/AtsJobBoardsJobBoardIdJobPostingsGetResponsesContentApplicationJsonSchemaDataItemsJobJobEmploymentTypesItems" }, "type": "array" }, "job_locations": { "description": "Locations associated with the job", "items": { "$ref": "#/components/schemas/AtsJobBoardsJobBoardIdJobPostingsGetResponsesContentApplicationJsonSchemaDataItemsJobJobLocationsItems" }, "type": "array" }, "job_teams": { "description": "Teams associated with the job", "items": { "$ref": "#/components/schemas/AtsJobBoardsJobBoardIdJobPostingsGetResponsesContentApplicationJsonSchemaDataItemsJobJobTeamsItems" }, "type": [ "array", "null" ] } }, "required": [ "id", "compensation", "job_locations", "job_employment_types" ], "title": "AtsJobBoardsJobBoardIdJobPostingsGetResponsesContentApplicationJsonSchemaDataItemsJob", "type": "object" }, "AtsJobBoardsJobBoardIdJobPostingsGetResponsesContentApplicationJsonSchemaDataItemsJobCompensation": { "description": "Compensation information for the job", "properties": { "currency_iso_code": { "description": "Currency ISO code for the compensation", "type": "string" }, "id": { "description": "Unique identifier for the compensation record", "format": "uuid", "type": "string" }, "max_amount": { "description": "Maximum compensation amount", "format": "double", "type": [ "number", "null" ] }, "min_amount": { "description": "Minimum compensation amount", "format": "double", "type": [ "number", "null" ] } }, "required": [ "id", "currency_iso_code" ], "title": "AtsJobBoardsJobBoardIdJobPostingsGetResponsesContentApplicationJsonSchemaDataItemsJobCompensation", "type": "object" }, "AtsJobBoardsJobBoardIdJobPostingsGetResponsesContentApplicationJsonSchemaDataItemsJobJobDepartmentsItems": { "properties": { "department": { "oneOf": [ { "$ref": "#/components/schemas/AtsJobBoardsJobBoardIdJobPostingsGetResponsesContentApplicationJsonSchemaDataItemsJobJobDepartmentsItemsDepartment" }, { "type": "null" } ] }, "id": { "description": "Job-department association row identifier.", "format": "uuid", "type": "string" } }, "required": [ "id" ], "title": "AtsJobBoardsJobBoardIdJobPostingsGetResponsesContentApplicationJsonSchemaDataItemsJobJobDepartmentsItems", "type": "object" }, "AtsJobBoardsJobBoardIdJobPostingsGetResponsesContentApplicationJsonSchemaDataItemsJobJobDepartmentsItemsDepartment": { "properties": { "id": { "description": "Department identifier.", "format": "uuid", "type": "string" }, "name": { "description": "Display name of the department.", "maxLength": 100, "type": "string" } }, "title": "AtsJobBoardsJobBoardIdJobPostingsGetResponsesContentApplicationJsonSchemaDataItemsJobJobDepartmentsItemsDepartment", "type": "object" }, "AtsJobBoardsJobBoardIdJobPostingsGetResponsesContentApplicationJsonSchemaDataItemsJobJobEmploymentTypesItems": { "properties": { "employment_type": { "$ref": "#/components/schemas/AtsJobBoardsJobBoardIdJobPostingsGetResponsesContentApplicationJsonSchemaDataItemsJobJobEmploymentTypesItemsEmploymentType", "description": "Details for the employment type assigned to the job" }, "id": { "description": "Unique identifier for the job employment type", "format": "uuid", "type": "string" } }, "required": [ "id", "employment_type" ], "title": "AtsJobBoardsJobBoardIdJobPostingsGetResponsesContentApplicationJsonSchemaDataItemsJobJobEmploymentTypesItems", "type": "object" }, "AtsJobBoardsJobBoardIdJobPostingsGetResponsesContentApplicationJsonSchemaDataItemsJobJobEmploymentTypesItemsEmploymentType": { "description": "Details for the employment type assigned to the job", "properties": { "id": { "description": "Unique identifier for the employment type", "format": "uuid", "type": "string" }, "name": { "description": "Employment type name", "type": "string" } }, "required": [ "id", "name" ], "title": "AtsJobBoardsJobBoardIdJobPostingsGetResponsesContentApplicationJsonSchemaDataItemsJobJobEmploymentTypesItemsEmploymentType", "type": "object" }, "AtsJobBoardsJobBoardIdJobPostingsGetResponsesContentApplicationJsonSchemaDataItemsJobJobLocationsItems": { "properties": { "id": { "description": "Unique identifier for the job location", "format": "uuid", "type": "string" }, "location": { "$ref": "#/components/schemas/AtsJobBoardsJobBoardIdJobPostingsGetResponsesContentApplicationJsonSchemaDataItemsJobJobLocationsItemsLocation", "description": "Details for the location assigned to the job" } }, "required": [ "id", "location" ], "title": "AtsJobBoardsJobBoardIdJobPostingsGetResponsesContentApplicationJsonSchemaDataItemsJobJobLocationsItems", "type": "object" }, "AtsJobBoardsJobBoardIdJobPostingsGetResponsesContentApplicationJsonSchemaDataItemsJobJobLocationsItemsLocation": { "description": "Details for the location assigned to the job", "properties": { "id": { "description": "Unique identifier for the location", "format": "uuid", "type": "string" }, "name": { "description": "Location name", "type": "string" } }, "required": [ "id", "name" ], "title": "AtsJobBoardsJobBoardIdJobPostingsGetResponsesContentApplicationJsonSchemaDataItemsJobJobLocationsItemsLocation", "type": "object" }, "AtsJobBoardsJobBoardIdJobPostingsGetResponsesContentApplicationJsonSchemaDataItemsJobJobTeamsItems": { "properties": { "id": { "description": "Unique identifier for the job team", "format": "uuid", "type": "string" }, "team": { "$ref": "#/components/schemas/AtsJobBoardsJobBoardIdJobPostingsGetResponsesContentApplicationJsonSchemaDataItemsJobJobTeamsItemsTeam", "description": "Details for the team assigned to the job" } }, "required": [ "id", "team" ], "title": "AtsJobBoardsJobBoardIdJobPostingsGetResponsesContentApplicationJsonSchemaDataItemsJobJobTeamsItems", "type": "object" }, "AtsJobBoardsJobBoardIdJobPostingsGetResponsesContentApplicationJsonSchemaDataItemsJobJobTeamsItemsTeam": { "description": "Details for the team assigned to the job", "properties": { "id": { "description": "Unique identifier for the team", "format": "uuid", "type": "string" }, "name": { "description": "Team name", "type": "string" } }, "required": [ "id", "name" ], "title": "AtsJobBoardsJobBoardIdJobPostingsGetResponsesContentApplicationJsonSchemaDataItemsJobJobTeamsItemsTeam", "type": "object" }, "AtsJobBoardsJobBoardIdJobPostingsGetResponsesContentApplicationJsonSchemaDataItemsPublicationsItems": { "description": "Publication information for different job boards", "properties": { "current_state": { "$ref": "#/components/schemas/AtsJobBoardsJobBoardIdJobPostingsGetResponsesContentApplicationJsonSchemaDataItemsPublicationsItemsCurrentState", "description": "Current publication state details" }, "id": { "description": "Unique identifier for the job posting publication", "format": "uuid", "type": "string" }, "job_board": { "$ref": "#/components/schemas/AtsJobBoardsJobBoardIdJobPostingsGetResponsesContentApplicationJsonSchemaDataItemsPublicationsItemsJobBoard", "description": "Job board where the posting is published" } }, "required": [ "id", "job_board", "current_state" ], "title": "AtsJobBoardsJobBoardIdJobPostingsGetResponsesContentApplicationJsonSchemaDataItemsPublicationsItems", "type": "object" }, "AtsJobBoardsJobBoardIdJobPostingsGetResponsesContentApplicationJsonSchemaDataItemsPublicationsItemsCurrentState": { "description": "Current publication state details", "properties": { "created_at": { "description": "Timestamp when the publication was created", "format": "date-time", "type": "string" }, "created_by": { "description": "User who created the publication", "format": "uuid", "type": [ "string", "null" ] }, "error_message": { "description": "Error message if publication failed", "type": [ "string", "null" ] }, "id": { "description": "Unique identifier for the publication state", "format": "uuid", "type": "string" }, "state_slug": { "$ref": "#/components/schemas/AtsJobBoardsJobBoardIdJobPostingsGetResponsesContentApplicationJsonSchemaDataItemsPublicationsItemsCurrentStateStateSlug", "description": "Current publication state" } }, "required": [ "id", "created_at", "state_slug" ], "title": "AtsJobBoardsJobBoardIdJobPostingsGetResponsesContentApplicationJsonSchemaDataItemsPublicationsItemsCurrentState", "type": "object" }, "AtsJobBoardsJobBoardIdJobPostingsGetResponsesContentApplicationJsonSchemaDataItemsPublicationsItemsCurrentStateStateSlug": { "description": "Current publication state", "enum": [ "PUBLISHED_BASIC", "PUBLISHED_PREMIUM", "UNPUBLISHED", "EXPIRED", "IN_PROGRESS", "FAILED" ], "title": "AtsJobBoardsJobBoardIdJobPostingsGetResponsesContentApplicationJsonSchemaDataItemsPublicationsItemsCurrentStateStateSlug", "type": "string" }, "AtsJobBoardsJobBoardIdJobPostingsGetResponsesContentApplicationJsonSchemaDataItemsPublicationsItemsJobBoard": { "description": "Job board where the posting is published", "properties": { "id": { "description": "Unique identifier for the job board", "format": "uuid", "type": "string" } }, "required": [ "id" ], "title": "AtsJobBoardsJobBoardIdJobPostingsGetResponsesContentApplicationJsonSchemaDataItemsPublicationsItemsJobBoard", "type": "object" }, "AtsJobBoardsJobBoardIdJobPostingsGetResponsesContentApplicationJsonSchemaErrorsItems": { "properties": { "code": { "description": "Machine-readable error code", "type": "string" }, "field": { "description": "Request field related to the error, if applicable", "type": "string" }, "message": { "description": "Human-readable error message", "type": "string" } }, "required": [ "code", "message" ], "title": "AtsJobBoardsJobBoardIdJobPostingsGetResponsesContentApplicationJsonSchemaErrorsItems", "type": "object" }, "AtsJobPostingsGetResponsesContentApplicationJsonSchemaDataItems": { "description": "Job posting with nested job details and publication status.", "properties": { "application_form": { "description": "Application form assigned to the job posting", "oneOf": [ { "$ref": "#/components/schemas/AtsJobPostingsGetResponsesContentApplicationJsonSchemaDataItemsApplicationForm" }, { "type": "null" } ] }, "created_at": { "description": "Creation timestamp", "format": "date-time", "type": "string" }, "id": { "description": "Unique identifier for the job posting", "format": "uuid", "type": "string" }, "is_compensation_visible": { "description": "Indicates if compensation details are visible to candidates", "type": "boolean" }, "job": { "$ref": "#/components/schemas/AtsJobPostingsGetResponsesContentApplicationJsonSchemaDataItemsJob", "description": "Associated job information" }, "job_id": { "description": "Identifier of the underlying job this posting belongs to.", "format": "uuid", "type": "string" }, "publications": { "description": "Publication rows for this posting, one per job board integration, with current state.", "items": { "$ref": "#/components/schemas/AtsJobPostingsGetResponsesContentApplicationJsonSchemaDataItemsPublicationsItems" }, "type": "array" }, "richtext_description": { "description": "Rich text description of the job posting", "type": [ "string", "null" ] }, "title": { "description": "Job posting title", "maxLength": 200, "type": "string" }, "updated_at": { "description": "Last update timestamp", "format": "date-time", "type": "string" } }, "required": [ "id", "job", "title", "job_id", "created_at", "updated_at", "publications", "richtext_description", "is_compensation_visible" ], "title": "AtsJobPostingsGetResponsesContentApplicationJsonSchemaDataItems", "type": "object" }, "AtsJobPostingsGetResponsesContentApplicationJsonSchemaDataItemsApplicationForm": { "description": "Application form assigned to the job posting", "properties": { "id": { "description": "Unique identifier for the application form", "format": "uuid", "type": "string" }, "title": { "description": "Title of the application form", "type": "string" } }, "required": [ "id", "title" ], "title": "AtsJobPostingsGetResponsesContentApplicationJsonSchemaDataItemsApplicationForm", "type": "object" }, "AtsJobPostingsGetResponsesContentApplicationJsonSchemaDataItemsJob": { "description": "Associated job information", "properties": { "compensation": { "description": "Compensation information for the job", "oneOf": [ { "$ref": "#/components/schemas/AtsJobPostingsGetResponsesContentApplicationJsonSchemaDataItemsJobCompensation" }, { "type": "null" } ] }, "id": { "description": "Unique identifier for the job", "format": "uuid", "type": "string" }, "job_departments": { "description": "Departments associated with the job", "items": { "$ref": "#/components/schemas/AtsJobPostingsGetResponsesContentApplicationJsonSchemaDataItemsJobJobDepartmentsItems" }, "type": [ "array", "null" ] }, "job_employment_types": { "description": "Employment types associated with the job", "items": { "$ref": "#/components/schemas/AtsJobPostingsGetResponsesContentApplicationJsonSchemaDataItemsJobJobEmploymentTypesItems" }, "type": "array" }, "job_locations": { "description": "Locations associated with the job", "items": { "$ref": "#/components/schemas/AtsJobPostingsGetResponsesContentApplicationJsonSchemaDataItemsJobJobLocationsItems" }, "type": "array" }, "job_teams": { "description": "Teams associated with the job", "items": { "$ref": "#/components/schemas/AtsJobPostingsGetResponsesContentApplicationJsonSchemaDataItemsJobJobTeamsItems" }, "type": [ "array", "null" ] } }, "required": [ "id", "compensation", "job_locations", "job_employment_types" ], "title": "AtsJobPostingsGetResponsesContentApplicationJsonSchemaDataItemsJob", "type": "object" }, "AtsJobPostingsGetResponsesContentApplicationJsonSchemaDataItemsJobCompensation": { "description": "Compensation information for the job", "properties": { "currency_iso_code": { "description": "Currency ISO code for the compensation", "type": "string" }, "id": { "description": "Unique identifier for the compensation record", "format": "uuid", "type": "string" }, "max_amount": { "description": "Maximum compensation amount", "format": "double", "type": [ "number", "null" ] }, "min_amount": { "description": "Minimum compensation amount", "format": "double", "type": [ "number", "null" ] } }, "required": [ "id", "currency_iso_code" ], "title": "AtsJobPostingsGetResponsesContentApplicationJsonSchemaDataItemsJobCompensation", "type": "object" }, "AtsJobPostingsGetResponsesContentApplicationJsonSchemaDataItemsJobJobDepartmentsItems": { "properties": { "department": { "oneOf": [ { "$ref": "#/components/schemas/AtsJobPostingsGetResponsesContentApplicationJsonSchemaDataItemsJobJobDepartmentsItemsDepartment" }, { "type": "null" } ] }, "id": { "description": "Job-department association row identifier.", "format": "uuid", "type": "string" } }, "required": [ "id" ], "title": "AtsJobPostingsGetResponsesContentApplicationJsonSchemaDataItemsJobJobDepartmentsItems", "type": "object" }, "AtsJobPostingsGetResponsesContentApplicationJsonSchemaDataItemsJobJobDepartmentsItemsDepartment": { "properties": { "id": { "description": "Department identifier.", "format": "uuid", "type": "string" }, "name": { "description": "Display name of the department.", "maxLength": 100, "type": "string" } }, "title": "AtsJobPostingsGetResponsesContentApplicationJsonSchemaDataItemsJobJobDepartmentsItemsDepartment", "type": "object" }, "AtsJobPostingsGetResponsesContentApplicationJsonSchemaDataItemsJobJobEmploymentTypesItems": { "properties": { "employment_type": { "$ref": "#/components/schemas/AtsJobPostingsGetResponsesContentApplicationJsonSchemaDataItemsJobJobEmploymentTypesItemsEmploymentType", "description": "Details for the employment type assigned to the job" }, "id": { "description": "Unique identifier for the job employment type", "format": "uuid", "type": "string" } }, "required": [ "id", "employment_type" ], "title": "AtsJobPostingsGetResponsesContentApplicationJsonSchemaDataItemsJobJobEmploymentTypesItems", "type": "object" }, "AtsJobPostingsGetResponsesContentApplicationJsonSchemaDataItemsJobJobEmploymentTypesItemsEmploymentType": { "description": "Details for the employment type assigned to the job", "properties": { "id": { "description": "Unique identifier for the employment type", "format": "uuid", "type": "string" }, "name": { "description": "Employment type name", "type": "string" } }, "required": [ "id", "name" ], "title": "AtsJobPostingsGetResponsesContentApplicationJsonSchemaDataItemsJobJobEmploymentTypesItemsEmploymentType", "type": "object" }, "AtsJobPostingsGetResponsesContentApplicationJsonSchemaDataItemsJobJobLocationsItems": { "properties": { "id": { "description": "Unique identifier for the job location", "format": "uuid", "type": "string" }, "location": { "$ref": "#/components/schemas/AtsJobPostingsGetResponsesContentApplicationJsonSchemaDataItemsJobJobLocationsItemsLocation", "description": "Details for the location assigned to the job" } }, "required": [ "id", "location" ], "title": "AtsJobPostingsGetResponsesContentApplicationJsonSchemaDataItemsJobJobLocationsItems", "type": "object" }, "AtsJobPostingsGetResponsesContentApplicationJsonSchemaDataItemsJobJobLocationsItemsLocation": { "description": "Details for the location assigned to the job", "properties": { "id": { "description": "Unique identifier for the location", "format": "uuid", "type": "string" }, "name": { "description": "Location name", "type": "string" } }, "required": [ "id", "name" ], "title": "AtsJobPostingsGetResponsesContentApplicationJsonSchemaDataItemsJobJobLocationsItemsLocation", "type": "object" }, "AtsJobPostingsGetResponsesContentApplicationJsonSchemaDataItemsJobJobTeamsItems": { "properties": { "id": { "description": "Unique identifier for the job team", "format": "uuid", "type": "string" }, "team": { "$ref": "#/components/schemas/AtsJobPostingsGetResponsesContentApplicationJsonSchemaDataItemsJobJobTeamsItemsTeam", "description": "Details for the team assigned to the job" } }, "required": [ "id", "team" ], "title": "AtsJobPostingsGetResponsesContentApplicationJsonSchemaDataItemsJobJobTeamsItems", "type": "object" }, "AtsJobPostingsGetResponsesContentApplicationJsonSchemaDataItemsJobJobTeamsItemsTeam": { "description": "Details for the team assigned to the job", "properties": { "id": { "description": "Unique identifier for the team", "format": "uuid", "type": "string" }, "name": { "description": "Team name", "type": "string" } }, "required": [ "id", "name" ], "title": "AtsJobPostingsGetResponsesContentApplicationJsonSchemaDataItemsJobJobTeamsItemsTeam", "type": "object" }, "AtsJobPostingsGetResponsesContentApplicationJsonSchemaDataItemsPublicationsItems": { "description": "Publication information for different job boards", "properties": { "current_state": { "$ref": "#/components/schemas/AtsJobPostingsGetResponsesContentApplicationJsonSchemaDataItemsPublicationsItemsCurrentState", "description": "Current publication state details" }, "id": { "description": "Unique identifier for the job posting publication", "format": "uuid", "type": "string" }, "job_board": { "$ref": "#/components/schemas/AtsJobPostingsGetResponsesContentApplicationJsonSchemaDataItemsPublicationsItemsJobBoard", "description": "Job board where the posting is published" } }, "required": [ "id", "job_board", "current_state" ], "title": "AtsJobPostingsGetResponsesContentApplicationJsonSchemaDataItemsPublicationsItems", "type": "object" }, "AtsJobPostingsGetResponsesContentApplicationJsonSchemaDataItemsPublicationsItemsCurrentState": { "description": "Current publication state details", "properties": { "created_at": { "description": "Timestamp when the publication was created", "format": "date-time", "type": "string" }, "created_by": { "description": "User who created the publication", "format": "uuid", "type": [ "string", "null" ] }, "error_message": { "description": "Error message if publication failed", "type": [ "string", "null" ] }, "id": { "description": "Unique identifier for the publication state", "format": "uuid", "type": "string" }, "state_slug": { "$ref": "#/components/schemas/AtsJobPostingsGetResponsesContentApplicationJsonSchemaDataItemsPublicationsItemsCurrentStateStateSlug", "description": "Current publication state" } }, "required": [ "id", "created_at", "state_slug" ], "title": "AtsJobPostingsGetResponsesContentApplicationJsonSchemaDataItemsPublicationsItemsCurrentState", "type": "object" }, "AtsJobPostingsGetResponsesContentApplicationJsonSchemaDataItemsPublicationsItemsCurrentStateStateSlug": { "description": "Current publication state", "enum": [ "PUBLISHED_BASIC", "PUBLISHED_PREMIUM", "UNPUBLISHED", "EXPIRED", "IN_PROGRESS", "FAILED" ], "title": "AtsJobPostingsGetResponsesContentApplicationJsonSchemaDataItemsPublicationsItemsCurrentStateStateSlug", "type": "string" }, "AtsJobPostingsGetResponsesContentApplicationJsonSchemaDataItemsPublicationsItemsJobBoard": { "description": "Job board where the posting is published", "properties": { "id": { "description": "Unique identifier for the job board", "format": "uuid", "type": "string" } }, "required": [ "id" ], "title": "AtsJobPostingsGetResponsesContentApplicationJsonSchemaDataItemsPublicationsItemsJobBoard", "type": "object" }, "AtsJobPostingsGetResponsesContentApplicationJsonSchemaErrorsItems": { "properties": { "code": { "description": "Machine-readable error code", "type": "string" }, "field": { "description": "Request field related to the error, if applicable", "type": "string" }, "message": { "description": "Human-readable error message", "type": "string" } }, "required": [ "code", "message" ], "title": "AtsJobPostingsGetResponsesContentApplicationJsonSchemaErrorsItems", "type": "object" }, "AtsJobPostingsJobPostingIdGetResponsesContentApplicationJsonSchemaData": { "description": "Job posting with nested job details and publication status.", "properties": { "application_form": { "description": "Application form assigned to the job posting", "oneOf": [ { "$ref": "#/components/schemas/AtsJobPostingsJobPostingIdGetResponsesContentApplicationJsonSchemaDataApplicationForm" }, { "type": "null" } ] }, "created_at": { "description": "Creation timestamp", "format": "date-time", "type": "string" }, "id": { "description": "Unique identifier for the job posting", "format": "uuid", "type": "string" }, "is_compensation_visible": { "description": "Indicates if compensation details are visible to candidates", "type": "boolean" }, "job": { "$ref": "#/components/schemas/AtsJobPostingsJobPostingIdGetResponsesContentApplicationJsonSchemaDataJob", "description": "Associated job information" }, "job_id": { "description": "Identifier of the underlying job this posting belongs to.", "format": "uuid", "type": "string" }, "publications": { "description": "Publication rows for this posting, one per job board integration, with current state.", "items": { "$ref": "#/components/schemas/AtsJobPostingsJobPostingIdGetResponsesContentApplicationJsonSchemaDataPublicationsItems" }, "type": "array" }, "richtext_description": { "description": "Rich text description of the job posting", "type": [ "string", "null" ] }, "title": { "description": "Job posting title", "maxLength": 200, "type": "string" }, "updated_at": { "description": "Last update timestamp", "format": "date-time", "type": "string" } }, "required": [ "id", "job", "title", "job_id", "created_at", "updated_at", "publications", "richtext_description", "is_compensation_visible" ], "title": "AtsJobPostingsJobPostingIdGetResponsesContentApplicationJsonSchemaData", "type": "object" }, "AtsJobPostingsJobPostingIdGetResponsesContentApplicationJsonSchemaDataApplicationForm": { "description": "Application form assigned to the job posting", "properties": { "id": { "description": "Unique identifier for the application form", "format": "uuid", "type": "string" }, "title": { "description": "Title of the application form", "type": "string" } }, "required": [ "id", "title" ], "title": "AtsJobPostingsJobPostingIdGetResponsesContentApplicationJsonSchemaDataApplicationForm", "type": "object" }, "AtsJobPostingsJobPostingIdGetResponsesContentApplicationJsonSchemaDataJob": { "description": "Associated job information", "properties": { "compensation": { "description": "Compensation information for the job", "oneOf": [ { "$ref": "#/components/schemas/AtsJobPostingsJobPostingIdGetResponsesContentApplicationJsonSchemaDataJobCompensation" }, { "type": "null" } ] }, "id": { "description": "Unique identifier for the job", "format": "uuid", "type": "string" }, "job_departments": { "description": "Departments associated with the job", "items": { "$ref": "#/components/schemas/AtsJobPostingsJobPostingIdGetResponsesContentApplicationJsonSchemaDataJobJobDepartmentsItems" }, "type": [ "array", "null" ] }, "job_employment_types": { "description": "Employment types associated with the job", "items": { "$ref": "#/components/schemas/AtsJobPostingsJobPostingIdGetResponsesContentApplicationJsonSchemaDataJobJobEmploymentTypesItems" }, "type": "array" }, "job_locations": { "description": "Locations associated with the job", "items": { "$ref": "#/components/schemas/AtsJobPostingsJobPostingIdGetResponsesContentApplicationJsonSchemaDataJobJobLocationsItems" }, "type": "array" }, "job_teams": { "description": "Teams associated with the job", "items": { "$ref": "#/components/schemas/AtsJobPostingsJobPostingIdGetResponsesContentApplicationJsonSchemaDataJobJobTeamsItems" }, "type": [ "array", "null" ] } }, "required": [ "id", "compensation", "job_locations", "job_employment_types" ], "title": "AtsJobPostingsJobPostingIdGetResponsesContentApplicationJsonSchemaDataJob", "type": "object" }, "AtsJobPostingsJobPostingIdGetResponsesContentApplicationJsonSchemaDataJobCompensation": { "description": "Compensation information for the job", "properties": { "currency_iso_code": { "description": "Currency ISO code for the compensation", "type": "string" }, "id": { "description": "Unique identifier for the compensation record", "format": "uuid", "type": "string" }, "max_amount": { "description": "Maximum compensation amount", "format": "double", "type": [ "number", "null" ] }, "min_amount": { "description": "Minimum compensation amount", "format": "double", "type": [ "number", "null" ] } }, "required": [ "id", "currency_iso_code" ], "title": "AtsJobPostingsJobPostingIdGetResponsesContentApplicationJsonSchemaDataJobCompensation", "type": "object" }, "AtsJobPostingsJobPostingIdGetResponsesContentApplicationJsonSchemaDataJobJobDepartmentsItems": { "properties": { "department": { "oneOf": [ { "$ref": "#/components/schemas/AtsJobPostingsJobPostingIdGetResponsesContentApplicationJsonSchemaDataJobJobDepartmentsItemsDepartment" }, { "type": "null" } ] }, "id": { "description": "Job-department association row identifier.", "format": "uuid", "type": "string" } }, "required": [ "id" ], "title": "AtsJobPostingsJobPostingIdGetResponsesContentApplicationJsonSchemaDataJobJobDepartmentsItems", "type": "object" }, "AtsJobPostingsJobPostingIdGetResponsesContentApplicationJsonSchemaDataJobJobDepartmentsItemsDepartment": { "properties": { "id": { "description": "Department identifier.", "format": "uuid", "type": "string" }, "name": { "description": "Display name of the department.", "maxLength": 100, "type": "string" } }, "title": "AtsJobPostingsJobPostingIdGetResponsesContentApplicationJsonSchemaDataJobJobDepartmentsItemsDepartment", "type": "object" }, "AtsJobPostingsJobPostingIdGetResponsesContentApplicationJsonSchemaDataJobJobEmploymentTypesItems": { "properties": { "employment_type": { "$ref": "#/components/schemas/AtsJobPostingsJobPostingIdGetResponsesContentApplicationJsonSchemaDataJobJobEmploymentTypesItemsEmploymentType", "description": "Details for the employment type assigned to the job" }, "id": { "description": "Unique identifier for the job employment type", "format": "uuid", "type": "string" } }, "required": [ "id", "employment_type" ], "title": "AtsJobPostingsJobPostingIdGetResponsesContentApplicationJsonSchemaDataJobJobEmploymentTypesItems", "type": "object" }, "AtsJobPostingsJobPostingIdGetResponsesContentApplicationJsonSchemaDataJobJobEmploymentTypesItemsEmploymentType": { "description": "Details for the employment type assigned to the job", "properties": { "id": { "description": "Unique identifier for the employment type", "format": "uuid", "type": "string" }, "name": { "description": "Employment type name", "type": "string" } }, "required": [ "id", "name" ], "title": "AtsJobPostingsJobPostingIdGetResponsesContentApplicationJsonSchemaDataJobJobEmploymentTypesItemsEmploymentType", "type": "object" }, "AtsJobPostingsJobPostingIdGetResponsesContentApplicationJsonSchemaDataJobJobLocationsItems": { "properties": { "id": { "description": "Unique identifier for the job location", "format": "uuid", "type": "string" }, "location": { "$ref": "#/components/schemas/AtsJobPostingsJobPostingIdGetResponsesContentApplicationJsonSchemaDataJobJobLocationsItemsLocation", "description": "Details for the location assigned to the job" } }, "required": [ "id", "location" ], "title": "AtsJobPostingsJobPostingIdGetResponsesContentApplicationJsonSchemaDataJobJobLocationsItems", "type": "object" }, "AtsJobPostingsJobPostingIdGetResponsesContentApplicationJsonSchemaDataJobJobLocationsItemsLocation": { "description": "Details for the location assigned to the job", "properties": { "id": { "description": "Unique identifier for the location", "format": "uuid", "type": "string" }, "name": { "description": "Location name", "type": "string" } }, "required": [ "id", "name" ], "title": "AtsJobPostingsJobPostingIdGetResponsesContentApplicationJsonSchemaDataJobJobLocationsItemsLocation", "type": "object" }, "AtsJobPostingsJobPostingIdGetResponsesContentApplicationJsonSchemaDataJobJobTeamsItems": { "properties": { "id": { "description": "Unique identifier for the job team", "format": "uuid", "type": "string" }, "team": { "$ref": "#/components/schemas/AtsJobPostingsJobPostingIdGetResponsesContentApplicationJsonSchemaDataJobJobTeamsItemsTeam", "description": "Details for the team assigned to the job" } }, "required": [ "id", "team" ], "title": "AtsJobPostingsJobPostingIdGetResponsesContentApplicationJsonSchemaDataJobJobTeamsItems", "type": "object" }, "AtsJobPostingsJobPostingIdGetResponsesContentApplicationJsonSchemaDataJobJobTeamsItemsTeam": { "description": "Details for the team assigned to the job", "properties": { "id": { "description": "Unique identifier for the team", "format": "uuid", "type": "string" }, "name": { "description": "Team name", "type": "string" } }, "required": [ "id", "name" ], "title": "AtsJobPostingsJobPostingIdGetResponsesContentApplicationJsonSchemaDataJobJobTeamsItemsTeam", "type": "object" }, "AtsJobPostingsJobPostingIdGetResponsesContentApplicationJsonSchemaDataPublicationsItems": { "description": "Publication information for different job boards", "properties": { "current_state": { "$ref": "#/components/schemas/AtsJobPostingsJobPostingIdGetResponsesContentApplicationJsonSchemaDataPublicationsItemsCurrentState", "description": "Current publication state details" }, "id": { "description": "Unique identifier for the job posting publication", "format": "uuid", "type": "string" }, "job_board": { "$ref": "#/components/schemas/AtsJobPostingsJobPostingIdGetResponsesContentApplicationJsonSchemaDataPublicationsItemsJobBoard", "description": "Job board where the posting is published" } }, "required": [ "id", "job_board", "current_state" ], "title": "AtsJobPostingsJobPostingIdGetResponsesContentApplicationJsonSchemaDataPublicationsItems", "type": "object" }, "AtsJobPostingsJobPostingIdGetResponsesContentApplicationJsonSchemaDataPublicationsItemsCurrentState": { "description": "Current publication state details", "properties": { "created_at": { "description": "Timestamp when the publication was created", "format": "date-time", "type": "string" }, "created_by": { "description": "User who created the publication", "format": "uuid", "type": [ "string", "null" ] }, "error_message": { "description": "Error message if publication failed", "type": [ "string", "null" ] }, "id": { "description": "Unique identifier for the publication state", "format": "uuid", "type": "string" }, "state_slug": { "$ref": "#/components/schemas/AtsJobPostingsJobPostingIdGetResponsesContentApplicationJsonSchemaDataPublicationsItemsCurrentStateStateSlug", "description": "Current publication state" } }, "required": [ "id", "created_at", "state_slug" ], "title": "AtsJobPostingsJobPostingIdGetResponsesContentApplicationJsonSchemaDataPublicationsItemsCurrentState", "type": "object" }, "AtsJobPostingsJobPostingIdGetResponsesContentApplicationJsonSchemaDataPublicationsItemsCurrentStateStateSlug": { "description": "Current publication state", "enum": [ "PUBLISHED_BASIC", "PUBLISHED_PREMIUM", "UNPUBLISHED", "EXPIRED", "IN_PROGRESS", "FAILED" ], "title": "AtsJobPostingsJobPostingIdGetResponsesContentApplicationJsonSchemaDataPublicationsItemsCurrentStateStateSlug", "type": "string" }, "AtsJobPostingsJobPostingIdGetResponsesContentApplicationJsonSchemaDataPublicationsItemsJobBoard": { "description": "Job board where the posting is published", "properties": { "id": { "description": "Unique identifier for the job board", "format": "uuid", "type": "string" } }, "required": [ "id" ], "title": "AtsJobPostingsJobPostingIdGetResponsesContentApplicationJsonSchemaDataPublicationsItemsJobBoard", "type": "object" }, "AtsJobPostingsJobPostingIdGetResponsesContentApplicationJsonSchemaErrorsItems": { "properties": { "code": { "description": "Machine-readable error code", "type": "string" }, "field": { "description": "Request field related to the error, if applicable", "type": "string" }, "message": { "description": "Human-readable error message", "type": "string" } }, "required": [ "code", "message" ], "title": "AtsJobPostingsJobPostingIdGetResponsesContentApplicationJsonSchemaErrorsItems", "type": "object" }, "AtsJobsGetParametersStatusSchemaItems": { "enum": [ "OPEN", "PAUSED", "CLOSED", "DRAFT", "WAITING_FOR_APPROVAL", "APPROVED", "NOT_APPROVED", "ARCHIVED" ], "title": "AtsJobsGetParametersStatusSchemaItems", "type": "string" }, "AtsJobsGetParametersWorkArrangementsSchemaItems": { "enum": [ "ON_SITE", "HYBRID", "REMOTE" ], "title": "AtsJobsGetParametersWorkArrangementsSchemaItems", "type": "string" }, "AtsJobsGetResponsesContentApplicationJsonSchemaDataItems": { "properties": { "applications_count": { "description": "Number of applications for the job", "type": [ "integer", "null" ] }, "approval_request_id": { "description": "Unique identifier for the approval request", "format": "uuid", "type": [ "string", "null" ] }, "approval_request_stringified": { "description": "Stringified approval request", "type": [ "string", "null" ] }, "approval_rule_id": { "description": "Unique identifier for the approval rule", "format": "uuid", "type": [ "string", "null" ] }, "created_at": { "description": "Timestamp when the job was created", "format": "date-time", "type": "string" }, "created_by_hris_organization_user_id": { "description": "Unique identifier of the user who created the job", "format": "uuid", "type": [ "string", "null" ] }, "current_compensation": { "oneOf": [ { "$ref": "#/components/schemas/AtsJobsGetResponsesContentApplicationJsonSchemaDataItemsCurrentCompensation" }, { "type": "null" } ] }, "hiring_member_job_permissions_by_type_slug": { "oneOf": [ { "$ref": "#/components/schemas/AtsJobsGetResponsesContentApplicationJsonSchemaDataItemsHiringMemberJobPermissionsByTypeSlug" }, { "type": "null" } ] }, "hiring_members": { "description": "Hiring members associated with the job", "items": { "$ref": "#/components/schemas/AtsJobsGetResponsesContentApplicationJsonSchemaDataItemsHiringMembersItems" }, "type": [ "array", "null" ] }, "id": { "description": "Unique identifier for the job", "format": "uuid", "type": "string" }, "interview_plan_stages": { "description": "Interview plan stages", "items": { "$ref": "#/components/schemas/AtsJobsGetResponsesContentApplicationJsonSchemaDataItemsInterviewPlanStagesItems" }, "type": [ "array", "null" ] }, "is_confidential": { "description": "Indicates if the job is confidential", "type": "boolean" }, "job_departments": { "description": "Departments associated with the job", "items": { "$ref": "#/components/schemas/AtsJobsGetResponsesContentApplicationJsonSchemaDataItemsJobDepartmentsItems" }, "type": [ "array", "null" ] }, "job_employment_types": { "description": "Employment types associated with the job", "items": { "$ref": "#/components/schemas/AtsJobsGetResponsesContentApplicationJsonSchemaDataItemsJobEmploymentTypesItems" }, "type": "array" }, "job_locations": { "description": "Locations associated with the job", "items": { "$ref": "#/components/schemas/AtsJobsGetResponsesContentApplicationJsonSchemaDataItemsJobLocationsItems" }, "type": "array" }, "job_teams": { "description": "Teams associated with the job", "items": { "$ref": "#/components/schemas/AtsJobsGetResponsesContentApplicationJsonSchemaDataItemsJobTeamsItems" }, "type": [ "array", "null" ] }, "richtext_description": { "description": "Rich text description of the job", "type": [ "string", "null" ] }, "status": { "$ref": "#/components/schemas/AtsJobsGetResponsesContentApplicationJsonSchemaDataItemsStatus", "description": "Job status" }, "title": { "description": "Job title", "type": "string" }, "updated_at": { "description": "Timestamp when the job was last updated", "format": "date-time", "type": "string" }, "work_arrangement_enum": { "description": "Work arrangement of the job. Null when unspecified.", "oneOf": [ { "$ref": "#/components/schemas/AtsJobsGetResponsesContentApplicationJsonSchemaDataItemsWorkArrangementEnum" }, { "type": "null" } ] } }, "title": "AtsJobsGetResponsesContentApplicationJsonSchemaDataItems", "type": "object" }, "AtsJobsGetResponsesContentApplicationJsonSchemaDataItemsCurrentCompensation": { "properties": { "currency_iso_code": { "description": "ISO code of the currency", "type": "string" }, "id": { "description": "Unique identifier for the compensation", "format": "uuid", "type": "string" }, "job_id": { "description": "Job ID associated with the compensation", "format": "uuid", "type": "string" }, "max_amount": { "description": "Maximum compensation amount", "format": "double", "type": [ "number", "null" ] }, "min_amount": { "description": "Minimum compensation amount", "format": "double", "type": [ "number", "null" ] }, "period_slug": { "$ref": "#/components/schemas/AtsJobsGetResponsesContentApplicationJsonSchemaDataItemsCurrentCompensationPeriodSlug", "description": "Compensation period" } }, "title": "AtsJobsGetResponsesContentApplicationJsonSchemaDataItemsCurrentCompensation", "type": "object" }, "AtsJobsGetResponsesContentApplicationJsonSchemaDataItemsCurrentCompensationPeriodSlug": { "description": "Compensation period", "enum": [ "ANNUALLY", "MONTHLY", "SEMIMONTHLY", "BIWEEKLY", "WEEKLY", "DAILY", "HOURLY" ], "title": "AtsJobsGetResponsesContentApplicationJsonSchemaDataItemsCurrentCompensationPeriodSlug", "type": "string" }, "AtsJobsGetResponsesContentApplicationJsonSchemaDataItemsHiringMemberJobPermissionsByTypeSlug": { "properties": { "application_form_submission": { "description": "Application form submission permissions", "type": "string" }, "application_form_submission_sensitive_fields": { "description": "Application form submission sensitive fields permissions", "type": "string" }, "compensation": { "description": "Compensation permissions", "type": "string" }, "hiring_team": { "description": "Hiring team permissions", "type": "string" }, "interview_plan": { "description": "Interview plan permissions", "type": "string" }, "job_posting": { "description": "Job posting permissions", "type": "string" } }, "title": "AtsJobsGetResponsesContentApplicationJsonSchemaDataItemsHiringMemberJobPermissionsByTypeSlug", "type": "object" }, "AtsJobsGetResponsesContentApplicationJsonSchemaDataItemsHiringMembersItems": { "properties": { "hris_organization_user_id": { "description": "Unique identifier for the HRIS organization user", "format": "uuid", "type": "string" }, "id": { "description": "Unique identifier for the hiring member", "format": "uuid", "type": "string" } }, "title": "AtsJobsGetResponsesContentApplicationJsonSchemaDataItemsHiringMembersItems", "type": "object" }, "AtsJobsGetResponsesContentApplicationJsonSchemaDataItemsInterviewPlanStagesItems": { "properties": { "category_type_slug": { "$ref": "#/components/schemas/AtsJobsGetResponsesContentApplicationJsonSchemaDataItemsInterviewPlanStagesItemsCategoryTypeSlug", "description": "Category type of the interview plan stage" }, "default_type_slug": { "description": "Default type slug of the interview plan stage", "type": [ "string", "null" ] }, "id": { "description": "Unique identifier for the interview plan stage", "format": "uuid", "type": "string" }, "interview_plan_id": { "description": "Interview plan ID associated with this stage", "format": "uuid", "type": "string" }, "name": { "description": "Interview plan stage name", "type": "string" }, "position_number": { "description": "Position number of the stage in the interview plan", "type": [ "integer", "null" ] } }, "title": "AtsJobsGetResponsesContentApplicationJsonSchemaDataItemsInterviewPlanStagesItems", "type": "object" }, "AtsJobsGetResponsesContentApplicationJsonSchemaDataItemsInterviewPlanStagesItemsCategoryTypeSlug": { "description": "Category type of the interview plan stage", "enum": [ "LEAD", "ACTIVE", "COMPLETED" ], "title": "AtsJobsGetResponsesContentApplicationJsonSchemaDataItemsInterviewPlanStagesItemsCategoryTypeSlug", "type": "string" }, "AtsJobsGetResponsesContentApplicationJsonSchemaDataItemsJobDepartmentsItems": { "properties": { "department": { "oneOf": [ { "$ref": "#/components/schemas/AtsJobsGetResponsesContentApplicationJsonSchemaDataItemsJobDepartmentsItemsDepartment" }, { "type": "null" } ] }, "id": { "description": "Unique identifier for the job department", "format": "uuid", "type": "string" } }, "required": [ "id", "department" ], "title": "AtsJobsGetResponsesContentApplicationJsonSchemaDataItemsJobDepartmentsItems", "type": "object" }, "AtsJobsGetResponsesContentApplicationJsonSchemaDataItemsJobDepartmentsItemsDepartment": { "properties": { "id": { "description": "Unique identifier for the department", "format": "uuid", "type": "string" }, "name": { "description": "Department name", "type": "string" } }, "required": [ "id", "name" ], "title": "AtsJobsGetResponsesContentApplicationJsonSchemaDataItemsJobDepartmentsItemsDepartment", "type": "object" }, "AtsJobsGetResponsesContentApplicationJsonSchemaDataItemsJobEmploymentTypesItems": { "properties": { "employment_type": { "$ref": "#/components/schemas/AtsJobsGetResponsesContentApplicationJsonSchemaDataItemsJobEmploymentTypesItemsEmploymentType" }, "id": { "description": "Unique identifier for the job employment type", "format": "uuid", "type": "string" } }, "required": [ "id", "employment_type" ], "title": "AtsJobsGetResponsesContentApplicationJsonSchemaDataItemsJobEmploymentTypesItems", "type": "object" }, "AtsJobsGetResponsesContentApplicationJsonSchemaDataItemsJobEmploymentTypesItemsEmploymentType": { "properties": { "id": { "description": "Unique identifier for the employment type", "format": "uuid", "type": "string" }, "name": { "description": "Employment type name", "type": "string" } }, "required": [ "id", "name" ], "title": "AtsJobsGetResponsesContentApplicationJsonSchemaDataItemsJobEmploymentTypesItemsEmploymentType", "type": "object" }, "AtsJobsGetResponsesContentApplicationJsonSchemaDataItemsJobLocationsItems": { "properties": { "id": { "description": "Unique identifier for the job location", "format": "uuid", "type": "string" }, "location": { "$ref": "#/components/schemas/AtsJobsGetResponsesContentApplicationJsonSchemaDataItemsJobLocationsItemsLocation" } }, "required": [ "id", "location" ], "title": "AtsJobsGetResponsesContentApplicationJsonSchemaDataItemsJobLocationsItems", "type": "object" }, "AtsJobsGetResponsesContentApplicationJsonSchemaDataItemsJobLocationsItemsLocation": { "properties": { "id": { "description": "Unique identifier for the location", "format": "uuid", "type": "string" }, "name": { "description": "Location name", "type": "string" } }, "required": [ "id", "name" ], "title": "AtsJobsGetResponsesContentApplicationJsonSchemaDataItemsJobLocationsItemsLocation", "type": "object" }, "AtsJobsGetResponsesContentApplicationJsonSchemaDataItemsJobTeamsItems": { "properties": { "id": { "description": "Unique identifier for the job team", "format": "uuid", "type": "string" }, "team": { "$ref": "#/components/schemas/AtsJobsGetResponsesContentApplicationJsonSchemaDataItemsJobTeamsItemsTeam" } }, "required": [ "id", "team" ], "title": "AtsJobsGetResponsesContentApplicationJsonSchemaDataItemsJobTeamsItems", "type": "object" }, "AtsJobsGetResponsesContentApplicationJsonSchemaDataItemsJobTeamsItemsTeam": { "properties": { "id": { "description": "Unique identifier for the team", "format": "uuid", "type": "string" }, "name": { "description": "Team name", "type": "string" } }, "required": [ "id", "name" ], "title": "AtsJobsGetResponsesContentApplicationJsonSchemaDataItemsJobTeamsItemsTeam", "type": "object" }, "AtsJobsGetResponsesContentApplicationJsonSchemaDataItemsStatus": { "description": "Job status", "enum": [ "OPEN", "PAUSED", "CLOSED", "DRAFT", "WAITING_FOR_APPROVAL", "APPROVED", "NOT_APPROVED", "ARCHIVED" ], "title": "AtsJobsGetResponsesContentApplicationJsonSchemaDataItemsStatus", "type": "string" }, "AtsJobsGetResponsesContentApplicationJsonSchemaDataItemsWorkArrangementEnum": { "description": "Work arrangement of the job. Null when unspecified.", "enum": [ "ON_SITE", "HYBRID", "REMOTE" ], "title": "AtsJobsGetResponsesContentApplicationJsonSchemaDataItemsWorkArrangementEnum", "type": "string" }, "AtsJobsGetResponsesContentApplicationJsonSchemaErrorsItems": { "properties": { "code": { "description": "Machine-readable error code", "type": "string" }, "field": { "description": "Request field related to the error, if applicable", "type": "string" }, "message": { "description": "Human-readable error message", "type": "string" } }, "required": [ "code", "message" ], "title": "AtsJobsGetResponsesContentApplicationJsonSchemaErrorsItems", "type": "object" }, "AtsJobsJobIdInterviewPlanStagesGetParametersIncludeSchemaItems": { "enum": [ "CURRENT_APPLICATIONS" ], "title": "AtsJobsJobIdInterviewPlanStagesGetParametersIncludeSchemaItems", "type": "string" }, "AtsJobsJobIdInterviewPlanStagesGetResponsesContentApplicationJsonSchemaDataItems": { "description": "An interview plan stage of the job with pipeline counts.", "properties": { "category_type_slug": { "$ref": "#/components/schemas/AtsJobsJobIdInterviewPlanStagesGetResponsesContentApplicationJsonSchemaDataItemsCategoryTypeSlug", "description": "Stage category." }, "current_applications": { "description": "Most recently moved applications currently in the stage. Present only when include=CURRENT_APPLICATIONS is requested.", "items": { "$ref": "#/components/schemas/AtsJobsJobIdInterviewPlanStagesGetResponsesContentApplicationJsonSchemaDataItemsCurrentApplicationsItems" }, "type": "array" }, "current_applications_count": { "description": "Applications currently in this stage; null when the caller may not see the job's applications.", "type": [ "integer", "null" ] }, "default_type_slug": { "description": "System stage type (new_lead, application_review, offer, hired, archived); null for custom stages.", "type": [ "string", "null" ] }, "id": { "description": "Interview plan stage identifier.", "format": "uuid", "type": "string" }, "interview_plan_id": { "description": "Interview plan the stage belongs to.", "format": "uuid", "type": "string" }, "job_id": { "description": "Job the interview plan is attached to.", "format": "uuid", "type": "string" }, "name": { "description": "Customer-defined stage name.", "type": "string" }, "position_number": { "description": "Position of the stage in the interview plan; lower comes first.", "type": "integer" }, "reached_applications_count": { "description": "Applications that have ever been in this stage, including ones since advanced, hired or archived; null when the caller may not see the job's applications.", "type": [ "integer", "null" ] } }, "required": [ "id", "name", "job_id", "position_number", "default_type_slug", "interview_plan_id", "category_type_slug", "current_applications_count", "reached_applications_count" ], "title": "AtsJobsJobIdInterviewPlanStagesGetResponsesContentApplicationJsonSchemaDataItems", "type": "object" }, "AtsJobsJobIdInterviewPlanStagesGetResponsesContentApplicationJsonSchemaDataItemsCategoryTypeSlug": { "description": "Stage category.", "enum": [ "LEAD", "ACTIVE", "COMPLETED" ], "title": "AtsJobsJobIdInterviewPlanStagesGetResponsesContentApplicationJsonSchemaDataItemsCategoryTypeSlug", "type": "string" }, "AtsJobsJobIdInterviewPlanStagesGetResponsesContentApplicationJsonSchemaDataItemsCurrentApplicationsItems": { "description": "An application currently in the stage.", "properties": { "candidate": { "$ref": "#/components/schemas/AtsJobsJobIdInterviewPlanStagesGetResponsesContentApplicationJsonSchemaDataItemsCurrentApplicationsItemsCandidate", "description": "The candidate on the application." }, "created_at": { "description": "When the application was created.", "format": "date-time", "type": "string" }, "id": { "description": "Application identifier.", "format": "uuid", "type": "string" }, "moved_to_current_stage_at": { "description": "When the application entered this stage.", "format": "date-time", "type": "string" }, "numeric_id": { "description": "Application numeric identifier.", "type": "integer" } }, "required": [ "id", "candidate", "created_at", "numeric_id", "moved_to_current_stage_at" ], "title": "AtsJobsJobIdInterviewPlanStagesGetResponsesContentApplicationJsonSchemaDataItemsCurrentApplicationsItems", "type": "object" }, "AtsJobsJobIdInterviewPlanStagesGetResponsesContentApplicationJsonSchemaDataItemsCurrentApplicationsItemsCandidate": { "description": "The candidate on the application.", "properties": { "email": { "description": "Candidate email.", "format": "email", "type": "string" }, "first_name": { "description": "Candidate first name.", "type": "string" }, "id": { "description": "Candidate identifier.", "format": "uuid", "type": "string" }, "last_name": { "description": "Candidate last name.", "type": "string" } }, "required": [ "id", "email", "last_name", "first_name" ], "title": "AtsJobsJobIdInterviewPlanStagesGetResponsesContentApplicationJsonSchemaDataItemsCurrentApplicationsItemsCandidate", "type": "object" }, "AtsJobsJobIdInterviewPlanStagesGetResponsesContentApplicationJsonSchemaErrorsItems": { "properties": { "code": { "description": "Machine-readable error code", "type": "string" }, "field": { "description": "Request field related to the error, if applicable", "type": "string" }, "message": { "description": "Human-readable error message", "type": "string" } }, "required": [ "code", "message" ], "title": "AtsJobsJobIdInterviewPlanStagesGetResponsesContentApplicationJsonSchemaErrorsItems", "type": "object" }, "AtsJobsPostRequestBodyContentApplicationJsonSchemaData": { "properties": { "department_ids": { "description": "Array of department IDs (optional)", "items": { "format": "uuid", "type": "string" }, "type": "array" }, "employment_type_ids": { "description": "Array of employment type IDs (at least one required)", "items": { "format": "uuid", "type": "string" }, "type": "array" }, "interview_plan_id": { "description": "Interview Plan ID must be a valid UUID", "format": "uuid", "type": "string" }, "is_confidential": { "default": false, "description": "Whether the job posting is confidential", "type": "boolean" }, "location_ids": { "description": "Array of location IDs (at least one required)", "items": { "format": "uuid", "type": "string" }, "type": "array" }, "richtext_description": { "description": "Rich text description of the job", "maxLength": 20000, "type": [ "string", "null" ] }, "status": { "$ref": "#/components/schemas/AtsJobsPostRequestBodyContentApplicationJsonSchemaDataStatus", "description": "Initial status of the job. Defaults to the status derived from the applicable approval rule when omitted." }, "team_ids": { "description": "Array of team IDs (at least one required)", "items": { "format": "uuid", "type": "string" }, "type": "array" }, "title": { "description": "The job title", "maxLength": 100, "minLength": 1, "type": "string" }, "work_arrangement_enum": { "description": "Work arrangement of the job. Omit or send null to leave it unspecified.", "oneOf": [ { "$ref": "#/components/schemas/AtsJobsPostRequestBodyContentApplicationJsonSchemaDataWorkArrangementEnum" }, { "type": "null" } ] } }, "required": [ "title", "team_ids", "location_ids", "interview_plan_id", "employment_type_ids" ], "title": "AtsJobsPostRequestBodyContentApplicationJsonSchemaData", "type": "object" }, "AtsJobsPostRequestBodyContentApplicationJsonSchemaDataStatus": { "description": "Initial status of the job. Defaults to the status derived from the applicable approval rule when omitted.", "enum": [ "DRAFT", "WAITING_FOR_APPROVAL", "APPROVED", "NOT_APPROVED", "OPEN", "CLOSED", "ARCHIVED" ], "title": "AtsJobsPostRequestBodyContentApplicationJsonSchemaDataStatus", "type": "string" }, "AtsJobsPostRequestBodyContentApplicationJsonSchemaDataWorkArrangementEnum": { "description": "Work arrangement of the job. Omit or send null to leave it unspecified.", "enum": [ "ON_SITE", "HYBRID", "REMOTE" ], "title": "AtsJobsPostRequestBodyContentApplicationJsonSchemaDataWorkArrangementEnum", "type": "string" }, "AtsJobsPostResponsesContentApplicationJsonSchemaData": { "properties": { "approval_request_id": { "description": "ID of the approval request for this job", "format": "uuid", "type": [ "string", "null" ] }, "approval_rule_id": { "description": "ID of the approval rule applied to this job", "format": "uuid", "type": [ "string", "null" ] }, "created_at": { "description": "Timestamp when the job was created", "format": "date-time", "type": "string" }, "created_by_hris_organization_user_id": { "description": "ID of the user who created the job", "format": "uuid", "type": [ "string", "null" ] }, "id": { "description": "Unique identifier for the created job", "format": "uuid", "type": "string" }, "is_confidential": { "description": "Whether the job posting is confidential", "type": "boolean" }, "job_departments": { "description": "Departments associated with the job", "items": { "$ref": "#/components/schemas/AtsJobsPostResponsesContentApplicationJsonSchemaDataJobDepartmentsItems" }, "type": [ "array", "null" ] }, "job_employment_types": { "description": "Employment types associated with the job", "items": { "$ref": "#/components/schemas/AtsJobsPostResponsesContentApplicationJsonSchemaDataJobEmploymentTypesItems" }, "type": "array" }, "job_locations": { "description": "Locations associated with the job", "items": { "$ref": "#/components/schemas/AtsJobsPostResponsesContentApplicationJsonSchemaDataJobLocationsItems" }, "type": "array" }, "job_teams": { "description": "Teams associated with the job", "items": { "$ref": "#/components/schemas/AtsJobsPostResponsesContentApplicationJsonSchemaDataJobTeamsItems" }, "type": "array" }, "richtext_description": { "description": "Rich text description of the job", "type": [ "string", "null" ] }, "status": { "$ref": "#/components/schemas/AtsJobsPostResponsesContentApplicationJsonSchemaDataStatus", "description": "Current status of the job" }, "title": { "description": "The job title", "type": "string" }, "updated_at": { "description": "Timestamp when the job was last updated", "format": "date-time", "type": "string" }, "work_arrangement_enum": { "description": "Work arrangement of the job. Null when unspecified.", "oneOf": [ { "$ref": "#/components/schemas/AtsJobsPostResponsesContentApplicationJsonSchemaDataWorkArrangementEnum" }, { "type": "null" } ] } }, "required": [ "id", "title", "status", "job_teams", "job_locations", "is_confidential", "approval_rule_id", "approval_request_id", "job_employment_types", "created_by_hris_organization_user_id" ], "title": "AtsJobsPostResponsesContentApplicationJsonSchemaData", "type": "object" }, "AtsJobsPostResponsesContentApplicationJsonSchemaDataJobDepartmentsItems": { "properties": { "department": { "oneOf": [ { "$ref": "#/components/schemas/AtsJobsPostResponsesContentApplicationJsonSchemaDataJobDepartmentsItemsDepartment" }, { "type": "null" } ] }, "id": { "description": "Unique identifier for the job department", "format": "uuid", "type": "string" } }, "required": [ "id", "department" ], "title": "AtsJobsPostResponsesContentApplicationJsonSchemaDataJobDepartmentsItems", "type": "object" }, "AtsJobsPostResponsesContentApplicationJsonSchemaDataJobDepartmentsItemsDepartment": { "properties": { "id": { "description": "Unique identifier for the department", "format": "uuid", "type": "string" }, "name": { "description": "Department name", "type": "string" } }, "required": [ "id", "name" ], "title": "AtsJobsPostResponsesContentApplicationJsonSchemaDataJobDepartmentsItemsDepartment", "type": "object" }, "AtsJobsPostResponsesContentApplicationJsonSchemaDataJobEmploymentTypesItems": { "properties": { "employment_type": { "$ref": "#/components/schemas/AtsJobsPostResponsesContentApplicationJsonSchemaDataJobEmploymentTypesItemsEmploymentType" }, "id": { "description": "Unique identifier for the job employment type", "format": "uuid", "type": "string" } }, "required": [ "id", "employment_type" ], "title": "AtsJobsPostResponsesContentApplicationJsonSchemaDataJobEmploymentTypesItems", "type": "object" }, "AtsJobsPostResponsesContentApplicationJsonSchemaDataJobEmploymentTypesItemsEmploymentType": { "properties": { "id": { "description": "Unique identifier for the employment type", "format": "uuid", "type": "string" }, "name": { "description": "Employment type name", "type": "string" } }, "required": [ "id", "name" ], "title": "AtsJobsPostResponsesContentApplicationJsonSchemaDataJobEmploymentTypesItemsEmploymentType", "type": "object" }, "AtsJobsPostResponsesContentApplicationJsonSchemaDataJobLocationsItems": { "properties": { "id": { "description": "Unique identifier for the job location", "format": "uuid", "type": "string" }, "location": { "$ref": "#/components/schemas/AtsJobsPostResponsesContentApplicationJsonSchemaDataJobLocationsItemsLocation" } }, "required": [ "id", "location" ], "title": "AtsJobsPostResponsesContentApplicationJsonSchemaDataJobLocationsItems", "type": "object" }, "AtsJobsPostResponsesContentApplicationJsonSchemaDataJobLocationsItemsLocation": { "properties": { "id": { "description": "Unique identifier for the location", "format": "uuid", "type": "string" }, "name": { "description": "Location name", "type": "string" } }, "required": [ "id", "name" ], "title": "AtsJobsPostResponsesContentApplicationJsonSchemaDataJobLocationsItemsLocation", "type": "object" }, "AtsJobsPostResponsesContentApplicationJsonSchemaDataJobTeamsItems": { "properties": { "id": { "description": "Unique identifier for the job team", "format": "uuid", "type": "string" }, "team": { "$ref": "#/components/schemas/AtsJobsPostResponsesContentApplicationJsonSchemaDataJobTeamsItemsTeam" } }, "required": [ "id", "team" ], "title": "AtsJobsPostResponsesContentApplicationJsonSchemaDataJobTeamsItems", "type": "object" }, "AtsJobsPostResponsesContentApplicationJsonSchemaDataJobTeamsItemsTeam": { "properties": { "id": { "description": "Unique identifier for the team", "format": "uuid", "type": "string" }, "name": { "description": "Team name", "type": "string" } }, "required": [ "id", "name" ], "title": "AtsJobsPostResponsesContentApplicationJsonSchemaDataJobTeamsItemsTeam", "type": "object" }, "AtsJobsPostResponsesContentApplicationJsonSchemaDataStatus": { "description": "Current status of the job", "enum": [ "DRAFT", "WAITING_FOR_APPROVAL", "APPROVED", "NOT_APPROVED", "OPEN", "CLOSED", "ARCHIVED" ], "title": "AtsJobsPostResponsesContentApplicationJsonSchemaDataStatus", "type": "string" }, "AtsJobsPostResponsesContentApplicationJsonSchemaDataWorkArrangementEnum": { "description": "Work arrangement of the job. Null when unspecified.", "enum": [ "ON_SITE", "HYBRID", "REMOTE" ], "title": "AtsJobsPostResponsesContentApplicationJsonSchemaDataWorkArrangementEnum", "type": "string" }, "AtsJobsPostResponsesContentApplicationJsonSchemaErrorsItems": { "properties": { "code": { "description": "Machine-readable error code", "type": "string" }, "field": { "description": "Request field related to the error, if applicable", "type": "string" }, "message": { "description": "Human-readable error message", "type": "string" } }, "required": [ "code", "message" ], "title": "AtsJobsPostResponsesContentApplicationJsonSchemaErrorsItems", "type": "object" }, "AtsLocationsGetResponsesContentApplicationJsonSchemaDataItems": { "properties": { "archived_at": { "description": "Timestamp when the location was archived; null while the location is active and selectable", "format": "date-time", "type": [ "string", "null" ] }, "city": { "description": "City name", "type": [ "string", "null" ] }, "country_code": { "description": "ISO country code", "type": [ "string", "null" ] }, "created_at": { "description": "Timestamp when the location was created", "format": "date-time", "type": "string" }, "id": { "description": "Unique identifier for the location", "format": "uuid", "type": "string" }, "is_remote": { "description": "Indicates if this is a remote location", "type": "boolean" }, "location_group": { "description": "Location group information", "oneOf": [ { "$ref": "#/components/schemas/AtsLocationsGetResponsesContentApplicationJsonSchemaDataItemsLocationGroup" }, { "type": "null" } ] }, "name": { "description": "Name of the location/country", "type": "string" }, "province_or_region_text": { "description": "Province or region text", "type": [ "string", "null" ] }, "updated_at": { "description": "Timestamp when the location was last updated", "format": "date-time", "type": "string" } }, "required": [ "id", "name", "created_at", "updated_at" ], "title": "AtsLocationsGetResponsesContentApplicationJsonSchemaDataItems", "type": "object" }, "AtsLocationsGetResponsesContentApplicationJsonSchemaDataItemsLocationGroup": { "description": "Location group information", "properties": { "id": { "description": "Unique identifier for the location group", "format": "uuid", "type": "string" }, "name": { "description": "Name of the location group", "type": "string" } }, "required": [ "id", "name" ], "title": "AtsLocationsGetResponsesContentApplicationJsonSchemaDataItemsLocationGroup", "type": "object" }, "AtsLocationsGetResponsesContentApplicationJsonSchemaErrorsItems": { "properties": { "code": { "description": "Machine-readable error code", "type": "string" }, "field": { "description": "Request field related to the error, if applicable", "type": "string" }, "message": { "description": "Human-readable error message", "type": "string" } }, "required": [ "code", "message" ], "title": "AtsLocationsGetResponsesContentApplicationJsonSchemaErrorsItems", "type": "object" }, "AtsOffersGetParametersOfferStatusSchemaItems": { "enum": [ "CREATED", "WAITING_FOR_APPROVAL", "APPROVED", "NOT_APPROVED", "SENT", "EXPIRED", "ACCEPTED", "REJECTED" ], "title": "AtsOffersGetParametersOfferStatusSchemaItems", "type": "string" }, "AtsOffersGetResponsesContentApplicationJsonSchemaDataItems": { "properties": { "additional_details": { "description": "Additional details about the offer", "type": [ "string", "null" ] }, "application": { "$ref": "#/components/schemas/AtsOffersGetResponsesContentApplicationJsonSchemaDataItemsApplication", "description": "The application this offer was made on, so an offer identifies its own candidate and job without a second lookup. Always present: an offer whose application the caller cannot see is not returned at all." }, "application_interview_plan_stage_id": { "description": "Application interview plan stage identifier", "format": "uuid", "type": "string" }, "approval_request_id": { "description": "Approval request identifier", "format": "uuid", "type": [ "string", "null" ] }, "approval_rule_id": { "description": "Approval rule identifier", "format": "uuid", "type": [ "string", "null" ] }, "attachment_id": { "description": "Attachment identifier", "format": "uuid", "type": [ "string", "null" ] }, "compensation_amount": { "description": "Compensation amount", "format": "double", "type": "number" }, "compensation_currency": { "description": "Compensation currency", "type": "string" }, "compensation_period_slug": { "$ref": "#/components/schemas/AtsOffersGetResponsesContentApplicationJsonSchemaDataItemsCompensationPeriodSlug", "description": "Compensation period" }, "country_code": { "description": "Country code", "format": "country-code", "type": "string" }, "created_at": { "description": "Timestamp when the offer was created", "format": "date-time", "type": "string" }, "custom_fields": { "description": "Custom fields attached to the offer", "items": { "$ref": "#/components/schemas/AtsOffersGetResponsesContentApplicationJsonSchemaDataItemsCustomFieldsItems" }, "type": "array" }, "email": { "description": "Email details", "oneOf": [ { "$ref": "#/components/schemas/AtsOffersGetResponsesContentApplicationJsonSchemaDataItemsEmail" }, { "type": "null" } ] }, "expires_at": { "description": "Date when the sent offer expires if the candidate has not responded", "format": "date", "type": [ "string", "null" ] }, "id": { "description": "Unique identifier", "format": "uuid", "type": "string" }, "job_title": { "description": "Job title", "type": "string" }, "offer_letter_template_id": { "description": "Offer letter template identifier", "format": "uuid", "type": [ "string", "null" ] }, "offer_status": { "$ref": "#/components/schemas/AtsOffersGetResponsesContentApplicationJsonSchemaDataItemsOfferStatus", "description": "Offer status" }, "rejection_reason_id": { "description": "Rejection reason identifier", "format": "uuid", "type": [ "string", "null" ] }, "replied_at": { "description": "Timestamp when the candidate replied (accepted or rejected) to the offer", "format": "date-time", "type": [ "string", "null" ] }, "sent_at": { "description": "Timestamp when the offer reached the candidate, through Deel or another channel; null until it has been sent", "format": "date-time", "type": [ "string", "null" ] }, "start_date": { "description": "Start date", "format": "date-time", "type": "string" }, "updated_at": { "description": "Timestamp when the offer was last updated", "format": "date-time", "type": "string" }, "worker_type": { "$ref": "#/components/schemas/AtsOffersGetResponsesContentApplicationJsonSchemaDataItemsWorkerType", "description": "Worker type" } }, "title": "AtsOffersGetResponsesContentApplicationJsonSchemaDataItems", "type": "object" }, "AtsOffersGetResponsesContentApplicationJsonSchemaDataItemsApplication": { "description": "The application this offer was made on, so an offer identifies its own candidate and job without a second lookup. Always present: an offer whose application the caller cannot see is not returned at all.", "properties": { "candidate": { "description": "The candidate who received the offer. Null once the candidate has been deleted or anonymized.", "oneOf": [ { "$ref": "#/components/schemas/AtsOffersGetResponsesContentApplicationJsonSchemaDataItemsApplicationCandidate" }, { "type": "null" } ] }, "id": { "description": "Application unique identifier", "format": "uuid", "type": "string" }, "job": { "$ref": "#/components/schemas/AtsOffersGetResponsesContentApplicationJsonSchemaDataItemsApplicationJob", "description": "The job the application belongs to. The title repeats the offer's own job_title field." } }, "required": [ "id", "job", "candidate" ], "title": "AtsOffersGetResponsesContentApplicationJsonSchemaDataItemsApplication", "type": "object" }, "AtsOffersGetResponsesContentApplicationJsonSchemaDataItemsApplicationCandidate": { "description": "The candidate who received the offer. Null once the candidate has been deleted or anonymized.", "properties": { "first_name": { "description": "Candidate first name", "type": "string" }, "id": { "description": "Candidate unique identifier", "format": "uuid", "type": "string" }, "last_name": { "description": "Candidate last name", "type": "string" } }, "required": [ "id", "last_name", "first_name" ], "title": "AtsOffersGetResponsesContentApplicationJsonSchemaDataItemsApplicationCandidate", "type": "object" }, "AtsOffersGetResponsesContentApplicationJsonSchemaDataItemsApplicationJob": { "description": "The job the application belongs to. The title repeats the offer's own job_title field.", "properties": { "id": { "description": "Job unique identifier", "format": "uuid", "type": "string" }, "title": { "description": "Job title", "type": "string" } }, "required": [ "id", "title" ], "title": "AtsOffersGetResponsesContentApplicationJsonSchemaDataItemsApplicationJob", "type": "object" }, "AtsOffersGetResponsesContentApplicationJsonSchemaDataItemsCompensationPeriodSlug": { "description": "Compensation period", "enum": [ "annually", "monthly", "semimonthly", "biweekly", "weekly", "daily", "hourly" ], "title": "AtsOffersGetResponsesContentApplicationJsonSchemaDataItemsCompensationPeriodSlug", "type": "string" }, "AtsOffersGetResponsesContentApplicationJsonSchemaDataItemsCustomFieldsItems": { "description": "Custom field attached to the offer", "properties": { "description": { "description": "Description of the custom field", "type": [ "string", "null" ] }, "id": { "description": "Unique identifier for the custom field", "format": "uuid", "type": "string" }, "name": { "description": "Custom field name", "type": "string" }, "required": { "description": "Whether the custom field is required", "type": "boolean" }, "type": { "$ref": "#/components/schemas/AtsOffersGetResponsesContentApplicationJsonSchemaDataItemsCustomFieldsItemsType", "description": "Type of custom field" } }, "required": [ "id", "name", "type", "required" ], "title": "AtsOffersGetResponsesContentApplicationJsonSchemaDataItemsCustomFieldsItems", "type": "object" }, "AtsOffersGetResponsesContentApplicationJsonSchemaDataItemsCustomFieldsItemsType": { "description": "Type of custom field", "enum": [ "TEXT", "PERCENTAGE", "LIST", "MULTISELECT", "DATE", "NUMBER", "CURRENCY", "HYPERLINK" ], "title": "AtsOffersGetResponsesContentApplicationJsonSchemaDataItemsCustomFieldsItemsType", "type": "string" }, "AtsOffersGetResponsesContentApplicationJsonSchemaDataItemsEmail": { "description": "Email details", "properties": { "body": { "description": "Email body", "type": "string" }, "id": { "description": "Unique identifier for the email", "format": "uuid", "type": "string" }, "recipient_bcc": { "description": "Blind-carbon-copy recipient email address", "format": "email", "type": [ "string", "null" ] }, "recipient_cc": { "description": "Carbon-copy recipient email address", "format": "email", "type": [ "string", "null" ] }, "recipient_to": { "description": "Primary recipient email address", "format": "email", "type": "string" }, "sender_name": { "description": "Sender name", "type": "string" }, "subject": { "description": "Email subject", "type": "string" } }, "required": [ "id", "body", "subject", "sender_name", "recipient_to" ], "title": "AtsOffersGetResponsesContentApplicationJsonSchemaDataItemsEmail", "type": "object" }, "AtsOffersGetResponsesContentApplicationJsonSchemaDataItemsOfferStatus": { "description": "Offer status", "enum": [ "CREATED", "WAITING_FOR_APPROVAL", "APPROVED", "NOT_APPROVED", "SENT", "EXPIRED", "ACCEPTED", "REJECTED" ], "title": "AtsOffersGetResponsesContentApplicationJsonSchemaDataItemsOfferStatus", "type": "string" }, "AtsOffersGetResponsesContentApplicationJsonSchemaDataItemsWorkerType": { "description": "Worker type", "enum": [ "CONTRACTOR_FIXED", "CONTRACTOR_PAY_AS_YOU_GO", "CONTRACTOR_MILESTONE", "DIRECT_EMPLOYEE", "EOR_EMPLOYEE", "GLOBAL_PAYROLL_EMPLOYEE", "PEO_EMPLOYEE", "PWAC", "UNKNOWN" ], "title": "AtsOffersGetResponsesContentApplicationJsonSchemaDataItemsWorkerType", "type": "string" }, "AtsOffersGetResponsesContentApplicationJsonSchemaErrorsItems": { "properties": { "code": { "description": "Machine-readable error code", "type": "string" }, "field": { "description": "Request field related to the error, if applicable", "type": "string" }, "message": { "description": "Human-readable error message", "type": "string" } }, "required": [ "code", "message" ], "title": "AtsOffersGetResponsesContentApplicationJsonSchemaErrorsItems", "type": "object" }, "AtsOpeningsGetParametersStatusSchemaItems": { "enum": [ "DRAFT", "OPEN", "FILLED", "CLOSED", "WAITING_FOR_APPROVAL", "APPROVED", "NOT_APPROVED", "ARCHIVED" ], "title": "AtsOpeningsGetParametersStatusSchemaItems", "type": "string" }, "AtsOpeningsGetParametersTagIdsOperator": { "enum": [ "ANY", "ALL" ], "title": "AtsOpeningsGetParametersTagIdsOperator", "type": "string" }, "AtsOpeningsGetResponsesContentApplicationJsonSchemaDataItems": { "properties": { "compensation_currency_iso_code": { "description": "ISO 4217 currency code for compensation.", "type": [ "string", "null" ] }, "compensation_period": { "description": "Compensation period (e.g. yearly, monthly).", "type": [ "string", "null" ] }, "created_at": { "description": "ISO 8601 datetime when the opening was created.", "format": "date-time", "type": "string" }, "created_by_hris_organization_user_id": { "description": "HRIS organization user ID of the user who created this opening.", "format": "uuid", "type": [ "string", "null" ] }, "employment_type": { "description": "Employment type details.", "oneOf": [ { "$ref": "#/components/schemas/AtsOpeningsGetResponsesContentApplicationJsonSchemaDataItemsEmploymentType" }, { "type": "null" } ] }, "employment_type_id": { "description": "ID of the employment type associated with the opening.", "format": "uuid", "type": [ "string", "null" ] }, "filled_by_application": { "description": "The application that filled this opening, including the hired candidate name. Null unless the opening is filled.", "oneOf": [ { "$ref": "#/components/schemas/AtsOpeningsGetResponsesContentApplicationJsonSchemaDataItemsFilledByApplication" }, { "type": "null" } ] }, "filled_by_application_id": { "description": "ID of the application that filled this opening, if any.", "format": "uuid", "type": [ "string", "null" ] }, "filled_by_offer": { "description": "The accepted offer that filled this opening (latest ACCEPTED offer by update time). Null unless the opening is filled with an accepted offer. Contains no compensation data.", "oneOf": [ { "$ref": "#/components/schemas/AtsOpeningsGetResponsesContentApplicationJsonSchemaDataItemsFilledByOffer" }, { "type": "null" } ] }, "id": { "description": "Unique identifier of the opening.", "format": "uuid", "type": "string" }, "is_confidential": { "description": "Whether this opening is marked confidential.", "type": "boolean" }, "job_ids": { "description": "IDs of jobs linked to this opening.", "items": { "format": "uuid", "type": "string" }, "type": "array" }, "location": { "description": "Location details.", "oneOf": [ { "$ref": "#/components/schemas/AtsOpeningsGetResponsesContentApplicationJsonSchemaDataItemsLocation" }, { "type": "null" } ] }, "location_id": { "description": "ID of the location associated with the opening.", "format": "uuid", "type": [ "string", "null" ] }, "max_compensation_amount": { "description": "Maximum compensation amount as a decimal string.", "type": [ "string", "null" ] }, "min_compensation_amount": { "description": "Minimum compensation amount as a decimal string.", "type": [ "string", "null" ] }, "opening_numeric_id": { "description": "Numeric part of the opening identifier (e.g. 42 in ENG-42).", "type": "integer" }, "opening_prefix": { "description": "Prefix of the opening identifier (e.g. ENG in ENG-42).", "type": "string" }, "opening_type_slug": { "$ref": "#/components/schemas/AtsOpeningsGetResponsesContentApplicationJsonSchemaDataItemsOpeningTypeSlug", "description": "Whether this opening is for a new hire or a backfill." }, "status": { "$ref": "#/components/schemas/AtsOpeningsGetResponsesContentApplicationJsonSchemaDataItemsStatus", "description": "Current lifecycle status of the opening." }, "target_hire_date": { "description": "Target date by which the opening should be filled (ISO 8601).", "format": "date-time", "type": [ "string", "null" ] }, "target_start_date": { "description": "Target start date for the new hire (ISO 8601).", "format": "date-time", "type": [ "string", "null" ] }, "team": { "description": "Team details.", "oneOf": [ { "$ref": "#/components/schemas/AtsOpeningsGetResponsesContentApplicationJsonSchemaDataItemsTeam" }, { "type": "null" } ] }, "team_id": { "description": "ID of the team this opening belongs to.", "format": "uuid", "type": [ "string", "null" ] }, "title": { "description": "Title of the job opening.", "type": "string" }, "updated_at": { "description": "ISO 8601 datetime when the opening was last updated.", "format": "date-time", "type": "string" }, "updated_by_hris_organization_user_id": { "description": "HRIS organization user ID of the user who last updated this opening.", "format": "uuid", "type": [ "string", "null" ] } }, "required": [ "id", "title", "status", "created_at", "updated_at", "opening_prefix", "opening_type_slug", "opening_numeric_id" ], "title": "AtsOpeningsGetResponsesContentApplicationJsonSchemaDataItems", "type": "object" }, "AtsOpeningsGetResponsesContentApplicationJsonSchemaDataItemsEmploymentType": { "description": "Employment type details.", "properties": { "id": { "description": "Unique identifier of the employment type.", "format": "uuid", "type": "string" }, "name": { "description": "Name of the employment type.", "type": "string" } }, "title": "AtsOpeningsGetResponsesContentApplicationJsonSchemaDataItemsEmploymentType", "type": "object" }, "AtsOpeningsGetResponsesContentApplicationJsonSchemaDataItemsFilledByApplication": { "description": "The application that filled this opening, including the hired candidate name. Null unless the opening is filled.", "properties": { "candidate": { "description": "Minimal identity of the hired candidate.", "oneOf": [ { "$ref": "#/components/schemas/AtsOpeningsGetResponsesContentApplicationJsonSchemaDataItemsFilledByApplicationCandidate" }, { "type": "null" } ] }, "id": { "description": "ID of the application that filled this opening.", "format": "uuid", "type": "string" } }, "title": "AtsOpeningsGetResponsesContentApplicationJsonSchemaDataItemsFilledByApplication", "type": "object" }, "AtsOpeningsGetResponsesContentApplicationJsonSchemaDataItemsFilledByApplicationCandidate": { "description": "Minimal identity of the hired candidate.", "properties": { "first_name": { "description": "First name of the hired candidate.", "type": "string" }, "last_name": { "description": "Last name of the hired candidate.", "type": "string" } }, "title": "AtsOpeningsGetResponsesContentApplicationJsonSchemaDataItemsFilledByApplicationCandidate", "type": "object" }, "AtsOpeningsGetResponsesContentApplicationJsonSchemaDataItemsFilledByOffer": { "description": "The accepted offer that filled this opening (latest ACCEPTED offer by update time). Null unless the opening is filled with an accepted offer. Contains no compensation data.", "properties": { "offer_status_enum": { "$ref": "#/components/schemas/AtsOpeningsGetResponsesContentApplicationJsonSchemaDataItemsFilledByOfferOfferStatusEnum", "description": "Status of the filling offer. This object is only present for the accepted offer that filled the opening, so the value is always ACCEPTED." }, "start_date": { "description": "Start date from the accepted offer (ISO 8601).", "format": "date-time", "type": "string" } }, "title": "AtsOpeningsGetResponsesContentApplicationJsonSchemaDataItemsFilledByOffer", "type": "object" }, "AtsOpeningsGetResponsesContentApplicationJsonSchemaDataItemsFilledByOfferOfferStatusEnum": { "description": "Status of the filling offer. This object is only present for the accepted offer that filled the opening, so the value is always ACCEPTED.", "enum": [ "ACCEPTED" ], "title": "AtsOpeningsGetResponsesContentApplicationJsonSchemaDataItemsFilledByOfferOfferStatusEnum", "type": "string" }, "AtsOpeningsGetResponsesContentApplicationJsonSchemaDataItemsLocation": { "description": "Location details.", "properties": { "country": { "description": "ISO 3166-1 alpha-2 country code of the location.", "type": [ "string", "null" ] }, "id": { "description": "Unique identifier of the location.", "format": "uuid", "type": "string" }, "name": { "description": "Name of the location.", "type": "string" } }, "title": "AtsOpeningsGetResponsesContentApplicationJsonSchemaDataItemsLocation", "type": "object" }, "AtsOpeningsGetResponsesContentApplicationJsonSchemaDataItemsOpeningTypeSlug": { "description": "Whether this opening is for a new hire or a backfill.", "enum": [ "NEW_HIRE", "BACKFILL" ], "title": "AtsOpeningsGetResponsesContentApplicationJsonSchemaDataItemsOpeningTypeSlug", "type": "string" }, "AtsOpeningsGetResponsesContentApplicationJsonSchemaDataItemsStatus": { "description": "Current lifecycle status of the opening.", "enum": [ "DRAFT", "OPEN", "FILLED", "CLOSED", "WAITING_FOR_APPROVAL", "APPROVED", "NOT_APPROVED", "ARCHIVED" ], "title": "AtsOpeningsGetResponsesContentApplicationJsonSchemaDataItemsStatus", "type": "string" }, "AtsOpeningsGetResponsesContentApplicationJsonSchemaDataItemsTeam": { "description": "Team details.", "properties": { "id": { "description": "Unique identifier of the team.", "format": "uuid", "type": "string" }, "name": { "description": "Name of the team.", "type": "string" } }, "title": "AtsOpeningsGetResponsesContentApplicationJsonSchemaDataItemsTeam", "type": "object" }, "AtsOpeningsGetResponsesContentApplicationJsonSchemaErrorsItems": { "properties": { "code": { "description": "Machine-readable error code", "type": "string" }, "field": { "description": "Request field related to the error, if applicable", "type": "string" }, "message": { "description": "Human-readable error message", "type": "string" } }, "required": [ "code", "message" ], "title": "AtsOpeningsGetResponsesContentApplicationJsonSchemaErrorsItems", "type": "object" }, "AtsReasonsGetParametersReasonGroupSlug": { "enum": [ "CANDIDATE_ARCHIVATION", "OFFER_REJECTION", "JOB_CLOSURE", "INTERVIEW_CANCELLATION" ], "title": "AtsReasonsGetParametersReasonGroupSlug", "type": "string" }, "AtsReasonsGetParametersSubgroupSlug": { "enum": [ "INTEREST", "LOCATION", "COMPENSATION", "RESPONSIVENESS", "QUALIFICATION", "FIT", "EXPERIENCE", "STATUS", "ROLE_CHANGE", "WITHDREW", "BENEFITS", "COUNTER_OFFER", "REMOTE_WORK", "PERSONAL", "TIMING", "BUDGET", "BUSINESS_NEEDS", "EXTERNAL_CANDIDATE", "INTERNAL_TRANSFER", "HIRING_FREEZE" ], "title": "AtsReasonsGetParametersSubgroupSlug", "type": "string" }, "AtsReasonsGetResponsesContentApplicationJsonSchemaDataItems": { "properties": { "archived_at": { "description": "Timestamp when the reason was archived; null while the reason is active and selectable", "format": "date-time", "type": [ "string", "null" ] }, "candidates_count": { "description": "Number of candidates associated with this reason", "format": "double", "type": [ "number", "null" ] }, "created_at": { "description": "Timestamp when the reason was created", "format": "date-time", "type": "string" }, "email_template": { "description": "Associated email template", "oneOf": [ { "$ref": "#/components/schemas/AtsReasonsGetResponsesContentApplicationJsonSchemaDataItemsEmailTemplate" }, { "type": "null" } ] }, "id": { "description": "Unique identifier for the reason", "format": "uuid", "type": "string" }, "jobs_count": { "description": "Number of jobs associated with this reason", "format": "double", "type": [ "number", "null" ] }, "label": { "description": "Label of the reason", "type": "string" }, "reason_group_slug": { "$ref": "#/components/schemas/AtsReasonsGetResponsesContentApplicationJsonSchemaDataItemsReasonGroupSlug", "description": "Reason group slug" }, "subgroup_slug": { "description": "Reason subgroup slug", "oneOf": [ { "$ref": "#/components/schemas/AtsReasonsGetResponsesContentApplicationJsonSchemaDataItemsSubgroupSlug" }, { "type": "null" } ] }, "updated_at": { "description": "Timestamp when the reason was last updated", "format": "date-time", "type": "string" } }, "required": [ "id", "label", "created_at", "reason_group_slug" ], "title": "AtsReasonsGetResponsesContentApplicationJsonSchemaDataItems", "type": "object" }, "AtsReasonsGetResponsesContentApplicationJsonSchemaDataItemsEmailTemplate": { "description": "Associated email template", "properties": { "id": { "description": "Email template ID", "format": "uuid", "type": "string" }, "title": { "description": "Email template title", "type": "string" } }, "required": [ "id", "title" ], "title": "AtsReasonsGetResponsesContentApplicationJsonSchemaDataItemsEmailTemplate", "type": "object" }, "AtsReasonsGetResponsesContentApplicationJsonSchemaDataItemsReasonGroupSlug": { "description": "Reason group slug", "enum": [ "CANDIDATE_ARCHIVATION", "OFFER_REJECTION", "JOB_CLOSURE", "INTERVIEW_CANCELLATION" ], "title": "AtsReasonsGetResponsesContentApplicationJsonSchemaDataItemsReasonGroupSlug", "type": "string" }, "AtsReasonsGetResponsesContentApplicationJsonSchemaDataItemsSubgroupSlug": { "description": "Reason subgroup slug", "enum": [ "INTEREST", "LOCATION", "COMPENSATION", "RESPONSIVENESS", "QUALIFICATION", "FIT", "EXPERIENCE", "STATUS", "ROLE_CHANGE", "WITHDREW", "BENEFITS", "COUNTER_OFFER", "REMOTE_WORK", "PERSONAL", "TIMING", "BUDGET", "BUSINESS_NEEDS", "EXTERNAL_CANDIDATE", "INTERNAL_TRANSFER", "HIRING_FREEZE" ], "title": "AtsReasonsGetResponsesContentApplicationJsonSchemaDataItemsSubgroupSlug", "type": "string" }, "AtsReasonsGetResponsesContentApplicationJsonSchemaErrorsItems": { "properties": { "code": { "description": "Machine-readable error code", "type": "string" }, "field": { "description": "Request field related to the error, if applicable", "type": "string" }, "message": { "description": "Human-readable error message", "type": "string" } }, "required": [ "code", "message" ], "title": "AtsReasonsGetResponsesContentApplicationJsonSchemaErrorsItems", "type": "object" }, "AtsTagsGetParametersIncludeCounts": { "default": "false", "enum": [ "true", "false" ], "title": "AtsTagsGetParametersIncludeCounts", "type": "string" }, "AtsTagsGetParametersTagGroupSlug": { "enum": [ "CANDIDATE" ], "title": "AtsTagsGetParametersTagGroupSlug", "type": "string" }, "AtsTagsGetResponsesContentApplicationJsonSchemaDataItems": { "properties": { "archived_at": { "description": "When the tag was archived; null while the tag is active and selectable.", "format": "date-time", "type": [ "string", "null" ] }, "candidates_count": { "description": "Number of candidates with this tag. Present only when include_counts=true.", "type": [ "integer", "null" ] }, "created_at": { "description": "When the tag was created.", "format": "date-time", "type": "string" }, "created_by_hris_organization_user_id": { "description": "ID of the user who created the tag, if any.", "format": "uuid", "type": [ "string", "null" ] }, "id": { "description": "Unique identifier of the tag.", "format": "uuid", "type": "string" }, "label": { "description": "Display name of the tag.", "type": "string" }, "tag_group_slug": { "$ref": "#/components/schemas/AtsTagsGetResponsesContentApplicationJsonSchemaDataItemsTagGroupSlug", "description": "Tag group. Use CANDIDATE for candidate tags." }, "updated_at": { "description": "When the tag was last updated.", "format": "date-time", "type": "string" }, "updated_by_hris_organization_user_id": { "description": "ID of the user who last updated the tag, if any.", "format": "uuid", "type": [ "string", "null" ] } }, "required": [ "id", "created_at", "updated_at" ], "title": "AtsTagsGetResponsesContentApplicationJsonSchemaDataItems", "type": "object" }, "AtsTagsGetResponsesContentApplicationJsonSchemaDataItemsTagGroupSlug": { "description": "Tag group. Use CANDIDATE for candidate tags.", "enum": [ "CANDIDATE" ], "title": "AtsTagsGetResponsesContentApplicationJsonSchemaDataItemsTagGroupSlug", "type": "string" }, "AtsTagsGetResponsesContentApplicationJsonSchemaErrorsItems": { "properties": { "code": { "description": "Machine-readable error code", "type": "string" }, "field": { "description": "Request field related to the error, if applicable", "type": "string" }, "message": { "description": "Human-readable error message", "type": "string" } }, "required": [ "code", "message" ], "title": "AtsTagsGetResponsesContentApplicationJsonSchemaErrorsItems", "type": "object" }, "AtsTeamsGetResponsesContentApplicationJsonSchemaDataItems": { "properties": { "archived_at": { "description": "Timestamp when the team was archived; null while the team is active and selectable", "format": "date-time", "type": [ "string", "null" ] }, "created_at": { "description": "Timestamp when the team was created", "format": "date-time", "type": "string" }, "department_teams": { "description": "Array of department-team relationships", "items": { "$ref": "#/components/schemas/AtsTeamsGetResponsesContentApplicationJsonSchemaDataItemsDepartmentTeamsItems" }, "type": "array" }, "id": { "description": "Unique identifier for the team", "format": "uuid", "type": "string" }, "name": { "description": "Name of the team", "type": "string" }, "organization_id": { "description": "Unique identifier for the organization", "format": "uuid", "type": "string" }, "richtext_description": { "description": "Rich text description of the team", "type": "string" }, "updated_at": { "description": "Timestamp when the team was last updated", "format": "date-time", "type": "string" } }, "required": [ "id", "name", "created_at", "updated_at", "organization_id", "department_teams" ], "title": "AtsTeamsGetResponsesContentApplicationJsonSchemaDataItems", "type": "object" }, "AtsTeamsGetResponsesContentApplicationJsonSchemaDataItemsDepartmentTeamsItems": { "properties": { "department": { "$ref": "#/components/schemas/AtsTeamsGetResponsesContentApplicationJsonSchemaDataItemsDepartmentTeamsItemsDepartment" }, "id": { "description": "Unique identifier for the department-team relationship", "format": "uuid", "type": "string" } }, "required": [ "id", "department" ], "title": "AtsTeamsGetResponsesContentApplicationJsonSchemaDataItemsDepartmentTeamsItems", "type": "object" }, "AtsTeamsGetResponsesContentApplicationJsonSchemaDataItemsDepartmentTeamsItemsDepartment": { "properties": { "id": { "description": "Unique identifier for the department", "format": "uuid", "type": "string" }, "name": { "description": "Name of the department", "type": "string" } }, "required": [ "id", "name" ], "title": "AtsTeamsGetResponsesContentApplicationJsonSchemaDataItemsDepartmentTeamsItemsDepartment", "type": "object" }, "AtsTeamsGetResponsesContentApplicationJsonSchemaErrorsItems": { "properties": { "code": { "description": "Machine-readable error code", "type": "string" }, "field": { "description": "Request field related to the error, if applicable", "type": "string" }, "message": { "description": "Human-readable error message", "type": "string" } }, "required": [ "code", "message" ], "title": "AtsTeamsGetResponsesContentApplicationJsonSchemaErrorsItems", "type": "object" }, "AtsUpsertionsBulkTagsPostRequestBodyContentApplicationJsonSchemaData": { "description": "At least one tag group must be provided. Include tag_id to update an existing tag label, or omit it to create or match case-insensitively.", "oneOf": [ { "$ref": "#/components/schemas/AtsUpsertionsBulkTagsPostRequestBodyContentApplicationJsonSchemaData0" }, { "$ref": "#/components/schemas/AtsUpsertionsBulkTagsPostRequestBodyContentApplicationJsonSchemaData1" }, { "$ref": "#/components/schemas/AtsUpsertionsBulkTagsPostRequestBodyContentApplicationJsonSchemaData2" } ], "title": "AtsUpsertionsBulkTagsPostRequestBodyContentApplicationJsonSchemaData" }, "AtsUpsertionsBulkTagsPostRequestBodyContentApplicationJsonSchemaData0": { "properties": { "candidate_tags": { "description": "Any type" } }, "required": [ "candidate_tags" ], "title": "AtsUpsertionsBulkTagsPostRequestBodyContentApplicationJsonSchemaData0", "type": "object" }, "AtsUpsertionsBulkTagsPostRequestBodyContentApplicationJsonSchemaData1": { "properties": { "job_tags": { "description": "Any type" } }, "required": [ "job_tags" ], "title": "AtsUpsertionsBulkTagsPostRequestBodyContentApplicationJsonSchemaData1", "type": "object" }, "AtsUpsertionsBulkTagsPostRequestBodyContentApplicationJsonSchemaData2": { "properties": { "opening_tags": { "description": "Any type" } }, "required": [ "opening_tags" ], "title": "AtsUpsertionsBulkTagsPostRequestBodyContentApplicationJsonSchemaData2", "type": "object" }, "AtsUpsertionsBulkTagsPostResponsesContentApplicationJsonSchemaData": { "description": "Resolved tags grouped by tag group.", "properties": { "candidate_tags": { "items": { "$ref": "#/components/schemas/AtsUpsertionsBulkTagsPostResponsesContentApplicationJsonSchemaDataCandidateTagsItems" }, "type": "array" }, "job_tags": { "items": { "$ref": "#/components/schemas/AtsUpsertionsBulkTagsPostResponsesContentApplicationJsonSchemaDataJobTagsItems" }, "type": "array" }, "opening_tags": { "items": { "$ref": "#/components/schemas/AtsUpsertionsBulkTagsPostResponsesContentApplicationJsonSchemaDataOpeningTagsItems" }, "type": "array" } }, "title": "AtsUpsertionsBulkTagsPostResponsesContentApplicationJsonSchemaData", "type": "object" }, "AtsUpsertionsBulkTagsPostResponsesContentApplicationJsonSchemaDataCandidateTagsItems": { "properties": { "tag_id": { "description": "Unique identifier of the resolved tag.", "format": "uuid", "type": "string" }, "tag_name": { "description": "The tag label.", "type": "string" } }, "required": [ "tag_id", "tag_name" ], "title": "AtsUpsertionsBulkTagsPostResponsesContentApplicationJsonSchemaDataCandidateTagsItems", "type": "object" }, "AtsUpsertionsBulkTagsPostResponsesContentApplicationJsonSchemaDataJobTagsItems": { "properties": { "tag_id": { "description": "Unique identifier of the resolved tag.", "format": "uuid", "type": "string" }, "tag_name": { "description": "The tag label.", "type": "string" } }, "required": [ "tag_id", "tag_name" ], "title": "AtsUpsertionsBulkTagsPostResponsesContentApplicationJsonSchemaDataJobTagsItems", "type": "object" }, "AtsUpsertionsBulkTagsPostResponsesContentApplicationJsonSchemaDataOpeningTagsItems": { "properties": { "tag_id": { "description": "Unique identifier of the resolved tag.", "format": "uuid", "type": "string" }, "tag_name": { "description": "The tag label.", "type": "string" } }, "required": [ "tag_id", "tag_name" ], "title": "AtsUpsertionsBulkTagsPostResponsesContentApplicationJsonSchemaDataOpeningTagsItems", "type": "object" }, "AtsUpsertionsBulkTagsPostResponsesContentApplicationJsonSchemaErrorsItems": { "properties": { "code": { "description": "Machine-readable error code", "type": "string" }, "field": { "description": "Request field related to the error, if applicable", "type": "string" }, "message": { "description": "Human-readable error message", "type": "string" } }, "required": [ "code", "message" ], "title": "AtsUpsertionsBulkTagsPostResponsesContentApplicationJsonSchemaErrorsItems", "type": "object" }, "AttachOnDemandPayrollEntries-v2026-07-31RequestBadRequestError": { "properties": { "errors": { "description": "List of errors.", "items": { "$ref": "#/components/schemas/OnDemandPayrollOdpIdEntriesAttachPatchResponsesContentApplicationJsonSchemaErrorsItems" }, "type": "array" } }, "required": [ "errors" ], "title": "AttachOnDemandPayrollEntries-v2026-07-31RequestBadRequestError", "type": "object" }, "AttachOnDemandPayrollEntries-v2026-07-31RequestForbiddenError": { "properties": { "errors": { "description": "List of errors.", "items": { "$ref": "#/components/schemas/OnDemandPayrollOdpIdEntriesAttachPatchResponsesContentApplicationJsonSchemaErrorsItems" }, "type": "array" } }, "required": [ "errors" ], "title": "AttachOnDemandPayrollEntries-v2026-07-31RequestForbiddenError", "type": "object" }, "AttachOnDemandPayrollEntries-v2026-07-31RequestNotFoundError": { "properties": { "errors": { "description": "List of errors.", "items": { "$ref": "#/components/schemas/OnDemandPayrollOdpIdEntriesAttachPatchResponsesContentApplicationJsonSchemaErrorsItems" }, "type": "array" } }, "required": [ "errors" ], "title": "AttachOnDemandPayrollEntries-v2026-07-31RequestNotFoundError", "type": "object" }, "AttachOnDemandPayrollEntries-v2026-07-31RequestUnauthorizedError": { "properties": { "errors": { "description": "List of errors.", "items": { "$ref": "#/components/schemas/OnDemandPayrollOdpIdEntriesAttachPatchResponsesContentApplicationJsonSchemaErrorsItems" }, "type": "array" } }, "required": [ "errors" ], "title": "AttachOnDemandPayrollEntries-v2026-07-31RequestUnauthorizedError", "type": "object" }, "BulkTagUpsertions-v2026-06-12RequestBadRequestError": { "properties": { "errors": { "description": "List of error objects", "items": { "$ref": "#/components/schemas/AtsUpsertionsBulkTagsPostResponsesContentApplicationJsonSchemaErrorsItems" }, "type": "array" } }, "required": [ "errors" ], "title": "BulkTagUpsertions-v2026-06-12RequestBadRequestError", "type": "object" }, "BulkTagUpsertions-v2026-06-12RequestForbiddenError": { "properties": { "errors": { "description": "List of error objects", "items": { "$ref": "#/components/schemas/AtsUpsertionsBulkTagsPostResponsesContentApplicationJsonSchemaErrorsItems" }, "type": "array" } }, "required": [ "errors" ], "title": "BulkTagUpsertions-v2026-06-12RequestForbiddenError", "type": "object" }, "BulkTagUpsertions-v2026-06-12RequestInternalServerError": { "properties": { "errors": { "description": "List of error objects", "items": { "$ref": "#/components/schemas/AtsUpsertionsBulkTagsPostResponsesContentApplicationJsonSchemaErrorsItems" }, "type": "array" } }, "required": [ "errors" ], "title": "BulkTagUpsertions-v2026-06-12RequestInternalServerError", "type": "object" }, "CancelAClearanceRequest-v2026-09-15RequestBadRequestError": { "properties": { "errors": { "items": { "$ref": "#/components/schemas/ItClearanceRequestsClearanceRequestIdCancelPostResponsesContentApplicationJsonSchemaErrorsItems" }, "type": "array" } }, "required": [ "errors" ], "title": "CancelAClearanceRequest-v2026-09-15RequestBadRequestError", "type": "object" }, "CancelAClearanceRequest-v2026-09-15RequestConflictError": { "properties": { "errors": { "items": { "$ref": "#/components/schemas/ItClearanceRequestsClearanceRequestIdCancelPostResponsesContentApplicationJsonSchemaErrorsItems" }, "type": "array" } }, "required": [ "errors" ], "title": "CancelAClearanceRequest-v2026-09-15RequestConflictError", "type": "object" }, "CancelAClearanceRequest-v2026-09-15RequestForbiddenError": { "properties": { "errors": { "items": { "$ref": "#/components/schemas/ItClearanceRequestsClearanceRequestIdCancelPostResponsesContentApplicationJsonSchemaErrorsItems" }, "type": "array" } }, "required": [ "errors" ], "title": "CancelAClearanceRequest-v2026-09-15RequestForbiddenError", "type": "object" }, "CancelAClearanceRequest-v2026-09-15RequestInternalServerError": { "properties": { "errors": { "items": { "$ref": "#/components/schemas/ItClearanceRequestsClearanceRequestIdCancelPostResponsesContentApplicationJsonSchemaErrorsItems" }, "type": "array" } }, "required": [ "errors" ], "title": "CancelAClearanceRequest-v2026-09-15RequestInternalServerError", "type": "object" }, "CancelAClearanceRequest-v2026-09-15RequestNotFoundError": { "properties": { "errors": { "items": { "$ref": "#/components/schemas/ItClearanceRequestsClearanceRequestIdCancelPostResponsesContentApplicationJsonSchemaErrorsItems" }, "type": "array" } }, "required": [ "errors" ], "title": "CancelAClearanceRequest-v2026-09-15RequestNotFoundError", "type": "object" }, "CancelAClearanceRequest-v2026-09-15RequestUnauthorizedError": { "properties": { "errors": { "items": { "$ref": "#/components/schemas/ItClearanceRequestsClearanceRequestIdCancelPostResponsesContentApplicationJsonSchemaErrorsItems" }, "type": "array" } }, "required": [ "errors" ], "title": "CancelAClearanceRequest-v2026-09-15RequestUnauthorizedError", "type": "object" }, "CancelAmendment-v2026-01-01RequestBadRequestError": { "properties": { "errors": { "items": { "$ref": "#/components/schemas/EorContractsContractIdAmendmentsAmendmentIdDeleteResponsesContentApplicationJsonSchemaErrorsItems" }, "type": "array" } }, "required": [ "errors" ], "title": "CancelAmendment-v2026-01-01RequestBadRequestError", "type": "object" }, "CancelAmendment-v2026-01-01RequestInternalServerError": { "properties": { "errors": { "items": { "$ref": "#/components/schemas/EorContractsContractIdAmendmentsAmendmentIdDeleteResponsesContentApplicationJsonSchemaErrorsItems" }, "type": "array" } }, "required": [ "errors" ], "title": "CancelAmendment-v2026-01-01RequestInternalServerError", "type": "object" }, "CancelAmendment-v2026-01-01RequestNotFoundError": { "properties": { "errors": { "items": { "$ref": "#/components/schemas/EorContractsContractIdAmendmentsAmendmentIdDeleteResponsesContentApplicationJsonSchemaErrorsItems" }, "type": "array" } }, "required": [ "errors" ], "title": "CancelAmendment-v2026-01-01RequestNotFoundError", "type": "object" }, "CancelEorContract-v2026-01-01RequestBadRequestError": { "properties": { "error": { "description": "Error message details", "type": "string" } }, "title": "CancelEorContract-v2026-01-01RequestBadRequestError", "type": "object" }, "CancelEorContract-v2026-01-01RequestNotFoundError": { "properties": { "error": { "description": "Error message details", "type": "string" } }, "title": "CancelEorContract-v2026-01-01RequestNotFoundError", "type": "object" }, "CancelItOrder-v2026-09-15RequestBadRequestError": { "properties": { "errors": { "items": { "$ref": "#/components/schemas/ItOrdersOrderIdCancelPostResponsesContentApplicationJsonSchemaErrorsItems" }, "type": "array" } }, "required": [ "errors" ], "title": "CancelItOrder-v2026-09-15RequestBadRequestError", "type": "object" }, "CancelItOrder-v2026-09-15RequestConflictError": { "properties": { "errors": { "items": { "$ref": "#/components/schemas/ItOrdersOrderIdCancelPostResponsesContentApplicationJsonSchemaErrorsItems" }, "type": "array" } }, "required": [ "errors" ], "title": "CancelItOrder-v2026-09-15RequestConflictError", "type": "object" }, "CancelItOrder-v2026-09-15RequestForbiddenError": { "properties": { "errors": { "items": { "$ref": "#/components/schemas/ItOrdersOrderIdCancelPostResponsesContentApplicationJsonSchemaErrorsItems" }, "type": "array" } }, "required": [ "errors" ], "title": "CancelItOrder-v2026-09-15RequestForbiddenError", "type": "object" }, "CancelItOrder-v2026-09-15RequestInternalServerError": { "properties": { "errors": { "items": { "$ref": "#/components/schemas/ItOrdersOrderIdCancelPostResponsesContentApplicationJsonSchemaErrorsItems" }, "type": "array" } }, "required": [ "errors" ], "title": "CancelItOrder-v2026-09-15RequestInternalServerError", "type": "object" }, "CancelItOrder-v2026-09-15RequestNotFoundError": { "properties": { "errors": { "items": { "$ref": "#/components/schemas/ItOrdersOrderIdCancelPostResponsesContentApplicationJsonSchemaErrorsItems" }, "type": "array" } }, "required": [ "errors" ], "title": "CancelItOrder-v2026-09-15RequestNotFoundError", "type": "object" }, "CancelItOrder-v2026-09-15RequestUnauthorizedError": { "properties": { "errors": { "items": { "$ref": "#/components/schemas/ItOrdersOrderIdCancelPostResponsesContentApplicationJsonSchemaErrorsItems" }, "type": "array" } }, "required": [ "errors" ], "title": "CancelItOrder-v2026-09-15RequestUnauthorizedError", "type": "object" }, "CancelItOrder-v2026-09-15RequestUnprocessableEntityError": { "properties": { "errors": { "items": { "$ref": "#/components/schemas/ItOrdersOrderIdCancelPostResponsesContentApplicationJsonSchemaErrorsItems" }, "type": "array" } }, "required": [ "errors" ], "title": "CancelItOrder-v2026-09-15RequestUnprocessableEntityError", "type": "object" }, "CancelOnDemandPayroll-v2026-07-31RequestBadRequestError": { "properties": { "errors": { "description": "List of errors.", "items": { "$ref": "#/components/schemas/OnDemandPayrollOdpIdCancelPostResponsesContentApplicationJsonSchemaErrorsItems" }, "type": "array" } }, "required": [ "errors" ], "title": "CancelOnDemandPayroll-v2026-07-31RequestBadRequestError", "type": "object" }, "CancelOnDemandPayroll-v2026-07-31RequestForbiddenError": { "properties": { "errors": { "description": "List of errors.", "items": { "$ref": "#/components/schemas/OnDemandPayrollOdpIdCancelPostResponsesContentApplicationJsonSchemaErrorsItems" }, "type": "array" } }, "required": [ "errors" ], "title": "CancelOnDemandPayroll-v2026-07-31RequestForbiddenError", "type": "object" }, "CancelOnDemandPayroll-v2026-07-31RequestNotFoundError": { "properties": { "errors": { "description": "List of errors.", "items": { "$ref": "#/components/schemas/OnDemandPayrollOdpIdCancelPostResponsesContentApplicationJsonSchemaErrorsItems" }, "type": "array" } }, "required": [ "errors" ], "title": "CancelOnDemandPayroll-v2026-07-31RequestNotFoundError", "type": "object" }, "CancelOnDemandPayroll-v2026-07-31RequestUnauthorizedError": { "properties": { "errors": { "description": "List of errors.", "items": { "$ref": "#/components/schemas/OnDemandPayrollOdpIdCancelPostResponsesContentApplicationJsonSchemaErrorsItems" }, "type": "array" } }, "required": [ "errors" ], "title": "CancelOnDemandPayroll-v2026-07-31RequestUnauthorizedError", "type": "object" }, "CancelTimeOffRequest-v2026-01-01RequestNotFoundError": { "properties": { "message": { "description": "Error message", "type": "string" } }, "title": "CancelTimeOffRequest-v2026-01-01RequestNotFoundError", "type": "object" }, "CandidatesPostRequestBodyContentApplicationJsonSchemaData": { "description": "Details of candidate to create", "properties": { "country": { "description": "Country code.", "maxLength": 2, "minLength": 2, "pattern": "^[A-Z]{2}$", "type": "string" }, "email": { "description": "Worker's work email address.", "format": "email", "minLength": 5, "type": "string" }, "first_name": { "description": "Candidate's first name.", "type": "string" }, "id": { "description": "Unique identifier of candidate in your ATS.", "type": "string" }, "job_title": { "description": "Job Title.", "type": "string" }, "last_name": { "description": "Candidate's last name.", "type": "string" }, "link": { "description": "Link to candidate's profile in ATS.", "type": "string" }, "nationality": { "description": "Nationality of the worker.", "maxLength": 2, "minLength": 2, "type": "string" }, "personal_email": { "description": "Worker's personal email address.", "format": "email", "minLength": 5, "type": "string" }, "start_date": { "description": "Short date in format ISO-8601 (YYYY-MM-DD).", "format": "date", "type": "string" }, "state": { "description": "Job location state.", "maxLength": 50, "minLength": 1, "type": "string" }, "status": { "$ref": "#/components/schemas/CandidatesPostRequestBodyContentApplicationJsonSchemaDataStatus", "description": "Offer status" } }, "required": [ "id", "link", "status", "last_name", "first_name", "start_date" ], "title": "CandidatesPostRequestBodyContentApplicationJsonSchemaData", "type": "object" }, "CandidatesPostRequestBodyContentApplicationJsonSchemaDataStatus": { "description": "Offer status", "enum": [ "offer-accepted", "offer-sent", "offer-declined", "offer-deleted" ], "title": "CandidatesPostRequestBodyContentApplicationJsonSchemaDataStatus", "type": "string" }, "CandidatesPostResponsesContentApplicationJsonSchemaData": { "properties": { "created": { "description": "Indicates if the candidate was created successfully.", "type": "boolean" } }, "required": [ "created" ], "title": "CandidatesPostResponsesContentApplicationJsonSchemaData", "type": "object" }, "Candidates_addCandidate-v2026-01-01_Response_201": { "properties": { "data": { "$ref": "#/components/schemas/CandidatesPostResponsesContentApplicationJsonSchemaData" } }, "required": [ "data" ], "title": "Candidates_addCandidate-v2026-01-01_Response_201", "type": "object" }, "ChangeEorMailboxPassword-v2026-01-01RequestBadRequestError": { "properties": { "errors": { "items": { "$ref": "#/components/schemas/EorMailboxesChangePasswordPostResponsesContentApplicationJsonSchemaErrorsItems" }, "type": "array" } }, "title": "ChangeEorMailboxPassword-v2026-01-01RequestBadRequestError", "type": "object" }, "ChangeEorMailboxPassword-v2026-01-01RequestInternalServerError": { "properties": { "errors": { "items": { "$ref": "#/components/schemas/EorMailboxesChangePasswordPostResponsesContentApplicationJsonSchemaErrorsItems" }, "type": "array" } }, "title": "ChangeEorMailboxPassword-v2026-01-01RequestInternalServerError", "type": "object" }, "ClearItAsset-v2026-09-17RequestBadRequestError": { "properties": { "errors": { "items": { "$ref": "#/components/schemas/ItAssetsAssetIdClearPostResponsesContentApplicationJsonSchemaErrorsItems" }, "type": "array" } }, "required": [ "errors" ], "title": "ClearItAsset-v2026-09-17RequestBadRequestError", "type": "object" }, "ClearItAsset-v2026-09-17RequestConflictError": { "properties": { "errors": { "items": { "$ref": "#/components/schemas/ItAssetsAssetIdClearPostResponsesContentApplicationJsonSchemaErrorsItems" }, "type": "array" } }, "required": [ "errors" ], "title": "ClearItAsset-v2026-09-17RequestConflictError", "type": "object" }, "ClearItAsset-v2026-09-17RequestForbiddenError": { "properties": { "errors": { "items": { "$ref": "#/components/schemas/ItAssetsAssetIdClearPostResponsesContentApplicationJsonSchemaErrorsItems" }, "type": "array" } }, "required": [ "errors" ], "title": "ClearItAsset-v2026-09-17RequestForbiddenError", "type": "object" }, "ClearItAsset-v2026-09-17RequestInternalServerError": { "properties": { "errors": { "items": { "$ref": "#/components/schemas/ItAssetsAssetIdClearPostResponsesContentApplicationJsonSchemaErrorsItems" }, "type": "array" } }, "required": [ "errors" ], "title": "ClearItAsset-v2026-09-17RequestInternalServerError", "type": "object" }, "ClearItAsset-v2026-09-17RequestNotFoundError": { "properties": { "errors": { "items": { "$ref": "#/components/schemas/ItAssetsAssetIdClearPostResponsesContentApplicationJsonSchemaErrorsItems" }, "type": "array" } }, "required": [ "errors" ], "title": "ClearItAsset-v2026-09-17RequestNotFoundError", "type": "object" }, "ClearItAsset-v2026-09-17RequestUnauthorizedError": { "properties": { "errors": { "items": { "$ref": "#/components/schemas/ItAssetsAssetIdClearPostResponsesContentApplicationJsonSchemaErrorsItems" }, "type": "array" } }, "required": [ "errors" ], "title": "ClearItAsset-v2026-09-17RequestUnauthorizedError", "type": "object" }, "Clearance_requests_cancelAClearanceRequest-v2026-09-15_Response_200": { "properties": { "data": { "$ref": "#/components/schemas/ItClearanceRequestsClearanceRequestIdCancelPostResponsesContentApplicationJsonSchemaData" } }, "required": [ "data" ], "title": "Clearance requests_cancelAClearanceRequest-v2026-09-15_Response_200", "type": "object" }, "Clearance_requests_clearItAsset-v2026-09-17_Response_200": { "properties": { "data": { "$ref": "#/components/schemas/ItAssetsAssetIdClearPostResponsesContentApplicationJsonSchemaData" } }, "required": [ "data" ], "title": "Clearance requests_clearItAsset-v2026-09-17_Response_200", "type": "object" }, "Clearance_requests_decideAClearanceRequest-v2026-09-17_Response_200": { "properties": { "data": { "$ref": "#/components/schemas/ItClearanceRequestsClearanceRequestIdDecidePostResponsesContentApplicationJsonSchemaData" } }, "required": [ "data" ], "title": "Clearance requests_decideAClearanceRequest-v2026-09-17_Response_200", "type": "object" }, "Clearance_requests_listClearanceRequests-v2026-09-16_Response_200": { "properties": { "data": { "items": { "$ref": "#/components/schemas/ItClearanceRequestsGetResponsesContentApplicationJsonSchemaDataItems" }, "type": "array" }, "has_more": { "description": "Whether there are more results available", "type": "boolean" }, "next_cursor": { "description": "Cursor to the next page", "type": [ "string", "null" ] }, "total_count": { "description": "Total number of records", "format": "int64", "type": "integer" } }, "required": [ "data", "has_more", "next_cursor", "total_count" ], "title": "Clearance requests_listClearanceRequests-v2026-09-16_Response_200", "type": "object" }, "Clearance_requests_retrieveAClearanceRequest-v2026-09-15_Response_200": { "properties": { "data": { "$ref": "#/components/schemas/ItClearanceRequestsClearanceRequestIdGetResponsesContentApplicationJsonSchemaData" } }, "required": [ "data" ], "title": "Clearance requests_retrieveAClearanceRequest-v2026-09-15_Response_200", "type": "object" }, "CloneAGroup-v2026-01-01RequestBadRequestError": { "properties": { "errors": { "items": { "$ref": "#/components/schemas/GroupsIdClonePostResponsesContentApplicationJsonSchemaErrorsItems" }, "type": "array" } }, "title": "CloneAGroup-v2026-01-01RequestBadRequestError", "type": "object" }, "CollectItAsset-v2026-09-15RequestBadRequestError": { "properties": { "errors": { "items": { "$ref": "#/components/schemas/ItAssetsAssetIdCollectPostResponsesContentApplicationJsonSchemaErrorsItems" }, "type": "array" } }, "required": [ "errors" ], "title": "CollectItAsset-v2026-09-15RequestBadRequestError", "type": "object" }, "CollectItAsset-v2026-09-15RequestConflictError": { "properties": { "errors": { "items": { "$ref": "#/components/schemas/ItAssetsAssetIdCollectPostResponsesContentApplicationJsonSchemaErrorsItems" }, "type": "array" } }, "required": [ "errors" ], "title": "CollectItAsset-v2026-09-15RequestConflictError", "type": "object" }, "CollectItAsset-v2026-09-15RequestForbiddenError": { "properties": { "errors": { "items": { "$ref": "#/components/schemas/ItAssetsAssetIdCollectPostResponsesContentApplicationJsonSchemaErrorsItems" }, "type": "array" } }, "required": [ "errors" ], "title": "CollectItAsset-v2026-09-15RequestForbiddenError", "type": "object" }, "CollectItAsset-v2026-09-15RequestInternalServerError": { "properties": { "errors": { "items": { "$ref": "#/components/schemas/ItAssetsAssetIdCollectPostResponsesContentApplicationJsonSchemaErrorsItems" }, "type": "array" } }, "required": [ "errors" ], "title": "CollectItAsset-v2026-09-15RequestInternalServerError", "type": "object" }, "CollectItAsset-v2026-09-15RequestNotFoundError": { "properties": { "errors": { "items": { "$ref": "#/components/schemas/ItAssetsAssetIdCollectPostResponsesContentApplicationJsonSchemaErrorsItems" }, "type": "array" } }, "required": [ "errors" ], "title": "CollectItAsset-v2026-09-15RequestNotFoundError", "type": "object" }, "CollectItAsset-v2026-09-15RequestUnauthorizedError": { "properties": { "errors": { "items": { "$ref": "#/components/schemas/ItAssetsAssetIdCollectPostResponsesContentApplicationJsonSchemaErrorsItems" }, "type": "array" } }, "required": [ "errors" ], "title": "CollectItAsset-v2026-09-15RequestUnauthorizedError", "type": "object" }, "CompleteIndividualContractorProfileSetup-v2026-01-01RequestBadRequestError": { "properties": { "errors": { "items": { "$ref": "#/components/schemas/OnboardingWorkersIndividualPostResponsesContentApplicationJsonSchemaErrorsItems" }, "type": "array" } }, "title": "CompleteIndividualContractorProfileSetup-v2026-01-01RequestBadRequestError", "type": "object" }, "CompleteIndividualContractorProfileSetup-v2026-01-01RequestInternalServerError": { "properties": { "errors": { "items": { "$ref": "#/components/schemas/OnboardingWorkersIndividualPostResponsesContentApplicationJsonSchemaErrorsItems" }, "type": "array" } }, "title": "CompleteIndividualContractorProfileSetup-v2026-01-01RequestInternalServerError", "type": "object" }, "ConfirmAnExistingContractAmendment-v2026-01-01RequestBadRequestError": { "properties": { "errors": { "items": { "$ref": "#/components/schemas/EorContractsContractIdAmendmentsAmendmentIdConfirmPostResponsesContentApplicationJsonSchemaErrorsItems" }, "type": "array" } }, "required": [ "errors" ], "title": "ConfirmAnExistingContractAmendment-v2026-01-01RequestBadRequestError", "type": "object" }, "ConfirmAnExistingContractAmendment-v2026-01-01RequestInternalServerError": { "properties": { "errors": { "items": { "$ref": "#/components/schemas/EorContractsContractIdAmendmentsAmendmentIdConfirmPostResponsesContentApplicationJsonSchemaErrorsItems" }, "type": "array" } }, "required": [ "errors" ], "title": "ConfirmAnExistingContractAmendment-v2026-01-01RequestInternalServerError", "type": "object" }, "ConfirmAnExistingContractAmendment-v2026-01-01RequestNotFoundError": { "properties": { "errors": { "items": { "$ref": "#/components/schemas/EorContractsContractIdAmendmentsAmendmentIdConfirmPostResponsesContentApplicationJsonSchemaErrorsItems" }, "type": "array" } }, "required": [ "errors" ], "title": "ConfirmAnExistingContractAmendment-v2026-01-01RequestNotFoundError", "type": "object" }, "ConsentTokenPostRequestBodyContentApplicationJsonSchemaData": { "properties": { "contract_id": { "description": "Contract ID", "minLength": 1, "type": "string" }, "profile_id": { "description": "Profile ID", "minLength": 1, "type": "string" }, "user_id": { "description": "User ID", "minLength": 1, "type": "string" } }, "required": [ "user_id", "profile_id", "contract_id" ], "title": "ConsentTokenPostRequestBodyContentApplicationJsonSchemaData", "type": "object" }, "ConsentTokenPostResponsesContentApplicationJsonSchemaData": { "properties": { "created_at": { "description": "Token creation timestamp", "format": "date-time", "type": "string" }, "expires_at": { "description": "Token expiration timestamp", "format": "date-time", "type": "string" }, "unique_consent_token": { "description": "JWT token for consent", "minLength": 1, "type": "string" }, "updated_at": { "description": "Token last update timestamp", "format": "date-time", "type": "string" } }, "required": [ "created_at", "expires_at", "updated_at", "unique_consent_token" ], "title": "ConsentTokenPostResponsesContentApplicationJsonSchemaData", "type": "object" }, "Consent_createConsentToken-v2026-01-01_Response_201": { "properties": { "data": { "$ref": "#/components/schemas/ConsentTokenPostResponsesContentApplicationJsonSchemaData" } }, "required": [ "data" ], "title": "Consent_createConsentToken-v2026-01-01_Response_201", "type": "object" }, "ContractTemplatesGetResponsesContentApplicationJsonSchemaDataItems": { "properties": { "id": { "$ref": "#/components/schemas/ContractTemplatesGetResponsesContentApplicationJsonSchemaDataItemsId" }, "title": { "description": "The title of a contract template.", "type": "string" } }, "required": [ "id", "title" ], "title": "ContractTemplatesGetResponsesContentApplicationJsonSchemaDataItems", "type": "object" }, "ContractTemplatesGetResponsesContentApplicationJsonSchemaDataItemsId": { "oneOf": [ { "type": "string" }, { "format": "int64", "type": "integer" } ], "title": "ContractTemplatesGetResponsesContentApplicationJsonSchemaDataItemsId" }, "ContractsContractIdAdjustmentsGetResponsesContentApplicationJsonSchemaDataItems": { "properties": { "actual_end_cycle_date": { "description": "The date of the actual end cycle date", "type": "string" }, "actual_start_cycle_date": { "description": "The date of the actual start cycle date", "type": "string" }, "adjustment_category_id": { "description": "The identifier of the adjustment category associated with the adjustment", "type": "string" }, "amount": { "description": "The amount of the adjustment", "type": "string" }, "contract_id": { "description": "The identifier of the contract associated with the adjustment", "type": "string" }, "created_at": { "description": "The date and time when the adjustment was created", "format": "date-time", "type": "string" }, "cycle_reference": { "description": "The reference to the cycle associated with the adjustment", "type": [ "string", "null" ] }, "date_of_adjustment": { "description": "The date of the adjustment", "format": "date-time", "type": [ "string", "null" ] }, "description": { "description": "The description of the adjustment", "type": "string" }, "file": { "description": "Info for the attachment of adjustment", "oneOf": [ { "$ref": "#/components/schemas/ContractsContractIdAdjustmentsGetResponsesContentApplicationJsonSchemaDataItemsFile" }, { "type": "null" } ] }, "id": { "description": "The unique identifier of the adjustment", "type": "string" }, "move_next_cycle": { "description": "If an adjustments can belong to another payroll cycle", "type": "boolean" }, "odp_only": { "description": "Whether the adjustment is restricted to on-demand payroll and never attached to a regular payroll cycle. Always false for contract types other than EOR", "type": "boolean" }, "status": { "$ref": "#/components/schemas/ContractsContractIdAdjustmentsGetResponsesContentApplicationJsonSchemaDataItemsStatus", "description": "Adjustment status" }, "title": { "description": "The title of the adjustment", "type": "string" }, "updated_at": { "description": "The date and time when the adjustment was last updated", "format": "date-time", "type": "string" } }, "title": "ContractsContractIdAdjustmentsGetResponsesContentApplicationJsonSchemaDataItems", "type": "object" }, "ContractsContractIdAdjustmentsGetResponsesContentApplicationJsonSchemaDataItemsFile": { "description": "Info for the attachment of adjustment", "properties": { "fileType": { "description": "The type of the file", "type": "string" }, "id": { "description": "The unique identifier of the file", "type": "string" }, "name": { "description": "The name of the file", "type": "string" } }, "title": "ContractsContractIdAdjustmentsGetResponsesContentApplicationJsonSchemaDataItemsFile", "type": "object" }, "ContractsContractIdAdjustmentsGetResponsesContentApplicationJsonSchemaDataItemsStatus": { "description": "Adjustment status", "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" ], "title": "ContractsContractIdAdjustmentsGetResponsesContentApplicationJsonSchemaDataItemsStatus", "type": "string" }, "ContractsContractIdAdjustmentsGetResponsesContentApplicationJsonSchemaErrorsItems": { "properties": { "message": { "description": "You must have access to the contract sent", "type": "string" } }, "title": "ContractsContractIdAdjustmentsGetResponsesContentApplicationJsonSchemaErrorsItems", "type": "object" }, "ContractsContractIdAmendmentsAmendmentIdSignPostParametersXBeta": { "default": "true", "enum": [ "true" ], "title": "ContractsContractIdAmendmentsAmendmentIdSignPostParametersXBeta", "type": "string" }, "ContractsContractIdAmendmentsAmendmentIdSignPostRequestBodyContentApplicationJsonSchemaData": { "properties": { "client_signature": { "description": "The client's signature for the amendment.", "minLength": 2, "type": "string" } }, "required": [ "client_signature" ], "title": "ContractsContractIdAmendmentsAmendmentIdSignPostRequestBodyContentApplicationJsonSchemaData", "type": "object" }, "ContractsContractIdAmendmentsAmendmentIdSignPostResponsesContentApplicationJsonSchemaData": { "properties": { "id": { "description": "The unique identifier of the signed amendment.", "format": "uuid", "type": "string" }, "is_signed": { "description": "Indicates whether the amendment was successfully signed.", "type": "boolean" } }, "required": [ "id", "is_signed" ], "title": "ContractsContractIdAmendmentsAmendmentIdSignPostResponsesContentApplicationJsonSchemaData", "type": "object" }, "ContractsContractIdAmendmentsAmendmentIdSignPostResponsesContentApplicationJsonSchemaErrorsItems": { "properties": { "code": { "description": "Machine-readable error code", "type": "string" }, "message": { "description": "Human-readable explanation of the error", "type": "string" } }, "title": "ContractsContractIdAmendmentsAmendmentIdSignPostResponsesContentApplicationJsonSchemaErrorsItems", "type": "object" }, "ContractsContractIdAmendmentsGetParametersSignStatusesSchemaItems": { "enum": [ "PENDING", "WAITING_FOR_APPROVAL", "APPROVED", "DECLINED" ], "title": "ContractsContractIdAmendmentsGetParametersSignStatusesSchemaItems", "type": "string" }, "ContractsContractIdAmendmentsGetParametersStatusesSchemaItems": { "enum": [ "INITIAL", "PENDING", "ACTIVE", "OUTDATED", "APPROVED", "DECLINED" ], "title": "ContractsContractIdAmendmentsGetParametersStatusesSchemaItems", "type": "string" }, "ContractsContractIdAmendmentsGetResponsesContentApplicationJsonSchemaDataItems": { "oneOf": [ { "$ref": "#/components/schemas/ContractsContractIdAmendmentsGetResponsesContentApplicationJsonSchemaDataItems0" }, { "$ref": "#/components/schemas/ContractsContractIdAmendmentsGetResponsesContentApplicationJsonSchemaDataItems1" } ], "title": "ContractsContractIdAmendmentsGetResponsesContentApplicationJsonSchemaDataItems" }, "ContractsContractIdAmendmentsGetResponsesContentApplicationJsonSchemaDataItems0": { "properties": { "contract_name": { "description": "Name of the associated contract.", "type": [ "string", "null" ] }, "contract_type": { "description": "Type of the associated IC contract.", "oneOf": [ { "$ref": "#/components/schemas/ContractsContractIdAmendmentsGetResponsesContentApplicationJsonSchemaDataItemsOneOf0ContractType" }, { "type": "null" } ] }, "created_at": { "description": "Timestamp when the work statement was created.", "format": "date-time", "type": "string" }, "currency_code": { "description": "Currency code in ISO 4217 format (e.g., USD, EUR, GBP).", "maxLength": 3, "minLength": 3, "pattern": "^[A-Z]{3}$", "type": [ "string", "null" ] }, "effective_date": { "description": "Effective date when the work statement becomes active.", "format": "date-time", "type": [ "string", "null" ] }, "id": { "description": "Unique identifier for the work statement.", "format": "uuid", "type": "string" }, "rate": { "description": "Compensation rate per scale. The amount paid according to the specified scale (e.g., 5000 per month).", "format": "double", "type": [ "number", "null" ] }, "scale": { "description": "Payment frequency/scale that defines how often the rate is paid.", "oneOf": [ { "$ref": "#/components/schemas/ContractsContractIdAmendmentsGetResponsesContentApplicationJsonSchemaDataItemsOneOf0Scale" }, { "type": "null" } ] }, "sign_status": { "$ref": "#/components/schemas/ContractsContractIdAmendmentsGetResponsesContentApplicationJsonSchemaDataItemsOneOf0SignStatus", "description": "Current sign status of the work statement." }, "status": { "$ref": "#/components/schemas/ContractsContractIdAmendmentsGetResponsesContentApplicationJsonSchemaDataItemsOneOf0Status", "description": "Current status of the work statement." }, "updated_at": { "description": "Timestamp when the work statement was last updated.", "format": "date-time", "type": "string" } }, "required": [ "id", "status", "created_at", "updated_at", "sign_status" ], "title": "ContractsContractIdAmendmentsGetResponsesContentApplicationJsonSchemaDataItems0", "type": "object" }, "ContractsContractIdAmendmentsGetResponsesContentApplicationJsonSchemaDataItems1": { "properties": { "base_compensation_type": { "description": "Type of base compensation for the amendment.", "oneOf": [ { "$ref": "#/components/schemas/ContractsContractIdAmendmentsGetResponsesContentApplicationJsonSchemaDataItemsOneOf1BaseCompensationType" }, { "type": "null" } ] }, "created_at": { "description": "Timestamp when the amendment was created.", "format": "date-time", "type": "string" }, "currency_code": { "description": "Currency code for the base compensation.", "type": [ "string", "null" ] }, "effective_date": { "description": "Short date in format ISO-8601 (YYYY-MM-DD) when the amendment takes effect.", "format": "date", "type": [ "string", "null" ] }, "id": { "description": "Unique identifier for the amendment.", "format": "uuid", "type": "string" }, "rate": { "description": "Base compensation rate for the amendment.", "format": "double", "type": [ "number", "null" ] }, "scale": { "description": "Payment scale for the base compensation.", "oneOf": [ { "$ref": "#/components/schemas/ContractsContractIdAmendmentsGetResponsesContentApplicationJsonSchemaDataItemsOneOf1Scale" }, { "type": "null" } ] }, "sign_status": { "description": "Sign status is not tracked for Global Payroll amendments; always null. Signing state is conveyed by `status`. Filters `statuses` and `sign_statuses` apply to Individual Contractor contracts only and are ignored for Global Payroll contracts.", "oneOf": [ { "$ref": "#/components/schemas/ContractsContractIdAmendmentsGetResponsesContentApplicationJsonSchemaDataItemsOneOf1SignStatus" }, { "type": "null" } ] }, "status": { "$ref": "#/components/schemas/ContractsContractIdAmendmentsGetResponsesContentApplicationJsonSchemaDataItemsOneOf1Status", "description": "Status of the Global Payroll amendment." }, "updated_at": { "description": "Timestamp when the amendment was last updated.", "format": "date-time", "type": "string" } }, "required": [ "id", "status", "created_at", "updated_at", "sign_status" ], "title": "ContractsContractIdAmendmentsGetResponsesContentApplicationJsonSchemaDataItems1", "type": "object" }, "ContractsContractIdAmendmentsGetResponsesContentApplicationJsonSchemaDataItemsOneOf0ContractType": { "description": "Type of the associated IC contract.", "enum": [ "milestones", "time_based", "ongoing_time_based", "pay_as_you_go_time_based", "commission", "payg_milestones", "payg_tasks" ], "title": "ContractsContractIdAmendmentsGetResponsesContentApplicationJsonSchemaDataItemsOneOf0ContractType", "type": "string" }, "ContractsContractIdAmendmentsGetResponsesContentApplicationJsonSchemaDataItemsOneOf0Scale": { "description": "Payment frequency/scale that defines how often the rate is paid.", "enum": [ "hourly", "daily", "weekly", "monthly", "biweekly", "semimonthly", "custom" ], "title": "ContractsContractIdAmendmentsGetResponsesContentApplicationJsonSchemaDataItemsOneOf0Scale", "type": "string" }, "ContractsContractIdAmendmentsGetResponsesContentApplicationJsonSchemaDataItemsOneOf0SignStatus": { "description": "Current sign status of the work statement.", "enum": [ "PENDING", "WAITING_FOR_APPROVAL", "APPROVED", "DECLINED" ], "title": "ContractsContractIdAmendmentsGetResponsesContentApplicationJsonSchemaDataItemsOneOf0SignStatus", "type": "string" }, "ContractsContractIdAmendmentsGetResponsesContentApplicationJsonSchemaDataItemsOneOf0Status": { "description": "Current status of the work statement.", "enum": [ "INITIAL", "PENDING", "ACTIVE", "OUTDATED", "APPROVED", "DECLINED" ], "title": "ContractsContractIdAmendmentsGetResponsesContentApplicationJsonSchemaDataItemsOneOf0Status", "type": "string" }, "ContractsContractIdAmendmentsGetResponsesContentApplicationJsonSchemaDataItemsOneOf1BaseCompensationType": { "description": "Type of base compensation for the amendment.", "enum": [ "salaried", "hourly", "unpaid", "commission_only" ], "title": "ContractsContractIdAmendmentsGetResponsesContentApplicationJsonSchemaDataItemsOneOf1BaseCompensationType", "type": "string" }, "ContractsContractIdAmendmentsGetResponsesContentApplicationJsonSchemaDataItemsOneOf1Scale": { "description": "Payment scale for the base compensation.", "enum": [ "hourly", "daily", "weekly", "monthly", "annually", "two_weekly", "bi_monthly", "custom", "one_off" ], "title": "ContractsContractIdAmendmentsGetResponsesContentApplicationJsonSchemaDataItemsOneOf1Scale", "type": "string" }, "ContractsContractIdAmendmentsGetResponsesContentApplicationJsonSchemaDataItemsOneOf1SignStatus": { "description": "Sign status is not tracked for Global Payroll amendments; always null. Signing state is conveyed by `status`. Filters `statuses` and `sign_statuses` apply to Individual Contractor contracts only and are ignored for Global Payroll contracts.", "enum": [ "PENDING", "WAITING_FOR_APPROVAL", "APPROVED", "DECLINED" ], "title": "ContractsContractIdAmendmentsGetResponsesContentApplicationJsonSchemaDataItemsOneOf1SignStatus", "type": "string" }, "ContractsContractIdAmendmentsGetResponsesContentApplicationJsonSchemaDataItemsOneOf1Status": { "description": "Status of the Global Payroll amendment.", "enum": [ "waiting_for_approval", "waiting_client_sign", "waiting_worker_sign", "signed", "completed", "obsolete" ], "title": "ContractsContractIdAmendmentsGetResponsesContentApplicationJsonSchemaDataItemsOneOf1Status", "type": "string" }, "ContractsContractIdAmendmentsGetResponsesContentApplicationJsonSchemaErrorsItems": { "properties": { "code": { "description": "Machine-readable error code", "type": "string" }, "message": { "description": "Human-readable explanation of the error", "type": "string" } }, "title": "ContractsContractIdAmendmentsGetResponsesContentApplicationJsonSchemaErrorsItems", "type": "object" }, "ContractsContractIdAmendmentsPostRequestBodyContentApplicationJsonSchemaData": { "oneOf": [ { "$ref": "#/components/schemas/ContractsContractIdAmendmentsPostRequestBodyContentApplicationJsonSchemaData0" }, { "$ref": "#/components/schemas/ContractsContractIdAmendmentsPostRequestBodyContentApplicationJsonSchemaData1" } ], "title": "ContractsContractIdAmendmentsPostRequestBodyContentApplicationJsonSchemaData" }, "ContractsContractIdAmendmentsPostRequestBodyContentApplicationJsonSchemaData0": { "description": "You can specify any combination of data points that need changing.", "properties": { "amount": { "description": "Amount to be paid per scale.", "format": "double", "minimum": 1, "type": "number" }, "currency_code": { "description": "Currency code in ISO 4217 format.", "maxLength": 3, "minLength": 3, "pattern": "^[A-Z]{3}$", "type": "string" }, "cycle_end": { "description": "Day of the month when the cycle ends.", "format": "double", "maximum": 31, "minimum": 1, "type": "number" }, "cycle_end_type": { "$ref": "#/components/schemas/ContractsContractIdAmendmentsPostRequestBodyContentApplicationJsonSchemaDataOneOf0CycleEndType", "description": "Cycle end can be weekly 1-7 (Monday = 1) or monthly 1-31." }, "effective_date": { "description": "Short date in format ISO-8601 (YYYY-MM-DD). For example: 2022-12-31.", "format": "date", "type": "string" }, "first_payment": { "description": "Amount to be paid as the first payment.", "format": "double", "minimum": 0, "type": "number" }, "first_payment_date": { "description": "Short date in format ISO-8601 (YYYY-MM-DD). For example: 2022-12-31.", "format": "date", "type": "string" }, "frequency": { "$ref": "#/components/schemas/ContractsContractIdAmendmentsPostRequestBodyContentApplicationJsonSchemaDataOneOf0Frequency", "description": "Scale of the invoice cycle." }, "job_title_id": { "$ref": "#/components/schemas/ContractsContractIdAmendmentsPostRequestBodyContentApplicationJsonSchemaDataOneOf0JobTitleId" }, "job_title_name": { "description": "You can enter new job title.", "type": "string" }, "pay_before_weekends": { "description": "If the payment due is on a weekend, pay on Friday.", "type": "boolean" }, "payment_due_days": { "description": "Number of days after the invoice is sent that the payment is due.", "format": "double", "maximum": 90, "minimum": 0, "type": "number" }, "payment_due_type": { "$ref": "#/components/schemas/ContractsContractIdAmendmentsPostRequestBodyContentApplicationJsonSchemaDataOneOf0PaymentDueType", "default": "REGULAR", "description": "Type of payment due. If the payment is due on the last day of month, enter 'WITHIN_MONTH'." }, "scale": { "$ref": "#/components/schemas/ContractsContractIdAmendmentsPostRequestBodyContentApplicationJsonSchemaDataOneOf0Scale", "description": "Defines the scale at which the amount is paid. For example, enter 'hourly' to define the amount per hour. This field can be excluded when creating a Pay-as-you-go task-based or Milestone contracts." }, "scope_of_work": { "description": "Text to describe the scope of work of the contract.", "type": "string" }, "seniority_id": { "$ref": "#/components/schemas/ContractsContractIdAmendmentsPostRequestBodyContentApplicationJsonSchemaDataOneOf0SeniorityId" }, "special_clause": { "description": "Text to describe any special clause in contract.", "type": "string" }, "start_date": { "description": "The contract start date in ISO-8601 format (YYYY-MM-DD). Updates the contract's effective date.", "format": "date", "type": "string" } }, "title": "ContractsContractIdAmendmentsPostRequestBodyContentApplicationJsonSchemaData0", "type": "object" }, "ContractsContractIdAmendmentsPostRequestBodyContentApplicationJsonSchemaData1": { "description": "You can specify any combination of data points that need changing for a Global Payroll amendment, alongside the required effective_date.", "properties": { "amount": { "description": "Base compensation amount to be paid per scale.", "format": "double", "maximum": 1000000000, "minimum": 0, "type": "number" }, "base_compensation_custom_name": { "description": "Custom display name for the base compensation.", "maxLength": 255, "type": "string" }, "base_compensation_type": { "$ref": "#/components/schemas/ContractsContractIdAmendmentsPostRequestBodyContentApplicationJsonSchemaDataOneOf1BaseCompensationType", "default": "salaried", "description": "Type of base compensation. Defaults to salaried if base compensation fields are provided and this is omitted." }, "change_reason": { "description": "The unique identifier (oid) of a modification reason configured for the organization, not free text. Required by organizations that have modification reasons configured.", "format": "uuid", "type": "string" }, "contract_start_date": { "description": "Short date in format ISO-8601 (YYYY-MM-DD). The contract start date.", "format": "date", "type": "string" }, "contract_term": { "$ref": "#/components/schemas/ContractsContractIdAmendmentsPostRequestBodyContentApplicationJsonSchemaDataOneOf1ContractTerm", "description": "Whether the contract has a fixed end date. 'end_date' is required when this is 'definite'." }, "currency_code": { "description": "Currency code in ISO 4217 format.", "maxLength": 3, "minLength": 3, "pattern": "^[A-Z]{3}$", "type": "string" }, "custom_fields": { "description": "Custom field values to update.", "items": { "$ref": "#/components/schemas/ContractsContractIdAmendmentsPostRequestBodyContentApplicationJsonSchemaDataOneOf1CustomFieldsItems" }, "type": "array" }, "effective_date": { "description": "Short date in format ISO-8601 (YYYY-MM-DD) when the amendment takes effect. Required — the amendment cannot be signed without it.", "format": "date", "type": "string" }, "end_date": { "description": "Short date in format ISO-8601 (YYYY-MM-DD). Required when contract_term is 'definite'.", "format": "date", "type": "string" }, "pay_slip_currency": { "description": "Currency shown on the payslip.", "maxLength": 3, "minLength": 3, "pattern": "^[A-Z]{3}$", "type": "string" }, "payout_currency": { "description": "Currency the worker is paid out in.", "maxLength": 3, "minLength": 3, "pattern": "^[A-Z]{3}$", "type": "string" }, "scale": { "$ref": "#/components/schemas/ContractsContractIdAmendmentsPostRequestBodyContentApplicationJsonSchemaDataOneOf1Scale", "description": "Defines the scale at which the base compensation amount is paid." }, "type_of_edit": { "$ref": "#/components/schemas/ContractsContractIdAmendmentsPostRequestBodyContentApplicationJsonSchemaDataOneOf1TypeOfEdit", "default": "amendment", "description": "Whether the change requires a signature. 'amendment' (default) creates a pending amendment that must be signed via POST /rest/contracts/{contract_id}/amendments/{amendment_id}/sign before it takes effect. 'direct' applies the change immediately, with no signature required." }, "variable_compensations": { "description": "Variable compensations to add or update alongside the base compensation change.", "items": { "$ref": "#/components/schemas/ContractsContractIdAmendmentsPostRequestBodyContentApplicationJsonSchemaDataOneOf1VariableCompensationsItems" }, "type": "array" } }, "required": [ "effective_date" ], "title": "ContractsContractIdAmendmentsPostRequestBodyContentApplicationJsonSchemaData1", "type": "object" }, "ContractsContractIdAmendmentsPostRequestBodyContentApplicationJsonSchemaDataOneOf0CycleEndType": { "description": "Cycle end can be weekly 1-7 (Monday = 1) or monthly 1-31.", "enum": [ "DAY_OF_WEEK", "DAY_OF_LAST_WEEK", "DAY_OF_MONTH" ], "title": "ContractsContractIdAmendmentsPostRequestBodyContentApplicationJsonSchemaDataOneOf0CycleEndType", "type": "string" }, "ContractsContractIdAmendmentsPostRequestBodyContentApplicationJsonSchemaDataOneOf0Frequency": { "description": "Scale of the invoice cycle.", "enum": [ "weekly", "monthly", "biweekly", "semimonthly", "calendar-month" ], "title": "ContractsContractIdAmendmentsPostRequestBodyContentApplicationJsonSchemaDataOneOf0Frequency", "type": "string" }, "ContractsContractIdAmendmentsPostRequestBodyContentApplicationJsonSchemaDataOneOf0JobTitleId": { "oneOf": [ { "type": "string" }, { "format": "int64", "type": "integer" } ], "title": "ContractsContractIdAmendmentsPostRequestBodyContentApplicationJsonSchemaDataOneOf0JobTitleId" }, "ContractsContractIdAmendmentsPostRequestBodyContentApplicationJsonSchemaDataOneOf0PaymentDueType": { "default": "REGULAR", "description": "Type of payment due. If the payment is due on the last day of month, enter 'WITHIN_MONTH'.", "enum": [ "REGULAR", "WITHIN_MONTH" ], "title": "ContractsContractIdAmendmentsPostRequestBodyContentApplicationJsonSchemaDataOneOf0PaymentDueType", "type": "string" }, "ContractsContractIdAmendmentsPostRequestBodyContentApplicationJsonSchemaDataOneOf0Scale": { "description": "Defines the scale at which the amount is paid. For example, enter 'hourly' to define the amount per hour. This field can be excluded when creating a Pay-as-you-go task-based or Milestone contracts.", "enum": [ "hourly", "daily", "weekly", "monthly", "biweekly", "semimonthly", "custom" ], "title": "ContractsContractIdAmendmentsPostRequestBodyContentApplicationJsonSchemaDataOneOf0Scale", "type": "string" }, "ContractsContractIdAmendmentsPostRequestBodyContentApplicationJsonSchemaDataOneOf0SeniorityId": { "oneOf": [ { "type": "string" }, { "format": "int64", "type": "integer" } ], "title": "ContractsContractIdAmendmentsPostRequestBodyContentApplicationJsonSchemaDataOneOf0SeniorityId" }, "ContractsContractIdAmendmentsPostRequestBodyContentApplicationJsonSchemaDataOneOf1BaseCompensationType": { "default": "salaried", "description": "Type of base compensation. Defaults to salaried if base compensation fields are provided and this is omitted.", "enum": [ "salaried", "hourly", "unpaid", "commission_only" ], "title": "ContractsContractIdAmendmentsPostRequestBodyContentApplicationJsonSchemaDataOneOf1BaseCompensationType", "type": "string" }, "ContractsContractIdAmendmentsPostRequestBodyContentApplicationJsonSchemaDataOneOf1ContractTerm": { "description": "Whether the contract has a fixed end date. 'end_date' is required when this is 'definite'.", "enum": [ "definite", "indefinite" ], "title": "ContractsContractIdAmendmentsPostRequestBodyContentApplicationJsonSchemaDataOneOf1ContractTerm", "type": "string" }, "ContractsContractIdAmendmentsPostRequestBodyContentApplicationJsonSchemaDataOneOf1CustomFieldsItems": { "properties": { "currency": { "description": "Currency code in ISO 4217 format, for a currency-typed custom field.", "maxLength": 3, "minLength": 3, "pattern": "^[A-Z]{3}$", "type": "string" }, "id": { "description": "The unique identifier of the custom field.", "format": "uuid", "type": "string" }, "value": { "$ref": "#/components/schemas/ContractsContractIdAmendmentsPostRequestBodyContentApplicationJsonSchemaDataOneOf1CustomFieldsItemsValue", "description": "The new value for the custom field." } }, "required": [ "id", "value" ], "title": "ContractsContractIdAmendmentsPostRequestBodyContentApplicationJsonSchemaDataOneOf1CustomFieldsItems", "type": "object" }, "ContractsContractIdAmendmentsPostRequestBodyContentApplicationJsonSchemaDataOneOf1CustomFieldsItemsValue": { "description": "The new value for the custom field.", "oneOf": [ { "maxLength": 5000, "type": "string" }, { "format": "double", "type": "number" }, { "type": "boolean" } ], "title": "ContractsContractIdAmendmentsPostRequestBodyContentApplicationJsonSchemaDataOneOf1CustomFieldsItemsValue" }, "ContractsContractIdAmendmentsPostRequestBodyContentApplicationJsonSchemaDataOneOf1Scale": { "description": "Defines the scale at which the base compensation amount is paid.", "enum": [ "hourly", "daily", "weekly", "monthly", "annually", "two_weekly", "bi_monthly", "custom", "one_off" ], "title": "ContractsContractIdAmendmentsPostRequestBodyContentApplicationJsonSchemaDataOneOf1Scale", "type": "string" }, "ContractsContractIdAmendmentsPostRequestBodyContentApplicationJsonSchemaDataOneOf1TypeOfEdit": { "default": "amendment", "description": "Whether the change requires a signature. 'amendment' (default) creates a pending amendment that must be signed via POST /rest/contracts/{contract_id}/amendments/{amendment_id}/sign before it takes effect. 'direct' applies the change immediately, with no signature required.", "enum": [ "amendment", "direct" ], "title": "ContractsContractIdAmendmentsPostRequestBodyContentApplicationJsonSchemaDataOneOf1TypeOfEdit", "type": "string" }, "ContractsContractIdAmendmentsPostRequestBodyContentApplicationJsonSchemaDataOneOf1VariableCompensationsItems": { "properties": { "currency_code": { "description": "Currency code in ISO 4217 format.", "maxLength": 3, "minLength": 3, "pattern": "^[A-Z]{3}$", "type": "string" }, "effective_date": { "description": "Short date in format ISO-8601 (YYYY-MM-DD) when this variable compensation takes effect.", "format": "date", "type": "string" }, "effective_end_date": { "description": "Short date in format ISO-8601 (YYYY-MM-DD) when this variable compensation stops applying, if it does.", "format": "date", "type": [ "string", "null" ] }, "format": { "$ref": "#/components/schemas/ContractsContractIdAmendmentsPostRequestBodyContentApplicationJsonSchemaDataOneOf1VariableCompensationsItemsFormat", "description": "Whether the rate is a fixed amount or a percentage." }, "id": { "description": "The unique identifier of an existing variable compensation being updated. Omit when adding a new one.", "format": "uuid", "type": "string" }, "rate": { "description": "Variable compensation amount to be paid per scale.", "format": "double", "maximum": 1000000000, "minimum": 0, "type": "number" }, "scale": { "$ref": "#/components/schemas/ContractsContractIdAmendmentsPostRequestBodyContentApplicationJsonSchemaDataOneOf1VariableCompensationsItemsScale", "description": "Defines the scale at which the variable compensation amount is paid." }, "variable_compensation_configuration_id": { "description": "The unique identifier of the variable compensation configuration.", "format": "uuid", "type": "string" } }, "required": [ "rate", "scale", "currency_code", "effective_date", "variable_compensation_configuration_id" ], "title": "ContractsContractIdAmendmentsPostRequestBodyContentApplicationJsonSchemaDataOneOf1VariableCompensationsItems", "type": "object" }, "ContractsContractIdAmendmentsPostRequestBodyContentApplicationJsonSchemaDataOneOf1VariableCompensationsItemsFormat": { "description": "Whether the rate is a fixed amount or a percentage.", "enum": [ "amount", "percentage" ], "title": "ContractsContractIdAmendmentsPostRequestBodyContentApplicationJsonSchemaDataOneOf1VariableCompensationsItemsFormat", "type": "string" }, "ContractsContractIdAmendmentsPostRequestBodyContentApplicationJsonSchemaDataOneOf1VariableCompensationsItemsScale": { "description": "Defines the scale at which the variable compensation amount is paid.", "enum": [ "bi_annually", "annually", "quarterly", "monthly", "one_off" ], "title": "ContractsContractIdAmendmentsPostRequestBodyContentApplicationJsonSchemaDataOneOf1VariableCompensationsItemsScale", "type": "string" }, "ContractsContractIdAmendmentsPostResponsesContentApplicationJsonSchemaData": { "oneOf": [ { "$ref": "#/components/schemas/ContractsContractIdAmendmentsPostResponsesContentApplicationJsonSchemaData0" }, { "$ref": "#/components/schemas/ContractsContractIdAmendmentsPostResponsesContentApplicationJsonSchemaData1" } ], "title": "ContractsContractIdAmendmentsPostResponsesContentApplicationJsonSchemaData" }, "ContractsContractIdAmendmentsPostResponsesContentApplicationJsonSchemaData0": { "properties": { "created": { "description": "Contract has been successfully amended.", "type": "boolean" }, "created_at": { "description": "Timestamp when the work statement was created.", "format": "date-time", "type": "string" }, "currency_code": { "description": "Currency code for the amended work statement.", "type": "string" }, "id": { "description": "The unique identifier of the created amendment.", "format": "uuid", "type": "string" }, "job_title": { "description": "Job title for the amended work statement.", "type": [ "string", "null" ] }, "rate": { "description": "Rate/amount for the amended work statement.", "format": "double", "type": [ "number", "null" ] }, "scale": { "description": "Payment scale for the amended work statement.", "oneOf": [ { "$ref": "#/components/schemas/ContractsContractIdAmendmentsPostResponsesContentApplicationJsonSchemaDataOneOf0Scale" }, { "type": "null" } ] }, "scope_of_work": { "description": "Scope of work for the amended work statement.", "type": [ "string", "null" ] }, "special_clause": { "description": "Special clause for the amended work statement.", "type": [ "string", "null" ] }, "status": { "$ref": "#/components/schemas/ContractsContractIdAmendmentsPostResponsesContentApplicationJsonSchemaDataOneOf0Status", "description": "Status of the amended work statement." }, "termination_notice_days": { "description": "Number of days notice required for termination. Defaults to 10 if not provided.", "type": "integer" }, "updated_at": { "description": "Timestamp when the work statement was last updated.", "format": "date-time", "type": "string" }, "worker_id": { "description": "The unique identifier of the worker.", "format": "uuid", "type": [ "string", "null" ] } }, "required": [ "id", "status", "created", "created_at", "updated_at" ], "title": "ContractsContractIdAmendmentsPostResponsesContentApplicationJsonSchemaData0", "type": "object" }, "ContractsContractIdAmendmentsPostResponsesContentApplicationJsonSchemaData1": { "properties": { "base_compensation_type": { "description": "Type of base compensation for the amendment.", "oneOf": [ { "$ref": "#/components/schemas/ContractsContractIdAmendmentsPostResponsesContentApplicationJsonSchemaDataOneOf1BaseCompensationType" }, { "type": "null" } ] }, "created": { "description": "True if this call created a new amendment, false if it updated an existing pending one.", "type": "boolean" }, "created_at": { "description": "Timestamp when the amendment was created.", "format": "date-time", "type": "string" }, "currency_code": { "description": "Currency code for the base compensation.", "type": [ "string", "null" ] }, "effective_date": { "description": "Short date in format ISO-8601 (YYYY-MM-DD) when the amendment takes effect.", "format": "date", "type": [ "string", "null" ] }, "id": { "description": "The unique identifier of the amendment.", "format": "uuid", "type": "string" }, "rate": { "description": "Base compensation rate for the amended employment agreement.", "format": "double", "type": [ "number", "null" ] }, "scale": { "description": "Payment scale for the base compensation.", "oneOf": [ { "$ref": "#/components/schemas/ContractsContractIdAmendmentsPostResponsesContentApplicationJsonSchemaDataOneOf1Scale" }, { "type": "null" } ] }, "status": { "$ref": "#/components/schemas/ContractsContractIdAmendmentsPostResponsesContentApplicationJsonSchemaDataOneOf1Status", "description": "Status of the Global Payroll amendment. 'applied' only appears after a type_of_edit=direct request — the change took effect immediately and no pending amendment remains." }, "updated_at": { "description": "Timestamp when the amendment was last updated.", "format": "date-time", "type": "string" } }, "required": [ "id", "status", "created", "created_at", "updated_at" ], "title": "ContractsContractIdAmendmentsPostResponsesContentApplicationJsonSchemaData1", "type": "object" }, "ContractsContractIdAmendmentsPostResponsesContentApplicationJsonSchemaDataOneOf0Scale": { "description": "Payment scale for the amended work statement.", "enum": [ "hourly", "daily", "weekly", "monthly", "biweekly", "semimonthly", "custom" ], "title": "ContractsContractIdAmendmentsPostResponsesContentApplicationJsonSchemaDataOneOf0Scale", "type": "string" }, "ContractsContractIdAmendmentsPostResponsesContentApplicationJsonSchemaDataOneOf0Status": { "description": "Status of the amended work statement.", "enum": [ "initial", "pending", "active", "outdated", "approved", "declined" ], "title": "ContractsContractIdAmendmentsPostResponsesContentApplicationJsonSchemaDataOneOf0Status", "type": "string" }, "ContractsContractIdAmendmentsPostResponsesContentApplicationJsonSchemaDataOneOf1BaseCompensationType": { "description": "Type of base compensation for the amendment.", "enum": [ "salaried", "hourly", "unpaid", "commission_only" ], "title": "ContractsContractIdAmendmentsPostResponsesContentApplicationJsonSchemaDataOneOf1BaseCompensationType", "type": "string" }, "ContractsContractIdAmendmentsPostResponsesContentApplicationJsonSchemaDataOneOf1Scale": { "description": "Payment scale for the base compensation.", "enum": [ "hourly", "daily", "weekly", "monthly", "annually", "two_weekly", "bi_monthly", "custom", "one_off" ], "title": "ContractsContractIdAmendmentsPostResponsesContentApplicationJsonSchemaDataOneOf1Scale", "type": "string" }, "ContractsContractIdAmendmentsPostResponsesContentApplicationJsonSchemaDataOneOf1Status": { "description": "Status of the Global Payroll amendment. 'applied' only appears after a type_of_edit=direct request — the change took effect immediately and no pending amendment remains.", "enum": [ "waiting_for_approval", "waiting_client_sign", "waiting_worker_sign", "signed", "completed", "obsolete", "applied" ], "title": "ContractsContractIdAmendmentsPostResponsesContentApplicationJsonSchemaDataOneOf1Status", "type": "string" }, "ContractsContractIdAmendmentsPostResponsesContentApplicationJsonSchemaErrorsItems": { "properties": { "code": { "description": "Machine-readable error code", "type": "string" }, "message": { "description": "Human-readable explanation of the error", "type": "string" } }, "title": "ContractsContractIdAmendmentsPostResponsesContentApplicationJsonSchemaErrorsItems", "type": "object" }, "ContractsContractIdCostCentersPostRequestBodyContentApplicationJsonSchemaData": { "properties": { "effective_date": { "description": "Allocation start date", "format": "date", "type": "string" }, "value": { "items": { "$ref": "#/components/schemas/ContractsContractIdCostCentersPostRequestBodyContentApplicationJsonSchemaDataValueItems" }, "type": "array" } }, "required": [ "value", "effective_date" ], "title": "ContractsContractIdCostCentersPostRequestBodyContentApplicationJsonSchemaData", "type": "object" }, "ContractsContractIdCostCentersPostRequestBodyContentApplicationJsonSchemaDataValueItems": { "properties": { "allocation_percentage": { "description": "Cost center allocation for this employment, between 0 (none) and 1 (100%)", "format": "double", "maximum": 1, "minimum": 0, "type": "number" }, "cost_center_id": { "description": "Cost center id", "format": "int64", "type": "integer" } }, "required": [ "cost_center_id", "allocation_percentage" ], "title": "ContractsContractIdCostCentersPostRequestBodyContentApplicationJsonSchemaDataValueItems", "type": "object" }, "ContractsContractIdCostCentersPostResponsesContentApplicationJsonSchemaData": { "properties": { "id": { "description": "Updated employment term id", "type": "string" } }, "title": "ContractsContractIdCostCentersPostResponsesContentApplicationJsonSchemaData", "type": "object" }, "ContractsContractIdCostCentersPostResponsesContentApplicationJsonSchemaErrorsItems": { "properties": { "error": { "description": "A description of the returned error", "type": "string" } }, "title": "ContractsContractIdCostCentersPostResponsesContentApplicationJsonSchemaErrorsItems", "type": "object" }, "ContractsContractIdCostCentersPostResponsesContentApplicationJsonSchemaRequest": { "properties": { "api_req_id": { "description": "The request ID of the failed request", "type": "string" }, "code": { "description": "The code of the source handler which produced the returned error", "format": "double", "type": "number" }, "docs": { "description": "A link to the official documentation for the requested endpoint resource", "type": "string" }, "method": { "description": "The HTTP method of the failed request", "type": "string" }, "source": { "description": "The source handler which produced the returned error", "type": "string" }, "status": { "description": "The status code of the response", "format": "double", "type": "number" }, "url": { "description": "The relative URL of the failed request", "type": "string" } }, "title": "ContractsContractIdCostCentersPostResponsesContentApplicationJsonSchemaRequest", "type": "object" }, "ContractsContractIdCustomFieldsGetResponsesContentApplicationJsonSchemaDataItems": { "properties": { "data": { "$ref": "#/components/schemas/ContractsContractIdCustomFieldsGetResponsesContentApplicationJsonSchemaDataItemsData" }, "id": { "description": "UUID for the custom field value", "format": "uuid", "type": "string" }, "name": { "description": "Name of the custom field", "type": "string" }, "type": { "$ref": "#/components/schemas/ContractsContractIdCustomFieldsGetResponsesContentApplicationJsonSchemaDataItemsType", "description": "Type of the custom field" } }, "required": [ "id", "data", "name", "type" ], "title": "ContractsContractIdCustomFieldsGetResponsesContentApplicationJsonSchemaDataItems", "type": "object" }, "ContractsContractIdCustomFieldsGetResponsesContentApplicationJsonSchemaDataItemsData": { "oneOf": [ { "$ref": "#/components/schemas/ContractsContractIdCustomFieldsGetResponsesContentApplicationJsonSchemaDataItemsData0" }, { "$ref": "#/components/schemas/ContractsContractIdCustomFieldsGetResponsesContentApplicationJsonSchemaDataItemsData1" }, { "$ref": "#/components/schemas/ContractsContractIdCustomFieldsGetResponsesContentApplicationJsonSchemaDataItemsData2" }, { "$ref": "#/components/schemas/ContractsContractIdCustomFieldsGetResponsesContentApplicationJsonSchemaDataItemsData3" }, { "$ref": "#/components/schemas/ContractsContractIdCustomFieldsGetResponsesContentApplicationJsonSchemaDataItemsData4" }, { "$ref": "#/components/schemas/ContractsContractIdCustomFieldsGetResponsesContentApplicationJsonSchemaDataItemsData5" }, { "$ref": "#/components/schemas/ContractsContractIdCustomFieldsGetResponsesContentApplicationJsonSchemaDataItemsData6" } ], "title": "ContractsContractIdCustomFieldsGetResponsesContentApplicationJsonSchemaDataItemsData" }, "ContractsContractIdCustomFieldsGetResponsesContentApplicationJsonSchemaDataItemsData0": { "description": "Text type", "properties": { "value": { "type": "string" } }, "title": "ContractsContractIdCustomFieldsGetResponsesContentApplicationJsonSchemaDataItemsData0", "type": "object" }, "ContractsContractIdCustomFieldsGetResponsesContentApplicationJsonSchemaDataItemsData1": { "description": "Number type", "properties": { "value": { "format": "double", "type": "number" } }, "title": "ContractsContractIdCustomFieldsGetResponsesContentApplicationJsonSchemaDataItemsData1", "type": "object" }, "ContractsContractIdCustomFieldsGetResponsesContentApplicationJsonSchemaDataItemsData2": { "description": "Date type: YYYY-MM-DD", "properties": { "value": { "format": "date", "type": "string" } }, "title": "ContractsContractIdCustomFieldsGetResponsesContentApplicationJsonSchemaDataItemsData2", "type": "object" }, "ContractsContractIdCustomFieldsGetResponsesContentApplicationJsonSchemaDataItemsData3": { "description": "Percentage type", "properties": { "text": { "type": "string" }, "value": { "format": "double", "type": "number" } }, "title": "ContractsContractIdCustomFieldsGetResponsesContentApplicationJsonSchemaDataItemsData3", "type": "object" }, "ContractsContractIdCustomFieldsGetResponsesContentApplicationJsonSchemaDataItemsData4": { "description": "Currency type", "properties": { "amount": { "format": "double", "type": "number" }, "currency": { "description": "The currency code in ISO 4217 format", "type": "string" } }, "title": "ContractsContractIdCustomFieldsGetResponsesContentApplicationJsonSchemaDataItemsData4", "type": "object" }, "ContractsContractIdCustomFieldsGetResponsesContentApplicationJsonSchemaDataItemsData5": { "description": "List type", "properties": { "option": { "type": "string" } }, "title": "ContractsContractIdCustomFieldsGetResponsesContentApplicationJsonSchemaDataItemsData5", "type": "object" }, "ContractsContractIdCustomFieldsGetResponsesContentApplicationJsonSchemaDataItemsData6": { "description": "Multiselect type", "properties": { "options": { "items": { "type": "string" }, "type": "array" } }, "title": "ContractsContractIdCustomFieldsGetResponsesContentApplicationJsonSchemaDataItemsData6", "type": "object" }, "ContractsContractIdCustomFieldsGetResponsesContentApplicationJsonSchemaDataItemsType": { "description": "Type of the custom field", "enum": [ "text", "number", "currency", "date", "percentage", "list", "multiselect", "hyperlink" ], "title": "ContractsContractIdCustomFieldsGetResponsesContentApplicationJsonSchemaDataItemsType", "type": "string" }, "ContractsContractIdCustomFieldsPutRequestBodyContentApplicationJsonSchemaData": { "properties": { "data": { "$ref": "#/components/schemas/ContractsContractIdCustomFieldsPutRequestBodyContentApplicationJsonSchemaDataData" }, "id": { "description": "UUID for the custom field value", "format": "uuid", "type": "string" } }, "required": [ "id", "data" ], "title": "ContractsContractIdCustomFieldsPutRequestBodyContentApplicationJsonSchemaData", "type": "object" }, "ContractsContractIdCustomFieldsPutRequestBodyContentApplicationJsonSchemaDataData": { "oneOf": [ { "$ref": "#/components/schemas/ContractsContractIdCustomFieldsPutRequestBodyContentApplicationJsonSchemaDataData0" }, { "$ref": "#/components/schemas/ContractsContractIdCustomFieldsPutRequestBodyContentApplicationJsonSchemaDataData1" }, { "$ref": "#/components/schemas/ContractsContractIdCustomFieldsPutRequestBodyContentApplicationJsonSchemaDataData2" }, { "$ref": "#/components/schemas/ContractsContractIdCustomFieldsPutRequestBodyContentApplicationJsonSchemaDataData3" }, { "$ref": "#/components/schemas/ContractsContractIdCustomFieldsPutRequestBodyContentApplicationJsonSchemaDataData4" }, { "$ref": "#/components/schemas/ContractsContractIdCustomFieldsPutRequestBodyContentApplicationJsonSchemaDataData5" }, { "$ref": "#/components/schemas/ContractsContractIdCustomFieldsPutRequestBodyContentApplicationJsonSchemaDataData6" } ], "title": "ContractsContractIdCustomFieldsPutRequestBodyContentApplicationJsonSchemaDataData" }, "ContractsContractIdCustomFieldsPutRequestBodyContentApplicationJsonSchemaDataData0": { "description": "Text type", "properties": { "value": { "type": "string" } }, "title": "ContractsContractIdCustomFieldsPutRequestBodyContentApplicationJsonSchemaDataData0", "type": "object" }, "ContractsContractIdCustomFieldsPutRequestBodyContentApplicationJsonSchemaDataData1": { "description": "Number type", "properties": { "value": { "format": "double", "type": "number" } }, "title": "ContractsContractIdCustomFieldsPutRequestBodyContentApplicationJsonSchemaDataData1", "type": "object" }, "ContractsContractIdCustomFieldsPutRequestBodyContentApplicationJsonSchemaDataData2": { "description": "Date type: YYYY-MM-DD", "properties": { "value": { "format": "date", "type": "string" } }, "title": "ContractsContractIdCustomFieldsPutRequestBodyContentApplicationJsonSchemaDataData2", "type": "object" }, "ContractsContractIdCustomFieldsPutRequestBodyContentApplicationJsonSchemaDataData3": { "description": "Percentage type", "properties": { "value": { "format": "double", "type": "number" } }, "title": "ContractsContractIdCustomFieldsPutRequestBodyContentApplicationJsonSchemaDataData3", "type": "object" }, "ContractsContractIdCustomFieldsPutRequestBodyContentApplicationJsonSchemaDataData4": { "description": "Currency type", "properties": { "amount": { "format": "double", "type": "number" }, "currency": { "description": "Important: When currency type is fixed, the currency field is ignored. ", "pattern": "^[A-Z]{3}$", "type": "string" } }, "title": "ContractsContractIdCustomFieldsPutRequestBodyContentApplicationJsonSchemaDataData4", "type": "object" }, "ContractsContractIdCustomFieldsPutRequestBodyContentApplicationJsonSchemaDataData5": { "description": "List type", "properties": { "option": { "type": "string" } }, "title": "ContractsContractIdCustomFieldsPutRequestBodyContentApplicationJsonSchemaDataData5", "type": "object" }, "ContractsContractIdCustomFieldsPutRequestBodyContentApplicationJsonSchemaDataData6": { "description": "Multiselect type", "properties": { "options": { "items": { "type": "string" }, "type": "array" } }, "title": "ContractsContractIdCustomFieldsPutRequestBodyContentApplicationJsonSchemaDataData6", "type": "object" }, "ContractsContractIdDocumentsPostResponsesContentApplicationJsonSchemaData": { "description": "This object is used for linking file attachments to your records.", "properties": { "filename": { "description": "Original filename you used to upload using attachments end-point.", "type": "string" }, "key": { "description": "You can call attachments end-point, get key and URL to upload your file.", "type": "string" } }, "required": [ "key", "filename" ], "title": "ContractsContractIdDocumentsPostResponsesContentApplicationJsonSchemaData", "type": "object" }, "ContractsContractIdGetParametersExpandSchemaItems": { "description": "Additional fields to include in the response.", "enum": [ "cost_centers", "custom_fields" ], "title": "ContractsContractIdGetParametersExpandSchemaItems", "type": "string" }, "ContractsContractIdGetResponsesContentApplicationJsonSchemaData": { "properties": { "client": { "description": "Client details associated with the contract.", "oneOf": [ { "$ref": "#/components/schemas/ContractsContractIdGetResponsesContentApplicationJsonSchemaDataClient" }, { "type": "null" } ] }, "compensation_details": { "$ref": "#/components/schemas/ContractsContractIdGetResponsesContentApplicationJsonSchemaDataCompensationDetails", "description": "Compensation and payment configuration for the contract." }, "contract_template": { "description": "Contract template details.", "oneOf": [ { "$ref": "#/components/schemas/ContractsContractIdGetResponsesContentApplicationJsonSchemaDataContractTemplate" }, { "type": "null" } ] }, "cost_centers": { "description": "List of cost centers associated with the contract.", "items": { "$ref": "#/components/schemas/ContractsContractIdGetResponsesContentApplicationJsonSchemaDataCostCentersItems" }, "type": "array" }, "created_at": { "description": "Date and time when the contract was created.", "format": "date-time", "type": "string" }, "custom_fields": { "description": "List of custom fields attached to the contract.", "items": { "$ref": "#/components/schemas/ContractsContractIdGetResponsesContentApplicationJsonSchemaDataCustomFieldsItems" }, "type": [ "array", "null" ] }, "division": { "description": "Division the worker belongs to, from the active job information of a Global Payroll contract. Null for other contract types or when no division is set.", "type": [ "string", "null" ] }, "employment_details": { "$ref": "#/components/schemas/ContractsContractIdGetResponsesContentApplicationJsonSchemaDataEmploymentDetails", "description": "Employment-related details for the contract." }, "employment_type": { "description": "Type of employment.", "oneOf": [ { "$ref": "#/components/schemas/ContractsContractIdGetResponsesContentApplicationJsonSchemaDataEmploymentType" }, { "type": "null" } ] }, "external_id": { "description": "External identifier of the contract.", "type": [ "string", "null" ] }, "fte_percentage": { "description": "Full time percentage", "format": "double", "type": [ "number", "null" ] }, "id": { "description": "Unique identifier for the contract.", "minLength": 1, "type": "string" }, "invitations": { "$ref": "#/components/schemas/ContractsContractIdGetResponsesContentApplicationJsonSchemaDataInvitations", "description": "Invitation email addresses for signing the contract." }, "is_archived": { "description": "Flag to indicate if the contract is archived.", "type": [ "boolean", "null" ] }, "job_title": { "description": "Job title associated with the contract.", "type": "string" }, "location": { "description": "Location name associated with the contract.", "type": [ "string", "null" ] }, "notice_period": { "description": "Notice period in days.", "format": "double", "type": [ "number", "null" ] }, "platform_payment_type": { "$ref": "#/components/schemas/ContractsContractIdGetResponsesContentApplicationJsonSchemaDataPlatformPaymentType", "description": "Whether the contract is paid through Deel (`STANDARD`) or outside Deel (`OFF_PLATFORM`). Applies to IC contracts only." }, "product_area": { "description": "Product area code associated with the contract.", "format": "double", "type": [ "number", "null" ] }, "quote": { "$ref": "#/components/schemas/ContractsContractIdGetResponsesContentApplicationJsonSchemaDataQuote", "description": "EOR quote approved by Deel." }, "scope_of_work": { "description": "Scope of work of the contract.", "type": [ "string", "null" ] }, "seniority": { "description": "Seniority describes level of expertise at a job e.g. junior.", "oneOf": [ { "$ref": "#/components/schemas/ContractsContractIdGetResponsesContentApplicationJsonSchemaDataSeniority" }, { "type": "null" } ] }, "signatures": { "$ref": "#/components/schemas/ContractsContractIdGetResponsesContentApplicationJsonSchemaDataSignatures", "description": "Signature information for the contract parties." }, "special_clause": { "description": "Special clause of the contract.", "type": [ "string", "null" ] }, "start_date": { "description": "Date and time when the contract starts.", "format": "date-time", "type": "string" }, "status": { "$ref": "#/components/schemas/ContractsContractIdGetResponsesContentApplicationJsonSchemaDataStatus", "description": "Status of a contract in Deel workflow." }, "termination_date": { "description": "Date and time when the contract ends.", "type": [ "string", "null" ] }, "title": { "description": "Title of the contract.", "minLength": 1, "type": "string" }, "type": { "$ref": "#/components/schemas/ContractsContractIdGetResponsesContentApplicationJsonSchemaDataType", "description": "Type of a contract." }, "updated_at": { "description": "Date and time when the contract was updated.", "format": "date-time", "type": "string" }, "who_reports": { "description": "Who reports the hours.", "type": "string" }, "work_schedule": { "description": "Defines a work schedule including working days, hours, and employment details", "oneOf": [ { "$ref": "#/components/schemas/ContractsContractIdGetResponsesContentApplicationJsonSchemaDataWorkSchedule" }, { "type": "null" } ] }, "work_statement_id": { "description": "The unique identifier of the associated work statement.", "type": [ "string", "null" ] }, "worker": { "description": "Worker details associated with the contract.", "oneOf": [ { "$ref": "#/components/schemas/ContractsContractIdGetResponsesContentApplicationJsonSchemaDataWorker" }, { "type": "null" } ] } }, "required": [ "id", "type", "title", "client", "status", "worker", "created_at", "signatures", "start_date", "updated_at", "invitations", "is_archived", "special_clause", "termination_date" ], "title": "ContractsContractIdGetResponsesContentApplicationJsonSchemaData", "type": "object" }, "ContractsContractIdGetResponsesContentApplicationJsonSchemaDataClient": { "description": "Client details associated with the contract.", "properties": { "email": { "description": "User's email address.", "minLength": 5, "pattern": "^[^\\s@]+@[^\\s@]+\\.[^\\s@]+(_no_mail|_archived)?$", "type": [ "string", "null" ] }, "full_name": { "description": "Full name of the client.", "type": "string" }, "id": { "description": "Unique identifier of this resource.", "type": "string" }, "legal_entity": { "description": "Legal entity details of the client.", "oneOf": [ { "$ref": "#/components/schemas/ContractsContractIdGetResponsesContentApplicationJsonSchemaDataClientLegalEntity" }, { "type": "null" } ] }, "team": { "$ref": "#/components/schemas/ContractsContractIdGetResponsesContentApplicationJsonSchemaDataClientTeam", "description": "Team information for the client organization." } }, "required": [ "team" ], "title": "ContractsContractIdGetResponsesContentApplicationJsonSchemaDataClient", "type": "object" }, "ContractsContractIdGetResponsesContentApplicationJsonSchemaDataClientLegalEntity": { "description": "Legal entity details of the client.", "properties": { "email": { "description": "Email address of the legal entity.", "type": [ "string", "null" ] }, "id": { "description": "Unique identifier of this resource.", "type": "string" }, "name": { "description": "Name of a team.", "type": "string" }, "registration_number": { "description": "Registration number of the legal entity.", "type": [ "string", "null" ] }, "subtype": { "description": "Sub-type of the legal entity.", "type": [ "string", "null" ] }, "type": { "description": "Type of the legal entity.", "type": [ "string", "null" ] }, "vat_number": { "description": "VAT number of the legal entity.", "type": [ "string", "null" ] } }, "title": "ContractsContractIdGetResponsesContentApplicationJsonSchemaDataClientLegalEntity", "type": "object" }, "ContractsContractIdGetResponsesContentApplicationJsonSchemaDataClientTeam": { "description": "Team information for the client organization.", "properties": { "id": { "$ref": "#/components/schemas/ContractsContractIdGetResponsesContentApplicationJsonSchemaDataClientTeamId", "description": "Unique identifier of this resource." }, "name": { "description": "Name of a team.", "type": "string" } }, "required": [ "id", "name" ], "title": "ContractsContractIdGetResponsesContentApplicationJsonSchemaDataClientTeam", "type": "object" }, "ContractsContractIdGetResponsesContentApplicationJsonSchemaDataClientTeamId": { "description": "Unique identifier of this resource.", "oneOf": [ { "type": "string" }, { "format": "double", "type": "number" } ], "title": "ContractsContractIdGetResponsesContentApplicationJsonSchemaDataClientTeamId" }, "ContractsContractIdGetResponsesContentApplicationJsonSchemaDataCompensationDetails": { "description": "Compensation and payment configuration for the contract.", "properties": { "amount": { "description": "Amount to be paid. This field can be excluded when creating a Pay-as-you-go task-based or Milestone contracts.", "type": [ "string", "null" ] }, "currency_code": { "description": "Currency code.", "maxLength": 3, "minLength": 3, "pattern": "^[A-Z]{3}$", "type": [ "string", "null" ] }, "cycle_end": { "description": "Day of the cycle end", "format": "double", "type": [ "number", "null" ] }, "cycle_end_type": { "description": " Cycle end type", "oneOf": [ { "$ref": "#/components/schemas/ContractsContractIdGetResponsesContentApplicationJsonSchemaDataCompensationDetailsCycleEndType" }, { "type": "null" } ] }, "first_payment": { "description": "First payment amount.", "type": [ "string", "null" ] }, "first_payment_date": { "description": "First payment date.", "type": [ "string", "null" ] }, "frequency": { "description": "Scale of the invoice cycle.", "type": "string" }, "gross_annual_salary": { "description": "Gross annual salary.", "type": [ "string", "null" ] }, "gross_signing_bonus": { "description": "Gross signing bonus.", "type": [ "string", "null" ] }, "gross_variable_bonus": { "description": "Gross variable bonus.", "type": [ "string", "null" ] }, "scale": { "description": "Scale of the payment.", "type": [ "string", "null" ] } }, "title": "ContractsContractIdGetResponsesContentApplicationJsonSchemaDataCompensationDetails", "type": "object" }, "ContractsContractIdGetResponsesContentApplicationJsonSchemaDataCompensationDetailsCycleEndType": { "description": " Cycle end type", "enum": [ "DAY_OF_WEEK", "DAY_OF_LAST_WEEK", "DAY_OF_MONTH" ], "title": "ContractsContractIdGetResponsesContentApplicationJsonSchemaDataCompensationDetailsCycleEndType", "type": "string" }, "ContractsContractIdGetResponsesContentApplicationJsonSchemaDataContractTemplate": { "description": "Contract template details.", "properties": { "id": { "description": "Unique identifier of a contract template.", "type": "string" }, "title": { "description": "Title of a contract template", "type": "string" } }, "title": "ContractsContractIdGetResponsesContentApplicationJsonSchemaDataContractTemplate", "type": "object" }, "ContractsContractIdGetResponsesContentApplicationJsonSchemaDataCostCentersItems": { "properties": { "allocation_percentage": { "description": "Percentage of the cost center allocation.", "format": "double", "type": "number" }, "name": { "description": "Cost center name.", "type": "string" }, "number": { "description": "Cost center number.", "type": "string" } }, "title": "ContractsContractIdGetResponsesContentApplicationJsonSchemaDataCostCentersItems", "type": "object" }, "ContractsContractIdGetResponsesContentApplicationJsonSchemaDataCustomFieldsItems": { "description": "Customized attributes on contracts (Employee ID, Project code, etc).", "properties": { "id": { "description": "Unique identifier of the custom field.", "type": [ "string", "null" ] }, "name": { "description": "Custom field property name.", "type": "string" }, "value": { "description": "Custom field property value.", "type": "string" } }, "title": "ContractsContractIdGetResponsesContentApplicationJsonSchemaDataCustomFieldsItems", "type": "object" }, "ContractsContractIdGetResponsesContentApplicationJsonSchemaDataEmploymentDetails": { "description": "Employment-related details for the contract.", "properties": { "days_per_week": { "description": "Number of days per week.", "format": "double", "type": "number" }, "hours_per_day": { "description": "Number of hours per day.", "format": "double", "type": "number" }, "non_compete_clause": { "description": "Non-compete clause state on the active EOR SOW. Null when not yet populated.", "type": [ "boolean", "null" ] }, "non_solicitation_clause": { "description": "Non-solicitation clause state on the active EOR SOW. Null when not yet populated.", "type": [ "boolean", "null" ] }, "paid_vacation_days": { "description": "Number of paid vacation days.", "format": "double", "type": "number" }, "probation_period": { "description": "Probation period in days.", "format": "double", "type": [ "number", "null" ] }, "type": { "description": "Type of employment.", "type": "string" } }, "title": "ContractsContractIdGetResponsesContentApplicationJsonSchemaDataEmploymentDetails", "type": "object" }, "ContractsContractIdGetResponsesContentApplicationJsonSchemaDataEmploymentType": { "description": "Type of employment.", "enum": [ "FULL_TIME", "PART_TIME" ], "title": "ContractsContractIdGetResponsesContentApplicationJsonSchemaDataEmploymentType", "type": "string" }, "ContractsContractIdGetResponsesContentApplicationJsonSchemaDataInvitations": { "description": "Invitation email addresses for signing the contract.", "properties": { "client_email": { "description": "User's email address.", "type": [ "string", "null" ] }, "worker_email": { "description": "User's email address.", "type": [ "string", "null" ] } }, "title": "ContractsContractIdGetResponsesContentApplicationJsonSchemaDataInvitations", "type": "object" }, "ContractsContractIdGetResponsesContentApplicationJsonSchemaDataPlatformPaymentType": { "description": "Whether the contract is paid through Deel (`STANDARD`) or outside Deel (`OFF_PLATFORM`). Applies to IC contracts only.", "enum": [ "STANDARD", "OFF_PLATFORM" ], "title": "ContractsContractIdGetResponsesContentApplicationJsonSchemaDataPlatformPaymentType", "type": "string" }, "ContractsContractIdGetResponsesContentApplicationJsonSchemaDataQuote": { "description": "EOR quote approved by Deel.", "properties": { "benefits": { "description": "Array of benefits.", "items": { "$ref": "#/components/schemas/ContractsContractIdGetResponsesContentApplicationJsonSchemaDataQuoteBenefitsItems" }, "type": "array" }, "currency": { "description": "Currency used for the quote.", "maxLength": 3, "minLength": 3, "pattern": "^[A-Z]{3}$", "type": "string" } }, "title": "ContractsContractIdGetResponsesContentApplicationJsonSchemaDataQuote", "type": "object" }, "ContractsContractIdGetResponsesContentApplicationJsonSchemaDataQuoteBenefitsItems": { "properties": { "currency": { "description": "Currency code.", "maxLength": 3, "minLength": 3, "pattern": "^[A-Z]{3}$", "type": "string" }, "fee": { "description": "Fee in local currency.", "format": "double", "type": "number" }, "fee_usd": { "description": "Fee in USD.", "format": "double", "type": "number" }, "name": { "description": "Benefit's name.", "type": "string" }, "plan": { "description": "Benefit's plan.", "type": "string" }, "price": { "description": "Price in local currency.", "format": "double", "type": "number" }, "price_usd": { "description": "Price in USD.", "format": "double", "type": "number" } }, "title": "ContractsContractIdGetResponsesContentApplicationJsonSchemaDataQuoteBenefitsItems", "type": "object" }, "ContractsContractIdGetResponsesContentApplicationJsonSchemaDataSeniority": { "description": "Seniority describes level of expertise at a job e.g. junior.", "properties": { "id": { "description": "Unique identifier of this resource.", "format": "double", "type": [ "number", "null" ] }, "level": { "description": "Level of seniority level e.g. 2.", "format": "double", "type": [ "number", "null" ] }, "name": { "description": "Name of seniority level e.g. Mid (Individual Contributor Level 2).", "type": [ "string", "null" ] } }, "title": "ContractsContractIdGetResponsesContentApplicationJsonSchemaDataSeniority", "type": "object" }, "ContractsContractIdGetResponsesContentApplicationJsonSchemaDataSignatures": { "description": "Signature information for the contract parties.", "properties": { "client_signature": { "description": "Client representative signature (typically a name).", "type": "string" }, "client_signed_at": { "description": "Date and time when the client signed the contract.", "format": "date-time", "type": [ "string", "null" ] }, "signed_at": { "description": "Date and time when the contract was signed.", "format": "date-time", "type": [ "string", "null" ] }, "worker_signature": { "description": "Worker signature (typically a name).", "type": "string" }, "worker_signed_at": { "description": "Date and time when the worker signed the contract.", "format": "date-time", "type": [ "string", "null" ] } }, "title": "ContractsContractIdGetResponsesContentApplicationJsonSchemaDataSignatures", "type": "object" }, "ContractsContractIdGetResponsesContentApplicationJsonSchemaDataStatus": { "description": "Status of a contract in Deel workflow.", "enum": [ "new", "under_review", "waiting_for_employee_contract", "waiting_for_client_sign", "processing_payment", "waiting_for_contractor_sign", "waiting_for_eor_sign", "waiting_for_employee_sign", "awaiting_deposit_payment", "in_progress", "completed", "cancelled", "user_cancelled", "rejected", "waiting_for_client_payment", "onboarding", "waiting_for_approval", "onboarded" ], "title": "ContractsContractIdGetResponsesContentApplicationJsonSchemaDataStatus", "type": "string" }, "ContractsContractIdGetResponsesContentApplicationJsonSchemaDataType": { "description": "Type of a contract.", "enum": [ "ongoing_time_based", "milestones", "time_based", "pay_as_you_go_time_based", "commission", "payg_milestones", "payg_tasks", "contractor_outside_deel", "eor", "unknown", "employee", "global_payroll", "shield_msa", "hris_direct_employee", "peo" ], "title": "ContractsContractIdGetResponsesContentApplicationJsonSchemaDataType", "type": "string" }, "ContractsContractIdGetResponsesContentApplicationJsonSchemaDataWorkSchedule": { "description": "Defines a work schedule including working days, hours, and employment details", "properties": { "country": { "description": "Country code where this work schedule applies (ISO 3166-1 alpha-2)", "pattern": "^[A-Z]{2}$", "type": "string" }, "days": { "description": "Working days and hours configuration", "items": { "$ref": "#/components/schemas/ContractsContractIdGetResponsesContentApplicationJsonSchemaDataWorkScheduleDaysItems" }, "type": "array" }, "effective_from": { "description": "Date and time when the contract's work schedule became effective.", "type": "string" }, "employment_type": { "description": "Type of employment arrangement", "oneOf": [ { "$ref": "#/components/schemas/ContractsContractIdGetResponsesContentApplicationJsonSchemaDataWorkScheduleEmploymentType" }, { "type": "null" } ] }, "name": { "description": "Unique identifier or name for the work schedule", "maxLength": 50, "type": "string" }, "work_hours_per_week": { "description": "Total number of working hours per week", "maximum": 168, "minimum": 1, "type": "integer" }, "work_schedule_type": { "description": "Work schedule type", "type": "string" }, "worker_types": { "description": "List of worker types that can use this schedule", "items": { "$ref": "#/components/schemas/ContractsContractIdGetResponsesContentApplicationJsonSchemaDataWorkScheduleWorkerTypesItems" }, "type": "array" } }, "required": [ "days", "name", "country", "worker_types", "effective_from", "work_schedule_type", "work_hours_per_week" ], "title": "ContractsContractIdGetResponsesContentApplicationJsonSchemaDataWorkSchedule", "type": "object" }, "ContractsContractIdGetResponsesContentApplicationJsonSchemaDataWorkScheduleDaysItems": { "description": "Defines working hours for a specific day of the week", "properties": { "day": { "$ref": "#/components/schemas/ContractsContractIdGetResponsesContentApplicationJsonSchemaDataWorkScheduleDaysItemsDay", "description": "Day of the week" }, "end": { "description": "End time for the work day (HH:MM:SS format)", "format": "time", "pattern": "^([01]?[0-9]|2[0-3]):[0-5][0-9]:[0-5][0-9]$", "type": [ "string", "null" ] }, "start": { "description": "Start time for the work day (HH:MM:SS format)", "format": "time", "pattern": "^([01]?[0-9]|2[0-3]):[0-5][0-9]:[0-5][0-9]$", "type": "string" }, "work_hours": { "description": "Number of working hours for this day", "title": "float", "type": "string" } }, "required": [ "day", "end", "start", "work_hours" ], "title": "ContractsContractIdGetResponsesContentApplicationJsonSchemaDataWorkScheduleDaysItems", "type": "object" }, "ContractsContractIdGetResponsesContentApplicationJsonSchemaDataWorkScheduleDaysItemsDay": { "description": "Day of the week", "enum": [ "MONDAY", "TUESDAY", "WEDNESDAY", "THURSDAY", "FRIDAY", "SATURDAY", "SUNDAY" ], "title": "ContractsContractIdGetResponsesContentApplicationJsonSchemaDataWorkScheduleDaysItemsDay", "type": "string" }, "ContractsContractIdGetResponsesContentApplicationJsonSchemaDataWorkScheduleEmploymentType": { "description": "Type of employment arrangement", "enum": [ "FULL_TIME", "PART_TIME", "CONTRACT", "TEMPORARY" ], "title": "ContractsContractIdGetResponsesContentApplicationJsonSchemaDataWorkScheduleEmploymentType", "type": "string" }, "ContractsContractIdGetResponsesContentApplicationJsonSchemaDataWorkScheduleWorkerTypesItems": { "enum": [ "SALARIED_DIRECT_EMPLOYEE_PAYROLL", "SALARIED_HRIS_DIRECT_EMPLOYEE", "SALARIED_EOR_EMPLOYEE", "HOURLY_EOR_EMPLOYEE", "HOURLY_DIRECT_EMPLOYEE_PAYROLL" ], "title": "ContractsContractIdGetResponsesContentApplicationJsonSchemaDataWorkScheduleWorkerTypesItems", "type": "string" }, "ContractsContractIdGetResponsesContentApplicationJsonSchemaDataWorker": { "description": "Worker details associated with the contract.", "properties": { "alternate_email": { "description": "List of alternate email addresses.", "items": { "$ref": "#/components/schemas/ContractsContractIdGetResponsesContentApplicationJsonSchemaDataWorkerAlternateEmailItems" }, "type": [ "array", "null" ] }, "country": { "description": "Country of the worker.", "type": [ "string", "null" ] }, "date_of_birth": { "$ref": "#/components/schemas/ContractsContractIdGetResponsesContentApplicationJsonSchemaDataWorkerDateOfBirth" }, "email": { "description": "User's email address.", "minLength": 5, "pattern": "^[^\\s@]+@[^\\s@]+\\.[^\\s@]+(_no_mail|_archived)?$", "type": [ "string", "null" ] }, "expected_email": { "description": "Expected email address of the worker (e.g., invitation target email).", "type": "string" }, "first_name": { "description": "First name of the worker.", "type": "string" }, "full_name": { "description": "Full name of the client.", "type": "string" }, "id": { "description": "Unique identifier of this resource.", "type": "string" }, "last_name": { "description": "Last name of the worker.", "type": "string" }, "nationality": { "description": "Nationality of the worker.", "type": [ "string", "null" ] } }, "title": "ContractsContractIdGetResponsesContentApplicationJsonSchemaDataWorker", "type": "object" }, "ContractsContractIdGetResponsesContentApplicationJsonSchemaDataWorkerAlternateEmailItems": { "properties": { "email": { "description": "Email address of the worker.", "type": "string" }, "isVerified": { "description": "Indicates whether this alternate email address has been verified.", "type": "boolean" } }, "title": "ContractsContractIdGetResponsesContentApplicationJsonSchemaDataWorkerAlternateEmailItems", "type": "object" }, "ContractsContractIdGetResponsesContentApplicationJsonSchemaDataWorkerDateOfBirth": { "oneOf": [ { "format": "date", "type": "string" }, { "maxLength": 0, "type": "string" } ], "title": "ContractsContractIdGetResponsesContentApplicationJsonSchemaDataWorkerDateOfBirth" }, "ContractsContractIdGetResponsesContentApplicationJsonSchemaErrorsItems": { "properties": { "message": { "description": "Error response", "type": "string" } }, "required": [ "message" ], "title": "ContractsContractIdGetResponsesContentApplicationJsonSchemaErrorsItems", "type": "object" }, "ContractsContractIdGetResponsesContentApplicationJsonSchemaRequest": { "description": "Error request details", "properties": { "method": { "description": "Method of the API", "type": "string" }, "status": { "description": "Status of API response", "format": "double", "type": "number" } }, "title": "ContractsContractIdGetResponsesContentApplicationJsonSchemaRequest", "type": "object" }, "ContractsContractIdIcInvoicingTaxesGetResponsesContentApplicationJsonSchemaData": { "properties": { "id": { "description": "Deel contract ID", "type": "string" }, "vat": { "description": "VAT tax details (if applicable)", "oneOf": [ { "$ref": "#/components/schemas/ContractsContractIdIcInvoicingTaxesGetResponsesContentApplicationJsonSchemaDataVat" }, { "type": "null" } ] }, "withholding_tax": { "description": "Withholding tax details (if applicable)", "oneOf": [ { "$ref": "#/components/schemas/ContractsContractIdIcInvoicingTaxesGetResponsesContentApplicationJsonSchemaDataWithholdingTax" }, { "type": "null" } ] } }, "required": [ "id" ], "title": "ContractsContractIdIcInvoicingTaxesGetResponsesContentApplicationJsonSchemaData", "type": "object" }, "ContractsContractIdIcInvoicingTaxesGetResponsesContentApplicationJsonSchemaDataVat": { "description": "VAT tax details (if applicable)", "properties": { "percentage": { "description": "VAT percentage", "format": "double", "type": [ "number", "null" ] } }, "title": "ContractsContractIdIcInvoicingTaxesGetResponsesContentApplicationJsonSchemaDataVat", "type": "object" }, "ContractsContractIdIcInvoicingTaxesGetResponsesContentApplicationJsonSchemaDataWithholdingTax": { "description": "Withholding tax details (if applicable)", "properties": { "percentage": { "description": "Withholding tax percentage", "format": "double", "type": [ "number", "null" ] } }, "title": "ContractsContractIdIcInvoicingTaxesGetResponsesContentApplicationJsonSchemaDataWithholdingTax", "type": "object" }, "ContractsContractIdIcInvoicingTaxesGetResponsesContentApplicationJsonSchemaErrorsItems": { "properties": { "code": { "description": "Machine-readable error code", "type": "string" }, "message": { "description": "Human-readable explanation of the error", "type": "string" } }, "title": "ContractsContractIdIcInvoicingTaxesGetResponsesContentApplicationJsonSchemaErrorsItems", "type": "object" }, "ContractsContractIdIcInvoicingTaxesPatchRequestBodyContentApplicationJsonSchemaData": { "description": "IC invoicing tax fields to update on the contract.", "properties": { "percentage": { "description": "Tax percentage amount.", "format": "double", "type": "number" }, "tax_type": { "$ref": "#/components/schemas/ContractsContractIdIcInvoicingTaxesPatchRequestBodyContentApplicationJsonSchemaDataTaxType", "description": "Type of IC invoicing tax." } }, "required": [ "tax_type", "percentage" ], "title": "ContractsContractIdIcInvoicingTaxesPatchRequestBodyContentApplicationJsonSchemaData", "type": "object" }, "ContractsContractIdIcInvoicingTaxesPatchRequestBodyContentApplicationJsonSchemaDataTaxType": { "description": "Type of IC invoicing tax.", "enum": [ "WITHHOLDING_TAX", "VAT" ], "title": "ContractsContractIdIcInvoicingTaxesPatchRequestBodyContentApplicationJsonSchemaDataTaxType", "type": "string" }, "ContractsContractIdIcInvoicingTaxesPatchResponsesContentApplicationJsonSchemaErrorsItems": { "properties": { "code": { "description": "Machine-readable error code identifying the failure category.", "type": "string" }, "message": { "description": "Human-readable error message describing the unexpected condition.", "type": "string" } }, "required": [ "message" ], "title": "ContractsContractIdIcInvoicingTaxesPatchResponsesContentApplicationJsonSchemaErrorsItems", "type": "object" }, "ContractsContractIdIcInvoicingTaxesPostRequestBodyContentApplicationJsonSchemaData": { "properties": { "percentage": { "description": "Tax percentage amount.", "format": "double", "type": "number" }, "tax_type": { "$ref": "#/components/schemas/ContractsContractIdIcInvoicingTaxesPostRequestBodyContentApplicationJsonSchemaDataTaxType", "description": "Type of IC invoicing tax." } }, "required": [ "tax_type", "percentage" ], "title": "ContractsContractIdIcInvoicingTaxesPostRequestBodyContentApplicationJsonSchemaData", "type": "object" }, "ContractsContractIdIcInvoicingTaxesPostRequestBodyContentApplicationJsonSchemaDataTaxType": { "description": "Type of IC invoicing tax.", "enum": [ "WITHHOLDING_TAX", "VAT" ], "title": "ContractsContractIdIcInvoicingTaxesPostRequestBodyContentApplicationJsonSchemaDataTaxType", "type": "string" }, "ContractsContractIdIcInvoicingTaxesPostResponsesContentApplicationJsonSchemaErrorsItems": { "properties": { "code": { "description": "Machine-readable error code", "type": "string" }, "message": { "description": "Human-readable explanation of the error", "type": "string" } }, "title": "ContractsContractIdIcInvoicingTaxesPostResponsesContentApplicationJsonSchemaErrorsItems", "type": "object" }, "ContractsContractIdIcInvoicingTaxesTaxTypeDeleteParametersTaxType": { "enum": [ "WITHHOLDING_TAX", "VAT" ], "title": "ContractsContractIdIcInvoicingTaxesTaxTypeDeleteParametersTaxType", "type": "string" }, "ContractsContractIdIcInvoicingTaxesTaxTypeDeleteResponsesContentApplicationJsonSchemaErrorsItems": { "properties": { "code": { "description": "Machine-readable error code identifying the failure category.", "type": "string" }, "message": { "description": "Human-readable error message describing the unexpected condition.", "type": "string" } }, "required": [ "message" ], "title": "ContractsContractIdIcInvoicingTaxesTaxTypeDeleteResponsesContentApplicationJsonSchemaErrorsItems", "type": "object" }, "ContractsContractIdInvitationsDeleteResponsesContentApplicationJsonSchemaData": { "properties": { "deleted": { "description": "Confirms the deletion.", "type": "boolean" } }, "required": [ "deleted" ], "title": "ContractsContractIdInvitationsDeleteResponsesContentApplicationJsonSchemaData", "type": "object" }, "ContractsContractIdInvitationsPostRequestBodyContentApplicationJsonSchemaData": { "properties": { "email": { "description": "Worker email", "format": "email", "type": "string" }, "locale": { "$ref": "#/components/schemas/ContractsContractIdInvitationsPostRequestBodyContentApplicationJsonSchemaDataLocale", "default": "en", "description": "Locale of the email" }, "message": { "description": "Message to the worker", "type": "string" } }, "title": "ContractsContractIdInvitationsPostRequestBodyContentApplicationJsonSchemaData", "type": "object" }, "ContractsContractIdInvitationsPostRequestBodyContentApplicationJsonSchemaDataLocale": { "default": "en", "description": "Locale of the email", "enum": [ "en", "es", "fr", "de", "it", "pt", "pl", "nn", "nl", "da", "deAT", "fi", "sv", "nlBE", "ja" ], "title": "ContractsContractIdInvitationsPostRequestBodyContentApplicationJsonSchemaDataLocale", "type": "string" }, "ContractsContractIdInvitationsPostResponsesContentApplicationJsonSchemaData": { "properties": { "created": { "type": "boolean" } }, "required": [ "created" ], "title": "ContractsContractIdInvitationsPostResponsesContentApplicationJsonSchemaData", "type": "object" }, "ContractsContractIdInvoiceAdjustmentsGetParametersContractTypesSchemaItems": { "description": "Type of a contract", "enum": [ "ongoing_time_based", "milestones", "time_based", "pay_as_you_go_time_based", "commission", "payg_milestones", "payg_tasks", "eor", "unknown", "employee", "global_payroll", "shield_msa", "hris_direct_employee", "peo" ], "title": "ContractsContractIdInvoiceAdjustmentsGetParametersContractTypesSchemaItems", "type": "string" }, "ContractsContractIdInvoiceAdjustmentsGetParametersStatusesSchemaItems": { "description": "status of invoice adjustment", "enum": [ "approved", "declined", "not_payable", "paid", "pending", "processing" ], "title": "ContractsContractIdInvoiceAdjustmentsGetParametersStatusesSchemaItems", "type": "string" }, "ContractsContractIdInvoiceAdjustmentsGetParametersTypesSchemaItems": { "description": "Type of invoice adjustment.", "enum": [ "accrued_holiday", "additional_fee", "allowance", "bonus", "commission", "deduction", "deposit", "deposit_refund", "employer_cost", "expense", "health_allowance", "health_benefit", "health_insurance_fee", "legal_fee", "management_fee", "milestone", "offcycle", "other", "overtime", "pension", "pro_rata", "setup_fee", "severance", "shield_service", "signing_bonus", "signing_bonus_employer_cost", "refund", "task", "time_off", "vat", "withholding_tax", "work" ], "title": "ContractsContractIdInvoiceAdjustmentsGetParametersTypesSchemaItems", "type": "string" }, "ContractsContractIdInvoiceAdjustmentsGetResponsesContentApplicationJsonSchemaDataItems": { "properties": { "attachment": { "description": "This object is used for linking file attachments to your records.", "oneOf": [ { "$ref": "#/components/schemas/ContractsContractIdInvoiceAdjustmentsGetResponsesContentApplicationJsonSchemaDataItemsAttachment" }, { "type": "null" } ] }, "contract": { "$ref": "#/components/schemas/ContractsContractIdInvoiceAdjustmentsGetResponsesContentApplicationJsonSchemaDataItemsContract", "description": "Contract associated with this invoice adjustment." }, "created_at": { "description": "Timestamp when the adjustment was created (ISO-8601).", "format": "date-time", "type": "string" }, "currency_code": { "description": "ISO 4217 currency code used for the amount.", "maxLength": 3, "minLength": 3, "pattern": "^[A-Z]{3}$", "type": "string" }, "custom_scale": { "description": "Custom scale label defined by the client.", "type": [ "string", "null" ] }, "date_submitted": { "description": "Timestamp when the adjustment was submitted for review (ISO-8601).", "format": "date-time", "type": "string" }, "description": { "description": "Human-readable explanation of the invoice adjustment.", "type": "string" }, "id": { "description": "Unique identifier of this invoice adjustment.", "format": "uuid", "type": [ "string", "null" ] }, "invoice_id": { "description": "Identifier of the generated invoice this adjustment belongs to.", "format": "double", "type": [ "number", "null" ] }, "payment_cycle": { "$ref": "#/components/schemas/ContractsContractIdInvoiceAdjustmentsGetResponsesContentApplicationJsonSchemaDataItemsPaymentCycle", "description": "Payment cycle associated with this adjustment." }, "quantity": { "description": "Quantity used to calculate the total amount.", "format": "double", "type": [ "number", "null" ] }, "reported_by": { "$ref": "#/components/schemas/ContractsContractIdInvoiceAdjustmentsGetResponsesContentApplicationJsonSchemaDataItemsReportedBy", "description": "User who reported the invoice adjustment." }, "reviewed_by": { "description": "Reviewer information if the adjustment has been reviewed.", "oneOf": [ { "$ref": "#/components/schemas/ContractsContractIdInvoiceAdjustmentsGetResponsesContentApplicationJsonSchemaDataItemsReviewedBy" }, { "type": "null" } ] }, "scale": { "description": "Predefined scale used to calculate the adjustment amount.", "type": [ "string", "null" ] }, "status": { "description": "Current processing status of the invoice adjustment.", "oneOf": [ { "$ref": "#/components/schemas/ContractsContractIdInvoiceAdjustmentsGetResponsesContentApplicationJsonSchemaDataItemsStatus" }, { "type": "null" } ] }, "total_amount": { "description": "Total monetary value of the invoice adjustment.", "type": "string" }, "type": { "$ref": "#/components/schemas/ContractsContractIdInvoiceAdjustmentsGetResponsesContentApplicationJsonSchemaDataItemsType", "description": "Type of invoice adjustment." }, "worksheet": { "description": "Breakdown of time worked across different units.", "oneOf": [ { "$ref": "#/components/schemas/ContractsContractIdInvoiceAdjustmentsGetResponsesContentApplicationJsonSchemaDataItemsWorksheet" }, { "type": "null" } ] } }, "required": [ "id", "type", "status", "contract", "quantity", "worksheet", "attachment", "created_at", "description", "reported_by", "reviewed_by", "total_amount", "currency_code", "payment_cycle", "date_submitted" ], "title": "ContractsContractIdInvoiceAdjustmentsGetResponsesContentApplicationJsonSchemaDataItems", "type": "object" }, "ContractsContractIdInvoiceAdjustmentsGetResponsesContentApplicationJsonSchemaDataItemsAttachment": { "description": "This object is used for linking file attachments to your records.", "properties": { "filename": { "description": "Original filename you used to upload using attachments end-point.", "type": "string" }, "key": { "description": "You can call attachments end-point, get key and URL to upload your file.", "type": "string" } }, "required": [ "key", "filename" ], "title": "ContractsContractIdInvoiceAdjustmentsGetResponsesContentApplicationJsonSchemaDataItemsAttachment", "type": "object" }, "ContractsContractIdInvoiceAdjustmentsGetResponsesContentApplicationJsonSchemaDataItemsContract": { "description": "Contract associated with this invoice adjustment.", "properties": { "id": { "description": "Unique identifier of the contract.", "type": "string" }, "title": { "description": "Human-readable title of the contract.", "type": "string" }, "type": { "$ref": "#/components/schemas/ContractsContractIdInvoiceAdjustmentsGetResponsesContentApplicationJsonSchemaDataItemsContractType", "description": "Type of a contract" } }, "required": [ "id", "type", "title" ], "title": "ContractsContractIdInvoiceAdjustmentsGetResponsesContentApplicationJsonSchemaDataItemsContract", "type": "object" }, "ContractsContractIdInvoiceAdjustmentsGetResponsesContentApplicationJsonSchemaDataItemsContractType": { "description": "Type of a contract", "enum": [ "ongoing_time_based", "milestones", "time_based", "pay_as_you_go_time_based", "commission", "payg_milestones", "payg_tasks", "eor", "unknown", "employee", "global_payroll", "shield_msa", "hris_direct_employee", "peo" ], "title": "ContractsContractIdInvoiceAdjustmentsGetResponsesContentApplicationJsonSchemaDataItemsContractType", "type": "string" }, "ContractsContractIdInvoiceAdjustmentsGetResponsesContentApplicationJsonSchemaDataItemsPaymentCycle": { "description": "Payment cycle associated with this adjustment.", "properties": { "end_date": { "description": "End date of the payment cycle (ISO-8601).", "format": "date-time", "type": [ "string", "null" ] }, "start_date": { "description": "Start date of the payment cycle (ISO-8601).", "format": "date-time", "type": [ "string", "null" ] } }, "required": [ "end_date", "start_date" ], "title": "ContractsContractIdInvoiceAdjustmentsGetResponsesContentApplicationJsonSchemaDataItemsPaymentCycle", "type": "object" }, "ContractsContractIdInvoiceAdjustmentsGetResponsesContentApplicationJsonSchemaDataItemsReportedBy": { "description": "User who reported the invoice adjustment.", "properties": { "full_name": { "description": "Full name of the user who reported the adjustment.", "type": "string" }, "id": { "$ref": "#/components/schemas/ContractsContractIdInvoiceAdjustmentsGetResponsesContentApplicationJsonSchemaDataItemsReportedById", "description": "Unique identifier of the reporting user (string or integer)." } }, "required": [ "id" ], "title": "ContractsContractIdInvoiceAdjustmentsGetResponsesContentApplicationJsonSchemaDataItemsReportedBy", "type": "object" }, "ContractsContractIdInvoiceAdjustmentsGetResponsesContentApplicationJsonSchemaDataItemsReportedById": { "description": "Unique identifier of the reporting user (string or integer).", "oneOf": [ { "type": "string" }, { "format": "int64", "type": "integer" } ], "title": "ContractsContractIdInvoiceAdjustmentsGetResponsesContentApplicationJsonSchemaDataItemsReportedById" }, "ContractsContractIdInvoiceAdjustmentsGetResponsesContentApplicationJsonSchemaDataItemsReviewedBy": { "description": "Reviewer information if the adjustment has been reviewed.", "properties": { "full_name": { "description": "Full name of the reviewer.", "type": "string" }, "id": { "$ref": "#/components/schemas/ContractsContractIdInvoiceAdjustmentsGetResponsesContentApplicationJsonSchemaDataItemsReviewedById", "description": "Unique identifier of the reviewer (string or integer)." }, "remarks": { "description": "Reviewer remarks or decision notes.", "type": "string" }, "reviewed_at": { "description": "Timestamp when the review occurred (ISO-8601).", "type": "string" } }, "required": [ "id", "remarks", "reviewed_at" ], "title": "ContractsContractIdInvoiceAdjustmentsGetResponsesContentApplicationJsonSchemaDataItemsReviewedBy", "type": "object" }, "ContractsContractIdInvoiceAdjustmentsGetResponsesContentApplicationJsonSchemaDataItemsReviewedById": { "description": "Unique identifier of the reviewer (string or integer).", "oneOf": [ { "type": "string" }, { "format": "int64", "type": "integer" } ], "title": "ContractsContractIdInvoiceAdjustmentsGetResponsesContentApplicationJsonSchemaDataItemsReviewedById" }, "ContractsContractIdInvoiceAdjustmentsGetResponsesContentApplicationJsonSchemaDataItemsStatus": { "description": "Current processing status of the invoice adjustment.", "enum": [ "approved", "declined", "not_payable", "paid", "pending", "processing" ], "title": "ContractsContractIdInvoiceAdjustmentsGetResponsesContentApplicationJsonSchemaDataItemsStatus", "type": "string" }, "ContractsContractIdInvoiceAdjustmentsGetResponsesContentApplicationJsonSchemaDataItemsType": { "description": "Type of invoice adjustment.", "enum": [ "accrued_holiday", "additional_fee", "allowance", "bonus", "commission", "deduction", "deposit", "deposit_refund", "employer_cost", "expense", "health_allowance", "health_benefit", "health_insurance_fee", "legal_fee", "management_fee", "milestone", "offcycle", "other", "overtime", "pension", "pro_rata", "setup_fee", "severance", "shield_service", "signing_bonus", "signing_bonus_employer_cost", "refund", "task", "time_off", "vat", "withholding_tax", "work" ], "title": "ContractsContractIdInvoiceAdjustmentsGetResponsesContentApplicationJsonSchemaDataItemsType", "type": "string" }, "ContractsContractIdInvoiceAdjustmentsGetResponsesContentApplicationJsonSchemaDataItemsWorksheet": { "description": "Breakdown of time worked across different units.", "properties": { "days": { "description": "Number of days reported.", "format": "double", "minimum": 0, "type": "number" }, "hours": { "description": "Number of hours reported.", "format": "double", "minimum": 0, "type": "number" }, "minutes": { "description": "Number of minutes reported.", "format": "double", "minimum": 0, "type": "number" }, "weeks": { "description": "Number of weeks reported.", "format": "double", "minimum": 0, "type": "number" } }, "required": [ "days", "hours", "weeks", "minutes" ], "title": "ContractsContractIdInvoiceAdjustmentsGetResponsesContentApplicationJsonSchemaDataItemsWorksheet", "type": "object" }, "ContractsContractIdInvoiceAdjustmentsGetResponsesContentApplicationJsonSchemaErrorsItems": { "properties": { "message": { "description": "Error response", "type": "string" } }, "required": [ "message" ], "title": "ContractsContractIdInvoiceAdjustmentsGetResponsesContentApplicationJsonSchemaErrorsItems", "type": "object" }, "ContractsContractIdInvoiceAdjustmentsGetResponsesContentApplicationJsonSchemaPage": { "description": "Pagination metadata for the response.", "properties": { "items_per_page": { "description": "Number of items per page", "format": "double", "maximum": 100, "minimum": 1, "type": "number" }, "offset": { "description": "Index of the first row in this page", "format": "double", "maximum": 999999999, "minimum": 0, "type": "number" }, "total_rows": { "description": "Total number of rows in the result set", "format": "double", "type": "number" } }, "required": [ "offset", "total_rows", "items_per_page" ], "title": "ContractsContractIdInvoiceAdjustmentsGetResponsesContentApplicationJsonSchemaPage", "type": "object" }, "ContractsContractIdInvoiceAdjustmentsGetResponsesContentApplicationJsonSchemaRequest": { "description": "Error request details", "properties": { "method": { "description": "Method of the API", "type": "string" }, "status": { "description": "Status of API response", "format": "double", "type": "number" } }, "title": "ContractsContractIdInvoiceAdjustmentsGetResponsesContentApplicationJsonSchemaRequest", "type": "object" }, "ContractsContractIdMilestonesGetResponsesContentApplicationJsonSchemaDataItems": { "properties": { "amount": { "description": "The amount to be paid for completing this milestone.", "type": "string" }, "approval_requested": { "description": "Indicates whether approval has been requested for the milestone.", "type": "boolean" }, "created_at": { "description": "The creation date of the milestone in ISO-8601 format.", "pattern": "^\\d{4}-\\d{2}-\\d{2}([T ]\\d{2}:\\d{2}:\\d{2}(\\.\\d+)?(Z|[+-]\\d{2}:?\\d{2})?)?$", "type": [ "string", "null" ] }, "description": { "description": "A detailed description of the milestone.", "type": "string" }, "id": { "$ref": "#/components/schemas/ContractsContractIdMilestonesGetResponsesContentApplicationJsonSchemaDataItemsId" }, "reported_by": { "$ref": "#/components/schemas/ContractsContractIdMilestonesGetResponsesContentApplicationJsonSchemaDataItemsReportedBy", "description": "Information about the creator of the milestone." }, "reviewed_by": { "description": "Information about the person who reviewed the milestone.", "oneOf": [ { "$ref": "#/components/schemas/ContractsContractIdMilestonesGetResponsesContentApplicationJsonSchemaDataItemsReviewedBy" }, { "type": "null" } ] }, "status": { "description": "The current status of the milestone, such as 'Pending Approval', 'Approved', or 'Completed'.", "type": "string" }, "title": { "description": "The title of the milestone.", "type": "string" } }, "required": [ "id", "title", "amount", "status", "created_at", "description", "reported_by", "reviewed_by", "approval_requested" ], "title": "ContractsContractIdMilestonesGetResponsesContentApplicationJsonSchemaDataItems", "type": "object" }, "ContractsContractIdMilestonesGetResponsesContentApplicationJsonSchemaDataItemsId": { "oneOf": [ { "type": "string" }, { "format": "int64", "type": "integer" } ], "title": "ContractsContractIdMilestonesGetResponsesContentApplicationJsonSchemaDataItemsId" }, "ContractsContractIdMilestonesGetResponsesContentApplicationJsonSchemaDataItemsReportedBy": { "description": "Information about the creator of the milestone.", "properties": { "full_name": { "description": "The full name of the person who reported the milestone.", "type": "string" }, "id": { "$ref": "#/components/schemas/ContractsContractIdMilestonesGetResponsesContentApplicationJsonSchemaDataItemsReportedById" } }, "required": [ "id" ], "title": "ContractsContractIdMilestonesGetResponsesContentApplicationJsonSchemaDataItemsReportedBy", "type": "object" }, "ContractsContractIdMilestonesGetResponsesContentApplicationJsonSchemaDataItemsReportedById": { "oneOf": [ { "type": "string" }, { "format": "int64", "type": "integer" } ], "title": "ContractsContractIdMilestonesGetResponsesContentApplicationJsonSchemaDataItemsReportedById" }, "ContractsContractIdMilestonesGetResponsesContentApplicationJsonSchemaDataItemsReviewedBy": { "description": "Information about the person who reviewed the milestone.", "properties": { "full_name": { "description": "The full name of the person who reviewed the milestone.", "type": "string" }, "id": { "$ref": "#/components/schemas/ContractsContractIdMilestonesGetResponsesContentApplicationJsonSchemaDataItemsReviewedById" } }, "required": [ "id" ], "title": "ContractsContractIdMilestonesGetResponsesContentApplicationJsonSchemaDataItemsReviewedBy", "type": "object" }, "ContractsContractIdMilestonesGetResponsesContentApplicationJsonSchemaDataItemsReviewedById": { "oneOf": [ { "type": "string" }, { "format": "int64", "type": "integer" } ], "title": "ContractsContractIdMilestonesGetResponsesContentApplicationJsonSchemaDataItemsReviewedById" }, "ContractsContractIdMilestonesGetResponsesContentApplicationJsonSchemaErrorsItems": { "properties": { "code": { "description": "Machine-readable error code identifying the failure category.", "type": "string" }, "message": { "description": "Human-readable error message describing the unexpected condition.", "type": "string" } }, "required": [ "message" ], "title": "ContractsContractIdMilestonesGetResponsesContentApplicationJsonSchemaErrorsItems", "type": "object" }, "ContractsContractIdMilestonesMilestoneIdDeleteResponsesContentApplicationJsonSchemaData": { "properties": { "deleted": { "description": "Confirms that the milestone was successfully deleted.", "type": "boolean" } }, "required": [ "deleted" ], "title": "ContractsContractIdMilestonesMilestoneIdDeleteResponsesContentApplicationJsonSchemaData", "type": "object" }, "ContractsContractIdMilestonesMilestoneIdDeleteResponsesContentApplicationJsonSchemaErrorsItems": { "properties": { "code": { "description": "Machine-readable error code identifying the failure category.", "type": "string" }, "message": { "description": "Human-readable error message describing the unexpected condition.", "type": "string" } }, "required": [ "message" ], "title": "ContractsContractIdMilestonesMilestoneIdDeleteResponsesContentApplicationJsonSchemaErrorsItems", "type": "object" }, "ContractsContractIdMilestonesMilestoneIdGetResponsesContentApplicationJsonSchemaData": { "properties": { "amount": { "description": "Amount to be paid for the milestone.", "type": "string" }, "approval_requested": { "description": "Indicates if the contractor has requested the approval for the milestone.", "type": "boolean" }, "created_at": { "description": "Long date-time format following ISO-8601", "pattern": "^\\d{4}-\\d{2}-\\d{2}([T ]\\d{2}:\\d{2}:\\d{2}(\\.\\d+)?(Z|[+-]\\d{2}:?\\d{2})?)?$", "type": [ "string", "null" ] }, "description": { "description": "Description of milestone.", "type": "string" }, "id": { "$ref": "#/components/schemas/ContractsContractIdMilestonesMilestoneIdGetResponsesContentApplicationJsonSchemaDataId" }, "reported_by": { "$ref": "#/components/schemas/ContractsContractIdMilestonesMilestoneIdGetResponsesContentApplicationJsonSchemaDataReportedBy", "description": "Milestone creator." }, "reviewed_by": { "description": "Reviewer's information.", "oneOf": [ { "$ref": "#/components/schemas/ContractsContractIdMilestonesMilestoneIdGetResponsesContentApplicationJsonSchemaDataReviewedBy" }, { "type": "null" } ] }, "status": { "description": "Current status of milestone.", "type": "string" }, "title": { "description": "Title of milestone.", "type": "string" } }, "required": [ "id", "title", "amount", "status", "created_at", "description", "reported_by", "reviewed_by", "approval_requested" ], "title": "ContractsContractIdMilestonesMilestoneIdGetResponsesContentApplicationJsonSchemaData", "type": "object" }, "ContractsContractIdMilestonesMilestoneIdGetResponsesContentApplicationJsonSchemaDataId": { "oneOf": [ { "type": "string" }, { "format": "int64", "type": "integer" } ], "title": "ContractsContractIdMilestonesMilestoneIdGetResponsesContentApplicationJsonSchemaDataId" }, "ContractsContractIdMilestonesMilestoneIdGetResponsesContentApplicationJsonSchemaDataReportedBy": { "description": "Milestone creator.", "properties": { "full_name": { "description": "Reporter's full name.", "type": "string" }, "id": { "$ref": "#/components/schemas/ContractsContractIdMilestonesMilestoneIdGetResponsesContentApplicationJsonSchemaDataReportedById" } }, "required": [ "id" ], "title": "ContractsContractIdMilestonesMilestoneIdGetResponsesContentApplicationJsonSchemaDataReportedBy", "type": "object" }, "ContractsContractIdMilestonesMilestoneIdGetResponsesContentApplicationJsonSchemaDataReportedById": { "oneOf": [ { "type": "string" }, { "format": "int64", "type": "integer" } ], "title": "ContractsContractIdMilestonesMilestoneIdGetResponsesContentApplicationJsonSchemaDataReportedById" }, "ContractsContractIdMilestonesMilestoneIdGetResponsesContentApplicationJsonSchemaDataReviewedBy": { "description": "Reviewer's information.", "properties": { "full_name": { "description": "Reviewer's full name.", "type": "string" }, "id": { "$ref": "#/components/schemas/ContractsContractIdMilestonesMilestoneIdGetResponsesContentApplicationJsonSchemaDataReviewedById" } }, "required": [ "id" ], "title": "ContractsContractIdMilestonesMilestoneIdGetResponsesContentApplicationJsonSchemaDataReviewedBy", "type": "object" }, "ContractsContractIdMilestonesMilestoneIdGetResponsesContentApplicationJsonSchemaDataReviewedById": { "oneOf": [ { "type": "string" }, { "format": "int64", "type": "integer" } ], "title": "ContractsContractIdMilestonesMilestoneIdGetResponsesContentApplicationJsonSchemaDataReviewedById" }, "ContractsContractIdMilestonesMilestoneIdGetResponsesContentApplicationJsonSchemaErrorsItems": { "properties": { "code": { "description": "Machine-readable error code identifying the failure category.", "type": "string" }, "message": { "description": "Human-readable error message describing the unexpected condition.", "type": "string" } }, "required": [ "message" ], "title": "ContractsContractIdMilestonesMilestoneIdGetResponsesContentApplicationJsonSchemaErrorsItems", "type": "object" }, "ContractsContractIdMilestonesPostRequestBodyContentApplicationJsonSchemaData": { "properties": { "amount": { "$ref": "#/components/schemas/ContractsContractIdMilestonesPostRequestBodyContentApplicationJsonSchemaDataAmount" }, "description": { "description": "A detailed description of the milestone.", "type": "string" }, "title": { "description": "The title of the milestone.", "type": "string" } }, "required": [ "title", "amount", "description" ], "title": "ContractsContractIdMilestonesPostRequestBodyContentApplicationJsonSchemaData", "type": "object" }, "ContractsContractIdMilestonesPostRequestBodyContentApplicationJsonSchemaDataAmount": { "oneOf": [ { "type": "string" }, { "format": "double", "type": "number" } ], "title": "ContractsContractIdMilestonesPostRequestBodyContentApplicationJsonSchemaDataAmount" }, "ContractsContractIdMilestonesPostResponsesContentApplicationJsonSchemaData": { "properties": { "created": { "description": "Indicates whether the milestone was successfully created.", "type": "boolean" } }, "required": [ "created" ], "title": "ContractsContractIdMilestonesPostResponsesContentApplicationJsonSchemaData", "type": "object" }, "ContractsContractIdMilestonesPostResponsesContentApplicationJsonSchemaErrorsItems": { "properties": { "code": { "description": "Machine-readable error code identifying the failure category.", "type": "string" }, "message": { "description": "Human-readable error message describing the unexpected condition.", "type": "string" } }, "required": [ "message" ], "title": "ContractsContractIdMilestonesPostResponsesContentApplicationJsonSchemaErrorsItems", "type": "object" }, "ContractsContractIdOffCyclePaymentsGetResponsesContentApplicationJsonSchemaDataItems": { "properties": { "amount": { "description": "The amount of the off-cycle payment.", "type": "string" }, "created_at": { "description": "The timestamp when the off-cycle payment was created.", "format": "date-time", "type": "string" }, "currency_code": { "description": "The three-letter ISO currency code for the payment amount.", "maxLength": 3, "minLength": 3, "pattern": "^[A-Z]{3}$", "type": "string" }, "date_submitted": { "description": "The timestamp when the off-cycle payment was submitted.", "format": "date-time", "type": "string" }, "description": { "description": "A description or reason for the off-cycle payment.", "type": "string" }, "id": { "description": "Unique identifier of the off-cycle payment.", "format": "uuid", "type": "string" }, "reported_by": { "$ref": "#/components/schemas/ContractsContractIdOffCyclePaymentsGetResponsesContentApplicationJsonSchemaDataItemsReportedBy", "description": "Details of the person who reported the off-cycle payment." }, "status": { "description": "The current status of the off-cycle payment.", "oneOf": [ { "$ref": "#/components/schemas/ContractsContractIdOffCyclePaymentsGetResponsesContentApplicationJsonSchemaDataItemsStatus" }, { "type": "null" } ] } }, "required": [ "id", "amount", "status", "created_at", "description", "reported_by", "currency_code", "date_submitted" ], "title": "ContractsContractIdOffCyclePaymentsGetResponsesContentApplicationJsonSchemaDataItems", "type": "object" }, "ContractsContractIdOffCyclePaymentsGetResponsesContentApplicationJsonSchemaDataItemsReportedBy": { "description": "Details of the person who reported the off-cycle payment.", "properties": { "full_name": { "description": "Full name of the individual who reported the payment.", "type": "string" }, "id": { "description": "Unique identifier of the reporter.", "format": "uuid", "type": "string" } }, "required": [ "id" ], "title": "ContractsContractIdOffCyclePaymentsGetResponsesContentApplicationJsonSchemaDataItemsReportedBy", "type": "object" }, "ContractsContractIdOffCyclePaymentsGetResponsesContentApplicationJsonSchemaDataItemsStatus": { "description": "The current status of the off-cycle payment.", "enum": [ "approved", "declined", "new", "not_payable", "paid", "pending", "processing" ], "title": "ContractsContractIdOffCyclePaymentsGetResponsesContentApplicationJsonSchemaDataItemsStatus", "type": "string" }, "ContractsContractIdOffCyclePaymentsGetResponsesContentApplicationJsonSchemaErrorsItems": { "properties": { "code": { "description": "Machine-readable error code identifying the failure category.", "type": "string" }, "message": { "description": "Human-readable error message describing the unexpected condition.", "type": "string" } }, "required": [ "message" ], "title": "ContractsContractIdOffCyclePaymentsGetResponsesContentApplicationJsonSchemaErrorsItems", "type": "object" }, "ContractsContractIdOffCyclePaymentsOffCyclePaymentIdGetResponsesContentApplicationJsonSchemaData": { "description": "Details of the off-cycle payment.", "properties": { "amount": { "description": "Amount of the off-cycle payment.", "type": "string" }, "created_at": { "description": "Timestamp of when the off-cycle payment was created.", "format": "date-time", "type": "string" }, "currency_code": { "description": "ISO 4217 currency code of the payment.", "maxLength": 3, "minLength": 3, "pattern": "^[A-Z]{3}$", "type": "string" }, "date_submitted": { "description": "Timestamp of when the payment was submitted.", "format": "date-time", "type": "string" }, "description": { "description": "Description of the off-cycle payment.", "type": "string" }, "id": { "description": "Unique identifier for the off-cycle payment.", "format": "uuid", "type": "string" }, "reported_by": { "$ref": "#/components/schemas/ContractsContractIdOffCyclePaymentsOffCyclePaymentIdGetResponsesContentApplicationJsonSchemaDataReportedBy", "description": "Details of the person who reported the off-cycle payment." }, "status": { "description": "Current status of the off-cycle payment.", "oneOf": [ { "$ref": "#/components/schemas/ContractsContractIdOffCyclePaymentsOffCyclePaymentIdGetResponsesContentApplicationJsonSchemaDataStatus" }, { "type": "null" } ] } }, "required": [ "id", "amount", "status", "created_at", "description", "reported_by", "currency_code", "date_submitted" ], "title": "ContractsContractIdOffCyclePaymentsOffCyclePaymentIdGetResponsesContentApplicationJsonSchemaData", "type": "object" }, "ContractsContractIdOffCyclePaymentsOffCyclePaymentIdGetResponsesContentApplicationJsonSchemaDataReportedBy": { "description": "Details of the person who reported the off-cycle payment.", "properties": { "full_name": { "description": "Full name of the person who reported the payment.", "type": "string" }, "id": { "description": "Unique identifier of the reporter.", "format": "uuid", "type": "string" } }, "required": [ "id" ], "title": "ContractsContractIdOffCyclePaymentsOffCyclePaymentIdGetResponsesContentApplicationJsonSchemaDataReportedBy", "type": "object" }, "ContractsContractIdOffCyclePaymentsOffCyclePaymentIdGetResponsesContentApplicationJsonSchemaDataStatus": { "description": "Current status of the off-cycle payment.", "enum": [ "approved", "declined", "new", "not_payable", "paid", "pending", "processing" ], "title": "ContractsContractIdOffCyclePaymentsOffCyclePaymentIdGetResponsesContentApplicationJsonSchemaDataStatus", "type": "string" }, "ContractsContractIdOffCyclePaymentsOffCyclePaymentIdGetResponsesContentApplicationJsonSchemaErrorsItems": { "properties": { "code": { "description": "Machine-readable error code identifying the failure category.", "type": "string" }, "message": { "description": "Human-readable error message describing the unexpected condition.", "type": "string" } }, "required": [ "message" ], "title": "ContractsContractIdOffCyclePaymentsOffCyclePaymentIdGetResponsesContentApplicationJsonSchemaErrorsItems", "type": "object" }, "ContractsContractIdOffCyclePaymentsPostRequestBodyContentApplicationJsonSchemaData": { "description": "The off-cycle payment data to submit.", "properties": { "amount": { "description": "The amount of the off-cycle payment.", "format": "double", "minimum": 0, "type": "number" }, "date_submitted": { "description": "The date the off-cycle payment is submitted, in ISO-8601 format (YYYY-MM-DD).", "format": "date", "type": "string" }, "description": { "description": "A description or reason for the off-cycle payment.", "type": "string" }, "hourly_report_preset_id": { "description": "Id of an existing preset.", "format": "uuid", "type": [ "string", "null" ] }, "is_auto_approved": { "description": "If true, the off-cycle payment will be automatically approved as part of the request.", "type": "boolean" }, "payment_due_date": { "description": "Due date of the resulting one-off invoice, in ISO-8601 format (YYYY-MM-DD) in the contract timezone. Defaults to today when omitted or null. Must be today or later and, when the contract is active and has an end date, not after that end date.", "format": "date", "type": [ "string", "null" ] } }, "required": [ "amount", "description", "date_submitted" ], "title": "ContractsContractIdOffCyclePaymentsPostRequestBodyContentApplicationJsonSchemaData", "type": "object" }, "ContractsContractIdOffCyclePaymentsPostResponsesContentApplicationJsonSchemaData": { "description": "Details of the newly created off-cycle payment.", "properties": { "created": { "description": "Indicates whether the off-cycle payment was successfully created.", "type": "boolean" }, "id": { "description": "The unique identifier of the created off-cycle payment.", "format": "uuid", "type": "string" } }, "required": [ "created" ], "title": "ContractsContractIdOffCyclePaymentsPostResponsesContentApplicationJsonSchemaData", "type": "object" }, "ContractsContractIdOffCyclePaymentsPostResponsesContentApplicationJsonSchemaErrorsItems": { "properties": { "code": { "description": "Machine-readable error code identifying the failure category.", "type": "string" }, "message": { "description": "Human-readable error message describing the unexpected condition.", "type": "string" } }, "required": [ "message" ], "title": "ContractsContractIdOffCyclePaymentsPostResponsesContentApplicationJsonSchemaErrorsItems", "type": "object" }, "ContractsContractIdPatchRequestBodyContentApplicationJsonSchemaData": { "properties": { "external_id": { "description": "A unique identifier for the object provided by an external system. Use or send null when you want to reset the external id.", "type": [ "string", "null" ] } }, "required": [ "external_id" ], "title": "ContractsContractIdPatchRequestBodyContentApplicationJsonSchemaData", "type": "object" }, "ContractsContractIdPatchResponsesContentApplicationJsonSchemaClient": { "description": "Client details associated with the contract.", "properties": { "email": { "description": "User's email address. It can be an empty string when no email has been provided for the worker. This can happen for draft contracts or workers with incomplete onboarding.", "type": [ "string", "null" ] }, "full_name": { "description": "Full name of the client.", "type": "string" }, "id": { "description": "Unique identifier of this resource.", "type": "string" }, "legal_entity": { "description": "Legal entity details of the client.", "oneOf": [ { "$ref": "#/components/schemas/ContractsContractIdPatchResponsesContentApplicationJsonSchemaClientLegalEntity" }, { "type": "null" } ] }, "team": { "$ref": "#/components/schemas/ContractsContractIdPatchResponsesContentApplicationJsonSchemaClientTeam", "description": "Team information for the client organization." } }, "required": [ "team" ], "title": "ContractsContractIdPatchResponsesContentApplicationJsonSchemaClient", "type": "object" }, "ContractsContractIdPatchResponsesContentApplicationJsonSchemaClientLegalEntity": { "description": "Legal entity details of the client.", "properties": { "email": { "description": "Email address of the legal entity.", "type": [ "string", "null" ] }, "id": { "description": "Unique identifier of this resource.", "type": "string" }, "name": { "description": "Name of a team.", "type": "string" }, "registration_number": { "description": "Registration number of the legal entity.", "type": [ "string", "null" ] }, "subtype": { "description": "Sub-type of the legal entity.", "type": [ "string", "null" ] }, "type": { "description": "Type of the legal entity.", "type": [ "string", "null" ] }, "vat_number": { "description": "VAT number of the legal entity.", "type": [ "string", "null" ] } }, "title": "ContractsContractIdPatchResponsesContentApplicationJsonSchemaClientLegalEntity", "type": "object" }, "ContractsContractIdPatchResponsesContentApplicationJsonSchemaClientTeam": { "description": "Team information for the client organization.", "properties": { "id": { "$ref": "#/components/schemas/ContractsContractIdPatchResponsesContentApplicationJsonSchemaClientTeamId", "description": "Unique identifier of this resource." }, "name": { "description": "Name of a team.", "type": "string" } }, "required": [ "id", "name" ], "title": "ContractsContractIdPatchResponsesContentApplicationJsonSchemaClientTeam", "type": "object" }, "ContractsContractIdPatchResponsesContentApplicationJsonSchemaClientTeamId": { "description": "Unique identifier of this resource.", "oneOf": [ { "type": "string" }, { "format": "double", "type": "number" } ], "title": "ContractsContractIdPatchResponsesContentApplicationJsonSchemaClientTeamId" }, "ContractsContractIdPatchResponsesContentApplicationJsonSchemaCompensationDetails": { "description": "Compensation and payment configuration for the contract.", "properties": { "amount": { "description": "Amount to be paid. This field can be excluded when creating a Pay-as-you-go task-based or Milestone contracts.", "type": [ "string", "null" ] }, "currency_code": { "description": "Currency code.", "maxLength": 3, "minLength": 3, "pattern": "^[A-Z]{3}$", "type": [ "string", "null" ] }, "cycle_end": { "description": "Day of the cycle end", "format": "double", "type": [ "number", "null" ] }, "cycle_end_type": { "description": " Cycle end type", "oneOf": [ { "$ref": "#/components/schemas/ContractsContractIdPatchResponsesContentApplicationJsonSchemaCompensationDetailsCycleEndType" }, { "type": "null" } ] }, "first_payment": { "description": "First payment amount.", "type": [ "string", "null" ] }, "first_payment_date": { "description": "First payment date.", "type": [ "string", "null" ] }, "frequency": { "description": "Scale of the invoice cycle.", "type": "string" }, "gross_annual_salary": { "description": "Gross annual salary.", "type": [ "string", "null" ] }, "gross_signing_bonus": { "description": "Gross signing bonus.", "type": [ "string", "null" ] }, "gross_variable_bonus": { "description": "Gross variable bonus.", "type": [ "string", "null" ] }, "scale": { "description": "Scale of the payment.", "type": [ "string", "null" ] } }, "title": "ContractsContractIdPatchResponsesContentApplicationJsonSchemaCompensationDetails", "type": "object" }, "ContractsContractIdPatchResponsesContentApplicationJsonSchemaCompensationDetailsCycleEndType": { "description": " Cycle end type", "enum": [ "DAY_OF_WEEK", "DAY_OF_LAST_WEEK", "DAY_OF_MONTH" ], "title": "ContractsContractIdPatchResponsesContentApplicationJsonSchemaCompensationDetailsCycleEndType", "type": "string" }, "ContractsContractIdPatchResponsesContentApplicationJsonSchemaContractTemplate": { "description": "Contract template details.", "properties": { "id": { "description": "Unique identifier of a contract template.", "type": "string" }, "title": { "description": "Title of a contract template", "type": "string" } }, "title": "ContractsContractIdPatchResponsesContentApplicationJsonSchemaContractTemplate", "type": "object" }, "ContractsContractIdPatchResponsesContentApplicationJsonSchemaCostCentersItems": { "properties": { "allocation_percentage": { "description": "Percentage of the cost center allocation.", "format": "double", "type": "number" }, "name": { "description": "Cost center name.", "type": "string" }, "number": { "description": "Cost center number.", "type": "string" } }, "title": "ContractsContractIdPatchResponsesContentApplicationJsonSchemaCostCentersItems", "type": "object" }, "ContractsContractIdPatchResponsesContentApplicationJsonSchemaCustomFieldsItems": { "description": "Customized attributes on contracts (Employee ID, Project code, etc).", "properties": { "name": { "description": "Custom field property name.", "type": "string" }, "value": { "description": "Custom field property value.", "type": "string" } }, "title": "ContractsContractIdPatchResponsesContentApplicationJsonSchemaCustomFieldsItems", "type": "object" }, "ContractsContractIdPatchResponsesContentApplicationJsonSchemaEmploymentDetails": { "description": "Employment-related details for the contract.", "properties": { "days_per_week": { "description": "Number of days per week.", "format": "double", "type": "number" }, "hours_per_day": { "description": "Number of hours per day.", "format": "double", "type": "number" }, "paid_vacation_days": { "description": "Number of paid vacation days.", "format": "double", "type": "number" }, "probation_period": { "description": "Probation period in days.", "format": "double", "type": [ "number", "null" ] }, "type": { "description": "Type of employment.", "type": "string" } }, "title": "ContractsContractIdPatchResponsesContentApplicationJsonSchemaEmploymentDetails", "type": "object" }, "ContractsContractIdPatchResponsesContentApplicationJsonSchemaEmploymentType": { "description": "Type of employment.", "enum": [ "FULL_TIME", "PART_TIME" ], "title": "ContractsContractIdPatchResponsesContentApplicationJsonSchemaEmploymentType", "type": "string" }, "ContractsContractIdPatchResponsesContentApplicationJsonSchemaErrorsItems": { "properties": { "message": { "description": "Error response", "type": "string" } }, "required": [ "message" ], "title": "ContractsContractIdPatchResponsesContentApplicationJsonSchemaErrorsItems", "type": "object" }, "ContractsContractIdPatchResponsesContentApplicationJsonSchemaInvitations": { "description": "Invitation email addresses for signing the contract.", "properties": { "client_email": { "description": "User's email address.", "type": [ "string", "null" ] }, "worker_email": { "description": "User's email address.", "type": [ "string", "null" ] } }, "title": "ContractsContractIdPatchResponsesContentApplicationJsonSchemaInvitations", "type": "object" }, "ContractsContractIdPatchResponsesContentApplicationJsonSchemaQuote": { "description": "EOR quote approved by Deel.", "properties": { "benefits": { "description": "Array of benefits.", "items": { "$ref": "#/components/schemas/ContractsContractIdPatchResponsesContentApplicationJsonSchemaQuoteBenefitsItems" }, "type": "array" }, "currency": { "description": "Currency used for the quote.", "maxLength": 3, "minLength": 3, "pattern": "^[A-Z]{3}$", "type": "string" } }, "title": "ContractsContractIdPatchResponsesContentApplicationJsonSchemaQuote", "type": "object" }, "ContractsContractIdPatchResponsesContentApplicationJsonSchemaQuoteBenefitsItems": { "properties": { "currency": { "description": "Currency code.", "maxLength": 3, "minLength": 3, "pattern": "^[A-Z]{3}$", "type": "string" }, "fee": { "description": "Fee in local currency.", "format": "double", "type": "number" }, "fee_usd": { "description": "Fee in USD.", "format": "double", "type": "number" }, "name": { "description": "Benefit's name.", "type": "string" }, "plan": { "description": "Benefit's plan.", "type": "string" }, "price": { "description": "Price in local currency.", "format": "double", "type": "number" }, "price_usd": { "description": "Price in USD.", "format": "double", "type": "number" } }, "title": "ContractsContractIdPatchResponsesContentApplicationJsonSchemaQuoteBenefitsItems", "type": "object" }, "ContractsContractIdPatchResponsesContentApplicationJsonSchemaRequest": { "description": "Error request details", "properties": { "method": { "description": "Method of the API", "type": "string" }, "status": { "description": "Status of API response", "format": "double", "type": "number" } }, "title": "ContractsContractIdPatchResponsesContentApplicationJsonSchemaRequest", "type": "object" }, "ContractsContractIdPatchResponsesContentApplicationJsonSchemaSeniority": { "description": "Seniority describes level of expertise at a job e.g. junior.", "properties": { "id": { "description": "Unique identifier of this resource.", "format": "double", "type": [ "number", "null" ] }, "level": { "description": "Level of seniority level e.g. 2.", "format": "double", "type": [ "number", "null" ] }, "name": { "description": "Name of seniority level e.g. Mid (Individual Contributor Level 2).", "type": [ "string", "null" ] } }, "title": "ContractsContractIdPatchResponsesContentApplicationJsonSchemaSeniority", "type": "object" }, "ContractsContractIdPatchResponsesContentApplicationJsonSchemaSignatures": { "description": "Signature information for the contract parties.", "properties": { "client_signature": { "description": "Client representative signature (typically a name).", "type": "string" }, "client_signed_at": { "description": "Date and time when the client signed the contract.", "format": "date-time", "type": [ "string", "null" ] }, "signed_at": { "description": "Date and time when the contract was signed.", "format": "date-time", "type": [ "string", "null" ] }, "worker_signature": { "description": "Worker signature (typically a name).", "type": "string" }, "worker_signed_at": { "description": "Date and time when the worker signed the contract.", "format": "date-time", "type": [ "string", "null" ] } }, "title": "ContractsContractIdPatchResponsesContentApplicationJsonSchemaSignatures", "type": "object" }, "ContractsContractIdPatchResponsesContentApplicationJsonSchemaStatus": { "description": "Status of a contract in Deel workflow.", "enum": [ "new", "under_review", "waiting_for_employee_contract", "waiting_for_client_sign", "processing_payment", "waiting_for_contractor_sign", "waiting_for_eor_sign", "waiting_for_employee_sign", "awaiting_deposit_payment", "in_progress", "completed", "cancelled", "user_cancelled", "rejected", "waiting_for_client_payment", "onboarding", "waiting_for_approval", "onboarded" ], "title": "ContractsContractIdPatchResponsesContentApplicationJsonSchemaStatus", "type": "string" }, "ContractsContractIdPatchResponsesContentApplicationJsonSchemaType": { "description": "Type of a contract.", "enum": [ "ongoing_time_based", "milestones", "time_based", "pay_as_you_go_time_based", "commission", "payg_milestones", "payg_tasks", "contractor_outside_deel", "eor", "unknown", "employee", "global_payroll", "shield_msa", "hris_direct_employee", "peo" ], "title": "ContractsContractIdPatchResponsesContentApplicationJsonSchemaType", "type": "string" }, "ContractsContractIdPatchResponsesContentApplicationJsonSchemaWorkSchedule": { "description": "Defines a work schedule including working days, hours, and employment details", "properties": { "country": { "description": "Country code where this work schedule applies (ISO 3166-1 alpha-2)", "pattern": "^[A-Z]{2}$", "type": "string" }, "days": { "description": "Working days and hours configuration", "items": { "$ref": "#/components/schemas/ContractsContractIdPatchResponsesContentApplicationJsonSchemaWorkScheduleDaysItems" }, "type": "array" }, "employment_type": { "description": "Type of employment arrangement", "oneOf": [ { "$ref": "#/components/schemas/ContractsContractIdPatchResponsesContentApplicationJsonSchemaWorkScheduleEmploymentType" }, { "type": "null" } ] }, "name": { "description": "Unique identifier or name for the work schedule", "maxLength": 50, "type": "string" }, "work_hours_per_week": { "description": "Total number of working hours per week", "maximum": 168, "minimum": 1, "type": "integer" }, "work_schedule_type": { "description": "Work schedule type", "type": "string" }, "worker_types": { "description": "List of worker types that can use this schedule", "items": { "$ref": "#/components/schemas/ContractsContractIdPatchResponsesContentApplicationJsonSchemaWorkScheduleWorkerTypesItems" }, "type": "array" } }, "required": [ "days", "name", "country", "worker_types", "work_schedule_type", "work_hours_per_week" ], "title": "ContractsContractIdPatchResponsesContentApplicationJsonSchemaWorkSchedule", "type": "object" }, "ContractsContractIdPatchResponsesContentApplicationJsonSchemaWorkScheduleDaysItems": { "description": "Defines working hours for a specific day of the week", "properties": { "day": { "$ref": "#/components/schemas/ContractsContractIdPatchResponsesContentApplicationJsonSchemaWorkScheduleDaysItemsDay", "description": "Day of the week" }, "end": { "description": "End time for the work day (HH:MM:SS format)", "format": "time", "pattern": "^([01]?[0-9]|2[0-3]):[0-5][0-9]:[0-5][0-9]$", "type": [ "string", "null" ] }, "start": { "description": "Start time for the work day (HH:MM:SS format)", "format": "time", "pattern": "^([01]?[0-9]|2[0-3]):[0-5][0-9]:[0-5][0-9]$", "type": "string" }, "work_hours": { "description": "Number of working hours for this day", "title": "float", "type": "string" } }, "required": [ "day", "end", "start", "work_hours" ], "title": "ContractsContractIdPatchResponsesContentApplicationJsonSchemaWorkScheduleDaysItems", "type": "object" }, "ContractsContractIdPatchResponsesContentApplicationJsonSchemaWorkScheduleDaysItemsDay": { "description": "Day of the week", "enum": [ "MONDAY", "TUESDAY", "WEDNESDAY", "THURSDAY", "FRIDAY", "SATURDAY", "SUNDAY" ], "title": "ContractsContractIdPatchResponsesContentApplicationJsonSchemaWorkScheduleDaysItemsDay", "type": "string" }, "ContractsContractIdPatchResponsesContentApplicationJsonSchemaWorkScheduleEmploymentType": { "description": "Type of employment arrangement", "enum": [ "FULL_TIME", "PART_TIME", "CONTRACT", "TEMPORARY" ], "title": "ContractsContractIdPatchResponsesContentApplicationJsonSchemaWorkScheduleEmploymentType", "type": "string" }, "ContractsContractIdPatchResponsesContentApplicationJsonSchemaWorkScheduleWorkerTypesItems": { "enum": [ "SALARIED_DIRECT_EMPLOYEE_PAYROLL", "SALARIED_HRIS_DIRECT_EMPLOYEE", "SALARIED_EOR_EMPLOYEE", "HOURLY_EOR_EMPLOYEE", "HOURLY_DIRECT_EMPLOYEE_PAYROLL" ], "title": "ContractsContractIdPatchResponsesContentApplicationJsonSchemaWorkScheduleWorkerTypesItems", "type": "string" }, "ContractsContractIdPatchResponsesContentApplicationJsonSchemaWorker": { "description": "Worker details associated with the contract.", "properties": { "alternate_email": { "description": "List of alternate email addresses.", "items": { "$ref": "#/components/schemas/ContractsContractIdPatchResponsesContentApplicationJsonSchemaWorkerAlternateEmailItems" }, "type": [ "array", "null" ] }, "country": { "description": "Country of the worker.", "type": [ "string", "null" ] }, "date_of_birth": { "$ref": "#/components/schemas/ContractsContractIdPatchResponsesContentApplicationJsonSchemaWorkerDateOfBirth", "description": "Date of birth of the worker. Supports full date-time, date-only, or an empty string." }, "email": { "description": "User's email address.", "format": "email", "minLength": 5, "type": [ "string", "null" ] }, "expected_email": { "description": "Expected email address of the worker (e.g., invitation target email).", "type": "string" }, "first_name": { "description": "First name of the worker.", "type": "string" }, "full_name": { "description": "Full name of the client.", "type": "string" }, "id": { "description": "Unique identifier of this resource.", "type": "string" }, "last_name": { "description": "Last name of the worker.", "type": "string" }, "nationality": { "description": "Nationality of the worker.", "type": [ "string", "null" ] } }, "title": "ContractsContractIdPatchResponsesContentApplicationJsonSchemaWorker", "type": "object" }, "ContractsContractIdPatchResponsesContentApplicationJsonSchemaWorkerAlternateEmailItems": { "properties": { "email": { "description": "Email address of the worker.", "type": "string" }, "isVerified": { "description": "Indicates whether this alternate email address has been verified.", "type": "boolean" } }, "title": "ContractsContractIdPatchResponsesContentApplicationJsonSchemaWorkerAlternateEmailItems", "type": "object" }, "ContractsContractIdPatchResponsesContentApplicationJsonSchemaWorkerDateOfBirth": { "description": "Date of birth of the worker. Supports full date-time, date-only, or an empty string.", "oneOf": [ { "format": "date-time", "type": "string" }, { "format": "date", "type": "string" }, { "$ref": "#/components/schemas/ContractsContractIdPatchResponsesContentApplicationJsonSchemaWorkerDateOfBirth2" } ], "title": "ContractsContractIdPatchResponsesContentApplicationJsonSchemaWorkerDateOfBirth" }, "ContractsContractIdPatchResponsesContentApplicationJsonSchemaWorkerDateOfBirth2": { "description": "Empty string for unknown/unset values.", "enum": [ "" ], "title": "ContractsContractIdPatchResponsesContentApplicationJsonSchemaWorkerDateOfBirth2", "type": "string" }, "ContractsContractIdPaymentCyclesGetResponsesContentApplicationJsonSchemaDataItems": { "properties": { "due_date": { "description": "The date and time when the payment is due.", "format": "date-time", "type": "string" }, "id": { "description": "Unique identifier for the payment.", "format": "uuid", "type": "string" }, "status": { "$ref": "#/components/schemas/ContractsContractIdPaymentCyclesGetResponsesContentApplicationJsonSchemaDataItemsStatus", "description": "The current status of the payment cycle." } }, "required": [ "id", "status", "due_date" ], "title": "ContractsContractIdPaymentCyclesGetResponsesContentApplicationJsonSchemaDataItems", "type": "object" }, "ContractsContractIdPaymentCyclesGetResponsesContentApplicationJsonSchemaDataItemsStatus": { "description": "The current status of the payment cycle.", "enum": [ "active", "upcoming", "awaiting_payment", "overdue", "awaiting_invoice_submission", "completed" ], "title": "ContractsContractIdPaymentCyclesGetResponsesContentApplicationJsonSchemaDataItemsStatus", "type": "string" }, "ContractsContractIdPlatformPaymentPatchRequestBodyContentApplicationJsonSchemaData": { "properties": { "platform_payment_type": { "$ref": "#/components/schemas/ContractsContractIdPlatformPaymentPatchRequestBodyContentApplicationJsonSchemaDataPlatformPaymentType", "description": "Whether the contract is paid through Deel (`STANDARD`) or outside Deel (`OFF_PLATFORM`). Applies to IC contracts only." }, "platform_payment_type_application_type": { "$ref": "#/components/schemas/ContractsContractIdPlatformPaymentPatchRequestBodyContentApplicationJsonSchemaDataPlatformPaymentTypeApplicationType", "description": "When to apply the change. Required when changing `platform_payment_type` on a signed contract." } }, "required": [ "platform_payment_type" ], "title": "ContractsContractIdPlatformPaymentPatchRequestBodyContentApplicationJsonSchemaData", "type": "object" }, "ContractsContractIdPlatformPaymentPatchRequestBodyContentApplicationJsonSchemaDataPlatformPaymentType": { "description": "Whether the contract is paid through Deel (`STANDARD`) or outside Deel (`OFF_PLATFORM`). Applies to IC contracts only.", "enum": [ "STANDARD", "OFF_PLATFORM" ], "title": "ContractsContractIdPlatformPaymentPatchRequestBodyContentApplicationJsonSchemaDataPlatformPaymentType", "type": "string" }, "ContractsContractIdPlatformPaymentPatchRequestBodyContentApplicationJsonSchemaDataPlatformPaymentTypeApplicationType": { "description": "When to apply the change. Required when changing `platform_payment_type` on a signed contract.", "enum": [ "IMMEDIATELY", "NEXT_PAYMENT_CYCLE" ], "title": "ContractsContractIdPlatformPaymentPatchRequestBodyContentApplicationJsonSchemaDataPlatformPaymentTypeApplicationType", "type": "string" }, "ContractsContractIdPlatformPaymentPatchResponsesContentApplicationJsonSchemaData": { "description": "The updated contract. See `GET /contracts/{contract_id}` for the full response shape.", "properties": { "id": { "description": "Unique identifier for the contract.", "type": "string" }, "platform_payment_type": { "$ref": "#/components/schemas/ContractsContractIdPlatformPaymentPatchResponsesContentApplicationJsonSchemaDataPlatformPaymentType", "description": "Whether the contract is paid through Deel (`STANDARD`) or outside Deel (`OFF_PLATFORM`)." } }, "title": "ContractsContractIdPlatformPaymentPatchResponsesContentApplicationJsonSchemaData", "type": "object" }, "ContractsContractIdPlatformPaymentPatchResponsesContentApplicationJsonSchemaDataPlatformPaymentType": { "description": "Whether the contract is paid through Deel (`STANDARD`) or outside Deel (`OFF_PLATFORM`).", "enum": [ "STANDARD", "OFF_PLATFORM" ], "title": "ContractsContractIdPlatformPaymentPatchResponsesContentApplicationJsonSchemaDataPlatformPaymentType", "type": "string" }, "ContractsContractIdPlatformPaymentPatchResponsesContentApplicationJsonSchemaErrorsItems": { "properties": { "code": { "description": "Machine-readable error code", "type": "string" }, "message": { "description": "Human-readable explanation of the error", "type": "string" } }, "title": "ContractsContractIdPlatformPaymentPatchResponsesContentApplicationJsonSchemaErrorsItems", "type": "object" }, "ContractsContractIdSignaturesPostRequestBodyContentApplicationJsonSchemaData": { "properties": { "client_signature": { "description": "Signature of client.", "minLength": 2, "type": "string" }, "contract_template_id": { "$ref": "#/components/schemas/ContractsContractIdSignaturesPostRequestBodyContentApplicationJsonSchemaDataContractTemplateId", "description": "Please use null to use default Deel contract template; otherwise you can use the template you created and customized. If template ID is not in payload, template stays unchanged." } }, "required": [ "client_signature" ], "title": "ContractsContractIdSignaturesPostRequestBodyContentApplicationJsonSchemaData", "type": "object" }, "ContractsContractIdSignaturesPostRequestBodyContentApplicationJsonSchemaDataContractTemplateId": { "description": "Please use null to use default Deel contract template; otherwise you can use the template you created and customized. If template ID is not in payload, template stays unchanged.", "oneOf": [ { "format": "double", "type": "number" }, { "type": "string" } ], "title": "ContractsContractIdSignaturesPostRequestBodyContentApplicationJsonSchemaDataContractTemplateId" }, "ContractsContractIdSignaturesPostResponsesContentApplicationJsonSchemaData": { "properties": { "created": { "type": "boolean" } }, "required": [ "created" ], "title": "ContractsContractIdSignaturesPostResponsesContentApplicationJsonSchemaData", "type": "object" }, "ContractsContractIdTasksGetResponsesContentApplicationJsonSchemaDataItems": { "properties": { "amount": { "description": "The monetary amount associated with the task.", "type": "string" }, "attachment": { "$ref": "#/components/schemas/ContractsContractIdTasksGetResponsesContentApplicationJsonSchemaDataItemsAttachment" }, "date_submitted": { "description": "(Required) The date when the task was submitted.", "type": "string" }, "description": { "description": "(Required) A brief description of the task.", "type": "string" }, "id": { "description": "The unique identifier for the task.", "minLength": 1, "type": "string" }, "status": { "description": "The current status of the task.", "oneOf": [ { "$ref": "#/components/schemas/ContractsContractIdTasksGetResponsesContentApplicationJsonSchemaDataItemsStatus" }, { "type": "null" } ] } }, "required": [ "id", "amount", "status", "description", "date_submitted" ], "title": "ContractsContractIdTasksGetResponsesContentApplicationJsonSchemaDataItems", "type": "object" }, "ContractsContractIdTasksGetResponsesContentApplicationJsonSchemaDataItemsAttachment": { "properties": { "filename": { "description": "(Optional) The name of the file attached to the task.", "type": [ "string", "null" ] }, "key": { "description": "(Optional) The key for accessing the attachment.", "type": [ "string", "null" ] } }, "title": "ContractsContractIdTasksGetResponsesContentApplicationJsonSchemaDataItemsAttachment", "type": "object" }, "ContractsContractIdTasksGetResponsesContentApplicationJsonSchemaDataItemsStatus": { "description": "The current status of the task.", "enum": [ "approved", "declined", "not_payable", "paid", "pending", "processing" ], "title": "ContractsContractIdTasksGetResponsesContentApplicationJsonSchemaDataItemsStatus", "type": "string" }, "ContractsContractIdTasksManyReviewsPostRequestBodyContentApplicationJsonSchemaData": { "properties": { "ids": { "description": "An array of task IDs to review. A maximum of 1000 task IDs is allowed per request.", "items": { "format": "uuid", "type": "string" }, "type": "array" }, "reason": { "description": "Optional reason for declining the tasks.", "type": [ "string", "null" ] }, "status": { "$ref": "#/components/schemas/ContractsContractIdTasksManyReviewsPostRequestBodyContentApplicationJsonSchemaDataStatus", "description": "The review status of the tasks. Possible values are 'approved' or 'declined'." } }, "required": [ "ids", "status" ], "title": "ContractsContractIdTasksManyReviewsPostRequestBodyContentApplicationJsonSchemaData", "type": "object" }, "ContractsContractIdTasksManyReviewsPostRequestBodyContentApplicationJsonSchemaDataStatus": { "description": "The review status of the tasks. Possible values are 'approved' or 'declined'.", "enum": [ "approved", "declined" ], "title": "ContractsContractIdTasksManyReviewsPostRequestBodyContentApplicationJsonSchemaDataStatus", "type": "string" }, "ContractsContractIdTasksManyReviewsPostResponsesContentApplicationJsonSchemaData": { "properties": { "created": { "description": "Indicating whether the task review was created", "type": "boolean" } }, "required": [ "created" ], "title": "ContractsContractIdTasksManyReviewsPostResponsesContentApplicationJsonSchemaData", "type": "object" }, "ContractsContractIdTasksPostRequestBodyContentApplicationJsonSchemaData": { "properties": { "amount": { "description": "The amount to be associated with the task, in the appropriate currency.", "type": "string" }, "date_submitted": { "$ref": "#/components/schemas/ContractsContractIdTasksPostRequestBodyContentApplicationJsonSchemaDataDateSubmitted", "description": "The date the task was submitted, in ISO 8601 format. Also accepts date-time (YYYY-MM-DDTHH:MM:SSZ)." }, "description": { "description": "A description of the task.", "type": [ "string", "null" ] }, "group_key": { "description": "When provided, tasks sharing the same group_key within the same payment cycle are merged into a single aggregated line item on the invoice. The group_key is used as the invoice line item description. Requires is_auto_approved to be true.", "maxLength": 300, "type": [ "string", "null" ] }, "hourly_report_preset_id": { "description": "Id of an existing TRACKING preset.", "format": "uuid", "type": [ "string", "null" ] }, "is_auto_approved": { "description": "If true, the task will be automatically approved as part of the request. Required to be true when group_key is provided.", "type": "boolean" } }, "required": [ "amount", "description", "date_submitted" ], "title": "ContractsContractIdTasksPostRequestBodyContentApplicationJsonSchemaData", "type": "object" }, "ContractsContractIdTasksPostRequestBodyContentApplicationJsonSchemaDataDateSubmitted": { "description": "The date the task was submitted, in ISO 8601 format. Also accepts date-time (YYYY-MM-DDTHH:MM:SSZ).", "oneOf": [ { "format": "date", "type": "string" }, { "format": "date-time", "type": "string" } ], "title": "ContractsContractIdTasksPostRequestBodyContentApplicationJsonSchemaDataDateSubmitted" }, "ContractsContractIdTasksPostResponsesContentApplicationJsonSchemaData": { "properties": { "created": { "description": "Indicates whether the task creation operation was successful.", "type": "boolean" }, "id": { "description": "The unique identifier for the created task.", "format": "uuid", "type": "string" }, "status": { "description": "The current status of the task.", "oneOf": [ { "$ref": "#/components/schemas/ContractsContractIdTasksPostResponsesContentApplicationJsonSchemaDataStatus" }, { "type": "null" } ] } }, "title": "ContractsContractIdTasksPostResponsesContentApplicationJsonSchemaData", "type": "object" }, "ContractsContractIdTasksPostResponsesContentApplicationJsonSchemaDataStatus": { "description": "The current status of the task.", "enum": [ "approved", "declined", "new", "not_payable", "paid", "pending", "processing" ], "title": "ContractsContractIdTasksPostResponsesContentApplicationJsonSchemaDataStatus", "type": "string" }, "ContractsContractIdTasksTaskIdDeleteResponsesContentApplicationJsonSchemaData": { "properties": { "deleted": { "description": "Indicates whether the task was successfully deleted.", "type": "boolean" } }, "required": [ "deleted" ], "title": "ContractsContractIdTasksTaskIdDeleteResponsesContentApplicationJsonSchemaData", "type": "object" }, "ContractsContractIdTasksTaskIdReviewsPostRequestBodyContentApplicationJsonSchemaData": { "properties": { "reason": { "description": "Optional reason for declining the task.", "type": [ "string", "null" ] }, "status": { "$ref": "#/components/schemas/ContractsContractIdTasksTaskIdReviewsPostRequestBodyContentApplicationJsonSchemaDataStatus", "description": "The review status of the task. Possible values are 'approved' or 'declined'." } }, "required": [ "status" ], "title": "ContractsContractIdTasksTaskIdReviewsPostRequestBodyContentApplicationJsonSchemaData", "type": "object" }, "ContractsContractIdTasksTaskIdReviewsPostRequestBodyContentApplicationJsonSchemaDataStatus": { "description": "The review status of the task. Possible values are 'approved' or 'declined'.", "enum": [ "approved", "declined" ], "title": "ContractsContractIdTasksTaskIdReviewsPostRequestBodyContentApplicationJsonSchemaDataStatus", "type": "string" }, "ContractsContractIdTasksTaskIdReviewsPostResponsesContentApplicationJsonSchemaData": { "properties": { "created": { "description": "Indicating whether the task review was created", "type": "boolean" } }, "required": [ "created" ], "title": "ContractsContractIdTasksTaskIdReviewsPostResponsesContentApplicationJsonSchemaData", "type": "object" }, "ContractsContractIdTerminationsDeleteResponsesContentApplicationJsonSchemaErrorsItems": { "properties": { "code": { "description": "Machine-readable error code", "type": "string" }, "message": { "description": "Human-readable explanation of the error", "type": "string" } }, "title": "ContractsContractIdTerminationsDeleteResponsesContentApplicationJsonSchemaErrorsItems", "type": "object" }, "ContractsContractIdTerminationsPostRequestBodyContentApplicationJsonSchemaData": { "description": "Termination data. At minimum, you must provide either terminate_now: true (for immediate termination) OR completion_date (for scheduled termination).", "properties": { "completion_date": { "description": "Contract completion date (YYYY-MM-DD). Required when terminate_now is false or not provided. Since terminate_now defaults to false, this field is required unless you explicitly set terminate_now to true.", "format": "date", "type": "string" }, "eligible_for_rehire": { "$ref": "#/components/schemas/ContractsContractIdTerminationsPostRequestBodyContentApplicationJsonSchemaDataEligibleForRehire", "description": "Indicates whether the contractor is eligible for rehire in the future." }, "eligible_for_rehire_reason": { "description": "Provides context when eligible_for_rehire is 'DONT_KNOW'. Should be empty or null for other values.", "maxLength": 255, "type": "string" }, "message": { "description": "Optional message to include with the termination", "maxLength": 1000, "type": "string" }, "terminate_now": { "default": false, "description": "If true, terminates the contract immediately. If false, completion_date is required.", "type": "boolean" }, "termination_reason_description": { "description": "Free-form text providing additional context about the termination reason. Can be provided independently without termination_reason_id, or used to add context to a selected reason.", "maxLength": 1000, "type": "string" }, "termination_reason_id": { "description": "The UUID of the termination reason. Use GET /contracts/termination-reasons to retrieve the list of available reasons.", "format": "uuid", "type": "string" }, "termination_type": { "$ref": "#/components/schemas/ContractsContractIdTerminationsPostRequestBodyContentApplicationJsonSchemaDataTerminationType", "description": "The type of termination. Specifies whether it is a resignation (contractor-initiated), termination (client-initiated), or end of contract (mutual/planned)." } }, "title": "ContractsContractIdTerminationsPostRequestBodyContentApplicationJsonSchemaData", "type": "object" }, "ContractsContractIdTerminationsPostRequestBodyContentApplicationJsonSchemaDataEligibleForRehire": { "description": "Indicates whether the contractor is eligible for rehire in the future.", "enum": [ "YES", "NO", "DONT_KNOW" ], "title": "ContractsContractIdTerminationsPostRequestBodyContentApplicationJsonSchemaDataEligibleForRehire", "type": "string" }, "ContractsContractIdTerminationsPostRequestBodyContentApplicationJsonSchemaDataTerminationType": { "description": "The type of termination. Specifies whether it is a resignation (contractor-initiated), termination (client-initiated), or end of contract (mutual/planned).", "enum": [ "RESIGNATION", "TERMINATION", "END_OF_CONTRACT" ], "title": "ContractsContractIdTerminationsPostRequestBodyContentApplicationJsonSchemaDataTerminationType", "type": "string" }, "ContractsContractIdTerminationsPostResponsesContentApplicationJsonSchemaData": { "properties": { "completion_date": { "description": "Contract completion date", "format": "date-time", "type": "string" }, "id": { "description": "Contract id", "type": "string" } }, "title": "ContractsContractIdTerminationsPostResponsesContentApplicationJsonSchemaData", "type": "object" }, "ContractsContractIdTerminationsPostResponsesContentApplicationJsonSchemaErrorsItems": { "properties": { "code": { "description": "Machine-readable error code", "type": "string" }, "message": { "description": "Human-readable explanation of the error", "type": "string" } }, "title": "ContractsContractIdTerminationsPostResponsesContentApplicationJsonSchemaErrorsItems", "type": "object" }, "ContractsContractIdTimesheetsGetParametersContractTypesSchemaItems": { "description": "Type of a contract", "enum": [ "ongoing_time_based", "milestones", "time_based", "pay_as_you_go_time_based", "commission", "payg_milestones", "payg_tasks", "eor", "unknown", "employee", "global_payroll", "shield_msa", "hris_direct_employee", "peo" ], "title": "ContractsContractIdTimesheetsGetParametersContractTypesSchemaItems", "type": "string" }, "ContractsContractIdTimesheetsGetParametersStatusesSchemaItems": { "description": "Current processing status of the timesheet.", "enum": [ "approved", "declined", "new", "not_payable", "paid", "pending", "processing" ], "title": "ContractsContractIdTimesheetsGetParametersStatusesSchemaItems", "type": "string" }, "ContractsContractIdTimesheetsGetResponsesContentApplicationJsonSchemaDataItems": { "properties": { "attachment": { "description": "This object is used for linking file attachments to your records.", "oneOf": [ { "$ref": "#/components/schemas/ContractsContractIdTimesheetsGetResponsesContentApplicationJsonSchemaDataItemsAttachment" }, { "type": "null" } ] }, "contract": { "$ref": "#/components/schemas/ContractsContractIdTimesheetsGetResponsesContentApplicationJsonSchemaDataItemsContract", "description": "Contract associated with this timesheet." }, "created_at": { "description": "Timestamp when the timesheet was created (ISO-8601).", "type": "string" }, "currency_code": { "description": "ISO 4217 currency code used for the amount.", "maxLength": 3, "minLength": 3, "pattern": "^[A-Z]{3}$", "type": [ "string", "null" ] }, "custom_scale": { "description": "Custom scale label defined by the client for non-standard billing rates.", "type": [ "string", "null" ] }, "date_submitted": { "description": "Timestamp when the timesheet was submitted for review (ISO-8601).", "format": "date-time", "type": [ "string", "null" ] }, "description": { "description": "Human-readable description of the work performed.", "type": "string" }, "hourly_report_preset": { "description": "Timesheet preset linked to this entry, if any.", "oneOf": [ { "$ref": "#/components/schemas/ContractsContractIdTimesheetsGetResponsesContentApplicationJsonSchemaDataItemsHourlyReportPreset" }, { "type": "null" } ] }, "id": { "description": "Unique identifier of this resource.", "format": "uuid", "type": "string" }, "payment_cycle": { "$ref": "#/components/schemas/ContractsContractIdTimesheetsGetResponsesContentApplicationJsonSchemaDataItemsPaymentCycle", "description": "Payment cycle associated with this timesheet." }, "quantity": { "description": "Quantity of work units (hours, days, etc.) used to calculate the total amount.", "format": "double", "type": [ "number", "null" ] }, "reported_by": { "$ref": "#/components/schemas/ContractsContractIdTimesheetsGetResponsesContentApplicationJsonSchemaDataItemsReportedBy", "description": "User who submitted the timesheet." }, "reviewed_by": { "description": "Reviewer information if the timesheet has been reviewed.", "oneOf": [ { "$ref": "#/components/schemas/ContractsContractIdTimesheetsGetResponsesContentApplicationJsonSchemaDataItemsReviewedBy" }, { "type": "null" } ] }, "scale": { "description": "Predefined scale used to calculate the timesheet amount (e.g. hourly, daily, custom).", "type": [ "string", "null" ] }, "status": { "description": "Current processing status of the timesheet.", "oneOf": [ { "$ref": "#/components/schemas/ContractsContractIdTimesheetsGetResponsesContentApplicationJsonSchemaDataItemsStatus" }, { "type": "null" } ] }, "total_amount": { "description": "Total monetary value equal to quantity times rate of active work statement plus any bonus.", "type": "string" }, "type": { "description": "Deprecated - it is always \"work\"", "type": "string" }, "worksheet": { "description": "Breakdown of time worked across different units.", "oneOf": [ { "$ref": "#/components/schemas/ContractsContractIdTimesheetsGetResponsesContentApplicationJsonSchemaDataItemsWorksheet" }, { "type": "null" } ] } }, "required": [ "id", "type", "status", "contract", "quantity", "worksheet", "created_at", "description", "reported_by", "total_amount", "currency_code", "date_submitted" ], "title": "ContractsContractIdTimesheetsGetResponsesContentApplicationJsonSchemaDataItems", "type": "object" }, "ContractsContractIdTimesheetsGetResponsesContentApplicationJsonSchemaDataItemsAttachment": { "description": "This object is used for linking file attachments to your records.", "properties": { "filename": { "description": "Original filename you used to upload using attachments end-point.", "type": "string" }, "key": { "description": "You can call attachments end-point, get key and URL to upload your file.", "type": "string" } }, "required": [ "key", "filename" ], "title": "ContractsContractIdTimesheetsGetResponsesContentApplicationJsonSchemaDataItemsAttachment", "type": "object" }, "ContractsContractIdTimesheetsGetResponsesContentApplicationJsonSchemaDataItemsContract": { "description": "Contract associated with this timesheet.", "properties": { "id": { "description": "Unique identifier of the contract.", "type": "string" }, "title": { "description": "Human-readable title of the contract.", "type": "string" }, "type": { "$ref": "#/components/schemas/ContractsContractIdTimesheetsGetResponsesContentApplicationJsonSchemaDataItemsContractType", "description": "Type of a contract" } }, "required": [ "id", "type", "title" ], "title": "ContractsContractIdTimesheetsGetResponsesContentApplicationJsonSchemaDataItemsContract", "type": "object" }, "ContractsContractIdTimesheetsGetResponsesContentApplicationJsonSchemaDataItemsContractType": { "description": "Type of a contract", "enum": [ "ongoing_time_based", "milestones", "time_based", "pay_as_you_go_time_based", "commission", "payg_milestones", "payg_tasks", "eor", "unknown", "employee", "global_payroll", "shield_msa", "hris_direct_employee", "peo" ], "title": "ContractsContractIdTimesheetsGetResponsesContentApplicationJsonSchemaDataItemsContractType", "type": "string" }, "ContractsContractIdTimesheetsGetResponsesContentApplicationJsonSchemaDataItemsHourlyReportPreset": { "description": "Timesheet preset linked to this entry, if any.", "properties": { "description": { "description": "Description of the related timesheet preset.", "type": [ "string", "null" ] }, "id": { "description": "Unique identifier of the related timesheet preset.", "type": [ "string", "null" ] }, "rate": { "description": "Hourly rate of the related timesheet preset.", "format": "double", "type": [ "number", "null" ] }, "title": { "description": "Title of the related timesheet preset.", "type": [ "string", "null" ] } }, "title": "ContractsContractIdTimesheetsGetResponsesContentApplicationJsonSchemaDataItemsHourlyReportPreset", "type": "object" }, "ContractsContractIdTimesheetsGetResponsesContentApplicationJsonSchemaDataItemsPaymentCycle": { "description": "Payment cycle associated with this timesheet.", "properties": { "end_date": { "description": "End date of the payment cycle (ISO-8601).", "format": "date-time", "type": [ "string", "null" ] }, "start_date": { "description": "Start date of the payment cycle (ISO-8601).", "format": "date-time", "type": [ "string", "null" ] } }, "title": "ContractsContractIdTimesheetsGetResponsesContentApplicationJsonSchemaDataItemsPaymentCycle", "type": "object" }, "ContractsContractIdTimesheetsGetResponsesContentApplicationJsonSchemaDataItemsReportedBy": { "description": "User who submitted the timesheet.", "properties": { "full_name": { "description": "Full name of the user who submitted the timesheet.", "type": "string" }, "id": { "description": "Unique identifier of the reporting user.", "format": "uuid", "type": "string" } }, "required": [ "id" ], "title": "ContractsContractIdTimesheetsGetResponsesContentApplicationJsonSchemaDataItemsReportedBy", "type": "object" }, "ContractsContractIdTimesheetsGetResponsesContentApplicationJsonSchemaDataItemsReviewedBy": { "description": "Reviewer information if the timesheet has been reviewed.", "properties": { "full_name": { "description": "Full name of the reviewer.", "type": "string" }, "id": { "description": "Unique identifier of the reviewer.", "format": "uuid", "type": "string" }, "remarks": { "description": "Reviewer remarks or decision notes.", "type": "string" }, "reviewed_at": { "description": "Timestamp when the review occurred (ISO-8601).", "type": "string" } }, "required": [ "id", "remarks", "reviewed_at" ], "title": "ContractsContractIdTimesheetsGetResponsesContentApplicationJsonSchemaDataItemsReviewedBy", "type": "object" }, "ContractsContractIdTimesheetsGetResponsesContentApplicationJsonSchemaDataItemsStatus": { "description": "Current processing status of the timesheet.", "enum": [ "approved", "declined", "new", "not_payable", "paid", "pending", "processing" ], "title": "ContractsContractIdTimesheetsGetResponsesContentApplicationJsonSchemaDataItemsStatus", "type": "string" }, "ContractsContractIdTimesheetsGetResponsesContentApplicationJsonSchemaDataItemsWorksheet": { "description": "Breakdown of time worked across different units.", "properties": { "days": { "description": "Number of days reported.", "format": "double", "minimum": 0, "type": "number" }, "hours": { "description": "Number of hours reported.", "format": "double", "minimum": 0, "type": "number" }, "minutes": { "description": "Number of minutes reported.", "format": "double", "minimum": 0, "type": "number" }, "weeks": { "description": "Number of weeks reported.", "format": "double", "minimum": 0, "type": "number" } }, "required": [ "days", "hours", "weeks", "minutes" ], "title": "ContractsContractIdTimesheetsGetResponsesContentApplicationJsonSchemaDataItemsWorksheet", "type": "object" }, "ContractsContractIdTimesheetsGetResponsesContentApplicationJsonSchemaErrorsItems": { "properties": { "code": { "description": "Machine-readable error code identifying the failure category.", "type": "string" }, "message": { "description": "Human-readable error message describing the unexpected condition.", "type": "string" } }, "required": [ "message" ], "title": "ContractsContractIdTimesheetsGetResponsesContentApplicationJsonSchemaErrorsItems", "type": "object" }, "ContractsContractIdTimesheetsGetResponsesContentApplicationJsonSchemaPage": { "description": "Pagination metadata for the response.", "properties": { "total_rows": { "description": "Total number of records available.", "format": "double", "type": "number" } }, "required": [ "total_rows" ], "title": "ContractsContractIdTimesheetsGetResponsesContentApplicationJsonSchemaPage", "type": "object" }, "ContractsContractIdTimesheetsPresetsGetResponsesContentApplicationJsonSchemaDataItems": { "properties": { "description": { "description": "Detailed description of the hourly report preset", "type": "string" }, "file": { "description": "File attached to this hourly report preset, if any.", "oneOf": [ { "$ref": "#/components/schemas/ContractsContractIdTimesheetsPresetsGetResponsesContentApplicationJsonSchemaDataItemsFile" }, { "type": "null" } ] }, "hourly_report_root_preset": { "$ref": "#/components/schemas/ContractsContractIdTimesheetsPresetsGetResponsesContentApplicationJsonSchemaDataItemsHourlyReportRootPreset", "description": "Root preset this hourly report preset is based on." }, "id": { "description": "The unique identifier of the hourly report preset", "format": "uuid", "type": "string" }, "rate": { "description": "The hourly rate for this preset", "format": "double", "type": "number" }, "title": { "description": "Title of the hourly report preset.", "type": "string" } }, "required": [ "id", "rate", "title", "description", "hourly_report_root_preset" ], "title": "ContractsContractIdTimesheetsPresetsGetResponsesContentApplicationJsonSchemaDataItems", "type": "object" }, "ContractsContractIdTimesheetsPresetsGetResponsesContentApplicationJsonSchemaDataItemsFile": { "description": "File attached to this hourly report preset, if any.", "properties": { "id": { "description": "The unique identifier of the file", "type": "string" }, "name": { "description": "The name of the file", "type": "string" }, "type": { "description": "The type of the file", "type": "string" } }, "title": "ContractsContractIdTimesheetsPresetsGetResponsesContentApplicationJsonSchemaDataItemsFile", "type": "object" }, "ContractsContractIdTimesheetsPresetsGetResponsesContentApplicationJsonSchemaDataItemsHourlyReportRootPreset": { "description": "Root preset this hourly report preset is based on.", "properties": { "description": { "description": "Detailed description of the root preset template", "type": [ "string", "null" ] }, "file": { "description": "File attached to this root preset, if any.", "oneOf": [ { "$ref": "#/components/schemas/ContractsContractIdTimesheetsPresetsGetResponsesContentApplicationJsonSchemaDataItemsHourlyReportRootPresetFile" }, { "type": "null" } ] }, "id": { "description": "The unique identifier of the root preset", "format": "uuid", "type": "string" }, "title": { "description": "The title of the root preset template", "type": "string" }, "type": { "$ref": "#/components/schemas/ContractsContractIdTimesheetsPresetsGetResponsesContentApplicationJsonSchemaDataItemsHourlyReportRootPresetType", "description": "The type of preset based on type of root preset" } }, "required": [ "id", "title", "description" ], "title": "ContractsContractIdTimesheetsPresetsGetResponsesContentApplicationJsonSchemaDataItemsHourlyReportRootPreset", "type": "object" }, "ContractsContractIdTimesheetsPresetsGetResponsesContentApplicationJsonSchemaDataItemsHourlyReportRootPresetFile": { "description": "File attached to this root preset, if any.", "properties": { "id": { "description": "The unique identifier of the file", "type": "string" }, "name": { "description": "The name of the file", "type": "string" }, "type": { "description": "The type of the file", "type": "string" } }, "title": "ContractsContractIdTimesheetsPresetsGetResponsesContentApplicationJsonSchemaDataItemsHourlyReportRootPresetFile", "type": "object" }, "ContractsContractIdTimesheetsPresetsGetResponsesContentApplicationJsonSchemaDataItemsHourlyReportRootPresetType": { "description": "The type of preset based on type of root preset", "enum": [ "RATE", "TRACKING" ], "title": "ContractsContractIdTimesheetsPresetsGetResponsesContentApplicationJsonSchemaDataItemsHourlyReportRootPresetType", "type": "string" }, "ContractsContractIdTimesheetsPresetsGetResponsesContentApplicationJsonSchemaErrorsItems": { "properties": { "code": { "description": "Machine-readable error code identifying the failure category.", "type": "string" }, "message": { "description": "Human-readable error message describing the unexpected condition.", "type": "string" } }, "required": [ "message" ], "title": "ContractsContractIdTimesheetsPresetsGetResponsesContentApplicationJsonSchemaErrorsItems", "type": "object" }, "ContractsContractIdTimesheetsPresetsGetResponsesContentApplicationJsonSchemaPage": { "description": "Pagination metadata for the response.", "properties": { "cursor": { "description": "Pagination cursor for fetching the next set of results", "type": "string" }, "total_rows": { "description": "Total number of rows available in the result set", "type": "integer" } }, "required": [ "cursor", "total_rows" ], "title": "ContractsContractIdTimesheetsPresetsGetResponsesContentApplicationJsonSchemaPage", "type": "object" }, "ContractsCustomFieldsGetResponsesContentApplicationJsonSchemaDataItems": { "properties": { "created_at": { "description": "Creation date of the custom field", "format": "date-time", "type": "string" }, "description": { "description": "Description of the custom field", "maxLength": 140, "type": [ "string", "null" ] }, "id": { "description": "Unique identifier of the custom field", "format": "uuid", "type": "string" }, "name": { "description": "Name of the custom field", "type": "string" }, "placement": { "description": "Valid placements for custom field", "oneOf": [ { "$ref": "#/components/schemas/ContractsCustomFieldsGetResponsesContentApplicationJsonSchemaDataItemsPlacement" }, { "type": "null" } ] }, "settings": { "$ref": "#/components/schemas/ContractsCustomFieldsGetResponsesContentApplicationJsonSchemaDataItemsSettings", "description": "Configuration settings for the custom field including requirements, visibility, and access controls" }, "type": { "$ref": "#/components/schemas/ContractsCustomFieldsGetResponsesContentApplicationJsonSchemaDataItemsType", "description": "Type configuration of the custom field including its data type and type-specific properties" } }, "required": [ "id", "name", "type", "settings", "created_at" ], "title": "ContractsCustomFieldsGetResponsesContentApplicationJsonSchemaDataItems", "type": "object" }, "ContractsCustomFieldsGetResponsesContentApplicationJsonSchemaDataItemsPlacement": { "description": "Valid placements for custom field", "enum": [ "profile", "contract" ], "title": "ContractsCustomFieldsGetResponsesContentApplicationJsonSchemaDataItemsPlacement", "type": "string" }, "ContractsCustomFieldsGetResponsesContentApplicationJsonSchemaDataItemsSettings": { "description": "Configuration settings for the custom field including requirements, visibility, and access controls", "properties": { "access": { "$ref": "#/components/schemas/ContractsCustomFieldsGetResponsesContentApplicationJsonSchemaDataItemsSettingsAccess", "description": "Access settings for the custom field" }, "countries": { "description": "Countries for which the custom field is applicable. Omitted when applicable to all.", "items": { "type": "string" }, "type": "array" }, "is_enabled": { "description": "Whether the custom field is enabled", "type": "boolean" }, "required": { "description": "Whether the custom field is required", "type": "boolean" }, "worker_types": { "description": "Worker types for which the custom field is applicable. Omitted when applicable to all.", "items": { "$ref": "#/components/schemas/ContractsCustomFieldsGetResponsesContentApplicationJsonSchemaDataItemsSettingsWorkerTypesItems" }, "type": "array" } }, "required": [ "access", "required", "is_enabled" ], "title": "ContractsCustomFieldsGetResponsesContentApplicationJsonSchemaDataItemsSettings", "type": "object" }, "ContractsCustomFieldsGetResponsesContentApplicationJsonSchemaDataItemsSettingsAccess": { "description": "Access settings for the custom field", "properties": { "group_permission_set": { "description": "Permission set identifier for the custom field", "type": [ "string", "null" ] }, "is_sensitive": { "description": "Whether the custom field is sensitive", "type": "boolean" }, "provided_by": { "description": "Entity providing access to the custom field", "oneOf": [ { "$ref": "#/components/schemas/ContractsCustomFieldsGetResponsesContentApplicationJsonSchemaDataItemsSettingsAccessProvidedBy" }, { "type": "null" } ] } }, "required": [ "is_sensitive" ], "title": "ContractsCustomFieldsGetResponsesContentApplicationJsonSchemaDataItemsSettingsAccess", "type": "object" }, "ContractsCustomFieldsGetResponsesContentApplicationJsonSchemaDataItemsSettingsAccessProvidedBy": { "description": "Entity providing access to the custom field", "enum": [ "organization", "worker" ], "title": "ContractsCustomFieldsGetResponsesContentApplicationJsonSchemaDataItemsSettingsAccessProvidedBy", "type": "string" }, "ContractsCustomFieldsGetResponsesContentApplicationJsonSchemaDataItemsSettingsWorkerTypesItems": { "enum": [ "eor", "contractor", "hris_direct_employee", "direct_employee" ], "title": "ContractsCustomFieldsGetResponsesContentApplicationJsonSchemaDataItemsSettingsWorkerTypesItems", "type": "string" }, "ContractsCustomFieldsGetResponsesContentApplicationJsonSchemaDataItemsType": { "description": "Type configuration of the custom field including its data type and type-specific properties", "oneOf": [ { "$ref": "#/components/schemas/ContractsCustomFieldsGetResponsesContentApplicationJsonSchemaDataItemsType0" }, { "$ref": "#/components/schemas/ContractsCustomFieldsGetResponsesContentApplicationJsonSchemaDataItemsType1" }, { "$ref": "#/components/schemas/ContractsCustomFieldsGetResponsesContentApplicationJsonSchemaDataItemsType2" } ], "title": "ContractsCustomFieldsGetResponsesContentApplicationJsonSchemaDataItemsType" }, "ContractsCustomFieldsGetResponsesContentApplicationJsonSchemaDataItemsType0": { "properties": { "name": { "$ref": "#/components/schemas/ContractsCustomFieldsGetResponsesContentApplicationJsonSchemaDataItemsTypeOneOf0Name", "description": "Simple types" } }, "required": [ "name" ], "title": "ContractsCustomFieldsGetResponsesContentApplicationJsonSchemaDataItemsType0", "type": "object" }, "ContractsCustomFieldsGetResponsesContentApplicationJsonSchemaDataItemsType1": { "properties": { "currency": { "description": "Currency code (null when is_fixed is false)", "maxLength": 3, "type": [ "string", "null" ] }, "is_fixed": { "description": "When currency is fixed, only the amount can be edited by the users", "type": "boolean" }, "name": { "$ref": "#/components/schemas/ContractsCustomFieldsGetResponsesContentApplicationJsonSchemaDataItemsTypeOneOf1Name", "description": "Currency type" } }, "required": [ "name", "is_fixed" ], "title": "ContractsCustomFieldsGetResponsesContentApplicationJsonSchemaDataItemsType1", "type": "object" }, "ContractsCustomFieldsGetResponsesContentApplicationJsonSchemaDataItemsType2": { "properties": { "name": { "$ref": "#/components/schemas/ContractsCustomFieldsGetResponsesContentApplicationJsonSchemaDataItemsTypeOneOf2Name", "description": "List types" }, "options": { "description": "List of options for the custom field", "items": { "type": "string" }, "type": "array" } }, "required": [ "name", "options" ], "title": "ContractsCustomFieldsGetResponsesContentApplicationJsonSchemaDataItemsType2", "type": "object" }, "ContractsCustomFieldsGetResponsesContentApplicationJsonSchemaDataItemsTypeOneOf0Name": { "description": "Simple types", "enum": [ "text", "number", "date", "percentage", "hyperlink" ], "title": "ContractsCustomFieldsGetResponsesContentApplicationJsonSchemaDataItemsTypeOneOf0Name", "type": "string" }, "ContractsCustomFieldsGetResponsesContentApplicationJsonSchemaDataItemsTypeOneOf1Name": { "description": "Currency type", "enum": [ "currency" ], "title": "ContractsCustomFieldsGetResponsesContentApplicationJsonSchemaDataItemsTypeOneOf1Name", "type": "string" }, "ContractsCustomFieldsGetResponsesContentApplicationJsonSchemaDataItemsTypeOneOf2Name": { "description": "List types", "enum": [ "list", "multiselect" ], "title": "ContractsCustomFieldsGetResponsesContentApplicationJsonSchemaDataItemsTypeOneOf2Name", "type": "string" }, "ContractsCustomFieldsGetResponsesContentApplicationJsonSchemaErrorsItems": { "properties": { "code": { "description": "Machine-readable error code", "type": "string" }, "message": { "description": "Human-readable explanation of the error", "type": "string" } }, "required": [ "code", "message" ], "title": "ContractsCustomFieldsGetResponsesContentApplicationJsonSchemaErrorsItems", "type": "object" }, "ContractsCustomFieldsIdGetResponsesContentApplicationJsonSchemaData": { "description": "Custom field object", "properties": { "created_at": { "description": "Creation timestamp", "format": "date-time", "type": "string" }, "description": { "description": "Optional description of the custom field", "type": [ "string", "null" ] }, "id": { "description": "Custom field id", "format": "uuid", "type": "string" }, "name": { "description": "Name of the custom field", "type": "string" }, "placement": { "$ref": "#/components/schemas/ContractsCustomFieldsIdGetResponsesContentApplicationJsonSchemaDataPlacement", "description": "Where the custom field is displayed" }, "settings": { "$ref": "#/components/schemas/ContractsCustomFieldsIdGetResponsesContentApplicationJsonSchemaDataSettings", "description": "Configuration settings for the custom field" }, "type": { "$ref": "#/components/schemas/ContractsCustomFieldsIdGetResponsesContentApplicationJsonSchemaDataType", "description": "Type definition of the custom field" } }, "title": "ContractsCustomFieldsIdGetResponsesContentApplicationJsonSchemaData", "type": "object" }, "ContractsCustomFieldsIdGetResponsesContentApplicationJsonSchemaDataPlacement": { "description": "Where the custom field is displayed", "enum": [ "profile", "contract" ], "title": "ContractsCustomFieldsIdGetResponsesContentApplicationJsonSchemaDataPlacement", "type": "string" }, "ContractsCustomFieldsIdGetResponsesContentApplicationJsonSchemaDataSettings": { "description": "Configuration settings for the custom field", "properties": { "access": { "$ref": "#/components/schemas/ContractsCustomFieldsIdGetResponsesContentApplicationJsonSchemaDataSettingsAccess", "description": "Access control settings" }, "countries": { "description": "Countries where the field applies", "items": { "type": "string" }, "type": "array" }, "is_enabled": { "description": "Whether the field is enabled", "type": "boolean" }, "required": { "description": "Whether the field is mandatory", "type": "boolean" }, "worker_types": { "description": "Applicable worker types", "items": { "$ref": "#/components/schemas/ContractsCustomFieldsIdGetResponsesContentApplicationJsonSchemaDataSettingsWorkerTypesItems" }, "type": "array" } }, "title": "ContractsCustomFieldsIdGetResponsesContentApplicationJsonSchemaDataSettings", "type": "object" }, "ContractsCustomFieldsIdGetResponsesContentApplicationJsonSchemaDataSettingsAccess": { "description": "Access control settings", "properties": { "is_sensitive": { "description": "Whether the field contains sensitive data", "type": "boolean" }, "provided_by": { "description": "Entity providing access", "oneOf": [ { "$ref": "#/components/schemas/ContractsCustomFieldsIdGetResponsesContentApplicationJsonSchemaDataSettingsAccessProvidedBy" }, { "type": "null" } ] } }, "title": "ContractsCustomFieldsIdGetResponsesContentApplicationJsonSchemaDataSettingsAccess", "type": "object" }, "ContractsCustomFieldsIdGetResponsesContentApplicationJsonSchemaDataSettingsAccessProvidedBy": { "description": "Entity providing access", "enum": [ "organization", "worker" ], "title": "ContractsCustomFieldsIdGetResponsesContentApplicationJsonSchemaDataSettingsAccessProvidedBy", "type": "string" }, "ContractsCustomFieldsIdGetResponsesContentApplicationJsonSchemaDataSettingsWorkerTypesItems": { "description": "Worker type", "enum": [ "eor", "contractor", "hris_direct_employee", "direct_employee" ], "title": "ContractsCustomFieldsIdGetResponsesContentApplicationJsonSchemaDataSettingsWorkerTypesItems", "type": "string" }, "ContractsCustomFieldsIdGetResponsesContentApplicationJsonSchemaDataType": { "description": "Type definition of the custom field", "oneOf": [ { "$ref": "#/components/schemas/ContractsCustomFieldsIdGetResponsesContentApplicationJsonSchemaDataType0" }, { "$ref": "#/components/schemas/ContractsCustomFieldsIdGetResponsesContentApplicationJsonSchemaDataType1" }, { "$ref": "#/components/schemas/ContractsCustomFieldsIdGetResponsesContentApplicationJsonSchemaDataType2" } ], "title": "ContractsCustomFieldsIdGetResponsesContentApplicationJsonSchemaDataType" }, "ContractsCustomFieldsIdGetResponsesContentApplicationJsonSchemaDataType0": { "description": "Simple custom field types", "properties": { "name": { "$ref": "#/components/schemas/ContractsCustomFieldsIdGetResponsesContentApplicationJsonSchemaDataTypeOneOf0Name", "description": "Simple field type" } }, "title": "ContractsCustomFieldsIdGetResponsesContentApplicationJsonSchemaDataType0", "type": "object" }, "ContractsCustomFieldsIdGetResponsesContentApplicationJsonSchemaDataType1": { "description": "Currency custom field type", "properties": { "currency": { "description": "ISO currency code", "type": "string" }, "is_fixed": { "description": "Whether the currency is fixed", "type": "boolean" }, "name": { "$ref": "#/components/schemas/ContractsCustomFieldsIdGetResponsesContentApplicationJsonSchemaDataTypeOneOf1Name", "description": "Currency field type" } }, "title": "ContractsCustomFieldsIdGetResponsesContentApplicationJsonSchemaDataType1", "type": "object" }, "ContractsCustomFieldsIdGetResponsesContentApplicationJsonSchemaDataType2": { "description": "List or multiselect custom field type", "properties": { "name": { "$ref": "#/components/schemas/ContractsCustomFieldsIdGetResponsesContentApplicationJsonSchemaDataTypeOneOf2Name", "description": "List field type" }, "options": { "description": "Available options for the list field", "items": { "type": "string" }, "type": "array" } }, "title": "ContractsCustomFieldsIdGetResponsesContentApplicationJsonSchemaDataType2", "type": "object" }, "ContractsCustomFieldsIdGetResponsesContentApplicationJsonSchemaDataTypeOneOf0Name": { "description": "Simple field type", "enum": [ "text", "number", "date", "percentage", "hyperlink" ], "title": "ContractsCustomFieldsIdGetResponsesContentApplicationJsonSchemaDataTypeOneOf0Name", "type": "string" }, "ContractsCustomFieldsIdGetResponsesContentApplicationJsonSchemaDataTypeOneOf1Name": { "description": "Currency field type", "enum": [ "currency" ], "title": "ContractsCustomFieldsIdGetResponsesContentApplicationJsonSchemaDataTypeOneOf1Name", "type": "string" }, "ContractsCustomFieldsIdGetResponsesContentApplicationJsonSchemaDataTypeOneOf2Name": { "description": "List field type", "enum": [ "list", "multiselect" ], "title": "ContractsCustomFieldsIdGetResponsesContentApplicationJsonSchemaDataTypeOneOf2Name", "type": "string" }, "ContractsCustomFieldsIdGetResponsesContentApplicationJsonSchemaError": { "properties": { "code": { "description": "Error code identifying the type of error.", "type": "string" }, "details": { "description": "Additional details about the error.", "type": [ "string", "null" ] }, "message": { "description": "Error message describing what went wrong.", "type": "string" } }, "required": [ "code", "message" ], "title": "ContractsCustomFieldsIdGetResponsesContentApplicationJsonSchemaError", "type": "object" }, "ContractsGetParametersExpandSchemaItems": { "description": "Additional fields to include in the response.", "enum": [ "cost_centers", "custom_fields" ], "title": "ContractsGetParametersExpandSchemaItems", "type": "string" }, "ContractsGetParametersLegalEntityId": { "oneOf": [ { "type": "string" }, { "items": { "type": "string" }, "type": "array" } ], "title": "ContractsGetParametersLegalEntityId" }, "ContractsGetParametersOrderDirection": { "enum": [ "asc", "desc" ], "title": "ContractsGetParametersOrderDirection", "type": "string" }, "ContractsGetParametersSortBy": { "enum": [ "contract_title", "worker_name" ], "title": "ContractsGetParametersSortBy", "type": "string" }, "ContractsGetParametersStatusesSchemaItems": { "description": "Status of a contract in Deel workflow.", "enum": [ "new", "under_review", "waiting_for_employee_contract", "waiting_for_client_sign", "processing_payment", "waiting_for_contractor_sign", "waiting_for_eor_sign", "waiting_for_employee_sign", "awaiting_deposit_payment", "in_progress", "completed", "cancelled", "user_cancelled", "rejected", "waiting_for_client_payment", "onboarding", "onboarded" ], "title": "ContractsGetParametersStatusesSchemaItems", "type": "string" }, "ContractsGetParametersTeamId": { "oneOf": [ { "type": "string" }, { "items": { "type": "string" }, "type": "array" } ], "title": "ContractsGetParametersTeamId" }, "ContractsGetParametersTypesSchemaItems": { "description": "Type of a contract.", "enum": [ "ongoing_time_based", "milestones", "time_based", "pay_as_you_go_time_based", "commission", "payg_milestones", "payg_tasks", "eor", "peo", "unknown", "employee", "global_payroll", "shield_msa", "hris_direct_employee", "contractor_outside_deel" ], "title": "ContractsGetParametersTypesSchemaItems", "type": "string" }, "ContractsGetResponsesContentApplicationJsonSchemaDataItems": { "properties": { "client": { "$ref": "#/components/schemas/ContractsGetResponsesContentApplicationJsonSchemaDataItemsClient", "description": "Client information associated with the contract." }, "cost_centers": { "description": "List of cost centers associated with the contract.", "items": { "$ref": "#/components/schemas/ContractsGetResponsesContentApplicationJsonSchemaDataItemsCostCentersItems" }, "type": "array" }, "created_at": { "description": "Timestamp when the contract was created, in ISO-8601 format.", "format": "date-time", "type": [ "string", "null" ] }, "custom_fields": { "description": "Contract-level custom fields. Only returned when `expand=custom_fields` is provided.", "items": { "$ref": "#/components/schemas/ContractsGetResponsesContentApplicationJsonSchemaDataItemsCustomFieldsItems" }, "type": [ "array", "null" ] }, "external_id": { "description": "A unique identifier for the object provided by an external system.", "type": [ "string", "null" ] }, "fte_percentage": { "description": "Full time percentage", "format": "double", "type": [ "number", "null" ] }, "id": { "description": "UUID of the contract.", "minLength": 1, "type": "string" }, "invitations": { "$ref": "#/components/schemas/ContractsGetResponsesContentApplicationJsonSchemaDataItemsInvitations", "description": "Details of invitations sent for signing the contract." }, "is_archived": { "description": "Indicates whether the contract is archived.", "type": "boolean" }, "is_shielded": { "description": "Indicates whether the contract is shielded.", "type": "boolean" }, "notice_period": { "default": 0, "description": "Number of days required to give notice before terminating the contract.", "format": "double", "minimum": 0, "type": "number" }, "scale": { "description": "The payment scale (e.g., hourly, weekly, monthly, etc.).", "type": [ "string", "null" ] }, "signatures": { "$ref": "#/components/schemas/ContractsGetResponsesContentApplicationJsonSchemaDataItemsSignatures", "description": "Signature information for the contract." }, "status": { "$ref": "#/components/schemas/ContractsGetResponsesContentApplicationJsonSchemaDataItemsStatus", "description": "Status of a contract in Deel workflow." }, "termination_date": { "description": "Date when the contract is terminated, in ISO-8601 format.", "format": "date-time", "type": [ "string", "null" ] }, "title": { "description": "Title of the contract.", "minLength": 1, "type": "string" }, "type": { "$ref": "#/components/schemas/ContractsGetResponsesContentApplicationJsonSchemaDataItemsType", "description": "Type of a contract." }, "who_reports": { "$ref": "#/components/schemas/ContractsGetResponsesContentApplicationJsonSchemaDataItemsWhoReports", "description": "Indicates who is responsible for providing regular reports." }, "worker": { "description": "Worker information associated with the contract.", "oneOf": [ { "$ref": "#/components/schemas/ContractsGetResponsesContentApplicationJsonSchemaDataItemsWorker" }, { "type": "null" } ] } }, "required": [ "id", "type", "title", "client", "status", "created_at", "signatures", "invitations", "is_archived", "is_shielded", "termination_date" ], "title": "ContractsGetResponsesContentApplicationJsonSchemaDataItems", "type": "object" }, "ContractsGetResponsesContentApplicationJsonSchemaDataItemsClient": { "description": "Client information associated with the contract.", "properties": { "legal_entity": { "description": "Legal entity information for the client.", "oneOf": [ { "$ref": "#/components/schemas/ContractsGetResponsesContentApplicationJsonSchemaDataItemsClientLegalEntity" }, { "type": "null" } ] }, "team": { "$ref": "#/components/schemas/ContractsGetResponsesContentApplicationJsonSchemaDataItemsClientTeam", "description": "Team information for the client." } }, "title": "ContractsGetResponsesContentApplicationJsonSchemaDataItemsClient", "type": "object" }, "ContractsGetResponsesContentApplicationJsonSchemaDataItemsClientLegalEntity": { "description": "Legal entity information for the client.", "properties": { "id": { "description": "Unique identifier of this resource.", "type": "string" }, "name": { "description": "Name of the legal entity.", "type": [ "string", "null" ] } }, "required": [ "id", "name" ], "title": "ContractsGetResponsesContentApplicationJsonSchemaDataItemsClientLegalEntity", "type": "object" }, "ContractsGetResponsesContentApplicationJsonSchemaDataItemsClientTeam": { "description": "Team information for the client.", "properties": { "id": { "description": "Unique identifier of this resource.", "type": "string" }, "name": { "description": "Name of a team.", "type": [ "string", "null" ] } }, "required": [ "id", "name" ], "title": "ContractsGetResponsesContentApplicationJsonSchemaDataItemsClientTeam", "type": "object" }, "ContractsGetResponsesContentApplicationJsonSchemaDataItemsCostCentersItems": { "description": "Cost center object.", "properties": { "allocation_percentage": { "description": "Percentage of the cost center allocation.", "format": "double", "type": "number" }, "name": { "description": "Cost center name.", "type": "string" }, "number": { "description": "Cost center number.", "type": "string" } }, "title": "ContractsGetResponsesContentApplicationJsonSchemaDataItemsCostCentersItems", "type": "object" }, "ContractsGetResponsesContentApplicationJsonSchemaDataItemsCustomFieldsItems": { "description": "Contract custom field object.", "properties": { "id": { "description": "Public identifier of the custom field.", "type": "string" }, "name": { "description": "Name of the custom field.", "type": "string" }, "value": { "description": "Value of the custom field for this contract.", "type": [ "string", "null" ] } }, "title": "ContractsGetResponsesContentApplicationJsonSchemaDataItemsCustomFieldsItems", "type": "object" }, "ContractsGetResponsesContentApplicationJsonSchemaDataItemsInvitations": { "description": "Details of invitations sent for signing the contract.", "properties": { "client_email": { "description": "Email address of the client to invite.", "type": [ "string", "null" ] }, "worker_email": { "description": "Email address of the worker to invite.", "type": [ "string", "null" ] } }, "title": "ContractsGetResponsesContentApplicationJsonSchemaDataItemsInvitations", "type": "object" }, "ContractsGetResponsesContentApplicationJsonSchemaDataItemsSignatures": { "description": "Signature information for the contract.", "properties": { "client_signed_at": { "description": "Timestamp when the client signed the contract, in ISO-8601 format.", "format": "date-time", "type": [ "string", "null" ] }, "worker_signature": { "description": "Worker's signature.", "type": [ "string", "null" ] }, "worker_signed_at": { "description": "Timestamp when the worker signed the contract, in ISO-8601 format.", "format": "date-time", "type": [ "string", "null" ] } }, "required": [ "client_signed_at", "worker_signature", "worker_signed_at" ], "title": "ContractsGetResponsesContentApplicationJsonSchemaDataItemsSignatures", "type": "object" }, "ContractsGetResponsesContentApplicationJsonSchemaDataItemsStatus": { "description": "Status of a contract in Deel workflow.", "enum": [ "new", "under_review", "waiting_for_approval", "waiting_for_employee_contract", "waiting_for_client_sign", "processing_payment", "waiting_for_contractor_sign", "waiting_for_eor_sign", "waiting_for_employee_sign", "waiting_for_hris_employee_sign", "awaiting_deposit_payment", "in_progress", "completed", "cancelled", "user_cancelled", "rejected", "waiting_for_client_payment", "onboarding", "onboarded" ], "title": "ContractsGetResponsesContentApplicationJsonSchemaDataItemsStatus", "type": "string" }, "ContractsGetResponsesContentApplicationJsonSchemaDataItemsType": { "description": "Type of a contract.", "enum": [ "ongoing_time_based", "milestones", "time_based", "pay_as_you_go_time_based", "commission", "payg_milestones", "payg_tasks", "eor", "unknown", "peo", "employee", "global_payroll", "shield_msa", "hris_direct_employee", "contractor_outside_deel" ], "title": "ContractsGetResponsesContentApplicationJsonSchemaDataItemsType", "type": "string" }, "ContractsGetResponsesContentApplicationJsonSchemaDataItemsWhoReports": { "description": "Indicates who is responsible for providing regular reports.", "enum": [ "both", "client", "contractor" ], "title": "ContractsGetResponsesContentApplicationJsonSchemaDataItemsWhoReports", "type": "string" }, "ContractsGetResponsesContentApplicationJsonSchemaDataItemsWorker": { "description": "Worker information associated with the contract.", "properties": { "alternate_email": { "description": "List of alternate email addresses.", "items": { "$ref": "#/components/schemas/ContractsGetResponsesContentApplicationJsonSchemaDataItemsWorkerAlternateEmailItems" }, "type": "array" }, "email": { "description": "User's email address.", "minLength": 5, "type": [ "string", "null" ] }, "full_name": { "description": "Full name of the worker.", "minLength": 1, "type": "string" }, "id": { "description": "Unique identifier of this resource.", "type": "string" }, "image": { "description": "URL of the worker's profile image.", "format": "uri", "minLength": 5, "type": [ "string", "null" ] } }, "required": [ "id" ], "title": "ContractsGetResponsesContentApplicationJsonSchemaDataItemsWorker", "type": "object" }, "ContractsGetResponsesContentApplicationJsonSchemaDataItemsWorkerAlternateEmailItems": { "description": "Alternate email address object.", "properties": { "email": { "description": "User's email address.", "format": "email", "minLength": 5, "type": [ "string", "null" ] }, "isVerified": { "description": "Indicates whether the alternate email address is verified.", "type": "boolean" } }, "title": "ContractsGetResponsesContentApplicationJsonSchemaDataItemsWorkerAlternateEmailItems", "type": "object" }, "ContractsGetResponsesContentApplicationJsonSchemaErrorsItems": { "properties": { "message": { "description": "Error response", "type": "string" } }, "required": [ "message" ], "title": "ContractsGetResponsesContentApplicationJsonSchemaErrorsItems", "type": "object" }, "ContractsGetResponsesContentApplicationJsonSchemaPage": { "description": "Pagination information for the response.", "properties": { "cursor": { "description": "Cursor for paginated results.", "type": "string" }, "total_rows": { "description": "Total number of rows in the result set.", "format": "double", "type": "number" } }, "required": [ "cursor", "total_rows" ], "title": "ContractsGetResponsesContentApplicationJsonSchemaPage", "type": "object" }, "ContractsGetResponsesContentApplicationJsonSchemaRequest": { "description": "Error request details", "properties": { "method": { "description": "Method of the API", "type": "string" }, "status": { "description": "Status of API response", "format": "double", "type": "number" } }, "title": "ContractsGetResponsesContentApplicationJsonSchemaRequest", "type": "object" }, "ContractsGpPostRequestBodyContentApplicationJsonSchemaData": { "properties": { "client": { "$ref": "#/components/schemas/ContractsGpPostRequestBodyContentApplicationJsonSchemaDataClient" }, "compensation_details": { "$ref": "#/components/schemas/ContractsGpPostRequestBodyContentApplicationJsonSchemaDataCompensationDetails" }, "employee": { "$ref": "#/components/schemas/ContractsGpPostRequestBodyContentApplicationJsonSchemaDataEmployee" }, "employment": { "$ref": "#/components/schemas/ContractsGpPostRequestBodyContentApplicationJsonSchemaDataEmployment" }, "invite_employee_to_app": { "description": "When true, the employee will receive an invitation to join the platform for onboarding.", "type": "boolean" }, "job_title": { "description": "Employee's official job title as stated in the employment agreement.", "type": "string" }, "work_location": { "$ref": "#/components/schemas/ContractsGpPostRequestBodyContentApplicationJsonSchemaDataWorkLocation", "description": "Work location details for the employee. Required for US legal entities." } }, "required": [ "client", "employee", "job_title", "employment", "compensation_details" ], "title": "ContractsGpPostRequestBodyContentApplicationJsonSchemaData", "type": "object" }, "ContractsGpPostRequestBodyContentApplicationJsonSchemaDataClient": { "properties": { "legal_entity": { "$ref": "#/components/schemas/ContractsGpPostRequestBodyContentApplicationJsonSchemaDataClientLegalEntity" }, "team": { "$ref": "#/components/schemas/ContractsGpPostRequestBodyContentApplicationJsonSchemaDataClientTeam" } }, "required": [ "team", "legal_entity" ], "title": "ContractsGpPostRequestBodyContentApplicationJsonSchemaDataClient", "type": "object" }, "ContractsGpPostRequestBodyContentApplicationJsonSchemaDataClientLegalEntity": { "properties": { "id": { "description": "Unique identifier of the legal entity.", "format": "uuid", "type": "string" } }, "required": [ "id" ], "title": "ContractsGpPostRequestBodyContentApplicationJsonSchemaDataClientLegalEntity", "type": "object" }, "ContractsGpPostRequestBodyContentApplicationJsonSchemaDataClientTeam": { "properties": { "id": { "description": "Refers to Groups in the platform. Working groups that reflect the organization's structure.", "format": "uuid", "type": "string" } }, "required": [ "id" ], "title": "ContractsGpPostRequestBodyContentApplicationJsonSchemaDataClientTeam", "type": "object" }, "ContractsGpPostRequestBodyContentApplicationJsonSchemaDataCompensationDetails": { "properties": { "currency": { "description": "Three-letter ISO 4217 currency code representing the salary currency.", "maxLength": 3, "minLength": 3, "pattern": "^[A-Z]{3}$", "type": "string" }, "salary": { "description": "Gross salary amount based on the selected scale.", "format": "double", "type": "number" }, "scale": { "$ref": "#/components/schemas/ContractsGpPostRequestBodyContentApplicationJsonSchemaDataCompensationDetailsScale", "description": "Defines whether the salary amount represents yearly or monthly gross compensation." } }, "required": [ "scale", "salary" ], "title": "ContractsGpPostRequestBodyContentApplicationJsonSchemaDataCompensationDetails", "type": "object" }, "ContractsGpPostRequestBodyContentApplicationJsonSchemaDataCompensationDetailsScale": { "default": "YEAR", "description": "Defines whether the salary amount represents yearly or monthly gross compensation.", "enum": [ "YEAR", "MONTH" ], "title": "ContractsGpPostRequestBodyContentApplicationJsonSchemaDataCompensationDetailsScale", "type": "string" }, "ContractsGpPostRequestBodyContentApplicationJsonSchemaDataEmployee": { "properties": { "address": { "$ref": "#/components/schemas/ContractsGpPostRequestBodyContentApplicationJsonSchemaDataEmployeeAddress" }, "email": { "description": "Employee's personal email address used for communication and onboarding.", "format": "email", "minLength": 5, "type": "string" }, "employee_number": { "description": "Internal employee identifier within the client organization.", "type": "string" }, "first_name": { "description": "Employee's first name.", "type": "string" }, "last_name": { "description": "Employee's last name.", "type": "string" }, "nationality": { "$ref": "#/components/schemas/ContractsGpPostRequestBodyContentApplicationJsonSchemaDataEmployeeNationality", "description": "Employee's nationality in ISO 3166-1 alpha-2 format." }, "work_email": { "description": "Employee's company email address associated with the client organization.", "format": "email", "minLength": 5, "type": "string" } }, "required": [ "email", "address", "last_name", "first_name", "work_email" ], "title": "ContractsGpPostRequestBodyContentApplicationJsonSchemaDataEmployee", "type": "object" }, "ContractsGpPostRequestBodyContentApplicationJsonSchemaDataEmployeeAddress": { "properties": { "city": { "description": "City of residence.", "type": "string" }, "country": { "$ref": "#/components/schemas/ContractsGpPostRequestBodyContentApplicationJsonSchemaDataEmployeeAddressCountry", "description": "ISO 3166-1 alpha-2 country code." }, "state": { "description": "State or province code.", "type": "string" }, "street": { "description": "Street name and building number.", "type": "string" }, "zip": { "description": "Postal or ZIP code.", "type": "string" } }, "required": [ "zip", "city", "street", "country" ], "title": "ContractsGpPostRequestBodyContentApplicationJsonSchemaDataEmployeeAddress", "type": "object" }, "ContractsGpPostRequestBodyContentApplicationJsonSchemaDataEmployeeAddressCountry": { "description": "ISO 3166-1 alpha-2 country code.", "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" ], "title": "ContractsGpPostRequestBodyContentApplicationJsonSchemaDataEmployeeAddressCountry", "type": "string" }, "ContractsGpPostRequestBodyContentApplicationJsonSchemaDataEmployeeNationality": { "description": "Employee's nationality in ISO 3166-1 alpha-2 format.", "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" ], "title": "ContractsGpPostRequestBodyContentApplicationJsonSchemaDataEmployeeNationality", "type": "string" }, "ContractsGpPostRequestBodyContentApplicationJsonSchemaDataEmployment": { "properties": { "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." }, "fte": { "default": 1, "description": "Full-time equivalent (FTE) percentage, expressed as a decimal between 0 and 1 with up to two decimal places (e.g. 1 = 100%, 0.5 = 50%). Required when `type` is `Part-time`; defaults to 1 (full-time) when omitted or null.", "format": "double", "maximum": 1, "minimum": 0, "type": [ "number", "null" ] }, "holidays": { "$ref": "#/components/schemas/ContractsGpPostRequestBodyContentApplicationJsonSchemaDataEmploymentHolidays" }, "start_date": { "description": "Employment start date in ISO-8601 format (YYYY-MM-DD).", "format": "date", "type": "string" }, "type": { "$ref": "#/components/schemas/ContractsGpPostRequestBodyContentApplicationJsonSchemaDataEmploymentType", "description": "Employment type indicating whether the employee works full-time or part-time." } }, "required": [ "type", "holidays", "start_date" ], "title": "ContractsGpPostRequestBodyContentApplicationJsonSchemaDataEmployment", "type": "object" }, "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.", "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" ], "title": "ContractsGpPostRequestBodyContentApplicationJsonSchemaDataEmploymentCountry", "type": "string" }, "ContractsGpPostRequestBodyContentApplicationJsonSchemaDataEmploymentHolidays": { "properties": { "allowance": { "description": "Number of paid holiday days allocated per year.", "format": "double", "type": "number" }, "start_date": { "description": "Date when the holiday entitlement becomes effective (ISO-8601 YYYY-MM-DD).", "format": "date", "type": "string" } }, "required": [ "allowance", "start_date" ], "title": "ContractsGpPostRequestBodyContentApplicationJsonSchemaDataEmploymentHolidays", "type": "object" }, "ContractsGpPostRequestBodyContentApplicationJsonSchemaDataEmploymentType": { "description": "Employment type indicating whether the employee works full-time or part-time.", "enum": [ "Full-time", "Part-time" ], "title": "ContractsGpPostRequestBodyContentApplicationJsonSchemaDataEmploymentType", "type": "string" }, "ContractsGpPostRequestBodyContentApplicationJsonSchemaDataWorkLocation": { "description": "Work location details for the employee. Required for US legal entities.", "properties": { "effective_date": { "description": "Date when the work location becomes effective (ISO-8601 YYYY-MM-DD).", "format": "date", "type": "string" }, "is_wfh": { "description": "Indicates whether the employee works remotely.", "type": "boolean" }, "name": { "description": "Name of the registered entity address where the employee works. Use 'Remote' if applicable.", "type": "string" } }, "required": [ "is_wfh" ], "title": "ContractsGpPostRequestBodyContentApplicationJsonSchemaDataWorkLocation", "type": "object" }, "ContractsGpPostResponsesContentApplicationJsonSchemaData": { "properties": { "client": { "$ref": "#/components/schemas/ContractsGpPostResponsesContentApplicationJsonSchemaDataClient" }, "compensation_details": { "$ref": "#/components/schemas/ContractsGpPostResponsesContentApplicationJsonSchemaDataCompensationDetails" }, "created_at": { "description": "Long date-time format following ISO-8601.", "format": "date-time", "type": [ "string", "null" ] }, "employee": { "$ref": "#/components/schemas/ContractsGpPostResponsesContentApplicationJsonSchemaDataEmployee" }, "employment": { "$ref": "#/components/schemas/ContractsGpPostResponsesContentApplicationJsonSchemaDataEmployment" }, "id": { "description": "Id of the contract created.", "type": "string" }, "job_title": { "description": "Employee's job title.", "type": "string" }, "status": { "$ref": "#/components/schemas/ContractsGpPostResponsesContentApplicationJsonSchemaDataStatus", "description": "Status of a contract in Deel workflow." }, "type": { "$ref": "#/components/schemas/ContractsGpPostResponsesContentApplicationJsonSchemaDataType", "description": "Type of a contract." } }, "title": "ContractsGpPostResponsesContentApplicationJsonSchemaData", "type": "object" }, "ContractsGpPostResponsesContentApplicationJsonSchemaDataClient": { "properties": { "legal_entity": { "$ref": "#/components/schemas/ContractsGpPostResponsesContentApplicationJsonSchemaDataClientLegalEntity" } }, "title": "ContractsGpPostResponsesContentApplicationJsonSchemaDataClient", "type": "object" }, "ContractsGpPostResponsesContentApplicationJsonSchemaDataClientLegalEntity": { "properties": { "name": { "description": "Legal entity name.", "type": "string" } }, "title": "ContractsGpPostResponsesContentApplicationJsonSchemaDataClientLegalEntity", "type": "object" }, "ContractsGpPostResponsesContentApplicationJsonSchemaDataCompensationDetails": { "properties": { "currency": { "description": "Currency of gross annual/month salary.", "type": "string" }, "salary": { "description": "Gross annual/month salary.", "format": "double", "type": "number" }, "scale": { "description": "Scale at which the salary is paid.", "type": "string" } }, "title": "ContractsGpPostResponsesContentApplicationJsonSchemaDataCompensationDetails", "type": "object" }, "ContractsGpPostResponsesContentApplicationJsonSchemaDataEmployee": { "properties": { "email": { "description": "Employee's email address.", "type": "string" }, "employee_number": { "description": "Employee's number.", "type": [ "string", "null" ] }, "first_name": { "description": "Employee's first name.", "type": "string" }, "last_name": { "description": "Employee's last name.", "type": "string" } }, "title": "ContractsGpPostResponsesContentApplicationJsonSchemaDataEmployee", "type": "object" }, "ContractsGpPostResponsesContentApplicationJsonSchemaDataEmployment": { "properties": { "country": { "description": "Country of employment.", "type": "string" }, "end_date": { "description": "Long date-time format following ISO-8601.", "format": "date-time", "type": [ "string", "null" ] }, "holidays": { "$ref": "#/components/schemas/ContractsGpPostResponsesContentApplicationJsonSchemaDataEmploymentHolidays" }, "start_date": { "description": "Long date-time format following ISO-8601.", "format": "date-time", "type": [ "string", "null" ] }, "state": { "description": "State code of the state/province where this person will be employed.", "type": [ "string", "null" ] }, "type": { "description": "Is it a full-time contract or a part-time contract?", "type": "string" }, "work_visa_required": { "description": "Do you require Deel to apply for a work visa for this person?", "type": "boolean" } }, "title": "ContractsGpPostResponsesContentApplicationJsonSchemaDataEmployment", "type": "object" }, "ContractsGpPostResponsesContentApplicationJsonSchemaDataEmploymentHolidays": { "properties": { "allowance": { "description": "Number of holidays.", "format": "double", "type": "number" }, "start_date": { "description": "Long date-time format following ISO-8601.", "format": "date-time", "type": [ "string", "null" ] } }, "title": "ContractsGpPostResponsesContentApplicationJsonSchemaDataEmploymentHolidays", "type": "object" }, "ContractsGpPostResponsesContentApplicationJsonSchemaDataStatus": { "description": "Status of a contract in Deel workflow.", "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" ], "title": "ContractsGpPostResponsesContentApplicationJsonSchemaDataStatus", "type": "string" }, "ContractsGpPostResponsesContentApplicationJsonSchemaDataType": { "description": "Type of a contract.", "enum": [ "ongoing_time_based", "milestones", "time_based", "pay_as_you_go_time_based", "commission", "payg_milestones", "payg_tasks", "eor", "unknown", "employee", "global_payroll", "shield_msa", "hris_direct_employee", "peo" ], "title": "ContractsGpPostResponsesContentApplicationJsonSchemaDataType", "type": "string" }, "ContractsGpPostResponsesContentApplicationJsonSchemaErrorsItems": { "properties": { "code": { "description": "Machine-readable error code", "type": "string" }, "message": { "description": "Human-readable explanation of the error", "type": "string" } }, "title": "ContractsGpPostResponsesContentApplicationJsonSchemaErrorsItems", "type": "object" }, "ContractsPostRequestBodyContentApplicationJsonSchemaData": { "oneOf": [ { "$ref": "#/components/schemas/ContractsPostRequestBodyContentApplicationJsonSchemaData0" }, { "$ref": "#/components/schemas/ContractsPostRequestBodyContentApplicationJsonSchemaData1" }, { "$ref": "#/components/schemas/ContractsPostRequestBodyContentApplicationJsonSchemaData2" }, { "$ref": "#/components/schemas/ContractsPostRequestBodyContentApplicationJsonSchemaData3" } ], "title": "ContractsPostRequestBodyContentApplicationJsonSchemaData" }, "ContractsPostRequestBodyContentApplicationJsonSchemaData0": { "description": "Details of contract to create", "properties": { "citizenship": { "description": "ISO 3166-1 alpha-2 country code of the worker's citizenship.", "maxLength": 2, "minLength": 2, "pattern": "^[A-Z]{2}$", "type": [ "string", "null" ] }, "client": { "$ref": "#/components/schemas/ContractsPostRequestBodyContentApplicationJsonSchemaDataOneOf0Client", "description": "Client details for the contract, including the legal entity and team." }, "compensation_details": { "$ref": "#/components/schemas/ContractsPostRequestBodyContentApplicationJsonSchemaDataOneOf0CompensationDetails", "description": "Compensation and invoicing configuration for the contract." }, "contract_template_id": { "description": "Contract Template Id.", "type": [ "string", "null" ] }, "country_code": { "description": "Country code.", "maxLength": 2, "minLength": 2, "pattern": "^[A-Z]{2}$", "type": "string" }, "external_id": { "description": "External Id.", "type": [ "string", "null" ] }, "job_title": { "$ref": "#/components/schemas/ContractsPostRequestBodyContentApplicationJsonSchemaDataOneOf0JobTitle", "description": "Worker's job title. You can enter a custom job title or use a pre-defined job title using the Id retrieved in job-titles endpoint." }, "meta": { "$ref": "#/components/schemas/ContractsPostRequestBodyContentApplicationJsonSchemaDataOneOf0Meta", "description": "Additional custom info about a contract" }, "notice_period": { "default": 10, "description": "Days before to notice the termination of contract for either party.", "format": "double", "minimum": 0, "type": "number" }, "platform_payment_type": { "$ref": "#/components/schemas/ContractsPostRequestBodyContentApplicationJsonSchemaDataOneOf0PlatformPaymentType", "description": "Whether the contract is paid through Deel (`STANDARD`) or outside Deel (`OFF_PLATFORM`). Applies to IC contracts only." }, "scope_of_work": { "description": "Describe the work to be performed.", "type": [ "string", "null" ] }, "scope_of_work_id": { "description": "Existing scope of work public id", "format": "uuid", "type": [ "string", "null" ] }, "seniority": { "description": "Job seniority level. Please use the seniority levels endpoint to retrieve the list of seniority levels.", "oneOf": [ { "$ref": "#/components/schemas/ContractsPostRequestBodyContentApplicationJsonSchemaDataOneOf0Seniority" }, { "type": "null" } ] }, "special_clause": { "description": "Enter any special clause you may have.", "type": [ "string", "null" ] }, "start_date": { "description": "Short date in format ISO-8601 (YYYY-MM-DD). For example: 2022-12-31.", "format": "date", "pattern": "^\\d{4}-\\d{2}-\\d{2}$", "type": "string" }, "state_code": { "description": "The state or province code. Use country lookup endpoint to retrieve state codes.", "type": [ "string", "null" ] }, "termination_date": { "description": "Short date in format ISO-8601 (YYYY-MM-DD). For example: 2022-12-31.", "format": "date", "pattern": "^\\d{4}-\\d{2}-\\d{2}$", "type": [ "string", "null" ] }, "title": { "description": "The title of the contract.", "type": "string" }, "type": { "$ref": "#/components/schemas/ContractsPostRequestBodyContentApplicationJsonSchemaDataOneOf0Type", "description": "Type of contract" }, "who_reports": { "$ref": "#/components/schemas/ContractsPostRequestBodyContentApplicationJsonSchemaDataOneOf0WhoReports", "description": "Flag to indicate who is supposed to provide regular reports" }, "worker": { "description": "Worker properties", "oneOf": [ { "$ref": "#/components/schemas/ContractsPostRequestBodyContentApplicationJsonSchemaDataOneOf0Worker" }, { "type": "null" } ] } }, "required": [ "meta", "title", "client", "type", "start_date", "compensation_details" ], "title": "ContractsPostRequestBodyContentApplicationJsonSchemaData0", "type": "object" }, "ContractsPostRequestBodyContentApplicationJsonSchemaData1": { "description": "Details of contract to create", "properties": { "citizenship": { "description": "ISO 3166-1 alpha-2 country code of the worker's citizenship.", "maxLength": 2, "minLength": 2, "pattern": "^[A-Z]{2}$", "type": [ "string", "null" ] }, "client": { "$ref": "#/components/schemas/ContractsPostRequestBodyContentApplicationJsonSchemaDataOneOf1Client", "description": "Client details for the contract, including the legal entity and team." }, "compensation_details": { "$ref": "#/components/schemas/ContractsPostRequestBodyContentApplicationJsonSchemaDataOneOf1CompensationDetails", "description": "Compensation and invoicing configuration for the contract." }, "contract_template_id": { "description": "Contract Template Id.", "type": [ "string", "null" ] }, "country_code": { "description": "Country code.", "maxLength": 2, "minLength": 2, "pattern": "^[A-Z]{2}$", "type": "string" }, "external_id": { "description": "External Id.", "type": [ "string", "null" ] }, "job_title": { "$ref": "#/components/schemas/ContractsPostRequestBodyContentApplicationJsonSchemaDataOneOf1JobTitle", "description": "Worker's job title. You can enter a custom job title or use a pre-defined job title using the Id retrieved in job-titles endpoint." }, "meta": { "$ref": "#/components/schemas/ContractsPostRequestBodyContentApplicationJsonSchemaDataOneOf1Meta", "description": "Additional custom info about a contract" }, "notice_period": { "default": 10, "description": "Days before to notice the termination of contract for either party.", "format": "double", "minimum": 0, "type": "number" }, "scope_of_work": { "description": "Describe the work to be performed.", "type": [ "string", "null" ] }, "scope_of_work_id": { "description": "Existing scope of work public id", "format": "uuid", "type": [ "string", "null" ] }, "seniority": { "description": "Job seniority level. Please use the seniority levels endpoint to retrieve the list of seniority levels.", "oneOf": [ { "$ref": "#/components/schemas/ContractsPostRequestBodyContentApplicationJsonSchemaDataOneOf1Seniority" }, { "type": "null" } ] }, "special_clause": { "description": "Enter any special clause you may have.", "type": [ "string", "null" ] }, "start_date": { "description": "Short date in format ISO-8601 (YYYY-MM-DD). For example: 2022-12-31.", "format": "date", "pattern": "^\\d{4}-\\d{2}-\\d{2}$", "type": "string" }, "state_code": { "description": "The state or province code. Use country lookup endpoint to retrieve state codes.", "type": [ "string", "null" ] }, "termination_date": { "description": "Short date in format ISO-8601 (YYYY-MM-DD). For example: 2022-12-31.", "format": "date", "pattern": "^\\d{4}-\\d{2}-\\d{2}$", "type": [ "string", "null" ] }, "title": { "description": "The title of the contract.", "type": "string" }, "type": { "$ref": "#/components/schemas/ContractsPostRequestBodyContentApplicationJsonSchemaDataOneOf1Type", "description": "Type of contract" }, "who_reports": { "$ref": "#/components/schemas/ContractsPostRequestBodyContentApplicationJsonSchemaDataOneOf1WhoReports", "description": "Flag to indicate who is supposed to provide regular reports" }, "worker": { "description": "Worker properties", "oneOf": [ { "$ref": "#/components/schemas/ContractsPostRequestBodyContentApplicationJsonSchemaDataOneOf1Worker" }, { "type": "null" } ] } }, "required": [ "meta", "title", "client", "type", "start_date", "compensation_details" ], "title": "ContractsPostRequestBodyContentApplicationJsonSchemaData1", "type": "object" }, "ContractsPostRequestBodyContentApplicationJsonSchemaData2": { "description": "Details of contract to create", "properties": { "citizenship": { "description": "ISO 3166-1 alpha-2 country code of the worker's citizenship.", "maxLength": 2, "minLength": 2, "pattern": "^[A-Z]{2}$", "type": [ "string", "null" ] }, "client": { "$ref": "#/components/schemas/ContractsPostRequestBodyContentApplicationJsonSchemaDataOneOf2Client", "description": "Client details for the contract, including the legal entity and team." }, "compensation_details": { "$ref": "#/components/schemas/ContractsPostRequestBodyContentApplicationJsonSchemaDataOneOf2CompensationDetails", "description": "Compensation and invoicing configuration for the contract." }, "contract_template_id": { "description": "Contract Template Id.", "type": [ "string", "null" ] }, "country_code": { "description": "Country code.", "maxLength": 2, "minLength": 2, "pattern": "^[A-Z]{2}$", "type": "string" }, "external_id": { "description": "External Id.", "type": [ "string", "null" ] }, "job_title": { "$ref": "#/components/schemas/ContractsPostRequestBodyContentApplicationJsonSchemaDataOneOf2JobTitle", "description": "Worker's job title. You can enter a custom job title or use a pre-defined job title using the Id retrieved in job-titles endpoint." }, "meta": { "$ref": "#/components/schemas/ContractsPostRequestBodyContentApplicationJsonSchemaDataOneOf2Meta", "description": "Additional custom info about a contract" }, "notice_period": { "default": 10, "description": "Days before to notice the termination of contract for either party.", "format": "double", "minimum": 0, "type": "number" }, "scope_of_work": { "description": "Describe the work to be performed.", "type": [ "string", "null" ] }, "scope_of_work_id": { "description": "Existing scope of work public id", "format": "uuid", "type": [ "string", "null" ] }, "seniority": { "description": "Job seniority level. Please use the seniority levels endpoint to retrieve the list of seniority levels.", "oneOf": [ { "$ref": "#/components/schemas/ContractsPostRequestBodyContentApplicationJsonSchemaDataOneOf2Seniority" }, { "type": "null" } ] }, "special_clause": { "description": "Enter any special clause you may have.", "type": [ "string", "null" ] }, "start_date": { "description": "Short date in format ISO-8601 (YYYY-MM-DD). For example: 2022-12-31.", "format": "date", "pattern": "^\\d{4}-\\d{2}-\\d{2}$", "type": [ "string", "null" ] }, "state_code": { "description": "The state or province code. Use country lookup endpoint to retrieve state codes.", "type": [ "string", "null" ] }, "termination_date": { "description": "Short date in format ISO-8601 (YYYY-MM-DD). For example: 2022-12-31.", "format": "date", "pattern": "^\\d{4}-\\d{2}-\\d{2}$", "type": [ "string", "null" ] }, "title": { "description": "The title of the contract.", "type": "string" }, "type": { "$ref": "#/components/schemas/ContractsPostRequestBodyContentApplicationJsonSchemaDataOneOf2Type", "description": "Type of contract" }, "who_reports": { "$ref": "#/components/schemas/ContractsPostRequestBodyContentApplicationJsonSchemaDataOneOf2WhoReports", "description": "Flag to indicate who is supposed to provide regular reports" }, "worker": { "description": "Worker properties", "oneOf": [ { "$ref": "#/components/schemas/ContractsPostRequestBodyContentApplicationJsonSchemaDataOneOf2Worker" }, { "type": "null" } ] } }, "required": [ "meta", "title", "client", "type", "compensation_details" ], "title": "ContractsPostRequestBodyContentApplicationJsonSchemaData2", "type": "object" }, "ContractsPostRequestBodyContentApplicationJsonSchemaData3": { "description": "Details of contract to create", "properties": { "citizenship": { "description": "ISO 3166-1 alpha-2 country code of the worker's citizenship.", "maxLength": 2, "minLength": 2, "pattern": "^[A-Z]{2}$", "type": [ "string", "null" ] }, "client": { "$ref": "#/components/schemas/ContractsPostRequestBodyContentApplicationJsonSchemaDataOneOf3Client", "description": "Client details for the contract, including the legal entity and team." }, "compensation_details": { "$ref": "#/components/schemas/ContractsPostRequestBodyContentApplicationJsonSchemaDataOneOf3CompensationDetails", "description": "Compensation and invoicing configuration for the contract." }, "contract_template_id": { "description": "Contract Template Id.", "type": [ "string", "null" ] }, "country_code": { "description": "Country code.", "maxLength": 2, "minLength": 2, "pattern": "^[A-Z]{2}$", "type": "string" }, "external_id": { "description": "External Id.", "type": [ "string", "null" ] }, "job_title": { "$ref": "#/components/schemas/ContractsPostRequestBodyContentApplicationJsonSchemaDataOneOf3JobTitle", "description": "Worker's job title. You can enter a custom job title or use a pre-defined job title using the Id retrieved in job-titles endpoint." }, "meta": { "$ref": "#/components/schemas/ContractsPostRequestBodyContentApplicationJsonSchemaDataOneOf3Meta", "description": "Additional custom info about a contract" }, "notice_period": { "default": 10, "description": "Days before to notice the termination of contract for either party.", "format": "double", "minimum": 0, "type": "number" }, "scope_of_work": { "description": "Describe the work to be performed.", "type": [ "string", "null" ] }, "scope_of_work_id": { "description": "Existing scope of work public id", "format": "uuid", "type": [ "string", "null" ] }, "seniority": { "description": "Job seniority level. Please use the seniority levels endpoint to retrieve the list of seniority levels.", "oneOf": [ { "$ref": "#/components/schemas/ContractsPostRequestBodyContentApplicationJsonSchemaDataOneOf3Seniority" }, { "type": "null" } ] }, "special_clause": { "description": "Enter any special clause you may have.", "type": [ "string", "null" ] }, "start_date": { "description": "Short date in format ISO-8601 (YYYY-MM-DD). For example: 2022-12-31.", "format": "date", "pattern": "^\\d{4}-\\d{2}-\\d{2}$", "type": "string" }, "state_code": { "description": "The state or province code. Use country lookup endpoint to retrieve state codes.", "type": [ "string", "null" ] }, "termination_date": { "description": "Short date in format ISO-8601 (YYYY-MM-DD). For example: 2022-12-31.", "format": "date", "pattern": "^\\d{4}-\\d{2}-\\d{2}$", "type": [ "string", "null" ] }, "title": { "description": "The title of the contract.", "type": "string" }, "type": { "$ref": "#/components/schemas/ContractsPostRequestBodyContentApplicationJsonSchemaDataOneOf3Type", "description": "Type of contract" }, "who_reports": { "$ref": "#/components/schemas/ContractsPostRequestBodyContentApplicationJsonSchemaDataOneOf3WhoReports", "description": "Flag to indicate who is supposed to provide regular reports" }, "worker": { "description": "Worker properties", "oneOf": [ { "$ref": "#/components/schemas/ContractsPostRequestBodyContentApplicationJsonSchemaDataOneOf3Worker" }, { "type": "null" } ] } }, "required": [ "meta", "title", "client", "type", "start_date", "compensation_details" ], "title": "ContractsPostRequestBodyContentApplicationJsonSchemaData3", "type": "object" }, "ContractsPostRequestBodyContentApplicationJsonSchemaDataOneOf0Client": { "description": "Client details for the contract, including the legal entity and team.", "properties": { "legal_entity": { "$ref": "#/components/schemas/ContractsPostRequestBodyContentApplicationJsonSchemaDataOneOf0ClientLegalEntity", "description": "Choose the Deel legal entity for this contract. Use legal entity endpoint to retrieve a list of legal entities in your organization." }, "team": { "$ref": "#/components/schemas/ContractsPostRequestBodyContentApplicationJsonSchemaDataOneOf0ClientTeam", "description": "Choose the Deel team for this contract. Use teams endpoint to retrieve a list of teams in your organization." } }, "required": [ "team", "legal_entity" ], "title": "ContractsPostRequestBodyContentApplicationJsonSchemaDataOneOf0Client", "type": "object" }, "ContractsPostRequestBodyContentApplicationJsonSchemaDataOneOf0ClientLegalEntity": { "description": "Choose the Deel legal entity for this contract. Use legal entity endpoint to retrieve a list of legal entities in your organization.", "properties": { "id": { "$ref": "#/components/schemas/ContractsPostRequestBodyContentApplicationJsonSchemaDataOneOf0ClientLegalEntityId", "description": "Unique identifier of this resource." } }, "required": [ "id" ], "title": "ContractsPostRequestBodyContentApplicationJsonSchemaDataOneOf0ClientLegalEntity", "type": "object" }, "ContractsPostRequestBodyContentApplicationJsonSchemaDataOneOf0ClientLegalEntityId": { "description": "Unique identifier of this resource.", "oneOf": [ { "type": "string" }, { "format": "double", "type": "number" } ], "title": "ContractsPostRequestBodyContentApplicationJsonSchemaDataOneOf0ClientLegalEntityId" }, "ContractsPostRequestBodyContentApplicationJsonSchemaDataOneOf0ClientTeam": { "description": "Choose the Deel team for this contract. Use teams endpoint to retrieve a list of teams in your organization.", "properties": { "id": { "$ref": "#/components/schemas/ContractsPostRequestBodyContentApplicationJsonSchemaDataOneOf0ClientTeamId", "description": "Unique identifier of this resource." } }, "required": [ "id" ], "title": "ContractsPostRequestBodyContentApplicationJsonSchemaDataOneOf0ClientTeam", "type": "object" }, "ContractsPostRequestBodyContentApplicationJsonSchemaDataOneOf0ClientTeamId": { "description": "Unique identifier of this resource.", "oneOf": [ { "type": "string" }, { "format": "double", "type": "number" } ], "title": "ContractsPostRequestBodyContentApplicationJsonSchemaDataOneOf0ClientTeamId" }, "ContractsPostRequestBodyContentApplicationJsonSchemaDataOneOf0CompensationDetails": { "description": "Compensation and invoicing configuration for the contract.", "properties": { "amount": { "description": "Amount to be paid. This field can be excluded when creating a Pay-as-you-go task-based or Milestone contracts.", "format": "double", "type": "number" }, "currency_code": { "description": "Currency code.", "maxLength": 3, "minLength": 3, "pattern": "^[A-Z]{3}$", "type": "string" }, "cycle_end": { "description": "Date invoice cycle ends.", "format": "double", "maximum": 31, "minimum": 1, "type": "number" }, "cycle_end_type": { "$ref": "#/components/schemas/ContractsPostRequestBodyContentApplicationJsonSchemaDataOneOf0CompensationDetailsCycleEndType", "description": "Cycle end can be weekly 1-7 (Monday = 1) or monthly 1-31." }, "first_payment": { "default": 0, "description": "First payment amount.", "format": "double", "minimum": 0, "type": "number" }, "first_payment_date": { "description": "Short date in format ISO-8601 (YYYY-MM-DD). For example: 2022-12-31.", "type": [ "string", "null" ] }, "frequency": { "$ref": "#/components/schemas/ContractsPostRequestBodyContentApplicationJsonSchemaDataOneOf0CompensationDetailsFrequency", "description": "Scale of the invoice cycle." }, "notice_period": { "default": 10, "description": "Days before to notice the termination of contract for either party.", "format": "double", "minimum": 0, "type": "number" }, "pay_before_weekends": { "description": "If the payment due is on a weekend, pay on Friday.", "type": "boolean" }, "payment_due_days": { "description": "Number of days to pay the invoice.", "format": "double", "maximum": 90, "minimum": 0, "type": "number" }, "payment_due_type": { "$ref": "#/components/schemas/ContractsPostRequestBodyContentApplicationJsonSchemaDataOneOf0CompensationDetailsPaymentDueType", "default": "REGULAR", "description": "Type of payment due. If the payment is due on the last day of month, enter 'WITHIN_MONTH'. If the payment is due some days after the end of the month, enter 'AFTER_MONTH'. If the payment is due before the end of the invoice cycle, enter 'BEFORE_CYCLE_END'." }, "payment_policy_id": { "description": "ID of a pre-configured payment policy. When provided, the payment schedule is derived from the policy and the individual payment fields (frequency, cycle_end, cycle_end_type, payment_due_type, payment_due_days, pay_before_weekends) must be omitted. Mutually exclusive with those individual fields.", "format": "uuid", "type": "string" }, "scale": { "$ref": "#/components/schemas/ContractsPostRequestBodyContentApplicationJsonSchemaDataOneOf0CompensationDetailsScale", "description": "Defines the scale at which the amount is paid. For example, enter 'hourly' to define the amount per hour. This field can be excluded when creating a Pay-as-you-go task-based or Milestone contracts." } }, "required": [ "amount", "currency_code", "scale" ], "title": "ContractsPostRequestBodyContentApplicationJsonSchemaDataOneOf0CompensationDetails", "type": "object" }, "ContractsPostRequestBodyContentApplicationJsonSchemaDataOneOf0CompensationDetailsCycleEndType": { "description": "Cycle end can be weekly 1-7 (Monday = 1) or monthly 1-31.", "enum": [ "DAY_OF_WEEK", "DAY_OF_LAST_WEEK", "DAY_OF_MONTH" ], "title": "ContractsPostRequestBodyContentApplicationJsonSchemaDataOneOf0CompensationDetailsCycleEndType", "type": "string" }, "ContractsPostRequestBodyContentApplicationJsonSchemaDataOneOf0CompensationDetailsFrequency": { "description": "Scale of the invoice cycle.", "enum": [ "weekly", "monthly", "biweekly", "semimonthly", "calendar-month" ], "title": "ContractsPostRequestBodyContentApplicationJsonSchemaDataOneOf0CompensationDetailsFrequency", "type": "string" }, "ContractsPostRequestBodyContentApplicationJsonSchemaDataOneOf0CompensationDetailsPaymentDueType": { "default": "REGULAR", "description": "Type of payment due. If the payment is due on the last day of month, enter 'WITHIN_MONTH'. If the payment is due some days after the end of the month, enter 'AFTER_MONTH'. If the payment is due before the end of the invoice cycle, enter 'BEFORE_CYCLE_END'.", "enum": [ "REGULAR", "WITHIN_MONTH", "AFTER_MONTH", "BEFORE_CYCLE_END" ], "title": "ContractsPostRequestBodyContentApplicationJsonSchemaDataOneOf0CompensationDetailsPaymentDueType", "type": "string" }, "ContractsPostRequestBodyContentApplicationJsonSchemaDataOneOf0CompensationDetailsScale": { "description": "Defines the scale at which the amount is paid. For example, enter 'hourly' to define the amount per hour. This field can be excluded when creating a Pay-as-you-go task-based or Milestone contracts.", "enum": [ "hourly", "daily", "weekly", "monthly", "biweekly", "semimonthly", "custom" ], "title": "ContractsPostRequestBodyContentApplicationJsonSchemaDataOneOf0CompensationDetailsScale", "type": "string" }, "ContractsPostRequestBodyContentApplicationJsonSchemaDataOneOf0JobTitle": { "description": "Worker's job title. You can enter a custom job title or use a pre-defined job title using the Id retrieved in job-titles endpoint.", "properties": { "id": { "$ref": "#/components/schemas/ContractsPostRequestBodyContentApplicationJsonSchemaDataOneOf0JobTitleId", "description": "Unique identifier of this resource." }, "name": { "description": "Job title. Please leave it blank when entering an Id.", "maxLength": 255, "type": [ "string", "null" ] } }, "title": "ContractsPostRequestBodyContentApplicationJsonSchemaDataOneOf0JobTitle", "type": "object" }, "ContractsPostRequestBodyContentApplicationJsonSchemaDataOneOf0JobTitleId": { "description": "Unique identifier of this resource.", "oneOf": [ { "type": "string" }, { "format": "double", "type": "number" } ], "title": "ContractsPostRequestBodyContentApplicationJsonSchemaDataOneOf0JobTitleId" }, "ContractsPostRequestBodyContentApplicationJsonSchemaDataOneOf0Meta": { "description": "Additional custom info about a contract", "properties": { "documents_required": { "description": "Require the contractor to upload necessary compliance documents as per their country’s labor laws.", "type": "boolean" }, "is_main_income": { "description": "Flag to indicate if the contract is the main income for the contractor.", "type": "boolean" } }, "required": [ "documents_required" ], "title": "ContractsPostRequestBodyContentApplicationJsonSchemaDataOneOf0Meta", "type": "object" }, "ContractsPostRequestBodyContentApplicationJsonSchemaDataOneOf0PlatformPaymentType": { "description": "Whether the contract is paid through Deel (`STANDARD`) or outside Deel (`OFF_PLATFORM`). Applies to IC contracts only.", "enum": [ "STANDARD", "OFF_PLATFORM" ], "title": "ContractsPostRequestBodyContentApplicationJsonSchemaDataOneOf0PlatformPaymentType", "type": "string" }, "ContractsPostRequestBodyContentApplicationJsonSchemaDataOneOf0Seniority": { "description": "Job seniority level. Please use the seniority levels endpoint to retrieve the list of seniority levels.", "properties": { "id": { "$ref": "#/components/schemas/ContractsPostRequestBodyContentApplicationJsonSchemaDataOneOf0SeniorityId", "description": "Unique identifier of this resource." } }, "title": "ContractsPostRequestBodyContentApplicationJsonSchemaDataOneOf0Seniority", "type": "object" }, "ContractsPostRequestBodyContentApplicationJsonSchemaDataOneOf0SeniorityId": { "description": "Unique identifier of this resource.", "oneOf": [ { "type": "string" }, { "format": "double", "type": "number" } ], "title": "ContractsPostRequestBodyContentApplicationJsonSchemaDataOneOf0SeniorityId" }, "ContractsPostRequestBodyContentApplicationJsonSchemaDataOneOf0Type": { "description": "Type of contract", "enum": [ "pay_as_you_go_time_based" ], "title": "ContractsPostRequestBodyContentApplicationJsonSchemaDataOneOf0Type", "type": "string" }, "ContractsPostRequestBodyContentApplicationJsonSchemaDataOneOf0WhoReports": { "description": "Flag to indicate who is supposed to provide regular reports", "enum": [ "both", "client", "contractor" ], "title": "ContractsPostRequestBodyContentApplicationJsonSchemaDataOneOf0WhoReports", "type": "string" }, "ContractsPostRequestBodyContentApplicationJsonSchemaDataOneOf0Worker": { "description": "Worker properties", "properties": { "expected_email": { "description": "Worker's email address.", "format": "email", "minLength": 5, "type": [ "string", "null" ] }, "first_name": { "description": "Worker's first name", "maxLength": 255, "type": [ "string", "null" ] }, "last_name": { "description": "Worker's last name", "maxLength": 255, "type": [ "string", "null" ] }, "work_email": { "description": "Worker's work email address.", "format": "email", "maxLength": 255, "type": [ "string", "null" ] } }, "required": [ "first_name", "expected_email" ], "title": "ContractsPostRequestBodyContentApplicationJsonSchemaDataOneOf0Worker", "type": "object" }, "ContractsPostRequestBodyContentApplicationJsonSchemaDataOneOf1Client": { "description": "Client details for the contract, including the legal entity and team.", "properties": { "legal_entity": { "$ref": "#/components/schemas/ContractsPostRequestBodyContentApplicationJsonSchemaDataOneOf1ClientLegalEntity", "description": "Choose the Deel legal entity for this contract. Use legal entity endpoint to retrieve a list of legal entities in your organization." }, "team": { "$ref": "#/components/schemas/ContractsPostRequestBodyContentApplicationJsonSchemaDataOneOf1ClientTeam", "description": "Choose the Deel team for this contract. Use teams endpoint to retrieve a list of teams in your organization." } }, "required": [ "team", "legal_entity" ], "title": "ContractsPostRequestBodyContentApplicationJsonSchemaDataOneOf1Client", "type": "object" }, "ContractsPostRequestBodyContentApplicationJsonSchemaDataOneOf1ClientLegalEntity": { "description": "Choose the Deel legal entity for this contract. Use legal entity endpoint to retrieve a list of legal entities in your organization.", "properties": { "id": { "$ref": "#/components/schemas/ContractsPostRequestBodyContentApplicationJsonSchemaDataOneOf1ClientLegalEntityId", "description": "Unique identifier of this resource." } }, "required": [ "id" ], "title": "ContractsPostRequestBodyContentApplicationJsonSchemaDataOneOf1ClientLegalEntity", "type": "object" }, "ContractsPostRequestBodyContentApplicationJsonSchemaDataOneOf1ClientLegalEntityId": { "description": "Unique identifier of this resource.", "oneOf": [ { "type": "string" }, { "format": "double", "type": "number" } ], "title": "ContractsPostRequestBodyContentApplicationJsonSchemaDataOneOf1ClientLegalEntityId" }, "ContractsPostRequestBodyContentApplicationJsonSchemaDataOneOf1ClientTeam": { "description": "Choose the Deel team for this contract. Use teams endpoint to retrieve a list of teams in your organization.", "properties": { "id": { "$ref": "#/components/schemas/ContractsPostRequestBodyContentApplicationJsonSchemaDataOneOf1ClientTeamId", "description": "Unique identifier of this resource." } }, "required": [ "id" ], "title": "ContractsPostRequestBodyContentApplicationJsonSchemaDataOneOf1ClientTeam", "type": "object" }, "ContractsPostRequestBodyContentApplicationJsonSchemaDataOneOf1ClientTeamId": { "description": "Unique identifier of this resource.", "oneOf": [ { "type": "string" }, { "format": "double", "type": "number" } ], "title": "ContractsPostRequestBodyContentApplicationJsonSchemaDataOneOf1ClientTeamId" }, "ContractsPostRequestBodyContentApplicationJsonSchemaDataOneOf1CompensationDetails": { "description": "Compensation and invoicing configuration for the contract.", "oneOf": [ { "description": "Any type" }, { "description": "Any type" } ], "title": "ContractsPostRequestBodyContentApplicationJsonSchemaDataOneOf1CompensationDetails" }, "ContractsPostRequestBodyContentApplicationJsonSchemaDataOneOf1JobTitle": { "description": "Worker's job title. You can enter a custom job title or use a pre-defined job title using the Id retrieved in job-titles endpoint.", "properties": { "id": { "$ref": "#/components/schemas/ContractsPostRequestBodyContentApplicationJsonSchemaDataOneOf1JobTitleId", "description": "Unique identifier of this resource." }, "name": { "description": "Job title. Please leave it blank when entering an Id.", "maxLength": 255, "type": [ "string", "null" ] } }, "title": "ContractsPostRequestBodyContentApplicationJsonSchemaDataOneOf1JobTitle", "type": "object" }, "ContractsPostRequestBodyContentApplicationJsonSchemaDataOneOf1JobTitleId": { "description": "Unique identifier of this resource.", "oneOf": [ { "type": "string" }, { "format": "double", "type": "number" } ], "title": "ContractsPostRequestBodyContentApplicationJsonSchemaDataOneOf1JobTitleId" }, "ContractsPostRequestBodyContentApplicationJsonSchemaDataOneOf1Meta": { "description": "Additional custom info about a contract", "properties": { "documents_required": { "description": "Require the contractor to upload necessary compliance documents as per their country’s labor laws.", "type": "boolean" }, "is_main_income": { "description": "Flag to indicate if the contract is the main income for the contractor.", "type": "boolean" } }, "required": [ "documents_required" ], "title": "ContractsPostRequestBodyContentApplicationJsonSchemaDataOneOf1Meta", "type": "object" }, "ContractsPostRequestBodyContentApplicationJsonSchemaDataOneOf1Seniority": { "description": "Job seniority level. Please use the seniority levels endpoint to retrieve the list of seniority levels.", "properties": { "id": { "$ref": "#/components/schemas/ContractsPostRequestBodyContentApplicationJsonSchemaDataOneOf1SeniorityId", "description": "Unique identifier of this resource." } }, "title": "ContractsPostRequestBodyContentApplicationJsonSchemaDataOneOf1Seniority", "type": "object" }, "ContractsPostRequestBodyContentApplicationJsonSchemaDataOneOf1SeniorityId": { "description": "Unique identifier of this resource.", "oneOf": [ { "type": "string" }, { "format": "double", "type": "number" } ], "title": "ContractsPostRequestBodyContentApplicationJsonSchemaDataOneOf1SeniorityId" }, "ContractsPostRequestBodyContentApplicationJsonSchemaDataOneOf1Type": { "description": "Type of contract", "enum": [ "payg_tasks" ], "title": "ContractsPostRequestBodyContentApplicationJsonSchemaDataOneOf1Type", "type": "string" }, "ContractsPostRequestBodyContentApplicationJsonSchemaDataOneOf1WhoReports": { "description": "Flag to indicate who is supposed to provide regular reports", "enum": [ "both", "client", "contractor" ], "title": "ContractsPostRequestBodyContentApplicationJsonSchemaDataOneOf1WhoReports", "type": "string" }, "ContractsPostRequestBodyContentApplicationJsonSchemaDataOneOf1Worker": { "description": "Worker properties", "properties": { "expected_email": { "description": "Worker's email address.", "format": "email", "minLength": 5, "type": [ "string", "null" ] }, "first_name": { "description": "Worker's first name", "maxLength": 255, "type": [ "string", "null" ] }, "last_name": { "description": "Worker's last name", "maxLength": 255, "type": [ "string", "null" ] }, "work_email": { "description": "Worker's work email address.", "format": "email", "maxLength": 255, "type": [ "string", "null" ] } }, "required": [ "first_name", "expected_email" ], "title": "ContractsPostRequestBodyContentApplicationJsonSchemaDataOneOf1Worker", "type": "object" }, "ContractsPostRequestBodyContentApplicationJsonSchemaDataOneOf2Client": { "description": "Client details for the contract, including the legal entity and team.", "properties": { "legal_entity": { "$ref": "#/components/schemas/ContractsPostRequestBodyContentApplicationJsonSchemaDataOneOf2ClientLegalEntity", "description": "Choose the Deel legal entity for this contract. Use legal entity endpoint to retrieve a list of legal entities in your organization." }, "team": { "$ref": "#/components/schemas/ContractsPostRequestBodyContentApplicationJsonSchemaDataOneOf2ClientTeam", "description": "Choose the Deel team for this contract. Use teams endpoint to retrieve a list of teams in your organization." } }, "required": [ "team", "legal_entity" ], "title": "ContractsPostRequestBodyContentApplicationJsonSchemaDataOneOf2Client", "type": "object" }, "ContractsPostRequestBodyContentApplicationJsonSchemaDataOneOf2ClientLegalEntity": { "description": "Choose the Deel legal entity for this contract. Use legal entity endpoint to retrieve a list of legal entities in your organization.", "properties": { "id": { "$ref": "#/components/schemas/ContractsPostRequestBodyContentApplicationJsonSchemaDataOneOf2ClientLegalEntityId", "description": "Unique identifier of this resource." } }, "required": [ "id" ], "title": "ContractsPostRequestBodyContentApplicationJsonSchemaDataOneOf2ClientLegalEntity", "type": "object" }, "ContractsPostRequestBodyContentApplicationJsonSchemaDataOneOf2ClientLegalEntityId": { "description": "Unique identifier of this resource.", "oneOf": [ { "type": "string" }, { "format": "double", "type": "number" } ], "title": "ContractsPostRequestBodyContentApplicationJsonSchemaDataOneOf2ClientLegalEntityId" }, "ContractsPostRequestBodyContentApplicationJsonSchemaDataOneOf2ClientTeam": { "description": "Choose the Deel team for this contract. Use teams endpoint to retrieve a list of teams in your organization.", "properties": { "id": { "$ref": "#/components/schemas/ContractsPostRequestBodyContentApplicationJsonSchemaDataOneOf2ClientTeamId", "description": "Unique identifier of this resource." } }, "required": [ "id" ], "title": "ContractsPostRequestBodyContentApplicationJsonSchemaDataOneOf2ClientTeam", "type": "object" }, "ContractsPostRequestBodyContentApplicationJsonSchemaDataOneOf2ClientTeamId": { "description": "Unique identifier of this resource.", "oneOf": [ { "type": "string" }, { "format": "double", "type": "number" } ], "title": "ContractsPostRequestBodyContentApplicationJsonSchemaDataOneOf2ClientTeamId" }, "ContractsPostRequestBodyContentApplicationJsonSchemaDataOneOf2CompensationDetails": { "description": "Compensation and invoicing configuration for the contract.", "properties": { "amount": { "description": "Amount to be paid. This field can be excluded when creating a Pay-as-you-go task-based or Milestone contracts.", "format": "double", "type": "number" }, "currency_code": { "description": "Currency code.", "maxLength": 3, "minLength": 3, "pattern": "^[A-Z]{3}$", "type": "string" }, "cycle_end": { "description": "Date invoice cycle ends.", "format": "double", "maximum": 31, "minimum": 1, "type": "number" }, "cycle_end_type": { "$ref": "#/components/schemas/ContractsPostRequestBodyContentApplicationJsonSchemaDataOneOf2CompensationDetailsCycleEndType", "description": "Cycle end can be weekly 1-7 (Monday = 1) or monthly 1-31." }, "first_payment": { "default": 0, "description": "First payment amount.", "format": "double", "minimum": 0, "type": "number" }, "first_payment_date": { "description": "Short date in format ISO-8601 (YYYY-MM-DD). For example: 2022-12-31.", "type": [ "string", "null" ] }, "frequency": { "$ref": "#/components/schemas/ContractsPostRequestBodyContentApplicationJsonSchemaDataOneOf2CompensationDetailsFrequency", "description": "Scale of the invoice cycle." }, "notice_period": { "default": 10, "description": "Days before to notice the termination of contract for either party.", "format": "double", "minimum": 0, "type": "number" }, "pay_before_weekends": { "description": "If the payment due is on a weekend, pay on Friday.", "type": "boolean" }, "payment_due_days": { "description": "Number of days to pay the invoice.", "format": "double", "maximum": 90, "minimum": 0, "type": "number" }, "payment_due_type": { "$ref": "#/components/schemas/ContractsPostRequestBodyContentApplicationJsonSchemaDataOneOf2CompensationDetailsPaymentDueType", "description": "Type of payment due. If the payment is due on the last day of month, enter 'WITHIN_MONTH'. If the payment is due some days after the end of the month, enter 'AFTER_MONTH'. If the payment is due before the end of the invoice cycle, enter 'BEFORE_CYCLE_END'." } }, "required": [ "cycle_end", "frequency", "currency_code", "cycle_end_type", "payment_due_days", "payment_due_type" ], "title": "ContractsPostRequestBodyContentApplicationJsonSchemaDataOneOf2CompensationDetails", "type": "object" }, "ContractsPostRequestBodyContentApplicationJsonSchemaDataOneOf2CompensationDetailsCycleEndType": { "description": "Cycle end can be weekly 1-7 (Monday = 1) or monthly 1-31.", "enum": [ "DAY_OF_WEEK", "DAY_OF_LAST_WEEK", "DAY_OF_MONTH" ], "title": "ContractsPostRequestBodyContentApplicationJsonSchemaDataOneOf2CompensationDetailsCycleEndType", "type": "string" }, "ContractsPostRequestBodyContentApplicationJsonSchemaDataOneOf2CompensationDetailsFrequency": { "description": "Scale of the invoice cycle.", "enum": [ "weekly", "monthly", "biweekly", "semimonthly", "calendar-month" ], "title": "ContractsPostRequestBodyContentApplicationJsonSchemaDataOneOf2CompensationDetailsFrequency", "type": "string" }, "ContractsPostRequestBodyContentApplicationJsonSchemaDataOneOf2CompensationDetailsPaymentDueType": { "default": "REGULAR", "description": "Type of payment due. If the payment is due on the last day of month, enter 'WITHIN_MONTH'. If the payment is due some days after the end of the month, enter 'AFTER_MONTH'. If the payment is due before the end of the invoice cycle, enter 'BEFORE_CYCLE_END'.", "enum": [ "REGULAR", "WITHIN_MONTH", "AFTER_MONTH", "BEFORE_CYCLE_END" ], "title": "ContractsPostRequestBodyContentApplicationJsonSchemaDataOneOf2CompensationDetailsPaymentDueType", "type": "string" }, "ContractsPostRequestBodyContentApplicationJsonSchemaDataOneOf2JobTitle": { "description": "Worker's job title. You can enter a custom job title or use a pre-defined job title using the Id retrieved in job-titles endpoint.", "properties": { "id": { "$ref": "#/components/schemas/ContractsPostRequestBodyContentApplicationJsonSchemaDataOneOf2JobTitleId", "description": "Unique identifier of this resource." }, "name": { "description": "Job title. Please leave it blank when entering an Id.", "maxLength": 255, "type": [ "string", "null" ] } }, "title": "ContractsPostRequestBodyContentApplicationJsonSchemaDataOneOf2JobTitle", "type": "object" }, "ContractsPostRequestBodyContentApplicationJsonSchemaDataOneOf2JobTitleId": { "description": "Unique identifier of this resource.", "oneOf": [ { "type": "string" }, { "format": "double", "type": "number" } ], "title": "ContractsPostRequestBodyContentApplicationJsonSchemaDataOneOf2JobTitleId" }, "ContractsPostRequestBodyContentApplicationJsonSchemaDataOneOf2Meta": { "description": "Additional custom info about a contract", "properties": { "documents_required": { "description": "Require the contractor to upload necessary compliance documents as per their country’s labor laws.", "type": "boolean" }, "is_main_income": { "description": "Flag to indicate if the contract is the main income for the contractor.", "type": "boolean" } }, "required": [ "documents_required" ], "title": "ContractsPostRequestBodyContentApplicationJsonSchemaDataOneOf2Meta", "type": "object" }, "ContractsPostRequestBodyContentApplicationJsonSchemaDataOneOf2Seniority": { "description": "Job seniority level. Please use the seniority levels endpoint to retrieve the list of seniority levels.", "properties": { "id": { "$ref": "#/components/schemas/ContractsPostRequestBodyContentApplicationJsonSchemaDataOneOf2SeniorityId", "description": "Unique identifier of this resource." } }, "title": "ContractsPostRequestBodyContentApplicationJsonSchemaDataOneOf2Seniority", "type": "object" }, "ContractsPostRequestBodyContentApplicationJsonSchemaDataOneOf2SeniorityId": { "description": "Unique identifier of this resource.", "oneOf": [ { "type": "string" }, { "format": "double", "type": "number" } ], "title": "ContractsPostRequestBodyContentApplicationJsonSchemaDataOneOf2SeniorityId" }, "ContractsPostRequestBodyContentApplicationJsonSchemaDataOneOf2Type": { "description": "Type of contract", "enum": [ "payg_milestones" ], "title": "ContractsPostRequestBodyContentApplicationJsonSchemaDataOneOf2Type", "type": "string" }, "ContractsPostRequestBodyContentApplicationJsonSchemaDataOneOf2WhoReports": { "description": "Flag to indicate who is supposed to provide regular reports", "enum": [ "both", "client", "contractor" ], "title": "ContractsPostRequestBodyContentApplicationJsonSchemaDataOneOf2WhoReports", "type": "string" }, "ContractsPostRequestBodyContentApplicationJsonSchemaDataOneOf2Worker": { "description": "Worker properties", "properties": { "expected_email": { "description": "Worker's email address.", "format": "email", "minLength": 5, "type": [ "string", "null" ] }, "first_name": { "description": "Worker's first name", "maxLength": 255, "type": [ "string", "null" ] }, "last_name": { "description": "Worker's last name", "maxLength": 255, "type": [ "string", "null" ] }, "work_email": { "description": "Worker's work email address.", "format": "email", "maxLength": 255, "type": [ "string", "null" ] } }, "required": [ "first_name", "expected_email" ], "title": "ContractsPostRequestBodyContentApplicationJsonSchemaDataOneOf2Worker", "type": "object" }, "ContractsPostRequestBodyContentApplicationJsonSchemaDataOneOf3Client": { "description": "Client details for the contract, including the legal entity and team.", "properties": { "legal_entity": { "$ref": "#/components/schemas/ContractsPostRequestBodyContentApplicationJsonSchemaDataOneOf3ClientLegalEntity", "description": "Choose the Deel legal entity for this contract. Use legal entity endpoint to retrieve a list of legal entities in your organization." }, "team": { "$ref": "#/components/schemas/ContractsPostRequestBodyContentApplicationJsonSchemaDataOneOf3ClientTeam", "description": "Choose the Deel team for this contract. Use teams endpoint to retrieve a list of teams in your organization." } }, "required": [ "team", "legal_entity" ], "title": "ContractsPostRequestBodyContentApplicationJsonSchemaDataOneOf3Client", "type": "object" }, "ContractsPostRequestBodyContentApplicationJsonSchemaDataOneOf3ClientLegalEntity": { "description": "Choose the Deel legal entity for this contract. Use legal entity endpoint to retrieve a list of legal entities in your organization.", "properties": { "id": { "$ref": "#/components/schemas/ContractsPostRequestBodyContentApplicationJsonSchemaDataOneOf3ClientLegalEntityId", "description": "Unique identifier of this resource." } }, "required": [ "id" ], "title": "ContractsPostRequestBodyContentApplicationJsonSchemaDataOneOf3ClientLegalEntity", "type": "object" }, "ContractsPostRequestBodyContentApplicationJsonSchemaDataOneOf3ClientLegalEntityId": { "description": "Unique identifier of this resource.", "oneOf": [ { "type": "string" }, { "format": "double", "type": "number" } ], "title": "ContractsPostRequestBodyContentApplicationJsonSchemaDataOneOf3ClientLegalEntityId" }, "ContractsPostRequestBodyContentApplicationJsonSchemaDataOneOf3ClientTeam": { "description": "Choose the Deel team for this contract. Use teams endpoint to retrieve a list of teams in your organization.", "properties": { "id": { "$ref": "#/components/schemas/ContractsPostRequestBodyContentApplicationJsonSchemaDataOneOf3ClientTeamId", "description": "Unique identifier of this resource." } }, "required": [ "id" ], "title": "ContractsPostRequestBodyContentApplicationJsonSchemaDataOneOf3ClientTeam", "type": "object" }, "ContractsPostRequestBodyContentApplicationJsonSchemaDataOneOf3ClientTeamId": { "description": "Unique identifier of this resource.", "oneOf": [ { "type": "string" }, { "format": "double", "type": "number" } ], "title": "ContractsPostRequestBodyContentApplicationJsonSchemaDataOneOf3ClientTeamId" }, "ContractsPostRequestBodyContentApplicationJsonSchemaDataOneOf3CompensationDetails": { "description": "Compensation and invoicing configuration for the contract.", "properties": { "amount": { "description": "Amount to be paid. This field can be excluded when creating a Pay-as-you-go task-based or Milestone contracts.", "format": "double", "type": "number" }, "currency_code": { "description": "Currency code.", "maxLength": 3, "minLength": 3, "pattern": "^[A-Z]{3}$", "type": "string" }, "cycle_end": { "description": "Date invoice cycle ends.", "format": "double", "maximum": 31, "minimum": 1, "type": "number" }, "cycle_end_type": { "$ref": "#/components/schemas/ContractsPostRequestBodyContentApplicationJsonSchemaDataOneOf3CompensationDetailsCycleEndType", "description": "Cycle end can be weekly 1-7 (Monday = 1) or monthly 1-31." }, "first_payment": { "default": 0, "description": "First payment amount.", "format": "double", "minimum": 0, "type": "number" }, "first_payment_date": { "description": "Short date in format ISO-8601 (YYYY-MM-DD). For example: 2022-12-31.", "type": [ "string", "null" ] }, "frequency": { "$ref": "#/components/schemas/ContractsPostRequestBodyContentApplicationJsonSchemaDataOneOf3CompensationDetailsFrequency", "description": "Scale of the invoice cycle." }, "notice_period": { "default": 10, "description": "Days before to notice the termination of contract for either party.", "format": "double", "minimum": 0, "type": "number" }, "pay_before_weekends": { "description": "If the payment due is on a weekend, pay on Friday.", "type": "boolean" }, "payment_due_days": { "description": "Number of days to pay the invoice.", "format": "double", "maximum": 90, "minimum": 0, "type": "number" }, "payment_due_type": { "$ref": "#/components/schemas/ContractsPostRequestBodyContentApplicationJsonSchemaDataOneOf3CompensationDetailsPaymentDueType", "default": "REGULAR", "description": "Type of payment due. If the payment is due on the last day of month, enter 'WITHIN_MONTH'. If the payment is due some days after the end of the month, enter 'AFTER_MONTH'. If the payment is due before the end of the invoice cycle, enter 'BEFORE_CYCLE_END'." }, "payment_policy_id": { "description": "ID of a pre-configured payment policy. When provided, the payment schedule is derived from the policy and the individual payment fields (frequency, cycle_end, cycle_end_type, payment_due_type, payment_due_days, pay_before_weekends) must be omitted. Mutually exclusive with those individual fields.", "format": "uuid", "type": "string" }, "scale": { "$ref": "#/components/schemas/ContractsPostRequestBodyContentApplicationJsonSchemaDataOneOf3CompensationDetailsScale", "description": "Defines the scale at which the amount is paid. For example, enter 'hourly' to define the amount per hour. This field can be excluded when creating a Pay-as-you-go task-based or Milestone contracts." } }, "required": [ "amount", "currency_code", "scale" ], "title": "ContractsPostRequestBodyContentApplicationJsonSchemaDataOneOf3CompensationDetails", "type": "object" }, "ContractsPostRequestBodyContentApplicationJsonSchemaDataOneOf3CompensationDetailsCycleEndType": { "description": "Cycle end can be weekly 1-7 (Monday = 1) or monthly 1-31.", "enum": [ "DAY_OF_WEEK", "DAY_OF_LAST_WEEK", "DAY_OF_MONTH" ], "title": "ContractsPostRequestBodyContentApplicationJsonSchemaDataOneOf3CompensationDetailsCycleEndType", "type": "string" }, "ContractsPostRequestBodyContentApplicationJsonSchemaDataOneOf3CompensationDetailsFrequency": { "description": "Scale of the invoice cycle.", "enum": [ "weekly", "monthly", "biweekly", "semimonthly", "calendar-month" ], "title": "ContractsPostRequestBodyContentApplicationJsonSchemaDataOneOf3CompensationDetailsFrequency", "type": "string" }, "ContractsPostRequestBodyContentApplicationJsonSchemaDataOneOf3CompensationDetailsPaymentDueType": { "default": "REGULAR", "description": "Type of payment due. If the payment is due on the last day of month, enter 'WITHIN_MONTH'. If the payment is due some days after the end of the month, enter 'AFTER_MONTH'. If the payment is due before the end of the invoice cycle, enter 'BEFORE_CYCLE_END'.", "enum": [ "REGULAR", "WITHIN_MONTH", "AFTER_MONTH", "BEFORE_CYCLE_END" ], "title": "ContractsPostRequestBodyContentApplicationJsonSchemaDataOneOf3CompensationDetailsPaymentDueType", "type": "string" }, "ContractsPostRequestBodyContentApplicationJsonSchemaDataOneOf3CompensationDetailsScale": { "description": "Defines the scale at which the amount is paid. For example, enter 'hourly' to define the amount per hour. This field can be excluded when creating a Pay-as-you-go task-based or Milestone contracts.", "enum": [ "hourly", "daily", "weekly", "monthly", "biweekly", "semimonthly", "custom" ], "title": "ContractsPostRequestBodyContentApplicationJsonSchemaDataOneOf3CompensationDetailsScale", "type": "string" }, "ContractsPostRequestBodyContentApplicationJsonSchemaDataOneOf3JobTitle": { "description": "Worker's job title. You can enter a custom job title or use a pre-defined job title using the Id retrieved in job-titles endpoint.", "properties": { "id": { "$ref": "#/components/schemas/ContractsPostRequestBodyContentApplicationJsonSchemaDataOneOf3JobTitleId", "description": "Unique identifier of this resource." }, "name": { "description": "Job title. Please leave it blank when entering an Id.", "maxLength": 255, "type": [ "string", "null" ] } }, "title": "ContractsPostRequestBodyContentApplicationJsonSchemaDataOneOf3JobTitle", "type": "object" }, "ContractsPostRequestBodyContentApplicationJsonSchemaDataOneOf3JobTitleId": { "description": "Unique identifier of this resource.", "oneOf": [ { "type": "string" }, { "format": "double", "type": "number" } ], "title": "ContractsPostRequestBodyContentApplicationJsonSchemaDataOneOf3JobTitleId" }, "ContractsPostRequestBodyContentApplicationJsonSchemaDataOneOf3Meta": { "description": "Additional custom info about a contract", "properties": { "documents_required": { "description": "Require the contractor to upload necessary compliance documents as per their country’s labor laws.", "type": "boolean" }, "is_main_income": { "description": "Flag to indicate if the contract is the main income for the contractor.", "type": "boolean" } }, "required": [ "documents_required" ], "title": "ContractsPostRequestBodyContentApplicationJsonSchemaDataOneOf3Meta", "type": "object" }, "ContractsPostRequestBodyContentApplicationJsonSchemaDataOneOf3Seniority": { "description": "Job seniority level. Please use the seniority levels endpoint to retrieve the list of seniority levels.", "properties": { "id": { "$ref": "#/components/schemas/ContractsPostRequestBodyContentApplicationJsonSchemaDataOneOf3SeniorityId", "description": "Unique identifier of this resource." } }, "title": "ContractsPostRequestBodyContentApplicationJsonSchemaDataOneOf3Seniority", "type": "object" }, "ContractsPostRequestBodyContentApplicationJsonSchemaDataOneOf3SeniorityId": { "description": "Unique identifier of this resource.", "oneOf": [ { "type": "string" }, { "format": "double", "type": "number" } ], "title": "ContractsPostRequestBodyContentApplicationJsonSchemaDataOneOf3SeniorityId" }, "ContractsPostRequestBodyContentApplicationJsonSchemaDataOneOf3Type": { "description": "Type of contract", "enum": [ "ongoing_time_based" ], "title": "ContractsPostRequestBodyContentApplicationJsonSchemaDataOneOf3Type", "type": "string" }, "ContractsPostRequestBodyContentApplicationJsonSchemaDataOneOf3WhoReports": { "description": "Flag to indicate who is supposed to provide regular reports", "enum": [ "both", "client", "contractor" ], "title": "ContractsPostRequestBodyContentApplicationJsonSchemaDataOneOf3WhoReports", "type": "string" }, "ContractsPostRequestBodyContentApplicationJsonSchemaDataOneOf3Worker": { "description": "Worker properties", "properties": { "expected_email": { "description": "Worker's email address.", "format": "email", "minLength": 5, "type": [ "string", "null" ] }, "first_name": { "description": "Worker's first name", "maxLength": 255, "type": [ "string", "null" ] }, "last_name": { "description": "Worker's last name", "maxLength": 255, "type": [ "string", "null" ] }, "work_email": { "description": "Worker's work email address.", "format": "email", "maxLength": 255, "type": [ "string", "null" ] } }, "required": [ "first_name", "expected_email" ], "title": "ContractsPostRequestBodyContentApplicationJsonSchemaDataOneOf3Worker", "type": "object" }, "ContractsPostResponsesContentApplicationJsonSchemaData": { "properties": { "client": { "description": "Client details associated with the contract.", "oneOf": [ { "$ref": "#/components/schemas/ContractsPostResponsesContentApplicationJsonSchemaDataClient" }, { "type": "null" } ] }, "compensation_details": { "$ref": "#/components/schemas/ContractsPostResponsesContentApplicationJsonSchemaDataCompensationDetails", "description": "Compensation configuration and payment schedule details for the contract." }, "created_at": { "description": "Long date-time format following ISO-8601", "format": "date-time", "type": [ "string", "null" ] }, "custom_fields": { "description": "Custom fields attached to the contract.", "items": { "$ref": "#/components/schemas/ContractsPostResponsesContentApplicationJsonSchemaDataCustomFieldsItems" }, "type": "array" }, "employment_details": { "$ref": "#/components/schemas/ContractsPostResponsesContentApplicationJsonSchemaDataEmploymentDetails", "description": "Employment-related details for the contract, when applicable." }, "external_id": { "description": "A unique identifier for the object provided by an external system.", "type": [ "string", "null" ] }, "id": { "description": "The public id of the object", "type": "string" }, "invitations": { "$ref": "#/components/schemas/ContractsPostResponsesContentApplicationJsonSchemaDataInvitations", "description": "List of signature invitations sent for this contract." }, "is_archived": { "description": "Flag to indicate if the contract is archived", "type": "boolean" }, "job_title": { "description": "Job title associated with the contract.", "type": "string" }, "notice_period": { "default": 10, "description": "Days before to notice the termination of contract for either party.", "format": "double", "minimum": 0, "type": "number" }, "platform_payment_type": { "$ref": "#/components/schemas/ContractsPostResponsesContentApplicationJsonSchemaDataPlatformPaymentType", "description": "Whether the contract is paid through Deel (`STANDARD`) or outside Deel (`OFF_PLATFORM`). Applies to IC contracts only." }, "quote": { "$ref": "#/components/schemas/ContractsPostResponsesContentApplicationJsonSchemaDataQuote", "description": "EOR quote approved by Deel" }, "scope_of_work": { "description": "Scope of work for the contract", "type": [ "string", "null" ] }, "seniority": { "description": "Seniority describes level of expertise at a job e.g. junior", "oneOf": [ { "$ref": "#/components/schemas/ContractsPostResponsesContentApplicationJsonSchemaDataSeniority" }, { "type": "null" } ] }, "signatures": { "$ref": "#/components/schemas/ContractsPostResponsesContentApplicationJsonSchemaDataSignatures", "description": "List of signatures recorded for this contract." }, "special_clause": { "description": "Special clause for the contract", "type": "string" }, "start_date": { "description": "Long date-time format following ISO-8601", "format": "date-time", "type": [ "string", "null" ] }, "status": { "$ref": "#/components/schemas/ContractsPostResponsesContentApplicationJsonSchemaDataStatus", "description": "Status of a contract in Deel workflow" }, "termination_date": { "$ref": "#/components/schemas/ContractsPostResponsesContentApplicationJsonSchemaDataTerminationDate", "description": "Contract termination date. When present, it is a date-time string in ISO-8601 format." }, "title": { "description": "Title of a contract", "minLength": 1, "type": "string" }, "type": { "$ref": "#/components/schemas/ContractsPostResponsesContentApplicationJsonSchemaDataType", "description": "Type of a contract" }, "who_reports": { "$ref": "#/components/schemas/ContractsPostResponsesContentApplicationJsonSchemaDataWhoReports", "description": "Flag to indicate who is supposed to provide regular reports" }, "work_statement_id": { "description": "The public unique identifier of the work statement", "type": "string" }, "worker": { "description": "Worker details associated with the contract.", "oneOf": [ { "$ref": "#/components/schemas/ContractsPostResponsesContentApplicationJsonSchemaDataWorker" }, { "type": "null" } ] } }, "required": [ "id", "type", "title", "client", "status", "worker", "job_title", "created_at", "signatures", "start_date", "invitations", "is_archived", "special_clause", "termination_date", "work_statement_id", "employment_details", "compensation_details" ], "title": "ContractsPostResponsesContentApplicationJsonSchemaData", "type": "object" }, "ContractsPostResponsesContentApplicationJsonSchemaDataClient": { "description": "Client details associated with the contract.", "properties": { "email": { "description": "User's email address.", "format": "email", "minLength": 5, "type": [ "string", "null" ] }, "full_name": { "description": "User's full name.", "type": "string" }, "id": { "description": "Unique identifier of this resource.", "type": "string" }, "legal_entity": { "description": "Legal entity information for the client organization.", "oneOf": [ { "$ref": "#/components/schemas/ContractsPostResponsesContentApplicationJsonSchemaDataClientLegalEntity" }, { "type": "null" } ] }, "team": { "$ref": "#/components/schemas/ContractsPostResponsesContentApplicationJsonSchemaDataClientTeam", "description": "Team information for the client organization." } }, "required": [ "team", "legal_entity" ], "title": "ContractsPostResponsesContentApplicationJsonSchemaDataClient", "type": "object" }, "ContractsPostResponsesContentApplicationJsonSchemaDataClientLegalEntity": { "description": "Legal entity information for the client organization.", "properties": { "email": { "description": "User's email address.", "type": [ "string", "null" ] }, "id": { "description": "Unique identifier of this resource.", "type": "string" }, "name": { "description": "Name of a legal entity", "type": "string" }, "registration_number": { "description": "Registration number of a legal entity", "type": "string" }, "subtype": { "description": "Subtype of a legal entity", "type": "string" }, "type": { "$ref": "#/components/schemas/ContractsPostResponsesContentApplicationJsonSchemaDataClientLegalEntityType", "description": "Type of a legal entity" }, "vat_number": { "description": "VAT number of a legal entity", "type": "string" } }, "required": [ "id", "name", "type", "email", "subtype", "vat_number", "registration_number" ], "title": "ContractsPostResponsesContentApplicationJsonSchemaDataClientLegalEntity", "type": "object" }, "ContractsPostResponsesContentApplicationJsonSchemaDataClientLegalEntityType": { "description": "Type of a legal entity", "enum": [ "individual", "company" ], "title": "ContractsPostResponsesContentApplicationJsonSchemaDataClientLegalEntityType", "type": "string" }, "ContractsPostResponsesContentApplicationJsonSchemaDataClientTeam": { "description": "Team information for the client organization.", "properties": { "id": { "description": "Unique identifier of this resource.", "type": "string" }, "name": { "description": "Name of a team", "type": "string" } }, "required": [ "id", "name" ], "title": "ContractsPostResponsesContentApplicationJsonSchemaDataClientTeam", "type": "object" }, "ContractsPostResponsesContentApplicationJsonSchemaDataCompensationDetails": { "description": "Compensation configuration and payment schedule details for the contract.", "properties": { "amount": { "description": "Amount of compensation", "type": [ "string", "null" ] }, "currency_code": { "description": "Currency code.", "maxLength": 3, "minLength": 3, "pattern": "^[A-Z]{3}$", "type": "string" }, "first_payment": { "description": "First payment", "type": [ "string", "null" ] }, "first_payment_date": { "description": "Long date-time format following ISO-8601", "type": [ "string", "null" ] }, "frequency": { "description": "Frequency of compensation", "type": "string" }, "gross_annual_salary": { "description": "Gross annual salary", "type": [ "string", "null" ] }, "gross_signing_bonus": { "description": "Gross signing bonus", "type": [ "string", "null" ] }, "gross_variable_bonus": { "description": "Gross variable bonus", "type": [ "string", "null" ] }, "scale": { "description": "Scale of compensation", "type": "string" } }, "required": [ "scale", "amount", "frequency", "currency_code", "first_payment", "first_payment_date", "gross_annual_salary", "gross_signing_bonus", "gross_variable_bonus" ], "title": "ContractsPostResponsesContentApplicationJsonSchemaDataCompensationDetails", "type": "object" }, "ContractsPostResponsesContentApplicationJsonSchemaDataCustomFieldsItems": { "description": "Customized attributes on contracts (Employee ID, Project code, etc).", "properties": { "name": { "description": "Custom field property name.", "type": "string" }, "value": { "description": "Custom field property value.", "type": "string" } }, "title": "ContractsPostResponsesContentApplicationJsonSchemaDataCustomFieldsItems", "type": "object" }, "ContractsPostResponsesContentApplicationJsonSchemaDataEmploymentDetails": { "description": "Employment-related details for the contract, when applicable.", "properties": { "country": { "description": "Country code.", "maxLength": 2, "minLength": 2, "pattern": "^[A-Z]{2}$", "type": "string" }, "days_per_week": { "description": "Number of days per week", "format": "double", "type": "number" }, "hours_per_day": { "description": "Number of hours per day", "format": "double", "type": "number" }, "paid_vacation_days": { "description": "Number of paid vacation days", "format": "double", "type": "number" }, "probation_period": { "description": "Number of days for probation period", "format": "double", "type": [ "number", "null" ] }, "state": { "description": "State code.", "type": [ "string", "null" ] }, "type": { "description": "Employment type classification for the contract.", "type": "string" } }, "required": [ "type", "days_per_week", "hours_per_day", "probation_period", "paid_vacation_days" ], "title": "ContractsPostResponsesContentApplicationJsonSchemaDataEmploymentDetails", "type": "object" }, "ContractsPostResponsesContentApplicationJsonSchemaDataInvitations": { "description": "List of signature invitations sent for this contract.", "properties": { "client_email": { "description": "User's email address.", "type": [ "string", "null" ] }, "worker_email": { "description": "User's email address.", "type": [ "string", "null" ] } }, "title": "ContractsPostResponsesContentApplicationJsonSchemaDataInvitations", "type": "object" }, "ContractsPostResponsesContentApplicationJsonSchemaDataPlatformPaymentType": { "description": "Whether the contract is paid through Deel (`STANDARD`) or outside Deel (`OFF_PLATFORM`). Applies to IC contracts only.", "enum": [ "STANDARD", "OFF_PLATFORM" ], "title": "ContractsPostResponsesContentApplicationJsonSchemaDataPlatformPaymentType", "type": "string" }, "ContractsPostResponsesContentApplicationJsonSchemaDataQuote": { "description": "EOR quote approved by Deel", "properties": { "annual_salary": { "description": "Annual Salary in local currency", "format": "double", "type": "number" }, "benefits": { "description": "Array of benefits", "items": { "$ref": "#/components/schemas/ContractsPostResponsesContentApplicationJsonSchemaDataQuoteBenefitsItems" }, "type": "array" }, "breakdown_costs": { "$ref": "#/components/schemas/ContractsPostResponsesContentApplicationJsonSchemaDataQuoteBreakdownCosts", "description": "Cost breakdown for the quote, grouped by billing cadence (e.g., monthly)." }, "cba_total": { "description": "Total CBA in local currency", "format": "double", "type": "number" }, "cba_total_usd": { "description": "Total CBA in USD", "format": "double", "type": "number" }, "created_at": { "description": "Short date in format ISO-8601 (YYYY-MM-DD). For example: 2022-12-31.", "format": "date", "pattern": "^\\d{4}-\\d{2}-\\d{2}$", "type": [ "string", "null" ] }, "currency": { "description": "Currency code.", "maxLength": 3, "minLength": 3, "pattern": "^[A-Z]{3}$", "type": "string" }, "employer_cost_total": { "description": "Total employer cost in local currency", "format": "double", "type": "number" }, "employer_cost_total_usd": { "description": "Total employer cost in USD", "format": "double", "type": "number" }, "gross_salary_total": { "description": "Total gross salary in local currency", "format": "double", "type": "number" }, "gross_salary_total_usd": { "description": "Total gross salary in USD", "format": "double", "type": "number" }, "mobility_fee_total": { "description": "Total mobility fee in local currency", "format": "double", "type": "number" }, "mobility_fee_total_usd": { "description": "Total mobility fee in USD", "format": "double", "type": "number" }, "monthly_cost_total": { "description": "Total monthly cost in local currency", "format": "double", "type": "number" }, "monthly_cost_total_usd": { "description": "Total monthly cost in USD", "format": "double", "type": "number" }, "platform_fee_total": { "description": "Total platform fee in local currency", "format": "double", "type": "number" }, "platform_fee_total_usd": { "description": "Total platform fee in USD", "format": "double", "type": "number" }, "recurring_allowance_total": { "description": "Total recurring allowance in local currency", "format": "double", "type": "number" }, "recurring_allowance_total_usd": { "description": "Total recurring allowance in USD", "format": "double", "type": "number" }, "salary_total": { "description": "Total salary in local currency", "format": "double", "type": "number" }, "salary_total_usd": { "description": "Total salary in USD", "format": "double", "type": "number" }, "severance_accrual_total": { "description": "Total severance accrual in local currency", "format": "double", "type": "number" }, "severance_accrual_total_usd": { "description": "Total severance accrual in USD", "format": "double", "type": "number" }, "updated_at": { "description": "Short date in format ISO-8601 (YYYY-MM-DD). For example: 2022-12-31.", "format": "date", "pattern": "^\\d{4}-\\d{2}-\\d{2}$", "type": [ "string", "null" ] } }, "title": "ContractsPostResponsesContentApplicationJsonSchemaDataQuote", "type": "object" }, "ContractsPostResponsesContentApplicationJsonSchemaDataQuoteBenefitsItems": { "properties": { "currency": { "description": "Currency code.", "maxLength": 3, "minLength": 3, "pattern": "^[A-Z]{3}$", "type": "string" }, "fee": { "description": "Fee in local currency", "format": "double", "type": "number" }, "fee_usd": { "description": "Fee in USD", "format": "double", "type": "number" }, "name": { "description": "Benefit's name", "type": "string" }, "plan": { "description": "Benefit's plan", "type": "string" }, "price": { "description": "Price in local currency", "format": "double", "type": "number" }, "price_usd": { "description": "Price in USD", "format": "double", "type": "number" } }, "title": "ContractsPostResponsesContentApplicationJsonSchemaDataQuoteBenefitsItems", "type": "object" }, "ContractsPostResponsesContentApplicationJsonSchemaDataQuoteBreakdownCosts": { "description": "Cost breakdown for the quote, grouped by billing cadence (e.g., monthly).", "properties": { "monthly": { "$ref": "#/components/schemas/ContractsPostResponsesContentApplicationJsonSchemaDataQuoteBreakdownCostsMonthly", "description": "Monthly cost breakdown for the quote." } }, "title": "ContractsPostResponsesContentApplicationJsonSchemaDataQuoteBreakdownCosts", "type": "object" }, "ContractsPostResponsesContentApplicationJsonSchemaDataQuoteBreakdownCostsMonthly": { "description": "Monthly cost breakdown for the quote.", "properties": { "costs": { "description": "List of individual monthly cost line items included in the quote.", "items": { "$ref": "#/components/schemas/ContractsPostResponsesContentApplicationJsonSchemaDataQuoteBreakdownCostsMonthlyCostsItems" }, "type": "array" }, "total": { "description": "Total costs in local currency", "format": "double", "type": "number" }, "total_usd": { "description": "Total costs in USD", "format": "double", "type": "number" } }, "title": "ContractsPostResponsesContentApplicationJsonSchemaDataQuoteBreakdownCostsMonthly", "type": "object" }, "ContractsPostResponsesContentApplicationJsonSchemaDataQuoteBreakdownCostsMonthlyCostsItems": { "properties": { "currency": { "description": "Currency code.", "maxLength": 3, "minLength": 3, "pattern": "^[A-Z]{3}$", "type": "string" }, "name": { "description": "Cost's name", "type": "string" }, "total": { "description": "Total cost in local currency", "format": "double", "type": "number" }, "total_usd": { "description": "Total cost in USD", "format": "double", "type": "number" } }, "title": "ContractsPostResponsesContentApplicationJsonSchemaDataQuoteBreakdownCostsMonthlyCostsItems", "type": "object" }, "ContractsPostResponsesContentApplicationJsonSchemaDataSeniority": { "description": "Seniority describes level of expertise at a job e.g. junior", "properties": { "id": { "description": "Unique identifier of this resource.", "format": "double", "type": "number" }, "level": { "description": "Level of seniority level e.g. 2", "format": "double", "type": [ "number", "null" ] }, "name": { "description": "Name of seniority level e.g. Mid (Individual Contributor Level 2)", "minLength": 1, "type": "string" } }, "required": [ "id", "name" ], "title": "ContractsPostResponsesContentApplicationJsonSchemaDataSeniority", "type": "object" }, "ContractsPostResponsesContentApplicationJsonSchemaDataSignatures": { "description": "List of signatures recorded for this contract.", "properties": { "client_signature": { "description": "normally name of client is used as signature", "type": "string" }, "client_signed_at": { "description": "Long date-time format following ISO-8601", "type": [ "string", "null" ] }, "signed_at": { "description": "Long date-time format following ISO-8601", "type": [ "string", "null" ] }, "worker_signature": { "description": "Signatures of client representative.", "type": "string" }, "worker_signed_at": { "description": "Long date-time format following ISO-8601", "type": [ "string", "null" ] } }, "required": [ "signed_at", "client_signature", "client_signed_at", "worker_signature", "worker_signed_at" ], "title": "ContractsPostResponsesContentApplicationJsonSchemaDataSignatures", "type": "object" }, "ContractsPostResponsesContentApplicationJsonSchemaDataStatus": { "description": "Status of a contract in Deel workflow", "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" ], "title": "ContractsPostResponsesContentApplicationJsonSchemaDataStatus", "type": "string" }, "ContractsPostResponsesContentApplicationJsonSchemaDataTerminationDate": { "description": "Contract termination date. When present, it is a date-time string in ISO-8601 format.", "oneOf": [ { "format": "date-time", "type": "string" }, { "$ref": "#/components/schemas/ContractsPostResponsesContentApplicationJsonSchemaDataTerminationDate1" } ], "title": "ContractsPostResponsesContentApplicationJsonSchemaDataTerminationDate" }, "ContractsPostResponsesContentApplicationJsonSchemaDataTerminationDate1": { "enum": [ "" ], "title": "ContractsPostResponsesContentApplicationJsonSchemaDataTerminationDate1", "type": "string" }, "ContractsPostResponsesContentApplicationJsonSchemaDataType": { "description": "Type of a contract", "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" ], "title": "ContractsPostResponsesContentApplicationJsonSchemaDataType", "type": "string" }, "ContractsPostResponsesContentApplicationJsonSchemaDataWhoReports": { "description": "Flag to indicate who is supposed to provide regular reports", "enum": [ "both", "client", "contractor", "" ], "title": "ContractsPostResponsesContentApplicationJsonSchemaDataWhoReports", "type": "string" }, "ContractsPostResponsesContentApplicationJsonSchemaDataWorker": { "description": "Worker details associated with the contract.", "properties": { "alternate_email": { "description": "List of alternate email addresses.", "items": { "$ref": "#/components/schemas/ContractsPostResponsesContentApplicationJsonSchemaDataWorkerAlternateEmailItems" }, "type": "array" }, "country": { "description": "Worker's country (location not nationality)", "type": [ "string", "null" ] }, "date_of_birth": { "description": "Long date-time format following ISO-8601", "format": "date-time", "type": [ "string", "null" ] }, "email": { "description": "User's email address.", "format": "email", "minLength": 5, "type": [ "string", "null" ] }, "expected_email": { "description": "Worker's email address.", "format": "email", "minLength": 5, "type": [ "string", "null" ] }, "first_name": { "description": "Worker's first name", "maxLength": 255, "type": [ "string", "null" ] }, "full_name": { "description": "Worker's full name.", "minLength": 1, "type": "string" }, "id": { "description": "A unique identifier for this resource.", "type": [ "string", "null" ] }, "image": { "description": "URL to worker's image", "format": "url", "type": "string" }, "last_name": { "description": "Worker's last name", "maxLength": 255, "type": [ "string", "null" ] }, "legal_entity": { "$ref": "#/components/schemas/ContractsPostResponsesContentApplicationJsonSchemaDataWorkerLegalEntity", "description": "Worker legal entity information, if applicable." }, "nationality": { "description": "Worker's nationality.", "type": [ "string", "null" ] } }, "title": "ContractsPostResponsesContentApplicationJsonSchemaDataWorker", "type": "object" }, "ContractsPostResponsesContentApplicationJsonSchemaDataWorkerAlternateEmailItems": { "properties": { "email": { "description": "User's email address.", "format": "email", "minLength": 5, "type": [ "string", "null" ] }, "isVerified": { "description": "True if email has been verified", "type": "boolean" } }, "required": [ "email", "isVerified" ], "title": "ContractsPostResponsesContentApplicationJsonSchemaDataWorkerAlternateEmailItems", "type": "object" }, "ContractsPostResponsesContentApplicationJsonSchemaDataWorkerLegalEntity": { "description": "Worker legal entity information, if applicable.", "properties": { "personal_name": { "description": "Name of a legal entity", "type": "string" }, "registration_number": { "description": "Registration number of a legal entity", "type": "string" }, "type": { "$ref": "#/components/schemas/ContractsPostResponsesContentApplicationJsonSchemaDataWorkerLegalEntityType", "description": "Type of a legal entity" } }, "required": [ "type", "personal_name", "registration_number" ], "title": "ContractsPostResponsesContentApplicationJsonSchemaDataWorkerLegalEntity", "type": "object" }, "ContractsPostResponsesContentApplicationJsonSchemaDataWorkerLegalEntityType": { "description": "Type of a legal entity", "enum": [ "individual", "company" ], "title": "ContractsPostResponsesContentApplicationJsonSchemaDataWorkerLegalEntityType", "type": "string" }, "ContractsPostResponsesContentApplicationJsonSchemaErrorsItems": { "properties": { "message": { "description": "Error response", "type": "string" } }, "required": [ "message" ], "title": "ContractsPostResponsesContentApplicationJsonSchemaErrorsItems", "type": "object" }, "ContractsPostResponsesContentApplicationJsonSchemaRequest": { "description": "Error request details", "properties": { "method": { "description": "Method of the API", "type": "string" }, "status": { "description": "Status of API response", "format": "double", "type": "number" } }, "title": "ContractsPostResponsesContentApplicationJsonSchemaRequest", "type": "object" }, "ContractsTerminationReasonsGetParametersOrder": { "default": "asc", "enum": [ "asc", "desc" ], "title": "ContractsTerminationReasonsGetParametersOrder", "type": "string" }, "ContractsTerminationReasonsGetParametersOrderBy": { "default": "frequency", "enum": [ "frequency" ], "title": "ContractsTerminationReasonsGetParametersOrderBy", "type": "string" }, "ContractsTerminationReasonsGetResponsesContentApplicationJsonSchemaDataItems": { "properties": { "created_at": { "description": "Timestamp when the termination reason was created", "format": "date-time", "type": "string" }, "frequency": { "$ref": "#/components/schemas/ContractsTerminationReasonsGetResponsesContentApplicationJsonSchemaDataItemsFrequency", "description": "How commonly this reason is used" }, "id": { "description": "Unique identifier for the termination reason", "format": "uuid", "type": "string" }, "name": { "description": "The display text for the termination reason that can be shown to users", "type": "string" }, "updated_at": { "description": "Timestamp when the termination reason was last updated", "format": "date-time", "type": "string" } }, "required": [ "id", "name", "frequency", "created_at", "updated_at" ], "title": "ContractsTerminationReasonsGetResponsesContentApplicationJsonSchemaDataItems", "type": "object" }, "ContractsTerminationReasonsGetResponsesContentApplicationJsonSchemaDataItemsFrequency": { "description": "How commonly this reason is used", "enum": [ "COMMON", "MOST_COMMON", "LESS_COMMON" ], "title": "ContractsTerminationReasonsGetResponsesContentApplicationJsonSchemaDataItemsFrequency", "type": "string" }, "ContractsTerminationReasonsGetResponsesContentApplicationJsonSchemaErrorsItems": { "properties": { "code": { "description": "Machine-readable error code", "type": "string" }, "message": { "description": "Human-readable explanation of the error", "type": "string" } }, "title": "ContractsTerminationReasonsGetResponsesContentApplicationJsonSchemaErrorsItems", "type": "object" }, "Contracts_approveAnEquityExercise-v2026-01-01_Response_200": { "properties": { "created_at": { "description": "The date when the equity exercise was created.", "format": "date", "type": "string" }, "employer_approval": { "description": "Indicates whether the employer has approved the equity exercise. Valid values: 'approved', 'rejected'.", "type": "string" }, "id": { "description": "Unique identifier of the equity exercise.", "format": "uuid", "type": "string" }, "status": { "description": "The current status of the equity exercise, e.g., 'approved' or 'pending'.", "type": "string" }, "updated_at": { "description": "The date when the equity exercise was last updated.", "format": "date", "type": "string" } }, "required": [ "id", "status", "created_at", "updated_at", "employer_approval" ], "title": "Contracts_approveAnEquityExercise-v2026-01-01_Response_200", "type": "object" }, "Contracts_createARequestToExerciseEquity-v2026-01-01_Response_201": { "properties": { "data": { "$ref": "#/components/schemas/EquityExercisePostResponsesContentApplicationJsonSchemaData" } }, "required": [ "data" ], "title": "Contracts_createARequestToExerciseEquity-v2026-01-01_Response_201", "type": "object" }, "Contracts_createWorkStatementPaymentPolicy-v2026-09-07_Response_201": { "properties": { "data": { "$ref": "#/components/schemas/WorkStatementPaymentPoliciesPostResponsesContentApplicationJsonSchemaData", "description": "The created work statement payment policy." } }, "required": [ "data" ], "title": "Contracts_createWorkStatementPaymentPolicy-v2026-09-07_Response_201", "type": "object" }, "Contracts_getContractTemplates-v2026-01-01_Response_200": { "properties": { "data": { "items": { "$ref": "#/components/schemas/ContractTemplatesGetResponsesContentApplicationJsonSchemaDataItems" }, "type": "array" } }, "title": "Contracts_getContractTemplates-v2026-01-01_Response_200", "type": "object" }, "Contracts_getWorkStatementPaymentPolicies-v2026-09-07_Response_200": { "properties": { "data": { "description": "The organization's work statement payment policies.", "items": { "$ref": "#/components/schemas/WorkStatementPaymentPoliciesGetResponsesContentApplicationJsonSchemaDataItems" }, "type": "array" } }, "required": [ "data" ], "title": "Contracts_getWorkStatementPaymentPolicies-v2026-09-07_Response_200", "type": "object" }, "Contracts_listContractTerminationReasons-v2026-01-01_Response_200": { "properties": { "data": { "items": { "$ref": "#/components/schemas/ContractsTerminationReasonsGetResponsesContentApplicationJsonSchemaDataItems" }, "type": "array" }, "has_more": { "description": "Indicates whether there are more results available", "type": "boolean" }, "next_cursor": { "description": "Cursor to use for fetching the next page. Null if there are no more results.", "type": [ "string", "null" ] }, "total_count": { "description": "Total number of termination reasons available", "type": "integer" } }, "required": [ "data", "has_more", "next_cursor", "total_count" ], "title": "Contracts_listContractTerminationReasons-v2026-01-01_Response_200", "type": "object" }, "Contracts_retrieveContractPdfDownloadLink-v2026-01-01_Response_200": { "properties": { "data": { "$ref": "#/components/schemas/WorkersContractsContractIdPdfGetResponsesContentApplicationJsonSchemaData" } }, "required": [ "data" ], "title": "Contracts_retrieveContractPdfDownloadLink-v2026-01-01_Response_200", "type": "object" }, "Contracts_signAmendment-v2026-01-01_Response_201": { "properties": { "data": { "$ref": "#/components/schemas/WorkersAmendmentsAmendmentIdSignPostResponsesContentApplicationJsonSchemaData" } }, "required": [ "data" ], "title": "Contracts_signAmendment-v2026-01-01_Response_201", "type": "object" }, "Contracts_signGlobalPayrollAmendment-v2026-09-29_Response_200": { "properties": { "data": { "$ref": "#/components/schemas/ContractsContractIdAmendmentsAmendmentIdSignPostResponsesContentApplicationJsonSchemaData" } }, "required": [ "data" ], "title": "Contracts_signGlobalPayrollAmendment-v2026-09-29_Response_200", "type": "object" }, "Contracts_signWorkerContract-v2026-01-01_Response_201": { "properties": { "data": { "$ref": "#/components/schemas/WorkersContractsContractIdSignaturesPostResponsesContentApplicationJsonSchemaData" } }, "required": [ "data" ], "title": "Contracts_signWorkerContract-v2026-01-01_Response_201", "type": "object" }, "Contracts_updateContractPlatformPaymentType-v2026-06-24_Response_200": { "properties": { "data": { "$ref": "#/components/schemas/ContractsContractIdPlatformPaymentPatchResponsesContentApplicationJsonSchemaData", "description": "The updated contract. See `GET /contracts/{contract_id}` for the full response shape." } }, "required": [ "data" ], "title": "Contracts_updateContractPlatformPaymentType-v2026-06-24_Response_200", "type": "object" }, "Cost_Centers_assignCostCentersToAnEmploymentContract-v2026-01-01_Response_201": { "properties": { "data": { "$ref": "#/components/schemas/ContractsContractIdCostCentersPostResponsesContentApplicationJsonSchemaData" } }, "title": "Cost Centers_assignCostCentersToAnEmploymentContract-v2026-01-01_Response_201", "type": "object" }, "Cost_Centers_syncCostCentersForLegalEntity-v2026-01-01_Response_201": { "properties": { "data": { "items": { "$ref": "#/components/schemas/LegalEntitiesLegalEntityIdCostCentersSynchronizePostResponsesContentApplicationJsonSchemaDataItems" }, "type": "array" } }, "title": "Cost Centers_syncCostCentersForLegalEntity-v2026-01-01_Response_201", "type": "object" }, "CreateABankTransferMethod-v2026-01-01RequestBadRequestError": { "properties": { "errors": { "items": { "$ref": "#/components/schemas/PayoutsContractorsMethodsPostResponsesContentApplicationJsonSchemaErrorsItems" }, "type": "array" } }, "title": "CreateABankTransferMethod-v2026-01-01RequestBadRequestError", "type": "object" }, "CreateADirectEmployee-v2026-01-01RequestBadRequestError": { "properties": { "error": { "$ref": "#/components/schemas/PeoplePostResponsesContentApplicationJsonSchemaError" } }, "required": [ "error" ], "title": "CreateADirectEmployee-v2026-01-01RequestBadRequestError", "type": "object" }, "CreateADirectEmployee-v2026-01-01RequestInternalServerError": { "properties": { "error": { "$ref": "#/components/schemas/PeoplePostResponsesContentApplicationJsonSchemaError" } }, "required": [ "error" ], "title": "CreateADirectEmployee-v2026-01-01RequestInternalServerError", "type": "object" }, "CreateAGlobalPayrollGpContract-v2026-01-01RequestBadRequestError": { "properties": { "errors": { "items": { "$ref": "#/components/schemas/ContractsGpPostResponsesContentApplicationJsonSchemaErrorsItems" }, "type": "array" } }, "title": "CreateAGlobalPayrollGpContract-v2026-01-01RequestBadRequestError", "type": "object" }, "CreateAGlobalPayrollGpContract-v2026-01-01RequestInternalServerError": { "properties": { "errors": { "items": { "$ref": "#/components/schemas/ContractsGpPostResponsesContentApplicationJsonSchemaErrorsItems" }, "type": "array" } }, "title": "CreateAGlobalPayrollGpContract-v2026-01-01RequestInternalServerError", "type": "object" }, "CreateANewAdjustment-v2026-01-01RequestBadRequestError": { "properties": { "errors": { "items": { "$ref": "#/components/schemas/AdjustmentsPostResponsesContentApplicationJsonSchemaErrorsItems" }, "type": "array" } }, "required": [ "errors" ], "title": "CreateANewAdjustment-v2026-01-01RequestBadRequestError", "type": "object" }, "CreateANewContract-v2026-01-01RequestBadRequestError": { "properties": { "errors": { "description": "Error messages", "items": { "$ref": "#/components/schemas/ContractsPostResponsesContentApplicationJsonSchemaErrorsItems" }, "type": "array" }, "request": { "$ref": "#/components/schemas/ContractsPostResponsesContentApplicationJsonSchemaRequest", "description": "Error request details" } }, "required": [ "errors" ], "title": "CreateANewContract-v2026-01-01RequestBadRequestError", "type": "object" }, "CreateANewHrisOrganizationStructure-v2026-01-01RequestBadRequestError": { "properties": { "errors": { "items": { "$ref": "#/components/schemas/HrisOrganizationStructuresPostResponsesContentApplicationJsonSchemaErrorsItems" }, "type": "array" } }, "title": "CreateANewHrisOrganizationStructure-v2026-01-01RequestBadRequestError", "type": "object" }, "CreateANewHrisOrganizationStructure-v2026-01-01RequestInternalServerError": { "properties": { "errors": { "items": { "$ref": "#/components/schemas/HrisOrganizationStructuresPostResponsesContentApplicationJsonSchemaErrorsItems" }, "type": "array" } }, "title": "CreateANewHrisOrganizationStructure-v2026-01-01RequestInternalServerError", "type": "object" }, "CreateANewTask-v2026-01-01RequestBadRequestError": { "properties": { "error": { "type": "string" } }, "title": "CreateANewTask-v2026-01-01RequestBadRequestError", "type": "object" }, "CreateANewTask-v2026-01-01RequestInternalServerError": { "properties": { "error": { "type": "string" } }, "title": "CreateANewTask-v2026-01-01RequestInternalServerError", "type": "object" }, "CreateANewTask-v2026-01-01RequestUnauthorizedError": { "properties": { "error": { "type": "string" } }, "title": "CreateANewTask-v2026-01-01RequestUnauthorizedError", "type": "object" }, "CreateAParentWorkerRelationWithExternalId-v2026-01-01RequestBadRequestError": { "properties": { "errors": { "items": { "$ref": "#/components/schemas/HrisWorkerRelationsProfileExternalProfileIdParentPutResponsesContentApplicationJsonSchemaErrorsItems" }, "type": "array" } }, "required": [ "errors" ], "title": "CreateAParentWorkerRelationWithExternalId-v2026-01-01RequestBadRequestError", "type": "object" }, "CreateAParentWorkerRelationWithExternalId-v2026-01-01RequestNotFoundError": { "properties": { "errors": { "items": { "$ref": "#/components/schemas/HrisWorkerRelationsProfileExternalProfileIdParentPutResponsesContentApplicationJsonSchemaErrorsItems" }, "type": "array" } }, "required": [ "errors" ], "title": "CreateAParentWorkerRelationWithExternalId-v2026-01-01RequestNotFoundError", "type": "object" }, "CreateAPersonWithoutAContract-v2026-01-01RequestBadRequestError": { "properties": { "error": { "$ref": "#/components/schemas/PwacPostResponsesContentApplicationJsonSchemaError" } }, "required": [ "error" ], "title": "CreateAPersonWithoutAContract-v2026-01-01RequestBadRequestError", "type": "object" }, "CreateAPersonWithoutAContract-v2026-01-01RequestInternalServerError": { "properties": { "error": { "$ref": "#/components/schemas/PwacPostResponsesContentApplicationJsonSchemaError" } }, "required": [ "error" ], "title": "CreateAPersonWithoutAContract-v2026-01-01RequestInternalServerError", "type": "object" }, "CreateARequestToExerciseEquity-v2026-01-01RequestBadRequestError": { "properties": { "errors": { "items": { "$ref": "#/components/schemas/EquityExercisePostResponsesContentApplicationJsonSchemaErrorsItems" }, "type": "array" } }, "required": [ "errors" ], "title": "CreateARequestToExerciseEquity-v2026-01-01RequestBadRequestError", "type": "object" }, "CreateARequestToExerciseEquity-v2026-01-01RequestForbiddenError": { "properties": { "errors": { "items": { "$ref": "#/components/schemas/EquityExercisePostResponsesContentApplicationJsonSchemaErrorsItems" }, "type": "array" } }, "required": [ "errors" ], "title": "CreateARequestToExerciseEquity-v2026-01-01RequestForbiddenError", "type": "object" }, "CreateARequestToExerciseEquity-v2026-01-01RequestInternalServerError": { "properties": { "errors": { "items": { "$ref": "#/components/schemas/EquityExercisePostResponsesContentApplicationJsonSchemaErrorsItems" }, "type": "array" } }, "required": [ "errors" ], "title": "CreateARequestToExerciseEquity-v2026-01-01RequestInternalServerError", "type": "object" }, "CreateARequestToExerciseEquity-v2026-01-01RequestNotFoundError": { "properties": { "errors": { "items": { "$ref": "#/components/schemas/EquityExercisePostResponsesContentApplicationJsonSchemaErrorsItems" }, "type": "array" } }, "required": [ "errors" ], "title": "CreateARequestToExerciseEquity-v2026-01-01RequestNotFoundError", "type": "object" }, "CreateARequestToExerciseEquity-v2026-01-01RequestTooManyRequestsError": { "properties": { "errors": { "items": { "$ref": "#/components/schemas/EquityExercisePostResponsesContentApplicationJsonSchemaErrorsItems" }, "type": "array" } }, "required": [ "errors" ], "title": "CreateARequestToExerciseEquity-v2026-01-01RequestTooManyRequestsError", "type": "object" }, "CreateARequestToExerciseEquity-v2026-01-01RequestUnauthorizedError": { "properties": { "errors": { "items": { "$ref": "#/components/schemas/EquityExercisePostResponsesContentApplicationJsonSchemaErrorsItems" }, "type": "array" } }, "required": [ "errors" ], "title": "CreateARequestToExerciseEquity-v2026-01-01RequestUnauthorizedError", "type": "object" }, "CreateARequestToExerciseEquity-v2026-01-01RequestUnprocessableEntityError": { "properties": { "errors": { "items": { "$ref": "#/components/schemas/EquityExercisePostResponsesContentApplicationJsonSchemaErrorsItems" }, "type": "array" } }, "required": [ "errors" ], "title": "CreateARequestToExerciseEquity-v2026-01-01RequestUnprocessableEntityError", "type": "object" }, "CreateATaxFormForAWorker-v2026-01-01RequestBadRequestError": { "properties": { "errors": { "items": { "$ref": "#/components/schemas/WorkersTaxFormsPostResponsesContentApplicationJsonSchemaErrorsItems" }, "type": "array" } }, "title": "CreateATaxFormForAWorker-v2026-01-01RequestBadRequestError", "type": "object" }, "CreateATaxFormForAWorker-v2026-01-01RequestConflictError": { "properties": { "errors": { "items": { "$ref": "#/components/schemas/WorkersTaxFormsPostResponsesContentApplicationJsonSchemaErrorsItems" }, "type": "array" } }, "title": "CreateATaxFormForAWorker-v2026-01-01RequestConflictError", "type": "object" }, "CreateATaxFormForAWorker-v2026-01-01RequestForbiddenError": { "properties": { "errors": { "items": { "$ref": "#/components/schemas/WorkersTaxFormsPostResponsesContentApplicationJsonSchemaErrorsItems" }, "type": "array" } }, "title": "CreateATaxFormForAWorker-v2026-01-01RequestForbiddenError", "type": "object" }, "CreateATaxFormForAWorker-v2026-01-01RequestInternalServerError": { "properties": { "errors": { "items": { "$ref": "#/components/schemas/WorkersTaxFormsPostResponsesContentApplicationJsonSchemaErrorsItems" }, "type": "array" } }, "title": "CreateATaxFormForAWorker-v2026-01-01RequestInternalServerError", "type": "object" }, "CreateATaxFormForAWorker-v2026-01-01RequestNotFoundError": { "properties": { "errors": { "items": { "$ref": "#/components/schemas/WorkersTaxFormsPostResponsesContentApplicationJsonSchemaErrorsItems" }, "type": "array" } }, "title": "CreateATaxFormForAWorker-v2026-01-01RequestNotFoundError", "type": "object" }, "CreateATimesheetEntry-v2026-01-01RequestBadRequestError": { "properties": { "errors": { "description": "Validation or business rule errors describing why the timesheet entry could not be created.", "items": { "$ref": "#/components/schemas/TimesheetsPostResponsesContentApplicationJsonSchemaErrorsItems" }, "type": "array" } }, "required": [ "errors" ], "title": "CreateATimesheetEntry-v2026-01-01RequestBadRequestError", "type": "object" }, "CreateATimesheetEntry-v2026-01-01RequestInternalServerError": { "properties": { "errors": { "description": "Generic upstream or internal errors emitted when the timesheet entry cannot be processed.", "items": { "$ref": "#/components/schemas/TimesheetsPostResponsesContentApplicationJsonSchemaErrorsItems" }, "type": "array" } }, "required": [ "errors" ], "title": "CreateATimesheetEntry-v2026-01-01RequestInternalServerError", "type": "object" }, "CreateAWorkerRelation-v2026-01-01RequestBadRequestError": { "properties": { "errors": { "items": { "$ref": "#/components/schemas/HrisWorkerRelationsProfilePostResponsesContentApplicationJsonSchemaErrorsItems" }, "type": "array" } }, "required": [ "errors" ], "title": "CreateAWorkerRelation-v2026-01-01RequestBadRequestError", "type": "object" }, "CreateAWorkerRelation-v2026-01-01RequestNotFoundError": { "properties": { "errors": { "items": { "$ref": "#/components/schemas/HrisWorkerRelationsProfilePostResponsesContentApplicationJsonSchemaErrorsItems" }, "type": "array" } }, "required": [ "errors" ], "title": "CreateAWorkerRelation-v2026-01-01RequestNotFoundError", "type": "object" }, "CreateAnEorContractAmendment-v2026-01-01RequestBadRequestError": { "properties": { "errors": { "items": { "$ref": "#/components/schemas/EorContractsContractIdAmendmentsPostResponsesContentApplicationJsonSchemaErrorsItems" }, "type": "array" } }, "required": [ "errors" ], "title": "CreateAnEorContractAmendment-v2026-01-01RequestBadRequestError", "type": "object" }, "CreateAnEorContractAmendment-v2026-01-01RequestConflictError": { "properties": { "errors": { "items": { "$ref": "#/components/schemas/EorContractsContractIdAmendmentsPostResponsesContentApplicationJsonSchemaErrorsItems" }, "type": "array" } }, "required": [ "errors" ], "title": "CreateAnEorContractAmendment-v2026-01-01RequestConflictError", "type": "object" }, "CreateAnEorContractAmendment-v2026-01-01RequestForbiddenError": { "properties": { "errors": { "items": { "$ref": "#/components/schemas/EorContractsContractIdAmendmentsPostResponsesContentApplicationJsonSchemaErrorsItems" }, "type": "array" } }, "required": [ "errors" ], "title": "CreateAnEorContractAmendment-v2026-01-01RequestForbiddenError", "type": "object" }, "CreateAnEorContractAmendment-v2026-01-01RequestInternalServerError": { "properties": { "errors": { "items": { "$ref": "#/components/schemas/EorContractsContractIdAmendmentsPostResponsesContentApplicationJsonSchemaErrorsItems" }, "type": "array" } }, "required": [ "errors" ], "title": "CreateAnEorContractAmendment-v2026-01-01RequestInternalServerError", "type": "object" }, "CreateAnEorContractAmendment-v2026-01-01RequestNotFoundError": { "properties": { "errors": { "items": { "$ref": "#/components/schemas/EorContractsContractIdAmendmentsPostResponsesContentApplicationJsonSchemaErrorsItems" }, "type": "array" } }, "required": [ "errors" ], "title": "CreateAnEorContractAmendment-v2026-01-01RequestNotFoundError", "type": "object" }, "CreateAnEorContractAmendment-v2026-01-01RequestUnprocessableEntityError": { "properties": { "errors": { "description": "List of validation or business rule errors.", "items": { "$ref": "#/components/schemas/EorContractsContractIdAmendmentsPostResponsesContentApplicationJsonSchemaErrorsItems" }, "type": "array" } }, "required": [ "errors" ], "title": "CreateAnEorContractAmendment-v2026-01-01RequestUnprocessableEntityError", "type": "object" }, "CreateAnImmigrationCase-v2026-01-01RequestBadRequestError": { "properties": { "errors": { "items": { "$ref": "#/components/schemas/ImmigrationClientCasesPostResponsesContentApplicationJsonSchemaErrorsItems" }, "type": "array" } }, "title": "CreateAnImmigrationCase-v2026-01-01RequestBadRequestError", "type": "object" }, "CreateAnImmigrationCase-v2026-01-01RequestInternalServerError": { "properties": { "errors": { "items": { "$ref": "#/components/schemas/ImmigrationClientCasesPostResponsesContentApplicationJsonSchemaErrorsItems" }, "type": "array" } }, "title": "CreateAnImmigrationCase-v2026-01-01RequestInternalServerError", "type": "object" }, "CreateAnInvoiceAdjustment-v2026-01-01RequestBadRequestError": { "properties": { "errors": { "description": "Validation or business rule errors describing why the invoice adjustment could not be created.", "items": { "$ref": "#/components/schemas/InvoiceAdjustmentsPostResponsesContentApplicationJsonSchemaErrorsItems" }, "type": "array" } }, "required": [ "errors" ], "title": "CreateAnInvoiceAdjustment-v2026-01-01RequestBadRequestError", "type": "object" }, "CreateAnInvoiceAdjustment-v2026-01-01RequestInternalServerError": { "properties": { "errors": { "description": "Generic upstream or internal errors emitted when the invoice adjustment cannot be processed.", "items": { "$ref": "#/components/schemas/InvoiceAdjustmentsPostResponsesContentApplicationJsonSchemaErrorsItems" }, "type": "array" } }, "required": [ "errors" ], "title": "CreateAnInvoiceAdjustment-v2026-01-01RequestInternalServerError", "type": "object" }, "CreateApplication-v2026-01-01RequestBadRequestError": { "properties": { "errors": { "description": "List of error objects", "items": { "$ref": "#/components/schemas/AtsApplicationsPostResponsesContentApplicationJsonSchemaErrorsItems" }, "type": "array" } }, "required": [ "errors" ], "title": "CreateApplication-v2026-01-01RequestBadRequestError", "type": "object" }, "CreateApplication-v2026-01-01RequestForbiddenError": { "properties": { "errors": { "description": "List of error objects", "items": { "$ref": "#/components/schemas/AtsApplicationsPostResponsesContentApplicationJsonSchemaErrorsItems" }, "type": "array" } }, "required": [ "errors" ], "title": "CreateApplication-v2026-01-01RequestForbiddenError", "type": "object" }, "CreateApplication-v2026-01-01RequestInternalServerError": { "properties": { "errors": { "description": "List of error objects", "items": { "$ref": "#/components/schemas/AtsApplicationsPostResponsesContentApplicationJsonSchemaErrorsItems" }, "type": "array" } }, "required": [ "errors" ], "title": "CreateApplication-v2026-01-01RequestInternalServerError", "type": "object" }, "CreateAsset-v2026-09-15RequestBadRequestError": { "properties": { "errors": { "items": { "$ref": "#/components/schemas/ItAssetsPostResponsesContentApplicationJsonSchemaErrorsItems" }, "type": "array" } }, "required": [ "errors" ], "title": "CreateAsset-v2026-09-15RequestBadRequestError", "type": "object" }, "CreateAsset-v2026-09-15RequestConflictError": { "properties": { "errors": { "items": { "$ref": "#/components/schemas/ItAssetsPostResponsesContentApplicationJsonSchemaErrorsItems" }, "type": "array" } }, "required": [ "errors" ], "title": "CreateAsset-v2026-09-15RequestConflictError", "type": "object" }, "CreateAsset-v2026-09-15RequestForbiddenError": { "properties": { "errors": { "items": { "$ref": "#/components/schemas/ItAssetsPostResponsesContentApplicationJsonSchemaErrorsItems" }, "type": "array" } }, "required": [ "errors" ], "title": "CreateAsset-v2026-09-15RequestForbiddenError", "type": "object" }, "CreateAsset-v2026-09-15RequestInternalServerError": { "properties": { "errors": { "items": { "$ref": "#/components/schemas/ItAssetsPostResponsesContentApplicationJsonSchemaErrorsItems" }, "type": "array" } }, "required": [ "errors" ], "title": "CreateAsset-v2026-09-15RequestInternalServerError", "type": "object" }, "CreateAsset-v2026-09-15RequestNotFoundError": { "properties": { "errors": { "items": { "$ref": "#/components/schemas/ItAssetsPostResponsesContentApplicationJsonSchemaErrorsItems" }, "type": "array" } }, "required": [ "errors" ], "title": "CreateAsset-v2026-09-15RequestNotFoundError", "type": "object" }, "CreateAsset-v2026-09-15RequestUnauthorizedError": { "properties": { "errors": { "items": { "$ref": "#/components/schemas/ItAssetsPostResponsesContentApplicationJsonSchemaErrorsItems" }, "type": "array" } }, "required": [ "errors" ], "title": "CreateAsset-v2026-09-15RequestUnauthorizedError", "type": "object" }, "CreateAtsAttachmentFile-v2026-01-01RequestBadRequestError": { "properties": { "errors": { "description": "List of error objects", "items": { "$ref": "#/components/schemas/AtsAttachmentsAttachableTypeSlugAttachableIdAttachmentTypeSlugPostResponsesContentApplicationJsonSchemaErrorsItems" }, "type": "array" } }, "required": [ "errors" ], "title": "CreateAtsAttachmentFile-v2026-01-01RequestBadRequestError", "type": "object" }, "CreateAtsAttachmentFile-v2026-01-01RequestForbiddenError": { "properties": { "errors": { "description": "List of error objects", "items": { "$ref": "#/components/schemas/AtsAttachmentsAttachableTypeSlugAttachableIdAttachmentTypeSlugPostResponsesContentApplicationJsonSchemaErrorsItems" }, "type": "array" } }, "required": [ "errors" ], "title": "CreateAtsAttachmentFile-v2026-01-01RequestForbiddenError", "type": "object" }, "CreateAtsAttachmentFile-v2026-01-01RequestInternalServerError": { "properties": { "errors": { "description": "List of error objects", "items": { "$ref": "#/components/schemas/AtsAttachmentsAttachableTypeSlugAttachableIdAttachmentTypeSlugPostResponsesContentApplicationJsonSchemaErrorsItems" }, "type": "array" } }, "required": [ "errors" ], "title": "CreateAtsAttachmentFile-v2026-01-01RequestInternalServerError", "type": "object" }, "CreateAtsCandidate-v2026-01-01RequestBadRequestError": { "properties": { "errors": { "description": "List of error objects", "items": { "$ref": "#/components/schemas/AtsCandidatesPostResponsesContentApplicationJsonSchemaErrorsItems" }, "type": "array" } }, "required": [ "errors" ], "title": "CreateAtsCandidate-v2026-01-01RequestBadRequestError", "type": "object" }, "CreateAtsCandidate-v2026-01-01RequestForbiddenError": { "properties": { "errors": { "description": "List of error objects", "items": { "$ref": "#/components/schemas/AtsCandidatesPostResponsesContentApplicationJsonSchemaErrorsItems" }, "type": "array" } }, "required": [ "errors" ], "title": "CreateAtsCandidate-v2026-01-01RequestForbiddenError", "type": "object" }, "CreateAtsCandidate-v2026-01-01RequestInternalServerError": { "properties": { "errors": { "description": "List of error objects", "items": { "$ref": "#/components/schemas/AtsCandidatesPostResponsesContentApplicationJsonSchemaErrorsItems" }, "type": "array" } }, "required": [ "errors" ], "title": "CreateAtsCandidate-v2026-01-01RequestInternalServerError", "type": "object" }, "CreateAtsCandidateAttachment-v2026-09-16RequestBadRequestError": { "properties": { "errors": { "description": "List of error objects", "items": { "$ref": "#/components/schemas/AtsCandidatesCandidateIdAttachmentsPostResponsesContentApplicationJsonSchemaErrorsItems" }, "type": "array" } }, "required": [ "errors" ], "title": "CreateAtsCandidateAttachment-v2026-09-16RequestBadRequestError", "type": "object" }, "CreateAtsCandidateAttachment-v2026-09-16RequestForbiddenError": { "properties": { "errors": { "description": "List of error objects", "items": { "$ref": "#/components/schemas/AtsCandidatesCandidateIdAttachmentsPostResponsesContentApplicationJsonSchemaErrorsItems" }, "type": "array" } }, "required": [ "errors" ], "title": "CreateAtsCandidateAttachment-v2026-09-16RequestForbiddenError", "type": "object" }, "CreateAtsCandidateAttachment-v2026-09-16RequestInternalServerError": { "properties": { "errors": { "description": "List of error objects", "items": { "$ref": "#/components/schemas/AtsCandidatesCandidateIdAttachmentsPostResponsesContentApplicationJsonSchemaErrorsItems" }, "type": "array" } }, "required": [ "errors" ], "title": "CreateAtsCandidateAttachment-v2026-09-16RequestInternalServerError", "type": "object" }, "CreateAtsJob-v2026-01-01RequestBadRequestError": { "properties": { "errors": { "description": "List of error objects", "items": { "$ref": "#/components/schemas/AtsJobsPostResponsesContentApplicationJsonSchemaErrorsItems" }, "type": "array" } }, "required": [ "errors" ], "title": "CreateAtsJob-v2026-01-01RequestBadRequestError", "type": "object" }, "CreateAtsJob-v2026-01-01RequestForbiddenError": { "properties": { "errors": { "description": "List of error objects", "items": { "$ref": "#/components/schemas/AtsJobsPostResponsesContentApplicationJsonSchemaErrorsItems" }, "type": "array" } }, "required": [ "errors" ], "title": "CreateAtsJob-v2026-01-01RequestForbiddenError", "type": "object" }, "CreateAtsJob-v2026-01-01RequestInternalServerError": { "properties": { "errors": { "description": "List of error objects", "items": { "$ref": "#/components/schemas/AtsJobsPostResponsesContentApplicationJsonSchemaErrorsItems" }, "type": "array" } }, "required": [ "errors" ], "title": "CreateAtsJob-v2026-01-01RequestInternalServerError", "type": "object" }, "CreateCandidateTags-v2024-06-12RequestBadRequestError": { "properties": { "errors": { "description": "List of error objects", "items": { "$ref": "#/components/schemas/AtsCandidatesCandidateIdTagsPostResponsesContentApplicationJsonSchemaErrorsItems" }, "type": "array" } }, "required": [ "errors" ], "title": "CreateCandidateTags-v2024-06-12RequestBadRequestError", "type": "object" }, "CreateCandidateTags-v2024-06-12RequestForbiddenError": { "properties": { "errors": { "description": "List of error objects", "items": { "$ref": "#/components/schemas/AtsCandidatesCandidateIdTagsPostResponsesContentApplicationJsonSchemaErrorsItems" }, "type": "array" } }, "required": [ "errors" ], "title": "CreateCandidateTags-v2024-06-12RequestForbiddenError", "type": "object" }, "CreateCandidateTags-v2024-06-12RequestInternalServerError": { "properties": { "errors": { "description": "List of error objects", "items": { "$ref": "#/components/schemas/AtsCandidatesCandidateIdTagsPostResponsesContentApplicationJsonSchemaErrorsItems" }, "type": "array" } }, "required": [ "errors" ], "title": "CreateCandidateTags-v2024-06-12RequestInternalServerError", "type": "object" }, "CreateChildOrgSessionToken-v2026-07-14RequestBadRequestError": { "properties": { "errors": { "description": "The list of errors that caused the request to fail.", "items": { "$ref": "#/components/schemas/OrganizationsChildrenChildOrganizationIdSessionPostResponsesContentApplicationJsonSchemaErrorsItems" }, "type": "array" } }, "required": [ "errors" ], "title": "CreateChildOrgSessionToken-v2026-07-14RequestBadRequestError", "type": "object" }, "CreateChildOrgSessionToken-v2026-07-14RequestForbiddenError": { "properties": { "errors": { "description": "The list of errors that caused the request to fail.", "items": { "$ref": "#/components/schemas/OrganizationsChildrenChildOrganizationIdSessionPostResponsesContentApplicationJsonSchemaErrorsItems" }, "type": "array" } }, "required": [ "errors" ], "title": "CreateChildOrgSessionToken-v2026-07-14RequestForbiddenError", "type": "object" }, "CreateChildOrgSessionToken-v2026-07-14RequestNotFoundError": { "properties": { "errors": { "description": "The list of errors that caused the request to fail.", "items": { "$ref": "#/components/schemas/OrganizationsChildrenChildOrganizationIdSessionPostResponsesContentApplicationJsonSchemaErrorsItems" }, "type": "array" } }, "required": [ "errors" ], "title": "CreateChildOrgSessionToken-v2026-07-14RequestNotFoundError", "type": "object" }, "CreateChildOrgSessionToken-v2026-07-14RequestUnauthorizedError": { "properties": { "errors": { "description": "The list of errors that caused the request to fail.", "items": { "$ref": "#/components/schemas/OrganizationsChildrenChildOrganizationIdSessionPostResponsesContentApplicationJsonSchemaErrorsItems" }, "type": "array" } }, "required": [ "errors" ], "title": "CreateChildOrgSessionToken-v2026-07-14RequestUnauthorizedError", "type": "object" }, "CreateChildOrganization-v2026-01-01RequestBadRequestError": { "properties": { "errors": { "items": { "$ref": "#/components/schemas/OrganizationsChildrenPostResponsesContentApplicationJsonSchemaErrorsItems" }, "type": "array" }, "request": { "$ref": "#/components/schemas/OrganizationsChildrenPostResponsesContentApplicationJsonSchemaRequest" } }, "title": "CreateChildOrganization-v2026-01-01RequestBadRequestError", "type": "object" }, "CreateChildOrganization-v2026-01-01RequestConflictError": { "properties": { "errors": { "items": { "$ref": "#/components/schemas/OrganizationsChildrenPostResponsesContentApplicationJsonSchemaErrorsItems" }, "type": "array" } }, "required": [ "errors" ], "title": "CreateChildOrganization-v2026-01-01RequestConflictError", "type": "object" }, "CreateChildOrganization-v2026-01-01RequestInternalServerError": { "properties": { "errors": { "items": { "$ref": "#/components/schemas/OrganizationsChildrenPostResponsesContentApplicationJsonSchemaErrorsItems" }, "type": "array" } }, "title": "CreateChildOrganization-v2026-01-01RequestInternalServerError", "type": "object" }, "CreateChildOrganization-v2026-01-01RequestTooManyRequestsError": { "properties": { "errors": { "items": { "$ref": "#/components/schemas/OrganizationsChildrenPostResponsesContentApplicationJsonSchemaErrorsItems" }, "type": "array" } }, "required": [ "errors" ], "title": "CreateChildOrganization-v2026-01-01RequestTooManyRequestsError", "type": "object" }, "CreateChildWorkerRelation-v2026-01-01RequestBadRequestError": { "properties": { "errors": { "items": { "$ref": "#/components/schemas/HrisWorkerRelationsProfileHrisProfileOidChildPutResponsesContentApplicationJsonSchemaErrorsItems" }, "type": "array" } }, "required": [ "errors" ], "title": "CreateChildWorkerRelation-v2026-01-01RequestBadRequestError", "type": "object" }, "CreateChildWorkerRelation-v2026-01-01RequestNotFoundError": { "properties": { "errors": { "items": { "$ref": "#/components/schemas/HrisWorkerRelationsProfileHrisProfileOidChildPutResponsesContentApplicationJsonSchemaErrorsItems" }, "type": "array" } }, "required": [ "errors" ], "title": "CreateChildWorkerRelation-v2026-01-01RequestNotFoundError", "type": "object" }, "CreateConsentToken-v2026-01-01RequestBadRequestError": { "properties": { "error": { "type": "string" } }, "title": "CreateConsentToken-v2026-01-01RequestBadRequestError", "type": "object" }, "CreateConsentToken-v2026-01-01RequestInternalServerError": { "properties": { "error": { "type": "string" } }, "title": "CreateConsentToken-v2026-01-01RequestInternalServerError", "type": "object" }, "CreateDealRegistration-v2026-09-30RequestBadRequestError": { "properties": { "errors": { "items": { "$ref": "#/components/schemas/OrganizationsDealRegistrationsPostResponsesContentApplicationJsonSchemaErrorsItems" }, "type": "array" } }, "required": [ "errors" ], "title": "CreateDealRegistration-v2026-09-30RequestBadRequestError", "type": "object" }, "CreateDealRegistration-v2026-09-30RequestForbiddenError": { "properties": { "errors": { "items": { "$ref": "#/components/schemas/OrganizationsDealRegistrationsPostResponsesContentApplicationJsonSchemaErrorsItems" }, "type": "array" } }, "required": [ "errors" ], "title": "CreateDealRegistration-v2026-09-30RequestForbiddenError", "type": "object" }, "CreateDealRegistration-v2026-09-30RequestInternalServerError": { "properties": { "errors": { "items": { "$ref": "#/components/schemas/OrganizationsDealRegistrationsPostResponsesContentApplicationJsonSchemaErrorsItems" }, "type": "array" } }, "required": [ "errors" ], "title": "CreateDealRegistration-v2026-09-30RequestInternalServerError", "type": "object" }, "CreateDealRegistration-v2026-09-30RequestTooManyRequestsError": { "properties": { "errors": { "items": { "$ref": "#/components/schemas/OrganizationsDealRegistrationsPostResponsesContentApplicationJsonSchemaErrorsItems" }, "type": "array" } }, "required": [ "errors" ], "title": "CreateDealRegistration-v2026-09-30RequestTooManyRequestsError", "type": "object" }, "CreateDealRegistration-v2026-09-30RequestUnauthorizedError": { "properties": { "errors": { "items": { "$ref": "#/components/schemas/OrganizationsDealRegistrationsPostResponsesContentApplicationJsonSchemaErrorsItems" }, "type": "array" } }, "required": [ "errors" ], "title": "CreateDealRegistration-v2026-09-30RequestUnauthorizedError", "type": "object" }, "CreateEorWorker-v2026-01-01RequestBadRequestError": { "properties": { "errors": { "items": { "$ref": "#/components/schemas/EorWorkerPostResponsesContentApplicationJsonSchemaErrorsItems" }, "type": "array" }, "request": { "$ref": "#/components/schemas/EorWorkerPostResponsesContentApplicationJsonSchemaRequest" } }, "title": "CreateEorWorker-v2026-01-01RequestBadRequestError", "type": "object" }, "CreateEquityOrTokenTaxEvent-v2026-01-01RequestBadRequestError": { "properties": { "errors": { "items": { "$ref": "#/components/schemas/EquitiesTokensTaxEventsPostResponsesContentApplicationJsonSchemaErrorsItems" }, "type": "array" } }, "title": "CreateEquityOrTokenTaxEvent-v2026-01-01RequestBadRequestError", "type": "object" }, "CreateGpWorker-v2026-10-01RequestBadRequestError": { "properties": { "errors": { "items": { "$ref": "#/components/schemas/GpWorkersPostResponsesContentApplicationJsonSchemaErrorsItems" }, "type": "array" } }, "required": [ "errors" ], "title": "CreateGpWorker-v2026-10-01RequestBadRequestError", "type": "object" }, "CreateGpWorker-v2026-10-01RequestConflictError": { "properties": { "errors": { "items": { "$ref": "#/components/schemas/GpWorkersPostResponsesContentApplicationJsonSchemaErrorsItems" }, "type": "array" } }, "required": [ "errors" ], "title": "CreateGpWorker-v2026-10-01RequestConflictError", "type": "object" }, "CreateGpWorker-v2026-10-01RequestForbiddenError": { "properties": { "errors": { "items": { "$ref": "#/components/schemas/GpWorkersPostResponsesContentApplicationJsonSchemaErrorsItems" }, "type": "array" } }, "required": [ "errors" ], "title": "CreateGpWorker-v2026-10-01RequestForbiddenError", "type": "object" }, "CreateGpWorker-v2026-10-01RequestInternalServerError": { "properties": { "errors": { "items": { "$ref": "#/components/schemas/GpWorkersPostResponsesContentApplicationJsonSchemaErrorsItems" }, "type": "array" } }, "required": [ "errors" ], "title": "CreateGpWorker-v2026-10-01RequestInternalServerError", "type": "object" }, "CreateGpWorker-v2026-10-01RequestNotFoundError": { "properties": { "errors": { "items": { "$ref": "#/components/schemas/GpWorkersPostResponsesContentApplicationJsonSchemaErrorsItems" }, "type": "array" } }, "required": [ "errors" ], "title": "CreateGpWorker-v2026-10-01RequestNotFoundError", "type": "object" }, "CreateGpWorker-v2026-10-01RequestUnauthorizedError": { "properties": { "errors": { "items": { "$ref": "#/components/schemas/GpWorkersPostResponsesContentApplicationJsonSchemaErrorsItems" }, "type": "array" } }, "required": [ "errors" ], "title": "CreateGpWorker-v2026-10-01RequestUnauthorizedError", "type": "object" }, "CreateGroup-v2026-01-01RequestBadRequestError": { "properties": { "error": { "$ref": "#/components/schemas/GroupsPostResponsesContentApplicationJsonSchemaError" } }, "title": "CreateGroup-v2026-01-01RequestBadRequestError", "type": "object" }, "CreateHourlyReportPreset-v2026-01-01RequestBadRequestError": { "properties": { "error": { "type": "string" } }, "title": "CreateHourlyReportPreset-v2026-01-01RequestBadRequestError", "type": "object" }, "CreateHourlyReportPreset-v2026-01-01RequestForbiddenError": { "properties": { "error": { "type": "string" } }, "title": "CreateHourlyReportPreset-v2026-01-01RequestForbiddenError", "type": "object" }, "CreateHourlyReportRootPreset-v2026-01-01RequestBadRequestError": { "properties": { "error": { "type": "string" } }, "title": "CreateHourlyReportRootPreset-v2026-01-01RequestBadRequestError", "type": "object" }, "CreateIcInvoicingTax-v2026-01-01RequestBadRequestError": { "properties": { "errors": { "items": { "$ref": "#/components/schemas/ContractsContractIdIcInvoicingTaxesPostResponsesContentApplicationJsonSchemaErrorsItems" }, "type": "array" } }, "title": "CreateIcInvoicingTax-v2026-01-01RequestBadRequestError", "type": "object" }, "CreateIcInvoicingTax-v2026-01-01RequestInternalServerError": { "properties": { "errors": { "items": { "$ref": "#/components/schemas/ContractsContractIdIcInvoicingTaxesPostResponsesContentApplicationJsonSchemaErrorsItems" }, "type": "array" } }, "title": "CreateIcInvoicingTax-v2026-01-01RequestInternalServerError", "type": "object" }, "CreateItOrder-v2026-09-17RequestBadRequestError": { "properties": { "errors": { "items": { "$ref": "#/components/schemas/ItOrdersPostResponsesContentApplicationJsonSchemaErrorsItems" }, "type": "array" } }, "required": [ "errors" ], "title": "CreateItOrder-v2026-09-17RequestBadRequestError", "type": "object" }, "CreateItOrder-v2026-09-17RequestConflictError": { "properties": { "errors": { "items": { "$ref": "#/components/schemas/ItOrdersPostResponsesContentApplicationJsonSchemaErrorsItems" }, "type": "array" } }, "required": [ "errors" ], "title": "CreateItOrder-v2026-09-17RequestConflictError", "type": "object" }, "CreateItOrder-v2026-09-17RequestForbiddenError": { "properties": { "errors": { "items": { "$ref": "#/components/schemas/ItOrdersPostResponsesContentApplicationJsonSchemaErrorsItems" }, "type": "array" } }, "required": [ "errors" ], "title": "CreateItOrder-v2026-09-17RequestForbiddenError", "type": "object" }, "CreateItOrder-v2026-09-17RequestInternalServerError": { "properties": { "errors": { "items": { "$ref": "#/components/schemas/ItOrdersPostResponsesContentApplicationJsonSchemaErrorsItems" }, "type": "array" } }, "required": [ "errors" ], "title": "CreateItOrder-v2026-09-17RequestInternalServerError", "type": "object" }, "CreateItOrder-v2026-09-17RequestNotFoundError": { "properties": { "errors": { "items": { "$ref": "#/components/schemas/ItOrdersPostResponsesContentApplicationJsonSchemaErrorsItems" }, "type": "array" } }, "required": [ "errors" ], "title": "CreateItOrder-v2026-09-17RequestNotFoundError", "type": "object" }, "CreateItOrder-v2026-09-17RequestUnauthorizedError": { "properties": { "errors": { "items": { "$ref": "#/components/schemas/ItOrdersPostResponsesContentApplicationJsonSchemaErrorsItems" }, "type": "array" } }, "required": [ "errors" ], "title": "CreateItOrder-v2026-09-17RequestUnauthorizedError", "type": "object" }, "CreateItOrder-v2026-09-17RequestUnprocessableEntityError": { "properties": { "errors": { "items": { "$ref": "#/components/schemas/ItOrdersPostResponsesContentApplicationJsonSchemaErrorsItems" }, "type": "array" } }, "required": [ "errors" ], "title": "CreateItOrder-v2026-09-17RequestUnprocessableEntityError", "type": "object" }, "CreateLegalEntity-v2026-01-01RequestBadRequestError": { "properties": { "message": { "description": "Error message explaining what went wrong.", "type": "string" } }, "title": "CreateLegalEntity-v2026-01-01RequestBadRequestError", "type": "object" }, "CreateLegalEntity-v2026-01-01RequestForbiddenError": { "properties": { "message": { "description": "Error message explaining the lack of permission.", "type": "string" } }, "title": "CreateLegalEntity-v2026-01-01RequestForbiddenError", "type": "object" }, "CreateMagicLink-v2026-01-01RequestInternalServerError": { "properties": { "error": { "type": "string" } }, "title": "CreateMagicLink-v2026-01-01RequestInternalServerError", "type": "object" }, "CreateMagicLink-v2026-01-01RequestUnauthorizedError": { "properties": { "error": { "type": "string" } }, "title": "CreateMagicLink-v2026-01-01RequestUnauthorizedError", "type": "object" }, "CreateManager-v2026-01-01RequestBadRequestError": { "properties": { "error": { "description": "Description of the validation error.", "type": "string" } }, "title": "CreateManager-v2026-01-01RequestBadRequestError", "type": "object" }, "CreateManager-v2026-01-01RequestConflictError": { "properties": { "error": { "description": "Explanation of the conflict error.", "type": "string" } }, "title": "CreateManager-v2026-01-01RequestConflictError", "type": "object" }, "CreateManualVerificationScreening-v2026-01-01RequestBadRequestError": { "properties": { "code": { "type": "integer" }, "message": { "description": "Human-readable error message", "type": "string" } }, "required": [ "code", "message" ], "title": "CreateManualVerificationScreening-v2026-01-01RequestBadRequestError", "type": "object" }, "CreateManualVerificationScreening-v2026-01-01RequestConflictError": { "properties": { "code": { "type": "integer" }, "message": { "type": "string" } }, "required": [ "code", "message" ], "title": "CreateManualVerificationScreening-v2026-01-01RequestConflictError", "type": "object" }, "CreateMilestone-v2026-01-01RequestBadRequestError": { "properties": { "errors": { "description": "Validation or business rule errors describing why the milestone could not be created, such as invalid input, an unsupported contract type, or an amount exceeding the allowed maximum.", "items": { "$ref": "#/components/schemas/ContractsContractIdMilestonesPostResponsesContentApplicationJsonSchemaErrorsItems" }, "type": "array" } }, "required": [ "errors" ], "title": "CreateMilestone-v2026-01-01RequestBadRequestError", "type": "object" }, "CreateMilestone-v2026-01-01RequestForbiddenError": { "properties": { "errors": { "description": "Errors describing why the milestone could not be created for this contract.", "items": { "$ref": "#/components/schemas/ContractsContractIdMilestonesPostResponsesContentApplicationJsonSchemaErrorsItems" }, "type": "array" } }, "required": [ "errors" ], "title": "CreateMilestone-v2026-01-01RequestForbiddenError", "type": "object" }, "CreateMilestone-v2026-01-01RequestInternalServerError": { "properties": { "errors": { "description": "Generic upstream or internal errors emitted when the milestone cannot be created.", "items": { "$ref": "#/components/schemas/ContractsContractIdMilestonesPostResponsesContentApplicationJsonSchemaErrorsItems" }, "type": "array" } }, "required": [ "errors" ], "title": "CreateMilestone-v2026-01-01RequestInternalServerError", "type": "object" }, "CreateMilestone-v2026-01-01RequestNotFoundError": { "properties": { "errors": { "description": "Errors describing why a referenced resource, such as the contract or reporting preset, could not be found.", "items": { "$ref": "#/components/schemas/ContractsContractIdMilestonesPostResponsesContentApplicationJsonSchemaErrorsItems" }, "type": "array" } }, "required": [ "errors" ], "title": "CreateMilestone-v2026-01-01RequestNotFoundError", "type": "object" }, "CreateOnDemandPayroll-v2026-07-28RequestBadRequestError": { "properties": { "errors": { "description": "List of errors.", "items": { "$ref": "#/components/schemas/OnDemandPayrollContractContractIdPostResponsesContentApplicationJsonSchemaErrorsItems" }, "type": "array" } }, "required": [ "errors" ], "title": "CreateOnDemandPayroll-v2026-07-28RequestBadRequestError", "type": "object" }, "CreateOnDemandPayroll-v2026-07-28RequestForbiddenError": { "properties": { "errors": { "description": "List of errors.", "items": { "$ref": "#/components/schemas/OnDemandPayrollContractContractIdPostResponsesContentApplicationJsonSchemaErrorsItems" }, "type": "array" } }, "required": [ "errors" ], "title": "CreateOnDemandPayroll-v2026-07-28RequestForbiddenError", "type": "object" }, "CreateOnDemandPayroll-v2026-07-28RequestUnauthorizedError": { "properties": { "errors": { "description": "List of errors.", "items": { "$ref": "#/components/schemas/OnDemandPayrollContractContractIdPostResponsesContentApplicationJsonSchemaErrorsItems" }, "type": "array" } }, "required": [ "errors" ], "title": "CreateOnDemandPayroll-v2026-07-28RequestUnauthorizedError", "type": "object" }, "CreateOrganizationSecureVaultFolder-v2026-08-05RequestBadRequestError": { "properties": { "errors": { "description": "List of errors that occurred while processing the request.", "items": { "$ref": "#/components/schemas/OrganizationsSecureVaultFoldersPostResponsesContentApplicationJsonSchemaErrorsItems" }, "type": "array" } }, "required": [ "errors" ], "title": "CreateOrganizationSecureVaultFolder-v2026-08-05RequestBadRequestError", "type": "object" }, "CreateOrganizationSecureVaultFolder-v2026-08-05RequestForbiddenError": { "properties": { "errors": { "description": "List of errors that occurred while processing the request.", "items": { "$ref": "#/components/schemas/OrganizationsSecureVaultFoldersPostResponsesContentApplicationJsonSchemaErrorsItems" }, "type": "array" } }, "required": [ "errors" ], "title": "CreateOrganizationSecureVaultFolder-v2026-08-05RequestForbiddenError", "type": "object" }, "CreateOrganizationSecureVaultFolder-v2026-08-05RequestNotFoundError": { "properties": { "errors": { "description": "List of errors that occurred while processing the request.", "items": { "$ref": "#/components/schemas/OrganizationsSecureVaultFoldersPostResponsesContentApplicationJsonSchemaErrorsItems" }, "type": "array" } }, "required": [ "errors" ], "title": "CreateOrganizationSecureVaultFolder-v2026-08-05RequestNotFoundError", "type": "object" }, "CreateOrganizationSecureVaultFolder-v2026-08-05RequestUnauthorizedError": { "properties": { "errors": { "description": "List of errors that occurred while processing the request.", "items": { "$ref": "#/components/schemas/OrganizationsSecureVaultFoldersPostResponsesContentApplicationJsonSchemaErrorsItems" }, "type": "array" } }, "required": [ "errors" ], "title": "CreateOrganizationSecureVaultFolder-v2026-08-05RequestUnauthorizedError", "type": "object" }, "CreatePaymentStatement-v2026-07-23RequestBadRequestError": { "properties": { "errors": { "items": { "$ref": "#/components/schemas/PaymentsStatementsPostResponsesContentApplicationJsonSchemaErrorsItems" }, "type": "array" } }, "required": [ "errors" ], "title": "CreatePaymentStatement-v2026-07-23RequestBadRequestError", "type": "object" }, "CreatePaymentStatement-v2026-07-23RequestConflictError": { "properties": { "errors": { "items": { "$ref": "#/components/schemas/PaymentsStatementsPostResponsesContentApplicationJsonSchemaErrorsItems" }, "type": "array" } }, "required": [ "errors" ], "title": "CreatePaymentStatement-v2026-07-23RequestConflictError", "type": "object" }, "CreatePaymentStatement-v2026-07-23RequestForbiddenError": { "properties": { "errors": { "items": { "$ref": "#/components/schemas/PaymentsStatementsPostResponsesContentApplicationJsonSchemaErrorsItems" }, "type": "array" } }, "required": [ "errors" ], "title": "CreatePaymentStatement-v2026-07-23RequestForbiddenError", "type": "object" }, "CreatePaymentStatement-v2026-07-23RequestInternalServerError": { "properties": { "errors": { "items": { "$ref": "#/components/schemas/PaymentsStatementsPostResponsesContentApplicationJsonSchemaErrorsItems" }, "type": "array" } }, "required": [ "errors" ], "title": "CreatePaymentStatement-v2026-07-23RequestInternalServerError", "type": "object" }, "CreatePaymentStatement-v2026-07-23RequestNotFoundError": { "properties": { "errors": { "items": { "$ref": "#/components/schemas/PaymentsStatementsPostResponsesContentApplicationJsonSchemaErrorsItems" }, "type": "array" } }, "required": [ "errors" ], "title": "CreatePaymentStatement-v2026-07-23RequestNotFoundError", "type": "object" }, "CreatePaymentStatement-v2026-07-23RequestTooManyRequestsError": { "properties": { "errors": { "items": { "$ref": "#/components/schemas/PaymentsStatementsPostResponsesContentApplicationJsonSchemaErrorsItems" }, "type": "array" } }, "required": [ "errors" ], "title": "CreatePaymentStatement-v2026-07-23RequestTooManyRequestsError", "type": "object" }, "CreatePaymentStatement-v2026-07-23RequestUnauthorizedError": { "properties": { "errors": { "items": { "$ref": "#/components/schemas/PaymentsStatementsPostResponsesContentApplicationJsonSchemaErrorsItems" }, "type": "array" } }, "required": [ "errors" ], "title": "CreatePaymentStatement-v2026-07-23RequestUnauthorizedError", "type": "object" }, "CreateTimeOffRequest-v2026-01-01RequestBadRequestError": { "properties": { "errors": { "description": "List of errors describing what went wrong", "items": { "$ref": "#/components/schemas/TimeOffsPostResponsesContentApplicationJsonSchemaErrorsItems" }, "type": "array" }, "request": { "$ref": "#/components/schemas/TimeOffsPostResponsesContentApplicationJsonSchemaRequest", "description": "Request metadata" } }, "title": "CreateTimeOffRequest-v2026-01-01RequestBadRequestError", "type": "object" }, "CreateTimeOffRequest-v2026-01-01RequestForbiddenError": { "properties": { "errors": { "description": "List of errors describing what went wrong", "items": { "$ref": "#/components/schemas/TimeOffsPostResponsesContentApplicationJsonSchemaErrorsItems" }, "type": "array" }, "request": { "$ref": "#/components/schemas/TimeOffsPostResponsesContentApplicationJsonSchemaRequest", "description": "Request metadata" } }, "title": "CreateTimeOffRequest-v2026-01-01RequestForbiddenError", "type": "object" }, "CreateTimeOffRequest-v2026-01-01RequestNotFoundError": { "properties": { "errors": { "description": "List of errors describing what went wrong", "items": { "$ref": "#/components/schemas/TimeOffsPostResponsesContentApplicationJsonSchemaErrorsItems" }, "type": "array" }, "request": { "$ref": "#/components/schemas/TimeOffsPostResponsesContentApplicationJsonSchemaRequest", "description": "Request metadata" } }, "title": "CreateTimeOffRequest-v2026-01-01RequestNotFoundError", "type": "object" }, "CreateTimesheetReview-v2026-01-01RequestBadRequestError": { "properties": { "errors": { "description": "Validation or business rule errors describing why the timesheet review could not be processed, such as invalid input or the organization requiring the approval-requests workflow instead.", "items": { "$ref": "#/components/schemas/TimesheetsTimesheetIdReviewsPostResponsesContentApplicationJsonSchemaErrorsItems" }, "type": "array" } }, "required": [ "errors" ], "title": "CreateTimesheetReview-v2026-01-01RequestBadRequestError", "type": "object" }, "CreateTimesheetReview-v2026-01-01RequestInternalServerError": { "properties": { "errors": { "description": "Generic upstream or internal errors emitted when the timesheet review cannot be processed.", "items": { "$ref": "#/components/schemas/TimesheetsTimesheetIdReviewsPostResponsesContentApplicationJsonSchemaErrorsItems" }, "type": "array" } }, "required": [ "errors" ], "title": "CreateTimesheetReview-v2026-01-01RequestInternalServerError", "type": "object" }, "CreateTimesheetReview-v2026-01-01RequestNotFoundError": { "properties": { "errors": { "description": "Errors describing why the timesheet to review could not be found.", "items": { "$ref": "#/components/schemas/TimesheetsTimesheetIdReviewsPostResponsesContentApplicationJsonSchemaErrorsItems" }, "type": "array" } }, "required": [ "errors" ], "title": "CreateTimesheetReview-v2026-01-01RequestNotFoundError", "type": "object" }, "CreateVendorBill-v2026-01-01RequestBadRequestError": { "properties": { "errors": { "items": { "$ref": "#/components/schemas/AccountsPayableVendorBillsPostResponsesContentApplicationJsonSchemaErrorsItems" }, "type": "array" } }, "required": [ "errors" ], "title": "CreateVendorBill-v2026-01-01RequestBadRequestError", "type": "object" }, "CreateVendorBill-v2026-01-01RequestConflictError": { "properties": { "errors": { "items": { "$ref": "#/components/schemas/AccountsPayableVendorBillsPostResponsesContentApplicationJsonSchemaErrorsItems" }, "type": "array" } }, "required": [ "errors" ], "title": "CreateVendorBill-v2026-01-01RequestConflictError", "type": "object" }, "CreateVendorBill-v2026-01-01RequestInternalServerError": { "properties": { "errors": { "items": { "$ref": "#/components/schemas/AccountsPayableVendorBillsPostResponsesContentApplicationJsonSchemaErrorsItems" }, "type": "array" } }, "required": [ "errors" ], "title": "CreateVendorBill-v2026-01-01RequestInternalServerError", "type": "object" }, "CreateWebhook-v2026-01-01RequestBadRequestError": { "properties": { "errors": { "description": "The list of errors that caused the request to fail.", "items": { "$ref": "#/components/schemas/WebhooksPostResponsesContentApplicationJsonSchemaErrorsItems" }, "type": "array" } }, "required": [ "errors" ], "title": "CreateWebhook-v2026-01-01RequestBadRequestError", "type": "object" }, "CreateWebhook-v2026-01-01RequestForbiddenError": { "properties": { "errors": { "description": "The list of errors that caused the request to fail.", "items": { "$ref": "#/components/schemas/WebhooksPostResponsesContentApplicationJsonSchemaErrorsItems" }, "type": "array" } }, "required": [ "errors" ], "title": "CreateWebhook-v2026-01-01RequestForbiddenError", "type": "object" }, "CreateWebhook-v2026-01-01RequestInternalServerError": { "properties": { "errors": { "description": "The list of errors that caused the request to fail.", "items": { "$ref": "#/components/schemas/WebhooksPostResponsesContentApplicationJsonSchemaErrorsItems" }, "type": "array" } }, "required": [ "errors" ], "title": "CreateWebhook-v2026-01-01RequestInternalServerError", "type": "object" }, "CreateWebhook-v2026-01-01RequestMethodNotAllowedError": { "properties": { "errors": { "description": "The list of errors that caused the request to fail.", "items": { "$ref": "#/components/schemas/WebhooksPostResponsesContentApplicationJsonSchemaErrorsItems" }, "type": "array" } }, "required": [ "errors" ], "title": "CreateWebhook-v2026-01-01RequestMethodNotAllowedError", "type": "object" }, "CreateWebhook-v2026-01-01RequestNotFoundError": { "properties": { "errors": { "description": "The list of errors that caused the request to fail.", "items": { "$ref": "#/components/schemas/WebhooksPostResponsesContentApplicationJsonSchemaErrorsItems" }, "type": "array" } }, "required": [ "errors" ], "title": "CreateWebhook-v2026-01-01RequestNotFoundError", "type": "object" }, "CreateWebhook-v2026-01-01RequestTooManyRequestsError": { "properties": { "errors": { "description": "The list of errors that caused the request to fail.", "items": { "$ref": "#/components/schemas/WebhooksPostResponsesContentApplicationJsonSchemaErrorsItems" }, "type": "array" } }, "required": [ "errors" ], "title": "CreateWebhook-v2026-01-01RequestTooManyRequestsError", "type": "object" }, "CreateWebhook-v2026-01-01RequestUnauthorizedError": { "properties": { "errors": { "description": "The list of errors that caused the request to fail.", "items": { "$ref": "#/components/schemas/WebhooksPostResponsesContentApplicationJsonSchemaErrorsItems" }, "type": "array" } }, "required": [ "errors" ], "title": "CreateWebhook-v2026-01-01RequestUnauthorizedError", "type": "object" }, "CreateWorkStatementPaymentPolicy-v2026-09-07RequestBadRequestError": { "properties": { "errors": { "items": { "$ref": "#/components/schemas/WorkStatementPaymentPoliciesPostResponsesContentApplicationJsonSchemaErrorsItems" }, "type": "array" } }, "title": "CreateWorkStatementPaymentPolicy-v2026-09-07RequestBadRequestError", "type": "object" }, "CreateWorkStatementPaymentPolicy-v2026-09-07RequestInternalServerError": { "properties": { "errors": { "items": { "$ref": "#/components/schemas/WorkStatementPaymentPoliciesPostResponsesContentApplicationJsonSchemaErrorsItems" }, "type": "array" } }, "title": "CreateWorkStatementPaymentPolicy-v2026-09-07RequestInternalServerError", "type": "object" }, "CreateWorker-v2026-01-01RequestBadRequestError": { "properties": { "error": { "type": "string" } }, "title": "CreateWorker-v2026-01-01RequestBadRequestError", "type": "object" }, "CreateWorker-v2026-01-01RequestInternalServerError": { "properties": { "error": { "type": "string" } }, "title": "CreateWorker-v2026-01-01RequestInternalServerError", "type": "object" }, "CreateWorkerRelationType-v2026-01-01RequestBadRequestError": { "properties": { "errors": { "items": { "$ref": "#/components/schemas/HrisWorkerRelationsTypesPostResponsesContentApplicationJsonSchemaErrorsItems" }, "type": "array" } }, "title": "CreateWorkerRelationType-v2026-01-01RequestBadRequestError", "type": "object" }, "CreateWorkerRelationType-v2026-01-01RequestInternalServerError": { "properties": { "errors": { "items": { "$ref": "#/components/schemas/HrisWorkerRelationsTypesPostResponsesContentApplicationJsonSchemaErrorsItems" }, "type": "array" } }, "title": "CreateWorkerRelationType-v2026-01-01RequestInternalServerError", "type": "object" }, "Createtimesheetreviews-v2026-01-01RequestBadRequestError": { "properties": { "errors": { "description": "Validation or business rule errors describing why the timesheet reviews could not be created.", "items": { "$ref": "#/components/schemas/TimesheetsManyReviewsPostResponsesContentApplicationJsonSchemaErrorsItems" }, "type": "array" } }, "required": [ "errors" ], "title": "Createtimesheetreviews-v2026-01-01RequestBadRequestError", "type": "object" }, "Createtimesheetreviews-v2026-01-01RequestConflictError": { "properties": { "errors": { "description": "Errors describing why the batch review conflicts with work already in progress.", "items": { "$ref": "#/components/schemas/TimesheetsManyReviewsPostResponsesContentApplicationJsonSchemaErrorsItems" }, "type": "array" } }, "required": [ "errors" ], "title": "Createtimesheetreviews-v2026-01-01RequestConflictError", "type": "object" }, "Createtimesheetreviews-v2026-01-01RequestForbiddenError": { "properties": { "errors": { "description": "Errors describing why the caller may not review these timesheets, emitted when contract access is denied.", "items": { "$ref": "#/components/schemas/TimesheetsManyReviewsPostResponsesContentApplicationJsonSchemaErrorsItems" }, "type": "array" } }, "required": [ "errors" ], "title": "Createtimesheetreviews-v2026-01-01RequestForbiddenError", "type": "object" }, "Createtimesheetreviews-v2026-01-01RequestInternalServerError": { "properties": { "errors": { "description": "Generic upstream or internal errors emitted when the timesheet reviews cannot be processed.", "items": { "$ref": "#/components/schemas/TimesheetsManyReviewsPostResponsesContentApplicationJsonSchemaErrorsItems" }, "type": "array" } }, "required": [ "errors" ], "title": "Createtimesheetreviews-v2026-01-01RequestInternalServerError", "type": "object" }, "Createtimesheetreviews-v2026-01-01RequestNotFoundError": { "properties": { "errors": { "description": "Errors describing why none of the referenced timesheets could be reviewed.", "items": { "$ref": "#/components/schemas/TimesheetsManyReviewsPostResponsesContentApplicationJsonSchemaErrorsItems" }, "type": "array" } }, "required": [ "errors" ], "title": "Createtimesheetreviews-v2026-01-01RequestNotFoundError", "type": "object" }, "DaasBanksBankIdPatchRequestBodyContentApplicationJsonSchemaDataItems": { "properties": { "key": { "description": "The key of the bank account properties.", "type": "string" }, "value": { "description": "The value for that key property.", "type": "string" } }, "required": [ "key", "value" ], "title": "DaasBanksBankIdPatchRequestBodyContentApplicationJsonSchemaDataItems", "type": "object" }, "DaasBanksBankIdPatchResponsesContentApplicationJsonSchemaData": { "properties": { "created_at": { "description": "Long date-time format following ISO-8601", "format": "date-time", "type": "string" }, "id": { "description": "ID of Bank Account.", "type": "string" }, "status": { "$ref": "#/components/schemas/DaasBanksBankIdPatchResponsesContentApplicationJsonSchemaDataStatus", "description": "Bank Account status" }, "updated_at": { "description": "Long date-time format following ISO-8601", "format": "date-time", "type": "string" } }, "title": "DaasBanksBankIdPatchResponsesContentApplicationJsonSchemaData", "type": "object" }, "DaasBanksBankIdPatchResponsesContentApplicationJsonSchemaDataStatus": { "description": "Bank Account status", "enum": [ "new", "pending", "approved", "failed" ], "title": "DaasBanksBankIdPatchResponsesContentApplicationJsonSchemaDataStatus", "type": "string" }, "DaasPayslipsGetResponsesContentApplicationJsonSchemaDataItems": { "properties": { "created_at": { "description": "Creation date", "format": "date-time", "type": "string" }, "from": { "description": "Start date of the payment period.", "format": "date-time", "type": "string" }, "id": { "description": "Unique identifier for the payslip record.", "type": "string" }, "published_at": { "description": "Publish date", "format": "date-time", "type": "string" }, "reject_reason": { "description": "Rejection reason", "type": "string" }, "rejected_at": { "description": "Rejection date", "format": "date-time", "type": "string" }, "schedule_publishing_date": { "description": "Scheduled for publishing date", "format": "date-time", "type": "string" }, "status": { "description": "Status of the payslip (e.g., 'Pending', 'Processed').", "type": "string" }, "to": { "description": "End date of the payment period.", "format": "date-time", "type": "string" }, "updated_at": { "description": "Last update date", "format": "date-time", "type": "string" }, "uploaded_at": { "description": "Upload date", "format": "date-time", "type": "string" }, "url": { "description": "URL", "type": "string" } }, "required": [ "id", "to", "url", "from", "status", "created_at", "updated_at", "rejected_at", "uploaded_at", "published_at", "reject_reason", "schedule_publishing_date" ], "title": "DaasPayslipsGetResponsesContentApplicationJsonSchemaDataItems", "type": "object" }, "DecideAClearanceRequest-v2026-09-17RequestBadRequestError": { "properties": { "errors": { "items": { "$ref": "#/components/schemas/ItClearanceRequestsClearanceRequestIdDecidePostResponsesContentApplicationJsonSchemaErrorsItems" }, "type": "array" } }, "required": [ "errors" ], "title": "DecideAClearanceRequest-v2026-09-17RequestBadRequestError", "type": "object" }, "DecideAClearanceRequest-v2026-09-17RequestConflictError": { "properties": { "errors": { "items": { "$ref": "#/components/schemas/ItClearanceRequestsClearanceRequestIdDecidePostResponsesContentApplicationJsonSchemaErrorsItems" }, "type": "array" } }, "required": [ "errors" ], "title": "DecideAClearanceRequest-v2026-09-17RequestConflictError", "type": "object" }, "DecideAClearanceRequest-v2026-09-17RequestForbiddenError": { "properties": { "errors": { "items": { "$ref": "#/components/schemas/ItClearanceRequestsClearanceRequestIdDecidePostResponsesContentApplicationJsonSchemaErrorsItems" }, "type": "array" } }, "required": [ "errors" ], "title": "DecideAClearanceRequest-v2026-09-17RequestForbiddenError", "type": "object" }, "DecideAClearanceRequest-v2026-09-17RequestInternalServerError": { "properties": { "errors": { "items": { "$ref": "#/components/schemas/ItClearanceRequestsClearanceRequestIdDecidePostResponsesContentApplicationJsonSchemaErrorsItems" }, "type": "array" } }, "required": [ "errors" ], "title": "DecideAClearanceRequest-v2026-09-17RequestInternalServerError", "type": "object" }, "DecideAClearanceRequest-v2026-09-17RequestNotFoundError": { "properties": { "errors": { "items": { "$ref": "#/components/schemas/ItClearanceRequestsClearanceRequestIdDecidePostResponsesContentApplicationJsonSchemaErrorsItems" }, "type": "array" } }, "required": [ "errors" ], "title": "DecideAClearanceRequest-v2026-09-17RequestNotFoundError", "type": "object" }, "DecideAClearanceRequest-v2026-09-17RequestUnauthorizedError": { "properties": { "errors": { "items": { "$ref": "#/components/schemas/ItClearanceRequestsClearanceRequestIdDecidePostResponsesContentApplicationJsonSchemaErrorsItems" }, "type": "array" } }, "required": [ "errors" ], "title": "DecideAClearanceRequest-v2026-09-17RequestUnauthorizedError", "type": "object" }, "DecideAClearanceRequest-v2026-09-17RequestUnprocessableEntityError": { "properties": { "errors": { "items": { "$ref": "#/components/schemas/ItClearanceRequestsClearanceRequestIdDecidePostResponsesContentApplicationJsonSchemaErrorsItems" }, "type": "array" } }, "required": [ "errors" ], "title": "DecideAClearanceRequest-v2026-09-17RequestUnprocessableEntityError", "type": "object" }, "DeclineItOrder-v2026-09-30RequestBadRequestError": { "properties": { "errors": { "items": { "$ref": "#/components/schemas/ItOrdersOrderIdDeclinePostResponsesContentApplicationJsonSchemaErrorsItems" }, "type": "array" } }, "required": [ "errors" ], "title": "DeclineItOrder-v2026-09-30RequestBadRequestError", "type": "object" }, "DeclineItOrder-v2026-09-30RequestConflictError": { "properties": { "errors": { "items": { "$ref": "#/components/schemas/ItOrdersOrderIdDeclinePostResponsesContentApplicationJsonSchemaErrorsItems" }, "type": "array" } }, "required": [ "errors" ], "title": "DeclineItOrder-v2026-09-30RequestConflictError", "type": "object" }, "DeclineItOrder-v2026-09-30RequestForbiddenError": { "properties": { "errors": { "items": { "$ref": "#/components/schemas/ItOrdersOrderIdDeclinePostResponsesContentApplicationJsonSchemaErrorsItems" }, "type": "array" } }, "required": [ "errors" ], "title": "DeclineItOrder-v2026-09-30RequestForbiddenError", "type": "object" }, "DeclineItOrder-v2026-09-30RequestInternalServerError": { "properties": { "errors": { "items": { "$ref": "#/components/schemas/ItOrdersOrderIdDeclinePostResponsesContentApplicationJsonSchemaErrorsItems" }, "type": "array" } }, "required": [ "errors" ], "title": "DeclineItOrder-v2026-09-30RequestInternalServerError", "type": "object" }, "DeclineItOrder-v2026-09-30RequestNotFoundError": { "properties": { "errors": { "items": { "$ref": "#/components/schemas/ItOrdersOrderIdDeclinePostResponsesContentApplicationJsonSchemaErrorsItems" }, "type": "array" } }, "required": [ "errors" ], "title": "DeclineItOrder-v2026-09-30RequestNotFoundError", "type": "object" }, "DeclineItOrder-v2026-09-30RequestUnauthorizedError": { "properties": { "errors": { "items": { "$ref": "#/components/schemas/ItOrdersOrderIdDeclinePostResponsesContentApplicationJsonSchemaErrorsItems" }, "type": "array" } }, "required": [ "errors" ], "title": "DeclineItOrder-v2026-09-30RequestUnauthorizedError", "type": "object" }, "Deel_As_a_Service_getEorEmployeePayslips-v2026-01-01_Response_200": { "properties": { "data": { "items": { "$ref": "#/components/schemas/DaasPayslipsGetResponsesContentApplicationJsonSchemaDataItems" }, "type": "array" } }, "required": [ "data" ], "title": "Deel As a Service_getEorEmployeePayslips-v2026-01-01_Response_200", "type": "object" }, "Deel_As_a_Service_patchEORBankAccount-v2026-01-01_Response_201": { "properties": { "data": { "$ref": "#/components/schemas/DaasBanksBankIdPatchResponsesContentApplicationJsonSchemaData" } }, "required": [ "data" ], "title": "Deel As a Service_patchEORBankAccount-v2026-01-01_Response_201", "type": "object" }, "DelayEorEmployeeOnboarding-v2026-01-01RequestBadRequestError": { "properties": { "error": { "description": "Error message", "type": "string" } }, "required": [ "error" ], "title": "DelayEorEmployeeOnboarding-v2026-01-01RequestBadRequestError", "type": "object" }, "DeleteAWorkerRelationType-v2026-01-01RequestBadRequestError": { "properties": { "errors": { "items": { "$ref": "#/components/schemas/HrisWorkerRelationsTypesTypeIdDeleteResponsesContentApplicationJsonSchemaErrorsItems" }, "type": "array" } }, "title": "DeleteAWorkerRelationType-v2026-01-01RequestBadRequestError", "type": "object" }, "DeleteAWorkerRelationType-v2026-01-01RequestInternalServerError": { "properties": { "errors": { "items": { "$ref": "#/components/schemas/HrisWorkerRelationsTypesTypeIdDeleteResponsesContentApplicationJsonSchemaErrorsItems" }, "type": "array" } }, "title": "DeleteAWorkerRelationType-v2026-01-01RequestInternalServerError", "type": "object" }, "DeleteAnOrgStructureFromTheOrganization-v2026-01-01RequestBadRequestError": { "properties": { "errors": { "items": { "$ref": "#/components/schemas/HrisOrganizationStructuresHrisOrgStructureIdDeleteResponsesContentApplicationJsonSchemaErrorsItems" }, "type": "array" } }, "title": "DeleteAnOrgStructureFromTheOrganization-v2026-01-01RequestBadRequestError", "type": "object" }, "DeleteAnOrgStructureFromTheOrganization-v2026-01-01RequestInternalServerError": { "properties": { "errors": { "items": { "$ref": "#/components/schemas/HrisOrganizationStructuresHrisOrgStructureIdDeleteResponsesContentApplicationJsonSchemaErrorsItems" }, "type": "array" } }, "title": "DeleteAnOrgStructureFromTheOrganization-v2026-01-01RequestInternalServerError", "type": "object" }, "DeleteContractTerminationRequest-v2026-01-01RequestBadRequestError": { "properties": { "errors": { "items": { "$ref": "#/components/schemas/ContractsContractIdTerminationsDeleteResponsesContentApplicationJsonSchemaErrorsItems" }, "type": "array" } }, "title": "DeleteContractTerminationRequest-v2026-01-01RequestBadRequestError", "type": "object" }, "DeleteContractTerminationRequest-v2026-01-01RequestInternalServerError": { "properties": { "errors": { "items": { "$ref": "#/components/schemas/ContractsContractIdTerminationsDeleteResponsesContentApplicationJsonSchemaErrorsItems" }, "type": "array" } }, "title": "DeleteContractTerminationRequest-v2026-01-01RequestInternalServerError", "type": "object" }, "DeleteGroup-v2026-01-01RequestBadRequestError": { "properties": { "error": { "$ref": "#/components/schemas/GroupsIdDeleteResponsesContentApplicationJsonSchemaError" } }, "title": "DeleteGroup-v2026-01-01RequestBadRequestError", "type": "object" }, "DeleteGroup-v2026-01-01RequestNotFoundError": { "properties": { "error": { "$ref": "#/components/schemas/GroupsIdDeleteResponsesContentApplicationJsonSchemaError" } }, "title": "DeleteGroup-v2026-01-01RequestNotFoundError", "type": "object" }, "DeleteHourlyReportPreset-v2026-01-01RequestBadRequestError": { "properties": { "error": { "type": "string" } }, "title": "DeleteHourlyReportPreset-v2026-01-01RequestBadRequestError", "type": "object" }, "DeleteHourlyReportPreset-v2026-01-01RequestForbiddenError": { "properties": { "error": { "type": "string" } }, "title": "DeleteHourlyReportPreset-v2026-01-01RequestForbiddenError", "type": "object" }, "DeleteHourlyReportPreset-v2026-01-01RequestNotFoundError": { "properties": { "error": { "type": "string" } }, "title": "DeleteHourlyReportPreset-v2026-01-01RequestNotFoundError", "type": "object" }, "DeleteIcInvoicingTax-v2026-01-01RequestBadRequestError": { "properties": { "errors": { "description": "Validation or business rule errors describing why the IC invoicing tax could not be deleted, such as an unsupported contract type, a missing active payment cycle, or the tax not currently existing on the contract.", "items": { "$ref": "#/components/schemas/ContractsContractIdIcInvoicingTaxesTaxTypeDeleteResponsesContentApplicationJsonSchemaErrorsItems" }, "type": "array" } }, "required": [ "errors" ], "title": "DeleteIcInvoicingTax-v2026-01-01RequestBadRequestError", "type": "object" }, "DeleteIcInvoicingTax-v2026-01-01RequestInternalServerError": { "properties": { "errors": { "description": "Generic upstream or internal errors emitted when the IC invoicing tax cannot be deleted.", "items": { "$ref": "#/components/schemas/ContractsContractIdIcInvoicingTaxesTaxTypeDeleteResponsesContentApplicationJsonSchemaErrorsItems" }, "type": "array" } }, "required": [ "errors" ], "title": "DeleteIcInvoicingTax-v2026-01-01RequestInternalServerError", "type": "object" }, "DeleteIcInvoicingTax-v2026-01-01RequestNotFoundError": { "properties": { "errors": { "description": "Errors describing why the contract could not be found.", "items": { "$ref": "#/components/schemas/ContractsContractIdIcInvoicingTaxesTaxTypeDeleteResponsesContentApplicationJsonSchemaErrorsItems" }, "type": "array" } }, "required": [ "errors" ], "title": "DeleteIcInvoicingTax-v2026-01-01RequestNotFoundError", "type": "object" }, "DeleteLegalEntity-v2026-01-01RequestBadRequestError": { "properties": { "message": { "description": "Error message explaining what went wrong.", "type": "string" } }, "title": "DeleteLegalEntity-v2026-01-01RequestBadRequestError", "type": "object" }, "DeleteLegalEntity-v2026-01-01RequestForbiddenError": { "properties": { "error": { "description": "Error message explaining why access is denied.", "type": "string" } }, "title": "DeleteLegalEntity-v2026-01-01RequestForbiddenError", "type": "object" }, "DeleteLegalEntityRegistrationDocument-v2026-08-17RequestBadRequestError": { "properties": { "errors": { "description": "List of errors that occurred while processing the request.", "items": { "$ref": "#/components/schemas/LegalEntitiesLegalEntityIdRegistrationDocumentsDocumentIdDeleteResponsesContentApplicationJsonSchemaErrorsItems" }, "type": "array" } }, "required": [ "errors" ], "title": "DeleteLegalEntityRegistrationDocument-v2026-08-17RequestBadRequestError", "type": "object" }, "DeleteLegalEntityRegistrationDocument-v2026-08-17RequestForbiddenError": { "properties": { "errors": { "description": "List of errors that occurred while processing the request.", "items": { "$ref": "#/components/schemas/LegalEntitiesLegalEntityIdRegistrationDocumentsDocumentIdDeleteResponsesContentApplicationJsonSchemaErrorsItems" }, "type": "array" } }, "required": [ "errors" ], "title": "DeleteLegalEntityRegistrationDocument-v2026-08-17RequestForbiddenError", "type": "object" }, "DeleteLegalEntityRegistrationDocument-v2026-08-17RequestNotFoundError": { "properties": { "errors": { "description": "List of errors that occurred while processing the request.", "items": { "$ref": "#/components/schemas/LegalEntitiesLegalEntityIdRegistrationDocumentsDocumentIdDeleteResponsesContentApplicationJsonSchemaErrorsItems" }, "type": "array" } }, "required": [ "errors" ], "title": "DeleteLegalEntityRegistrationDocument-v2026-08-17RequestNotFoundError", "type": "object" }, "DeleteLegalEntityRegistrationDocument-v2026-08-17RequestUnauthorizedError": { "properties": { "errors": { "description": "List of errors that occurred while processing the request.", "items": { "$ref": "#/components/schemas/LegalEntitiesLegalEntityIdRegistrationDocumentsDocumentIdDeleteResponsesContentApplicationJsonSchemaErrorsItems" }, "type": "array" } }, "required": [ "errors" ], "title": "DeleteLegalEntityRegistrationDocument-v2026-08-17RequestUnauthorizedError", "type": "object" }, "DeleteLegalEntityRegistrationDocumentFiles-v2026-08-17RequestBadRequestError": { "properties": { "errors": { "description": "List of errors that occurred while processing the request.", "items": { "$ref": "#/components/schemas/LegalEntitiesLegalEntityIdRegistrationDocumentsDocumentIdFilesDeleteResponsesContentApplicationJsonSchemaErrorsItems" }, "type": "array" } }, "required": [ "errors" ], "title": "DeleteLegalEntityRegistrationDocumentFiles-v2026-08-17RequestBadRequestError", "type": "object" }, "DeleteLegalEntityRegistrationDocumentFiles-v2026-08-17RequestForbiddenError": { "properties": { "errors": { "description": "List of errors that occurred while processing the request.", "items": { "$ref": "#/components/schemas/LegalEntitiesLegalEntityIdRegistrationDocumentsDocumentIdFilesDeleteResponsesContentApplicationJsonSchemaErrorsItems" }, "type": "array" } }, "required": [ "errors" ], "title": "DeleteLegalEntityRegistrationDocumentFiles-v2026-08-17RequestForbiddenError", "type": "object" }, "DeleteLegalEntityRegistrationDocumentFiles-v2026-08-17RequestNotFoundError": { "properties": { "errors": { "description": "List of errors that occurred while processing the request.", "items": { "$ref": "#/components/schemas/LegalEntitiesLegalEntityIdRegistrationDocumentsDocumentIdFilesDeleteResponsesContentApplicationJsonSchemaErrorsItems" }, "type": "array" } }, "required": [ "errors" ], "title": "DeleteLegalEntityRegistrationDocumentFiles-v2026-08-17RequestNotFoundError", "type": "object" }, "DeleteLegalEntityRegistrationDocumentFiles-v2026-08-17RequestUnauthorizedError": { "properties": { "errors": { "description": "List of errors that occurred while processing the request.", "items": { "$ref": "#/components/schemas/LegalEntitiesLegalEntityIdRegistrationDocumentsDocumentIdFilesDeleteResponsesContentApplicationJsonSchemaErrorsItems" }, "type": "array" } }, "required": [ "errors" ], "title": "DeleteLegalEntityRegistrationDocumentFiles-v2026-08-17RequestUnauthorizedError", "type": "object" }, "DeleteMilestoneById-v2026-01-01RequestBadRequestError": { "properties": { "errors": { "description": "Business rule errors describing why the milestone could not be removed, such as its current review status.", "items": { "$ref": "#/components/schemas/ContractsContractIdMilestonesMilestoneIdDeleteResponsesContentApplicationJsonSchemaErrorsItems" }, "type": "array" } }, "required": [ "errors" ], "title": "DeleteMilestoneById-v2026-01-01RequestBadRequestError", "type": "object" }, "DeleteMilestoneById-v2026-01-01RequestForbiddenError": { "properties": { "errors": { "description": "Errors describing why the milestone could not be deleted.", "items": { "$ref": "#/components/schemas/ContractsContractIdMilestonesMilestoneIdDeleteResponsesContentApplicationJsonSchemaErrorsItems" }, "type": "array" } }, "required": [ "errors" ], "title": "DeleteMilestoneById-v2026-01-01RequestForbiddenError", "type": "object" }, "DeleteMilestoneById-v2026-01-01RequestInternalServerError": { "properties": { "errors": { "description": "Generic upstream or internal errors emitted when the milestone cannot be deleted.", "items": { "$ref": "#/components/schemas/ContractsContractIdMilestonesMilestoneIdDeleteResponsesContentApplicationJsonSchemaErrorsItems" }, "type": "array" } }, "required": [ "errors" ], "title": "DeleteMilestoneById-v2026-01-01RequestInternalServerError", "type": "object" }, "DeleteMilestoneById-v2026-01-01RequestNotFoundError": { "properties": { "errors": { "description": "Errors describing why the milestone could not be found.", "items": { "$ref": "#/components/schemas/ContractsContractIdMilestonesMilestoneIdDeleteResponsesContentApplicationJsonSchemaErrorsItems" }, "type": "array" } }, "required": [ "errors" ], "title": "DeleteMilestoneById-v2026-01-01RequestNotFoundError", "type": "object" }, "DeleteOrganizationSecureVaultFile-v2026-08-05RequestBadRequestError": { "properties": { "errors": { "description": "List of errors that occurred while processing the request.", "items": { "$ref": "#/components/schemas/OrganizationsSecureVaultFilesFileIdDeleteResponsesContentApplicationJsonSchemaErrorsItems" }, "type": "array" } }, "required": [ "errors" ], "title": "DeleteOrganizationSecureVaultFile-v2026-08-05RequestBadRequestError", "type": "object" }, "DeleteOrganizationSecureVaultFile-v2026-08-05RequestForbiddenError": { "properties": { "errors": { "description": "List of errors that occurred while processing the request.", "items": { "$ref": "#/components/schemas/OrganizationsSecureVaultFilesFileIdDeleteResponsesContentApplicationJsonSchemaErrorsItems" }, "type": "array" } }, "required": [ "errors" ], "title": "DeleteOrganizationSecureVaultFile-v2026-08-05RequestForbiddenError", "type": "object" }, "DeleteOrganizationSecureVaultFile-v2026-08-05RequestNotFoundError": { "properties": { "errors": { "description": "List of errors that occurred while processing the request.", "items": { "$ref": "#/components/schemas/OrganizationsSecureVaultFilesFileIdDeleteResponsesContentApplicationJsonSchemaErrorsItems" }, "type": "array" } }, "required": [ "errors" ], "title": "DeleteOrganizationSecureVaultFile-v2026-08-05RequestNotFoundError", "type": "object" }, "DeleteOrganizationSecureVaultFile-v2026-08-05RequestUnauthorizedError": { "properties": { "errors": { "description": "List of errors that occurred while processing the request.", "items": { "$ref": "#/components/schemas/OrganizationsSecureVaultFilesFileIdDeleteResponsesContentApplicationJsonSchemaErrorsItems" }, "type": "array" } }, "required": [ "errors" ], "title": "DeleteOrganizationSecureVaultFile-v2026-08-05RequestUnauthorizedError", "type": "object" }, "DeleteOrganizationSecureVaultFolder-v2026-08-05RequestBadRequestError": { "properties": { "errors": { "description": "List of errors that occurred while processing the request.", "items": { "$ref": "#/components/schemas/OrganizationsSecureVaultFoldersFolderIdDeleteResponsesContentApplicationJsonSchemaErrorsItems" }, "type": "array" } }, "required": [ "errors" ], "title": "DeleteOrganizationSecureVaultFolder-v2026-08-05RequestBadRequestError", "type": "object" }, "DeleteOrganizationSecureVaultFolder-v2026-08-05RequestForbiddenError": { "properties": { "errors": { "description": "List of errors that occurred while processing the request.", "items": { "$ref": "#/components/schemas/OrganizationsSecureVaultFoldersFolderIdDeleteResponsesContentApplicationJsonSchemaErrorsItems" }, "type": "array" } }, "required": [ "errors" ], "title": "DeleteOrganizationSecureVaultFolder-v2026-08-05RequestForbiddenError", "type": "object" }, "DeleteOrganizationSecureVaultFolder-v2026-08-05RequestNotFoundError": { "properties": { "errors": { "description": "List of errors that occurred while processing the request.", "items": { "$ref": "#/components/schemas/OrganizationsSecureVaultFoldersFolderIdDeleteResponsesContentApplicationJsonSchemaErrorsItems" }, "type": "array" } }, "required": [ "errors" ], "title": "DeleteOrganizationSecureVaultFolder-v2026-08-05RequestNotFoundError", "type": "object" }, "DeleteOrganizationSecureVaultFolder-v2026-08-05RequestUnauthorizedError": { "properties": { "errors": { "description": "List of errors that occurred while processing the request.", "items": { "$ref": "#/components/schemas/OrganizationsSecureVaultFoldersFolderIdDeleteResponsesContentApplicationJsonSchemaErrorsItems" }, "type": "array" } }, "required": [ "errors" ], "title": "DeleteOrganizationSecureVaultFolder-v2026-08-05RequestUnauthorizedError", "type": "object" }, "DeleteTimesheetById-v2026-01-01RequestBadRequestError": { "properties": { "errors": { "description": "Business rule errors describing why the timesheet could not be deleted, such as its current status or type.", "items": { "$ref": "#/components/schemas/TimesheetsTimesheetIdDeleteResponsesContentApplicationJsonSchemaErrorsItems" }, "type": "array" } }, "required": [ "errors" ], "title": "DeleteTimesheetById-v2026-01-01RequestBadRequestError", "type": "object" }, "DeleteTimesheetById-v2026-01-01RequestForbiddenError": { "properties": { "errors": { "description": "Errors describing why the timesheet could not be found or accessed.", "items": { "$ref": "#/components/schemas/TimesheetsTimesheetIdDeleteResponsesContentApplicationJsonSchemaErrorsItems" }, "type": "array" } }, "required": [ "errors" ], "title": "DeleteTimesheetById-v2026-01-01RequestForbiddenError", "type": "object" }, "DeleteTimesheetById-v2026-01-01RequestInternalServerError": { "properties": { "errors": { "description": "Generic upstream or internal errors emitted when the timesheet cannot be deleted.", "items": { "$ref": "#/components/schemas/TimesheetsTimesheetIdDeleteResponsesContentApplicationJsonSchemaErrorsItems" }, "type": "array" } }, "required": [ "errors" ], "title": "DeleteTimesheetById-v2026-01-01RequestInternalServerError", "type": "object" }, "DeleteTimesheetById-v2026-01-01RequestNotFoundError": { "properties": { "errors": { "description": "Errors describing why the timesheet could not be found.", "items": { "$ref": "#/components/schemas/TimesheetsTimesheetIdDeleteResponsesContentApplicationJsonSchemaErrorsItems" }, "type": "array" } }, "required": [ "errors" ], "title": "DeleteTimesheetById-v2026-01-01RequestNotFoundError", "type": "object" }, "DeleteWebhookById-v2026-01-01RequestBadRequestError": { "properties": { "errors": { "description": "The list of errors that caused the request to fail.", "items": { "$ref": "#/components/schemas/WebhooksIdDeleteResponsesContentApplicationJsonSchemaErrorsItems" }, "type": "array" } }, "required": [ "errors" ], "title": "DeleteWebhookById-v2026-01-01RequestBadRequestError", "type": "object" }, "DeleteWebhookById-v2026-01-01RequestForbiddenError": { "properties": { "errors": { "description": "The list of errors that caused the request to fail.", "items": { "$ref": "#/components/schemas/WebhooksIdDeleteResponsesContentApplicationJsonSchemaErrorsItems" }, "type": "array" } }, "required": [ "errors" ], "title": "DeleteWebhookById-v2026-01-01RequestForbiddenError", "type": "object" }, "DeleteWebhookById-v2026-01-01RequestInternalServerError": { "properties": { "errors": { "description": "The list of errors that caused the request to fail.", "items": { "$ref": "#/components/schemas/WebhooksIdDeleteResponsesContentApplicationJsonSchemaErrorsItems" }, "type": "array" } }, "required": [ "errors" ], "title": "DeleteWebhookById-v2026-01-01RequestInternalServerError", "type": "object" }, "DeleteWebhookById-v2026-01-01RequestMethodNotAllowedError": { "properties": { "errors": { "description": "The list of errors that caused the request to fail.", "items": { "$ref": "#/components/schemas/WebhooksIdDeleteResponsesContentApplicationJsonSchemaErrorsItems" }, "type": "array" } }, "required": [ "errors" ], "title": "DeleteWebhookById-v2026-01-01RequestMethodNotAllowedError", "type": "object" }, "DeleteWebhookById-v2026-01-01RequestNotFoundError": { "properties": { "errors": { "description": "The list of errors that caused the request to fail.", "items": { "$ref": "#/components/schemas/WebhooksIdDeleteResponsesContentApplicationJsonSchemaErrorsItems" }, "type": "array" } }, "required": [ "errors" ], "title": "DeleteWebhookById-v2026-01-01RequestNotFoundError", "type": "object" }, "DeleteWebhookById-v2026-01-01RequestTooManyRequestsError": { "properties": { "errors": { "description": "The list of errors that caused the request to fail.", "items": { "$ref": "#/components/schemas/WebhooksIdDeleteResponsesContentApplicationJsonSchemaErrorsItems" }, "type": "array" } }, "required": [ "errors" ], "title": "DeleteWebhookById-v2026-01-01RequestTooManyRequestsError", "type": "object" }, "DeleteWebhookById-v2026-01-01RequestUnauthorizedError": { "properties": { "errors": { "description": "The list of errors that caused the request to fail.", "items": { "$ref": "#/components/schemas/WebhooksIdDeleteResponsesContentApplicationJsonSchemaErrorsItems" }, "type": "array" } }, "required": [ "errors" ], "title": "DeleteWebhookById-v2026-01-01RequestUnauthorizedError", "type": "object" }, "DeleteWorkerContractComplianceDocumentSubmission-v2026-08-25RequestBadRequestError": { "properties": { "errors": { "description": "Errors that occurred while processing the request.", "items": { "$ref": "#/components/schemas/WorkersContractsContractIdComplianceDocumentsDocumentIdDeleteResponsesContentApplicationJsonSchemaErrorsItems" }, "type": "array" } }, "required": [ "errors" ], "title": "DeleteWorkerContractComplianceDocumentSubmission-v2026-08-25RequestBadRequestError", "type": "object" }, "DeleteWorkerContractComplianceDocumentSubmission-v2026-08-25RequestForbiddenError": { "properties": { "errors": { "description": "Errors that occurred while processing the request.", "items": { "$ref": "#/components/schemas/WorkersContractsContractIdComplianceDocumentsDocumentIdDeleteResponsesContentApplicationJsonSchemaErrorsItems" }, "type": "array" } }, "required": [ "errors" ], "title": "DeleteWorkerContractComplianceDocumentSubmission-v2026-08-25RequestForbiddenError", "type": "object" }, "DeleteWorkerContractComplianceDocumentSubmission-v2026-08-25RequestNotFoundError": { "properties": { "errors": { "description": "Errors that occurred while processing the request.", "items": { "$ref": "#/components/schemas/WorkersContractsContractIdComplianceDocumentsDocumentIdDeleteResponsesContentApplicationJsonSchemaErrorsItems" }, "type": "array" } }, "required": [ "errors" ], "title": "DeleteWorkerContractComplianceDocumentSubmission-v2026-08-25RequestNotFoundError", "type": "object" }, "DeleteWorkerContractComplianceDocumentSubmission-v2026-08-25RequestUnauthorizedError": { "properties": { "errors": { "description": "Errors that occurred while processing the request.", "items": { "$ref": "#/components/schemas/WorkersContractsContractIdComplianceDocumentsDocumentIdDeleteResponsesContentApplicationJsonSchemaErrorsItems" }, "type": "array" } }, "required": [ "errors" ], "title": "DeleteWorkerContractComplianceDocumentSubmission-v2026-08-25RequestUnauthorizedError", "type": "object" }, "DeleteWorkerContractComplianceDocumentSubmission-v2026-08-25RequestUnprocessableEntityError": { "properties": { "errors": { "description": "Errors that occurred while processing the request.", "items": { "$ref": "#/components/schemas/WorkersContractsContractIdComplianceDocumentsDocumentIdDeleteResponsesContentApplicationJsonSchemaErrorsItems" }, "type": "array" } }, "required": [ "errors" ], "title": "DeleteWorkerContractComplianceDocumentSubmission-v2026-08-25RequestUnprocessableEntityError", "type": "object" }, "DeliverItAsset-v2026-09-15RequestBadRequestError": { "properties": { "errors": { "items": { "$ref": "#/components/schemas/ItAssetsAssetIdDeliverPostResponsesContentApplicationJsonSchemaErrorsItems" }, "type": "array" } }, "required": [ "errors" ], "title": "DeliverItAsset-v2026-09-15RequestBadRequestError", "type": "object" }, "DeliverItAsset-v2026-09-15RequestConflictError": { "properties": { "errors": { "items": { "$ref": "#/components/schemas/ItAssetsAssetIdDeliverPostResponsesContentApplicationJsonSchemaErrorsItems" }, "type": "array" } }, "required": [ "errors" ], "title": "DeliverItAsset-v2026-09-15RequestConflictError", "type": "object" }, "DeliverItAsset-v2026-09-15RequestForbiddenError": { "properties": { "errors": { "items": { "$ref": "#/components/schemas/ItAssetsAssetIdDeliverPostResponsesContentApplicationJsonSchemaErrorsItems" }, "type": "array" } }, "required": [ "errors" ], "title": "DeliverItAsset-v2026-09-15RequestForbiddenError", "type": "object" }, "DeliverItAsset-v2026-09-15RequestInternalServerError": { "properties": { "errors": { "items": { "$ref": "#/components/schemas/ItAssetsAssetIdDeliverPostResponsesContentApplicationJsonSchemaErrorsItems" }, "type": "array" } }, "required": [ "errors" ], "title": "DeliverItAsset-v2026-09-15RequestInternalServerError", "type": "object" }, "DeliverItAsset-v2026-09-15RequestNotFoundError": { "properties": { "errors": { "items": { "$ref": "#/components/schemas/ItAssetsAssetIdDeliverPostResponsesContentApplicationJsonSchemaErrorsItems" }, "type": "array" } }, "required": [ "errors" ], "title": "DeliverItAsset-v2026-09-15RequestNotFoundError", "type": "object" }, "DeliverItAsset-v2026-09-15RequestUnauthorizedError": { "properties": { "errors": { "items": { "$ref": "#/components/schemas/ItAssetsAssetIdDeliverPostResponsesContentApplicationJsonSchemaErrorsItems" }, "type": "array" } }, "required": [ "errors" ], "title": "DeliverItAsset-v2026-09-15RequestUnauthorizedError", "type": "object" }, "DepartmentsGetResponsesContentApplicationJsonSchemaDataItems": { "properties": { "id": { "description": "The unique identifier for the department.", "format": "uuid", "type": "string" }, "name": { "description": "The name of the department.", "minLength": 1, "type": "string" }, "parent": { "description": "The ID of the parent department, if applicable.", "type": [ "string", "null" ] } }, "required": [ "id", "name" ], "title": "DepartmentsGetResponsesContentApplicationJsonSchemaDataItems", "type": "object" }, "DetachOnDemandPayrollEntries-v2026-07-31RequestBadRequestError": { "properties": { "errors": { "description": "List of errors.", "items": { "$ref": "#/components/schemas/OnDemandPayrollOdpIdEntriesDetachPatchResponsesContentApplicationJsonSchemaErrorsItems" }, "type": "array" } }, "required": [ "errors" ], "title": "DetachOnDemandPayrollEntries-v2026-07-31RequestBadRequestError", "type": "object" }, "DetachOnDemandPayrollEntries-v2026-07-31RequestForbiddenError": { "properties": { "errors": { "description": "List of errors.", "items": { "$ref": "#/components/schemas/OnDemandPayrollOdpIdEntriesDetachPatchResponsesContentApplicationJsonSchemaErrorsItems" }, "type": "array" } }, "required": [ "errors" ], "title": "DetachOnDemandPayrollEntries-v2026-07-31RequestForbiddenError", "type": "object" }, "DetachOnDemandPayrollEntries-v2026-07-31RequestNotFoundError": { "properties": { "errors": { "description": "List of errors.", "items": { "$ref": "#/components/schemas/OnDemandPayrollOdpIdEntriesDetachPatchResponsesContentApplicationJsonSchemaErrorsItems" }, "type": "array" } }, "required": [ "errors" ], "title": "DetachOnDemandPayrollEntries-v2026-07-31RequestNotFoundError", "type": "object" }, "DetachOnDemandPayrollEntries-v2026-07-31RequestUnauthorizedError": { "properties": { "errors": { "description": "List of errors.", "items": { "$ref": "#/components/schemas/OnDemandPayrollOdpIdEntriesDetachPatchResponsesContentApplicationJsonSchemaErrorsItems" }, "type": "array" } }, "required": [ "errors" ], "title": "DetachOnDemandPayrollEntries-v2026-07-31RequestUnauthorizedError", "type": "object" }, "Documents_addLegalEntityRegistrationDocumentFiles-v2026-08-17_Response_200": { "properties": { "data": { "$ref": "#/components/schemas/LegalEntitiesLegalEntityIdRegistrationDocumentsDocumentIdPatchResponsesContentApplicationJsonSchemaData" } }, "required": [ "data" ], "title": "Documents_addLegalEntityRegistrationDocumentFiles-v2026-08-17_Response_200", "type": "object" }, "Documents_createOrganizationSecureVaultFolder-v2026-08-05_Response_201": { "properties": { "data": { "$ref": "#/components/schemas/OrganizationsSecureVaultFoldersPostResponsesContentApplicationJsonSchemaData", "description": "The created folder." } }, "required": [ "data" ], "title": "Documents_createOrganizationSecureVaultFolder-v2026-08-05_Response_201", "type": "object" }, "Documents_downloadLegalEntityRegistrationDocumentFile-v2026-08-17_Response_200": { "properties": { "data": { "$ref": "#/components/schemas/LegalEntitiesLegalEntityIdRegistrationDocumentsDocumentIdFilesFileIdDownloadGetResponsesContentApplicationJsonSchemaData" } }, "required": [ "data" ], "title": "Documents_downloadLegalEntityRegistrationDocumentFile-v2026-08-17_Response_200", "type": "object" }, "Documents_downloadLegalEntityRegistrationDocumentRequirementTemplate-v2026-08-17_Response_200": { "properties": { "data": { "$ref": "#/components/schemas/RegistrationDocumentRequirementsRequirementIdTemplateGetResponsesContentApplicationJsonSchemaData" } }, "required": [ "data" ], "title": "Documents_downloadLegalEntityRegistrationDocumentRequirementTemplate-v2026-08-17_Response_200", "type": "object" }, "Documents_getLegalEntityRegistrationDocument-v2026-08-17_Response_200": { "properties": { "data": { "$ref": "#/components/schemas/LegalEntitiesLegalEntityIdRegistrationDocumentsDocumentIdGetResponsesContentApplicationJsonSchemaData" } }, "required": [ "data" ], "title": "Documents_getLegalEntityRegistrationDocument-v2026-08-17_Response_200", "type": "object" }, "Documents_getOrganizationSecureVaultFolder-v2026-08-05_Response_200": { "properties": { "data": { "$ref": "#/components/schemas/OrganizationsSecureVaultFoldersFolderIdGetResponsesContentApplicationJsonSchemaData", "description": "The folder." } }, "required": [ "data" ], "title": "Documents_getOrganizationSecureVaultFolder-v2026-08-05_Response_200", "type": "object" }, "Documents_listLegalEntityRegistrationDocuments-v2026-08-17_Response_200": { "properties": { "data": { "description": "Documents for this page.", "items": { "$ref": "#/components/schemas/LegalEntitiesLegalEntityIdRegistrationDocumentsGetResponsesContentApplicationJsonSchemaDataItems" }, "type": "array" }, "has_more": { "description": "Whether another page of results is available.", "type": "boolean" }, "next_cursor": { "description": "Cursor to pass as `cursor` for the next page. Null when there are no more pages.", "type": [ "string", "null" ] }, "total_count": { "description": "Total number of matching documents.", "minimum": 0, "type": "integer" } }, "required": [ "data", "has_more", "next_cursor", "total_count" ], "title": "Documents_listLegalEntityRegistrationDocuments-v2026-08-17_Response_200", "type": "object" }, "Documents_listOrganizationRegistrationDocuments-v2026-08-17_Response_200": { "properties": { "data": { "description": "Documents for this page.", "items": { "$ref": "#/components/schemas/LegalEntitiesRegistrationDocumentsGetResponsesContentApplicationJsonSchemaDataItems" }, "type": "array" }, "has_more": { "description": "Whether another page of results is available.", "type": "boolean" }, "next_cursor": { "description": "Cursor to pass as `cursor` for the next page. Null when there are no more pages.", "type": [ "string", "null" ] }, "total_count": { "description": "Total number of matching documents.", "minimum": 0, "type": "integer" } }, "required": [ "data", "has_more", "next_cursor", "total_count" ], "title": "Documents_listOrganizationRegistrationDocuments-v2026-08-17_Response_200", "type": "object" }, "Documents_listOrganizationSecureVaultFolderItems-v2026-08-05_Response_200": { "properties": { "data": { "description": "Folders and files for this page.", "items": { "$ref": "#/components/schemas/OrganizationsSecureVaultFoldersFolderIdItemsGetResponsesContentApplicationJsonSchemaDataItems" }, "type": "array" }, "has_more": { "description": "Whether another page of results is available.", "type": "boolean" }, "next_cursor": { "description": "Cursor for the next page. Null when there are no more pages.", "type": [ "string", "null" ] }, "total_count": { "description": "Total number of matching records.", "minimum": 0, "type": "integer" } }, "required": [ "data", "has_more", "next_cursor", "total_count" ], "title": "Documents_listOrganizationSecureVaultFolderItems-v2026-08-05_Response_200", "type": "object" }, "Documents_resubmitLegalEntityRegistrationDocument-v2026-08-17_Response_200": { "properties": { "data": { "$ref": "#/components/schemas/LegalEntitiesLegalEntityIdRegistrationDocumentsDocumentIdPutResponsesContentApplicationJsonSchemaData" } }, "required": [ "data" ], "title": "Documents_resubmitLegalEntityRegistrationDocument-v2026-08-17_Response_200", "type": "object" }, "Documents_submitLegalEntityRegistrationDocuments-v2026-08-17_Response_201": { "properties": { "data": { "description": "The created submissions, in request order.", "items": { "$ref": "#/components/schemas/LegalEntitiesLegalEntityIdRegistrationDocumentsPostResponsesContentApplicationJsonSchemaDataItems" }, "type": "array" } }, "required": [ "data" ], "title": "Documents_submitLegalEntityRegistrationDocuments-v2026-08-17_Response_201", "type": "object" }, "Documents_uploadOrganizationSecureVaultFiles-v2026-08-05_Response_201": { "properties": { "data": { "$ref": "#/components/schemas/OrganizationsSecureVaultFilesPostResponsesContentApplicationJsonSchemaData", "description": "Result of the upload." } }, "required": [ "data" ], "title": "Documents_uploadOrganizationSecureVaultFiles-v2026-08-05_Response_201", "type": "object" }, "Documents_uploadOrganizationSecureVaultFilesToFolder-v2026-08-05_Response_201": { "properties": { "data": { "$ref": "#/components/schemas/OrganizationsSecureVaultFoldersFolderIdFilesPostResponsesContentApplicationJsonSchemaData", "description": "Result of the upload." } }, "required": [ "data" ], "title": "Documents_uploadOrganizationSecureVaultFilesToFolder-v2026-08-05_Response_201", "type": "object" }, "DownloadAGpWorkerPayslip-v2026-01-01RequestBadRequestError": { "properties": { "errors": { "description": "Error messages", "items": { "$ref": "#/components/schemas/GpWorkersIdPayslipsPayslipIdDownloadGetResponsesContentApplicationJsonSchemaErrorsItems" }, "type": "array" }, "request": { "$ref": "#/components/schemas/GpWorkersIdPayslipsPayslipIdDownloadGetResponsesContentApplicationJsonSchemaRequest", "description": "Error request details" } }, "required": [ "errors" ], "title": "DownloadAGpWorkerPayslip-v2026-01-01RequestBadRequestError", "type": "object" }, "DownloadEmployeeAgreementPdf-v2026-01-01RequestBadRequestError": { "properties": { "errors": { "items": { "$ref": "#/components/schemas/EorWorkersContractsContractIdEmployeeAgreementDownloadGetResponsesContentApplicationJsonSchemaErrorsItems" }, "type": "array" } }, "title": "DownloadEmployeeAgreementPdf-v2026-01-01RequestBadRequestError", "type": "object" }, "DownloadEmployeeAgreementPdf-v2026-01-01RequestConflictError": { "properties": { "errors": { "items": { "$ref": "#/components/schemas/EorWorkersContractsContractIdEmployeeAgreementDownloadGetResponsesContentApplicationJsonSchemaErrorsItems" }, "type": "array" }, "request": { "$ref": "#/components/schemas/EorWorkersContractsContractIdEmployeeAgreementDownloadGetResponsesContentApplicationJsonSchemaRequest" } }, "title": "DownloadEmployeeAgreementPdf-v2026-01-01RequestConflictError", "type": "object" }, "DownloadEmployeeAgreementPdf-v2026-01-01RequestNotFoundError": { "properties": { "errors": { "items": { "$ref": "#/components/schemas/EorWorkersContractsContractIdEmployeeAgreementDownloadGetResponsesContentApplicationJsonSchemaErrorsItems" }, "type": "array" } }, "title": "DownloadEmployeeAgreementPdf-v2026-01-01RequestNotFoundError", "type": "object" }, "DownloadEmployeeComplianceDocumentTemplate-v2026-01-01RequestNotFoundError": { "properties": { "errors": { "description": "List of errors.", "items": { "$ref": "#/components/schemas/EorWorkersComplianceDocumentsDocumentIdTemplatesDownloadGetResponsesContentApplicationJsonSchemaErrorsItems" }, "type": "array" } }, "title": "DownloadEmployeeComplianceDocumentTemplate-v2026-01-01RequestNotFoundError", "type": "object" }, "DownloadHrxDocuments-v2026-01-01RequestBadRequestError": { "properties": { "errors": { "items": { "$ref": "#/components/schemas/EorContractsContractIdHrxDocumentsDocumentIdGetResponsesContentApplicationJsonSchemaErrorsItems" }, "type": "array" } }, "title": "DownloadHrxDocuments-v2026-01-01RequestBadRequestError", "type": "object" }, "DownloadHrxDocuments-v2026-01-01RequestUnauthorizedError": { "properties": { "errors": { "items": { "$ref": "#/components/schemas/EorContractsContractIdHrxDocumentsDocumentIdGetResponsesContentApplicationJsonSchemaErrorsItems" }, "type": "array" } }, "title": "DownloadHrxDocuments-v2026-01-01RequestUnauthorizedError", "type": "object" }, "DownloadLegalEntityRegistrationDocumentFile-v2026-08-17RequestBadRequestError": { "properties": { "errors": { "description": "List of errors that occurred while processing the request.", "items": { "$ref": "#/components/schemas/LegalEntitiesLegalEntityIdRegistrationDocumentsDocumentIdFilesFileIdDownloadGetResponsesContentApplicationJsonSchemaErrorsItems" }, "type": "array" } }, "required": [ "errors" ], "title": "DownloadLegalEntityRegistrationDocumentFile-v2026-08-17RequestBadRequestError", "type": "object" }, "DownloadLegalEntityRegistrationDocumentFile-v2026-08-17RequestForbiddenError": { "properties": { "errors": { "description": "List of errors that occurred while processing the request.", "items": { "$ref": "#/components/schemas/LegalEntitiesLegalEntityIdRegistrationDocumentsDocumentIdFilesFileIdDownloadGetResponsesContentApplicationJsonSchemaErrorsItems" }, "type": "array" } }, "required": [ "errors" ], "title": "DownloadLegalEntityRegistrationDocumentFile-v2026-08-17RequestForbiddenError", "type": "object" }, "DownloadLegalEntityRegistrationDocumentFile-v2026-08-17RequestNotFoundError": { "properties": { "errors": { "description": "List of errors that occurred while processing the request.", "items": { "$ref": "#/components/schemas/LegalEntitiesLegalEntityIdRegistrationDocumentsDocumentIdFilesFileIdDownloadGetResponsesContentApplicationJsonSchemaErrorsItems" }, "type": "array" } }, "required": [ "errors" ], "title": "DownloadLegalEntityRegistrationDocumentFile-v2026-08-17RequestNotFoundError", "type": "object" }, "DownloadLegalEntityRegistrationDocumentFile-v2026-08-17RequestUnauthorizedError": { "properties": { "errors": { "description": "List of errors that occurred while processing the request.", "items": { "$ref": "#/components/schemas/LegalEntitiesLegalEntityIdRegistrationDocumentsDocumentIdFilesFileIdDownloadGetResponsesContentApplicationJsonSchemaErrorsItems" }, "type": "array" } }, "required": [ "errors" ], "title": "DownloadLegalEntityRegistrationDocumentFile-v2026-08-17RequestUnauthorizedError", "type": "object" }, "DownloadLegalEntityRegistrationDocumentRequirementTemplate-v2026-08-17RequestBadRequestError": { "properties": { "errors": { "description": "List of errors that occurred while processing the request.", "items": { "$ref": "#/components/schemas/RegistrationDocumentRequirementsRequirementIdTemplateGetResponsesContentApplicationJsonSchemaErrorsItems" }, "type": "array" } }, "required": [ "errors" ], "title": "DownloadLegalEntityRegistrationDocumentRequirementTemplate-v2026-08-17RequestBadRequestError", "type": "object" }, "DownloadLegalEntityRegistrationDocumentRequirementTemplate-v2026-08-17RequestForbiddenError": { "properties": { "errors": { "description": "List of errors that occurred while processing the request.", "items": { "$ref": "#/components/schemas/RegistrationDocumentRequirementsRequirementIdTemplateGetResponsesContentApplicationJsonSchemaErrorsItems" }, "type": "array" } }, "required": [ "errors" ], "title": "DownloadLegalEntityRegistrationDocumentRequirementTemplate-v2026-08-17RequestForbiddenError", "type": "object" }, "DownloadLegalEntityRegistrationDocumentRequirementTemplate-v2026-08-17RequestNotFoundError": { "properties": { "errors": { "description": "List of errors that occurred while processing the request.", "items": { "$ref": "#/components/schemas/RegistrationDocumentRequirementsRequirementIdTemplateGetResponsesContentApplicationJsonSchemaErrorsItems" }, "type": "array" } }, "required": [ "errors" ], "title": "DownloadLegalEntityRegistrationDocumentRequirementTemplate-v2026-08-17RequestNotFoundError", "type": "object" }, "DownloadLegalEntityRegistrationDocumentRequirementTemplate-v2026-08-17RequestUnauthorizedError": { "properties": { "errors": { "description": "List of errors that occurred while processing the request.", "items": { "$ref": "#/components/schemas/RegistrationDocumentRequirementsRequirementIdTemplateGetResponsesContentApplicationJsonSchemaErrorsItems" }, "type": "array" } }, "required": [ "errors" ], "title": "DownloadLegalEntityRegistrationDocumentRequirementTemplate-v2026-08-17RequestUnauthorizedError", "type": "object" }, "DownloadSubmittedComplianceDocument-v2026-01-01RequestBadRequestError": { "properties": { "errors": { "items": { "$ref": "#/components/schemas/EorWorkersComplianceDocumentsDocumentIdDownloadGetResponsesContentApplicationJsonSchemaErrorsItems" }, "type": "array" }, "request": { "$ref": "#/components/schemas/EorWorkersComplianceDocumentsDocumentIdDownloadGetResponsesContentApplicationJsonSchemaRequest" } }, "title": "DownloadSubmittedComplianceDocument-v2026-01-01RequestBadRequestError", "type": "object" }, "DownloadWorkerContractComplianceDocument-v2026-08-25RequestBadRequestError": { "properties": { "errors": { "description": "Errors that occurred while processing the request.", "items": { "$ref": "#/components/schemas/WorkersContractsContractIdComplianceDocumentsDocumentIdDownloadGetResponsesContentApplicationJsonSchemaErrorsItems" }, "type": "array" } }, "required": [ "errors" ], "title": "DownloadWorkerContractComplianceDocument-v2026-08-25RequestBadRequestError", "type": "object" }, "DownloadWorkerContractComplianceDocument-v2026-08-25RequestForbiddenError": { "properties": { "errors": { "description": "Errors that occurred while processing the request.", "items": { "$ref": "#/components/schemas/WorkersContractsContractIdComplianceDocumentsDocumentIdDownloadGetResponsesContentApplicationJsonSchemaErrorsItems" }, "type": "array" } }, "required": [ "errors" ], "title": "DownloadWorkerContractComplianceDocument-v2026-08-25RequestForbiddenError", "type": "object" }, "DownloadWorkerContractComplianceDocument-v2026-08-25RequestNotFoundError": { "properties": { "errors": { "description": "Errors that occurred while processing the request.", "items": { "$ref": "#/components/schemas/WorkersContractsContractIdComplianceDocumentsDocumentIdDownloadGetResponsesContentApplicationJsonSchemaErrorsItems" }, "type": "array" } }, "required": [ "errors" ], "title": "DownloadWorkerContractComplianceDocument-v2026-08-25RequestNotFoundError", "type": "object" }, "DownloadWorkerContractComplianceDocument-v2026-08-25RequestUnauthorizedError": { "properties": { "errors": { "description": "Errors that occurred while processing the request.", "items": { "$ref": "#/components/schemas/WorkersContractsContractIdComplianceDocumentsDocumentIdDownloadGetResponsesContentApplicationJsonSchemaErrorsItems" }, "type": "array" } }, "required": [ "errors" ], "title": "DownloadWorkerContractComplianceDocument-v2026-08-25RequestUnauthorizedError", "type": "object" }, "DownloadWorkerContractComplianceDocument-v2026-08-25RequestUnprocessableEntityError": { "properties": { "errors": { "description": "Errors that occurred while processing the request.", "items": { "$ref": "#/components/schemas/WorkersContractsContractIdComplianceDocumentsDocumentIdDownloadGetResponsesContentApplicationJsonSchemaErrorsItems" }, "type": "array" } }, "required": [ "errors" ], "title": "DownloadWorkerContractComplianceDocument-v2026-08-25RequestUnprocessableEntityError", "type": "object" }, "DynamicRequirements-v2026-01-01RequestBadRequestError": { "properties": { "errors": { "items": { "$ref": "#/components/schemas/PayoutsEmployeesMethodsBankTransfersRequirementsPostResponsesContentApplicationJsonSchemaErrorsItems" }, "type": "array" } }, "title": "DynamicRequirements-v2026-01-01RequestBadRequestError", "type": "object" }, "EOR_getAdditionalInformation-v2026-09-18_Response_200": { "properties": { "data": { "$ref": "#/components/schemas/EorWorkersContractsContractIdAdditionalInformationGetResponsesContentApplicationJsonSchemaData", "description": "Only fields with a saved value are included. Keys not listed above are country/state-specific additional information fields, keyed the same way as the fields returned by GET /forms/eor/worker-additional-fields/{country_code} (public keys)." } }, "required": [ "data" ], "title": "EOR_getAdditionalInformation-v2026-09-18_Response_200", "type": "object" }, "EOR_getAmendmentDataPointsConfigurationByCountry-v2026-05-06_Response_200": { "properties": { "data": { "$ref": "#/components/schemas/EorContractsAmendmentsDataPointsConfigurationGetResponsesContentApplicationJsonSchemaData" }, "has_more": { "description": "Whether more pages are available", "type": "boolean" }, "next_cursor": { "description": "Opaque cursor to pass as the cursor query param to fetch the next page. null when on the last page.", "type": [ "string", "null" ] }, "total_count": { "description": "Total number of countries with amendment settings in the database", "type": "integer" } }, "required": [ "data", "has_more", "next_cursor", "total_count" ], "title": "EOR_getAmendmentDataPointsConfigurationByCountry-v2026-05-06_Response_200", "type": "object" }, "EOR_getEmployeeAgreementDraftPreview-v2026-01-01_Response_200": { "properties": { "data": { "$ref": "#/components/schemas/EorContractsContractIdEmployeeAgreementDraftPreviewGetResponsesContentApplicationJsonSchemaData" } }, "title": "EOR_getEmployeeAgreementDraftPreview-v2026-01-01_Response_200", "type": "object" }, "EOR_modifyBankAccountForAnEorEmployee-v2026-08-19_Response_201": { "properties": { "data": { "$ref": "#/components/schemas/EorWorkersBanksBankIdPatchResponsesContentApplicationJsonSchemaData" } }, "required": [ "data" ], "title": "EOR_modifyBankAccountForAnEorEmployee-v2026-08-19_Response_201", "type": "object" }, "EOR_rejectEorQuote-v2026-09-10_Response_200": { "properties": { "data": { "$ref": "#/components/schemas/EorContractsContractIdRejectPatchResponsesContentApplicationJsonSchemaData" } }, "title": "EOR_rejectEorQuote-v2026-09-10_Response_200", "type": "object" }, "EditALegalEntity-v2026-01-01RequestBadRequestError": { "properties": { "message": { "description": "Error message explaining what went wrong.", "type": "string" } }, "title": "EditALegalEntity-v2026-01-01RequestBadRequestError", "type": "object" }, "EditALegalEntity-v2026-01-01RequestForbiddenError": { "properties": { "error": { "description": "Error message explaining why access is denied.", "type": "string" } }, "title": "EditALegalEntity-v2026-01-01RequestForbiddenError", "type": "object" }, "EditGroup-v2026-01-01RequestBadRequestError": { "properties": { "error": { "$ref": "#/components/schemas/GroupsIdPatchResponsesContentApplicationJsonSchemaError" } }, "title": "EditGroup-v2026-01-01RequestBadRequestError", "type": "object" }, "EmployeeAdditionalInfoTemplate-v2026-01-01RequestBadRequestError": { "properties": {}, "title": "EmployeeAdditionalInfoTemplate-v2026-01-01RequestBadRequestError", "type": "object" }, "EmployeeAdditionalInfoTemplate-v2026-01-01RequestForbiddenError": { "properties": { "errors": { "items": { "$ref": "#/components/schemas/EmployeeInfoContractTypesTypeCountriesCountryGetResponsesContentApplicationJsonSchemaErrorsItems" }, "type": "array" } }, "required": [ "errors" ], "title": "EmployeeAdditionalInfoTemplate-v2026-01-01RequestForbiddenError", "type": "object" }, "EmployeeAdditionalInfoTemplate-v2026-01-01RequestInternalServerError": { "properties": { "errors": { "items": { "$ref": "#/components/schemas/EmployeeInfoContractTypesTypeCountriesCountryGetResponsesContentApplicationJsonSchemaErrorsItems" }, "type": "array" } }, "required": [ "errors" ], "title": "EmployeeAdditionalInfoTemplate-v2026-01-01RequestInternalServerError", "type": "object" }, "EmployeeAdditionalInfoTemplate-v2026-01-01RequestNotFoundError": { "properties": { "errors": { "items": { "$ref": "#/components/schemas/EmployeeInfoContractTypesTypeCountriesCountryGetResponsesContentApplicationJsonSchemaErrorsItems" }, "type": "array" } }, "required": [ "errors" ], "title": "EmployeeAdditionalInfoTemplate-v2026-01-01RequestNotFoundError", "type": "object" }, "EmployeeAdditionalInfoTemplate-v2026-01-01RequestTooManyRequestsError": { "properties": { "errors": { "items": { "$ref": "#/components/schemas/EmployeeInfoContractTypesTypeCountriesCountryGetResponsesContentApplicationJsonSchemaErrorsItems" }, "type": "array" } }, "required": [ "errors" ], "title": "EmployeeAdditionalInfoTemplate-v2026-01-01RequestTooManyRequestsError", "type": "object" }, "EmployeeAdditionalInfoTemplate-v2026-01-01RequestUnauthorizedError": { "properties": { "errors": { "items": { "$ref": "#/components/schemas/EmployeeInfoContractTypesTypeCountriesCountryGetResponsesContentApplicationJsonSchemaErrorsItems" }, "type": "array" } }, "required": [ "errors" ], "title": "EmployeeAdditionalInfoTemplate-v2026-01-01RequestUnauthorizedError", "type": "object" }, "EmployeeInfoContractTypesTypeCountriesCountryGetParametersType": { "enum": [ "eor", "gp" ], "title": "EmployeeInfoContractTypesTypeCountriesCountryGetParametersType", "type": "string" }, "EmployeeInfoContractTypesTypeCountriesCountryGetResponsesContentApplicationJsonSchemaDataItems": { "properties": { "alias": { "description": "Alias for the field", "type": "string" }, "can_be_skipped": { "description": "Indicates if the field can be skipped", "type": [ "boolean", "null" ] }, "dependencies": { "description": "Dependencies for the field", "items": { "$ref": "#/components/schemas/EmployeeInfoContractTypesTypeCountriesCountryGetResponsesContentApplicationJsonSchemaDataItemsDependenciesItems" }, "type": [ "array", "null" ] }, "dependency_condition_match_mode": { "description": "Condition match mode for dependencies", "oneOf": [ { "$ref": "#/components/schemas/EmployeeInfoContractTypesTypeCountriesCountryGetResponsesContentApplicationJsonSchemaDataItemsDependencyConditionMatchMode" }, { "type": "null" } ] }, "description": { "description": "Description of the field", "type": [ "string", "null" ] }, "display_order": { "description": "Display order of the field", "type": [ "string", "null" ] }, "footnote": { "description": "Footnote for the field", "type": [ "string", "null" ] }, "how_to_obtain": { "description": "Instructions on how to obtain the field value", "type": [ "string", "null" ] }, "id": { "description": "Unique identifier for the field", "type": "string" }, "input_configuration": { "description": "Configuration object for the input field. Present for input types that require additional format or display configuration, such as date fields.", "oneOf": [ { "$ref": "#/components/schemas/EmployeeInfoContractTypesTypeCountriesCountryGetResponsesContentApplicationJsonSchemaDataItemsInputConfiguration" }, { "type": "null" } ] }, "input_type": { "description": "Type of input for the field", "type": "string" }, "is_optional": { "description": "Indicates if the field is optional", "type": "boolean" }, "label": { "description": "Label for the field", "type": "string" }, "link_to_obtain": { "description": "Link to obtain the field value", "type": [ "string", "null" ] }, "link_to_obtain_label": { "description": "Label for the link to obtain the field value", "type": [ "string", "null" ] }, "local_name": { "description": "Local name for the field", "type": [ "string", "null" ] }, "name": { "description": "Name of the field", "type": "string" }, "options": { "description": "Options for select input type", "items": { "type": "string" }, "type": [ "array", "null" ] }, "required_by": { "description": "Specifies when the field is required", "type": "string" }, "validation_error_message": { "description": "Validation error message for the field", "type": [ "string", "null" ] }, "validation_rule": { "description": "Validation rule for the field", "type": [ "string", "null" ] } }, "title": "EmployeeInfoContractTypesTypeCountriesCountryGetResponsesContentApplicationJsonSchemaDataItems", "type": "object" }, "EmployeeInfoContractTypesTypeCountriesCountryGetResponsesContentApplicationJsonSchemaDataItemsDependenciesItems": { "properties": { "id": { "description": "ID of the dependency", "type": "string" }, "value": { "$ref": "#/components/schemas/EmployeeInfoContractTypesTypeCountriesCountryGetResponsesContentApplicationJsonSchemaDataItemsDependenciesItemsValue", "description": "Value the parent field is compared against. A bare scalar or array implies equality (membership for arrays); the object form specifies an explicit comparison operator, and requires value for every operator except notnull." } }, "title": "EmployeeInfoContractTypesTypeCountriesCountryGetResponsesContentApplicationJsonSchemaDataItemsDependenciesItems", "type": "object" }, "EmployeeInfoContractTypesTypeCountriesCountryGetResponsesContentApplicationJsonSchemaDataItemsDependenciesItemsValue": { "description": "Value the parent field is compared against. A bare scalar or array implies equality (membership for arrays); the object form specifies an explicit comparison operator, and requires value for every operator except notnull.", "oneOf": [ { "type": "string" }, { "format": "double", "type": "number" }, { "type": "boolean" }, { "$ref": "#/components/schemas/EmployeeInfoContractTypesTypeCountriesCountryGetResponsesContentApplicationJsonSchemaDataItemsDependenciesItemsValue3" }, { "$ref": "#/components/schemas/EmployeeInfoContractTypesTypeCountriesCountryGetResponsesContentApplicationJsonSchemaDataItemsDependenciesItemsValue4" } ], "title": "EmployeeInfoContractTypesTypeCountriesCountryGetResponsesContentApplicationJsonSchemaDataItemsDependenciesItemsValue" }, "EmployeeInfoContractTypesTypeCountriesCountryGetResponsesContentApplicationJsonSchemaDataItemsDependenciesItemsValue3": { "items": { "$ref": "#/components/schemas/EmployeeInfoContractTypesTypeCountriesCountryGetResponsesContentApplicationJsonSchemaDataItemsDependenciesItemsValueOneOf3Items" }, "title": "EmployeeInfoContractTypesTypeCountriesCountryGetResponsesContentApplicationJsonSchemaDataItemsDependenciesItemsValue3", "type": "array" }, "EmployeeInfoContractTypesTypeCountriesCountryGetResponsesContentApplicationJsonSchemaDataItemsDependenciesItemsValue4": { "oneOf": [ { "$ref": "#/components/schemas/EmployeeInfoContractTypesTypeCountriesCountryGetResponsesContentApplicationJsonSchemaDataItemsDependenciesItemsValue40" }, { "$ref": "#/components/schemas/EmployeeInfoContractTypesTypeCountriesCountryGetResponsesContentApplicationJsonSchemaDataItemsDependenciesItemsValue41" } ], "title": "EmployeeInfoContractTypesTypeCountriesCountryGetResponsesContentApplicationJsonSchemaDataItemsDependenciesItemsValue4" }, "EmployeeInfoContractTypesTypeCountriesCountryGetResponsesContentApplicationJsonSchemaDataItemsDependenciesItemsValue40": { "properties": { "op": { "$ref": "#/components/schemas/EmployeeInfoContractTypesTypeCountriesCountryGetResponsesContentApplicationJsonSchemaDataItemsDependenciesItemsValueOneOf4OneOf0Op" } }, "required": [ "op" ], "title": "EmployeeInfoContractTypesTypeCountriesCountryGetResponsesContentApplicationJsonSchemaDataItemsDependenciesItemsValue40", "type": "object" }, "EmployeeInfoContractTypesTypeCountriesCountryGetResponsesContentApplicationJsonSchemaDataItemsDependenciesItemsValue41": { "properties": { "op": { "$ref": "#/components/schemas/EmployeeInfoContractTypesTypeCountriesCountryGetResponsesContentApplicationJsonSchemaDataItemsDependenciesItemsValueOneOf4OneOf1Op" } }, "required": [ "op" ], "title": "EmployeeInfoContractTypesTypeCountriesCountryGetResponsesContentApplicationJsonSchemaDataItemsDependenciesItemsValue41", "type": "object" }, "EmployeeInfoContractTypesTypeCountriesCountryGetResponsesContentApplicationJsonSchemaDataItemsDependenciesItemsValueOneOf3Items": { "oneOf": [ { "type": "string" }, { "format": "double", "type": "number" }, { "type": "boolean" } ], "title": "EmployeeInfoContractTypesTypeCountriesCountryGetResponsesContentApplicationJsonSchemaDataItemsDependenciesItemsValueOneOf3Items" }, "EmployeeInfoContractTypesTypeCountriesCountryGetResponsesContentApplicationJsonSchemaDataItemsDependenciesItemsValueOneOf4OneOf0Op": { "enum": [ "eq", "ne", "gt", "gte", "lt", "lte", "contains" ], "title": "EmployeeInfoContractTypesTypeCountriesCountryGetResponsesContentApplicationJsonSchemaDataItemsDependenciesItemsValueOneOf4OneOf0Op", "type": "string" }, "EmployeeInfoContractTypesTypeCountriesCountryGetResponsesContentApplicationJsonSchemaDataItemsDependenciesItemsValueOneOf4OneOf1Op": { "enum": [ "notnull" ], "title": "EmployeeInfoContractTypesTypeCountriesCountryGetResponsesContentApplicationJsonSchemaDataItemsDependenciesItemsValueOneOf4OneOf1Op", "type": "string" }, "EmployeeInfoContractTypesTypeCountriesCountryGetResponsesContentApplicationJsonSchemaDataItemsDependencyConditionMatchMode": { "description": "Condition match mode for dependencies", "enum": [ "ALL", "ANY" ], "title": "EmployeeInfoContractTypesTypeCountriesCountryGetResponsesContentApplicationJsonSchemaDataItemsDependencyConditionMatchMode", "type": "string" }, "EmployeeInfoContractTypesTypeCountriesCountryGetResponsesContentApplicationJsonSchemaDataItemsInputConfiguration": { "description": "Configuration object for the input field. Present for input types that require additional format or display configuration, such as date fields.", "properties": { "format": { "$ref": "#/components/schemas/EmployeeInfoContractTypesTypeCountriesCountryGetResponsesContentApplicationJsonSchemaDataItemsInputConfigurationFormat", "description": "Format configuration for the input" }, "type": { "description": "The configuration type matching the input type", "type": "string" } }, "title": "EmployeeInfoContractTypesTypeCountriesCountryGetResponsesContentApplicationJsonSchemaDataItemsInputConfiguration", "type": "object" }, "EmployeeInfoContractTypesTypeCountriesCountryGetResponsesContentApplicationJsonSchemaDataItemsInputConfigurationFormat": { "description": "Format configuration for the input", "properties": { "pattern": { "description": "Date format pattern", "type": "string" }, "separator": { "description": "Separator character for the format", "type": "string" } }, "title": "EmployeeInfoContractTypesTypeCountriesCountryGetResponsesContentApplicationJsonSchemaDataItemsInputConfigurationFormat", "type": "object" }, "EmployeeInfoContractTypesTypeCountriesCountryGetResponsesContentApplicationJsonSchemaErrorsItems": { "properties": { "message": { "description": "Use this message for logging and debugging purposes. Contains a general error description.", "type": "string" } }, "required": [ "message" ], "title": "EmployeeInfoContractTypesTypeCountriesCountryGetResponsesContentApplicationJsonSchemaErrorsItems", "type": "object" }, "Employee_Information_employeeAdditionalInfoTemplate-v2026-01-01_Response_200": { "properties": { "data": { "items": { "$ref": "#/components/schemas/EmployeeInfoContractTypesTypeCountriesCountryGetResponsesContentApplicationJsonSchemaDataItems" }, "type": "array" } }, "title": "Employee Information_employeeAdditionalInfoTemplate-v2026-01-01_Response_200", "type": "object" }, "EngageLearningActionableJourneysGetResponsesContentApplicationJsonSchemaDataItems": { "description": "ActionableJourney item", "properties": { "actionable_path": { "description": "Path to redirect User for starting/resuming the Actionable Journey.", "type": "string" }, "completed_journey_steps_count": { "description": "Number of Journey Steps the worker has completed so far.", "minimum": 0, "type": "integer" }, "completion": { "$ref": "#/components/schemas/EngageLearningActionableJourneysGetResponsesContentApplicationJsonSchemaDataItemsCompletion", "description": "Completion status of the Journey" }, "journey": { "$ref": "#/components/schemas/EngageLearningActionableJourneysGetResponsesContentApplicationJsonSchemaDataItemsJourney", "description": "Journey details" }, "recipient_setting_dynamic_role_id": { "description": "Dynamic role/relationship ID for RecipientSetting.", "type": [ "string", "null" ] }, "recipient_setting_dynamic_role_name": { "description": "Dynamic role name for RecipientSetting", "type": [ "string", "null" ] }, "recipient_setting_type": { "description": "Type of RecipientSetting. e.g Manager, Buddy etc.", "oneOf": [ { "$ref": "#/components/schemas/EngageLearningActionableJourneysGetResponsesContentApplicationJsonSchemaDataItemsRecipientSettingType" }, { "type": "null" } ] }, "recipientable": { "$ref": "#/components/schemas/EngageLearningActionableJourneysGetResponsesContentApplicationJsonSchemaDataItemsRecipientable", "description": "Recipient for the ActionableJourney Step. Used in conjunction with recipient_setting_type. Recipient can be the same user as Assignee or any other user e.g Manager or Accounts Lead based on the RecipientSetting for the Step." }, "scopeable": { "$ref": "#/components/schemas/EngageLearningActionableJourneysGetResponsesContentApplicationJsonSchemaDataItemsScopeable", "description": "Scopeable entity details e.g Assignment details" }, "step": { "$ref": "#/components/schemas/EngageLearningActionableJourneysGetResponsesContentApplicationJsonSchemaDataItemsStep", "description": "Step details" }, "total_journey_steps_count": { "description": "Total number of Journey Steps in this Journey.", "minimum": 0, "type": "integer" } }, "required": [ "step", "journey", "scopeable", "completion", "recipientable", "actionable_path", "recipient_setting_type", "total_journey_steps_count", "completed_journey_steps_count", "recipient_setting_dynamic_role_id", "recipient_setting_dynamic_role_name" ], "title": "EngageLearningActionableJourneysGetResponsesContentApplicationJsonSchemaDataItems", "type": "object" }, "EngageLearningActionableJourneysGetResponsesContentApplicationJsonSchemaDataItemsCompletion": { "description": "Completion status of the Journey", "properties": { "percentage": { "description": "Completion percentage of the Journey", "format": "double", "maximum": 100, "minimum": 0, "type": "number" } }, "required": [ "percentage" ], "title": "EngageLearningActionableJourneysGetResponsesContentApplicationJsonSchemaDataItemsCompletion", "type": "object" }, "EngageLearningActionableJourneysGetResponsesContentApplicationJsonSchemaDataItemsJourney": { "description": "Journey details", "properties": { "cover_picture": { "description": "CoverPicture details for the Journey", "oneOf": [ { "$ref": "#/components/schemas/EngageLearningActionableJourneysGetResponsesContentApplicationJsonSchemaDataItemsJourneyCoverPicture" }, { "type": "null" } ] }, "created_at": { "description": "The timestamp when the Journey was created", "format": "date-time", "type": "string" }, "created_by_hris_organization_user_profile": { "$ref": "#/components/schemas/EngageLearningActionableJourneysGetResponsesContentApplicationJsonSchemaDataItemsJourneyCreatedByHrisOrganizationUserProfile", "description": "Profile of the user who created the journey" }, "description": { "description": "Description of the Journey", "type": [ "string", "null" ] }, "draft_for_id": { "description": "If this is draft for an existing Journey, draft_for_id is the reference to the original Journey ID.", "format": "uuid", "type": [ "string", "null" ] }, "id": { "description": "Unique identifier of the journey", "format": "uuid", "type": "string" }, "is_self_assignment_allowed": { "description": "Whether self-assignment is allowed for this Journey", "type": "boolean" }, "is_template": { "description": "Whether the Journey is a template", "type": "boolean" }, "is_time_based": { "description": "Whether the Journey is time-based", "type": "boolean" }, "is_visible_in_library": { "description": "Whether the Journey is visible in the library", "type": "boolean" }, "organization_id": { "description": "The organizationID this Journey belongs to", "type": "integer" }, "published_at": { "description": "The timestamp when the Journey was published", "format": "date-time", "type": "string" }, "recently_edited_at": { "description": "The timestamp when the Journey was recently edited", "format": "date-time", "type": "string" }, "title": { "description": "Title of the journey", "type": "string" }, "type_slug": { "description": "The type slug of the Journey e.g default, Scorm", "type": "string" }, "updated_at": { "description": "The timestamp when the Journey was last updated", "format": "date-time", "type": "string" }, "updated_by_hris_organization_user_profile": { "$ref": "#/components/schemas/EngageLearningActionableJourneysGetResponsesContentApplicationJsonSchemaDataItemsJourneyUpdatedByHrisOrganizationUserProfile", "description": "Profile of the user who last updated the journey" }, "visibility_slug": { "$ref": "#/components/schemas/EngageLearningActionableJourneysGetResponsesContentApplicationJsonSchemaDataItemsJourneyVisibilitySlug", "description": "The visibility setting of the Journey" } }, "required": [ "id", "title", "type_slug", "created_at", "updated_at", "description", "is_template", "draft_for_id", "published_at", "is_time_based", "organization_id", "visibility_slug", "recently_edited_at", "is_visible_in_library", "is_self_assignment_allowed", "created_by_hris_organization_user_profile", "updated_by_hris_organization_user_profile" ], "title": "EngageLearningActionableJourneysGetResponsesContentApplicationJsonSchemaDataItemsJourney", "type": "object" }, "EngageLearningActionableJourneysGetResponsesContentApplicationJsonSchemaDataItemsJourneyCoverPicture": { "description": "CoverPicture details for the Journey", "properties": { "attachable_id": { "description": "ID of the entity this attachment belongs to e.g. JourneyID", "format": "uuid", "type": "string" }, "attachable_type": { "description": "Type of the entity this attachment belongs to e.g Journey", "type": "string" }, "attachment_type_slug": { "description": "Type of the attachment (e.g., cover_picture)", "type": "string" }, "file_content_type": { "description": "Content type of the file", "type": "string" }, "file_name": { "description": "Name of the file", "type": "string" }, "id": { "description": "Unique identifier of the CoverPicture Attachment", "format": "uuid", "type": "string" }, "url": { "description": "URL to access the cover picture", "format": "uri", "type": "string" } }, "title": "EngageLearningActionableJourneysGetResponsesContentApplicationJsonSchemaDataItemsJourneyCoverPicture", "type": "object" }, "EngageLearningActionableJourneysGetResponsesContentApplicationJsonSchemaDataItemsJourneyCreatedByHrisOrganizationUserProfile": { "description": "Profile of the user who created the journey", "properties": { "country": { "description": "Country of the User", "type": [ "string", "null" ] }, "deactivated_at": { "description": "Deactivation timestamp, if applicable", "format": "date-time", "type": [ "string", "null" ] }, "email": { "description": "Email of the user who created the Journey", "format": "email", "type": [ "string", "null" ] }, "first_name": { "description": "First name of the User", "type": [ "string", "null" ] }, "hris_organization_user_id": { "description": "HRIS organization user ID", "format": "uuid", "type": "string" }, "job_title": { "description": "Job title of the User", "type": [ "string", "null" ] }, "last_name": { "description": "Last name of the User", "type": [ "string", "null" ] }, "organization_public_id": { "description": "Public ID of the organization", "format": "uuid", "type": "string" }, "pic_url": { "description": "URL of the profile picture", "format": "uri", "type": [ "string", "null" ] }, "preferred_name": { "description": "Preferred name of the User", "type": [ "string", "null" ] }, "type": { "$ref": "#/components/schemas/EngageLearningActionableJourneysGetResponsesContentApplicationJsonSchemaDataItemsJourneyCreatedByHrisOrganizationUserProfileType", "description": "Type of the User" }, "work_email": { "description": "Work email of the User", "format": "email", "type": [ "string", "null" ] } }, "title": "EngageLearningActionableJourneysGetResponsesContentApplicationJsonSchemaDataItemsJourneyCreatedByHrisOrganizationUserProfile", "type": "object" }, "EngageLearningActionableJourneysGetResponsesContentApplicationJsonSchemaDataItemsJourneyCreatedByHrisOrganizationUserProfileType": { "description": "Type of the User", "enum": [ "WORKER", "CLIENT" ], "title": "EngageLearningActionableJourneysGetResponsesContentApplicationJsonSchemaDataItemsJourneyCreatedByHrisOrganizationUserProfileType", "type": "string" }, "EngageLearningActionableJourneysGetResponsesContentApplicationJsonSchemaDataItemsJourneyUpdatedByHrisOrganizationUserProfile": { "description": "Profile of the user who last updated the journey", "properties": { "country": { "description": "Country of the User", "type": [ "string", "null" ] }, "deactivated_at": { "description": "Deactivation timestamp, if applicable", "format": "date-time", "type": [ "string", "null" ] }, "email": { "description": "Email of the user who last updated the journey", "format": "email", "type": [ "string", "null" ] }, "first_name": { "description": "First name of the User", "type": [ "string", "null" ] }, "hris_organization_user_id": { "description": "HRIS organization user ID", "format": "uuid", "type": "string" }, "job_title": { "description": "Job title of the User", "type": [ "string", "null" ] }, "last_name": { "description": "Last name of the User", "type": [ "string", "null" ] }, "organization_public_id": { "description": "Public ID of the organization", "format": "uuid", "type": "string" }, "pic_url": { "description": "URL of the profile picture", "format": "uri", "type": [ "string", "null" ] }, "preferred_name": { "description": "Preferred name of the User", "type": [ "string", "null" ] }, "type": { "$ref": "#/components/schemas/EngageLearningActionableJourneysGetResponsesContentApplicationJsonSchemaDataItemsJourneyUpdatedByHrisOrganizationUserProfileType", "description": "Type of the User" }, "work_email": { "description": "Work email of the User", "format": "email", "type": [ "string", "null" ] } }, "title": "EngageLearningActionableJourneysGetResponsesContentApplicationJsonSchemaDataItemsJourneyUpdatedByHrisOrganizationUserProfile", "type": "object" }, "EngageLearningActionableJourneysGetResponsesContentApplicationJsonSchemaDataItemsJourneyUpdatedByHrisOrganizationUserProfileType": { "description": "Type of the User", "enum": [ "WORKER", "CLIENT" ], "title": "EngageLearningActionableJourneysGetResponsesContentApplicationJsonSchemaDataItemsJourneyUpdatedByHrisOrganizationUserProfileType", "type": "string" }, "EngageLearningActionableJourneysGetResponsesContentApplicationJsonSchemaDataItemsJourneyVisibilitySlug": { "description": "The visibility setting of the Journey", "enum": [ "organization", "public", "private-marketplace" ], "title": "EngageLearningActionableJourneysGetResponsesContentApplicationJsonSchemaDataItemsJourneyVisibilitySlug", "type": "string" }, "EngageLearningActionableJourneysGetResponsesContentApplicationJsonSchemaDataItemsRecipientSettingType": { "description": "Type of RecipientSetting. e.g Manager, Buddy etc.", "enum": [ "hris_organization_user", "manager", "buddy", "mentor" ], "title": "EngageLearningActionableJourneysGetResponsesContentApplicationJsonSchemaDataItemsRecipientSettingType", "type": "string" }, "EngageLearningActionableJourneysGetResponsesContentApplicationJsonSchemaDataItemsRecipientable": { "description": "Recipient for the ActionableJourney Step. Used in conjunction with recipient_setting_type. Recipient can be the same user as Assignee or any other user e.g Manager or Accounts Lead based on the RecipientSetting for the Step.", "properties": { "country": { "description": "Country of the recipient", "type": [ "string", "null" ] }, "deactivated_at": { "description": "Deactivation timestamp of the recipient, if applicable", "format": "date-time", "type": [ "string", "null" ] }, "email": { "description": "Email address of the recipient", "format": "email", "type": "string" }, "first_name": { "description": "First name of the recipient", "type": "string" }, "hris_organization_user_id": { "description": "HRIS organization user ID of the recipient", "format": "uuid", "type": "string" }, "job_title": { "description": "Job title of the recipient", "type": [ "string", "null" ] }, "last_name": { "description": "Last name of the recipient", "type": "string" }, "organization_public_id": { "description": "Public ID of the organization the recipient belongs to", "format": "uuid", "type": "string" }, "pic_url": { "description": "URL of the profile picture of the recipient", "format": "uri", "type": [ "string", "null" ] }, "preferred_name": { "description": "Preferred name of the recipient", "type": "string" }, "type": { "$ref": "#/components/schemas/EngageLearningActionableJourneysGetResponsesContentApplicationJsonSchemaDataItemsRecipientableType", "description": "Type of the recipient User" }, "work_email": { "description": "Work email of the recipient", "format": "email", "type": "string" } }, "required": [ "type", "email", "country", "pic_url", "job_title", "last_name", "first_name", "work_email", "deactivated_at", "preferred_name", "organization_public_id", "hris_organization_user_id" ], "title": "EngageLearningActionableJourneysGetResponsesContentApplicationJsonSchemaDataItemsRecipientable", "type": "object" }, "EngageLearningActionableJourneysGetResponsesContentApplicationJsonSchemaDataItemsRecipientableType": { "description": "Type of the recipient User", "enum": [ "WORKER", "CLIENT" ], "title": "EngageLearningActionableJourneysGetResponsesContentApplicationJsonSchemaDataItemsRecipientableType", "type": "string" }, "EngageLearningActionableJourneysGetResponsesContentApplicationJsonSchemaDataItemsScopeable": { "description": "Scopeable entity details e.g Assignment details", "properties": { "assignee_hris_organization_user": { "$ref": "#/components/schemas/EngageLearningActionableJourneysGetResponsesContentApplicationJsonSchemaDataItemsScopeableAssigneeHrisOrganizationUser", "description": "Details of the assigned user" }, "id": { "description": "Unique identifier of the scopeable entity e.g AssignmentID", "format": "uuid", "type": "string" }, "is_self_assigned": { "description": "Whether the assignment was self-assigned", "type": "boolean" } }, "required": [ "id", "is_self_assigned", "assignee_hris_organization_user" ], "title": "EngageLearningActionableJourneysGetResponsesContentApplicationJsonSchemaDataItemsScopeable", "type": "object" }, "EngageLearningActionableJourneysGetResponsesContentApplicationJsonSchemaDataItemsScopeableAssigneeHrisOrganizationUser": { "description": "Details of the assigned user", "properties": { "country": { "description": "Country of the assignee", "type": [ "string", "null" ] }, "deactivated_at": { "description": "Deactivation timestamp of the assignee, if applicable", "format": "date-time", "type": [ "string", "null" ] }, "email": { "description": "Email address of the assignee", "format": "email", "type": "string" }, "first_name": { "description": "First name of the assignee", "type": "string" }, "hris_organization_user_id": { "description": "HRIS organization user ID of the assignee", "format": "uuid", "type": "string" }, "job_title": { "description": "Job title of the assignee", "type": [ "string", "null" ] }, "last_name": { "description": "Last name of the assignee", "type": "string" }, "organization_public_id": { "description": "Public ID of the organization the assignee belongs to", "format": "uuid", "type": "string" }, "pic_url": { "description": "URL of the profile picture of the assignee", "format": "uri", "type": [ "string", "null" ] }, "preferred_name": { "description": "Preferred name of the assignee", "type": "string" }, "type": { "$ref": "#/components/schemas/EngageLearningActionableJourneysGetResponsesContentApplicationJsonSchemaDataItemsScopeableAssigneeHrisOrganizationUserType", "description": "Type of the assignee user" }, "work_email": { "description": "Work email of the assignee", "format": "email", "type": "string" } }, "title": "EngageLearningActionableJourneysGetResponsesContentApplicationJsonSchemaDataItemsScopeableAssigneeHrisOrganizationUser", "type": "object" }, "EngageLearningActionableJourneysGetResponsesContentApplicationJsonSchemaDataItemsScopeableAssigneeHrisOrganizationUserType": { "description": "Type of the assignee user", "enum": [ "WORKER", "CLIENT" ], "title": "EngageLearningActionableJourneysGetResponsesContentApplicationJsonSchemaDataItemsScopeableAssigneeHrisOrganizationUserType", "type": "string" }, "EngageLearningActionableJourneysGetResponsesContentApplicationJsonSchemaDataItemsStep": { "description": "Step details", "properties": { "id": { "description": "Unique identifier of the Step", "format": "uuid", "type": "string" }, "journey": { "$ref": "#/components/schemas/EngageLearningActionableJourneysGetResponsesContentApplicationJsonSchemaDataItemsStepJourney", "description": "Basic Journey information for the step" }, "journey_id": { "description": "ID of the Journey this step belongs to", "format": "uuid", "type": "string" } }, "required": [ "id", "journey", "journey_id" ], "title": "EngageLearningActionableJourneysGetResponsesContentApplicationJsonSchemaDataItemsStep", "type": "object" }, "EngageLearningActionableJourneysGetResponsesContentApplicationJsonSchemaDataItemsStepJourney": { "description": "Basic Journey information for the step", "properties": { "id": { "description": "Unique identifier of the Journey", "format": "uuid", "type": "string" }, "title": { "description": "Title of the journey", "type": "string" } }, "title": "EngageLearningActionableJourneysGetResponsesContentApplicationJsonSchemaDataItemsStepJourney", "type": "object" }, "EngageLearningActionableJourneysGetResponsesContentApplicationJsonSchemaErrorsItems": { "properties": { "message": { "description": "A description of the returned error", "type": "string" }, "path": { "description": "The JSON path where input validation failed", "type": "string" } }, "title": "EngageLearningActionableJourneysGetResponsesContentApplicationJsonSchemaErrorsItems", "type": "object" }, "EngageLearningActionableJourneysGetResponsesContentApplicationJsonSchemaRequest": { "properties": { "api_req_id": { "description": "The request ID of the failed request", "type": "string" }, "code": { "description": "The code of the source handler which produced the returned error", "format": "double", "type": "number" }, "docs": { "description": "A link to the official documentation for the requested endpoint resource", "type": "string" }, "method": { "description": "The HTTP method of the failed request", "type": "string" }, "source": { "description": "The source handler which produced the returned error", "type": "string" }, "status": { "description": "The status code of the response", "format": "double", "type": "number" }, "url": { "description": "The relative URL of the failed request", "type": "string" } }, "title": "EngageLearningActionableJourneysGetResponsesContentApplicationJsonSchemaRequest", "type": "object" }, "EnrolAssetIntoAddon-v2026-10-09RequestBadRequestError": { "properties": { "errors": { "items": { "$ref": "#/components/schemas/ItAssetsAssetIdAddonsAddonIdAssignPostResponsesContentApplicationJsonSchemaErrorsItems" }, "type": "array" } }, "required": [ "errors" ], "title": "EnrolAssetIntoAddon-v2026-10-09RequestBadRequestError", "type": "object" }, "EnrolAssetIntoAddon-v2026-10-09RequestConflictError": { "properties": { "errors": { "items": { "$ref": "#/components/schemas/ItAssetsAssetIdAddonsAddonIdAssignPostResponsesContentApplicationJsonSchemaErrorsItems" }, "type": "array" } }, "required": [ "errors" ], "title": "EnrolAssetIntoAddon-v2026-10-09RequestConflictError", "type": "object" }, "EnrolAssetIntoAddon-v2026-10-09RequestForbiddenError": { "properties": { "errors": { "items": { "$ref": "#/components/schemas/ItAssetsAssetIdAddonsAddonIdAssignPostResponsesContentApplicationJsonSchemaErrorsItems" }, "type": "array" } }, "required": [ "errors" ], "title": "EnrolAssetIntoAddon-v2026-10-09RequestForbiddenError", "type": "object" }, "EnrolAssetIntoAddon-v2026-10-09RequestInternalServerError": { "properties": { "errors": { "items": { "$ref": "#/components/schemas/ItAssetsAssetIdAddonsAddonIdAssignPostResponsesContentApplicationJsonSchemaErrorsItems" }, "type": "array" } }, "required": [ "errors" ], "title": "EnrolAssetIntoAddon-v2026-10-09RequestInternalServerError", "type": "object" }, "EnrolAssetIntoAddon-v2026-10-09RequestNotFoundError": { "properties": { "errors": { "items": { "$ref": "#/components/schemas/ItAssetsAssetIdAddonsAddonIdAssignPostResponsesContentApplicationJsonSchemaErrorsItems" }, "type": "array" } }, "required": [ "errors" ], "title": "EnrolAssetIntoAddon-v2026-10-09RequestNotFoundError", "type": "object" }, "EnrolAssetIntoAddon-v2026-10-09RequestUnauthorizedError": { "properties": { "errors": { "items": { "$ref": "#/components/schemas/ItAssetsAssetIdAddonsAddonIdAssignPostResponsesContentApplicationJsonSchemaErrorsItems" }, "type": "array" } }, "required": [ "errors" ], "title": "EnrolAssetIntoAddon-v2026-10-09RequestUnauthorizedError", "type": "object" }, "EorAdditionalCostsCountryGetResponsesContentApplicationJsonSchemaData": { "properties": { "allowances": { "items": { "$ref": "#/components/schemas/EorAdditionalCostsCountryGetResponsesContentApplicationJsonSchemaDataAllowancesItems" }, "type": "array" }, "non_statutory": { "items": { "$ref": "#/components/schemas/EorAdditionalCostsCountryGetResponsesContentApplicationJsonSchemaDataNonStatutoryItems" }, "type": "array" } }, "title": "EorAdditionalCostsCountryGetResponsesContentApplicationJsonSchemaData", "type": "object" }, "EorAdditionalCostsCountryGetResponsesContentApplicationJsonSchemaDataAllowancesItems": { "properties": { "description": { "description": "Allowance description.", "type": "string" }, "is_recurring": { "description": "Indicates if the allowance is recurring.", "type": "boolean" }, "name": { "description": "Allowance name.", "type": "string" }, "optional": { "description": "Indicates if the allowance is optional.", "type": "boolean" }, "rule_cost_id": { "description": "Unique identifier for the allowance.", "type": "string" }, "skipping_confirmation_text": { "description": "Confirmation text for opting out of the allowance.", "type": [ "string", "null" ] }, "use_contract_currency": { "description": "Indicates if the allowance uses the contract currency.", "type": "boolean" }, "value": { "description": "Allowance value.", "format": "double", "type": "number" } }, "title": "EorAdditionalCostsCountryGetResponsesContentApplicationJsonSchemaDataAllowancesItems", "type": "object" }, "EorAdditionalCostsCountryGetResponsesContentApplicationJsonSchemaDataNonStatutoryItems": { "properties": { "currency": { "description": "Currency", "type": "string" }, "description": { "description": "Allowance description.", "type": "string" }, "is_recurring": { "description": "Indicates if the allowance is recurring.", "type": "boolean" }, "name": { "description": "Allowance name.", "type": "string" }, "rule_cost_id": { "description": "Unique identifier for the allowance.", "type": "string" }, "use_contract_currency": { "description": "Indicates if the allowance uses the contract currency.", "type": "boolean" }, "value": { "description": "Allowance value.", "format": "double", "type": "number" } }, "title": "EorAdditionalCostsCountryGetResponsesContentApplicationJsonSchemaDataNonStatutoryItems", "type": "object" }, "EorAdditionalCostsCountryGetResponsesContentApplicationJsonSchemaErrorsItems": { "properties": { "message": { "description": "A description of the returned error", "type": "string" }, "path": { "description": "The JSON path where input validation failed", "type": "string" } }, "title": "EorAdditionalCostsCountryGetResponsesContentApplicationJsonSchemaErrorsItems", "type": "object" }, "EorAdditionalCostsCountryGetResponsesContentApplicationJsonSchemaRequest": { "properties": { "api_req_id": { "description": "The request ID of the failed request", "type": "string" }, "code": { "description": "The code of the source handler which produced the returned error", "format": "double", "type": "number" }, "docs": { "description": "A link to the official documentation for the requested endpoint resource", "type": "string" }, "method": { "description": "The HTTP method of the failed request", "type": "string" }, "source": { "description": "The source handler which produced the returned error", "type": "string" }, "status": { "description": "The status code of the response", "format": "double", "type": "number" }, "url": { "description": "The relative URL of the failed request", "type": "string" } }, "title": "EorAdditionalCostsCountryGetResponsesContentApplicationJsonSchemaRequest", "type": "object" }, "EorBenefitsGetParametersEmploymentType": { "enum": [ "Full-time", "Part-time" ], "title": "EorBenefitsGetParametersEmploymentType", "type": "string" }, "EorBenefitsGetResponsesContentApplicationJsonSchemaDataItems": { "properties": { "description": { "description": "The description of the benefit.", "type": "string" }, "is_discriminatory": { "description": "Indicates if the benefit is discriminatory.", "type": "boolean" }, "is_mandatory": { "description": "Indicates if the benefit is mandatory.", "type": "boolean" }, "name": { "description": "The name of the benefit.", "type": "string" }, "providers": { "items": { "$ref": "#/components/schemas/EorBenefitsGetResponsesContentApplicationJsonSchemaDataItemsProvidersItems" }, "type": "array" } }, "required": [ "name", "providers", "description", "is_mandatory", "is_discriminatory" ], "title": "EorBenefitsGetResponsesContentApplicationJsonSchemaDataItems", "type": "object" }, "EorBenefitsGetResponsesContentApplicationJsonSchemaDataItemsProvidersItems": { "properties": { "attachments": { "items": { "$ref": "#/components/schemas/EorBenefitsGetResponsesContentApplicationJsonSchemaDataItemsProvidersItemsAttachmentsItems" }, "type": "array" }, "client_info": { "description": "Client information.", "type": [ "string", "null" ] }, "contribution_options": { "items": { "$ref": "#/components/schemas/EorBenefitsGetResponsesContentApplicationJsonSchemaDataItemsProvidersItemsContributionOptionsItems" }, "type": "array" }, "country": { "description": "Country code.", "type": "string" }, "currency": { "description": "Currency.", "type": "string" }, "employee_info": { "description": "Employee information.", "type": [ "string", "null" ] }, "home_page_url": { "description": "The home page URL of the benefit provider.", "type": "string" }, "id": { "description": "ID of the benefit provider.", "format": "uuid", "type": "string" }, "is_unisure": { "description": "Indicates if Unisure.", "type": "boolean" }, "max_contribution": { "description": "Maximum contribution.", "format": "double", "type": [ "number", "null" ] }, "min_contribution": { "description": "Minimum contribution.", "format": "double", "type": [ "number", "null" ] }, "name": { "description": "The name of the benefit provider.", "type": "string" }, "plans": { "items": { "$ref": "#/components/schemas/EorBenefitsGetResponsesContentApplicationJsonSchemaDataItemsProvidersItemsPlansItems" }, "type": "array" }, "type": { "description": "Benefit type.", "type": "string" } }, "required": [ "id", "name", "type", "plans", "country", "currency", "is_unisure", "attachments", "home_page_url", "contribution_options" ], "title": "EorBenefitsGetResponsesContentApplicationJsonSchemaDataItemsProvidersItems", "type": "object" }, "EorBenefitsGetResponsesContentApplicationJsonSchemaDataItemsProvidersItemsAttachmentsItems": { "properties": { "id": { "description": "The unique ID of the attachment.", "type": "string" }, "label": { "description": "The label of the attachment.", "type": "string" }, "url": { "description": "The url of the attachment.", "type": "string" } }, "required": [ "id", "url", "label" ], "title": "EorBenefitsGetResponsesContentApplicationJsonSchemaDataItemsProvidersItemsAttachmentsItems", "type": "object" }, "EorBenefitsGetResponsesContentApplicationJsonSchemaDataItemsProvidersItemsContributionOptionsItems": { "properties": { "amount": { "description": "Amount.", "format": "double", "type": "number" }, "id": { "description": "Unique ID of the contribution.", "type": "string" } }, "required": [ "id", "amount" ], "title": "EorBenefitsGetResponsesContentApplicationJsonSchemaDataItemsProvidersItemsContributionOptionsItems", "type": "object" }, "EorBenefitsGetResponsesContentApplicationJsonSchemaDataItemsProvidersItemsPlansItems": { "properties": { "attachments": { "items": { "$ref": "#/components/schemas/EorBenefitsGetResponsesContentApplicationJsonSchemaDataItemsProvidersItemsPlansItemsAttachmentsItems" }, "type": "array" }, "id": { "description": "The unique ID of the plan.", "type": "string" }, "name": { "description": "The name of the plan.", "type": "string" }, "price": { "description": "The price of the plan.", "format": "double", "type": "number" } }, "required": [ "id", "name", "price", "attachments" ], "title": "EorBenefitsGetResponsesContentApplicationJsonSchemaDataItemsProvidersItemsPlansItems", "type": "object" }, "EorBenefitsGetResponsesContentApplicationJsonSchemaDataItemsProvidersItemsPlansItemsAttachmentsItems": { "properties": { "id": { "description": "The unique ID of the attachment.", "type": "string" }, "label": { "description": "The label of the attachment.", "type": "string" }, "url": { "description": "The url of the attachment.", "type": "string" } }, "required": [ "id", "url", "label" ], "title": "EorBenefitsGetResponsesContentApplicationJsonSchemaDataItemsProvidersItemsPlansItemsAttachmentsItems", "type": "object" }, "EorBenefitsGetResponsesContentApplicationJsonSchemaErrorsItems": { "properties": { "message": { "description": "A description of the returned error", "type": "string" }, "path": { "description": "The JSON path where input validation failed", "type": "string" } }, "title": "EorBenefitsGetResponsesContentApplicationJsonSchemaErrorsItems", "type": "object" }, "EorBenefitsGetResponsesContentApplicationJsonSchemaRequest": { "properties": { "api_req_id": { "description": "The request ID of the failed request", "type": "string" }, "code": { "description": "The code of the source handler which produced the returned error", "format": "double", "type": "number" }, "docs": { "description": "A link to the official documentation for the requested endpoint resource", "type": "string" }, "method": { "description": "The HTTP method of the failed request", "type": "string" }, "source": { "description": "The source handler which produced the returned error", "type": "string" }, "status": { "description": "The status code of the response", "format": "double", "type": "number" }, "url": { "description": "The relative URL of the failed request", "type": "string" } }, "title": "EorBenefitsGetResponsesContentApplicationJsonSchemaRequest", "type": "object" }, "EorContractContractIdPatchRequestBodyContentApplicationJsonSchemaData": { "properties": { "allow_consultant_equipment_reimbursement": { "description": "Allow equipment reimbursement for consultants", "type": "boolean" }, "benefits": { "description": "Array of employee benefits", "items": { "$ref": "#/components/schemas/EorContractContractIdPatchRequestBodyContentApplicationJsonSchemaDataBenefitsItems" }, "type": [ "array", "null" ] }, "contract_term_type": { "$ref": "#/components/schemas/EorContractContractIdPatchRequestBodyContentApplicationJsonSchemaDataContractTermType", "description": "Type of contract term" }, "currency": { "description": "Currency code for salary and benefits", "type": "string" }, "employee_address": { "$ref": "#/components/schemas/EorContractContractIdPatchRequestBodyContentApplicationJsonSchemaDataEmployeeAddress", "description": "Employee's address information" }, "employee_email": { "description": "Employee's email address", "format": "email", "type": "string" }, "employee_first_name": { "description": "Employee's first name", "type": "string" }, "employee_id": { "description": "Employee's unique identifier", "type": "string" }, "employee_last_name": { "description": "Employee's last name", "type": "string" }, "employee_nationality": { "description": "Employee's nationality", "type": "string" }, "employment_country": { "description": "Country of employment", "type": "string" }, "employment_state": { "description": "State/Province of employment", "type": [ "string", "null" ] }, "employment_type": { "$ref": "#/components/schemas/EorContractContractIdPatchRequestBodyContentApplicationJsonSchemaDataEmploymentType", "description": "Type of employment" }, "end_date": { "description": "Employment end date", "format": "date", "type": [ "string", "null" ] }, "hiring_objective": { "$ref": "#/components/schemas/EorContractContractIdPatchRequestBodyContentApplicationJsonSchemaDataHiringObjective", "description": "Objective for hiring" }, "hiring_objective_extra_info": { "description": "Additional information about hiring objective", "type": [ "string", "null" ] }, "holidays": { "description": "Number of holiday days per year", "format": "double", "minimum": 0, "type": [ "number", "null" ] }, "hourly_rate": { "description": "Hourly rate. Required when is_hourly is true. Must not be sent when is_hourly is false or omitted.", "title": "float", "type": [ "string", "null" ] }, "is_auto_quote_validation_passed": { "description": "Auto quote validation status", "type": [ "boolean", "null" ] }, "is_hourly": { "description": "Indicates if compensation is hourly", "type": [ "boolean", "null" ] }, "is_resubmit": { "description": "Indicates if this is a resubmission", "type": [ "boolean", "null" ] }, "job_title": { "description": "Job title (cannot be C-level position)", "type": "string" }, "medical_insurance": { "description": "Medical insurance coverage", "type": "boolean" }, "notice_period_after_probation": { "description": "Notice period after probation (days)", "format": "double", "minimum": 0, "type": "number" }, "notice_period_during_probation": { "description": "Notice period during probation (days)", "format": "double", "minimum": 0, "type": "number" }, "notice_period_type": { "$ref": "#/components/schemas/EorContractContractIdPatchRequestBodyContentApplicationJsonSchemaDataNoticePeriodType", "description": "Type of notice period" }, "probation_period": { "description": "Probation period duration", "format": "double", "minimum": 0, "type": [ "number", "null" ] }, "probation_period_type_for_definite": { "$ref": "#/components/schemas/EorContractContractIdPatchRequestBodyContentApplicationJsonSchemaDataProbationPeriodTypeForDefinite", "description": "Unit of time for probation period" }, "quote_additional_fields": { "$ref": "#/components/schemas/EorContractContractIdPatchRequestBodyContentApplicationJsonSchemaDataQuoteAdditionalFields", "description": "Additional quote-specific information" }, "reason_for_fixed_term": { "description": "Reason for fixed-term contract", "oneOf": [ { "$ref": "#/components/schemas/EorContractContractIdPatchRequestBodyContentApplicationJsonSchemaDataReasonForFixedTerm" }, { "type": "null" } ] }, "salary": { "description": "Annual salary amount. Optional; must not be sent when is_hourly is true.", "title": "float", "type": "string" }, "schedule_id": { "description": "Unique identifier for the employee's work schedule", "type": [ "string", "null" ] }, "scope": { "$ref": "#/components/schemas/EorContractContractIdPatchRequestBodyContentApplicationJsonSchemaDataScope", "description": "Scope of work description, either as a plain string or as a reference to a scope template." }, "seniority_date": { "description": "Employee seniority date", "format": "date", "type": "string" }, "seniority_id": { "description": "Seniority level identifier", "format": "double", "type": "number" }, "sick_leave_days": { "description": "Number of sick leave days per year", "format": "double", "maximum": 90, "minimum": 0, "type": [ "number", "null" ] }, "signing_bonus": { "description": "Signing bonus amount", "title": "float", "type": [ "string", "null" ] }, "signing_bonus_payout_type": { "default": "FIRST_CYCLE", "description": "Determines when the signing bonus will be paid out", "oneOf": [ { "$ref": "#/components/schemas/EorContractContractIdPatchRequestBodyContentApplicationJsonSchemaDataSigningBonusPayoutType" }, { "type": "null" } ] }, "start_date": { "description": "Employment start date", "format": "date", "type": "string" }, "time_off_type": { "$ref": "#/components/schemas/EorContractContractIdPatchRequestBodyContentApplicationJsonSchemaDataTimeOffType", "description": "Type of time off" }, "work_arrangement": { "description": "Work arrangement type", "oneOf": [ { "$ref": "#/components/schemas/EorContractContractIdPatchRequestBodyContentApplicationJsonSchemaDataWorkArrangement" }, { "type": "null" } ] }, "work_eligibility": { "$ref": "#/components/schemas/EorContractContractIdPatchRequestBodyContentApplicationJsonSchemaDataWorkEligibility", "description": "Work eligibility documentation" }, "work_hours_per_week": { "description": "Working hours per week", "format": "double", "maximum": 168, "minimum": 0, "type": "number" }, "work_pension": { "description": "Indicates if work pension is included", "type": [ "boolean", "null" ] }, "work_visa": { "description": "Indicates if work visa is required", "type": [ "boolean", "null" ] } }, "required": [ "job_title", "start_date", "employee_email", "employment_type", "employee_last_name", "employment_country", "employee_first_name" ], "title": "EorContractContractIdPatchRequestBodyContentApplicationJsonSchemaData", "type": "object" }, "EorContractContractIdPatchRequestBodyContentApplicationJsonSchemaDataBenefitsItems": { "description": "Benefit plan details", "properties": { "contribution": { "description": "Contribution amount", "format": "double", "maximum": 9999999999999, "minimum": 0, "type": [ "number", "null" ] }, "cover_all": { "description": "Indicates if benefit covers all", "type": "boolean" }, "cover_dependents": { "description": "Indicates if benefit covers dependents", "type": "boolean" }, "plan_id": { "description": "Benefit plan ID", "type": [ "string", "null" ] }, "provider_id": { "description": "Benefit provider ID", "type": [ "string", "null" ] } }, "title": "EorContractContractIdPatchRequestBodyContentApplicationJsonSchemaDataBenefitsItems", "type": "object" }, "EorContractContractIdPatchRequestBodyContentApplicationJsonSchemaDataContractTermType": { "description": "Type of contract term", "enum": [ "DEFINITE", "INDEFINITE" ], "title": "EorContractContractIdPatchRequestBodyContentApplicationJsonSchemaDataContractTermType", "type": "string" }, "EorContractContractIdPatchRequestBodyContentApplicationJsonSchemaDataEmployeeAddress": { "description": "Employee's address information", "properties": { "calling_code": { "description": "Country calling code", "type": "string" }, "city": { "description": "City of residence", "type": "string" }, "country": { "description": "Country of residence (can be country code or name)", "type": "string" }, "phone": { "description": "Phone number", "type": "string" }, "province": { "description": "Province of residence", "type": "string" }, "state": { "description": "State of residence", "type": "string" }, "street": { "description": "Street address", "type": "string" }, "zip": { "description": "ZIP/Postal code", "type": "string" } }, "required": [ "city", "street", "country" ], "title": "EorContractContractIdPatchRequestBodyContentApplicationJsonSchemaDataEmployeeAddress", "type": "object" }, "EorContractContractIdPatchRequestBodyContentApplicationJsonSchemaDataEmploymentType": { "description": "Type of employment", "enum": [ "Full-time", "Part-time" ], "title": "EorContractContractIdPatchRequestBodyContentApplicationJsonSchemaDataEmploymentType", "type": "string" }, "EorContractContractIdPatchRequestBodyContentApplicationJsonSchemaDataHiringObjective": { "description": "Objective for hiring", "enum": [ "EXPANDING_TO_NEW_COUNTRY", "TEMP_EOR_OPENING_ENTITY", "ONE_OFF_HIRE", "CONVERTING_CONTRACTOR", "OTHER" ], "title": "EorContractContractIdPatchRequestBodyContentApplicationJsonSchemaDataHiringObjective", "type": "string" }, "EorContractContractIdPatchRequestBodyContentApplicationJsonSchemaDataNoticePeriodType": { "description": "Type of notice period", "enum": [ "STANDARD", "CUSTOM" ], "title": "EorContractContractIdPatchRequestBodyContentApplicationJsonSchemaDataNoticePeriodType", "type": "string" }, "EorContractContractIdPatchRequestBodyContentApplicationJsonSchemaDataProbationPeriodTypeForDefinite": { "description": "Unit of time for probation period", "enum": [ "CUSTOM", "STANDARD" ], "title": "EorContractContractIdPatchRequestBodyContentApplicationJsonSchemaDataProbationPeriodTypeForDefinite", "type": "string" }, "EorContractContractIdPatchRequestBodyContentApplicationJsonSchemaDataQuoteAdditionalFields": { "description": "Additional quote-specific information", "properties": { "employee_type": { "$ref": "#/components/schemas/EorContractContractIdPatchRequestBodyContentApplicationJsonSchemaDataQuoteAdditionalFieldsEmployeeType", "description": "Type of employee" }, "qualifications": { "description": "Required qualifications", "type": "string" }, "qualifications_german_translation": { "description": "German translation of qualifications", "type": "string" }, "scope_german_translation": { "description": "German translation of scope", "type": "string" } }, "title": "EorContractContractIdPatchRequestBodyContentApplicationJsonSchemaDataQuoteAdditionalFields", "type": "object" }, "EorContractContractIdPatchRequestBodyContentApplicationJsonSchemaDataQuoteAdditionalFieldsEmployeeType": { "description": "Type of employee", "enum": [ "Employee", "Manager" ], "title": "EorContractContractIdPatchRequestBodyContentApplicationJsonSchemaDataQuoteAdditionalFieldsEmployeeType", "type": "string" }, "EorContractContractIdPatchRequestBodyContentApplicationJsonSchemaDataReasonForFixedTerm": { "description": "Reason for fixed-term contract", "enum": [ "SEASONAL_OR_TEMPORARY_WORK", "PROJECT_BASED_EMPLOYMENT", "REPLACEMENT_FOR_PERMANENT_STAFF", "TRIAL_PERIODS_FOR_NEW_ROLES_OR_BUSINESSES" ], "title": "EorContractContractIdPatchRequestBodyContentApplicationJsonSchemaDataReasonForFixedTerm", "type": "string" }, "EorContractContractIdPatchRequestBodyContentApplicationJsonSchemaDataScope": { "description": "Scope of work description, either as a plain string or as a reference to a scope template.", "oneOf": [ { "maxLength": 10000, "minLength": 100, "type": "string" }, { "$ref": "#/components/schemas/EorContractContractIdPatchRequestBodyContentApplicationJsonSchemaDataScope1" } ], "title": "EorContractContractIdPatchRequestBodyContentApplicationJsonSchemaDataScope" }, "EorContractContractIdPatchRequestBodyContentApplicationJsonSchemaDataScope1": { "description": "Reference to a scope template or validation.", "properties": { "scope_template_id": { "description": "Scope template UUID.", "format": "uuid", "type": "string" }, "scope_validation_id": { "description": "Scope validation UUID.", "format": "uuid", "type": "string" } }, "title": "EorContractContractIdPatchRequestBodyContentApplicationJsonSchemaDataScope1", "type": "object" }, "EorContractContractIdPatchRequestBodyContentApplicationJsonSchemaDataSigningBonusPayoutType": { "default": "FIRST_CYCLE", "description": "Determines when the signing bonus will be paid out", "enum": [ "FIRST_CYCLE", "AFTER_PROBATION", "AFTER_FIRST_CONTRACT_ANNIVERSARY" ], "title": "EorContractContractIdPatchRequestBodyContentApplicationJsonSchemaDataSigningBonusPayoutType", "type": "string" }, "EorContractContractIdPatchRequestBodyContentApplicationJsonSchemaDataTimeOffType": { "description": "Type of time off", "enum": [ "STANDARD", "SPECIFIC", "PRORATED" ], "title": "EorContractContractIdPatchRequestBodyContentApplicationJsonSchemaDataTimeOffType", "type": "string" }, "EorContractContractIdPatchRequestBodyContentApplicationJsonSchemaDataWorkArrangement": { "description": "Work arrangement type", "enum": [ "REMOTE", "ON_SITE_OR_HYBRID" ], "title": "EorContractContractIdPatchRequestBodyContentApplicationJsonSchemaDataWorkArrangement", "type": "string" }, "EorContractContractIdPatchRequestBodyContentApplicationJsonSchemaDataWorkEligibility": { "description": "Work eligibility documentation", "properties": { "file_name": { "description": "Name of the work eligibility document file", "type": "string" }, "key": { "description": "Unique identifier for the work eligibility document", "type": "string" } }, "required": [ "key", "file_name" ], "title": "EorContractContractIdPatchRequestBodyContentApplicationJsonSchemaDataWorkEligibility", "type": "object" }, "EorContractContractIdPatchResponsesContentApplicationJsonSchemaErrorsItems": { "properties": { "code": { "description": "Error code identifier", "type": "string" }, "field": { "description": "The field that caused the error, if applicable", "type": [ "string", "null" ] }, "message": { "description": "Error message details", "type": "string" } }, "title": "EorContractContractIdPatchResponsesContentApplicationJsonSchemaErrorsItems", "type": "object" }, "EorContractContractIdPatchResponsesContentApplicationJsonSchemaStatus": { "description": "Current status of the contract", "enum": [ "new", "under_review", "waiting_for_client_sign", "waiting_for_eor_sign", "waiting_for_employee_sign", "awaiting_deposit_payment", "rejected" ], "title": "EorContractContractIdPatchResponsesContentApplicationJsonSchemaStatus", "type": "string" }, "EorContractIdBenefitsGetResponsesContentApplicationJsonSchemaDataItems": { "properties": { "enrollment_details": { "$ref": "#/components/schemas/EorContractIdBenefitsGetResponsesContentApplicationJsonSchemaDataItemsEnrollmentDetails" }, "id": { "description": "The unique ID of the benefit.", "type": "string" }, "name": { "description": "The name of the benefit.", "type": "string" }, "offer_status": { "$ref": "#/components/schemas/EorContractIdBenefitsGetResponsesContentApplicationJsonSchemaDataItemsOfferStatus", "description": "Indicates whether the benefit is offered." }, "plan": { "$ref": "#/components/schemas/EorContractIdBenefitsGetResponsesContentApplicationJsonSchemaDataItemsPlan" }, "provider": { "$ref": "#/components/schemas/EorContractIdBenefitsGetResponsesContentApplicationJsonSchemaDataItemsProvider" } }, "title": "EorContractIdBenefitsGetResponsesContentApplicationJsonSchemaDataItems", "type": "object" }, "EorContractIdBenefitsGetResponsesContentApplicationJsonSchemaDataItemsEnrollmentDetails": { "properties": { "current_cycle": { "$ref": "#/components/schemas/EorContractIdBenefitsGetResponsesContentApplicationJsonSchemaDataItemsEnrollmentDetailsCurrentCycle" }, "plan": { "$ref": "#/components/schemas/EorContractIdBenefitsGetResponsesContentApplicationJsonSchemaDataItemsEnrollmentDetailsPlan" }, "standard": { "$ref": "#/components/schemas/EorContractIdBenefitsGetResponsesContentApplicationJsonSchemaDataItemsEnrollmentDetailsStandard" }, "status": { "description": "The current enrollment status of the benefit (e.g. ENROLLED, AWAITING_ENROLLMENT, AWAITING_CONTRACT_ACTIVATION, AWAITING_CARRIER_CONFIRMATION).", "type": "string" } }, "title": "EorContractIdBenefitsGetResponsesContentApplicationJsonSchemaDataItemsEnrollmentDetails", "type": "object" }, "EorContractIdBenefitsGetResponsesContentApplicationJsonSchemaDataItemsEnrollmentDetailsCurrentCycle": { "properties": { "employee_monthly_contribution": { "description": "The monthly contribution paid by the employer (client) for the current enrollment. Note: despite the field name, this value is the employer contribution, not the employee's.", "type": "string" }, "monthly_cost": { "description": "The total monthly cost of the current enrollment.", "type": "string" } }, "title": "EorContractIdBenefitsGetResponsesContentApplicationJsonSchemaDataItemsEnrollmentDetailsCurrentCycle", "type": "object" }, "EorContractIdBenefitsGetResponsesContentApplicationJsonSchemaDataItemsEnrollmentDetailsPlan": { "properties": { "name": { "description": "The name of the enrolled plan.", "type": "string" } }, "title": "EorContractIdBenefitsGetResponsesContentApplicationJsonSchemaDataItemsEnrollmentDetailsPlan", "type": "object" }, "EorContractIdBenefitsGetResponsesContentApplicationJsonSchemaDataItemsEnrollmentDetailsStandard": { "properties": { "employee_monthly_contribution": { "description": "The standard monthly contribution paid by the employer (client) toward the benefit. Note: despite the field name, this value is the employer contribution, not the employee's.", "type": [ "string", "null" ] }, "monthly_cost": { "description": "The standard total monthly cost of the benefit.", "type": [ "string", "null" ] } }, "title": "EorContractIdBenefitsGetResponsesContentApplicationJsonSchemaDataItemsEnrollmentDetailsStandard", "type": "object" }, "EorContractIdBenefitsGetResponsesContentApplicationJsonSchemaDataItemsOfferStatus": { "description": "Indicates whether the benefit is offered.", "enum": [ "Offered", "Not offered" ], "title": "EorContractIdBenefitsGetResponsesContentApplicationJsonSchemaDataItemsOfferStatus", "type": "string" }, "EorContractIdBenefitsGetResponsesContentApplicationJsonSchemaDataItemsPlan": { "properties": { "name": { "description": "The name of the associated plan.", "type": "string" } }, "title": "EorContractIdBenefitsGetResponsesContentApplicationJsonSchemaDataItemsPlan", "type": "object" }, "EorContractIdBenefitsGetResponsesContentApplicationJsonSchemaDataItemsProvider": { "properties": { "name": { "description": "The name of the benefit provider.", "type": "string" } }, "title": "EorContractIdBenefitsGetResponsesContentApplicationJsonSchemaDataItemsProvider", "type": "object" }, "EorContractIdBenefitsGetResponsesContentApplicationJsonSchemaWorkerBenefitsLink": { "description": "Short-lived link where the worker completes their benefits enrolment and manages their benefits. Only returned for organisations set up as white-label with Deel, whose workers don't use the Deel app. Redirect the worker to it from your app; call this endpoint again for a new link after expires_at. Don't store, email or share it.", "properties": { "expires_at": { "description": "The date and time (UTC) after which the link no longer works.", "format": "date-time", "type": "string" }, "url": { "description": "The short-lived URL to redirect the worker to.", "format": "uri", "type": "string" } }, "title": "EorContractIdBenefitsGetResponsesContentApplicationJsonSchemaWorkerBenefitsLink", "type": "object" }, "EorContractOidCancelPostRequestBodyContentApplicationJsonSchemaData": { "properties": { "cancellation_message": { "description": "Message for contract termination", "type": "string" }, "cancellation_reason": { "$ref": "#/components/schemas/EorContractOidCancelPostRequestBodyContentApplicationJsonSchemaDataCancellationReason", "description": "Reason for contract termination" } }, "required": [ "cancellation_reason" ], "title": "EorContractOidCancelPostRequestBodyContentApplicationJsonSchemaData", "type": "object" }, "EorContractOidCancelPostRequestBodyContentApplicationJsonSchemaDataCancellationReason": { "description": "Reason for contract termination", "enum": [ "INTERNAL_DECISION", "UNSATISFACTORY_EXPERIENCE", "EXPLORING_ALTERNATIVE", "OFFER_CHANGES" ], "title": "EorContractOidCancelPostRequestBodyContentApplicationJsonSchemaDataCancellationReason", "type": "string" }, "EorContractOidDelayOnboardingPatchRequestBodyContentApplicationJsonSchemaData": { "properties": { "is_employee_onboarding_delayed": { "description": "Indicates if the employee onboarding is delayed", "type": "boolean" } }, "required": [ "is_employee_onboarding_delayed" ], "title": "EorContractOidDelayOnboardingPatchRequestBodyContentApplicationJsonSchemaData", "type": "object" }, "EorContractsAmendmentsDataPointsConfigurationGetResponsesContentApplicationJsonSchemaData": { "properties": { "settings": { "description": "List of countries with their amendment data points configuration", "items": { "$ref": "#/components/schemas/EorContractsAmendmentsDataPointsConfigurationGetResponsesContentApplicationJsonSchemaDataSettingsItems" }, "type": "array" } }, "required": [ "settings" ], "title": "EorContractsAmendmentsDataPointsConfigurationGetResponsesContentApplicationJsonSchemaData", "type": "object" }, "EorContractsAmendmentsDataPointsConfigurationGetResponsesContentApplicationJsonSchemaDataSettingsItems": { "properties": { "country": { "description": "ISO 3166-1 alpha-2 country code", "type": "string" }, "created_at": { "description": "Timestamp when the country settings row was created. null when no DB row exists.", "format": "date-time", "type": [ "string", "null" ] }, "data_points": { "description": "Amendment data points configured for this country", "items": { "$ref": "#/components/schemas/EorContractsAmendmentsDataPointsConfigurationGetResponsesContentApplicationJsonSchemaDataSettingsItemsDataPointsItems" }, "type": "array" }, "id": { "description": "Database record ID for this country's settings. null when no settings row exists and defaults are returned.", "format": "uuid", "type": [ "string", "null" ] }, "updated_at": { "description": "Timestamp when the country settings row was last updated. null when no DB row exists.", "format": "date-time", "type": [ "string", "null" ] } }, "required": [ "id", "country", "created_at", "updated_at", "data_points" ], "title": "EorContractsAmendmentsDataPointsConfigurationGetResponsesContentApplicationJsonSchemaDataSettingsItems", "type": "object" }, "EorContractsAmendmentsDataPointsConfigurationGetResponsesContentApplicationJsonSchemaDataSettingsItemsDataPointsItems": { "properties": { "is_enabled": { "description": "Whether at least one amendment item within this data point is enabled", "type": "boolean" }, "item": { "$ref": "#/components/schemas/EorContractsAmendmentsDataPointsConfigurationGetResponsesContentApplicationJsonSchemaDataSettingsItemsDataPointsItemsItem", "description": "Data point identifier" }, "metadata": { "$ref": "#/components/schemas/EorContractsAmendmentsDataPointsConfigurationGetResponsesContentApplicationJsonSchemaDataSettingsItemsDataPointsItemsMetadata", "description": "Additional configuration for the data point. Present only for CUSTOM." }, "types": { "description": "Processing type configuration per amendment item within this data point", "items": { "$ref": "#/components/schemas/EorContractsAmendmentsDataPointsConfigurationGetResponsesContentApplicationJsonSchemaDataSettingsItemsDataPointsItemsTypesItems" }, "type": "array" } }, "required": [ "item", "types", "is_enabled" ], "title": "EorContractsAmendmentsDataPointsConfigurationGetResponsesContentApplicationJsonSchemaDataSettingsItemsDataPointsItems", "type": "object" }, "EorContractsAmendmentsDataPointsConfigurationGetResponsesContentApplicationJsonSchemaDataSettingsItemsDataPointsItemsItem": { "description": "Data point identifier", "enum": [ "SALARY", "START_DATE", "END_DATE", "HOLIDAYS", "SCOPE", "JOB_TITLE", "VARIABLE_COMPENSATIONS", "CUSTOM", "CURRENCY", "TIME_OFF_TYPE", "FIXED_ALLOWANCES", "PROBATION_PERIOD", "SENIORITY_ID", "WORK_HOURS_PER_WEEK", "EMPLOYMENT_STATE", "EMPLOYMENT_TYPE", "EMPLOYEE_NATIONALITY", "NOTICE_PERIOD_DURING_PROBATION", "NOTICE_PERIOD_AFTER_PROBATION", "NOTICE_PERIOD_TYPE", "WORK_SCHEDULE", "SENIORITY_DATE", "JOB_CATEGORY", "JOB_CODE" ], "title": "EorContractsAmendmentsDataPointsConfigurationGetResponsesContentApplicationJsonSchemaDataSettingsItemsDataPointsItemsItem", "type": "string" }, "EorContractsAmendmentsDataPointsConfigurationGetResponsesContentApplicationJsonSchemaDataSettingsItemsDataPointsItemsMetadata": { "description": "Additional configuration for the data point. Present only for CUSTOM.", "properties": { "possible_options": { "description": "Allowed subject values for a custom amendment item", "items": { "$ref": "#/components/schemas/EorContractsAmendmentsDataPointsConfigurationGetResponsesContentApplicationJsonSchemaDataSettingsItemsDataPointsItemsMetadataPossibleOptionsItems" }, "type": "array" } }, "title": "EorContractsAmendmentsDataPointsConfigurationGetResponsesContentApplicationJsonSchemaDataSettingsItemsDataPointsItemsMetadata", "type": "object" }, "EorContractsAmendmentsDataPointsConfigurationGetResponsesContentApplicationJsonSchemaDataSettingsItemsDataPointsItemsMetadataPossibleOptionsItems": { "enum": [ "START_DATE", "END_DATE", "BENEFITS", "PROBATION_PERIOD", "VARIABLE_COMPENSATIONS", "INCENTIVE_PLAN", "SALARY", "FIXED_ALLOWANCES", "JOB_TITLE", "SENIORITY_ID", "SENIORITY_DATE", "JOB_CODE", "JOB_CATEGORY", "JOB_SCOPE", "EMPLOYMENT_TYPE", "PERSONAL_DATA", "OTHER" ], "title": "EorContractsAmendmentsDataPointsConfigurationGetResponsesContentApplicationJsonSchemaDataSettingsItemsDataPointsItemsMetadataPossibleOptionsItems", "type": "string" }, "EorContractsAmendmentsDataPointsConfigurationGetResponsesContentApplicationJsonSchemaDataSettingsItemsDataPointsItemsTypesItems": { "properties": { "amendment_item": { "description": "Amendment item identifier", "type": "string" }, "type": { "$ref": "#/components/schemas/EorContractsAmendmentsDataPointsConfigurationGetResponsesContentApplicationJsonSchemaDataSettingsItemsDataPointsItemsTypesItemsType", "description": "Processing type. AUTOMATED means no explicit configuration — processed automatically." } }, "required": [ "type", "amendment_item" ], "title": "EorContractsAmendmentsDataPointsConfigurationGetResponsesContentApplicationJsonSchemaDataSettingsItemsDataPointsItemsTypesItems", "type": "object" }, "EorContractsAmendmentsDataPointsConfigurationGetResponsesContentApplicationJsonSchemaDataSettingsItemsDataPointsItemsTypesItemsType": { "description": "Processing type. AUTOMATED means no explicit configuration — processed automatically.", "enum": [ "AUTOMATED", "INSTANT", "LEGAL", "NO_AUTOMATION", "DISABLED_AMENDMENTS" ], "title": "EorContractsAmendmentsDataPointsConfigurationGetResponsesContentApplicationJsonSchemaDataSettingsItemsDataPointsItemsTypesItemsType", "type": "string" }, "EorContractsAmendmentsDataPointsConfigurationGetResponsesContentApplicationJsonSchemaErrorsItems": { "properties": { "code": { "type": "string" }, "message": { "type": "string" } }, "required": [ "code", "message" ], "title": "EorContractsAmendmentsDataPointsConfigurationGetResponsesContentApplicationJsonSchemaErrorsItems", "type": "object" }, "EorContractsContractIdAmendmentsAmendmentIdAcceptPostResponsesContentApplicationJsonSchemaData": { "properties": { "amendment_statuses": { "description": "List of amendment statuses representing the history and progression of an amendment.", "items": { "$ref": "#/components/schemas/EorContractsContractIdAmendmentsAmendmentIdAcceptPostResponsesContentApplicationJsonSchemaDataAmendmentStatusesItems" }, "type": "array" }, "created_at": { "description": "Creation date of the amendment.", "format": "date-time", "type": "string" }, "currency": { "description": "Contract currency.", "type": "string" }, "custom_items": { "description": "Custom amendment items associated with the amendment flow", "items": { "$ref": "#/components/schemas/EorContractsContractIdAmendmentsAmendmentIdAcceptPostResponsesContentApplicationJsonSchemaDataCustomItemsItems" }, "type": "array" }, "description": { "description": "Free-text description of the amendment.", "type": [ "string", "null" ] }, "document_type": { "description": "Amendment document type", "oneOf": [ { "$ref": "#/components/schemas/EorContractsContractIdAmendmentsAmendmentIdAcceptPostResponsesContentApplicationJsonSchemaDataDocumentType" }, { "type": "null" } ] }, "effective_date": { "description": "Effective date of the amendment.", "format": "date-time", "type": [ "string", "null" ] }, "employee_nationality": { "description": "Nationality of the employee.", "type": "string" }, "employment_state": { "description": "State of employment.", "type": [ "string", "null" ] }, "employment_type": { "$ref": "#/components/schemas/EorContractsContractIdAmendmentsAmendmentIdAcceptPostResponsesContentApplicationJsonSchemaDataEmploymentType", "description": "Type of employment." }, "end_date": { "description": "End date of the employment.", "format": "date-time", "type": [ "string", "null" ] }, "fixed_adjustments": { "description": "List of fixed adjustments associated with the amendment request.", "items": { "$ref": "#/components/schemas/EorContractsContractIdAmendmentsAmendmentIdAcceptPostResponsesContentApplicationJsonSchemaDataFixedAdjustmentsItems" }, "type": "array" }, "holidays": { "description": "Number of holidays.", "type": [ "integer", "null" ] }, "hourly_rate": { "description": "Hourly rate of the amendment", "type": [ "string", "null" ] }, "id": { "description": "Id of amendment", "format": "uuid", "type": "string" }, "is_effective_date_updated": { "description": "Is Effective Date updated.", "type": "boolean" }, "is_hrx_action_needed": { "description": "Is HRX action needed.", "type": "boolean" }, "items": { "description": "Items of amendment", "items": { "$ref": "#/components/schemas/EorContractsContractIdAmendmentsAmendmentIdAcceptPostResponsesContentApplicationJsonSchemaDataItemsItems" }, "type": "array" }, "job_category": { "description": "Job category associated with the job title.", "type": [ "string", "null" ] }, "job_code": { "description": "Job code associated with the job title.", "type": [ "string", "null" ] }, "job_title": { "description": "Job title associated with the amendment.", "maxLength": 1000, "type": "string" }, "legal_context": { "description": "Additional details needed for legal input", "oneOf": [ { "$ref": "#/components/schemas/EorContractsContractIdAmendmentsAmendmentIdAcceptPostResponsesContentApplicationJsonSchemaDataLegalContext" }, { "type": "null" } ] }, "net_salary": { "description": "Net salary for the amendment.", "type": [ "string", "null" ] }, "notice_period_after_probation": { "description": "Notice period after probation.", "type": [ "string", "null" ] }, "notice_period_during_probation": { "description": "Notice period during probation.", "type": [ "string", "null" ] }, "notice_period_time_unit": { "description": "Notice period time unit.", "oneOf": [ { "$ref": "#/components/schemas/EorContractsContractIdAmendmentsAmendmentIdAcceptPostResponsesContentApplicationJsonSchemaDataNoticePeriodTimeUnit" }, { "type": "null" } ] }, "notice_period_type": { "description": "Type of notice period.", "oneOf": [ { "$ref": "#/components/schemas/EorContractsContractIdAmendmentsAmendmentIdAcceptPostResponsesContentApplicationJsonSchemaDataNoticePeriodType" }, { "type": "null" } ] }, "probation_period": { "description": "Duration of the probation period.", "type": [ "integer", "null" ] }, "probation_period_type_for_definite": { "description": "Type of probation period for definite contracts.", "oneOf": [ { "$ref": "#/components/schemas/EorContractsContractIdAmendmentsAmendmentIdAcceptPostResponsesContentApplicationJsonSchemaDataProbationPeriodTypeForDefinite" }, { "type": "null" } ] }, "rejection_context": { "description": "Additional details containing rejection reason", "oneOf": [ { "$ref": "#/components/schemas/EorContractsContractIdAmendmentsAmendmentIdAcceptPostResponsesContentApplicationJsonSchemaDataRejectionContext" }, { "type": "null" } ] }, "requested_by": { "description": "Profile name of the user who requested the change", "type": [ "string", "null" ] }, "salary": { "description": "Salary for the amendment.", "type": "string" }, "scope": { "description": "Scope of the amendment.", "type": "string" }, "seniority_date": { "description": "The seniority date represents the employee’s original start date with a previous employer. It is used to preserve employment tenure when the employee transfers to this company. Can be null if not applicable.", "format": "date", "type": [ "string", "null" ] }, "seniority_id": { "description": "Seniority level identifier.", "format": "uuid", "type": [ "string", "null" ] }, "sick_leave_days": { "description": "Number of sick leave days", "type": [ "integer", "null" ] }, "source": { "description": "Source of amendment flow creation.", "oneOf": [ { "$ref": "#/components/schemas/EorContractsContractIdAmendmentsAmendmentIdAcceptPostResponsesContentApplicationJsonSchemaDataSource" }, { "type": "null" } ] }, "start_date": { "description": "Start date of the employment.", "format": "date-time", "type": "string" }, "time_off_type": { "$ref": "#/components/schemas/EorContractsContractIdAmendmentsAmendmentIdAcceptPostResponsesContentApplicationJsonSchemaDataTimeOffType", "description": "Type of time off." }, "type": { "description": "Type of amendment", "oneOf": [ { "$ref": "#/components/schemas/EorContractsContractIdAmendmentsAmendmentIdAcceptPostResponsesContentApplicationJsonSchemaDataType" }, { "type": "null" } ] }, "updated_at": { "description": "Date when amendment is updated", "format": "date-time", "type": "string" }, "variable_compensation": { "$ref": "#/components/schemas/EorContractsContractIdAmendmentsAmendmentIdAcceptPostResponsesContentApplicationJsonSchemaDataVariableCompensation", "description": "Represents a variable compensation record (such as a bonus, commission, or incentive) within a contract. It contains details like the amount, type, frequency, and whether it is part of an incentive plan. The record also tracks when it was created, updated, and whether it has been amended." }, "void_deadline": { "description": "Deadline this SOW to be voided", "format": "date-time", "type": [ "string", "null" ] }, "void_deadline_type": { "description": "Type of void deadline", "oneOf": [ { "$ref": "#/components/schemas/EorContractsContractIdAmendmentsAmendmentIdAcceptPostResponsesContentApplicationJsonSchemaDataVoidDeadlineType" }, { "type": "null" } ] }, "work_hours_per_week": { "description": "Number of work hours per week.", "type": "string" }, "work_schedule_id": { "description": "Work schedule id", "format": "uuid", "type": [ "string", "null" ] }, "work_schedule_rules_version": { "description": "Work schedule rule version.", "type": [ "string", "null" ] } }, "title": "EorContractsContractIdAmendmentsAmendmentIdAcceptPostResponsesContentApplicationJsonSchemaData", "type": "object" }, "EorContractsContractIdAmendmentsAmendmentIdAcceptPostResponsesContentApplicationJsonSchemaDataAmendmentStatusesItems": { "description": "Details of a specific amendment status in the lifecycle of the amendment.", "properties": { "amendment_flow_status": { "$ref": "#/components/schemas/EorContractsContractIdAmendmentsAmendmentIdAcceptPostResponsesContentApplicationJsonSchemaDataAmendmentStatusesItemsAmendmentFlowStatus", "description": "Metadata about the amendment status, including when it was created." }, "friendly_name": { "description": "Human-readable label of the amendment status (e.g., DRAFT, PENDING, APPROVED).", "type": "string" }, "name": { "description": "Logical, system-oriented identifier of the amendment status. Can be used to group statuses under a parent category and subgroup them for more granular state tracking. The structure typically follows a dot-separated hierarchy (e.g., 'PARENT','PARENT.CHILD', 'PARENT.CHILD.CHILD.CHILD', ...), which allows logical grouping and filtering of related statuses.", "type": "string" } }, "title": "EorContractsContractIdAmendmentsAmendmentIdAcceptPostResponsesContentApplicationJsonSchemaDataAmendmentStatusesItems", "type": "object" }, "EorContractsContractIdAmendmentsAmendmentIdAcceptPostResponsesContentApplicationJsonSchemaDataAmendmentStatusesItemsAmendmentFlowStatus": { "description": "Metadata about the amendment status, including when it was created.", "properties": { "created_at": { "description": "The timestamp when this amendment status was created.", "format": "date-time", "type": "string" } }, "title": "EorContractsContractIdAmendmentsAmendmentIdAcceptPostResponsesContentApplicationJsonSchemaDataAmendmentStatusesItemsAmendmentFlowStatus", "type": "object" }, "EorContractsContractIdAmendmentsAmendmentIdAcceptPostResponsesContentApplicationJsonSchemaDataCustomItemsItems": { "properties": { "description": { "description": "Detailed description of the custom amendment item", "type": [ "string", "null" ] }, "id": { "description": "Unique identifier for the custom amendment item", "format": "uuid", "type": "string" }, "rejection_reason": { "description": "Reason for rejection if the item was rejected", "type": [ "string", "null" ] }, "status": { "$ref": "#/components/schemas/EorContractsContractIdAmendmentsAmendmentIdAcceptPostResponsesContentApplicationJsonSchemaDataCustomItemsItemsStatus", "description": "Current status of the custom amendment item" }, "type": { "description": "Type/context of the custom amendment item", "type": "string" } }, "required": [ "id", "type", "status" ], "title": "EorContractsContractIdAmendmentsAmendmentIdAcceptPostResponsesContentApplicationJsonSchemaDataCustomItemsItems", "type": "object" }, "EorContractsContractIdAmendmentsAmendmentIdAcceptPostResponsesContentApplicationJsonSchemaDataCustomItemsItemsStatus": { "description": "Current status of the custom amendment item", "enum": [ "REJECTED", "APPROVED", "PENDING_REVIEW", "PENDING_LEGAL" ], "title": "EorContractsContractIdAmendmentsAmendmentIdAcceptPostResponsesContentApplicationJsonSchemaDataCustomItemsItemsStatus", "type": "string" }, "EorContractsContractIdAmendmentsAmendmentIdAcceptPostResponsesContentApplicationJsonSchemaDataDocumentType": { "description": "Amendment document type", "enum": [ "EA", "SOW", "SOW_EA" ], "title": "EorContractsContractIdAmendmentsAmendmentIdAcceptPostResponsesContentApplicationJsonSchemaDataDocumentType", "type": "string" }, "EorContractsContractIdAmendmentsAmendmentIdAcceptPostResponsesContentApplicationJsonSchemaDataEmploymentType": { "description": "Type of employment.", "enum": [ "FULL_TIME", "PART_TIME" ], "title": "EorContractsContractIdAmendmentsAmendmentIdAcceptPostResponsesContentApplicationJsonSchemaDataEmploymentType", "type": "string" }, "EorContractsContractIdAmendmentsAmendmentIdAcceptPostResponsesContentApplicationJsonSchemaDataFixedAdjustmentsItems": { "properties": { "created_at": { "description": "Timestamp when the fixed adjustment was created.", "format": "date-time", "type": "string" }, "description": { "description": "Description of the fixed adjustment.", "maxLength": 256, "minLength": 1, "type": "string" }, "id": { "description": "System-generated unique identifier for the fixed adjustment record in an amendment request.", "type": "string" }, "is_amended": { "description": "Whether this fixed adjustment was amended from a previous one.", "type": "boolean" }, "is_country_specific": { "description": "Whether this fixed adjustment applies only to a specific country.", "type": "boolean" }, "is_deleted": { "description": "True if the fixed adjustment was deleted as part of the amendment; otherwise false.", "type": "boolean" }, "is_recurring": { "description": "Whether the fixed adjustment is recurring. If set to false, it will be treated as a one-time fixed allowance.", "type": "boolean" }, "parent_fixed_adjustment_id": { "description": "Reference to the parent fixed adjustment, if applicable.", "type": [ "string", "null" ] }, "status": { "$ref": "#/components/schemas/EorContractsContractIdAmendmentsAmendmentIdAcceptPostResponsesContentApplicationJsonSchemaDataFixedAdjustmentsItemsStatus", "description": "Current status of the fixed adjustment." }, "updated_at": { "description": "Timestamp when the fixed adjustment was last updated.", "format": "date-time", "type": "string" }, "value": { "description": "Value of the fixed adjustment.", "pattern": "^(?!0+(\\.0+)?$)\\d+(?:\\.\\d+)?$", "type": "string" } }, "required": [ "id", "value", "status", "created_at", "is_amended", "updated_at", "description", "is_recurring", "is_country_specific" ], "title": "EorContractsContractIdAmendmentsAmendmentIdAcceptPostResponsesContentApplicationJsonSchemaDataFixedAdjustmentsItems", "type": "object" }, "EorContractsContractIdAmendmentsAmendmentIdAcceptPostResponsesContentApplicationJsonSchemaDataFixedAdjustmentsItemsStatus": { "description": "Current status of the fixed adjustment.", "enum": [ "WAITING_FOR_SIGNING", "ACTIVE", "OUTDATED", "CANCELLED" ], "title": "EorContractsContractIdAmendmentsAmendmentIdAcceptPostResponsesContentApplicationJsonSchemaDataFixedAdjustmentsItemsStatus", "type": "string" }, "EorContractsContractIdAmendmentsAmendmentIdAcceptPostResponsesContentApplicationJsonSchemaDataItemsItems": { "properties": { "data_point": { "description": "The field that is selected for amendment.", "type": "string" }, "id": { "description": "Id of amendment item", "format": "uuid", "type": "string" }, "item": { "description": "Amendment item", "type": "string" }, "new_value": { "description": "The new valid value after the attempted change.", "type": "string" }, "previous_value": { "description": "The previous valid value before the attempted change.", "type": "string" }, "type": { "$ref": "#/components/schemas/EorContractsContractIdAmendmentsAmendmentIdAcceptPostResponsesContentApplicationJsonSchemaDataItemsItemsType", "description": "Type of amendment" } }, "title": "EorContractsContractIdAmendmentsAmendmentIdAcceptPostResponsesContentApplicationJsonSchemaDataItemsItems", "type": "object" }, "EorContractsContractIdAmendmentsAmendmentIdAcceptPostResponsesContentApplicationJsonSchemaDataItemsItemsType": { "description": "Type of amendment", "enum": [ "INSTANT", "OPS", "LEGAL", "DISABLED", "CUSTOM", "AUTOMATED" ], "title": "EorContractsContractIdAmendmentsAmendmentIdAcceptPostResponsesContentApplicationJsonSchemaDataItemsItemsType", "type": "string" }, "EorContractsContractIdAmendmentsAmendmentIdAcceptPostResponsesContentApplicationJsonSchemaDataLegalContext": { "description": "Additional details needed for legal input", "properties": { "details": { "description": "Details regarding the legal request", "type": "string" }, "jira_ticket": { "description": "Jira ticket identifier linked to the legal context", "type": "string" }, "jira_web_url": { "description": "Link to the Jira ticket for tracking", "format": "uri", "type": "string" }, "requested_at": { "description": "Timestamp when legal review was requested", "format": "date-time", "type": "string" }, "status": { "$ref": "#/components/schemas/EorContractsContractIdAmendmentsAmendmentIdAcceptPostResponsesContentApplicationJsonSchemaDataLegalContextStatus", "description": "Current status of the legal review process" } }, "title": "EorContractsContractIdAmendmentsAmendmentIdAcceptPostResponsesContentApplicationJsonSchemaDataLegalContext", "type": "object" }, "EorContractsContractIdAmendmentsAmendmentIdAcceptPostResponsesContentApplicationJsonSchemaDataLegalContextStatus": { "description": "Current status of the legal review process", "enum": [ "REQUEST_LEGAL_REVIEW", "WAITING_FOR_ANOTHER_TEAM", "WAITING_FOR_HRX_ACTION", "DECLINED", "SOLVED" ], "title": "EorContractsContractIdAmendmentsAmendmentIdAcceptPostResponsesContentApplicationJsonSchemaDataLegalContextStatus", "type": "string" }, "EorContractsContractIdAmendmentsAmendmentIdAcceptPostResponsesContentApplicationJsonSchemaDataNoticePeriodTimeUnit": { "description": "Notice period time unit.", "enum": [ "DAY", "WEEK", "MONTH" ], "title": "EorContractsContractIdAmendmentsAmendmentIdAcceptPostResponsesContentApplicationJsonSchemaDataNoticePeriodTimeUnit", "type": "string" }, "EorContractsContractIdAmendmentsAmendmentIdAcceptPostResponsesContentApplicationJsonSchemaDataNoticePeriodType": { "description": "Type of notice period.", "enum": [ "STANDARD", "CUSTOM" ], "title": "EorContractsContractIdAmendmentsAmendmentIdAcceptPostResponsesContentApplicationJsonSchemaDataNoticePeriodType", "type": "string" }, "EorContractsContractIdAmendmentsAmendmentIdAcceptPostResponsesContentApplicationJsonSchemaDataProbationPeriodTypeForDefinite": { "description": "Type of probation period for definite contracts.", "enum": [ "STANDARD", "CUSTOM" ], "title": "EorContractsContractIdAmendmentsAmendmentIdAcceptPostResponsesContentApplicationJsonSchemaDataProbationPeriodTypeForDefinite", "type": "string" }, "EorContractsContractIdAmendmentsAmendmentIdAcceptPostResponsesContentApplicationJsonSchemaDataRejectionContext": { "description": "Additional details containing rejection reason", "properties": { "rejected_at": { "description": "Timestamp of when the rejection occurred", "format": "date-time", "type": "string" }, "rejection_reason": { "description": "Reason provided when the amendment was rejected. Null when the amendment was cancelled rather than rejected by an admin.", "type": [ "string", "null" ] } }, "title": "EorContractsContractIdAmendmentsAmendmentIdAcceptPostResponsesContentApplicationJsonSchemaDataRejectionContext", "type": "object" }, "EorContractsContractIdAmendmentsAmendmentIdAcceptPostResponsesContentApplicationJsonSchemaDataSource": { "description": "Source of amendment flow creation.", "enum": [ "APP", "PUBLIC_API", "APP_BULK_AMENDMENT" ], "title": "EorContractsContractIdAmendmentsAmendmentIdAcceptPostResponsesContentApplicationJsonSchemaDataSource", "type": "string" }, "EorContractsContractIdAmendmentsAmendmentIdAcceptPostResponsesContentApplicationJsonSchemaDataTimeOffType": { "description": "Type of time off.", "enum": [ "STANDARD", "SPECIFIC", "PRORATED" ], "title": "EorContractsContractIdAmendmentsAmendmentIdAcceptPostResponsesContentApplicationJsonSchemaDataTimeOffType", "type": "string" }, "EorContractsContractIdAmendmentsAmendmentIdAcceptPostResponsesContentApplicationJsonSchemaDataType": { "description": "Type of amendment", "enum": [ "INSTANT", "OPS", "LEGAL", "DISABLED", "CUSTOM", "AUTOMATED" ], "title": "EorContractsContractIdAmendmentsAmendmentIdAcceptPostResponsesContentApplicationJsonSchemaDataType", "type": "string" }, "EorContractsContractIdAmendmentsAmendmentIdAcceptPostResponsesContentApplicationJsonSchemaDataVariableCompensation": { "description": "Represents a variable compensation record (such as a bonus, commission, or incentive) within a contract. It contains details like the amount, type, frequency, and whether it is part of an incentive plan. The record also tracks when it was created, updated, and whether it has been amended.", "properties": { "amount": { "description": "The value of the compensation. Shown as a string to keep the exact number of decimals.", "format": "decimal", "type": "string" }, "created_at": { "description": "The date and time when this record was first created in the system.", "format": "date-time", "type": "string" }, "effective_date": { "description": "The date when this compensation starts being valid.", "format": "date-time", "type": "string" }, "id": { "description": "The unique ID assigned by the system to this variable compensation record.", "type": "string" }, "incentive_plan": { "$ref": "#/components/schemas/EorContractsContractIdAmendmentsAmendmentIdAcceptPostResponsesContentApplicationJsonSchemaDataVariableCompensationIncentivePlan", "description": "Details of the incentive plan linked to this compensation, if any." }, "is_amended": { "description": "Shows whether this compensation has been changed as part of an amendment.", "type": "boolean" }, "is_deleted": { "description": "Shows whether this compensation has been deleted.", "type": "boolean" }, "parent_id": { "description": "Reference to the parent variable compensation, if applicable. Null if this compensation is not linked to any compensation.", "type": [ "string", "null" ] }, "timeline": { "$ref": "#/components/schemas/EorContractsContractIdAmendmentsAmendmentIdAcceptPostResponsesContentApplicationJsonSchemaDataVariableCompensationTimeline", "description": "How often the compensation is paid — for example monthly, quarterly, annually, or twice a year." }, "title": { "description": "Title or name of the variable compensation.", "type": "string" }, "type": { "$ref": "#/components/schemas/EorContractsContractIdAmendmentsAmendmentIdAcceptPostResponsesContentApplicationJsonSchemaDataVariableCompensationType", "description": "The way the compensation is calculated. `FIXED` means a fixed amount (like $1000). `PERCENTAGE` means it’s based on a percentage of the salary." }, "updated_at": { "description": "The date and time when this record was last updated.", "format": "date-time", "type": "string" } }, "required": [ "id", "type", "title", "amount", "timeline", "parent_id", "created_at", "updated_at", "effective_date" ], "title": "EorContractsContractIdAmendmentsAmendmentIdAcceptPostResponsesContentApplicationJsonSchemaDataVariableCompensation", "type": "object" }, "EorContractsContractIdAmendmentsAmendmentIdAcceptPostResponsesContentApplicationJsonSchemaDataVariableCompensationIncentivePlan": { "description": "Details of the incentive plan linked to this compensation, if any.", "properties": { "details": { "description": "Extra details about the incentive plan, if any.", "type": "string" }, "employee_signature": { "description": "The employee’s signature for the incentive plan, if collected.", "type": "string" }, "employee_signed_at": { "description": "The date and time when the employee signed the incentive plan. Empty if not signed.", "format": "date-time", "type": "string" } }, "title": "EorContractsContractIdAmendmentsAmendmentIdAcceptPostResponsesContentApplicationJsonSchemaDataVariableCompensationIncentivePlan", "type": "object" }, "EorContractsContractIdAmendmentsAmendmentIdAcceptPostResponsesContentApplicationJsonSchemaDataVariableCompensationTimeline": { "description": "How often the compensation is paid — for example monthly, quarterly, annually, or twice a year.", "enum": [ "MONTHLY", "QUARTERLY", "ANNUALLY", "BIANNUALLY" ], "title": "EorContractsContractIdAmendmentsAmendmentIdAcceptPostResponsesContentApplicationJsonSchemaDataVariableCompensationTimeline", "type": "string" }, "EorContractsContractIdAmendmentsAmendmentIdAcceptPostResponsesContentApplicationJsonSchemaDataVariableCompensationType": { "description": "The way the compensation is calculated. `FIXED` means a fixed amount (like $1000). `PERCENTAGE` means it’s based on a percentage of the salary.", "enum": [ "FIXED", "PERCENTAGE" ], "title": "EorContractsContractIdAmendmentsAmendmentIdAcceptPostResponsesContentApplicationJsonSchemaDataVariableCompensationType", "type": "string" }, "EorContractsContractIdAmendmentsAmendmentIdAcceptPostResponsesContentApplicationJsonSchemaDataVoidDeadlineType": { "description": "Type of void deadline", "enum": [ "CUTOFF", "START_DATE", "END_DATE", "EXPIRY" ], "title": "EorContractsContractIdAmendmentsAmendmentIdAcceptPostResponsesContentApplicationJsonSchemaDataVoidDeadlineType", "type": "string" }, "EorContractsContractIdAmendmentsAmendmentIdAcceptPostResponsesContentApplicationJsonSchemaErrorsItems": { "properties": { "code": { "type": "string" }, "message": { "type": "string" } }, "required": [ "code", "message" ], "title": "EorContractsContractIdAmendmentsAmendmentIdAcceptPostResponsesContentApplicationJsonSchemaErrorsItems", "type": "object" }, "EorContractsContractIdAmendmentsAmendmentIdConfirmPostResponsesContentApplicationJsonSchemaData": { "properties": { "amendment_statuses": { "description": "List of amendment statuses representing the history and progression of an amendment.", "items": { "$ref": "#/components/schemas/EorContractsContractIdAmendmentsAmendmentIdConfirmPostResponsesContentApplicationJsonSchemaDataAmendmentStatusesItems" }, "type": "array" }, "created_at": { "description": "Creation date of the amendment.", "format": "date-time", "type": "string" }, "currency": { "description": "Contract currency.", "type": "string" }, "custom_items": { "description": "Custom amendment items associated with the amendment flow", "items": { "$ref": "#/components/schemas/EorContractsContractIdAmendmentsAmendmentIdConfirmPostResponsesContentApplicationJsonSchemaDataCustomItemsItems" }, "type": "array" }, "description": { "description": "Free-text description of the amendment.", "type": [ "string", "null" ] }, "document_type": { "description": "Amendment document type", "oneOf": [ { "$ref": "#/components/schemas/EorContractsContractIdAmendmentsAmendmentIdConfirmPostResponsesContentApplicationJsonSchemaDataDocumentType" }, { "type": "null" } ] }, "effective_date": { "description": "Effective date of the amendment.", "format": "date-time", "type": [ "string", "null" ] }, "employee_nationality": { "description": "Nationality of the employee.", "type": "string" }, "employment_state": { "description": "State of employment.", "type": [ "string", "null" ] }, "employment_type": { "$ref": "#/components/schemas/EorContractsContractIdAmendmentsAmendmentIdConfirmPostResponsesContentApplicationJsonSchemaDataEmploymentType", "description": "Type of employment." }, "end_date": { "description": "End date of the employment.", "format": "date-time", "type": [ "string", "null" ] }, "fixed_adjustments": { "description": "List of fixed adjustments associated with the amendment request.", "items": { "$ref": "#/components/schemas/EorContractsContractIdAmendmentsAmendmentIdConfirmPostResponsesContentApplicationJsonSchemaDataFixedAdjustmentsItems" }, "type": "array" }, "holidays": { "description": "Number of holidays.", "type": [ "integer", "null" ] }, "hourly_rate": { "description": "Hourly rate of the amendment", "type": [ "string", "null" ] }, "id": { "description": "Id of amendment", "format": "uuid", "type": "string" }, "is_effective_date_updated": { "description": "Is Effective Date updated.", "type": "boolean" }, "is_hrx_action_needed": { "description": "Is HRX action needed.", "type": "boolean" }, "items": { "description": "Items of amendment", "items": { "$ref": "#/components/schemas/EorContractsContractIdAmendmentsAmendmentIdConfirmPostResponsesContentApplicationJsonSchemaDataItemsItems" }, "type": "array" }, "job_category": { "description": "Job category associated with the job title.", "type": [ "string", "null" ] }, "job_code": { "description": "Job code associated with the job title.", "type": [ "string", "null" ] }, "job_title": { "description": "Job title associated with the amendment.", "maxLength": 1000, "type": "string" }, "legal_context": { "description": "Additional details needed for legal input", "oneOf": [ { "$ref": "#/components/schemas/EorContractsContractIdAmendmentsAmendmentIdConfirmPostResponsesContentApplicationJsonSchemaDataLegalContext" }, { "type": "null" } ] }, "net_salary": { "description": "Net salary for the amendment.", "type": [ "string", "null" ] }, "notice_period_after_probation": { "description": "Notice period after probation.", "type": [ "string", "null" ] }, "notice_period_during_probation": { "description": "Notice period during probation.", "type": [ "string", "null" ] }, "notice_period_time_unit": { "description": "Notice period time unit.", "oneOf": [ { "$ref": "#/components/schemas/EorContractsContractIdAmendmentsAmendmentIdConfirmPostResponsesContentApplicationJsonSchemaDataNoticePeriodTimeUnit" }, { "type": "null" } ] }, "notice_period_type": { "description": "Type of notice period.", "oneOf": [ { "$ref": "#/components/schemas/EorContractsContractIdAmendmentsAmendmentIdConfirmPostResponsesContentApplicationJsonSchemaDataNoticePeriodType" }, { "type": "null" } ] }, "probation_period": { "description": "Duration of the probation period.", "type": [ "integer", "null" ] }, "probation_period_type_for_definite": { "description": "Type of probation period for definite contracts.", "oneOf": [ { "$ref": "#/components/schemas/EorContractsContractIdAmendmentsAmendmentIdConfirmPostResponsesContentApplicationJsonSchemaDataProbationPeriodTypeForDefinite" }, { "type": "null" } ] }, "rejection_context": { "description": "Additional details containing rejection reason", "oneOf": [ { "$ref": "#/components/schemas/EorContractsContractIdAmendmentsAmendmentIdConfirmPostResponsesContentApplicationJsonSchemaDataRejectionContext" }, { "type": "null" } ] }, "requested_by": { "description": "Profile name of the user who requested the change", "type": [ "string", "null" ] }, "salary": { "description": "Salary for the amendment.", "type": "string" }, "scope": { "description": "Scope of the amendment.", "type": "string" }, "seniority_date": { "description": "The seniority date represents the employee’s original start date with a previous employer. It is used to preserve employment tenure when the employee transfers to this company. Can be null if not applicable.", "format": "date-time", "type": [ "string", "null" ] }, "seniority_id": { "description": "Seniority level identifier.", "format": "uuid", "type": [ "string", "null" ] }, "sick_leave_days": { "description": "Number of sick leave days", "type": [ "integer", "null" ] }, "source": { "description": "Source of amendment flow creation.", "oneOf": [ { "$ref": "#/components/schemas/EorContractsContractIdAmendmentsAmendmentIdConfirmPostResponsesContentApplicationJsonSchemaDataSource" }, { "type": "null" } ] }, "start_date": { "description": "Start date of the employment.", "format": "date-time", "type": "string" }, "time_off_type": { "$ref": "#/components/schemas/EorContractsContractIdAmendmentsAmendmentIdConfirmPostResponsesContentApplicationJsonSchemaDataTimeOffType", "description": "Type of time off." }, "type": { "description": "Type of amendment", "oneOf": [ { "$ref": "#/components/schemas/EorContractsContractIdAmendmentsAmendmentIdConfirmPostResponsesContentApplicationJsonSchemaDataType" }, { "type": "null" } ] }, "updated_at": { "description": "Date when amendment is updated", "format": "date-time", "type": "string" }, "variable_compensation": { "$ref": "#/components/schemas/EorContractsContractIdAmendmentsAmendmentIdConfirmPostResponsesContentApplicationJsonSchemaDataVariableCompensation", "description": "Represents a variable compensation record (such as a bonus, commission, or incentive) within a contract. It contains details like the amount, type, frequency, and whether it is part of an incentive plan. The record also tracks when it was created, updated, and whether it has been amended." }, "void_deadline": { "description": "Deadline this SOW to be voided", "format": "date", "type": [ "string", "null" ] }, "void_deadline_type": { "description": "Type of void deadline", "oneOf": [ { "$ref": "#/components/schemas/EorContractsContractIdAmendmentsAmendmentIdConfirmPostResponsesContentApplicationJsonSchemaDataVoidDeadlineType" }, { "type": "null" } ] }, "work_hours_per_week": { "description": "Number of work hours per week.", "type": "string" }, "work_schedule_id": { "description": "Work schedule id", "format": "uuid", "type": [ "string", "null" ] }, "work_schedule_rules_version": { "description": "Work schedule rule version.", "type": [ "string", "null" ] } }, "title": "EorContractsContractIdAmendmentsAmendmentIdConfirmPostResponsesContentApplicationJsonSchemaData", "type": "object" }, "EorContractsContractIdAmendmentsAmendmentIdConfirmPostResponsesContentApplicationJsonSchemaDataAmendmentStatusesItems": { "properties": { "amendment_flow_status": { "$ref": "#/components/schemas/EorContractsContractIdAmendmentsAmendmentIdConfirmPostResponsesContentApplicationJsonSchemaDataAmendmentStatusesItemsAmendmentFlowStatus", "description": "Metadata about the amendment status, including when it was created." }, "friendly_name": { "description": "Friendly name of amendment status", "type": "string" }, "name": { "description": "Logical, system-oriented identifier of the amendment status. Can be used to group statuses under a parent category and subgroup them for more granular state tracking. The structure typically follows a dot-separated hierarchy (e.g., 'PARENT','PARENT.CHILD', 'PARENT.CHILD.CHILD.CHILD', ...), which allows logical grouping and filtering of related statuses.", "type": "string" } }, "title": "EorContractsContractIdAmendmentsAmendmentIdConfirmPostResponsesContentApplicationJsonSchemaDataAmendmentStatusesItems", "type": "object" }, "EorContractsContractIdAmendmentsAmendmentIdConfirmPostResponsesContentApplicationJsonSchemaDataAmendmentStatusesItemsAmendmentFlowStatus": { "description": "Metadata about the amendment status, including when it was created.", "properties": { "created_at": { "description": "Creation date", "format": "date-time", "type": "string" } }, "title": "EorContractsContractIdAmendmentsAmendmentIdConfirmPostResponsesContentApplicationJsonSchemaDataAmendmentStatusesItemsAmendmentFlowStatus", "type": "object" }, "EorContractsContractIdAmendmentsAmendmentIdConfirmPostResponsesContentApplicationJsonSchemaDataCustomItemsItems": { "properties": { "description": { "description": "Detailed description of the custom amendment item", "type": [ "string", "null" ] }, "id": { "description": "Unique identifier for the custom amendment item", "format": "uuid", "type": "string" }, "rejection_reason": { "description": "Reason for rejection if the item was rejected", "type": [ "string", "null" ] }, "status": { "$ref": "#/components/schemas/EorContractsContractIdAmendmentsAmendmentIdConfirmPostResponsesContentApplicationJsonSchemaDataCustomItemsItemsStatus", "description": "Current status of the custom amendment item" }, "type": { "description": "Type/context of the custom amendment item", "type": "string" } }, "required": [ "id", "type", "status" ], "title": "EorContractsContractIdAmendmentsAmendmentIdConfirmPostResponsesContentApplicationJsonSchemaDataCustomItemsItems", "type": "object" }, "EorContractsContractIdAmendmentsAmendmentIdConfirmPostResponsesContentApplicationJsonSchemaDataCustomItemsItemsStatus": { "description": "Current status of the custom amendment item", "enum": [ "REJECTED", "APPROVED", "PENDING_REVIEW", "PENDING_LEGAL" ], "title": "EorContractsContractIdAmendmentsAmendmentIdConfirmPostResponsesContentApplicationJsonSchemaDataCustomItemsItemsStatus", "type": "string" }, "EorContractsContractIdAmendmentsAmendmentIdConfirmPostResponsesContentApplicationJsonSchemaDataDocumentType": { "description": "Amendment document type", "enum": [ "EA", "SOW", "SOW_EA" ], "title": "EorContractsContractIdAmendmentsAmendmentIdConfirmPostResponsesContentApplicationJsonSchemaDataDocumentType", "type": "string" }, "EorContractsContractIdAmendmentsAmendmentIdConfirmPostResponsesContentApplicationJsonSchemaDataEmploymentType": { "description": "Type of employment.", "enum": [ "FULL_TIME", "PART_TIME" ], "title": "EorContractsContractIdAmendmentsAmendmentIdConfirmPostResponsesContentApplicationJsonSchemaDataEmploymentType", "type": "string" }, "EorContractsContractIdAmendmentsAmendmentIdConfirmPostResponsesContentApplicationJsonSchemaDataFixedAdjustmentsItems": { "properties": { "created_at": { "description": "Timestamp when the fixed adjustment was created.", "format": "date-time", "type": "string" }, "description": { "description": "Description of the fixed adjustment.", "maxLength": 256, "minLength": 1, "type": "string" }, "id": { "description": "System-generated unique identifier for the fixed adjustment record in an amendment request.", "type": "string" }, "is_amended": { "description": "Whether this fixed adjustment was amended from a previous one.", "type": "boolean" }, "is_country_specific": { "description": "Whether this fixed adjustment applies only to a specific country.", "type": "boolean" }, "is_deleted": { "description": "True if the fixed adjustment was deleted as part of the amendment; otherwise false.", "type": "boolean" }, "is_recurring": { "description": "Whether the fixed adjustment is recurring. If set to false, it will be treated as a one-time fixed allowance.", "type": "boolean" }, "parent_fixed_adjustment_id": { "description": "Reference to the parent fixed adjustment, if applicable.", "type": [ "string", "null" ] }, "status": { "$ref": "#/components/schemas/EorContractsContractIdAmendmentsAmendmentIdConfirmPostResponsesContentApplicationJsonSchemaDataFixedAdjustmentsItemsStatus", "description": "Current status of the fixed adjustment." }, "updated_at": { "description": "Timestamp when the fixed adjustment was last updated.", "format": "date-time", "type": "string" }, "value": { "description": "Value of the fixed adjustment.", "pattern": "^(?!0+(\\.0+)?$)\\d+(?:\\.\\d+)?$", "type": "string" } }, "required": [ "id", "value", "status", "created_at", "is_amended", "updated_at", "description", "is_recurring", "is_country_specific" ], "title": "EorContractsContractIdAmendmentsAmendmentIdConfirmPostResponsesContentApplicationJsonSchemaDataFixedAdjustmentsItems", "type": "object" }, "EorContractsContractIdAmendmentsAmendmentIdConfirmPostResponsesContentApplicationJsonSchemaDataFixedAdjustmentsItemsStatus": { "description": "Current status of the fixed adjustment.", "enum": [ "WAITING_FOR_SIGNING", "ACTIVE", "OUTDATED", "CANCELLED" ], "title": "EorContractsContractIdAmendmentsAmendmentIdConfirmPostResponsesContentApplicationJsonSchemaDataFixedAdjustmentsItemsStatus", "type": "string" }, "EorContractsContractIdAmendmentsAmendmentIdConfirmPostResponsesContentApplicationJsonSchemaDataItemsItems": { "properties": { "data_point": { "description": "The field that is selected for amendment.", "type": "string" }, "id": { "description": "Id of amendment item", "format": "uuid", "type": "string" }, "item": { "description": "Amendment item", "type": "string" }, "new_value": { "description": "The new valid value after the attempted change.", "type": "string" }, "previous_value": { "description": "The previous valid value before the attempted change.", "type": "string" }, "type": { "description": "Type of amendment", "type": "string" } }, "title": "EorContractsContractIdAmendmentsAmendmentIdConfirmPostResponsesContentApplicationJsonSchemaDataItemsItems", "type": "object" }, "EorContractsContractIdAmendmentsAmendmentIdConfirmPostResponsesContentApplicationJsonSchemaDataLegalContext": { "description": "Additional details needed for legal input", "properties": { "details": { "description": "Details regarding the legal request", "type": "string" }, "jira_ticket": { "description": "Jira ticket identifier linked to the legal context", "type": "string" }, "jira_web_url": { "description": "Link to the Jira ticket for tracking", "format": "uri", "type": "string" }, "requested_at": { "description": "Timestamp when legal review was requested", "format": "date-time", "type": "string" }, "status": { "$ref": "#/components/schemas/EorContractsContractIdAmendmentsAmendmentIdConfirmPostResponsesContentApplicationJsonSchemaDataLegalContextStatus", "description": "Current status of the legal review process" } }, "title": "EorContractsContractIdAmendmentsAmendmentIdConfirmPostResponsesContentApplicationJsonSchemaDataLegalContext", "type": "object" }, "EorContractsContractIdAmendmentsAmendmentIdConfirmPostResponsesContentApplicationJsonSchemaDataLegalContextStatus": { "description": "Current status of the legal review process", "enum": [ "REQUEST_LEGAL_REVIEW", "WAITING_FOR_ANOTHER_TEAM", "WAITING_FOR_HRX_ACTION", "DECLINED", "SOLVED" ], "title": "EorContractsContractIdAmendmentsAmendmentIdConfirmPostResponsesContentApplicationJsonSchemaDataLegalContextStatus", "type": "string" }, "EorContractsContractIdAmendmentsAmendmentIdConfirmPostResponsesContentApplicationJsonSchemaDataNoticePeriodTimeUnit": { "description": "Notice period time unit.", "enum": [ "DAY", "WEEK", "MONTH" ], "title": "EorContractsContractIdAmendmentsAmendmentIdConfirmPostResponsesContentApplicationJsonSchemaDataNoticePeriodTimeUnit", "type": "string" }, "EorContractsContractIdAmendmentsAmendmentIdConfirmPostResponsesContentApplicationJsonSchemaDataNoticePeriodType": { "description": "Type of notice period.", "enum": [ "STANDARD", "CUSTOM" ], "title": "EorContractsContractIdAmendmentsAmendmentIdConfirmPostResponsesContentApplicationJsonSchemaDataNoticePeriodType", "type": "string" }, "EorContractsContractIdAmendmentsAmendmentIdConfirmPostResponsesContentApplicationJsonSchemaDataProbationPeriodTypeForDefinite": { "description": "Type of probation period for definite contracts.", "enum": [ "STANDARD", "CUSTOM" ], "title": "EorContractsContractIdAmendmentsAmendmentIdConfirmPostResponsesContentApplicationJsonSchemaDataProbationPeriodTypeForDefinite", "type": "string" }, "EorContractsContractIdAmendmentsAmendmentIdConfirmPostResponsesContentApplicationJsonSchemaDataRejectionContext": { "description": "Additional details containing rejection reason", "properties": { "rejected_at": { "description": "Timestamp of when the rejection occurred", "format": "date-time", "type": "string" }, "rejection_reason": { "description": "Reason provided when the amendment was rejected. Null when the amendment was cancelled rather than rejected by an admin.", "type": [ "string", "null" ] } }, "title": "EorContractsContractIdAmendmentsAmendmentIdConfirmPostResponsesContentApplicationJsonSchemaDataRejectionContext", "type": "object" }, "EorContractsContractIdAmendmentsAmendmentIdConfirmPostResponsesContentApplicationJsonSchemaDataSource": { "description": "Source of amendment flow creation.", "enum": [ "APP", "PUBLIC_API", "APP_BULK_AMENDMENT" ], "title": "EorContractsContractIdAmendmentsAmendmentIdConfirmPostResponsesContentApplicationJsonSchemaDataSource", "type": "string" }, "EorContractsContractIdAmendmentsAmendmentIdConfirmPostResponsesContentApplicationJsonSchemaDataTimeOffType": { "description": "Type of time off.", "enum": [ "STANDARD", "SPECIFIC", "PRORATED" ], "title": "EorContractsContractIdAmendmentsAmendmentIdConfirmPostResponsesContentApplicationJsonSchemaDataTimeOffType", "type": "string" }, "EorContractsContractIdAmendmentsAmendmentIdConfirmPostResponsesContentApplicationJsonSchemaDataType": { "description": "Type of amendment", "enum": [ "INSTANT", "OPS", "LEGAL", "DISABLED", "CUSTOM", "AUTOMATED" ], "title": "EorContractsContractIdAmendmentsAmendmentIdConfirmPostResponsesContentApplicationJsonSchemaDataType", "type": "string" }, "EorContractsContractIdAmendmentsAmendmentIdConfirmPostResponsesContentApplicationJsonSchemaDataVariableCompensation": { "description": "Represents a variable compensation record (such as a bonus, commission, or incentive) within a contract. It contains details like the amount, type, frequency, and whether it is part of an incentive plan. The record also tracks when it was created, updated, and whether it has been amended.", "properties": { "amount": { "description": "The value of the compensation. Shown as a string to keep the exact number of decimals.", "format": "decimal", "type": "string" }, "created_at": { "description": "The date and time when this record was first created in the system.", "format": "date-time", "type": "string" }, "effective_date": { "description": "The date when this compensation starts being valid.", "format": "date-time", "type": "string" }, "id": { "description": "The unique ID assigned by the system to this variable compensation record.", "type": "string" }, "incentive_plan": { "$ref": "#/components/schemas/EorContractsContractIdAmendmentsAmendmentIdConfirmPostResponsesContentApplicationJsonSchemaDataVariableCompensationIncentivePlan", "description": "Details of the incentive plan linked to this compensation, if any." }, "is_amended": { "description": "Shows whether this compensation has been changed as part of an amendment.", "type": "boolean" }, "is_deleted": { "description": "Shows whether this compensation has been deleted.", "type": "boolean" }, "parent_id": { "description": "Reference to the parent variable compensation, if applicable. Null if this compensation is not linked to any compensation.", "type": [ "string", "null" ] }, "timeline": { "$ref": "#/components/schemas/EorContractsContractIdAmendmentsAmendmentIdConfirmPostResponsesContentApplicationJsonSchemaDataVariableCompensationTimeline", "description": "How often the compensation is paid — for example monthly, quarterly, annually, or twice a year." }, "title": { "description": "Title or name of the variable compensation.", "type": "string" }, "type": { "$ref": "#/components/schemas/EorContractsContractIdAmendmentsAmendmentIdConfirmPostResponsesContentApplicationJsonSchemaDataVariableCompensationType", "description": "The way the compensation is calculated. `FIXED` means a fixed amount (like $1000). `PERCENTAGE` means it’s based on a percentage of the salary." }, "updated_at": { "description": "The date and time when this record was last updated.", "format": "date-time", "type": "string" } }, "required": [ "id", "type", "title", "amount", "timeline", "parent_id", "created_at", "updated_at", "effective_date" ], "title": "EorContractsContractIdAmendmentsAmendmentIdConfirmPostResponsesContentApplicationJsonSchemaDataVariableCompensation", "type": "object" }, "EorContractsContractIdAmendmentsAmendmentIdConfirmPostResponsesContentApplicationJsonSchemaDataVariableCompensationIncentivePlan": { "description": "Details of the incentive plan linked to this compensation, if any.", "properties": { "details": { "description": "Extra details about the incentive plan, if any.", "type": "string" }, "employee_signature": { "description": "The employee’s signature for the incentive plan, if collected.", "type": "string" }, "employee_signed_at": { "description": "The date and time when the employee signed the incentive plan. Empty if not signed.", "format": "date-time", "type": "string" } }, "title": "EorContractsContractIdAmendmentsAmendmentIdConfirmPostResponsesContentApplicationJsonSchemaDataVariableCompensationIncentivePlan", "type": "object" }, "EorContractsContractIdAmendmentsAmendmentIdConfirmPostResponsesContentApplicationJsonSchemaDataVariableCompensationTimeline": { "description": "How often the compensation is paid — for example monthly, quarterly, annually, or twice a year.", "enum": [ "MONTHLY", "QUARTERLY", "ANNUALLY", "BIANNUALLY" ], "title": "EorContractsContractIdAmendmentsAmendmentIdConfirmPostResponsesContentApplicationJsonSchemaDataVariableCompensationTimeline", "type": "string" }, "EorContractsContractIdAmendmentsAmendmentIdConfirmPostResponsesContentApplicationJsonSchemaDataVariableCompensationType": { "description": "The way the compensation is calculated. `FIXED` means a fixed amount (like $1000). `PERCENTAGE` means it’s based on a percentage of the salary.", "enum": [ "FIXED", "PERCENTAGE" ], "title": "EorContractsContractIdAmendmentsAmendmentIdConfirmPostResponsesContentApplicationJsonSchemaDataVariableCompensationType", "type": "string" }, "EorContractsContractIdAmendmentsAmendmentIdConfirmPostResponsesContentApplicationJsonSchemaDataVoidDeadlineType": { "description": "Type of void deadline", "enum": [ "CUTOFF", "START_DATE", "END_DATE", "EXPIRY" ], "title": "EorContractsContractIdAmendmentsAmendmentIdConfirmPostResponsesContentApplicationJsonSchemaDataVoidDeadlineType", "type": "string" }, "EorContractsContractIdAmendmentsAmendmentIdConfirmPostResponsesContentApplicationJsonSchemaErrorsItems": { "properties": { "code": { "type": "string" }, "message": { "type": "string" } }, "required": [ "code", "message" ], "title": "EorContractsContractIdAmendmentsAmendmentIdConfirmPostResponsesContentApplicationJsonSchemaErrorsItems", "type": "object" }, "EorContractsContractIdAmendmentsAmendmentIdDeleteResponsesContentApplicationJsonSchemaData": { "properties": { "success": { "description": "Whether the amendment was deleted.", "type": "boolean" } }, "required": [ "success" ], "title": "EorContractsContractIdAmendmentsAmendmentIdDeleteResponsesContentApplicationJsonSchemaData", "type": "object" }, "EorContractsContractIdAmendmentsAmendmentIdDeleteResponsesContentApplicationJsonSchemaErrorsItems": { "properties": { "code": { "type": "string" }, "message": { "type": "string" } }, "required": [ "code", "message" ], "title": "EorContractsContractIdAmendmentsAmendmentIdDeleteResponsesContentApplicationJsonSchemaErrorsItems", "type": "object" }, "EorContractsContractIdAmendmentsAmendmentIdEffectiveDateLimitationsGetResponsesContentApplicationJsonSchemaData": { "properties": { "default_effective_date": { "description": "A default effective date suggested by the system", "format": "date-time", "type": [ "string", "null" ] }, "is_disabled": { "description": "Indicates if the effective date field is disabled", "type": "boolean" }, "is_hidden": { "description": "Indicates if the effective date field should be hidden.", "type": "boolean" }, "max_effective_date": { "description": "The latest valid effective date", "format": "date-time", "type": [ "string", "null" ] }, "message": { "description": "Optional human-readable additional explanation on effective date limitation", "type": "string" }, "min_effective_date": { "description": "The earliest valid effective date", "format": "date-time", "type": [ "string", "null" ] } }, "title": "EorContractsContractIdAmendmentsAmendmentIdEffectiveDateLimitationsGetResponsesContentApplicationJsonSchemaData", "type": "object" }, "EorContractsContractIdAmendmentsAmendmentIdEffectiveDateLimitationsGetResponsesContentApplicationJsonSchemaErrorsItems": { "properties": { "code": { "type": "string" }, "message": { "type": "string" } }, "required": [ "code", "message" ], "title": "EorContractsContractIdAmendmentsAmendmentIdEffectiveDateLimitationsGetResponsesContentApplicationJsonSchemaErrorsItems", "type": "object" }, "EorContractsContractIdAmendmentsAmendmentIdGetResponsesContentApplicationJsonSchemaData": { "properties": { "amendment_statuses": { "description": "List of amendment statuses representing the history and progression of an amendment.", "items": { "$ref": "#/components/schemas/EorContractsContractIdAmendmentsAmendmentIdGetResponsesContentApplicationJsonSchemaDataAmendmentStatusesItems" }, "type": "array" }, "created_at": { "description": "Creation date of the amendment.", "format": "date-time", "type": "string" }, "currency": { "description": "Contract currency.", "type": "string" }, "custom_items": { "description": "Custom amendment items associated with the amendment flow", "items": { "$ref": "#/components/schemas/EorContractsContractIdAmendmentsAmendmentIdGetResponsesContentApplicationJsonSchemaDataCustomItemsItems" }, "type": "array" }, "description": { "description": "Free-text description of the amendment.", "type": [ "string", "null" ] }, "document_type": { "description": "Amendment document type", "oneOf": [ { "$ref": "#/components/schemas/EorContractsContractIdAmendmentsAmendmentIdGetResponsesContentApplicationJsonSchemaDataDocumentType" }, { "type": "null" } ] }, "effective_date": { "description": "Effective date of the amendment.", "format": "date-time", "type": [ "string", "null" ] }, "employee_nationality": { "description": "Nationality of the employee.", "type": "string" }, "employment_state": { "description": "State of employment.", "type": [ "string", "null" ] }, "employment_type": { "$ref": "#/components/schemas/EorContractsContractIdAmendmentsAmendmentIdGetResponsesContentApplicationJsonSchemaDataEmploymentType", "description": "Type of employment." }, "end_date": { "description": "End date of the employment.", "format": "date-time", "type": [ "string", "null" ] }, "fixed_adjustments": { "description": "List of fixed adjustments associated with the amendment request.", "items": { "$ref": "#/components/schemas/EorContractsContractIdAmendmentsAmendmentIdGetResponsesContentApplicationJsonSchemaDataFixedAdjustmentsItems" }, "type": "array" }, "holidays": { "description": "Number of holidays.", "type": [ "integer", "null" ] }, "hourly_rate": { "description": "Hourly rate of the amendment", "type": [ "string", "null" ] }, "id": { "description": "Id of amendment", "format": "uuid", "type": "string" }, "is_effective_date_updated": { "description": "Is Effective Date updated.", "type": "boolean" }, "is_hrx_action_needed": { "description": "Is HRX action needed.", "type": "boolean" }, "items": { "description": "Items of amendment", "items": { "$ref": "#/components/schemas/EorContractsContractIdAmendmentsAmendmentIdGetResponsesContentApplicationJsonSchemaDataItemsItems" }, "type": "array" }, "job_category": { "description": "Job category associated with the job title.", "type": [ "string", "null" ] }, "job_code": { "description": "Job code associated with the job title.", "type": [ "string", "null" ] }, "job_title": { "description": "Job title associated with the amendment.", "maxLength": 1000, "type": "string" }, "legal_context": { "description": "Additional details needed for legal input", "oneOf": [ { "$ref": "#/components/schemas/EorContractsContractIdAmendmentsAmendmentIdGetResponsesContentApplicationJsonSchemaDataLegalContext" }, { "type": "null" } ] }, "net_salary": { "description": "Net salary for the amendment.", "type": [ "string", "null" ] }, "notice_period_after_probation": { "description": "Notice period after probation.", "type": [ "string", "null" ] }, "notice_period_during_probation": { "description": "Notice period during probation.", "type": [ "string", "null" ] }, "notice_period_time_unit": { "description": "Notice period time unit.", "oneOf": [ { "$ref": "#/components/schemas/EorContractsContractIdAmendmentsAmendmentIdGetResponsesContentApplicationJsonSchemaDataNoticePeriodTimeUnit" }, { "type": "null" } ] }, "notice_period_type": { "description": "Type of notice period.", "oneOf": [ { "$ref": "#/components/schemas/EorContractsContractIdAmendmentsAmendmentIdGetResponsesContentApplicationJsonSchemaDataNoticePeriodType" }, { "type": "null" } ] }, "probation_period": { "description": "Duration of the probation period.", "type": [ "integer", "null" ] }, "probation_period_type_for_definite": { "description": "Type of probation period for definite contracts.", "oneOf": [ { "$ref": "#/components/schemas/EorContractsContractIdAmendmentsAmendmentIdGetResponsesContentApplicationJsonSchemaDataProbationPeriodTypeForDefinite" }, { "type": "null" } ] }, "rejection_context": { "description": "Additional details containing rejection reason", "oneOf": [ { "$ref": "#/components/schemas/EorContractsContractIdAmendmentsAmendmentIdGetResponsesContentApplicationJsonSchemaDataRejectionContext" }, { "type": "null" } ] }, "requested_by": { "description": "Profile name of the user who requested the change", "type": [ "string", "null" ] }, "salary": { "description": "Salary for the amendment.", "type": "string" }, "scope": { "description": "Scope of the amendment.", "type": "string" }, "seniority_date": { "description": "The seniority date represents the employee’s original start date with a previous employer. It is used to preserve employment tenure when the employee transfers to this company. Can be null if not applicable.", "format": "date", "type": [ "string", "null" ] }, "seniority_id": { "description": "Seniority level identifier.", "format": "uuid", "type": [ "string", "null" ] }, "sick_leave_days": { "description": "Number of sick leave days", "type": [ "integer", "null" ] }, "source": { "description": "Source of amendment flow creation.", "oneOf": [ { "$ref": "#/components/schemas/EorContractsContractIdAmendmentsAmendmentIdGetResponsesContentApplicationJsonSchemaDataSource" }, { "type": "null" } ] }, "start_date": { "description": "Start date of the employment.", "format": "date-time", "type": "string" }, "time_off_type": { "$ref": "#/components/schemas/EorContractsContractIdAmendmentsAmendmentIdGetResponsesContentApplicationJsonSchemaDataTimeOffType", "description": "Type of time off." }, "type": { "description": "Type of amendment", "oneOf": [ { "$ref": "#/components/schemas/EorContractsContractIdAmendmentsAmendmentIdGetResponsesContentApplicationJsonSchemaDataType" }, { "type": "null" } ] }, "updated_at": { "description": "Date when amendment is updated", "format": "date-time", "type": "string" }, "variable_compensation": { "$ref": "#/components/schemas/EorContractsContractIdAmendmentsAmendmentIdGetResponsesContentApplicationJsonSchemaDataVariableCompensation", "description": "Represents a variable compensation record (such as a bonus, commission, or incentive) within a contract. It contains details like the amount, type, frequency, and whether it is part of an incentive plan. The record also tracks when it was created, updated, and whether it has been amended." }, "void_deadline": { "description": "Deadline this SOW to be voided", "format": "date-time", "type": [ "string", "null" ] }, "void_deadline_type": { "description": "Type of void deadline", "oneOf": [ { "$ref": "#/components/schemas/EorContractsContractIdAmendmentsAmendmentIdGetResponsesContentApplicationJsonSchemaDataVoidDeadlineType" }, { "type": "null" } ] }, "work_hours_per_week": { "description": "Number of work hours per week.", "type": "string" }, "work_schedule_id": { "description": "Work schedule id", "format": "uuid", "type": [ "string", "null" ] }, "work_schedule_rules_version": { "description": "Work schedule rule version.", "type": [ "string", "null" ] } }, "title": "EorContractsContractIdAmendmentsAmendmentIdGetResponsesContentApplicationJsonSchemaData", "type": "object" }, "EorContractsContractIdAmendmentsAmendmentIdGetResponsesContentApplicationJsonSchemaDataAmendmentStatusesItems": { "description": "Details of a specific amendment status in the lifecycle of the amendment.", "properties": { "amendment_flow_status": { "$ref": "#/components/schemas/EorContractsContractIdAmendmentsAmendmentIdGetResponsesContentApplicationJsonSchemaDataAmendmentStatusesItemsAmendmentFlowStatus", "description": "Metadata about the amendment status, including when it was created." }, "friendly_name": { "description": "Human-readable label of the amendment status (e.g., DRAFT, PENDING, APPROVED).", "type": "string" }, "name": { "description": "Logical, system-oriented identifier of the amendment status. Can be used to group statuses under a parent category and subgroup them for more granular state tracking. The structure typically follows a dot-separated hierarchy (e.g., 'PARENT','PARENT.CHILD', 'PARENT.CHILD.CHILD.CHILD', ...), which allows logical grouping and filtering of related statuses.", "type": "string" } }, "title": "EorContractsContractIdAmendmentsAmendmentIdGetResponsesContentApplicationJsonSchemaDataAmendmentStatusesItems", "type": "object" }, "EorContractsContractIdAmendmentsAmendmentIdGetResponsesContentApplicationJsonSchemaDataAmendmentStatusesItemsAmendmentFlowStatus": { "description": "Metadata about the amendment status, including when it was created.", "properties": { "created_at": { "description": "The timestamp when this amendment status was created.", "format": "date-time", "type": "string" } }, "title": "EorContractsContractIdAmendmentsAmendmentIdGetResponsesContentApplicationJsonSchemaDataAmendmentStatusesItemsAmendmentFlowStatus", "type": "object" }, "EorContractsContractIdAmendmentsAmendmentIdGetResponsesContentApplicationJsonSchemaDataCustomItemsItems": { "properties": { "description": { "description": "Detailed description of the custom amendment item", "type": [ "string", "null" ] }, "id": { "description": "Unique identifier for the custom amendment item", "format": "uuid", "type": "string" }, "rejection_reason": { "description": "Reason for rejection if the item was rejected", "type": [ "string", "null" ] }, "status": { "$ref": "#/components/schemas/EorContractsContractIdAmendmentsAmendmentIdGetResponsesContentApplicationJsonSchemaDataCustomItemsItemsStatus", "description": "Current status of the custom amendment item" }, "type": { "description": "Type/context of the custom amendment item", "type": "string" } }, "required": [ "id", "type", "status" ], "title": "EorContractsContractIdAmendmentsAmendmentIdGetResponsesContentApplicationJsonSchemaDataCustomItemsItems", "type": "object" }, "EorContractsContractIdAmendmentsAmendmentIdGetResponsesContentApplicationJsonSchemaDataCustomItemsItemsStatus": { "description": "Current status of the custom amendment item", "enum": [ "REJECTED", "APPROVED", "PENDING_REVIEW", "PENDING_LEGAL" ], "title": "EorContractsContractIdAmendmentsAmendmentIdGetResponsesContentApplicationJsonSchemaDataCustomItemsItemsStatus", "type": "string" }, "EorContractsContractIdAmendmentsAmendmentIdGetResponsesContentApplicationJsonSchemaDataDocumentType": { "description": "Amendment document type", "enum": [ "EA", "SOW", "SOW_EA" ], "title": "EorContractsContractIdAmendmentsAmendmentIdGetResponsesContentApplicationJsonSchemaDataDocumentType", "type": "string" }, "EorContractsContractIdAmendmentsAmendmentIdGetResponsesContentApplicationJsonSchemaDataEmploymentType": { "description": "Type of employment.", "enum": [ "FULL_TIME", "PART_TIME" ], "title": "EorContractsContractIdAmendmentsAmendmentIdGetResponsesContentApplicationJsonSchemaDataEmploymentType", "type": "string" }, "EorContractsContractIdAmendmentsAmendmentIdGetResponsesContentApplicationJsonSchemaDataFixedAdjustmentsItems": { "properties": { "created_at": { "description": "Timestamp when the fixed adjustment was created.", "format": "date-time", "type": "string" }, "description": { "description": "Description of the fixed adjustment.", "maxLength": 256, "minLength": 1, "type": "string" }, "id": { "description": "System-generated unique identifier for the fixed adjustment record in an amendment request.", "type": "string" }, "is_amended": { "description": "Whether this fixed adjustment was amended from a previous one.", "type": "boolean" }, "is_country_specific": { "description": "Whether this fixed adjustment applies only to a specific country.", "type": "boolean" }, "is_deleted": { "description": "True if the fixed adjustment was deleted as part of the amendment; otherwise false.", "type": "boolean" }, "is_recurring": { "description": "Whether the fixed adjustment is recurring. If set to false, it will be treated as a one-time fixed allowance.", "type": "boolean" }, "parent_fixed_adjustment_id": { "description": "Reference to the parent fixed adjustment, if applicable.", "type": [ "string", "null" ] }, "status": { "$ref": "#/components/schemas/EorContractsContractIdAmendmentsAmendmentIdGetResponsesContentApplicationJsonSchemaDataFixedAdjustmentsItemsStatus", "description": "Current status of the fixed adjustment." }, "updated_at": { "description": "Timestamp when the fixed adjustment was last updated.", "format": "date-time", "type": "string" }, "value": { "description": "Value of the fixed adjustment.", "pattern": "^(?!0+(\\.0+)?$)\\d+(?:\\.\\d+)?$", "type": "string" } }, "required": [ "id", "value", "status", "created_at", "is_amended", "updated_at", "description", "is_recurring", "is_country_specific" ], "title": "EorContractsContractIdAmendmentsAmendmentIdGetResponsesContentApplicationJsonSchemaDataFixedAdjustmentsItems", "type": "object" }, "EorContractsContractIdAmendmentsAmendmentIdGetResponsesContentApplicationJsonSchemaDataFixedAdjustmentsItemsStatus": { "description": "Current status of the fixed adjustment.", "enum": [ "WAITING_FOR_SIGNING", "ACTIVE", "OUTDATED", "CANCELLED" ], "title": "EorContractsContractIdAmendmentsAmendmentIdGetResponsesContentApplicationJsonSchemaDataFixedAdjustmentsItemsStatus", "type": "string" }, "EorContractsContractIdAmendmentsAmendmentIdGetResponsesContentApplicationJsonSchemaDataItemsItems": { "properties": { "data_point": { "description": "The field that is selected for amendment.", "type": "string" }, "id": { "description": "Id of amendment item", "format": "uuid", "type": "string" }, "item": { "description": "Amendment item", "type": "string" }, "new_value": { "description": "The new valid value after the attempted change.", "type": "string" }, "previous_value": { "description": "The previous valid value before the attempted change.", "type": "string" }, "type": { "$ref": "#/components/schemas/EorContractsContractIdAmendmentsAmendmentIdGetResponsesContentApplicationJsonSchemaDataItemsItemsType", "description": "Type of amendment" } }, "title": "EorContractsContractIdAmendmentsAmendmentIdGetResponsesContentApplicationJsonSchemaDataItemsItems", "type": "object" }, "EorContractsContractIdAmendmentsAmendmentIdGetResponsesContentApplicationJsonSchemaDataItemsItemsType": { "description": "Type of amendment", "enum": [ "INSTANT", "OPS", "LEGAL", "DISABLED", "CUSTOM", "AUTOMATED" ], "title": "EorContractsContractIdAmendmentsAmendmentIdGetResponsesContentApplicationJsonSchemaDataItemsItemsType", "type": "string" }, "EorContractsContractIdAmendmentsAmendmentIdGetResponsesContentApplicationJsonSchemaDataLegalContext": { "description": "Additional details needed for legal input", "properties": { "details": { "description": "Details regarding the legal request", "type": "string" }, "jira_ticket": { "description": "Jira ticket identifier linked to the legal context", "type": "string" }, "jira_web_url": { "description": "Link to the Jira ticket for tracking", "format": "uri", "type": "string" }, "requested_at": { "description": "Timestamp when legal review was requested", "format": "date-time", "type": "string" }, "status": { "$ref": "#/components/schemas/EorContractsContractIdAmendmentsAmendmentIdGetResponsesContentApplicationJsonSchemaDataLegalContextStatus", "description": "Current status of the legal review process" } }, "title": "EorContractsContractIdAmendmentsAmendmentIdGetResponsesContentApplicationJsonSchemaDataLegalContext", "type": "object" }, "EorContractsContractIdAmendmentsAmendmentIdGetResponsesContentApplicationJsonSchemaDataLegalContextStatus": { "description": "Current status of the legal review process", "enum": [ "REQUEST_LEGAL_REVIEW", "WAITING_FOR_ANOTHER_TEAM", "WAITING_FOR_HRX_ACTION", "DECLINED", "SOLVED" ], "title": "EorContractsContractIdAmendmentsAmendmentIdGetResponsesContentApplicationJsonSchemaDataLegalContextStatus", "type": "string" }, "EorContractsContractIdAmendmentsAmendmentIdGetResponsesContentApplicationJsonSchemaDataNoticePeriodTimeUnit": { "description": "Notice period time unit.", "enum": [ "DAY", "WEEK", "MONTH" ], "title": "EorContractsContractIdAmendmentsAmendmentIdGetResponsesContentApplicationJsonSchemaDataNoticePeriodTimeUnit", "type": "string" }, "EorContractsContractIdAmendmentsAmendmentIdGetResponsesContentApplicationJsonSchemaDataNoticePeriodType": { "description": "Type of notice period.", "enum": [ "STANDARD", "CUSTOM" ], "title": "EorContractsContractIdAmendmentsAmendmentIdGetResponsesContentApplicationJsonSchemaDataNoticePeriodType", "type": "string" }, "EorContractsContractIdAmendmentsAmendmentIdGetResponsesContentApplicationJsonSchemaDataProbationPeriodTypeForDefinite": { "description": "Type of probation period for definite contracts.", "enum": [ "STANDARD", "CUSTOM" ], "title": "EorContractsContractIdAmendmentsAmendmentIdGetResponsesContentApplicationJsonSchemaDataProbationPeriodTypeForDefinite", "type": "string" }, "EorContractsContractIdAmendmentsAmendmentIdGetResponsesContentApplicationJsonSchemaDataRejectionContext": { "description": "Additional details containing rejection reason", "properties": { "rejected_at": { "description": "Timestamp of when the rejection occurred", "format": "date-time", "type": "string" }, "rejection_reason": { "description": "Reason provided when the amendment was rejected. Null when the amendment was cancelled rather than rejected by an admin.", "type": [ "string", "null" ] } }, "title": "EorContractsContractIdAmendmentsAmendmentIdGetResponsesContentApplicationJsonSchemaDataRejectionContext", "type": "object" }, "EorContractsContractIdAmendmentsAmendmentIdGetResponsesContentApplicationJsonSchemaDataSource": { "description": "Source of amendment flow creation.", "enum": [ "APP", "PUBLIC_API", "APP_BULK_AMENDMENT" ], "title": "EorContractsContractIdAmendmentsAmendmentIdGetResponsesContentApplicationJsonSchemaDataSource", "type": "string" }, "EorContractsContractIdAmendmentsAmendmentIdGetResponsesContentApplicationJsonSchemaDataTimeOffType": { "description": "Type of time off.", "enum": [ "STANDARD", "SPECIFIC", "PRORATED" ], "title": "EorContractsContractIdAmendmentsAmendmentIdGetResponsesContentApplicationJsonSchemaDataTimeOffType", "type": "string" }, "EorContractsContractIdAmendmentsAmendmentIdGetResponsesContentApplicationJsonSchemaDataType": { "description": "Type of amendment", "enum": [ "INSTANT", "OPS", "LEGAL", "DISABLED", "CUSTOM", "AUTOMATED" ], "title": "EorContractsContractIdAmendmentsAmendmentIdGetResponsesContentApplicationJsonSchemaDataType", "type": "string" }, "EorContractsContractIdAmendmentsAmendmentIdGetResponsesContentApplicationJsonSchemaDataVariableCompensation": { "description": "Represents a variable compensation record (such as a bonus, commission, or incentive) within a contract. It contains details like the amount, type, frequency, and whether it is part of an incentive plan. The record also tracks when it was created, updated, and whether it has been amended.", "properties": { "amount": { "description": "The value of the compensation. Shown as a string to keep the exact number of decimals.", "format": "decimal", "type": "string" }, "created_at": { "description": "The date and time when this record was first created in the system.", "format": "date-time", "type": "string" }, "effective_date": { "description": "The date when this compensation starts being valid.", "format": "date-time", "type": "string" }, "id": { "description": "The unique ID assigned by the system to this variable compensation record.", "type": "string" }, "incentive_plan": { "$ref": "#/components/schemas/EorContractsContractIdAmendmentsAmendmentIdGetResponsesContentApplicationJsonSchemaDataVariableCompensationIncentivePlan", "description": "Details of the incentive plan linked to this compensation, if any." }, "is_amended": { "description": "Shows whether this compensation has been changed as part of an amendment.", "type": "boolean" }, "is_deleted": { "description": "Shows whether this compensation has been deleted.", "type": "boolean" }, "parent_id": { "description": "Reference to the parent variable compensation, if applicable. Null if this compensation is not linked to any compensation.", "type": [ "string", "null" ] }, "timeline": { "$ref": "#/components/schemas/EorContractsContractIdAmendmentsAmendmentIdGetResponsesContentApplicationJsonSchemaDataVariableCompensationTimeline", "description": "How often the compensation is paid — for example monthly, quarterly, annually, or twice a year." }, "title": { "description": "Title or name of the variable compensation.", "type": "string" }, "type": { "$ref": "#/components/schemas/EorContractsContractIdAmendmentsAmendmentIdGetResponsesContentApplicationJsonSchemaDataVariableCompensationType", "description": "The way the compensation is calculated. `FIXED` means a fixed amount (like $1000). `PERCENTAGE` means it’s based on a percentage of the salary." }, "updated_at": { "description": "The date and time when this record was last updated.", "format": "date-time", "type": "string" } }, "required": [ "id", "type", "title", "amount", "timeline", "parent_id", "created_at", "updated_at", "effective_date" ], "title": "EorContractsContractIdAmendmentsAmendmentIdGetResponsesContentApplicationJsonSchemaDataVariableCompensation", "type": "object" }, "EorContractsContractIdAmendmentsAmendmentIdGetResponsesContentApplicationJsonSchemaDataVariableCompensationIncentivePlan": { "description": "Details of the incentive plan linked to this compensation, if any.", "properties": { "details": { "description": "Extra details about the incentive plan, if any.", "type": "string" }, "employee_signature": { "description": "The employee’s signature for the incentive plan, if collected.", "type": "string" }, "employee_signed_at": { "description": "The date and time when the employee signed the incentive plan. Empty if not signed.", "format": "date-time", "type": "string" } }, "title": "EorContractsContractIdAmendmentsAmendmentIdGetResponsesContentApplicationJsonSchemaDataVariableCompensationIncentivePlan", "type": "object" }, "EorContractsContractIdAmendmentsAmendmentIdGetResponsesContentApplicationJsonSchemaDataVariableCompensationTimeline": { "description": "How often the compensation is paid — for example monthly, quarterly, annually, or twice a year.", "enum": [ "MONTHLY", "QUARTERLY", "ANNUALLY", "BIANNUALLY" ], "title": "EorContractsContractIdAmendmentsAmendmentIdGetResponsesContentApplicationJsonSchemaDataVariableCompensationTimeline", "type": "string" }, "EorContractsContractIdAmendmentsAmendmentIdGetResponsesContentApplicationJsonSchemaDataVariableCompensationType": { "description": "The way the compensation is calculated. `FIXED` means a fixed amount (like $1000). `PERCENTAGE` means it’s based on a percentage of the salary.", "enum": [ "FIXED", "PERCENTAGE" ], "title": "EorContractsContractIdAmendmentsAmendmentIdGetResponsesContentApplicationJsonSchemaDataVariableCompensationType", "type": "string" }, "EorContractsContractIdAmendmentsAmendmentIdGetResponsesContentApplicationJsonSchemaDataVoidDeadlineType": { "description": "Type of void deadline", "enum": [ "CUTOFF", "START_DATE", "END_DATE", "EXPIRY" ], "title": "EorContractsContractIdAmendmentsAmendmentIdGetResponsesContentApplicationJsonSchemaDataVoidDeadlineType", "type": "string" }, "EorContractsContractIdAmendmentsAmendmentIdGetResponsesContentApplicationJsonSchemaErrorsItems": { "properties": { "code": { "type": "string" }, "message": { "type": "string" } }, "required": [ "code", "message" ], "title": "EorContractsContractIdAmendmentsAmendmentIdGetResponsesContentApplicationJsonSchemaErrorsItems", "type": "object" }, "EorContractsContractIdAmendmentsAmendmentIdPatchRequestBodyContentApplicationJsonSchemaData": { "properties": { "additional_info": { "description": "Additional metadata related to job validation and categorisation", "oneOf": [ { "$ref": "#/components/schemas/EorContractsContractIdAmendmentsAmendmentIdPatchRequestBodyContentApplicationJsonSchemaDataAdditionalInfo" }, { "type": "null" } ] }, "custom": { "description": "An optional array of custom objects.", "items": { "$ref": "#/components/schemas/EorContractsContractIdAmendmentsAmendmentIdPatchRequestBodyContentApplicationJsonSchemaDataCustomItems" }, "type": "array" }, "effective_date": { "description": "Effective date for the amendment.", "format": "date", "type": "string" }, "employment_state": { "description": "State of employment.", "type": "string" }, "employment_type": { "$ref": "#/components/schemas/EorContractsContractIdAmendmentsAmendmentIdPatchRequestBodyContentApplicationJsonSchemaDataEmploymentType", "description": "Type of employment." }, "end_date": { "description": "End date of the employment.", "format": "date", "type": "string" }, "fixed_adjustments": { "description": "Array of fixed adjustments to be submitted for the amendment request.", "items": { "$ref": "#/components/schemas/EorContractsContractIdAmendmentsAmendmentIdPatchRequestBodyContentApplicationJsonSchemaDataFixedAdjustmentsItems" }, "type": "array" }, "holidays": { "description": "Number of holidays.", "format": "double", "type": "number" }, "hourly_rate": { "description": "Hourly rate of the amendment. The max value supported is 1e19", "format": "double", "type": "number" }, "job_title": { "description": "Job title associated with the amendment.", "maxLength": 1000, "type": "string" }, "notice_period_after_probation": { "description": "Notice period after probation.", "format": "double", "type": "number" }, "notice_period_during_probation": { "description": "Notice period during probation.", "format": "double", "type": "number" }, "notice_period_type": { "$ref": "#/components/schemas/EorContractsContractIdAmendmentsAmendmentIdPatchRequestBodyContentApplicationJsonSchemaDataNoticePeriodType", "description": "Type of notice period." }, "probation_period": { "description": "Duration of the probation period.", "format": "double", "type": "number" }, "probation_period_type_for_definite": { "$ref": "#/components/schemas/EorContractsContractIdAmendmentsAmendmentIdPatchRequestBodyContentApplicationJsonSchemaDataProbationPeriodTypeForDefinite", "description": "Type of probation period for definite contracts." }, "salary": { "description": "Salary for the amendment.", "format": "double", "type": "number" }, "scope": { "description": "Scope of the amendment.", "maxLength": 20000, "type": "string" }, "seniority_date": { "description": "The seniority date represents the employee’s original start date with a previous employer. It is used to preserve employment tenure when the employee transfers to this company. Can be null if not applicable.", "format": "date", "type": [ "string", "null" ] }, "seniority_id": { "description": "Public Id of the seniority level.", "format": "uuid", "type": "string" }, "start_date": { "description": "Start date of the employment.", "format": "date", "type": "string" }, "time_off_type": { "$ref": "#/components/schemas/EorContractsContractIdAmendmentsAmendmentIdPatchRequestBodyContentApplicationJsonSchemaDataTimeOffType", "description": "Type of time off." }, "variable_compensation": { "$ref": "#/components/schemas/EorContractsContractIdAmendmentsAmendmentIdPatchRequestBodyContentApplicationJsonSchemaDataVariableCompensation", "description": "Represents a change to an employee’s variable compensation (e.g., bonus or commission). This schema is used for creating new variable compensation items or updating existing ones. Some fields are required when creating, optional when updating, and forbidden when updating, as specified in each field description." }, "work_hours_per_week": { "description": "Number of work hours per week.", "format": "double", "type": "number" } }, "title": "EorContractsContractIdAmendmentsAmendmentIdPatchRequestBodyContentApplicationJsonSchemaData", "type": "object" }, "EorContractsContractIdAmendmentsAmendmentIdPatchRequestBodyContentApplicationJsonSchemaDataAdditionalInfo": { "description": "Additional metadata related to job validation and categorisation", "properties": { "ai_scope_check_public_id": { "description": "Identifier or flag for AI scope validation check", "format": "uuid", "type": "string" }, "job_categorization_log_id": { "description": "Identifier for job categorisation log", "format": "uuid", "type": "string" } }, "title": "EorContractsContractIdAmendmentsAmendmentIdPatchRequestBodyContentApplicationJsonSchemaDataAdditionalInfo", "type": "object" }, "EorContractsContractIdAmendmentsAmendmentIdPatchRequestBodyContentApplicationJsonSchemaDataCustomItems": { "properties": { "description": { "description": "A required description for the custom object.", "maxLength": 1000, "minLength": 50, "type": "string" }, "id": { "description": "An optional identifier for the custom object.", "format": "uuid", "type": "string" }, "type": { "description": "The type of the custom object. Must be one of the valid custom types.", "type": "string" } }, "required": [ "type", "description" ], "title": "EorContractsContractIdAmendmentsAmendmentIdPatchRequestBodyContentApplicationJsonSchemaDataCustomItems", "type": "object" }, "EorContractsContractIdAmendmentsAmendmentIdPatchRequestBodyContentApplicationJsonSchemaDataEmploymentType": { "description": "Type of employment.", "enum": [ "FULL_TIME", "PART_TIME" ], "title": "EorContractsContractIdAmendmentsAmendmentIdPatchRequestBodyContentApplicationJsonSchemaDataEmploymentType", "type": "string" }, "EorContractsContractIdAmendmentsAmendmentIdPatchRequestBodyContentApplicationJsonSchemaDataFixedAdjustmentsItems": { "properties": { "description": { "description": "Description of the fixed adjustment.", "maxLength": 256, "minLength": 1, "type": "string" }, "id": { "description": "The ID of an existing active fixed adjustment to update or delete. Include this in the request only if you are updating or deleting an existing adjustment. Do not include it when creating a new one.", "type": "string" }, "is_deleted": { "description": "Flag to mark the fixed adjustment as deleted. Required only when the fixed adjustment needs to be removed; omit it otherwise.", "type": "boolean" }, "is_recurring": { "description": "Whether the fixed adjustment is recurring. If set to false, it will be treated as a one-time fixed allowance.", "type": "boolean" }, "value": { "description": "Value of the fixed adjustment. Must be a positive number, not zero.", "pattern": "^(?!0+(\\.0+)?$)\\d+(?:\\.\\d+)?$", "type": "string" } }, "required": [ "value", "description", "is_recurring" ], "title": "EorContractsContractIdAmendmentsAmendmentIdPatchRequestBodyContentApplicationJsonSchemaDataFixedAdjustmentsItems", "type": "object" }, "EorContractsContractIdAmendmentsAmendmentIdPatchRequestBodyContentApplicationJsonSchemaDataNoticePeriodType": { "description": "Type of notice period.", "enum": [ "STANDARD", "CUSTOM" ], "title": "EorContractsContractIdAmendmentsAmendmentIdPatchRequestBodyContentApplicationJsonSchemaDataNoticePeriodType", "type": "string" }, "EorContractsContractIdAmendmentsAmendmentIdPatchRequestBodyContentApplicationJsonSchemaDataProbationPeriodTypeForDefinite": { "description": "Type of probation period for definite contracts.", "enum": [ "STANDARD", "CUSTOM" ], "title": "EorContractsContractIdAmendmentsAmendmentIdPatchRequestBodyContentApplicationJsonSchemaDataProbationPeriodTypeForDefinite", "type": "string" }, "EorContractsContractIdAmendmentsAmendmentIdPatchRequestBodyContentApplicationJsonSchemaDataTimeOffType": { "description": "Type of time off.", "enum": [ "STANDARD", "SPECIFIC", "PRORATED" ], "title": "EorContractsContractIdAmendmentsAmendmentIdPatchRequestBodyContentApplicationJsonSchemaDataTimeOffType", "type": "string" }, "EorContractsContractIdAmendmentsAmendmentIdPatchRequestBodyContentApplicationJsonSchemaDataVariableCompensation": { "description": "Represents a change to an employee’s variable compensation (e.g., bonus or commission). This schema is used for creating new variable compensation items or updating existing ones. Some fields are required when creating, optional when updating, and forbidden when updating, as specified in each field description.", "properties": { "amount": { "description": "Positive amount for the variable compensation.", "format": "double", "minimum": 0, "type": "number" }, "effective_date": { "description": "The date when this compensation starts or becomes effective. Required when creating a new compensation. Optional when updating an existing compensation.", "format": "date", "type": "string" }, "id": { "description": "The ID of an existing active variable compensation to update or delete. Include this in the request only if you are updating or deleting an existing compensation. Do not include it when creating a new one.", "type": "string" }, "is_deleted": { "description": "Flag to mark the variable compensation as deleted. Required only when the variable compensation needs to be removed; omit it otherwise", "type": "boolean" }, "timeline": { "$ref": "#/components/schemas/EorContractsContractIdAmendmentsAmendmentIdPatchRequestBodyContentApplicationJsonSchemaDataVariableCompensationTimeline", "description": "How often this compensation occurs. Required when creating a new compensation. Forbidden when updating an existing compensation." }, "title": { "description": "The title of the compensation. Required when creating a new compensation. Optional when updating an existing compensation.", "maxLength": 250, "minLength": 1, "type": "string" }, "type": { "$ref": "#/components/schemas/EorContractsContractIdAmendmentsAmendmentIdPatchRequestBodyContentApplicationJsonSchemaDataVariableCompensationType", "description": "Type of variable compensation." } }, "required": [ "type", "amount" ], "title": "EorContractsContractIdAmendmentsAmendmentIdPatchRequestBodyContentApplicationJsonSchemaDataVariableCompensation", "type": "object" }, "EorContractsContractIdAmendmentsAmendmentIdPatchRequestBodyContentApplicationJsonSchemaDataVariableCompensationTimeline": { "description": "How often this compensation occurs. Required when creating a new compensation. Forbidden when updating an existing compensation.", "enum": [ "MONTHLY", "QUARTERLY", "ANNUALLY", "BIANNUALLY" ], "title": "EorContractsContractIdAmendmentsAmendmentIdPatchRequestBodyContentApplicationJsonSchemaDataVariableCompensationTimeline", "type": "string" }, "EorContractsContractIdAmendmentsAmendmentIdPatchRequestBodyContentApplicationJsonSchemaDataVariableCompensationType": { "description": "Type of variable compensation.", "enum": [ "PERCENTAGE", "FIXED" ], "title": "EorContractsContractIdAmendmentsAmendmentIdPatchRequestBodyContentApplicationJsonSchemaDataVariableCompensationType", "type": "string" }, "EorContractsContractIdAmendmentsAmendmentIdPatchResponsesContentApplicationJsonSchemaData": { "properties": { "amendment_statuses": { "description": "List of amendment statuses representing the history and progression of an amendment.", "items": { "$ref": "#/components/schemas/EorContractsContractIdAmendmentsAmendmentIdPatchResponsesContentApplicationJsonSchemaDataAmendmentStatusesItems" }, "type": "array" }, "created_at": { "description": "Creation date of the amendment.", "format": "date-time", "type": "string" }, "currency": { "description": "Contract currency.", "type": "string" }, "custom_items": { "description": "Custom amendment items associated with the amendment flow", "items": { "$ref": "#/components/schemas/EorContractsContractIdAmendmentsAmendmentIdPatchResponsesContentApplicationJsonSchemaDataCustomItemsItems" }, "type": "array" }, "description": { "description": "Free-text description of the amendment.", "type": [ "string", "null" ] }, "document_type": { "description": "Amendment document type", "oneOf": [ { "$ref": "#/components/schemas/EorContractsContractIdAmendmentsAmendmentIdPatchResponsesContentApplicationJsonSchemaDataDocumentType" }, { "type": "null" } ] }, "effective_date": { "description": "Effective date of the amendment.", "format": "date-time", "type": [ "string", "null" ] }, "employee_nationality": { "description": "Nationality of the employee.", "type": "string" }, "employment_state": { "description": "State of employment.", "type": [ "string", "null" ] }, "employment_type": { "$ref": "#/components/schemas/EorContractsContractIdAmendmentsAmendmentIdPatchResponsesContentApplicationJsonSchemaDataEmploymentType", "description": "Type of employment." }, "end_date": { "description": "End date of the employment.", "format": "date-time", "type": [ "string", "null" ] }, "fixed_adjustments": { "description": "List of fixed adjustments associated with the amendment request.", "items": { "$ref": "#/components/schemas/EorContractsContractIdAmendmentsAmendmentIdPatchResponsesContentApplicationJsonSchemaDataFixedAdjustmentsItems" }, "type": "array" }, "holidays": { "description": "Number of holidays.", "type": [ "integer", "null" ] }, "hourly_rate": { "description": "Hourly rate of the amendment", "type": [ "string", "null" ] }, "id": { "description": "Id of amendment", "format": "uuid", "type": "string" }, "is_effective_date_updated": { "description": "Is Effective Date updated.", "type": "boolean" }, "is_hrx_action_needed": { "description": "Is HRX action needed.", "type": "boolean" }, "items": { "description": "Items of amendment", "items": { "$ref": "#/components/schemas/EorContractsContractIdAmendmentsAmendmentIdPatchResponsesContentApplicationJsonSchemaDataItemsItems" }, "type": "array" }, "job_category": { "description": "Job category associated with the job title.", "type": [ "string", "null" ] }, "job_code": { "description": "Job code associated with the job title.", "type": [ "string", "null" ] }, "job_title": { "description": "Job title associated with the amendment.", "maxLength": 1000, "type": "string" }, "legal_context": { "description": "Additional details needed for legal input", "oneOf": [ { "$ref": "#/components/schemas/EorContractsContractIdAmendmentsAmendmentIdPatchResponsesContentApplicationJsonSchemaDataLegalContext" }, { "type": "null" } ] }, "net_salary": { "description": "Net salary for the amendment.", "type": [ "string", "null" ] }, "notice_period_after_probation": { "description": "Notice period after probation.", "type": [ "string", "null" ] }, "notice_period_during_probation": { "description": "Notice period during probation.", "type": [ "string", "null" ] }, "notice_period_time_unit": { "description": "Notice period time unit.", "oneOf": [ { "$ref": "#/components/schemas/EorContractsContractIdAmendmentsAmendmentIdPatchResponsesContentApplicationJsonSchemaDataNoticePeriodTimeUnit" }, { "type": "null" } ] }, "notice_period_type": { "description": "Type of notice period.", "oneOf": [ { "$ref": "#/components/schemas/EorContractsContractIdAmendmentsAmendmentIdPatchResponsesContentApplicationJsonSchemaDataNoticePeriodType" }, { "type": "null" } ] }, "probation_period": { "description": "Duration of the probation period.", "type": [ "integer", "null" ] }, "probation_period_type_for_definite": { "description": "Type of probation period for definite contracts.", "oneOf": [ { "$ref": "#/components/schemas/EorContractsContractIdAmendmentsAmendmentIdPatchResponsesContentApplicationJsonSchemaDataProbationPeriodTypeForDefinite" }, { "type": "null" } ] }, "rejection_context": { "description": "Additional details containing rejection reason", "oneOf": [ { "$ref": "#/components/schemas/EorContractsContractIdAmendmentsAmendmentIdPatchResponsesContentApplicationJsonSchemaDataRejectionContext" }, { "type": "null" } ] }, "requested_by": { "description": "Profile name of the user who requested the change", "type": [ "string", "null" ] }, "salary": { "description": "Salary for the amendment.", "type": "string" }, "scope": { "description": "Scope of the amendment.", "type": "string" }, "seniority_date": { "description": "The seniority date represents the employee’s original start date with a previous employer. It is used to preserve employment tenure when the employee transfers to this company. Can be null if not applicable.", "format": "date", "type": [ "string", "null" ] }, "seniority_id": { "description": "Seniority level identifier.", "format": "uuid", "type": [ "string", "null" ] }, "sick_leave_days": { "description": "Number of sick leave days", "type": [ "integer", "null" ] }, "source": { "description": "Source of amendment flow creation.", "oneOf": [ { "$ref": "#/components/schemas/EorContractsContractIdAmendmentsAmendmentIdPatchResponsesContentApplicationJsonSchemaDataSource" }, { "type": "null" } ] }, "start_date": { "description": "Start date of the employment.", "format": "date-time", "type": "string" }, "time_off_type": { "$ref": "#/components/schemas/EorContractsContractIdAmendmentsAmendmentIdPatchResponsesContentApplicationJsonSchemaDataTimeOffType", "description": "Type of time off." }, "type": { "description": "Type of amendment", "oneOf": [ { "$ref": "#/components/schemas/EorContractsContractIdAmendmentsAmendmentIdPatchResponsesContentApplicationJsonSchemaDataType" }, { "type": "null" } ] }, "updated_at": { "description": "Date when amendment is updated", "format": "date-time", "type": "string" }, "variable_compensation": { "$ref": "#/components/schemas/EorContractsContractIdAmendmentsAmendmentIdPatchResponsesContentApplicationJsonSchemaDataVariableCompensation", "description": "Represents a variable compensation record (such as a bonus, commission, or incentive) within a contract. It contains details like the amount, type, frequency, and whether it is part of an incentive plan. The record also tracks when it was created, updated, and whether it has been amended." }, "void_deadline": { "description": "Deadline this SOW to be voided", "format": "date-time", "type": [ "string", "null" ] }, "void_deadline_type": { "description": "Type of void deadline", "oneOf": [ { "$ref": "#/components/schemas/EorContractsContractIdAmendmentsAmendmentIdPatchResponsesContentApplicationJsonSchemaDataVoidDeadlineType" }, { "type": "null" } ] }, "work_hours_per_week": { "description": "Number of work hours per week.", "type": "string" }, "work_schedule_id": { "description": "Work schedule id", "format": "uuid", "type": [ "string", "null" ] }, "work_schedule_rules_version": { "description": "Work schedule rule version.", "type": [ "string", "null" ] } }, "title": "EorContractsContractIdAmendmentsAmendmentIdPatchResponsesContentApplicationJsonSchemaData", "type": "object" }, "EorContractsContractIdAmendmentsAmendmentIdPatchResponsesContentApplicationJsonSchemaDataAmendmentStatusesItems": { "properties": { "amendment_flow_status": { "$ref": "#/components/schemas/EorContractsContractIdAmendmentsAmendmentIdPatchResponsesContentApplicationJsonSchemaDataAmendmentStatusesItemsAmendmentFlowStatus", "description": "Metadata about the amendment status, including when it was created." }, "friendly_name": { "description": "Friendly name of amendment status", "type": "string" }, "name": { "description": "Logical, system-oriented identifier of the amendment status. Can be used to group statuses under a parent category and subgroup them for more granular state tracking. The structure typically follows a dot-separated hierarchy (e.g., 'PARENT','PARENT.CHILD', 'PARENT.CHILD.CHILD.CHILD', ...), which allows logical grouping and filtering of related statuses.", "type": "string" } }, "title": "EorContractsContractIdAmendmentsAmendmentIdPatchResponsesContentApplicationJsonSchemaDataAmendmentStatusesItems", "type": "object" }, "EorContractsContractIdAmendmentsAmendmentIdPatchResponsesContentApplicationJsonSchemaDataAmendmentStatusesItemsAmendmentFlowStatus": { "description": "Metadata about the amendment status, including when it was created.", "properties": { "created_at": { "description": "Creation date", "format": "date-time", "type": "string" } }, "title": "EorContractsContractIdAmendmentsAmendmentIdPatchResponsesContentApplicationJsonSchemaDataAmendmentStatusesItemsAmendmentFlowStatus", "type": "object" }, "EorContractsContractIdAmendmentsAmendmentIdPatchResponsesContentApplicationJsonSchemaDataCustomItemsItems": { "properties": { "description": { "description": "Detailed description of the custom amendment item", "type": [ "string", "null" ] }, "id": { "description": "Unique identifier for the custom amendment item", "format": "uuid", "type": "string" }, "rejection_reason": { "description": "Reason for rejection if the item was rejected", "type": [ "string", "null" ] }, "status": { "$ref": "#/components/schemas/EorContractsContractIdAmendmentsAmendmentIdPatchResponsesContentApplicationJsonSchemaDataCustomItemsItemsStatus", "description": "Current status of the custom amendment item" }, "type": { "description": "Type/context of the custom amendment item", "type": "string" } }, "required": [ "id", "type", "status" ], "title": "EorContractsContractIdAmendmentsAmendmentIdPatchResponsesContentApplicationJsonSchemaDataCustomItemsItems", "type": "object" }, "EorContractsContractIdAmendmentsAmendmentIdPatchResponsesContentApplicationJsonSchemaDataCustomItemsItemsStatus": { "description": "Current status of the custom amendment item", "enum": [ "REJECTED", "APPROVED", "PENDING_REVIEW", "PENDING_LEGAL" ], "title": "EorContractsContractIdAmendmentsAmendmentIdPatchResponsesContentApplicationJsonSchemaDataCustomItemsItemsStatus", "type": "string" }, "EorContractsContractIdAmendmentsAmendmentIdPatchResponsesContentApplicationJsonSchemaDataDocumentType": { "description": "Amendment document type", "enum": [ "EA", "SOW", "SOW_EA" ], "title": "EorContractsContractIdAmendmentsAmendmentIdPatchResponsesContentApplicationJsonSchemaDataDocumentType", "type": "string" }, "EorContractsContractIdAmendmentsAmendmentIdPatchResponsesContentApplicationJsonSchemaDataEmploymentType": { "description": "Type of employment.", "enum": [ "FULL_TIME", "PART_TIME" ], "title": "EorContractsContractIdAmendmentsAmendmentIdPatchResponsesContentApplicationJsonSchemaDataEmploymentType", "type": "string" }, "EorContractsContractIdAmendmentsAmendmentIdPatchResponsesContentApplicationJsonSchemaDataFixedAdjustmentsItems": { "properties": { "created_at": { "description": "Timestamp when the fixed adjustment was created.", "format": "date-time", "type": "string" }, "description": { "description": "Description of the fixed adjustment.", "maxLength": 256, "minLength": 1, "type": "string" }, "id": { "description": "System-generated unique identifier for the fixed adjustment record in an amendment request.", "type": "string" }, "is_amended": { "description": "Whether this fixed adjustment was amended from a previous one.", "type": "boolean" }, "is_country_specific": { "description": "Whether this fixed adjustment applies only to a specific country.", "type": "boolean" }, "is_deleted": { "description": "True if the fixed adjustment was deleted as part of the amendment; otherwise false.", "type": "boolean" }, "is_recurring": { "description": "Whether the fixed adjustment is recurring. If set to false, it will be treated as a one-time fixed allowance.", "type": "boolean" }, "parent_fixed_adjustment_id": { "description": "Reference to the parent fixed adjustment, if applicable.", "type": [ "string", "null" ] }, "status": { "$ref": "#/components/schemas/EorContractsContractIdAmendmentsAmendmentIdPatchResponsesContentApplicationJsonSchemaDataFixedAdjustmentsItemsStatus", "description": "Current status of the fixed adjustment." }, "updated_at": { "description": "Timestamp when the fixed adjustment was last updated.", "format": "date-time", "type": "string" }, "value": { "description": "Value of the fixed adjustment.", "pattern": "^(?!0+(\\.0+)?$)\\d+(?:\\.\\d+)?$", "type": "string" } }, "required": [ "id", "value", "status", "created_at", "is_amended", "updated_at", "description", "is_recurring", "is_country_specific" ], "title": "EorContractsContractIdAmendmentsAmendmentIdPatchResponsesContentApplicationJsonSchemaDataFixedAdjustmentsItems", "type": "object" }, "EorContractsContractIdAmendmentsAmendmentIdPatchResponsesContentApplicationJsonSchemaDataFixedAdjustmentsItemsStatus": { "description": "Current status of the fixed adjustment.", "enum": [ "WAITING_FOR_SIGNING", "ACTIVE", "OUTDATED", "CANCELLED" ], "title": "EorContractsContractIdAmendmentsAmendmentIdPatchResponsesContentApplicationJsonSchemaDataFixedAdjustmentsItemsStatus", "type": "string" }, "EorContractsContractIdAmendmentsAmendmentIdPatchResponsesContentApplicationJsonSchemaDataItemsItems": { "properties": { "data_point": { "description": "The field that is selected for amendment.", "type": "string" }, "id": { "description": "Id of amendment item", "format": "uuid", "type": "string" }, "item": { "description": "Amendment item", "type": "string" }, "new_value": { "description": "The new valid value after the attempted change.", "type": "string" }, "previous_value": { "description": "The previous valid value before the attempted change.", "type": "string" }, "type": { "$ref": "#/components/schemas/EorContractsContractIdAmendmentsAmendmentIdPatchResponsesContentApplicationJsonSchemaDataItemsItemsType", "description": "Type of amendment" } }, "title": "EorContractsContractIdAmendmentsAmendmentIdPatchResponsesContentApplicationJsonSchemaDataItemsItems", "type": "object" }, "EorContractsContractIdAmendmentsAmendmentIdPatchResponsesContentApplicationJsonSchemaDataItemsItemsType": { "description": "Type of amendment", "enum": [ "INSTANT", "OPS", "LEGAL", "DISABLED", "CUSTOM", "AUTOMATED" ], "title": "EorContractsContractIdAmendmentsAmendmentIdPatchResponsesContentApplicationJsonSchemaDataItemsItemsType", "type": "string" }, "EorContractsContractIdAmendmentsAmendmentIdPatchResponsesContentApplicationJsonSchemaDataLegalContext": { "description": "Additional details needed for legal input", "properties": { "details": { "description": "Details regarding the legal request", "type": "string" }, "jira_ticket": { "description": "Jira ticket identifier linked to the legal context", "type": "string" }, "jira_web_url": { "description": "Link to the Jira ticket for tracking", "format": "uri", "type": "string" }, "requested_at": { "description": "Timestamp when legal review was requested", "format": "date-time", "type": "string" }, "status": { "$ref": "#/components/schemas/EorContractsContractIdAmendmentsAmendmentIdPatchResponsesContentApplicationJsonSchemaDataLegalContextStatus", "description": "Current status of the legal review process" } }, "title": "EorContractsContractIdAmendmentsAmendmentIdPatchResponsesContentApplicationJsonSchemaDataLegalContext", "type": "object" }, "EorContractsContractIdAmendmentsAmendmentIdPatchResponsesContentApplicationJsonSchemaDataLegalContextStatus": { "description": "Current status of the legal review process", "enum": [ "REQUEST_LEGAL_REVIEW", "WAITING_FOR_ANOTHER_TEAM", "WAITING_FOR_HRX_ACTION", "DECLINED", "SOLVED" ], "title": "EorContractsContractIdAmendmentsAmendmentIdPatchResponsesContentApplicationJsonSchemaDataLegalContextStatus", "type": "string" }, "EorContractsContractIdAmendmentsAmendmentIdPatchResponsesContentApplicationJsonSchemaDataNoticePeriodTimeUnit": { "description": "Notice period time unit.", "enum": [ "DAY", "WEEK", "MONTH" ], "title": "EorContractsContractIdAmendmentsAmendmentIdPatchResponsesContentApplicationJsonSchemaDataNoticePeriodTimeUnit", "type": "string" }, "EorContractsContractIdAmendmentsAmendmentIdPatchResponsesContentApplicationJsonSchemaDataNoticePeriodType": { "description": "Type of notice period.", "enum": [ "STANDARD", "CUSTOM" ], "title": "EorContractsContractIdAmendmentsAmendmentIdPatchResponsesContentApplicationJsonSchemaDataNoticePeriodType", "type": "string" }, "EorContractsContractIdAmendmentsAmendmentIdPatchResponsesContentApplicationJsonSchemaDataProbationPeriodTypeForDefinite": { "description": "Type of probation period for definite contracts.", "enum": [ "STANDARD", "CUSTOM" ], "title": "EorContractsContractIdAmendmentsAmendmentIdPatchResponsesContentApplicationJsonSchemaDataProbationPeriodTypeForDefinite", "type": "string" }, "EorContractsContractIdAmendmentsAmendmentIdPatchResponsesContentApplicationJsonSchemaDataRejectionContext": { "description": "Additional details containing rejection reason", "properties": { "rejected_at": { "description": "Timestamp of when the rejection occurred", "format": "date-time", "type": "string" }, "rejection_reason": { "description": "Reason provided when the amendment was rejected. Null when the amendment was cancelled rather than rejected by an admin.", "type": [ "string", "null" ] } }, "title": "EorContractsContractIdAmendmentsAmendmentIdPatchResponsesContentApplicationJsonSchemaDataRejectionContext", "type": "object" }, "EorContractsContractIdAmendmentsAmendmentIdPatchResponsesContentApplicationJsonSchemaDataSource": { "description": "Source of amendment flow creation.", "enum": [ "APP", "PUBLIC_API", "APP_BULK_AMENDMENT" ], "title": "EorContractsContractIdAmendmentsAmendmentIdPatchResponsesContentApplicationJsonSchemaDataSource", "type": "string" }, "EorContractsContractIdAmendmentsAmendmentIdPatchResponsesContentApplicationJsonSchemaDataTimeOffType": { "description": "Type of time off.", "enum": [ "STANDARD", "SPECIFIC", "PRORATED" ], "title": "EorContractsContractIdAmendmentsAmendmentIdPatchResponsesContentApplicationJsonSchemaDataTimeOffType", "type": "string" }, "EorContractsContractIdAmendmentsAmendmentIdPatchResponsesContentApplicationJsonSchemaDataType": { "description": "Type of amendment", "enum": [ "INSTANT", "OPS", "LEGAL", "DISABLED", "CUSTOM", "AUTOMATED" ], "title": "EorContractsContractIdAmendmentsAmendmentIdPatchResponsesContentApplicationJsonSchemaDataType", "type": "string" }, "EorContractsContractIdAmendmentsAmendmentIdPatchResponsesContentApplicationJsonSchemaDataVariableCompensation": { "description": "Represents a variable compensation record (such as a bonus, commission, or incentive) within a contract. It contains details like the amount, type, frequency, and whether it is part of an incentive plan. The record also tracks when it was created, updated, and whether it has been amended.", "properties": { "amount": { "description": "The value of the compensation. Shown as a string to keep the exact number of decimals.", "format": "decimal", "type": "string" }, "created_at": { "description": "The date and time when this record was first created in the system.", "format": "date-time", "type": "string" }, "effective_date": { "description": "The date when this compensation starts being valid.", "format": "date-time", "type": "string" }, "id": { "description": "The unique ID assigned by the system to this variable compensation record.", "type": "string" }, "incentive_plan": { "$ref": "#/components/schemas/EorContractsContractIdAmendmentsAmendmentIdPatchResponsesContentApplicationJsonSchemaDataVariableCompensationIncentivePlan", "description": "Details of the incentive plan linked to this compensation, if any." }, "is_amended": { "description": "Shows whether this compensation has been changed as part of an amendment.", "type": "boolean" }, "is_deleted": { "description": "Shows whether this compensation has been deleted.", "type": "boolean" }, "parent_id": { "description": "Reference to the parent variable compensation, if applicable. Null if this compensation is not linked to any compensation.", "type": [ "string", "null" ] }, "timeline": { "$ref": "#/components/schemas/EorContractsContractIdAmendmentsAmendmentIdPatchResponsesContentApplicationJsonSchemaDataVariableCompensationTimeline", "description": "How often the compensation is paid — for example monthly, quarterly, annually, or twice a year." }, "title": { "description": "Title or name of the variable compensation.", "type": "string" }, "type": { "$ref": "#/components/schemas/EorContractsContractIdAmendmentsAmendmentIdPatchResponsesContentApplicationJsonSchemaDataVariableCompensationType", "description": "The way the compensation is calculated. `FIXED` means a fixed amount (like $1000). `PERCENTAGE` means it’s based on a percentage of the salary." }, "updated_at": { "description": "The date and time when this record was last updated.", "format": "date-time", "type": "string" } }, "required": [ "id", "type", "title", "amount", "timeline", "parent_id", "created_at", "updated_at", "effective_date" ], "title": "EorContractsContractIdAmendmentsAmendmentIdPatchResponsesContentApplicationJsonSchemaDataVariableCompensation", "type": "object" }, "EorContractsContractIdAmendmentsAmendmentIdPatchResponsesContentApplicationJsonSchemaDataVariableCompensationIncentivePlan": { "description": "Details of the incentive plan linked to this compensation, if any.", "properties": { "details": { "description": "Extra details about the incentive plan, if any.", "type": "string" }, "employee_signature": { "description": "The employee’s signature for the incentive plan, if collected.", "type": "string" }, "employee_signed_at": { "description": "The date and time when the employee signed the incentive plan. Empty if not signed.", "format": "date-time", "type": "string" } }, "title": "EorContractsContractIdAmendmentsAmendmentIdPatchResponsesContentApplicationJsonSchemaDataVariableCompensationIncentivePlan", "type": "object" }, "EorContractsContractIdAmendmentsAmendmentIdPatchResponsesContentApplicationJsonSchemaDataVariableCompensationTimeline": { "description": "How often the compensation is paid — for example monthly, quarterly, annually, or twice a year.", "enum": [ "MONTHLY", "QUARTERLY", "ANNUALLY", "BIANNUALLY" ], "title": "EorContractsContractIdAmendmentsAmendmentIdPatchResponsesContentApplicationJsonSchemaDataVariableCompensationTimeline", "type": "string" }, "EorContractsContractIdAmendmentsAmendmentIdPatchResponsesContentApplicationJsonSchemaDataVariableCompensationType": { "description": "The way the compensation is calculated. `FIXED` means a fixed amount (like $1000). `PERCENTAGE` means it’s based on a percentage of the salary.", "enum": [ "FIXED", "PERCENTAGE" ], "title": "EorContractsContractIdAmendmentsAmendmentIdPatchResponsesContentApplicationJsonSchemaDataVariableCompensationType", "type": "string" }, "EorContractsContractIdAmendmentsAmendmentIdPatchResponsesContentApplicationJsonSchemaDataVoidDeadlineType": { "description": "Type of void deadline", "enum": [ "CUTOFF", "START_DATE", "END_DATE", "EXPIRY" ], "title": "EorContractsContractIdAmendmentsAmendmentIdPatchResponsesContentApplicationJsonSchemaDataVoidDeadlineType", "type": "string" }, "EorContractsContractIdAmendmentsAmendmentIdPatchResponsesContentApplicationJsonSchemaErrorsItems": { "properties": { "code": { "type": "string" }, "message": { "type": "string" } }, "required": [ "code", "message" ], "title": "EorContractsContractIdAmendmentsAmendmentIdPatchResponsesContentApplicationJsonSchemaErrorsItems", "type": "object" }, "EorContractsContractIdAmendmentsAmendmentIdPdfGetResponsesContentApplicationJsonSchemaData": { "properties": { "url": { "description": "Pre-signed URL to download the exported PDF (valid for 15 minutes).", "format": "uri", "type": "string" } }, "title": "EorContractsContractIdAmendmentsAmendmentIdPdfGetResponsesContentApplicationJsonSchemaData", "type": "object" }, "EorContractsContractIdAmendmentsAmendmentIdPdfGetResponsesContentApplicationJsonSchemaErrorsItems": { "properties": { "code": { "type": "string" }, "message": { "type": "string" } }, "required": [ "code", "message" ], "title": "EorContractsContractIdAmendmentsAmendmentIdPdfGetResponsesContentApplicationJsonSchemaErrorsItems", "type": "object" }, "EorContractsContractIdAmendmentsAmendmentIdSignPostResponsesContentApplicationJsonSchemaData": { "properties": { "amendment_statuses": { "description": "List of amendment statuses representing the history and progression of an amendment.", "items": { "$ref": "#/components/schemas/EorContractsContractIdAmendmentsAmendmentIdSignPostResponsesContentApplicationJsonSchemaDataAmendmentStatusesItems" }, "type": "array" }, "created_at": { "description": "Creation date of the amendment.", "format": "date-time", "type": "string" }, "currency": { "description": "Contract currency.", "type": "string" }, "custom_items": { "description": "Custom amendment items associated with the amendment flow", "items": { "$ref": "#/components/schemas/EorContractsContractIdAmendmentsAmendmentIdSignPostResponsesContentApplicationJsonSchemaDataCustomItemsItems" }, "type": "array" }, "document_type": { "description": "Amendment document type", "oneOf": [ { "$ref": "#/components/schemas/EorContractsContractIdAmendmentsAmendmentIdSignPostResponsesContentApplicationJsonSchemaDataDocumentType" }, { "type": "null" } ] }, "effective_date": { "description": "Effective date of the amendment.", "format": "date-time", "type": [ "string", "null" ] }, "employee_nationality": { "description": "Nationality of the employee.", "type": "string" }, "employment_state": { "description": "State of employment.", "type": [ "string", "null" ] }, "employment_type": { "$ref": "#/components/schemas/EorContractsContractIdAmendmentsAmendmentIdSignPostResponsesContentApplicationJsonSchemaDataEmploymentType", "description": "Type of employment." }, "end_date": { "description": "End date of the employment.", "format": "date-time", "type": [ "string", "null" ] }, "fixed_adjustments": { "description": "List of fixed adjustments associated with the amendment request.", "items": { "$ref": "#/components/schemas/EorContractsContractIdAmendmentsAmendmentIdSignPostResponsesContentApplicationJsonSchemaDataFixedAdjustmentsItems" }, "type": "array" }, "holidays": { "description": "Number of holidays.", "type": [ "integer", "null" ] }, "hourly_rate": { "description": "Hourly rate of the amendment", "type": [ "string", "null" ] }, "id": { "description": "Id of amendment", "format": "uuid", "type": "string" }, "is_effective_date_updated": { "description": "Is Effective Date updated.", "type": "boolean" }, "is_hrx_action_needed": { "description": "Is HRX action needed.", "type": "boolean" }, "items": { "description": "Items of amendment", "items": { "$ref": "#/components/schemas/EorContractsContractIdAmendmentsAmendmentIdSignPostResponsesContentApplicationJsonSchemaDataItemsItems" }, "type": "array" }, "job_category": { "description": "Job category associated with the job title.", "type": [ "string", "null" ] }, "job_code": { "description": "Job code associated with the job title.", "type": [ "string", "null" ] }, "job_title": { "description": "Job title associated with the amendment.", "maxLength": 1000, "type": "string" }, "legal_context": { "description": "Additional details needed for legal input", "oneOf": [ { "$ref": "#/components/schemas/EorContractsContractIdAmendmentsAmendmentIdSignPostResponsesContentApplicationJsonSchemaDataLegalContext" }, { "type": "null" } ] }, "notice_period_after_probation": { "description": "Notice period after probation.", "type": [ "string", "null" ] }, "notice_period_during_probation": { "description": "Notice period during probation.", "type": [ "string", "null" ] }, "notice_period_time_unit": { "description": "Notice period time unit.", "oneOf": [ { "$ref": "#/components/schemas/EorContractsContractIdAmendmentsAmendmentIdSignPostResponsesContentApplicationJsonSchemaDataNoticePeriodTimeUnit" }, { "type": "null" } ] }, "notice_period_type": { "description": "Type of notice period.", "oneOf": [ { "$ref": "#/components/schemas/EorContractsContractIdAmendmentsAmendmentIdSignPostResponsesContentApplicationJsonSchemaDataNoticePeriodType" }, { "type": "null" } ] }, "probation_period": { "description": "Duration of the probation period.", "type": [ "integer", "null" ] }, "probation_period_type_for_definite": { "description": "Type of probation period for definite contracts.", "oneOf": [ { "$ref": "#/components/schemas/EorContractsContractIdAmendmentsAmendmentIdSignPostResponsesContentApplicationJsonSchemaDataProbationPeriodTypeForDefinite" }, { "type": "null" } ] }, "rejection_context": { "description": "Additional details containing rejection reason", "oneOf": [ { "$ref": "#/components/schemas/EorContractsContractIdAmendmentsAmendmentIdSignPostResponsesContentApplicationJsonSchemaDataRejectionContext" }, { "type": "null" } ] }, "requested_by": { "description": "Profile name of the user who requested the change", "type": [ "string", "null" ] }, "salary": { "description": "Salary for the amendment.", "type": "string" }, "scope": { "description": "Scope of the amendment.", "type": "string" }, "seniority_date": { "description": "The seniority date represents the employee’s original start date with a previous employer. It is used to preserve employment tenure when the employee transfers to this company. Can be null if not applicable.", "format": "date", "type": [ "string", "null" ] }, "seniority_id": { "description": "Seniority level identifier.", "format": "uuid", "type": [ "string", "null" ] }, "sick_leave_days": { "description": "Number of sick leave days", "type": [ "integer", "null" ] }, "source": { "description": "Source of amendment flow creation.", "oneOf": [ { "$ref": "#/components/schemas/EorContractsContractIdAmendmentsAmendmentIdSignPostResponsesContentApplicationJsonSchemaDataSource" }, { "type": "null" } ] }, "start_date": { "description": "Start date of the employment.", "format": "date-time", "type": "string" }, "time_off_type": { "$ref": "#/components/schemas/EorContractsContractIdAmendmentsAmendmentIdSignPostResponsesContentApplicationJsonSchemaDataTimeOffType", "description": "Type of time off." }, "type": { "description": "Type of amendment", "oneOf": [ { "$ref": "#/components/schemas/EorContractsContractIdAmendmentsAmendmentIdSignPostResponsesContentApplicationJsonSchemaDataType" }, { "type": "null" } ] }, "updated_at": { "description": "Date when amendment is updated", "format": "date-time", "type": "string" }, "variable_compensation": { "$ref": "#/components/schemas/EorContractsContractIdAmendmentsAmendmentIdSignPostResponsesContentApplicationJsonSchemaDataVariableCompensation", "description": "Represents a variable compensation record (such as a bonus, commission, or incentive) within a contract. It contains details like the amount, type, frequency, and whether it is part of an incentive plan. The record also tracks when it was created, updated, and whether it has been amended." }, "void_deadline": { "description": "Deadline this SOW to be voided", "format": "date-time", "type": [ "string", "null" ] }, "void_deadline_type": { "description": "Type of void deadline", "oneOf": [ { "$ref": "#/components/schemas/EorContractsContractIdAmendmentsAmendmentIdSignPostResponsesContentApplicationJsonSchemaDataVoidDeadlineType" }, { "type": "null" } ] }, "work_hours_per_week": { "description": "Number of work hours per week.", "type": "string" }, "work_schedule_id": { "description": "Work schedule id", "format": "uuid", "type": [ "string", "null" ] }, "work_schedule_rules_version": { "description": "Work schedule rule version.", "type": [ "string", "null" ] } }, "title": "EorContractsContractIdAmendmentsAmendmentIdSignPostResponsesContentApplicationJsonSchemaData", "type": "object" }, "EorContractsContractIdAmendmentsAmendmentIdSignPostResponsesContentApplicationJsonSchemaDataAmendmentStatusesItems": { "properties": { "amendment_flow_status": { "$ref": "#/components/schemas/EorContractsContractIdAmendmentsAmendmentIdSignPostResponsesContentApplicationJsonSchemaDataAmendmentStatusesItemsAmendmentFlowStatus", "description": "Metadata about the amendment status, including when it was created." }, "friendly_name": { "description": "Friendly name of amendment status", "type": "string" }, "name": { "description": "Logical, system-oriented identifier of the amendment status. Can be used to group statuses under a parent category and subgroup them for more granular state tracking. The structure typically follows a dot-separated hierarchy (e.g., 'PARENT','PARENT.CHILD', 'PARENT.CHILD.CHILD.CHILD', ...), which allows logical grouping and filtering of related statuses.", "type": "string" } }, "title": "EorContractsContractIdAmendmentsAmendmentIdSignPostResponsesContentApplicationJsonSchemaDataAmendmentStatusesItems", "type": "object" }, "EorContractsContractIdAmendmentsAmendmentIdSignPostResponsesContentApplicationJsonSchemaDataAmendmentStatusesItemsAmendmentFlowStatus": { "description": "Metadata about the amendment status, including when it was created.", "properties": { "created_at": { "description": "Creation date", "format": "date-time", "type": "string" } }, "title": "EorContractsContractIdAmendmentsAmendmentIdSignPostResponsesContentApplicationJsonSchemaDataAmendmentStatusesItemsAmendmentFlowStatus", "type": "object" }, "EorContractsContractIdAmendmentsAmendmentIdSignPostResponsesContentApplicationJsonSchemaDataCustomItemsItems": { "properties": { "description": { "description": "Detailed description of the custom amendment item", "type": [ "string", "null" ] }, "id": { "description": "Unique identifier for the custom amendment item", "format": "uuid", "type": "string" }, "rejection_reason": { "description": "Reason for rejection if the item was rejected", "type": [ "string", "null" ] }, "status": { "$ref": "#/components/schemas/EorContractsContractIdAmendmentsAmendmentIdSignPostResponsesContentApplicationJsonSchemaDataCustomItemsItemsStatus", "description": "Current status of the custom amendment item" }, "type": { "description": "Type/context of the custom amendment item", "type": "string" } }, "required": [ "id", "type", "status" ], "title": "EorContractsContractIdAmendmentsAmendmentIdSignPostResponsesContentApplicationJsonSchemaDataCustomItemsItems", "type": "object" }, "EorContractsContractIdAmendmentsAmendmentIdSignPostResponsesContentApplicationJsonSchemaDataCustomItemsItemsStatus": { "description": "Current status of the custom amendment item", "enum": [ "REJECTED", "APPROVED", "PENDING_REVIEW", "PENDING_LEGAL" ], "title": "EorContractsContractIdAmendmentsAmendmentIdSignPostResponsesContentApplicationJsonSchemaDataCustomItemsItemsStatus", "type": "string" }, "EorContractsContractIdAmendmentsAmendmentIdSignPostResponsesContentApplicationJsonSchemaDataDocumentType": { "description": "Amendment document type", "enum": [ "EA", "SOW", "SOW_EA" ], "title": "EorContractsContractIdAmendmentsAmendmentIdSignPostResponsesContentApplicationJsonSchemaDataDocumentType", "type": "string" }, "EorContractsContractIdAmendmentsAmendmentIdSignPostResponsesContentApplicationJsonSchemaDataEmploymentType": { "description": "Type of employment.", "enum": [ "FULL_TIME", "PART_TIME" ], "title": "EorContractsContractIdAmendmentsAmendmentIdSignPostResponsesContentApplicationJsonSchemaDataEmploymentType", "type": "string" }, "EorContractsContractIdAmendmentsAmendmentIdSignPostResponsesContentApplicationJsonSchemaDataFixedAdjustmentsItems": { "properties": { "created_at": { "description": "Timestamp when the fixed adjustment was created.", "format": "date-time", "type": "string" }, "description": { "description": "Description of the fixed adjustment.", "maxLength": 256, "minLength": 1, "type": "string" }, "id": { "description": "System-generated unique identifier for the fixed adjustment record in an amendment request.", "type": "string" }, "is_amended": { "description": "Whether this fixed adjustment was amended from a previous one.", "type": "boolean" }, "is_country_specific": { "description": "Whether this fixed adjustment applies only to a specific country.", "type": "boolean" }, "is_deleted": { "description": "True if the fixed adjustment was deleted as part of the amendment; otherwise false.", "type": "boolean" }, "is_recurring": { "description": "Whether the fixed adjustment is recurring. If set to false, it will be treated as a one-time fixed allowance.", "type": "boolean" }, "parent_fixed_adjustment_id": { "description": "Reference to the parent fixed adjustment, if applicable.", "type": [ "string", "null" ] }, "status": { "$ref": "#/components/schemas/EorContractsContractIdAmendmentsAmendmentIdSignPostResponsesContentApplicationJsonSchemaDataFixedAdjustmentsItemsStatus", "description": "Current status of the fixed adjustment." }, "updated_at": { "description": "Timestamp when the fixed adjustment was last updated.", "format": "date-time", "type": "string" }, "value": { "description": "Value of the fixed adjustment.", "pattern": "^(?!0+(\\.0+)?$)\\d+(?:\\.\\d+)?$", "type": "string" } }, "required": [ "id", "value", "status", "created_at", "is_amended", "updated_at", "description", "is_recurring", "is_country_specific" ], "title": "EorContractsContractIdAmendmentsAmendmentIdSignPostResponsesContentApplicationJsonSchemaDataFixedAdjustmentsItems", "type": "object" }, "EorContractsContractIdAmendmentsAmendmentIdSignPostResponsesContentApplicationJsonSchemaDataFixedAdjustmentsItemsStatus": { "description": "Current status of the fixed adjustment.", "enum": [ "WAITING_FOR_SIGNING", "ACTIVE", "OUTDATED", "CANCELLED" ], "title": "EorContractsContractIdAmendmentsAmendmentIdSignPostResponsesContentApplicationJsonSchemaDataFixedAdjustmentsItemsStatus", "type": "string" }, "EorContractsContractIdAmendmentsAmendmentIdSignPostResponsesContentApplicationJsonSchemaDataItemsItems": { "properties": { "data_point": { "description": "The field that is selected for amendment.", "type": "string" }, "id": { "description": "Id of amendment item", "format": "uuid", "type": "string" }, "item": { "description": "Amendment item", "type": "string" }, "new_value": { "description": "The new valid value after the attempted change.", "type": "string" }, "previous_value": { "description": "The previous valid value before the attempted change.", "type": "string" }, "type": { "$ref": "#/components/schemas/EorContractsContractIdAmendmentsAmendmentIdSignPostResponsesContentApplicationJsonSchemaDataItemsItemsType", "description": "Type of amendment" } }, "title": "EorContractsContractIdAmendmentsAmendmentIdSignPostResponsesContentApplicationJsonSchemaDataItemsItems", "type": "object" }, "EorContractsContractIdAmendmentsAmendmentIdSignPostResponsesContentApplicationJsonSchemaDataItemsItemsType": { "description": "Type of amendment", "enum": [ "INSTANT", "OPS", "LEGAL", "DISABLED", "CUSTOM", "AUTOMATED" ], "title": "EorContractsContractIdAmendmentsAmendmentIdSignPostResponsesContentApplicationJsonSchemaDataItemsItemsType", "type": "string" }, "EorContractsContractIdAmendmentsAmendmentIdSignPostResponsesContentApplicationJsonSchemaDataLegalContext": { "description": "Additional details needed for legal input", "properties": { "details": { "description": "Details regarding the legal request", "type": "string" }, "jira_ticket": { "description": "Jira ticket identifier linked to the legal context", "type": "string" }, "jira_web_url": { "description": "Link to the Jira ticket for tracking", "format": "uri", "type": "string" }, "requested_at": { "description": "Timestamp when legal review was requested", "format": "date-time", "type": "string" }, "status": { "$ref": "#/components/schemas/EorContractsContractIdAmendmentsAmendmentIdSignPostResponsesContentApplicationJsonSchemaDataLegalContextStatus", "description": "Current status of the legal review process" } }, "title": "EorContractsContractIdAmendmentsAmendmentIdSignPostResponsesContentApplicationJsonSchemaDataLegalContext", "type": "object" }, "EorContractsContractIdAmendmentsAmendmentIdSignPostResponsesContentApplicationJsonSchemaDataLegalContextStatus": { "description": "Current status of the legal review process", "enum": [ "REQUEST_LEGAL_REVIEW", "WAITING_FOR_ANOTHER_TEAM", "WAITING_FOR_HRX_ACTION", "DECLINED", "SOLVED" ], "title": "EorContractsContractIdAmendmentsAmendmentIdSignPostResponsesContentApplicationJsonSchemaDataLegalContextStatus", "type": "string" }, "EorContractsContractIdAmendmentsAmendmentIdSignPostResponsesContentApplicationJsonSchemaDataNoticePeriodTimeUnit": { "description": "Notice period time unit.", "enum": [ "DAY", "WEEK", "MONTH" ], "title": "EorContractsContractIdAmendmentsAmendmentIdSignPostResponsesContentApplicationJsonSchemaDataNoticePeriodTimeUnit", "type": "string" }, "EorContractsContractIdAmendmentsAmendmentIdSignPostResponsesContentApplicationJsonSchemaDataNoticePeriodType": { "description": "Type of notice period.", "enum": [ "STANDARD", "CUSTOM" ], "title": "EorContractsContractIdAmendmentsAmendmentIdSignPostResponsesContentApplicationJsonSchemaDataNoticePeriodType", "type": "string" }, "EorContractsContractIdAmendmentsAmendmentIdSignPostResponsesContentApplicationJsonSchemaDataProbationPeriodTypeForDefinite": { "description": "Type of probation period for definite contracts.", "enum": [ "STANDARD", "CUSTOM" ], "title": "EorContractsContractIdAmendmentsAmendmentIdSignPostResponsesContentApplicationJsonSchemaDataProbationPeriodTypeForDefinite", "type": "string" }, "EorContractsContractIdAmendmentsAmendmentIdSignPostResponsesContentApplicationJsonSchemaDataRejectionContext": { "description": "Additional details containing rejection reason", "properties": { "rejected_at": { "description": "Timestamp of when the rejection occurred", "format": "date-time", "type": "string" } }, "title": "EorContractsContractIdAmendmentsAmendmentIdSignPostResponsesContentApplicationJsonSchemaDataRejectionContext", "type": "object" }, "EorContractsContractIdAmendmentsAmendmentIdSignPostResponsesContentApplicationJsonSchemaDataSource": { "description": "Source of amendment flow creation.", "enum": [ "APP", "PUBLIC_API", "APP_BULK_AMENDMENT" ], "title": "EorContractsContractIdAmendmentsAmendmentIdSignPostResponsesContentApplicationJsonSchemaDataSource", "type": "string" }, "EorContractsContractIdAmendmentsAmendmentIdSignPostResponsesContentApplicationJsonSchemaDataTimeOffType": { "description": "Type of time off.", "enum": [ "STANDARD", "SPECIFIC", "PRORATED" ], "title": "EorContractsContractIdAmendmentsAmendmentIdSignPostResponsesContentApplicationJsonSchemaDataTimeOffType", "type": "string" }, "EorContractsContractIdAmendmentsAmendmentIdSignPostResponsesContentApplicationJsonSchemaDataType": { "description": "Type of amendment", "enum": [ "INSTANT", "OPS", "LEGAL", "DISABLED", "CUSTOM", "AUTOMATED" ], "title": "EorContractsContractIdAmendmentsAmendmentIdSignPostResponsesContentApplicationJsonSchemaDataType", "type": "string" }, "EorContractsContractIdAmendmentsAmendmentIdSignPostResponsesContentApplicationJsonSchemaDataVariableCompensation": { "description": "Represents a variable compensation record (such as a bonus, commission, or incentive) within a contract. It contains details like the amount, type, frequency, and whether it is part of an incentive plan. The record also tracks when it was created, updated, and whether it has been amended.", "properties": { "amount": { "description": "The value of the compensation. Shown as a string to keep the exact number of decimals.", "format": "decimal", "type": "string" }, "created_at": { "description": "The date and time when this record was first created in the system.", "format": "date-time", "type": "string" }, "effective_date": { "description": "The date when this compensation starts being valid.", "format": "date-time", "type": "string" }, "id": { "description": "The unique ID assigned by the system to this variable compensation record.", "type": "string" }, "incentive_plan": { "$ref": "#/components/schemas/EorContractsContractIdAmendmentsAmendmentIdSignPostResponsesContentApplicationJsonSchemaDataVariableCompensationIncentivePlan", "description": "Details of the incentive plan linked to this compensation, if any." }, "is_amended": { "description": "Shows whether this compensation has been changed as part of an amendment.", "type": "boolean" }, "is_deleted": { "description": "Shows whether this compensation has been deleted.", "type": "boolean" }, "parent_id": { "description": "Reference to the parent variable compensation, if applicable. Null if this compensation is not linked to any compensation.", "type": [ "string", "null" ] }, "timeline": { "$ref": "#/components/schemas/EorContractsContractIdAmendmentsAmendmentIdSignPostResponsesContentApplicationJsonSchemaDataVariableCompensationTimeline", "description": "How often the compensation is paid — for example monthly, quarterly, annually, or twice a year." }, "title": { "description": "Title or name of the variable compensation.", "type": "string" }, "type": { "$ref": "#/components/schemas/EorContractsContractIdAmendmentsAmendmentIdSignPostResponsesContentApplicationJsonSchemaDataVariableCompensationType", "description": "The way the compensation is calculated. `FIXED` means a fixed amount (like $1000). `PERCENTAGE` means it’s based on a percentage of the salary." }, "updated_at": { "description": "The date and time when this record was last updated.", "format": "date-time", "type": "string" } }, "required": [ "id", "type", "title", "amount", "timeline", "parent_id", "created_at", "updated_at", "effective_date" ], "title": "EorContractsContractIdAmendmentsAmendmentIdSignPostResponsesContentApplicationJsonSchemaDataVariableCompensation", "type": "object" }, "EorContractsContractIdAmendmentsAmendmentIdSignPostResponsesContentApplicationJsonSchemaDataVariableCompensationIncentivePlan": { "description": "Details of the incentive plan linked to this compensation, if any.", "properties": { "details": { "description": "Extra details about the incentive plan, if any.", "type": "string" }, "employee_signature": { "description": "The employee’s signature for the incentive plan, if collected.", "type": "string" }, "employee_signed_at": { "description": "The date and time when the employee signed the incentive plan. Empty if not signed.", "format": "date-time", "type": "string" } }, "title": "EorContractsContractIdAmendmentsAmendmentIdSignPostResponsesContentApplicationJsonSchemaDataVariableCompensationIncentivePlan", "type": "object" }, "EorContractsContractIdAmendmentsAmendmentIdSignPostResponsesContentApplicationJsonSchemaDataVariableCompensationTimeline": { "description": "How often the compensation is paid — for example monthly, quarterly, annually, or twice a year.", "enum": [ "MONTHLY", "QUARTERLY", "ANNUALLY", "BIANNUALLY" ], "title": "EorContractsContractIdAmendmentsAmendmentIdSignPostResponsesContentApplicationJsonSchemaDataVariableCompensationTimeline", "type": "string" }, "EorContractsContractIdAmendmentsAmendmentIdSignPostResponsesContentApplicationJsonSchemaDataVariableCompensationType": { "description": "The way the compensation is calculated. `FIXED` means a fixed amount (like $1000). `PERCENTAGE` means it’s based on a percentage of the salary.", "enum": [ "FIXED", "PERCENTAGE" ], "title": "EorContractsContractIdAmendmentsAmendmentIdSignPostResponsesContentApplicationJsonSchemaDataVariableCompensationType", "type": "string" }, "EorContractsContractIdAmendmentsAmendmentIdSignPostResponsesContentApplicationJsonSchemaDataVoidDeadlineType": { "description": "Type of void deadline", "enum": [ "CUTOFF", "START_DATE", "END_DATE", "EXPIRY" ], "title": "EorContractsContractIdAmendmentsAmendmentIdSignPostResponsesContentApplicationJsonSchemaDataVoidDeadlineType", "type": "string" }, "EorContractsContractIdAmendmentsAmendmentIdSignPostResponsesContentApplicationJsonSchemaErrorsItems": { "properties": { "code": { "type": "string" }, "message": { "type": "string" } }, "required": [ "code", "message" ], "title": "EorContractsContractIdAmendmentsAmendmentIdSignPostResponsesContentApplicationJsonSchemaErrorsItems", "type": "object" }, "EorContractsContractIdAmendmentsGetResponsesContentApplicationJsonSchemaDataItems": { "properties": { "amendment_statuses": { "description": "List of amendment statuses representing the history and progression of an amendment.", "items": { "$ref": "#/components/schemas/EorContractsContractIdAmendmentsGetResponsesContentApplicationJsonSchemaDataItemsAmendmentStatusesItems" }, "type": "array" }, "created_at": { "description": "Creation date of the amendment.", "format": "date-time", "type": "string" }, "currency": { "description": "Contract currency.", "type": "string" }, "custom_items": { "description": "Custom amendment items associated with the amendment flow", "items": { "$ref": "#/components/schemas/EorContractsContractIdAmendmentsGetResponsesContentApplicationJsonSchemaDataItemsCustomItemsItems" }, "type": "array" }, "description": { "description": "Free-text description of the amendment.", "type": [ "string", "null" ] }, "document_type": { "description": "Amendment document type", "oneOf": [ { "$ref": "#/components/schemas/EorContractsContractIdAmendmentsGetResponsesContentApplicationJsonSchemaDataItemsDocumentType" }, { "type": "null" } ] }, "effective_date": { "description": "Effective date of the amendment.", "format": "date-time", "type": [ "string", "null" ] }, "employee_nationality": { "description": "Nationality of the employee.", "type": "string" }, "employment_state": { "description": "State of employment.", "type": [ "string", "null" ] }, "employment_type": { "$ref": "#/components/schemas/EorContractsContractIdAmendmentsGetResponsesContentApplicationJsonSchemaDataItemsEmploymentType", "description": "Type of employment." }, "end_date": { "description": "End date of the employment.", "format": "date-time", "type": [ "string", "null" ] }, "fixed_adjustments": { "description": "List of fixed adjustments associated with the amendment request.", "items": { "$ref": "#/components/schemas/EorContractsContractIdAmendmentsGetResponsesContentApplicationJsonSchemaDataItemsFixedAdjustmentsItems" }, "type": "array" }, "holidays": { "description": "Number of holidays.", "type": [ "integer", "null" ] }, "hourly_rate": { "description": "Hourly rate of the amendment", "type": [ "string", "null" ] }, "id": { "description": "Id of amendment", "format": "uuid", "type": "string" }, "is_effective_date_updated": { "description": "Is Effective Date updated.", "type": "boolean" }, "is_hrx_action_needed": { "description": "Is HRX action needed.", "type": "boolean" }, "items": { "description": "Items of amendment", "items": { "$ref": "#/components/schemas/EorContractsContractIdAmendmentsGetResponsesContentApplicationJsonSchemaDataItemsItemsItems" }, "type": "array" }, "job_category": { "description": "Job category associated with the job title.", "type": [ "string", "null" ] }, "job_code": { "description": "Job code associated with the job title.", "type": [ "string", "null" ] }, "job_title": { "description": "Job title associated with the amendment.", "maxLength": 1000, "type": "string" }, "legal_context": { "description": "Additional details needed for legal input", "oneOf": [ { "$ref": "#/components/schemas/EorContractsContractIdAmendmentsGetResponsesContentApplicationJsonSchemaDataItemsLegalContext" }, { "type": "null" } ] }, "net_salary": { "description": "Net salary for the amendment.", "type": [ "string", "null" ] }, "notice_period_after_probation": { "description": "Notice period after probation.", "type": [ "string", "null" ] }, "notice_period_during_probation": { "description": "Notice period during probation.", "type": [ "string", "null" ] }, "notice_period_time_unit": { "description": "Notice period time unit.", "oneOf": [ { "$ref": "#/components/schemas/EorContractsContractIdAmendmentsGetResponsesContentApplicationJsonSchemaDataItemsNoticePeriodTimeUnit" }, { "type": "null" } ] }, "notice_period_type": { "description": "Type of notice period.", "oneOf": [ { "$ref": "#/components/schemas/EorContractsContractIdAmendmentsGetResponsesContentApplicationJsonSchemaDataItemsNoticePeriodType" }, { "type": "null" } ] }, "probation_period": { "description": "Duration of the probation period.", "type": [ "integer", "null" ] }, "probation_period_type_for_definite": { "description": "Type of probation period for definite contracts.", "oneOf": [ { "$ref": "#/components/schemas/EorContractsContractIdAmendmentsGetResponsesContentApplicationJsonSchemaDataItemsProbationPeriodTypeForDefinite" }, { "type": "null" } ] }, "rejection_context": { "description": "Additional details containing rejection reason", "oneOf": [ { "$ref": "#/components/schemas/EorContractsContractIdAmendmentsGetResponsesContentApplicationJsonSchemaDataItemsRejectionContext" }, { "type": "null" } ] }, "requested_by": { "description": "Profile name of the user who requested the change", "type": [ "string", "null" ] }, "salary": { "description": "Salary for the amendment.", "type": "string" }, "scope": { "description": "Scope of the amendment.", "type": "string" }, "seniority_date": { "description": "The seniority date represents the employee’s original start date with a previous employer. It is used to preserve employment tenure when the employee transfers to this company. Can be null if not applicable.", "format": "date-time", "type": [ "string", "null" ] }, "seniority_id": { "description": "New seniority level identifier.", "format": "uuid", "type": [ "string", "null" ] }, "sick_leave_days": { "description": "Number of sick leave days", "type": [ "integer", "null" ] }, "source": { "description": "Source of amendment flow creation.", "oneOf": [ { "$ref": "#/components/schemas/EorContractsContractIdAmendmentsGetResponsesContentApplicationJsonSchemaDataItemsSource" }, { "type": "null" } ] }, "start_date": { "description": "Start date of the employment.", "format": "date-time", "type": "string" }, "time_off_type": { "$ref": "#/components/schemas/EorContractsContractIdAmendmentsGetResponsesContentApplicationJsonSchemaDataItemsTimeOffType", "description": "Type of time off." }, "type": { "description": "Type of amendment", "oneOf": [ { "$ref": "#/components/schemas/EorContractsContractIdAmendmentsGetResponsesContentApplicationJsonSchemaDataItemsType" }, { "type": "null" } ] }, "updated_at": { "description": "Date when amendment is updated", "format": "date-time", "type": "string" }, "variable_compensation": { "$ref": "#/components/schemas/EorContractsContractIdAmendmentsGetResponsesContentApplicationJsonSchemaDataItemsVariableCompensation", "description": "Represents a variable compensation record (such as a bonus, commission, or incentive) within a contract. It contains details like the amount, type, frequency, and whether it is part of an incentive plan. The record also tracks when it was created, updated, and whether it has been amended." }, "void_deadline": { "description": "Deadline this SOW to be voided", "format": "date-time", "type": [ "string", "null" ] }, "void_deadline_type": { "description": "Type of void deadline", "oneOf": [ { "$ref": "#/components/schemas/EorContractsContractIdAmendmentsGetResponsesContentApplicationJsonSchemaDataItemsVoidDeadlineType" }, { "type": "null" } ] }, "work_hours_per_week": { "description": "Number of work hours per week.", "type": "string" }, "work_schedule_id": { "description": "Work schedule id", "format": "uuid", "type": [ "string", "null" ] }, "work_schedule_rules_version": { "description": "Work schedule rule version.", "type": [ "string", "null" ] } }, "title": "EorContractsContractIdAmendmentsGetResponsesContentApplicationJsonSchemaDataItems", "type": "object" }, "EorContractsContractIdAmendmentsGetResponsesContentApplicationJsonSchemaDataItemsAmendmentStatusesItems": { "properties": { "amendment_flow_status": { "$ref": "#/components/schemas/EorContractsContractIdAmendmentsGetResponsesContentApplicationJsonSchemaDataItemsAmendmentStatusesItemsAmendmentFlowStatus", "description": "Metadata about the amendment status, including when it was created." }, "friendly_name": { "description": "Friendly name of amendment status", "type": "string" }, "name": { "description": "Logical, system-oriented identifier of the amendment status. Can be used to group statuses under a parent category and subgroup them for more granular state tracking. The structure typically follows a dot-separated hierarchy (e.g., 'PARENT','PARENT.CHILD', 'PARENT.CHILD.CHILD.CHILD', ...), which allows logical grouping and filtering of related statuses.", "type": "string" } }, "title": "EorContractsContractIdAmendmentsGetResponsesContentApplicationJsonSchemaDataItemsAmendmentStatusesItems", "type": "object" }, "EorContractsContractIdAmendmentsGetResponsesContentApplicationJsonSchemaDataItemsAmendmentStatusesItemsAmendmentFlowStatus": { "description": "Metadata about the amendment status, including when it was created.", "properties": { "created_at": { "description": "Creation date", "format": "date-time", "type": "string" } }, "title": "EorContractsContractIdAmendmentsGetResponsesContentApplicationJsonSchemaDataItemsAmendmentStatusesItemsAmendmentFlowStatus", "type": "object" }, "EorContractsContractIdAmendmentsGetResponsesContentApplicationJsonSchemaDataItemsCustomItemsItems": { "properties": { "description": { "description": "Detailed description of the custom amendment item", "type": [ "string", "null" ] }, "id": { "description": "Unique identifier for the custom amendment item", "format": "uuid", "type": "string" }, "rejection_reason": { "description": "Reason for rejection if the item was rejected", "type": [ "string", "null" ] }, "status": { "$ref": "#/components/schemas/EorContractsContractIdAmendmentsGetResponsesContentApplicationJsonSchemaDataItemsCustomItemsItemsStatus", "description": "Current status of the custom amendment item" }, "type": { "description": "Type/context of the custom amendment item", "type": "string" } }, "required": [ "id", "type", "status" ], "title": "EorContractsContractIdAmendmentsGetResponsesContentApplicationJsonSchemaDataItemsCustomItemsItems", "type": "object" }, "EorContractsContractIdAmendmentsGetResponsesContentApplicationJsonSchemaDataItemsCustomItemsItemsStatus": { "description": "Current status of the custom amendment item", "enum": [ "REJECTED", "APPROVED", "PENDING_REVIEW", "PENDING_LEGAL" ], "title": "EorContractsContractIdAmendmentsGetResponsesContentApplicationJsonSchemaDataItemsCustomItemsItemsStatus", "type": "string" }, "EorContractsContractIdAmendmentsGetResponsesContentApplicationJsonSchemaDataItemsDocumentType": { "description": "Amendment document type", "enum": [ "EA", "SOW", "SOW_EA" ], "title": "EorContractsContractIdAmendmentsGetResponsesContentApplicationJsonSchemaDataItemsDocumentType", "type": "string" }, "EorContractsContractIdAmendmentsGetResponsesContentApplicationJsonSchemaDataItemsEmploymentType": { "description": "Type of employment.", "enum": [ "FULL_TIME", "PART_TIME" ], "title": "EorContractsContractIdAmendmentsGetResponsesContentApplicationJsonSchemaDataItemsEmploymentType", "type": "string" }, "EorContractsContractIdAmendmentsGetResponsesContentApplicationJsonSchemaDataItemsFixedAdjustmentsItems": { "properties": { "created_at": { "description": "Timestamp when the fixed adjustment was created.", "format": "date-time", "type": "string" }, "description": { "description": "Description of the fixed adjustment.", "maxLength": 256, "minLength": 1, "type": "string" }, "id": { "description": "System-generated unique identifier for the fixed adjustment record in an amendment request.", "type": "string" }, "is_amended": { "description": "Whether this fixed adjustment was amended from a previous one.", "type": "boolean" }, "is_country_specific": { "description": "Whether this fixed adjustment applies only to a specific country.", "type": "boolean" }, "is_deleted": { "description": "True if the fixed adjustment was deleted as part of the amendment; otherwise false.", "type": "boolean" }, "is_recurring": { "description": "Whether the fixed adjustment is recurring. If set to false, it will be treated as a one-time fixed allowance.", "type": "boolean" }, "parent_fixed_adjustment_id": { "description": "Reference to the parent fixed adjustment, if applicable.", "type": [ "string", "null" ] }, "status": { "$ref": "#/components/schemas/EorContractsContractIdAmendmentsGetResponsesContentApplicationJsonSchemaDataItemsFixedAdjustmentsItemsStatus", "description": "Current status of the fixed adjustment." }, "updated_at": { "description": "Timestamp when the fixed adjustment was last updated.", "format": "date-time", "type": "string" }, "value": { "description": "Value of the fixed adjustment.", "pattern": "^(?!0+(\\.0+)?$)\\d+(?:\\.\\d+)?$", "type": "string" } }, "required": [ "id", "value", "status", "created_at", "is_amended", "updated_at", "description", "is_recurring", "is_country_specific" ], "title": "EorContractsContractIdAmendmentsGetResponsesContentApplicationJsonSchemaDataItemsFixedAdjustmentsItems", "type": "object" }, "EorContractsContractIdAmendmentsGetResponsesContentApplicationJsonSchemaDataItemsFixedAdjustmentsItemsStatus": { "description": "Current status of the fixed adjustment.", "enum": [ "WAITING_FOR_SIGNING", "ACTIVE", "OUTDATED", "CANCELLED" ], "title": "EorContractsContractIdAmendmentsGetResponsesContentApplicationJsonSchemaDataItemsFixedAdjustmentsItemsStatus", "type": "string" }, "EorContractsContractIdAmendmentsGetResponsesContentApplicationJsonSchemaDataItemsItemsItems": { "properties": { "data_point": { "description": "The field that is selected for amendment.", "type": "string" }, "id": { "description": "Id of amendment item", "format": "uuid", "type": "string" }, "item": { "description": "Amendment item", "type": "string" }, "new_value": { "description": "The new valid value after the attempted change.", "type": "string" }, "previous_value": { "description": "The previous valid value before the attempted change.", "type": "string" }, "type": { "description": "Type of amendment", "type": "string" } }, "title": "EorContractsContractIdAmendmentsGetResponsesContentApplicationJsonSchemaDataItemsItemsItems", "type": "object" }, "EorContractsContractIdAmendmentsGetResponsesContentApplicationJsonSchemaDataItemsLegalContext": { "description": "Additional details needed for legal input", "properties": { "details": { "description": "Details regarding the legal request", "type": "string" }, "jira_ticket": { "description": "Jira ticket identifier linked to the legal context", "type": "string" }, "jira_web_url": { "description": "Link to the Jira ticket for tracking", "format": "uri", "type": "string" }, "requested_at": { "description": "Timestamp when legal review was requested", "format": "date-time", "type": "string" }, "status": { "$ref": "#/components/schemas/EorContractsContractIdAmendmentsGetResponsesContentApplicationJsonSchemaDataItemsLegalContextStatus", "description": "Current status of the legal review process" } }, "title": "EorContractsContractIdAmendmentsGetResponsesContentApplicationJsonSchemaDataItemsLegalContext", "type": "object" }, "EorContractsContractIdAmendmentsGetResponsesContentApplicationJsonSchemaDataItemsLegalContextStatus": { "description": "Current status of the legal review process", "enum": [ "REQUEST_LEGAL_REVIEW", "WAITING_FOR_ANOTHER_TEAM", "WAITING_FOR_HRX_ACTION", "DECLINED", "SOLVED", "SOLVE_LEGAL", "LEGAL_JIRA_REOPENED" ], "title": "EorContractsContractIdAmendmentsGetResponsesContentApplicationJsonSchemaDataItemsLegalContextStatus", "type": "string" }, "EorContractsContractIdAmendmentsGetResponsesContentApplicationJsonSchemaDataItemsNoticePeriodTimeUnit": { "description": "Notice period time unit.", "enum": [ "DAY", "WEEK", "MONTH" ], "title": "EorContractsContractIdAmendmentsGetResponsesContentApplicationJsonSchemaDataItemsNoticePeriodTimeUnit", "type": "string" }, "EorContractsContractIdAmendmentsGetResponsesContentApplicationJsonSchemaDataItemsNoticePeriodType": { "description": "Type of notice period.", "enum": [ "STANDARD", "CUSTOM" ], "title": "EorContractsContractIdAmendmentsGetResponsesContentApplicationJsonSchemaDataItemsNoticePeriodType", "type": "string" }, "EorContractsContractIdAmendmentsGetResponsesContentApplicationJsonSchemaDataItemsProbationPeriodTypeForDefinite": { "description": "Type of probation period for definite contracts.", "enum": [ "STANDARD", "CUSTOM" ], "title": "EorContractsContractIdAmendmentsGetResponsesContentApplicationJsonSchemaDataItemsProbationPeriodTypeForDefinite", "type": "string" }, "EorContractsContractIdAmendmentsGetResponsesContentApplicationJsonSchemaDataItemsRejectionContext": { "description": "Additional details containing rejection reason", "properties": { "rejected_at": { "description": "Timestamp of when the rejection occurred", "format": "date-time", "type": "string" }, "rejection_reason": { "description": "Reason provided when the amendment was rejected. Null when the amendment was cancelled rather than rejected by an admin.", "type": [ "string", "null" ] } }, "title": "EorContractsContractIdAmendmentsGetResponsesContentApplicationJsonSchemaDataItemsRejectionContext", "type": "object" }, "EorContractsContractIdAmendmentsGetResponsesContentApplicationJsonSchemaDataItemsSource": { "description": "Source of amendment flow creation.", "enum": [ "APP", "PUBLIC_API", "APP_BULK_AMENDMENT" ], "title": "EorContractsContractIdAmendmentsGetResponsesContentApplicationJsonSchemaDataItemsSource", "type": "string" }, "EorContractsContractIdAmendmentsGetResponsesContentApplicationJsonSchemaDataItemsTimeOffType": { "description": "Type of time off.", "enum": [ "STANDARD", "SPECIFIC", "PRORATED" ], "title": "EorContractsContractIdAmendmentsGetResponsesContentApplicationJsonSchemaDataItemsTimeOffType", "type": "string" }, "EorContractsContractIdAmendmentsGetResponsesContentApplicationJsonSchemaDataItemsType": { "description": "Type of amendment", "enum": [ "INSTANT", "OPS", "LEGAL", "DISABLED", "CUSTOM", "AUTOMATED" ], "title": "EorContractsContractIdAmendmentsGetResponsesContentApplicationJsonSchemaDataItemsType", "type": "string" }, "EorContractsContractIdAmendmentsGetResponsesContentApplicationJsonSchemaDataItemsVariableCompensation": { "description": "Represents a variable compensation record (such as a bonus, commission, or incentive) within a contract. It contains details like the amount, type, frequency, and whether it is part of an incentive plan. The record also tracks when it was created, updated, and whether it has been amended.", "properties": { "amount": { "description": "The value of the compensation. Shown as a string to keep the exact number of decimals.", "format": "decimal", "type": "string" }, "created_at": { "description": "The date and time when this record was first created in the system.", "format": "date-time", "type": "string" }, "effective_date": { "description": "The date when this compensation starts being valid.", "format": "date-time", "type": "string" }, "id": { "description": "The unique ID assigned by the system to this variable compensation record.", "type": "string" }, "incentive_plan": { "$ref": "#/components/schemas/EorContractsContractIdAmendmentsGetResponsesContentApplicationJsonSchemaDataItemsVariableCompensationIncentivePlan", "description": "Details of the incentive plan linked to this compensation, if any." }, "is_amended": { "description": "Shows whether this compensation has been changed as part of an amendment.", "type": "boolean" }, "is_deleted": { "description": "Shows whether this compensation has been deleted.", "type": "boolean" }, "parent_id": { "description": "Reference to the parent variable compensation, if applicable. Null if this compensation is not linked to any compensation.", "type": [ "string", "null" ] }, "timeline": { "$ref": "#/components/schemas/EorContractsContractIdAmendmentsGetResponsesContentApplicationJsonSchemaDataItemsVariableCompensationTimeline", "description": "How often the compensation is paid — for example monthly, quarterly, annually, or twice a year." }, "title": { "description": "Title or name of the variable compensation.", "type": "string" }, "type": { "$ref": "#/components/schemas/EorContractsContractIdAmendmentsGetResponsesContentApplicationJsonSchemaDataItemsVariableCompensationType", "description": "The way the compensation is calculated. `FIXED` means a fixed amount (like $1000). `PERCENTAGE` means it’s based on a percentage of the salary." }, "updated_at": { "description": "The date and time when this record was last updated.", "format": "date-time", "type": "string" } }, "required": [ "id", "type", "title", "amount", "timeline", "parent_id", "created_at", "updated_at", "effective_date" ], "title": "EorContractsContractIdAmendmentsGetResponsesContentApplicationJsonSchemaDataItemsVariableCompensation", "type": "object" }, "EorContractsContractIdAmendmentsGetResponsesContentApplicationJsonSchemaDataItemsVariableCompensationIncentivePlan": { "description": "Details of the incentive plan linked to this compensation, if any.", "properties": { "details": { "description": "Extra details about the incentive plan, if any.", "type": "string" }, "employee_signature": { "description": "The employee’s signature for the incentive plan, if collected.", "type": "string" }, "employee_signed_at": { "description": "The date and time when the employee signed the incentive plan. Empty if not signed.", "format": "date-time", "type": "string" } }, "title": "EorContractsContractIdAmendmentsGetResponsesContentApplicationJsonSchemaDataItemsVariableCompensationIncentivePlan", "type": "object" }, "EorContractsContractIdAmendmentsGetResponsesContentApplicationJsonSchemaDataItemsVariableCompensationTimeline": { "description": "How often the compensation is paid — for example monthly, quarterly, annually, or twice a year.", "enum": [ "MONTHLY", "QUARTERLY", "ANNUALLY", "BIANNUALLY" ], "title": "EorContractsContractIdAmendmentsGetResponsesContentApplicationJsonSchemaDataItemsVariableCompensationTimeline", "type": "string" }, "EorContractsContractIdAmendmentsGetResponsesContentApplicationJsonSchemaDataItemsVariableCompensationType": { "description": "The way the compensation is calculated. `FIXED` means a fixed amount (like $1000). `PERCENTAGE` means it’s based on a percentage of the salary.", "enum": [ "FIXED", "PERCENTAGE" ], "title": "EorContractsContractIdAmendmentsGetResponsesContentApplicationJsonSchemaDataItemsVariableCompensationType", "type": "string" }, "EorContractsContractIdAmendmentsGetResponsesContentApplicationJsonSchemaDataItemsVoidDeadlineType": { "description": "Type of void deadline", "enum": [ "CUTOFF", "START_DATE", "END_DATE", "EXPIRY" ], "title": "EorContractsContractIdAmendmentsGetResponsesContentApplicationJsonSchemaDataItemsVoidDeadlineType", "type": "string" }, "EorContractsContractIdAmendmentsGetResponsesContentApplicationJsonSchemaErrorsItems": { "properties": { "code": { "type": "string" }, "message": { "type": "string" } }, "required": [ "code", "message" ], "title": "EorContractsContractIdAmendmentsGetResponsesContentApplicationJsonSchemaErrorsItems", "type": "object" }, "EorContractsContractIdAmendmentsPostRequestBodyContentApplicationJsonSchemaData": { "properties": { "additional_info": { "description": "Additional metadata related to job validation and categorisation", "oneOf": [ { "$ref": "#/components/schemas/EorContractsContractIdAmendmentsPostRequestBodyContentApplicationJsonSchemaDataAdditionalInfo" }, { "type": "null" } ] }, "custom": { "description": "An optional array of custom objects.", "items": { "$ref": "#/components/schemas/EorContractsContractIdAmendmentsPostRequestBodyContentApplicationJsonSchemaDataCustomItems" }, "type": "array" }, "effective_date": { "description": "Effective date for the amendment.", "format": "date", "type": "string" }, "employment_state": { "description": "State of employment.", "type": "string" }, "employment_type": { "$ref": "#/components/schemas/EorContractsContractIdAmendmentsPostRequestBodyContentApplicationJsonSchemaDataEmploymentType", "description": "Type of employment." }, "end_date": { "description": "End date of the employment.", "format": "date", "type": "string" }, "fixed_adjustments": { "description": "Array of fixed adjustments to be submitted for the amendment request.", "items": { "$ref": "#/components/schemas/EorContractsContractIdAmendmentsPostRequestBodyContentApplicationJsonSchemaDataFixedAdjustmentsItems" }, "type": "array" }, "holidays": { "description": "Number of holidays.", "format": "double", "type": "number" }, "hourly_rate": { "description": "Hourly rate of the amendment. The max value supported is 1e19", "format": "double", "type": "number" }, "job_title": { "description": "Job title associated with the amendment.", "maxLength": 1000, "type": "string" }, "notice_period_after_probation": { "description": "Notice period after probation.", "format": "double", "type": "number" }, "notice_period_during_probation": { "description": "Notice period during probation.", "format": "double", "type": "number" }, "notice_period_type": { "$ref": "#/components/schemas/EorContractsContractIdAmendmentsPostRequestBodyContentApplicationJsonSchemaDataNoticePeriodType", "description": "Type of notice period." }, "probation_period": { "description": "Duration of the probation period.", "format": "double", "type": "number" }, "probation_period_type_for_definite": { "$ref": "#/components/schemas/EorContractsContractIdAmendmentsPostRequestBodyContentApplicationJsonSchemaDataProbationPeriodTypeForDefinite", "description": "Type of probation period for definite contracts." }, "salary": { "description": "Salary for the amendment.", "format": "double", "type": "number" }, "scope": { "description": "Scope of the amendment.", "maxLength": 20000, "type": "string" }, "seniority_date": { "description": "The seniority date represents the employee’s original start date with a previous employer. It is used to preserve employment tenure when the employee transfers to this company. Can be null if not applicable.", "format": "date", "type": [ "string", "null" ] }, "seniority_id": { "description": "Public Id of the seniority level.", "format": "uuid", "type": "string" }, "start_date": { "description": "Start date of the employment.", "format": "date", "type": "string" }, "time_off_type": { "$ref": "#/components/schemas/EorContractsContractIdAmendmentsPostRequestBodyContentApplicationJsonSchemaDataTimeOffType", "description": "Type of time off." }, "variable_compensation": { "$ref": "#/components/schemas/EorContractsContractIdAmendmentsPostRequestBodyContentApplicationJsonSchemaDataVariableCompensation", "description": "Represents a change to an employee’s variable compensation (e.g., bonus or commission). This schema is used for creating new variable compensation items or updating existing ones. Some fields are required when creating, optional when updating, and forbidden when updating, as specified in each field description." }, "work_hours_per_week": { "description": "Number of work hours per week.", "format": "double", "type": "number" } }, "title": "EorContractsContractIdAmendmentsPostRequestBodyContentApplicationJsonSchemaData", "type": "object" }, "EorContractsContractIdAmendmentsPostRequestBodyContentApplicationJsonSchemaDataAdditionalInfo": { "description": "Additional metadata related to job validation and categorisation", "properties": { "ai_scope_check_public_id": { "description": "Identifier or flag for AI scope validation check", "format": "uuid", "type": "string" }, "job_categorization_log_id": { "description": "Identifier for job categorisation log", "format": "uuid", "type": "string" } }, "title": "EorContractsContractIdAmendmentsPostRequestBodyContentApplicationJsonSchemaDataAdditionalInfo", "type": "object" }, "EorContractsContractIdAmendmentsPostRequestBodyContentApplicationJsonSchemaDataCustomItems": { "properties": { "description": { "description": "A required description for the custom object.", "maxLength": 1000, "minLength": 50, "type": "string" }, "id": { "description": "An optional identifier for the custom object.", "format": "uuid", "type": "string" }, "type": { "description": "The type of the custom object. Must be one of the valid custom types.", "type": "string" } }, "required": [ "type", "description" ], "title": "EorContractsContractIdAmendmentsPostRequestBodyContentApplicationJsonSchemaDataCustomItems", "type": "object" }, "EorContractsContractIdAmendmentsPostRequestBodyContentApplicationJsonSchemaDataEmploymentType": { "description": "Type of employment.", "enum": [ "FULL_TIME", "PART_TIME" ], "title": "EorContractsContractIdAmendmentsPostRequestBodyContentApplicationJsonSchemaDataEmploymentType", "type": "string" }, "EorContractsContractIdAmendmentsPostRequestBodyContentApplicationJsonSchemaDataFixedAdjustmentsItems": { "properties": { "description": { "description": "Description of the fixed adjustment.", "maxLength": 256, "minLength": 1, "type": "string" }, "id": { "description": "The ID of an existing active fixed adjustment to update or delete. Include this in the request only if you are updating or deleting an existing adjustment. Do not include it when creating a new one.", "type": "string" }, "is_deleted": { "description": "Flag to mark the fixed adjustment as deleted. Required only when the fixed adjustment needs to be removed; omit it otherwise.", "type": "boolean" }, "is_recurring": { "description": "Whether the fixed adjustment is recurring. If set to false, it will be treated as a one-time fixed allowance.", "type": "boolean" }, "value": { "description": "Value of the fixed adjustment. Must be a positive number, not zero.", "pattern": "^(?!0+(\\.0+)?$)\\d+(?:\\.\\d+)?$", "type": "string" } }, "required": [ "value", "description", "is_recurring" ], "title": "EorContractsContractIdAmendmentsPostRequestBodyContentApplicationJsonSchemaDataFixedAdjustmentsItems", "type": "object" }, "EorContractsContractIdAmendmentsPostRequestBodyContentApplicationJsonSchemaDataNoticePeriodType": { "description": "Type of notice period.", "enum": [ "STANDARD", "CUSTOM" ], "title": "EorContractsContractIdAmendmentsPostRequestBodyContentApplicationJsonSchemaDataNoticePeriodType", "type": "string" }, "EorContractsContractIdAmendmentsPostRequestBodyContentApplicationJsonSchemaDataProbationPeriodTypeForDefinite": { "description": "Type of probation period for definite contracts.", "enum": [ "STANDARD", "CUSTOM" ], "title": "EorContractsContractIdAmendmentsPostRequestBodyContentApplicationJsonSchemaDataProbationPeriodTypeForDefinite", "type": "string" }, "EorContractsContractIdAmendmentsPostRequestBodyContentApplicationJsonSchemaDataTimeOffType": { "description": "Type of time off.", "enum": [ "STANDARD", "SPECIFIC", "PRORATED" ], "title": "EorContractsContractIdAmendmentsPostRequestBodyContentApplicationJsonSchemaDataTimeOffType", "type": "string" }, "EorContractsContractIdAmendmentsPostRequestBodyContentApplicationJsonSchemaDataVariableCompensation": { "description": "Represents a change to an employee’s variable compensation (e.g., bonus or commission). This schema is used for creating new variable compensation items or updating existing ones. Some fields are required when creating, optional when updating, and forbidden when updating, as specified in each field description.", "properties": { "amount": { "description": "Positive amount for the variable compensation.", "format": "double", "minimum": 0, "type": "number" }, "effective_date": { "description": "The date when this compensation starts or becomes effective. Required when creating a new compensation. Optional when updating an existing compensation.", "format": "date", "type": "string" }, "id": { "description": "The ID of an existing active variable compensation to update or delete. Include this in the request only if you are updating or deleting an existing compensation. Do not include it when creating a new one.", "type": "string" }, "is_deleted": { "description": "Flag to mark the variable compensation as deleted. Required only when the variable compensation needs to be removed; omit it otherwise", "type": "boolean" }, "timeline": { "$ref": "#/components/schemas/EorContractsContractIdAmendmentsPostRequestBodyContentApplicationJsonSchemaDataVariableCompensationTimeline", "description": "How often this compensation occurs. Required when creating a new compensation. Forbidden when updating an existing compensation." }, "title": { "description": "The title of the compensation. Required when creating a new compensation. Optional when updating an existing compensation.", "maxLength": 250, "minLength": 1, "type": "string" }, "type": { "$ref": "#/components/schemas/EorContractsContractIdAmendmentsPostRequestBodyContentApplicationJsonSchemaDataVariableCompensationType", "description": "Type of variable compensation." } }, "required": [ "type", "amount" ], "title": "EorContractsContractIdAmendmentsPostRequestBodyContentApplicationJsonSchemaDataVariableCompensation", "type": "object" }, "EorContractsContractIdAmendmentsPostRequestBodyContentApplicationJsonSchemaDataVariableCompensationTimeline": { "description": "How often this compensation occurs. Required when creating a new compensation. Forbidden when updating an existing compensation.", "enum": [ "MONTHLY", "QUARTERLY", "ANNUALLY", "BIANNUALLY" ], "title": "EorContractsContractIdAmendmentsPostRequestBodyContentApplicationJsonSchemaDataVariableCompensationTimeline", "type": "string" }, "EorContractsContractIdAmendmentsPostRequestBodyContentApplicationJsonSchemaDataVariableCompensationType": { "description": "Type of variable compensation.", "enum": [ "PERCENTAGE", "FIXED" ], "title": "EorContractsContractIdAmendmentsPostRequestBodyContentApplicationJsonSchemaDataVariableCompensationType", "type": "string" }, "EorContractsContractIdAmendmentsPostResponsesContentApplicationJsonSchemaData": { "properties": { "amendment_statuses": { "description": "List of amendment statuses representing the history and progression of an amendment.", "items": { "$ref": "#/components/schemas/EorContractsContractIdAmendmentsPostResponsesContentApplicationJsonSchemaDataAmendmentStatusesItems" }, "type": "array" }, "created_at": { "description": "Creation date of the amendment.", "format": "date-time", "type": "string" }, "currency": { "description": "Contract currency.", "type": "string" }, "custom_items": { "description": "Custom amendment items associated with the amendment flow", "items": { "$ref": "#/components/schemas/EorContractsContractIdAmendmentsPostResponsesContentApplicationJsonSchemaDataCustomItemsItems" }, "type": "array" }, "description": { "description": "Free-text description of the amendment.", "type": [ "string", "null" ] }, "document_type": { "description": "Amendment document type", "oneOf": [ { "$ref": "#/components/schemas/EorContractsContractIdAmendmentsPostResponsesContentApplicationJsonSchemaDataDocumentType" }, { "type": "null" } ] }, "effective_date": { "description": "Effective date of the amendment.", "format": "date-time", "type": [ "string", "null" ] }, "employee_nationality": { "description": "Nationality of the employee.", "type": "string" }, "employment_state": { "description": "State of employment.", "type": [ "string", "null" ] }, "employment_type": { "$ref": "#/components/schemas/EorContractsContractIdAmendmentsPostResponsesContentApplicationJsonSchemaDataEmploymentType", "description": "Type of employment." }, "end_date": { "description": "End date of the employment.", "format": "date-time", "type": [ "string", "null" ] }, "fixed_adjustments": { "description": "List of fixed adjustments associated with the amendment request.", "items": { "$ref": "#/components/schemas/EorContractsContractIdAmendmentsPostResponsesContentApplicationJsonSchemaDataFixedAdjustmentsItems" }, "type": "array" }, "holidays": { "description": "Number of holidays.", "type": [ "integer", "null" ] }, "hourly_rate": { "description": "Hourly rate of the amendment", "type": [ "string", "null" ] }, "id": { "description": "Id of amendment", "format": "uuid", "type": "string" }, "is_effective_date_updated": { "description": "Is Effective Date updated.", "type": "boolean" }, "is_hrx_action_needed": { "description": "Is HRX action needed.", "type": "boolean" }, "items": { "description": "Items of amendment", "items": { "$ref": "#/components/schemas/EorContractsContractIdAmendmentsPostResponsesContentApplicationJsonSchemaDataItemsItems" }, "type": "array" }, "job_category": { "description": "Job category associated with the job title.", "type": [ "string", "null" ] }, "job_code": { "description": "Job code associated with the job title.", "type": [ "string", "null" ] }, "job_title": { "description": "Job title associated with the amendment.", "maxLength": 1000, "type": "string" }, "legal_context": { "description": "Additional details needed for legal input", "oneOf": [ { "$ref": "#/components/schemas/EorContractsContractIdAmendmentsPostResponsesContentApplicationJsonSchemaDataLegalContext" }, { "type": "null" } ] }, "net_salary": { "description": "Net salary for the amendment.", "type": [ "string", "null" ] }, "notice_period_after_probation": { "description": "Notice period after probation.", "type": [ "string", "null" ] }, "notice_period_during_probation": { "description": "Notice period during probation.", "type": [ "string", "null" ] }, "notice_period_time_unit": { "description": "Notice period time unit.", "oneOf": [ { "$ref": "#/components/schemas/EorContractsContractIdAmendmentsPostResponsesContentApplicationJsonSchemaDataNoticePeriodTimeUnit" }, { "type": "null" } ] }, "notice_period_type": { "description": "Type of notice period.", "oneOf": [ { "$ref": "#/components/schemas/EorContractsContractIdAmendmentsPostResponsesContentApplicationJsonSchemaDataNoticePeriodType" }, { "type": "null" } ] }, "probation_period": { "description": "Duration of the probation period.", "type": [ "integer", "null" ] }, "probation_period_type_for_definite": { "description": "Type of probation period for definite contracts.", "oneOf": [ { "$ref": "#/components/schemas/EorContractsContractIdAmendmentsPostResponsesContentApplicationJsonSchemaDataProbationPeriodTypeForDefinite" }, { "type": "null" } ] }, "rejection_context": { "description": "Additional details containing rejection reason", "oneOf": [ { "$ref": "#/components/schemas/EorContractsContractIdAmendmentsPostResponsesContentApplicationJsonSchemaDataRejectionContext" }, { "type": "null" } ] }, "requested_by": { "description": "Profile name of the user who requested the change", "type": [ "string", "null" ] }, "salary": { "description": "Salary for the amendment.", "type": "string" }, "scope": { "description": "Scope of the amendment.", "type": "string" }, "seniority_date": { "description": "The seniority date represents the employee’s original start date with a previous employer. It is used to preserve employment tenure when the employee transfers to this company. Can be null if not applicable.", "format": "date-time", "type": [ "string", "null" ] }, "seniority_id": { "description": "Seniority level identifier.", "format": "uuid", "type": [ "string", "null" ] }, "sick_leave_days": { "description": "Number of sick leave days", "type": [ "integer", "null" ] }, "source": { "description": "Source of amendment flow creation.", "oneOf": [ { "$ref": "#/components/schemas/EorContractsContractIdAmendmentsPostResponsesContentApplicationJsonSchemaDataSource" }, { "type": "null" } ] }, "start_date": { "description": "Start date of the employment.", "format": "date-time", "type": "string" }, "time_off_type": { "$ref": "#/components/schemas/EorContractsContractIdAmendmentsPostResponsesContentApplicationJsonSchemaDataTimeOffType", "description": "Type of time off." }, "type": { "description": "Type of amendment", "oneOf": [ { "$ref": "#/components/schemas/EorContractsContractIdAmendmentsPostResponsesContentApplicationJsonSchemaDataType" }, { "type": "null" } ] }, "updated_at": { "description": "Date when amendment is updated", "format": "date-time", "type": "string" }, "variable_compensation": { "$ref": "#/components/schemas/EorContractsContractIdAmendmentsPostResponsesContentApplicationJsonSchemaDataVariableCompensation", "description": "Represents a variable compensation record (such as a bonus, commission, or incentive) within a contract. It contains details like the amount, type, frequency, and whether it is part of an incentive plan. The record also tracks when it was created, updated, and whether it has been amended." }, "void_deadline": { "description": "Deadline this SOW to be voided", "format": "date-time", "type": [ "string", "null" ] }, "void_deadline_type": { "description": "Type of void deadline", "oneOf": [ { "$ref": "#/components/schemas/EorContractsContractIdAmendmentsPostResponsesContentApplicationJsonSchemaDataVoidDeadlineType" }, { "type": "null" } ] }, "work_hours_per_week": { "description": "Number of work hours per week.", "type": "string" }, "work_schedule_id": { "description": "Work schedule id", "format": "uuid", "type": [ "string", "null" ] }, "work_schedule_rules_version": { "description": "Work schedule rule version.", "type": [ "string", "null" ] } }, "title": "EorContractsContractIdAmendmentsPostResponsesContentApplicationJsonSchemaData", "type": "object" }, "EorContractsContractIdAmendmentsPostResponsesContentApplicationJsonSchemaDataAmendmentStatusesItems": { "properties": { "amendment_flow_status": { "$ref": "#/components/schemas/EorContractsContractIdAmendmentsPostResponsesContentApplicationJsonSchemaDataAmendmentStatusesItemsAmendmentFlowStatus", "description": "Metadata about the amendment status, including when it was created." }, "friendly_name": { "description": "Friendly name of amendment status", "type": "string" }, "name": { "description": "Logical, system-oriented identifier of the amendment status. Can be used to group statuses under a parent category and subgroup them for more granular state tracking. The structure typically follows a dot-separated hierarchy (e.g., 'PARENT','PARENT.CHILD', 'PARENT.CHILD.CHILD.CHILD', ...), which allows logical grouping and filtering of related statuses.", "type": "string" } }, "title": "EorContractsContractIdAmendmentsPostResponsesContentApplicationJsonSchemaDataAmendmentStatusesItems", "type": "object" }, "EorContractsContractIdAmendmentsPostResponsesContentApplicationJsonSchemaDataAmendmentStatusesItemsAmendmentFlowStatus": { "description": "Metadata about the amendment status, including when it was created.", "properties": { "created_at": { "description": "Creation date", "format": "date-time", "type": "string" } }, "title": "EorContractsContractIdAmendmentsPostResponsesContentApplicationJsonSchemaDataAmendmentStatusesItemsAmendmentFlowStatus", "type": "object" }, "EorContractsContractIdAmendmentsPostResponsesContentApplicationJsonSchemaDataCustomItemsItems": { "properties": { "description": { "description": "Detailed description of the custom amendment item", "type": [ "string", "null" ] }, "id": { "description": "Unique identifier for the custom amendment item", "format": "uuid", "type": "string" }, "rejection_reason": { "description": "Reason for rejection if the item was rejected", "type": [ "string", "null" ] }, "status": { "$ref": "#/components/schemas/EorContractsContractIdAmendmentsPostResponsesContentApplicationJsonSchemaDataCustomItemsItemsStatus", "description": "Current status of the custom amendment item" }, "type": { "description": "Type/context of the custom amendment item", "type": "string" } }, "required": [ "id", "type", "status" ], "title": "EorContractsContractIdAmendmentsPostResponsesContentApplicationJsonSchemaDataCustomItemsItems", "type": "object" }, "EorContractsContractIdAmendmentsPostResponsesContentApplicationJsonSchemaDataCustomItemsItemsStatus": { "description": "Current status of the custom amendment item", "enum": [ "REJECTED", "APPROVED", "PENDING_REVIEW", "PENDING_LEGAL" ], "title": "EorContractsContractIdAmendmentsPostResponsesContentApplicationJsonSchemaDataCustomItemsItemsStatus", "type": "string" }, "EorContractsContractIdAmendmentsPostResponsesContentApplicationJsonSchemaDataDocumentType": { "description": "Amendment document type", "enum": [ "EA", "SOW", "SOW_EA" ], "title": "EorContractsContractIdAmendmentsPostResponsesContentApplicationJsonSchemaDataDocumentType", "type": "string" }, "EorContractsContractIdAmendmentsPostResponsesContentApplicationJsonSchemaDataEmploymentType": { "description": "Type of employment.", "enum": [ "FULL_TIME", "PART_TIME" ], "title": "EorContractsContractIdAmendmentsPostResponsesContentApplicationJsonSchemaDataEmploymentType", "type": "string" }, "EorContractsContractIdAmendmentsPostResponsesContentApplicationJsonSchemaDataFixedAdjustmentsItems": { "properties": { "created_at": { "description": "Timestamp when the fixed adjustment was created.", "format": "date-time", "type": "string" }, "description": { "description": "Description of the fixed adjustment.", "maxLength": 256, "minLength": 1, "type": "string" }, "id": { "description": "System-generated unique identifier for the fixed adjustment record in an amendment request.", "type": "string" }, "is_amended": { "description": "Whether this fixed adjustment was amended from a previous one.", "type": "boolean" }, "is_country_specific": { "description": "Whether this fixed adjustment applies only to a specific country.", "type": "boolean" }, "is_deleted": { "description": "True if the fixed adjustment was deleted as part of the amendment; otherwise false.", "type": "boolean" }, "is_recurring": { "description": "Whether the fixed adjustment is recurring. If set to false, it will be treated as a one-time fixed allowance.", "type": "boolean" }, "parent_fixed_adjustment_id": { "description": "Reference to the parent fixed adjustment, if applicable.", "type": [ "string", "null" ] }, "status": { "$ref": "#/components/schemas/EorContractsContractIdAmendmentsPostResponsesContentApplicationJsonSchemaDataFixedAdjustmentsItemsStatus", "description": "Current status of the fixed adjustment." }, "updated_at": { "description": "Timestamp when the fixed adjustment was last updated.", "format": "date-time", "type": "string" }, "value": { "description": "Value of the fixed adjustment.", "pattern": "^(?!0+(\\.0+)?$)\\d+(?:\\.\\d+)?$", "type": "string" } }, "required": [ "id", "value", "status", "created_at", "is_amended", "updated_at", "description", "is_recurring", "is_country_specific" ], "title": "EorContractsContractIdAmendmentsPostResponsesContentApplicationJsonSchemaDataFixedAdjustmentsItems", "type": "object" }, "EorContractsContractIdAmendmentsPostResponsesContentApplicationJsonSchemaDataFixedAdjustmentsItemsStatus": { "description": "Current status of the fixed adjustment.", "enum": [ "WAITING_FOR_SIGNING", "ACTIVE", "OUTDATED", "CANCELLED" ], "title": "EorContractsContractIdAmendmentsPostResponsesContentApplicationJsonSchemaDataFixedAdjustmentsItemsStatus", "type": "string" }, "EorContractsContractIdAmendmentsPostResponsesContentApplicationJsonSchemaDataItemsItems": { "properties": { "data_point": { "description": "The field that is selected for amendment.", "type": "string" }, "id": { "description": "Id of amendment item", "format": "uuid", "type": "string" }, "item": { "description": "Amendment item", "type": "string" }, "new_value": { "description": "The new valid value after the attempted change.", "type": "string" }, "previous_value": { "description": "The previous valid value before the attempted change.", "type": "string" }, "type": { "$ref": "#/components/schemas/EorContractsContractIdAmendmentsPostResponsesContentApplicationJsonSchemaDataItemsItemsType", "description": "Type of amendment" } }, "title": "EorContractsContractIdAmendmentsPostResponsesContentApplicationJsonSchemaDataItemsItems", "type": "object" }, "EorContractsContractIdAmendmentsPostResponsesContentApplicationJsonSchemaDataItemsItemsType": { "description": "Type of amendment", "enum": [ "INSTANT", "OPS", "LEGAL", "DISABLED", "CUSTOM", "AUTOMATED" ], "title": "EorContractsContractIdAmendmentsPostResponsesContentApplicationJsonSchemaDataItemsItemsType", "type": "string" }, "EorContractsContractIdAmendmentsPostResponsesContentApplicationJsonSchemaDataLegalContext": { "description": "Additional details needed for legal input", "properties": { "details": { "description": "Details regarding the legal request", "type": "string" }, "jira_ticket": { "description": "Jira ticket identifier linked to the legal context", "type": "string" }, "jira_web_url": { "description": "Link to the Jira ticket for tracking", "format": "uri", "type": "string" }, "requested_at": { "description": "Timestamp when legal review was requested", "format": "date-time", "type": "string" }, "status": { "$ref": "#/components/schemas/EorContractsContractIdAmendmentsPostResponsesContentApplicationJsonSchemaDataLegalContextStatus", "description": "Current status of the legal review process" } }, "title": "EorContractsContractIdAmendmentsPostResponsesContentApplicationJsonSchemaDataLegalContext", "type": "object" }, "EorContractsContractIdAmendmentsPostResponsesContentApplicationJsonSchemaDataLegalContextStatus": { "description": "Current status of the legal review process", "enum": [ "REQUEST_LEGAL_REVIEW", "WAITING_FOR_ANOTHER_TEAM", "WAITING_FOR_HRX_ACTION", "DECLINED", "SOLVED" ], "title": "EorContractsContractIdAmendmentsPostResponsesContentApplicationJsonSchemaDataLegalContextStatus", "type": "string" }, "EorContractsContractIdAmendmentsPostResponsesContentApplicationJsonSchemaDataNoticePeriodTimeUnit": { "description": "Notice period time unit.", "enum": [ "DAY", "WEEK", "MONTH" ], "title": "EorContractsContractIdAmendmentsPostResponsesContentApplicationJsonSchemaDataNoticePeriodTimeUnit", "type": "string" }, "EorContractsContractIdAmendmentsPostResponsesContentApplicationJsonSchemaDataNoticePeriodType": { "description": "Type of notice period.", "enum": [ "STANDARD", "CUSTOM" ], "title": "EorContractsContractIdAmendmentsPostResponsesContentApplicationJsonSchemaDataNoticePeriodType", "type": "string" }, "EorContractsContractIdAmendmentsPostResponsesContentApplicationJsonSchemaDataProbationPeriodTypeForDefinite": { "description": "Type of probation period for definite contracts.", "enum": [ "STANDARD", "CUSTOM" ], "title": "EorContractsContractIdAmendmentsPostResponsesContentApplicationJsonSchemaDataProbationPeriodTypeForDefinite", "type": "string" }, "EorContractsContractIdAmendmentsPostResponsesContentApplicationJsonSchemaDataRejectionContext": { "description": "Additional details containing rejection reason", "properties": { "rejected_at": { "description": "Timestamp of when the rejection occurred", "format": "date-time", "type": "string" }, "rejection_reason": { "description": "Reason provided when the amendment was rejected. Null when the amendment was cancelled rather than rejected by an admin.", "type": [ "string", "null" ] } }, "title": "EorContractsContractIdAmendmentsPostResponsesContentApplicationJsonSchemaDataRejectionContext", "type": "object" }, "EorContractsContractIdAmendmentsPostResponsesContentApplicationJsonSchemaDataSource": { "description": "Source of amendment flow creation.", "enum": [ "APP", "PUBLIC_API", "APP_BULK_AMENDMENT" ], "title": "EorContractsContractIdAmendmentsPostResponsesContentApplicationJsonSchemaDataSource", "type": "string" }, "EorContractsContractIdAmendmentsPostResponsesContentApplicationJsonSchemaDataTimeOffType": { "description": "Type of time off.", "enum": [ "STANDARD", "SPECIFIC", "PRORATED" ], "title": "EorContractsContractIdAmendmentsPostResponsesContentApplicationJsonSchemaDataTimeOffType", "type": "string" }, "EorContractsContractIdAmendmentsPostResponsesContentApplicationJsonSchemaDataType": { "description": "Type of amendment", "enum": [ "INSTANT", "OPS", "LEGAL", "DISABLED", "CUSTOM", "AUTOMATED" ], "title": "EorContractsContractIdAmendmentsPostResponsesContentApplicationJsonSchemaDataType", "type": "string" }, "EorContractsContractIdAmendmentsPostResponsesContentApplicationJsonSchemaDataVariableCompensation": { "description": "Represents a variable compensation record (such as a bonus, commission, or incentive) within a contract. It contains details like the amount, type, frequency, and whether it is part of an incentive plan. The record also tracks when it was created, updated, and whether it has been amended.", "properties": { "amount": { "description": "The value of the compensation. Shown as a string to keep the exact number of decimals.", "format": "decimal", "type": "string" }, "created_at": { "description": "The date and time when this record was first created in the system.", "format": "date-time", "type": "string" }, "effective_date": { "description": "The date when this compensation starts being valid.", "format": "date-time", "type": "string" }, "id": { "description": "The unique ID assigned by the system to this variable compensation record.", "type": "string" }, "incentive_plan": { "$ref": "#/components/schemas/EorContractsContractIdAmendmentsPostResponsesContentApplicationJsonSchemaDataVariableCompensationIncentivePlan", "description": "Details of the incentive plan linked to this compensation, if any." }, "is_amended": { "description": "Shows whether this compensation has been changed as part of an amendment.", "type": "boolean" }, "is_deleted": { "description": "Shows whether this compensation has been deleted.", "type": "boolean" }, "parent_id": { "description": "Reference to the parent variable compensation, if applicable. Null if this compensation is not linked to any compensation.", "type": [ "string", "null" ] }, "timeline": { "$ref": "#/components/schemas/EorContractsContractIdAmendmentsPostResponsesContentApplicationJsonSchemaDataVariableCompensationTimeline", "description": "How often the compensation is paid — for example monthly, quarterly, annually, or twice a year." }, "title": { "description": "Title or name of the variable compensation.", "type": "string" }, "type": { "$ref": "#/components/schemas/EorContractsContractIdAmendmentsPostResponsesContentApplicationJsonSchemaDataVariableCompensationType", "description": "The way the compensation is calculated. `FIXED` means a fixed amount (like $1000). `PERCENTAGE` means it’s based on a percentage of the salary." }, "updated_at": { "description": "The date and time when this record was last updated.", "format": "date-time", "type": "string" } }, "required": [ "id", "type", "title", "amount", "timeline", "parent_id", "created_at", "updated_at", "effective_date" ], "title": "EorContractsContractIdAmendmentsPostResponsesContentApplicationJsonSchemaDataVariableCompensation", "type": "object" }, "EorContractsContractIdAmendmentsPostResponsesContentApplicationJsonSchemaDataVariableCompensationIncentivePlan": { "description": "Details of the incentive plan linked to this compensation, if any.", "properties": { "details": { "description": "Extra details about the incentive plan, if any.", "type": "string" }, "employee_signature": { "description": "The employee’s signature for the incentive plan, if collected.", "type": "string" }, "employee_signed_at": { "description": "The date and time when the employee signed the incentive plan. Empty if not signed.", "format": "date-time", "type": "string" } }, "title": "EorContractsContractIdAmendmentsPostResponsesContentApplicationJsonSchemaDataVariableCompensationIncentivePlan", "type": "object" }, "EorContractsContractIdAmendmentsPostResponsesContentApplicationJsonSchemaDataVariableCompensationTimeline": { "description": "How often the compensation is paid — for example monthly, quarterly, annually, or twice a year.", "enum": [ "MONTHLY", "QUARTERLY", "ANNUALLY", "BIANNUALLY" ], "title": "EorContractsContractIdAmendmentsPostResponsesContentApplicationJsonSchemaDataVariableCompensationTimeline", "type": "string" }, "EorContractsContractIdAmendmentsPostResponsesContentApplicationJsonSchemaDataVariableCompensationType": { "description": "The way the compensation is calculated. `FIXED` means a fixed amount (like $1000). `PERCENTAGE` means it’s based on a percentage of the salary.", "enum": [ "FIXED", "PERCENTAGE" ], "title": "EorContractsContractIdAmendmentsPostResponsesContentApplicationJsonSchemaDataVariableCompensationType", "type": "string" }, "EorContractsContractIdAmendmentsPostResponsesContentApplicationJsonSchemaDataVoidDeadlineType": { "description": "Type of void deadline", "enum": [ "CUTOFF", "START_DATE", "END_DATE", "EXPIRY" ], "title": "EorContractsContractIdAmendmentsPostResponsesContentApplicationJsonSchemaDataVoidDeadlineType", "type": "string" }, "EorContractsContractIdAmendmentsPostResponsesContentApplicationJsonSchemaErrorsItems": { "properties": { "code": { "type": "string" }, "message": { "type": "string" } }, "required": [ "code", "message" ], "title": "EorContractsContractIdAmendmentsPostResponsesContentApplicationJsonSchemaErrorsItems", "type": "object" }, "EorContractsContractIdAmendmentsValidatePostResponsesContentApplicationJsonSchemaData": { "properties": { "message": { "description": "Validation message for the field, present when the value is invalid.", "type": [ "string", "null" ] }, "valid": { "description": "Whether the submitted value for this field is valid.", "type": [ "boolean", "null" ] } }, "title": "EorContractsContractIdAmendmentsValidatePostResponsesContentApplicationJsonSchemaData", "type": "object" }, "EorContractsContractIdAmendmentsValidatePostResponsesContentApplicationJsonSchemaErrorsItems": { "properties": { "code": { "type": "string" }, "message": { "type": "string" } }, "required": [ "code", "message" ], "title": "EorContractsContractIdAmendmentsValidatePostResponsesContentApplicationJsonSchemaErrorsItems", "type": "object" }, "EorContractsContractIdAmendmentsValidationSettingsGetResponsesContentApplicationJsonSchemaDataItems": { "properties": { "data_point": { "description": "The name of the data point being configured.", "type": "string" }, "rules": { "description": "The rules for the data point.", "items": { "$ref": "#/components/schemas/EorContractsContractIdAmendmentsValidationSettingsGetResponsesContentApplicationJsonSchemaDataItemsRulesItems" }, "type": "array" } }, "title": "EorContractsContractIdAmendmentsValidationSettingsGetResponsesContentApplicationJsonSchemaDataItems", "type": "object" }, "EorContractsContractIdAmendmentsValidationSettingsGetResponsesContentApplicationJsonSchemaDataItemsRulesItems": { "properties": { "additional_details": { "$ref": "#/components/schemas/EorContractsContractIdAmendmentsValidationSettingsGetResponsesContentApplicationJsonSchemaDataItemsRulesItemsAdditionalDetails", "description": "Optional additional information for rules, if applicable." }, "external_validation": { "description": "Indicates whether external validation/fetching is required for this data point. If yes, the information for this data point must be retrieved using another endpoint.", "type": "boolean" }, "is_editable": { "description": "Indicates whether the data point can be updated.", "type": "boolean" }, "max": { "description": "The maximum allowable value for numerical data points.", "format": "double", "type": "number" }, "max_date": { "description": "The latest allowable date for date-type data points.", "format": "date", "type": [ "string", "null" ] }, "min": { "description": "The minimum allowable value for numerical data points.", "format": "double", "type": [ "number", "null" ] }, "min_date": { "description": "The earliest allowable date for date-type data points.", "format": "date", "type": [ "string", "null" ] }, "nullable": { "description": "Indicates whether the data point can be null.", "type": "boolean" }, "possible_options": { "description": "A list of possible values the data point can have. Unique for each data point.", "items": { "type": "string" }, "type": "array" }, "requires": { "$ref": "#/components/schemas/EorContractsContractIdAmendmentsValidationSettingsGetResponsesContentApplicationJsonSchemaDataItemsRulesItemsRequires", "description": "Contract conditions that must be met for this rule to be applied." }, "tenure_based_rules": { "description": "Defines notice period rules based on the duration of employment.", "items": { "$ref": "#/components/schemas/EorContractsContractIdAmendmentsValidationSettingsGetResponsesContentApplicationJsonSchemaDataItemsRulesItemsTenureBasedRulesItems" }, "type": "array" } }, "title": "EorContractsContractIdAmendmentsValidationSettingsGetResponsesContentApplicationJsonSchemaDataItemsRulesItems", "type": "object" }, "EorContractsContractIdAmendmentsValidationSettingsGetResponsesContentApplicationJsonSchemaDataItemsRulesItemsAdditionalDetails": { "description": "Optional additional information for rules, if applicable.", "properties": { "cap": { "description": "The maximum limit imposed for probation period for definite contract when specific calculation is used, it will be in additional_details.rule.", "format": "double", "type": [ "number", "null" ] }, "note": { "description": "Additional explanation or notes related to this rule.", "type": [ "string", "null" ] }, "rule": { "description": "Specific rule that applies for probation period.", "oneOf": [ { "$ref": "#/components/schemas/EorContractsContractIdAmendmentsValidationSettingsGetResponsesContentApplicationJsonSchemaDataItemsRulesItemsAdditionalDetailsRule" }, { "type": "null" } ] }, "time_unit": { "description": "The unit of time applicable to notice period.", "oneOf": [ { "$ref": "#/components/schemas/EorContractsContractIdAmendmentsValidationSettingsGetResponsesContentApplicationJsonSchemaDataItemsRulesItemsAdditionalDetailsTimeUnit" }, { "type": "null" } ] } }, "title": "EorContractsContractIdAmendmentsValidationSettingsGetResponsesContentApplicationJsonSchemaDataItemsRulesItemsAdditionalDetails", "type": "object" }, "EorContractsContractIdAmendmentsValidationSettingsGetResponsesContentApplicationJsonSchemaDataItemsRulesItemsAdditionalDetailsRule": { "description": "Specific rule that applies for probation period.", "enum": [ "ONE_QUARTER_OF_CONTRACT_DURATION", "ONE_THIRD_OF_CONTRACT_DURATION", "HALF_OF_CONTRACT_DURATION" ], "title": "EorContractsContractIdAmendmentsValidationSettingsGetResponsesContentApplicationJsonSchemaDataItemsRulesItemsAdditionalDetailsRule", "type": "string" }, "EorContractsContractIdAmendmentsValidationSettingsGetResponsesContentApplicationJsonSchemaDataItemsRulesItemsAdditionalDetailsTimeUnit": { "description": "The unit of time applicable to notice period.", "enum": [ "WEEK", "MONTH", "DAY" ], "title": "EorContractsContractIdAmendmentsValidationSettingsGetResponsesContentApplicationJsonSchemaDataItemsRulesItemsAdditionalDetailsTimeUnit", "type": "string" }, "EorContractsContractIdAmendmentsValidationSettingsGetResponsesContentApplicationJsonSchemaDataItemsRulesItemsRequires": { "description": "Contract conditions that must be met for this rule to be applied.", "properties": {}, "title": "EorContractsContractIdAmendmentsValidationSettingsGetResponsesContentApplicationJsonSchemaDataItemsRulesItemsRequires", "type": "object" }, "EorContractsContractIdAmendmentsValidationSettingsGetResponsesContentApplicationJsonSchemaDataItemsRulesItemsTenureBasedRulesItems": { "properties": { "employment_duration_type": { "description": "The unit of measurement for the employment duration.", "oneOf": [ { "$ref": "#/components/schemas/EorContractsContractIdAmendmentsValidationSettingsGetResponsesContentApplicationJsonSchemaDataItemsRulesItemsTenureBasedRulesItemsEmploymentDurationType" }, { "type": "null" } ] }, "max_employment_duration": { "description": "The maximum duration of employment for this rule to apply.", "type": [ "integer", "null" ] }, "min_employment_duration": { "description": "The minimum duration of employment for this rule to apply.", "type": [ "integer", "null" ] }, "notice_value": { "description": "The required notice period for this range of employment duration.", "type": [ "integer", "null" ] } }, "title": "EorContractsContractIdAmendmentsValidationSettingsGetResponsesContentApplicationJsonSchemaDataItemsRulesItemsTenureBasedRulesItems", "type": "object" }, "EorContractsContractIdAmendmentsValidationSettingsGetResponsesContentApplicationJsonSchemaDataItemsRulesItemsTenureBasedRulesItemsEmploymentDurationType": { "description": "The unit of measurement for the employment duration.", "enum": [ "DAY", "WEEK", "MONTH", "YEAR" ], "title": "EorContractsContractIdAmendmentsValidationSettingsGetResponsesContentApplicationJsonSchemaDataItemsRulesItemsTenureBasedRulesItemsEmploymentDurationType", "type": "string" }, "EorContractsContractIdAmendmentsValidationSettingsGetResponsesContentApplicationJsonSchemaErrorsItems": { "properties": { "code": { "type": "string" }, "message": { "type": "string" } }, "required": [ "code", "message" ], "title": "EorContractsContractIdAmendmentsValidationSettingsGetResponsesContentApplicationJsonSchemaErrorsItems", "type": "object" }, "EorContractsContractIdDetailsGetResponsesContentApplicationJsonSchemaCanAdjustOn": { "description": "Time frame when adjustments can be made.", "properties": { "end": { "description": "End of the period when adjustments can be made.", "type": "string" }, "start": { "description": "Start of the period when adjustments can be made.", "type": "string" } }, "title": "EorContractsContractIdDetailsGetResponsesContentApplicationJsonSchemaCanAdjustOn", "type": "object" }, "EorContractsContractIdDetailsGetResponsesContentApplicationJsonSchemaCompensationType": { "description": "Compensation type for the contract.", "enum": [ "HOURLY", "ANNUAL" ], "title": "EorContractsContractIdDetailsGetResponsesContentApplicationJsonSchemaCompensationType", "type": "string" }, "EorContractsContractIdDetailsGetResponsesContentApplicationJsonSchemaContractType": { "description": "The type of contract.", "enum": [ "eor" ], "title": "EorContractsContractIdDetailsGetResponsesContentApplicationJsonSchemaContractType", "type": "string" }, "EorContractsContractIdDetailsGetResponsesContentApplicationJsonSchemaCreator": { "properties": { "email": { "description": "The email address of the contract creator.", "type": "string" }, "firstname": { "description": "The first name of the contract creator.", "type": "string" }, "name": { "description": "The name of the contract creator.", "type": "string" } }, "title": "EorContractsContractIdDetailsGetResponsesContentApplicationJsonSchemaCreator", "type": "object" }, "EorContractsContractIdDetailsGetResponsesContentApplicationJsonSchemaEmployee": { "description": "Employee details", "properties": { "email": { "description": "The email of the employee.", "type": "string" }, "first_name": { "description": "The first name of the employee.", "type": "string" }, "last_name": { "description": "The last name of the employee.", "type": "string" }, "legal_name": { "description": "The legal name of the employee.", "type": "string" }, "nationality": { "description": "Two letter country code of the employee nationality.", "type": "string" }, "pic_url": { "description": "URL to employee's picture.", "type": [ "string", "null" ] } }, "title": "EorContractsContractIdDetailsGetResponsesContentApplicationJsonSchemaEmployee", "type": "object" }, "EorContractsContractIdDetailsGetResponsesContentApplicationJsonSchemaEmploymentCosts": { "description": "Detailed breakdown of employment costs including summary totals, sectioned cost groups, and additional context notes.", "properties": { "additional_data": { "$ref": "#/components/schemas/EorContractsContractIdDetailsGetResponsesContentApplicationJsonSchemaEmploymentCostsAdditionalData", "description": "Supplementary notes and contextual information relevant to the cost quote." }, "sections": { "description": "Detailed and categorized cost sections including grouped and standalone items.", "items": { "$ref": "#/components/schemas/EorContractsContractIdDetailsGetResponsesContentApplicationJsonSchemaEmploymentCostsSectionsItems" }, "type": "array" }, "summary": { "$ref": "#/components/schemas/EorContractsContractIdDetailsGetResponsesContentApplicationJsonSchemaEmploymentCostsSummary", "description": "Top-level overview of costs, including key totals and currency metadata." } }, "title": "EorContractsContractIdDetailsGetResponsesContentApplicationJsonSchemaEmploymentCosts", "type": "object" }, "EorContractsContractIdDetailsGetResponsesContentApplicationJsonSchemaEmploymentCostsAdditionalData": { "description": "Supplementary notes and contextual information relevant to the cost quote.", "properties": { "additional_notes": { "description": "General conditions, assumptions, or fees that may apply to the quote.", "items": { "type": "string" }, "type": "array" }, "annual_notes": { "description": "Notes or assumptions specifically relevant to annual cost calculations.", "items": { "type": "string" }, "type": "array" }, "monthly_notes": { "description": "Notes or assumptions specifically relevant to monthly cost calculations.", "items": { "type": "string" }, "type": "array" }, "once_off_notes": { "description": "Notes regarding one-time costs or irregular payments in the quote.", "items": { "type": "string" }, "type": "array" } }, "title": "EorContractsContractIdDetailsGetResponsesContentApplicationJsonSchemaEmploymentCostsAdditionalData", "type": "object" }, "EorContractsContractIdDetailsGetResponsesContentApplicationJsonSchemaEmploymentCostsSectionsItems": { "properties": { "groups": { "description": "Collections of related costs grouped under a common label.", "items": { "$ref": "#/components/schemas/EorContractsContractIdDetailsGetResponsesContentApplicationJsonSchemaEmploymentCostsSectionsItemsGroupsItems" }, "type": "array" }, "is_summarized": { "description": "Indicates whether the section is presented in summarized form.", "type": "boolean" }, "label": { "description": "Display name for the cost section.", "type": "string" }, "name": { "description": "Internal identifier for the cost section (e.g., MONTHLY_EMPLOYMENT_BREAKDOWN).", "type": "string" }, "standalone_items": { "description": "Cost items that do not belong to regular groups, often irregular or one-off costs.", "items": { "$ref": "#/components/schemas/EorContractsContractIdDetailsGetResponsesContentApplicationJsonSchemaEmploymentCostsSectionsItemsStandaloneItemsItems" }, "type": "array" }, "totals": { "description": "Overall totals for the section, summing all groups and standalone items.", "items": { "$ref": "#/components/schemas/EorContractsContractIdDetailsGetResponsesContentApplicationJsonSchemaEmploymentCostsSectionsItemsTotalsItems" }, "type": "array" } }, "title": "EorContractsContractIdDetailsGetResponsesContentApplicationJsonSchemaEmploymentCostsSectionsItems", "type": "object" }, "EorContractsContractIdDetailsGetResponsesContentApplicationJsonSchemaEmploymentCostsSectionsItemsGroupsItems": { "properties": { "costs": { "description": "Individual cost items within the group.", "items": { "$ref": "#/components/schemas/EorContractsContractIdDetailsGetResponsesContentApplicationJsonSchemaEmploymentCostsSectionsItemsGroupsItemsCostsItems" }, "type": "array" }, "has_breakdown": { "description": "Indicates if the group contains multiple detailed cost items to be expanded.", "type": "boolean" }, "label": { "description": "Display name for the group (e.g., Gross Salary, Employer Cost).", "type": "string" }, "name": { "description": "Internal identifier for the group.", "type": "string" }, "totals": { "description": "Aggregated totals for all items within the group.", "items": { "$ref": "#/components/schemas/EorContractsContractIdDetailsGetResponsesContentApplicationJsonSchemaEmploymentCostsSectionsItemsGroupsItemsTotalsItems" }, "type": "array" } }, "title": "EorContractsContractIdDetailsGetResponsesContentApplicationJsonSchemaEmploymentCostsSectionsItemsGroupsItems", "type": "object" }, "EorContractsContractIdDetailsGetResponsesContentApplicationJsonSchemaEmploymentCostsSectionsItemsGroupsItemsCostsItems": { "properties": { "label": { "description": "Name of the specific cost item (e.g., Salary, Meal Voucher).", "type": "string" }, "totals": { "description": "Monthly and annual totals for the cost item in local and supporting currencies.", "items": { "$ref": "#/components/schemas/EorContractsContractIdDetailsGetResponsesContentApplicationJsonSchemaEmploymentCostsSectionsItemsGroupsItemsCostsItemsTotalsItems" }, "type": "array" } }, "title": "EorContractsContractIdDetailsGetResponsesContentApplicationJsonSchemaEmploymentCostsSectionsItemsGroupsItemsCostsItems", "type": "object" }, "EorContractsContractIdDetailsGetResponsesContentApplicationJsonSchemaEmploymentCostsSectionsItemsGroupsItemsCostsItemsTotalsItems": { "properties": { "frequency": { "description": "How often this cost occurs (e.g., monthly, annual, one-time).", "type": "string" }, "total": { "description": "Total cost amount in local currency.", "type": "string" }, "total_supporting": { "description": "Total cost amount in the supporting currency.", "type": "string" } }, "title": "EorContractsContractIdDetailsGetResponsesContentApplicationJsonSchemaEmploymentCostsSectionsItemsGroupsItemsCostsItemsTotalsItems", "type": "object" }, "EorContractsContractIdDetailsGetResponsesContentApplicationJsonSchemaEmploymentCostsSectionsItemsGroupsItemsTotalsItems": { "properties": { "frequency": { "description": "How often the total is calculated (e.g., monthly, annual).", "type": "string" }, "total": { "description": "Group total in local currency.", "type": "string" }, "total_supporting": { "description": "Group total in supporting currency.", "type": "string" } }, "title": "EorContractsContractIdDetailsGetResponsesContentApplicationJsonSchemaEmploymentCostsSectionsItemsGroupsItemsTotalsItems", "type": "object" }, "EorContractsContractIdDetailsGetResponsesContentApplicationJsonSchemaEmploymentCostsSectionsItemsStandaloneItemsItems": { "properties": { "label": { "description": "Display name for the standalone cost item.", "type": "string" }, "name": { "description": "Internal identifier for the standalone cost item.", "type": "string" }, "totals": { "description": "Monthly and annual totals for the standalone item in local and supporting currencies.", "items": { "$ref": "#/components/schemas/EorContractsContractIdDetailsGetResponsesContentApplicationJsonSchemaEmploymentCostsSectionsItemsStandaloneItemsItemsTotalsItems" }, "type": "array" } }, "title": "EorContractsContractIdDetailsGetResponsesContentApplicationJsonSchemaEmploymentCostsSectionsItemsStandaloneItemsItems", "type": "object" }, "EorContractsContractIdDetailsGetResponsesContentApplicationJsonSchemaEmploymentCostsSectionsItemsStandaloneItemsItemsTotalsItems": { "properties": { "frequency": { "description": "How often this cost occurs (e.g., monthly, annual, one-time).", "type": "string" }, "total": { "description": "Standalone cost amount in local currency.", "type": "string" }, "total_supporting": { "description": "Standalone cost amount in the supporting currency.", "type": "string" } }, "title": "EorContractsContractIdDetailsGetResponsesContentApplicationJsonSchemaEmploymentCostsSectionsItemsStandaloneItemsItemsTotalsItems", "type": "object" }, "EorContractsContractIdDetailsGetResponsesContentApplicationJsonSchemaEmploymentCostsSectionsItemsTotalsItems": { "properties": { "frequency": { "description": "How often the total is calculated (e.g., monthly, annual).", "type": "string" }, "total": { "description": "Total cost for the section in local currency.", "type": "string" }, "total_supporting": { "description": "Total cost for the section in supporting currency.", "type": "string" } }, "title": "EorContractsContractIdDetailsGetResponsesContentApplicationJsonSchemaEmploymentCostsSectionsItemsTotalsItems", "type": "object" }, "EorContractsContractIdDetailsGetResponsesContentApplicationJsonSchemaEmploymentCostsSummary": { "description": "Top-level overview of costs, including key totals and currency metadata.", "properties": { "currency": { "description": "Local currency code (e.g., BRL, PLN).", "type": "string" }, "exchange_rate": { "description": "Exchange rate used to convert from local to supporting currency.", "type": "string" }, "salary": { "description": "Annual gross salary in local currency.", "type": "string" }, "supporting_currency": { "description": "Reference or secondary currency (e.g., USD) used for reporting totals.", "type": "string" }, "totals_formatted": { "description": "Formatted summary totals in both local and supporting currencies.", "items": { "$ref": "#/components/schemas/EorContractsContractIdDetailsGetResponsesContentApplicationJsonSchemaEmploymentCostsSummaryTotalsFormattedItems" }, "type": "array" } }, "title": "EorContractsContractIdDetailsGetResponsesContentApplicationJsonSchemaEmploymentCostsSummary", "type": "object" }, "EorContractsContractIdDetailsGetResponsesContentApplicationJsonSchemaEmploymentCostsSummaryTotalsFormattedItems": { "properties": { "frequency": { "description": "Time period for the total (e.g., monthly, annual).", "type": "string" }, "title": { "description": "Display title for the total (e.g., 'Monthly Total').", "type": "string" }, "total": { "description": "Formatted amount in local currency.", "type": "string" }, "total_supporting": { "description": "Formatted amount in supporting currency.", "type": "string" } }, "title": "EorContractsContractIdDetailsGetResponsesContentApplicationJsonSchemaEmploymentCostsSummaryTotalsFormattedItems", "type": "object" }, "EorContractsContractIdDetailsGetResponsesContentApplicationJsonSchemaEmploymentType": { "description": "The type of employment.", "enum": [ "Full-time", "Part-time" ], "title": "EorContractsContractIdDetailsGetResponsesContentApplicationJsonSchemaEmploymentType", "type": "string" }, "EorContractsContractIdDetailsGetResponsesContentApplicationJsonSchemaErrorsItems": { "properties": { "code": { "description": "Error code identifier", "type": "string" }, "field": { "description": "The field that caused the error, if applicable", "type": [ "string", "null" ] }, "message": { "description": "Error message details", "type": "string" } }, "required": [ "code", "message" ], "title": "EorContractsContractIdDetailsGetResponsesContentApplicationJsonSchemaErrorsItems", "type": "object" }, "EorContractsContractIdDetailsGetResponsesContentApplicationJsonSchemaHiringObjective": { "description": "Information about the hiring objective.", "properties": { "extra_info": { "type": [ "string", "null" ] }, "type": { "$ref": "#/components/schemas/EorContractsContractIdDetailsGetResponsesContentApplicationJsonSchemaHiringObjectiveType" } }, "title": "EorContractsContractIdDetailsGetResponsesContentApplicationJsonSchemaHiringObjective", "type": "object" }, "EorContractsContractIdDetailsGetResponsesContentApplicationJsonSchemaHiringObjectiveType": { "enum": [ "EXPANDING_TO_NEW_COUNTRY", "TEMP_EOR_OPENING_ENTITY", "ONE_OFF_HIRE", "CONVERTING_CONTRACTOR", "OTHER" ], "title": "EorContractsContractIdDetailsGetResponsesContentApplicationJsonSchemaHiringObjectiveType", "type": "string" }, "EorContractsContractIdDetailsGetResponsesContentApplicationJsonSchemaLastQuoteRejection": { "description": "Timestamp of last quote rejection.", "properties": { "created_at": { "description": "Timestamp of when the rejection was made.", "type": "string" }, "rejected_by": { "$ref": "#/components/schemas/EorContractsContractIdDetailsGetResponsesContentApplicationJsonSchemaLastQuoteRejectionRejectedBy", "description": "Details of the person who rejected." }, "rejection_message": { "description": "Optional message explaining the rejection.", "type": [ "string", "null" ] }, "rejection_reason": { "$ref": "#/components/schemas/EorContractsContractIdDetailsGetResponsesContentApplicationJsonSchemaLastQuoteRejectionRejectionReason", "description": "Reason why the rejection occurred." }, "rejection_type": { "description": "Type of rejection.", "oneOf": [ { "$ref": "#/components/schemas/EorContractsContractIdDetailsGetResponsesContentApplicationJsonSchemaLastQuoteRejectionRejectionType" }, { "type": "null" } ] } }, "title": "EorContractsContractIdDetailsGetResponsesContentApplicationJsonSchemaLastQuoteRejection", "type": "object" }, "EorContractsContractIdDetailsGetResponsesContentApplicationJsonSchemaLastQuoteRejectionRejectedBy": { "description": "Details of the person who rejected.", "properties": { "name": { "description": "Full name of the rejecting person.", "type": "string" }, "profile_public_id": { "description": "Public identifier for the rejecting person's profile.", "format": "uuid", "type": "string" } }, "title": "EorContractsContractIdDetailsGetResponsesContentApplicationJsonSchemaLastQuoteRejectionRejectedBy", "type": "object" }, "EorContractsContractIdDetailsGetResponsesContentApplicationJsonSchemaLastQuoteRejectionRejectionReason": { "description": "Reason why the rejection occurred.", "enum": [ "TOO_EXPENSIVE", "DECIDED_AGAINST_EMPLOYING_EOR", "TEST_QUOTE", "NOT_SATISFIED_WITH_DEEL", "INACCURATE_INFO_JOB_TITLE", "INACCURATE_INFO_JOB_DESCRIPTION", "INACCURATE_INFO_JOB_DUTIES_SCOPE_OF_WORK", "COMPLIANCE_RESTRICTIONS", "OTHER" ], "title": "EorContractsContractIdDetailsGetResponsesContentApplicationJsonSchemaLastQuoteRejectionRejectionReason", "type": "string" }, "EorContractsContractIdDetailsGetResponsesContentApplicationJsonSchemaLastQuoteRejectionRejectionType": { "description": "Type of rejection.", "enum": [ "CLIENT", "EOR_AGENT" ], "title": "EorContractsContractIdDetailsGetResponsesContentApplicationJsonSchemaLastQuoteRejectionRejectionType", "type": "string" }, "EorContractsContractIdDetailsGetResponsesContentApplicationJsonSchemaNoticePeriodType": { "description": "Type of notice period if applicable.", "enum": [ "STANDARD", "CUSTOM" ], "title": "EorContractsContractIdDetailsGetResponsesContentApplicationJsonSchemaNoticePeriodType", "type": "string" }, "EorContractsContractIdDetailsGetResponsesContentApplicationJsonSchemaPayrollType": { "description": "Payroll frequency for the contract", "enum": [ "BIMONTHLY", "MONTHLY", "BIWEEKLY", "WEEKLY", "FOUR_WEEKLY", "QUARTERLY" ], "title": "EorContractsContractIdDetailsGetResponsesContentApplicationJsonSchemaPayrollType", "type": "string" }, "EorContractsContractIdDetailsGetResponsesContentApplicationJsonSchemaProbationPeriodTypeForDefinite": { "description": "Probation period type for definite contracts.", "enum": [ "STANDARD", "CUSTOM" ], "title": "EorContractsContractIdDetailsGetResponsesContentApplicationJsonSchemaProbationPeriodTypeForDefinite", "type": "string" }, "EorContractsContractIdDetailsGetResponsesContentApplicationJsonSchemaSeniority": { "properties": { "id": { "description": "The unique identifier for the seniority level.", "format": "double", "type": "number" }, "name": { "description": "The name of the seniority level.", "type": "string" } }, "title": "EorContractsContractIdDetailsGetResponsesContentApplicationJsonSchemaSeniority", "type": "object" }, "EorContractsContractIdDetailsGetResponsesContentApplicationJsonSchemaSickDays": { "description": "Allowed sick days range.", "properties": { "max": { "description": "Maximum number of sick days allowed.", "type": [ "string", "null" ] }, "min": { "description": "Minimum number of sick days allowed.", "type": [ "string", "null" ] } }, "title": "EorContractsContractIdDetailsGetResponsesContentApplicationJsonSchemaSickDays", "type": "object" }, "EorContractsContractIdDetailsGetResponsesContentApplicationJsonSchemaSigningBonusPayoutType": { "description": "Defines when the signing bonus is paid. Set only when signing_bonus is present.", "enum": [ "FIRST_CYCLE", "AFTER_PROBATION", "AFTER_FIRST_CONTRACT_ANNIVERSARY" ], "title": "EorContractsContractIdDetailsGetResponsesContentApplicationJsonSchemaSigningBonusPayoutType", "type": "string" }, "EorContractsContractIdDetailsGetResponsesContentApplicationJsonSchemaStatus": { "description": "The current status of the contract.", "enum": [ "under_review", "waiting_for_employee_contract", "waiting_for_client_sign", "waiting_for_eor_sign", "waiting_for_employee_sign", "awaiting_deposit_payment", "in_progress", "completed", "cancelled", "user_cancelled", "rejected" ], "title": "EorContractsContractIdDetailsGetResponsesContentApplicationJsonSchemaStatus", "type": "string" }, "EorContractsContractIdDetailsGetResponsesContentApplicationJsonSchemaTeam": { "properties": { "id": { "description": "The unique identifier for the team.", "type": "string" }, "name": { "description": "The name of the team.", "type": "string" } }, "title": "EorContractsContractIdDetailsGetResponsesContentApplicationJsonSchemaTeam", "type": "object" }, "EorContractsContractIdDetailsGetResponsesContentApplicationJsonSchemaTimeOffType": { "description": "Type of time off policy.", "enum": [ "STANDARD", "SPECIFIC", "PRORATED" ], "title": "EorContractsContractIdDetailsGetResponsesContentApplicationJsonSchemaTimeOffType", "type": "string" }, "EorContractsContractIdDetailsGetResponsesContentApplicationJsonSchemaWorkArrangementType": { "description": "Work arrangement type of the EOR contract (Deel Field Solutions classification). Null if unclassified.", "enum": [ "REMOTE", "ONSITE", "FIELD", "HYBRID" ], "title": "EorContractsContractIdDetailsGetResponsesContentApplicationJsonSchemaWorkArrangementType", "type": "string" }, "EorContractsContractIdDetailsGetResponsesContentApplicationJsonSchemaWorkScheduleAssignmentSettings": { "description": "Work schedule assignment setting.", "enum": [ "NOT_AVAILABLE", "SPECIFIC_SCHEDULES", "GENERAL_SCHEDULES", "ONE_TIME_AMENDMENT" ], "title": "EorContractsContractIdDetailsGetResponsesContentApplicationJsonSchemaWorkScheduleAssignmentSettings", "type": "string" }, "EorContractsContractIdDocumentsGetResponsesContentApplicationJsonSchemaDataItems": { "properties": { "client_job_title": { "description": "The job title of the client if the document is signed.", "type": [ "string", "null" ] }, "document_type": { "$ref": "#/components/schemas/EorContractsContractIdDocumentsGetResponsesContentApplicationJsonSchemaDataItemsDocumentType", "description": "The type of document. Currently only FRAMEWORK_AGREEMENT is supported." }, "eor_signature": { "description": "The signature of the EOR if the document is signed.", "type": [ "string", "null" ] }, "eor_signed_at": { "description": "The date and time the EOR signed the document if it is signed.", "format": "date-time", "type": [ "string", "null" ] }, "signature": { "description": "The signature of the client if the document is signed.", "type": [ "string", "null" ] }, "signed_at": { "description": "The date and time the client signed the document if it is signed.", "format": "date-time", "type": [ "string", "null" ] } }, "required": [ "document_type" ], "title": "EorContractsContractIdDocumentsGetResponsesContentApplicationJsonSchemaDataItems", "type": "object" }, "EorContractsContractIdDocumentsGetResponsesContentApplicationJsonSchemaDataItemsDocumentType": { "description": "The type of document. Currently only FRAMEWORK_AGREEMENT is supported.", "enum": [ "FRAMEWORK_AGREEMENT" ], "title": "EorContractsContractIdDocumentsGetResponsesContentApplicationJsonSchemaDataItemsDocumentType", "type": "string" }, "EorContractsContractIdDocumentsGetResponsesContentApplicationJsonSchemaErrorsItems": { "properties": { "message": { "description": "A description of the returned error", "type": "string" }, "path": { "description": "The JSON path where input validation failed", "type": "string" } }, "title": "EorContractsContractIdDocumentsGetResponsesContentApplicationJsonSchemaErrorsItems", "type": "object" }, "EorContractsContractIdDocumentsGetResponsesContentApplicationJsonSchemaRequest": { "properties": { "api_req_id": { "description": "The request ID of the failed request", "type": "string" }, "code": { "description": "The code of the source handler which produced the returned error", "format": "double", "type": "number" }, "docs": { "description": "A link to the official documentation for the requested endpoint resource", "type": "string" }, "method": { "description": "The HTTP method of the failed request", "type": "string" }, "source": { "description": "The source handler which produced the returned error", "type": "string" }, "status": { "description": "The status code of the response", "format": "double", "type": "number" }, "url": { "description": "The relative URL of the failed request", "type": "string" } }, "title": "EorContractsContractIdDocumentsGetResponsesContentApplicationJsonSchemaRequest", "type": "object" }, "EorContractsContractIdDocumentsTypeGetParametersType": { "enum": [ "FRAMEWORK_AGREEMENT" ], "title": "EorContractsContractIdDocumentsTypeGetParametersType", "type": "string" }, "EorContractsContractIdDocumentsTypeGetResponsesContentApplicationJsonSchemaErrorsItems": { "properties": { "message": { "description": "A description of the returned error", "type": "string" }, "path": { "description": "The JSON path where input validation failed", "type": "string" } }, "title": "EorContractsContractIdDocumentsTypeGetResponsesContentApplicationJsonSchemaErrorsItems", "type": "object" }, "EorContractsContractIdDocumentsTypeGetResponsesContentApplicationJsonSchemaRequest": { "properties": { "api_req_id": { "description": "The request ID of the failed request", "type": "string" }, "code": { "description": "The code of the source handler which produced the returned error", "format": "double", "type": "number" }, "docs": { "description": "A link to the official documentation for the requested endpoint resource", "type": "string" }, "method": { "description": "The HTTP method of the failed request", "type": "string" }, "source": { "description": "The source handler which produced the returned error", "type": "string" }, "status": { "description": "The status code of the response", "format": "double", "type": "number" }, "url": { "description": "The relative URL of the failed request", "type": "string" } }, "title": "EorContractsContractIdDocumentsTypeGetResponsesContentApplicationJsonSchemaRequest", "type": "object" }, "EorContractsContractIdDocumentsTypeSignPostParametersType": { "enum": [ "FRAMEWORK_AGREEMENT" ], "title": "EorContractsContractIdDocumentsTypeSignPostParametersType", "type": "string" }, "EorContractsContractIdDocumentsTypeSignPostRequestBodyContentApplicationJsonSchemaData": { "properties": { "client_job_title": { "description": "The job title of the client signing the document.", "type": "string" }, "signature": { "description": "The signature of the client signing the document.", "type": "string" } }, "required": [ "signature", "client_job_title" ], "title": "EorContractsContractIdDocumentsTypeSignPostRequestBodyContentApplicationJsonSchemaData", "type": "object" }, "EorContractsContractIdDocumentsTypeSignPostResponsesContentApplicationJsonSchemaData": { "properties": { "client_job_title": { "description": "The job title of the client if the document is signed.", "type": [ "string", "null" ] }, "document_type": { "$ref": "#/components/schemas/EorContractsContractIdDocumentsTypeSignPostResponsesContentApplicationJsonSchemaDataDocumentType", "description": "The type of document. Currently only FRAMEWORK_AGREEMENT is supported." }, "eor_signature": { "description": "The signature of the EOR if the document is signed.", "type": [ "string", "null" ] }, "eor_signed_at": { "description": "The date and time the EOR signed the document if it is signed.", "format": "date-time", "type": [ "string", "null" ] }, "signature": { "description": "The signature of the client if the document is signed.", "type": [ "string", "null" ] }, "signed_at": { "description": "The date and time the client signed the document if it is signed.", "format": "date-time", "type": [ "string", "null" ] } }, "required": [ "document_type" ], "title": "EorContractsContractIdDocumentsTypeSignPostResponsesContentApplicationJsonSchemaData", "type": "object" }, "EorContractsContractIdDocumentsTypeSignPostResponsesContentApplicationJsonSchemaDataDocumentType": { "description": "The type of document. Currently only FRAMEWORK_AGREEMENT is supported.", "enum": [ "FRAMEWORK_AGREEMENT" ], "title": "EorContractsContractIdDocumentsTypeSignPostResponsesContentApplicationJsonSchemaDataDocumentType", "type": "string" }, "EorContractsContractIdDocumentsTypeSignPostResponsesContentApplicationJsonSchemaErrorsItems": { "properties": { "message": { "description": "A description of the returned error", "type": "string" }, "path": { "description": "The JSON path where input validation failed", "type": "string" } }, "title": "EorContractsContractIdDocumentsTypeSignPostResponsesContentApplicationJsonSchemaErrorsItems", "type": "object" }, "EorContractsContractIdDocumentsTypeSignPostResponsesContentApplicationJsonSchemaRequest": { "properties": { "api_req_id": { "description": "The request ID of the failed request", "type": "string" }, "code": { "description": "The code of the source handler which produced the returned error", "format": "double", "type": "number" }, "docs": { "description": "A link to the official documentation for the requested endpoint resource", "type": "string" }, "method": { "description": "The HTTP method of the failed request", "type": "string" }, "source": { "description": "The source handler which produced the returned error", "type": "string" }, "status": { "description": "The status code of the response", "format": "double", "type": "number" }, "url": { "description": "The relative URL of the failed request", "type": "string" } }, "title": "EorContractsContractIdDocumentsTypeSignPostResponsesContentApplicationJsonSchemaRequest", "type": "object" }, "EorContractsContractIdEmployeeAgreementDraftPreviewGetResponsesContentApplicationJsonSchemaData": { "properties": { "is_processing": { "description": "True while generation is in progress; false when the url is ready.", "type": "boolean" }, "task_id": { "description": "Async task ID. Use this in subsequent requests to poll.", "type": "string" }, "url": { "description": "Signed URL to download the draft PDF. Valid for 15 minutes. Present only when is_processing is false.", "type": "string" } }, "title": "EorContractsContractIdEmployeeAgreementDraftPreviewGetResponsesContentApplicationJsonSchemaData", "type": "object" }, "EorContractsContractIdEmployeeInformationPatchRequestBodyContentApplicationJsonSchemaData": { "properties": { "employee_first_name": { "description": "The first name of the employee.", "type": "string" }, "employee_last_name": { "description": "The last name of the employee.", "type": "string" } }, "title": "EorContractsContractIdEmployeeInformationPatchRequestBodyContentApplicationJsonSchemaData", "type": "object" }, "EorContractsContractIdEmployeeInformationPatchResponsesContentApplicationJsonSchemaData": { "properties": { "employee_first_name": { "description": "The first name of the contract employee.", "type": "string" }, "employee_last_name": { "description": "The last name of the contract employee.", "type": "string" }, "id": { "description": "The unique identifier of the employee contract.", "type": "string" }, "scope_of_work": { "description": "Scope of work description.", "type": "string" }, "status": { "$ref": "#/components/schemas/EorContractsContractIdEmployeeInformationPatchResponsesContentApplicationJsonSchemaDataStatus", "description": "Current status of the contract" } }, "required": [ "id", "status" ], "title": "EorContractsContractIdEmployeeInformationPatchResponsesContentApplicationJsonSchemaData", "type": "object" }, "EorContractsContractIdEmployeeInformationPatchResponsesContentApplicationJsonSchemaDataStatus": { "description": "Current status of the contract", "enum": [ "new", "under_review", "waiting_for_client_sign", "waiting_for_eor_sign", "waiting_for_employee_contract", "waiting_for_employee_sign", "awaiting_deposit_payment", "rejected" ], "title": "EorContractsContractIdEmployeeInformationPatchResponsesContentApplicationJsonSchemaDataStatus", "type": "string" }, "EorContractsContractIdEmployeeInformationPatchResponsesContentApplicationJsonSchemaErrorsItems": { "properties": { "code": { "description": "Machine-readable error code", "type": "string" }, "message": { "description": "Human-readable explanation of the error", "type": "string" } }, "title": "EorContractsContractIdEmployeeInformationPatchResponsesContentApplicationJsonSchemaErrorsItems", "type": "object" }, "EorContractsContractIdHrxDocumentsDocumentIdGetResponsesContentApplicationJsonSchemaData": { "description": "Download information for the HRX document", "properties": { "created_at": { "description": "When the document was created", "format": "date-time", "type": "string" }, "updated_at": { "description": "When the document was last updated", "format": "date-time", "type": "string" }, "url": { "description": "Pre-signed URL to download the HRX document PDF. Valid for 15 minutes.", "format": "uri", "type": "string" } }, "required": [ "url", "created_at", "updated_at" ], "title": "EorContractsContractIdHrxDocumentsDocumentIdGetResponsesContentApplicationJsonSchemaData", "type": "object" }, "EorContractsContractIdHrxDocumentsDocumentIdGetResponsesContentApplicationJsonSchemaErrorsItems": { "properties": { "code": { "description": "Error code of the handler which produced the returned error", "type": "string" }, "field": { "description": "The field name where authentication failed", "type": "string" }, "message": { "description": "Description of the returned error", "type": "string" } }, "title": "EorContractsContractIdHrxDocumentsDocumentIdGetResponsesContentApplicationJsonSchemaErrorsItems", "type": "object" }, "EorContractsContractIdHrxDocumentsGetResponsesContentApplicationJsonSchemaDataItems": { "properties": { "category": { "description": "Type of the document category", "type": "string" }, "category_description": { "description": "Description of the document category", "type": "string" }, "category_id": { "description": "Unique identifier for the document category", "format": "uuid", "type": "string" }, "category_type": { "$ref": "#/components/schemas/EorContractsContractIdHrxDocumentsGetResponsesContentApplicationJsonSchemaDataItemsCategoryType", "description": "Type of the document category" }, "created_at": { "description": "When the document was created", "format": "date-time", "type": "string" }, "id": { "description": "Unique identifier for the employee document", "format": "uuid", "type": "string" }, "name": { "description": "Name of the employee document", "type": "string" }, "updated_at": { "description": "When the document was last updated", "format": "date-time", "type": "string" } }, "required": [ "id", "name", "category", "created_at", "updated_at", "category_id", "category_type", "category_description" ], "title": "EorContractsContractIdHrxDocumentsGetResponsesContentApplicationJsonSchemaDataItems", "type": "object" }, "EorContractsContractIdHrxDocumentsGetResponsesContentApplicationJsonSchemaDataItemsCategoryType": { "description": "Type of the document category", "enum": [ "EMPLOYMENT_AGREEMENT", "ONBOARDING_REGISTRATION", "OFFBOARDING_TERMINATION", "TAX_FISCAL", "STATUS_BENEFITS", "VISA_TRAVEL_SUPPORT", "OTHER" ], "title": "EorContractsContractIdHrxDocumentsGetResponsesContentApplicationJsonSchemaDataItemsCategoryType", "type": "string" }, "EorContractsContractIdHrxDocumentsGetResponsesContentApplicationJsonSchemaErrorsItems": { "properties": { "code": { "description": "Error code of the handler which produced the returned error", "type": "string" }, "field": { "description": "The field name where authentication failed", "type": "string" }, "message": { "description": "Description of the returned error", "type": "string" } }, "title": "EorContractsContractIdHrxDocumentsGetResponsesContentApplicationJsonSchemaErrorsItems", "type": "object" }, "EorContractsContractIdOffboardingAttachmentsAttachmentIdGetResponsesContentApplicationJsonSchemaErrorsItems": { "properties": { "code": { "description": "Error code of the handler which produced the returned error", "type": "string" }, "field": { "description": "The field name where error occurred (null for server errors)", "type": "string" }, "message": { "description": "Description of the returned error", "type": "string" } }, "title": "EorContractsContractIdOffboardingAttachmentsAttachmentIdGetResponsesContentApplicationJsonSchemaErrorsItems", "type": "object" }, "EorContractsContractIdOffboardingGetResponsesContentApplicationJsonSchemaData": { "properties": { "contract_id": { "description": "The unique identifier of the employee contract.", "type": "string" }, "created_at": { "description": "The date and time the offboarding request was created", "format": "date-time", "type": "string" }, "desired_end_date": { "description": "The desired end date. If the date is not provided, it will be selected by HRX the closest date possible", "format": "date-time", "type": [ "string", "null" ] }, "documents": { "$ref": "#/components/schemas/EorContractsContractIdOffboardingGetResponsesContentApplicationJsonSchemaDataDocuments", "description": "Document management structure for termination workflow including review processes and supporting documents" }, "end_date": { "description": "The definitive contract end date", "format": "date-time", "type": [ "string", "null" ] }, "id": { "description": "The unique identifier of the offboarding request", "format": "uuid", "type": "string" }, "is_sensitive": { "description": "Indicates if the offboarding request is sensitive. This is used to restrict access to the request only to the requester and the HRX team.", "type": "boolean" }, "request_data": { "oneOf": [ { "$ref": "#/components/schemas/EorContractsContractIdOffboardingGetResponsesContentApplicationJsonSchemaDataRequestData" }, { "type": "null" } ] }, "updated_at": { "description": "The date and time the offboarding request was updated", "format": "date-time", "type": "string" } }, "title": "EorContractsContractIdOffboardingGetResponsesContentApplicationJsonSchemaData", "type": "object" }, "EorContractsContractIdOffboardingGetResponsesContentApplicationJsonSchemaDataDocuments": { "description": "Document management structure for termination workflow including review processes and supporting documents", "properties": { "offboarding": { "description": "Document set shared that requires client or employee review", "items": { "$ref": "#/components/schemas/EorContractsContractIdOffboardingGetResponsesContentApplicationJsonSchemaDataDocumentsOffboardingItems" }, "type": "array" }, "supporting": { "items": { "$ref": "#/components/schemas/EorContractsContractIdOffboardingGetResponsesContentApplicationJsonSchemaDataDocumentsSupportingItems" }, "type": "array" } }, "required": [ "supporting", "offboarding" ], "title": "EorContractsContractIdOffboardingGetResponsesContentApplicationJsonSchemaDataDocuments", "type": "object" }, "EorContractsContractIdOffboardingGetResponsesContentApplicationJsonSchemaDataDocumentsOffboardingItems": { "properties": { "created_at": { "description": "The date and time the document set was created", "format": "date-time", "type": "string" }, "files": { "items": { "$ref": "#/components/schemas/EorContractsContractIdOffboardingGetResponsesContentApplicationJsonSchemaDataDocumentsOffboardingItemsFilesItems" }, "type": "array" }, "id": { "description": "The unique identifier of the document set shared with the employee.", "format": "uuid", "type": "string" }, "is_employee_notification_required": { "description": "Indicates if the employee should be notified about this document review", "type": "boolean" }, "notification_instructions": { "description": "HTML instructions for the reviewer notification", "type": [ "string", "null" ] }, "reviewed_at": { "description": "The date and time when the document was reviewed", "format": "date-time", "type": [ "string", "null" ] }, "reviewed_by": { "description": "The name of the reviewer for this document. If the reviewer is not an employee, it will be the name of the client", "type": [ "string", "null" ] }, "reviewer_feedback": { "description": "Feedback provided by the reviewer", "type": [ "string", "null" ] }, "reviewer_type": { "$ref": "#/components/schemas/EorContractsContractIdOffboardingGetResponsesContentApplicationJsonSchemaDataDocumentsOffboardingItemsReviewerType", "description": "The type of reviewer for this document" }, "status": { "$ref": "#/components/schemas/EorContractsContractIdOffboardingGetResponsesContentApplicationJsonSchemaDataDocumentsOffboardingItemsStatus", "description": "The current status of the document review" }, "updated_at": { "description": "The date and time the document set was updated", "format": "date-time", "type": "string" } }, "required": [ "files", "status", "reviewer_type", "is_employee_notification_required" ], "title": "EorContractsContractIdOffboardingGetResponsesContentApplicationJsonSchemaDataDocumentsOffboardingItems", "type": "object" }, "EorContractsContractIdOffboardingGetResponsesContentApplicationJsonSchemaDataDocumentsOffboardingItemsFilesItems": { "properties": { "created_at": { "description": "The date and time the file was created", "format": "date-time", "type": "string" }, "id": { "description": "The unique identifier of the file", "type": "string" }, "name": { "description": "The name of the file", "type": "string" }, "type": { "description": "The type/extension of the file", "type": "string" }, "updated_at": { "description": "The date and time the file was updated", "format": "date-time", "type": "string" } }, "required": [ "id", "name", "type", "created_at" ], "title": "EorContractsContractIdOffboardingGetResponsesContentApplicationJsonSchemaDataDocumentsOffboardingItemsFilesItems", "type": "object" }, "EorContractsContractIdOffboardingGetResponsesContentApplicationJsonSchemaDataDocumentsOffboardingItemsReviewerType": { "description": "The type of reviewer for this document", "enum": [ "CLIENT", "EMPLOYEE" ], "title": "EorContractsContractIdOffboardingGetResponsesContentApplicationJsonSchemaDataDocumentsOffboardingItemsReviewerType", "type": "string" }, "EorContractsContractIdOffboardingGetResponsesContentApplicationJsonSchemaDataDocumentsOffboardingItemsStatus": { "description": "The current status of the document review", "enum": [ "AWAITING_REVIEW", "AWAITING_FEEDBACK", "FEEDBACK_PROVIDED", "APPROVED", "CHANGES_REQUESTED_BY_CLIENT", "CHANGES_REQUESTED_BY_EMPLOYEE", "WAIVED_REVIEW", "NOT_RESPONDED", "CANCELLED" ], "title": "EorContractsContractIdOffboardingGetResponsesContentApplicationJsonSchemaDataDocumentsOffboardingItemsStatus", "type": "string" }, "EorContractsContractIdOffboardingGetResponsesContentApplicationJsonSchemaDataDocumentsSupportingItems": { "properties": { "created_at": { "description": "The date and time the file was created", "format": "date-time", "type": "string" }, "id": { "description": "The unique identifier of the file", "type": "string" }, "is_additional_supporting_document": { "description": "Indicates if this is an additional supporting document added after the initial submission", "type": "boolean" }, "name": { "description": "The name of the file", "type": "string" }, "type": { "description": "The type/extension of the file", "type": "string" }, "updated_at": { "description": "The date and time the file was updated", "format": "date-time", "type": "string" } }, "required": [ "id", "name", "type", "created_at", "updated_at", "is_additional_supporting_document" ], "title": "EorContractsContractIdOffboardingGetResponsesContentApplicationJsonSchemaDataDocumentsSupportingItems", "type": "object" }, "EorContractsContractIdOffboardingGetResponsesContentApplicationJsonSchemaDataRequestData": { "properties": { "desired_end_date": { "description": "The desired end date. If the date is not provided, it will be selected by HRX the closest date possible", "format": "date", "type": [ "string", "null" ] }, "eligible_for_rehire": { "description": "Parameter to inform whether it would be possible for the client to hire the employee again", "oneOf": [ { "$ref": "#/components/schemas/EorContractsContractIdOffboardingGetResponsesContentApplicationJsonSchemaDataRequestDataEligibleForRehire" }, { "type": "null" } ] }, "eligible_for_rehire_reason": { "description": "Describe if the option DONT_KNOW was selected on eligible_for_rehire", "type": [ "string", "null" ] }, "end_date": { "description": "The definitive contract end date", "format": "date-time", "type": [ "string", "null" ] }, "reason": { "$ref": "#/components/schemas/EorContractsContractIdOffboardingGetResponsesContentApplicationJsonSchemaDataRequestDataReason", "description": "The reason for the termination" }, "reason_detail": { "description": "Optional field to describe the reason behind the resignation request", "type": [ "string", "null" ] }, "used_time_off": { "$ref": "#/components/schemas/EorContractsContractIdOffboardingGetResponsesContentApplicationJsonSchemaDataRequestDataUsedTimeOff", "description": "Time-off usage data including policy information and tracking periods" } }, "title": "EorContractsContractIdOffboardingGetResponsesContentApplicationJsonSchemaDataRequestData", "type": "object" }, "EorContractsContractIdOffboardingGetResponsesContentApplicationJsonSchemaDataRequestDataEligibleForRehire": { "description": "Parameter to inform whether it would be possible for the client to hire the employee again", "enum": [ "YES", "NO", "DONT_KNOW" ], "title": "EorContractsContractIdOffboardingGetResponsesContentApplicationJsonSchemaDataRequestDataEligibleForRehire", "type": "string" }, "EorContractsContractIdOffboardingGetResponsesContentApplicationJsonSchemaDataRequestDataReason": { "description": "The reason for the termination", "enum": [ "STATUS_CHANGE", "RELOCATION", "COMPENSATION", "RETIREMENT", "JOB_ABANDONMENT", "WORK_RELATED", "PERSONAL", "OTHER_OPPORTUNITY", "NON_RENEWAL", "PROBATION", "ASSIGNMENT_ENDED", "POSITION_ELIMINATION", "FORCE_REDUCTION", "DEATH", "FOR_CAUSE", "PERFORMANCE", "MEDICAL", "PERFORMANCE_ISSUES", "ATTENDANCE_ISSUES", "REORGANIZATION_DOWNSIZING_BUDGET_OR_REDUCTION_OF_WORKFORCE", "ROLE_BECAME_REDUNDANT_OR_ROLE_CHANGED", "OFFER_WAS_REVOKED", "EXITING_THE_MARKET", "NO_LONGER_WISH_TO_WORK_WITH_DEEL", "COMPANY_ACQUIRED", "STEALING", "MISCONDUCT", "FALSIFYING", "HARASSMENT", "VIOLENCE", "REORGANIZATION_DOWNSIZING_BUDGET_OR_REDUCTION_OF_WORKFORCE_OR_ROLE_BECAME_REDUNDANT_OR_ROLE_CHANGED", "UNAUTHORIZED_ABSENCES_OR_LACK_OF_ATTENDANCE", "STANDARD_RESELLER_PRACTICE", "MOVING_EMPLOYEE_TO_INTERNAL_ENTITY", "MOVING_EMPLOYEE_TO_DEEL_PEO", "WORKER_TYPE_CHANGE", "DISSATISFIED_WITH_DEEL_SERVICE", "DISSATISFIED_WITH_DEEL_PRICING", "DISSATISFIED_WITH_DEEL_PRODUCT", "DEEL_COLLECTIONS", "EMPLOYEE_IS_MOVING_TO_ANOTHER_COUNTRY", "EMPLOYEE_FOUND_ANOTHER_JOB", "EMPLOYEE_NOT_HAPPY_WITH_BENEFITS", "EMPLOYEE_NOT_HAPPY_WITH_SALARY", "EMPLOYEE_NOT_HAPPY_WITH_THE_ROLE", "EMPLOYEE_NOT_HAPPY_WITH_COMPANY_CULTURE", "EMPLOYEE_NOT_HAPPY_WITH_DEEL", "EMPLOYEE_PROJECT_ENDED", "EMPLOYEE_SWITCHING_TO_OTHER_EOR_PROVIDER", "EMPLOYEE_LEFT_ROLE_FOR_PERSONAL_MATTERS", "EMPLOYEE_MOVING_FROM_EOR_TO_CONTRACTOR_OR_FREELANCE", "EMPLOYEE_DID_NOT_TAKE_THE_OFFER", "EMPLOYEE_PROVIDED_NO_REASON", "OTHER_BUSINESS_REASONS", "PREFERRED_NOT_TO_SAY", "OTHER" ], "title": "EorContractsContractIdOffboardingGetResponsesContentApplicationJsonSchemaDataRequestDataReason", "type": "string" }, "EorContractsContractIdOffboardingGetResponsesContentApplicationJsonSchemaDataRequestDataUsedTimeOff": { "description": "Time-off usage data including policy information and tracking periods", "properties": { "additional_details": { "oneOf": [ { "$ref": "#/components/schemas/EorContractsContractIdOffboardingGetResponsesContentApplicationJsonSchemaDataRequestDataUsedTimeOffAdditionalDetails" }, { "type": "null" } ] }, "is_deel_pto_confirmed": { "description": "Indicates whether the PTO allocation has been confirmed by Deel's system", "type": "boolean" }, "time_offs": { "items": { "$ref": "#/components/schemas/EorContractsContractIdOffboardingGetResponsesContentApplicationJsonSchemaDataRequestDataUsedTimeOffTimeOffsItems" }, "type": "array" } }, "required": [ "time_offs", "is_deel_pto_confirmed" ], "title": "EorContractsContractIdOffboardingGetResponsesContentApplicationJsonSchemaDataRequestDataUsedTimeOff", "type": "object" }, "EorContractsContractIdOffboardingGetResponsesContentApplicationJsonSchemaDataRequestDataUsedTimeOffAdditionalDetails": { "properties": { "last_updated_at": { "description": "The date and time when the time-off data was last updated", "format": "date-time", "type": [ "string", "null" ] }, "notes": { "description": "Additional notes or comments about the time-off data", "type": [ "string", "null" ] }, "updated_by": { "description": "The person or system that last updated the time-off data", "type": [ "string", "null" ] } }, "title": "EorContractsContractIdOffboardingGetResponsesContentApplicationJsonSchemaDataRequestDataUsedTimeOffAdditionalDetails", "type": "object" }, "EorContractsContractIdOffboardingGetResponsesContentApplicationJsonSchemaDataRequestDataUsedTimeOffTimeOffsItems": { "properties": { "policy_type": { "description": "The type of time-off policy", "type": "string" }, "scheduled_until_end_date": { "description": "The amount of time off scheduled until the end date of the current tracking period", "format": "double", "type": "number" }, "tracking_periods": { "items": { "$ref": "#/components/schemas/EorContractsContractIdOffboardingGetResponsesContentApplicationJsonSchemaDataRequestDataUsedTimeOffTimeOffsItemsTrackingPeriodsItems" }, "type": "array" }, "unit": { "$ref": "#/components/schemas/EorContractsContractIdOffboardingGetResponsesContentApplicationJsonSchemaDataRequestDataUsedTimeOffTimeOffsItemsUnit", "description": "The unit of measurement for time off tracking" } }, "required": [ "unit", "policy_type", "tracking_periods", "scheduled_until_end_date" ], "title": "EorContractsContractIdOffboardingGetResponsesContentApplicationJsonSchemaDataRequestDataUsedTimeOffTimeOffsItems", "type": "object" }, "EorContractsContractIdOffboardingGetResponsesContentApplicationJsonSchemaDataRequestDataUsedTimeOffTimeOffsItemsTrackingPeriodsItems": { "properties": { "end_date": { "description": "The end date of the tracking period", "format": "date-time", "type": "string" }, "start_date": { "description": "The start date of the tracking period", "format": "date-time", "type": "string" }, "used": { "description": "The amount of time off used in this tracking period", "format": "double", "type": "number" } }, "required": [ "used", "end_date", "start_date" ], "title": "EorContractsContractIdOffboardingGetResponsesContentApplicationJsonSchemaDataRequestDataUsedTimeOffTimeOffsItemsTrackingPeriodsItems", "type": "object" }, "EorContractsContractIdOffboardingGetResponsesContentApplicationJsonSchemaDataRequestDataUsedTimeOffTimeOffsItemsUnit": { "description": "The unit of measurement for time off tracking", "enum": [ "BUSINESS_DAY", "CALENDAR_DAY", "HOUR" ], "title": "EorContractsContractIdOffboardingGetResponsesContentApplicationJsonSchemaDataRequestDataUsedTimeOffTimeOffsItemsUnit", "type": "string" }, "EorContractsContractIdOffboardingGetResponsesContentApplicationJsonSchemaErrorsItems": { "properties": { "code": { "description": "Error code of the handler which produced the returned error", "type": "string" }, "field": { "description": "The field name where error occurred (null for server errors)", "type": "string" }, "message": { "description": "Description of the returned error", "type": "string" } }, "title": "EorContractsContractIdOffboardingGetResponsesContentApplicationJsonSchemaErrorsItems", "type": "object" }, "EorContractsContractIdOffboardingRequiredInformationGetResponsesContentApplicationJsonSchemaData": { "description": "Specifies the text of additional questions that the client must answer when requesting a termination", "properties": { "documents": { "description": "If not null, specifies the documents that the client must upload when requesting a termination", "type": [ "string", "null" ] }, "questions": { "description": "A list of additional questions that the client must answer when requesting a termination. Some questions are mandatory, while others are optional.", "items": { "$ref": "#/components/schemas/EorContractsContractIdOffboardingRequiredInformationGetResponsesContentApplicationJsonSchemaDataQuestionsItems" }, "type": [ "array", "null" ] } }, "title": "EorContractsContractIdOffboardingRequiredInformationGetResponsesContentApplicationJsonSchemaData", "type": "object" }, "EorContractsContractIdOffboardingRequiredInformationGetResponsesContentApplicationJsonSchemaDataQuestionsItems": { "properties": { "is_optional": { "description": "Indicates whether answering the question is optional. If false, client must provide an answer.", "type": "boolean" }, "text": { "description": "Specifies the text of additional questions that the client must answer when requesting a termination", "type": "string" } }, "title": "EorContractsContractIdOffboardingRequiredInformationGetResponsesContentApplicationJsonSchemaDataQuestionsItems", "type": "object" }, "EorContractsContractIdOffboardingRequiredInformationGetResponsesContentApplicationJsonSchemaErrorsItems": { "properties": { "code": { "description": "Error code of the handler which produced the returned error", "type": "string" }, "field": { "description": "The field name where error occurred (null for server errors)", "type": "string" }, "message": { "description": "Description of the returned error", "type": "string" } }, "title": "EorContractsContractIdOffboardingRequiredInformationGetResponsesContentApplicationJsonSchemaErrorsItems", "type": "object" }, "EorContractsContractIdOffboardingResignationPostRequestBodyContentMultipartFormDataSchemaData": { "properties": { "additional_reason": { "description": "An additional reason can be provided in case the reason selected is MOVING_EMPLOYEE_TO_INTERNAL_ENTITY", "oneOf": [ { "$ref": "#/components/schemas/EorContractsContractIdOffboardingResignationPostRequestBodyContentMultipartFormDataSchemaDataAdditionalReason" }, { "type": "null" } ] }, "attachments": { "description": "This field allows for uploading multiple files at once. Attach any document that is important for the request to terminate the contract. Includes common image formats (JPG, JPEG, PNG, HEIC) and PDF documents", "format": "binary", "type": "string" }, "desired_end_date": { "description": "The desired end date. If the date is not provided, it will be selected by HRX the closest date possible", "format": "date", "type": "string" }, "eligible_for_rehire": { "description": "Parameter to inform whether it would be possible for the client to hire the employee again", "oneOf": [ { "$ref": "#/components/schemas/EorContractsContractIdOffboardingResignationPostRequestBodyContentMultipartFormDataSchemaDataEligibleForRehire" }, { "type": "null" } ] }, "eligible_for_rehire_reason": { "description": "Describe if the option DONT_KNOW was selected on eligible_for_rehire", "maxLength": 255, "type": [ "string", "null" ] }, "is_employee_staying_with_deel": { "description": "Defines if employee will keep using Deel as provider", "type": [ "boolean", "null" ] }, "is_sensitive": { "description": "Defines whether the termination is sensitive. In this case, only the person requesting the termination will be able to view the termination, receive emails or notifications.", "type": "boolean" }, "reason": { "$ref": "#/components/schemas/EorContractsContractIdOffboardingResignationPostRequestBodyContentMultipartFormDataSchemaDataReason", "description": "Reason why the contract is being terminated" }, "reason_detail": { "description": "Optional field to describe the reason behind the resignation request", "maxLength": 5000, "type": "string" }, "severance_amount": { "description": "The amount of severance needed", "title": "float", "type": "string" }, "severance_type": { "$ref": "#/components/schemas/EorContractsContractIdOffboardingResignationPostRequestBodyContentMultipartFormDataSchemaDataSeveranceType", "description": "The type of severance selected by the client. It's an optional field" }, "termination_notes": { "default": [], "description": "Additional notes can be provided regarding the termination for Deel, like questions and doubts", "items": { "maxLength": 5000, "type": "string" }, "type": "array" }, "used_time_off": { "$ref": "#/components/schemas/EorContractsContractIdOffboardingResignationPostRequestBodyContentMultipartFormDataSchemaDataUsedTimeOff" } }, "required": [ "reason", "used_time_off", "is_employee_staying_with_deel" ], "title": "EorContractsContractIdOffboardingResignationPostRequestBodyContentMultipartFormDataSchemaData", "type": "object" }, "EorContractsContractIdOffboardingResignationPostRequestBodyContentMultipartFormDataSchemaDataAdditionalReason": { "description": "An additional reason can be provided in case the reason selected is MOVING_EMPLOYEE_TO_INTERNAL_ENTITY", "enum": [ "MOVING_TO_INTERNAL_ENTITY_WITH_DEEL_GLOBAL_PAYROLL", "MOVING_TO_INTERNAL_ENTITY_WITH_OTHER_PROVIDER" ], "title": "EorContractsContractIdOffboardingResignationPostRequestBodyContentMultipartFormDataSchemaDataAdditionalReason", "type": "string" }, "EorContractsContractIdOffboardingResignationPostRequestBodyContentMultipartFormDataSchemaDataEligibleForRehire": { "description": "Parameter to inform whether it would be possible for the client to hire the employee again", "enum": [ "YES", "NO", "DONT_KNOW" ], "title": "EorContractsContractIdOffboardingResignationPostRequestBodyContentMultipartFormDataSchemaDataEligibleForRehire", "type": "string" }, "EorContractsContractIdOffboardingResignationPostRequestBodyContentMultipartFormDataSchemaDataReason": { "description": "Reason why the contract is being terminated", "enum": [ "EMPLOYEE_IS_MOVING_TO_ANOTHER_COUNTRY", "MOVING_EMPLOYEE_TO_INTERNAL_ENTITY", "MOVING_EMPLOYEE_TO_DEEL_PEO", "EMPLOYEE_FOUND_ANOTHER_JOB", "EMPLOYEE_NOT_HAPPY_WITH_BENEFITS", "EMPLOYEE_NOT_HAPPY_WITH_SALARY", "EMPLOYEE_NOT_HAPPY_WITH_THE_ROLE", "EMPLOYEE_NOT_HAPPY_WITH_COMPANY_CULTURE", "EMPLOYEE_NOT_HAPPY_WITH_DEEL", "EMPLOYEE_PROJECT_ENDED", "EMPLOYEE_SWITCHING_TO_OTHER_EOR_PROVIDER", "EMPLOYEE_LEFT_ROLE_FOR_PERSONAL_MATTERS", "EMPLOYEE_MOVING_FROM_EOR_TO_CONTRACTOR_OR_FREELANCE", "WORKER_TYPE_CHANGE", "DEEL_COLLECTIONS", "EMPLOYEE_DID_NOT_TAKE_THE_OFFER", "EMPLOYEE_PROVIDED_NO_REASON", "OTHER_BUSINESS_REASONS" ], "title": "EorContractsContractIdOffboardingResignationPostRequestBodyContentMultipartFormDataSchemaDataReason", "type": "string" }, "EorContractsContractIdOffboardingResignationPostRequestBodyContentMultipartFormDataSchemaDataSeveranceType": { "description": "The type of severance selected by the client. It's an optional field", "enum": [ "DAYS", "WEEKS", "MONTHS", "CASH" ], "title": "EorContractsContractIdOffboardingResignationPostRequestBodyContentMultipartFormDataSchemaDataSeveranceType", "type": "string" }, "EorContractsContractIdOffboardingResignationPostRequestBodyContentMultipartFormDataSchemaDataUsedTimeOff": { "properties": { "off_platform_used_time_off": { "description": "Required when tracking_type is OFF_PLATFORM, null otherwise", "oneOf": [ { "$ref": "#/components/schemas/EorContractsContractIdOffboardingResignationPostRequestBodyContentMultipartFormDataSchemaDataUsedTimeOffOffPlatformUsedTimeOff" }, { "type": "null" } ] }, "tracking_type": { "$ref": "#/components/schemas/EorContractsContractIdOffboardingResignationPostRequestBodyContentMultipartFormDataSchemaDataUsedTimeOffTrackingType", "description": "Type of time off tracking - whether it's tracked on Deel platform or off platform" } }, "title": "EorContractsContractIdOffboardingResignationPostRequestBodyContentMultipartFormDataSchemaDataUsedTimeOff", "type": "object" }, "EorContractsContractIdOffboardingResignationPostRequestBodyContentMultipartFormDataSchemaDataUsedTimeOffOffPlatformUsedTimeOff": { "description": "Required when tracking_type is OFF_PLATFORM, null otherwise", "properties": { "entitlement_unit": { "$ref": "#/components/schemas/EorContractsContractIdOffboardingResignationPostRequestBodyContentMultipartFormDataSchemaDataUsedTimeOffOffPlatformUsedTimeOffEntitlementUnit", "description": "Unit of measurement for the time off entitlements" }, "entitlements": { "description": "Array of time off entitlements for different tracking periods", "items": { "$ref": "#/components/schemas/EorContractsContractIdOffboardingResignationPostRequestBodyContentMultipartFormDataSchemaDataUsedTimeOffOffPlatformUsedTimeOffEntitlementsItems" }, "type": "array" }, "total_scheduled": { "description": "Total amount of time off scheduled until the end date", "title": "float", "type": "string" } }, "required": [ "entitlements", "total_scheduled", "entitlement_unit" ], "title": "EorContractsContractIdOffboardingResignationPostRequestBodyContentMultipartFormDataSchemaDataUsedTimeOffOffPlatformUsedTimeOff", "type": "object" }, "EorContractsContractIdOffboardingResignationPostRequestBodyContentMultipartFormDataSchemaDataUsedTimeOffOffPlatformUsedTimeOffEntitlementUnit": { "description": "Unit of measurement for the time off entitlements", "enum": [ "BUSINESS_DAY", "CALENDAR_DAY", "HOUR", "WEEK", "MONTH", "YEAR" ], "title": "EorContractsContractIdOffboardingResignationPostRequestBodyContentMultipartFormDataSchemaDataUsedTimeOffOffPlatformUsedTimeOffEntitlementUnit", "type": "string" }, "EorContractsContractIdOffboardingResignationPostRequestBodyContentMultipartFormDataSchemaDataUsedTimeOffOffPlatformUsedTimeOffEntitlementsItems": { "properties": { "tracking_period": { "description": "Start date of the tracking period", "format": "date", "type": "string" }, "tracking_period_end_date": { "description": "End date of the tracking period", "format": "date", "type": "string" }, "used": { "description": "Amount of time off used in the period", "title": "float", "type": "string" } }, "required": [ "used", "tracking_period", "tracking_period_end_date" ], "title": "EorContractsContractIdOffboardingResignationPostRequestBodyContentMultipartFormDataSchemaDataUsedTimeOffOffPlatformUsedTimeOffEntitlementsItems", "type": "object" }, "EorContractsContractIdOffboardingResignationPostRequestBodyContentMultipartFormDataSchemaDataUsedTimeOffTrackingType": { "description": "Type of time off tracking - whether it's tracked on Deel platform or off platform", "enum": [ "ON_PLATFORM", "OFF_PLATFORM" ], "title": "EorContractsContractIdOffboardingResignationPostRequestBodyContentMultipartFormDataSchemaDataUsedTimeOffTrackingType", "type": "string" }, "EorContractsContractIdOffboardingResignationPostResponsesContentApplicationJsonSchemaData": { "properties": { "contract_id": { "description": "The unique identifier of the employee contract.", "type": "string" }, "created_at": { "description": "The date and time the offboarding request was created", "format": "date-time", "type": "string" }, "desired_end_date": { "description": "The desired end date. If the date is not provided, it will be selected by HRX the closest date possible", "format": "date-time", "type": [ "string", "null" ] }, "documents": { "$ref": "#/components/schemas/EorContractsContractIdOffboardingResignationPostResponsesContentApplicationJsonSchemaDataDocuments", "description": "Document management structure for termination workflow including review processes and supporting documents" }, "end_date": { "description": "The definitive contract end date", "format": "date-time", "type": [ "string", "null" ] }, "id": { "description": "The unique identifier of the offboarding request", "format": "uuid", "type": "string" }, "is_sensitive": { "description": "Indicates if the offboarding request is sensitive. This is used to restrict access to the request only to the requester and the HRX team.", "type": "boolean" }, "request_data": { "oneOf": [ { "$ref": "#/components/schemas/EorContractsContractIdOffboardingResignationPostResponsesContentApplicationJsonSchemaDataRequestData" }, { "type": "null" } ] }, "updated_at": { "description": "The date and time the offboarding request was updated", "format": "date-time", "type": "string" } }, "title": "EorContractsContractIdOffboardingResignationPostResponsesContentApplicationJsonSchemaData", "type": "object" }, "EorContractsContractIdOffboardingResignationPostResponsesContentApplicationJsonSchemaDataDocuments": { "description": "Document management structure for termination workflow including review processes and supporting documents", "properties": { "offboarding": { "description": "Document set shared that requires client or employee review", "items": { "$ref": "#/components/schemas/EorContractsContractIdOffboardingResignationPostResponsesContentApplicationJsonSchemaDataDocumentsOffboardingItems" }, "type": "array" }, "supporting": { "items": { "$ref": "#/components/schemas/EorContractsContractIdOffboardingResignationPostResponsesContentApplicationJsonSchemaDataDocumentsSupportingItems" }, "type": "array" } }, "required": [ "supporting", "offboarding" ], "title": "EorContractsContractIdOffboardingResignationPostResponsesContentApplicationJsonSchemaDataDocuments", "type": "object" }, "EorContractsContractIdOffboardingResignationPostResponsesContentApplicationJsonSchemaDataDocumentsOffboardingItems": { "properties": { "created_at": { "description": "The date and time the document set was created", "format": "date-time", "type": "string" }, "files": { "items": { "$ref": "#/components/schemas/EorContractsContractIdOffboardingResignationPostResponsesContentApplicationJsonSchemaDataDocumentsOffboardingItemsFilesItems" }, "type": "array" }, "id": { "description": "The unique identifier of the document set shared with the employee.", "format": "uuid", "type": "string" }, "is_employee_notification_required": { "description": "Indicates if the employee should be notified about this document review", "type": "boolean" }, "notification_instructions": { "description": "HTML instructions for the reviewer notification", "type": [ "string", "null" ] }, "reviewed_at": { "description": "The date and time when the document was reviewed", "format": "date-time", "type": [ "string", "null" ] }, "reviewed_by": { "description": "The name of the reviewer for this document. If the reviewer is not an employee, it will be the name of the client", "type": [ "string", "null" ] }, "reviewer_feedback": { "description": "Feedback provided by the reviewer", "type": [ "string", "null" ] }, "reviewer_type": { "$ref": "#/components/schemas/EorContractsContractIdOffboardingResignationPostResponsesContentApplicationJsonSchemaDataDocumentsOffboardingItemsReviewerType", "description": "The type of reviewer for this document" }, "status": { "$ref": "#/components/schemas/EorContractsContractIdOffboardingResignationPostResponsesContentApplicationJsonSchemaDataDocumentsOffboardingItemsStatus", "description": "The current status of the document review" }, "updated_at": { "description": "The date and time the document set was updated", "format": "date-time", "type": "string" } }, "required": [ "files", "status", "reviewer_type", "is_employee_notification_required" ], "title": "EorContractsContractIdOffboardingResignationPostResponsesContentApplicationJsonSchemaDataDocumentsOffboardingItems", "type": "object" }, "EorContractsContractIdOffboardingResignationPostResponsesContentApplicationJsonSchemaDataDocumentsOffboardingItemsFilesItems": { "properties": { "created_at": { "description": "The date and time the file was created", "format": "date-time", "type": "string" }, "id": { "description": "The unique identifier of the file", "type": "string" }, "name": { "description": "The name of the file", "type": "string" }, "type": { "description": "The type/extension of the file", "type": "string" }, "updated_at": { "description": "The date and time the file was updated", "format": "date-time", "type": "string" } }, "required": [ "id", "name", "type", "created_at" ], "title": "EorContractsContractIdOffboardingResignationPostResponsesContentApplicationJsonSchemaDataDocumentsOffboardingItemsFilesItems", "type": "object" }, "EorContractsContractIdOffboardingResignationPostResponsesContentApplicationJsonSchemaDataDocumentsOffboardingItemsReviewerType": { "description": "The type of reviewer for this document", "enum": [ "CLIENT", "EMPLOYEE" ], "title": "EorContractsContractIdOffboardingResignationPostResponsesContentApplicationJsonSchemaDataDocumentsOffboardingItemsReviewerType", "type": "string" }, "EorContractsContractIdOffboardingResignationPostResponsesContentApplicationJsonSchemaDataDocumentsOffboardingItemsStatus": { "description": "The current status of the document review", "enum": [ "AWAITING_REVIEW", "AWAITING_FEEDBACK", "FEEDBACK_PROVIDED", "APPROVED", "CHANGES_REQUESTED_BY_CLIENT", "CHANGES_REQUESTED_BY_EMPLOYEE", "WAIVED_REVIEW", "NOT_RESPONDED", "CANCELLED" ], "title": "EorContractsContractIdOffboardingResignationPostResponsesContentApplicationJsonSchemaDataDocumentsOffboardingItemsStatus", "type": "string" }, "EorContractsContractIdOffboardingResignationPostResponsesContentApplicationJsonSchemaDataDocumentsSupportingItems": { "properties": { "created_at": { "description": "The date and time the file was created", "format": "date-time", "type": "string" }, "id": { "description": "The unique identifier of the file", "type": "string" }, "is_additional_supporting_document": { "description": "Indicates if this is an additional supporting document added after the initial submission", "type": "boolean" }, "name": { "description": "The name of the file", "type": "string" }, "type": { "description": "The type/extension of the file", "type": "string" }, "updated_at": { "description": "The date and time the file was updated", "format": "date-time", "type": "string" } }, "required": [ "id", "name", "type", "created_at", "updated_at", "is_additional_supporting_document" ], "title": "EorContractsContractIdOffboardingResignationPostResponsesContentApplicationJsonSchemaDataDocumentsSupportingItems", "type": "object" }, "EorContractsContractIdOffboardingResignationPostResponsesContentApplicationJsonSchemaDataRequestData": { "properties": { "desired_end_date": { "description": "The desired end date. If the date is not provided, it will be selected by HRX the closest date possible", "format": "date", "type": [ "string", "null" ] }, "eligible_for_rehire": { "description": "Parameter to inform whether it would be possible for the client to hire the employee again", "oneOf": [ { "$ref": "#/components/schemas/EorContractsContractIdOffboardingResignationPostResponsesContentApplicationJsonSchemaDataRequestDataEligibleForRehire" }, { "type": "null" } ] }, "eligible_for_rehire_reason": { "description": "Describe if the option DONT_KNOW was selected on eligible_for_rehire", "type": [ "string", "null" ] }, "end_date": { "description": "The definitive contract end date", "format": "date-time", "type": [ "string", "null" ] }, "reason": { "$ref": "#/components/schemas/EorContractsContractIdOffboardingResignationPostResponsesContentApplicationJsonSchemaDataRequestDataReason", "description": "The reason for the termination" }, "reason_detail": { "description": "Optional field to describe the reason behind the resignation request", "type": [ "string", "null" ] }, "used_time_off": { "$ref": "#/components/schemas/EorContractsContractIdOffboardingResignationPostResponsesContentApplicationJsonSchemaDataRequestDataUsedTimeOff", "description": "Time-off usage data including policy information and tracking periods" } }, "title": "EorContractsContractIdOffboardingResignationPostResponsesContentApplicationJsonSchemaDataRequestData", "type": "object" }, "EorContractsContractIdOffboardingResignationPostResponsesContentApplicationJsonSchemaDataRequestDataEligibleForRehire": { "description": "Parameter to inform whether it would be possible for the client to hire the employee again", "enum": [ "YES", "NO", "DONT_KNOW" ], "title": "EorContractsContractIdOffboardingResignationPostResponsesContentApplicationJsonSchemaDataRequestDataEligibleForRehire", "type": "string" }, "EorContractsContractIdOffboardingResignationPostResponsesContentApplicationJsonSchemaDataRequestDataReason": { "description": "The reason for the termination", "enum": [ "STATUS_CHANGE", "RELOCATION", "COMPENSATION", "RETIREMENT", "JOB_ABANDONMENT", "WORK_RELATED", "PERSONAL", "OTHER_OPPORTUNITY", "NON_RENEWAL", "PROBATION", "ASSIGNMENT_ENDED", "POSITION_ELIMINATION", "FORCE_REDUCTION", "DEATH", "FOR_CAUSE", "PERFORMANCE", "MEDICAL", "PERFORMANCE_ISSUES", "ATTENDANCE_ISSUES", "REORGANIZATION_DOWNSIZING_BUDGET_OR_REDUCTION_OF_WORKFORCE", "ROLE_BECAME_REDUNDANT_OR_ROLE_CHANGED", "OFFER_WAS_REVOKED", "EXITING_THE_MARKET", "NO_LONGER_WISH_TO_WORK_WITH_DEEL", "COMPANY_ACQUIRED", "STEALING", "MISCONDUCT", "FALSIFYING", "HARASSMENT", "VIOLENCE", "REORGANIZATION_DOWNSIZING_BUDGET_OR_REDUCTION_OF_WORKFORCE_OR_ROLE_BECAME_REDUNDANT_OR_ROLE_CHANGED", "UNAUTHORIZED_ABSENCES_OR_LACK_OF_ATTENDANCE", "STANDARD_RESELLER_PRACTICE", "MOVING_EMPLOYEE_TO_INTERNAL_ENTITY", "MOVING_EMPLOYEE_TO_DEEL_PEO", "OTHER" ], "title": "EorContractsContractIdOffboardingResignationPostResponsesContentApplicationJsonSchemaDataRequestDataReason", "type": "string" }, "EorContractsContractIdOffboardingResignationPostResponsesContentApplicationJsonSchemaDataRequestDataUsedTimeOff": { "description": "Time-off usage data including policy information and tracking periods", "properties": { "additional_details": { "oneOf": [ { "$ref": "#/components/schemas/EorContractsContractIdOffboardingResignationPostResponsesContentApplicationJsonSchemaDataRequestDataUsedTimeOffAdditionalDetails" }, { "type": "null" } ] }, "is_deel_pto_confirmed": { "description": "Indicates whether the PTO allocation has been confirmed by Deel's system", "type": "boolean" }, "time_offs": { "items": { "$ref": "#/components/schemas/EorContractsContractIdOffboardingResignationPostResponsesContentApplicationJsonSchemaDataRequestDataUsedTimeOffTimeOffsItems" }, "type": "array" } }, "required": [ "time_offs", "is_deel_pto_confirmed" ], "title": "EorContractsContractIdOffboardingResignationPostResponsesContentApplicationJsonSchemaDataRequestDataUsedTimeOff", "type": "object" }, "EorContractsContractIdOffboardingResignationPostResponsesContentApplicationJsonSchemaDataRequestDataUsedTimeOffAdditionalDetails": { "properties": { "last_updated_at": { "description": "The date and time when the time-off data was last updated", "format": "date-time", "type": [ "string", "null" ] }, "notes": { "description": "Additional notes or comments about the time-off data", "type": [ "string", "null" ] }, "updated_by": { "description": "The person or system that last updated the time-off data", "type": [ "string", "null" ] } }, "title": "EorContractsContractIdOffboardingResignationPostResponsesContentApplicationJsonSchemaDataRequestDataUsedTimeOffAdditionalDetails", "type": "object" }, "EorContractsContractIdOffboardingResignationPostResponsesContentApplicationJsonSchemaDataRequestDataUsedTimeOffTimeOffsItems": { "properties": { "policy_type": { "description": "The type of time-off policy", "type": "string" }, "scheduled_until_end_date": { "description": "The amount of time off scheduled until the end date of the current tracking period", "format": "double", "type": "number" }, "tracking_periods": { "items": { "$ref": "#/components/schemas/EorContractsContractIdOffboardingResignationPostResponsesContentApplicationJsonSchemaDataRequestDataUsedTimeOffTimeOffsItemsTrackingPeriodsItems" }, "type": "array" }, "unit": { "$ref": "#/components/schemas/EorContractsContractIdOffboardingResignationPostResponsesContentApplicationJsonSchemaDataRequestDataUsedTimeOffTimeOffsItemsUnit", "description": "The unit of measurement for time off tracking" } }, "required": [ "unit", "policy_type", "tracking_periods", "scheduled_until_end_date" ], "title": "EorContractsContractIdOffboardingResignationPostResponsesContentApplicationJsonSchemaDataRequestDataUsedTimeOffTimeOffsItems", "type": "object" }, "EorContractsContractIdOffboardingResignationPostResponsesContentApplicationJsonSchemaDataRequestDataUsedTimeOffTimeOffsItemsTrackingPeriodsItems": { "properties": { "end_date": { "description": "The end date of the tracking period", "format": "date-time", "type": "string" }, "start_date": { "description": "The start date of the tracking period", "format": "date-time", "type": "string" }, "used": { "description": "The amount of time off used in this tracking period", "format": "double", "type": "number" } }, "required": [ "used", "end_date", "start_date" ], "title": "EorContractsContractIdOffboardingResignationPostResponsesContentApplicationJsonSchemaDataRequestDataUsedTimeOffTimeOffsItemsTrackingPeriodsItems", "type": "object" }, "EorContractsContractIdOffboardingResignationPostResponsesContentApplicationJsonSchemaDataRequestDataUsedTimeOffTimeOffsItemsUnit": { "description": "The unit of measurement for time off tracking", "enum": [ "BUSINESS_DAY", "CALENDAR_DAY", "HOUR" ], "title": "EorContractsContractIdOffboardingResignationPostResponsesContentApplicationJsonSchemaDataRequestDataUsedTimeOffTimeOffsItemsUnit", "type": "string" }, "EorContractsContractIdOffboardingResignationPostResponsesContentApplicationJsonSchemaErrorsItems": { "properties": { "code": { "description": "Error code of the handler which produced the returned error", "type": "string" }, "field": { "description": "The field name where error occurred (null for server errors)", "type": "string" }, "message": { "description": "Description of the returned error", "type": "string" } }, "title": "EorContractsContractIdOffboardingResignationPostResponsesContentApplicationJsonSchemaErrorsItems", "type": "object" }, "EorContractsContractIdOffboardingResignationsReviewPtoPostRequestBodyContentApplicationJsonSchemaData": { "properties": { "decline_reason": { "$ref": "#/components/schemas/EorContractsContractIdOffboardingResignationsReviewPtoPostRequestBodyContentApplicationJsonSchemaDataDeclineReason", "description": "Reason for declining the resignation request" }, "decline_reason_detail": { "description": "Detailed explanation for declining the resignation request", "maxLength": 2000, "minLength": 150, "type": "string" }, "has_client_accepted_resignation_request": { "description": "Indicates whether the client has accepted the resignation request", "type": "boolean" }, "severance_amount": { "description": "Amount of severance offered to the employee", "title": "float", "type": "string" }, "severance_type": { "$ref": "#/components/schemas/EorContractsContractIdOffboardingResignationsReviewPtoPostRequestBodyContentApplicationJsonSchemaDataSeveranceType", "description": "Type of severance offered to the employee" }, "used_time_off": { "$ref": "#/components/schemas/EorContractsContractIdOffboardingResignationsReviewPtoPostRequestBodyContentApplicationJsonSchemaDataUsedTimeOff", "description": "Time-off usage data including policy information and tracking periods" } }, "title": "EorContractsContractIdOffboardingResignationsReviewPtoPostRequestBodyContentApplicationJsonSchemaData", "type": "object" }, "EorContractsContractIdOffboardingResignationsReviewPtoPostRequestBodyContentApplicationJsonSchemaDataDeclineReason": { "description": "Reason for declining the resignation request", "enum": [ "NOT_AGREE_WITH_END_DATE", "NOT_A_RESIGNATION_BUT_TERMINATION", "EMPLOYEE_UNDER_REVIEW_OR_INVESTIGATION_FOR_DISCIPLINARY_ACTIONS", "OTHER" ], "title": "EorContractsContractIdOffboardingResignationsReviewPtoPostRequestBodyContentApplicationJsonSchemaDataDeclineReason", "type": "string" }, "EorContractsContractIdOffboardingResignationsReviewPtoPostRequestBodyContentApplicationJsonSchemaDataSeveranceType": { "description": "Type of severance offered to the employee", "enum": [ "DAYS", "WEEKS", "MONTHS", "CASH" ], "title": "EorContractsContractIdOffboardingResignationsReviewPtoPostRequestBodyContentApplicationJsonSchemaDataSeveranceType", "type": "string" }, "EorContractsContractIdOffboardingResignationsReviewPtoPostRequestBodyContentApplicationJsonSchemaDataUsedTimeOff": { "description": "Time-off usage data including policy information and tracking periods", "properties": { "off_platform_used_time_off": { "description": "Required when tracking_type is OFF_PLATFORM, null otherwise", "oneOf": [ { "$ref": "#/components/schemas/EorContractsContractIdOffboardingResignationsReviewPtoPostRequestBodyContentApplicationJsonSchemaDataUsedTimeOffOffPlatformUsedTimeOff" }, { "type": "null" } ] }, "tracking_type": { "$ref": "#/components/schemas/EorContractsContractIdOffboardingResignationsReviewPtoPostRequestBodyContentApplicationJsonSchemaDataUsedTimeOffTrackingType", "description": "Type of time off tracking - whether it's tracked on Deel platform or off platform" } }, "title": "EorContractsContractIdOffboardingResignationsReviewPtoPostRequestBodyContentApplicationJsonSchemaDataUsedTimeOff", "type": "object" }, "EorContractsContractIdOffboardingResignationsReviewPtoPostRequestBodyContentApplicationJsonSchemaDataUsedTimeOffOffPlatformUsedTimeOff": { "description": "Required when tracking_type is OFF_PLATFORM, null otherwise", "properties": { "entitlement_unit": { "$ref": "#/components/schemas/EorContractsContractIdOffboardingResignationsReviewPtoPostRequestBodyContentApplicationJsonSchemaDataUsedTimeOffOffPlatformUsedTimeOffEntitlementUnit", "description": "Unit of measurement for the time off entitlements" }, "entitlements": { "description": "Array of time off entitlements for different tracking periods", "items": { "$ref": "#/components/schemas/EorContractsContractIdOffboardingResignationsReviewPtoPostRequestBodyContentApplicationJsonSchemaDataUsedTimeOffOffPlatformUsedTimeOffEntitlementsItems" }, "type": "array" }, "total_scheduled": { "description": "Total amount of time off scheduled until the end date", "title": "float", "type": "string" } }, "required": [ "entitlements", "total_scheduled", "entitlement_unit" ], "title": "EorContractsContractIdOffboardingResignationsReviewPtoPostRequestBodyContentApplicationJsonSchemaDataUsedTimeOffOffPlatformUsedTimeOff", "type": "object" }, "EorContractsContractIdOffboardingResignationsReviewPtoPostRequestBodyContentApplicationJsonSchemaDataUsedTimeOffOffPlatformUsedTimeOffEntitlementUnit": { "description": "Unit of measurement for the time off entitlements", "enum": [ "BUSINESS_DAY", "CALENDAR_DAY", "HOUR", "WEEK", "MONTH", "YEAR" ], "title": "EorContractsContractIdOffboardingResignationsReviewPtoPostRequestBodyContentApplicationJsonSchemaDataUsedTimeOffOffPlatformUsedTimeOffEntitlementUnit", "type": "string" }, "EorContractsContractIdOffboardingResignationsReviewPtoPostRequestBodyContentApplicationJsonSchemaDataUsedTimeOffOffPlatformUsedTimeOffEntitlementsItems": { "properties": { "tracking_period": { "description": "Start date of the tracking period", "format": "date", "type": "string" }, "tracking_period_end_date": { "description": "End date of the tracking period", "format": "date", "type": "string" }, "used": { "description": "Amount of time off used in the period", "title": "float", "type": "string" } }, "required": [ "used", "tracking_period", "tracking_period_end_date" ], "title": "EorContractsContractIdOffboardingResignationsReviewPtoPostRequestBodyContentApplicationJsonSchemaDataUsedTimeOffOffPlatformUsedTimeOffEntitlementsItems", "type": "object" }, "EorContractsContractIdOffboardingResignationsReviewPtoPostRequestBodyContentApplicationJsonSchemaDataUsedTimeOffTrackingType": { "description": "Type of time off tracking - whether it's tracked on Deel platform or off platform", "enum": [ "ON_PLATFORM", "OFF_PLATFORM" ], "title": "EorContractsContractIdOffboardingResignationsReviewPtoPostRequestBodyContentApplicationJsonSchemaDataUsedTimeOffTrackingType", "type": "string" }, "EorContractsContractIdOffboardingResignationsReviewPtoPostResponsesContentApplicationJsonSchemaData": { "properties": { "contract_id": { "description": "The unique identifier of the employee contract.", "type": "string" }, "created_at": { "description": "The date and time the offboarding request was created", "format": "date-time", "type": "string" }, "desired_end_date": { "description": "The desired end date. If the date is not provided, it will be selected by HRX the closest date possible", "format": "date-time", "type": [ "string", "null" ] }, "documents": { "$ref": "#/components/schemas/EorContractsContractIdOffboardingResignationsReviewPtoPostResponsesContentApplicationJsonSchemaDataDocuments", "description": "Document management structure for termination workflow including review processes and supporting documents" }, "end_date": { "description": "The definitive contract end date", "format": "date-time", "type": [ "string", "null" ] }, "id": { "description": "The unique identifier of the offboarding request", "format": "uuid", "type": "string" }, "is_sensitive": { "description": "Indicates if the offboarding request is sensitive. This is used to restrict access to the request only to the requester and the HRX team.", "type": "boolean" }, "request_data": { "oneOf": [ { "$ref": "#/components/schemas/EorContractsContractIdOffboardingResignationsReviewPtoPostResponsesContentApplicationJsonSchemaDataRequestData" }, { "type": "null" } ] }, "updated_at": { "description": "The date and time the offboarding request was updated", "format": "date-time", "type": "string" } }, "title": "EorContractsContractIdOffboardingResignationsReviewPtoPostResponsesContentApplicationJsonSchemaData", "type": "object" }, "EorContractsContractIdOffboardingResignationsReviewPtoPostResponsesContentApplicationJsonSchemaDataDocuments": { "description": "Document management structure for termination workflow including review processes and supporting documents", "properties": { "offboarding": { "description": "Document set shared that requires client or employee review", "items": { "$ref": "#/components/schemas/EorContractsContractIdOffboardingResignationsReviewPtoPostResponsesContentApplicationJsonSchemaDataDocumentsOffboardingItems" }, "type": "array" }, "supporting": { "items": { "$ref": "#/components/schemas/EorContractsContractIdOffboardingResignationsReviewPtoPostResponsesContentApplicationJsonSchemaDataDocumentsSupportingItems" }, "type": "array" } }, "required": [ "supporting", "offboarding" ], "title": "EorContractsContractIdOffboardingResignationsReviewPtoPostResponsesContentApplicationJsonSchemaDataDocuments", "type": "object" }, "EorContractsContractIdOffboardingResignationsReviewPtoPostResponsesContentApplicationJsonSchemaDataDocumentsOffboardingItems": { "properties": { "created_at": { "description": "The date and time the document set was created", "format": "date-time", "type": "string" }, "files": { "items": { "$ref": "#/components/schemas/EorContractsContractIdOffboardingResignationsReviewPtoPostResponsesContentApplicationJsonSchemaDataDocumentsOffboardingItemsFilesItems" }, "type": "array" }, "id": { "description": "The unique identifier of the document set shared with the employee.", "format": "uuid", "type": "string" }, "is_employee_notification_required": { "description": "Indicates if the employee should be notified about this document review", "type": "boolean" }, "notification_instructions": { "description": "HTML instructions for the reviewer notification", "type": [ "string", "null" ] }, "reviewed_at": { "description": "The date and time when the document was reviewed", "format": "date-time", "type": [ "string", "null" ] }, "reviewed_by": { "description": "The name of the reviewer for this document. If the reviewer is not an employee, it will be the name of the client", "type": [ "string", "null" ] }, "reviewer_feedback": { "description": "Feedback provided by the reviewer", "type": [ "string", "null" ] }, "reviewer_type": { "$ref": "#/components/schemas/EorContractsContractIdOffboardingResignationsReviewPtoPostResponsesContentApplicationJsonSchemaDataDocumentsOffboardingItemsReviewerType", "description": "The type of reviewer for this document" }, "status": { "$ref": "#/components/schemas/EorContractsContractIdOffboardingResignationsReviewPtoPostResponsesContentApplicationJsonSchemaDataDocumentsOffboardingItemsStatus", "description": "The current status of the document review" }, "updated_at": { "description": "The date and time the document set was updated", "format": "date-time", "type": "string" } }, "required": [ "files", "status", "reviewer_type", "is_employee_notification_required" ], "title": "EorContractsContractIdOffboardingResignationsReviewPtoPostResponsesContentApplicationJsonSchemaDataDocumentsOffboardingItems", "type": "object" }, "EorContractsContractIdOffboardingResignationsReviewPtoPostResponsesContentApplicationJsonSchemaDataDocumentsOffboardingItemsFilesItems": { "properties": { "created_at": { "description": "The date and time the file was created", "format": "date-time", "type": "string" }, "id": { "description": "The unique identifier of the file", "type": "string" }, "name": { "description": "The name of the file", "type": "string" }, "type": { "description": "The type/extension of the file", "type": "string" }, "updated_at": { "description": "The date and time the file was updated", "format": "date-time", "type": "string" } }, "required": [ "id", "name", "type", "created_at" ], "title": "EorContractsContractIdOffboardingResignationsReviewPtoPostResponsesContentApplicationJsonSchemaDataDocumentsOffboardingItemsFilesItems", "type": "object" }, "EorContractsContractIdOffboardingResignationsReviewPtoPostResponsesContentApplicationJsonSchemaDataDocumentsOffboardingItemsReviewerType": { "description": "The type of reviewer for this document", "enum": [ "CLIENT", "EMPLOYEE" ], "title": "EorContractsContractIdOffboardingResignationsReviewPtoPostResponsesContentApplicationJsonSchemaDataDocumentsOffboardingItemsReviewerType", "type": "string" }, "EorContractsContractIdOffboardingResignationsReviewPtoPostResponsesContentApplicationJsonSchemaDataDocumentsOffboardingItemsStatus": { "description": "The current status of the document review", "enum": [ "AWAITING_REVIEW", "AWAITING_FEEDBACK", "FEEDBACK_PROVIDED", "APPROVED", "CHANGES_REQUESTED_BY_CLIENT", "CHANGES_REQUESTED_BY_EMPLOYEE", "WAIVED_REVIEW", "NOT_RESPONDED", "CANCELLED" ], "title": "EorContractsContractIdOffboardingResignationsReviewPtoPostResponsesContentApplicationJsonSchemaDataDocumentsOffboardingItemsStatus", "type": "string" }, "EorContractsContractIdOffboardingResignationsReviewPtoPostResponsesContentApplicationJsonSchemaDataDocumentsSupportingItems": { "properties": { "created_at": { "description": "The date and time the file was created", "format": "date-time", "type": "string" }, "id": { "description": "The unique identifier of the file", "type": "string" }, "is_additional_supporting_document": { "description": "Indicates if this is an additional supporting document added after the initial submission", "type": "boolean" }, "name": { "description": "The name of the file", "type": "string" }, "type": { "description": "The type/extension of the file", "type": "string" }, "updated_at": { "description": "The date and time the file was updated", "format": "date-time", "type": "string" } }, "required": [ "id", "name", "type", "created_at", "updated_at", "is_additional_supporting_document" ], "title": "EorContractsContractIdOffboardingResignationsReviewPtoPostResponsesContentApplicationJsonSchemaDataDocumentsSupportingItems", "type": "object" }, "EorContractsContractIdOffboardingResignationsReviewPtoPostResponsesContentApplicationJsonSchemaDataRequestData": { "properties": { "desired_end_date": { "description": "The desired end date. If the date is not provided, it will be selected by HRX the closest date possible", "format": "date", "type": [ "string", "null" ] }, "eligible_for_rehire": { "description": "Parameter to inform whether it would be possible for the client to hire the employee again", "oneOf": [ { "$ref": "#/components/schemas/EorContractsContractIdOffboardingResignationsReviewPtoPostResponsesContentApplicationJsonSchemaDataRequestDataEligibleForRehire" }, { "type": "null" } ] }, "eligible_for_rehire_reason": { "description": "Describe if the option DONT_KNOW was selected on eligible_for_rehire", "type": [ "string", "null" ] }, "end_date": { "description": "The definitive contract end date", "format": "date-time", "type": [ "string", "null" ] }, "reason": { "$ref": "#/components/schemas/EorContractsContractIdOffboardingResignationsReviewPtoPostResponsesContentApplicationJsonSchemaDataRequestDataReason", "description": "The reason for the termination" }, "reason_detail": { "description": "Optional field to describe the reason behind the resignation request", "type": [ "string", "null" ] }, "used_time_off": { "$ref": "#/components/schemas/EorContractsContractIdOffboardingResignationsReviewPtoPostResponsesContentApplicationJsonSchemaDataRequestDataUsedTimeOff", "description": "Time-off usage data including policy information and tracking periods" } }, "title": "EorContractsContractIdOffboardingResignationsReviewPtoPostResponsesContentApplicationJsonSchemaDataRequestData", "type": "object" }, "EorContractsContractIdOffboardingResignationsReviewPtoPostResponsesContentApplicationJsonSchemaDataRequestDataEligibleForRehire": { "description": "Parameter to inform whether it would be possible for the client to hire the employee again", "enum": [ "YES", "NO", "DONT_KNOW" ], "title": "EorContractsContractIdOffboardingResignationsReviewPtoPostResponsesContentApplicationJsonSchemaDataRequestDataEligibleForRehire", "type": "string" }, "EorContractsContractIdOffboardingResignationsReviewPtoPostResponsesContentApplicationJsonSchemaDataRequestDataReason": { "description": "The reason for the termination", "enum": [ "STATUS_CHANGE", "RELOCATION", "COMPENSATION", "RETIREMENT", "JOB_ABANDONMENT", "WORK_RELATED", "PERSONAL", "OTHER_OPPORTUNITY", "NON_RENEWAL", "PROBATION", "ASSIGNMENT_ENDED", "POSITION_ELIMINATION", "FORCE_REDUCTION", "DEATH", "FOR_CAUSE", "PERFORMANCE", "MEDICAL", "PERFORMANCE_ISSUES", "ATTENDANCE_ISSUES", "REORGANIZATION_DOWNSIZING_BUDGET_OR_REDUCTION_OF_WORKFORCE", "ROLE_BECAME_REDUNDANT_OR_ROLE_CHANGED", "OFFER_WAS_REVOKED", "EXITING_THE_MARKET", "NO_LONGER_WISH_TO_WORK_WITH_DEEL", "COMPANY_ACQUIRED", "STEALING", "MISCONDUCT", "FALSIFYING", "HARASSMENT", "VIOLENCE", "REORGANIZATION_DOWNSIZING_BUDGET_OR_REDUCTION_OF_WORKFORCE_OR_ROLE_BECAME_REDUNDANT_OR_ROLE_CHANGED", "UNAUTHORIZED_ABSENCES_OR_LACK_OF_ATTENDANCE", "STANDARD_RESELLER_PRACTICE", "MOVING_EMPLOYEE_TO_INTERNAL_ENTITY", "MOVING_EMPLOYEE_TO_DEEL_PEO", "OTHER" ], "title": "EorContractsContractIdOffboardingResignationsReviewPtoPostResponsesContentApplicationJsonSchemaDataRequestDataReason", "type": "string" }, "EorContractsContractIdOffboardingResignationsReviewPtoPostResponsesContentApplicationJsonSchemaDataRequestDataUsedTimeOff": { "description": "Time-off usage data including policy information and tracking periods", "properties": { "additional_details": { "oneOf": [ { "$ref": "#/components/schemas/EorContractsContractIdOffboardingResignationsReviewPtoPostResponsesContentApplicationJsonSchemaDataRequestDataUsedTimeOffAdditionalDetails" }, { "type": "null" } ] }, "is_deel_pto_confirmed": { "description": "Indicates whether the PTO allocation has been confirmed by Deel's system", "type": "boolean" }, "time_offs": { "items": { "$ref": "#/components/schemas/EorContractsContractIdOffboardingResignationsReviewPtoPostResponsesContentApplicationJsonSchemaDataRequestDataUsedTimeOffTimeOffsItems" }, "type": "array" } }, "required": [ "time_offs", "is_deel_pto_confirmed" ], "title": "EorContractsContractIdOffboardingResignationsReviewPtoPostResponsesContentApplicationJsonSchemaDataRequestDataUsedTimeOff", "type": "object" }, "EorContractsContractIdOffboardingResignationsReviewPtoPostResponsesContentApplicationJsonSchemaDataRequestDataUsedTimeOffAdditionalDetails": { "properties": { "last_updated_at": { "description": "The date and time when the time-off data was last updated", "format": "date-time", "type": [ "string", "null" ] }, "notes": { "description": "Additional notes or comments about the time-off data", "type": [ "string", "null" ] }, "updated_by": { "description": "The person or system that last updated the time-off data", "type": [ "string", "null" ] } }, "title": "EorContractsContractIdOffboardingResignationsReviewPtoPostResponsesContentApplicationJsonSchemaDataRequestDataUsedTimeOffAdditionalDetails", "type": "object" }, "EorContractsContractIdOffboardingResignationsReviewPtoPostResponsesContentApplicationJsonSchemaDataRequestDataUsedTimeOffTimeOffsItems": { "properties": { "policy_type": { "description": "The type of time-off policy", "type": "string" }, "scheduled_until_end_date": { "description": "The amount of time off scheduled until the end date of the current tracking period", "format": "double", "type": "number" }, "tracking_periods": { "items": { "$ref": "#/components/schemas/EorContractsContractIdOffboardingResignationsReviewPtoPostResponsesContentApplicationJsonSchemaDataRequestDataUsedTimeOffTimeOffsItemsTrackingPeriodsItems" }, "type": "array" }, "unit": { "$ref": "#/components/schemas/EorContractsContractIdOffboardingResignationsReviewPtoPostResponsesContentApplicationJsonSchemaDataRequestDataUsedTimeOffTimeOffsItemsUnit", "description": "The unit of measurement for time off tracking" } }, "required": [ "unit", "policy_type", "tracking_periods", "scheduled_until_end_date" ], "title": "EorContractsContractIdOffboardingResignationsReviewPtoPostResponsesContentApplicationJsonSchemaDataRequestDataUsedTimeOffTimeOffsItems", "type": "object" }, "EorContractsContractIdOffboardingResignationsReviewPtoPostResponsesContentApplicationJsonSchemaDataRequestDataUsedTimeOffTimeOffsItemsTrackingPeriodsItems": { "properties": { "end_date": { "description": "The end date of the tracking period", "format": "date-time", "type": "string" }, "start_date": { "description": "The start date of the tracking period", "format": "date-time", "type": "string" }, "used": { "description": "The amount of time off used in this tracking period", "format": "double", "type": "number" } }, "required": [ "used", "end_date", "start_date" ], "title": "EorContractsContractIdOffboardingResignationsReviewPtoPostResponsesContentApplicationJsonSchemaDataRequestDataUsedTimeOffTimeOffsItemsTrackingPeriodsItems", "type": "object" }, "EorContractsContractIdOffboardingResignationsReviewPtoPostResponsesContentApplicationJsonSchemaDataRequestDataUsedTimeOffTimeOffsItemsUnit": { "description": "The unit of measurement for time off tracking", "enum": [ "BUSINESS_DAY", "CALENDAR_DAY", "HOUR" ], "title": "EorContractsContractIdOffboardingResignationsReviewPtoPostResponsesContentApplicationJsonSchemaDataRequestDataUsedTimeOffTimeOffsItemsUnit", "type": "string" }, "EorContractsContractIdOffboardingResignationsReviewPtoPostResponsesContentApplicationJsonSchemaErrorsItems": { "properties": { "code": { "description": "Error code of the handler which produced the returned error", "type": "string" }, "field": { "description": "The field name where error occurred (null for server errors)", "type": "string" }, "message": { "description": "Description of the returned error", "type": "string" } }, "title": "EorContractsContractIdOffboardingResignationsReviewPtoPostResponsesContentApplicationJsonSchemaErrorsItems", "type": "object" }, "EorContractsContractIdOffboardingRestrictedDatesGetParametersTerminationType": { "enum": [ "TERMINATION", "RESIGNATION" ], "title": "EorContractsContractIdOffboardingRestrictedDatesGetParametersTerminationType", "type": "string" }, "EorContractsContractIdOffboardingRestrictedDatesGetResponsesContentApplicationJsonSchemaData": { "properties": { "earliest_available_end_date": { "description": "The earliest date that can be selected as the end date.", "format": "date-time", "type": "string" }, "is_end_date_allowed_on_holidays": { "description": "Whether end date selection is allowed on holidays.", "type": "boolean" }, "is_out_work_scheduled_allowed": { "description": "Whether scheduling out of work is allowed.", "type": "boolean" }, "restricted_dates": { "description": "Dates that are not enabled for selection.", "items": { "format": "date-time", "type": "string" }, "type": "array" } }, "required": [ "restricted_dates", "earliest_available_end_date", "is_out_work_scheduled_allowed", "is_end_date_allowed_on_holidays" ], "title": "EorContractsContractIdOffboardingRestrictedDatesGetResponsesContentApplicationJsonSchemaData", "type": "object" }, "EorContractsContractIdOffboardingRestrictedDatesGetResponsesContentApplicationJsonSchemaErrorsItems": { "properties": { "code": { "description": "Error code of the handler which produced the returned error", "type": "string" }, "field": { "description": "The field name where error occurred (null for server errors)", "type": "string" }, "message": { "description": "Description of the returned error", "type": "string" } }, "title": "EorContractsContractIdOffboardingRestrictedDatesGetResponsesContentApplicationJsonSchemaErrorsItems", "type": "object" }, "EorContractsContractIdOffboardingReviewClientSignOffsPostRequestBodyContentApplicationJsonSchemaData": { "properties": { "has_client_approved": { "description": "Indicates if the client has approved the termination request", "type": "boolean" }, "has_employee_been_notified": { "description": "Indicates if the employee has been notified about the termiantion", "type": [ "boolean", "null" ] }, "reviewer_feedback": { "description": "Feedback from the reviewer when the termination is not approved. Required if has_client_approved is false, otherwise optional.", "maxLength": 2000, "type": [ "string", "null" ] } }, "required": [ "has_client_approved" ], "title": "EorContractsContractIdOffboardingReviewClientSignOffsPostRequestBodyContentApplicationJsonSchemaData", "type": "object" }, "EorContractsContractIdOffboardingReviewClientSignOffsPostResponsesContentApplicationJsonSchemaData": { "properties": { "contract_id": { "description": "The unique identifier of the employee contract.", "type": "string" }, "created_at": { "description": "The date and time the offboarding request was created", "format": "date-time", "type": "string" }, "desired_end_date": { "description": "The desired end date. If the date is not provided, it will be selected by HRX the closest date possible", "format": "date-time", "type": [ "string", "null" ] }, "documents": { "$ref": "#/components/schemas/EorContractsContractIdOffboardingReviewClientSignOffsPostResponsesContentApplicationJsonSchemaDataDocuments", "description": "Document management structure for termination workflow including review processes and supporting documents" }, "end_date": { "description": "The definitive contract end date", "format": "date-time", "type": [ "string", "null" ] }, "id": { "description": "The unique identifier of the offboarding request", "format": "uuid", "type": "string" }, "is_sensitive": { "description": "Indicates if the offboarding request is sensitive. This is used to restrict access to the request only to the requester and the HRX team.", "type": "boolean" }, "request_data": { "oneOf": [ { "$ref": "#/components/schemas/EorContractsContractIdOffboardingReviewClientSignOffsPostResponsesContentApplicationJsonSchemaDataRequestData" }, { "type": "null" } ] }, "updated_at": { "description": "The date and time the offboarding request was updated", "format": "date-time", "type": "string" } }, "title": "EorContractsContractIdOffboardingReviewClientSignOffsPostResponsesContentApplicationJsonSchemaData", "type": "object" }, "EorContractsContractIdOffboardingReviewClientSignOffsPostResponsesContentApplicationJsonSchemaDataDocuments": { "description": "Document management structure for termination workflow including review processes and supporting documents", "properties": { "offboarding": { "description": "Document set shared that requires client or employee review", "items": { "$ref": "#/components/schemas/EorContractsContractIdOffboardingReviewClientSignOffsPostResponsesContentApplicationJsonSchemaDataDocumentsOffboardingItems" }, "type": "array" }, "resignation_letter": { "oneOf": [ { "$ref": "#/components/schemas/EorContractsContractIdOffboardingReviewClientSignOffsPostResponsesContentApplicationJsonSchemaDataDocumentsResignationLetter" }, { "type": "null" } ] }, "supporting": { "items": { "$ref": "#/components/schemas/EorContractsContractIdOffboardingReviewClientSignOffsPostResponsesContentApplicationJsonSchemaDataDocumentsSupportingItems" }, "type": "array" } }, "required": [ "supporting", "offboarding" ], "title": "EorContractsContractIdOffboardingReviewClientSignOffsPostResponsesContentApplicationJsonSchemaDataDocuments", "type": "object" }, "EorContractsContractIdOffboardingReviewClientSignOffsPostResponsesContentApplicationJsonSchemaDataDocumentsOffboardingItems": { "properties": { "created_at": { "description": "The date and time the document set was created", "format": "date-time", "type": "string" }, "files": { "items": { "$ref": "#/components/schemas/EorContractsContractIdOffboardingReviewClientSignOffsPostResponsesContentApplicationJsonSchemaDataDocumentsOffboardingItemsFilesItems" }, "type": "array" }, "id": { "description": "The unique identifier of the document set shared with the employee.", "format": "uuid", "type": "string" }, "is_employee_notification_required": { "description": "Indicates if the employee should be notified about this document review", "type": "boolean" }, "notification_instructions": { "description": "HTML instructions for the reviewer notification", "type": [ "string", "null" ] }, "reviewed_at": { "description": "The date and time when the document was reviewed", "format": "date-time", "type": [ "string", "null" ] }, "reviewed_by": { "description": "The name of the reviewer for this document. If the reviewer is not an employee, it will be the name of the client", "type": [ "string", "null" ] }, "reviewer_feedback": { "description": "Feedback provided by the reviewer", "type": [ "string", "null" ] }, "reviewer_type": { "$ref": "#/components/schemas/EorContractsContractIdOffboardingReviewClientSignOffsPostResponsesContentApplicationJsonSchemaDataDocumentsOffboardingItemsReviewerType", "description": "The type of reviewer for this document" }, "status": { "$ref": "#/components/schemas/EorContractsContractIdOffboardingReviewClientSignOffsPostResponsesContentApplicationJsonSchemaDataDocumentsOffboardingItemsStatus", "description": "The current status of the document review" }, "updated_at": { "description": "The date and time the document set was updated", "format": "date-time", "type": "string" } }, "required": [ "files", "status", "reviewer_type", "is_employee_notification_required" ], "title": "EorContractsContractIdOffboardingReviewClientSignOffsPostResponsesContentApplicationJsonSchemaDataDocumentsOffboardingItems", "type": "object" }, "EorContractsContractIdOffboardingReviewClientSignOffsPostResponsesContentApplicationJsonSchemaDataDocumentsOffboardingItemsFilesItems": { "properties": { "created_at": { "description": "The date and time the file was created", "format": "date-time", "type": "string" }, "id": { "description": "The unique identifier of the file", "type": "string" }, "name": { "description": "The name of the file", "type": "string" }, "type": { "description": "The type/extension of the file", "type": "string" }, "updated_at": { "description": "The date and time the file was updated", "format": "date-time", "type": "string" } }, "required": [ "id", "name", "type", "created_at" ], "title": "EorContractsContractIdOffboardingReviewClientSignOffsPostResponsesContentApplicationJsonSchemaDataDocumentsOffboardingItemsFilesItems", "type": "object" }, "EorContractsContractIdOffboardingReviewClientSignOffsPostResponsesContentApplicationJsonSchemaDataDocumentsOffboardingItemsReviewerType": { "description": "The type of reviewer for this document", "enum": [ "CLIENT", "EMPLOYEE" ], "title": "EorContractsContractIdOffboardingReviewClientSignOffsPostResponsesContentApplicationJsonSchemaDataDocumentsOffboardingItemsReviewerType", "type": "string" }, "EorContractsContractIdOffboardingReviewClientSignOffsPostResponsesContentApplicationJsonSchemaDataDocumentsOffboardingItemsStatus": { "description": "The current status of the document review", "enum": [ "AWAITING_REVIEW", "AWAITING_FEEDBACK", "FEEDBACK_PROVIDED", "APPROVED", "CHANGES_REQUESTED_BY_CLIENT", "CHANGES_REQUESTED_BY_EMPLOYEE", "WAIVED_REVIEW", "NOT_RESPONDED", "CANCELLED" ], "title": "EorContractsContractIdOffboardingReviewClientSignOffsPostResponsesContentApplicationJsonSchemaDataDocumentsOffboardingItemsStatus", "type": "string" }, "EorContractsContractIdOffboardingReviewClientSignOffsPostResponsesContentApplicationJsonSchemaDataDocumentsResignationLetter": { "properties": { "created_at": { "description": "The date and time the resignation letter was created", "format": "date-time", "type": "string" }, "id": { "description": "The unique identifier of the resignation letter", "format": "uuid", "type": "string" }, "signature": { "description": "The signature of the resignation letter", "type": [ "string", "null" ] }, "signed_at": { "description": "The date and time when the resignation letter was signed", "format": "date-time", "type": [ "string", "null" ] }, "updated_at": { "description": "The date and time the resignation letter was updated", "format": "date-time", "type": "string" } }, "title": "EorContractsContractIdOffboardingReviewClientSignOffsPostResponsesContentApplicationJsonSchemaDataDocumentsResignationLetter", "type": "object" }, "EorContractsContractIdOffboardingReviewClientSignOffsPostResponsesContentApplicationJsonSchemaDataDocumentsSupportingItems": { "properties": { "created_at": { "description": "The date and time the file was created", "format": "date-time", "type": "string" }, "id": { "description": "The unique identifier of the file", "type": "string" }, "is_additional_supporting_document": { "description": "Indicates if this is an additional supporting document added after the initial submission", "type": "boolean" }, "name": { "description": "The name of the file", "type": "string" }, "type": { "description": "The type/extension of the file", "type": "string" }, "updated_at": { "description": "The date and time the file was updated", "format": "date-time", "type": "string" } }, "required": [ "id", "name", "type", "created_at", "updated_at", "is_additional_supporting_document" ], "title": "EorContractsContractIdOffboardingReviewClientSignOffsPostResponsesContentApplicationJsonSchemaDataDocumentsSupportingItems", "type": "object" }, "EorContractsContractIdOffboardingReviewClientSignOffsPostResponsesContentApplicationJsonSchemaDataRequestData": { "properties": { "desired_end_date": { "description": "The desired end date. If the date is not provided, it will be selected by HRX the closest date possible", "format": "date", "type": [ "string", "null" ] }, "eligible_for_rehire": { "description": "Parameter to inform whether it would be possible for the client to hire the employee again", "oneOf": [ { "$ref": "#/components/schemas/EorContractsContractIdOffboardingReviewClientSignOffsPostResponsesContentApplicationJsonSchemaDataRequestDataEligibleForRehire" }, { "type": "null" } ] }, "eligible_for_rehire_reason": { "description": "Describe if the option DONT_KNOW was selected on eligible_for_rehire", "type": [ "string", "null" ] }, "end_date": { "description": "The definitive contract end date", "format": "date-time", "type": [ "string", "null" ] }, "reason": { "$ref": "#/components/schemas/EorContractsContractIdOffboardingReviewClientSignOffsPostResponsesContentApplicationJsonSchemaDataRequestDataReason", "description": "The reason for the termination" }, "reason_detail": { "description": "Optional field to describe the reason behind the resignation request", "type": [ "string", "null" ] }, "used_time_off": { "$ref": "#/components/schemas/EorContractsContractIdOffboardingReviewClientSignOffsPostResponsesContentApplicationJsonSchemaDataRequestDataUsedTimeOff", "description": "Time-off usage data including policy information and tracking periods" } }, "title": "EorContractsContractIdOffboardingReviewClientSignOffsPostResponsesContentApplicationJsonSchemaDataRequestData", "type": "object" }, "EorContractsContractIdOffboardingReviewClientSignOffsPostResponsesContentApplicationJsonSchemaDataRequestDataEligibleForRehire": { "description": "Parameter to inform whether it would be possible for the client to hire the employee again", "enum": [ "YES", "NO", "DONT_KNOW" ], "title": "EorContractsContractIdOffboardingReviewClientSignOffsPostResponsesContentApplicationJsonSchemaDataRequestDataEligibleForRehire", "type": "string" }, "EorContractsContractIdOffboardingReviewClientSignOffsPostResponsesContentApplicationJsonSchemaDataRequestDataReason": { "description": "The reason for the termination", "enum": [ "STATUS_CHANGE", "RELOCATION", "COMPENSATION", "RETIREMENT", "JOB_ABANDONMENT", "WORK_RELATED", "PERSONAL", "OTHER_OPPORTUNITY", "NON_RENEWAL", "PROBATION", "ASSIGNMENT_ENDED", "POSITION_ELIMINATION", "FORCE_REDUCTION", "DEATH", "FOR_CAUSE", "PERFORMANCE", "MEDICAL", "PERFORMANCE_ISSUES", "ATTENDANCE_ISSUES", "REORGANIZATION_DOWNSIZING_BUDGET_OR_REDUCTION_OF_WORKFORCE", "ROLE_BECAME_REDUNDANT_OR_ROLE_CHANGED", "OFFER_WAS_REVOKED", "EXITING_THE_MARKET", "NO_LONGER_WISH_TO_WORK_WITH_DEEL", "COMPANY_ACQUIRED", "STEALING", "MISCONDUCT", "FALSIFYING", "HARASSMENT", "VIOLENCE", "REORGANIZATION_DOWNSIZING_BUDGET_OR_REDUCTION_OF_WORKFORCE_OR_ROLE_BECAME_REDUNDANT_OR_ROLE_CHANGED", "UNAUTHORIZED_ABSENCES_OR_LACK_OF_ATTENDANCE", "STANDARD_RESELLER_PRACTICE", "MOVING_EMPLOYEE_TO_INTERNAL_ENTITY", "MOVING_EMPLOYEE_TO_DEEL_PEO", "OTHER" ], "title": "EorContractsContractIdOffboardingReviewClientSignOffsPostResponsesContentApplicationJsonSchemaDataRequestDataReason", "type": "string" }, "EorContractsContractIdOffboardingReviewClientSignOffsPostResponsesContentApplicationJsonSchemaDataRequestDataUsedTimeOff": { "description": "Time-off usage data including policy information and tracking periods", "properties": { "additional_details": { "oneOf": [ { "$ref": "#/components/schemas/EorContractsContractIdOffboardingReviewClientSignOffsPostResponsesContentApplicationJsonSchemaDataRequestDataUsedTimeOffAdditionalDetails" }, { "type": "null" } ] }, "is_deel_pto_confirmed": { "description": "Indicates whether the PTO allocation has been confirmed by Deel's system", "type": "boolean" }, "time_offs": { "items": { "$ref": "#/components/schemas/EorContractsContractIdOffboardingReviewClientSignOffsPostResponsesContentApplicationJsonSchemaDataRequestDataUsedTimeOffTimeOffsItems" }, "type": "array" } }, "required": [ "time_offs", "is_deel_pto_confirmed" ], "title": "EorContractsContractIdOffboardingReviewClientSignOffsPostResponsesContentApplicationJsonSchemaDataRequestDataUsedTimeOff", "type": "object" }, "EorContractsContractIdOffboardingReviewClientSignOffsPostResponsesContentApplicationJsonSchemaDataRequestDataUsedTimeOffAdditionalDetails": { "properties": { "last_updated_at": { "description": "The date and time when the time-off data was last updated", "format": "date-time", "type": [ "string", "null" ] }, "notes": { "description": "Additional notes or comments about the time-off data", "type": [ "string", "null" ] }, "updated_by": { "description": "The person or system that last updated the time-off data", "type": [ "string", "null" ] } }, "title": "EorContractsContractIdOffboardingReviewClientSignOffsPostResponsesContentApplicationJsonSchemaDataRequestDataUsedTimeOffAdditionalDetails", "type": "object" }, "EorContractsContractIdOffboardingReviewClientSignOffsPostResponsesContentApplicationJsonSchemaDataRequestDataUsedTimeOffTimeOffsItems": { "properties": { "policy_type": { "description": "The type of time-off policy", "type": "string" }, "scheduled_until_end_date": { "description": "The amount of time off scheduled until the end date of the current tracking period", "format": "double", "type": "number" }, "tracking_periods": { "items": { "$ref": "#/components/schemas/EorContractsContractIdOffboardingReviewClientSignOffsPostResponsesContentApplicationJsonSchemaDataRequestDataUsedTimeOffTimeOffsItemsTrackingPeriodsItems" }, "type": "array" }, "unit": { "$ref": "#/components/schemas/EorContractsContractIdOffboardingReviewClientSignOffsPostResponsesContentApplicationJsonSchemaDataRequestDataUsedTimeOffTimeOffsItemsUnit", "description": "The unit of measurement for time off tracking" } }, "required": [ "unit", "policy_type", "tracking_periods", "scheduled_until_end_date" ], "title": "EorContractsContractIdOffboardingReviewClientSignOffsPostResponsesContentApplicationJsonSchemaDataRequestDataUsedTimeOffTimeOffsItems", "type": "object" }, "EorContractsContractIdOffboardingReviewClientSignOffsPostResponsesContentApplicationJsonSchemaDataRequestDataUsedTimeOffTimeOffsItemsTrackingPeriodsItems": { "properties": { "end_date": { "description": "The end date of the tracking period", "format": "date-time", "type": "string" }, "start_date": { "description": "The start date of the tracking period", "format": "date-time", "type": "string" }, "used": { "description": "The amount of time off used in this tracking period", "format": "double", "type": "number" } }, "required": [ "used", "end_date", "start_date" ], "title": "EorContractsContractIdOffboardingReviewClientSignOffsPostResponsesContentApplicationJsonSchemaDataRequestDataUsedTimeOffTimeOffsItemsTrackingPeriodsItems", "type": "object" }, "EorContractsContractIdOffboardingReviewClientSignOffsPostResponsesContentApplicationJsonSchemaDataRequestDataUsedTimeOffTimeOffsItemsUnit": { "description": "The unit of measurement for time off tracking", "enum": [ "BUSINESS_DAY", "CALENDAR_DAY", "HOUR" ], "title": "EorContractsContractIdOffboardingReviewClientSignOffsPostResponsesContentApplicationJsonSchemaDataRequestDataUsedTimeOffTimeOffsItemsUnit", "type": "string" }, "EorContractsContractIdOffboardingReviewClientSignOffsPostResponsesContentApplicationJsonSchemaErrorsItems": { "properties": { "code": { "description": "Error code of the handler which produced the returned error", "type": "string" }, "field": { "description": "The field name where error occurred (null for server errors)", "type": "string" }, "message": { "description": "Description of the returned error", "type": "string" } }, "title": "EorContractsContractIdOffboardingReviewClientSignOffsPostResponsesContentApplicationJsonSchemaErrorsItems", "type": "object" }, "EorContractsContractIdOffboardingReviewEmployeeSignOffsPostRequestBodyContentApplicationJsonSchemaData": { "properties": { "approved": { "description": "Indicates if the employee has approved the sign-off review", "type": "boolean" }, "requested_changes": { "description": "Details of requested changes if the review is not approved", "maxLength": 2000, "type": [ "string", "null" ] }, "reviewer_signature": { "description": "Signature of the reviewer if the review is approved", "maxLength": 1000, "type": [ "string", "null" ] } }, "required": [ "approved", "requested_changes", "reviewer_signature" ], "title": "EorContractsContractIdOffboardingReviewEmployeeSignOffsPostRequestBodyContentApplicationJsonSchemaData", "type": "object" }, "EorContractsContractIdOffboardingReviewEmployeeSignOffsPostResponsesContentApplicationJsonSchemaData": { "properties": { "contract_id": { "description": "The unique identifier of the employee contract.", "type": "string" }, "created_at": { "description": "The date and time the offboarding request was created", "format": "date-time", "type": "string" }, "desired_end_date": { "description": "The desired end date. If the date is not provided, it will be selected by HRX the closest date possible", "format": "date-time", "type": [ "string", "null" ] }, "documents": { "$ref": "#/components/schemas/EorContractsContractIdOffboardingReviewEmployeeSignOffsPostResponsesContentApplicationJsonSchemaDataDocuments", "description": "Document management structure for termination workflow including review processes and supporting documents" }, "end_date": { "description": "The definitive contract end date", "format": "date-time", "type": [ "string", "null" ] }, "id": { "description": "The unique identifier of the offboarding request", "format": "uuid", "type": "string" }, "is_sensitive": { "description": "Indicates if the offboarding request is sensitive. This is used to restrict access to the request only to the requester and the HRX team.", "type": "boolean" }, "request_data": { "oneOf": [ { "$ref": "#/components/schemas/EorContractsContractIdOffboardingReviewEmployeeSignOffsPostResponsesContentApplicationJsonSchemaDataRequestData" }, { "type": "null" } ] }, "updated_at": { "description": "The date and time the offboarding request was updated", "format": "date-time", "type": "string" } }, "title": "EorContractsContractIdOffboardingReviewEmployeeSignOffsPostResponsesContentApplicationJsonSchemaData", "type": "object" }, "EorContractsContractIdOffboardingReviewEmployeeSignOffsPostResponsesContentApplicationJsonSchemaDataDocuments": { "description": "Document management structure for termination workflow including review processes and supporting documents", "properties": { "offboarding": { "description": "Document set shared that requires client or employee review", "items": { "$ref": "#/components/schemas/EorContractsContractIdOffboardingReviewEmployeeSignOffsPostResponsesContentApplicationJsonSchemaDataDocumentsOffboardingItems" }, "type": "array" }, "resignation_letter": { "oneOf": [ { "$ref": "#/components/schemas/EorContractsContractIdOffboardingReviewEmployeeSignOffsPostResponsesContentApplicationJsonSchemaDataDocumentsResignationLetter" }, { "type": "null" } ] }, "supporting": { "items": { "$ref": "#/components/schemas/EorContractsContractIdOffboardingReviewEmployeeSignOffsPostResponsesContentApplicationJsonSchemaDataDocumentsSupportingItems" }, "type": "array" } }, "required": [ "supporting", "offboarding" ], "title": "EorContractsContractIdOffboardingReviewEmployeeSignOffsPostResponsesContentApplicationJsonSchemaDataDocuments", "type": "object" }, "EorContractsContractIdOffboardingReviewEmployeeSignOffsPostResponsesContentApplicationJsonSchemaDataDocumentsOffboardingItems": { "properties": { "created_at": { "description": "The date and time the document set was created", "format": "date-time", "type": "string" }, "files": { "items": { "$ref": "#/components/schemas/EorContractsContractIdOffboardingReviewEmployeeSignOffsPostResponsesContentApplicationJsonSchemaDataDocumentsOffboardingItemsFilesItems" }, "type": "array" }, "id": { "description": "The unique identifier of the document set shared with the employee.", "format": "uuid", "type": "string" }, "is_employee_notification_required": { "description": "Indicates if the employee should be notified about this document review", "type": "boolean" }, "notification_instructions": { "description": "HTML instructions for the reviewer notification", "type": [ "string", "null" ] }, "reviewed_at": { "description": "The date and time when the document was reviewed", "format": "date-time", "type": [ "string", "null" ] }, "reviewed_by": { "description": "The name of the reviewer for this document. If the reviewer is not an employee, it will be the name of the client", "type": [ "string", "null" ] }, "reviewer_feedback": { "description": "Feedback provided by the reviewer", "type": [ "string", "null" ] }, "reviewer_type": { "$ref": "#/components/schemas/EorContractsContractIdOffboardingReviewEmployeeSignOffsPostResponsesContentApplicationJsonSchemaDataDocumentsOffboardingItemsReviewerType", "description": "The type of reviewer for this document" }, "status": { "$ref": "#/components/schemas/EorContractsContractIdOffboardingReviewEmployeeSignOffsPostResponsesContentApplicationJsonSchemaDataDocumentsOffboardingItemsStatus", "description": "The current status of the document review" }, "updated_at": { "description": "The date and time the document set was updated", "format": "date-time", "type": "string" } }, "required": [ "files", "status", "reviewer_type", "is_employee_notification_required" ], "title": "EorContractsContractIdOffboardingReviewEmployeeSignOffsPostResponsesContentApplicationJsonSchemaDataDocumentsOffboardingItems", "type": "object" }, "EorContractsContractIdOffboardingReviewEmployeeSignOffsPostResponsesContentApplicationJsonSchemaDataDocumentsOffboardingItemsFilesItems": { "properties": { "created_at": { "description": "The date and time the file was created", "format": "date-time", "type": "string" }, "id": { "description": "The unique identifier of the file", "type": "string" }, "name": { "description": "The name of the file", "type": "string" }, "type": { "description": "The type/extension of the file", "type": "string" }, "updated_at": { "description": "The date and time the file was updated", "format": "date-time", "type": "string" } }, "required": [ "id", "name", "type", "created_at" ], "title": "EorContractsContractIdOffboardingReviewEmployeeSignOffsPostResponsesContentApplicationJsonSchemaDataDocumentsOffboardingItemsFilesItems", "type": "object" }, "EorContractsContractIdOffboardingReviewEmployeeSignOffsPostResponsesContentApplicationJsonSchemaDataDocumentsOffboardingItemsReviewerType": { "description": "The type of reviewer for this document", "enum": [ "CLIENT", "EMPLOYEE" ], "title": "EorContractsContractIdOffboardingReviewEmployeeSignOffsPostResponsesContentApplicationJsonSchemaDataDocumentsOffboardingItemsReviewerType", "type": "string" }, "EorContractsContractIdOffboardingReviewEmployeeSignOffsPostResponsesContentApplicationJsonSchemaDataDocumentsOffboardingItemsStatus": { "description": "The current status of the document review", "enum": [ "AWAITING_REVIEW", "AWAITING_FEEDBACK", "FEEDBACK_PROVIDED", "APPROVED", "CHANGES_REQUESTED_BY_CLIENT", "CHANGES_REQUESTED_BY_EMPLOYEE", "WAIVED_REVIEW", "NOT_RESPONDED", "CANCELLED" ], "title": "EorContractsContractIdOffboardingReviewEmployeeSignOffsPostResponsesContentApplicationJsonSchemaDataDocumentsOffboardingItemsStatus", "type": "string" }, "EorContractsContractIdOffboardingReviewEmployeeSignOffsPostResponsesContentApplicationJsonSchemaDataDocumentsResignationLetter": { "properties": { "created_at": { "description": "The date and time the resignation letter was created", "format": "date-time", "type": "string" }, "id": { "description": "The unique identifier of the resignation letter", "format": "uuid", "type": "string" }, "signature": { "description": "The signature of the resignation letter", "type": [ "string", "null" ] }, "signed_at": { "description": "The date and time when the resignation letter was signed", "format": "date-time", "type": [ "string", "null" ] }, "updated_at": { "description": "The date and time the resignation letter was updated", "format": "date-time", "type": "string" } }, "title": "EorContractsContractIdOffboardingReviewEmployeeSignOffsPostResponsesContentApplicationJsonSchemaDataDocumentsResignationLetter", "type": "object" }, "EorContractsContractIdOffboardingReviewEmployeeSignOffsPostResponsesContentApplicationJsonSchemaDataDocumentsSupportingItems": { "properties": { "created_at": { "description": "The date and time the file was created", "format": "date-time", "type": "string" }, "id": { "description": "The unique identifier of the file", "type": "string" }, "is_additional_supporting_document": { "description": "Indicates if this is an additional supporting document added after the initial submission", "type": "boolean" }, "name": { "description": "The name of the file", "type": "string" }, "type": { "description": "The type/extension of the file", "type": "string" }, "updated_at": { "description": "The date and time the file was updated", "format": "date-time", "type": "string" } }, "required": [ "id", "name", "type", "created_at", "updated_at", "is_additional_supporting_document" ], "title": "EorContractsContractIdOffboardingReviewEmployeeSignOffsPostResponsesContentApplicationJsonSchemaDataDocumentsSupportingItems", "type": "object" }, "EorContractsContractIdOffboardingReviewEmployeeSignOffsPostResponsesContentApplicationJsonSchemaDataRequestData": { "properties": { "desired_end_date": { "description": "The desired end date. If the date is not provided, it will be selected by HRX the closest date possible", "format": "date", "type": [ "string", "null" ] }, "eligible_for_rehire": { "description": "Parameter to inform whether it would be possible for the client to hire the employee again", "oneOf": [ { "$ref": "#/components/schemas/EorContractsContractIdOffboardingReviewEmployeeSignOffsPostResponsesContentApplicationJsonSchemaDataRequestDataEligibleForRehire" }, { "type": "null" } ] }, "eligible_for_rehire_reason": { "description": "Describe if the option DONT_KNOW was selected on eligible_for_rehire", "type": [ "string", "null" ] }, "end_date": { "description": "The definitive contract end date", "format": "date-time", "type": [ "string", "null" ] }, "reason": { "$ref": "#/components/schemas/EorContractsContractIdOffboardingReviewEmployeeSignOffsPostResponsesContentApplicationJsonSchemaDataRequestDataReason", "description": "The reason for the termination" }, "reason_detail": { "description": "Optional field to describe the reason behind the resignation request", "type": [ "string", "null" ] }, "used_time_off": { "$ref": "#/components/schemas/EorContractsContractIdOffboardingReviewEmployeeSignOffsPostResponsesContentApplicationJsonSchemaDataRequestDataUsedTimeOff", "description": "Time-off usage data including policy information and tracking periods" } }, "title": "EorContractsContractIdOffboardingReviewEmployeeSignOffsPostResponsesContentApplicationJsonSchemaDataRequestData", "type": "object" }, "EorContractsContractIdOffboardingReviewEmployeeSignOffsPostResponsesContentApplicationJsonSchemaDataRequestDataEligibleForRehire": { "description": "Parameter to inform whether it would be possible for the client to hire the employee again", "enum": [ "YES", "NO", "DONT_KNOW" ], "title": "EorContractsContractIdOffboardingReviewEmployeeSignOffsPostResponsesContentApplicationJsonSchemaDataRequestDataEligibleForRehire", "type": "string" }, "EorContractsContractIdOffboardingReviewEmployeeSignOffsPostResponsesContentApplicationJsonSchemaDataRequestDataReason": { "description": "The reason for the termination", "enum": [ "STATUS_CHANGE", "RELOCATION", "COMPENSATION", "RETIREMENT", "JOB_ABANDONMENT", "WORK_RELATED", "PERSONAL", "OTHER_OPPORTUNITY", "NON_RENEWAL", "PROBATION", "ASSIGNMENT_ENDED", "POSITION_ELIMINATION", "FORCE_REDUCTION", "DEATH", "FOR_CAUSE", "PERFORMANCE", "MEDICAL", "PERFORMANCE_ISSUES", "ATTENDANCE_ISSUES", "REORGANIZATION_DOWNSIZING_BUDGET_OR_REDUCTION_OF_WORKFORCE", "ROLE_BECAME_REDUNDANT_OR_ROLE_CHANGED", "OFFER_WAS_REVOKED", "EXITING_THE_MARKET", "NO_LONGER_WISH_TO_WORK_WITH_DEEL", "COMPANY_ACQUIRED", "STEALING", "MISCONDUCT", "FALSIFYING", "HARASSMENT", "VIOLENCE", "REORGANIZATION_DOWNSIZING_BUDGET_OR_REDUCTION_OF_WORKFORCE_OR_ROLE_BECAME_REDUNDANT_OR_ROLE_CHANGED", "UNAUTHORIZED_ABSENCES_OR_LACK_OF_ATTENDANCE", "STANDARD_RESELLER_PRACTICE", "MOVING_EMPLOYEE_TO_INTERNAL_ENTITY", "MOVING_EMPLOYEE_TO_DEEL_PEO", "OTHER" ], "title": "EorContractsContractIdOffboardingReviewEmployeeSignOffsPostResponsesContentApplicationJsonSchemaDataRequestDataReason", "type": "string" }, "EorContractsContractIdOffboardingReviewEmployeeSignOffsPostResponsesContentApplicationJsonSchemaDataRequestDataUsedTimeOff": { "description": "Time-off usage data including policy information and tracking periods", "properties": { "additional_details": { "oneOf": [ { "$ref": "#/components/schemas/EorContractsContractIdOffboardingReviewEmployeeSignOffsPostResponsesContentApplicationJsonSchemaDataRequestDataUsedTimeOffAdditionalDetails" }, { "type": "null" } ] }, "is_deel_pto_confirmed": { "description": "Indicates whether the PTO allocation has been confirmed by Deel's system", "type": "boolean" }, "time_offs": { "items": { "$ref": "#/components/schemas/EorContractsContractIdOffboardingReviewEmployeeSignOffsPostResponsesContentApplicationJsonSchemaDataRequestDataUsedTimeOffTimeOffsItems" }, "type": "array" } }, "required": [ "time_offs", "is_deel_pto_confirmed" ], "title": "EorContractsContractIdOffboardingReviewEmployeeSignOffsPostResponsesContentApplicationJsonSchemaDataRequestDataUsedTimeOff", "type": "object" }, "EorContractsContractIdOffboardingReviewEmployeeSignOffsPostResponsesContentApplicationJsonSchemaDataRequestDataUsedTimeOffAdditionalDetails": { "properties": { "last_updated_at": { "description": "The date and time when the time-off data was last updated", "format": "date-time", "type": [ "string", "null" ] }, "notes": { "description": "Additional notes or comments about the time-off data", "type": [ "string", "null" ] }, "updated_by": { "description": "The person or system that last updated the time-off data", "type": [ "string", "null" ] } }, "title": "EorContractsContractIdOffboardingReviewEmployeeSignOffsPostResponsesContentApplicationJsonSchemaDataRequestDataUsedTimeOffAdditionalDetails", "type": "object" }, "EorContractsContractIdOffboardingReviewEmployeeSignOffsPostResponsesContentApplicationJsonSchemaDataRequestDataUsedTimeOffTimeOffsItems": { "properties": { "policy_type": { "description": "The type of time-off policy", "type": "string" }, "scheduled_until_end_date": { "description": "The amount of time off scheduled until the end date of the current tracking period", "format": "double", "type": "number" }, "tracking_periods": { "items": { "$ref": "#/components/schemas/EorContractsContractIdOffboardingReviewEmployeeSignOffsPostResponsesContentApplicationJsonSchemaDataRequestDataUsedTimeOffTimeOffsItemsTrackingPeriodsItems" }, "type": "array" }, "unit": { "$ref": "#/components/schemas/EorContractsContractIdOffboardingReviewEmployeeSignOffsPostResponsesContentApplicationJsonSchemaDataRequestDataUsedTimeOffTimeOffsItemsUnit", "description": "The unit of measurement for time off tracking" } }, "required": [ "unit", "policy_type", "tracking_periods", "scheduled_until_end_date" ], "title": "EorContractsContractIdOffboardingReviewEmployeeSignOffsPostResponsesContentApplicationJsonSchemaDataRequestDataUsedTimeOffTimeOffsItems", "type": "object" }, "EorContractsContractIdOffboardingReviewEmployeeSignOffsPostResponsesContentApplicationJsonSchemaDataRequestDataUsedTimeOffTimeOffsItemsTrackingPeriodsItems": { "properties": { "end_date": { "description": "The end date of the tracking period", "format": "date-time", "type": "string" }, "start_date": { "description": "The start date of the tracking period", "format": "date-time", "type": "string" }, "used": { "description": "The amount of time off used in this tracking period", "format": "double", "type": "number" } }, "required": [ "used", "end_date", "start_date" ], "title": "EorContractsContractIdOffboardingReviewEmployeeSignOffsPostResponsesContentApplicationJsonSchemaDataRequestDataUsedTimeOffTimeOffsItemsTrackingPeriodsItems", "type": "object" }, "EorContractsContractIdOffboardingReviewEmployeeSignOffsPostResponsesContentApplicationJsonSchemaDataRequestDataUsedTimeOffTimeOffsItemsUnit": { "description": "The unit of measurement for time off tracking", "enum": [ "BUSINESS_DAY", "CALENDAR_DAY", "HOUR" ], "title": "EorContractsContractIdOffboardingReviewEmployeeSignOffsPostResponsesContentApplicationJsonSchemaDataRequestDataUsedTimeOffTimeOffsItemsUnit", "type": "string" }, "EorContractsContractIdOffboardingReviewEmployeeSignOffsPostResponsesContentApplicationJsonSchemaErrorsItems": { "properties": { "code": { "description": "Error code of the handler which produced the returned error", "type": "string" }, "field": { "description": "The field name where error occurred (null for server errors)", "type": "string" }, "message": { "description": "Description of the returned error", "type": "string" } }, "title": "EorContractsContractIdOffboardingReviewEmployeeSignOffsPostResponsesContentApplicationJsonSchemaErrorsItems", "type": "object" }, "EorContractsContractIdOffboardingTerminationPostRequestBodyContentMultipartFormDataSchemaData": { "properties": { "additional_reason": { "description": "An additional reason can be provided in case the reason selected is NO_LONGER_WISH_TO_WORK_WITH_DEEL", "oneOf": [ { "$ref": "#/components/schemas/EorContractsContractIdOffboardingTerminationPostRequestBodyContentMultipartFormDataSchemaDataAdditionalReason" }, { "type": "null" } ] }, "additional_supporting_documents": { "description": "This field allows for uploading multiple files at once. Any proof such as correspondence, documentation of previous warnings or attendance records for the reason select above. Includes common image formats (JPG, JPEG, PNG, HEIC) and PDF documents.", "format": "binary", "type": "string" }, "attachments": { "description": "This field allows for uploading multiple files at once. Attach any document that is important for the request to terminate the contract. Includes common image formats (JPG, JPEG, PNG, HEIC) and PDF documents.", "format": "binary", "type": "string" }, "desired_end_date": { "description": "The desired end date of the contract. If the date is not provided, Deel HRX team will select the nearest possible date.", "format": "date", "type": "string" }, "eligible_for_rehire": { "description": "Parameter to inform whether it would be possible for the client to hire the employee again", "oneOf": [ { "$ref": "#/components/schemas/EorContractsContractIdOffboardingTerminationPostRequestBodyContentMultipartFormDataSchemaDataEligibleForRehire" }, { "type": "null" } ] }, "employee_notification_detail": { "description": "If it's an termination contract ending and employee was already informed, should detail the notification to the employee", "maxLength": 5000, "minLength": 1, "type": [ "string", "null" ] }, "is_employee_notified": { "description": "Defines if employee was informed by client or not before the termination", "type": "boolean" }, "is_sensitive": { "description": "Defines whether the termination is sensitive. In this case, only the person requesting the termination will be able to view the termination, receive emails or notifications.", "type": "boolean" }, "reason": { "$ref": "#/components/schemas/EorContractsContractIdOffboardingTerminationPostRequestBodyContentMultipartFormDataSchemaDataReason", "description": "Reason why the contract is being terminated" }, "reason_detail": { "description": "Field to better explain how communication with the employee will be and/or their reaction to the communication, or other necessary information", "maxLength": 5000, "minLength": 100, "type": "string" }, "required_information": { "description": "For some countries some data is needed to help to process the termination. The questions comes from another endpoint to get the required information. See GET /eor/:oid/offboarding/required-information to get the questions.", "items": { "$ref": "#/components/schemas/EorContractsContractIdOffboardingTerminationPostRequestBodyContentMultipartFormDataSchemaDataRequiredInformationItems" }, "type": "array" }, "severance_amount": { "description": "The amount of severance needed", "minimum": 0, "type": "integer" }, "severance_type": { "$ref": "#/components/schemas/EorContractsContractIdOffboardingTerminationPostRequestBodyContentMultipartFormDataSchemaDataSeveranceType", "description": "The type of severance selected by the client. It's an optional field" }, "termination_impact_id": { "description": "Termination impact data if there is some configured on HR module", "format": "uuid", "type": "string" }, "termination_notes": { "default": [], "description": "Additional notes can be provided regarding the termination for Deel, like questions and doubts", "items": { "maxLength": 5000, "type": "string" }, "type": "array" }, "used_time_off": { "$ref": "#/components/schemas/EorContractsContractIdOffboardingTerminationPostRequestBodyContentMultipartFormDataSchemaDataUsedTimeOff" } }, "required": [ "reason", "reason_detail", "used_time_off", "is_employee_notified" ], "title": "EorContractsContractIdOffboardingTerminationPostRequestBodyContentMultipartFormDataSchemaData", "type": "object" }, "EorContractsContractIdOffboardingTerminationPostRequestBodyContentMultipartFormDataSchemaDataAdditionalReason": { "description": "An additional reason can be provided in case the reason selected is NO_LONGER_WISH_TO_WORK_WITH_DEEL", "enum": [ "DISSATISFIED_WITH_DEEL_SERVICE", "DISSATISFIED_WITH_DEEL_PRICING", "DISSATISFIED_WITH_DEEL_PRODUCT" ], "title": "EorContractsContractIdOffboardingTerminationPostRequestBodyContentMultipartFormDataSchemaDataAdditionalReason", "type": "string" }, "EorContractsContractIdOffboardingTerminationPostRequestBodyContentMultipartFormDataSchemaDataEligibleForRehire": { "description": "Parameter to inform whether it would be possible for the client to hire the employee again", "enum": [ "YES", "NO", "DONT_KNOW" ], "title": "EorContractsContractIdOffboardingTerminationPostRequestBodyContentMultipartFormDataSchemaDataEligibleForRehire", "type": "string" }, "EorContractsContractIdOffboardingTerminationPostRequestBodyContentMultipartFormDataSchemaDataReason": { "description": "Reason why the contract is being terminated", "enum": [ "DEEL_COLLECTIONS", "STATUS_CHANGE", "RELOCATION", "COMPENSATION", "RETIREMENT", "JOB_ABANDONMENT", "WORK_RELATED", "PERSONAL", "OTHER_OPPORTUNITY", "NON_RENEWAL", "PROBATION", "ASSIGNMENT_ENDED", "POSITION_ELIMINATION", "FORCE_REDUCTION", "DEATH", "FOR_CAUSE", "PERFORMANCE", "MEDICAL", "PERFORMANCE_ISSUES", "ATTENDANCE_ISSUES", "REORGANIZATION_DOWNSIZING_BUDGET_OR_REDUCTION_OF_WORKFORCE", "ROLE_BECAME_REDUNDANT_OR_ROLE_CHANGED", "OFFER_WAS_REVOKED", "EXITING_THE_MARKET", "NO_LONGER_WISH_TO_WORK_WITH_DEEL", "COMPANY_ACQUIRED", "STEALING", "MISCONDUCT", "FALSIFYING", "HARASSMENT", "VIOLENCE", "REORGANIZATION_DOWNSIZING_BUDGET_OR_REDUCTION_OF_WORKFORCE_OR_ROLE_BECAME_REDUNDANT_OR_ROLE_CHANGED", "UNAUTHORIZED_ABSENCES_OR_LACK_OF_ATTENDANCE", "STANDARD_RESELLER_PRACTICE", "MOVING_EMPLOYEE_TO_INTERNAL_ENTITY", "MOVING_EMPLOYEE_TO_DEEL_PEO", "OTHER" ], "title": "EorContractsContractIdOffboardingTerminationPostRequestBodyContentMultipartFormDataSchemaDataReason", "type": "string" }, "EorContractsContractIdOffboardingTerminationPostRequestBodyContentMultipartFormDataSchemaDataRequiredInformationItems": { "properties": { "answer": { "description": "The answer to the question", "type": [ "boolean", "null" ] }, "question": { "description": "The question to be answered", "type": "string" } }, "required": [ "answer", "question" ], "title": "EorContractsContractIdOffboardingTerminationPostRequestBodyContentMultipartFormDataSchemaDataRequiredInformationItems", "type": "object" }, "EorContractsContractIdOffboardingTerminationPostRequestBodyContentMultipartFormDataSchemaDataSeveranceType": { "description": "The type of severance selected by the client. It's an optional field", "enum": [ "DAYS", "WEEKS", "MONTHS", "CASH" ], "title": "EorContractsContractIdOffboardingTerminationPostRequestBodyContentMultipartFormDataSchemaDataSeveranceType", "type": "string" }, "EorContractsContractIdOffboardingTerminationPostRequestBodyContentMultipartFormDataSchemaDataUsedTimeOff": { "properties": { "off_platform_used_time_off": { "description": "Required when tracking_type is OFF_PLATFORM, null otherwise", "oneOf": [ { "$ref": "#/components/schemas/EorContractsContractIdOffboardingTerminationPostRequestBodyContentMultipartFormDataSchemaDataUsedTimeOffOffPlatformUsedTimeOff" }, { "type": "null" } ] }, "tracking_type": { "$ref": "#/components/schemas/EorContractsContractIdOffboardingTerminationPostRequestBodyContentMultipartFormDataSchemaDataUsedTimeOffTrackingType", "description": "Type of time off tracking - whether it's tracked on Deel platform or off platform" } }, "title": "EorContractsContractIdOffboardingTerminationPostRequestBodyContentMultipartFormDataSchemaDataUsedTimeOff", "type": "object" }, "EorContractsContractIdOffboardingTerminationPostRequestBodyContentMultipartFormDataSchemaDataUsedTimeOffOffPlatformUsedTimeOff": { "description": "Required when tracking_type is OFF_PLATFORM, null otherwise", "properties": { "entitlement_unit": { "$ref": "#/components/schemas/EorContractsContractIdOffboardingTerminationPostRequestBodyContentMultipartFormDataSchemaDataUsedTimeOffOffPlatformUsedTimeOffEntitlementUnit", "description": "Unit of measurement for the time off entitlements" }, "entitlements": { "description": "Array of time off entitlements for different tracking periods", "items": { "$ref": "#/components/schemas/EorContractsContractIdOffboardingTerminationPostRequestBodyContentMultipartFormDataSchemaDataUsedTimeOffOffPlatformUsedTimeOffEntitlementsItems" }, "type": "array" }, "total_scheduled": { "description": "Total amount of time off scheduled until the end date", "title": "float", "type": "string" } }, "required": [ "entitlements", "total_scheduled", "entitlement_unit" ], "title": "EorContractsContractIdOffboardingTerminationPostRequestBodyContentMultipartFormDataSchemaDataUsedTimeOffOffPlatformUsedTimeOff", "type": "object" }, "EorContractsContractIdOffboardingTerminationPostRequestBodyContentMultipartFormDataSchemaDataUsedTimeOffOffPlatformUsedTimeOffEntitlementUnit": { "description": "Unit of measurement for the time off entitlements", "enum": [ "BUSINESS_DAY", "CALENDAR_DAY", "HOUR", "WEEK", "MONTH", "YEAR" ], "title": "EorContractsContractIdOffboardingTerminationPostRequestBodyContentMultipartFormDataSchemaDataUsedTimeOffOffPlatformUsedTimeOffEntitlementUnit", "type": "string" }, "EorContractsContractIdOffboardingTerminationPostRequestBodyContentMultipartFormDataSchemaDataUsedTimeOffOffPlatformUsedTimeOffEntitlementsItems": { "properties": { "tracking_period": { "description": "Start date of the tracking period", "format": "date", "type": "string" }, "tracking_period_end_date": { "description": "End date of the tracking period", "format": "date", "type": "string" }, "used": { "description": "Amount of time off used in the period", "title": "float", "type": "string" } }, "required": [ "used", "tracking_period", "tracking_period_end_date" ], "title": "EorContractsContractIdOffboardingTerminationPostRequestBodyContentMultipartFormDataSchemaDataUsedTimeOffOffPlatformUsedTimeOffEntitlementsItems", "type": "object" }, "EorContractsContractIdOffboardingTerminationPostRequestBodyContentMultipartFormDataSchemaDataUsedTimeOffTrackingType": { "description": "Type of time off tracking - whether it's tracked on Deel platform or off platform", "enum": [ "ON_PLATFORM", "OFF_PLATFORM" ], "title": "EorContractsContractIdOffboardingTerminationPostRequestBodyContentMultipartFormDataSchemaDataUsedTimeOffTrackingType", "type": "string" }, "EorContractsContractIdOffboardingTerminationPostResponsesContentApplicationJsonSchemaData": { "properties": { "contract_id": { "description": "The unique identifier of the employee contract.", "type": "string" }, "created_at": { "description": "The date and time the offboarding request was created", "format": "date-time", "type": "string" }, "desired_end_date": { "description": "The desired end date. If the date is not provided, it will be selected by HRX the closest date possible", "format": "date-time", "type": [ "string", "null" ] }, "documents": { "$ref": "#/components/schemas/EorContractsContractIdOffboardingTerminationPostResponsesContentApplicationJsonSchemaDataDocuments", "description": "Document management structure for termination workflow including review processes and supporting documents" }, "end_date": { "description": "The definitive contract end date", "format": "date-time", "type": [ "string", "null" ] }, "id": { "description": "The unique identifier of the offboarding request", "format": "uuid", "type": "string" }, "is_sensitive": { "description": "Indicates if the offboarding request is sensitive. This is used to restrict access to the request only to the requester and the HRX team.", "type": "boolean" }, "request_data": { "oneOf": [ { "$ref": "#/components/schemas/EorContractsContractIdOffboardingTerminationPostResponsesContentApplicationJsonSchemaDataRequestData" }, { "type": "null" } ] }, "updated_at": { "description": "The date and time the offboarding request was updated", "format": "date-time", "type": "string" } }, "title": "EorContractsContractIdOffboardingTerminationPostResponsesContentApplicationJsonSchemaData", "type": "object" }, "EorContractsContractIdOffboardingTerminationPostResponsesContentApplicationJsonSchemaDataDocuments": { "description": "Document management structure for termination workflow including review processes and supporting documents", "properties": { "offboarding": { "description": "Document set shared that requires client or employee review", "items": { "$ref": "#/components/schemas/EorContractsContractIdOffboardingTerminationPostResponsesContentApplicationJsonSchemaDataDocumentsOffboardingItems" }, "type": "array" }, "supporting": { "items": { "$ref": "#/components/schemas/EorContractsContractIdOffboardingTerminationPostResponsesContentApplicationJsonSchemaDataDocumentsSupportingItems" }, "type": "array" } }, "required": [ "supporting", "offboarding" ], "title": "EorContractsContractIdOffboardingTerminationPostResponsesContentApplicationJsonSchemaDataDocuments", "type": "object" }, "EorContractsContractIdOffboardingTerminationPostResponsesContentApplicationJsonSchemaDataDocumentsOffboardingItems": { "properties": { "created_at": { "description": "The date and time the document set was created", "format": "date-time", "type": "string" }, "files": { "items": { "$ref": "#/components/schemas/EorContractsContractIdOffboardingTerminationPostResponsesContentApplicationJsonSchemaDataDocumentsOffboardingItemsFilesItems" }, "type": "array" }, "id": { "description": "The unique identifier of the document set shared with the employee.", "format": "uuid", "type": "string" }, "is_employee_notification_required": { "description": "Indicates if the employee should be notified about this document review", "type": "boolean" }, "notification_instructions": { "description": "HTML instructions for the reviewer notification", "type": [ "string", "null" ] }, "reviewed_at": { "description": "The date and time when the document was reviewed", "format": "date-time", "type": [ "string", "null" ] }, "reviewed_by": { "description": "The name of the reviewer for this document. If the reviewer is not an employee, it will be the name of the client", "type": [ "string", "null" ] }, "reviewer_feedback": { "description": "Feedback provided by the reviewer", "type": [ "string", "null" ] }, "reviewer_type": { "$ref": "#/components/schemas/EorContractsContractIdOffboardingTerminationPostResponsesContentApplicationJsonSchemaDataDocumentsOffboardingItemsReviewerType", "description": "The type of reviewer for this document" }, "status": { "$ref": "#/components/schemas/EorContractsContractIdOffboardingTerminationPostResponsesContentApplicationJsonSchemaDataDocumentsOffboardingItemsStatus", "description": "The current status of the document review" }, "updated_at": { "description": "The date and time the document set was updated", "format": "date-time", "type": "string" } }, "required": [ "files", "status", "reviewer_type", "is_employee_notification_required" ], "title": "EorContractsContractIdOffboardingTerminationPostResponsesContentApplicationJsonSchemaDataDocumentsOffboardingItems", "type": "object" }, "EorContractsContractIdOffboardingTerminationPostResponsesContentApplicationJsonSchemaDataDocumentsOffboardingItemsFilesItems": { "properties": { "created_at": { "description": "The date and time the file was created", "format": "date-time", "type": "string" }, "id": { "description": "The unique identifier of the file", "type": "string" }, "name": { "description": "The name of the file", "type": "string" }, "type": { "description": "The type/extension of the file", "type": "string" }, "updated_at": { "description": "The date and time the file was updated", "format": "date-time", "type": "string" } }, "required": [ "id", "name", "type", "created_at" ], "title": "EorContractsContractIdOffboardingTerminationPostResponsesContentApplicationJsonSchemaDataDocumentsOffboardingItemsFilesItems", "type": "object" }, "EorContractsContractIdOffboardingTerminationPostResponsesContentApplicationJsonSchemaDataDocumentsOffboardingItemsReviewerType": { "description": "The type of reviewer for this document", "enum": [ "CLIENT", "EMPLOYEE" ], "title": "EorContractsContractIdOffboardingTerminationPostResponsesContentApplicationJsonSchemaDataDocumentsOffboardingItemsReviewerType", "type": "string" }, "EorContractsContractIdOffboardingTerminationPostResponsesContentApplicationJsonSchemaDataDocumentsOffboardingItemsStatus": { "description": "The current status of the document review", "enum": [ "AWAITING_REVIEW", "AWAITING_FEEDBACK", "FEEDBACK_PROVIDED", "APPROVED", "CHANGES_REQUESTED_BY_CLIENT", "CHANGES_REQUESTED_BY_EMPLOYEE", "WAIVED_REVIEW", "NOT_RESPONDED", "CANCELLED" ], "title": "EorContractsContractIdOffboardingTerminationPostResponsesContentApplicationJsonSchemaDataDocumentsOffboardingItemsStatus", "type": "string" }, "EorContractsContractIdOffboardingTerminationPostResponsesContentApplicationJsonSchemaDataDocumentsSupportingItems": { "properties": { "created_at": { "description": "The date and time the file was created", "format": "date-time", "type": "string" }, "id": { "description": "The unique identifier of the file", "type": "string" }, "is_additional_supporting_document": { "description": "Indicates if this is an additional supporting document added after the initial submission", "type": "boolean" }, "name": { "description": "The name of the file", "type": "string" }, "type": { "description": "The type/extension of the file", "type": "string" }, "updated_at": { "description": "The date and time the file was updated", "format": "date-time", "type": "string" } }, "required": [ "id", "name", "type", "created_at", "updated_at", "is_additional_supporting_document" ], "title": "EorContractsContractIdOffboardingTerminationPostResponsesContentApplicationJsonSchemaDataDocumentsSupportingItems", "type": "object" }, "EorContractsContractIdOffboardingTerminationPostResponsesContentApplicationJsonSchemaDataRequestData": { "properties": { "desired_end_date": { "description": "The desired end date. If the date is not provided, it will be selected by HRX the closest date possible", "format": "date", "type": [ "string", "null" ] }, "eligible_for_rehire": { "description": "Parameter to inform whether it would be possible for the client to hire the employee again", "oneOf": [ { "$ref": "#/components/schemas/EorContractsContractIdOffboardingTerminationPostResponsesContentApplicationJsonSchemaDataRequestDataEligibleForRehire" }, { "type": "null" } ] }, "eligible_for_rehire_reason": { "description": "Describe if the option DONT_KNOW was selected on eligible_for_rehire", "type": [ "string", "null" ] }, "end_date": { "description": "The definitive contract end date", "format": "date-time", "type": [ "string", "null" ] }, "reason": { "$ref": "#/components/schemas/EorContractsContractIdOffboardingTerminationPostResponsesContentApplicationJsonSchemaDataRequestDataReason", "description": "The reason for the termination" }, "reason_detail": { "description": "Optional field to describe the reason behind the resignation request", "type": [ "string", "null" ] }, "used_time_off": { "$ref": "#/components/schemas/EorContractsContractIdOffboardingTerminationPostResponsesContentApplicationJsonSchemaDataRequestDataUsedTimeOff", "description": "Time-off usage data including policy information and tracking periods" } }, "title": "EorContractsContractIdOffboardingTerminationPostResponsesContentApplicationJsonSchemaDataRequestData", "type": "object" }, "EorContractsContractIdOffboardingTerminationPostResponsesContentApplicationJsonSchemaDataRequestDataEligibleForRehire": { "description": "Parameter to inform whether it would be possible for the client to hire the employee again", "enum": [ "YES", "NO", "DONT_KNOW" ], "title": "EorContractsContractIdOffboardingTerminationPostResponsesContentApplicationJsonSchemaDataRequestDataEligibleForRehire", "type": "string" }, "EorContractsContractIdOffboardingTerminationPostResponsesContentApplicationJsonSchemaDataRequestDataReason": { "description": "The reason for the termination", "enum": [ "STATUS_CHANGE", "RELOCATION", "COMPENSATION", "RETIREMENT", "JOB_ABANDONMENT", "WORK_RELATED", "PERSONAL", "OTHER_OPPORTUNITY", "NON_RENEWAL", "PROBATION", "ASSIGNMENT_ENDED", "POSITION_ELIMINATION", "FORCE_REDUCTION", "DEATH", "FOR_CAUSE", "PERFORMANCE", "MEDICAL", "PERFORMANCE_ISSUES", "ATTENDANCE_ISSUES", "REORGANIZATION_DOWNSIZING_BUDGET_OR_REDUCTION_OF_WORKFORCE", "ROLE_BECAME_REDUNDANT_OR_ROLE_CHANGED", "OFFER_WAS_REVOKED", "EXITING_THE_MARKET", "NO_LONGER_WISH_TO_WORK_WITH_DEEL", "COMPANY_ACQUIRED", "STEALING", "MISCONDUCT", "FALSIFYING", "HARASSMENT", "VIOLENCE", "REORGANIZATION_DOWNSIZING_BUDGET_OR_REDUCTION_OF_WORKFORCE_OR_ROLE_BECAME_REDUNDANT_OR_ROLE_CHANGED", "UNAUTHORIZED_ABSENCES_OR_LACK_OF_ATTENDANCE", "STANDARD_RESELLER_PRACTICE", "MOVING_EMPLOYEE_TO_INTERNAL_ENTITY", "MOVING_EMPLOYEE_TO_DEEL_PEO", "OTHER" ], "title": "EorContractsContractIdOffboardingTerminationPostResponsesContentApplicationJsonSchemaDataRequestDataReason", "type": "string" }, "EorContractsContractIdOffboardingTerminationPostResponsesContentApplicationJsonSchemaDataRequestDataUsedTimeOff": { "description": "Time-off usage data including policy information and tracking periods", "properties": { "additional_details": { "oneOf": [ { "$ref": "#/components/schemas/EorContractsContractIdOffboardingTerminationPostResponsesContentApplicationJsonSchemaDataRequestDataUsedTimeOffAdditionalDetails" }, { "type": "null" } ] }, "is_deel_pto_confirmed": { "description": "Indicates whether the PTO allocation has been confirmed by Deel's system", "type": "boolean" }, "time_offs": { "items": { "$ref": "#/components/schemas/EorContractsContractIdOffboardingTerminationPostResponsesContentApplicationJsonSchemaDataRequestDataUsedTimeOffTimeOffsItems" }, "type": "array" } }, "required": [ "time_offs", "is_deel_pto_confirmed" ], "title": "EorContractsContractIdOffboardingTerminationPostResponsesContentApplicationJsonSchemaDataRequestDataUsedTimeOff", "type": "object" }, "EorContractsContractIdOffboardingTerminationPostResponsesContentApplicationJsonSchemaDataRequestDataUsedTimeOffAdditionalDetails": { "properties": { "last_updated_at": { "description": "The date and time when the time-off data was last updated", "format": "date-time", "type": [ "string", "null" ] }, "notes": { "description": "Additional notes or comments about the time-off data", "type": [ "string", "null" ] }, "updated_by": { "description": "The person or system that last updated the time-off data", "type": [ "string", "null" ] } }, "title": "EorContractsContractIdOffboardingTerminationPostResponsesContentApplicationJsonSchemaDataRequestDataUsedTimeOffAdditionalDetails", "type": "object" }, "EorContractsContractIdOffboardingTerminationPostResponsesContentApplicationJsonSchemaDataRequestDataUsedTimeOffTimeOffsItems": { "properties": { "policy_type": { "description": "The type of time-off policy", "type": "string" }, "scheduled_until_end_date": { "description": "The amount of time off scheduled until the end date of the current tracking period", "format": "double", "type": "number" }, "tracking_periods": { "items": { "$ref": "#/components/schemas/EorContractsContractIdOffboardingTerminationPostResponsesContentApplicationJsonSchemaDataRequestDataUsedTimeOffTimeOffsItemsTrackingPeriodsItems" }, "type": "array" }, "unit": { "$ref": "#/components/schemas/EorContractsContractIdOffboardingTerminationPostResponsesContentApplicationJsonSchemaDataRequestDataUsedTimeOffTimeOffsItemsUnit", "description": "The unit of measurement for time off tracking" } }, "required": [ "unit", "policy_type", "tracking_periods", "scheduled_until_end_date" ], "title": "EorContractsContractIdOffboardingTerminationPostResponsesContentApplicationJsonSchemaDataRequestDataUsedTimeOffTimeOffsItems", "type": "object" }, "EorContractsContractIdOffboardingTerminationPostResponsesContentApplicationJsonSchemaDataRequestDataUsedTimeOffTimeOffsItemsTrackingPeriodsItems": { "properties": { "end_date": { "description": "The end date of the tracking period", "format": "date-time", "type": "string" }, "start_date": { "description": "The start date of the tracking period", "format": "date-time", "type": "string" }, "used": { "description": "The amount of time off used in this tracking period", "format": "double", "type": "number" } }, "required": [ "used", "end_date", "start_date" ], "title": "EorContractsContractIdOffboardingTerminationPostResponsesContentApplicationJsonSchemaDataRequestDataUsedTimeOffTimeOffsItemsTrackingPeriodsItems", "type": "object" }, "EorContractsContractIdOffboardingTerminationPostResponsesContentApplicationJsonSchemaDataRequestDataUsedTimeOffTimeOffsItemsUnit": { "description": "The unit of measurement for time off tracking", "enum": [ "BUSINESS_DAY", "CALENDAR_DAY", "HOUR" ], "title": "EorContractsContractIdOffboardingTerminationPostResponsesContentApplicationJsonSchemaDataRequestDataUsedTimeOffTimeOffsItemsUnit", "type": "string" }, "EorContractsContractIdOffboardingTerminationPostResponsesContentApplicationJsonSchemaErrorsItems": { "properties": { "code": { "description": "Error code of the handler which produced the returned error", "type": "string" }, "field": { "description": "The field name where error occurred (null for server errors)", "type": "string" }, "message": { "description": "Description of the returned error", "type": "string" } }, "title": "EorContractsContractIdOffboardingTerminationPostResponsesContentApplicationJsonSchemaErrorsItems", "type": "object" }, "EorContractsContractIdOffboardingTimeOffsGetResponsesContentApplicationJsonSchemaData": { "properties": { "contract_id": { "description": "The unique identifier of the employee contract", "type": "string" }, "entitlements": { "description": "List of entitlement periods sorted by tracking period (descending)", "items": { "$ref": "#/components/schemas/EorContractsContractIdOffboardingTimeOffsGetResponsesContentApplicationJsonSchemaDataEntitlementsItems" }, "type": "array" }, "has_external_integration": { "description": "Whether the contract has external integration", "type": "boolean" }, "policy_settings": { "$ref": "#/components/schemas/EorContractsContractIdOffboardingTimeOffsGetResponsesContentApplicationJsonSchemaDataPolicySettings", "description": "Policy configuration settings for time off calculations" }, "remaining_balance": { "description": "Remaining time off balance", "format": "double", "type": [ "number", "null" ] }, "tracking_type": { "$ref": "#/components/schemas/EorContractsContractIdOffboardingTimeOffsGetResponsesContentApplicationJsonSchemaDataTrackingType", "description": "The time off tracking type" }, "upcoming_time_offs": { "description": "List of upcoming time off requests", "items": { "$ref": "#/components/schemas/EorContractsContractIdOffboardingTimeOffsGetResponsesContentApplicationJsonSchemaDataUpcomingTimeOffsItems" }, "type": "array" } }, "required": [ "contract_id", "entitlements", "tracking_type", "policy_settings", "upcoming_time_offs", "has_external_integration" ], "title": "EorContractsContractIdOffboardingTimeOffsGetResponsesContentApplicationJsonSchemaData", "type": "object" }, "EorContractsContractIdOffboardingTimeOffsGetResponsesContentApplicationJsonSchemaDataEntitlementsItems": { "properties": { "created_at": { "description": "When the entitlement was created", "format": "date-time", "type": "string" }, "entitlement_unit": { "$ref": "#/components/schemas/EorContractsContractIdOffboardingTimeOffsGetResponsesContentApplicationJsonSchemaDataEntitlementsItemsEntitlementUnit", "description": "Unit of time measurement" }, "id": { "description": "The entitlement ID", "format": "uuid", "type": "string" }, "requests": { "description": "Number of time off requests in this period", "type": "integer" }, "tracking_period": { "description": "The tracking period start date", "format": "date", "type": "string" }, "tracking_period_end_date": { "description": "The tracking period end date", "format": "date", "type": "string" }, "updated_at": { "description": "When the entitlement was updated", "format": "date-time", "type": "string" }, "used": { "description": "Amount of time off used in this period", "format": "double", "type": "number" } }, "required": [ "id", "used", "requests", "created_at", "updated_at", "tracking_period", "entitlement_unit", "tracking_period_end_date" ], "title": "EorContractsContractIdOffboardingTimeOffsGetResponsesContentApplicationJsonSchemaDataEntitlementsItems", "type": "object" }, "EorContractsContractIdOffboardingTimeOffsGetResponsesContentApplicationJsonSchemaDataEntitlementsItemsEntitlementUnit": { "description": "Unit of time measurement", "enum": [ "BUSINESS_DAY", "CALENDAR_DAY", "HOUR", "WEEK", "MONTH", "YEAR" ], "title": "EorContractsContractIdOffboardingTimeOffsGetResponsesContentApplicationJsonSchemaDataEntitlementsItemsEntitlementUnit", "type": "string" }, "EorContractsContractIdOffboardingTimeOffsGetResponsesContentApplicationJsonSchemaDataPolicySettings": { "description": "Policy configuration settings for time off calculations", "properties": { "entitlement_unit": { "description": "The entitlement unit for the policy", "type": "string" }, "is_accrued_days_available": { "description": "Whether accrued days are available", "type": "boolean" }, "is_estimated_payout_available": { "description": "Whether estimated payout is available", "type": "boolean" } }, "required": [ "entitlement_unit", "is_accrued_days_available", "is_estimated_payout_available" ], "title": "EorContractsContractIdOffboardingTimeOffsGetResponsesContentApplicationJsonSchemaDataPolicySettings", "type": "object" }, "EorContractsContractIdOffboardingTimeOffsGetResponsesContentApplicationJsonSchemaDataTrackingType": { "description": "The time off tracking type", "enum": [ "OFF_PLATFORM", "ON_PLATFORM" ], "title": "EorContractsContractIdOffboardingTimeOffsGetResponsesContentApplicationJsonSchemaDataTrackingType", "type": "string" }, "EorContractsContractIdOffboardingTimeOffsGetResponsesContentApplicationJsonSchemaDataUpcomingTimeOffsItems": { "properties": { "amount": { "description": "Amount of time off requested", "format": "double", "type": "number" }, "approved_at": { "description": "When the time off was approved", "format": "date-time", "type": "string" }, "created_at": { "description": "When the time off request was created", "format": "date-time", "type": "string" }, "end_date": { "description": "End date of the time off", "format": "date-time", "type": "string" }, "id": { "description": "Time off request ID", "format": "uuid", "type": "string" }, "requested_at": { "description": "When the time off was requested", "format": "date-time", "type": "string" }, "start_date": { "description": "Start date of the time off", "format": "date-time", "type": "string" }, "status": { "description": "Status of the time off request", "type": "string" }, "updated_at": { "description": "When the time off request was updated", "format": "date-time", "type": "string" } }, "required": [ "id", "amount", "status", "end_date", "created_at", "start_date", "updated_at", "approved_at", "requested_at" ], "title": "EorContractsContractIdOffboardingTimeOffsGetResponsesContentApplicationJsonSchemaDataUpcomingTimeOffsItems", "type": "object" }, "EorContractsContractIdOffboardingTimeOffsGetResponsesContentApplicationJsonSchemaErrorsItems": { "properties": { "code": { "description": "Error code of the handler which produced the returned error", "type": "string" }, "field": { "description": "The field name where error occurred (null for server errors)", "type": "string" }, "message": { "description": "Description of the returned error", "type": "string" } }, "title": "EorContractsContractIdOffboardingTimeOffsGetResponsesContentApplicationJsonSchemaErrorsItems", "type": "object" }, "EorContractsContractIdProjectAssignmentAcceptPostRequestBodyContentApplicationJsonSchemaData": { "properties": { "version": { "description": "This field is to ensure that the latest version of the project assignment PDF matches the version received from the webhook. If it is not sent, the version validation is not performed and the endpoint returns the PDF. If it is sent, it is checked whether the current version is equal to the version sent; if not, a 409 error occurs, otherwise, the PDF is returned.", "maxLength": 20, "minLength": 20, "type": "string" } }, "title": "EorContractsContractIdProjectAssignmentAcceptPostRequestBodyContentApplicationJsonSchemaData", "type": "object" }, "EorContractsContractIdProjectAssignmentAcceptPostResponsesContentApplicationJsonSchemaErrorsItems": { "properties": { "code": { "description": "Machine-readable error code", "type": "string" }, "message": { "description": "Human-readable explanation of the error", "type": "string" } }, "required": [ "code", "message" ], "title": "EorContractsContractIdProjectAssignmentAcceptPostResponsesContentApplicationJsonSchemaErrorsItems", "type": "object" }, "EorContractsContractIdProjectAssignmentCheckinGetResponsesContentApplicationJsonSchemaData": { "properties": { "created_at": { "description": "Timestamp indicating when the resource was created (ISO 8601).", "format": "date-time", "type": "string" }, "id": { "description": "Unique identifier of the resource", "format": "uuid", "type": "string" }, "sections": { "description": "Sections of questions", "items": { "$ref": "#/components/schemas/EorContractsContractIdProjectAssignmentCheckinGetResponsesContentApplicationJsonSchemaDataSectionsItems" }, "type": "array" }, "updated_at": { "description": "Timestamp indicating when the resource was last updated (ISO 8601).", "format": "date-time", "type": "string" } }, "required": [ "id", "sections", "created_at", "updated_at" ], "title": "EorContractsContractIdProjectAssignmentCheckinGetResponsesContentApplicationJsonSchemaData", "type": "object" }, "EorContractsContractIdProjectAssignmentCheckinGetResponsesContentApplicationJsonSchemaDataSectionsItems": { "properties": { "questions": { "description": "List of questions within the section.", "items": { "$ref": "#/components/schemas/EorContractsContractIdProjectAssignmentCheckinGetResponsesContentApplicationJsonSchemaDataSectionsItemsQuestionsItems" }, "type": "array" }, "subtitle": { "description": "Additional information shown at the top of the section.", "type": "string" }, "title": { "description": "Title of the section.", "type": "string" } }, "required": [ "title", "questions" ], "title": "EorContractsContractIdProjectAssignmentCheckinGetResponsesContentApplicationJsonSchemaDataSectionsItems", "type": "object" }, "EorContractsContractIdProjectAssignmentCheckinGetResponsesContentApplicationJsonSchemaDataSectionsItemsQuestionsItems": { "properties": { "default_value": { "$ref": "#/components/schemas/EorContractsContractIdProjectAssignmentCheckinGetResponsesContentApplicationJsonSchemaDataSectionsItemsQuestionsItemsDefaultValue", "description": "Default value to pre-fill in the form." }, "is_only_digits": { "description": "Restricts input to numeric characters only, for FreeText questions.", "type": "boolean" }, "is_required": { "description": "Indicates if the question is required.", "type": "boolean" }, "key": { "description": "Unique key identifier for the question.", "type": "string" }, "options": { "description": "List of selectable options for selection-type questions. Value may be of any type.", "items": { "$ref": "#/components/schemas/EorContractsContractIdProjectAssignmentCheckinGetResponsesContentApplicationJsonSchemaDataSectionsItemsQuestionsItemsOptionsItems" }, "type": [ "array", "null" ] }, "title": { "description": "Title of the question.", "type": "string" }, "type": { "$ref": "#/components/schemas/EorContractsContractIdProjectAssignmentCheckinGetResponsesContentApplicationJsonSchemaDataSectionsItemsQuestionsItemsType", "description": "Type of the question." } }, "required": [ "key", "type", "title" ], "title": "EorContractsContractIdProjectAssignmentCheckinGetResponsesContentApplicationJsonSchemaDataSectionsItemsQuestionsItems", "type": "object" }, "EorContractsContractIdProjectAssignmentCheckinGetResponsesContentApplicationJsonSchemaDataSectionsItemsQuestionsItemsDefaultValue": { "description": "Default value to pre-fill in the form.", "oneOf": [ { "type": "string" }, { "format": "double", "type": "number" }, { "type": "boolean" } ], "title": "EorContractsContractIdProjectAssignmentCheckinGetResponsesContentApplicationJsonSchemaDataSectionsItemsQuestionsItemsDefaultValue" }, "EorContractsContractIdProjectAssignmentCheckinGetResponsesContentApplicationJsonSchemaDataSectionsItemsQuestionsItemsOptionsItems": { "properties": { "title": { "description": "Display text for the option.", "type": "string" }, "value": { "description": "Value associated with the option.", "type": [ "string", "null" ] } }, "title": "EorContractsContractIdProjectAssignmentCheckinGetResponsesContentApplicationJsonSchemaDataSectionsItemsQuestionsItemsOptionsItems", "type": "object" }, "EorContractsContractIdProjectAssignmentCheckinGetResponsesContentApplicationJsonSchemaDataSectionsItemsQuestionsItemsType": { "description": "Type of the question.", "enum": [ "FreeText", "Paragraph", "SingleSelection", "MultiSelection", "Address", "PhoneNumber", "DocumentUpload", "Number", "Dropdown", "DatePicker", "Email" ], "title": "EorContractsContractIdProjectAssignmentCheckinGetResponsesContentApplicationJsonSchemaDataSectionsItemsQuestionsItemsType", "type": "string" }, "EorContractsContractIdProjectAssignmentCheckinGetResponsesContentApplicationJsonSchemaErrorsItems": { "properties": { "code": { "description": "Machine-readable error code", "type": "string" }, "message": { "description": "Human-readable explanation of the error", "type": "string" } }, "title": "EorContractsContractIdProjectAssignmentCheckinGetResponsesContentApplicationJsonSchemaErrorsItems", "type": "object" }, "EorContractsContractIdProjectAssignmentCheckinPostRequestBodyContentApplicationJsonSchemaData": { "description": "Form submission payload containing respondent type, question answers, and optional version.", "properties": { "questions_with_answers": { "additionalProperties": { "minLength": 1, "type": "string" }, "description": "Map of question IDs to their corresponding answers.", "type": "object" }, "type": { "$ref": "#/components/schemas/EorContractsContractIdProjectAssignmentCheckinPostRequestBodyContentApplicationJsonSchemaDataType", "description": "Indicates who is submitting the form. Can be either 'EMPLOYEE' or 'CLIENT'." }, "version": { "description": "Optional version identifier of the form or schema.", "maxLength": 20, "type": "string" } }, "required": [ "type", "questions_with_answers" ], "title": "EorContractsContractIdProjectAssignmentCheckinPostRequestBodyContentApplicationJsonSchemaData", "type": "object" }, "EorContractsContractIdProjectAssignmentCheckinPostRequestBodyContentApplicationJsonSchemaDataType": { "description": "Indicates who is submitting the form. Can be either 'EMPLOYEE' or 'CLIENT'.", "enum": [ "EMPLOYEE", "CLIENT" ], "title": "EorContractsContractIdProjectAssignmentCheckinPostRequestBodyContentApplicationJsonSchemaDataType", "type": "string" }, "EorContractsContractIdProjectAssignmentCheckinPostResponsesContentApplicationJsonSchemaErrorsItems": { "properties": { "code": { "description": "Machine-readable error code", "type": "string" }, "message": { "description": "Human-readable explanation of the error", "type": "string" } }, "title": "EorContractsContractIdProjectAssignmentCheckinPostResponsesContentApplicationJsonSchemaErrorsItems", "type": "object" }, "EorContractsContractIdProjectAssignmentGetResponsesContentApplicationJsonSchemaErrorsItems": { "properties": { "code": { "description": "Machine-readable error code", "type": "string" }, "message": { "description": "Human-readable explanation of the error", "type": "string" } }, "required": [ "code", "message" ], "title": "EorContractsContractIdProjectAssignmentGetResponsesContentApplicationJsonSchemaErrorsItems", "type": "object" }, "EorContractsContractIdRejectPatchRequestBodyContentApplicationJsonSchemaData": { "properties": { "message": { "description": "Optional free-text explanation accompanying the rejection.", "maxLength": 2000, "type": "string" }, "reason": { "$ref": "#/components/schemas/EorContractsContractIdRejectPatchRequestBodyContentApplicationJsonSchemaDataReason", "description": "The reason for rejecting the quote." } }, "required": [ "reason" ], "title": "EorContractsContractIdRejectPatchRequestBodyContentApplicationJsonSchemaData", "type": "object" }, "EorContractsContractIdRejectPatchRequestBodyContentApplicationJsonSchemaDataReason": { "description": "The reason for rejecting the quote.", "enum": [ "TOO_EXPENSIVE", "DECIDED_AGAINST_EMPLOYING_EOR", "TEST_QUOTE", "NOT_SATISFIED_WITH_DEEL", "INACCURATE_INFO_JOB_TITLE", "INACCURATE_INFO_JOB_DESCRIPTION", "INACCURATE_INFO_JOB_DUTIES_SCOPE_OF_WORK", "COMPLIANCE_RESTRICTIONS", "OTHER" ], "title": "EorContractsContractIdRejectPatchRequestBodyContentApplicationJsonSchemaDataReason", "type": "string" }, "EorContractsContractIdRejectPatchResponsesContentApplicationJsonSchemaData": { "properties": { "id": { "description": "The unique identifier of the EOR contract whose quote was rejected.", "type": [ "string", "null" ] }, "rejection_reason": { "description": "The reason recorded for the latest quote rejection.", "type": [ "string", "null" ] }, "status": { "description": "The status of the contract after the rejection.", "type": [ "string", "null" ] } }, "title": "EorContractsContractIdRejectPatchResponsesContentApplicationJsonSchemaData", "type": "object" }, "EorContractsContractIdRejectPatchResponsesContentApplicationJsonSchemaErrorsItems": { "properties": { "code": { "description": "Machine-readable error code", "type": "string" }, "message": { "description": "Human-readable explanation of the error", "type": "string" } }, "title": "EorContractsContractIdRejectPatchResponsesContentApplicationJsonSchemaErrorsItems", "type": "object" }, "EorEmploymentCostPostRequestBodyContentApplicationJsonSchemaData": { "properties": { "benefits": { "description": "A list of selected benefit plans for the employee.", "items": { "$ref": "#/components/schemas/EorEmploymentCostPostRequestBodyContentApplicationJsonSchemaDataBenefitsItems" }, "type": [ "array", "null" ] }, "country": { "description": "The full name of the country where the employee is based.", "type": "string" }, "country_code": { "description": "The two-letter country code where the employee is based.", "type": "string" }, "currency": { "description": "The currency in which the costs are calculated.", "type": "string" }, "salary": { "description": "The base salary for the employee.", "format": "double", "minimum": 1, "type": "number" }, "salary_period": { "$ref": "#/components/schemas/EorEmploymentCostPostRequestBodyContentApplicationJsonSchemaDataSalaryPeriod", "default": "ANNUALLY", "description": "The salary period for the amount provided." }, "state": { "description": "The state or region within the country, if applicable.", "type": "string" } }, "required": [ "salary", "country", "currency" ], "title": "EorEmploymentCostPostRequestBodyContentApplicationJsonSchemaData", "type": "object" }, "EorEmploymentCostPostRequestBodyContentApplicationJsonSchemaDataBenefitsItems": { "properties": { "plan_id": { "description": "The ID of the benefits plan, if applicable.", "type": [ "string", "null" ] }, "provider_id": { "description": "The ID of the benefits provider.", "type": "string" } }, "required": [ "provider_id" ], "title": "EorEmploymentCostPostRequestBodyContentApplicationJsonSchemaDataBenefitsItems", "type": "object" }, "EorEmploymentCostPostRequestBodyContentApplicationJsonSchemaDataSalaryPeriod": { "default": "ANNUALLY", "description": "The salary period for the amount provided.", "enum": [ "ANNUALLY", "MONTHLY" ], "title": "EorEmploymentCostPostRequestBodyContentApplicationJsonSchemaDataSalaryPeriod", "type": "string" }, "EorEmploymentCostPostResponsesContentApplicationJsonSchemaAdditionalData": { "properties": { "additional_notes": { "items": { "type": "string" }, "type": "array" } }, "title": "EorEmploymentCostPostResponsesContentApplicationJsonSchemaAdditionalData", "type": "object" }, "EorEmploymentCostPostResponsesContentApplicationJsonSchemaBenefitsDataItems": { "properties": { "amount": { "description": "Benefit cost.", "type": "string" }, "fee_amount": { "description": "Fees associated with the benefit.", "type": "string" }, "name": { "description": "Benefit name.", "type": "string" }, "plan": { "description": "Benefit plan.", "type": "string" } }, "title": "EorEmploymentCostPostResponsesContentApplicationJsonSchemaBenefitsDataItems", "type": "object" }, "EorEmploymentCostPostResponsesContentApplicationJsonSchemaCostsItems": { "properties": { "amount": { "description": "Cost amount.", "type": "string" }, "country": { "description": "The country of the cost item.", "type": "string" }, "country_code": { "description": "ISO Alpha-2 code of the country.", "type": "string" }, "frequency": { "description": "The frequency of the cost (e.g., monthly, annually).", "type": "string" }, "name": { "description": "Name of the cost item.", "type": "string" } }, "title": "EorEmploymentCostPostResponsesContentApplicationJsonSchemaCostsItems", "type": "object" }, "EorJobScopesGetResponsesContentApplicationJsonSchemaError": { "description": "Error message indicating the missing entity", "enum": [ "No organization is linked with the profile", "No teams found for this organization" ], "title": "EorJobScopesGetResponsesContentApplicationJsonSchemaError", "type": "string" }, "EorJobScopesGetResponsesContentApplicationJsonSchemaItems": { "properties": { "content": { "description": "Detailed description of the job scope", "type": "string" }, "created_at": { "description": "Timestamp of when the job scope was created", "type": "string" }, "created_by": { "$ref": "#/components/schemas/EorJobScopesGetResponsesContentApplicationJsonSchemaItemsCreatedBy" }, "id": { "description": "Unique identifier for the job scope", "type": "string" }, "organization_id": { "description": "Identifier of the associated organization, if any", "type": [ "string", "null" ] }, "personal": { "description": "Identifier from the team or the profile, whichever is available", "type": [ "string", "null" ] }, "source_type": { "$ref": "#/components/schemas/EorJobScopesGetResponsesContentApplicationJsonSchemaItemsSourceType", "description": "Source of the job scope data" }, "team": { "$ref": "#/components/schemas/EorJobScopesGetResponsesContentApplicationJsonSchemaItemsTeam" }, "title": { "description": "Title or name of the job scope", "type": "string" }, "updated_at": { "description": "Timestamp of when the job scope was last updated", "type": "string" }, "updated_by": { "$ref": "#/components/schemas/EorJobScopesGetResponsesContentApplicationJsonSchemaItemsUpdatedBy" } }, "title": "EorJobScopesGetResponsesContentApplicationJsonSchemaItems", "type": "object" }, "EorJobScopesGetResponsesContentApplicationJsonSchemaItemsCreatedBy": { "properties": { "id": { "description": "Unique identifier of the user who created the job scope", "type": [ "string", "null" ] }, "name": { "description": "Name of the user who created the job scope", "type": [ "string", "null" ] } }, "title": "EorJobScopesGetResponsesContentApplicationJsonSchemaItemsCreatedBy", "type": "object" }, "EorJobScopesGetResponsesContentApplicationJsonSchemaItemsSourceType": { "description": "Source of the job scope data", "enum": [ "MANUAL", "AI" ], "title": "EorJobScopesGetResponsesContentApplicationJsonSchemaItemsSourceType", "type": "string" }, "EorJobScopesGetResponsesContentApplicationJsonSchemaItemsTeam": { "properties": { "id": { "description": "Unique identifier of the associated team, if any", "type": [ "string", "null" ] }, "name": { "description": "Name of the team associated with the job scope, if any", "type": [ "string", "null" ] } }, "title": "EorJobScopesGetResponsesContentApplicationJsonSchemaItemsTeam", "type": "object" }, "EorJobScopesGetResponsesContentApplicationJsonSchemaItemsUpdatedBy": { "properties": { "id": { "description": "Unique identifier of the user who last updated the job scope", "type": [ "string", "null" ] }, "name": { "description": "Name of the user who last updated the job scope", "type": [ "string", "null" ] } }, "title": "EorJobScopesGetResponsesContentApplicationJsonSchemaItemsUpdatedBy", "type": "object" }, "EorJobScopesValidatePostRequestBodyContentApplicationJsonSchemaData": { "description": "details of job scope", "properties": { "client_legal_entity_id": { "description": "The ID of the client's legal entity.", "format": "uuid", "type": "string" }, "client_name": { "description": "Optional client name. The validation refuses a job scope if it includes the client name. If not provided, it will be inferred from the legal entity instead.", "type": "string" }, "employee_name": { "description": "The name of the employee.", "type": "string" }, "employee_nationality": { "description": "The nationality of the employee.", "type": "string" }, "employment_country": { "description": "The country of employment.", "type": "string" }, "employment_state": { "description": "The state of employment.", "type": [ "string", "null" ] }, "job_scope": { "description": "The scope of the job.", "maxLength": 10000, "minLength": 100, "type": "string" }, "job_title": { "description": "The title of the job.", "type": "string" }, "special_job_id": { "description": "The ID of the special job.", "format": "uuid", "type": [ "string", "null" ] }, "team_id": { "description": "The ID of the team.", "format": "uuid", "type": "string" }, "work_visa": { "description": "Indicates if a work visa is required.", "type": "boolean" } }, "required": [ "team_id", "job_scope", "job_title", "employee_name", "employment_country", "client_legal_entity_id" ], "title": "EorJobScopesValidatePostRequestBodyContentApplicationJsonSchemaData", "type": "object" }, "EorJobScopesValidatePostResponsesContentApplicationJsonSchemaDataForCorrectedJobScopeEndpoint": { "description": "Data for corrected job scope endpoint.", "properties": { "anonymized_job_scope": { "description": "Anonymized job scope.", "type": [ "string", "null" ] }, "errors_for_correct_job_scope": { "description": "List of errors for corrected job scope.", "items": { "$ref": "#/components/schemas/EorJobScopesValidatePostResponsesContentApplicationJsonSchemaDataForCorrectedJobScopeEndpointErrorsForCorrectJobScopeItems" }, "type": "array" }, "must_create_correct_job_scope": { "description": "Indicates if a corrected job scope is required.", "type": "boolean" } }, "title": "EorJobScopesValidatePostResponsesContentApplicationJsonSchemaDataForCorrectedJobScopeEndpoint", "type": "object" }, "EorJobScopesValidatePostResponsesContentApplicationJsonSchemaDataForCorrectedJobScopeEndpointErrorsForCorrectJobScopeItems": { "properties": { "message": { "description": "Message with error description", "type": "string" } }, "title": "EorJobScopesValidatePostResponsesContentApplicationJsonSchemaDataForCorrectedJobScopeEndpointErrorsForCorrectJobScopeItems", "type": "object" }, "EorJobScopesValidatePostResponsesContentApplicationJsonSchemaErrorsItems": { "properties": { "message": { "description": "A description of the returned error", "type": "string" }, "path": { "description": "The JSON path where input validation failed", "type": "string" } }, "title": "EorJobScopesValidatePostResponsesContentApplicationJsonSchemaErrorsItems", "type": "object" }, "EorJobScopesValidatePostResponsesContentApplicationJsonSchemaRequest": { "properties": { "api_req_id": { "description": "The request ID of the failed request", "type": "string" }, "code": { "description": "The code of the source handler which produced the returned error", "format": "double", "type": "number" }, "docs": { "description": "A link to the official documentation for the requested endpoint resource", "type": "string" }, "method": { "description": "The HTTP method of the failed request", "type": "string" }, "source": { "description": "The source handler which produced the returned error", "type": "string" }, "status": { "description": "The status code of the response", "format": "double", "type": "number" }, "url": { "description": "The relative URL of the failed request", "type": "string" } }, "title": "EorJobScopesValidatePostResponsesContentApplicationJsonSchemaRequest", "type": "object" }, "EorMailboxesChangePasswordPostRequestBodyContentApplicationJsonSchemaData": { "properties": { "password": { "description": "The new password.", "type": "string" } }, "title": "EorMailboxesChangePasswordPostRequestBodyContentApplicationJsonSchemaData", "type": "object" }, "EorMailboxesChangePasswordPostResponsesContentApplicationJsonSchemaErrorsItems": { "properties": { "code": { "description": "Machine-readable error code", "type": "string" }, "message": { "description": "Human-readable explanation of the error", "type": "string" } }, "title": "EorMailboxesChangePasswordPostResponsesContentApplicationJsonSchemaErrorsItems", "type": "object" }, "EorOidTerminationsRegularPostRequestBodyContentApplicationJsonSchemaData": { "properties": { "additional_country_data": { "description": "For some countries some data is needed to help Deel to process the termination. The questions comes from another endpoint to get the additional country data", "items": { "$ref": "#/components/schemas/EorOidTerminationsRegularPostRequestBodyContentApplicationJsonSchemaDataAdditionalCountryDataItems" }, "type": "array" }, "additional_reason": { "description": "An additional reason can be provided in case the reason selected is NO_LONGER_WISH_TO_WORK_WITH_DEEL", "oneOf": [ { "$ref": "#/components/schemas/EorOidTerminationsRegularPostRequestBodyContentApplicationJsonSchemaDataAdditionalReason" }, { "type": "null" } ] }, "additional_supporting_documents": { "description": "Any proof such as correspondence, documentation of previous warnings or attendance records for the reason select above.", "items": { "$ref": "#/components/schemas/EorOidTerminationsRegularPostRequestBodyContentApplicationJsonSchemaDataAdditionalSupportingDocumentsItems" }, "type": "array" }, "attachments": { "description": "Any document that is important for the request to terminate the contract", "items": { "$ref": "#/components/schemas/EorOidTerminationsRegularPostRequestBodyContentApplicationJsonSchemaDataAttachmentsItems" }, "type": "array" }, "custom_termination_reason_id": { "description": "Custom termination reason ID. A custom termination reason can be added on Client HR module", "format": "uuid", "type": "string" }, "desired_end_date": { "description": "The desired end date. If the date is not provided, it will be selected by HRX the closest date possible", "pattern": "^\\d{4}-\\d{2}-\\d{2}$", "type": "string" }, "eligible_for_rehire": { "description": "Parameter to inform whether it would be possible for the client to hire the employee again", "oneOf": [ { "$ref": "#/components/schemas/EorOidTerminationsRegularPostRequestBodyContentApplicationJsonSchemaDataEligibleForRehire" }, { "type": "null" } ] }, "employee_notification_detail": { "description": "If it's an termination contract ending and employee was already informed, the employee notification details should be provided", "maxLength": 5000, "minLength": 1, "type": [ "string", "null" ] }, "eor_country_data_id": { "description": "The current country data id", "title": "float", "type": "string" }, "is_employee_notified": { "description": "Defines if employee was informed by client or not before the termination", "type": "boolean" }, "is_sensitive": { "description": "Defines whether the termination is sensitive. In this case, only the person requesting the termination will be able to view the termination, receive emails or notifications.", "type": "boolean" }, "reason": { "$ref": "#/components/schemas/EorOidTerminationsRegularPostRequestBodyContentApplicationJsonSchemaDataReason", "description": "Reason why the contract is being terminated" }, "reason_detail": { "description": "Field to better explain how communication with the employee will be and/or their reaction to the communication, or other necessary information", "maxLength": 5000, "minLength": 100, "type": "string" }, "severance_amount": { "description": "The amount of severance needed", "title": "float", "type": "string" }, "severance_type": { "$ref": "#/components/schemas/EorOidTerminationsRegularPostRequestBodyContentApplicationJsonSchemaDataSeveranceType", "description": "The type of severance selected by the client. It's an optional field" }, "termination_impact_id": { "description": "Termination impact data if there is some configured on HR module", "format": "uuid", "type": "string" }, "termination_notes": { "default": [], "description": "Additional notes can be provided regarding the termination for Deel, like questions and doubts", "items": { "maxLength": 5000, "type": "string" }, "type": "array" }, "used_time_off": { "$ref": "#/components/schemas/EorOidTerminationsRegularPostRequestBodyContentApplicationJsonSchemaDataUsedTimeOff" } }, "required": [ "reason", "reason_detail", "used_time_off", "is_employee_notified" ], "title": "EorOidTerminationsRegularPostRequestBodyContentApplicationJsonSchemaData", "type": "object" }, "EorOidTerminationsRegularPostRequestBodyContentApplicationJsonSchemaDataAdditionalCountryDataItems": { "properties": { "answer": { "type": [ "boolean", "null" ] }, "question": { "type": "string" } }, "required": [ "answer", "question" ], "title": "EorOidTerminationsRegularPostRequestBodyContentApplicationJsonSchemaDataAdditionalCountryDataItems", "type": "object" }, "EorOidTerminationsRegularPostRequestBodyContentApplicationJsonSchemaDataAdditionalReason": { "description": "An additional reason can be provided in case the reason selected is NO_LONGER_WISH_TO_WORK_WITH_DEEL", "enum": [ "DISSATISFIED_WITH_DEEL_SERVICE", "DISSATISFIED_WITH_DEEL_PRICING", "DISSATISFIED_WITH_DEEL_PRODUCT" ], "title": "EorOidTerminationsRegularPostRequestBodyContentApplicationJsonSchemaDataAdditionalReason", "type": "string" }, "EorOidTerminationsRegularPostRequestBodyContentApplicationJsonSchemaDataAdditionalSupportingDocumentsItems": { "properties": { "file_name": { "pattern": "\\.(png|PNG|jpg|JPG|jpeg|JPEG|heic|HEIC|pdf|PDF)$", "type": "string" }, "key": { "type": "string" } }, "required": [ "key" ], "title": "EorOidTerminationsRegularPostRequestBodyContentApplicationJsonSchemaDataAdditionalSupportingDocumentsItems", "type": "object" }, "EorOidTerminationsRegularPostRequestBodyContentApplicationJsonSchemaDataAttachmentsItems": { "properties": { "file_name": { "pattern": "\\.(png|PNG|jpg|JPG|jpeg|JPEG|heic|HEIC|pdf|PDF)$", "type": "string" }, "key": { "type": "string" } }, "required": [ "key" ], "title": "EorOidTerminationsRegularPostRequestBodyContentApplicationJsonSchemaDataAttachmentsItems", "type": "object" }, "EorOidTerminationsRegularPostRequestBodyContentApplicationJsonSchemaDataEligibleForRehire": { "description": "Parameter to inform whether it would be possible for the client to hire the employee again", "enum": [ "YES", "NO", "DONT_KNOW" ], "title": "EorOidTerminationsRegularPostRequestBodyContentApplicationJsonSchemaDataEligibleForRehire", "type": "string" }, "EorOidTerminationsRegularPostRequestBodyContentApplicationJsonSchemaDataReason": { "description": "Reason why the contract is being terminated", "enum": [ "DEEL_COLLECTIONS", "STATUS_CHANGE", "RELOCATION", "COMPENSATION", "RETIREMENT", "JOB_ABANDONMENT", "WORK_RELATED", "PERSONAL", "OTHER_OPPORTUNITY", "NON_RENEWAL", "PROBATION", "ASSIGNMENT_ENDED", "POSITION_ELIMINATION", "FORCE_REDUCTION", "DEATH", "FOR_CAUSE", "PERFORMANCE", "MEDICAL", "PERFORMANCE_ISSUES", "ATTENDANCE_ISSUES", "REORGANIZATION_DOWNSIZING_BUDGET_OR_REDUCTION_OF_WORKFORCE", "ROLE_BECAME_REDUNDANT_OR_ROLE_CHANGED", "OFFER_WAS_REVOKED", "EXITING_THE_MARKET", "NO_LONGER_WISH_TO_WORK_WITH_DEEL", "COMPANY_ACQUIRED", "STEALING", "MISCONDUCT", "FALSIFYING", "HARASSMENT", "VIOLENCE", "REORGANIZATION_DOWNSIZING_BUDGET_OR_REDUCTION_OF_WORKFORCE_OR_ROLE_BECAME_REDUNDANT_OR_ROLE_CHANGED", "UNAUTHORIZED_ABSENCES_OR_LACK_OF_ATTENDANCE", "STANDARD_RESELLER_PRACTICE", "MOVING_EMPLOYEE_TO_INTERNAL_ENTITY", "MOVING_EMPLOYEE_TO_DEEL_PEO", "OTHER" ], "title": "EorOidTerminationsRegularPostRequestBodyContentApplicationJsonSchemaDataReason", "type": "string" }, "EorOidTerminationsRegularPostRequestBodyContentApplicationJsonSchemaDataSeveranceType": { "description": "The type of severance selected by the client. It's an optional field", "enum": [ "DAYS", "WEEKS", "MONTHS", "CASH" ], "title": "EorOidTerminationsRegularPostRequestBodyContentApplicationJsonSchemaDataSeveranceType", "type": "string" }, "EorOidTerminationsRegularPostRequestBodyContentApplicationJsonSchemaDataUsedTimeOff": { "properties": { "additional_details": { "description": "Any additional details regarding time off that HRX should know", "type": [ "string", "null" ] }, "is_deel_pto_confirmed": { "description": "Defines whether the client agrees with the time off values ​​that are registered in Deel. If false, it means that the client changed the values.", "type": "boolean" }, "time_offs": { "description": "All time-off used by the employee during contract period", "items": { "$ref": "#/components/schemas/EorOidTerminationsRegularPostRequestBodyContentApplicationJsonSchemaDataUsedTimeOffTimeOffsItems" }, "type": "array" } }, "title": "EorOidTerminationsRegularPostRequestBodyContentApplicationJsonSchemaDataUsedTimeOff", "type": "object" }, "EorOidTerminationsRegularPostRequestBodyContentApplicationJsonSchemaDataUsedTimeOffTimeOffsItems": { "properties": { "policy_type": { "$ref": "#/components/schemas/EorOidTerminationsRegularPostRequestBodyContentApplicationJsonSchemaDataUsedTimeOffTimeOffsItemsPolicyType", "description": "Time off policy type" }, "scheduled_until_end_date": { "description": "Time off escheduled until contract end date", "title": "float", "type": "string" }, "tracking_periods": { "items": { "$ref": "#/components/schemas/EorOidTerminationsRegularPostRequestBodyContentApplicationJsonSchemaDataUsedTimeOffTimeOffsItemsTrackingPeriodsItems" }, "type": "array" }, "unit": { "$ref": "#/components/schemas/EorOidTerminationsRegularPostRequestBodyContentApplicationJsonSchemaDataUsedTimeOffTimeOffsItemsUnit", "description": "Time off unit" } }, "required": [ "unit" ], "title": "EorOidTerminationsRegularPostRequestBodyContentApplicationJsonSchemaDataUsedTimeOffTimeOffsItems", "type": "object" }, "EorOidTerminationsRegularPostRequestBodyContentApplicationJsonSchemaDataUsedTimeOffTimeOffsItemsPolicyType": { "description": "Time off policy type", "enum": [ "Vacation", "Sick leave", "Maternity leave", "Paternity leave", "Parental leave", "Bereavement leave", "Childcare leave", "Civic/public duty leave", "Personal leave", "Adoption leave", "Blood donation leave", "Childbirth leave", "Disability leave", "Doctor's appointment leave", "Family & domestic violence leave", "Hajj leave", "Marriage/wedding leave", "Military leave", "Moving leave", "Pregnancy leave", "Study leave", "Volunteer leave", "Unpaid leave", "Paid leave", "Other leave", "RTT", "Regional holiday", "Breastfeeding leave", "Advanced vacation", "Supplementary Leave", "Floating Holiday Allowance" ], "title": "EorOidTerminationsRegularPostRequestBodyContentApplicationJsonSchemaDataUsedTimeOffTimeOffsItemsPolicyType", "type": "string" }, "EorOidTerminationsRegularPostRequestBodyContentApplicationJsonSchemaDataUsedTimeOffTimeOffsItemsTrackingPeriodsItems": { "properties": { "end_date": { "description": "Time off start period", "format": "date-time", "type": "string" }, "start_date": { "description": "Time off end period", "format": "date-time", "type": "string" }, "used": { "description": "Time off used in the period", "title": "float", "type": "string" } }, "required": [ "used" ], "title": "EorOidTerminationsRegularPostRequestBodyContentApplicationJsonSchemaDataUsedTimeOffTimeOffsItemsTrackingPeriodsItems", "type": "object" }, "EorOidTerminationsRegularPostRequestBodyContentApplicationJsonSchemaDataUsedTimeOffTimeOffsItemsUnit": { "description": "Time off unit", "enum": [ "BUSINESS_DAY", "CALENDAR_DAY", "HOUR", "WEEK", "MONTH", "YEAR" ], "title": "EorOidTerminationsRegularPostRequestBodyContentApplicationJsonSchemaDataUsedTimeOffTimeOffsItemsUnit", "type": "string" }, "EorOidTerminationsRegularPostResponsesContentApplicationJsonSchemaItems": { "properties": { "message": { "type": "string" } }, "required": [ "message" ], "title": "EorOidTerminationsRegularPostResponsesContentApplicationJsonSchemaItems", "type": "object" }, "EorOidTerminationsRegularPostResponsesContentApplicationJsonSchemaRequestData": { "properties": { "custom_termination_reason_id": { "description": "Custom termination reason ID. A custom termination reason can be added on Client HR module", "title": "float", "type": [ "string", "null" ] }, "desired_end_date": { "description": "The desired end date. If the date is not provided, it will be selected by HRX the closest date possible", "format": "date-time", "type": [ "string", "null" ] }, "eligible_for_rehire": { "description": "Parameter to inform whether it would be possible for the client to hire the employee again", "oneOf": [ { "$ref": "#/components/schemas/EorOidTerminationsRegularPostResponsesContentApplicationJsonSchemaRequestDataEligibleForRehire" }, { "type": "null" } ] }, "eligible_for_rehire_reason": { "description": "Describe if the option DONT_KNOW was selected on eligibleForRehire", "type": [ "string", "null" ] }, "end_date": { "description": "The definitive contract end date", "format": "date-time", "type": [ "string", "null" ] }, "reason": { "type": [ "string", "null" ] }, "reason_detail": { "description": "Optional field to describe the reason behind the resignation request", "type": [ "string", "null" ] }, "termination_impact": { "description": "Custom termination impact data if there is some configured on HR module", "oneOf": [ { "$ref": "#/components/schemas/EorOidTerminationsRegularPostResponsesContentApplicationJsonSchemaRequestDataTerminationImpact" }, { "type": "null" } ] } }, "title": "EorOidTerminationsRegularPostResponsesContentApplicationJsonSchemaRequestData", "type": "object" }, "EorOidTerminationsRegularPostResponsesContentApplicationJsonSchemaRequestDataEligibleForRehire": { "description": "Parameter to inform whether it would be possible for the client to hire the employee again", "enum": [ "YES", "NO", "DONT_KNOW" ], "title": "EorOidTerminationsRegularPostResponsesContentApplicationJsonSchemaRequestDataEligibleForRehire", "type": "string" }, "EorOidTerminationsRegularPostResponsesContentApplicationJsonSchemaRequestDataTerminationImpact": { "description": "Custom termination impact data if there is some configured on HR module", "properties": { "description": { "description": "Termination impact description", "type": "string" }, "id": { "format": "uuid", "type": "string" }, "title": { "description": "Termination impact title", "type": "string" } }, "title": "EorOidTerminationsRegularPostResponsesContentApplicationJsonSchemaRequestDataTerminationImpact", "type": "object" }, "EorOidTerminationsResignationPostRequestBodyContentApplicationJsonSchemaData": { "properties": { "data": { "$ref": "#/components/schemas/EorOidTerminationsResignationPostRequestBodyContentApplicationJsonSchemaDataData" } }, "required": [ "data" ], "title": "EorOidTerminationsResignationPostRequestBodyContentApplicationJsonSchemaData", "type": "object" }, "EorOidTerminationsResignationPostRequestBodyContentApplicationJsonSchemaDataData": { "properties": { "additional_reason": { "description": "An additional reason can be provided in case the reason selected is MOVING_EMPLOYEE_TO_INTERNAL_ENTITY", "oneOf": [ { "$ref": "#/components/schemas/EorOidTerminationsResignationPostRequestBodyContentApplicationJsonSchemaDataDataAdditionalReason" }, { "type": "null" } ] }, "attachments": { "description": "Any document that is important for the request to terminate the contract", "items": { "$ref": "#/components/schemas/EorOidTerminationsResignationPostRequestBodyContentApplicationJsonSchemaDataDataAttachmentsItems" }, "type": "array" }, "custom_termination_reason_id": { "description": "Custom termination reason ID. A custom termination reason can be added on Client HR module", "format": "uuid", "type": [ "string", "null" ] }, "desired_end_date": { "description": "The desired end date. If the date is not provided, it will be selected by HRX the closest date possible", "pattern": "^\\d{4}-\\d{2}-\\d{2}$", "type": "string" }, "eligible_for_rehire": { "description": "Parameter to inform whether it would be possible for the client to hire the employee again", "oneOf": [ { "$ref": "#/components/schemas/EorOidTerminationsResignationPostRequestBodyContentApplicationJsonSchemaDataDataEligibleForRehire" }, { "type": "null" } ] }, "eligible_for_rehire_reason": { "description": "Describe if the option DONT_KNOW was selected on eligibleForRehire", "maxLength": 255, "type": [ "string", "null" ] }, "is_employee_staying_with_deel": { "description": "Defines if employee will keep using Deel as provider", "type": [ "boolean", "null" ] }, "is_sensitive": { "description": "Defines whether the termination is sensitive. In this case, only the person requesting the termination will be able to view the termination, receive emails or notifications.", "type": "boolean" }, "reason": { "$ref": "#/components/schemas/EorOidTerminationsResignationPostRequestBodyContentApplicationJsonSchemaDataDataReason", "description": "Reason why the contract is being terminated" }, "reason_detail": { "description": "Optional field to describe the reason behind the resignation request", "maxLength": 5000, "type": "string" }, "severance_amount": { "description": "The amount of severance needed", "title": "float", "type": "string" }, "severance_type": { "$ref": "#/components/schemas/EorOidTerminationsResignationPostRequestBodyContentApplicationJsonSchemaDataDataSeveranceType", "description": "The type of severance selected by the client. It's an optional field" }, "termination_impact_id": { "description": "Termination impact data if there is some configured on HR module", "format": "uuid", "type": "string" }, "termination_notes": { "default": [], "description": "Additional notes can be provided regarding the termination for Deel, like questions and doubts", "items": { "maxLength": 5000, "type": "string" }, "type": "array" }, "used_time_off": { "$ref": "#/components/schemas/EorOidTerminationsResignationPostRequestBodyContentApplicationJsonSchemaDataDataUsedTimeOff" } }, "required": [ "reason", "used_time_off", "is_employee_staying_with_deel" ], "title": "EorOidTerminationsResignationPostRequestBodyContentApplicationJsonSchemaDataData", "type": "object" }, "EorOidTerminationsResignationPostRequestBodyContentApplicationJsonSchemaDataDataAdditionalReason": { "description": "An additional reason can be provided in case the reason selected is MOVING_EMPLOYEE_TO_INTERNAL_ENTITY", "enum": [ "MOVING_TO_INTERNAL_ENTITY_WITH_DEEL_GLOBAL_PAYROLL", "MOVING_TO_INTERNAL_ENTITY_WITH_OTHER_PROVIDER" ], "title": "EorOidTerminationsResignationPostRequestBodyContentApplicationJsonSchemaDataDataAdditionalReason", "type": "string" }, "EorOidTerminationsResignationPostRequestBodyContentApplicationJsonSchemaDataDataAttachmentsItems": { "properties": { "file_name": { "pattern": "\\.(png|PNG|jpg|JPG|jpeg|JPEG|heic|HEIC|pdf|PDF)$", "type": "string" }, "key": { "type": "string" } }, "required": [ "key" ], "title": "EorOidTerminationsResignationPostRequestBodyContentApplicationJsonSchemaDataDataAttachmentsItems", "type": "object" }, "EorOidTerminationsResignationPostRequestBodyContentApplicationJsonSchemaDataDataEligibleForRehire": { "description": "Parameter to inform whether it would be possible for the client to hire the employee again", "enum": [ "YES", "NO", "DONT_KNOW" ], "title": "EorOidTerminationsResignationPostRequestBodyContentApplicationJsonSchemaDataDataEligibleForRehire", "type": "string" }, "EorOidTerminationsResignationPostRequestBodyContentApplicationJsonSchemaDataDataReason": { "description": "Reason why the contract is being terminated", "enum": [ "EMPLOYEE_IS_MOVING_TO_ANOTHER_COUNTRY", "MOVING_EMPLOYEE_TO_INTERNAL_ENTITY", "MOVING_EMPLOYEE_TO_DEEL_PEO", "EMPLOYEE_FOUND_ANOTHER_JOB", "EMPLOYEE_NOT_HAPPY_WITH_BENEFITS", "EMPLOYEE_NOT_HAPPY_WITH_SALARY", "EMPLOYEE_NOT_HAPPY_WITH_THE_ROLE", "EMPLOYEE_NOT_HAPPY_WITH_COMPANY_CULTURE", "EMPLOYEE_NOT_HAPPY_WITH_DEEL", "EMPLOYEE_PROJECT_ENDED", "EMPLOYEE_SWITCHING_TO_OTHER_EOR_PROVIDER", "EMPLOYEE_LEFT_ROLE_FOR_PERSONAL_MATTERS", "EMPLOYEE_MOVING_FROM_EOR_TO_CONTRACTOR_OR_FREELANCE", "WORKER_TYPE_CHANGE", "DEEL_COLLECTIONS", "EMPLOYEE_DID_NOT_TAKE_THE_OFFER", "EMPLOYEE_PROVIDED_NO_REASON", "OTHER_BUSINESS_REASONS" ], "title": "EorOidTerminationsResignationPostRequestBodyContentApplicationJsonSchemaDataDataReason", "type": "string" }, "EorOidTerminationsResignationPostRequestBodyContentApplicationJsonSchemaDataDataSeveranceType": { "description": "The type of severance selected by the client. It's an optional field", "enum": [ "DAYS", "WEEKS", "MONTHS", "CASH" ], "title": "EorOidTerminationsResignationPostRequestBodyContentApplicationJsonSchemaDataDataSeveranceType", "type": "string" }, "EorOidTerminationsResignationPostRequestBodyContentApplicationJsonSchemaDataDataUsedTimeOff": { "properties": { "additional_details": { "description": "Any additional details regarding time off that HRX should know", "type": [ "string", "null" ] }, "is_deel_pto_confirmed": { "description": "Defines whether the client agrees with the time off values that are registered in Deel. If false, it means that the client changed the values.", "type": "boolean" }, "time_offs": { "description": "All time-off used by the employee during contract period", "items": { "$ref": "#/components/schemas/EorOidTerminationsResignationPostRequestBodyContentApplicationJsonSchemaDataDataUsedTimeOffTimeOffsItems" }, "type": "array" } }, "title": "EorOidTerminationsResignationPostRequestBodyContentApplicationJsonSchemaDataDataUsedTimeOff", "type": "object" }, "EorOidTerminationsResignationPostRequestBodyContentApplicationJsonSchemaDataDataUsedTimeOffTimeOffsItems": { "properties": { "policy_type": { "$ref": "#/components/schemas/EorOidTerminationsResignationPostRequestBodyContentApplicationJsonSchemaDataDataUsedTimeOffTimeOffsItemsPolicyType", "description": "Time off policy type" }, "scheduled_until_end_date": { "description": "Time off escheduled until contract end date", "title": "float", "type": "string" }, "tracking_periods": { "items": { "$ref": "#/components/schemas/EorOidTerminationsResignationPostRequestBodyContentApplicationJsonSchemaDataDataUsedTimeOffTimeOffsItemsTrackingPeriodsItems" }, "type": "array" }, "unit": { "$ref": "#/components/schemas/EorOidTerminationsResignationPostRequestBodyContentApplicationJsonSchemaDataDataUsedTimeOffTimeOffsItemsUnit", "description": "Time off unit" } }, "required": [ "unit" ], "title": "EorOidTerminationsResignationPostRequestBodyContentApplicationJsonSchemaDataDataUsedTimeOffTimeOffsItems", "type": "object" }, "EorOidTerminationsResignationPostRequestBodyContentApplicationJsonSchemaDataDataUsedTimeOffTimeOffsItemsPolicyType": { "description": "Time off policy type", "enum": [ "Vacation", "Sick leave", "Maternity leave", "Paternity leave", "Parental leave", "Bereavement leave", "Childcare leave", "Civic/public duty leave", "Personal leave", "Adoption leave", "Blood donation leave", "Childbirth leave", "Disability leave", "Doctor's appointment leave", "Family & domestic violence leave", "Hajj leave", "Marriage/wedding leave", "Military leave", "Moving leave", "Pregnancy leave", "Study leave", "Volunteer leave", "Unpaid leave", "Paid leave", "Other leave", "RTT", "Regional holiday", "Breastfeeding leave", "Advanced vacation", "Supplementary Leave", "Floating Holiday Allowance" ], "title": "EorOidTerminationsResignationPostRequestBodyContentApplicationJsonSchemaDataDataUsedTimeOffTimeOffsItemsPolicyType", "type": "string" }, "EorOidTerminationsResignationPostRequestBodyContentApplicationJsonSchemaDataDataUsedTimeOffTimeOffsItemsTrackingPeriodsItems": { "properties": { "end_date": { "description": "Time off start period", "format": "date-time", "type": "string" }, "start_date": { "description": "Time off end period", "format": "date-time", "type": "string" }, "used": { "description": "Time off used in the period", "title": "float", "type": "string" } }, "required": [ "used" ], "title": "EorOidTerminationsResignationPostRequestBodyContentApplicationJsonSchemaDataDataUsedTimeOffTimeOffsItemsTrackingPeriodsItems", "type": "object" }, "EorOidTerminationsResignationPostRequestBodyContentApplicationJsonSchemaDataDataUsedTimeOffTimeOffsItemsUnit": { "description": "Time off unit", "enum": [ "BUSINESS_DAY", "CALENDAR_DAY", "HOUR", "WEEK", "MONTH", "YEAR" ], "title": "EorOidTerminationsResignationPostRequestBodyContentApplicationJsonSchemaDataDataUsedTimeOffTimeOffsItemsUnit", "type": "string" }, "EorOidTerminationsResignationPostResponsesContentApplicationJsonSchemaData": { "properties": { "contract_id": { "description": "Public contract oid", "type": "string" }, "desired_end_date": { "description": "The desired end date. If the date is not provided, it will be selected by HRX the closest date possible", "format": "date-time", "type": [ "string", "null" ] }, "end_date": { "description": "The definitive contract end date", "format": "date-time", "type": [ "string", "null" ] }, "id": { "title": "float", "type": "string" }, "request_data": { "oneOf": [ { "$ref": "#/components/schemas/EorOidTerminationsResignationPostResponsesContentApplicationJsonSchemaDataRequestData" }, { "type": "null" } ] } }, "title": "EorOidTerminationsResignationPostResponsesContentApplicationJsonSchemaData", "type": "object" }, "EorOidTerminationsResignationPostResponsesContentApplicationJsonSchemaDataRequestData": { "properties": { "custom_termination_reason_id": { "description": "Custom termination reason ID. A custom termination reason can be added on Client HR module", "title": "float", "type": [ "string", "null" ] }, "desired_end_date": { "description": "The desired end date. If the date is not provided, it will be selected by HRX the closest date possible", "format": "date-time", "type": [ "string", "null" ] }, "eligible_for_rehire": { "description": "Parameter to inform whether it would be possible for the client to hire the employee again", "oneOf": [ { "$ref": "#/components/schemas/EorOidTerminationsResignationPostResponsesContentApplicationJsonSchemaDataRequestDataEligibleForRehire" }, { "type": "null" } ] }, "eligible_for_rehire_reason": { "description": "Describe if the option DONT_KNOW was selected on eligibleForRehire", "type": [ "string", "null" ] }, "end_date": { "description": "The definitive contract end date", "format": "date-time", "type": [ "string", "null" ] }, "reason": { "type": [ "string", "null" ] }, "reason_detail": { "description": "Optional field to describe the reason behind the resignation request", "type": [ "string", "null" ] }, "termination_impact": { "description": "Custom termination impact data if there is some configured on HR module", "oneOf": [ { "$ref": "#/components/schemas/EorOidTerminationsResignationPostResponsesContentApplicationJsonSchemaDataRequestDataTerminationImpact" }, { "type": "null" } ] } }, "title": "EorOidTerminationsResignationPostResponsesContentApplicationJsonSchemaDataRequestData", "type": "object" }, "EorOidTerminationsResignationPostResponsesContentApplicationJsonSchemaDataRequestDataEligibleForRehire": { "description": "Parameter to inform whether it would be possible for the client to hire the employee again", "enum": [ "YES", "NO", "DONT_KNOW" ], "title": "EorOidTerminationsResignationPostResponsesContentApplicationJsonSchemaDataRequestDataEligibleForRehire", "type": "string" }, "EorOidTerminationsResignationPostResponsesContentApplicationJsonSchemaDataRequestDataTerminationImpact": { "description": "Custom termination impact data if there is some configured on HR module", "properties": { "description": { "description": "Termination impact description", "type": "string" }, "id": { "format": "uuid", "type": "string" }, "title": { "description": "Termination impact title", "type": "string" } }, "title": "EorOidTerminationsResignationPostResponsesContentApplicationJsonSchemaDataRequestDataTerminationImpact", "type": "object" }, "EorOidTerminationsResignationPostResponsesContentApplicationJsonSchemaItems": { "properties": { "message": { "type": "string" } }, "required": [ "message" ], "title": "EorOidTerminationsResignationPostResponsesContentApplicationJsonSchemaItems", "type": "object" }, "EorOidTerminationsTerminationIdGetResponsesContentApplicationJsonSchemaItems": { "properties": { "message": { "type": "string" } }, "required": [ "message" ], "title": "EorOidTerminationsTerminationIdGetResponsesContentApplicationJsonSchemaItems", "type": "object" }, "EorOidTerminationsTerminationIdGetResponsesContentApplicationJsonSchemaRequestData": { "properties": { "custom_termination_reason_id": { "description": "Custom termination reason ID. A custom termination reason can be added on Client HR module", "title": "float", "type": [ "string", "null" ] }, "desired_end_date": { "description": "The desired end date. If the date is not provided, it will be selected by HRX the closest date possible", "format": "date-time", "type": [ "string", "null" ] }, "eligible_for_rehire": { "description": "Parameter to inform whether it would be possible for the client to hire the employee again", "oneOf": [ { "$ref": "#/components/schemas/EorOidTerminationsTerminationIdGetResponsesContentApplicationJsonSchemaRequestDataEligibleForRehire" }, { "type": "null" } ] }, "eligible_for_rehire_reason": { "description": "Describe if the option DONT_KNOW was selected on eligibleForRehire", "type": [ "string", "null" ] }, "end_date": { "description": "The definitive contract end date", "format": "date-time", "type": [ "string", "null" ] }, "reason": { "type": [ "string", "null" ] }, "reason_detail": { "description": "Optional field to describe the reason behind the resignation request", "type": [ "string", "null" ] }, "termination_impact": { "description": "Custom termination impact data if there is some configured on HR module", "oneOf": [ { "$ref": "#/components/schemas/EorOidTerminationsTerminationIdGetResponsesContentApplicationJsonSchemaRequestDataTerminationImpact" }, { "type": "null" } ] } }, "title": "EorOidTerminationsTerminationIdGetResponsesContentApplicationJsonSchemaRequestData", "type": "object" }, "EorOidTerminationsTerminationIdGetResponsesContentApplicationJsonSchemaRequestDataEligibleForRehire": { "description": "Parameter to inform whether it would be possible for the client to hire the employee again", "enum": [ "YES", "NO", "DONT_KNOW" ], "title": "EorOidTerminationsTerminationIdGetResponsesContentApplicationJsonSchemaRequestDataEligibleForRehire", "type": "string" }, "EorOidTerminationsTerminationIdGetResponsesContentApplicationJsonSchemaRequestDataTerminationImpact": { "description": "Custom termination impact data if there is some configured on HR module", "properties": { "description": { "description": "Termination impact description", "type": "string" }, "id": { "format": "uuid", "type": "string" }, "title": { "description": "Termination impact title", "type": "string" } }, "title": "EorOidTerminationsTerminationIdGetResponsesContentApplicationJsonSchemaRequestDataTerminationImpact", "type": "object" }, "EorPostRequestBodyContentApplicationJsonSchemaData": { "properties": { "benefits": { "items": { "$ref": "#/components/schemas/EorPostRequestBodyContentApplicationJsonSchemaDataBenefitsItems" }, "type": "array" }, "client": { "$ref": "#/components/schemas/EorPostRequestBodyContentApplicationJsonSchemaDataClient", "description": "Client details for the contract." }, "compensation_details": { "$ref": "#/components/schemas/EorPostRequestBodyContentApplicationJsonSchemaDataCompensationDetails" }, "employee": { "$ref": "#/components/schemas/EorPostRequestBodyContentApplicationJsonSchemaDataEmployee" }, "employment": { "$ref": "#/components/schemas/EorPostRequestBodyContentApplicationJsonSchemaDataEmployment", "description": "Employment contract specific details." }, "health_plan_id": { "description": "Healthcare plan id. You can see available healthcare plans in the country guide endpoint.", "type": "string" }, "is_team_manager": { "description": "Italy only. Whether the role is responsible for managing a team. Required when job_category is provided.", "type": "boolean" }, "job_category": { "$ref": "#/components/schemas/EorPostRequestBodyContentApplicationJsonSchemaDataJobCategory", "description": "Italy only. Job category chosen by the client. If omitted, Deel assigns one automatically. When provided, is_team_manager, reports_to_job_title and employment.probation_period are required." }, "job_title": { "description": "Employee's job title.", "type": "string" }, "pension": { "$ref": "#/components/schemas/EorPostRequestBodyContentApplicationJsonSchemaDataPension", "description": "Some countries required a pension benefit." }, "quote_additional_fields": { "description": "Some countries require additional employee information for employment contracts.", "oneOf": [ { "$ref": "#/components/schemas/EorPostRequestBodyContentApplicationJsonSchemaDataQuoteAdditionalFields" }, { "type": "null" } ] }, "reports_to_job_title": { "description": "Italy only. Job title of the person this role reports to. Required when job_category is provided.", "maxLength": 255, "minLength": 1, "type": "string" }, "seniority": { "$ref": "#/components/schemas/EorPostRequestBodyContentApplicationJsonSchemaDataSeniority", "description": "Seniority selection for the role." } }, "required": [ "client", "employee", "job_title", "seniority", "employment", "compensation_details" ], "title": "EorPostRequestBodyContentApplicationJsonSchemaData", "type": "object" }, "EorPostRequestBodyContentApplicationJsonSchemaDataBenefitsItems": { "description": "List of additional benefits to include in the calculation", "properties": { "contribution": { "description": "The amount the client will contribute for the benefit in the currency of the contract. Only taken into account if cover_all is set to false. For Unisure provider contribution is always in USD.", "format": "double", "type": "number" }, "cover_all": { "description": "Flag indicating if benefit will fully cover the employee.", "type": "boolean" }, "cover_dependents": { "description": "Flag indicating if benefit will cover dependents. Only needed if cover_all is set to true.", "type": "boolean" }, "plan_id": { "description": "The ID of a benefits plan to include in the calculation.", "type": "string" }, "provider_id": { "description": "The ID of a benefits provider to include in the calculation.", "type": "string" } }, "title": "EorPostRequestBodyContentApplicationJsonSchemaDataBenefitsItems", "type": "object" }, "EorPostRequestBodyContentApplicationJsonSchemaDataClient": { "description": "Client details for the contract.", "properties": { "legal_entity": { "$ref": "#/components/schemas/EorPostRequestBodyContentApplicationJsonSchemaDataClientLegalEntity" }, "team": { "$ref": "#/components/schemas/EorPostRequestBodyContentApplicationJsonSchemaDataClientTeam" } }, "required": [ "team" ], "title": "EorPostRequestBodyContentApplicationJsonSchemaDataClient", "type": "object" }, "EorPostRequestBodyContentApplicationJsonSchemaDataClientLegalEntity": { "properties": { "id": { "$ref": "#/components/schemas/EorPostRequestBodyContentApplicationJsonSchemaDataClientLegalEntityId", "description": "Legal entity reference for the client." } }, "required": [ "id" ], "title": "EorPostRequestBodyContentApplicationJsonSchemaDataClientLegalEntity", "type": "object" }, "EorPostRequestBodyContentApplicationJsonSchemaDataClientLegalEntityId": { "description": "Legal entity reference for the client.", "oneOf": [ { "type": "string" }, { "format": "int64", "type": "integer" } ], "title": "EorPostRequestBodyContentApplicationJsonSchemaDataClientLegalEntityId" }, "EorPostRequestBodyContentApplicationJsonSchemaDataClientTeam": { "properties": { "id": { "$ref": "#/components/schemas/EorPostRequestBodyContentApplicationJsonSchemaDataClientTeamId", "description": "Team identifying information." } }, "required": [ "id" ], "title": "EorPostRequestBodyContentApplicationJsonSchemaDataClientTeam", "type": "object" }, "EorPostRequestBodyContentApplicationJsonSchemaDataClientTeamId": { "description": "Team identifying information.", "oneOf": [ { "type": "string" }, { "format": "int64", "type": "integer" } ], "title": "EorPostRequestBodyContentApplicationJsonSchemaDataClientTeamId" }, "EorPostRequestBodyContentApplicationJsonSchemaDataCompensationDetails": { "properties": { "currency": { "description": "Salary currency.", "type": "string" }, "fixed_adjustments": { "items": { "$ref": "#/components/schemas/EorPostRequestBodyContentApplicationJsonSchemaDataCompensationDetailsFixedAdjustmentsItems" }, "type": "array" }, "hourly_rate": { "description": "Employee's hourly rate. Required only if contract is set as hourly.", "format": "double", "type": "number" }, "salary": { "description": "Employee's gross annual salary. Required only if contract is salaried.", "format": "double", "type": "number" }, "signing_bonus": { "description": "Signing bonus amount.", "format": "double", "type": [ "number", "null" ] }, "signing_bonus_payout_type": { "description": "Should be set only if signing_bonus is set. It defines when the bonus is paid.", "oneOf": [ { "$ref": "#/components/schemas/EorPostRequestBodyContentApplicationJsonSchemaDataCompensationDetailsSigningBonusPayoutType" }, { "type": "null" } ] }, "variable_compensation": { "description": "Variable compensation. For example, if the person will earn 5% of the gross annual salary as the variable compensation, enter 5.", "format": "double", "type": [ "number", "null" ] }, "variable_compensation_effective_date": { "description": "Variable compensation effective date.", "format": "date", "type": "string" }, "variable_compensation_timeline": { "description": "Variable compensation timeline.", "oneOf": [ { "$ref": "#/components/schemas/EorPostRequestBodyContentApplicationJsonSchemaDataCompensationDetailsVariableCompensationTimeline" }, { "type": "null" } ] }, "variable_compensation_title": { "description": "Variable compensation title.", "type": "string" }, "variable_compensation_type": { "description": "Should be set only if variable_compensation is set. It can be PERCENTAGE or FIXED.", "oneOf": [ { "$ref": "#/components/schemas/EorPostRequestBodyContentApplicationJsonSchemaDataCompensationDetailsVariableCompensationType" }, { "type": "null" } ] } }, "required": [ "currency" ], "title": "EorPostRequestBodyContentApplicationJsonSchemaDataCompensationDetails", "type": "object" }, "EorPostRequestBodyContentApplicationJsonSchemaDataCompensationDetailsFixedAdjustmentsItems": { "properties": { "description": { "description": "Adjustment description.", "type": "string" }, "is_country_specific": { "description": "Whether this adjustment is country-specific.", "type": "boolean" }, "is_recurring": { "description": "Whether the adjustment is paid recurring monthly or one-time on employee's first payroll.", "type": "boolean" }, "name": { "description": "Adjustment name.", "type": "string" }, "opt_out": { "description": "Whether the adjustment is being opted out of.", "type": "boolean" }, "optional": { "description": "Whether the adjustment is optional.", "type": "boolean" }, "rule_cost_id": { "description": "Identifier of the rule cost associated with the adjustment.", "type": "string" }, "skipping_confirmation_text": { "description": "Optional skipping confirmation text shown to the user.", "type": "string" }, "value": { "description": "Adjustment value.", "format": "double", "type": "number" } }, "title": "EorPostRequestBodyContentApplicationJsonSchemaDataCompensationDetailsFixedAdjustmentsItems", "type": "object" }, "EorPostRequestBodyContentApplicationJsonSchemaDataCompensationDetailsSigningBonusPayoutType": { "description": "Should be set only if signing_bonus is set. It defines when the bonus is paid.", "enum": [ "FIRST_CYCLE", "AFTER_PROBATION", "AFTER_FIRST_CONTRACT_ANNIVERSARY" ], "title": "EorPostRequestBodyContentApplicationJsonSchemaDataCompensationDetailsSigningBonusPayoutType", "type": "string" }, "EorPostRequestBodyContentApplicationJsonSchemaDataCompensationDetailsVariableCompensationTimeline": { "description": "Variable compensation timeline.", "enum": [ "ANNUALLY", "BIANNUALLY", "QUARTERLY", "MONTHLY" ], "title": "EorPostRequestBodyContentApplicationJsonSchemaDataCompensationDetailsVariableCompensationTimeline", "type": "string" }, "EorPostRequestBodyContentApplicationJsonSchemaDataCompensationDetailsVariableCompensationType": { "description": "Should be set only if variable_compensation is set. It can be PERCENTAGE or FIXED.", "enum": [ "PERCENTAGE", "FIXED" ], "title": "EorPostRequestBodyContentApplicationJsonSchemaDataCompensationDetailsVariableCompensationType", "type": "string" }, "EorPostRequestBodyContentApplicationJsonSchemaDataEmployee": { "properties": { "address": { "oneOf": [ { "$ref": "#/components/schemas/EorPostRequestBodyContentApplicationJsonSchemaDataEmployeeAddress" }, { "type": "null" } ] }, "email": { "description": "Employee's email address.", "type": "string" }, "external_id": { "description": "External identifier of the employee.", "type": "string" }, "first_name": { "description": "Employee's first name.", "type": "string" }, "last_name": { "description": "Employee's last name.", "type": "string" }, "nationality": { "description": "Employee's nationality.", "type": "string" }, "pf_deductions": { "$ref": "#/components/schemas/EorPostRequestBodyContentApplicationJsonSchemaDataEmployeePfDeductions", "description": "Employee's PF deductions. Required only for India contracts." } }, "required": [ "last_name", "first_name", "nationality" ], "title": "EorPostRequestBodyContentApplicationJsonSchemaDataEmployee", "type": "object" }, "EorPostRequestBodyContentApplicationJsonSchemaDataEmployeeAddress": { "properties": { "city": { "description": "City name.", "type": "string" }, "country": { "description": "Country code.", "maxLength": 2, "minLength": 2, "pattern": "^[A-Z]{2}$", "type": "string" }, "state": { "description": "State code.", "type": [ "string", "null" ] }, "street": { "description": "Street and number.", "type": "string" }, "zip": { "description": "Zip code.", "type": "string" } }, "title": "EorPostRequestBodyContentApplicationJsonSchemaDataEmployeeAddress", "type": "object" }, "EorPostRequestBodyContentApplicationJsonSchemaDataEmployeePfDeductions": { "description": "Employee's PF deductions. Required only for India contracts.", "enum": [ "12% of Basic", "12% of Rs 15,000 (Rs 1,800)" ], "title": "EorPostRequestBodyContentApplicationJsonSchemaDataEmployeePfDeductions", "type": "string" }, "EorPostRequestBodyContentApplicationJsonSchemaDataEmployment": { "description": "Employment contract specific details.", "properties": { "country": { "description": "Country code of employment.", "maxLength": 2, "minLength": 2, "pattern": "^[A-Z]{2}$", "type": "string" }, "employee_completed_past_probation": { "default": false, "description": "Whether the employee has previously passed the probation period.", "type": "boolean" }, "end_date": { "description": "End date in ISO-8601 format (YYYY-MM-DD).", "format": "date", "type": [ "string", "null" ] }, "holidays": { "description": "Enter the number of holidays. Leave this field blank if you are choosing \"STANDARD\" time_off_type.", "format": "double", "type": [ "number", "null" ] }, "is_hourly": { "description": "Is the employee contract hourly instead of salaried?", "type": "boolean" }, "notice_period_after_probation": { "description": "Notice period after probation required when type is CUSTOM.", "format": "double", "type": [ "number", "null" ] }, "notice_period_after_probation_time_unit": { "$ref": "#/components/schemas/EorPostRequestBodyContentApplicationJsonSchemaDataEmploymentNoticePeriodAfterProbationTimeUnit", "description": "Time unit of notice period after probation." }, "notice_period_during_probation": { "description": "Notice period during probation required when type is CUSTOM.", "format": "double", "type": [ "number", "null" ] }, "notice_period_during_probation_time_unit": { "$ref": "#/components/schemas/EorPostRequestBodyContentApplicationJsonSchemaDataEmploymentNoticePeriodDuringProbationTimeUnit", "description": "Time unit of notice period during probation." }, "notice_period_type": { "$ref": "#/components/schemas/EorPostRequestBodyContentApplicationJsonSchemaDataEmploymentNoticePeriodType", "description": "Type of notice period." }, "probation_period": { "description": "Number of probation days.", "format": "double", "type": [ "number", "null" ] }, "probation_period_time_unit": { "$ref": "#/components/schemas/EorPostRequestBodyContentApplicationJsonSchemaDataEmploymentProbationPeriodTimeUnit", "description": "Time unit of probation period." }, "probation_period_type_for_definite": { "$ref": "#/components/schemas/EorPostRequestBodyContentApplicationJsonSchemaDataEmploymentProbationPeriodTypeForDefinite", "description": "Type of probation period for definite contracts." }, "scope_of_work": { "$ref": "#/components/schemas/EorPostRequestBodyContentApplicationJsonSchemaDataEmploymentScopeOfWork", "description": "Scope of work; either a string with full text or an object referencing a template/validation UUID." }, "seniority_date": { "description": "Seniority date", "format": "date", "type": "string" }, "sick_leave_days": { "description": "Number of sick leave days", "type": "integer" }, "start_date": { "description": "Start date in ISO-8601 format (YYYY-MM-DD).", "format": "date", "type": "string" }, "state": { "description": "State code of the state/province where the this person will be employed.", "type": [ "string", "null" ] }, "time_off_type": { "$ref": "#/components/schemas/EorPostRequestBodyContentApplicationJsonSchemaDataEmploymentTimeOffType", "description": "If you want to use standard number of holidays for this employee, choose \"STANDARD\". If you want to enter a specific number of holidays, choose \"SPECIFIC\" and enter the number of days in the holidays field." }, "type": { "$ref": "#/components/schemas/EorPostRequestBodyContentApplicationJsonSchemaDataEmploymentType", "description": "Is it a full-time contract or a part-time contract?" }, "work_hours_per_week": { "description": "Employee's work hours per week. Required only if contract is set as hourly.", "format": "double", "type": "number" }, "work_visa_required": { "default": false, "description": "Do you require Deel to apply for work visa for this person?", "type": "boolean" } }, "required": [ "country", "start_date", "scope_of_work", "work_visa_required" ], "title": "EorPostRequestBodyContentApplicationJsonSchemaDataEmployment", "type": "object" }, "EorPostRequestBodyContentApplicationJsonSchemaDataEmploymentNoticePeriodAfterProbationTimeUnit": { "description": "Time unit of notice period after probation.", "enum": [ "DAY", "WEEK", "MONTH" ], "title": "EorPostRequestBodyContentApplicationJsonSchemaDataEmploymentNoticePeriodAfterProbationTimeUnit", "type": "string" }, "EorPostRequestBodyContentApplicationJsonSchemaDataEmploymentNoticePeriodDuringProbationTimeUnit": { "description": "Time unit of notice period during probation.", "enum": [ "DAY", "WEEK", "MONTH" ], "title": "EorPostRequestBodyContentApplicationJsonSchemaDataEmploymentNoticePeriodDuringProbationTimeUnit", "type": "string" }, "EorPostRequestBodyContentApplicationJsonSchemaDataEmploymentNoticePeriodType": { "description": "Type of notice period.", "enum": [ "STANDARD", "CUSTOM" ], "title": "EorPostRequestBodyContentApplicationJsonSchemaDataEmploymentNoticePeriodType", "type": "string" }, "EorPostRequestBodyContentApplicationJsonSchemaDataEmploymentProbationPeriodTimeUnit": { "description": "Time unit of probation period.", "enum": [ "DAY", "WEEK", "MONTH" ], "title": "EorPostRequestBodyContentApplicationJsonSchemaDataEmploymentProbationPeriodTimeUnit", "type": "string" }, "EorPostRequestBodyContentApplicationJsonSchemaDataEmploymentProbationPeriodTypeForDefinite": { "description": "Type of probation period for definite contracts.", "enum": [ "STANDARD", "CUSTOM" ], "title": "EorPostRequestBodyContentApplicationJsonSchemaDataEmploymentProbationPeriodTypeForDefinite", "type": "string" }, "EorPostRequestBodyContentApplicationJsonSchemaDataEmploymentScopeOfWork": { "description": "Scope of work; either a string with full text or an object referencing a template/validation UUID.", "oneOf": [ { "maxLength": 10000, "minLength": 100, "type": "string" }, { "$ref": "#/components/schemas/EorPostRequestBodyContentApplicationJsonSchemaDataEmploymentScopeOfWork1" }, { "$ref": "#/components/schemas/EorPostRequestBodyContentApplicationJsonSchemaDataEmploymentScopeOfWork2" } ], "title": "EorPostRequestBodyContentApplicationJsonSchemaDataEmploymentScopeOfWork" }, "EorPostRequestBodyContentApplicationJsonSchemaDataEmploymentScopeOfWork1": { "properties": { "scope_template_id": { "description": "Scope template UUID.", "format": "uuid", "type": "string" } }, "title": "EorPostRequestBodyContentApplicationJsonSchemaDataEmploymentScopeOfWork1", "type": "object" }, "EorPostRequestBodyContentApplicationJsonSchemaDataEmploymentScopeOfWork2": { "properties": { "scope_validation_id": { "description": "Scope validation UUID.", "format": "uuid", "type": "string" } }, "title": "EorPostRequestBodyContentApplicationJsonSchemaDataEmploymentScopeOfWork2", "type": "object" }, "EorPostRequestBodyContentApplicationJsonSchemaDataEmploymentTimeOffType": { "description": "If you want to use standard number of holidays for this employee, choose \"STANDARD\". If you want to enter a specific number of holidays, choose \"SPECIFIC\" and enter the number of days in the holidays field.", "enum": [ "STANDARD", "SPECIFIC" ], "title": "EorPostRequestBodyContentApplicationJsonSchemaDataEmploymentTimeOffType", "type": "string" }, "EorPostRequestBodyContentApplicationJsonSchemaDataEmploymentType": { "description": "Is it a full-time contract or a part-time contract?", "enum": [ "Full-time", "Part-time" ], "title": "EorPostRequestBodyContentApplicationJsonSchemaDataEmploymentType", "type": "string" }, "EorPostRequestBodyContentApplicationJsonSchemaDataJobCategory": { "description": "Italy only. Job category chosen by the client. If omitted, Deel assigns one automatically. When provided, is_team_manager, reports_to_job_title and employment.probation_period are required.", "enum": [ "Impiegato", "Quadro", "Dirigente" ], "title": "EorPostRequestBodyContentApplicationJsonSchemaDataJobCategory", "type": "string" }, "EorPostRequestBodyContentApplicationJsonSchemaDataPension": { "description": "Some countries required a pension benefit.", "properties": { "contribution": { "description": "Enter the value of pension contribution. You should send this value only if the contribution object is available in the country guide endpoint and the value should be there between minimum and maximum values indicated.", "type": "string" }, "id": { "description": "Pension provider id. You can see available pension providers in the country guide endpoint.", "type": "string" } }, "title": "EorPostRequestBodyContentApplicationJsonSchemaDataPension", "type": "object" }, "EorPostRequestBodyContentApplicationJsonSchemaDataQuoteAdditionalFields": { "description": "Some countries require additional employee information for employment contracts.", "properties": { "dob": { "description": "Employee's date of birth.", "type": "string" }, "gender": { "description": "Employee's gender.", "type": "string" }, "worker_type": { "$ref": "#/components/schemas/EorPostRequestBodyContentApplicationJsonSchemaDataQuoteAdditionalFieldsWorkerType", "description": "Type of worker." } }, "title": "EorPostRequestBodyContentApplicationJsonSchemaDataQuoteAdditionalFields", "type": "object" }, "EorPostRequestBodyContentApplicationJsonSchemaDataQuoteAdditionalFieldsWorkerType": { "description": "Type of worker.", "enum": [ "Skilled", "Unskilled" ], "title": "EorPostRequestBodyContentApplicationJsonSchemaDataQuoteAdditionalFieldsWorkerType", "type": "string" }, "EorPostRequestBodyContentApplicationJsonSchemaDataSeniority": { "description": "Seniority selection for the role.", "properties": { "id": { "$ref": "#/components/schemas/EorPostRequestBodyContentApplicationJsonSchemaDataSeniorityId", "description": "Identifier for the seniority level (string or numeric ID)." } }, "title": "EorPostRequestBodyContentApplicationJsonSchemaDataSeniority", "type": "object" }, "EorPostRequestBodyContentApplicationJsonSchemaDataSeniorityId": { "description": "Identifier for the seniority level (string or numeric ID).", "oneOf": [ { "type": "string" }, { "format": "int64", "type": "integer" } ], "title": "EorPostRequestBodyContentApplicationJsonSchemaDataSeniorityId" }, "EorPostResponsesContentApplicationJsonSchemaData": { "properties": { "client": { "$ref": "#/components/schemas/EorPostResponsesContentApplicationJsonSchemaDataClient", "description": "Client information for the contract." }, "compensation_details": { "$ref": "#/components/schemas/EorPostResponsesContentApplicationJsonSchemaDataCompensationDetails" }, "costs": { "$ref": "#/components/schemas/EorPostResponsesContentApplicationJsonSchemaDataCosts", "description": "Detailed breakdown of employment costs including summary totals, sectioned cost groups, and additional context notes." }, "created_at": { "description": "Contract creation timestamp", "format": "date-time", "type": "string" }, "employee": { "$ref": "#/components/schemas/EorPostResponsesContentApplicationJsonSchemaDataEmployee" }, "employment": { "$ref": "#/components/schemas/EorPostResponsesContentApplicationJsonSchemaDataEmployment", "description": "Employment contract specific details." }, "health_plan": { "oneOf": [ { "$ref": "#/components/schemas/EorPostResponsesContentApplicationJsonSchemaDataHealthPlan" }, { "type": "null" } ] }, "id": { "description": "ID of the created contract quote.", "type": "string" }, "job_category": { "description": "Job category assigned to the role. Present only for countries that use job categorisation.", "type": "string" }, "job_code": { "description": "Country-specific occupation code, when applicable.", "type": "string" }, "job_title": { "description": "Employee's job title", "type": "string" }, "seniority": { "$ref": "#/components/schemas/EorPostResponsesContentApplicationJsonSchemaDataSeniority", "description": "Seniority level of the employee" }, "status": { "$ref": "#/components/schemas/EorPostResponsesContentApplicationJsonSchemaDataStatus", "description": "Current status of the contract." }, "type": { "$ref": "#/components/schemas/EorPostResponsesContentApplicationJsonSchemaDataType", "description": "Type of the contract." } }, "title": "EorPostResponsesContentApplicationJsonSchemaData", "type": "object" }, "EorPostResponsesContentApplicationJsonSchemaDataClient": { "description": "Client information for the contract.", "properties": { "legal_entity": { "$ref": "#/components/schemas/EorPostResponsesContentApplicationJsonSchemaDataClientLegalEntity" } }, "title": "EorPostResponsesContentApplicationJsonSchemaDataClient", "type": "object" }, "EorPostResponsesContentApplicationJsonSchemaDataClientLegalEntity": { "properties": { "name": { "description": "Legal entity name", "type": "string" } }, "title": "EorPostResponsesContentApplicationJsonSchemaDataClientLegalEntity", "type": "object" }, "EorPostResponsesContentApplicationJsonSchemaDataCompensationDetails": { "properties": { "currency": { "description": "Currency of the salary", "type": "string" }, "salary": { "description": "Gross annual salary", "type": "string" }, "variable_compensation": { "description": "Variable compensation account or percentage", "type": "string" }, "variable_compensation_type": { "description": "Type of variable compensation", "type": [ "string", "null" ] } }, "title": "EorPostResponsesContentApplicationJsonSchemaDataCompensationDetails", "type": "object" }, "EorPostResponsesContentApplicationJsonSchemaDataCosts": { "description": "Detailed breakdown of employment costs including summary totals, sectioned cost groups, and additional context notes.", "properties": { "additional_data": { "$ref": "#/components/schemas/EorPostResponsesContentApplicationJsonSchemaDataCostsAdditionalData", "description": "Supplementary notes and contextual information relevant to the cost quote." }, "sections": { "description": "Detailed and categorized cost sections including grouped and standalone items.", "items": { "$ref": "#/components/schemas/EorPostResponsesContentApplicationJsonSchemaDataCostsSectionsItems" }, "type": "array" }, "summary": { "$ref": "#/components/schemas/EorPostResponsesContentApplicationJsonSchemaDataCostsSummary", "description": "Top-level overview of costs, including key totals and currency metadata." } }, "title": "EorPostResponsesContentApplicationJsonSchemaDataCosts", "type": "object" }, "EorPostResponsesContentApplicationJsonSchemaDataCostsAdditionalData": { "description": "Supplementary notes and contextual information relevant to the cost quote.", "properties": { "additional_notes": { "description": "General conditions, assumptions, or fees that may apply to the quote.", "items": { "type": "string" }, "type": "array" }, "annual_notes": { "description": "Notes or assumptions specifically relevant to annual cost calculations.", "items": { "type": "string" }, "type": "array" }, "monthly_notes": { "description": "Notes or assumptions specifically relevant to monthly cost calculations.", "items": { "type": "string" }, "type": "array" }, "once_off_notes": { "description": "Notes regarding one-time costs or irregular payments in the quote.", "items": { "type": "string" }, "type": "array" } }, "title": "EorPostResponsesContentApplicationJsonSchemaDataCostsAdditionalData", "type": "object" }, "EorPostResponsesContentApplicationJsonSchemaDataCostsSectionsItems": { "properties": { "groups": { "description": "Collections of related costs grouped under a common label.", "items": { "$ref": "#/components/schemas/EorPostResponsesContentApplicationJsonSchemaDataCostsSectionsItemsGroupsItems" }, "type": "array" }, "is_summarized": { "description": "Indicates whether the section is presented in summarized form.", "type": "boolean" }, "label": { "description": "Display name for the cost section.", "type": "string" }, "name": { "description": "Internal identifier for the cost section (e.g., MONTHLY_EMPLOYMENT_BREAKDOWN).", "type": "string" }, "standalone_items": { "description": "Cost items that do not belong to regular groups, often irregular or one-off costs.", "items": { "$ref": "#/components/schemas/EorPostResponsesContentApplicationJsonSchemaDataCostsSectionsItemsStandaloneItemsItems" }, "type": "array" }, "totals": { "description": "Overall totals for the section, summing all groups and standalone items.", "items": { "$ref": "#/components/schemas/EorPostResponsesContentApplicationJsonSchemaDataCostsSectionsItemsTotalsItems" }, "type": "array" } }, "title": "EorPostResponsesContentApplicationJsonSchemaDataCostsSectionsItems", "type": "object" }, "EorPostResponsesContentApplicationJsonSchemaDataCostsSectionsItemsGroupsItems": { "properties": { "costs": { "description": "Individual cost items within the group.", "items": { "$ref": "#/components/schemas/EorPostResponsesContentApplicationJsonSchemaDataCostsSectionsItemsGroupsItemsCostsItems" }, "type": "array" }, "has_breakdown": { "description": "Indicates if the group contains multiple detailed cost items to be expanded.", "type": "boolean" }, "label": { "description": "Display name for the group (e.g., Gross Salary, Employer Cost).", "type": "string" }, "name": { "description": "Internal identifier for the group.", "type": "string" }, "totals": { "description": "Aggregated totals for all items within the group.", "items": { "$ref": "#/components/schemas/EorPostResponsesContentApplicationJsonSchemaDataCostsSectionsItemsGroupsItemsTotalsItems" }, "type": "array" } }, "title": "EorPostResponsesContentApplicationJsonSchemaDataCostsSectionsItemsGroupsItems", "type": "object" }, "EorPostResponsesContentApplicationJsonSchemaDataCostsSectionsItemsGroupsItemsCostsItems": { "properties": { "label": { "description": "Name of the specific cost item (e.g., Salary, Meal Voucher).", "type": "string" }, "totals": { "description": "Monthly and annual totals for the cost item in local and supporting currencies.", "items": { "$ref": "#/components/schemas/EorPostResponsesContentApplicationJsonSchemaDataCostsSectionsItemsGroupsItemsCostsItemsTotalsItems" }, "type": "array" } }, "title": "EorPostResponsesContentApplicationJsonSchemaDataCostsSectionsItemsGroupsItemsCostsItems", "type": "object" }, "EorPostResponsesContentApplicationJsonSchemaDataCostsSectionsItemsGroupsItemsCostsItemsTotalsItems": { "properties": { "frequency": { "description": "How often this cost occurs (e.g., monthly, annual, one-time).", "type": "string" }, "total": { "description": "Total cost amount in local currency.", "type": "string" }, "total_supporting": { "description": "Total cost amount in the supporting currency.", "type": "string" } }, "title": "EorPostResponsesContentApplicationJsonSchemaDataCostsSectionsItemsGroupsItemsCostsItemsTotalsItems", "type": "object" }, "EorPostResponsesContentApplicationJsonSchemaDataCostsSectionsItemsGroupsItemsTotalsItems": { "properties": { "frequency": { "description": "How often the total is calculated (e.g., monthly, annual).", "type": "string" }, "total": { "description": "Group total in local currency.", "type": "string" }, "total_supporting": { "description": "Group total in supporting currency.", "type": "string" } }, "title": "EorPostResponsesContentApplicationJsonSchemaDataCostsSectionsItemsGroupsItemsTotalsItems", "type": "object" }, "EorPostResponsesContentApplicationJsonSchemaDataCostsSectionsItemsStandaloneItemsItems": { "properties": { "label": { "description": "Display name for the standalone cost item.", "type": "string" }, "name": { "description": "Internal identifier for the standalone cost item.", "type": "string" }, "totals": { "description": "Monthly and annual totals for the standalone item in local and supporting currencies.", "items": { "$ref": "#/components/schemas/EorPostResponsesContentApplicationJsonSchemaDataCostsSectionsItemsStandaloneItemsItemsTotalsItems" }, "type": "array" } }, "title": "EorPostResponsesContentApplicationJsonSchemaDataCostsSectionsItemsStandaloneItemsItems", "type": "object" }, "EorPostResponsesContentApplicationJsonSchemaDataCostsSectionsItemsStandaloneItemsItemsTotalsItems": { "properties": { "frequency": { "description": "How often this cost occurs (e.g., monthly, annual, one-time).", "type": "string" }, "total": { "description": "Standalone cost amount in local currency.", "type": "string" }, "total_supporting": { "description": "Standalone cost amount in the supporting currency.", "type": "string" } }, "title": "EorPostResponsesContentApplicationJsonSchemaDataCostsSectionsItemsStandaloneItemsItemsTotalsItems", "type": "object" }, "EorPostResponsesContentApplicationJsonSchemaDataCostsSectionsItemsTotalsItems": { "properties": { "frequency": { "description": "How often the total is calculated (e.g., monthly, annual).", "type": "string" }, "total": { "description": "Total cost for the section in local currency.", "type": "string" }, "total_supporting": { "description": "Total cost for the section in supporting currency.", "type": "string" } }, "title": "EorPostResponsesContentApplicationJsonSchemaDataCostsSectionsItemsTotalsItems", "type": "object" }, "EorPostResponsesContentApplicationJsonSchemaDataCostsSummary": { "description": "Top-level overview of costs, including key totals and currency metadata.", "properties": { "currency": { "description": "Local currency code (e.g., BRL, PLN).", "type": "string" }, "exchange_rate": { "description": "Exchange rate used to convert from local to supporting currency.", "type": "string" }, "salary": { "description": "Annual gross salary in local currency.", "type": "string" }, "supporting_currency": { "description": "Reference or secondary currency (e.g., USD) used for reporting totals.", "type": "string" }, "totals_formatted": { "description": "Formatted summary totals in both local and supporting currencies.", "items": { "$ref": "#/components/schemas/EorPostResponsesContentApplicationJsonSchemaDataCostsSummaryTotalsFormattedItems" }, "type": "array" } }, "title": "EorPostResponsesContentApplicationJsonSchemaDataCostsSummary", "type": "object" }, "EorPostResponsesContentApplicationJsonSchemaDataCostsSummaryTotalsFormattedItems": { "properties": { "frequency": { "description": "Time period for the total (e.g., monthly, annual).", "type": "string" }, "title": { "description": "Display title for the total (e.g., 'Monthly Total').", "type": "string" }, "total": { "description": "Formatted amount in local currency.", "type": "string" }, "total_supporting": { "description": "Formatted amount in supporting currency.", "type": "string" } }, "title": "EorPostResponsesContentApplicationJsonSchemaDataCostsSummaryTotalsFormattedItems", "type": "object" }, "EorPostResponsesContentApplicationJsonSchemaDataEmployee": { "properties": { "email": { "description": "Employee's email", "type": "string" }, "first_name": { "description": "Employee's first name", "type": "string" }, "last_name": { "description": "Employee's last name", "type": "string" }, "legal_name": { "description": "Employee's legal name", "type": "string" } }, "title": "EorPostResponsesContentApplicationJsonSchemaDataEmployee", "type": "object" }, "EorPostResponsesContentApplicationJsonSchemaDataEmployment": { "description": "Employment contract specific details.", "properties": { "calculated_holidays": { "description": "Number of calculated holidays", "type": "string" }, "country": { "description": "Country of employment", "type": "string" }, "end_date": { "description": "Employment end date", "format": "date-time", "type": [ "string", "null" ] }, "probation_period": { "description": "Number of probation days", "type": [ "integer", "null" ] }, "scope_of_work": { "description": "Scope of work description.", "type": "string" }, "start_date": { "description": "Employment start date", "format": "date-time", "type": "string" }, "state": { "description": "State or province of employment", "type": [ "string", "null" ] }, "time_off_type": { "description": "Type of time off for the employee", "type": "string" }, "work_visa_required": { "description": "If a work visa is required", "type": "boolean" } }, "title": "EorPostResponsesContentApplicationJsonSchemaDataEmployment", "type": "object" }, "EorPostResponsesContentApplicationJsonSchemaDataHealthPlan": { "properties": { "id": { "description": "Health plan ID", "type": "string" }, "name": { "description": "Health plan name", "type": "string" } }, "title": "EorPostResponsesContentApplicationJsonSchemaDataHealthPlan", "type": "object" }, "EorPostResponsesContentApplicationJsonSchemaDataSeniority": { "description": "Seniority level of the employee", "properties": { "id": { "description": "Seniority level ID", "type": "integer" }, "name": { "description": "Seniority level name", "type": "string" } }, "required": [ "id", "name" ], "title": "EorPostResponsesContentApplicationJsonSchemaDataSeniority", "type": "object" }, "EorPostResponsesContentApplicationJsonSchemaDataStatus": { "description": "Current status of the contract.", "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" ], "title": "EorPostResponsesContentApplicationJsonSchemaDataStatus", "type": "string" }, "EorPostResponsesContentApplicationJsonSchemaDataType": { "description": "Type of the contract.", "enum": [ "ongoing_time_based", "milestones", "time_based", "pay_as_you_go_time_based", "commission", "payg_milestones", "payg_tasks", "eor", "unknown", "employee", "global_payroll", "shield_msa", "hris_direct_employee", "peo" ], "title": "EorPostResponsesContentApplicationJsonSchemaDataType", "type": "string" }, "EorStartDateGetResponsesContentApplicationJsonSchemaData": { "properties": { "first_payroll_lock": { "description": "Day of month when payroll gets locked", "type": "integer" }, "is_same_month_payment_country": { "description": "Whether the employment country requires start date within the same month", "type": "boolean" }, "min_start_date": { "description": "The earliest possible employment start date", "format": "date-time", "type": "string" }, "start_date_buffer": { "description": "Number of business days to buffer from today", "type": "integer" } }, "required": [ "min_start_date", "start_date_buffer", "first_payroll_lock", "is_same_month_payment_country" ], "title": "EorStartDateGetResponsesContentApplicationJsonSchemaData", "type": "object" }, "EorStartDateGetResponsesContentApplicationJsonSchemaErrorsItems": { "properties": { "message": { "description": "A description of the returned error", "type": "string" }, "path": { "description": "The JSON path where input validation failed", "type": "string" } }, "title": "EorStartDateGetResponsesContentApplicationJsonSchemaErrorsItems", "type": "object" }, "EorStartDateGetResponsesContentApplicationJsonSchemaRequest": { "properties": { "api_req_id": { "description": "The request ID of the failed request", "type": "string" }, "code": { "description": "The code of the source handler which produced the returned error", "format": "double", "type": "number" }, "docs": { "description": "A link to the official documentation for the requested endpoint resource", "type": "string" }, "method": { "description": "The HTTP method of the failed request", "type": "string" }, "source": { "description": "The source handler which produced the returned error", "type": "string" }, "status": { "description": "The status code of the response", "format": "double", "type": "number" }, "url": { "description": "The relative URL of the failed request", "type": "string" } }, "title": "EorStartDateGetResponsesContentApplicationJsonSchemaRequest", "type": "object" }, "EorValidationsCountryCodeGetResponsesContentApplicationJsonSchemaData": { "properties": { "currency": { "description": "Country currency.", "type": "string" }, "health_insurance": { "oneOf": [ { "$ref": "#/components/schemas/EorValidationsCountryCodeGetResponsesContentApplicationJsonSchemaDataHealthInsurance" }, { "type": "null" } ] }, "holiday": { "$ref": "#/components/schemas/EorValidationsCountryCodeGetResponsesContentApplicationJsonSchemaDataHoliday" }, "probation": { "$ref": "#/components/schemas/EorValidationsCountryCodeGetResponsesContentApplicationJsonSchemaDataProbation" }, "salary": { "$ref": "#/components/schemas/EorValidationsCountryCodeGetResponsesContentApplicationJsonSchemaDataSalary" } }, "title": "EorValidationsCountryCodeGetResponsesContentApplicationJsonSchemaData", "type": "object" }, "EorValidationsCountryCodeGetResponsesContentApplicationJsonSchemaDataHealthInsurance": { "properties": { "providers": { "items": { "$ref": "#/components/schemas/EorValidationsCountryCodeGetResponsesContentApplicationJsonSchemaDataHealthInsuranceProvidersItems" }, "type": "array" }, "status": { "$ref": "#/components/schemas/EorValidationsCountryCodeGetResponsesContentApplicationJsonSchemaDataHealthInsuranceStatus", "description": "Health insurance status." } }, "title": "EorValidationsCountryCodeGetResponsesContentApplicationJsonSchemaDataHealthInsurance", "type": "object" }, "EorValidationsCountryCodeGetResponsesContentApplicationJsonSchemaDataHealthInsuranceProvidersItems": { "properties": { "id": { "description": "Provider ID.", "type": "string" }, "name": { "description": "Provider name.", "type": "string" } }, "title": "EorValidationsCountryCodeGetResponsesContentApplicationJsonSchemaDataHealthInsuranceProvidersItems", "type": "object" }, "EorValidationsCountryCodeGetResponsesContentApplicationJsonSchemaDataHealthInsuranceStatus": { "description": "Health insurance status.", "enum": [ "REQUIRED", "ENABLED", "DISABLED" ], "title": "EorValidationsCountryCodeGetResponsesContentApplicationJsonSchemaDataHealthInsuranceStatus", "type": "string" }, "EorValidationsCountryCodeGetResponsesContentApplicationJsonSchemaDataHoliday": { "properties": { "max": { "description": "Maximum holidays.", "type": [ "string", "null" ] }, "min": { "description": "Minimum holidays.", "type": [ "string", "null" ] }, "mostCommon": { "description": "Most common holiday period.", "type": [ "string", "null" ] } }, "title": "EorValidationsCountryCodeGetResponsesContentApplicationJsonSchemaDataHoliday", "type": "object" }, "EorValidationsCountryCodeGetResponsesContentApplicationJsonSchemaDataProbation": { "properties": { "max": { "description": "Maximum probation period.", "format": "double", "type": [ "number", "null" ] }, "min": { "description": "Minimum probation period.", "format": "double", "type": [ "number", "null" ] } }, "title": "EorValidationsCountryCodeGetResponsesContentApplicationJsonSchemaDataProbation", "type": "object" }, "EorValidationsCountryCodeGetResponsesContentApplicationJsonSchemaDataSalary": { "properties": { "frequency": { "$ref": "#/components/schemas/EorValidationsCountryCodeGetResponsesContentApplicationJsonSchemaDataSalaryFrequency", "description": "Frequency of the salary payment." }, "max": { "description": "Maximum salary.", "type": [ "string", "null" ] }, "min": { "description": "Minimum salary.", "type": [ "string", "null" ] } }, "title": "EorValidationsCountryCodeGetResponsesContentApplicationJsonSchemaDataSalary", "type": "object" }, "EorValidationsCountryCodeGetResponsesContentApplicationJsonSchemaDataSalaryFrequency": { "description": "Frequency of the salary payment.", "enum": [ "monthly", "quarterly", "annually", "specific_month", "specific_date" ], "title": "EorValidationsCountryCodeGetResponsesContentApplicationJsonSchemaDataSalaryFrequency", "type": "string" }, "EorWorkerBenefitsGetResponsesContentApplicationJsonSchemaDataItems": { "properties": { "benefits": { "description": "All benefits associated with this contract, regardless of enrollment status. Includes benefits the employee is enrolled in, has opted out of, or is pending enrollment for.", "items": { "$ref": "#/components/schemas/EorWorkerBenefitsGetResponsesContentApplicationJsonSchemaDataItemsBenefitsItems" }, "type": "array" }, "contract_id": { "description": "Unique identifier for the employment contract these benefits are associated with. Use to correlate benefits with a specific contract when the employee has multiple active engagements.", "type": "string" }, "currency": { "description": "ISO 4217 currency code for all monetary amounts within this contract's benefits (e.g. 'USD', 'CAD', 'GBP'). Applies to all cost and contribution fields in this contract grouping.", "type": "string" } }, "required": [ "benefits", "currency", "contract_id" ], "title": "EorWorkerBenefitsGetResponsesContentApplicationJsonSchemaDataItems", "type": "object" }, "EorWorkerBenefitsGetResponsesContentApplicationJsonSchemaDataItemsBenefitsItems": { "properties": { "benefit_type_code": { "description": "Jurisdiction-aware classification code for this benefit. Use this (not only `type`) when product logic must differ by country — for example retirement: `401_K` in the US versus `OCCUPATIONAL_PENSION` in the UK and Ireland. Other common values include HEALTHCARE, DENTAL, VISION, LIFE_INSURANCE, ACCIDENT_INSURANCE, and CRITICAL_ILLNESS; the full set may expand as new benefit types are added.", "type": "string" }, "contract_type": { "description": "Workforce product for the contract this benefit belongs to. EOR — Employer of Record; Deel is the legal employer. GP — Global Payroll; the client is the legal employer and Deel runs payroll. PEO — Professional Employer Organization (US co-employment). EMBEDDED — payroll or HR through an embedded partner integration.", "type": "string" }, "coverage_group": { "description": "Who is covered under this benefit, derived from enrolled dependents on the contract benefit. EMPLOYEE = employee only. EMPLOYEE_AND_SPOUSE = employee plus legal spouse. EMPLOYEE_AND_DOMESTIC_PARTNER = employee plus registered domestic partner where applicable. EMPLOYEE_AND_CHILD = employee plus dependent child coverage structured as a single-child tier. EMPLOYEE_AND_CHILDREN = employee plus all enrolled children. EMPLOYEE_AND_FAMILY = employee plus spouse or partner and children (full family tier) per plan rules.", "type": "string" }, "description": { "description": "Plain-text explanation of what this benefit covers and why it matters to the employee. Suitable for display in a benefits overview UI or summary card.", "type": "string" }, "effective_date": { "description": "Date from which this benefit offering is in effect for this employee in this response (ISO 8601, `YYYY-MM-DD`). The benefit offering's offered-at date when present — not the same as contract coverage start or plan-specific coverage start dates inside enrollment.", "type": "string" }, "employee_contribution": { "$ref": "#/components/schemas/EorWorkerBenefitsGetResponsesContentApplicationJsonSchemaDataItemsBenefitsItemsEmployeeContribution", "description": "Recurring portion of plan cost collected from the employee's pay for this benefit. Expressed with calculation metadata (`type`, `value`), resolved `amount`, `currency`, and `frequency`. For a given period, `employee_contribution.amount` plus `employer_contribution.amount` reflects the split of premium or plan cost represented here; use `enrollment_details` cycle fields when you need billed totals for the current cycle." }, "employer_contribution": { "$ref": "#/components/schemas/EorWorkerBenefitsGetResponsesContentApplicationJsonSchemaDataItemsBenefitsItemsEmployerContribution", "description": "Recurring employer-paid portion for this benefit, same shape as `employee_contribution`. Together with `employee_contribution.amount`, describes how premium or plan cost is split for the modeled period; billed totals for the active cycle may also appear under `enrollment_details`." }, "end_date": { "description": "Date on which this benefit's coverage ends (ISO 8601, `YYYY-MM-DD`). Benefit record's effective end, termination, or offer end where applicable. Null or absent when no definitive end date is set on this record (coverage may still change if the contract or offering is updated).", "type": [ "string", "null" ] }, "enrollment_details": { "$ref": "#/components/schemas/EorWorkerBenefitsGetResponsesContentApplicationJsonSchemaDataItemsBenefitsItemsEnrollmentDetails", "description": "Details about the specific plan and provider the employee is currently enrolled in, along with the cost breakdown for the current billing cycle. Reflects the employee's actual enrollment, which may differ from organization_selection if the employee made their own plan choice." }, "enrollment_status": { "description": "Enrollment lifecycle state for this benefit. Always matches `status` in this API version; both are returned so integrations can use the explicit `enrollment_status` name. PENDING = benefit exists but no enrollment action yet. AWAITING_ENROLLMENT = employee must complete enrollment while an enrollment window applies. AWAITING_CARRIER_CONFIRMATION = submission received; awaiting carrier or administrator confirmation. AWAITING_CONTRACT_ACTIVATION = enrollment cannot complete until the underlying employment contract is active. ENROLLED = active coverage. OPTED_OUT = employee stopped or waived the coverage. TERMINATED = stopped before natural expiry. EXPIRED = coverage window has ended.", "type": "string" }, "enrollment_window": { "$ref": "#/components/schemas/EorWorkerBenefitsGetResponsesContentApplicationJsonSchemaDataItemsBenefitsItemsEnrollmentWindow", "description": "Calendar window during which the employee may enroll in, change, or opt out of this benefit. Omitted when no window is returned (enrollment changes are then not accepted until a new window opens, for example open enrollment, a qualifying life event, or a new-hire cycle per employer configuration)." }, "id": { "description": "Unique identifier (UUID) for this benefit instance. Use this when referencing the benefit in subsequent API calls.", "format": "uuid", "type": "string" }, "name": { "description": "Human-readable display name of the benefit (e.g. 'Healthcare', 'Dental', '401(k)'). Suitable for display in UI.", "type": "string" }, "organization_selection": { "$ref": "#/components/schemas/EorWorkerBenefitsGetResponsesContentApplicationJsonSchemaDataItemsBenefitsItemsOrganizationSelection", "description": "The plan and provider the client organization has configured as the default offering for this benefit type. This reflects the employer's choice, which may differ from enrollment_details if the employee hasn't enrolled yet or selected a different option during open enrollment." }, "plan_url": { "description": "URL to this specific plan's portal or documentation — for example, a plan summary PDF, carrier-hosted plan detail page, or plan materials. Distinct from `provider_website_url` (the provider organization as a whole) and `home_page_url` (employee portal for claims and ID cards).", "type": [ "string", "null" ] }, "provider_name": { "description": "Display name of the insurance carrier or benefit provider administering this plan (for example Allianz, Cigna, ManuLife).", "type": "string" }, "provider_website_url": { "description": "Public marketing or corporate website for the carrier or administrator. For the employee-facing portal (claims, ID cards, provider search), use `home_page_url` when enrolled.", "type": "string" }, "status": { "description": "Enrollment lifecycle state for this benefit. Populated with the same value as `enrollment_status` (both fields are returned for backward compatibility). ENROLLED = active, claimable coverage. OPTED_OUT = employee stopped or waived the coverage. TERMINATED = cancelled mid-contract. EXPIRED = coverage period ended. PENDING, AWAITING_ENROLLMENT, AWAITING_CARRIER_CONFIRMATION, and AWAITING_CONTRACT_ACTIVATION indicate transitional or pre-active states; see `enrollment_status` for the same enumeration and definitions.", "type": "string" }, "type": { "description": "High-level category of the benefit (e.g. HEALTHCARE, DENTAL, VISION). May be null if uncategorized. Use benefit_type_code for a more specific, jurisdiction-aware value.", "type": [ "string", "null" ] } }, "required": [ "name", "type", "status", "description", "enrollment_details", "organization_selection" ], "title": "EorWorkerBenefitsGetResponsesContentApplicationJsonSchemaDataItemsBenefitsItems", "type": "object" }, "EorWorkerBenefitsGetResponsesContentApplicationJsonSchemaDataItemsBenefitsItemsEmployeeContribution": { "description": "Recurring portion of plan cost collected from the employee's pay for this benefit. Expressed with calculation metadata (`type`, `value`), resolved `amount`, `currency`, and `frequency`. For a given period, `employee_contribution.amount` plus `employer_contribution.amount` reflects the split of premium or plan cost represented here; use `enrollment_details` cycle fields when you need billed totals for the current cycle.", "properties": { "amount": { "description": "Resolved employee contribution in `currency` for each `frequency` period (for example `100` with `USD` and `MONTHLY` means one hundred US dollars per month).", "format": "double", "type": [ "number", "null" ] }, "currency": { "description": "ISO 4217 currency code for `amount` (for example USD, CAD, GBP). Matches the parent contract's `currency` for this benefits payload.", "type": "string" }, "frequency": { "description": "Payroll or billing cadence for this contribution. Typical values include MONTHLY, SEMI_MONTHLY (twice per month), BIWEEKLY, WEEKLY, and ANNUALLY; exact strings follow Deel payroll configuration.", "type": [ "string", "null" ] }, "type": { "description": "How the employee contribution is derived. FIXED_AMOUNT = flat currency per `frequency`. PERCENTAGE = percent of an earnings or cost basis defined by the plan. Additional values (for example employer match shapes on retirement benefits) can appear for specialized products.", "type": [ "string", "null" ] }, "value": { "description": "Raw contribution input from configuration or upstream systems; may be a number or string (for example `\"1.23\"`). Use `amount` for display and arithmetic — it is the normalized numeric value in `currency` per `frequency`.", "oneOf": [ { "oneOf": [ { "$ref": "#/components/schemas/EorWorkerBenefitsGetResponsesContentApplicationJsonSchemaDataItemsBenefitsItemsEmployeeContributionValue" }, { "type": "null" } ] }, { "type": "null" } ] } }, "required": [ "type", "value", "amount", "currency", "frequency" ], "title": "EorWorkerBenefitsGetResponsesContentApplicationJsonSchemaDataItemsBenefitsItemsEmployeeContribution", "type": "object" }, "EorWorkerBenefitsGetResponsesContentApplicationJsonSchemaDataItemsBenefitsItemsEmployeeContributionValue": { "description": "Raw contribution input from configuration or upstream systems; may be a number or string (for example `\"1.23\"`). Use `amount` for display and arithmetic — it is the normalized numeric value in `currency` per `frequency`.", "oneOf": [ { "format": "double", "type": "number" }, { "type": "string" } ], "title": "EorWorkerBenefitsGetResponsesContentApplicationJsonSchemaDataItemsBenefitsItemsEmployeeContributionValue" }, "EorWorkerBenefitsGetResponsesContentApplicationJsonSchemaDataItemsBenefitsItemsEmployerContribution": { "description": "Recurring employer-paid portion for this benefit, same shape as `employee_contribution`. Together with `employee_contribution.amount`, describes how premium or plan cost is split for the modeled period; billed totals for the active cycle may also appear under `enrollment_details`.", "properties": { "amount": { "description": "Resolved employer contribution in `currency` per `frequency` period.", "format": "double", "type": [ "number", "null" ] }, "currency": { "description": "ISO 4217 currency code for `amount`. Matches the parent contract's `currency`.", "type": "string" }, "frequency": { "description": "Cadence at which the employer contribution is applied. Same vocabulary as `employee_contribution.frequency`.", "type": [ "string", "null" ] }, "type": { "description": "How the employer contribution is derived. FIXED_AMOUNT = flat currency per `frequency`. PERCENTAGE = percent of an earnings or cost basis. Additional values may appear for specialized products.", "type": [ "string", "null" ] }, "value": { "description": "Raw employer contribution input; may be number or string depending on source. Prefer `amount` for calculations and UI.", "oneOf": [ { "oneOf": [ { "$ref": "#/components/schemas/EorWorkerBenefitsGetResponsesContentApplicationJsonSchemaDataItemsBenefitsItemsEmployerContributionValue" }, { "type": "null" } ] }, { "type": "null" } ] } }, "required": [ "type", "value", "amount", "currency", "frequency" ], "title": "EorWorkerBenefitsGetResponsesContentApplicationJsonSchemaDataItemsBenefitsItemsEmployerContribution", "type": "object" }, "EorWorkerBenefitsGetResponsesContentApplicationJsonSchemaDataItemsBenefitsItemsEmployerContributionValue": { "description": "Raw employer contribution input; may be number or string depending on source. Prefer `amount` for calculations and UI.", "oneOf": [ { "format": "double", "type": "number" }, { "type": "string" } ], "title": "EorWorkerBenefitsGetResponsesContentApplicationJsonSchemaDataItemsBenefitsItemsEmployerContributionValue" }, "EorWorkerBenefitsGetResponsesContentApplicationJsonSchemaDataItemsBenefitsItemsEnrollmentDetails": { "description": "Details about the specific plan and provider the employee is currently enrolled in, along with the cost breakdown for the current billing cycle. Reflects the employee's actual enrollment, which may differ from organization_selection if the employee made their own plan choice.", "properties": { "current_cycle_employer_contribution": { "description": "Amount the employer contributes toward the plan cost for the current billing cycle, in the contract's currency. This is the portion the company pays on the employee's behalf. The employee's actual cost is current_cycle_plan_cost minus this value.", "format": "double", "type": "number" }, "current_cycle_plan_cost": { "description": "Total cost of the selected plan for the current billing cycle, in the contract's currency. This is the gross plan cost before employer contributions are applied. Subtract current_cycle_employer_contribution to get the employee's net out-of-pocket cost.", "format": "double", "type": "number" }, "selected_plan": { "description": "The specific benefit plan the employee is enrolled in (e.g. 'Gold', 'Silver', 'Bronze'). Contains the plan's ID, display name, and downloadable plan documents.", "oneOf": [ { "$ref": "#/components/schemas/EorWorkerBenefitsGetResponsesContentApplicationJsonSchemaDataItemsBenefitsItemsEnrollmentDetailsSelectedPlan" }, { "type": "null" } ] }, "selected_provider": { "description": "The insurance carrier or benefit administrator managing the employee's currently enrolled plan. Includes portal access URL and provider-level documents.", "oneOf": [ { "$ref": "#/components/schemas/EorWorkerBenefitsGetResponsesContentApplicationJsonSchemaDataItemsBenefitsItemsEnrollmentDetailsSelectedProvider" }, { "type": "null" } ] } }, "required": [ "selected_plan", "selected_provider", "current_cycle_plan_cost", "current_cycle_employer_contribution" ], "title": "EorWorkerBenefitsGetResponsesContentApplicationJsonSchemaDataItemsBenefitsItemsEnrollmentDetails", "type": "object" }, "EorWorkerBenefitsGetResponsesContentApplicationJsonSchemaDataItemsBenefitsItemsEnrollmentDetailsSelectedPlan": { "description": "The specific benefit plan the employee is enrolled in (e.g. 'Gold', 'Silver', 'Bronze'). Contains the plan's ID, display name, and downloadable plan documents.", "properties": { "attachments": { "description": "Downloadable documents associated with this plan (e.g. Summary of Benefits and Coverage, Certificate of Coverage, plan brochure). Render each item as a labeled download link.", "items": { "$ref": "#/components/schemas/EorWorkerBenefitsGetResponsesContentApplicationJsonSchemaDataItemsBenefitsItemsEnrollmentDetailsSelectedPlanAttachmentsItems" }, "type": "array" }, "id": { "description": "Unique identifier for this benefit plan. Use when referencing the plan in enrollment or amendment API calls.", "type": "string" }, "name": { "description": "Display name of the plan tier (e.g. 'Gold', 'Silver', 'Bronze'). Shown to employees during enrollment selection and in benefits summaries.", "type": "string" } }, "required": [ "id", "name", "attachments" ], "title": "EorWorkerBenefitsGetResponsesContentApplicationJsonSchemaDataItemsBenefitsItemsEnrollmentDetailsSelectedPlan", "type": "object" }, "EorWorkerBenefitsGetResponsesContentApplicationJsonSchemaDataItemsBenefitsItemsEnrollmentDetailsSelectedPlanAttachmentsItems": { "properties": { "id": { "description": "Unique identifier for this attachment document.", "type": "string" }, "label": { "description": "Human-readable filename or label for the attachment (e.g. 'Canada_Benefits.pdf'). Use as the visible text for download links.", "type": "string" }, "url": { "description": "Direct URL to download or view the attachment. Typically a PDF. Use as the href for a download link.", "type": "string" } }, "required": [ "id", "url", "label" ], "title": "EorWorkerBenefitsGetResponsesContentApplicationJsonSchemaDataItemsBenefitsItemsEnrollmentDetailsSelectedPlanAttachmentsItems", "type": "object" }, "EorWorkerBenefitsGetResponsesContentApplicationJsonSchemaDataItemsBenefitsItemsEnrollmentDetailsSelectedProvider": { "description": "The insurance carrier or benefit administrator managing the employee's currently enrolled plan. Includes portal access URL and provider-level documents.", "properties": { "attachments": { "description": "Provider-level documents such as general coverage guides, network directories, or enrollment guides. Render each as a labeled download link.", "items": { "$ref": "#/components/schemas/EorWorkerBenefitsGetResponsesContentApplicationJsonSchemaDataItemsBenefitsItemsEnrollmentDetailsSelectedProviderAttachmentsItems" }, "type": "array" }, "home_page_url": { "description": "URL to the employee-facing provider portal where the employee can view claims, access ID cards, find in-network providers, and manage coverage details.", "type": "string" }, "id": { "description": "Unique identifier for this provider.", "type": "string" }, "is_unisure": { "description": "True if this benefit is administered through Unisure, a global group insurance platform Deel uses to deliver international EOR benefits. Relevant for understanding the benefit's administration model and claims process.", "type": "boolean" }, "name": { "description": "Display name of the insurance carrier or benefit provider (e.g. 'ManuLife', 'Aetna'). Use for labeling in UI.", "type": "string" } }, "required": [ "id", "name", "attachments", "home_page_url" ], "title": "EorWorkerBenefitsGetResponsesContentApplicationJsonSchemaDataItemsBenefitsItemsEnrollmentDetailsSelectedProvider", "type": "object" }, "EorWorkerBenefitsGetResponsesContentApplicationJsonSchemaDataItemsBenefitsItemsEnrollmentDetailsSelectedProviderAttachmentsItems": { "properties": { "id": { "description": "Unique identifier for this attachment document.", "type": "string" }, "label": { "description": "Human-readable filename or label for the attachment. Use as the visible text for download links.", "type": "string" }, "url": { "description": "Direct URL to download or view the attachment. Use as the href for a download link.", "type": "string" } }, "required": [ "id", "url", "label" ], "title": "EorWorkerBenefitsGetResponsesContentApplicationJsonSchemaDataItemsBenefitsItemsEnrollmentDetailsSelectedProviderAttachmentsItems", "type": "object" }, "EorWorkerBenefitsGetResponsesContentApplicationJsonSchemaDataItemsBenefitsItemsEnrollmentWindow": { "description": "Calendar window during which the employee may enroll in, change, or opt out of this benefit. Omitted when no window is returned (enrollment changes are then not accepted until a new window opens, for example open enrollment, a qualifying life event, or a new-hire cycle per employer configuration).", "properties": { "ends_at": { "description": "Last date the enrollment window is open (ISO 8601, `YYYY-MM-DD`). After this date, enrollment is locked until a new window is triggered.", "type": "string" }, "starts_at": { "description": "First date the enrollment window is open (ISO 8601, `YYYY-MM-DD`). Enrollment actions are accepted on or after this date only.", "type": "string" }, "trigger": { "description": "Business reason this window was opened. new_hire = initial enrollment after onboarding completes. open_enrollment = scheduled annual election period. qualifying_life_event = permitted mid-year change after a life event (for example marriage, birth, divorce) per plan rules. termination = window tied to offboarding, often for continuation or COBRA-style elections in applicable jurisdictions.", "type": [ "string", "null" ] } }, "required": [ "ends_at", "trigger", "starts_at" ], "title": "EorWorkerBenefitsGetResponsesContentApplicationJsonSchemaDataItemsBenefitsItemsEnrollmentWindow", "type": "object" }, "EorWorkerBenefitsGetResponsesContentApplicationJsonSchemaDataItemsBenefitsItemsOrganizationSelection": { "description": "The plan and provider the client organization has configured as the default offering for this benefit type. This reflects the employer's choice, which may differ from enrollment_details if the employee hasn't enrolled yet or selected a different option during open enrollment.", "properties": { "selected_plan": { "description": "The plan tier the organization has chosen to offer employees by default for this benefit.", "oneOf": [ { "$ref": "#/components/schemas/EorWorkerBenefitsGetResponsesContentApplicationJsonSchemaDataItemsBenefitsItemsOrganizationSelectionSelectedPlan" }, { "type": "null" } ] }, "selected_provider": { "$ref": "#/components/schemas/EorWorkerBenefitsGetResponsesContentApplicationJsonSchemaDataItemsBenefitsItemsOrganizationSelectionSelectedProvider", "description": "The insurance carrier or benefit provider the organization has contracted with to administer this benefit." } }, "required": [ "selected_plan", "selected_provider" ], "title": "EorWorkerBenefitsGetResponsesContentApplicationJsonSchemaDataItemsBenefitsItemsOrganizationSelection", "type": "object" }, "EorWorkerBenefitsGetResponsesContentApplicationJsonSchemaDataItemsBenefitsItemsOrganizationSelectionSelectedPlan": { "description": "The plan tier the organization has chosen to offer employees by default for this benefit.", "properties": { "attachments": { "description": "Downloadable plan documents for the organization's selected plan.", "items": { "$ref": "#/components/schemas/EorWorkerBenefitsGetResponsesContentApplicationJsonSchemaDataItemsBenefitsItemsOrganizationSelectionSelectedPlanAttachmentsItems" }, "type": "array" }, "id": { "description": "Unique identifier for the organization's selected plan.", "type": "string" }, "name": { "description": "Display name of the plan tier the organization has selected (e.g. 'Gold', 'Silver'). Shown to employees as the employer-offered default.", "type": "string" } }, "required": [ "id", "name", "attachments" ], "title": "EorWorkerBenefitsGetResponsesContentApplicationJsonSchemaDataItemsBenefitsItemsOrganizationSelectionSelectedPlan", "type": "object" }, "EorWorkerBenefitsGetResponsesContentApplicationJsonSchemaDataItemsBenefitsItemsOrganizationSelectionSelectedPlanAttachmentsItems": { "properties": { "id": { "description": "Unique identifier for this attachment document.", "type": "string" }, "label": { "description": "Human-readable filename or label for the attachment.", "type": "string" }, "url": { "description": "Direct URL to download or view the attachment.", "type": "string" } }, "required": [ "id", "url", "label" ], "title": "EorWorkerBenefitsGetResponsesContentApplicationJsonSchemaDataItemsBenefitsItemsOrganizationSelectionSelectedPlanAttachmentsItems", "type": "object" }, "EorWorkerBenefitsGetResponsesContentApplicationJsonSchemaDataItemsBenefitsItemsOrganizationSelectionSelectedProvider": { "description": "The insurance carrier or benefit provider the organization has contracted with to administer this benefit.", "properties": { "attachments": { "description": "Provider-level documents associated with the organization's selected provider.", "items": { "$ref": "#/components/schemas/EorWorkerBenefitsGetResponsesContentApplicationJsonSchemaDataItemsBenefitsItemsOrganizationSelectionSelectedProviderAttachmentsItems" }, "type": "array" }, "home_page_url": { "description": "URL to the employee-facing portal for the organization's selected provider.", "type": "string" }, "id": { "description": "Unique identifier for the organization's selected provider.", "type": "string" }, "is_unisure": { "description": "True if this provider is Unisure, a global group insurance platform used by Deel for international EOR benefits.", "type": "boolean" }, "name": { "description": "Display name of the provider the organization has selected (e.g. 'ManuLife', 'Aetna').", "type": "string" } }, "required": [ "id", "name", "attachments", "home_page_url" ], "title": "EorWorkerBenefitsGetResponsesContentApplicationJsonSchemaDataItemsBenefitsItemsOrganizationSelectionSelectedProvider", "type": "object" }, "EorWorkerBenefitsGetResponsesContentApplicationJsonSchemaDataItemsBenefitsItemsOrganizationSelectionSelectedProviderAttachmentsItems": { "properties": { "id": { "description": "Unique identifier for this attachment document.", "type": "string" }, "label": { "description": "Human-readable filename or label for the attachment.", "type": "string" }, "url": { "description": "Direct URL to download or view the attachment.", "type": "string" } }, "required": [ "id", "url", "label" ], "title": "EorWorkerBenefitsGetResponsesContentApplicationJsonSchemaDataItemsBenefitsItemsOrganizationSelectionSelectedProviderAttachmentsItems", "type": "object" }, "EorWorkerBenefitsGetResponsesContentApplicationJsonSchemaErrorsItems": { "properties": { "message": { "description": "A description of the returned error", "type": "string" }, "path": { "description": "The JSON path where input validation failed", "type": "string" } }, "title": "EorWorkerBenefitsGetResponsesContentApplicationJsonSchemaErrorsItems", "type": "object" }, "EorWorkerBenefitsGetResponsesContentApplicationJsonSchemaRequest": { "properties": { "api_req_id": { "description": "The request ID of the failed request", "type": "string" }, "code": { "description": "The code of the source handler which produced the returned error", "format": "double", "type": "number" }, "docs": { "description": "A link to the official documentation for the requested endpoint resource", "type": "string" }, "method": { "description": "The HTTP method of the failed request", "type": "string" }, "source": { "description": "The source handler which produced the returned error", "type": "string" }, "status": { "description": "The status code of the response", "format": "double", "type": "number" }, "url": { "description": "The relative URL of the failed request", "type": "string" } }, "title": "EorWorkerBenefitsGetResponsesContentApplicationJsonSchemaRequest", "type": "object" }, "EorWorkerPostRequestBodyContentApplicationJsonSchemaData": { "properties": { "contract_id": { "description": "ID of the contract associated with the timesheet", "type": "string" } }, "required": [ "contract_id" ], "title": "EorWorkerPostRequestBodyContentApplicationJsonSchemaData", "type": "object" }, "EorWorkerPostResponsesContentApplicationJsonSchemaData": { "properties": { "hris_profile_id": { "description": "The ID of the worker's HRIS profile", "format": "uuid", "type": "string" }, "profile_id": { "description": "The ID of the worker's profile", "format": "uuid", "type": "string" }, "user_id": { "description": "The ID of the worker's user profile", "format": "uuid", "type": "string" } }, "required": [ "user_id", "profile_id", "hris_profile_id" ], "title": "EorWorkerPostResponsesContentApplicationJsonSchemaData", "type": "object" }, "EorWorkerPostResponsesContentApplicationJsonSchemaErrorsItems": { "properties": { "message": { "description": "A description of the returned error", "type": "string" }, "path": { "description": "The JSON path where input validation failed", "type": "string" } }, "title": "EorWorkerPostResponsesContentApplicationJsonSchemaErrorsItems", "type": "object" }, "EorWorkerPostResponsesContentApplicationJsonSchemaRequest": { "properties": { "api_req_id": { "description": "The request ID of the failed request", "type": "string" }, "code": { "description": "The code of the source handler which produced the returned error", "format": "double", "type": "number" }, "docs": { "description": "A link to the official documentation for the requested endpoint resource", "type": "string" }, "method": { "description": "The HTTP method of the failed request", "type": "string" }, "source": { "description": "The source handler which produced the returned error", "type": "string" }, "status": { "description": "The status code of the response", "format": "double", "type": "number" }, "url": { "description": "The relative URL of the failed request", "type": "string" } }, "title": "EorWorkerPostResponsesContentApplicationJsonSchemaRequest", "type": "object" }, "EorWorkersBanksBankIdPatchResponsesContentApplicationJsonSchemaData": { "properties": { "created_at": { "description": "Date and time when bank account was created", "format": "date-time", "type": "string" }, "id": { "description": "The unique identifier of the bank account.", "type": "string" }, "status": { "$ref": "#/components/schemas/EorWorkersBanksBankIdPatchResponsesContentApplicationJsonSchemaDataStatus", "description": "Bank Account status" }, "updated_at": { "description": "Date and time when bank account was last updated", "format": "date-time", "type": "string" } }, "title": "EorWorkersBanksBankIdPatchResponsesContentApplicationJsonSchemaData", "type": "object" }, "EorWorkersBanksBankIdPatchResponsesContentApplicationJsonSchemaDataStatus": { "description": "Bank Account status", "enum": [ "NEW", "PENDING", "APPROVED", "FAILED" ], "title": "EorWorkersBanksBankIdPatchResponsesContentApplicationJsonSchemaDataStatus", "type": "string" }, "EorWorkersBanksGuideCountryCountryCurrencyCurrencyGetResponsesContentApplicationJsonSchemaDataItems": { "properties": { "is_required": { "description": "Whether the field is required or not.", "type": [ "boolean", "null" ] }, "key": { "description": "The key of the field.", "type": "string" }, "type": { "description": "Type of the field", "type": "string" }, "ui_guide": { "$ref": "#/components/schemas/EorWorkersBanksGuideCountryCountryCurrencyCurrencyGetResponsesContentApplicationJsonSchemaDataItemsUiGuide", "description": "UI guidance information for rendering this field in forms." }, "validations": { "description": "Array of validation rules that apply to this field.", "items": { "$ref": "#/components/schemas/EorWorkersBanksGuideCountryCountryCurrencyCurrencyGetResponsesContentApplicationJsonSchemaDataItemsValidationsItems" }, "type": "array" }, "values_allowed": { "description": "Array of allowed values for this field (used for dropdowns, select lists, etc.).", "items": { "$ref": "#/components/schemas/EorWorkersBanksGuideCountryCountryCurrencyCurrencyGetResponsesContentApplicationJsonSchemaDataItemsValuesAllowedItems" }, "type": "array" } }, "required": [ "key", "ui_guide", "is_required" ], "title": "EorWorkersBanksGuideCountryCountryCurrencyCurrencyGetResponsesContentApplicationJsonSchemaDataItems", "type": "object" }, "EorWorkersBanksGuideCountryCountryCurrencyCurrencyGetResponsesContentApplicationJsonSchemaDataItemsUiGuide": { "description": "UI guidance information for rendering this field in forms.", "properties": { "helper_text": { "description": "Helper text to guide the user.", "type": [ "string", "null" ] }, "label": { "description": "Label for this field.", "type": "string" }, "order": { "description": "Order of the field in the form.", "type": "integer" } }, "title": "EorWorkersBanksGuideCountryCountryCurrencyCurrencyGetResponsesContentApplicationJsonSchemaDataItemsUiGuide", "type": "object" }, "EorWorkersBanksGuideCountryCountryCurrencyCurrencyGetResponsesContentApplicationJsonSchemaDataItemsValidationsItems": { "properties": { "error_message": { "description": "Error message to be displayed if validation fails.", "type": "string" }, "type": { "$ref": "#/components/schemas/EorWorkersBanksGuideCountryCountryCurrencyCurrencyGetResponsesContentApplicationJsonSchemaDataItemsValidationsItemsType", "description": "The type of validation rule to apply." }, "value": { "$ref": "#/components/schemas/EorWorkersBanksGuideCountryCountryCurrencyCurrencyGetResponsesContentApplicationJsonSchemaDataItemsValidationsItemsValue", "description": "The value to use for the validation rule (e.g., minimum length, regex pattern)." } }, "title": "EorWorkersBanksGuideCountryCountryCurrencyCurrencyGetResponsesContentApplicationJsonSchemaDataItemsValidationsItems", "type": "object" }, "EorWorkersBanksGuideCountryCountryCurrencyCurrencyGetResponsesContentApplicationJsonSchemaDataItemsValidationsItemsType": { "description": "The type of validation rule to apply.", "enum": [ "MIN_LENGTH", "MAX_LENGTH", "REGEX" ], "title": "EorWorkersBanksGuideCountryCountryCurrencyCurrencyGetResponsesContentApplicationJsonSchemaDataItemsValidationsItemsType", "type": "string" }, "EorWorkersBanksGuideCountryCountryCurrencyCurrencyGetResponsesContentApplicationJsonSchemaDataItemsValidationsItemsValue": { "description": "The value to use for the validation rule (e.g., minimum length, regex pattern).", "oneOf": [ { "type": "string" }, { "format": "double", "type": "number" } ], "title": "EorWorkersBanksGuideCountryCountryCurrencyCurrencyGetResponsesContentApplicationJsonSchemaDataItemsValidationsItemsValue" }, "EorWorkersBanksGuideCountryCountryCurrencyCurrencyGetResponsesContentApplicationJsonSchemaDataItemsValuesAllowedItems": { "properties": { "label": { "description": "The name of the allowed value.", "type": "string" }, "value": { "description": "The value of the allowed value.", "type": "string" } }, "title": "EorWorkersBanksGuideCountryCountryCurrencyCurrencyGetResponsesContentApplicationJsonSchemaDataItemsValuesAllowedItems", "type": "object" }, "EorWorkersBanksGuideCountryCountryCurrencyCurrencyGetResponsesContentApplicationJsonSchemaErrorsItems": { "properties": { "code": { "description": "Machine-readable error code", "type": "string" }, "field": { "description": "Name of the field causing the error (for validation issues)", "type": "string" }, "message": { "description": "Human-readable explanation of the error", "type": "string" } }, "title": "EorWorkersBanksGuideCountryCountryCurrencyCurrencyGetResponsesContentApplicationJsonSchemaErrorsItems", "type": "object" }, "EorWorkersBanksGuideGetResponsesContentApplicationJsonSchemaDataItems": { "properties": { "key": { "description": "The key of the field.", "type": "string" }, "label": { "description": "Label for this field.", "type": "string" }, "required": { "description": "Whether the field is required or not.", "type": "boolean" }, "type": { "description": "Type of the field", "type": "string" }, "validations": { "items": { "$ref": "#/components/schemas/EorWorkersBanksGuideGetResponsesContentApplicationJsonSchemaDataItemsValidationsItems" }, "type": "array" }, "values_allowed": { "items": { "$ref": "#/components/schemas/EorWorkersBanksGuideGetResponsesContentApplicationJsonSchemaDataItemsValuesAllowedItems" }, "type": "array" } }, "required": [ "key", "required" ], "title": "EorWorkersBanksGuideGetResponsesContentApplicationJsonSchemaDataItems", "type": "object" }, "EorWorkersBanksGuideGetResponsesContentApplicationJsonSchemaDataItemsValidationsItems": { "properties": { "type": { "$ref": "#/components/schemas/EorWorkersBanksGuideGetResponsesContentApplicationJsonSchemaDataItemsValidationsItemsType" }, "value": { "$ref": "#/components/schemas/EorWorkersBanksGuideGetResponsesContentApplicationJsonSchemaDataItemsValidationsItemsValue" } }, "title": "EorWorkersBanksGuideGetResponsesContentApplicationJsonSchemaDataItemsValidationsItems", "type": "object" }, "EorWorkersBanksGuideGetResponsesContentApplicationJsonSchemaDataItemsValidationsItemsType": { "enum": [ "MIN_LENGTH", "MAX_LENGTH", "REGEX" ], "title": "EorWorkersBanksGuideGetResponsesContentApplicationJsonSchemaDataItemsValidationsItemsType", "type": "string" }, "EorWorkersBanksGuideGetResponsesContentApplicationJsonSchemaDataItemsValidationsItemsValue": { "oneOf": [ { "type": "string" }, { "format": "double", "type": "number" } ], "title": "EorWorkersBanksGuideGetResponsesContentApplicationJsonSchemaDataItemsValidationsItemsValue" }, "EorWorkersBanksGuideGetResponsesContentApplicationJsonSchemaDataItemsValuesAllowedItems": { "properties": { "label": { "description": "The name of the allowed value.", "type": "string" }, "value": { "description": "The value of the allowed value.", "type": "string" } }, "title": "EorWorkersBanksGuideGetResponsesContentApplicationJsonSchemaDataItemsValuesAllowedItems", "type": "object" }, "EorWorkersBanksPostRequestBodyContentApplicationJsonSchemaDataItems": { "properties": { "key": { "description": "The key of the bank account properties.", "type": "string" }, "value": { "description": "The value for that key property.", "type": "string" } }, "required": [ "key", "value" ], "title": "EorWorkersBanksPostRequestBodyContentApplicationJsonSchemaDataItems", "type": "object" }, "EorWorkersBanksPostResponsesContentApplicationJsonSchemaData": { "properties": { "id": { "description": "ID of Bank Account.", "type": "string" } }, "required": [ "id" ], "title": "EorWorkersBanksPostResponsesContentApplicationJsonSchemaData", "type": "object" }, "EorWorkersComplianceDocumentsDocumentIdAcknowledgementPostResponsesContentApplicationJsonSchemaErrorsItems": { "properties": { "code": { "description": "Machine-readable error code", "type": "string" }, "message": { "description": "Human-readable explanation of the error", "type": "string" } }, "title": "EorWorkersComplianceDocumentsDocumentIdAcknowledgementPostResponsesContentApplicationJsonSchemaErrorsItems", "type": "object" }, "EorWorkersComplianceDocumentsDocumentIdDownloadGetResponsesContentApplicationJsonSchemaData": { "properties": { "expires_at": { "description": "Expiration date time of download URL.", "format": "date-time", "type": "string" }, "url": { "description": "The URL for the requested compliance document.", "type": "string" } }, "title": "EorWorkersComplianceDocumentsDocumentIdDownloadGetResponsesContentApplicationJsonSchemaData", "type": "object" }, "EorWorkersComplianceDocumentsDocumentIdDownloadGetResponsesContentApplicationJsonSchemaErrorsItems": { "properties": { "message": { "description": "A description of the returned error", "type": "string" }, "path": { "description": "The JSON path where input validation failed", "type": "string" } }, "title": "EorWorkersComplianceDocumentsDocumentIdDownloadGetResponsesContentApplicationJsonSchemaErrorsItems", "type": "object" }, "EorWorkersComplianceDocumentsDocumentIdDownloadGetResponsesContentApplicationJsonSchemaRequest": { "properties": { "api_req_id": { "description": "The request ID of the failed request", "type": "string" }, "code": { "description": "The code of the source handler which produced the returned error", "format": "double", "type": "number" }, "docs": { "description": "A link to the official documentation for the requested endpoint resource", "type": "string" }, "method": { "description": "The HTTP method of the failed request", "type": "string" }, "source": { "description": "The source handler which produced the returned error", "type": "string" }, "status": { "description": "The status code of the response", "format": "double", "type": "number" }, "url": { "description": "The relative URL of the failed request", "type": "string" } }, "title": "EorWorkersComplianceDocumentsDocumentIdDownloadGetResponsesContentApplicationJsonSchemaRequest", "type": "object" }, "EorWorkersComplianceDocumentsDocumentIdPostResponsesContentApplicationJsonSchemaData": { "properties": { "success": { "description": "A flag denoting if the file upload was successful.", "type": "boolean" } }, "title": "EorWorkersComplianceDocumentsDocumentIdPostResponsesContentApplicationJsonSchemaData", "type": "object" }, "EorWorkersComplianceDocumentsDocumentIdTemplatesDownloadGetResponsesContentApplicationJsonSchemaData": { "properties": { "expires_at": { "description": "Expiration date time of download URL.", "format": "date-time", "type": [ "string", "null" ] }, "updated_at": { "description": "Last modified date of the template file", "format": "date-time", "type": "string" }, "url": { "description": "The URL for the requested compliance document template.", "type": "string" } }, "title": "EorWorkersComplianceDocumentsDocumentIdTemplatesDownloadGetResponsesContentApplicationJsonSchemaData", "type": "object" }, "EorWorkersComplianceDocumentsDocumentIdTemplatesDownloadGetResponsesContentApplicationJsonSchemaErrorsItems": { "properties": { "code": { "description": "Error code.", "type": "string" }, "message": { "description": "Human-readable error message.", "type": "string" } }, "required": [ "code", "message" ], "title": "EorWorkersComplianceDocumentsDocumentIdTemplatesDownloadGetResponsesContentApplicationJsonSchemaErrorsItems", "type": "object" }, "EorWorkersComplianceDocumentsGetResponsesContentApplicationJsonSchemaData": { "properties": { "documents": { "description": "List of compliance documents required for the worker.", "items": { "$ref": "#/components/schemas/EorWorkersComplianceDocumentsGetResponsesContentApplicationJsonSchemaDataDocumentsItems" }, "type": "array" } }, "required": [ "documents" ], "title": "EorWorkersComplianceDocumentsGetResponsesContentApplicationJsonSchemaData", "type": "object" }, "EorWorkersComplianceDocumentsGetResponsesContentApplicationJsonSchemaDataDocumentsItems": { "properties": { "country": { "description": "ISO 3166-1 alpha-2 country code where the document is required.", "type": "string" }, "description": { "description": "Description of the document requirement. Empty string when no description exists.", "type": "string" }, "filenames": { "description": "List of uploaded file names. Empty array when no files have been uploaded.", "items": { "type": "string" }, "type": "array" }, "fillable": { "description": "Whether the document can be filled through the Deel platform.", "type": "boolean" }, "has_template": { "description": "Whether a template is available for this document.", "type": "boolean" }, "id": { "description": "Unique identifier for the compliance document requirement.", "format": "uuid", "type": "string" }, "is_acknowledgement_only_document": { "description": "Whether this document only requires acknowledgement without file upload.", "type": "boolean" }, "is_consent_required": { "description": "Whether consent is required for acknowledgement-only documents. Only present when is_acknowledgement_only_document is true.", "type": "boolean" }, "is_optional": { "description": "Whether the document is optional for the worker. Also true when the document is required within 30 days.", "type": "boolean" }, "name": { "description": "Display name of the compliance document.", "type": "string" }, "rejection_message": { "description": "Plain text message explaining why the document was rejected. Empty string when no rejection message exists.", "type": "string" }, "required_in_30_days": { "description": "Whether the document is required within 30 days of employment start.", "type": "boolean" }, "status": { "description": "Review status of the uploaded document, null if no document has been uploaded yet.", "oneOf": [ { "$ref": "#/components/schemas/EorWorkersComplianceDocumentsGetResponsesContentApplicationJsonSchemaDataDocumentsItemsStatus" }, { "type": "null" } ] }, "uploaded_at": { "description": "ISO 8601 timestamp when the document was uploaded, null if no document has been uploaded.", "format": "date-time", "type": [ "string", "null" ] } }, "required": [ "id", "name", "status", "country", "fillable", "filenames", "description", "is_optional", "uploaded_at", "has_template", "rejection_message", "required_in_30_days", "is_acknowledgement_only_document" ], "title": "EorWorkersComplianceDocumentsGetResponsesContentApplicationJsonSchemaDataDocumentsItems", "type": "object" }, "EorWorkersComplianceDocumentsGetResponsesContentApplicationJsonSchemaDataDocumentsItemsStatus": { "description": "Review status of the uploaded document, null if no document has been uploaded yet.", "enum": [ "AWAITING_EX_REVIEW", "AWAITING_EXTERNAL_REVIEW", "REJECTED", "APPROVED", "ON_HOLD" ], "title": "EorWorkersComplianceDocumentsGetResponsesContentApplicationJsonSchemaDataDocumentsItemsStatus", "type": "string" }, "EorWorkersComplianceDocumentsGetResponsesContentApplicationJsonSchemaErrorsItems": { "properties": { "code": { "type": "string" }, "field": { "type": [ "string", "null" ] }, "message": { "type": "string" } }, "required": [ "code", "message" ], "title": "EorWorkersComplianceDocumentsGetResponsesContentApplicationJsonSchemaErrorsItems", "type": "object" }, "EorWorkersContractsContractIdAdditionalInformationGetParametersXBeta": { "default": "true", "enum": [ "true" ], "title": "EorWorkersContractsContractIdAdditionalInformationGetParametersXBeta", "type": "string" }, "EorWorkersContractsContractIdAdditionalInformationGetResponsesContentApplicationJsonSchemaData": { "description": "Only fields with a saved value are included. Keys not listed above are country/state-specific additional information fields, keyed the same way as the fields returned by GET /forms/eor/worker-additional-fields/{country_code} (public keys).", "properties": { "city": { "description": "City", "type": "string" }, "dob": { "description": "Date of birth (ISO 8601 date)", "type": "string" }, "is_compliance_access_allowed": { "description": "Worker access to compliance documents", "type": "boolean" }, "is_payslip_access_allowed": { "description": "Worker access to payslips", "type": "boolean" }, "phone": { "description": "Worker phone", "type": "string" }, "state": { "description": "State/province", "type": "string" }, "street": { "description": "Street", "type": "string" }, "tax_residence": { "description": "Worker tax residence", "type": "string" }, "zip_code": { "description": "Zipcode/Post code", "type": "string" } }, "title": "EorWorkersContractsContractIdAdditionalInformationGetResponsesContentApplicationJsonSchemaData", "type": "object" }, "EorWorkersContractsContractIdAdditionalInformationGetResponsesContentApplicationJsonSchemaErrorsItems": { "properties": { "code": { "description": "Machine-readable error code", "type": "string" }, "message": { "type": "string" } }, "required": [ "message" ], "title": "EorWorkersContractsContractIdAdditionalInformationGetResponsesContentApplicationJsonSchemaErrorsItems", "type": "object" }, "EorWorkersContractsContractIdAdditionalInformationPatchRequestBodyContentApplicationJsonSchemaData": { "description": "You can submit any subset of fields. Keys not listed above are treated as country/state-specific additional information fields. Those keys must match the fields returned by GET /forms/eor/worker-additional-fields/{country_code} (public keys).", "properties": { "city": { "description": "City", "type": "string" }, "dob": { "description": "Date of birth (ISO 8601 date)", "type": "string" }, "is_compliance_access_allowed": { "description": "Worker access to compliance documents", "type": "boolean" }, "is_payslip_access_allowed": { "description": "Worker access to payslips", "type": "boolean" }, "phone": { "description": "Worker phone", "type": "string" }, "state": { "description": "State/province", "type": "string" }, "street": { "description": "Street", "type": "string" }, "tax_residence": { "description": "Worker tax residence", "type": "string" }, "zip_code": { "description": "Zipcode/Post code", "type": "string" } }, "title": "EorWorkersContractsContractIdAdditionalInformationPatchRequestBodyContentApplicationJsonSchemaData", "type": "object" }, "EorWorkersContractsContractIdAdditionalInformationPatchResponsesContentApplicationJsonSchemaData": { "properties": { "updated": { "description": "Indicates if contract was updated", "type": "boolean" } }, "required": [ "updated" ], "title": "EorWorkersContractsContractIdAdditionalInformationPatchResponsesContentApplicationJsonSchemaData", "type": "object" }, "EorWorkersContractsContractIdAdditionalInformationPatchResponsesContentApplicationJsonSchemaErrorsItems": { "properties": { "message": { "type": "string" } }, "required": [ "message" ], "title": "EorWorkersContractsContractIdAdditionalInformationPatchResponsesContentApplicationJsonSchemaErrorsItems", "type": "object" }, "EorWorkersContractsContractIdAdditionalInformationPostRequestBodyContentApplicationJsonSchemaData": { "description": "Additional fields are country/state-specific and validated against the worker additional fields form for the employment country.", "properties": { "city": { "description": "City", "type": "string" }, "is_compliance_access_allowed": { "description": "Worker access to compliance documents", "type": "boolean" }, "is_payslip_access_allowed": { "description": "Worker access to payslips", "type": "boolean" }, "phone": { "description": "Worker phone", "type": "string" }, "state": { "description": "State/province (required for countries with provinces/states).", "type": "string" }, "street": { "description": "Street", "type": "string" }, "tax_residence": { "description": "Worker tax residence", "type": "string" }, "zip_code": { "description": "Zipcode/Post code", "type": "string" } }, "required": [ "city", "phone", "street", "zip_code", "tax_residence", "is_payslip_access_allowed", "is_compliance_access_allowed" ], "title": "EorWorkersContractsContractIdAdditionalInformationPostRequestBodyContentApplicationJsonSchemaData", "type": "object" }, "EorWorkersContractsContractIdAdditionalInformationPostResponsesContentApplicationJsonSchemaData": { "properties": { "updated": { "description": "Indicates if contract was updated", "type": "boolean" } }, "required": [ "updated" ], "title": "EorWorkersContractsContractIdAdditionalInformationPostResponsesContentApplicationJsonSchemaData", "type": "object" }, "EorWorkersContractsContractIdAdditionalInformationPostResponsesContentApplicationJsonSchemaErrorsItems": { "properties": { "message": { "type": "string" } }, "required": [ "message" ], "title": "EorWorkersContractsContractIdAdditionalInformationPostResponsesContentApplicationJsonSchemaErrorsItems", "type": "object" }, "EorWorkersContractsContractIdAdditionalInformationPostResponsesContentApplicationJsonSchemaTranslationsItems": { "properties": { "originalKey": { "type": "string" }, "publicApiKey": { "type": "string" } }, "required": [ "originalKey", "publicApiKey" ], "title": "EorWorkersContractsContractIdAdditionalInformationPostResponsesContentApplicationJsonSchemaTranslationsItems", "type": "object" }, "EorWorkersContractsContractIdEmployeeAgreementDownloadGetResponsesContentApplicationJsonSchemaData": { "properties": { "expires_at": { "description": "Expiration date time of download URL.", "format": "date-time", "type": "string" }, "url": { "description": "URL to requested employee agreement to download.", "type": "string" } }, "title": "EorWorkersContractsContractIdEmployeeAgreementDownloadGetResponsesContentApplicationJsonSchemaData", "type": "object" }, "EorWorkersContractsContractIdEmployeeAgreementDownloadGetResponsesContentApplicationJsonSchemaErrorsItems": { "properties": { "message": { "description": "The error message", "type": "string" } }, "title": "EorWorkersContractsContractIdEmployeeAgreementDownloadGetResponsesContentApplicationJsonSchemaErrorsItems", "type": "object" }, "EorWorkersContractsContractIdEmployeeAgreementDownloadGetResponsesContentApplicationJsonSchemaRequest": { "properties": { "api_req_id": { "description": "The request ID of the failed request", "type": "string" }, "docs": { "description": "A link to the official documentation for the requested endpoint resource", "type": "string" }, "method": { "description": "The HTTP method of the failed request", "type": "string" }, "source": { "description": "The source handler which produced the returned error", "type": "string" }, "status": { "description": "The status code of the response", "format": "double", "type": "number" }, "url": { "description": "The relative URL of the failed request", "type": "string" } }, "title": "EorWorkersContractsContractIdEmployeeAgreementDownloadGetResponsesContentApplicationJsonSchemaRequest", "type": "object" }, "EorWorkersContractsContractIdHrDocumentsGetResponsesContentApplicationJsonSchemaDataItems": { "properties": { "id": { "description": "Document Id.", "type": "string" }, "name": { "description": "Name of the document.", "type": "string" } }, "required": [ "id", "name" ], "title": "EorWorkersContractsContractIdHrDocumentsGetResponsesContentApplicationJsonSchemaDataItems", "type": "object" }, "EorWorkersContractsContractIdOffboardingPostRequestBodyContentMultipartFormDataSchemaData": { "properties": { "desired_end_date": { "description": "The employee's desired last day of work in YYYY-MM-DD format", "format": "date", "pattern": "^\\d{4}-\\d{2}-\\d{2}$", "type": "string" }, "reason": { "$ref": "#/components/schemas/EorWorkersContractsContractIdOffboardingPostRequestBodyContentMultipartFormDataSchemaDataReason", "description": "The reason for the employee's resignation" }, "reason_detail": { "description": "Additional details explaining the resignation reason", "maxLength": 500, "type": "string" }, "signature": { "description": "Employee signature", "type": "string" }, "supporting_documents": { "description": "This field allows for uploading multiple files at once. Includes common image formats (JPG, JPEG, PNG, HEIC) and PDF documents.", "format": "binary", "type": "string" } }, "required": [ "reason", "signature", "desired_end_date" ], "title": "EorWorkersContractsContractIdOffboardingPostRequestBodyContentMultipartFormDataSchemaData", "type": "object" }, "EorWorkersContractsContractIdOffboardingPostRequestBodyContentMultipartFormDataSchemaDataReason": { "description": "The reason for the employee's resignation", "enum": [ "EMPLOYEE_IS_MOVING_TO_ANOTHER_COUNTRY", "MOVING_EMPLOYEE_TO_INTERNAL_ENTITY", "MOVING_EMPLOYEE_TO_DEEL_PEO", "EMPLOYEE_FOUND_ANOTHER_JOB", "EMPLOYEE_NOT_HAPPY_WITH_BENEFITS", "EMPLOYEE_NOT_HAPPY_WITH_SALARY", "EMPLOYEE_NOT_HAPPY_WITH_THE_ROLE", "EMPLOYEE_NOT_HAPPY_WITH_COMPANY_CULTURE", "EMPLOYEE_NOT_HAPPY_WITH_DEEL", "EMPLOYEE_PROJECT_ENDED", "EMPLOYEE_SWITCHING_TO_OTHER_EOR_PROVIDER", "EMPLOYEE_LEFT_ROLE_FOR_PERSONAL_MATTERS", "EMPLOYEE_MOVING_FROM_EOR_TO_CONTRACTOR_OR_FREELANCE", "WORKER_TYPE_CHANGE", "PREFERRED_NOT_TO_SAY" ], "title": "EorWorkersContractsContractIdOffboardingPostRequestBodyContentMultipartFormDataSchemaDataReason", "type": "string" }, "EorWorkersContractsContractIdOffboardingPostResponsesContentApplicationJsonSchemaData": { "properties": { "contract_id": { "description": "The unique identifier of the employee contract.", "type": "string" }, "created_at": { "description": "The date and time the offboarding request was created", "format": "date-time", "type": "string" }, "desired_end_date": { "description": "The desired end date. If the date is not provided, it will be selected by HRX the closest date possible", "format": "date-time", "type": [ "string", "null" ] }, "documents": { "$ref": "#/components/schemas/EorWorkersContractsContractIdOffboardingPostResponsesContentApplicationJsonSchemaDataDocuments", "description": "Document management structure for termination workflow including review processes and supporting documents" }, "end_date": { "description": "The definitive contract end date", "format": "date-time", "type": [ "string", "null" ] }, "id": { "description": "The unique identifier of the offboarding request", "format": "uuid", "type": "string" }, "is_sensitive": { "description": "Indicates if the offboarding request is sensitive. This is used to restrict access to the request only to the requester and the HRX team.", "type": "boolean" }, "request_data": { "oneOf": [ { "$ref": "#/components/schemas/EorWorkersContractsContractIdOffboardingPostResponsesContentApplicationJsonSchemaDataRequestData" }, { "type": "null" } ] }, "updated_at": { "description": "The date and time the offboarding request was updated", "format": "date-time", "type": "string" } }, "title": "EorWorkersContractsContractIdOffboardingPostResponsesContentApplicationJsonSchemaData", "type": "object" }, "EorWorkersContractsContractIdOffboardingPostResponsesContentApplicationJsonSchemaDataDocuments": { "description": "Document management structure for termination workflow including review processes and supporting documents", "properties": { "offboarding": { "description": "Document set shared that requires client or employee review", "items": { "$ref": "#/components/schemas/EorWorkersContractsContractIdOffboardingPostResponsesContentApplicationJsonSchemaDataDocumentsOffboardingItems" }, "type": "array" }, "supporting": { "items": { "$ref": "#/components/schemas/EorWorkersContractsContractIdOffboardingPostResponsesContentApplicationJsonSchemaDataDocumentsSupportingItems" }, "type": "array" } }, "required": [ "supporting", "offboarding" ], "title": "EorWorkersContractsContractIdOffboardingPostResponsesContentApplicationJsonSchemaDataDocuments", "type": "object" }, "EorWorkersContractsContractIdOffboardingPostResponsesContentApplicationJsonSchemaDataDocumentsOffboardingItems": { "properties": { "created_at": { "description": "The date and time the document set was created", "format": "date-time", "type": "string" }, "files": { "items": { "$ref": "#/components/schemas/EorWorkersContractsContractIdOffboardingPostResponsesContentApplicationJsonSchemaDataDocumentsOffboardingItemsFilesItems" }, "type": "array" }, "id": { "description": "The unique identifier of the document set shared with the employee.", "format": "uuid", "type": "string" }, "is_employee_notification_required": { "description": "Indicates if the employee should be notified about this document review", "type": "boolean" }, "notification_instructions": { "description": "HTML instructions for the reviewer notification", "type": [ "string", "null" ] }, "reviewed_at": { "description": "The date and time when the document was reviewed", "format": "date-time", "type": [ "string", "null" ] }, "reviewed_by": { "description": "The name of the reviewer for this document. If the reviewer is not an employee, it will be the name of the client", "type": [ "string", "null" ] }, "reviewer_feedback": { "description": "Feedback provided by the reviewer", "type": [ "string", "null" ] }, "reviewer_type": { "$ref": "#/components/schemas/EorWorkersContractsContractIdOffboardingPostResponsesContentApplicationJsonSchemaDataDocumentsOffboardingItemsReviewerType", "description": "The type of reviewer for this document" }, "status": { "$ref": "#/components/schemas/EorWorkersContractsContractIdOffboardingPostResponsesContentApplicationJsonSchemaDataDocumentsOffboardingItemsStatus", "description": "The current status of the document review" }, "updated_at": { "description": "The date and time the document set was updated", "format": "date-time", "type": "string" } }, "required": [ "files", "status", "reviewer_type", "is_employee_notification_required" ], "title": "EorWorkersContractsContractIdOffboardingPostResponsesContentApplicationJsonSchemaDataDocumentsOffboardingItems", "type": "object" }, "EorWorkersContractsContractIdOffboardingPostResponsesContentApplicationJsonSchemaDataDocumentsOffboardingItemsFilesItems": { "properties": { "created_at": { "description": "The date and time the file was created", "format": "date-time", "type": "string" }, "id": { "description": "The unique identifier of the file", "format": "cuid", "type": "string" }, "name": { "description": "The name of the file", "type": "string" }, "type": { "description": "The type/extension of the file", "type": "string" }, "updated_at": { "description": "The date and time the file was updated", "format": "date-time", "type": "string" } }, "required": [ "id", "name", "type", "created_at" ], "title": "EorWorkersContractsContractIdOffboardingPostResponsesContentApplicationJsonSchemaDataDocumentsOffboardingItemsFilesItems", "type": "object" }, "EorWorkersContractsContractIdOffboardingPostResponsesContentApplicationJsonSchemaDataDocumentsOffboardingItemsReviewerType": { "description": "The type of reviewer for this document", "enum": [ "CLIENT", "EMPLOYEE" ], "title": "EorWorkersContractsContractIdOffboardingPostResponsesContentApplicationJsonSchemaDataDocumentsOffboardingItemsReviewerType", "type": "string" }, "EorWorkersContractsContractIdOffboardingPostResponsesContentApplicationJsonSchemaDataDocumentsOffboardingItemsStatus": { "description": "The current status of the document review", "enum": [ "AWAITING_REVIEW", "AWAITING_FEEDBACK", "FEEDBACK_PROVIDED", "APPROVED", "CHANGES_REQUESTED_BY_CLIENT", "CHANGES_REQUESTED_BY_EMPLOYEE", "WAIVED_REVIEW", "NOT_RESPONDED", "CANCELLED" ], "title": "EorWorkersContractsContractIdOffboardingPostResponsesContentApplicationJsonSchemaDataDocumentsOffboardingItemsStatus", "type": "string" }, "EorWorkersContractsContractIdOffboardingPostResponsesContentApplicationJsonSchemaDataDocumentsSupportingItems": { "properties": { "created_at": { "description": "The date and time the file was created", "format": "date-time", "type": "string" }, "id": { "description": "The unique identifier of the file", "format": "cuid", "type": "string" }, "is_additional_supporting_document": { "description": "Indicates if this is an additional supporting document added after the initial submission", "type": "boolean" }, "name": { "description": "The name of the file", "type": "string" }, "type": { "description": "The type/extension of the file", "type": "string" }, "updated_at": { "description": "The date and time the file was updated", "format": "date-time", "type": "string" } }, "required": [ "id", "name", "type", "created_at", "updated_at", "is_additional_supporting_document" ], "title": "EorWorkersContractsContractIdOffboardingPostResponsesContentApplicationJsonSchemaDataDocumentsSupportingItems", "type": "object" }, "EorWorkersContractsContractIdOffboardingPostResponsesContentApplicationJsonSchemaDataRequestData": { "properties": { "desired_end_date": { "description": "The desired end date. If the date is not provided, it will be selected by HRX the closest date possible", "format": "date", "type": [ "string", "null" ] }, "eligible_for_rehire": { "description": "Parameter to inform whether it would be possible for the client to hire the employee again", "oneOf": [ { "$ref": "#/components/schemas/EorWorkersContractsContractIdOffboardingPostResponsesContentApplicationJsonSchemaDataRequestDataEligibleForRehire" }, { "type": "null" } ] }, "eligible_for_rehire_reason": { "description": "Describe if the option DONT_KNOW was selected on eligible_for_rehire", "type": [ "string", "null" ] }, "end_date": { "description": "The definitive contract end date", "format": "date-time", "type": [ "string", "null" ] }, "reason": { "$ref": "#/components/schemas/EorWorkersContractsContractIdOffboardingPostResponsesContentApplicationJsonSchemaDataRequestDataReason", "description": "The reason for the termination" }, "reason_detail": { "description": "Optional field to describe the reason behind the resignation request", "type": [ "string", "null" ] }, "used_time_off": { "$ref": "#/components/schemas/EorWorkersContractsContractIdOffboardingPostResponsesContentApplicationJsonSchemaDataRequestDataUsedTimeOff", "description": "Time-off usage data including policy information and tracking periods" } }, "title": "EorWorkersContractsContractIdOffboardingPostResponsesContentApplicationJsonSchemaDataRequestData", "type": "object" }, "EorWorkersContractsContractIdOffboardingPostResponsesContentApplicationJsonSchemaDataRequestDataEligibleForRehire": { "description": "Parameter to inform whether it would be possible for the client to hire the employee again", "enum": [ "YES", "NO", "DONT_KNOW" ], "title": "EorWorkersContractsContractIdOffboardingPostResponsesContentApplicationJsonSchemaDataRequestDataEligibleForRehire", "type": "string" }, "EorWorkersContractsContractIdOffboardingPostResponsesContentApplicationJsonSchemaDataRequestDataReason": { "description": "The reason for the termination", "enum": [ "STATUS_CHANGE", "RELOCATION", "COMPENSATION", "RETIREMENT", "JOB_ABANDONMENT", "WORK_RELATED", "PERSONAL", "OTHER_OPPORTUNITY", "NON_RENEWAL", "PROBATION", "ASSIGNMENT_ENDED", "POSITION_ELIMINATION", "FORCE_REDUCTION", "DEATH", "FOR_CAUSE", "PERFORMANCE", "MEDICAL", "PERFORMANCE_ISSUES", "ATTENDANCE_ISSUES", "REORGANIZATION_DOWNSIZING_BUDGET_OR_REDUCTION_OF_WORKFORCE", "ROLE_BECAME_REDUNDANT_OR_ROLE_CHANGED", "OFFER_WAS_REVOKED", "EXITING_THE_MARKET", "NO_LONGER_WISH_TO_WORK_WITH_DEEL", "COMPANY_ACQUIRED", "STEALING", "MISCONDUCT", "FALSIFYING", "HARASSMENT", "VIOLENCE", "REORGANIZATION_DOWNSIZING_BUDGET_OR_REDUCTION_OF_WORKFORCE_OR_ROLE_BECAME_REDUNDANT_OR_ROLE_CHANGED", "UNAUTHORIZED_ABSENCES_OR_LACK_OF_ATTENDANCE", "STANDARD_RESELLER_PRACTICE", "MOVING_EMPLOYEE_TO_INTERNAL_ENTITY", "MOVING_EMPLOYEE_TO_DEEL_PEO", "OTHER" ], "title": "EorWorkersContractsContractIdOffboardingPostResponsesContentApplicationJsonSchemaDataRequestDataReason", "type": "string" }, "EorWorkersContractsContractIdOffboardingPostResponsesContentApplicationJsonSchemaDataRequestDataUsedTimeOff": { "description": "Time-off usage data including policy information and tracking periods", "properties": { "additional_details": { "oneOf": [ { "$ref": "#/components/schemas/EorWorkersContractsContractIdOffboardingPostResponsesContentApplicationJsonSchemaDataRequestDataUsedTimeOffAdditionalDetails" }, { "type": "null" } ] }, "is_deel_pto_confirmed": { "description": "Indicates whether the PTO allocation has been confirmed by Deel's system", "type": "boolean" }, "time_offs": { "items": { "$ref": "#/components/schemas/EorWorkersContractsContractIdOffboardingPostResponsesContentApplicationJsonSchemaDataRequestDataUsedTimeOffTimeOffsItems" }, "type": "array" } }, "required": [ "time_offs", "is_deel_pto_confirmed" ], "title": "EorWorkersContractsContractIdOffboardingPostResponsesContentApplicationJsonSchemaDataRequestDataUsedTimeOff", "type": "object" }, "EorWorkersContractsContractIdOffboardingPostResponsesContentApplicationJsonSchemaDataRequestDataUsedTimeOffAdditionalDetails": { "properties": { "last_updated_at": { "description": "The date and time when the time-off data was last updated", "format": "date-time", "type": [ "string", "null" ] }, "notes": { "description": "Additional notes or comments about the time-off data", "type": [ "string", "null" ] }, "updated_by": { "description": "The person or system that last updated the time-off data", "type": [ "string", "null" ] } }, "title": "EorWorkersContractsContractIdOffboardingPostResponsesContentApplicationJsonSchemaDataRequestDataUsedTimeOffAdditionalDetails", "type": "object" }, "EorWorkersContractsContractIdOffboardingPostResponsesContentApplicationJsonSchemaDataRequestDataUsedTimeOffTimeOffsItems": { "properties": { "policy_type": { "description": "The type of time-off policy", "type": "string" }, "scheduled_until_end_date": { "description": "The amount of time off scheduled until the end date of the current tracking period", "format": "double", "type": "number" }, "tracking_periods": { "items": { "$ref": "#/components/schemas/EorWorkersContractsContractIdOffboardingPostResponsesContentApplicationJsonSchemaDataRequestDataUsedTimeOffTimeOffsItemsTrackingPeriodsItems" }, "type": "array" }, "unit": { "$ref": "#/components/schemas/EorWorkersContractsContractIdOffboardingPostResponsesContentApplicationJsonSchemaDataRequestDataUsedTimeOffTimeOffsItemsUnit", "description": "The unit of measurement for time off tracking" } }, "required": [ "unit", "policy_type", "tracking_periods", "scheduled_until_end_date" ], "title": "EorWorkersContractsContractIdOffboardingPostResponsesContentApplicationJsonSchemaDataRequestDataUsedTimeOffTimeOffsItems", "type": "object" }, "EorWorkersContractsContractIdOffboardingPostResponsesContentApplicationJsonSchemaDataRequestDataUsedTimeOffTimeOffsItemsTrackingPeriodsItems": { "properties": { "end_date": { "description": "The end date of the tracking period", "format": "date-time", "type": "string" }, "start_date": { "description": "The start date of the tracking period", "format": "date-time", "type": "string" }, "used": { "description": "The amount of time off used in this tracking period", "format": "double", "type": "number" } }, "required": [ "used", "end_date", "start_date" ], "title": "EorWorkersContractsContractIdOffboardingPostResponsesContentApplicationJsonSchemaDataRequestDataUsedTimeOffTimeOffsItemsTrackingPeriodsItems", "type": "object" }, "EorWorkersContractsContractIdOffboardingPostResponsesContentApplicationJsonSchemaDataRequestDataUsedTimeOffTimeOffsItemsUnit": { "description": "The unit of measurement for time off tracking", "enum": [ "BUSINESS_DAY", "CALENDAR_DAY", "HOUR" ], "title": "EorWorkersContractsContractIdOffboardingPostResponsesContentApplicationJsonSchemaDataRequestDataUsedTimeOffTimeOffsItemsUnit", "type": "string" }, "EorWorkersContractsContractIdOffboardingPostResponsesContentApplicationJsonSchemaErrorsItems": { "properties": { "code": { "description": "Error code of the handler which produced the returned error", "type": "string" }, "field": { "description": "The field name where error occurred (null for server errors)", "type": "string" }, "message": { "description": "Description of the returned error", "type": "string" } }, "title": "EorWorkersContractsContractIdOffboardingPostResponsesContentApplicationJsonSchemaErrorsItems", "type": "object" }, "EorWorkersContractsContractIdOffboardingResignationLetterGetResponsesContentApplicationJsonSchemaErrorsItems": { "properties": { "code": { "description": "Error code of the handler which produced the returned error", "type": "string" }, "field": { "description": "The field name where error occurred (null for server errors)", "type": "string" }, "message": { "description": "Description of the returned error", "type": "string" } }, "title": "EorWorkersContractsContractIdOffboardingResignationLetterGetResponsesContentApplicationJsonSchemaErrorsItems", "type": "object" }, "EorWorkersContractsContractIdOffboardingResignationLetterSignPostRequestBodyContentApplicationJsonSchemaData": { "properties": { "signature": { "description": "Employee signature", "type": "string" } }, "title": "EorWorkersContractsContractIdOffboardingResignationLetterSignPostRequestBodyContentApplicationJsonSchemaData", "type": "object" }, "EorWorkersContractsContractIdOffboardingResignationLetterSignPostResponsesContentApplicationJsonSchemaData": { "properties": { "contract_id": { "description": "The unique identifier of the employee contract.", "type": "string" }, "created_at": { "description": "The date and time the offboarding request was created", "format": "date-time", "type": "string" }, "desired_end_date": { "description": "The desired end date. If the date is not provided, it will be selected by HRX the closest date possible", "format": "date-time", "type": [ "string", "null" ] }, "documents": { "$ref": "#/components/schemas/EorWorkersContractsContractIdOffboardingResignationLetterSignPostResponsesContentApplicationJsonSchemaDataDocuments", "description": "Document management structure for termination workflow including review processes and supporting documents" }, "end_date": { "description": "The definitive contract end date", "format": "date-time", "type": [ "string", "null" ] }, "id": { "description": "The unique identifier of the offboarding request", "format": "uuid", "type": "string" }, "is_sensitive": { "description": "Indicates if the offboarding request is sensitive. This is used to restrict access to the request only to the requester and the HRX team.", "type": "boolean" }, "request_data": { "oneOf": [ { "$ref": "#/components/schemas/EorWorkersContractsContractIdOffboardingResignationLetterSignPostResponsesContentApplicationJsonSchemaDataRequestData" }, { "type": "null" } ] }, "updated_at": { "description": "The date and time the offboarding request was updated", "format": "date-time", "type": "string" } }, "title": "EorWorkersContractsContractIdOffboardingResignationLetterSignPostResponsesContentApplicationJsonSchemaData", "type": "object" }, "EorWorkersContractsContractIdOffboardingResignationLetterSignPostResponsesContentApplicationJsonSchemaDataDocuments": { "description": "Document management structure for termination workflow including review processes and supporting documents", "properties": { "offboarding": { "description": "Document set shared that requires client or employee review", "items": { "$ref": "#/components/schemas/EorWorkersContractsContractIdOffboardingResignationLetterSignPostResponsesContentApplicationJsonSchemaDataDocumentsOffboardingItems" }, "type": "array" }, "resignation_letter": { "oneOf": [ { "$ref": "#/components/schemas/EorWorkersContractsContractIdOffboardingResignationLetterSignPostResponsesContentApplicationJsonSchemaDataDocumentsResignationLetter" }, { "type": "null" } ] }, "supporting": { "items": { "$ref": "#/components/schemas/EorWorkersContractsContractIdOffboardingResignationLetterSignPostResponsesContentApplicationJsonSchemaDataDocumentsSupportingItems" }, "type": "array" } }, "required": [ "supporting", "offboarding" ], "title": "EorWorkersContractsContractIdOffboardingResignationLetterSignPostResponsesContentApplicationJsonSchemaDataDocuments", "type": "object" }, "EorWorkersContractsContractIdOffboardingResignationLetterSignPostResponsesContentApplicationJsonSchemaDataDocumentsOffboardingItems": { "properties": { "created_at": { "description": "The date and time the document set was created", "format": "date-time", "type": "string" }, "files": { "items": { "$ref": "#/components/schemas/EorWorkersContractsContractIdOffboardingResignationLetterSignPostResponsesContentApplicationJsonSchemaDataDocumentsOffboardingItemsFilesItems" }, "type": "array" }, "id": { "description": "The unique identifier of the document set shared with the employee.", "format": "uuid", "type": "string" }, "is_employee_notification_required": { "description": "Indicates if the employee should be notified about this document review", "type": "boolean" }, "notification_instructions": { "description": "HTML instructions for the reviewer notification", "type": [ "string", "null" ] }, "reviewed_at": { "description": "The date and time when the document was reviewed", "format": "date-time", "type": [ "string", "null" ] }, "reviewed_by": { "description": "The name of the reviewer for this document. If the reviewer is not an employee, it will be the name of the client", "type": [ "string", "null" ] }, "reviewer_feedback": { "description": "Feedback provided by the reviewer", "type": [ "string", "null" ] }, "reviewer_type": { "$ref": "#/components/schemas/EorWorkersContractsContractIdOffboardingResignationLetterSignPostResponsesContentApplicationJsonSchemaDataDocumentsOffboardingItemsReviewerType", "description": "The type of reviewer for this document" }, "status": { "$ref": "#/components/schemas/EorWorkersContractsContractIdOffboardingResignationLetterSignPostResponsesContentApplicationJsonSchemaDataDocumentsOffboardingItemsStatus", "description": "The current status of the document review" }, "updated_at": { "description": "The date and time the document set was updated", "format": "date-time", "type": "string" } }, "required": [ "files", "status", "reviewer_type", "is_employee_notification_required" ], "title": "EorWorkersContractsContractIdOffboardingResignationLetterSignPostResponsesContentApplicationJsonSchemaDataDocumentsOffboardingItems", "type": "object" }, "EorWorkersContractsContractIdOffboardingResignationLetterSignPostResponsesContentApplicationJsonSchemaDataDocumentsOffboardingItemsFilesItems": { "properties": { "created_at": { "description": "The date and time the file was created", "format": "date-time", "type": "string" }, "id": { "description": "The unique identifier of the file", "format": "cuid", "type": "string" }, "name": { "description": "The name of the file", "type": "string" }, "type": { "description": "The type/extension of the file", "type": "string" }, "updated_at": { "description": "The date and time the file was updated", "format": "date-time", "type": "string" } }, "required": [ "id", "name", "type", "created_at" ], "title": "EorWorkersContractsContractIdOffboardingResignationLetterSignPostResponsesContentApplicationJsonSchemaDataDocumentsOffboardingItemsFilesItems", "type": "object" }, "EorWorkersContractsContractIdOffboardingResignationLetterSignPostResponsesContentApplicationJsonSchemaDataDocumentsOffboardingItemsReviewerType": { "description": "The type of reviewer for this document", "enum": [ "CLIENT", "EMPLOYEE" ], "title": "EorWorkersContractsContractIdOffboardingResignationLetterSignPostResponsesContentApplicationJsonSchemaDataDocumentsOffboardingItemsReviewerType", "type": "string" }, "EorWorkersContractsContractIdOffboardingResignationLetterSignPostResponsesContentApplicationJsonSchemaDataDocumentsOffboardingItemsStatus": { "description": "The current status of the document review", "enum": [ "AWAITING_REVIEW", "AWAITING_FEEDBACK", "FEEDBACK_PROVIDED", "APPROVED", "CHANGES_REQUESTED_BY_CLIENT", "CHANGES_REQUESTED_BY_EMPLOYEE", "WAIVED_REVIEW", "NOT_RESPONDED", "CANCELLED" ], "title": "EorWorkersContractsContractIdOffboardingResignationLetterSignPostResponsesContentApplicationJsonSchemaDataDocumentsOffboardingItemsStatus", "type": "string" }, "EorWorkersContractsContractIdOffboardingResignationLetterSignPostResponsesContentApplicationJsonSchemaDataDocumentsResignationLetter": { "properties": { "created_at": { "description": "The date and time the resignation letter was created", "format": "date-time", "type": "string" }, "id": { "description": "The unique identifier of the resignation letter", "format": "uuid", "type": "string" }, "signature": { "description": "The signature of the resignation letter", "type": [ "string", "null" ] }, "signed_at": { "description": "The date and time when the resignation letter was signed", "format": "date-time", "type": [ "string", "null" ] }, "updated_at": { "description": "The date and time the resignation letter was updated", "format": "date-time", "type": "string" } }, "title": "EorWorkersContractsContractIdOffboardingResignationLetterSignPostResponsesContentApplicationJsonSchemaDataDocumentsResignationLetter", "type": "object" }, "EorWorkersContractsContractIdOffboardingResignationLetterSignPostResponsesContentApplicationJsonSchemaDataDocumentsSupportingItems": { "properties": { "created_at": { "description": "The date and time the file was created", "format": "date-time", "type": "string" }, "id": { "description": "The unique identifier of the file", "format": "cuid", "type": "string" }, "is_additional_supporting_document": { "description": "Indicates if this is an additional supporting document added after the initial submission", "type": "boolean" }, "name": { "description": "The name of the file", "type": "string" }, "type": { "description": "The type/extension of the file", "type": "string" }, "updated_at": { "description": "The date and time the file was updated", "format": "date-time", "type": "string" } }, "required": [ "id", "name", "type", "created_at", "updated_at", "is_additional_supporting_document" ], "title": "EorWorkersContractsContractIdOffboardingResignationLetterSignPostResponsesContentApplicationJsonSchemaDataDocumentsSupportingItems", "type": "object" }, "EorWorkersContractsContractIdOffboardingResignationLetterSignPostResponsesContentApplicationJsonSchemaDataRequestData": { "properties": { "desired_end_date": { "description": "The desired end date. If the date is not provided, it will be selected by HRX the closest date possible", "format": "date", "type": [ "string", "null" ] }, "eligible_for_rehire": { "description": "Parameter to inform whether it would be possible for the client to hire the employee again", "oneOf": [ { "$ref": "#/components/schemas/EorWorkersContractsContractIdOffboardingResignationLetterSignPostResponsesContentApplicationJsonSchemaDataRequestDataEligibleForRehire" }, { "type": "null" } ] }, "eligible_for_rehire_reason": { "description": "Describe if the option DONT_KNOW was selected on eligible_for_rehire", "type": [ "string", "null" ] }, "end_date": { "description": "The definitive contract end date", "format": "date-time", "type": [ "string", "null" ] }, "reason": { "$ref": "#/components/schemas/EorWorkersContractsContractIdOffboardingResignationLetterSignPostResponsesContentApplicationJsonSchemaDataRequestDataReason", "description": "The reason for the termination" }, "reason_detail": { "description": "Optional field to describe the reason behind the resignation request", "type": [ "string", "null" ] }, "used_time_off": { "$ref": "#/components/schemas/EorWorkersContractsContractIdOffboardingResignationLetterSignPostResponsesContentApplicationJsonSchemaDataRequestDataUsedTimeOff", "description": "Time-off usage data including policy information and tracking periods" } }, "title": "EorWorkersContractsContractIdOffboardingResignationLetterSignPostResponsesContentApplicationJsonSchemaDataRequestData", "type": "object" }, "EorWorkersContractsContractIdOffboardingResignationLetterSignPostResponsesContentApplicationJsonSchemaDataRequestDataEligibleForRehire": { "description": "Parameter to inform whether it would be possible for the client to hire the employee again", "enum": [ "YES", "NO", "DONT_KNOW" ], "title": "EorWorkersContractsContractIdOffboardingResignationLetterSignPostResponsesContentApplicationJsonSchemaDataRequestDataEligibleForRehire", "type": "string" }, "EorWorkersContractsContractIdOffboardingResignationLetterSignPostResponsesContentApplicationJsonSchemaDataRequestDataReason": { "description": "The reason for the termination", "enum": [ "STATUS_CHANGE", "RELOCATION", "COMPENSATION", "RETIREMENT", "JOB_ABANDONMENT", "WORK_RELATED", "PERSONAL", "OTHER_OPPORTUNITY", "NON_RENEWAL", "PROBATION", "ASSIGNMENT_ENDED", "POSITION_ELIMINATION", "FORCE_REDUCTION", "DEATH", "FOR_CAUSE", "PERFORMANCE", "MEDICAL", "PERFORMANCE_ISSUES", "ATTENDANCE_ISSUES", "REORGANIZATION_DOWNSIZING_BUDGET_OR_REDUCTION_OF_WORKFORCE", "ROLE_BECAME_REDUNDANT_OR_ROLE_CHANGED", "OFFER_WAS_REVOKED", "EXITING_THE_MARKET", "NO_LONGER_WISH_TO_WORK_WITH_DEEL", "COMPANY_ACQUIRED", "STEALING", "MISCONDUCT", "FALSIFYING", "HARASSMENT", "VIOLENCE", "REORGANIZATION_DOWNSIZING_BUDGET_OR_REDUCTION_OF_WORKFORCE_OR_ROLE_BECAME_REDUNDANT_OR_ROLE_CHANGED", "UNAUTHORIZED_ABSENCES_OR_LACK_OF_ATTENDANCE", "STANDARD_RESELLER_PRACTICE", "MOVING_EMPLOYEE_TO_INTERNAL_ENTITY", "MOVING_EMPLOYEE_TO_DEEL_PEO", "OTHER" ], "title": "EorWorkersContractsContractIdOffboardingResignationLetterSignPostResponsesContentApplicationJsonSchemaDataRequestDataReason", "type": "string" }, "EorWorkersContractsContractIdOffboardingResignationLetterSignPostResponsesContentApplicationJsonSchemaDataRequestDataUsedTimeOff": { "description": "Time-off usage data including policy information and tracking periods", "properties": { "additional_details": { "oneOf": [ { "$ref": "#/components/schemas/EorWorkersContractsContractIdOffboardingResignationLetterSignPostResponsesContentApplicationJsonSchemaDataRequestDataUsedTimeOffAdditionalDetails" }, { "type": "null" } ] }, "is_deel_pto_confirmed": { "description": "Indicates whether the PTO allocation has been confirmed by Deel's system", "type": "boolean" }, "time_offs": { "items": { "$ref": "#/components/schemas/EorWorkersContractsContractIdOffboardingResignationLetterSignPostResponsesContentApplicationJsonSchemaDataRequestDataUsedTimeOffTimeOffsItems" }, "type": "array" } }, "required": [ "time_offs", "is_deel_pto_confirmed" ], "title": "EorWorkersContractsContractIdOffboardingResignationLetterSignPostResponsesContentApplicationJsonSchemaDataRequestDataUsedTimeOff", "type": "object" }, "EorWorkersContractsContractIdOffboardingResignationLetterSignPostResponsesContentApplicationJsonSchemaDataRequestDataUsedTimeOffAdditionalDetails": { "properties": { "last_updated_at": { "description": "The date and time when the time-off data was last updated", "format": "date-time", "type": [ "string", "null" ] }, "notes": { "description": "Additional notes or comments about the time-off data", "type": [ "string", "null" ] }, "updated_by": { "description": "The person or system that last updated the time-off data", "type": [ "string", "null" ] } }, "title": "EorWorkersContractsContractIdOffboardingResignationLetterSignPostResponsesContentApplicationJsonSchemaDataRequestDataUsedTimeOffAdditionalDetails", "type": "object" }, "EorWorkersContractsContractIdOffboardingResignationLetterSignPostResponsesContentApplicationJsonSchemaDataRequestDataUsedTimeOffTimeOffsItems": { "properties": { "policy_type": { "description": "The type of time-off policy", "type": "string" }, "scheduled_until_end_date": { "description": "The amount of time off scheduled until the end date of the current tracking period", "format": "double", "type": "number" }, "tracking_periods": { "items": { "$ref": "#/components/schemas/EorWorkersContractsContractIdOffboardingResignationLetterSignPostResponsesContentApplicationJsonSchemaDataRequestDataUsedTimeOffTimeOffsItemsTrackingPeriodsItems" }, "type": "array" }, "unit": { "$ref": "#/components/schemas/EorWorkersContractsContractIdOffboardingResignationLetterSignPostResponsesContentApplicationJsonSchemaDataRequestDataUsedTimeOffTimeOffsItemsUnit", "description": "The unit of measurement for time off tracking" } }, "required": [ "unit", "policy_type", "tracking_periods", "scheduled_until_end_date" ], "title": "EorWorkersContractsContractIdOffboardingResignationLetterSignPostResponsesContentApplicationJsonSchemaDataRequestDataUsedTimeOffTimeOffsItems", "type": "object" }, "EorWorkersContractsContractIdOffboardingResignationLetterSignPostResponsesContentApplicationJsonSchemaDataRequestDataUsedTimeOffTimeOffsItemsTrackingPeriodsItems": { "properties": { "end_date": { "description": "The end date of the tracking period", "format": "date-time", "type": "string" }, "start_date": { "description": "The start date of the tracking period", "format": "date-time", "type": "string" }, "used": { "description": "The amount of time off used in this tracking period", "format": "double", "type": "number" } }, "required": [ "used", "end_date", "start_date" ], "title": "EorWorkersContractsContractIdOffboardingResignationLetterSignPostResponsesContentApplicationJsonSchemaDataRequestDataUsedTimeOffTimeOffsItemsTrackingPeriodsItems", "type": "object" }, "EorWorkersContractsContractIdOffboardingResignationLetterSignPostResponsesContentApplicationJsonSchemaDataRequestDataUsedTimeOffTimeOffsItemsUnit": { "description": "The unit of measurement for time off tracking", "enum": [ "BUSINESS_DAY", "CALENDAR_DAY", "HOUR" ], "title": "EorWorkersContractsContractIdOffboardingResignationLetterSignPostResponsesContentApplicationJsonSchemaDataRequestDataUsedTimeOffTimeOffsItemsUnit", "type": "string" }, "EorWorkersContractsContractIdOffboardingResignationLetterSignPostResponsesContentApplicationJsonSchemaErrorsItems": { "properties": { "code": { "description": "Error code of the handler which produced the returned error", "type": "string" }, "field": { "description": "The field name where error occurred (null for server errors)", "type": "string" }, "message": { "description": "Description of the returned error", "type": "string" } }, "title": "EorWorkersContractsContractIdOffboardingResignationLetterSignPostResponsesContentApplicationJsonSchemaErrorsItems", "type": "object" }, "EorWorkersContractsContractIdSignaturesPostRequestBodyContentApplicationJsonSchemaData": { "properties": { "signature": { "description": "Signature of employee.", "minLength": 2, "type": "string" }, "version": { "description": "Optional version of the Employment Agreement to be signed. If informed and in the case of a mismatch, the API will return an error.", "maxLength": 20, "minLength": 20, "type": "string" } }, "required": [ "signature" ], "title": "EorWorkersContractsContractIdSignaturesPostRequestBodyContentApplicationJsonSchemaData", "type": "object" }, "EorWorkersContractsContractIdSignaturesPostResponsesContentApplicationJsonSchemaData": { "properties": { "created": { "type": "boolean" } }, "required": [ "created" ], "title": "EorWorkersContractsContractIdSignaturesPostResponsesContentApplicationJsonSchemaData", "type": "object" }, "EorWorkersContractsContractIdSignaturesPostResponsesContentApplicationJsonSchemaErrorsItems": { "properties": { "message": { "description": "The error message", "type": "string" } }, "title": "EorWorkersContractsContractIdSignaturesPostResponsesContentApplicationJsonSchemaErrorsItems", "type": "object" }, "EorWorkersContractsContractIdSignaturesPostResponsesContentApplicationJsonSchemaRequest": { "properties": { "api_req_id": { "description": "The request ID of the failed request", "type": "string" }, "docs": { "description": "A link to the official documentation for the requested endpoint resource", "type": "string" }, "method": { "description": "The HTTP method of the failed request", "type": "string" }, "source": { "description": "The source handler which produced the returned error", "type": "string" }, "status": { "description": "The status code of the response", "format": "double", "type": "number" }, "url": { "description": "The relative URL of the failed request", "type": "string" } }, "title": "EorWorkersContractsContractIdSignaturesPostResponsesContentApplicationJsonSchemaRequest", "type": "object" }, "EorWorkersResignationsGetParametersStatus": { "enum": [ "AWAITING_SIGNATURE", "SIGNED" ], "title": "EorWorkersResignationsGetParametersStatus", "type": "string" }, "EorWorkersResignationsGetResponsesContentApplicationJsonSchemaDataItems": { "properties": { "contract_id": { "description": "The unique identifier of the employee contract.", "type": "string" }, "created_at": { "description": "The date and time the resignation was created", "format": "date-time", "type": "string" }, "desired_end_date": { "description": "The desired end date of the resignation", "format": "date-time", "type": [ "string", "null" ] }, "end_date": { "description": "The confirmed end date of the resignation", "format": "date-time", "type": [ "string", "null" ] }, "id": { "description": "The unique identifier of the resignation", "format": "uuid", "type": "string" }, "resignation_letter": { "oneOf": [ { "$ref": "#/components/schemas/EorWorkersResignationsGetResponsesContentApplicationJsonSchemaDataItemsResignationLetter" }, { "type": "null" } ] }, "status": { "$ref": "#/components/schemas/EorWorkersResignationsGetResponsesContentApplicationJsonSchemaDataItemsStatus", "description": "The status of the resignation" }, "updated_at": { "description": "The date and time the resignation was updated", "format": "date-time", "type": "string" } }, "required": [ "id", "status", "end_date", "created_at", "updated_at", "contract_id", "desired_end_date", "resignation_letter" ], "title": "EorWorkersResignationsGetResponsesContentApplicationJsonSchemaDataItems", "type": "object" }, "EorWorkersResignationsGetResponsesContentApplicationJsonSchemaDataItemsResignationLetter": { "properties": { "created_at": { "description": "The date and time the resignation letter was created", "format": "date-time", "type": "string" }, "id": { "description": "The unique identifier of the resignation letter", "format": "uuid", "type": "string" }, "signature": { "description": "The signature of the resignation letter", "type": [ "string", "null" ] }, "signed_at": { "description": "The date and time the resignation letter was signed", "format": "date-time", "type": [ "string", "null" ] }, "status": { "$ref": "#/components/schemas/EorWorkersResignationsGetResponsesContentApplicationJsonSchemaDataItemsResignationLetterStatus", "description": "The status of the resignation letter" }, "updated_at": { "description": "The date and time the resignation letter was updated", "format": "date-time", "type": "string" } }, "required": [ "id", "status", "signature", "signed_at", "created_at", "updated_at" ], "title": "EorWorkersResignationsGetResponsesContentApplicationJsonSchemaDataItemsResignationLetter", "type": "object" }, "EorWorkersResignationsGetResponsesContentApplicationJsonSchemaDataItemsResignationLetterStatus": { "description": "The status of the resignation letter", "enum": [ "AWAITING_SIGNATURE", "SIGNED" ], "title": "EorWorkersResignationsGetResponsesContentApplicationJsonSchemaDataItemsResignationLetterStatus", "type": "string" }, "EorWorkersResignationsGetResponsesContentApplicationJsonSchemaDataItemsStatus": { "description": "The status of the resignation", "enum": [ "CREATED", "COMPLETED", "AWAITING_REFUND", "PROCESSING", "AWAITING_TRIAGE", "AWAITING_PROCESSING", "CANCELLED", "AWAITING_PTO" ], "title": "EorWorkersResignationsGetResponsesContentApplicationJsonSchemaDataItemsStatus", "type": "string" }, "EorWorkersResignationsGetResponsesContentApplicationJsonSchemaErrorsItems": { "properties": { "code": { "description": "Error code of the handler which produced the returned error", "type": "string" }, "field": { "description": "The field name where error occurred (null for server errors)", "type": "string" }, "message": { "description": "Description of the returned error", "type": "string" } }, "title": "EorWorkersResignationsGetResponsesContentApplicationJsonSchemaErrorsItems", "type": "object" }, "EorWorkersTaxDocumentsGetResponsesContentApplicationJsonSchemaDataItems": { "properties": { "country": { "description": "Country of the tax document", "type": "string" }, "id": { "description": "Id of the tax document", "type": "string" }, "type": { "description": "Type of the tax document", "type": "string" }, "url": { "description": "URL of the tax document", "type": "string" }, "year": { "description": "Year of tax document", "format": "double", "type": "number" } }, "title": "EorWorkersTaxDocumentsGetResponsesContentApplicationJsonSchemaDataItems", "type": "object" }, "EorWorkersWorkerIdPayslipsGetResponsesContentApplicationJsonSchemaDataItems": { "properties": { "from": { "description": "Start date of the payment period.", "format": "date", "type": "string" }, "id": { "description": "Unique identifier for the payslip record.", "type": "string" }, "status": { "description": "Status of the payslip (e.g., 'Pending', 'Processed').", "type": "string" }, "to": { "description": "End date of the payment period.", "format": "date", "type": [ "string", "null" ] } }, "required": [ "id", "to", "from", "status" ], "title": "EorWorkersWorkerIdPayslipsGetResponsesContentApplicationJsonSchemaDataItems", "type": "object" }, "EorWorkersWorkerIdPayslipsPayslipIdDownloadGetResponsesContentApplicationJsonSchemaData": { "properties": { "url": { "description": "The URL to download the payslip PDF.", "type": "string" } }, "required": [ "url" ], "title": "EorWorkersWorkerIdPayslipsPayslipIdDownloadGetResponsesContentApplicationJsonSchemaData", "type": "object" }, "EquitiesTokensTaxEventsPostRequestBodyContentApplicationJsonSchemaData": { "properties": { "benefit_in_kind_local_currency": { "description": "The benefit in kind in the local currency", "title": "float", "type": "string" }, "contract_id": { "description": "The unique identifier of the contract of the employee who received the equity/token grant", "type": "string" }, "equity_grant_id": { "description": "The unique identifier of the equity/token grant - optional in case you don't have remove the property", "type": "string" }, "event_date": { "description": "The date of the event", "format": "date", "type": "string" }, "exercise_price": { "description": "The price at which the equity/token was exercised", "title": "float", "type": "string" }, "fx_rate": { "description": "The exchange rate used to convert the local currency to the payroll currency", "title": "float", "type": "string" }, "gross_value": { "description": "The gross value of the equity/token grant", "title": "float", "type": "string" }, "method_of_tax_coverage": { "$ref": "#/components/schemas/EquitiesTokensTaxEventsPostRequestBodyContentApplicationJsonSchemaDataMethodOfTaxCoverage", "description": "The method used to cover the taxes" }, "payroll_currency": { "description": "The currency in which the payroll is processed", "type": "string" }, "plan_currency": { "description": "The currency in which the equity/token grant was issued", "type": "string" }, "quantity_exercised_or_released": { "description": "The quantity of equity/token that was exercised or released", "title": "float", "type": "string" }, "quantity_remaining": { "description": "The quantity of equity/token that remains", "title": "float", "type": "string" }, "quantity_withheld_or_sold": { "description": "The quantity of equity/token that was withheld or sold", "title": "float", "type": "string" }, "sale_price": { "description": "The price at which the equity/token was sold", "title": "float", "type": "string" }, "settlement_date": { "description": "The date of the settlement", "format": "date", "type": "string" }, "tax_jurisdiction": { "description": "The tax jurisdiction in which the equity/token grant was issued", "type": "string" }, "tax_rate": { "description": "The tax rate applied to the benefit in kind", "title": "float", "type": "string" }, "taxable_gain_or_loss": { "description": "The taxable gain or loss", "title": "float", "type": "string" }, "total_exercise_price": { "description": "The total exercise price", "title": "float", "type": "string" }, "total_taxes_withheld": { "description": "The total amount of taxes withheld", "title": "float", "type": "string" }, "transaction_fees": { "description": "The fees associated with the transaction", "title": "float", "type": "string" }, "unit_fmv": { "description": "The fair market value of the equity/token grant at the time of the event", "title": "float", "type": "string" }, "withheld_tax_local_currency": { "description": "The tax withheld in the local currency", "title": "float", "type": "string" } }, "required": [ "fx_rate", "contract_id", "plan_currency", "settlement_date", "payroll_currency", "tax_jurisdiction", "taxable_gain_or_loss", "total_taxes_withheld", "method_of_tax_coverage", "withheld_tax_local_currency", "benefit_in_kind_local_currency" ], "title": "EquitiesTokensTaxEventsPostRequestBodyContentApplicationJsonSchemaData", "type": "object" }, "EquitiesTokensTaxEventsPostRequestBodyContentApplicationJsonSchemaDataMethodOfTaxCoverage": { "description": "The method used to cover the taxes", "enum": [ "AD_HOC", "BIK_REPORTING_ONLY", "BIK_WITHHOLDING_AT_SOURCE_CLIENT", "BIK_WITHHOLDING_AT_SOURCE_CLIENT_REVERSE", "BIK_WITHHOLDING_GROSSED_UP_BONUS", "BIK_WITHHOLDING_NET_SETTLEMENT", "BIK_WITHHOLDING_SALARY_DEDUCTION", "BIK_WITHHOLDING_WORKER", "NO_BIK_NO_WITHHOLDING" ], "title": "EquitiesTokensTaxEventsPostRequestBodyContentApplicationJsonSchemaDataMethodOfTaxCoverage", "type": "string" }, "EquitiesTokensTaxEventsPostResponsesContentApplicationJsonSchemaData": { "properties": { "created_at": { "description": "the date and time when the equity/token tax event was created", "format": "date-time", "type": "string" }, "id": { "description": "the id of the equity/token tax event generated", "format": "uuid", "type": "string" } }, "title": "EquitiesTokensTaxEventsPostResponsesContentApplicationJsonSchemaData", "type": "object" }, "EquitiesTokensTaxEventsPostResponsesContentApplicationJsonSchemaErrorsItems": { "properties": { "code": { "description": "return code error", "type": "string" }, "field": { "description": "field that caused the error", "type": "string" }, "message": { "description": "description of the error", "type": "string" } }, "title": "EquitiesTokensTaxEventsPostResponsesContentApplicationJsonSchemaErrorsItems", "type": "object" }, "EquityAmortizationsGetResponsesContentApplicationJsonSchemaDataItems": { "properties": { "actual_performance_factor": { "description": "Actual performance factor applied, as reported by the ingested file. Sparsely populated (measured: 5 of 11,863 real rows).", "format": "double", "type": [ "number", "null" ] }, "award_type": { "description": "Award type (e.g. Restricted Stock - Standard), as reported by the ingested file.", "type": "string" }, "before_period_total_expense_accrued": { "description": "Before Period > Total Expense Accrued, as reported by the ingested file.", "format": "double", "type": [ "number", "null" ] }, "before_period_total_shares_accrued": { "description": "Before Period > Total Shares Accrued, as reported by the ingested file.", "format": "double", "type": [ "number", "null" ] }, "before_period_unamortized_expense": { "description": "Before Period > Unamortized Expense, as reported by the ingested file.", "format": "double", "type": [ "number", "null" ] }, "before_period_unamortized_shares": { "description": "Before Period > Unamortized Shares, as reported by the ingested file.", "format": "double", "type": [ "number", "null" ] }, "created_at": { "description": "Timestamp this record was first ingested.", "format": "date-time", "type": "string" }, "employee_grant_number": { "description": "Shareworks grant number for this employee, as reported by the ingested file.", "type": "string" }, "employee_number": { "description": "Shareworks employee number, as reported by the ingested file. The intended join key for this record. Some values are non-numeric for legacy or masked records.", "type": "string" }, "estimated_performance_factor": { "description": "Estimated performance factor, as reported by the ingested file.", "format": "double", "type": [ "number", "null" ] }, "fair_value_per_share": { "description": "Fair market value per share, as reported by the ingested file.", "format": "double", "type": [ "number", "null" ] }, "grant_date": { "description": "Date the grant was issued, as reported by the ingested file.", "format": "date", "type": "string" }, "grant_name": { "description": "Grant name, as reported by the ingested file.", "type": "string" }, "grant_price": { "description": "Strike/grant price per unit, as reported by the ingested file.", "format": "double", "type": [ "number", "null" ] }, "hris_profile_id": { "description": "Matched HRIS profile id, if employee_number could be resolved to one. Null when unmatched, or when employee_number is non-numeric or blank.", "type": [ "integer", "null" ] }, "id": { "description": "The unique identifier of the record.", "format": "uuid", "type": "string" }, "last_seen_dataset_id": { "description": "Identifier of the most recent ingested dataset in which this record still appeared. Null for records ingested before dataset tracking began.", "format": "uuid", "type": [ "string", "null" ] }, "occurrence_index": { "description": "Discriminates several records the source file reports for the same natural key. Starts at 1, in the order the rows appear in the file.", "type": "integer" }, "period_end_life_to_date_total_expense_accrued": { "description": "Period End > Life-to-Date Total Expense Accrued, as reported by the ingested file.", "format": "double", "type": [ "number", "null" ] }, "period_end_life_to_date_total_shares_accrued": { "description": "Period End > Life-to-Date Total Shares Accrued, as reported by the ingested file.", "format": "double", "type": [ "number", "null" ] }, "period_end_unamortized_expense": { "description": "Period End > Unamortized Expense, as reported by the ingested file.", "format": "double", "type": [ "number", "null" ] }, "period_end_unamortized_shares": { "description": "Period End > Unamortized Shares, as reported by the ingested file.", "format": "double", "type": [ "number", "null" ] }, "period_end_weighted_avg_remaining_recognition_period": { "description": "Period End > Weighted Average Remaining Recognition Period, as reported by the ingested file.", "format": "double", "type": [ "number", "null" ] }, "plan_name": { "description": "Equity plan name, as reported by the ingested file.", "type": "string" }, "row_hash": { "description": "Hash of the reported values on this record. Compare it between syncs to detect a change without diffing every field.", "type": "string" }, "source_file_id": { "description": "Identifier of the ingested Shareworks report file this record was last upserted from.", "format": "uuid", "type": "string" }, "total_estimated_expense": { "description": "Total estimated expense, as reported by the ingested file.", "format": "double", "type": [ "number", "null" ] }, "total_estimated_shares_to_expense": { "description": "Total estimated shares to expense, as reported by the ingested file.", "format": "double", "type": [ "number", "null" ] }, "updated_at": { "description": "Timestamp this record was last upserted, for incremental sync.", "format": "date-time", "type": "string" }, "valuation_status": { "description": "Valuation status (e.g. Approved, Do Not Expense), as reported by the ingested file.", "type": [ "string", "null" ] }, "within_period_agg_grant_price_of_shares_early_exercised_vested": { "description": "Within Period > Aggregate Grant Price of Shares Early Exercised Vested, as reported by the ingested file. Sparsely populated.", "format": "double", "type": [ "number", "null" ] }, "within_period_agg_grant_price_of_shares_exercised_in_period": { "description": "Within Period > Aggregate Grant Price of Shares Exercised in Period, as reported by the ingested file.", "format": "double", "type": [ "number", "null" ] }, "within_period_expense_fv_of_shares_early_exercised_vested": { "description": "Within Period > Expense (Fair Value) of Shares Early Exercised Vested, as reported by the ingested file. Sparsely populated.", "format": "double", "type": [ "number", "null" ] }, "within_period_expense_fv_of_shares_exercised_released": { "description": "Within Period > Expense (Fair Value) of Shares Exercised / Released, as reported by the ingested file.", "format": "double", "type": [ "number", "null" ] }, "within_period_expense_fv_of_shares_vesting": { "description": "Within Period > Expense (Fair Value) of Shares Vesting, as reported by the ingested file.", "format": "double", "type": [ "number", "null" ] }, "within_period_shares_early_exercised_vested": { "description": "Within Period > Shares Early Exercised Vested, as reported by the ingested file. Sparsely populated (measured: 13 of 11,863 real rows).", "format": "double", "type": [ "number", "null" ] }, "within_period_shares_exercised_released": { "description": "Within Period > Shares Exercised / Released, as reported by the ingested file.", "format": "double", "type": [ "number", "null" ] }, "within_period_shares_vesting": { "description": "Within Period > Shares Vesting, as reported by the ingested file.", "format": "double", "type": [ "number", "null" ] }, "within_period_total_expense_accrued": { "description": "Within Period > Total Expense Accrued, as reported by the ingested file.", "format": "double", "type": [ "number", "null" ] }, "within_period_total_shares_accrued": { "description": "Within Period > Total Shares Accrued, as reported by the ingested file.", "format": "double", "type": [ "number", "null" ] } }, "required": [ "id", "row_hash", "plan_name", "award_type", "created_at", "grant_date", "grant_name", "updated_at", "grant_price", "source_file_id", "employee_number", "hris_profile_id", "occurrence_index", "valuation_status", "fair_value_per_share", "last_seen_dataset_id", "employee_grant_number", "total_estimated_expense", "actual_performance_factor", "estimated_performance_factor", "within_period_shares_vesting", "period_end_unamortized_shares", "period_end_unamortized_expense", "before_period_unamortized_shares", "before_period_unamortized_expense", "total_estimated_shares_to_expense", "before_period_total_shares_accrued", "within_period_total_shares_accrued", "before_period_total_expense_accrued", "within_period_total_expense_accrued", "within_period_shares_exercised_released", "within_period_expense_fv_of_shares_vesting", "within_period_shares_early_exercised_vested", "period_end_life_to_date_total_shares_accrued", "period_end_life_to_date_total_expense_accrued", "period_end_weighted_avg_remaining_recognition_period", "within_period_expense_fv_of_shares_exercised_released", "within_period_expense_fv_of_shares_early_exercised_vested", "within_period_agg_grant_price_of_shares_exercised_in_period", "within_period_agg_grant_price_of_shares_early_exercised_vested" ], "title": "EquityAmortizationsGetResponsesContentApplicationJsonSchemaDataItems", "type": "object" }, "EquityAmortizationsGetResponsesContentApplicationJsonSchemaErrorsItems": { "properties": { "code": { "description": "Machine-readable error code", "maxLength": 255, "type": "string" }, "field": { "description": "Field that caused the error, if applicable.", "type": [ "string", "null" ] }, "message": { "description": "Human-readable explanation", "type": "string" } }, "required": [ "message" ], "title": "EquityAmortizationsGetResponsesContentApplicationJsonSchemaErrorsItems", "type": "object" }, "EquityAwardsGetResponsesContentApplicationJsonSchemaDataItems": { "properties": { "allow_early_exercise": { "description": "Whether early exercise is allowed, as reported by the ingested file (verbatim text, e.g. Yes/No).", "type": [ "string", "null" ] }, "award_name": { "description": "Award template name, as reported by the ingested file.", "type": [ "string", "null" ] }, "compensation_benefit": { "description": "Compensation benefit amount, as reported by the ingested file.", "format": "double", "type": [ "number", "null" ] }, "created_at": { "description": "Timestamp this record was first ingested.", "format": "date-time", "type": "string" }, "employee_number": { "description": "Shareworks employee number, as reported by the ingested file. The intended join key for this record. Some values are non-numeric for legacy or masked records.", "type": "string" }, "employee_type": { "description": "Employee type (e.g. Employee, Consultant), as reported by the ingested file.", "type": [ "string", "null" ] }, "federal_exemption": { "description": "Federal exemption, as reported by the ingested file.", "type": [ "string", "null" ] }, "federal_exemption_date": { "description": "Federal exemption date, as reported by the ingested file.", "type": [ "string", "null" ] }, "first_name": { "description": "Employee first name, as reported by the ingested file.", "type": [ "string", "null" ] }, "fmv_per_share_at_grant_date": { "description": "Fair market value per share at grant date, as reported by the ingested file.", "format": "double", "type": [ "number", "null" ] }, "grant_date": { "description": "Date the grant was issued, as reported by the ingested file.", "format": "date", "type": "string" }, "grant_name": { "description": "Grant name, as reported by the ingested file.", "type": "string" }, "grant_price": { "description": "Strike/grant price per unit, as reported by the ingested file.", "format": "double", "type": [ "number", "null" ] }, "grant_quantity": { "description": "Number of shares/units granted, as reported by the ingested file.", "format": "double", "type": [ "number", "null" ] }, "hris_profile_id": { "description": "Matched HRIS profile id, if employee_number could be resolved to one. Null when unmatched, or when employee_number is non-numeric or blank.", "type": [ "integer", "null" ] }, "id": { "description": "The unique identifier of the record.", "format": "uuid", "type": "string" }, "is_under_rule_701": { "description": "Whether the grant is under Rule 701, as reported by the ingested file (verbatim text, e.g. Yes/No).", "type": [ "string", "null" ] }, "last_name": { "description": "Employee last name, as reported by the ingested file.", "type": [ "string", "null" ] }, "last_seen_dataset_id": { "description": "Identifier of the most recent ingested dataset in which this record still appeared. Null for records ingested before dataset tracking began.", "format": "uuid", "type": [ "string", "null" ] }, "occurrence_index": { "description": "Discriminates several records the source file reports for the same natural key. Starts at 1, in the order the rows appear in the file.", "type": "integer" }, "plan_name": { "description": "Equity plan name, as reported by the ingested file.", "type": [ "string", "null" ] }, "row_hash": { "description": "Hash of the reported values on this record. Compare it between syncs to detect a change without diffing every field.", "type": "string" }, "source_file_id": { "description": "Identifier of the ingested Shareworks report file this record was last upserted from.", "format": "uuid", "type": "string" }, "state_exemption": { "description": "State exemption, as reported by the ingested file.", "type": [ "string", "null" ] }, "state_exemption_date": { "description": "State exemption date, as reported by the ingested file.", "type": [ "string", "null" ] }, "state_of_exemption": { "description": "State of exemption, as reported by the ingested file.", "type": [ "string", "null" ] }, "total_exercise_price": { "description": "Total exercise price for the grant, as reported by the ingested file.", "format": "double", "type": [ "number", "null" ] }, "total_fmv": { "description": "Total fair market value of the grant, as reported by the ingested file.", "format": "double", "type": [ "number", "null" ] }, "updated_at": { "description": "Timestamp this record was last upserted, for incremental sync.", "format": "date-time", "type": "string" }, "vest_schedule_name": { "description": "Vesting schedule name, as reported by the ingested file.", "type": [ "string", "null" ] }, "vesting_start_date": { "description": "Vesting start date, as reported by the ingested file.", "format": "date", "type": [ "string", "null" ] } }, "required": [ "id", "row_hash", "last_name", "plan_name", "total_fmv", "award_name", "created_at", "first_name", "grant_date", "grant_name", "updated_at", "grant_price", "employee_type", "grant_quantity", "source_file_id", "employee_number", "hris_profile_id", "state_exemption", "occurrence_index", "federal_exemption", "is_under_rule_701", "state_of_exemption", "vest_schedule_name", "vesting_start_date", "allow_early_exercise", "compensation_benefit", "last_seen_dataset_id", "state_exemption_date", "total_exercise_price", "federal_exemption_date", "fmv_per_share_at_grant_date" ], "title": "EquityAwardsGetResponsesContentApplicationJsonSchemaDataItems", "type": "object" }, "EquityAwardsGetResponsesContentApplicationJsonSchemaErrorsItems": { "properties": { "code": { "description": "Machine-readable error code", "maxLength": 255, "type": "string" }, "field": { "description": "Field that caused the error, if applicable.", "type": [ "string", "null" ] }, "message": { "description": "Human-readable explanation", "type": "string" } }, "required": [ "message" ], "title": "EquityAwardsGetResponsesContentApplicationJsonSchemaErrorsItems", "type": "object" }, "EquityExercisePostResponsesContentApplicationJsonSchemaData": { "properties": { "created_at": { "description": "ISO 8601 timestamp when the equity exercise request was created.", "format": "date-time", "type": "string" }, "id": { "description": "Unique identifier of the equity exercise request.", "format": "uuid", "type": "string" }, "status": { "description": "The initial status of the newly created equity exercise request.", "type": "string" }, "updated_at": { "description": "ISO 8601 timestamp when the equity exercise request was last updated.", "format": "date-time", "type": "string" } }, "required": [ "id", "status", "created_at", "updated_at" ], "title": "EquityExercisePostResponsesContentApplicationJsonSchemaData", "type": "object" }, "EquityExercisePostResponsesContentApplicationJsonSchemaErrorsItems": { "properties": { "message": { "description": "General error description for logging and debugging.", "type": "string" } }, "required": [ "message" ], "title": "EquityExercisePostResponsesContentApplicationJsonSchemaErrorsItems", "type": "object" }, "EquityExercisePublicIdPatchResponsesContentApplicationJsonSchemaErrorsItems": { "properties": { "message": { "description": "General error description for logging and debugging.", "type": "string" } }, "required": [ "message" ], "title": "EquityExercisePublicIdPatchResponsesContentApplicationJsonSchemaErrorsItems", "type": "object" }, "EquityExercisesGetResponsesContentApplicationJsonSchemaDataItems": { "properties": { "cost_of_options": { "description": "Total cost paid to exercise the options.", "format": "double", "type": [ "number", "null" ] }, "currency": { "description": "ISO 4217 currency code for the monetary fields on this record.", "type": "string" }, "employee_grant_number": { "description": "Shareworks grant number for this employee.", "type": "string" }, "employee_number": { "description": "Shareworks employee number, as reported by the ingested file. The intended join key for this record.", "type": "string" }, "exercise_date": { "description": "Date the exercise took place.", "format": "date", "type": "string" }, "exercise_fmv": { "description": "Total fair market value of the exercised shares.", "format": "double", "type": [ "number", "null" ] }, "exercise_gain": { "description": "Gain realized on exercise (FMV minus cost).", "format": "double", "type": [ "number", "null" ] }, "exercise_price": { "description": "Strike/exercise price per unit.", "format": "double", "type": [ "number", "null" ] }, "fmv_per_unit": { "description": "Fair market value per unit at exercise.", "format": "double", "type": [ "number", "null" ] }, "grant_date": { "description": "Date the grant was issued.", "format": "date", "type": [ "string", "null" ] }, "grant_name": { "description": "Grant name, as reported by the ingested file.", "type": [ "string", "null" ] }, "grant_type": { "description": "Grant type (e.g. ISO, NSO, RSU), as reported by the ingested file.", "type": [ "string", "null" ] }, "hris_profile_id": { "description": "Matched HRIS profile id, if employee_number could be resolved to one. Null when unmatched.", "type": [ "integer", "null" ] }, "id": { "description": "The unique identifier of the exercise record.", "format": "uuid", "type": "string" }, "plan_name": { "description": "Equity plan name, as reported by the ingested file.", "type": [ "string", "null" ] }, "shares_exercised_total": { "description": "Total number of shares exercised.", "format": "double", "type": [ "number", "null" ] }, "shares_exercised_unvested": { "description": "Number of unvested shares exercised.", "format": "double", "type": [ "number", "null" ] }, "shares_exercised_vested": { "description": "Number of vested shares exercised.", "format": "double", "type": [ "number", "null" ] }, "updated_at": { "description": "Timestamp this record was last upserted, for incremental sync.", "format": "date-time", "type": "string" } }, "title": "EquityExercisesGetResponsesContentApplicationJsonSchemaDataItems", "type": "object" }, "EquityExercisesGetResponsesContentApplicationJsonSchemaErrorsItems": { "properties": { "code": { "description": "Machine-readable error code", "maxLength": 255, "type": "string" }, "field": { "description": "Field that caused the error, if applicable.", "type": [ "string", "null" ] }, "message": { "description": "Human-readable explanation", "type": "string" } }, "required": [ "message" ], "title": "EquityExercisesGetResponsesContentApplicationJsonSchemaErrorsItems", "type": "object" }, "EquityExpensesGetResponsesContentApplicationJsonSchemaDataItems": { "properties": { "actual_forfeitures": { "description": "Actual forfeited share count, as reported by the ingested file.", "format": "double", "type": "number" }, "actual_performance_factor": { "description": "Actual performance factor applied, as reported by the ingested file.", "format": "double", "type": [ "number", "null" ] }, "award_type": { "description": "Award type (e.g. Restricted Stock - Standard), as reported by the ingested file.", "type": "string" }, "base_expense": { "description": "Base expense amount, as reported by the ingested file.", "format": "double", "type": [ "number", "null" ] }, "base_shares": { "description": "Base share count for this grant, as reported by the ingested file.", "format": "double", "type": "number" }, "created_at": { "description": "Timestamp this record was first ingested.", "format": "date-time", "type": "string" }, "employee_grant_number": { "description": "Shareworks grant number for this employee, as reported by the ingested file.", "type": "string" }, "employee_number": { "description": "Shareworks employee number, as reported by the ingested file. The intended join key for this record. Some values are non-numeric for legacy or masked records.", "type": "string" }, "estimated_forfeitures": { "description": "Estimated forfeited share count, as reported by the ingested file.", "format": "double", "type": [ "number", "null" ] }, "estimated_performance_factor": { "description": "Estimated performance factor, as reported by the ingested file.", "format": "double", "type": [ "number", "null" ] }, "factor_shares": { "description": "Shares resulting from the performance factor, as reported by the ingested file.", "format": "double", "type": [ "number", "null" ] }, "fair_value_per_share": { "description": "Fair market value per share, as reported by the ingested file.", "format": "double", "type": [ "number", "null" ] }, "forfeiture_rate_percent": { "description": "Forfeiture rate, stored as the percent NUMBER itself (e.g. 44.336788 means 44.336788%), NOT a fraction. See parseShareworksPercent.", "format": "double", "type": [ "number", "null" ] }, "grant_date": { "description": "Date the grant was issued, as reported by the ingested file.", "format": "date", "type": "string" }, "grant_name": { "description": "Grant name, as reported by the ingested file.", "type": "string" }, "grant_price": { "description": "Strike/grant price per unit, as reported by the ingested file.", "format": "double", "type": [ "number", "null" ] }, "hris_profile_id": { "description": "Matched HRIS profile id, if employee_number could be resolved to one. Null when unmatched, or when employee_number is non-numeric or blank.", "type": [ "integer", "null" ] }, "id": { "description": "The unique identifier of the record.", "format": "uuid", "type": "string" }, "last_seen_dataset_id": { "description": "Identifier of the most recent ingested dataset in which this record still appeared. Null for records ingested before dataset tracking began.", "format": "uuid", "type": [ "string", "null" ] }, "occurrence_index": { "description": "Discriminates several records the source file reports for the same natural key. Starts at 1, in the order the rows appear in the file.", "type": "integer" }, "plan_name": { "description": "Equity plan name, as reported by the ingested file.", "type": "string" }, "row_hash": { "description": "Hash of the reported values on this record. Compare it between syncs to detect a change without diffing every field.", "type": "string" }, "source_file_id": { "description": "Identifier of the ingested Shareworks report file this record was last upserted from.", "format": "uuid", "type": "string" }, "total_actual_expense_to_accrue": { "description": "Total actual expense to accrue, as reported by the ingested file.", "format": "double", "type": [ "number", "null" ] }, "total_actual_shares_to_expense": { "description": "Total actual shares to expense, as reported by the ingested file.", "format": "double", "type": "number" }, "total_estimated_expense": { "description": "Total estimated expense, as reported by the ingested file.", "format": "double", "type": [ "number", "null" ] }, "total_estimated_shares_to_expense": { "description": "Total estimated shares to expense, as reported by the ingested file.", "format": "double", "type": [ "number", "null" ] }, "unvested_repurchased": { "description": "Unvested shares repurchased, as reported by the ingested file.", "format": "double", "type": [ "number", "null" ] }, "updated_at": { "description": "Timestamp this record was last upserted, for incremental sync.", "format": "date-time", "type": "string" }, "valuation_status": { "description": "Valuation status (e.g. Approved, Do Not Expense), as reported by the ingested file.", "type": [ "string", "null" ] } }, "required": [ "id", "row_hash", "plan_name", "award_type", "created_at", "grant_date", "grant_name", "updated_at", "base_shares", "grant_price", "base_expense", "factor_shares", "source_file_id", "employee_number", "hris_profile_id", "occurrence_index", "valuation_status", "actual_forfeitures", "fair_value_per_share", "last_seen_dataset_id", "unvested_repurchased", "employee_grant_number", "estimated_forfeitures", "forfeiture_rate_percent", "total_estimated_expense", "actual_performance_factor", "estimated_performance_factor", "total_actual_expense_to_accrue", "total_actual_shares_to_expense", "total_estimated_shares_to_expense" ], "title": "EquityExpensesGetResponsesContentApplicationJsonSchemaDataItems", "type": "object" }, "EquityExpensesGetResponsesContentApplicationJsonSchemaErrorsItems": { "properties": { "code": { "description": "Machine-readable error code", "maxLength": 255, "type": "string" }, "field": { "description": "Field that caused the error, if applicable.", "type": [ "string", "null" ] }, "message": { "description": "Human-readable explanation", "type": "string" } }, "required": [ "message" ], "title": "EquityExpensesGetResponsesContentApplicationJsonSchemaErrorsItems", "type": "object" }, "EquityGrantsGetResponsesContentApplicationJsonSchemaDataItems": { "properties": { "additional_grant_requirements_and_restrictions": { "description": "Free-text additional requirements or restrictions on the grant", "type": [ "string", "null" ] }, "cliff_period": { "description": "The cliff period in months before any shares vest", "format": "double", "type": [ "number", "null" ] }, "equity_grant_type": { "description": "The type of equity instrument granted", "type": [ "string", "null" ] }, "equity_grant_type_name": { "description": "The organization's custom label for the grant type", "type": [ "string", "null" ] }, "exercise_price": { "description": "The per-unit price at which the option or warrant can be exercised, in exercise price currency", "format": "double", "type": [ "number", "null" ] }, "exercise_price_currency": { "description": "The currency of the exercise price", "type": [ "string", "null" ] }, "fmv_when_granted": { "description": "The fair market value of the underlying instrument at grant time", "format": "double", "type": [ "number", "null" ] }, "grant_currency": { "description": "The currency of the grant value", "type": [ "string", "null" ] }, "grant_date": { "description": "The date the grant was issued", "format": "date", "type": [ "string", "null" ] }, "grant_name": { "description": "The name of the grant", "type": [ "string", "null" ] }, "grant_status": { "description": "The lifecycle status of the grant (e.g. GRANTED, PENDING_APPROVAL)", "type": [ "string", "null" ] }, "hris_profile": { "$ref": "#/components/schemas/EquityGrantsGetResponsesContentApplicationJsonSchemaDataItemsHrisProfile", "description": "Profile information for the EOR worker who holds the grant" }, "id": { "description": "The unique identifier of the equity grant", "format": "uuid", "type": "string" }, "option_expiration": { "description": "The date the option expires", "format": "date", "type": [ "string", "null" ] }, "quantity": { "description": "The total quantity granted", "format": "double", "type": [ "number", "null" ] }, "reference_id": { "description": "The human-readable reference number of the grant", "format": "double", "type": [ "number", "null" ] }, "source": { "description": "The system of record the grant originated from", "type": [ "string", "null" ] }, "tax_events": { "description": "The tax events reported against this grant", "items": { "$ref": "#/components/schemas/EquityGrantsGetResponsesContentApplicationJsonSchemaDataItemsTaxEventsItems" }, "type": "array" }, "tranches": { "description": "The number of vesting tranches", "format": "double", "type": [ "number", "null" ] }, "value": { "description": "The total grant value at the time of issuance, in grant currency", "format": "double", "type": [ "number", "null" ] }, "vested_events": { "description": "The individual vesting events recorded for this grant", "items": { "$ref": "#/components/schemas/EquityGrantsGetResponsesContentApplicationJsonSchemaDataItemsVestedEventsItems" }, "type": "array" }, "vested_quantity": { "description": "The quantity vested so far", "format": "double", "type": [ "number", "null" ] }, "vesting_length": { "description": "The total vesting length in months", "format": "double", "type": [ "number", "null" ] }, "vesting_start_date": { "description": "The date vesting begins", "format": "date", "type": [ "string", "null" ] } }, "title": "EquityGrantsGetResponsesContentApplicationJsonSchemaDataItems", "type": "object" }, "EquityGrantsGetResponsesContentApplicationJsonSchemaDataItemsHrisProfile": { "description": "Profile information for the EOR worker who holds the grant", "properties": { "email": { "description": "The worker's email address", "format": "email", "type": "string" }, "first_name": { "description": "The worker's first name", "type": [ "string", "null" ] }, "hiring_type": { "description": "The worker's engagement type within Deel (e.g. employee, contractor)", "type": [ "string", "null" ] }, "id": { "description": "The unique identifier of the worker", "format": "uuid", "type": "string" }, "job_title": { "description": "The worker's job title", "type": [ "string", "null" ] }, "last_name": { "description": "The worker's last name", "type": [ "string", "null" ] }, "middle_name": { "description": "The worker's middle name", "type": [ "string", "null" ] }, "pic_url": { "description": "URL of the worker's profile picture", "type": [ "string", "null" ] } }, "title": "EquityGrantsGetResponsesContentApplicationJsonSchemaDataItemsHrisProfile", "type": "object" }, "EquityGrantsGetResponsesContentApplicationJsonSchemaDataItemsTaxEventsItems": { "properties": { "actual_payroll_cycle_cutoff": { "description": "The cutoff date of the actual payroll cycle", "format": "date-time", "type": [ "string", "null" ] }, "actual_payroll_cycle_end": { "description": "The end date of the actual payroll cycle", "format": "date", "type": [ "string", "null" ] }, "actual_payroll_cycle_id": { "description": "The unique identifier of the actual payroll cycle", "format": "uuid", "type": [ "string", "null" ] }, "actual_payroll_cycle_start": { "description": "The start date of the actual payroll cycle", "format": "date", "type": [ "string", "null" ] }, "archived_at": { "description": "The date and time the tax event was archived", "format": "date-time", "type": [ "string", "null" ] }, "benefit_in_kind_local_currency": { "description": "The benefit-in-kind (BIK) value reported to payroll, expressed in the worker's local payroll currency", "type": [ "string", "null" ] }, "contract_completion_date": { "description": "The completion date of the associated contract", "format": "date-time", "type": [ "string", "null" ] }, "contract_id": { "description": "The unique identifier of the contract associated with the tax event", "type": "string" }, "contract_status": { "description": "The lifecycle status of the associated worker contract (e.g. in_progress, completed, cancelled)", "type": "string" }, "country": { "description": "The ISO 3166-1 alpha-2 country code of the worker's employment country", "type": [ "string", "null" ] }, "created_at": { "description": "The date and time the tax event was created", "format": "date-time", "type": [ "string", "null" ] }, "created_by_email": { "description": "The email of the user who created the tax event", "format": "email", "type": [ "string", "null" ] }, "email": { "description": "The worker's email address", "format": "email", "type": "string" }, "equity_service_status": { "description": "The equity service enrollment status for the worker (ONBOARDED, OFFBOARDED, NOT_ONBOARDED, NOT_ELIGIBLE, MORE_INFO_REQUIRED)", "type": "string" }, "event_date": { "description": "The date of the tax event", "format": "date", "type": [ "string", "null" ] }, "exercise_price": { "description": "The price at which the equity was exercised", "type": [ "string", "null" ] }, "expected_payroll_cycle_cutoff": { "description": "The cutoff date of the expected payroll cycle", "format": "date-time", "type": [ "string", "null" ] }, "expected_payroll_cycle_end": { "description": "The end date of the expected payroll cycle", "format": "date", "type": [ "string", "null" ] }, "expected_payroll_cycle_id": { "description": "The unique identifier of the expected payroll cycle", "format": "uuid", "type": [ "string", "null" ] }, "expected_payroll_cycle_start": { "description": "The start date of the expected payroll cycle", "format": "date", "type": [ "string", "null" ] }, "external_id": { "description": "An external system identifier for the worker, such as an ID from a cap-table provider", "type": [ "string", "null" ] }, "first_name": { "description": "The worker's first name", "type": [ "string", "null" ] }, "fx_rate": { "description": "The exchange rate used to convert local currency to payroll currency", "type": [ "string", "null" ] }, "grant_date": { "description": "The date the associated grant was issued", "format": "date", "type": [ "string", "null" ] }, "grant_id": { "description": "The unique identifier of the associated grant", "format": "uuid", "type": [ "string", "null" ] }, "grant_reference_id": { "description": "The human-readable reference number of the associated grant", "format": "double", "type": [ "number", "null" ] }, "grant_type": { "description": "The equity instrument type of the associated grant (e.g. RSU, NSO, ISO)", "type": [ "string", "null" ] }, "gross_value": { "description": "The gross value of the equity event, calculated as unit FMV multiplied by quantity exercised or released", "type": [ "string", "null" ] }, "hris_profile_id": { "description": "The unique identifier of the worker who holds the grant", "format": "uuid", "type": "string" }, "id": { "description": "The unique identifier of the tax event", "format": "uuid", "type": "string" }, "instrument_type": { "description": "The type of equity instrument (e.g. RSU, NSO, ISO, PHANTOM, SARS)", "type": [ "string", "null" ] }, "is_archived": { "description": "Whether the tax event has been archived", "type": [ "boolean", "null" ] }, "last_name": { "description": "The worker's last name", "type": [ "string", "null" ] }, "method_of_tax_coverage": { "description": "How the benefit-in-kind (BIK) tax on this equity event is collected. BIK_WITHHOLDING_* values indicate the employer withholds tax from payroll; the suffix identifies the mechanism (e.g. at-source deduction, salary deduction, net settlement, grossed-up bonus). BIK_REPORTING_ONLY reports the BIK without withholding. NO_BIK_NO_WITHHOLDING applies when no taxable benefit arises. AD_HOC covers special cases outside the standard methods.", "type": [ "string", "null" ] }, "middle_name": { "description": "The worker's middle name", "type": [ "string", "null" ] }, "note": { "description": "A free-text note attached to the tax event", "type": [ "string", "null" ] }, "organization_id": { "description": "The unique identifier of the organization", "format": "uuid", "type": "string" }, "organization_name": { "description": "The name of the organization", "type": [ "string", "null" ] }, "payroll_currency": { "description": "The currency in which payroll is processed", "type": [ "string", "null" ] }, "pic_url": { "description": "URL of the worker's profile picture", "type": [ "string", "null" ] }, "plan_currency": { "description": "The currency in which the equity plan was issued", "type": [ "string", "null" ] }, "quantity_exercised_or_released": { "description": "The quantity of equity exercised or released", "type": [ "string", "null" ] }, "quantity_remaining": { "description": "The quantity of equity remaining", "type": [ "string", "null" ] }, "quantity_withheld_or_sold": { "description": "The quantity of equity withheld or sold", "type": [ "string", "null" ] }, "sale_price": { "description": "The price at which the equity was sold", "type": [ "string", "null" ] }, "sent_for_processing_at": { "description": "The date and time the event was sent for payroll processing", "format": "date-time", "type": [ "string", "null" ] }, "settlement_date": { "description": "The date the equity event was settled (i.e. when shares were transferred or cash was received)", "format": "date", "type": [ "string", "null" ] }, "supporting_documents_id": { "description": "The unique identifier of the supporting documents attached to the event", "format": "uuid", "type": [ "string", "null" ] }, "tax_jurisdiction": { "description": "The ISO 3166-1 alpha-2 country code of the worker's contract jurisdiction at the time of the event", "type": [ "string", "null" ] }, "tax_rate": { "description": "The tax rate applied to the benefit in kind", "type": [ "string", "null" ] }, "taxable_gain_or_loss": { "description": "The taxable gain or loss on the event, typically gross value minus the total exercise price", "type": [ "string", "null" ] }, "total_exercise_price": { "description": "The total exercise price paid for the equity, calculated as exercise price per unit multiplied by quantity exercised", "type": [ "string", "null" ] }, "total_taxes_withheld": { "description": "The total amount of income tax and social contributions withheld on behalf of the worker", "type": [ "string", "null" ] }, "transaction_fees": { "description": "Brokerage or transaction fees associated with the equity event, in plan currency", "type": [ "string", "null" ] }, "unit_fmv": { "description": "The fair market value per unit at the time of the event", "type": [ "string", "null" ] }, "updated_at": { "description": "The date and time the tax event was last updated", "format": "date-time", "type": [ "string", "null" ] }, "verification_status": { "description": "The current verification status of the tax event (PENDING_VERIFICATION, VERIFIED, SENT_FOR_PROCESSING, PROCESSED, MISMATCH)", "type": [ "string", "null" ] }, "withheld_tax_local_currency": { "description": "The income tax and social contributions withheld, expressed in the worker's local payroll currency", "type": [ "string", "null" ] } }, "title": "EquityGrantsGetResponsesContentApplicationJsonSchemaDataItemsTaxEventsItems", "type": "object" }, "EquityGrantsGetResponsesContentApplicationJsonSchemaDataItemsVestedEventsItems": { "properties": { "quantity": { "description": "The quantity that vested on this date", "format": "double", "type": [ "number", "null" ] }, "vesting_date": { "description": "The date this tranche vested", "format": "date", "type": [ "string", "null" ] } }, "title": "EquityGrantsGetResponsesContentApplicationJsonSchemaDataItemsVestedEventsItems", "type": "object" }, "EquityGrantsGetResponsesContentApplicationJsonSchemaErrorsItems": { "properties": { "code": { "description": "A machine-readable code identifying the type of error", "type": "string" }, "message": { "description": "A human-readable description of the error", "type": "string" } }, "title": "EquityGrantsGetResponsesContentApplicationJsonSchemaErrorsItems", "type": "object" }, "EquityOptionLedgerGetResponsesContentApplicationJsonSchemaDataItems": { "properties": { "carta_grant_acceptance_date": { "description": "Carta - Grant Acceptance Date, as reported by the ingested file.", "format": "date", "type": [ "string", "null" ] }, "compensation_benefit": { "description": "Compensation benefit amount, as reported by the ingested file.", "format": "double", "type": [ "number", "null" ] }, "created_at": { "description": "Timestamp this record was first ingested.", "format": "date-time", "type": "string" }, "early_exercise_allowed": { "description": "Whether early exercise is allowed, as reported by the ingested file (verbatim text, e.g. Yes/No).", "type": [ "string", "null" ] }, "employee_grant_number": { "description": "Shareworks grant number for this employee, as reported by the ingested file.", "type": "string" }, "employee_number": { "description": "Shareworks employee number, as reported by the ingested file. The intended join key for this record. Some values are non-numeric for legacy or masked records.", "type": [ "string", "null" ] }, "exercise_price_per_share": { "description": "Exercise price per share, as reported by the ingested file.", "format": "double", "type": [ "number", "null" ] }, "expire_date": { "description": "Grant expiration date, as reported by the ingested file.", "format": "date", "type": [ "string", "null" ] }, "federal_exemption": { "description": "Federal exemption, as reported by the ingested file.", "type": [ "string", "null" ] }, "first_name": { "description": "Employee first name, as reported by the ingested file.", "type": [ "string", "null" ] }, "fmv_per_share_at_grant_date": { "description": "Fair market value per share at grant date, as reported by the ingested file.", "format": "double", "type": [ "number", "null" ] }, "formatted_home_address": { "description": "Formatted home address, as reported by the ingested file.", "type": [ "string", "null" ] }, "grant_agreement_template_name": { "description": "Grant agreement template name, as reported by the ingested file.", "type": [ "string", "null" ] }, "grant_date": { "description": "Date the grant was issued, as reported by the ingested file.", "format": "date", "type": [ "string", "null" ] }, "grant_name": { "description": "Grant name, as reported by the ingested file.", "type": [ "string", "null" ] }, "grant_reason": { "description": "Grant reason, as reported by the ingested file.", "type": [ "string", "null" ] }, "grant_type": { "description": "Grant type (e.g. Options (NQ)), as reported by the ingested file.", "type": [ "string", "null" ] }, "hris_profile_id": { "description": "Matched HRIS profile id, if employee_number could be resolved to one. Null when unmatched, or when employee_number is non-numeric or blank.", "type": [ "integer", "null" ] }, "id": { "description": "The unique identifier of the record.", "format": "uuid", "type": "string" }, "is_under_rule_701": { "description": "Whether the grant is under Rule 701, as reported by the ingested file (verbatim text, e.g. Yes/No).", "type": [ "string", "null" ] }, "iso_csop_disqualification_date": { "description": "ISO/CSOP disqualification date, as reported by the ingested file.", "format": "date", "type": [ "string", "null" ] }, "last_name": { "description": "Employee last name, as reported by the ingested file.", "type": [ "string", "null" ] }, "last_seen_dataset_id": { "description": "Identifier of the most recent ingested dataset in which this record still appeared. Null for records ingested before dataset tracking began.", "format": "uuid", "type": [ "string", "null" ] }, "middle_name": { "description": "Employee middle name, as reported by the ingested file.", "type": [ "string", "null" ] }, "no_of_shares_granted": { "description": "Number of shares/units granted, as reported by the ingested file.", "format": "double", "type": [ "number", "null" ] }, "no_of_shares_unvested": { "description": "Number of shares unvested, as reported by the ingested file.", "format": "double", "type": [ "number", "null" ] }, "no_of_shares_vested": { "description": "Number of shares vested, as reported by the ingested file.", "format": "double", "type": [ "number", "null" ] }, "notes": { "description": "Free-form notes, as reported by the ingested file.", "type": [ "string", "null" ] }, "occurrence_index": { "description": "Discriminates several records the source file reports for the same natural key. Starts at 1, in the order the rows appear in the file.", "type": "integer" }, "outstanding_exercisable": { "description": "Outstanding exercisable shares, as reported by the ingested file.", "format": "double", "type": [ "number", "null" ] }, "outstanding_unvested": { "description": "Outstanding unvested shares, as reported by the ingested file.", "format": "double", "type": [ "number", "null" ] }, "outstanding_vested": { "description": "Outstanding vested shares, as reported by the ingested file.", "format": "double", "type": [ "number", "null" ] }, "plan_name": { "description": "Equity plan name, as reported by the ingested file.", "type": [ "string", "null" ] }, "preferred_share_price": { "description": "Preferred share price, as reported by the ingested file.", "format": "double", "type": [ "number", "null" ] }, "row_hash": { "description": "Hash of the reported values on this record. Compare it between syncs to detect a change without diffing every field.", "type": "string" }, "section_102_disqualification_date": { "description": "\"102 Disqualification date\" in the source file (Section 102 of the Israeli tax ordinance).", "format": "date", "type": [ "string", "null" ] }, "shares_cancelled": { "description": "Shares cancelled, as reported by the ingested file.", "format": "double", "type": [ "number", "null" ] }, "shares_exercised_released": { "description": "Shares exercised/released, as reported by the ingested file.", "format": "double", "type": [ "number", "null" ] }, "shares_expired": { "description": "Shares expired, as reported by the ingested file.", "format": "double", "type": [ "number", "null" ] }, "shares_outstanding": { "description": "Shares outstanding, as reported by the ingested file.", "format": "double", "type": [ "number", "null" ] }, "shares_repurchased": { "description": "Shares repurchased, as reported by the ingested file.", "format": "double", "type": [ "number", "null" ] }, "shares_subject_to_repurchase": { "description": "Shares subject to repurchase, as reported by the ingested file.", "format": "double", "type": [ "number", "null" ] }, "shareworks_grant_agreement_agreement_date": { "description": "Shareworks - Grant Agreement - Agreement Date, as reported by the ingested file.", "format": "date", "type": [ "string", "null" ] }, "shareworks_grant_agreement_print_instant": { "description": "Shareworks - Grant Agreement - Print Instant, as reported by the ingested file.", "type": [ "string", "null" ] }, "source_file_id": { "description": "Identifier of the ingested Shareworks report file this record was last upserted from.", "format": "uuid", "type": "string" }, "split_employee_grant_number": { "description": "Split Employee Grant Number, as reported by the ingested file.", "type": [ "string", "null" ] }, "state_exemption": { "description": "State exemption, as reported by the ingested file.", "type": [ "string", "null" ] }, "stock_options_and_awards_employee_status": { "description": "Stock Options and Awards Employee Status, as reported by the ingested file.", "type": [ "string", "null" ] }, "stock_options_and_awards_employee_status_effective_date": { "description": "Stock Options and Awards Employee Status (Effective Date), as reported by the ingested file.", "format": "date", "type": [ "string", "null" ] }, "tax_identifier": { "description": "Tax identifier, as reported by the ingested file.", "type": [ "string", "null" ] }, "total_exercise_price": { "description": "Total exercise price for the grant, as reported by the ingested file.", "format": "double", "type": [ "number", "null" ] }, "total_fmv": { "description": "Total fair market value of the grant, as reported by the ingested file.", "format": "double", "type": [ "number", "null" ] }, "updated_at": { "description": "Timestamp this record was last upserted, for incremental sync.", "format": "date-time", "type": "string" }, "vesting_schedule": { "description": "Vesting schedule name, as reported by the ingested file.", "type": [ "string", "null" ] }, "vesting_start_date": { "description": "Vesting start date, as reported by the ingested file.", "format": "date", "type": [ "string", "null" ] } }, "required": [ "id", "notes", "row_hash", "last_name", "plan_name", "total_fmv", "created_at", "first_name", "grant_date", "grant_name", "grant_type", "updated_at", "expire_date", "middle_name", "grant_reason", "shares_expired", "source_file_id", "tax_identifier", "employee_number", "hris_profile_id", "state_exemption", "occurrence_index", "shares_cancelled", "vesting_schedule", "federal_exemption", "is_under_rule_701", "outstanding_vested", "shares_outstanding", "shares_repurchased", "vesting_start_date", "no_of_shares_vested", "compensation_benefit", "last_seen_dataset_id", "no_of_shares_granted", "outstanding_unvested", "total_exercise_price", "employee_grant_number", "no_of_shares_unvested", "preferred_share_price", "early_exercise_allowed", "formatted_home_address", "outstanding_exercisable", "exercise_price_per_share", "shares_exercised_released", "carta_grant_acceptance_date", "fmv_per_share_at_grant_date", "split_employee_grant_number", "shares_subject_to_repurchase", "grant_agreement_template_name", "iso_csop_disqualification_date", "section_102_disqualification_date", "shareworks_grant_agreement_print_instant", "stock_options_and_awards_employee_status", "shareworks_grant_agreement_agreement_date", "stock_options_and_awards_employee_status_effective_date" ], "title": "EquityOptionLedgerGetResponsesContentApplicationJsonSchemaDataItems", "type": "object" }, "EquityOptionLedgerGetResponsesContentApplicationJsonSchemaErrorsItems": { "properties": { "code": { "description": "Machine-readable error code", "maxLength": 255, "type": "string" }, "field": { "description": "Field that caused the error, if applicable.", "type": [ "string", "null" ] }, "message": { "description": "Human-readable explanation", "type": "string" } }, "required": [ "message" ], "title": "EquityOptionLedgerGetResponsesContentApplicationJsonSchemaErrorsItems", "type": "object" }, "EquityParticipantsGetResponsesContentApplicationJsonSchemaDataItems": { "properties": { "account_activation_date": { "description": "Moment the Shareworks account was activated. The source file reports this in US Pacific local time; it is returned here in UTC.", "format": "date-time", "type": [ "string", "null" ] }, "account_holder_type": { "description": "Account holder type, as reported by the ingested file.", "type": [ "string", "null" ] }, "alternate_employee_number": { "description": "Alternate employee number, as reported by the ingested file.", "type": [ "string", "null" ] }, "company_email": { "description": "Company email address, as reported by the ingested file.", "type": [ "string", "null" ] }, "company_provided_personal_email": { "description": "Personal email address supplied by the company, as reported by the ingested file.", "type": [ "string", "null" ] }, "cost_center": { "description": "Cost center, as reported by the ingested file.", "type": [ "string", "null" ] }, "cost_center_effective_date": { "description": "Date the cost center took effect.", "format": "date", "type": [ "string", "null" ] }, "created_at": { "description": "Timestamp this record was first ingested.", "format": "date-time", "type": "string" }, "current_employment": { "description": "Current employment classification, as reported by the ingested file.", "type": [ "string", "null" ] }, "current_employment_description": { "description": "Free-text description of the current employment, as reported by the ingested file. Unpopulated in every record delivered so far.", "type": [ "string", "null" ] }, "current_employment_effective_date": { "description": "Date the current employment classification took effect.", "format": "date", "type": [ "string", "null" ] }, "email": { "description": "Personal email address, as reported by the ingested file.", "type": [ "string", "null" ] }, "employee_number": { "description": "Shareworks employee number, as reported by the ingested file. The intended join key for this record. Some values are non-numeric for legacy or masked records.", "type": "string" }, "full_name": { "description": "Participant full name, as reported by the ingested file.", "type": [ "string", "null" ] }, "hire_date": { "description": "Hire date, as reported by the ingested file.", "format": "date", "type": [ "string", "null" ] }, "home_address_city": { "description": "Home address city, as reported by the ingested file.", "type": [ "string", "null" ] }, "home_address_country": { "description": "Home address country, as reported by the ingested file.", "type": [ "string", "null" ] }, "home_address_line_1": { "description": "First line of the home address, as reported by the ingested file.", "type": [ "string", "null" ] }, "home_address_line_2": { "description": "Second line of the home address, as reported by the ingested file.", "type": [ "string", "null" ] }, "home_address_state_province": { "description": "Home address state or province, as reported by the ingested file.", "type": [ "string", "null" ] }, "home_address_zip_postal_code": { "description": "Home address ZIP or postal code, as reported by the ingested file.", "type": [ "string", "null" ] }, "hris_profile_id": { "description": "Matched HRIS profile id, if employee_number could be resolved to one. Null when unmatched, or when employee_number is non-numeric or blank.", "type": [ "integer", "null" ] }, "id": { "description": "The unique identifier of the participant record.", "format": "uuid", "type": "string" }, "last_seen_dataset_id": { "description": "Identifier of the most recent ingested dataset in which this record still appeared. Null for records ingested before dataset tracking began.", "format": "uuid", "type": [ "string", "null" ] }, "organization_name": { "description": "Organization name, as reported by the ingested file.", "type": [ "string", "null" ] }, "pre_clearance": { "description": "Pre-clearance status, as reported by the ingested file.", "type": [ "string", "null" ] }, "row_hash": { "description": "Hash of the reported values on this record. Compare it between syncs to detect a change without diffing every field.", "type": "string" }, "source_file_id": { "description": "Identifier of the ingested Shareworks report file this record was last upserted from.", "format": "uuid", "type": "string" }, "ssn": { "description": "US Social Security Number, as reported by the ingested file. Returned in full, unmasked, because it is a required input to US equity tax withholding. Present only for participants whose source record carries one. Treat this value as a direct identifier and store it accordingly.", "type": [ "string", "null" ] }, "stock_options_and_awards_employee_status": { "description": "Stock options and awards employee status, as reported by the ingested file.", "type": [ "string", "null" ] }, "stock_options_and_awards_employee_status_effective_date": { "description": "Date the stock options and awards employee status took effect.", "format": "date", "type": [ "string", "null" ] }, "updated_at": { "description": "Timestamp this record was last upserted, for incremental sync.", "format": "date-time", "type": "string" } }, "required": [ "id", "ssn", "email", "row_hash", "full_name", "hire_date", "created_at", "updated_at", "cost_center", "company_email", "pre_clearance", "source_file_id", "employee_number", "hris_profile_id", "home_address_city", "organization_name", "current_employment", "account_holder_type", "home_address_line_1", "home_address_line_2", "home_address_country", "last_seen_dataset_id", "account_activation_date", "alternate_employee_number", "cost_center_effective_date", "home_address_state_province", "home_address_zip_postal_code", "current_employment_description", "company_provided_personal_email", "current_employment_effective_date", "stock_options_and_awards_employee_status", "stock_options_and_awards_employee_status_effective_date" ], "title": "EquityParticipantsGetResponsesContentApplicationJsonSchemaDataItems", "type": "object" }, "EquityParticipantsGetResponsesContentApplicationJsonSchemaErrorsItems": { "properties": { "code": { "description": "Machine-readable error code", "maxLength": 255, "type": "string" }, "field": { "description": "Field that caused the error, if applicable.", "type": [ "string", "null" ] }, "message": { "description": "Human-readable explanation", "type": "string" } }, "required": [ "message" ], "title": "EquityParticipantsGetResponsesContentApplicationJsonSchemaErrorsItems", "type": "object" }, "EquityValuationsGetResponsesContentApplicationJsonSchemaDataItems": { "properties": { "amortization_method": { "description": "Amortization method (e.g. Straight-Line), as reported by the ingested file.", "type": "string" }, "award_type": { "description": "Award type (e.g. Restricted Stock - Standard), as reported by the ingested file.", "type": "string" }, "created_at": { "description": "Timestamp this record was first ingested.", "format": "date-time", "type": "string" }, "dividend_yield_percent": { "description": "Dividend yield, stored as the percent NUMBER itself, NOT a fraction. See parseShareworksPercent. Sparsely populated (measured: 14,353 of 15,090 real rows).", "format": "double", "type": [ "number", "null" ] }, "dividend_yield_type": { "description": "Dividend yield type, as reported by the ingested file. Sparsely populated (measured: 14,353 of 15,090 real rows).", "type": [ "string", "null" ] }, "employee_grant_number": { "description": "Shareworks grant number for this employee, as reported by the ingested file.", "type": "string" }, "expected_life": { "description": "Expected life of the award (years), as reported by the ingested file. Sparsely populated (measured: 14,353 of 15,090 real rows).", "format": "double", "type": [ "number", "null" ] }, "expected_life_type": { "description": "Expected life type, as reported by the ingested file. Sparsely populated (measured: 14,353 of 15,090 real rows).", "type": [ "string", "null" ] }, "expense_amortization_start_date": { "description": "Expense amortization start date, as reported by the ingested file.", "format": "date", "type": "string" }, "expense_valuation_model": { "description": "Expense valuation model (e.g. Black-Scholes), as reported by the ingested file.", "type": "string" }, "fair_value_per_share": { "description": "Fair market value per share, as reported by the ingested file.", "format": "double", "type": "number" }, "forfeiture_rate_calculation_method": { "description": "Forfeiture rate calculation method, as reported by the ingested file.", "type": "string" }, "forfeiture_rate_percent": { "description": "Forfeiture rate, stored as the percent NUMBER itself (e.g. 5.25 means 5.25%), NOT a fraction. See parseShareworksPercent.", "format": "double", "type": "number" }, "grant_date": { "description": "Date the grant was issued, as reported by the ingested file.", "format": "date", "type": "string" }, "grant_name": { "description": "Grant name, as reported by the ingested file.", "type": "string" }, "grant_price": { "description": "Strike/grant price per unit, as reported by the ingested file.", "format": "double", "type": "number" }, "id": { "description": "The unique identifier of the record.", "format": "uuid", "type": "string" }, "last_seen_dataset_id": { "description": "Identifier of the most recent ingested dataset in which this record still appeared. Null for records ingested before dataset tracking began.", "format": "uuid", "type": [ "string", "null" ] }, "market_price": { "description": "Market price per unit, as reported by the ingested file.", "format": "double", "type": "number" }, "occurrence_index": { "description": "Discriminates several records the source file reports for the same natural key. Starts at 1, in the order the rows appear in the file.", "type": "integer" }, "original_granted": { "description": "Original granted share count, as reported by the ingested file.", "format": "double", "type": "number" }, "original_performance_rule": { "description": "Original performance rule, as reported by the ingested file. Sparsely populated (measured: 25 of 15,090 real rows).", "type": [ "string", "null" ] }, "original_vest_date": { "description": "Original vest date, as reported by the ingested file. Sparsely populated (measured: 4,477 of 15,090 real rows) - deliberately NOT part of the uniqueness key, since a Null value would not conflict with another Null under Postgres unique-constraint semantics.", "format": "date", "type": [ "string", "null" ] }, "plan_name": { "description": "Equity plan name, as reported by the ingested file.", "type": "string" }, "risk_free_rate_percent": { "description": "Risk-free rate, stored as the percent NUMBER itself, NOT a fraction. See parseShareworksPercent. Sparsely populated (measured: 14,353 of 15,090 real rows).", "format": "double", "type": [ "number", "null" ] }, "risk_free_rate_source": { "description": "Risk-free rate source, as reported by the ingested file. Sparsely populated (measured: 8,308 of 15,090 real rows).", "type": [ "string", "null" ] }, "risk_free_rate_type": { "description": "Risk-free rate type, as reported by the ingested file. Sparsely populated (measured: 14,353 of 15,090 real rows).", "type": [ "string", "null" ] }, "row_hash": { "description": "Hash of the reported values on this record. Compare it between syncs to detect a change without diffing every field.", "type": "string" }, "source_file_id": { "description": "Identifier of the ingested Shareworks report file this record was last upserted from.", "format": "uuid", "type": "string" }, "updated_at": { "description": "Timestamp this record was last upserted, for incremental sync.", "format": "date-time", "type": "string" }, "valuation_type": { "description": "Valuation type, as reported by the ingested file.", "type": "string" }, "volatility_percent": { "description": "Volatility, stored as the percent NUMBER itself, NOT a fraction. See parseShareworksPercent. Sparsely populated (measured: 14,353 of 15,090 real rows).", "format": "double", "type": [ "number", "null" ] }, "volatility_type": { "description": "Volatility type, as reported by the ingested file. Sparsely populated (measured: 14,353 of 15,090 real rows).", "type": [ "string", "null" ] } }, "required": [ "id", "row_hash", "plan_name", "award_type", "created_at", "grant_date", "grant_name", "updated_at", "grant_price", "market_price", "expected_life", "source_file_id", "valuation_type", "volatility_type", "occurrence_index", "original_granted", "expected_life_type", "original_vest_date", "volatility_percent", "amortization_method", "dividend_yield_type", "risk_free_rate_type", "fair_value_per_share", "last_seen_dataset_id", "employee_grant_number", "risk_free_rate_source", "dividend_yield_percent", "risk_free_rate_percent", "expense_valuation_model", "forfeiture_rate_percent", "original_performance_rule", "expense_amortization_start_date", "forfeiture_rate_calculation_method" ], "title": "EquityValuationsGetResponsesContentApplicationJsonSchemaDataItems", "type": "object" }, "EquityValuationsGetResponsesContentApplicationJsonSchemaErrorsItems": { "properties": { "code": { "description": "Machine-readable error code", "maxLength": 255, "type": "string" }, "field": { "description": "Field that caused the error, if applicable.", "type": [ "string", "null" ] }, "message": { "description": "Human-readable explanation", "type": "string" } }, "required": [ "message" ], "title": "EquityValuationsGetResponsesContentApplicationJsonSchemaErrorsItems", "type": "object" }, "Equity_Tokens_createEquityOrTokenTaxEvent-v2026-01-01_Response_201": { "properties": { "data": { "$ref": "#/components/schemas/EquitiesTokensTaxEventsPostResponsesContentApplicationJsonSchemaData" } }, "title": "Equity Tokens_createEquityOrTokenTaxEvent-v2026-01-01_Response_201", "type": "object" }, "Equity_Tokens_listEquityAmortizations-v2026-09-09_Response_200": { "properties": { "data": { "description": "Page of expense amortization records, one per grant occurrence.", "items": { "$ref": "#/components/schemas/EquityAmortizationsGetResponsesContentApplicationJsonSchemaDataItems" }, "type": "array" }, "has_more": { "description": "Whether another page of results is available.", "type": "boolean" }, "next_cursor": { "description": "Cursor for the next page. Null when has_more is false.", "type": [ "string", "null" ] } }, "required": [ "data", "has_more", "next_cursor" ], "title": "Equity Tokens_listEquityAmortizations-v2026-09-09_Response_200", "type": "object" }, "Equity_Tokens_listEquityAwards-v2026-09-09_Response_200": { "properties": { "data": { "description": "Page of granted equity award records, one per reported award row.", "items": { "$ref": "#/components/schemas/EquityAwardsGetResponsesContentApplicationJsonSchemaDataItems" }, "type": "array" }, "has_more": { "description": "Whether another page of results is available.", "type": "boolean" }, "next_cursor": { "description": "Cursor for the next page. Null when has_more is false.", "type": [ "string", "null" ] } }, "required": [ "data", "has_more", "next_cursor" ], "title": "Equity Tokens_listEquityAwards-v2026-09-09_Response_200", "type": "object" }, "Equity_Tokens_listEquityExpenses-v2026-09-09_Response_200": { "properties": { "data": { "description": "Page of total expense records, one per grant occurrence.", "items": { "$ref": "#/components/schemas/EquityExpensesGetResponsesContentApplicationJsonSchemaDataItems" }, "type": "array" }, "has_more": { "description": "Whether another page of results is available.", "type": "boolean" }, "next_cursor": { "description": "Cursor for the next page. Null when has_more is false.", "type": [ "string", "null" ] } }, "required": [ "data", "has_more", "next_cursor" ], "title": "Equity Tokens_listEquityExpenses-v2026-09-09_Response_200", "type": "object" }, "Equity_Tokens_listEquityGrantsWithTaxEvents-v2026-08-10_Response_200": { "properties": { "data": { "items": { "$ref": "#/components/schemas/EquityGrantsGetResponsesContentApplicationJsonSchemaDataItems" }, "type": "array" }, "limit": { "description": "The limit applied to this page of results", "type": "integer" }, "offset": { "description": "The offset applied to this page of results", "type": "integer" }, "total": { "description": "The total number of grants matching the query, independent of limit/offset", "type": "integer" } }, "title": "Equity Tokens_listEquityGrantsWithTaxEvents-v2026-08-10_Response_200", "type": "object" }, "Equity_Tokens_listEquityOptionLedgerEntries-v2026-09-09_Response_200": { "properties": { "data": { "description": "Page of option holder ledger records, one per grant occurrence.", "items": { "$ref": "#/components/schemas/EquityOptionLedgerGetResponsesContentApplicationJsonSchemaDataItems" }, "type": "array" }, "has_more": { "description": "Whether another page of results is available.", "type": "boolean" }, "next_cursor": { "description": "Cursor for the next page. Null when has_more is false.", "type": [ "string", "null" ] } }, "required": [ "data", "has_more", "next_cursor" ], "title": "Equity Tokens_listEquityOptionLedgerEntries-v2026-09-09_Response_200", "type": "object" }, "Equity_Tokens_listEquityParticipants-v2026-09-08_Response_200": { "properties": { "data": { "description": "Page of equity participant records, one per Shareworks employee number.", "items": { "$ref": "#/components/schemas/EquityParticipantsGetResponsesContentApplicationJsonSchemaDataItems" }, "type": "array" }, "has_more": { "description": "Whether another page of results is available.", "type": "boolean" }, "next_cursor": { "description": "Cursor for the next page. Null when has_more is false.", "type": [ "string", "null" ] } }, "required": [ "data", "has_more", "next_cursor" ], "title": "Equity Tokens_listEquityParticipants-v2026-09-08_Response_200", "type": "object" }, "Equity_Tokens_listEquityShareworksExercises-v2026-09-09_Response_200": { "properties": { "data": { "description": "Page of exercise records. Worker name fields are deliberately not included — employee_number is the intended join key, and first/last name are SENSITIVE PII not needed by downstream consumers of this endpoint.", "items": { "$ref": "#/components/schemas/EquityExercisesGetResponsesContentApplicationJsonSchemaDataItems" }, "type": "array" }, "has_more": { "description": "Whether another page of results is available.", "type": "boolean" }, "next_cursor": { "description": "Cursor for the next page. Null when has_more is false.", "type": [ "string", "null" ] } }, "required": [ "data", "has_more", "next_cursor" ], "title": "Equity Tokens_listEquityShareworksExercises-v2026-09-09_Response_200", "type": "object" }, "Equity_Tokens_listEquityValuations-v2026-09-09_Response_200": { "properties": { "data": { "description": "Page of grant valuation records, one per grant occurrence.", "items": { "$ref": "#/components/schemas/EquityValuationsGetResponsesContentApplicationJsonSchemaDataItems" }, "type": "array" }, "has_more": { "description": "Whether another page of results is available.", "type": "boolean" }, "next_cursor": { "description": "Cursor for the next page. Null when has_more is false.", "type": [ "string", "null" ] } }, "required": [ "data", "has_more", "next_cursor" ], "title": "Equity Tokens_listEquityValuations-v2026-09-09_Response_200", "type": "object" }, "ErrorResponse": { "properties": { "detail": { "description": "detail error message", "type": "string" }, "schemas": { "items": { "$ref": "#/components/schemas/ErrorResponseSchemasItems" }, "type": "array" }, "scimType": { "$ref": "#/components/schemas/ErrorResponseScimType", "description": "bad request type when status code is 400" }, "status": { "description": "same as HTTP status code, e.g. 400, 401, etc.", "type": "string" } }, "title": "ErrorResponse", "type": "object" }, "ErrorResponseSchemasItems": { "enum": [ "urn:ietf:params:scim:api:messages:2.0:Error" ], "title": "ErrorResponseSchemasItems", "type": "string" }, "ErrorResponseScimType": { "description": "bad request type when status code is 400", "enum": [ "uniqueness", "tooMany", "mutability", "sensitive", "invalidSyntax", "invalidFilter", "invalidPath", "invalidValue", "invalidVers", "noTarget" ], "title": "ErrorResponseScimType", "type": "string" }, "EscalationsWorkersMeHrxGetResponsesContentApplicationJsonSchemaData": { "properties": { "avatar": { "description": "URL to the HRX representative's avatar/profile picture", "type": "string" }, "cal_com_url": { "description": "A link to schedule call with HRX Manager", "type": "string" }, "created_at": { "description": "Timestamp when the HRX record was created", "format": "date-time", "type": "string" }, "id": { "description": "Unique identifier (UUID) for the HRX representative", "format": "uuid", "type": "string" }, "name": { "description": "Full name of the HRX representative", "type": "string" }, "updated_at": { "description": "Timestamp when the HRX record was last updated", "format": "date-time", "type": "string" } }, "required": [ "id", "name", "avatar", "created_at", "updated_at" ], "title": "EscalationsWorkersMeHrxGetResponsesContentApplicationJsonSchemaData", "type": "object" }, "EscalationsWorkersMeHrxGetResponsesContentApplicationJsonSchemaErrorsItems": { "properties": { "code": { "description": "Machine-readable error code", "type": "string" }, "message": { "description": "Human-readable explanation of the error", "type": "string" } }, "title": "EscalationsWorkersMeHrxGetResponsesContentApplicationJsonSchemaErrorsItems", "type": "object" }, "ExternalHrTimeOffSynchronization-v2026-01-01RequestBadRequestError": { "properties": { "errors": { "items": { "$ref": "#/components/schemas/TimeOffsGlobalPayrollSyncPostResponsesContentApplicationJsonSchemaErrorsItems" }, "type": "array" }, "request": { "$ref": "#/components/schemas/TimeOffsGlobalPayrollSyncPostResponsesContentApplicationJsonSchemaRequest" } }, "title": "ExternalHrTimeOffSynchronization-v2026-01-01RequestBadRequestError", "type": "object" }, "FetchAllPayoutMethods-v2026-01-01RequestBadRequestError": { "properties": { "errors": { "items": { "$ref": "#/components/schemas/PayoutsContractorsMethodsGetResponsesContentApplicationJsonSchemaErrorsItems" }, "type": "array" } }, "title": "FetchAllPayoutMethods-v2026-01-01RequestBadRequestError", "type": "object" }, "FetchAnOrgStructureFromTheOrganization-v2026-01-01RequestBadRequestError": { "properties": { "errors": { "items": { "$ref": "#/components/schemas/HrisOrganizationStructuresHrisOrgStructureIdGetResponsesContentApplicationJsonSchemaErrorsItems" }, "type": "array" } }, "required": [ "errors" ], "title": "FetchAnOrgStructureFromTheOrganization-v2026-01-01RequestBadRequestError", "type": "object" }, "FetchAnOrgStructureFromTheOrganization-v2026-01-01RequestNotFoundError": { "properties": { "errors": { "items": { "$ref": "#/components/schemas/HrisOrganizationStructuresHrisOrgStructureIdGetResponsesContentApplicationJsonSchemaErrorsItems" }, "type": "array" } }, "required": [ "errors" ], "title": "FetchAnOrgStructureFromTheOrganization-v2026-01-01RequestNotFoundError", "type": "object" }, "FetchEorContractDocument-v2026-01-01RequestBadRequestError": { "properties": { "errors": { "items": { "$ref": "#/components/schemas/EorContractsContractIdDocumentsTypeGetResponsesContentApplicationJsonSchemaErrorsItems" }, "type": "array" }, "request": { "$ref": "#/components/schemas/EorContractsContractIdDocumentsTypeGetResponsesContentApplicationJsonSchemaRequest" } }, "title": "FetchEorContractDocument-v2026-01-01RequestBadRequestError", "type": "object" }, "FetchEorContractDocuments-v2026-01-01RequestBadRequestError": { "properties": { "errors": { "items": { "$ref": "#/components/schemas/EorContractsContractIdDocumentsGetResponsesContentApplicationJsonSchemaErrorsItems" }, "type": "array" }, "request": { "$ref": "#/components/schemas/EorContractsContractIdDocumentsGetResponsesContentApplicationJsonSchemaRequest" } }, "title": "FetchEorContractDocuments-v2026-01-01RequestBadRequestError", "type": "object" }, "FetchEorContractForm-v2026-01-01RequestBadRequestError": { "properties": { "errors": { "items": { "$ref": "#/components/schemas/FormsEorCreateContractCountryCodeGetResponsesContentApplicationJsonSchemaErrorsItems" }, "type": "array" }, "request": { "$ref": "#/components/schemas/FormsEorCreateContractCountryCodeGetResponsesContentApplicationJsonSchemaRequest" } }, "title": "FetchEorContractForm-v2026-01-01RequestBadRequestError", "type": "object" }, "FetchEorContractForm-v2026-01-01RequestInternalServerError": { "properties": { "error": { "$ref": "#/components/schemas/FormsEorCreateContractCountryCodeGetResponsesContentApplicationJsonSchemaError" } }, "title": "FetchEorContractForm-v2026-01-01RequestInternalServerError", "type": "object" }, "FetchEorContractForm-v2026-01-01RequestNotFoundError": { "properties": { "error": { "$ref": "#/components/schemas/FormsEorCreateContractCountryCodeGetResponsesContentApplicationJsonSchemaError" } }, "title": "FetchEorContractForm-v2026-01-01RequestNotFoundError", "type": "object" }, "FetchEorProjectAssignmentPdf-v2026-01-01RequestBadRequestError": { "properties": { "errors": { "items": { "$ref": "#/components/schemas/EorContractsContractIdProjectAssignmentGetResponsesContentApplicationJsonSchemaErrorsItems" }, "type": "array" } }, "required": [ "errors" ], "title": "FetchEorProjectAssignmentPdf-v2026-01-01RequestBadRequestError", "type": "object" }, "FetchEorProjectAssignmentPdf-v2026-01-01RequestConflictError": { "properties": { "errors": { "items": { "$ref": "#/components/schemas/EorContractsContractIdProjectAssignmentGetResponsesContentApplicationJsonSchemaErrorsItems" }, "type": "array" } }, "required": [ "errors" ], "title": "FetchEorProjectAssignmentPdf-v2026-01-01RequestConflictError", "type": "object" }, "FetchEorProjectAssignmentPdf-v2026-01-01RequestInternalServerError": { "properties": { "errors": { "items": { "$ref": "#/components/schemas/EorContractsContractIdProjectAssignmentGetResponsesContentApplicationJsonSchemaErrorsItems" }, "type": "array" } }, "required": [ "errors" ], "title": "FetchEorProjectAssignmentPdf-v2026-01-01RequestInternalServerError", "type": "object" }, "FetchHrisPositionsFromAHrisProfile-v2026-01-01RequestBadRequestError": { "properties": { "errors": { "items": { "$ref": "#/components/schemas/HrisPositionsProfileHrisProfileIdGetResponsesContentApplicationJsonSchemaErrorsItems" }, "type": "array" } }, "required": [ "errors" ], "title": "FetchHrisPositionsFromAHrisProfile-v2026-01-01RequestBadRequestError", "type": "object" }, "FetchHrisPositionsFromAHrisProfile-v2026-01-01RequestNotFoundError": { "properties": { "errors": { "items": { "$ref": "#/components/schemas/HrisPositionsProfileHrisProfileIdGetResponsesContentApplicationJsonSchemaErrorsItems" }, "type": "array" } }, "required": [ "errors" ], "title": "FetchHrisPositionsFromAHrisProfile-v2026-01-01RequestNotFoundError", "type": "object" }, "FetchMultipleEorContractForms-v2026-01-01RequestBadRequestError": { "properties": { "errors": { "items": { "$ref": "#/components/schemas/FormsEorCreateContractDefinitionsPostResponsesContentApplicationJsonSchemaErrorsItems" }, "type": "array" } }, "title": "FetchMultipleEorContractForms-v2026-01-01RequestBadRequestError", "type": "object" }, "FetchMultipleEorContractForms-v2026-01-01RequestInternalServerError": { "properties": { "errors": { "items": { "$ref": "#/components/schemas/FormsEorCreateContractDefinitionsPostResponsesContentApplicationJsonSchemaErrorsItems" }, "type": "array" } }, "title": "FetchMultipleEorContractForms-v2026-01-01RequestInternalServerError", "type": "object" }, "FetchProjectAssignmentCheckinQuestionnaireData-v2026-01-01RequestBadRequestError": { "properties": { "errors": { "items": { "$ref": "#/components/schemas/EorContractsContractIdProjectAssignmentCheckinGetResponsesContentApplicationJsonSchemaErrorsItems" }, "type": "array" } }, "title": "FetchProjectAssignmentCheckinQuestionnaireData-v2026-01-01RequestBadRequestError", "type": "object" }, "FetchProjectAssignmentCheckinQuestionnaireData-v2026-01-01RequestConflictError": { "properties": { "errors": { "items": { "$ref": "#/components/schemas/EorContractsContractIdProjectAssignmentCheckinGetResponsesContentApplicationJsonSchemaErrorsItems" }, "type": "array" } }, "required": [ "errors" ], "title": "FetchProjectAssignmentCheckinQuestionnaireData-v2026-01-01RequestConflictError", "type": "object" }, "FetchProjectAssignmentCheckinQuestionnaireData-v2026-01-01RequestInternalServerError": { "properties": { "errors": { "items": { "$ref": "#/components/schemas/EorContractsContractIdProjectAssignmentCheckinGetResponsesContentApplicationJsonSchemaErrorsItems" }, "type": "array" } }, "title": "FetchProjectAssignmentCheckinQuestionnaireData-v2026-01-01RequestInternalServerError", "type": "object" }, "FetchStartDateForEorContracts-v2026-01-01RequestBadRequestError": { "properties": { "errors": { "items": { "$ref": "#/components/schemas/EorStartDateGetResponsesContentApplicationJsonSchemaErrorsItems" }, "type": "array" }, "request": { "$ref": "#/components/schemas/EorStartDateGetResponsesContentApplicationJsonSchemaRequest" } }, "title": "FetchStartDateForEorContracts-v2026-01-01RequestBadRequestError", "type": "object" }, "FetchWorkerRelationsOfAGivenHrisProfileByExternalId-v2026-01-01RequestBadRequestError": { "properties": { "errors": { "items": { "$ref": "#/components/schemas/HrisWorkerRelationsProfileExternalProfileIdGetResponsesContentApplicationJsonSchemaErrorsItems" }, "type": "array" } }, "required": [ "errors" ], "title": "FetchWorkerRelationsOfAGivenHrisProfileByExternalId-v2026-01-01RequestBadRequestError", "type": "object" }, "FetchWorkerRelationsOfAGivenHrisProfileByExternalId-v2026-01-01RequestNotFoundError": { "properties": { "errors": { "items": { "$ref": "#/components/schemas/HrisWorkerRelationsProfileExternalProfileIdGetResponsesContentApplicationJsonSchemaErrorsItems" }, "type": "array" } }, "required": [ "errors" ], "title": "FetchWorkerRelationsOfAGivenHrisProfileByExternalId-v2026-01-01RequestNotFoundError", "type": "object" }, "FilesFileidCompletePostRequestBodyContentApplicationJsonSchemaData": { "properties": { "parts": { "description": "Uploaded parts, in any order.", "items": { "$ref": "#/components/schemas/FilesFileidCompletePostRequestBodyContentApplicationJsonSchemaDataPartsItems" }, "type": "array" }, "upload_id": { "description": "S3 multipart upload ID from the register response.", "type": "string" } }, "required": [ "parts", "upload_id" ], "title": "FilesFileidCompletePostRequestBodyContentApplicationJsonSchemaData", "type": "object" }, "FilesFileidCompletePostRequestBodyContentApplicationJsonSchemaDataPartsItems": { "properties": { "etag": { "description": "ETag returned by S3 in the response header after uploading the part.", "type": "string" }, "number": { "description": "Part number (1-indexed) matching the register response.", "format": "double", "type": "number" } }, "required": [ "etag", "number" ], "title": "FilesFileidCompletePostRequestBodyContentApplicationJsonSchemaDataPartsItems", "type": "object" }, "FilesFileidStatusGetResponsesContentApplicationJsonSchemaData": { "properties": { "file_id": { "description": "Unique file identifier.", "format": "uuid", "type": "string" }, "status": { "description": "Upload status: pending (virus scan in progress), ready (claimable), or failed (virus scan failed).", "type": "string" } }, "required": [ "status", "file_id" ], "title": "FilesFileidStatusGetResponsesContentApplicationJsonSchemaData", "type": "object" }, "FilesPostParametersXUploadMethod": { "enum": [ "multipart" ], "title": "FilesPostParametersXUploadMethod", "type": "string" }, "FilesPostRequestBodyContentApplicationJsonSchemaData": { "properties": { "expiry": { "description": "Presigned URL expiry in seconds.", "format": "double", "type": "number" }, "filename": { "description": "Original filename with extension; used to detect the content type.", "type": "string" }, "is_attachment": { "description": "Whether the file should be served as an attachment (download) rather than inline.", "type": "boolean" }, "size": { "description": "Actual file size in bytes (max 1GB). Drives the server-side multipart decision when x-upload-method: multipart is set.", "format": "double", "type": "number" } }, "required": [ "filename" ], "title": "FilesPostRequestBodyContentApplicationJsonSchemaData", "type": "object" }, "FilesPostResponsesContentApplicationJsonSchemaData": { "properties": { "file_id": { "description": "Unique file identifier.", "format": "uuid", "type": "string" }, "one_time_secret": { "description": "One-time secret for claiming ownership. Pass to domain endpoints when ready to claim the file.", "type": "string" }, "upload_id": { "description": "S3 multipart upload ID. Present only when the server selected multipart — pass to POST /rest/files/{fileid}/complete.", "type": "string" }, "upload_parts": { "description": "Presigned upload targets (always present). Single-part: one presigned POST form with fields. Multipart: multiple presigned PUT URLs without fields.", "items": { "$ref": "#/components/schemas/FilesPostResponsesContentApplicationJsonSchemaDataUploadPartsItems" }, "type": "array" } }, "required": [ "file_id", "upload_parts", "one_time_secret" ], "title": "FilesPostResponsesContentApplicationJsonSchemaData", "type": "object" }, "FilesPostResponsesContentApplicationJsonSchemaDataUploadPartsItems": { "properties": { "fields": { "$ref": "#/components/schemas/FilesPostResponsesContentApplicationJsonSchemaDataUploadPartsItemsFields", "description": "Form fields to submit with the presigned POST form. Present for the single-part POST upload; absent for multipart PUT parts." }, "number": { "description": "Part number (1-indexed).", "format": "double", "type": "number" }, "size": { "description": "Maximum bytes for this part.", "format": "double", "type": "number" }, "url": { "description": "Presigned upload URL for this part.", "type": "string" } }, "title": "FilesPostResponsesContentApplicationJsonSchemaDataUploadPartsItems", "type": "object" }, "FilesPostResponsesContentApplicationJsonSchemaDataUploadPartsItemsFields": { "description": "Form fields to submit with the presigned POST form. Present for the single-part POST upload; absent for multipart PUT parts.", "properties": {}, "title": "FilesPostResponsesContentApplicationJsonSchemaDataUploadPartsItemsFields", "type": "object" }, "Files_getFileUploadStatus-v2026-08-05_Response_200": { "properties": { "data": { "$ref": "#/components/schemas/FilesFileidStatusGetResponsesContentApplicationJsonSchemaData" } }, "required": [ "data" ], "title": "Files_getFileUploadStatus-v2026-08-05_Response_200", "type": "object" }, "Files_registerFileUpload-v2026-08-05_Response_201": { "properties": { "data": { "$ref": "#/components/schemas/FilesPostResponsesContentApplicationJsonSchemaData" } }, "required": [ "data" ], "title": "Files_registerFileUpload-v2026-08-05_Response_201", "type": "object" }, "FormsEorCreateContractCountryCodeGetResponsesContentApplicationJsonSchemaData": { "properties": { "pages": { "description": "List of pages in the form.", "items": { "$ref": "#/components/schemas/FormsEorCreateContractCountryCodeGetResponsesContentApplicationJsonSchemaDataPagesItems" }, "type": "array" } }, "required": [ "pages" ], "title": "FormsEorCreateContractCountryCodeGetResponsesContentApplicationJsonSchemaData", "type": "object" }, "FormsEorCreateContractCountryCodeGetResponsesContentApplicationJsonSchemaDataPagesItems": { "properties": { "is_disabled": { "description": "Whether the entire page is disabled for the selected country.", "type": [ "boolean", "null" ] }, "sections": { "description": "Sections within the page.", "items": { "$ref": "#/components/schemas/FormsEorCreateContractCountryCodeGetResponsesContentApplicationJsonSchemaDataPagesItemsSectionsItems" }, "type": "array" }, "title": { "description": "Title of the form page.", "type": "string" } }, "required": [ "title", "sections" ], "title": "FormsEorCreateContractCountryCodeGetResponsesContentApplicationJsonSchemaDataPagesItems", "type": "object" }, "FormsEorCreateContractCountryCodeGetResponsesContentApplicationJsonSchemaDataPagesItemsSectionsItems": { "properties": { "is_disabled": { "description": "Whether the entire section is disabled.", "type": [ "boolean", "null" ] }, "questions": { "description": "List of questions within the section.", "items": { "$ref": "#/components/schemas/FormsEorCreateContractCountryCodeGetResponsesContentApplicationJsonSchemaDataPagesItemsSectionsItemsQuestionsItems" }, "type": "array" }, "subtitle": { "description": "Additional information shown at the top of the section.", "type": "string" }, "title": { "description": "Title of the section.", "type": "string" } }, "required": [ "title", "questions" ], "title": "FormsEorCreateContractCountryCodeGetResponsesContentApplicationJsonSchemaDataPagesItemsSectionsItems", "type": "object" }, "FormsEorCreateContractCountryCodeGetResponsesContentApplicationJsonSchemaDataPagesItemsSectionsItemsQuestionsItems": { "properties": { "additional_info": { "description": "Country-specific metadata for the question. The shape depends on the question key: `employment.start_date` → payroll scheduling info; `employment.end_date` → definite-contract configuration; `compensation_details.salary` → salary bounds; `employment.holidays` → PTO bounds; `employment.probation_period` → probation rules; `employment.notice_period_type` → notice period rules matrix.", "oneOf": [ { "$ref": "#/components/schemas/FormsEorCreateContractCountryCodeGetResponsesContentApplicationJsonSchemaDataPagesItemsSectionsItemsQuestionsItemsAdditionalInfo" }, { "type": "null" } ] }, "date_limitation": { "description": "Limits date selection (e.g., blocking past dates). Will always be 'BLOCK_PAST' for now.", "oneOf": [ { "$ref": "#/components/schemas/FormsEorCreateContractCountryCodeGetResponsesContentApplicationJsonSchemaDataPagesItemsSectionsItemsQuestionsItemsDateLimitation" }, { "type": "null" } ] }, "default_value": { "$ref": "#/components/schemas/FormsEorCreateContractCountryCodeGetResponsesContentApplicationJsonSchemaDataPagesItemsSectionsItemsQuestionsItemsDefaultValue", "description": "Default value to pre-fill in the form." }, "helper_text": { "description": "Additional information to assist the user.", "type": [ "string", "null" ] }, "is_disabled": { "description": "If true, the field is disabled and cannot be edited.", "type": "boolean" }, "is_multiple_selection": { "description": "Indicates if the user can select multiple values.", "type": "boolean" }, "is_only_digits": { "description": "Restricts input to numeric characters only, for FreeText questions.", "type": "boolean" }, "is_range": { "description": "Specifies whether a date picker allows range selection.", "type": "boolean" }, "is_required": { "description": "Indicates if the question is required.", "type": "boolean" }, "key": { "description": "Unique key identifier for the question.", "type": "string" }, "max_length": { "description": "Maximum character length for text responses.", "type": [ "integer", "null" ] }, "max_value": { "$ref": "#/components/schemas/FormsEorCreateContractCountryCodeGetResponsesContentApplicationJsonSchemaDataPagesItemsSectionsItemsQuestionsItemsMaxValue", "description": "Maximum value allowed." }, "min_length": { "description": "Minimum character length for text responses.", "type": [ "integer", "null" ] }, "min_value": { "$ref": "#/components/schemas/FormsEorCreateContractCountryCodeGetResponsesContentApplicationJsonSchemaDataPagesItemsSectionsItemsQuestionsItemsMinValue", "description": "Minimum value allowed." }, "must_request_validation": { "description": "Whether additional validation should be triggered for this field.", "type": "boolean" }, "number_type": { "description": "Used for number fields to define the unit or representation.", "type": "string" }, "options": { "description": "List of selectable options for selection-type questions. Value may be of any type.", "items": { "$ref": "#/components/schemas/FormsEorCreateContractCountryCodeGetResponsesContentApplicationJsonSchemaDataPagesItemsSectionsItemsQuestionsItemsOptionsItems" }, "type": [ "array", "null" ] }, "questions": { "description": "For Nested questions: the child questions within this group.", "items": { "$ref": "#/components/schemas/FormsEorCreateContractCountryCodeGetResponsesContentApplicationJsonSchemaDataPagesItemsSectionsItemsQuestionsItemsQuestionsItems" }, "type": [ "array", "null" ] }, "rules": { "description": "Validation rules for the question.", "items": { "$ref": "#/components/schemas/FormsEorCreateContractCountryCodeGetResponsesContentApplicationJsonSchemaDataPagesItemsSectionsItemsQuestionsItemsRulesItems" }, "type": [ "array", "null" ] }, "source": { "description": "Defines dynamic data source for the question.", "oneOf": [ { "$ref": "#/components/schemas/FormsEorCreateContractCountryCodeGetResponsesContentApplicationJsonSchemaDataPagesItemsSectionsItemsQuestionsItemsSource" }, { "type": "null" } ] }, "time_unit": { "description": "Time unit associated with numeric duration questions.", "type": [ "string", "null" ] }, "title": { "description": "Title of the question.", "type": "string" }, "type": { "$ref": "#/components/schemas/FormsEorCreateContractCountryCodeGetResponsesContentApplicationJsonSchemaDataPagesItemsSectionsItemsQuestionsItemsType", "description": "Type of the question." }, "variant_id": { "description": "Variant identifier used to distinguish different renderings of the same key.", "type": [ "string", "null" ] } }, "required": [ "key", "type", "title" ], "title": "FormsEorCreateContractCountryCodeGetResponsesContentApplicationJsonSchemaDataPagesItemsSectionsItemsQuestionsItems", "type": "object" }, "FormsEorCreateContractCountryCodeGetResponsesContentApplicationJsonSchemaDataPagesItemsSectionsItemsQuestionsItemsAdditionalInfo": { "description": "Country-specific metadata for the question. The shape depends on the question key: `employment.start_date` → payroll scheduling info; `employment.end_date` → definite-contract configuration; `compensation_details.salary` → salary bounds; `employment.holidays` → PTO bounds; `employment.probation_period` → probation rules; `employment.notice_period_type` → notice period rules matrix.", "oneOf": [ { "$ref": "#/components/schemas/FormsEorCreateContractCountryCodeGetResponsesContentApplicationJsonSchemaDataPagesItemsSectionsItemsQuestionsItemsAdditionalInfo0" }, { "$ref": "#/components/schemas/FormsEorCreateContractCountryCodeGetResponsesContentApplicationJsonSchemaDataPagesItemsSectionsItemsQuestionsItemsAdditionalInfo1" }, { "$ref": "#/components/schemas/FormsEorCreateContractCountryCodeGetResponsesContentApplicationJsonSchemaDataPagesItemsSectionsItemsQuestionsItemsAdditionalInfo2" }, { "$ref": "#/components/schemas/FormsEorCreateContractCountryCodeGetResponsesContentApplicationJsonSchemaDataPagesItemsSectionsItemsQuestionsItemsAdditionalInfo3" }, { "$ref": "#/components/schemas/FormsEorCreateContractCountryCodeGetResponsesContentApplicationJsonSchemaDataPagesItemsSectionsItemsQuestionsItemsAdditionalInfo4" }, { "$ref": "#/components/schemas/FormsEorCreateContractCountryCodeGetResponsesContentApplicationJsonSchemaDataPagesItemsSectionsItemsQuestionsItemsAdditionalInfo5" } ], "title": "FormsEorCreateContractCountryCodeGetResponsesContentApplicationJsonSchemaDataPagesItemsSectionsItemsQuestionsItemsAdditionalInfo" }, "FormsEorCreateContractCountryCodeGetResponsesContentApplicationJsonSchemaDataPagesItemsSectionsItemsQuestionsItemsAdditionalInfo0": { "description": "Additional info for the `employment.start_date` question.", "properties": { "is_same_month_payment_country": { "description": "Whether this country processes payroll in the same month as the employment start date (true) or the following month (false).", "type": "boolean" }, "min_value_buffer_in_days": { "description": "Minimum number of days from today before a start date can be selected. A value of 0 means the earliest available date is today (or the first upcoming payroll-eligible date). Null when no start date buffer is configured for the country.", "type": [ "integer", "null" ] }, "payroll_lock": { "description": "Day of the month after which the start date can no longer be set in the current month (payroll lock day).", "type": "integer" } }, "required": [ "payroll_lock", "min_value_buffer_in_days", "is_same_month_payment_country" ], "title": "FormsEorCreateContractCountryCodeGetResponsesContentApplicationJsonSchemaDataPagesItemsSectionsItemsQuestionsItemsAdditionalInfo0", "type": "object" }, "FormsEorCreateContractCountryCodeGetResponsesContentApplicationJsonSchemaDataPagesItemsSectionsItemsQuestionsItemsAdditionalInfo1": { "description": "Additional info for the `employment.end_date` question.", "properties": { "maximum_limitation_in_months": { "description": "Maximum fixed-term contract duration in months. Null when there is no maximum limitation.", "type": [ "integer", "null" ] }, "min_value_buffer_in_days": { "description": "Minimum fixed-term contract duration in days. Null when definite contracts are not allowed (type is NOT_ALLOWED). Represents the minimum gap between start_date and end_date.", "type": [ "integer", "null" ] }, "type": { "$ref": "#/components/schemas/FormsEorCreateContractCountryCodeGetResponsesContentApplicationJsonSchemaDataPagesItemsSectionsItemsQuestionsItemsAdditionalInfoOneOf1Type", "description": "Definite-contract policy for this country. Possible values: NOT_ALLOWED (no fixed-term contracts), ALLOWED_WITHOUT_LIMITATION (fixed-term allowed without duration limit), ALLOWED_WITH_MAXIMUM_LIMITATION (fixed-term allowed up to a maximum duration)." } }, "required": [ "type" ], "title": "FormsEorCreateContractCountryCodeGetResponsesContentApplicationJsonSchemaDataPagesItemsSectionsItemsQuestionsItemsAdditionalInfo1", "type": "object" }, "FormsEorCreateContractCountryCodeGetResponsesContentApplicationJsonSchemaDataPagesItemsSectionsItemsQuestionsItemsAdditionalInfo2": { "description": "Additional info for the `compensation_details.salary` question.", "properties": { "additional_payments": { "description": "Country-mandated irregular payments (e.g. 13th salary, profit sharing) that are included in the total employment cost.", "items": { "$ref": "#/components/schemas/FormsEorCreateContractCountryCodeGetResponsesContentApplicationJsonSchemaDataPagesItemsSectionsItemsQuestionsItemsAdditionalInfoOneOf2AdditionalPaymentsItems" }, "type": "array" }, "max_salary": { "description": "Maximum allowable gross annual salary for this country. Null when no maximum salary is configured for the country.", "format": "double", "type": [ "number", "null" ] }, "min_salary": { "description": "Minimum allowable gross annual salary for this country. Null when no minimum salary is configured for the country.", "format": "double", "type": [ "number", "null" ] }, "part_time_holiday_type": { "description": "How holiday pay is calculated for part-time employees (e.g. PRORATED, STANDARD).", "type": "string" }, "standard_hours_per_week": { "description": "Standard working hours per week used as the full-time reference.", "format": "double", "type": "number" } }, "required": [ "max_salary", "min_salary", "additional_payments" ], "title": "FormsEorCreateContractCountryCodeGetResponsesContentApplicationJsonSchemaDataPagesItemsSectionsItemsQuestionsItemsAdditionalInfo2", "type": "object" }, "FormsEorCreateContractCountryCodeGetResponsesContentApplicationJsonSchemaDataPagesItemsSectionsItemsQuestionsItemsAdditionalInfo3": { "description": "Additional info for the `employment.holidays` question.", "properties": { "max_holidays": { "description": "Maximum paid vacation days allowed. Null when there is no upper limit.", "format": "double", "type": [ "number", "null" ] }, "min_holidays": { "description": "Minimum statutory paid vacation days for this country.", "format": "double", "type": "number" }, "part_time_holiday_type": { "description": "How holiday entitlement is calculated for part-time employees (e.g. PRORATED, STANDARD).", "type": "string" }, "standard_hours_per_week": { "description": "Standard working hours per week used as the full-time reference.", "format": "double", "type": "number" } }, "required": [ "min_holidays", "standard_hours_per_week" ], "title": "FormsEorCreateContractCountryCodeGetResponsesContentApplicationJsonSchemaDataPagesItemsSectionsItemsQuestionsItemsAdditionalInfo3", "type": "object" }, "FormsEorCreateContractCountryCodeGetResponsesContentApplicationJsonSchemaDataPagesItemsSectionsItemsQuestionsItemsAdditionalInfo4": { "description": "Additional info for the `employment.probation_period` question.", "properties": { "probation_type_for_definite": { "$ref": "#/components/schemas/FormsEorCreateContractCountryCodeGetResponsesContentApplicationJsonSchemaDataPagesItemsSectionsItemsQuestionsItemsAdditionalInfoOneOf4ProbationTypeForDefinite", "description": "How the probation period is determined for definite (fixed-term) contracts. Possible values: STANDARD (fixed statutory period), SPECIFIC_CALCULATION (calculated from a rule), SPECIFIC_TO_DURATION_OF_CONTRACT (derived from contract length)." }, "specific_calculation_rules": { "description": "Calculation rules when probation_type_for_definite is SPECIFIC_CALCULATION. Null for other types.", "oneOf": [ { "$ref": "#/components/schemas/FormsEorCreateContractCountryCodeGetResponsesContentApplicationJsonSchemaDataPagesItemsSectionsItemsQuestionsItemsAdditionalInfoOneOf4SpecificCalculationRules" }, { "type": "null" } ] }, "specific_to_duration_of_contract_rules": { "description": "Rules mapping contract duration ranges to probation periods when probation_type_for_definite is SPECIFIC_TO_DURATION_OF_CONTRACT. Null for other types.", "items": { "$ref": "#/components/schemas/FormsEorCreateContractCountryCodeGetResponsesContentApplicationJsonSchemaDataPagesItemsSectionsItemsQuestionsItemsAdditionalInfoOneOf4SpecificToDurationOfContractRulesItems" }, "type": [ "array", "null" ] } }, "required": [ "probation_type_for_definite" ], "title": "FormsEorCreateContractCountryCodeGetResponsesContentApplicationJsonSchemaDataPagesItemsSectionsItemsQuestionsItemsAdditionalInfo4", "type": "object" }, "FormsEorCreateContractCountryCodeGetResponsesContentApplicationJsonSchemaDataPagesItemsSectionsItemsQuestionsItemsAdditionalInfo5": { "description": "Additional info for the `employment.notice_period_type` question.", "properties": { "notice_period_rule_type": { "description": "Notice-period rule type for the country (e.g. LIMITED_AGREEMENT, FIXED_AGREEMENT).", "type": "string" }, "notice_period_settings": { "description": "Notice-period configuration, one entry per employment type and term combination.", "items": { "$ref": "#/components/schemas/FormsEorCreateContractCountryCodeGetResponsesContentApplicationJsonSchemaDataPagesItemsSectionsItemsQuestionsItemsAdditionalInfoOneOf5NoticePeriodSettingsItems" }, "type": "array" }, "notice_period_time_unit": { "description": "Primary display time unit for the notice period (DAY, WEEK, or MONTH).", "type": "string" } }, "required": [ "notice_period_settings", "notice_period_rule_type", "notice_period_time_unit" ], "title": "FormsEorCreateContractCountryCodeGetResponsesContentApplicationJsonSchemaDataPagesItemsSectionsItemsQuestionsItemsAdditionalInfo5", "type": "object" }, "FormsEorCreateContractCountryCodeGetResponsesContentApplicationJsonSchemaDataPagesItemsSectionsItemsQuestionsItemsAdditionalInfoOneOf1Type": { "description": "Definite-contract policy for this country. Possible values: NOT_ALLOWED (no fixed-term contracts), ALLOWED_WITHOUT_LIMITATION (fixed-term allowed without duration limit), ALLOWED_WITH_MAXIMUM_LIMITATION (fixed-term allowed up to a maximum duration).", "enum": [ "NOT_ALLOWED", "ALLOWED_WITHOUT_LIMITATION", "ALLOWED_WITH_MAXIMUM_LIMITATION" ], "title": "FormsEorCreateContractCountryCodeGetResponsesContentApplicationJsonSchemaDataPagesItemsSectionsItemsQuestionsItemsAdditionalInfoOneOf1Type", "type": "string" }, "FormsEorCreateContractCountryCodeGetResponsesContentApplicationJsonSchemaDataPagesItemsSectionsItemsQuestionsItemsAdditionalInfoOneOf2AdditionalPaymentsItems": { "properties": { "amount": { "description": "Fixed amount of the payment (0 when it is percentage-based).", "format": "double", "type": [ "number", "null" ] }, "how_its_calculated": { "description": "Human-readable explanation of the calculation method.", "type": [ "string", "null" ] }, "invoicing_months": { "description": "Months in which the payment is invoiced.", "items": { "type": "string" }, "type": [ "array", "null" ] }, "invoicing_type": { "description": "How the payment is invoiced (e.g. Single Month, Multiple Months).", "type": [ "string", "null" ] }, "payment_local_name": { "description": "Local-language name of the additional payment.", "type": [ "string", "null" ] }, "payment_name": { "description": "Display name of the additional payment.", "type": "string" } }, "title": "FormsEorCreateContractCountryCodeGetResponsesContentApplicationJsonSchemaDataPagesItemsSectionsItemsQuestionsItemsAdditionalInfoOneOf2AdditionalPaymentsItems", "type": "object" }, "FormsEorCreateContractCountryCodeGetResponsesContentApplicationJsonSchemaDataPagesItemsSectionsItemsQuestionsItemsAdditionalInfoOneOf4ProbationTypeForDefinite": { "description": "How the probation period is determined for definite (fixed-term) contracts. Possible values: STANDARD (fixed statutory period), SPECIFIC_CALCULATION (calculated from a rule), SPECIFIC_TO_DURATION_OF_CONTRACT (derived from contract length).", "enum": [ "STANDARD", "SPECIFIC_CALCULATION", "SPECIFIC_TO_DURATION_OF_CONTRACT" ], "title": "FormsEorCreateContractCountryCodeGetResponsesContentApplicationJsonSchemaDataPagesItemsSectionsItemsQuestionsItemsAdditionalInfoOneOf4ProbationTypeForDefinite", "type": "string" }, "FormsEorCreateContractCountryCodeGetResponsesContentApplicationJsonSchemaDataPagesItemsSectionsItemsQuestionsItemsAdditionalInfoOneOf4SpecificCalculationRules": { "description": "Calculation rules when probation_type_for_definite is SPECIFIC_CALCULATION. Null for other types.", "properties": { "max_probation_for_definite": { "description": "Maximum probation duration (in the unit specified by time_unit).", "format": "double", "type": "number" }, "max_probation_type_for_definite": { "description": "The formula used to derive the maximum probation period for a definite contract.", "type": "string" }, "min_probation_for_definite": { "description": "Minimum probation duration (in the unit specified by time_unit).", "format": "double", "type": "number" }, "time_unit": { "$ref": "#/components/schemas/FormsEorCreateContractCountryCodeGetResponsesContentApplicationJsonSchemaDataPagesItemsSectionsItemsQuestionsItemsAdditionalInfoOneOf4SpecificCalculationRulesTimeUnit", "description": "Time unit for all probation durations in this object (DAY, WEEK, or MONTH)." } }, "title": "FormsEorCreateContractCountryCodeGetResponsesContentApplicationJsonSchemaDataPagesItemsSectionsItemsQuestionsItemsAdditionalInfoOneOf4SpecificCalculationRules", "type": "object" }, "FormsEorCreateContractCountryCodeGetResponsesContentApplicationJsonSchemaDataPagesItemsSectionsItemsQuestionsItemsAdditionalInfoOneOf4SpecificCalculationRulesTimeUnit": { "description": "Time unit for all probation durations in this object (DAY, WEEK, or MONTH).", "enum": [ "DAY", "WEEK", "MONTH" ], "title": "FormsEorCreateContractCountryCodeGetResponsesContentApplicationJsonSchemaDataPagesItemsSectionsItemsQuestionsItemsAdditionalInfoOneOf4SpecificCalculationRulesTimeUnit", "type": "string" }, "FormsEorCreateContractCountryCodeGetResponsesContentApplicationJsonSchemaDataPagesItemsSectionsItemsQuestionsItemsAdditionalInfoOneOf4SpecificToDurationOfContractRulesItems": { "properties": { "employment_duration_type": { "$ref": "#/components/schemas/FormsEorCreateContractCountryCodeGetResponsesContentApplicationJsonSchemaDataPagesItemsSectionsItemsQuestionsItemsAdditionalInfoOneOf4SpecificToDurationOfContractRulesItemsEmploymentDurationType", "description": "Time unit for the employment duration bounds (DAY, WEEK, MONTH, or YEAR)." }, "max_employment_duration": { "description": "Upper bound of the contract duration range. Null when unbounded.", "format": "double", "type": [ "number", "null" ] }, "min_employment_duration": { "description": "Lower bound of the contract duration range.", "format": "double", "type": "number" }, "min_probation_period": { "description": "Minimum probation duration for contracts in this range.", "format": "double", "type": "number" }, "probation_period": { "description": "Probation duration for contracts in this range.", "format": "double", "type": "number" }, "time_unit": { "$ref": "#/components/schemas/FormsEorCreateContractCountryCodeGetResponsesContentApplicationJsonSchemaDataPagesItemsSectionsItemsQuestionsItemsAdditionalInfoOneOf4SpecificToDurationOfContractRulesItemsTimeUnit", "description": "Time unit for probation_period and min_probation_period (DAY, WEEK, or MONTH)." } }, "title": "FormsEorCreateContractCountryCodeGetResponsesContentApplicationJsonSchemaDataPagesItemsSectionsItemsQuestionsItemsAdditionalInfoOneOf4SpecificToDurationOfContractRulesItems", "type": "object" }, "FormsEorCreateContractCountryCodeGetResponsesContentApplicationJsonSchemaDataPagesItemsSectionsItemsQuestionsItemsAdditionalInfoOneOf4SpecificToDurationOfContractRulesItemsEmploymentDurationType": { "description": "Time unit for the employment duration bounds (DAY, WEEK, MONTH, or YEAR).", "enum": [ "DAY", "WEEK", "MONTH", "YEAR" ], "title": "FormsEorCreateContractCountryCodeGetResponsesContentApplicationJsonSchemaDataPagesItemsSectionsItemsQuestionsItemsAdditionalInfoOneOf4SpecificToDurationOfContractRulesItemsEmploymentDurationType", "type": "string" }, "FormsEorCreateContractCountryCodeGetResponsesContentApplicationJsonSchemaDataPagesItemsSectionsItemsQuestionsItemsAdditionalInfoOneOf4SpecificToDurationOfContractRulesItemsTimeUnit": { "description": "Time unit for probation_period and min_probation_period (DAY, WEEK, or MONTH).", "enum": [ "DAY", "WEEK", "MONTH" ], "title": "FormsEorCreateContractCountryCodeGetResponsesContentApplicationJsonSchemaDataPagesItemsSectionsItemsQuestionsItemsAdditionalInfoOneOf4SpecificToDurationOfContractRulesItemsTimeUnit", "type": "string" }, "FormsEorCreateContractCountryCodeGetResponsesContentApplicationJsonSchemaDataPagesItemsSectionsItemsQuestionsItemsAdditionalInfoOneOf5NoticePeriodSettingsItems": { "properties": { "employment_term": { "$ref": "#/components/schemas/FormsEorCreateContractCountryCodeGetResponsesContentApplicationJsonSchemaDataPagesItemsSectionsItemsQuestionsItemsAdditionalInfoOneOf5NoticePeriodSettingsItemsEmploymentTerm", "description": "Employment term this rule applies to." }, "employment_type": { "$ref": "#/components/schemas/FormsEorCreateContractCountryCodeGetResponsesContentApplicationJsonSchemaDataPagesItemsSectionsItemsQuestionsItemsAdditionalInfoOneOf5NoticePeriodSettingsItemsEmploymentType", "description": "Employment type this rule applies to." }, "notice_period_after_probation": { "$ref": "#/components/schemas/FormsEorCreateContractCountryCodeGetResponsesContentApplicationJsonSchemaDataPagesItemsSectionsItemsQuestionsItemsAdditionalInfoOneOf5NoticePeriodSettingsItemsNoticePeriodAfterProbation", "description": "Notice period minimum/maximum bounds and default for this segment." }, "notice_period_during_probation": { "$ref": "#/components/schemas/FormsEorCreateContractCountryCodeGetResponsesContentApplicationJsonSchemaDataPagesItemsSectionsItemsQuestionsItemsAdditionalInfoOneOf5NoticePeriodSettingsItemsNoticePeriodDuringProbation", "description": "Notice period minimum/maximum bounds and default for this segment." }, "tenure_rules": { "description": "Tenure-based notice period rules, used when the notice type is TENURE_BASED.", "items": { "$ref": "#/components/schemas/FormsEorCreateContractCountryCodeGetResponsesContentApplicationJsonSchemaDataPagesItemsSectionsItemsQuestionsItemsAdditionalInfoOneOf5NoticePeriodSettingsItemsTenureRulesItems" }, "type": "array" }, "type_for_after_probation": { "description": "How the notice period is determined after probation (e.g. NO_NOTICE_PERIOD, MIN_MAX_LIMITED, SPECIFIC, TENURE_BASED).", "type": "string" }, "type_for_during_probation": { "description": "How the notice period is determined during probation (e.g. NO_NOTICE_PERIOD, MIN_MAX_LIMITED, SPECIFIC, TENURE_BASED).", "type": "string" } }, "title": "FormsEorCreateContractCountryCodeGetResponsesContentApplicationJsonSchemaDataPagesItemsSectionsItemsQuestionsItemsAdditionalInfoOneOf5NoticePeriodSettingsItems", "type": "object" }, "FormsEorCreateContractCountryCodeGetResponsesContentApplicationJsonSchemaDataPagesItemsSectionsItemsQuestionsItemsAdditionalInfoOneOf5NoticePeriodSettingsItemsEmploymentTerm": { "description": "Employment term this rule applies to.", "enum": [ "DEFINITE", "INDEFINITE" ], "title": "FormsEorCreateContractCountryCodeGetResponsesContentApplicationJsonSchemaDataPagesItemsSectionsItemsQuestionsItemsAdditionalInfoOneOf5NoticePeriodSettingsItemsEmploymentTerm", "type": "string" }, "FormsEorCreateContractCountryCodeGetResponsesContentApplicationJsonSchemaDataPagesItemsSectionsItemsQuestionsItemsAdditionalInfoOneOf5NoticePeriodSettingsItemsEmploymentType": { "description": "Employment type this rule applies to.", "enum": [ "FULL_TIME", "PART_TIME" ], "title": "FormsEorCreateContractCountryCodeGetResponsesContentApplicationJsonSchemaDataPagesItemsSectionsItemsQuestionsItemsAdditionalInfoOneOf5NoticePeriodSettingsItemsEmploymentType", "type": "string" }, "FormsEorCreateContractCountryCodeGetResponsesContentApplicationJsonSchemaDataPagesItemsSectionsItemsQuestionsItemsAdditionalInfoOneOf5NoticePeriodSettingsItemsNoticePeriodAfterProbation": { "description": "Notice period minimum/maximum bounds and default for this segment.", "properties": { "default_value": { "description": "Default notice period value. Null when there is no default.", "type": [ "integer", "null" ] }, "max_value": { "description": "Maximum notice period value. Null when not applicable.", "type": [ "integer", "null" ] }, "min_value": { "description": "Minimum notice period value. Null when not applicable.", "type": [ "integer", "null" ] }, "time_unit": { "$ref": "#/components/schemas/FormsEorCreateContractCountryCodeGetResponsesContentApplicationJsonSchemaDataPagesItemsSectionsItemsQuestionsItemsAdditionalInfoOneOf5NoticePeriodSettingsItemsNoticePeriodAfterProbationTimeUnit", "description": "Time unit for the notice period values." } }, "title": "FormsEorCreateContractCountryCodeGetResponsesContentApplicationJsonSchemaDataPagesItemsSectionsItemsQuestionsItemsAdditionalInfoOneOf5NoticePeriodSettingsItemsNoticePeriodAfterProbation", "type": "object" }, "FormsEorCreateContractCountryCodeGetResponsesContentApplicationJsonSchemaDataPagesItemsSectionsItemsQuestionsItemsAdditionalInfoOneOf5NoticePeriodSettingsItemsNoticePeriodAfterProbationTimeUnit": { "description": "Time unit for the notice period values.", "enum": [ "DAY", "WEEK", "MONTH" ], "title": "FormsEorCreateContractCountryCodeGetResponsesContentApplicationJsonSchemaDataPagesItemsSectionsItemsQuestionsItemsAdditionalInfoOneOf5NoticePeriodSettingsItemsNoticePeriodAfterProbationTimeUnit", "type": "string" }, "FormsEorCreateContractCountryCodeGetResponsesContentApplicationJsonSchemaDataPagesItemsSectionsItemsQuestionsItemsAdditionalInfoOneOf5NoticePeriodSettingsItemsNoticePeriodDuringProbation": { "description": "Notice period minimum/maximum bounds and default for this segment.", "properties": { "default_value": { "description": "Default notice period value. Null when there is no default.", "type": [ "integer", "null" ] }, "max_value": { "description": "Maximum notice period value. Null when not applicable.", "type": [ "integer", "null" ] }, "min_value": { "description": "Minimum notice period value. Null when not applicable.", "type": [ "integer", "null" ] }, "time_unit": { "$ref": "#/components/schemas/FormsEorCreateContractCountryCodeGetResponsesContentApplicationJsonSchemaDataPagesItemsSectionsItemsQuestionsItemsAdditionalInfoOneOf5NoticePeriodSettingsItemsNoticePeriodDuringProbationTimeUnit", "description": "Time unit for the notice period values." } }, "title": "FormsEorCreateContractCountryCodeGetResponsesContentApplicationJsonSchemaDataPagesItemsSectionsItemsQuestionsItemsAdditionalInfoOneOf5NoticePeriodSettingsItemsNoticePeriodDuringProbation", "type": "object" }, "FormsEorCreateContractCountryCodeGetResponsesContentApplicationJsonSchemaDataPagesItemsSectionsItemsQuestionsItemsAdditionalInfoOneOf5NoticePeriodSettingsItemsNoticePeriodDuringProbationTimeUnit": { "description": "Time unit for the notice period values.", "enum": [ "DAY", "WEEK", "MONTH" ], "title": "FormsEorCreateContractCountryCodeGetResponsesContentApplicationJsonSchemaDataPagesItemsSectionsItemsQuestionsItemsAdditionalInfoOneOf5NoticePeriodSettingsItemsNoticePeriodDuringProbationTimeUnit", "type": "string" }, "FormsEorCreateContractCountryCodeGetResponsesContentApplicationJsonSchemaDataPagesItemsSectionsItemsQuestionsItemsAdditionalInfoOneOf5NoticePeriodSettingsItemsTenureRulesItems": { "properties": { "employment_duration_type": { "$ref": "#/components/schemas/FormsEorCreateContractCountryCodeGetResponsesContentApplicationJsonSchemaDataPagesItemsSectionsItemsQuestionsItemsAdditionalInfoOneOf5NoticePeriodSettingsItemsTenureRulesItemsEmploymentDurationType", "description": "Time unit for the employment-duration bounds." }, "max_employment_duration": { "description": "Upper bound of the employment-duration range. Null when unbounded.", "type": [ "integer", "null" ] }, "min_employment_duration": { "description": "Lower bound of the employment-duration range.", "type": "integer" }, "notice_value": { "description": "Notice period value for contracts in this tenure range.", "type": "integer" }, "time_unit": { "$ref": "#/components/schemas/FormsEorCreateContractCountryCodeGetResponsesContentApplicationJsonSchemaDataPagesItemsSectionsItemsQuestionsItemsAdditionalInfoOneOf5NoticePeriodSettingsItemsTenureRulesItemsTimeUnit", "description": "Time unit for notice_value." } }, "title": "FormsEorCreateContractCountryCodeGetResponsesContentApplicationJsonSchemaDataPagesItemsSectionsItemsQuestionsItemsAdditionalInfoOneOf5NoticePeriodSettingsItemsTenureRulesItems", "type": "object" }, "FormsEorCreateContractCountryCodeGetResponsesContentApplicationJsonSchemaDataPagesItemsSectionsItemsQuestionsItemsAdditionalInfoOneOf5NoticePeriodSettingsItemsTenureRulesItemsEmploymentDurationType": { "description": "Time unit for the employment-duration bounds.", "enum": [ "DAY", "WEEK", "MONTH", "YEAR" ], "title": "FormsEorCreateContractCountryCodeGetResponsesContentApplicationJsonSchemaDataPagesItemsSectionsItemsQuestionsItemsAdditionalInfoOneOf5NoticePeriodSettingsItemsTenureRulesItemsEmploymentDurationType", "type": "string" }, "FormsEorCreateContractCountryCodeGetResponsesContentApplicationJsonSchemaDataPagesItemsSectionsItemsQuestionsItemsAdditionalInfoOneOf5NoticePeriodSettingsItemsTenureRulesItemsTimeUnit": { "description": "Time unit for notice_value.", "enum": [ "DAY", "WEEK", "MONTH" ], "title": "FormsEorCreateContractCountryCodeGetResponsesContentApplicationJsonSchemaDataPagesItemsSectionsItemsQuestionsItemsAdditionalInfoOneOf5NoticePeriodSettingsItemsTenureRulesItemsTimeUnit", "type": "string" }, "FormsEorCreateContractCountryCodeGetResponsesContentApplicationJsonSchemaDataPagesItemsSectionsItemsQuestionsItemsDateLimitation": { "description": "Limits date selection (e.g., blocking past dates). Will always be 'BLOCK_PAST' for now.", "enum": [ "BLOCK_PAST", "BLOCK_FUTURE" ], "title": "FormsEorCreateContractCountryCodeGetResponsesContentApplicationJsonSchemaDataPagesItemsSectionsItemsQuestionsItemsDateLimitation", "type": "string" }, "FormsEorCreateContractCountryCodeGetResponsesContentApplicationJsonSchemaDataPagesItemsSectionsItemsQuestionsItemsDefaultValue": { "description": "Default value to pre-fill in the form.", "oneOf": [ { "type": "string" }, { "format": "double", "type": "number" }, { "type": "boolean" } ], "title": "FormsEorCreateContractCountryCodeGetResponsesContentApplicationJsonSchemaDataPagesItemsSectionsItemsQuestionsItemsDefaultValue" }, "FormsEorCreateContractCountryCodeGetResponsesContentApplicationJsonSchemaDataPagesItemsSectionsItemsQuestionsItemsMaxValue": { "description": "Maximum value allowed.", "oneOf": [ { "type": "string" }, { "format": "double", "type": "number" } ], "title": "FormsEorCreateContractCountryCodeGetResponsesContentApplicationJsonSchemaDataPagesItemsSectionsItemsQuestionsItemsMaxValue" }, "FormsEorCreateContractCountryCodeGetResponsesContentApplicationJsonSchemaDataPagesItemsSectionsItemsQuestionsItemsMinValue": { "description": "Minimum value allowed.", "oneOf": [ { "type": "string" }, { "format": "double", "type": "number" } ], "title": "FormsEorCreateContractCountryCodeGetResponsesContentApplicationJsonSchemaDataPagesItemsSectionsItemsQuestionsItemsMinValue" }, "FormsEorCreateContractCountryCodeGetResponsesContentApplicationJsonSchemaDataPagesItemsSectionsItemsQuestionsItemsOptionsItems": { "properties": { "is_disabled": { "description": "Whether this specific option is disabled for the selected country.", "type": [ "boolean", "null" ] }, "rules": { "description": "Conditional rules that apply when this option is selected.", "items": { "$ref": "#/components/schemas/FormsEorCreateContractCountryCodeGetResponsesContentApplicationJsonSchemaDataPagesItemsSectionsItemsQuestionsItemsOptionsItemsRulesItems" }, "type": [ "array", "null" ] }, "title": { "description": "Display text for the option.", "type": "string" }, "value": { "description": "Value associated with the option.", "type": [ "string", "null" ] } }, "title": "FormsEorCreateContractCountryCodeGetResponsesContentApplicationJsonSchemaDataPagesItemsSectionsItemsQuestionsItemsOptionsItems", "type": "object" }, "FormsEorCreateContractCountryCodeGetResponsesContentApplicationJsonSchemaDataPagesItemsSectionsItemsQuestionsItemsOptionsItemsRulesItems": { "description": "A rule that modifies another question based on this option being selected.", "properties": {}, "title": "FormsEorCreateContractCountryCodeGetResponsesContentApplicationJsonSchemaDataPagesItemsSectionsItemsQuestionsItemsOptionsItemsRulesItems", "type": "object" }, "FormsEorCreateContractCountryCodeGetResponsesContentApplicationJsonSchemaDataPagesItemsSectionsItemsQuestionsItemsQuestionsItems": { "description": "A single child question within a Nested parent.", "properties": {}, "title": "FormsEorCreateContractCountryCodeGetResponsesContentApplicationJsonSchemaDataPagesItemsSectionsItemsQuestionsItemsQuestionsItems", "type": "object" }, "FormsEorCreateContractCountryCodeGetResponsesContentApplicationJsonSchemaDataPagesItemsSectionsItemsQuestionsItemsRulesItems": { "properties": { "date_limitation": { "description": "Limits date selection (e.g., blocking past dates). Will always be 'BLOCK_PAST' for now.", "type": [ "string", "null" ] }, "default_value": { "$ref": "#/components/schemas/FormsEorCreateContractCountryCodeGetResponsesContentApplicationJsonSchemaDataPagesItemsSectionsItemsQuestionsItemsRulesItemsDefaultValue", "description": "Default value to pre-fill in the form." }, "helper_text": { "description": "Additional information to assist the user.", "type": [ "string", "null" ] }, "is_disabled": { "description": "If true, the field is disabled and cannot be edited.", "type": "boolean" }, "is_multiple_selection": { "description": "Indicates if the user can select multiple values.", "type": "boolean" }, "is_only_digits": { "description": "Restricts input to numeric characters only, for FreeText questions.", "type": "boolean" }, "is_range": { "description": "Specifies whether a date picker allows range selection.", "type": "boolean" }, "is_required": { "description": "Indicates if the question is required.", "type": "boolean" }, "max_length": { "description": "Maximum character length for text responses.", "type": [ "integer", "null" ] }, "max_value": { "$ref": "#/components/schemas/FormsEorCreateContractCountryCodeGetResponsesContentApplicationJsonSchemaDataPagesItemsSectionsItemsQuestionsItemsRulesItemsMaxValue", "description": "Maximum value allowed." }, "min_length": { "description": "Minimum character length for text responses.", "type": [ "integer", "null" ] }, "min_value": { "$ref": "#/components/schemas/FormsEorCreateContractCountryCodeGetResponsesContentApplicationJsonSchemaDataPagesItemsSectionsItemsQuestionsItemsRulesItemsMinValue", "description": "Minimum value allowed." }, "must_request_validation": { "description": "Whether additional validation should be triggered for this field.", "type": "boolean" }, "number_type": { "description": "Used for number fields to define the unit or representation.", "type": "string" }, "options": { "description": "List of selectable options for selection-type questions. Value may be of any type.", "items": { "$ref": "#/components/schemas/FormsEorCreateContractCountryCodeGetResponsesContentApplicationJsonSchemaDataPagesItemsSectionsItemsQuestionsItemsRulesItemsOptionsItems" }, "type": [ "array", "null" ] }, "requires": { "description": "List of conditions that must be met for this rule to apply.", "items": { "$ref": "#/components/schemas/FormsEorCreateContractCountryCodeGetResponsesContentApplicationJsonSchemaDataPagesItemsSectionsItemsQuestionsItemsRulesItemsRequiresItems" }, "type": "array" }, "source": { "description": "Defines dynamic data source for the question.", "oneOf": [ { "$ref": "#/components/schemas/FormsEorCreateContractCountryCodeGetResponsesContentApplicationJsonSchemaDataPagesItemsSectionsItemsQuestionsItemsRulesItemsSource" }, { "type": "null" } ] }, "title": { "description": "Title of the question.", "type": "string" } }, "title": "FormsEorCreateContractCountryCodeGetResponsesContentApplicationJsonSchemaDataPagesItemsSectionsItemsQuestionsItemsRulesItems", "type": "object" }, "FormsEorCreateContractCountryCodeGetResponsesContentApplicationJsonSchemaDataPagesItemsSectionsItemsQuestionsItemsRulesItemsDefaultValue": { "description": "Default value to pre-fill in the form.", "oneOf": [ { "type": "string" }, { "format": "double", "type": "number" }, { "type": "boolean" } ], "title": "FormsEorCreateContractCountryCodeGetResponsesContentApplicationJsonSchemaDataPagesItemsSectionsItemsQuestionsItemsRulesItemsDefaultValue" }, "FormsEorCreateContractCountryCodeGetResponsesContentApplicationJsonSchemaDataPagesItemsSectionsItemsQuestionsItemsRulesItemsMaxValue": { "description": "Maximum value allowed.", "oneOf": [ { "type": "string" }, { "format": "double", "type": "number" } ], "title": "FormsEorCreateContractCountryCodeGetResponsesContentApplicationJsonSchemaDataPagesItemsSectionsItemsQuestionsItemsRulesItemsMaxValue" }, "FormsEorCreateContractCountryCodeGetResponsesContentApplicationJsonSchemaDataPagesItemsSectionsItemsQuestionsItemsRulesItemsMinValue": { "description": "Minimum value allowed.", "oneOf": [ { "type": "string" }, { "format": "double", "type": "number" } ], "title": "FormsEorCreateContractCountryCodeGetResponsesContentApplicationJsonSchemaDataPagesItemsSectionsItemsQuestionsItemsRulesItemsMinValue" }, "FormsEorCreateContractCountryCodeGetResponsesContentApplicationJsonSchemaDataPagesItemsSectionsItemsQuestionsItemsRulesItemsOptionsItems": { "properties": { "title": { "description": "Display text for the option.", "type": "string" }, "value": { "description": "Value associated with the option.", "type": [ "string", "null" ] } }, "title": "FormsEorCreateContractCountryCodeGetResponsesContentApplicationJsonSchemaDataPagesItemsSectionsItemsQuestionsItemsRulesItemsOptionsItems", "type": "object" }, "FormsEorCreateContractCountryCodeGetResponsesContentApplicationJsonSchemaDataPagesItemsSectionsItemsQuestionsItemsRulesItemsRequiresItems": { "properties": { "compare_key": { "description": "Key of the field to compare against.", "type": [ "string", "null" ] }, "key": { "description": "Key of the dependent field.", "type": "string" }, "operator": { "description": "Comparison operator (e.g., 'eq', 'ne').", "type": [ "string", "null" ] }, "value": { "$ref": "#/components/schemas/FormsEorCreateContractCountryCodeGetResponsesContentApplicationJsonSchemaDataPagesItemsSectionsItemsQuestionsItemsRulesItemsRequiresItemsValue", "description": "Expected value for the condition." } }, "title": "FormsEorCreateContractCountryCodeGetResponsesContentApplicationJsonSchemaDataPagesItemsSectionsItemsQuestionsItemsRulesItemsRequiresItems", "type": "object" }, "FormsEorCreateContractCountryCodeGetResponsesContentApplicationJsonSchemaDataPagesItemsSectionsItemsQuestionsItemsRulesItemsRequiresItemsValue": { "description": "Expected value for the condition.", "oneOf": [ { "type": "string" }, { "format": "double", "type": "number" }, { "type": "boolean" } ], "title": "FormsEorCreateContractCountryCodeGetResponsesContentApplicationJsonSchemaDataPagesItemsSectionsItemsQuestionsItemsRulesItemsRequiresItemsValue" }, "FormsEorCreateContractCountryCodeGetResponsesContentApplicationJsonSchemaDataPagesItemsSectionsItemsQuestionsItemsRulesItemsSource": { "description": "Defines dynamic data source for the question.", "properties": { "definition": { "description": "Reference URL for API documentation.", "type": "string" }, "description": { "description": "Description of the data source.", "type": "string" }, "url": { "description": "API endpoint providing dynamic options.", "type": "string" } }, "title": "FormsEorCreateContractCountryCodeGetResponsesContentApplicationJsonSchemaDataPagesItemsSectionsItemsQuestionsItemsRulesItemsSource", "type": "object" }, "FormsEorCreateContractCountryCodeGetResponsesContentApplicationJsonSchemaDataPagesItemsSectionsItemsQuestionsItemsSource": { "description": "Defines dynamic data source for the question.", "properties": { "definition": { "description": "Reference URL for API documentation.", "type": "string" }, "description": { "description": "Description of the data source.", "type": "string" }, "url": { "description": "API endpoint providing dynamic options.", "type": "string" } }, "title": "FormsEorCreateContractCountryCodeGetResponsesContentApplicationJsonSchemaDataPagesItemsSectionsItemsQuestionsItemsSource", "type": "object" }, "FormsEorCreateContractCountryCodeGetResponsesContentApplicationJsonSchemaDataPagesItemsSectionsItemsQuestionsItemsType": { "description": "Type of the question.", "enum": [ "FreeText", "Paragraph", "SingleSelection", "MultiSelection", "Address", "PhoneNumber", "DocumentUpload", "Number", "Dropdown", "DatePicker", "Email", "CustomDropdown", "PresetDropdown", "Nested" ], "title": "FormsEorCreateContractCountryCodeGetResponsesContentApplicationJsonSchemaDataPagesItemsSectionsItemsQuestionsItemsType", "type": "string" }, "FormsEorCreateContractCountryCodeGetResponsesContentApplicationJsonSchemaError": { "properties": { "code": { "description": "HTTP status code.", "type": "integer" }, "message": { "description": "Human-readable error message.", "type": "string" } }, "title": "FormsEorCreateContractCountryCodeGetResponsesContentApplicationJsonSchemaError", "type": "object" }, "FormsEorCreateContractCountryCodeGetResponsesContentApplicationJsonSchemaErrorsItems": { "properties": { "message": { "description": "A description of the returned error", "type": "string" }, "path": { "description": "The JSON path where input validation failed", "type": "string" } }, "title": "FormsEorCreateContractCountryCodeGetResponsesContentApplicationJsonSchemaErrorsItems", "type": "object" }, "FormsEorCreateContractCountryCodeGetResponsesContentApplicationJsonSchemaRequest": { "properties": { "api_req_id": { "description": "The request ID of the failed request", "type": "string" }, "code": { "description": "The code of the source handler which produced the returned error", "format": "double", "type": "number" }, "docs": { "description": "A link to the official documentation for the requested endpoint resource", "type": "string" }, "method": { "description": "The HTTP method of the failed request", "type": "string" }, "source": { "description": "The source handler which produced the returned error", "type": "string" }, "status": { "description": "The status code of the response", "format": "double", "type": "number" }, "url": { "description": "The relative URL of the failed request", "type": "string" } }, "title": "FormsEorCreateContractCountryCodeGetResponsesContentApplicationJsonSchemaRequest", "type": "object" }, "FormsEorCreateContractDefinitionsPostRequestBodyContentApplicationJsonSchemaData": { "properties": { "contract_duration_in_days": { "description": "The contract duration in days for definite contracts.", "minimum": 1, "type": "integer" }, "countries": { "description": "Array of countries for which to fetch quote forms. Maximum 10 countries per request.", "items": { "$ref": "#/components/schemas/FormsEorCreateContractDefinitionsPostRequestBodyContentApplicationJsonSchemaDataCountriesItems" }, "type": "array" }, "start_date": { "description": "The selected start date of the contract in ISO 8601 formatted date string.", "format": "date", "type": "string" }, "work_hours_per_week": { "description": "The selected number of work hours per week.", "maximum": 168, "minimum": 1, "type": "integer" } }, "required": [ "countries" ], "title": "FormsEorCreateContractDefinitionsPostRequestBodyContentApplicationJsonSchemaData", "type": "object" }, "FormsEorCreateContractDefinitionsPostRequestBodyContentApplicationJsonSchemaDataCountriesItems": { "properties": { "country_code": { "description": "Two-letter country code in ISO 3166-1 alpha-2 format", "maxLength": 2, "minLength": 2, "pattern": "^[A-Z]{2}$", "type": "string" }, "state": { "description": "The selected state code of the contract. This is only required for countries that specify it.", "type": "string" } }, "required": [ "country_code" ], "title": "FormsEorCreateContractDefinitionsPostRequestBodyContentApplicationJsonSchemaDataCountriesItems", "type": "object" }, "FormsEorCreateContractDefinitionsPostResponsesContentApplicationJsonSchemaDataItems": { "properties": { "country": { "description": "Two-letter country code in ISO 3166-1 alpha-2 format", "pattern": "^[A-Z]{2}$", "type": "string" }, "pages": { "description": "List of pages in the form.", "items": { "$ref": "#/components/schemas/FormsEorCreateContractDefinitionsPostResponsesContentApplicationJsonSchemaDataItemsPagesItems" }, "type": "array" }, "state": { "description": "State or province code if applicable", "type": [ "string", "null" ] } }, "required": [ "pages", "country" ], "title": "FormsEorCreateContractDefinitionsPostResponsesContentApplicationJsonSchemaDataItems", "type": "object" }, "FormsEorCreateContractDefinitionsPostResponsesContentApplicationJsonSchemaDataItemsPagesItems": { "properties": { "sections": { "description": "Sections within the page.", "items": { "$ref": "#/components/schemas/FormsEorCreateContractDefinitionsPostResponsesContentApplicationJsonSchemaDataItemsPagesItemsSectionsItems" }, "type": "array" }, "title": { "description": "Title of the form page.", "type": "string" } }, "required": [ "title", "sections" ], "title": "FormsEorCreateContractDefinitionsPostResponsesContentApplicationJsonSchemaDataItemsPagesItems", "type": "object" }, "FormsEorCreateContractDefinitionsPostResponsesContentApplicationJsonSchemaDataItemsPagesItemsSectionsItems": { "properties": { "questions": { "description": "List of questions within the section.", "items": { "$ref": "#/components/schemas/FormsEorCreateContractDefinitionsPostResponsesContentApplicationJsonSchemaDataItemsPagesItemsSectionsItemsQuestionsItems" }, "type": "array" }, "subtitle": { "description": "Additional information shown at the top of the section.", "type": "string" }, "title": { "description": "Title of the section.", "type": "string" } }, "required": [ "title", "questions" ], "title": "FormsEorCreateContractDefinitionsPostResponsesContentApplicationJsonSchemaDataItemsPagesItemsSectionsItems", "type": "object" }, "FormsEorCreateContractDefinitionsPostResponsesContentApplicationJsonSchemaDataItemsPagesItemsSectionsItemsQuestionsItems": { "properties": { "date_limitation": { "description": "Limits date selection (e.g., blocking past dates). Will always be 'BLOCK_PAST' for now.", "type": [ "string", "null" ] }, "default_value": { "$ref": "#/components/schemas/FormsEorCreateContractDefinitionsPostResponsesContentApplicationJsonSchemaDataItemsPagesItemsSectionsItemsQuestionsItemsDefaultValue", "description": "Default value to pre-fill in the form." }, "helper_text": { "description": "Additional information to assist the user.", "type": [ "string", "null" ] }, "is_disabled": { "description": "If true, the field is disabled and cannot be edited.", "type": "boolean" }, "is_multiple_selection": { "description": "Indicates if the user can select multiple values.", "type": "boolean" }, "is_only_digits": { "description": "Restricts input to numeric characters only, for FreeText questions.", "type": "boolean" }, "is_range": { "description": "Specifies whether a date picker allows range selection.", "type": "boolean" }, "is_required": { "description": "Indicates if the question is required.", "type": "boolean" }, "key": { "description": "Unique key identifier for the question.", "type": "string" }, "max_length": { "description": "Maximum character length for text responses.", "type": [ "integer", "null" ] }, "max_value": { "$ref": "#/components/schemas/FormsEorCreateContractDefinitionsPostResponsesContentApplicationJsonSchemaDataItemsPagesItemsSectionsItemsQuestionsItemsMaxValue", "description": "Maximum value allowed." }, "min_length": { "description": "Minimum character length for text responses.", "type": [ "integer", "null" ] }, "min_value": { "$ref": "#/components/schemas/FormsEorCreateContractDefinitionsPostResponsesContentApplicationJsonSchemaDataItemsPagesItemsSectionsItemsQuestionsItemsMinValue", "description": "Minimum value allowed." }, "must_request_validation": { "description": "Whether additional validation should be triggered for this field.", "type": "boolean" }, "number_type": { "description": "Used for number fields to define the unit or representation.", "type": "string" }, "options": { "description": "List of selectable options for selection-type questions. Value may be of any type.", "items": { "$ref": "#/components/schemas/FormsEorCreateContractDefinitionsPostResponsesContentApplicationJsonSchemaDataItemsPagesItemsSectionsItemsQuestionsItemsOptionsItems" }, "type": [ "array", "null" ] }, "rules": { "description": "Validation rules for the question.", "items": { "$ref": "#/components/schemas/FormsEorCreateContractDefinitionsPostResponsesContentApplicationJsonSchemaDataItemsPagesItemsSectionsItemsQuestionsItemsRulesItems" }, "type": [ "array", "null" ] }, "source": { "description": "Defines dynamic data source for the question.", "oneOf": [ { "$ref": "#/components/schemas/FormsEorCreateContractDefinitionsPostResponsesContentApplicationJsonSchemaDataItemsPagesItemsSectionsItemsQuestionsItemsSource" }, { "type": "null" } ] }, "title": { "description": "Title of the question.", "type": "string" }, "type": { "$ref": "#/components/schemas/FormsEorCreateContractDefinitionsPostResponsesContentApplicationJsonSchemaDataItemsPagesItemsSectionsItemsQuestionsItemsType", "description": "Type of the question." } }, "required": [ "key", "type", "title" ], "title": "FormsEorCreateContractDefinitionsPostResponsesContentApplicationJsonSchemaDataItemsPagesItemsSectionsItemsQuestionsItems", "type": "object" }, "FormsEorCreateContractDefinitionsPostResponsesContentApplicationJsonSchemaDataItemsPagesItemsSectionsItemsQuestionsItemsDefaultValue": { "description": "Default value to pre-fill in the form.", "oneOf": [ { "type": "string" }, { "format": "double", "type": "number" }, { "type": "boolean" } ], "title": "FormsEorCreateContractDefinitionsPostResponsesContentApplicationJsonSchemaDataItemsPagesItemsSectionsItemsQuestionsItemsDefaultValue" }, "FormsEorCreateContractDefinitionsPostResponsesContentApplicationJsonSchemaDataItemsPagesItemsSectionsItemsQuestionsItemsMaxValue": { "description": "Maximum value allowed.", "oneOf": [ { "type": "string" }, { "format": "double", "type": "number" } ], "title": "FormsEorCreateContractDefinitionsPostResponsesContentApplicationJsonSchemaDataItemsPagesItemsSectionsItemsQuestionsItemsMaxValue" }, "FormsEorCreateContractDefinitionsPostResponsesContentApplicationJsonSchemaDataItemsPagesItemsSectionsItemsQuestionsItemsMinValue": { "description": "Minimum value allowed.", "oneOf": [ { "type": "string" }, { "format": "double", "type": "number" } ], "title": "FormsEorCreateContractDefinitionsPostResponsesContentApplicationJsonSchemaDataItemsPagesItemsSectionsItemsQuestionsItemsMinValue" }, "FormsEorCreateContractDefinitionsPostResponsesContentApplicationJsonSchemaDataItemsPagesItemsSectionsItemsQuestionsItemsOptionsItems": { "properties": { "title": { "description": "Display text for the option.", "type": "string" }, "value": { "description": "Value associated with the option.", "type": [ "string", "null" ] } }, "title": "FormsEorCreateContractDefinitionsPostResponsesContentApplicationJsonSchemaDataItemsPagesItemsSectionsItemsQuestionsItemsOptionsItems", "type": "object" }, "FormsEorCreateContractDefinitionsPostResponsesContentApplicationJsonSchemaDataItemsPagesItemsSectionsItemsQuestionsItemsRulesItems": { "properties": { "date_limitation": { "description": "Limits date selection (e.g., blocking past dates). Will always be 'BLOCK_PAST' for now.", "type": [ "string", "null" ] }, "default_value": { "$ref": "#/components/schemas/FormsEorCreateContractDefinitionsPostResponsesContentApplicationJsonSchemaDataItemsPagesItemsSectionsItemsQuestionsItemsRulesItemsDefaultValue", "description": "Default value to pre-fill in the form." }, "helper_text": { "description": "Additional information to assist the user.", "type": [ "string", "null" ] }, "is_disabled": { "description": "If true, the field is disabled and cannot be edited.", "type": "boolean" }, "is_multiple_selection": { "description": "Indicates if the user can select multiple values.", "type": "boolean" }, "is_only_digits": { "description": "Restricts input to numeric characters only, for FreeText questions.", "type": "boolean" }, "is_range": { "description": "Specifies whether a date picker allows range selection.", "type": "boolean" }, "is_required": { "description": "Indicates if the question is required.", "type": "boolean" }, "max_length": { "description": "Maximum character length for text responses.", "type": [ "integer", "null" ] }, "max_value": { "$ref": "#/components/schemas/FormsEorCreateContractDefinitionsPostResponsesContentApplicationJsonSchemaDataItemsPagesItemsSectionsItemsQuestionsItemsRulesItemsMaxValue", "description": "Maximum value allowed." }, "min_length": { "description": "Minimum character length for text responses.", "type": [ "integer", "null" ] }, "min_value": { "$ref": "#/components/schemas/FormsEorCreateContractDefinitionsPostResponsesContentApplicationJsonSchemaDataItemsPagesItemsSectionsItemsQuestionsItemsRulesItemsMinValue", "description": "Minimum value allowed." }, "must_request_validation": { "description": "Whether additional validation should be triggered for this field.", "type": "boolean" }, "number_type": { "description": "Used for number fields to define the unit or representation.", "type": "string" }, "options": { "description": "List of selectable options for selection-type questions. Value may be of any type.", "items": { "$ref": "#/components/schemas/FormsEorCreateContractDefinitionsPostResponsesContentApplicationJsonSchemaDataItemsPagesItemsSectionsItemsQuestionsItemsRulesItemsOptionsItems" }, "type": [ "array", "null" ] }, "requires": { "description": "List of conditions that must be met for this rule to apply.", "items": { "$ref": "#/components/schemas/FormsEorCreateContractDefinitionsPostResponsesContentApplicationJsonSchemaDataItemsPagesItemsSectionsItemsQuestionsItemsRulesItemsRequiresItems" }, "type": "array" }, "source": { "description": "Defines dynamic data source for the question.", "oneOf": [ { "$ref": "#/components/schemas/FormsEorCreateContractDefinitionsPostResponsesContentApplicationJsonSchemaDataItemsPagesItemsSectionsItemsQuestionsItemsRulesItemsSource" }, { "type": "null" } ] }, "title": { "description": "Title of the question.", "type": "string" } }, "title": "FormsEorCreateContractDefinitionsPostResponsesContentApplicationJsonSchemaDataItemsPagesItemsSectionsItemsQuestionsItemsRulesItems", "type": "object" }, "FormsEorCreateContractDefinitionsPostResponsesContentApplicationJsonSchemaDataItemsPagesItemsSectionsItemsQuestionsItemsRulesItemsDefaultValue": { "description": "Default value to pre-fill in the form.", "oneOf": [ { "type": "string" }, { "format": "double", "type": "number" }, { "type": "boolean" } ], "title": "FormsEorCreateContractDefinitionsPostResponsesContentApplicationJsonSchemaDataItemsPagesItemsSectionsItemsQuestionsItemsRulesItemsDefaultValue" }, "FormsEorCreateContractDefinitionsPostResponsesContentApplicationJsonSchemaDataItemsPagesItemsSectionsItemsQuestionsItemsRulesItemsMaxValue": { "description": "Maximum value allowed.", "oneOf": [ { "type": "string" }, { "format": "double", "type": "number" } ], "title": "FormsEorCreateContractDefinitionsPostResponsesContentApplicationJsonSchemaDataItemsPagesItemsSectionsItemsQuestionsItemsRulesItemsMaxValue" }, "FormsEorCreateContractDefinitionsPostResponsesContentApplicationJsonSchemaDataItemsPagesItemsSectionsItemsQuestionsItemsRulesItemsMinValue": { "description": "Minimum value allowed.", "oneOf": [ { "type": "string" }, { "format": "double", "type": "number" } ], "title": "FormsEorCreateContractDefinitionsPostResponsesContentApplicationJsonSchemaDataItemsPagesItemsSectionsItemsQuestionsItemsRulesItemsMinValue" }, "FormsEorCreateContractDefinitionsPostResponsesContentApplicationJsonSchemaDataItemsPagesItemsSectionsItemsQuestionsItemsRulesItemsOptionsItems": { "properties": { "title": { "description": "Display text for the option.", "type": "string" }, "value": { "description": "Value associated with the option.", "type": [ "string", "null" ] } }, "title": "FormsEorCreateContractDefinitionsPostResponsesContentApplicationJsonSchemaDataItemsPagesItemsSectionsItemsQuestionsItemsRulesItemsOptionsItems", "type": "object" }, "FormsEorCreateContractDefinitionsPostResponsesContentApplicationJsonSchemaDataItemsPagesItemsSectionsItemsQuestionsItemsRulesItemsRequiresItems": { "properties": { "compare_key": { "description": "Key of the field to compare against.", "type": [ "string", "null" ] }, "key": { "description": "Key of the dependent field.", "type": "string" }, "operator": { "description": "Comparison operator (e.g., 'eq', 'ne').", "type": [ "string", "null" ] }, "value": { "$ref": "#/components/schemas/FormsEorCreateContractDefinitionsPostResponsesContentApplicationJsonSchemaDataItemsPagesItemsSectionsItemsQuestionsItemsRulesItemsRequiresItemsValue", "description": "Expected value for the condition." } }, "title": "FormsEorCreateContractDefinitionsPostResponsesContentApplicationJsonSchemaDataItemsPagesItemsSectionsItemsQuestionsItemsRulesItemsRequiresItems", "type": "object" }, "FormsEorCreateContractDefinitionsPostResponsesContentApplicationJsonSchemaDataItemsPagesItemsSectionsItemsQuestionsItemsRulesItemsRequiresItemsValue": { "description": "Expected value for the condition.", "oneOf": [ { "type": "string" }, { "format": "double", "type": "number" }, { "type": "boolean" } ], "title": "FormsEorCreateContractDefinitionsPostResponsesContentApplicationJsonSchemaDataItemsPagesItemsSectionsItemsQuestionsItemsRulesItemsRequiresItemsValue" }, "FormsEorCreateContractDefinitionsPostResponsesContentApplicationJsonSchemaDataItemsPagesItemsSectionsItemsQuestionsItemsRulesItemsSource": { "description": "Defines dynamic data source for the question.", "properties": { "definition": { "description": "Reference URL for API documentation.", "type": "string" }, "description": { "description": "Description of the data source.", "type": "string" }, "url": { "description": "API endpoint providing dynamic options.", "type": "string" } }, "title": "FormsEorCreateContractDefinitionsPostResponsesContentApplicationJsonSchemaDataItemsPagesItemsSectionsItemsQuestionsItemsRulesItemsSource", "type": "object" }, "FormsEorCreateContractDefinitionsPostResponsesContentApplicationJsonSchemaDataItemsPagesItemsSectionsItemsQuestionsItemsSource": { "description": "Defines dynamic data source for the question.", "properties": { "definition": { "description": "Reference URL for API documentation.", "type": "string" }, "description": { "description": "Description of the data source.", "type": "string" }, "url": { "description": "API endpoint providing dynamic options.", "type": "string" } }, "title": "FormsEorCreateContractDefinitionsPostResponsesContentApplicationJsonSchemaDataItemsPagesItemsSectionsItemsQuestionsItemsSource", "type": "object" }, "FormsEorCreateContractDefinitionsPostResponsesContentApplicationJsonSchemaDataItemsPagesItemsSectionsItemsQuestionsItemsType": { "description": "Type of the question.", "enum": [ "FreeText", "Paragraph", "SingleSelection", "MultiSelection", "Address", "PhoneNumber", "DocumentUpload", "Number", "Dropdown", "DatePicker", "Email", "Nested" ], "title": "FormsEorCreateContractDefinitionsPostResponsesContentApplicationJsonSchemaDataItemsPagesItemsSectionsItemsQuestionsItemsType", "type": "string" }, "FormsEorCreateContractDefinitionsPostResponsesContentApplicationJsonSchemaErrorsItems": { "properties": { "code": { "description": "Machine-readable error code", "type": "string" }, "message": { "description": "Human-readable explanation of the error", "type": "string" } }, "title": "FormsEorCreateContractDefinitionsPostResponsesContentApplicationJsonSchemaErrorsItems", "type": "object" }, "FormsEorWorkerAdditionalFieldsCountryCodeGetResponsesContentApplicationJsonSchemaDataItems": { "properties": { "dependencies": { "description": "Array of field dependencies that determine when this field should be displayed", "items": { "$ref": "#/components/schemas/FormsEorWorkerAdditionalFieldsCountryCodeGetResponsesContentApplicationJsonSchemaDataItemsDependenciesItems" }, "type": "array" }, "is_required": { "description": "Indicates if the field is required", "type": "boolean" }, "key": { "description": "Unique identifier for the field", "type": "string" }, "required_by": { "description": "Indicates when the field is required (e.g., sign_up, contract_signing)", "type": "string" }, "type": { "description": "Data type of the field", "type": "string" }, "ui_guide": { "$ref": "#/components/schemas/FormsEorWorkerAdditionalFieldsCountryCodeGetResponsesContentApplicationJsonSchemaDataItemsUiGuide", "description": "UI guidelines for rendering the field" }, "validation": { "description": "Array of validation rules to apply to the field input", "items": { "$ref": "#/components/schemas/FormsEorWorkerAdditionalFieldsCountryCodeGetResponsesContentApplicationJsonSchemaDataItemsValidationItems" }, "type": "array" }, "values_allowed": { "description": "List of allowed values for select fields", "items": { "type": "string" }, "type": "array" } }, "required": [ "key", "type", "ui_guide", "validation", "is_required", "dependencies" ], "title": "FormsEorWorkerAdditionalFieldsCountryCodeGetResponsesContentApplicationJsonSchemaDataItems", "type": "object" }, "FormsEorWorkerAdditionalFieldsCountryCodeGetResponsesContentApplicationJsonSchemaDataItemsDependenciesItems": { "properties": { "key": { "description": "Unique identifier for the dependant field", "type": "string" }, "value": { "$ref": "#/components/schemas/FormsEorWorkerAdditionalFieldsCountryCodeGetResponsesContentApplicationJsonSchemaDataItemsDependenciesItemsValue", "description": "Value expected from dependant in order to display field. Can be a plain value or an object with an operator." } }, "required": [ "key", "value" ], "title": "FormsEorWorkerAdditionalFieldsCountryCodeGetResponsesContentApplicationJsonSchemaDataItemsDependenciesItems", "type": "object" }, "FormsEorWorkerAdditionalFieldsCountryCodeGetResponsesContentApplicationJsonSchemaDataItemsDependenciesItemsValue": { "description": "Value expected from dependant in order to display field. Can be a plain value or an object with an operator.", "oneOf": [ { "type": "string" }, { "$ref": "#/components/schemas/FormsEorWorkerAdditionalFieldsCountryCodeGetResponsesContentApplicationJsonSchemaDataItemsDependenciesItemsValue1" }, { "items": { "type": "string" }, "type": "array" } ], "title": "FormsEorWorkerAdditionalFieldsCountryCodeGetResponsesContentApplicationJsonSchemaDataItemsDependenciesItemsValue" }, "FormsEorWorkerAdditionalFieldsCountryCodeGetResponsesContentApplicationJsonSchemaDataItemsDependenciesItemsValue1": { "properties": { "op": { "description": "Comparison operator (e.g., gt, gte, lt, lte, eq, neq)", "type": "string" }, "value": { "$ref": "#/components/schemas/FormsEorWorkerAdditionalFieldsCountryCodeGetResponsesContentApplicationJsonSchemaDataItemsDependenciesItemsValueOneOf1Value" } }, "required": [ "op", "value" ], "title": "FormsEorWorkerAdditionalFieldsCountryCodeGetResponsesContentApplicationJsonSchemaDataItemsDependenciesItemsValue1", "type": "object" }, "FormsEorWorkerAdditionalFieldsCountryCodeGetResponsesContentApplicationJsonSchemaDataItemsDependenciesItemsValueOneOf1Value": { "oneOf": [ { "type": "string" }, { "format": "double", "type": "number" } ], "title": "FormsEorWorkerAdditionalFieldsCountryCodeGetResponsesContentApplicationJsonSchemaDataItemsDependenciesItemsValueOneOf1Value" }, "FormsEorWorkerAdditionalFieldsCountryCodeGetResponsesContentApplicationJsonSchemaDataItemsUiGuide": { "description": "UI guidelines for rendering the field", "properties": { "description": { "description": "Additional description for the field UI", "type": "string" }, "field_type": { "description": "Type of the input field in the UI", "type": "string" }, "helper_text": { "description": "Helper text to guide user input", "type": "string" }, "label": { "description": "The primary label for the field", "type": "string" }, "local_label": { "description": "Localized version of the field label", "type": "string" }, "order": { "description": "Display order of the field in the UI", "type": "integer" } }, "required": [ "label", "order", "field_type", "description" ], "title": "FormsEorWorkerAdditionalFieldsCountryCodeGetResponsesContentApplicationJsonSchemaDataItemsUiGuide", "type": "object" }, "FormsEorWorkerAdditionalFieldsCountryCodeGetResponsesContentApplicationJsonSchemaDataItemsValidationItems": { "description": "Validation rules for the field", "properties": { "error_message": { "description": "Error message shown if the validation fails", "type": "string" }, "type": { "description": "Type of the validation", "type": "string" }, "value": { "description": "Value to be used in the validation according to the type", "type": "string" } }, "required": [ "type", "error_message" ], "title": "FormsEorWorkerAdditionalFieldsCountryCodeGetResponsesContentApplicationJsonSchemaDataItemsValidationItems", "type": "object" }, "FormsEorWorkerAdditionalFieldsCountryCodeGetResponsesContentApplicationJsonSchemaErrorsItems": { "properties": { "code": { "description": "Machine-readable error code", "type": "string" }, "message": { "description": "Human-readable explanation of the error", "type": "string" } }, "title": "FormsEorWorkerAdditionalFieldsCountryCodeGetResponsesContentApplicationJsonSchemaErrorsItems", "type": "object" }, "FormsGpWorkerAdditionalFieldsCountryCodeGetResponsesContentApplicationJsonSchemaDataItems": { "properties": { "dependencies": { "description": "Use this array to implement conditional field visibility. When non-empty, this field should only be displayed and required when the referenced dependency conditions are met. An empty array means the field has no conditional dependencies.", "items": { "$ref": "#/components/schemas/FormsGpWorkerAdditionalFieldsCountryCodeGetResponsesContentApplicationJsonSchemaDataItemsDependenciesItems" }, "type": "array" }, "is_required": { "description": "Use this flag to determine whether the field must be provided when submitting additional information. For GP workers, the value considers the GP-specific optionality setting when available, falling back to the general optionality flag.", "type": "boolean" }, "key": { "description": "Use this value as the field identifier when submitting additional information. Represents the snake_case version of the internal field name, generated by the API naming convention service.", "type": "string" }, "required_by": { "description": "Use this value to determine at which stage in the payroll lifecycle this field must be collected. Known values: 'before_payroll' (required before payroll processing), 'after_payroll' (can be collected after initial payroll), 'contract_signing' (required at contract signing). Absent from the response when no lifecycle stage is configured.", "type": "string" }, "type": { "$ref": "#/components/schemas/FormsGpWorkerAdditionalFieldsCountryCodeGetResponsesContentApplicationJsonSchemaDataItemsType", "description": "Use this value to determine the data type expected when submitting field values. Mapped from the raw input type: 'date', 'text', 'select', 'textarea', 'tel', 'phone', and 'string' map to \"string\"; 'number' maps to \"number\"; 'checkbox' maps to \"boolean\". An empty string indicates an unrecognized input type." }, "ui_guide": { "$ref": "#/components/schemas/FormsGpWorkerAdditionalFieldsCountryCodeGetResponsesContentApplicationJsonSchemaDataItemsUiGuide", "description": "Use this object to control how the field is rendered in the UI. Contains labels, input type, display order, and supplementary text." }, "validation": { "description": "Use this array to apply client-side validation before form submission. Contains zero or one validation rule per field. An empty array means no validation is configured.", "items": { "$ref": "#/components/schemas/FormsGpWorkerAdditionalFieldsCountryCodeGetResponsesContentApplicationJsonSchemaDataItemsValidationItems" }, "type": "array" }, "values_allowed": { "description": "Use this array to populate dropdown or select options when field_type is 'select'. Only present when the field has predefined options. Absent from the response for free-text, date, number, and other non-select field types.", "items": { "type": "string" }, "type": "array" } }, "required": [ "key", "type", "ui_guide", "validation", "is_required", "dependencies" ], "title": "FormsGpWorkerAdditionalFieldsCountryCodeGetResponsesContentApplicationJsonSchemaDataItems", "type": "object" }, "FormsGpWorkerAdditionalFieldsCountryCodeGetResponsesContentApplicationJsonSchemaDataItemsDependenciesItems": { "properties": { "key": { "description": "Use this value to identify the field that this dependency refers to. Contains the snake_case key of the dependency field, matching another field's 'key' property in the same response.", "type": "string" }, "value": { "$ref": "#/components/schemas/FormsGpWorkerAdditionalFieldsCountryCodeGetResponsesContentApplicationJsonSchemaDataItemsDependenciesItemsValue", "description": "Use this value to evaluate the dependency condition. When the value is a primitive (string, number, or boolean), the condition is satisfied when the referenced field equals this value. When the value is an array, the condition is satisfied when the referenced field equals any one of its entries. When the value is an object, apply the operator in 'op': 'eq' (equals), 'ne' (not equals), 'gt' (greater than), 'gte' (greater than or equal), 'lt' (less than), 'lte' (less than or equal), 'contains' (field value contains the specified substring) each compare against 'value', while 'notnull' takes no operand and is satisfied when the referenced field holds any non-empty value." } }, "required": [ "key", "value" ], "title": "FormsGpWorkerAdditionalFieldsCountryCodeGetResponsesContentApplicationJsonSchemaDataItemsDependenciesItems", "type": "object" }, "FormsGpWorkerAdditionalFieldsCountryCodeGetResponsesContentApplicationJsonSchemaDataItemsDependenciesItemsValue": { "description": "Use this value to evaluate the dependency condition. When the value is a primitive (string, number, or boolean), the condition is satisfied when the referenced field equals this value. When the value is an array, the condition is satisfied when the referenced field equals any one of its entries. When the value is an object, apply the operator in 'op': 'eq' (equals), 'ne' (not equals), 'gt' (greater than), 'gte' (greater than or equal), 'lt' (less than), 'lte' (less than or equal), 'contains' (field value contains the specified substring) each compare against 'value', while 'notnull' takes no operand and is satisfied when the referenced field holds any non-empty value.", "oneOf": [ { "type": "string" }, { "format": "double", "type": "number" }, { "type": "boolean" }, { "$ref": "#/components/schemas/FormsGpWorkerAdditionalFieldsCountryCodeGetResponsesContentApplicationJsonSchemaDataItemsDependenciesItemsValue3" }, { "$ref": "#/components/schemas/FormsGpWorkerAdditionalFieldsCountryCodeGetResponsesContentApplicationJsonSchemaDataItemsDependenciesItemsValue4" }, { "items": { "type": "string" }, "type": "array" } ], "title": "FormsGpWorkerAdditionalFieldsCountryCodeGetResponsesContentApplicationJsonSchemaDataItemsDependenciesItemsValue" }, "FormsGpWorkerAdditionalFieldsCountryCodeGetResponsesContentApplicationJsonSchemaDataItemsDependenciesItemsValue3": { "properties": { "op": { "$ref": "#/components/schemas/FormsGpWorkerAdditionalFieldsCountryCodeGetResponsesContentApplicationJsonSchemaDataItemsDependenciesItemsValueOneOf3Op", "description": "Use this operator to evaluate the dependency condition against the referenced field's submitted value." }, "value": { "description": "Use this value as the operand for the dependency condition evaluation." } }, "required": [ "op", "value" ], "title": "FormsGpWorkerAdditionalFieldsCountryCodeGetResponsesContentApplicationJsonSchemaDataItemsDependenciesItemsValue3", "type": "object" }, "FormsGpWorkerAdditionalFieldsCountryCodeGetResponsesContentApplicationJsonSchemaDataItemsDependenciesItemsValue4": { "properties": { "op": { "$ref": "#/components/schemas/FormsGpWorkerAdditionalFieldsCountryCodeGetResponsesContentApplicationJsonSchemaDataItemsDependenciesItemsValueOneOf4Op", "description": "Use this operator on its own: the condition is satisfied when the referenced field holds any non-empty value. It takes no operand." } }, "required": [ "op" ], "title": "FormsGpWorkerAdditionalFieldsCountryCodeGetResponsesContentApplicationJsonSchemaDataItemsDependenciesItemsValue4", "type": "object" }, "FormsGpWorkerAdditionalFieldsCountryCodeGetResponsesContentApplicationJsonSchemaDataItemsDependenciesItemsValueOneOf3Op": { "description": "Use this operator to evaluate the dependency condition against the referenced field's submitted value.", "enum": [ "eq", "ne", "gt", "gte", "lt", "lte", "contains" ], "title": "FormsGpWorkerAdditionalFieldsCountryCodeGetResponsesContentApplicationJsonSchemaDataItemsDependenciesItemsValueOneOf3Op", "type": "string" }, "FormsGpWorkerAdditionalFieldsCountryCodeGetResponsesContentApplicationJsonSchemaDataItemsDependenciesItemsValueOneOf4Op": { "description": "Use this operator on its own: the condition is satisfied when the referenced field holds any non-empty value. It takes no operand.", "enum": [ "notnull" ], "title": "FormsGpWorkerAdditionalFieldsCountryCodeGetResponsesContentApplicationJsonSchemaDataItemsDependenciesItemsValueOneOf4Op", "type": "string" }, "FormsGpWorkerAdditionalFieldsCountryCodeGetResponsesContentApplicationJsonSchemaDataItemsType": { "description": "Use this value to determine the data type expected when submitting field values. Mapped from the raw input type: 'date', 'text', 'select', 'textarea', 'tel', 'phone', and 'string' map to \"string\"; 'number' maps to \"number\"; 'checkbox' maps to \"boolean\". An empty string indicates an unrecognized input type.", "enum": [ "string", "number", "boolean", "" ], "title": "FormsGpWorkerAdditionalFieldsCountryCodeGetResponsesContentApplicationJsonSchemaDataItemsType", "type": "string" }, "FormsGpWorkerAdditionalFieldsCountryCodeGetResponsesContentApplicationJsonSchemaDataItemsUiGuide": { "description": "Use this object to control how the field is rendered in the UI. Contains labels, input type, display order, and supplementary text.", "properties": { "description": { "description": "Use this value to display supplementary context about the field below or beside the input. HTML tags are stripped. Returns an empty string when no description is configured.", "type": "string" }, "field_type": { "description": "Use this value to select the appropriate UI input component. Represents the raw input type from the field configuration. Known values include 'text', 'date', 'select', 'textarea', 'tel', 'phone', 'number', 'checkbox', and 'string'. Additional values may exist.", "type": "string" }, "helper_text": { "description": "Use this value to display footnote or instructional text near the field. HTML tags are stripped. Returns an empty string when no helper text is configured.", "type": "string" }, "label": { "description": "Use this value as the primary English-language label when rendering the field in the UI.", "type": "string" }, "local_label": { "description": "Use this value as the localized field label when rendering the form in the worker's local language.", "type": "string" }, "order": { "description": "Use this value to determine the display position of the field in the form. Starts at 1 and reflects the position in the response array, which is pre-sorted by the configured display order.", "minimum": 1, "type": "integer" } }, "required": [ "label", "order", "field_type", "description", "helper_text", "local_label" ], "title": "FormsGpWorkerAdditionalFieldsCountryCodeGetResponsesContentApplicationJsonSchemaDataItemsUiGuide", "type": "object" }, "FormsGpWorkerAdditionalFieldsCountryCodeGetResponsesContentApplicationJsonSchemaDataItemsValidationItems": { "properties": { "error_message": { "description": "Use this message to display to the user when the field value fails validation. Defaults to 'Review the value entered' when no custom message is configured.", "type": "string" }, "type": { "description": "Use this value to determine which validation strategy to apply. \"REGEX\" indicates the 'value' field contains a regular expression pattern. Any other value indicates a custom validation type identified by its uppercase name.", "type": "string" }, "value": { "description": "Use this value as the validation parameter. For REGEX type, contains the regular expression pattern to validate the field input against. Absent when the validation type is a custom type that does not require a parameter.", "type": "string" } }, "required": [ "type", "error_message" ], "title": "FormsGpWorkerAdditionalFieldsCountryCodeGetResponsesContentApplicationJsonSchemaDataItemsValidationItems", "type": "object" }, "FormsGpWorkerAdditionalFieldsCountryCodeGetResponsesContentApplicationJsonSchemaErrorsItems": { "properties": { "message": { "description": "Use this message to detect rate limiting. Implement exponential backoff before retrying.", "type": "string" } }, "required": [ "message" ], "title": "FormsGpWorkerAdditionalFieldsCountryCodeGetResponsesContentApplicationJsonSchemaErrorsItems", "type": "object" }, "Forms_fetchMultipleEorContractForms-v2026-01-01_Response_200": { "properties": { "data": { "description": "Array of quote forms for the requested countries.", "items": { "$ref": "#/components/schemas/FormsEorCreateContractDefinitionsPostResponsesContentApplicationJsonSchemaDataItems" }, "type": "array" }, "has_more": { "description": "Indicates if there are more results available beyond the current page.", "type": "boolean" }, "next_cursor": { "description": "Cursor for fetching the next page of results. Null if no more results.", "type": [ "string", "null" ] }, "total_count": { "description": "Total number of countries in the request.", "type": "integer" } }, "required": [ "data", "has_more", "total_count" ], "title": "Forms_fetchMultipleEorContractForms-v2026-01-01_Response_200", "type": "object" }, "Forms_getWorkerAdditionalFieldsForEor-v2026-01-01_Response_200": { "properties": { "data": { "description": "Array of field configuration objects", "items": { "$ref": "#/components/schemas/FormsEorWorkerAdditionalFieldsCountryCodeGetResponsesContentApplicationJsonSchemaDataItems" }, "type": "array" } }, "required": [ "data" ], "title": "Forms_getWorkerAdditionalFieldsForEor-v2026-01-01_Response_200", "type": "object" }, "GenerateMagicLinkForManagerLogin-v2026-01-01RequestForbiddenError": { "properties": { "errors": { "items": { "$ref": "#/components/schemas/ManagersMagicLinksPostResponsesContentApplicationJsonSchemaErrorsItems" }, "type": "array" } }, "title": "GenerateMagicLinkForManagerLogin-v2026-01-01RequestForbiddenError", "type": "object" }, "GenerateMagicLinkForManagerLogin-v2026-01-01RequestInternalServerError": { "properties": { "errors": { "items": { "$ref": "#/components/schemas/ManagersMagicLinksPostResponsesContentApplicationJsonSchemaErrorsItems" }, "type": "array" } }, "title": "GenerateMagicLinkForManagerLogin-v2026-01-01RequestInternalServerError", "type": "object" }, "GenerateMagicLinkForManagerLogin-v2026-01-01RequestNotFoundError": { "properties": { "errors": { "items": { "$ref": "#/components/schemas/ManagersMagicLinksPostResponsesContentApplicationJsonSchemaErrorsItems" }, "type": "array" } }, "title": "GenerateMagicLinkForManagerLogin-v2026-01-01RequestNotFoundError", "type": "object" }, "GenerateMagicLinkForManagerLogin-v2026-01-01RequestUnauthorizedError": { "properties": { "errors": { "items": { "$ref": "#/components/schemas/ManagersMagicLinksPostResponsesContentApplicationJsonSchemaErrorsItems" }, "type": "array" } }, "title": "GenerateMagicLinkForManagerLogin-v2026-01-01RequestUnauthorizedError", "type": "object" }, "GenerateTimesheetUploadUrl-v2026-01-01RequestBadRequestError": { "properties": { "errors": { "items": { "$ref": "#/components/schemas/TimeTrackingTimesheetsUploadUrlPostResponsesContentApplicationJsonSchemaErrorsItems" }, "type": "array" } }, "required": [ "errors" ], "title": "GenerateTimesheetUploadUrl-v2026-01-01RequestBadRequestError", "type": "object" }, "GenerateTimesheetUploadUrl-v2026-01-01RequestNotFoundError": { "properties": { "errors": { "items": { "$ref": "#/components/schemas/TimeTrackingTimesheetsUploadUrlPostResponsesContentApplicationJsonSchemaErrorsItems" }, "type": "array" } }, "required": [ "errors" ], "title": "GenerateTimesheetUploadUrl-v2026-01-01RequestNotFoundError", "type": "object" }, "GenerateTimesheetUploadUrl-v2026-01-01RequestUnprocessableEntityError": { "properties": { "errors": { "items": { "$ref": "#/components/schemas/TimeTrackingTimesheetsUploadUrlPostResponsesContentApplicationJsonSchemaErrorsItems" }, "type": "array" } }, "required": [ "errors" ], "title": "GenerateTimesheetUploadUrl-v2026-01-01RequestUnprocessableEntityError", "type": "object" }, "GetAdditionalInformation-v2026-09-18RequestBadRequestError": { "properties": { "errors": { "items": { "$ref": "#/components/schemas/EorWorkersContractsContractIdAdditionalInformationGetResponsesContentApplicationJsonSchemaErrorsItems" }, "type": "array" } }, "required": [ "errors" ], "title": "GetAdditionalInformation-v2026-09-18RequestBadRequestError", "type": "object" }, "GetAdditionalInformation-v2026-09-18RequestForbiddenError": { "properties": { "errors": { "items": { "$ref": "#/components/schemas/EorWorkersContractsContractIdAdditionalInformationGetResponsesContentApplicationJsonSchemaErrorsItems" }, "type": "array" } }, "required": [ "errors" ], "title": "GetAdditionalInformation-v2026-09-18RequestForbiddenError", "type": "object" }, "GetAdditionalInformation-v2026-09-18RequestInternalServerError": { "properties": { "errors": { "items": { "$ref": "#/components/schemas/EorWorkersContractsContractIdAdditionalInformationGetResponsesContentApplicationJsonSchemaErrorsItems" }, "type": "array" } }, "required": [ "errors" ], "title": "GetAdditionalInformation-v2026-09-18RequestInternalServerError", "type": "object" }, "GetAdditionalInformation-v2026-09-18RequestNotFoundError": { "properties": { "errors": { "items": { "$ref": "#/components/schemas/EorWorkersContractsContractIdAdditionalInformationGetResponsesContentApplicationJsonSchemaErrorsItems" }, "type": "array" } }, "required": [ "errors" ], "title": "GetAdditionalInformation-v2026-09-18RequestNotFoundError", "type": "object" }, "GetAdditionalInformation-v2026-09-18RequestTooManyRequestsError": { "properties": { "errors": { "items": { "$ref": "#/components/schemas/EorWorkersContractsContractIdAdditionalInformationGetResponsesContentApplicationJsonSchemaErrorsItems" }, "type": "array" } }, "required": [ "errors" ], "title": "GetAdditionalInformation-v2026-09-18RequestTooManyRequestsError", "type": "object" }, "GetAdditionalInformation-v2026-09-18RequestUnauthorizedError": { "properties": { "errors": { "items": { "$ref": "#/components/schemas/EorWorkersContractsContractIdAdditionalInformationGetResponsesContentApplicationJsonSchemaErrorsItems" }, "type": "array" } }, "required": [ "errors" ], "title": "GetAdditionalInformation-v2026-09-18RequestUnauthorizedError", "type": "object" }, "GetAdditionalInformationRequiredToRequestEmployeeTermination-v2026-01-01RequestBadRequestError": { "properties": { "errors": { "items": { "$ref": "#/components/schemas/EorContractsContractIdOffboardingRequiredInformationGetResponsesContentApplicationJsonSchemaErrorsItems" }, "type": "array" } }, "title": "GetAdditionalInformationRequiredToRequestEmployeeTermination-v2026-01-01RequestBadRequestError", "type": "object" }, "GetAdditionalInformationRequiredToRequestEmployeeTermination-v2026-01-01RequestForbiddenError": { "properties": { "errors": { "items": { "$ref": "#/components/schemas/EorContractsContractIdOffboardingRequiredInformationGetResponsesContentApplicationJsonSchemaErrorsItems" }, "type": "array" } }, "title": "GetAdditionalInformationRequiredToRequestEmployeeTermination-v2026-01-01RequestForbiddenError", "type": "object" }, "GetAdditionalInformationRequiredToRequestEmployeeTermination-v2026-01-01RequestInternalServerError": { "properties": { "errors": { "items": { "$ref": "#/components/schemas/EorContractsContractIdOffboardingRequiredInformationGetResponsesContentApplicationJsonSchemaErrorsItems" }, "type": "array" } }, "title": "GetAdditionalInformationRequiredToRequestEmployeeTermination-v2026-01-01RequestInternalServerError", "type": "object" }, "GetAdditionalInformationRequiredToRequestEmployeeTermination-v2026-01-01RequestUnauthorizedError": { "properties": { "errors": { "items": { "$ref": "#/components/schemas/EorContractsContractIdOffboardingRequiredInformationGetResponsesContentApplicationJsonSchemaErrorsItems" }, "type": "array" } }, "title": "GetAdditionalInformationRequiredToRequestEmployeeTermination-v2026-01-01RequestUnauthorizedError", "type": "object" }, "GetAllWebhookEventTypes-v2026-01-01RequestBadRequestError": { "properties": { "errors": { "description": "The list of errors that caused the request to fail.", "items": { "$ref": "#/components/schemas/WebhooksEventsTypesGetResponsesContentApplicationJsonSchemaErrorsItems" }, "type": "array" } }, "required": [ "errors" ], "title": "GetAllWebhookEventTypes-v2026-01-01RequestBadRequestError", "type": "object" }, "GetAllWebhookEventTypes-v2026-01-01RequestForbiddenError": { "properties": { "errors": { "description": "The list of errors that caused the request to fail.", "items": { "$ref": "#/components/schemas/WebhooksEventsTypesGetResponsesContentApplicationJsonSchemaErrorsItems" }, "type": "array" } }, "required": [ "errors" ], "title": "GetAllWebhookEventTypes-v2026-01-01RequestForbiddenError", "type": "object" }, "GetAllWebhookEventTypes-v2026-01-01RequestInternalServerError": { "properties": { "errors": { "description": "The list of errors that caused the request to fail.", "items": { "$ref": "#/components/schemas/WebhooksEventsTypesGetResponsesContentApplicationJsonSchemaErrorsItems" }, "type": "array" } }, "required": [ "errors" ], "title": "GetAllWebhookEventTypes-v2026-01-01RequestInternalServerError", "type": "object" }, "GetAllWebhookEventTypes-v2026-01-01RequestMethodNotAllowedError": { "properties": { "errors": { "description": "The list of errors that caused the request to fail.", "items": { "$ref": "#/components/schemas/WebhooksEventsTypesGetResponsesContentApplicationJsonSchemaErrorsItems" }, "type": "array" } }, "required": [ "errors" ], "title": "GetAllWebhookEventTypes-v2026-01-01RequestMethodNotAllowedError", "type": "object" }, "GetAllWebhookEventTypes-v2026-01-01RequestNotFoundError": { "properties": { "errors": { "description": "The list of errors that caused the request to fail.", "items": { "$ref": "#/components/schemas/WebhooksEventsTypesGetResponsesContentApplicationJsonSchemaErrorsItems" }, "type": "array" } }, "required": [ "errors" ], "title": "GetAllWebhookEventTypes-v2026-01-01RequestNotFoundError", "type": "object" }, "GetAllWebhookEventTypes-v2026-01-01RequestTooManyRequestsError": { "properties": { "errors": { "description": "The list of errors that caused the request to fail.", "items": { "$ref": "#/components/schemas/WebhooksEventsTypesGetResponsesContentApplicationJsonSchemaErrorsItems" }, "type": "array" } }, "required": [ "errors" ], "title": "GetAllWebhookEventTypes-v2026-01-01RequestTooManyRequestsError", "type": "object" }, "GetAllWebhookEventTypes-v2026-01-01RequestUnauthorizedError": { "properties": { "errors": { "description": "The list of errors that caused the request to fail.", "items": { "$ref": "#/components/schemas/WebhooksEventsTypesGetResponsesContentApplicationJsonSchemaErrorsItems" }, "type": "array" } }, "required": [ "errors" ], "title": "GetAllWebhookEventTypes-v2026-01-01RequestUnauthorizedError", "type": "object" }, "GetAllWebhooks-v2026-01-01RequestBadRequestError": { "properties": { "errors": { "description": "The list of errors that caused the request to fail.", "items": { "$ref": "#/components/schemas/WebhooksGetResponsesContentApplicationJsonSchemaErrorsItems" }, "type": "array" } }, "required": [ "errors" ], "title": "GetAllWebhooks-v2026-01-01RequestBadRequestError", "type": "object" }, "GetAllWebhooks-v2026-01-01RequestForbiddenError": { "properties": { "errors": { "description": "The list of errors that caused the request to fail.", "items": { "$ref": "#/components/schemas/WebhooksGetResponsesContentApplicationJsonSchemaErrorsItems" }, "type": "array" } }, "required": [ "errors" ], "title": "GetAllWebhooks-v2026-01-01RequestForbiddenError", "type": "object" }, "GetAllWebhooks-v2026-01-01RequestInternalServerError": { "properties": { "errors": { "description": "The list of errors that caused the request to fail.", "items": { "$ref": "#/components/schemas/WebhooksGetResponsesContentApplicationJsonSchemaErrorsItems" }, "type": "array" } }, "required": [ "errors" ], "title": "GetAllWebhooks-v2026-01-01RequestInternalServerError", "type": "object" }, "GetAllWebhooks-v2026-01-01RequestMethodNotAllowedError": { "properties": { "errors": { "description": "The list of errors that caused the request to fail.", "items": { "$ref": "#/components/schemas/WebhooksGetResponsesContentApplicationJsonSchemaErrorsItems" }, "type": "array" } }, "required": [ "errors" ], "title": "GetAllWebhooks-v2026-01-01RequestMethodNotAllowedError", "type": "object" }, "GetAllWebhooks-v2026-01-01RequestNotFoundError": { "properties": { "errors": { "description": "The list of errors that caused the request to fail.", "items": { "$ref": "#/components/schemas/WebhooksGetResponsesContentApplicationJsonSchemaErrorsItems" }, "type": "array" } }, "required": [ "errors" ], "title": "GetAllWebhooks-v2026-01-01RequestNotFoundError", "type": "object" }, "GetAllWebhooks-v2026-01-01RequestTooManyRequestsError": { "properties": { "errors": { "description": "The list of errors that caused the request to fail.", "items": { "$ref": "#/components/schemas/WebhooksGetResponsesContentApplicationJsonSchemaErrorsItems" }, "type": "array" } }, "required": [ "errors" ], "title": "GetAllWebhooks-v2026-01-01RequestTooManyRequestsError", "type": "object" }, "GetAllWebhooks-v2026-01-01RequestUnauthorizedError": { "properties": { "errors": { "description": "The list of errors that caused the request to fail.", "items": { "$ref": "#/components/schemas/WebhooksGetResponsesContentApplicationJsonSchemaErrorsItems" }, "type": "array" } }, "required": [ "errors" ], "title": "GetAllWebhooks-v2026-01-01RequestUnauthorizedError", "type": "object" }, "GetAmendmentDataPointsConfigurationByCountry-v2026-05-06RequestBadRequestError": { "properties": { "errors": { "items": { "$ref": "#/components/schemas/EorContractsAmendmentsDataPointsConfigurationGetResponsesContentApplicationJsonSchemaErrorsItems" }, "type": "array" } }, "required": [ "errors" ], "title": "GetAmendmentDataPointsConfigurationByCountry-v2026-05-06RequestBadRequestError", "type": "object" }, "GetAmendmentDataPointsConfigurationByCountry-v2026-05-06RequestForbiddenError": { "properties": { "errors": { "items": { "$ref": "#/components/schemas/EorContractsAmendmentsDataPointsConfigurationGetResponsesContentApplicationJsonSchemaErrorsItems" }, "type": "array" } }, "required": [ "errors" ], "title": "GetAmendmentDataPointsConfigurationByCountry-v2026-05-06RequestForbiddenError", "type": "object" }, "GetAmendmentDataPointsConfigurationByCountry-v2026-05-06RequestInternalServerError": { "properties": { "errors": { "items": { "$ref": "#/components/schemas/EorContractsAmendmentsDataPointsConfigurationGetResponsesContentApplicationJsonSchemaErrorsItems" }, "type": "array" } }, "required": [ "errors" ], "title": "GetAmendmentDataPointsConfigurationByCountry-v2026-05-06RequestInternalServerError", "type": "object" }, "GetAmendmentValidationSettingsForAnEorContract-v2026-01-01RequestBadRequestError": { "properties": { "errors": { "items": { "$ref": "#/components/schemas/EorContractsContractIdAmendmentsValidationSettingsGetResponsesContentApplicationJsonSchemaErrorsItems" }, "type": "array" } }, "required": [ "errors" ], "title": "GetAmendmentValidationSettingsForAnEorContract-v2026-01-01RequestBadRequestError", "type": "object" }, "GetAmendmentValidationSettingsForAnEorContract-v2026-01-01RequestInternalServerError": { "properties": { "errors": { "items": { "$ref": "#/components/schemas/EorContractsContractIdAmendmentsValidationSettingsGetResponsesContentApplicationJsonSchemaErrorsItems" }, "type": "array" } }, "required": [ "errors" ], "title": "GetAmendmentValidationSettingsForAnEorContract-v2026-01-01RequestInternalServerError", "type": "object" }, "GetAmendmentValidationSettingsForAnEorContract-v2026-01-01RequestNotFoundError": { "properties": { "errors": { "items": { "$ref": "#/components/schemas/EorContractsContractIdAmendmentsValidationSettingsGetResponsesContentApplicationJsonSchemaErrorsItems" }, "type": "array" } }, "required": [ "errors" ], "title": "GetAmendmentValidationSettingsForAnEorContract-v2026-01-01RequestNotFoundError", "type": "object" }, "GetBankTransferRequirements-v2026-01-01RequestBadRequestError": { "properties": { "errors": { "items": { "$ref": "#/components/schemas/PayoutsContractorsMethodsBankTransfersRequirementsGetResponsesContentApplicationJsonSchemaErrorsItems" }, "type": "array" } }, "title": "GetBankTransferRequirements-v2026-01-01RequestBadRequestError", "type": "object" }, "GetBillingInvoiceDownloadLink-v2026-01-01RequestNotFoundError": { "properties": { "errors": { "items": { "$ref": "#/components/schemas/InvoicesIdDownloadGetResponsesContentApplicationJsonSchemaErrorsItems" }, "type": "array" } }, "required": [ "errors" ], "title": "GetBillingInvoiceDownloadLink-v2026-01-01RequestNotFoundError", "type": "object" }, "GetBusinessVisaEligibilityAndRequirements-v2026-01-01RequestBadRequestError": { "properties": { "errors": { "items": { "$ref": "#/components/schemas/ImmigrationVisaRequirementBusinessGetResponsesContentApplicationJsonSchemaErrorsItems" }, "type": "array" } }, "title": "GetBusinessVisaEligibilityAndRequirements-v2026-01-01RequestBadRequestError", "type": "object" }, "GetBusinessVisaEligibilityAndRequirements-v2026-01-01RequestInternalServerError": { "properties": { "errors": { "items": { "$ref": "#/components/schemas/ImmigrationVisaRequirementBusinessGetResponsesContentApplicationJsonSchemaErrorsItems" }, "type": "array" } }, "title": "GetBusinessVisaEligibilityAndRequirements-v2026-01-01RequestInternalServerError", "type": "object" }, "GetCaseTimeline-v2026-10-14RequestBadRequestError": { "properties": { "errors": { "items": { "$ref": "#/components/schemas/ImmigrationCasesCaseIdTimelineGetResponsesContentApplicationJsonSchemaErrorsItems" }, "type": "array" } }, "title": "GetCaseTimeline-v2026-10-14RequestBadRequestError", "type": "object" }, "GetCaseTimeline-v2026-10-14RequestInternalServerError": { "properties": { "errors": { "items": { "$ref": "#/components/schemas/ImmigrationCasesCaseIdTimelineGetResponsesContentApplicationJsonSchemaErrorsItems" }, "type": "array" } }, "title": "GetCaseTimeline-v2026-10-14RequestInternalServerError", "type": "object" }, "GetContractAdditionalInfo-v2026-09-14RequestForbiddenError": { "properties": { "code": { "type": "string" }, "data": { "description": "Any type" }, "defined": { "type": "boolean" }, "message": { "default": "The caller is not authorized to access this contract.", "type": "string" }, "status": { "format": "double", "type": "number" } }, "required": [ "code", "status", "defined", "message" ], "title": "GetContractAdditionalInfo-v2026-09-14RequestForbiddenError", "type": "object" }, "GetContractAdditionalInfo-v2026-09-14RequestNotFoundError": { "properties": { "code": { "type": "string" }, "data": { "description": "Any type" }, "defined": { "type": "boolean" }, "message": { "default": "Contract not found or has no additional info.", "type": "string" }, "status": { "format": "double", "type": "number" } }, "required": [ "code", "status", "defined", "message" ], "title": "GetContractAdditionalInfo-v2026-09-14RequestNotFoundError", "type": "object" }, "GetCostCentersByLegalEntity-v2026-01-01RequestBadRequestError": { "properties": { "errors": { "items": { "$ref": "#/components/schemas/LegalEntitiesLegalEntityIdCostCentersGetResponsesContentApplicationJsonSchemaErrorsItems" }, "type": "array" }, "request": { "$ref": "#/components/schemas/LegalEntitiesLegalEntityIdCostCentersGetResponsesContentApplicationJsonSchemaRequest" } }, "title": "GetCostCentersByLegalEntity-v2026-01-01RequestBadRequestError", "type": "object" }, "GetCountryFieldsForALegalEntity-v2026-09-11RequestBadRequestError": { "properties": { "errors": { "items": { "$ref": "#/components/schemas/LegalEntitiesCountryFieldsCountryCodeGetResponsesContentApplicationJsonSchemaErrorsItems" }, "type": "array" } }, "title": "GetCountryFieldsForALegalEntity-v2026-09-11RequestBadRequestError", "type": "object" }, "GetCountryFieldsForALegalEntity-v2026-09-11RequestNotFoundError": { "properties": { "errors": { "items": { "$ref": "#/components/schemas/LegalEntitiesCountryFieldsCountryCodeGetResponsesContentApplicationJsonSchemaErrorsItems" }, "type": "array" } }, "title": "GetCountryFieldsForALegalEntity-v2026-09-11RequestNotFoundError", "type": "object" }, "GetCustomFieldsFromContracts-v2026-01-01RequestInternalServerError": { "properties": { "error": { "$ref": "#/components/schemas/ContractsCustomFieldsIdGetResponsesContentApplicationJsonSchemaError" } }, "required": [ "error" ], "title": "GetCustomFieldsFromContracts-v2026-01-01RequestInternalServerError", "type": "object" }, "GetDepartments-v2026-01-01RequestInternalServerError": { "properties": { "error": { "description": "A general error message indicating that the server encountered an unexpected issue.", "type": "string" } }, "title": "GetDepartments-v2026-01-01RequestInternalServerError", "type": "object" }, "GetDepartments-v2026-01-01RequestNotFoundError": { "properties": { "error": { "description": "An error message indicating that no departments were found.", "type": "string" } }, "title": "GetDepartments-v2026-01-01RequestNotFoundError", "type": "object" }, "GetDepartments-v2026-01-01RequestUnauthorizedError": { "properties": { "error": { "description": "An error message indicating that the authentication failed.", "type": "string" } }, "title": "GetDepartments-v2026-01-01RequestUnauthorizedError", "type": "object" }, "GetEmployeeAgreementDraftPreview-v2026-01-01RequestBadRequestError": { "properties": { "code": { "description": "Machine-readable error code", "type": "string" }, "message": { "description": "A description of the returned error", "type": "string" } }, "title": "GetEmployeeAgreementDraftPreview-v2026-01-01RequestBadRequestError", "type": "object" }, "GetEmployeeAgreementDraftPreview-v2026-01-01RequestNotFoundError": { "properties": { "code": { "description": "Machine-readable error code", "type": "string" }, "message": { "description": "A description of the returned error", "type": "string" } }, "title": "GetEmployeeAgreementDraftPreview-v2026-01-01RequestNotFoundError", "type": "object" }, "GetEorAdditionalCosts-v2026-01-01RequestBadRequestError": { "properties": { "errors": { "items": { "$ref": "#/components/schemas/EorAdditionalCostsCountryGetResponsesContentApplicationJsonSchemaErrorsItems" }, "type": "array" }, "request": { "$ref": "#/components/schemas/EorAdditionalCostsCountryGetResponsesContentApplicationJsonSchemaRequest" } }, "title": "GetEorAdditionalCosts-v2026-01-01RequestBadRequestError", "type": "object" }, "GetEorContractAmendmentPdfDownloadLinkForClientAndEmployee-v2026-01-01RequestBadRequestError": { "properties": { "errors": { "items": { "$ref": "#/components/schemas/EorContractsContractIdAmendmentsAmendmentIdPdfGetResponsesContentApplicationJsonSchemaErrorsItems" }, "type": "array" } }, "required": [ "errors" ], "title": "GetEorContractAmendmentPdfDownloadLinkForClientAndEmployee-v2026-01-01RequestBadRequestError", "type": "object" }, "GetEorContractAmendmentPdfDownloadLinkForClientAndEmployee-v2026-01-01RequestInternalServerError": { "properties": { "errors": { "items": { "$ref": "#/components/schemas/EorContractsContractIdAmendmentsAmendmentIdPdfGetResponsesContentApplicationJsonSchemaErrorsItems" }, "type": "array" } }, "required": [ "errors" ], "title": "GetEorContractAmendmentPdfDownloadLinkForClientAndEmployee-v2026-01-01RequestInternalServerError", "type": "object" }, "GetEorContractAmendmentPdfDownloadLinkForClientAndEmployee-v2026-01-01RequestNotFoundError": { "properties": { "errors": { "items": { "$ref": "#/components/schemas/EorContractsContractIdAmendmentsAmendmentIdPdfGetResponsesContentApplicationJsonSchemaErrorsItems" }, "type": "array" } }, "required": [ "errors" ], "title": "GetEorContractAmendmentPdfDownloadLinkForClientAndEmployee-v2026-01-01RequestNotFoundError", "type": "object" }, "GetGpContractBankAccounts-v2026-09-17RequestBadRequestError": { "properties": { "errors": { "items": { "$ref": "#/components/schemas/GpContractsContractIdBanksGetResponsesContentApplicationJsonSchemaErrorsItems" }, "type": "array" } }, "title": "GetGpContractBankAccounts-v2026-09-17RequestBadRequestError", "type": "object" }, "GetGpContractBankGuide-v2026-09-17RequestBadRequestError": { "properties": { "errors": { "items": { "$ref": "#/components/schemas/GpContractsContractIdBanksGuideGetResponsesContentApplicationJsonSchemaErrorsItems" }, "type": "array" } }, "title": "GetGpContractBankGuide-v2026-09-17RequestBadRequestError", "type": "object" }, "GetGroups-v2026-01-01RequestBadRequestError": { "properties": { "message": { "description": "Error message explaining what went wrong.", "type": "string" } }, "title": "GetGroups-v2026-01-01RequestBadRequestError", "type": "object" }, "GetHourlyReportPresetById-v2026-01-01RequestForbiddenError": { "properties": { "error": { "type": "string" } }, "title": "GetHourlyReportPresetById-v2026-01-01RequestForbiddenError", "type": "object" }, "GetHourlyReportPresetById-v2026-01-01RequestNotFoundError": { "properties": { "error": { "type": "string" } }, "title": "GetHourlyReportPresetById-v2026-01-01RequestNotFoundError", "type": "object" }, "GetHourlyReportPresets-v2026-01-01RequestBadRequestError": { "properties": { "errors": { "description": "Validation errors describing why the hourly report presets could not be listed.", "items": { "$ref": "#/components/schemas/ContractsContractIdTimesheetsPresetsGetResponsesContentApplicationJsonSchemaErrorsItems" }, "type": "array" } }, "required": [ "errors" ], "title": "GetHourlyReportPresets-v2026-01-01RequestBadRequestError", "type": "object" }, "GetHourlyReportPresets-v2026-01-01RequestForbiddenError": { "properties": { "errors": { "description": "Errors describing why the hourly report presets could not be accessed.", "items": { "$ref": "#/components/schemas/ContractsContractIdTimesheetsPresetsGetResponsesContentApplicationJsonSchemaErrorsItems" }, "type": "array" } }, "required": [ "errors" ], "title": "GetHourlyReportPresets-v2026-01-01RequestForbiddenError", "type": "object" }, "GetHourlyReportPresets-v2026-01-01RequestInternalServerError": { "properties": { "errors": { "description": "Generic upstream or internal errors emitted when the hourly report presets cannot be listed.", "items": { "$ref": "#/components/schemas/ContractsContractIdTimesheetsPresetsGetResponsesContentApplicationJsonSchemaErrorsItems" }, "type": "array" } }, "required": [ "errors" ], "title": "GetHourlyReportPresets-v2026-01-01RequestInternalServerError", "type": "object" }, "GetHourlyReportPresets-v2026-01-01RequestNotFoundError": { "properties": { "errors": { "description": "Errors describing why the presets could not be listed, such as the contract having no active work statement or the specified work_statement_id not belonging to it.", "items": { "$ref": "#/components/schemas/ContractsContractIdTimesheetsPresetsGetResponsesContentApplicationJsonSchemaErrorsItems" }, "type": "array" } }, "required": [ "errors" ], "title": "GetHourlyReportPresets-v2026-01-01RequestNotFoundError", "type": "object" }, "GetHourlyReportRootPresetById-v2026-01-01RequestBadRequestError": { "properties": { "error": { "type": "string" } }, "title": "GetHourlyReportRootPresetById-v2026-01-01RequestBadRequestError", "type": "object" }, "GetHourlyReportRootPresetById-v2026-01-01RequestNotFoundError": { "properties": { "error": { "type": "string" } }, "title": "GetHourlyReportRootPresetById-v2026-01-01RequestNotFoundError", "type": "object" }, "GetHourlyReportRootPresets-v2026-01-01RequestBadRequestError": { "properties": { "error": { "type": "string" } }, "title": "GetHourlyReportRootPresets-v2026-01-01RequestBadRequestError", "type": "object" }, "GetHrxManagerForWorker-v2026-01-01RequestForbiddenError": { "properties": { "errors": { "items": { "$ref": "#/components/schemas/EscalationsWorkersMeHrxGetResponsesContentApplicationJsonSchemaErrorsItems" }, "type": "array" } }, "title": "GetHrxManagerForWorker-v2026-01-01RequestForbiddenError", "type": "object" }, "GetHrxManagerForWorker-v2026-01-01RequestInternalServerError": { "properties": { "errors": { "items": { "$ref": "#/components/schemas/EscalationsWorkersMeHrxGetResponsesContentApplicationJsonSchemaErrorsItems" }, "type": "array" } }, "title": "GetHrxManagerForWorker-v2026-01-01RequestInternalServerError", "type": "object" }, "GetHrxManagerForWorker-v2026-01-01RequestNotFoundError": { "properties": { "errors": { "items": { "$ref": "#/components/schemas/EscalationsWorkersMeHrxGetResponsesContentApplicationJsonSchemaErrorsItems" }, "type": "array" } }, "title": "GetHrxManagerForWorker-v2026-01-01RequestNotFoundError", "type": "object" }, "GetIcInvoicingTaxes-v2026-01-01RequestBadRequestError": { "properties": { "errors": { "items": { "$ref": "#/components/schemas/ContractsContractIdIcInvoicingTaxesGetResponsesContentApplicationJsonSchemaErrorsItems" }, "type": "array" } }, "title": "GetIcInvoicingTaxes-v2026-01-01RequestBadRequestError", "type": "object" }, "GetIcInvoicingTaxes-v2026-01-01RequestInternalServerError": { "properties": { "errors": { "items": { "$ref": "#/components/schemas/ContractsContractIdIcInvoicingTaxesGetResponsesContentApplicationJsonSchemaErrorsItems" }, "type": "array" } }, "title": "GetIcInvoicingTaxes-v2026-01-01RequestInternalServerError", "type": "object" }, "GetImmigrationCaseDetails-v2026-01-01RequestBadRequestError": { "properties": { "errors": { "items": { "$ref": "#/components/schemas/ImmigrationClientCasesIdGetResponsesContentApplicationJsonSchemaErrorsItems" }, "type": "array" } }, "title": "GetImmigrationCaseDetails-v2026-01-01RequestBadRequestError", "type": "object" }, "GetImmigrationCaseDetails-v2026-01-01RequestInternalServerError": { "properties": { "errors": { "items": { "$ref": "#/components/schemas/ImmigrationClientCasesIdGetResponsesContentApplicationJsonSchemaErrorsItems" }, "type": "array" } }, "title": "GetImmigrationCaseDetails-v2026-01-01RequestInternalServerError", "type": "object" }, "GetInterviewTranscript-v2026-10-16RequestBadRequestError": { "properties": { "errors": { "description": "List of error objects", "items": { "$ref": "#/components/schemas/AtsInterviewsInterviewIdTranscriptGetResponsesContentApplicationJsonSchemaErrorsItems" }, "type": "array" } }, "required": [ "errors" ], "title": "GetInterviewTranscript-v2026-10-16RequestBadRequestError", "type": "object" }, "GetInterviewTranscript-v2026-10-16RequestForbiddenError": { "properties": { "errors": { "description": "List of error objects", "items": { "$ref": "#/components/schemas/AtsInterviewsInterviewIdTranscriptGetResponsesContentApplicationJsonSchemaErrorsItems" }, "type": "array" } }, "required": [ "errors" ], "title": "GetInterviewTranscript-v2026-10-16RequestForbiddenError", "type": "object" }, "GetInterviewTranscript-v2026-10-16RequestInternalServerError": { "properties": { "errors": { "description": "List of error objects", "items": { "$ref": "#/components/schemas/AtsInterviewsInterviewIdTranscriptGetResponsesContentApplicationJsonSchemaErrorsItems" }, "type": "array" } }, "required": [ "errors" ], "title": "GetInterviewTranscript-v2026-10-16RequestInternalServerError", "type": "object" }, "GetInterviewTranscript-v2026-10-16RequestNotFoundError": { "properties": { "errors": { "description": "List of error objects", "items": { "$ref": "#/components/schemas/AtsInterviewsInterviewIdTranscriptGetResponsesContentApplicationJsonSchemaErrorsItems" }, "type": "array" } }, "required": [ "errors" ], "title": "GetInterviewTranscript-v2026-10-16RequestNotFoundError", "type": "object" }, "GetInvoiceById-v2026-01-01RequestNotFoundError": { "properties": { "errors": { "description": "Error messages", "items": { "$ref": "#/components/schemas/InvoicesInvoiceIdGetResponsesContentApplicationJsonSchemaErrorsItems" }, "type": "array" }, "request": { "$ref": "#/components/schemas/InvoicesInvoiceIdGetResponsesContentApplicationJsonSchemaRequest", "description": "Error request details" } }, "required": [ "errors" ], "title": "GetInvoiceById-v2026-01-01RequestNotFoundError", "type": "object" }, "GetInvoiceDetailsById-v2026-04-27RequestBadRequestError": { "properties": { "errors": { "items": { "$ref": "#/components/schemas/IcWorkersInvoicesInvoiceIdGetResponsesContentApplicationJsonSchemaErrorsItems" }, "type": "array" } }, "required": [ "errors" ], "title": "GetInvoiceDetailsById-v2026-04-27RequestBadRequestError", "type": "object" }, "GetInvoiceDetailsById-v2026-04-27RequestForbiddenError": { "properties": { "errors": { "items": { "$ref": "#/components/schemas/IcWorkersInvoicesInvoiceIdGetResponsesContentApplicationJsonSchemaErrorsItems" }, "type": "array" }, "request": { "$ref": "#/components/schemas/IcWorkersInvoicesInvoiceIdGetResponsesContentApplicationJsonSchemaRequest", "description": "Present for some public API responses (e.g. when `x-is-api-call` is set)." } }, "required": [ "errors" ], "title": "GetInvoiceDetailsById-v2026-04-27RequestForbiddenError", "type": "object" }, "GetInvoiceDetailsById-v2026-04-27RequestInternalServerError": { "properties": { "errors": { "items": { "$ref": "#/components/schemas/IcWorkersInvoicesInvoiceIdGetResponsesContentApplicationJsonSchemaErrorsItems" }, "type": "array" } }, "required": [ "errors" ], "title": "GetInvoiceDetailsById-v2026-04-27RequestInternalServerError", "type": "object" }, "GetInvoiceDetailsById-v2026-04-27RequestPreconditionFailedError": { "properties": { "errors": { "items": { "$ref": "#/components/schemas/IcWorkersInvoicesInvoiceIdGetResponsesContentApplicationJsonSchemaErrorsItems" }, "type": "array" } }, "required": [ "errors" ], "title": "GetInvoiceDetailsById-v2026-04-27RequestPreconditionFailedError", "type": "object" }, "GetInvoiceDetailsById-v2026-04-27RequestUnauthorizedError": { "properties": { "errors": { "items": { "$ref": "#/components/schemas/IcWorkersInvoicesInvoiceIdGetResponsesContentApplicationJsonSchemaErrorsItems" }, "type": "array" } }, "required": [ "errors" ], "title": "GetInvoiceDetailsById-v2026-04-27RequestUnauthorizedError", "type": "object" }, "GetKnowledgeHubCountryGuidesByCountryCode-v2026-01-01RequestBadRequestError": { "properties": { "errors": { "items": { "$ref": "#/components/schemas/KnowledgeHubCountryGuideCountryCodeGetResponsesContentApplicationJsonSchemaErrorsItems" }, "type": "array" } }, "title": "GetKnowledgeHubCountryGuidesByCountryCode-v2026-01-01RequestBadRequestError", "type": "object" }, "GetKnowledgeHubCountryGuidesByCountryCode-v2026-01-01RequestInternalServerError": { "properties": { "errors": { "items": { "$ref": "#/components/schemas/KnowledgeHubCountryGuideCountryCodeGetResponsesContentApplicationJsonSchemaErrorsItems" }, "type": "array" } }, "title": "GetKnowledgeHubCountryGuidesByCountryCode-v2026-01-01RequestInternalServerError", "type": "object" }, "GetLegalEntity-v2026-09-09RequestBadRequestError": { "properties": { "message": { "description": "Error message explaining what went wrong.", "type": "string" } }, "title": "GetLegalEntity-v2026-09-09RequestBadRequestError", "type": "object" }, "GetLegalEntity-v2026-09-09RequestForbiddenError": { "properties": { "message": { "description": "Error message explaining why access is denied.", "type": "string" } }, "title": "GetLegalEntity-v2026-09-09RequestForbiddenError", "type": "object" }, "GetLegalEntity-v2026-09-09RequestNotFoundError": { "properties": { "message": { "description": "Error message returned when the legal entity does not exist.", "type": "string" } }, "title": "GetLegalEntity-v2026-09-09RequestNotFoundError", "type": "object" }, "GetLegalEntityKybState-v2026-10-01RequestForbiddenError": { "properties": { "errors": { "items": { "$ref": "#/components/schemas/LegalEntitiesLegalEntityIdKybGetResponsesContentApplicationJsonSchemaErrorsItems" }, "type": "array" } }, "required": [ "errors" ], "title": "GetLegalEntityKybState-v2026-10-01RequestForbiddenError", "type": "object" }, "GetLegalEntityKybState-v2026-10-01RequestNotFoundError": { "properties": { "errors": { "items": { "$ref": "#/components/schemas/LegalEntitiesLegalEntityIdKybGetResponsesContentApplicationJsonSchemaErrorsItems" }, "type": "array" } }, "required": [ "errors" ], "title": "GetLegalEntityKybState-v2026-10-01RequestNotFoundError", "type": "object" }, "GetLegalEntityKybState-v2026-10-01RequestUnauthorizedError": { "properties": { "errors": { "items": { "$ref": "#/components/schemas/LegalEntitiesLegalEntityIdKybGetResponsesContentApplicationJsonSchemaErrorsItems" }, "type": "array" } }, "required": [ "errors" ], "title": "GetLegalEntityKybState-v2026-10-01RequestUnauthorizedError", "type": "object" }, "GetLegalEntityRegistrationDocument-v2026-08-17RequestBadRequestError": { "properties": { "errors": { "description": "List of errors that occurred while processing the request.", "items": { "$ref": "#/components/schemas/LegalEntitiesLegalEntityIdRegistrationDocumentsDocumentIdGetResponsesContentApplicationJsonSchemaErrorsItems" }, "type": "array" } }, "required": [ "errors" ], "title": "GetLegalEntityRegistrationDocument-v2026-08-17RequestBadRequestError", "type": "object" }, "GetLegalEntityRegistrationDocument-v2026-08-17RequestForbiddenError": { "properties": { "errors": { "description": "List of errors that occurred while processing the request.", "items": { "$ref": "#/components/schemas/LegalEntitiesLegalEntityIdRegistrationDocumentsDocumentIdGetResponsesContentApplicationJsonSchemaErrorsItems" }, "type": "array" } }, "required": [ "errors" ], "title": "GetLegalEntityRegistrationDocument-v2026-08-17RequestForbiddenError", "type": "object" }, "GetLegalEntityRegistrationDocument-v2026-08-17RequestNotFoundError": { "properties": { "errors": { "description": "List of errors that occurred while processing the request.", "items": { "$ref": "#/components/schemas/LegalEntitiesLegalEntityIdRegistrationDocumentsDocumentIdGetResponsesContentApplicationJsonSchemaErrorsItems" }, "type": "array" } }, "required": [ "errors" ], "title": "GetLegalEntityRegistrationDocument-v2026-08-17RequestNotFoundError", "type": "object" }, "GetLegalEntityRegistrationDocument-v2026-08-17RequestUnauthorizedError": { "properties": { "errors": { "description": "List of errors that occurred while processing the request.", "items": { "$ref": "#/components/schemas/LegalEntitiesLegalEntityIdRegistrationDocumentsDocumentIdGetResponsesContentApplicationJsonSchemaErrorsItems" }, "type": "array" } }, "required": [ "errors" ], "title": "GetLegalEntityRegistrationDocument-v2026-08-17RequestUnauthorizedError", "type": "object" }, "GetLookups-v2026-01-01RequestBadRequestError": { "properties": { "message": { "description": "Error message explaining what went wrong.", "type": "string" } }, "title": "GetLookups-v2026-01-01RequestBadRequestError", "type": "object" }, "GetManagers-v2026-01-01RequestInternalServerError": { "properties": { "error": { "description": "A general error message indicating that the server encountered an unexpected issue.", "type": "string" } }, "title": "GetManagers-v2026-01-01RequestInternalServerError", "type": "object" }, "GetManagers-v2026-01-01RequestNotFoundError": { "properties": { "error": { "description": "An error message indicating that no managers were found.", "type": "string" } }, "title": "GetManagers-v2026-01-01RequestNotFoundError", "type": "object" }, "GetManagers-v2026-01-01RequestUnauthorizedError": { "properties": { "error": { "description": "An error message indicating that the authentication failed.", "type": "string" } }, "title": "GetManagers-v2026-01-01RequestUnauthorizedError", "type": "object" }, "GetMilestonesByContract-v2026-01-01RequestBadRequestError": { "properties": { "errors": { "description": "Validation errors describing why the contract milestones could not be retrieved.", "items": { "$ref": "#/components/schemas/ContractsContractIdMilestonesGetResponsesContentApplicationJsonSchemaErrorsItems" }, "type": "array" } }, "required": [ "errors" ], "title": "GetMilestonesByContract-v2026-01-01RequestBadRequestError", "type": "object" }, "GetMilestonesByContract-v2026-01-01RequestForbiddenError": { "properties": { "errors": { "description": "Errors describing why access to the contract milestones was denied.", "items": { "$ref": "#/components/schemas/ContractsContractIdMilestonesGetResponsesContentApplicationJsonSchemaErrorsItems" }, "type": "array" } }, "required": [ "errors" ], "title": "GetMilestonesByContract-v2026-01-01RequestForbiddenError", "type": "object" }, "GetMilestonesByContract-v2026-01-01RequestInternalServerError": { "properties": { "errors": { "description": "Generic upstream or internal errors emitted when the contract milestones cannot be retrieved.", "items": { "$ref": "#/components/schemas/ContractsContractIdMilestonesGetResponsesContentApplicationJsonSchemaErrorsItems" }, "type": "array" } }, "required": [ "errors" ], "title": "GetMilestonesByContract-v2026-01-01RequestInternalServerError", "type": "object" }, "GetMilestonesByContract-v2026-01-01RequestNotFoundError": { "properties": { "errors": { "description": "Errors describing why the contract could not be found.", "items": { "$ref": "#/components/schemas/ContractsContractIdMilestonesGetResponsesContentApplicationJsonSchemaErrorsItems" }, "type": "array" } }, "required": [ "errors" ], "title": "GetMilestonesByContract-v2026-01-01RequestNotFoundError", "type": "object" }, "GetMilestonesByContractAndId-v2026-01-01RequestBadRequestError": { "properties": { "errors": { "description": "Validation errors describing why the milestone could not be retrieved.", "items": { "$ref": "#/components/schemas/ContractsContractIdMilestonesMilestoneIdGetResponsesContentApplicationJsonSchemaErrorsItems" }, "type": "array" } }, "required": [ "errors" ], "title": "GetMilestonesByContractAndId-v2026-01-01RequestBadRequestError", "type": "object" }, "GetMilestonesByContractAndId-v2026-01-01RequestInternalServerError": { "properties": { "errors": { "description": "Generic upstream or internal errors emitted when the milestone cannot be retrieved.", "items": { "$ref": "#/components/schemas/ContractsContractIdMilestonesMilestoneIdGetResponsesContentApplicationJsonSchemaErrorsItems" }, "type": "array" } }, "required": [ "errors" ], "title": "GetMilestonesByContractAndId-v2026-01-01RequestInternalServerError", "type": "object" }, "GetMilestonesByContractAndId-v2026-01-01RequestNotFoundError": { "properties": { "errors": { "description": "Errors describing why the milestone could not be found.", "items": { "$ref": "#/components/schemas/ContractsContractIdMilestonesMilestoneIdGetResponsesContentApplicationJsonSchemaErrorsItems" }, "type": "array" } }, "required": [ "errors" ], "title": "GetMilestonesByContractAndId-v2026-01-01RequestNotFoundError", "type": "object" }, "GetMyCurrentPersonalProfile-v2026-01-01RequestUnauthorizedError": { "properties": { "errors": { "items": { "$ref": "#/components/schemas/PeopleMeGetResponsesContentApplicationJsonSchemaErrorsItems" }, "type": "array" } }, "title": "GetMyCurrentPersonalProfile-v2026-01-01RequestUnauthorizedError", "type": "object" }, "GetOffCyclePaymentByContractAndId-v2026-01-01RequestBadRequestError": { "properties": { "errors": { "description": "Validation errors describing why the off-cycle payment could not be retrieved.", "items": { "$ref": "#/components/schemas/ContractsContractIdOffCyclePaymentsOffCyclePaymentIdGetResponsesContentApplicationJsonSchemaErrorsItems" }, "type": "array" } }, "required": [ "errors" ], "title": "GetOffCyclePaymentByContractAndId-v2026-01-01RequestBadRequestError", "type": "object" }, "GetOffCyclePaymentByContractAndId-v2026-01-01RequestForbiddenError": { "properties": { "errors": { "description": "Errors describing why the off-cycle payment could not be accessed.", "items": { "$ref": "#/components/schemas/ContractsContractIdOffCyclePaymentsOffCyclePaymentIdGetResponsesContentApplicationJsonSchemaErrorsItems" }, "type": "array" } }, "required": [ "errors" ], "title": "GetOffCyclePaymentByContractAndId-v2026-01-01RequestForbiddenError", "type": "object" }, "GetOffCyclePaymentByContractAndId-v2026-01-01RequestInternalServerError": { "properties": { "errors": { "description": "Generic upstream or internal errors emitted when the off-cycle payment cannot be retrieved.", "items": { "$ref": "#/components/schemas/ContractsContractIdOffCyclePaymentsOffCyclePaymentIdGetResponsesContentApplicationJsonSchemaErrorsItems" }, "type": "array" } }, "required": [ "errors" ], "title": "GetOffCyclePaymentByContractAndId-v2026-01-01RequestInternalServerError", "type": "object" }, "GetOffCyclePaymentByContractAndId-v2026-01-01RequestNotFoundError": { "properties": { "errors": { "description": "Errors describing why the contract could not be found.", "items": { "$ref": "#/components/schemas/ContractsContractIdOffCyclePaymentsOffCyclePaymentIdGetResponsesContentApplicationJsonSchemaErrorsItems" }, "type": "array" } }, "required": [ "errors" ], "title": "GetOffCyclePaymentByContractAndId-v2026-01-01RequestNotFoundError", "type": "object" }, "GetOffCyclePaymentsByContract-v2026-01-01RequestBadRequestError": { "properties": { "errors": { "description": "Validation errors describing why the off-cycle payments could not be listed.", "items": { "$ref": "#/components/schemas/ContractsContractIdOffCyclePaymentsGetResponsesContentApplicationJsonSchemaErrorsItems" }, "type": "array" } }, "required": [ "errors" ], "title": "GetOffCyclePaymentsByContract-v2026-01-01RequestBadRequestError", "type": "object" }, "GetOffCyclePaymentsByContract-v2026-01-01RequestForbiddenError": { "properties": { "errors": { "description": "Errors describing why the off-cycle payments could not be accessed.", "items": { "$ref": "#/components/schemas/ContractsContractIdOffCyclePaymentsGetResponsesContentApplicationJsonSchemaErrorsItems" }, "type": "array" } }, "required": [ "errors" ], "title": "GetOffCyclePaymentsByContract-v2026-01-01RequestForbiddenError", "type": "object" }, "GetOffCyclePaymentsByContract-v2026-01-01RequestInternalServerError": { "properties": { "errors": { "description": "Generic upstream or internal errors emitted when the off-cycle payments cannot be listed.", "items": { "$ref": "#/components/schemas/ContractsContractIdOffCyclePaymentsGetResponsesContentApplicationJsonSchemaErrorsItems" }, "type": "array" } }, "required": [ "errors" ], "title": "GetOffCyclePaymentsByContract-v2026-01-01RequestInternalServerError", "type": "object" }, "GetOffCyclePaymentsByContract-v2026-01-01RequestNotFoundError": { "properties": { "errors": { "description": "Errors describing why the contract could not be found.", "items": { "$ref": "#/components/schemas/ContractsContractIdOffCyclePaymentsGetResponsesContentApplicationJsonSchemaErrorsItems" }, "type": "array" } }, "required": [ "errors" ], "title": "GetOffCyclePaymentsByContract-v2026-01-01RequestNotFoundError", "type": "object" }, "GetOnboardingDetailsByEmployeeHrisProfileId-v2026-01-01RequestBadRequestError": { "properties": { "errors": { "$ref": "#/components/schemas/OnboardingTrackerHrisProfileHrisProfileIdGetResponsesContentApplicationJsonSchemaErrors", "description": "The errors the endpoint returned" }, "request": { "$ref": "#/components/schemas/OnboardingTrackerHrisProfileHrisProfileIdGetResponsesContentApplicationJsonSchemaRequest", "description": "Error request details" } }, "required": [ "errors" ], "title": "GetOnboardingDetailsByEmployeeHrisProfileId-v2026-01-01RequestBadRequestError", "type": "object" }, "GetOnboardingDetailsByEmployeeHrisProfileId-v2026-01-01RequestNotFoundError": { "properties": { "errors": { "$ref": "#/components/schemas/OnboardingTrackerHrisProfileHrisProfileIdGetResponsesContentApplicationJsonSchemaErrors", "description": "The errors, as an object with an `errors` list, or as the list" }, "request": { "$ref": "#/components/schemas/OnboardingTrackerHrisProfileHrisProfileIdGetResponsesContentApplicationJsonSchemaRequest", "description": "Error request details" } }, "required": [ "errors" ], "title": "GetOnboardingDetailsByEmployeeHrisProfileId-v2026-01-01RequestNotFoundError", "type": "object" }, "GetOnboardingDetailsByOnboardingTrackerId-v2026-01-01RequestBadRequestError": { "properties": { "errors": { "$ref": "#/components/schemas/OnboardingTrackerTrackerIdGetResponsesContentApplicationJsonSchemaErrors", "description": "The errors the endpoint returned" }, "request": { "$ref": "#/components/schemas/OnboardingTrackerTrackerIdGetResponsesContentApplicationJsonSchemaRequest", "description": "Error request details" } }, "required": [ "errors" ], "title": "GetOnboardingDetailsByOnboardingTrackerId-v2026-01-01RequestBadRequestError", "type": "object" }, "GetOnboardingDetailsByOnboardingTrackerId-v2026-01-01RequestNotFoundError": { "properties": { "errors": { "$ref": "#/components/schemas/OnboardingTrackerTrackerIdGetResponsesContentApplicationJsonSchemaErrors", "description": "The errors, as an object with an `errors` list, or as the list" }, "request": { "$ref": "#/components/schemas/OnboardingTrackerTrackerIdGetResponsesContentApplicationJsonSchemaRequest", "description": "Error request details" } }, "required": [ "errors" ], "title": "GetOnboardingDetailsByOnboardingTrackerId-v2026-01-01RequestNotFoundError", "type": "object" }, "GetOnboardingDetailsByOnboardingTrackerId-v2026-01-01RequestPreconditionFailedError": { "properties": { "errors": { "additionalProperties": { "description": "Any type" }, "description": "The request details again, with no message", "type": "object" }, "request": { "$ref": "#/components/schemas/OnboardingTrackerTrackerIdGetResponsesContentApplicationJsonSchemaRequest", "description": "Error request details" } }, "required": [ "errors" ], "title": "GetOnboardingDetailsByOnboardingTrackerId-v2026-01-01RequestPreconditionFailedError", "type": "object" }, "GetOrganizationSecureVaultFolder-v2026-08-05RequestBadRequestError": { "properties": { "errors": { "description": "List of errors that occurred while processing the request.", "items": { "$ref": "#/components/schemas/OrganizationsSecureVaultFoldersFolderIdGetResponsesContentApplicationJsonSchemaErrorsItems" }, "type": "array" } }, "required": [ "errors" ], "title": "GetOrganizationSecureVaultFolder-v2026-08-05RequestBadRequestError", "type": "object" }, "GetOrganizationSecureVaultFolder-v2026-08-05RequestForbiddenError": { "properties": { "errors": { "description": "List of errors that occurred while processing the request.", "items": { "$ref": "#/components/schemas/OrganizationsSecureVaultFoldersFolderIdGetResponsesContentApplicationJsonSchemaErrorsItems" }, "type": "array" } }, "required": [ "errors" ], "title": "GetOrganizationSecureVaultFolder-v2026-08-05RequestForbiddenError", "type": "object" }, "GetOrganizationSecureVaultFolder-v2026-08-05RequestNotFoundError": { "properties": { "errors": { "description": "List of errors that occurred while processing the request.", "items": { "$ref": "#/components/schemas/OrganizationsSecureVaultFoldersFolderIdGetResponsesContentApplicationJsonSchemaErrorsItems" }, "type": "array" } }, "required": [ "errors" ], "title": "GetOrganizationSecureVaultFolder-v2026-08-05RequestNotFoundError", "type": "object" }, "GetOrganizationSecureVaultFolder-v2026-08-05RequestUnauthorizedError": { "properties": { "errors": { "description": "List of errors that occurred while processing the request.", "items": { "$ref": "#/components/schemas/OrganizationsSecureVaultFoldersFolderIdGetResponsesContentApplicationJsonSchemaErrorsItems" }, "type": "array" } }, "required": [ "errors" ], "title": "GetOrganizationSecureVaultFolder-v2026-08-05RequestUnauthorizedError", "type": "object" }, "GetOrganizations-v2026-01-01RequestInternalServerError": { "properties": { "error": { "description": "A general error message indicating that the server encountered an unexpected issue.", "type": "string" } }, "title": "GetOrganizations-v2026-01-01RequestInternalServerError", "type": "object" }, "GetOrganizations-v2026-01-01RequestNotFoundError": { "properties": { "error": { "description": "An error message indicating that no organization was found for the authenticated user.", "type": "string" } }, "title": "GetOrganizations-v2026-01-01RequestNotFoundError", "type": "object" }, "GetOrganizations-v2026-01-01RequestUnauthorizedError": { "properties": { "error": { "description": "An error message indicating that the authentication failed.", "type": "string" } }, "title": "GetOrganizations-v2026-01-01RequestUnauthorizedError", "type": "object" }, "GetPaymentStatement-v2026-07-23RequestForbiddenError": { "properties": { "errors": { "items": { "$ref": "#/components/schemas/PaymentsStatementsPaymentStatementIdGetResponsesContentApplicationJsonSchemaErrorsItems" }, "type": "array" } }, "required": [ "errors" ], "title": "GetPaymentStatement-v2026-07-23RequestForbiddenError", "type": "object" }, "GetPaymentStatement-v2026-07-23RequestInternalServerError": { "properties": { "errors": { "items": { "$ref": "#/components/schemas/PaymentsStatementsPaymentStatementIdGetResponsesContentApplicationJsonSchemaErrorsItems" }, "type": "array" } }, "required": [ "errors" ], "title": "GetPaymentStatement-v2026-07-23RequestInternalServerError", "type": "object" }, "GetPaymentStatement-v2026-07-23RequestNotFoundError": { "properties": { "errors": { "items": { "$ref": "#/components/schemas/PaymentsStatementsPaymentStatementIdGetResponsesContentApplicationJsonSchemaErrorsItems" }, "type": "array" } }, "required": [ "errors" ], "title": "GetPaymentStatement-v2026-07-23RequestNotFoundError", "type": "object" }, "GetPaymentStatement-v2026-07-23RequestUnauthorizedError": { "properties": { "errors": { "items": { "$ref": "#/components/schemas/PaymentsStatementsPaymentStatementIdGetResponsesContentApplicationJsonSchemaErrorsItems" }, "type": "array" } }, "required": [ "errors" ], "title": "GetPaymentStatement-v2026-07-23RequestUnauthorizedError", "type": "object" }, "GetPayrollActivations-v2026-10-12RequestForbiddenError": { "properties": { "code": { "type": "string" }, "data": { "description": "Any type" }, "defined": { "type": "boolean" }, "message": { "default": "Access forbidden. You do not have permission to view this resource.", "type": "string" }, "status": { "format": "double", "type": "number" } }, "required": [ "code", "status", "defined", "message" ], "title": "GetPayrollActivations-v2026-10-12RequestForbiddenError", "type": "object" }, "GetPayrollActivations-v2026-10-12RequestInternalServerError": { "properties": { "code": { "type": "string" }, "data": { "description": "Any type" }, "defined": { "type": "boolean" }, "message": { "default": "Internal server error.", "type": "string" }, "status": { "format": "double", "type": "number" } }, "required": [ "code", "status", "defined", "message" ], "title": "GetPayrollActivations-v2026-10-12RequestInternalServerError", "type": "object" }, "GetPayrollActivations-v2026-10-12RequestNotFoundError": { "properties": { "code": { "type": "string" }, "data": { "description": "Any type" }, "defined": { "type": "boolean" }, "message": { "default": "Legal entity not found.", "type": "string" }, "status": { "format": "double", "type": "number" } }, "required": [ "code", "status", "defined", "message" ], "title": "GetPayrollActivations-v2026-10-12RequestNotFoundError", "type": "object" }, "GetPayrollActivations-v2026-10-12RequestUnauthorizedError": { "properties": { "code": { "type": "string" }, "data": { "description": "Any type" }, "defined": { "type": "boolean" }, "message": { "default": "Access denied due to missing or invalid credentials.", "type": "string" }, "status": { "format": "double", "type": "number" } }, "required": [ "code", "status", "defined", "message" ], "title": "GetPayrollActivations-v2026-10-12RequestUnauthorizedError", "type": "object" }, "GetPayrollMigrationImport-v2026-09-15RequestForbiddenError": { "properties": { "code": { "type": "string" }, "data": { "description": "Any type" }, "defined": { "type": "boolean" }, "message": { "default": "The caller is not authorized to act on this legal entity.", "type": "string" }, "status": { "format": "double", "type": "number" } }, "required": [ "code", "status", "defined", "message" ], "title": "GetPayrollMigrationImport-v2026-09-15RequestForbiddenError", "type": "object" }, "GetPayrollMigrationImport-v2026-09-15RequestInternalServerError": { "properties": { "code": { "type": "string" }, "data": { "description": "Any type" }, "defined": { "type": "boolean" }, "message": { "default": "Internal server error.", "type": "string" }, "status": { "format": "double", "type": "number" } }, "required": [ "code", "status", "defined", "message" ], "title": "GetPayrollMigrationImport-v2026-09-15RequestInternalServerError", "type": "object" }, "GetPayrollMigrationImport-v2026-09-15RequestNotFoundError": { "properties": { "code": { "type": "string" }, "data": { "description": "Any type" }, "defined": { "type": "boolean" }, "message": { "default": "Payroll migration import not found.", "type": "string" }, "status": { "format": "double", "type": "number" } }, "required": [ "code", "status", "defined", "message" ], "title": "GetPayrollMigrationImport-v2026-09-15RequestNotFoundError", "type": "object" }, "GetPayrollMigrationImport-v2026-09-15RequestUnauthorizedError": { "properties": { "code": { "type": "string" }, "data": { "description": "Any type" }, "defined": { "type": "boolean" }, "message": { "default": "The request carries no caller identity the gateway could resolve.", "type": "string" }, "status": { "format": "double", "type": "number" } }, "required": [ "code", "status", "defined", "message" ], "title": "GetPayrollMigrationImport-v2026-09-15RequestUnauthorizedError", "type": "object" }, "GetPersonalInformationById-v2026-01-01RequestInternalServerError": { "properties": { "error": { "$ref": "#/components/schemas/PeopleWorkerIdPersonalGetResponsesContentApplicationJsonSchemaError" } }, "required": [ "error" ], "title": "GetPersonalInformationById-v2026-01-01RequestInternalServerError", "type": "object" }, "GetPoliciesForOrganization-v2026-09-09RequestBadRequestError": { "properties": { "errors": { "items": { "$ref": "#/components/schemas/TimeOffsPolicyGetResponsesContentApplicationJsonSchemaErrorsItems" }, "type": "array" } }, "required": [ "errors" ], "title": "GetPoliciesForOrganization-v2026-09-09RequestBadRequestError", "type": "object" }, "GetPoliciesForOrganization-v2026-09-09RequestForbiddenError": { "properties": { "errors": { "items": { "$ref": "#/components/schemas/TimeOffsPolicyGetResponsesContentApplicationJsonSchemaErrorsItems" }, "type": "array" } }, "required": [ "errors" ], "title": "GetPoliciesForOrganization-v2026-09-09RequestForbiddenError", "type": "object" }, "GetPoliciesForOrganization-v2026-09-09RequestInternalServerError": { "properties": { "errors": { "items": { "$ref": "#/components/schemas/TimeOffsPolicyGetResponsesContentApplicationJsonSchemaErrorsItems" }, "type": "array" } }, "required": [ "errors" ], "title": "GetPoliciesForOrganization-v2026-09-09RequestInternalServerError", "type": "object" }, "GetPoliciesForOrganization-v2026-09-09RequestUnauthorizedError": { "properties": { "errors": { "items": { "$ref": "#/components/schemas/TimeOffsPolicyGetResponsesContentApplicationJsonSchemaErrorsItems" }, "type": "array" } }, "required": [ "errors" ], "title": "GetPoliciesForOrganization-v2026-09-09RequestUnauthorizedError", "type": "object" }, "GetProfileEntitlements-v2026-01-01RequestBadRequestError": { "properties": { "errors": { "items": { "$ref": "#/components/schemas/TimeOffsProfileHrisProfileIdEntitlementsGetResponsesContentApplicationJsonSchemaErrorsItems" }, "type": "array" }, "request": { "$ref": "#/components/schemas/TimeOffsProfileHrisProfileIdEntitlementsGetResponsesContentApplicationJsonSchemaRequest" } }, "title": "GetProfileEntitlements-v2026-01-01RequestBadRequestError", "type": "object" }, "GetProfilesAssignedToPolicy-v2026-09-09RequestBadRequestError": { "properties": { "errors": { "items": { "$ref": "#/components/schemas/TimeOffsPolicyPolicyIdAssignmentsGetResponsesContentApplicationJsonSchemaErrorsItems" }, "type": "array" } }, "required": [ "errors" ], "title": "GetProfilesAssignedToPolicy-v2026-09-09RequestBadRequestError", "type": "object" }, "GetProfilesAssignedToPolicy-v2026-09-09RequestForbiddenError": { "properties": { "errors": { "items": { "$ref": "#/components/schemas/TimeOffsPolicyPolicyIdAssignmentsGetResponsesContentApplicationJsonSchemaErrorsItems" }, "type": "array" } }, "required": [ "errors" ], "title": "GetProfilesAssignedToPolicy-v2026-09-09RequestForbiddenError", "type": "object" }, "GetProfilesAssignedToPolicy-v2026-09-09RequestInternalServerError": { "properties": { "errors": { "items": { "$ref": "#/components/schemas/TimeOffsPolicyPolicyIdAssignmentsGetResponsesContentApplicationJsonSchemaErrorsItems" }, "type": "array" } }, "required": [ "errors" ], "title": "GetProfilesAssignedToPolicy-v2026-09-09RequestInternalServerError", "type": "object" }, "GetProfilesAssignedToPolicy-v2026-09-09RequestNotFoundError": { "properties": { "errors": { "items": { "$ref": "#/components/schemas/TimeOffsPolicyPolicyIdAssignmentsGetResponsesContentApplicationJsonSchemaErrorsItems" }, "type": "array" } }, "required": [ "errors" ], "title": "GetProfilesAssignedToPolicy-v2026-09-09RequestNotFoundError", "type": "object" }, "GetProfilesAssignedToPolicy-v2026-09-09RequestUnauthorizedError": { "properties": { "errors": { "items": { "$ref": "#/components/schemas/TimeOffsPolicyPolicyIdAssignmentsGetResponsesContentApplicationJsonSchemaErrorsItems" }, "type": "array" } }, "required": [ "errors" ], "title": "GetProfilesAssignedToPolicy-v2026-09-09RequestUnauthorizedError", "type": "object" }, "GetShiftDetails-v2026-01-01RequestBadRequestError": { "properties": { "error": { "$ref": "#/components/schemas/TimeTrackingShiftsExternalIdGetResponsesContentApplicationJsonSchemaError" } }, "title": "GetShiftDetails-v2026-01-01RequestBadRequestError", "type": "object" }, "GetSpecificImmigrationCaseDetails-v2026-04-02RequestBadRequestError": { "properties": { "errors": { "items": { "$ref": "#/components/schemas/ImmigrationWorkersCasesCaseIdGetResponsesContentApplicationJsonSchemaErrorsItems" }, "type": "array" } }, "title": "GetSpecificImmigrationCaseDetails-v2026-04-02RequestBadRequestError", "type": "object" }, "GetSpecificImmigrationCaseDetails-v2026-04-02RequestInternalServerError": { "properties": { "errors": { "items": { "$ref": "#/components/schemas/ImmigrationWorkersCasesCaseIdGetResponsesContentApplicationJsonSchemaErrorsItems" }, "type": "array" } }, "title": "GetSpecificImmigrationCaseDetails-v2026-04-02RequestInternalServerError", "type": "object" }, "GetStaticEmployeeBankTransferRequirements-v2026-09-28RequestBadRequestError": { "properties": { "errors": { "items": { "$ref": "#/components/schemas/PayoutsEmployeesMethodsBankTransfersRequirementsGetResponsesContentApplicationJsonSchemaErrorsItems" }, "type": "array" } }, "required": [ "errors" ], "title": "GetStaticEmployeeBankTransferRequirements-v2026-09-28RequestBadRequestError", "type": "object" }, "GetStaticEmployeeBankTransferRequirements-v2026-09-28RequestInternalServerError": { "properties": { "errors": { "items": { "$ref": "#/components/schemas/PayoutsEmployeesMethodsBankTransfersRequirementsGetResponsesContentApplicationJsonSchemaErrorsItems" }, "type": "array" } }, "required": [ "errors" ], "title": "GetStaticEmployeeBankTransferRequirements-v2026-09-28RequestInternalServerError", "type": "object" }, "GetStaticEmployeeBankTransferRequirements-v2026-09-28RequestServiceUnavailableError": { "properties": { "errors": { "items": { "$ref": "#/components/schemas/PayoutsEmployeesMethodsBankTransfersRequirementsGetResponsesContentApplicationJsonSchemaErrorsItems" }, "type": "array" } }, "required": [ "errors" ], "title": "GetStaticEmployeeBankTransferRequirements-v2026-09-28RequestServiceUnavailableError", "type": "object" }, "GetTeams-v2026-01-01RequestInternalServerError": { "properties": { "error": { "description": "A general error message indicating that the server encountered an unexpected issue.", "type": "string" } }, "title": "GetTeams-v2026-01-01RequestInternalServerError", "type": "object" }, "GetTeams-v2026-01-01RequestNotFoundError": { "properties": { "error": { "description": "An error message indicating that no teams were found.", "type": "string" } }, "title": "GetTeams-v2026-01-01RequestNotFoundError", "type": "object" }, "GetTeams-v2026-01-01RequestUnauthorizedError": { "properties": { "error": { "description": "An error message indicating that the authentication failed.", "type": "string" } }, "title": "GetTeams-v2026-01-01RequestUnauthorizedError", "type": "object" }, "GetTheRolesOfTheCurrentOrganization-v2026-01-01RequestBadRequestError": { "properties": { "error": { "type": "string" } }, "title": "GetTheRolesOfTheCurrentOrganization-v2026-01-01RequestBadRequestError", "type": "object" }, "GetTheRolesOfTheCurrentOrganization-v2026-01-01RequestInternalServerError": { "properties": { "error": { "type": "string" } }, "title": "GetTheRolesOfTheCurrentOrganization-v2026-01-01RequestInternalServerError", "type": "object" }, "GetTheRolesOfTheCurrentOrganization-v2026-01-01RequestUnauthorizedError": { "properties": { "error": { "type": "string" } }, "title": "GetTheRolesOfTheCurrentOrganization-v2026-01-01RequestUnauthorizedError", "type": "object" }, "GetTimeOffAttachmentDownloadUrl-v2026-07-31RequestForbiddenError": { "properties": { "errors": { "items": { "$ref": "#/components/schemas/TimeOffsAttachmentsAttachmentIdDownloadGetResponsesContentApplicationJsonSchemaErrorsItems" }, "type": "array" } }, "required": [ "errors" ], "title": "GetTimeOffAttachmentDownloadUrl-v2026-07-31RequestForbiddenError", "type": "object" }, "GetTimeOffAttachmentDownloadUrl-v2026-07-31RequestNotFoundError": { "properties": { "errors": { "items": { "$ref": "#/components/schemas/TimeOffsAttachmentsAttachmentIdDownloadGetResponsesContentApplicationJsonSchemaErrorsItems" }, "type": "array" } }, "required": [ "errors" ], "title": "GetTimeOffAttachmentDownloadUrl-v2026-07-31RequestNotFoundError", "type": "object" }, "GetTimeOffEventsForProfile-v2026-01-01RequestBadRequestError": { "properties": { "errors": { "items": { "$ref": "#/components/schemas/TimeOffsTimeOffEventsGetResponsesContentApplicationJsonSchemaErrorsItems" }, "type": "array" }, "request": { "$ref": "#/components/schemas/TimeOffsTimeOffEventsGetResponsesContentApplicationJsonSchemaRequest" } }, "title": "GetTimeOffEventsForProfile-v2026-01-01RequestBadRequestError", "type": "object" }, "GetTimesheetById-v2026-01-01RequestBadRequestError": { "properties": { "errors": { "description": "Validation errors describing why the timesheet could not be retrieved.", "items": { "$ref": "#/components/schemas/TimesheetsTimesheetIdGetResponsesContentApplicationJsonSchemaErrorsItems" }, "type": "array" } }, "required": [ "errors" ], "title": "GetTimesheetById-v2026-01-01RequestBadRequestError", "type": "object" }, "GetTimesheetById-v2026-01-01RequestForbiddenError": { "properties": { "errors": { "description": "Errors describing why the timesheet could not be found or accessed.", "items": { "$ref": "#/components/schemas/TimesheetsTimesheetIdGetResponsesContentApplicationJsonSchemaErrorsItems" }, "type": "array" } }, "required": [ "errors" ], "title": "GetTimesheetById-v2026-01-01RequestForbiddenError", "type": "object" }, "GetTimesheetById-v2026-01-01RequestInternalServerError": { "properties": { "errors": { "description": "Generic upstream or internal errors emitted when the timesheet cannot be retrieved.", "items": { "$ref": "#/components/schemas/TimesheetsTimesheetIdGetResponsesContentApplicationJsonSchemaErrorsItems" }, "type": "array" } }, "required": [ "errors" ], "title": "GetTimesheetById-v2026-01-01RequestInternalServerError", "type": "object" }, "GetTimesheetsByContract-v2026-01-01RequestBadRequestError": { "properties": { "errors": { "description": "Validation errors describing why the contract timesheets could not be listed.", "items": { "$ref": "#/components/schemas/ContractsContractIdTimesheetsGetResponsesContentApplicationJsonSchemaErrorsItems" }, "type": "array" } }, "required": [ "errors" ], "title": "GetTimesheetsByContract-v2026-01-01RequestBadRequestError", "type": "object" }, "GetTimesheetsByContract-v2026-01-01RequestForbiddenError": { "properties": { "errors": { "description": "Errors describing why the contract timesheets could not be accessed.", "items": { "$ref": "#/components/schemas/ContractsContractIdTimesheetsGetResponsesContentApplicationJsonSchemaErrorsItems" }, "type": "array" } }, "required": [ "errors" ], "title": "GetTimesheetsByContract-v2026-01-01RequestForbiddenError", "type": "object" }, "GetTimesheetsByContract-v2026-01-01RequestInternalServerError": { "properties": { "errors": { "description": "Generic upstream or internal errors emitted when the contract timesheets cannot be listed.", "items": { "$ref": "#/components/schemas/ContractsContractIdTimesheetsGetResponsesContentApplicationJsonSchemaErrorsItems" }, "type": "array" } }, "required": [ "errors" ], "title": "GetTimesheetsByContract-v2026-01-01RequestInternalServerError", "type": "object" }, "GetTimesheetsByContract-v2026-01-01RequestNotFoundError": { "properties": { "errors": { "description": "Errors describing why the contract could not be found.", "items": { "$ref": "#/components/schemas/ContractsContractIdTimesheetsGetResponsesContentApplicationJsonSchemaErrorsItems" }, "type": "array" } }, "required": [ "errors" ], "title": "GetTimesheetsByContract-v2026-01-01RequestNotFoundError", "type": "object" }, "GetWebhookById-v2026-01-01RequestBadRequestError": { "properties": { "errors": { "description": "The list of errors that caused the request to fail.", "items": { "$ref": "#/components/schemas/WebhooksIdGetResponsesContentApplicationJsonSchemaErrorsItems" }, "type": "array" } }, "required": [ "errors" ], "title": "GetWebhookById-v2026-01-01RequestBadRequestError", "type": "object" }, "GetWebhookById-v2026-01-01RequestForbiddenError": { "properties": { "errors": { "description": "The list of errors that caused the request to fail.", "items": { "$ref": "#/components/schemas/WebhooksIdGetResponsesContentApplicationJsonSchemaErrorsItems" }, "type": "array" } }, "required": [ "errors" ], "title": "GetWebhookById-v2026-01-01RequestForbiddenError", "type": "object" }, "GetWebhookById-v2026-01-01RequestInternalServerError": { "properties": { "errors": { "description": "The list of errors that caused the request to fail.", "items": { "$ref": "#/components/schemas/WebhooksIdGetResponsesContentApplicationJsonSchemaErrorsItems" }, "type": "array" } }, "required": [ "errors" ], "title": "GetWebhookById-v2026-01-01RequestInternalServerError", "type": "object" }, "GetWebhookById-v2026-01-01RequestMethodNotAllowedError": { "properties": { "errors": { "description": "The list of errors that caused the request to fail.", "items": { "$ref": "#/components/schemas/WebhooksIdGetResponsesContentApplicationJsonSchemaErrorsItems" }, "type": "array" } }, "required": [ "errors" ], "title": "GetWebhookById-v2026-01-01RequestMethodNotAllowedError", "type": "object" }, "GetWebhookById-v2026-01-01RequestNotFoundError": { "properties": { "errors": { "description": "The list of errors that caused the request to fail.", "items": { "$ref": "#/components/schemas/WebhooksIdGetResponsesContentApplicationJsonSchemaErrorsItems" }, "type": "array" } }, "required": [ "errors" ], "title": "GetWebhookById-v2026-01-01RequestNotFoundError", "type": "object" }, "GetWebhookById-v2026-01-01RequestTooManyRequestsError": { "properties": { "errors": { "description": "The list of errors that caused the request to fail.", "items": { "$ref": "#/components/schemas/WebhooksIdGetResponsesContentApplicationJsonSchemaErrorsItems" }, "type": "array" } }, "required": [ "errors" ], "title": "GetWebhookById-v2026-01-01RequestTooManyRequestsError", "type": "object" }, "GetWebhookById-v2026-01-01RequestUnauthorizedError": { "properties": { "errors": { "description": "The list of errors that caused the request to fail.", "items": { "$ref": "#/components/schemas/WebhooksIdGetResponsesContentApplicationJsonSchemaErrorsItems" }, "type": "array" } }, "required": [ "errors" ], "title": "GetWebhookById-v2026-01-01RequestUnauthorizedError", "type": "object" }, "GetWorkScheduleAndHolidays-v2026-01-01RequestBadRequestError": { "properties": { "errors": { "items": { "$ref": "#/components/schemas/TimeOffsDailiesGetResponsesContentApplicationJsonSchemaErrorsItems" }, "type": "array" }, "request": { "$ref": "#/components/schemas/TimeOffsDailiesGetResponsesContentApplicationJsonSchemaRequest" } }, "title": "GetWorkScheduleAndHolidays-v2026-01-01RequestBadRequestError", "type": "object" }, "GetWorkStatementPaymentPolicies-v2026-09-07RequestBadRequestError": { "properties": { "errors": { "items": { "$ref": "#/components/schemas/WorkStatementPaymentPoliciesGetResponsesContentApplicationJsonSchemaErrorsItems" }, "type": "array" } }, "title": "GetWorkStatementPaymentPolicies-v2026-09-07RequestBadRequestError", "type": "object" }, "GetWorkStatementPaymentPolicies-v2026-09-07RequestInternalServerError": { "properties": { "errors": { "items": { "$ref": "#/components/schemas/WorkStatementPaymentPoliciesGetResponsesContentApplicationJsonSchemaErrorsItems" }, "type": "array" } }, "title": "GetWorkStatementPaymentPolicies-v2026-09-07RequestInternalServerError", "type": "object" }, "GetWorkerAdditionalFieldsForEor-v2026-01-01RequestBadRequestError": { "properties": { "errors": { "items": { "$ref": "#/components/schemas/FormsEorWorkerAdditionalFieldsCountryCodeGetResponsesContentApplicationJsonSchemaErrorsItems" }, "type": "array" } }, "title": "GetWorkerAdditionalFieldsForEor-v2026-01-01RequestBadRequestError", "type": "object" }, "GetWorkerAdditionalFieldsForEor-v2026-01-01RequestInternalServerError": { "properties": { "errors": { "items": { "$ref": "#/components/schemas/FormsEorWorkerAdditionalFieldsCountryCodeGetResponsesContentApplicationJsonSchemaErrorsItems" }, "type": "array" } }, "title": "GetWorkerAdditionalFieldsForEor-v2026-01-01RequestInternalServerError", "type": "object" }, "GetWorkerContractComplianceDocument-v2026-08-25RequestBadRequestError": { "properties": { "errors": { "description": "Errors that occurred while processing the request.", "items": { "$ref": "#/components/schemas/WorkersContractsContractIdComplianceDocumentsDocumentIdGetResponsesContentApplicationJsonSchemaErrorsItems" }, "type": "array" } }, "required": [ "errors" ], "title": "GetWorkerContractComplianceDocument-v2026-08-25RequestBadRequestError", "type": "object" }, "GetWorkerContractComplianceDocument-v2026-08-25RequestForbiddenError": { "properties": { "errors": { "description": "Errors that occurred while processing the request.", "items": { "$ref": "#/components/schemas/WorkersContractsContractIdComplianceDocumentsDocumentIdGetResponsesContentApplicationJsonSchemaErrorsItems" }, "type": "array" } }, "required": [ "errors" ], "title": "GetWorkerContractComplianceDocument-v2026-08-25RequestForbiddenError", "type": "object" }, "GetWorkerContractComplianceDocument-v2026-08-25RequestNotFoundError": { "properties": { "errors": { "description": "Errors that occurred while processing the request.", "items": { "$ref": "#/components/schemas/WorkersContractsContractIdComplianceDocumentsDocumentIdGetResponsesContentApplicationJsonSchemaErrorsItems" }, "type": "array" } }, "required": [ "errors" ], "title": "GetWorkerContractComplianceDocument-v2026-08-25RequestNotFoundError", "type": "object" }, "GetWorkerContractComplianceDocument-v2026-08-25RequestUnauthorizedError": { "properties": { "errors": { "description": "Errors that occurred while processing the request.", "items": { "$ref": "#/components/schemas/WorkersContractsContractIdComplianceDocumentsDocumentIdGetResponsesContentApplicationJsonSchemaErrorsItems" }, "type": "array" } }, "required": [ "errors" ], "title": "GetWorkerContractComplianceDocument-v2026-08-25RequestUnauthorizedError", "type": "object" }, "GetWorkerContractComplianceDocument-v2026-08-25RequestUnprocessableEntityError": { "properties": { "errors": { "description": "Errors that occurred while processing the request.", "items": { "$ref": "#/components/schemas/WorkersContractsContractIdComplianceDocumentsDocumentIdGetResponsesContentApplicationJsonSchemaErrorsItems" }, "type": "array" } }, "required": [ "errors" ], "title": "GetWorkerContractComplianceDocument-v2026-08-25RequestUnprocessableEntityError", "type": "object" }, "GetWorkersKycDetails-v2026-01-01RequestBadRequestError": { "properties": { "errors": { "$ref": "#/components/schemas/ScreeningsKycDetailsGetResponsesContentApplicationJsonSchemaErrors" } }, "title": "GetWorkersKycDetails-v2026-01-01RequestBadRequestError", "type": "object" }, "GetWorkersKycDetails-v2026-01-01RequestConflictError": { "properties": { "errors": { "$ref": "#/components/schemas/ScreeningsKycDetailsGetResponsesContentApplicationJsonSchemaErrors" } }, "title": "GetWorkersKycDetails-v2026-01-01RequestConflictError", "type": "object" }, "GetWorkersKycDetails-v2026-01-01RequestForbiddenError": { "properties": { "errors": { "$ref": "#/components/schemas/ScreeningsKycDetailsGetResponsesContentApplicationJsonSchemaErrors" } }, "title": "GetWorkersKycDetails-v2026-01-01RequestForbiddenError", "type": "object" }, "GetWorkersKycDetails-v2026-01-01RequestNotFoundError": { "properties": { "errors": { "items": { "$ref": "#/components/schemas/ScreeningsKycDetailsGetResponsesContentApplicationJsonSchemaErrorsItems" }, "type": "array" } }, "title": "GetWorkersKycDetails-v2026-01-01RequestNotFoundError", "type": "object" }, "GetWorkersKycDetails-v2026-01-01RequestPreconditionFailedError": { "properties": { "errors": { "$ref": "#/components/schemas/ScreeningsKycDetailsGetResponsesContentApplicationJsonSchemaErrors" } }, "title": "GetWorkersKycDetails-v2026-01-01RequestPreconditionFailedError", "type": "object" }, "GetsG2NReportDataForAGivenPayrollCycleByItsId-v2026-01-01RequestBadRequestError": { "properties": { "errors": { "items": { "$ref": "#/components/schemas/ReportsPayrollCyclesCycleIdGrossToNetGetResponsesContentApplicationJsonSchemaErrorsItems" }, "type": "array" } }, "title": "GetsG2NReportDataForAGivenPayrollCycleByItsId-v2026-01-01RequestBadRequestError", "type": "object" }, "GetsG2NReportDataForAGivenPayrollCycleByItsId-v2026-01-01RequestInternalServerError": { "properties": { "errors": { "items": { "$ref": "#/components/schemas/ReportsPayrollCyclesCycleIdGrossToNetGetResponsesContentApplicationJsonSchemaErrorsItems" }, "type": "array" } }, "title": "GetsG2NReportDataForAGivenPayrollCycleByItsId-v2026-01-01RequestInternalServerError", "type": "object" }, "GetsG2NReportDataForAGivenPayrollCycleByItsId-v2026-01-01RequestNotFoundError": { "properties": { "code": { "description": "Machine-readable error code.", "type": "string" }, "message": { "description": "Error message explaining the resource was not found.", "type": "string" } }, "title": "GetsG2NReportDataForAGivenPayrollCycleByItsId-v2026-01-01RequestNotFoundError", "type": "object" }, "Global_Payroll_addGpContractBankAccount-v2026-09-17_Response_201": { "properties": { "data": { "$ref": "#/components/schemas/GpContractsContractIdBanksPostResponsesContentApplicationJsonSchemaData" } }, "required": [ "data" ], "title": "Global Payroll_addGpContractBankAccount-v2026-09-17_Response_201", "type": "object" }, "Global_Payroll_createGpWorker-v2026-10-01_Response_201": { "properties": { "data": { "$ref": "#/components/schemas/GpWorkersPostResponsesContentApplicationJsonSchemaData" } }, "required": [ "data" ], "title": "Global Payroll_createGpWorker-v2026-10-01_Response_201", "type": "object" }, "Global_Payroll_downloadAGpWorkerPayslip-v2026-01-01_Response_200": { "properties": { "data": { "$ref": "#/components/schemas/GpWorkersIdPayslipsPayslipIdDownloadGetResponsesContentApplicationJsonSchemaData" } }, "required": [ "data" ], "title": "Global Payroll_downloadAGpWorkerPayslip-v2026-01-01_Response_200", "type": "object" }, "Global_Payroll_getContractAdditionalInfo-v2026-09-14_Response_200": { "properties": { "data": { "additionalProperties": { "description": "Any type" }, "type": "object" } }, "required": [ "data" ], "title": "Global Payroll_getContractAdditionalInfo-v2026-09-14_Response_200", "type": "object" }, "Global_Payroll_getGpContractBankAccounts-v2026-09-17_Response_200": { "properties": { "data": { "items": { "$ref": "#/components/schemas/GpContractsContractIdBanksGetResponsesContentApplicationJsonSchemaDataItems" }, "type": "array" } }, "required": [ "data" ], "title": "Global Payroll_getGpContractBankAccounts-v2026-09-17_Response_200", "type": "object" }, "Global_Payroll_getGpContractBankGuide-v2026-09-17_Response_200": { "properties": { "data": { "items": { "$ref": "#/components/schemas/GpContractsContractIdBanksGuideGetResponsesContentApplicationJsonSchemaDataItems" }, "type": "array" } }, "required": [ "data" ], "title": "Global Payroll_getGpContractBankGuide-v2026-09-17_Response_200", "type": "object" }, "Global_Payroll_getHrisBankAccounts-v2026-09-21_Response_200": { "properties": { "data": { "items": { "$ref": "#/components/schemas/HrisWorkersWorkerIdBanksGetResponsesContentApplicationJsonSchemaDataItems" }, "type": "array" } }, "required": [ "data" ], "title": "Global Payroll_getHrisBankAccounts-v2026-09-21_Response_200", "type": "object" }, "Global_Payroll_getPayrollActivations-v2026-10-12_Response_200": { "properties": { "data": { "$ref": "#/components/schemas/PayrollActivationsGetResponsesContentApplicationJsonSchemaData" } }, "required": [ "data" ], "title": "Global Payroll_getPayrollActivations-v2026-10-12_Response_200", "type": "object" }, "Global_Payroll_getPayrollMigrationImport-v2026-09-15_Response_200": { "properties": { "data": { "$ref": "#/components/schemas/GpLegalEntitiesLegalEntityIdPayrollMigrationImportsImportIdGetResponsesContentApplicationJsonSchemaData", "description": "The payroll migration import." } }, "required": [ "data" ], "title": "Global Payroll_getPayrollMigrationImport-v2026-09-15_Response_200", "type": "object" }, "Global_Payroll_importPayrollMigrationFiles-v2026-09-14_Response_201": { "properties": { "data": { "$ref": "#/components/schemas/GpLegalEntitiesLegalEntityIdPayrollMigrationImportsPostResponsesContentApplicationJsonSchemaData", "description": "The payroll migration import." } }, "required": [ "data" ], "title": "Global Payroll_importPayrollMigrationFiles-v2026-09-14_Response_201", "type": "object" }, "Global_Payroll_listPayrollGroups-v2026-09-08_Response_200": { "properties": { "data": { "items": { "$ref": "#/components/schemas/PayrollGroupsGetResponsesContentApplicationJsonSchemaDataItems" }, "type": "array" }, "pagination": { "$ref": "#/components/schemas/PayrollGroupsGetResponsesContentApplicationJsonSchemaPagination" } }, "required": [ "data", "pagination" ], "title": "Global Payroll_listPayrollGroups-v2026-09-08_Response_200", "type": "object" }, "Global_Payroll_listPayrollMigrationImports-v2026-09-15_Response_200": { "properties": { "data": { "$ref": "#/components/schemas/GpLegalEntitiesLegalEntityIdPayrollMigrationImportsGetResponsesContentApplicationJsonSchemaData", "description": "The legal entity's payroll migration imports and the payroll data Deel already holds." }, "pagination": { "$ref": "#/components/schemas/GpLegalEntitiesLegalEntityIdPayrollMigrationImportsGetResponsesContentApplicationJsonSchemaPagination", "description": "Pagination metadata for the page of imports returned." } }, "required": [ "data", "pagination" ], "title": "Global Payroll_listPayrollMigrationImports-v2026-09-15_Response_200", "type": "object" }, "Global_Payroll_patchGpContractBankAccount-v2026-09-17_Response_200": { "properties": { "data": { "$ref": "#/components/schemas/GpContractsContractIdBanksBankIdPatchResponsesContentApplicationJsonSchemaData" } }, "required": [ "data" ], "title": "Global Payroll_patchGpContractBankAccount-v2026-09-17_Response_200", "type": "object" }, "Global_Payroll_retrieveAdditionalInformationFieldsForGpWorkersByCountry-v2026-01-01_Response_200": { "properties": { "data": { "description": "Use this array to build the form UI. Each item defines one field with its type, validation, and display configuration. Items are pre-sorted by EDM display order. An empty array means no additional fields are configured for the requested country.", "items": { "$ref": "#/components/schemas/FormsGpWorkerAdditionalFieldsCountryCodeGetResponsesContentApplicationJsonSchemaDataItems" }, "type": "array" } }, "required": [ "data" ], "title": "Global Payroll_retrieveAdditionalInformationFieldsForGpWorkersByCountry-v2026-01-01_Response_200", "type": "object" }, "Global_Payroll_retrieveGpWorkerCreationSchema-v2026-10-01_Response_200": { "properties": { "data": { "description": "Fields accepted by POST /rest/gp/workers. A field absent from the list is not accepted for the given country.", "items": { "$ref": "#/components/schemas/GpWorkersCreationSchemaGetResponsesContentApplicationJsonSchemaDataItems" }, "type": "array" } }, "required": [ "data" ], "title": "Global Payroll_retrieveGpWorkerCreationSchema-v2026-10-01_Response_200", "type": "object" }, "Global_Payroll_setGpContractBankSettings-v2026-09-17_Response_200": { "properties": { "data": { "description": "The resulting split per account after the update.", "items": { "$ref": "#/components/schemas/GpContractsContractIdBanksSettingsPatchResponsesContentApplicationJsonSchemaDataItems" }, "type": "array" } }, "required": [ "data" ], "title": "Global Payroll_setGpContractBankSettings-v2026-09-17_Response_200", "type": "object" }, "Global_Payroll_submitPayrollMigrationImport-v2026-09-14_Response_200": { "properties": { "data": { "$ref": "#/components/schemas/GpLegalEntitiesLegalEntityIdPayrollMigrationImportsImportIdSubmitPostResponsesContentApplicationJsonSchemaData", "description": "The payroll migration import." } }, "required": [ "data" ], "title": "Global Payroll_submitPayrollMigrationImport-v2026-09-14_Response_200", "type": "object" }, "Global_Payroll_updateEmploymentTypeForAContract-v2026-07-07_Response_200": { "properties": { "data": { "$ref": "#/components/schemas/GpContractsContractIdEmploymentTypePatchResponsesContentApplicationJsonSchemaData" } }, "required": [ "data" ], "title": "Global Payroll_updateEmploymentTypeForAContract-v2026-07-07_Response_200", "type": "object" }, "Global_Payroll_updateEndDateForAContract-v2026-10-12_Response_200": { "properties": { "data": { "$ref": "#/components/schemas/GpContractsContractIdEndDatePatchResponsesContentApplicationJsonSchemaData" } }, "required": [ "data" ], "title": "Global Payroll_updateEndDateForAContract-v2026-10-12_Response_200", "type": "object" }, "GpContractsContractIdBanksBankIdPatchRequestBodyContentApplicationJsonSchemaData": { "properties": { "account_number": { "description": "The user's bank account number.", "type": "string" }, "account_type": { "description": "Bank account type.", "type": "string" }, "ach_routing_number": { "description": "The ACH (Automated Clearing House) Routing Number.", "type": "string" }, "address_line1": { "description": "The primary address line.", "type": "string" }, "address_line2": { "description": "The secondary address line.", "type": "string" }, "bank_branch_name": { "description": "The name of the user's bank branch.", "type": "string" }, "bank_code": { "description": "The bank code.", "type": "string" }, "bank_country_code": { "description": "The country code where the bank is located.", "type": "string" }, "bank_name": { "description": "Name of the user's bank.", "type": "string" }, "branch_code": { "description": "The branch code of the user's bank.", "type": "string" }, "city": { "description": "The city of the user's address.", "type": "string" }, "country_code": { "description": "The country code of the user's address.", "type": "string" }, "currency_code": { "description": "The currency code for transactions.", "type": "string" }, "email": { "description": "The user's email address.", "type": "string" }, "full_name": { "description": "Full name of the user.", "type": "string" }, "iban": { "description": "The International Bank Account Number (IBAN).", "type": "string" }, "original_name": { "description": "The original name of the user.", "type": "string" }, "phone": { "description": "The user's phone number.", "type": "string" }, "postal": { "description": "The user's postal or ZIP code.", "type": "string" }, "province_state": { "description": "The state or province of the user's address.", "type": "string" }, "rib_number": { "description": "The RIB (Relevé d'Identité Bancaire).", "type": "string" }, "swift_bic": { "description": "SWIFT/BIC code for the bank.", "type": "string" }, "tax_id": { "description": "The user's tax identification number.", "type": "string" } }, "title": "GpContractsContractIdBanksBankIdPatchRequestBodyContentApplicationJsonSchemaData", "type": "object" }, "GpContractsContractIdBanksBankIdPatchResponsesContentApplicationJsonSchemaData": { "properties": { "created_at": { "description": "Timestamp of when the bank account was created, in ISO-8601 format.", "format": "date-time", "type": "string" }, "id": { "description": "Unique identifier for the modified bank account.", "format": "uuid", "type": "string" }, "status": { "description": "The status of the modified bank account.", "type": "string" }, "updated_at": { "description": "Timestamp of the last update to the bank account, in ISO-8601 format.", "format": "date-time", "type": "string" } }, "required": [ "id", "status", "created_at", "updated_at" ], "title": "GpContractsContractIdBanksBankIdPatchResponsesContentApplicationJsonSchemaData", "type": "object" }, "GpContractsContractIdBanksBankIdPatchResponsesContentApplicationJsonSchemaErrorsItems": { "properties": { "code": { "description": "Machine-readable error code.", "type": "string" }, "message": { "description": "Human-readable explanation.", "type": "string" } }, "title": "GpContractsContractIdBanksBankIdPatchResponsesContentApplicationJsonSchemaErrorsItems", "type": "object" }, "GpContractsContractIdBanksGetResponsesContentApplicationJsonSchemaDataItems": { "properties": { "account_number": { "description": "The user's bank account number.", "type": "string" }, "account_type": { "description": "Bank account type.", "type": "string" }, "ach_routing_number": { "description": "The ACH (Automated Clearing House) Routing Number.", "type": "string" }, "address_line1": { "description": "The primary address line.", "type": "string" }, "address_line2": { "description": "The secondary address line.", "type": "string" }, "bank_branch_name": { "description": "The name of the user's bank branch.", "type": "string" }, "bank_code": { "description": "The bank code.", "type": "string" }, "bank_country_code": { "description": "The country code where the bank is located.", "type": "string" }, "bank_name": { "description": "Name of the user's bank.", "type": "string" }, "branch_code": { "description": "The branch code of the user's bank.", "type": "string" }, "city": { "description": "The city of the user's address.", "type": "string" }, "country_code": { "description": "The country code of the user.", "type": "string" }, "created_at": { "description": "Long date-time format following ISO-8601.", "format": "date-time", "type": "string" }, "currency_code": { "description": "The currency code for transactions.", "type": "string" }, "email": { "description": "The user's email address.", "type": "string" }, "full_name": { "description": "Full name of the user.", "type": "string" }, "funds_distribution": { "description": "Percentage (0–100) of the salary paid to this account. All of a contract’s accounts sum to 100.", "format": "double", "type": [ "number", "null" ] }, "iban": { "description": "The International Bank Account Number (IBAN).", "type": "string" }, "id": { "description": "Unique identifier of this resource.", "type": "string" }, "original_name": { "description": "The original name of the user.", "type": "string" }, "phone": { "description": "The user's phone number.", "type": "string" }, "postal": { "description": "The user's postal or ZIP code.", "type": "string" }, "province_state": { "description": "The state or province of the user's address.", "type": "string" }, "rib_number": { "description": "The RIB(Relevé d'Identité Bancaire).", "type": "string" }, "sort_code": { "description": "UK sort code.", "type": "string" }, "status": { "description": "Current status of bank account.", "type": "string" }, "swift_bic": { "description": "SWIFT/BIC code for the bank.", "type": "string" }, "tax_id": { "description": "The user's tax identification number.", "type": "string" }, "updated_at": { "description": "Long date-time format following ISO-8601.", "format": "date-time", "type": "string" } }, "required": [ "id", "created_at", "updated_at" ], "title": "GpContractsContractIdBanksGetResponsesContentApplicationJsonSchemaDataItems", "type": "object" }, "GpContractsContractIdBanksGetResponsesContentApplicationJsonSchemaErrorsItems": { "properties": { "code": { "description": "Machine-readable error code.", "type": "string" }, "message": { "description": "Human-readable explanation.", "type": "string" } }, "title": "GpContractsContractIdBanksGetResponsesContentApplicationJsonSchemaErrorsItems", "type": "object" }, "GpContractsContractIdBanksGuideGetResponsesContentApplicationJsonSchemaDataItems": { "properties": { "is_required": { "description": "Indicates whether the field is required.", "type": "boolean" }, "key": { "description": "The unique key representing the field.", "type": "string" }, "label": { "description": "The label or display name for this field.", "type": "string" }, "type": { "description": "The type of the field, such as 'Text' or 'Dropdown'.", "type": "string" }, "validations": { "description": "An array of validation rules applied to the field.", "items": { "$ref": "#/components/schemas/GpContractsContractIdBanksGuideGetResponsesContentApplicationJsonSchemaDataItemsValidationsItems" }, "type": "array" }, "values_allowed": { "description": "An array of allowed values for the field (e.g., for dropdown fields).", "items": { "$ref": "#/components/schemas/GpContractsContractIdBanksGuideGetResponsesContentApplicationJsonSchemaDataItemsValuesAllowedItems" }, "type": "array" } }, "required": [ "key", "is_required" ], "title": "GpContractsContractIdBanksGuideGetResponsesContentApplicationJsonSchemaDataItems", "type": "object" }, "GpContractsContractIdBanksGuideGetResponsesContentApplicationJsonSchemaDataItemsValidationsItems": { "properties": { "type": { "$ref": "#/components/schemas/GpContractsContractIdBanksGuideGetResponsesContentApplicationJsonSchemaDataItemsValidationsItemsType", "description": "The type of validation applied to the field." }, "value": { "$ref": "#/components/schemas/GpContractsContractIdBanksGuideGetResponsesContentApplicationJsonSchemaDataItemsValidationsItemsValue" } }, "title": "GpContractsContractIdBanksGuideGetResponsesContentApplicationJsonSchemaDataItemsValidationsItems", "type": "object" }, "GpContractsContractIdBanksGuideGetResponsesContentApplicationJsonSchemaDataItemsValidationsItemsType": { "description": "The type of validation applied to the field.", "enum": [ "MIN_LENGTH", "MAX_LENGTH", "REGEX" ], "title": "GpContractsContractIdBanksGuideGetResponsesContentApplicationJsonSchemaDataItemsValidationsItemsType", "type": "string" }, "GpContractsContractIdBanksGuideGetResponsesContentApplicationJsonSchemaDataItemsValidationsItemsValue": { "oneOf": [ { "type": "string" }, { "format": "double", "type": "number" } ], "title": "GpContractsContractIdBanksGuideGetResponsesContentApplicationJsonSchemaDataItemsValidationsItemsValue" }, "GpContractsContractIdBanksGuideGetResponsesContentApplicationJsonSchemaDataItemsValuesAllowedItems": { "properties": { "label": { "description": "The display name of the allowed value.", "type": "string" }, "value": { "description": "The value associated with the allowed option.", "type": "string" } }, "title": "GpContractsContractIdBanksGuideGetResponsesContentApplicationJsonSchemaDataItemsValuesAllowedItems", "type": "object" }, "GpContractsContractIdBanksGuideGetResponsesContentApplicationJsonSchemaErrorsItems": { "properties": { "code": { "description": "Machine-readable error code.", "type": "string" }, "message": { "description": "Human-readable explanation.", "type": "string" } }, "title": "GpContractsContractIdBanksGuideGetResponsesContentApplicationJsonSchemaErrorsItems", "type": "object" }, "GpContractsContractIdBanksPostRequestBodyContentApplicationJsonSchemaData": { "properties": { "account_number": { "description": "The user's bank account number.", "type": "string" }, "account_type": { "description": "Bank account type.", "type": "string" }, "ach_routing_number": { "description": "The ACH (Automated Clearing House) Routing Number.", "type": "string" }, "address_line1": { "description": "The primary address line.", "type": "string" }, "address_line2": { "description": "The secondary address line.", "type": "string" }, "bank_branch_name": { "description": "The name of the user's bank branch.", "type": "string" }, "bank_code": { "description": "The bank code.", "type": "string" }, "bank_country_code": { "description": "The country code where the bank is located.", "type": "string" }, "bank_name": { "description": "Name of the user's bank.", "type": "string" }, "branch_code": { "description": "The branch code of the user's bank.", "type": "string" }, "city": { "description": "The city of the user's address.", "type": "string" }, "country_code": { "description": "The country code of the user's address.", "type": "string" }, "currency_code": { "description": "The currency code for transactions.", "type": "string" }, "email": { "description": "The user's email address.", "type": "string" }, "full_name": { "description": "Full name of the user.", "type": "string" }, "iban": { "description": "The International Bank Account Number (IBAN).", "type": "string" }, "original_name": { "description": "The original name of the user.", "type": "string" }, "phone": { "description": "The user's phone number.", "type": "string" }, "postal": { "description": "The user's postal or ZIP code.", "type": "string" }, "province_state": { "description": "The state or province of the user's address.", "type": "string" }, "rib_number": { "description": "The RIB (Relevé d'Identité Bancaire).", "type": "string" }, "swift_bic": { "description": "SWIFT/BIC code for the bank.", "type": "string" }, "tax_id": { "description": "The user's tax identification number.", "type": "string" } }, "title": "GpContractsContractIdBanksPostRequestBodyContentApplicationJsonSchemaData", "type": "object" }, "GpContractsContractIdBanksPostResponsesContentApplicationJsonSchemaData": { "properties": { "created_at": { "description": "Timestamp of when the bank account was created, in ISO-8601 format.", "format": "date-time", "type": "string" }, "funds_distribution": { "description": "Percentage (0–100) of the salary paid to this account. A newly added account starts at 0 unless it is the only account; use PATCH /banks/settings to change the split.", "format": "double", "type": [ "number", "null" ] }, "id": { "description": "Unique identifier for the newly added bank account.", "format": "uuid", "type": "string" }, "status": { "description": "The status of the newly added bank account.", "type": "string" }, "updated_at": { "description": "Timestamp of the last update to the bank account, in ISO-8601 format.", "format": "date-time", "type": "string" } }, "required": [ "id", "status", "created_at", "updated_at" ], "title": "GpContractsContractIdBanksPostResponsesContentApplicationJsonSchemaData", "type": "object" }, "GpContractsContractIdBanksPostResponsesContentApplicationJsonSchemaErrorsItems": { "properties": { "code": { "description": "Machine-readable error code.", "type": "string" }, "message": { "description": "Human-readable explanation.", "type": "string" } }, "title": "GpContractsContractIdBanksPostResponsesContentApplicationJsonSchemaErrorsItems", "type": "object" }, "GpContractsContractIdBanksSettingsPatchRequestBodyContentApplicationJsonSchemaData": { "properties": { "settings": { "description": "The salary split across the contract's bank accounts. Percentages must add up to 100.", "items": { "$ref": "#/components/schemas/GpContractsContractIdBanksSettingsPatchRequestBodyContentApplicationJsonSchemaDataSettingsItems" }, "type": "array" } }, "required": [ "settings" ], "title": "GpContractsContractIdBanksSettingsPatchRequestBodyContentApplicationJsonSchemaData", "type": "object" }, "GpContractsContractIdBanksSettingsPatchRequestBodyContentApplicationJsonSchemaDataSettingsItems": { "properties": { "bank_id": { "description": "Identifier of the bank account (as returned by GET /banks).", "type": "string" }, "funds_distribution": { "description": "Percentage (0–100) of the salary paid to this account.", "format": "double", "maximum": 100, "minimum": 0, "type": "number" } }, "required": [ "bank_id", "funds_distribution" ], "title": "GpContractsContractIdBanksSettingsPatchRequestBodyContentApplicationJsonSchemaDataSettingsItems", "type": "object" }, "GpContractsContractIdBanksSettingsPatchResponsesContentApplicationJsonSchemaDataItems": { "properties": { "funds_distribution": { "description": "Percentage (0–100) of the salary paid to this account.", "format": "double", "type": "number" }, "id": { "description": "Identifier of the bank account.", "type": "string" } }, "required": [ "id", "funds_distribution" ], "title": "GpContractsContractIdBanksSettingsPatchResponsesContentApplicationJsonSchemaDataItems", "type": "object" }, "GpContractsContractIdBanksSettingsPatchResponsesContentApplicationJsonSchemaErrorsItems": { "properties": { "code": { "description": "Machine-readable error code.", "type": "string" }, "message": { "description": "Human-readable explanation.", "type": "string" } }, "title": "GpContractsContractIdBanksSettingsPatchResponsesContentApplicationJsonSchemaErrorsItems", "type": "object" }, "GpContractsContractIdEmploymentTypePatchRequestBodyContentApplicationJsonSchemaData": { "description": "Employment-type change details, including the effective date.", "properties": { "effective_date": { "description": "The date from which the new employment type takes effect (YYYY-MM-DD).", "format": "date", "type": "string" }, "employment_type": { "$ref": "#/components/schemas/GpContractsContractIdEmploymentTypePatchRequestBodyContentApplicationJsonSchemaDataEmploymentType", "description": "The new employment type: EMPLOYEE_FT (full-time), EMPLOYEE_PT (part-time), or ON_LEAVE (on leave)." }, "fte": { "description": "Full-time equivalent for the new employment type, as a fraction between 0 and 1 (inclusive).", "format": "double", "maximum": 1, "minimum": 0, "type": "number" } }, "required": [ "fte", "effective_date", "employment_type" ], "title": "GpContractsContractIdEmploymentTypePatchRequestBodyContentApplicationJsonSchemaData", "type": "object" }, "GpContractsContractIdEmploymentTypePatchRequestBodyContentApplicationJsonSchemaDataEmploymentType": { "description": "The new employment type: EMPLOYEE_FT (full-time), EMPLOYEE_PT (part-time), or ON_LEAVE (on leave).", "enum": [ "EMPLOYEE_FT", "EMPLOYEE_PT", "ON_LEAVE" ], "title": "GpContractsContractIdEmploymentTypePatchRequestBodyContentApplicationJsonSchemaDataEmploymentType", "type": "string" }, "GpContractsContractIdEmploymentTypePatchResponsesContentApplicationJsonSchemaData": { "properties": { "contract_id": { "description": "The unique identifier of the GP contract.", "maxLength": 100, "pattern": "^(([a-z0-9]{6,})|([a-z0-9-_]{20,})|(-2[0-9]{2}))$", "type": "string" }, "effective_date": { "description": "The date from which the change takes effect.", "format": "date", "type": "string" }, "employment_type": { "$ref": "#/components/schemas/GpContractsContractIdEmploymentTypePatchResponsesContentApplicationJsonSchemaDataEmploymentType", "description": "The updated employment type." }, "fte": { "description": "The full-time equivalent for the updated employment type, as a fraction between 0 and 1 (inclusive).", "format": "double", "maximum": 1, "minimum": 0, "type": "number" } }, "required": [ "fte", "contract_id", "effective_date", "employment_type" ], "title": "GpContractsContractIdEmploymentTypePatchResponsesContentApplicationJsonSchemaData", "type": "object" }, "GpContractsContractIdEmploymentTypePatchResponsesContentApplicationJsonSchemaDataEmploymentType": { "description": "The updated employment type.", "enum": [ "EMPLOYEE_FT", "EMPLOYEE_PT", "ON_LEAVE" ], "title": "GpContractsContractIdEmploymentTypePatchResponsesContentApplicationJsonSchemaDataEmploymentType", "type": "string" }, "GpContractsContractIdEndDatePatchParametersXBeta": { "default": "true", "enum": [ "true" ], "title": "GpContractsContractIdEndDatePatchParametersXBeta", "type": "string" }, "GpContractsContractIdEndDatePatchRequestBodyContentApplicationJsonSchemaData": { "description": "End date change details, including the effective date.", "properties": { "effective_date": { "description": "The date from which the new end date applies (YYYY-MM-DD).", "format": "date", "type": "string" }, "end_date": { "description": "The new contract end date (YYYY-MM-DD), or null to make the contract open-ended.", "format": "date", "type": [ "string", "null" ] } }, "required": [ "end_date", "effective_date" ], "title": "GpContractsContractIdEndDatePatchRequestBodyContentApplicationJsonSchemaData", "type": "object" }, "GpContractsContractIdEndDatePatchResponsesContentApplicationJsonSchemaData": { "properties": { "contract_id": { "description": "The unique identifier of the GP contract.", "maxLength": 100, "pattern": "^(([a-z0-9]{6,})|([a-z0-9-_]{20,})|(-2[0-9]{2}))$", "type": "string" }, "contract_term": { "$ref": "#/components/schemas/GpContractsContractIdEndDatePatchResponsesContentApplicationJsonSchemaDataContractTerm", "description": "The contract term derived from the end date: DEFINITE when an end date is set, INDEFINITE when it is null." }, "effective_date": { "description": "The date from which the change takes effect.", "format": "date", "type": "string" }, "end_date": { "description": "The recorded contract end date, or null when the contract is open-ended.", "format": "date", "type": [ "string", "null" ] } }, "required": [ "end_date", "contract_id", "contract_term", "effective_date" ], "title": "GpContractsContractIdEndDatePatchResponsesContentApplicationJsonSchemaData", "type": "object" }, "GpContractsContractIdEndDatePatchResponsesContentApplicationJsonSchemaDataContractTerm": { "description": "The contract term derived from the end date: DEFINITE when an end date is set, INDEFINITE when it is null.", "enum": [ "DEFINITE", "INDEFINITE" ], "title": "GpContractsContractIdEndDatePatchResponsesContentApplicationJsonSchemaDataContractTerm", "type": "string" }, "GpLegalEntitiesLegalEntityIdPayrollMigrationImportsGetResponsesContentApplicationJsonSchemaData": { "description": "The legal entity's payroll migration imports and the payroll data Deel already holds.", "properties": { "imports": { "description": "The legal entity's payroll migration imports, newest first. Empty when it has none.", "items": { "$ref": "#/components/schemas/GpLegalEntitiesLegalEntityIdPayrollMigrationImportsGetResponsesContentApplicationJsonSchemaDataImportsItems" }, "type": "array" }, "period": { "$ref": "#/components/schemas/GpLegalEntitiesLegalEntityIdPayrollMigrationImportsGetResponsesContentApplicationJsonSchemaDataPeriod", "description": "The period the legal entity's payroll data on the Deel side already covers." } }, "required": [ "period", "imports" ], "title": "GpLegalEntitiesLegalEntityIdPayrollMigrationImportsGetResponsesContentApplicationJsonSchemaData", "type": "object" }, "GpLegalEntitiesLegalEntityIdPayrollMigrationImportsGetResponsesContentApplicationJsonSchemaDataImportsItems": { "description": "The payroll migration import.", "properties": { "created_at": { "description": "When the import was created.", "format": "date-time", "type": "string" }, "files": { "description": "The files attached to the import.", "items": { "$ref": "#/components/schemas/GpLegalEntitiesLegalEntityIdPayrollMigrationImportsGetResponsesContentApplicationJsonSchemaDataImportsItemsFilesItems" }, "type": "array" }, "import_id": { "description": "The unique identifier of the payroll migration import.", "format": "uuid", "type": "string" }, "legal_entity_id": { "description": "The legal entity the import belongs to.", "format": "uuid", "type": "string" }, "status": { "$ref": "#/components/schemas/GpLegalEntitiesLegalEntityIdPayrollMigrationImportsGetResponsesContentApplicationJsonSchemaDataImportsItemsStatus", "description": "The state of the import. IN_PROGRESS holds files that have not been submitted, and is what attaching files leaves behind - including on an import that had already been submitted, which reopens it. SUBMITTED once handed to Deel for review. DRAFT is an import started with no files yet, which only happens in the Deel web app." }, "submitted_at": { "description": "When the import was submitted for review, or null when it is not SUBMITTED.", "format": "date-time", "type": [ "string", "null" ] }, "type": { "$ref": "#/components/schemas/GpLegalEntitiesLegalEntityIdPayrollMigrationImportsGetResponsesContentApplicationJsonSchemaDataImportsItemsType", "description": "What kind of ingestion this is. Year-to-date payroll history is the only kind today." }, "updated_at": { "description": "When the import last changed.", "format": "date-time", "type": "string" } }, "required": [ "type", "files", "status", "import_id", "created_at", "updated_at", "submitted_at", "legal_entity_id" ], "title": "GpLegalEntitiesLegalEntityIdPayrollMigrationImportsGetResponsesContentApplicationJsonSchemaDataImportsItems", "type": "object" }, "GpLegalEntitiesLegalEntityIdPayrollMigrationImportsGetResponsesContentApplicationJsonSchemaDataImportsItemsFilesItems": { "properties": { "file_id": { "description": "The identifier of the file in the Deel file service.", "type": "string" }, "file_name": { "description": "The name displayed for the file in Deel, when one is known.", "type": [ "string", "null" ] }, "file_size": { "description": "The size of the file in bytes, when one is known.", "maximum": 10485760, "minimum": 1, "type": [ "integer", "null" ] }, "mime_type": { "description": "The media type of the file, when one is known.", "type": [ "string", "null" ] }, "source": { "$ref": "#/components/schemas/GpLegalEntitiesLegalEntityIdPayrollMigrationImportsGetResponsesContentApplicationJsonSchemaDataImportsItemsFilesItemsSource", "description": "Which surface the file arrived through: EXTERNAL for this API, INTERNAL for the Deel web app. An import can hold both when a client and a partner have each added files to it." }, "uploaded_at": { "description": "When the file was uploaded to the Deel file service.", "format": "date-time", "type": "string" } }, "required": [ "source", "file_id", "file_name", "file_size", "mime_type", "uploaded_at" ], "title": "GpLegalEntitiesLegalEntityIdPayrollMigrationImportsGetResponsesContentApplicationJsonSchemaDataImportsItemsFilesItems", "type": "object" }, "GpLegalEntitiesLegalEntityIdPayrollMigrationImportsGetResponsesContentApplicationJsonSchemaDataImportsItemsFilesItemsSource": { "description": "Which surface the file arrived through: EXTERNAL for this API, INTERNAL for the Deel web app. An import can hold both when a client and a partner have each added files to it.", "enum": [ "INTERNAL", "EXTERNAL" ], "title": "GpLegalEntitiesLegalEntityIdPayrollMigrationImportsGetResponsesContentApplicationJsonSchemaDataImportsItemsFilesItemsSource", "type": "string" }, "GpLegalEntitiesLegalEntityIdPayrollMigrationImportsGetResponsesContentApplicationJsonSchemaDataImportsItemsStatus": { "description": "The state of the import. IN_PROGRESS holds files that have not been submitted, and is what attaching files leaves behind - including on an import that had already been submitted, which reopens it. SUBMITTED once handed to Deel for review. DRAFT is an import started with no files yet, which only happens in the Deel web app.", "enum": [ "DRAFT", "IN_PROGRESS", "SUBMITTED" ], "title": "GpLegalEntitiesLegalEntityIdPayrollMigrationImportsGetResponsesContentApplicationJsonSchemaDataImportsItemsStatus", "type": "string" }, "GpLegalEntitiesLegalEntityIdPayrollMigrationImportsGetResponsesContentApplicationJsonSchemaDataImportsItemsType": { "description": "What kind of ingestion this is. Year-to-date payroll history is the only kind today.", "enum": [ "YTD_HISTORICAL_INGESTION" ], "title": "GpLegalEntitiesLegalEntityIdPayrollMigrationImportsGetResponsesContentApplicationJsonSchemaDataImportsItemsType", "type": "string" }, "GpLegalEntitiesLegalEntityIdPayrollMigrationImportsGetResponsesContentApplicationJsonSchemaDataPeriod": { "description": "The period the legal entity's payroll data on the Deel side already covers.", "properties": { "end": { "description": "The last day the payroll data Deel holds covers, as YYYY-MM-DD.", "type": [ "string", "null" ] }, "start": { "description": "The first day the payroll data Deel holds covers, as YYYY-MM-DD.", "type": [ "string", "null" ] } }, "required": [ "end", "start" ], "title": "GpLegalEntitiesLegalEntityIdPayrollMigrationImportsGetResponsesContentApplicationJsonSchemaDataPeriod", "type": "object" }, "GpLegalEntitiesLegalEntityIdPayrollMigrationImportsGetResponsesContentApplicationJsonSchemaPagination": { "description": "Pagination metadata for the page of imports returned.", "properties": { "has_more": { "description": "Whether a further page of imports exists.", "type": "boolean" }, "limit": { "description": "The page size that was applied - the requested limit, or its default when none was sent.", "maximum": 50, "minimum": 1, "type": "integer" }, "next_cursor": { "description": "The cursor to pass to fetch the next page, or null when this is the last one.", "type": [ "string", "null" ] } }, "required": [ "limit", "has_more", "next_cursor" ], "title": "GpLegalEntitiesLegalEntityIdPayrollMigrationImportsGetResponsesContentApplicationJsonSchemaPagination", "type": "object" }, "GpLegalEntitiesLegalEntityIdPayrollMigrationImportsImportIdGetResponsesContentApplicationJsonSchemaData": { "description": "The payroll migration import.", "properties": { "created_at": { "description": "When the import was created.", "format": "date-time", "type": "string" }, "files": { "description": "The files attached to the import.", "items": { "$ref": "#/components/schemas/GpLegalEntitiesLegalEntityIdPayrollMigrationImportsImportIdGetResponsesContentApplicationJsonSchemaDataFilesItems" }, "type": "array" }, "import_id": { "description": "The unique identifier of the payroll migration import.", "format": "uuid", "type": "string" }, "legal_entity_id": { "description": "The legal entity the import belongs to.", "format": "uuid", "type": "string" }, "status": { "$ref": "#/components/schemas/GpLegalEntitiesLegalEntityIdPayrollMigrationImportsImportIdGetResponsesContentApplicationJsonSchemaDataStatus", "description": "The state of the import. IN_PROGRESS holds files that have not been submitted, and is what attaching files leaves behind - including on an import that had already been submitted, which reopens it. SUBMITTED once handed to Deel for review. DRAFT is an import started with no files yet, which only happens in the Deel web app." }, "submitted_at": { "description": "When the import was submitted for review, or null when it is not SUBMITTED.", "format": "date-time", "type": [ "string", "null" ] }, "type": { "$ref": "#/components/schemas/GpLegalEntitiesLegalEntityIdPayrollMigrationImportsImportIdGetResponsesContentApplicationJsonSchemaDataType", "description": "What kind of ingestion this is. Year-to-date payroll history is the only kind today." }, "updated_at": { "description": "When the import last changed.", "format": "date-time", "type": "string" } }, "required": [ "type", "files", "status", "import_id", "created_at", "updated_at", "submitted_at", "legal_entity_id" ], "title": "GpLegalEntitiesLegalEntityIdPayrollMigrationImportsImportIdGetResponsesContentApplicationJsonSchemaData", "type": "object" }, "GpLegalEntitiesLegalEntityIdPayrollMigrationImportsImportIdGetResponsesContentApplicationJsonSchemaDataFilesItems": { "properties": { "file_id": { "description": "The identifier of the file in the Deel file service.", "type": "string" }, "file_name": { "description": "The name displayed for the file in Deel, when one is known.", "type": [ "string", "null" ] }, "file_size": { "description": "The size of the file in bytes, when one is known.", "maximum": 10485760, "minimum": 1, "type": [ "integer", "null" ] }, "mime_type": { "description": "The media type of the file, when one is known.", "type": [ "string", "null" ] }, "source": { "$ref": "#/components/schemas/GpLegalEntitiesLegalEntityIdPayrollMigrationImportsImportIdGetResponsesContentApplicationJsonSchemaDataFilesItemsSource", "description": "Which surface the file arrived through: EXTERNAL for this API, INTERNAL for the Deel web app. An import can hold both when a client and a partner have each added files to it." }, "uploaded_at": { "description": "When the file was uploaded to the Deel file service.", "format": "date-time", "type": "string" } }, "required": [ "source", "file_id", "file_name", "file_size", "mime_type", "uploaded_at" ], "title": "GpLegalEntitiesLegalEntityIdPayrollMigrationImportsImportIdGetResponsesContentApplicationJsonSchemaDataFilesItems", "type": "object" }, "GpLegalEntitiesLegalEntityIdPayrollMigrationImportsImportIdGetResponsesContentApplicationJsonSchemaDataFilesItemsSource": { "description": "Which surface the file arrived through: EXTERNAL for this API, INTERNAL for the Deel web app. An import can hold both when a client and a partner have each added files to it.", "enum": [ "INTERNAL", "EXTERNAL" ], "title": "GpLegalEntitiesLegalEntityIdPayrollMigrationImportsImportIdGetResponsesContentApplicationJsonSchemaDataFilesItemsSource", "type": "string" }, "GpLegalEntitiesLegalEntityIdPayrollMigrationImportsImportIdGetResponsesContentApplicationJsonSchemaDataStatus": { "description": "The state of the import. IN_PROGRESS holds files that have not been submitted, and is what attaching files leaves behind - including on an import that had already been submitted, which reopens it. SUBMITTED once handed to Deel for review. DRAFT is an import started with no files yet, which only happens in the Deel web app.", "enum": [ "DRAFT", "IN_PROGRESS", "SUBMITTED" ], "title": "GpLegalEntitiesLegalEntityIdPayrollMigrationImportsImportIdGetResponsesContentApplicationJsonSchemaDataStatus", "type": "string" }, "GpLegalEntitiesLegalEntityIdPayrollMigrationImportsImportIdGetResponsesContentApplicationJsonSchemaDataType": { "description": "What kind of ingestion this is. Year-to-date payroll history is the only kind today.", "enum": [ "YTD_HISTORICAL_INGESTION" ], "title": "GpLegalEntitiesLegalEntityIdPayrollMigrationImportsImportIdGetResponsesContentApplicationJsonSchemaDataType", "type": "string" }, "GpLegalEntitiesLegalEntityIdPayrollMigrationImportsImportIdSubmitPostResponsesContentApplicationJsonSchemaData": { "description": "The payroll migration import.", "properties": { "created_at": { "description": "When the import was created.", "format": "date-time", "type": "string" }, "files": { "description": "The files attached to the import.", "items": { "$ref": "#/components/schemas/GpLegalEntitiesLegalEntityIdPayrollMigrationImportsImportIdSubmitPostResponsesContentApplicationJsonSchemaDataFilesItems" }, "type": "array" }, "import_id": { "description": "The unique identifier of the payroll migration import.", "format": "uuid", "type": "string" }, "legal_entity_id": { "description": "The legal entity the import belongs to.", "format": "uuid", "type": "string" }, "status": { "$ref": "#/components/schemas/GpLegalEntitiesLegalEntityIdPayrollMigrationImportsImportIdSubmitPostResponsesContentApplicationJsonSchemaDataStatus", "description": "The state of the import. IN_PROGRESS holds files that have not been submitted, and is what attaching files leaves behind - including on an import that had already been submitted, which reopens it. SUBMITTED once handed to Deel for review. DRAFT is an import started with no files yet, which only happens in the Deel web app." }, "submitted_at": { "description": "When the import was submitted for review, or null when it is not SUBMITTED.", "format": "date-time", "type": [ "string", "null" ] }, "type": { "$ref": "#/components/schemas/GpLegalEntitiesLegalEntityIdPayrollMigrationImportsImportIdSubmitPostResponsesContentApplicationJsonSchemaDataType", "description": "What kind of ingestion this is. Year-to-date payroll history is the only kind today." }, "updated_at": { "description": "When the import last changed.", "format": "date-time", "type": "string" } }, "required": [ "type", "files", "status", "import_id", "created_at", "updated_at", "submitted_at", "legal_entity_id" ], "title": "GpLegalEntitiesLegalEntityIdPayrollMigrationImportsImportIdSubmitPostResponsesContentApplicationJsonSchemaData", "type": "object" }, "GpLegalEntitiesLegalEntityIdPayrollMigrationImportsImportIdSubmitPostResponsesContentApplicationJsonSchemaDataFilesItems": { "properties": { "file_id": { "description": "The identifier of the file in the Deel file service.", "type": "string" }, "file_name": { "description": "The name displayed for the file in Deel, when one is known.", "type": [ "string", "null" ] }, "file_size": { "description": "The size of the file in bytes, when one is known.", "maximum": 10485760, "minimum": 1, "type": [ "integer", "null" ] }, "mime_type": { "description": "The media type of the file, when one is known.", "type": [ "string", "null" ] }, "source": { "$ref": "#/components/schemas/GpLegalEntitiesLegalEntityIdPayrollMigrationImportsImportIdSubmitPostResponsesContentApplicationJsonSchemaDataFilesItemsSource", "description": "Which surface the file arrived through: EXTERNAL for this API, INTERNAL for the Deel web app. An import can hold both when a client and a partner have each added files to it." }, "uploaded_at": { "description": "When the file was uploaded to the Deel file service.", "format": "date-time", "type": "string" } }, "required": [ "source", "file_id", "file_name", "file_size", "mime_type", "uploaded_at" ], "title": "GpLegalEntitiesLegalEntityIdPayrollMigrationImportsImportIdSubmitPostResponsesContentApplicationJsonSchemaDataFilesItems", "type": "object" }, "GpLegalEntitiesLegalEntityIdPayrollMigrationImportsImportIdSubmitPostResponsesContentApplicationJsonSchemaDataFilesItemsSource": { "description": "Which surface the file arrived through: EXTERNAL for this API, INTERNAL for the Deel web app. An import can hold both when a client and a partner have each added files to it.", "enum": [ "INTERNAL", "EXTERNAL" ], "title": "GpLegalEntitiesLegalEntityIdPayrollMigrationImportsImportIdSubmitPostResponsesContentApplicationJsonSchemaDataFilesItemsSource", "type": "string" }, "GpLegalEntitiesLegalEntityIdPayrollMigrationImportsImportIdSubmitPostResponsesContentApplicationJsonSchemaDataStatus": { "description": "The state of the import. IN_PROGRESS holds files that have not been submitted, and is what attaching files leaves behind - including on an import that had already been submitted, which reopens it. SUBMITTED once handed to Deel for review. DRAFT is an import started with no files yet, which only happens in the Deel web app.", "enum": [ "DRAFT", "IN_PROGRESS", "SUBMITTED" ], "title": "GpLegalEntitiesLegalEntityIdPayrollMigrationImportsImportIdSubmitPostResponsesContentApplicationJsonSchemaDataStatus", "type": "string" }, "GpLegalEntitiesLegalEntityIdPayrollMigrationImportsImportIdSubmitPostResponsesContentApplicationJsonSchemaDataType": { "description": "What kind of ingestion this is. Year-to-date payroll history is the only kind today.", "enum": [ "YTD_HISTORICAL_INGESTION" ], "title": "GpLegalEntitiesLegalEntityIdPayrollMigrationImportsImportIdSubmitPostResponsesContentApplicationJsonSchemaDataType", "type": "string" }, "GpLegalEntitiesLegalEntityIdPayrollMigrationImportsPostRequestBodyContentApplicationJsonSchemaData": { "description": "The payroll migration files to attach to the import.", "properties": { "files": { "description": "The files to attach to the import, between 1 and 50 per request.", "items": { "$ref": "#/components/schemas/GpLegalEntitiesLegalEntityIdPayrollMigrationImportsPostRequestBodyContentApplicationJsonSchemaDataFilesItems" }, "type": "array" } }, "required": [ "files" ], "title": "GpLegalEntitiesLegalEntityIdPayrollMigrationImportsPostRequestBodyContentApplicationJsonSchemaData", "type": "object" }, "GpLegalEntitiesLegalEntityIdPayrollMigrationImportsPostRequestBodyContentApplicationJsonSchemaDataFilesItems": { "properties": { "file_id": { "description": "The identifier the Deel file service returned for the uploaded file.", "maxLength": 64, "minLength": 1, "pattern": "^[A-Za-z0-9_-]+$", "type": "string" }, "one_time_secret": { "description": "The single-use secret the Deel file service returned alongside the file id.", "maxLength": 255, "minLength": 1, "pattern": "^[\\u0021-\\u007e]+$", "type": "string" } }, "required": [ "file_id", "one_time_secret" ], "title": "GpLegalEntitiesLegalEntityIdPayrollMigrationImportsPostRequestBodyContentApplicationJsonSchemaDataFilesItems", "type": "object" }, "GpLegalEntitiesLegalEntityIdPayrollMigrationImportsPostResponsesContentApplicationJsonSchemaData": { "properties": { "file_ids": { "description": "The ids of the files the request was rejected over.", "items": { "type": "string" }, "type": "array" } }, "required": [ "file_ids" ], "title": "GpLegalEntitiesLegalEntityIdPayrollMigrationImportsPostResponsesContentApplicationJsonSchemaData", "type": "object" }, "GpLegalEntitiesLegalEntityIdReportsGetResponsesContentApplicationJsonSchemaDataItems": { "properties": { "end_date": { "description": "End date of the payroll event in ISO-8601 format.", "format": "date-time", "type": "string" }, "id": { "description": "Unique identifier for the payroll event.", "type": "string" }, "lock_date": { "description": "Date when the payroll event is locked, in ISO-8601 format.", "format": "date-time", "type": [ "string", "null" ] }, "start_date": { "description": "Start date of the payroll event in ISO-8601 format.", "format": "date-time", "type": "string" }, "status": { "description": "Status of the payroll event (e.g., OPEN, CLOSED).", "type": "string" } }, "required": [ "id", "status", "end_date", "start_date" ], "title": "GpLegalEntitiesLegalEntityIdReportsGetResponsesContentApplicationJsonSchemaDataItems", "type": "object" }, "GpLegalEntitiesLegalEntityIdReportsGetResponsesContentApplicationJsonSchemaErrorsItems": { "properties": { "message": { "description": "A description of the returned error", "type": "string" }, "path": { "description": "The JSON path where input validation failed", "type": "string" } }, "title": "GpLegalEntitiesLegalEntityIdReportsGetResponsesContentApplicationJsonSchemaErrorsItems", "type": "object" }, "GpLegalEntitiesLegalEntityIdReportsGetResponsesContentApplicationJsonSchemaRequest": { "properties": { "api_req_id": { "description": "The request ID of the failed request", "type": "string" }, "code": { "description": "The code of the source handler which produced the returned error", "format": "double", "type": "number" }, "docs": { "description": "A link to the official documentation for the requested endpoint resource", "type": "string" }, "method": { "description": "The HTTP method of the failed request", "type": "string" }, "source": { "description": "The source handler which produced the returned error", "type": "string" }, "status": { "description": "The status code of the response", "format": "double", "type": "number" }, "url": { "description": "The relative URL of the failed request", "type": "string" } }, "title": "GpLegalEntitiesLegalEntityIdReportsGetResponsesContentApplicationJsonSchemaRequest", "type": "object" }, "GpReportsIdGrossToNetGetResponsesContentApplicationJsonSchemaDataItems": { "description": "A cell value object for a given column.", "properties": { "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)." }, "formattedCurrentValue": { "description": "Formatted value for display purposes." }, "label": { "description": "Human-readable label of the column for this cell.", "type": "string" }, "percentageDiff": { "description": "Percentage difference between current and comparison values, if applicable." }, "type": { "description": "Cell type used for rendering/formatting.", "type": "string" } }, "required": [ "type", "label" ], "title": "GpReportsIdGrossToNetGetResponsesContentApplicationJsonSchemaDataItems", "type": "object" }, "GpReportsIdGrossToNetGetResponsesContentApplicationJsonSchemaErrorsItems": { "properties": { "message": { "description": "A description of the returned error", "type": "string" }, "path": { "description": "The JSON path where input validation failed", "type": "string" } }, "title": "GpReportsIdGrossToNetGetResponsesContentApplicationJsonSchemaErrorsItems", "type": "object" }, "GpReportsIdGrossToNetGetResponsesContentApplicationJsonSchemaPage": { "description": "Pagination metadata for the report rows.", "properties": { "limit": { "description": "Maximum number of rows returned per page.", "format": "double", "maximum": 200, "type": "number" }, "offset": { "description": "Zero-based offset of the first returned row.", "format": "double", "type": "number" }, "total_rows": { "description": "Total number of rows available across all pages.", "format": "double", "minimum": 0, "type": "number" } }, "required": [ "limit", "offset", "total_rows" ], "title": "GpReportsIdGrossToNetGetResponsesContentApplicationJsonSchemaPage", "type": "object" }, "GpReportsIdGrossToNetGetResponsesContentApplicationJsonSchemaRequest": { "properties": { "api_req_id": { "description": "The request ID of the failed request", "type": "string" }, "code": { "description": "The code of the source handler which produced the returned error", "format": "double", "type": "number" }, "docs": { "description": "A link to the official documentation for the requested endpoint resource", "type": "string" }, "method": { "description": "The HTTP method of the failed request", "type": "string" }, "source": { "description": "The source handler which produced the returned error", "type": "string" }, "status": { "description": "The status code of the response", "format": "double", "type": "number" }, "url": { "description": "The relative URL of the failed request", "type": "string" } }, "title": "GpReportsIdGrossToNetGetResponsesContentApplicationJsonSchemaRequest", "type": "object" }, "GpWorkersContractsContractIdAdditionalInformationPatchRequestBodyContentApplicationJsonSchemaData": { "oneOf": [ { "maxLength": 1000, "type": "string" }, { "format": "double", "type": "number" }, { "type": "boolean" } ], "title": "GpWorkersContractsContractIdAdditionalInformationPatchRequestBodyContentApplicationJsonSchemaData" }, "GpWorkersContractsContractIdAdditionalInformationPatchResponsesContentApplicationJsonSchemaData": { "properties": { "is_additional_data_done": { "description": "True when all required additional information fields for EDM onboarding have been provided.", "type": "boolean" }, "is_updated": { "description": "Indicates if the contract was updated.", "type": "boolean" }, "missing_keys": { "description": "Public API keys of required fields still missing. Empty when is_additional_data_done is true.", "items": { "type": "string" }, "type": "array" } }, "required": [ "is_updated", "missing_keys", "is_additional_data_done" ], "title": "GpWorkersContractsContractIdAdditionalInformationPatchResponsesContentApplicationJsonSchemaData", "type": "object" }, "GpWorkersContractsContractIdAdditionalInformationPatchResponsesContentApplicationJsonSchemaErrorsItems": { "properties": { "code": { "description": "Machine-readable error code", "type": "string" }, "message": { "description": "Human-readable explanation of the error", "type": "string" } }, "title": "GpWorkersContractsContractIdAdditionalInformationPatchResponsesContentApplicationJsonSchemaErrorsItems", "type": "object" }, "GpWorkersContractsContractIdAdditionalInformationPostRequestBodyContentApplicationJsonSchemaData": { "oneOf": [ { "maxLength": 1000, "type": "string" }, { "format": "double", "type": "number" }, { "type": "boolean" } ], "title": "GpWorkersContractsContractIdAdditionalInformationPostRequestBodyContentApplicationJsonSchemaData" }, "GpWorkersContractsContractIdAdditionalInformationPostResponsesContentApplicationJsonSchemaData": { "properties": { "created_at": { "description": "Datetime of submission of the additional information", "type": "string" } }, "title": "GpWorkersContractsContractIdAdditionalInformationPostResponsesContentApplicationJsonSchemaData", "type": "object" }, "GpWorkersContractsContractIdAdditionalInformationPostResponsesContentApplicationJsonSchemaErrorsItems": { "properties": { "code": { "description": "Machine-readable error code", "type": "string" }, "message": { "description": "Human-readable explanation of the error", "type": "string" } }, "title": "GpWorkersContractsContractIdAdditionalInformationPostResponsesContentApplicationJsonSchemaErrorsItems", "type": "object" }, "GpWorkersCreationSchemaGetParametersXBeta": { "default": "true", "enum": [ "true" ], "title": "GpWorkersCreationSchemaGetParametersXBeta", "type": "string" }, "GpWorkersCreationSchemaGetResponsesContentApplicationJsonSchemaDataItems": { "properties": { "default": { "description": "Value applied when the field is omitted." }, "dependencies": { "description": "Other fields this field is conditional on.", "items": { "$ref": "#/components/schemas/GpWorkersCreationSchemaGetResponsesContentApplicationJsonSchemaDataItemsDependenciesItems" }, "type": "array" }, "is_nullable": { "description": "Whether null is an accepted value.", "type": "boolean" }, "is_required": { "description": "Whether the field must be provided for the given country, legal entity and payroll group.", "type": "boolean" }, "key": { "description": "Field to send, exactly as the create endpoint accepts it. Dotted for nested objects.", "maxLength": 200, "minLength": 1, "type": "string" }, "type": { "$ref": "#/components/schemas/GpWorkersCreationSchemaGetResponsesContentApplicationJsonSchemaDataItemsType", "description": "Transport type of the field." }, "validation": { "description": "Constraints applied to the value.", "items": { "$ref": "#/components/schemas/GpWorkersCreationSchemaGetResponsesContentApplicationJsonSchemaDataItemsValidationItems" }, "type": "array" }, "values_allowed": { "description": "Permitted values, when the field is restricted to a fixed set. For contract_state these are the provinces of the country.", "items": { "description": "Any type" }, "type": "array" } }, "required": [ "key", "type", "is_required" ], "title": "GpWorkersCreationSchemaGetResponsesContentApplicationJsonSchemaDataItems", "type": "object" }, "GpWorkersCreationSchemaGetResponsesContentApplicationJsonSchemaDataItemsDependenciesItems": { "properties": { "equals": { "description": "Values of the referenced field that trigger the condition.", "items": { "description": "Any type" }, "type": "array" }, "field": { "description": "Field this one depends on.", "maxLength": 200, "minLength": 1, "type": "string" } }, "required": [ "field" ], "title": "GpWorkersCreationSchemaGetResponsesContentApplicationJsonSchemaDataItemsDependenciesItems", "type": "object" }, "GpWorkersCreationSchemaGetResponsesContentApplicationJsonSchemaDataItemsType": { "description": "Transport type of the field.", "enum": [ "string", "number", "boolean", "object", "array" ], "title": "GpWorkersCreationSchemaGetResponsesContentApplicationJsonSchemaDataItemsType", "type": "string" }, "GpWorkersCreationSchemaGetResponsesContentApplicationJsonSchemaDataItemsValidationItems": { "properties": { "field": { "description": "Field this constraint is relative to, when the bound references another field.", "maxLength": 200, "minLength": 1, "type": "string" }, "message": { "description": "Error message the create endpoint returns when the constraint fails.", "maxLength": 500, "minLength": 1, "type": "string" }, "type": { "description": "Constraint name, e.g. pattern, max, length, format, not_allowed.", "maxLength": 50, "minLength": 1, "type": "string" }, "value": { "description": "Constraint argument, when the constraint is a literal." } }, "required": [ "type" ], "title": "GpWorkersCreationSchemaGetResponsesContentApplicationJsonSchemaDataItemsValidationItems", "type": "object" }, "GpWorkersCreationSchemaGetResponsesContentApplicationJsonSchemaErrorsItems": { "properties": { "code": { "description": "Machine-readable error code.", "maxLength": 100, "minLength": 1, "type": "string" }, "details": { "$ref": "#/components/schemas/GpWorkersCreationSchemaGetResponsesContentApplicationJsonSchemaErrorsItemsDetails", "description": "Extra machine-readable context. Conflict errors carry the worker_id and contract_id of the existing record; currency_not_allowed carries allowed_currencies." }, "field": { "description": "Path of the request field the error refers to, when the error is caused by a single field.", "maxLength": 200, "minLength": 1, "type": "string" }, "message": { "description": "Human-readable explanation of the error.", "maxLength": 1000, "minLength": 1, "type": "string" } }, "required": [ "code", "message" ], "title": "GpWorkersCreationSchemaGetResponsesContentApplicationJsonSchemaErrorsItems", "type": "object" }, "GpWorkersCreationSchemaGetResponsesContentApplicationJsonSchemaErrorsItemsDetails": { "description": "Extra machine-readable context. Conflict errors carry the worker_id and contract_id of the existing record; currency_not_allowed carries allowed_currencies.", "properties": { "allowed_currencies": { "description": "Currencies the legal entity may pay in, when the requested currency is not allowed.", "items": { "type": "string" }, "type": "array" }, "contract_id": { "description": "Id of the existing contract the request conflicts with.", "type": [ "string", "null" ] }, "worker_id": { "description": "Id of the existing worker the request conflicts with.", "type": [ "string", "null" ] } }, "title": "GpWorkersCreationSchemaGetResponsesContentApplicationJsonSchemaErrorsItemsDetails", "type": "object" }, "GpWorkersIdPayslipsGetResponsesContentApplicationJsonSchemaDataItems": { "properties": { "from": { "description": "Start date of the payslip period in ISO-8601 format.", "format": "date", "type": "string" }, "id": { "description": "Unique identifier for the payslip.", "type": "string" }, "status": { "description": "The current status of the payslip (e.g., AVAILABLE, PENDING, PUBLISHED).", "type": "string" }, "to": { "description": "End date of the payslip period in ISO-8601 format.", "format": "date", "type": "string" } }, "required": [ "id", "to", "from", "status" ], "title": "GpWorkersIdPayslipsGetResponsesContentApplicationJsonSchemaDataItems", "type": "object" }, "GpWorkersIdPayslipsGetResponsesContentApplicationJsonSchemaErrorsItems": { "properties": { "message": { "description": "Error response", "type": "string" } }, "required": [ "message" ], "title": "GpWorkersIdPayslipsGetResponsesContentApplicationJsonSchemaErrorsItems", "type": "object" }, "GpWorkersIdPayslipsGetResponsesContentApplicationJsonSchemaRequest": { "description": "Error request details", "properties": { "method": { "description": "Method of the API", "type": "string" }, "status": { "description": "Status of API response", "format": "double", "type": "number" } }, "title": "GpWorkersIdPayslipsGetResponsesContentApplicationJsonSchemaRequest", "type": "object" }, "GpWorkersIdPayslipsPayslipIdDownloadGetResponsesContentApplicationJsonSchemaData": { "properties": { "url": { "description": "A pre-signed URL to download the payslip PDF.", "type": "string" } }, "required": [ "url" ], "title": "GpWorkersIdPayslipsPayslipIdDownloadGetResponsesContentApplicationJsonSchemaData", "type": "object" }, "GpWorkersIdPayslipsPayslipIdDownloadGetResponsesContentApplicationJsonSchemaErrorsItems": { "properties": { "message": { "description": "Error response", "type": "string" } }, "required": [ "message" ], "title": "GpWorkersIdPayslipsPayslipIdDownloadGetResponsesContentApplicationJsonSchemaErrorsItems", "type": "object" }, "GpWorkersIdPayslipsPayslipIdDownloadGetResponsesContentApplicationJsonSchemaRequest": { "description": "Error request details", "properties": { "method": { "description": "Method of the API", "type": "string" }, "status": { "description": "Status of API response", "format": "double", "type": "number" } }, "title": "GpWorkersIdPayslipsPayslipIdDownloadGetResponsesContentApplicationJsonSchemaRequest", "type": "object" }, "GpWorkersPostParametersXBeta": { "default": "true", "enum": [ "true" ], "title": "GpWorkersPostParametersXBeta", "type": "string" }, "GpWorkersPostRequestBodyContentApplicationJsonSchemaData": { "properties": { "compensation": { "$ref": "#/components/schemas/GpWorkersPostRequestBodyContentApplicationJsonSchemaDataCompensation", "description": "Base compensation of the worker." }, "contract_state": { "description": "State or province code the contract is governed by. Required when the legal entity country has provinces enabled for Global Payroll (for example CA, US, AU, BR, IN) and must be one of its provinces.", "maxLength": 50, "minLength": 1, "type": "string" }, "employee_number": { "description": "Employee number in your payroll system. Required when the payroll group is a Payroll Connect (Soft GP) group. It must be unique within the legal entity.", "maxLength": 100, "minLength": 1, "type": "string" }, "employment_type": { "$ref": "#/components/schemas/GpWorkersPostRequestBodyContentApplicationJsonSchemaDataEmploymentType", "description": "Employment type of the worker." }, "external_id": { "description": "Identifier of the worker in your own system. It must be unique within your organization.", "maxLength": 100, "minLength": 1, "type": "string" }, "fte_percentage": { "description": "Full-time equivalent percentage, from 1 to 99. Required when employment_type is PART_TIME and not allowed when it is FULL_TIME.", "maximum": 99, "minimum": 1, "type": "integer" }, "home_address": { "$ref": "#/components/schemas/GpWorkersPostRequestBodyContentApplicationJsonSchemaDataHomeAddress", "description": "Home address of the worker." }, "job_title": { "description": "Job title of the worker.", "maxLength": 255, "minLength": 1, "type": "string" }, "legal_entity_id": { "description": "Identifier of the Global Payroll legal entity the worker is employed by. It must belong to your organization.", "format": "uuid", "maxLength": 36, "minLength": 36, "type": "string" }, "payroll_group_id": { "description": "Identifier of the active Global Payroll payroll group of the legal entity the worker is paid in.", "maxLength": 100, "minLength": 1, "type": "string" }, "personal_info": { "$ref": "#/components/schemas/GpWorkersPostRequestBodyContentApplicationJsonSchemaDataPersonalInfo", "description": "Personal details of the worker." }, "pto": { "$ref": "#/components/schemas/GpWorkersPostRequestBodyContentApplicationJsonSchemaDataPto", "description": "Paid time off settings for the worker." }, "should_invite_employee_to_app": { "default": false, "description": "Whether to email the worker an invitation to join Deel. Defaults to false.", "type": "boolean" }, "start_date": { "description": "Employment start date, in YYYY-MM-DD format. The payroll start date defaults to it.", "format": "date", "maxLength": 10, "minLength": 10, "type": "string" }, "team_id": { "description": "Identifier of the team the contract is created in. It must belong to your organization and the caller needs permission to create contracts in it.", "format": "uuid", "maxLength": 36, "minLength": 36, "type": "string" }, "work_location": { "$ref": "#/components/schemas/GpWorkersPostRequestBodyContentApplicationJsonSchemaDataWorkLocation", "description": "Where the worker works. Required when the legal entity is in the United States." } }, "required": [ "team_id", "job_title", "start_date", "compensation", "home_address", "personal_info", "employment_type", "legal_entity_id", "payroll_group_id" ], "title": "GpWorkersPostRequestBodyContentApplicationJsonSchemaData", "type": "object" }, "GpWorkersPostRequestBodyContentApplicationJsonSchemaDataCompensation": { "description": "Base compensation of the worker.", "properties": { "amount": { "description": "Base compensation amount per scale period.", "format": "double", "minimum": 0, "type": "number" }, "currency": { "description": "ISO 4217 currency code. It must be one of the currencies allowed for the legal entity country.", "maxLength": 3, "minLength": 3, "pattern": "^[A-Z]{3}$", "type": "string" }, "scale": { "$ref": "#/components/schemas/GpWorkersPostRequestBodyContentApplicationJsonSchemaDataCompensationScale", "description": "Period the amount is paid for." }, "type": { "$ref": "#/components/schemas/GpWorkersPostRequestBodyContentApplicationJsonSchemaDataCompensationType", "default": "SALARIED", "description": "Whether the worker is salaried or paid hourly. Defaults to SALARIED." } }, "required": [ "scale", "amount", "currency" ], "title": "GpWorkersPostRequestBodyContentApplicationJsonSchemaDataCompensation", "type": "object" }, "GpWorkersPostRequestBodyContentApplicationJsonSchemaDataCompensationScale": { "description": "Period the amount is paid for.", "enum": [ "ANNUALLY", "MONTHLY", "BI_MONTHLY", "TWO_WEEKLY", "WEEKLY", "DAILY", "HOURLY" ], "title": "GpWorkersPostRequestBodyContentApplicationJsonSchemaDataCompensationScale", "type": "string" }, "GpWorkersPostRequestBodyContentApplicationJsonSchemaDataCompensationType": { "default": "SALARIED", "description": "Whether the worker is salaried or paid hourly. Defaults to SALARIED.", "enum": [ "SALARIED", "HOURLY" ], "title": "GpWorkersPostRequestBodyContentApplicationJsonSchemaDataCompensationType", "type": "string" }, "GpWorkersPostRequestBodyContentApplicationJsonSchemaDataEmploymentType": { "description": "Employment type of the worker.", "enum": [ "FULL_TIME", "PART_TIME" ], "title": "GpWorkersPostRequestBodyContentApplicationJsonSchemaDataEmploymentType", "type": "string" }, "GpWorkersPostRequestBodyContentApplicationJsonSchemaDataHomeAddress": { "description": "Home address of the worker.", "properties": { "city": { "description": "City.", "maxLength": 100, "minLength": 1, "type": "string" }, "country": { "description": "Country of the home address as an ISO 3166-1 alpha-2 code.", "maxLength": 2, "minLength": 2, "pattern": "^[A-Z]{2}$", "type": "string" }, "state": { "description": "State, province or region.", "maxLength": 50, "minLength": 1, "type": "string" }, "street": { "description": "Street and number.", "maxLength": 255, "minLength": 1, "type": "string" }, "zip": { "description": "Postal code.", "maxLength": 100, "minLength": 1, "type": "string" } }, "required": [ "zip", "city", "street", "country" ], "title": "GpWorkersPostRequestBodyContentApplicationJsonSchemaDataHomeAddress", "type": "object" }, "GpWorkersPostRequestBodyContentApplicationJsonSchemaDataPersonalInfo": { "description": "Personal details of the worker.", "properties": { "date_of_birth": { "description": "Date of birth of the worker, in YYYY-MM-DD format.", "format": "date", "maxLength": 10, "minLength": 10, "type": "string" }, "email": { "description": "Personal email address of the worker. It identifies the worker within your organization.", "format": "email", "maxLength": 255, "minLength": 3, "type": "string" }, "first_name": { "description": "First name of the worker.", "maxLength": 100, "minLength": 1, "type": "string" }, "last_name": { "description": "Last name of the worker.", "maxLength": 100, "minLength": 1, "type": "string" }, "nationality": { "description": "Nationality of the worker as an ISO 3166-1 alpha-2 country code.", "maxLength": 2, "minLength": 2, "pattern": "^[A-Z]{2}$", "type": "string" }, "work_email": { "description": "Work email address of the worker.", "format": "email", "maxLength": 255, "minLength": 3, "type": "string" } }, "required": [ "email", "last_name", "first_name" ], "title": "GpWorkersPostRequestBodyContentApplicationJsonSchemaDataPersonalInfo", "type": "object" }, "GpWorkersPostRequestBodyContentApplicationJsonSchemaDataPto": { "description": "Paid time off settings for the worker.", "properties": { "start_date": { "description": "Date paid time off starts accruing, in YYYY-MM-DD format.", "format": "date", "maxLength": 10, "minLength": 10, "type": "string" }, "yearly_allowance": { "description": "Number of paid time off days granted per year.", "format": "double", "minimum": 0, "type": "number" } }, "title": "GpWorkersPostRequestBodyContentApplicationJsonSchemaDataPto", "type": "object" }, "GpWorkersPostRequestBodyContentApplicationJsonSchemaDataWorkLocation": { "description": "Where the worker works. Required when the legal entity is in the United States.", "properties": { "effective_date": { "description": "Date from which the work location applies. Defaults to start_date.", "format": "date", "type": "string" }, "entity_address_id": { "description": "Identifier of an active address of the legal entity. When is_remote is false, provide either this or name.", "format": "uuid", "maxLength": 36, "minLength": 36, "type": "string" }, "is_remote": { "description": "Whether the worker works remotely rather than from an entity office.", "type": "boolean" }, "name": { "description": "Name of an active address of the legal entity, as shown in the app. Alternative to entity_address_id when is_remote is false. 'Remote' is accepted and means a remote worker.", "maxLength": 255, "minLength": 1, "type": "string" } }, "required": [ "is_remote" ], "title": "GpWorkersPostRequestBodyContentApplicationJsonSchemaDataWorkLocation", "type": "object" }, "GpWorkersPostResponsesContentApplicationJsonSchemaData": { "properties": { "client": { "$ref": "#/components/schemas/GpWorkersPostResponsesContentApplicationJsonSchemaDataClient" }, "compensation_details": { "$ref": "#/components/schemas/GpWorkersPostResponsesContentApplicationJsonSchemaDataCompensationDetails" }, "created_at": { "description": "Long date-time format following ISO-8601.", "format": "date-time", "type": [ "string", "null" ] }, "employee": { "$ref": "#/components/schemas/GpWorkersPostResponsesContentApplicationJsonSchemaDataEmployee" }, "employment": { "$ref": "#/components/schemas/GpWorkersPostResponsesContentApplicationJsonSchemaDataEmployment" }, "id": { "description": "Id of the contract created.", "type": "string" }, "job_title": { "description": "Employee's job title.", "type": "string" }, "status": { "$ref": "#/components/schemas/GpWorkersPostResponsesContentApplicationJsonSchemaDataStatus", "description": "Status of a contract in Deel workflow." }, "type": { "$ref": "#/components/schemas/GpWorkersPostResponsesContentApplicationJsonSchemaDataType", "description": "Type of a contract." } }, "title": "GpWorkersPostResponsesContentApplicationJsonSchemaData", "type": "object" }, "GpWorkersPostResponsesContentApplicationJsonSchemaDataClient": { "properties": { "legal_entity": { "$ref": "#/components/schemas/GpWorkersPostResponsesContentApplicationJsonSchemaDataClientLegalEntity" } }, "title": "GpWorkersPostResponsesContentApplicationJsonSchemaDataClient", "type": "object" }, "GpWorkersPostResponsesContentApplicationJsonSchemaDataClientLegalEntity": { "properties": { "name": { "description": "Legal entity name.", "type": "string" } }, "title": "GpWorkersPostResponsesContentApplicationJsonSchemaDataClientLegalEntity", "type": "object" }, "GpWorkersPostResponsesContentApplicationJsonSchemaDataCompensationDetails": { "properties": { "currency": { "description": "Currency of gross annual/month salary.", "type": "string" }, "salary": { "description": "Gross annual/month salary.", "format": "double", "type": "number" }, "scale": { "description": "Scale at which the salary is paid.", "type": "string" } }, "title": "GpWorkersPostResponsesContentApplicationJsonSchemaDataCompensationDetails", "type": "object" }, "GpWorkersPostResponsesContentApplicationJsonSchemaDataEmployee": { "properties": { "email": { "description": "Employee's email address.", "type": "string" }, "employee_number": { "description": "Employee's number.", "type": [ "string", "null" ] }, "first_name": { "description": "Employee's first name.", "type": "string" }, "id": { "description": "Worker id. Use it with the other Global Payroll worker endpoints (`/rest/gp/workers/{worker_id}/...`).", "format": "uuid", "type": "string" }, "last_name": { "description": "Employee's last name.", "type": "string" } }, "title": "GpWorkersPostResponsesContentApplicationJsonSchemaDataEmployee", "type": "object" }, "GpWorkersPostResponsesContentApplicationJsonSchemaDataEmployment": { "properties": { "country": { "description": "Country of employment.", "type": "string" }, "end_date": { "description": "Long date-time format following ISO-8601.", "format": "date-time", "type": [ "string", "null" ] }, "holidays": { "$ref": "#/components/schemas/GpWorkersPostResponsesContentApplicationJsonSchemaDataEmploymentHolidays" }, "is_work_visa_required": { "description": "Do you require Deel to apply for a work visa for this person?", "type": "boolean" }, "start_date": { "description": "Long date-time format following ISO-8601.", "format": "date-time", "type": [ "string", "null" ] }, "state": { "description": "State code of the state/province where this person will be employed.", "type": [ "string", "null" ] }, "type": { "description": "Is it a full-time contract or a part-time contract?", "type": "string" } }, "title": "GpWorkersPostResponsesContentApplicationJsonSchemaDataEmployment", "type": "object" }, "GpWorkersPostResponsesContentApplicationJsonSchemaDataEmploymentHolidays": { "properties": { "allowance": { "description": "Number of holidays.", "format": "double", "type": "number" }, "start_date": { "description": "Long date-time format following ISO-8601.", "format": "date-time", "type": [ "string", "null" ] } }, "title": "GpWorkersPostResponsesContentApplicationJsonSchemaDataEmploymentHolidays", "type": "object" }, "GpWorkersPostResponsesContentApplicationJsonSchemaDataStatus": { "description": "Status of a contract in Deel workflow.", "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" ], "title": "GpWorkersPostResponsesContentApplicationJsonSchemaDataStatus", "type": "string" }, "GpWorkersPostResponsesContentApplicationJsonSchemaDataType": { "description": "Type of a contract.", "enum": [ "ongoing_time_based", "milestones", "time_based", "pay_as_you_go_time_based", "commission", "payg_milestones", "payg_tasks", "eor", "unknown", "employee", "global_payroll", "shield_msa", "hris_direct_employee", "peo" ], "title": "GpWorkersPostResponsesContentApplicationJsonSchemaDataType", "type": "string" }, "GpWorkersPostResponsesContentApplicationJsonSchemaErrorsItems": { "properties": { "code": { "description": "Machine-readable error code.", "maxLength": 100, "minLength": 1, "type": "string" }, "details": { "$ref": "#/components/schemas/GpWorkersPostResponsesContentApplicationJsonSchemaErrorsItemsDetails", "description": "Extra machine-readable context. Conflict errors carry the worker_id and contract_id of the existing record; currency_not_allowed carries allowed_currencies." }, "field": { "description": "Path of the request field the error refers to, when the error is caused by a single field.", "maxLength": 200, "minLength": 1, "type": "string" }, "message": { "description": "Human-readable explanation of the error.", "maxLength": 1000, "minLength": 1, "type": "string" } }, "required": [ "code", "message" ], "title": "GpWorkersPostResponsesContentApplicationJsonSchemaErrorsItems", "type": "object" }, "GpWorkersPostResponsesContentApplicationJsonSchemaErrorsItemsDetails": { "description": "Extra machine-readable context. Conflict errors carry the worker_id and contract_id of the existing record; currency_not_allowed carries allowed_currencies.", "properties": { "allowed_currencies": { "description": "Currencies the legal entity may pay in, when the requested currency is not allowed.", "items": { "type": "string" }, "type": "array" }, "contract_id": { "description": "Id of the existing contract the request conflicts with.", "type": [ "string", "null" ] }, "worker_id": { "description": "Id of the existing worker the request conflicts with.", "type": [ "string", "null" ] } }, "title": "GpWorkersPostResponsesContentApplicationJsonSchemaErrorsItemsDetails", "type": "object" }, "GpWorkersWorkerIdAddressPatchRequestBodyContentApplicationJsonSchemaData": { "properties": { "city": { "description": "City name.", "type": "string" }, "street": { "description": "Street name.", "type": "string" }, "zip": { "description": "Zip code.", "type": "string" } }, "title": "GpWorkersWorkerIdAddressPatchRequestBodyContentApplicationJsonSchemaData", "type": "object" }, "GpWorkersWorkerIdAddressPatchResponsesContentApplicationJsonSchemaData": { "properties": { "city": { "description": "City name.", "type": [ "string", "null" ] }, "country": { "description": "Country code.", "maxLength": 2, "minLength": 2, "pattern": "^[A-Z]{2}$", "type": "string" }, "state": { "description": "State name.", "type": [ "string", "null" ] }, "street": { "description": "Street name.", "type": [ "string", "null" ] }, "updated_at": { "description": "Long date-time format following ISO-8601", "format": "date-time", "type": "string" }, "zip": { "description": "Zip code.", "type": [ "string", "null" ] } }, "title": "GpWorkersWorkerIdAddressPatchResponsesContentApplicationJsonSchemaData", "type": "object" }, "GpWorkersWorkerIdBanksBankIdPatchResponsesContentApplicationJsonSchemaData": { "properties": { "created_at": { "description": "Timestamp of when the bank account was created, in ISO-8601 format.", "format": "date-time", "type": "string" }, "id": { "description": "Unique identifier for the modified bank account.", "format": "uuid", "type": "string" }, "status": { "description": "The status of the modified bank account.", "type": "string" }, "updated_at": { "description": "Timestamp of the last update to the bank account, in ISO-8601 format.", "format": "date-time", "type": "string" } }, "required": [ "id", "status", "created_at", "updated_at" ], "title": "GpWorkersWorkerIdBanksBankIdPatchResponsesContentApplicationJsonSchemaData", "type": "object" }, "GpWorkersWorkerIdBanksGetResponsesContentApplicationJsonSchemaDataItems": { "properties": { "account_number": { "description": "The user's bank account number.", "type": "string" }, "account_type": { "description": "Bank account type.", "type": "string" }, "ach_routing_number": { "description": "The ACH (Automated Clearing House) Routing Number.", "type": "string" }, "address_line1": { "description": "The primary address line.", "type": "string" }, "address_line2": { "description": "The secondary address line.", "type": "string" }, "bank_branch_name": { "description": "The name of the user's bank branch.", "type": "string" }, "bank_code": { "description": "The bank code.", "type": "string" }, "bank_country_code": { "description": "The country code where the bank is located.", "type": "string" }, "bank_name": { "description": "Name of the user's bank.", "type": "string" }, "branch_code": { "description": "The branch code of the user's bank.", "type": "string" }, "city": { "description": "The city of the user's address.", "type": "string" }, "country_code": { "description": "The country code of the user.", "type": "string" }, "created_at": { "description": "Long date-time format following ISO-8601.", "format": "date-time", "type": "string" }, "currency_code": { "description": "The currency code for transactions.", "type": "string" }, "email": { "description": "The user's email address.", "type": "string" }, "full_name": { "description": "Full name of the user.", "type": "string" }, "iban": { "description": "The International Bank Account Number (IBAN).", "type": "string" }, "id": { "description": "Unique identifier of this resource.", "type": "string" }, "original_name": { "description": "The original name of the user.", "type": "string" }, "phone": { "description": "The user's phone number.", "type": "string" }, "postal": { "description": "The user's postal or ZIP code.", "type": "string" }, "province_state": { "description": "The state or province of the user's address.", "type": "string" }, "rib_number": { "description": "The RIB(Relevé d'Identité Bancaire).", "type": "string" }, "sort_code": { "description": "UK sort code.", "type": "string" }, "status": { "description": "Current status of bank account.", "type": "string" }, "swift_bic": { "description": "SWIFT/BIC code for the bank.", "type": "string" }, "tax_id": { "description": "The user's tax identification number.", "type": "string" }, "updated_at": { "description": "Long date-time format following ISO-8601.", "format": "date-time", "type": "string" } }, "required": [ "id", "created_at", "updated_at" ], "title": "GpWorkersWorkerIdBanksGetResponsesContentApplicationJsonSchemaDataItems", "type": "object" }, "GpWorkersWorkerIdBanksGuideGetResponsesContentApplicationJsonSchemaDataItems": { "properties": { "key": { "description": "The unique key representing the field.", "type": "string" }, "label": { "description": "The label or display name for this field.", "type": "string" }, "required": { "description": "Indicates whether the field is required.", "type": "boolean" }, "type": { "description": "The type of the field, such as 'Text' or 'Dropdown'.", "type": "string" }, "validations": { "description": "An array of validation rules applied to the field.", "items": { "$ref": "#/components/schemas/GpWorkersWorkerIdBanksGuideGetResponsesContentApplicationJsonSchemaDataItemsValidationsItems" }, "type": "array" }, "values_allowed": { "description": "An array of allowed values for the field (e.g., for dropdown fields).", "items": { "$ref": "#/components/schemas/GpWorkersWorkerIdBanksGuideGetResponsesContentApplicationJsonSchemaDataItemsValuesAllowedItems" }, "type": "array" } }, "required": [ "key", "required" ], "title": "GpWorkersWorkerIdBanksGuideGetResponsesContentApplicationJsonSchemaDataItems", "type": "object" }, "GpWorkersWorkerIdBanksGuideGetResponsesContentApplicationJsonSchemaDataItemsValidationsItems": { "properties": { "type": { "$ref": "#/components/schemas/GpWorkersWorkerIdBanksGuideGetResponsesContentApplicationJsonSchemaDataItemsValidationsItemsType", "description": "The type of validation applied to the field." }, "value": { "$ref": "#/components/schemas/GpWorkersWorkerIdBanksGuideGetResponsesContentApplicationJsonSchemaDataItemsValidationsItemsValue" } }, "title": "GpWorkersWorkerIdBanksGuideGetResponsesContentApplicationJsonSchemaDataItemsValidationsItems", "type": "object" }, "GpWorkersWorkerIdBanksGuideGetResponsesContentApplicationJsonSchemaDataItemsValidationsItemsType": { "description": "The type of validation applied to the field.", "enum": [ "MIN_LENGTH", "MAX_LENGTH", "REGEX" ], "title": "GpWorkersWorkerIdBanksGuideGetResponsesContentApplicationJsonSchemaDataItemsValidationsItemsType", "type": "string" }, "GpWorkersWorkerIdBanksGuideGetResponsesContentApplicationJsonSchemaDataItemsValidationsItemsValue": { "oneOf": [ { "type": "string" }, { "format": "double", "type": "number" } ], "title": "GpWorkersWorkerIdBanksGuideGetResponsesContentApplicationJsonSchemaDataItemsValidationsItemsValue" }, "GpWorkersWorkerIdBanksGuideGetResponsesContentApplicationJsonSchemaDataItemsValuesAllowedItems": { "properties": { "label": { "description": "The display name of the allowed value.", "type": "string" }, "value": { "description": "The value associated with the allowed option.", "type": "string" } }, "title": "GpWorkersWorkerIdBanksGuideGetResponsesContentApplicationJsonSchemaDataItemsValuesAllowedItems", "type": "object" }, "GpWorkersWorkerIdBanksPostRequestBodyContentApplicationJsonSchemaData": { "properties": { "account_number": { "description": "The user's bank account number.", "type": "string" }, "account_type": { "description": "Bank account type.", "type": "string" }, "ach_routing_number": { "description": "The ACH (Automated Clearing House) Routing Number.", "type": "string" }, "address_line1": { "description": "The primary address line.", "type": "string" }, "address_line2": { "description": "The secondary address line.", "type": "string" }, "bank_branch_name": { "description": "The name of the user's bank branch.", "type": "string" }, "bank_code": { "description": "The bank code.", "type": "string" }, "bank_country_code": { "description": "The country code where the bank is located.", "type": "string" }, "bank_name": { "description": "Name of the user's bank.", "type": "string" }, "branch_code": { "description": "The branch code of the user's bank.", "type": "string" }, "city": { "description": "The city of the user's address.", "type": "string" }, "country_code": { "description": "The country code of the user's address.", "type": "string" }, "currency_code": { "description": "The currency code for transactions.", "type": "string" }, "email": { "description": "The user's email address.", "type": "string" }, "full_name": { "description": "Full name of the user.", "type": "string" }, "iban": { "description": "The International Bank Account Number (IBAN).", "type": "string" }, "original_name": { "description": "The original name of the user.", "type": "string" }, "phone": { "description": "The user's phone number.", "type": "string" }, "postal": { "description": "The user's postal or ZIP code.", "type": "string" }, "province_state": { "description": "The state or province of the user's address.", "type": "string" }, "rib_number": { "description": "The RIB (Relevé d'Identité Bancaire).", "type": "string" }, "swift_bic": { "description": "SWIFT/BIC code for the bank.", "type": "string" }, "tax_id": { "description": "The user's tax identification number.", "type": "string" } }, "title": "GpWorkersWorkerIdBanksPostRequestBodyContentApplicationJsonSchemaData", "type": "object" }, "GpWorkersWorkerIdBanksPostResponsesContentApplicationJsonSchemaData": { "properties": { "created_at": { "description": "Timestamp of when the bank account was created, in ISO-8601 format.", "format": "date-time", "type": "string" }, "id": { "description": "Unique identifier for the newly added bank account.", "format": "uuid", "type": "string" }, "status": { "description": "The status of the newly added bank account.", "type": "string" }, "updated_at": { "description": "Timestamp of the last update to the bank account, in ISO-8601 format.", "format": "date-time", "type": "string" } }, "required": [ "id", "status", "created_at", "updated_at" ], "title": "GpWorkersWorkerIdBanksPostResponsesContentApplicationJsonSchemaData", "type": "object" }, "GpWorkersWorkerIdCompensationPatchRequestBodyContentApplicationJsonSchemaData": { "properties": { "effective_date": { "description": "Short date in format ISO-8601 (YYYY-MM-DD). For example: 2022-12-31.", "format": "date", "type": "string" }, "salary": { "description": "Compensation salary.", "format": "double", "type": "number" }, "scale": { "$ref": "#/components/schemas/GpWorkersWorkerIdCompensationPatchRequestBodyContentApplicationJsonSchemaDataScale", "description": "The scale to which a given salary applies." } }, "required": [ "scale", "salary", "effective_date" ], "title": "GpWorkersWorkerIdCompensationPatchRequestBodyContentApplicationJsonSchemaData", "type": "object" }, "GpWorkersWorkerIdCompensationPatchRequestBodyContentApplicationJsonSchemaDataScale": { "description": "The scale to which a given salary applies.", "enum": [ "YEAR", "MONTH", "HOUR" ], "title": "GpWorkersWorkerIdCompensationPatchRequestBodyContentApplicationJsonSchemaDataScale", "type": "string" }, "GpWorkersWorkerIdCompensationPatchResponsesContentApplicationJsonSchemaDataItems": { "properties": { "effective_date": { "description": "Short date in format ISO-8601 (YYYY-MM-DD). For example: 2022-12-31.", "format": "date", "type": "string" }, "salary": { "description": "Compensation salary.", "type": "string" }, "scale": { "$ref": "#/components/schemas/GpWorkersWorkerIdCompensationPatchResponsesContentApplicationJsonSchemaDataItemsScale", "description": "The scale to which a given salary applies." }, "status": { "$ref": "#/components/schemas/GpWorkersWorkerIdCompensationPatchResponsesContentApplicationJsonSchemaDataItemsStatus", "description": "The status of a salary amendment." } }, "title": "GpWorkersWorkerIdCompensationPatchResponsesContentApplicationJsonSchemaDataItems", "type": "object" }, "GpWorkersWorkerIdCompensationPatchResponsesContentApplicationJsonSchemaDataItemsScale": { "description": "The scale to which a given salary applies.", "enum": [ "YEAR", "MONTH", "HOUR" ], "title": "GpWorkersWorkerIdCompensationPatchResponsesContentApplicationJsonSchemaDataItemsScale", "type": "string" }, "GpWorkersWorkerIdCompensationPatchResponsesContentApplicationJsonSchemaDataItemsStatus": { "description": "The status of a salary amendment.", "enum": [ "ACTIVE", "UPCOMING", "OUTDATED" ], "title": "GpWorkersWorkerIdCompensationPatchResponsesContentApplicationJsonSchemaDataItemsStatus", "type": "string" }, "GpWorkersWorkerIdEmployeeInformationPatchRequestBodyContentApplicationJsonSchemaData": { "properties": { "employee_number": { "description": "Employee's unique number.", "type": "string" } }, "title": "GpWorkersWorkerIdEmployeeInformationPatchRequestBodyContentApplicationJsonSchemaData", "type": "object" }, "GpWorkersWorkerIdPtoPolicyPatchRequestBodyContentApplicationJsonSchemaData": { "properties": { "accrual_start_date": { "description": "Short date in format ISO-8601 (YYYY-MM-DD). For example: '2022-12-31'.", "format": "date", "type": "string" }, "yearly_allowance": { "description": "Enter the number of holidays. Example: '15' for 15 days.", "type": "string" } }, "required": [ "yearly_allowance", "accrual_start_date" ], "title": "GpWorkersWorkerIdPtoPolicyPatchRequestBodyContentApplicationJsonSchemaData", "type": "object" }, "GpWorkersWorkerIdPtoPolicyPatchResponsesContentApplicationJsonSchemaData": { "properties": { "updated": { "description": "Indicates if the PTO policy was successfully updated.", "type": "boolean" } }, "required": [ "updated" ], "title": "GpWorkersWorkerIdPtoPolicyPatchResponsesContentApplicationJsonSchemaData", "type": "object" }, "GpWorkersWorkerIdTerminationsPostRequestBodyContentApplicationJsonSchemaData": { "properties": { "desired_end_date": { "description": "The preferred end date for terminating the worker's engagement, in ISO-8601 format (YYYY-MM-DD).", "format": "date", "type": "string" }, "is_voluntary": { "description": "Indicates whether the worker termination is voluntary (true) or involuntary (false).", "type": "boolean" }, "last_date_of_work": { "description": "The effective termination date of the worker's employment, in ISO-8601 format (YYYY-MM-DD).", "format": "date", "type": "string" }, "message": { "description": "The reason for terminating the worker's engagement.", "type": "string" }, "severance": { "$ref": "#/components/schemas/GpWorkersWorkerIdTerminationsPostRequestBodyContentApplicationJsonSchemaDataSeverance" } }, "required": [ "message", "severance", "is_voluntary", "desired_end_date", "last_date_of_work" ], "title": "GpWorkersWorkerIdTerminationsPostRequestBodyContentApplicationJsonSchemaData", "type": "object" }, "GpWorkersWorkerIdTerminationsPostRequestBodyContentApplicationJsonSchemaDataSeverance": { "oneOf": [ { "$ref": "#/components/schemas/GpWorkersWorkerIdTerminationsPostRequestBodyContentApplicationJsonSchemaDataSeverance0" }, { "$ref": "#/components/schemas/GpWorkersWorkerIdTerminationsPostRequestBodyContentApplicationJsonSchemaDataSeverance1" } ], "title": "GpWorkersWorkerIdTerminationsPostRequestBodyContentApplicationJsonSchemaDataSeverance" }, "GpWorkersWorkerIdTerminationsPostRequestBodyContentApplicationJsonSchemaDataSeverance0": { "properties": { "amount": { "description": "The amount of severance, specified in the designated currency or time unit.", "format": "double", "type": "number" }, "currency": { "description": "Currency code for severance.", "maxLength": 3, "minLength": 3, "pattern": "^[A-Z]{3}$", "type": "string" }, "time_unit": { "$ref": "#/components/schemas/GpWorkersWorkerIdTerminationsPostRequestBodyContentApplicationJsonSchemaDataSeveranceOneOf0TimeUnit", "description": "The unit of time for severance (e.g., DAYS, WEEKS, MONTHS)." }, "type": { "$ref": "#/components/schemas/GpWorkersWorkerIdTerminationsPostRequestBodyContentApplicationJsonSchemaDataSeveranceOneOf0Type", "description": "The type of severance, either in time off." } }, "required": [ "type", "amount", "currency", "time_unit" ], "title": "GpWorkersWorkerIdTerminationsPostRequestBodyContentApplicationJsonSchemaDataSeverance0", "type": "object" }, "GpWorkersWorkerIdTerminationsPostRequestBodyContentApplicationJsonSchemaDataSeverance1": { "properties": { "amount": { "description": "The amount of severance, specified in the designated currency.", "format": "double", "type": "number" }, "currency": { "description": "Currency code for severance.", "maxLength": 3, "minLength": 3, "pattern": "^[A-Z]{3}$", "type": "string" }, "type": { "$ref": "#/components/schemas/GpWorkersWorkerIdTerminationsPostRequestBodyContentApplicationJsonSchemaDataSeveranceOneOf1Type", "description": "The type of severance, in cash." } }, "required": [ "type", "amount", "currency" ], "title": "GpWorkersWorkerIdTerminationsPostRequestBodyContentApplicationJsonSchemaDataSeverance1", "type": "object" }, "GpWorkersWorkerIdTerminationsPostRequestBodyContentApplicationJsonSchemaDataSeveranceOneOf0TimeUnit": { "description": "The unit of time for severance (e.g., DAYS, WEEKS, MONTHS).", "enum": [ "DAYS", "WEEKS", "MONTHS" ], "title": "GpWorkersWorkerIdTerminationsPostRequestBodyContentApplicationJsonSchemaDataSeveranceOneOf0TimeUnit", "type": "string" }, "GpWorkersWorkerIdTerminationsPostRequestBodyContentApplicationJsonSchemaDataSeveranceOneOf0Type": { "description": "The type of severance, either in time off.", "enum": [ "TIME" ], "title": "GpWorkersWorkerIdTerminationsPostRequestBodyContentApplicationJsonSchemaDataSeveranceOneOf0Type", "type": "string" }, "GpWorkersWorkerIdTerminationsPostRequestBodyContentApplicationJsonSchemaDataSeveranceOneOf1Type": { "description": "The type of severance, in cash.", "enum": [ "CASH" ], "title": "GpWorkersWorkerIdTerminationsPostRequestBodyContentApplicationJsonSchemaDataSeveranceOneOf1Type", "type": "string" }, "GpWorkersWorkerIdTerminationsPostResponsesContentApplicationJsonSchemaData": { "properties": { "id": { "description": "Unique identifier for the termination request.", "format": "uuid", "type": "string" }, "last_date_of_work": { "description": "Long date-time format following ISO-8601.", "format": "date-time", "type": "string" } }, "required": [ "id", "last_date_of_work" ], "title": "GpWorkersWorkerIdTerminationsPostResponsesContentApplicationJsonSchemaData", "type": "object" }, "GroupsGetParametersSortOrder": { "default": "ASC", "enum": [ "ASC", "DESC" ], "title": "GroupsGetParametersSortOrder", "type": "string" }, "GroupsGetResponsesContentApplicationJsonSchemaDataItems": { "properties": { "archived_at": { "description": "The timestamp when the group was archived (if applicable).", "format": "date-time", "type": [ "string", "null" ] }, "created_at": { "description": "The timestamp when the group was created.", "format": "date-time", "type": "string" }, "external_metadata": { "description": "Extra information about the group.", "oneOf": [ { "$ref": "#/components/schemas/GroupsGetResponsesContentApplicationJsonSchemaDataItemsExternalMetadata" }, { "type": "null" } ] }, "id": { "description": "The unique identifier of the group.", "type": "string" }, "managers": { "description": "The number of managers associated with the group.", "format": "double", "type": "number" }, "name": { "description": "The name of the group.", "type": "string" }, "status": { "$ref": "#/components/schemas/GroupsGetResponsesContentApplicationJsonSchemaDataItemsStatus", "description": "The current status of the group (active or archived)." }, "updated_at": { "description": "The timestamp when the group was last updated.", "format": "date-time", "type": "string" } }, "title": "GroupsGetResponsesContentApplicationJsonSchemaDataItems", "type": "object" }, "GroupsGetResponsesContentApplicationJsonSchemaDataItemsExternalMetadata": { "description": "Extra information about the group.", "properties": {}, "title": "GroupsGetResponsesContentApplicationJsonSchemaDataItemsExternalMetadata", "type": "object" }, "GroupsGetResponsesContentApplicationJsonSchemaDataItemsStatus": { "description": "The current status of the group (active or archived).", "enum": [ "active", "archived" ], "title": "GroupsGetResponsesContentApplicationJsonSchemaDataItemsStatus", "type": "string" }, "GroupsGetResponsesContentApplicationJsonSchemaPage": { "properties": { "cursor": { "description": "An opaque cursor to fetch the next set of results.", "type": [ "string", "null" ] }, "total_rows": { "description": "The total number of groups available for the current query (including pagination).", "type": "integer" } }, "title": "GroupsGetResponsesContentApplicationJsonSchemaPage", "type": "object" }, "GroupsIdClonePostRequestBodyContentApplicationJsonSchemaData": { "properties": { "external_metadata": { "$ref": "#/components/schemas/GroupsIdClonePostRequestBodyContentApplicationJsonSchemaDataExternalMetadata", "description": "The extra information of the group to be created." }, "name": { "description": "The name of the group to be created.", "maxLength": 48, "type": "string" } }, "required": [ "name" ], "title": "GroupsIdClonePostRequestBodyContentApplicationJsonSchemaData", "type": "object" }, "GroupsIdClonePostRequestBodyContentApplicationJsonSchemaDataExternalMetadata": { "description": "The extra information of the group to be created.", "properties": {}, "title": "GroupsIdClonePostRequestBodyContentApplicationJsonSchemaDataExternalMetadata", "type": "object" }, "GroupsIdClonePostResponsesContentApplicationJsonSchemaData": { "properties": { "created_at": { "description": "The timestamp when the group was created.", "format": "date-time", "type": "string" }, "external_metadata": { "$ref": "#/components/schemas/GroupsIdClonePostResponsesContentApplicationJsonSchemaDataExternalMetadata", "description": "Extra information of the group." }, "id": { "description": "The unique identifier of the created group.", "format": "uuid", "type": "string" }, "name": { "description": "The name of the created group.", "type": "string" }, "updated_at": { "description": "The timestamp when the group was last updated.", "format": "date-time", "type": "string" } }, "title": "GroupsIdClonePostResponsesContentApplicationJsonSchemaData", "type": "object" }, "GroupsIdClonePostResponsesContentApplicationJsonSchemaDataExternalMetadata": { "description": "Extra information of the group.", "properties": {}, "title": "GroupsIdClonePostResponsesContentApplicationJsonSchemaDataExternalMetadata", "type": "object" }, "GroupsIdClonePostResponsesContentApplicationJsonSchemaErrorsItems": { "properties": { "message": { "description": "A description of the returned error", "type": "string" } }, "title": "GroupsIdClonePostResponsesContentApplicationJsonSchemaErrorsItems", "type": "object" }, "GroupsIdDeleteResponsesContentApplicationJsonSchemaData": { "properties": { "archived_at": { "description": "The timestamp when the group was archived.", "format": "date-time", "type": "string" } }, "title": "GroupsIdDeleteResponsesContentApplicationJsonSchemaData", "type": "object" }, "GroupsIdDeleteResponsesContentApplicationJsonSchemaError": { "properties": { "message": { "description": "Group not found error message.", "type": "string" } }, "title": "GroupsIdDeleteResponsesContentApplicationJsonSchemaError", "type": "object" }, "GroupsIdPatchRequestBodyContentApplicationJsonSchemaData": { "properties": { "name": { "description": "The updated name of the group.", "maxLength": 48, "type": "string" } }, "required": [ "name" ], "title": "GroupsIdPatchRequestBodyContentApplicationJsonSchemaData", "type": "object" }, "GroupsIdPatchResponsesContentApplicationJsonSchemaData": { "properties": { "created_at": { "description": "The timestamp when the group was created.", "format": "date-time", "type": "string" }, "external_metadata": { "description": "Extra information of the group.", "oneOf": [ { "$ref": "#/components/schemas/GroupsIdPatchResponsesContentApplicationJsonSchemaDataExternalMetadata" }, { "type": "null" } ] }, "id": { "description": "The unique identifier of the updated group.", "type": "string" }, "name": { "description": "The updated name of the group.", "type": "string" }, "updated_at": { "description": "The timestamp when the group was last updated.", "format": "date-time", "type": "string" } }, "title": "GroupsIdPatchResponsesContentApplicationJsonSchemaData", "type": "object" }, "GroupsIdPatchResponsesContentApplicationJsonSchemaDataExternalMetadata": { "description": "Extra information of the group.", "properties": {}, "title": "GroupsIdPatchResponsesContentApplicationJsonSchemaDataExternalMetadata", "type": "object" }, "GroupsIdPatchResponsesContentApplicationJsonSchemaError": { "properties": { "message": { "description": "Description of the error.", "type": "string" } }, "title": "GroupsIdPatchResponsesContentApplicationJsonSchemaError", "type": "object" }, "GroupsPostRequestBodyContentApplicationJsonSchemaData": { "properties": { "external_metadata": { "description": "The extra information of the group to be created.", "oneOf": [ { "$ref": "#/components/schemas/GroupsPostRequestBodyContentApplicationJsonSchemaDataExternalMetadata" }, { "type": "null" } ] }, "name": { "description": "The name of the group to be created.", "maxLength": 48, "type": "string" } }, "required": [ "name" ], "title": "GroupsPostRequestBodyContentApplicationJsonSchemaData", "type": "object" }, "GroupsPostRequestBodyContentApplicationJsonSchemaDataExternalMetadata": { "description": "The extra information of the group to be created.", "properties": {}, "title": "GroupsPostRequestBodyContentApplicationJsonSchemaDataExternalMetadata", "type": "object" }, "GroupsPostResponsesContentApplicationJsonSchemaData": { "properties": { "created_at": { "description": "The timestamp when the group was created.", "format": "date-time", "type": "string" }, "external_metadata": { "description": "Extra information of the group.", "oneOf": [ { "$ref": "#/components/schemas/GroupsPostResponsesContentApplicationJsonSchemaDataExternalMetadata" }, { "type": "null" } ] }, "id": { "description": "The unique identifier of the created group.", "type": "string" }, "name": { "description": "The name of the created group.", "type": "string" }, "updated_at": { "description": "The timestamp when the group was last updated.", "format": "date-time", "type": "string" } }, "title": "GroupsPostResponsesContentApplicationJsonSchemaData", "type": "object" }, "GroupsPostResponsesContentApplicationJsonSchemaDataExternalMetadata": { "description": "Extra information of the group.", "properties": {}, "title": "GroupsPostResponsesContentApplicationJsonSchemaDataExternalMetadata", "type": "object" }, "GroupsPostResponsesContentApplicationJsonSchemaError": { "properties": { "message": { "description": "Description of the error.", "type": "string" } }, "title": "GroupsPostResponsesContentApplicationJsonSchemaError", "type": "object" }, "HRX_Documents_downloadHrxDocuments-v2026-01-01_Response_200": { "properties": { "data": { "$ref": "#/components/schemas/EorContractsContractIdHrxDocumentsDocumentIdGetResponsesContentApplicationJsonSchemaData", "description": "Download information for the HRX document" } }, "required": [ "data" ], "title": "HRX Documents_downloadHrxDocuments-v2026-01-01_Response_200", "type": "object" }, "HRX_Documents_retrieveHrxDocuments-v2026-01-01_Response_200": { "properties": { "data": { "description": "List of employee documents", "items": { "$ref": "#/components/schemas/EorContractsContractIdHrxDocumentsGetResponsesContentApplicationJsonSchemaDataItems" }, "type": "array" }, "has_more": { "description": "Indicates if there are more pages available", "type": "boolean" }, "next_cursor": { "description": "Cursor to use for the next page. Null if there are no more pages.", "type": [ "string", "null" ] }, "total_count": { "description": "Total number of documents available across all pages", "type": "integer" } }, "required": [ "data", "has_more", "next_cursor", "total_count" ], "title": "HRX Documents_retrieveHrxDocuments-v2026-01-01_Response_200", "type": "object" }, "HrisOrganizationStructuresExternalExternalIdGetResponsesContentApplicationJsonSchemaData": { "properties": { "enable_roles": { "description": "Flag to enable roles in the organization", "type": "boolean" }, "external_id": { "description": "External ID", "type": "string" }, "id": { "description": "Organization ID", "format": "uuid", "type": "string" }, "is_multiselect": { "description": "Flag to enable multiselect in the organization", "type": "boolean" }, "name": { "description": "Organization name", "type": "string" }, "roles": { "items": { "$ref": "#/components/schemas/HrisOrganizationStructuresExternalExternalIdGetResponsesContentApplicationJsonSchemaDataRolesItems" }, "type": "array" }, "teams": { "items": { "$ref": "#/components/schemas/HrisOrganizationStructuresExternalExternalIdGetResponsesContentApplicationJsonSchemaDataTeamsItems" }, "type": "array" }, "teams_count": { "description": "Number of teams in the organization", "type": "integer" }, "type": { "description": "Organization type", "type": "string" } }, "title": "HrisOrganizationStructuresExternalExternalIdGetResponsesContentApplicationJsonSchemaData", "type": "object" }, "HrisOrganizationStructuresExternalExternalIdGetResponsesContentApplicationJsonSchemaDataRolesItems": { "properties": { "id": { "description": "Role ID", "type": "integer" }, "name": { "description": "Role name", "type": "string" } }, "title": "HrisOrganizationStructuresExternalExternalIdGetResponsesContentApplicationJsonSchemaDataRolesItems", "type": "object" }, "HrisOrganizationStructuresExternalExternalIdGetResponsesContentApplicationJsonSchemaDataTeamsItems": { "properties": {}, "title": "HrisOrganizationStructuresExternalExternalIdGetResponsesContentApplicationJsonSchemaDataTeamsItems", "type": "object" }, "HrisOrganizationStructuresExternalExternalIdPatchRequestBodyContentApplicationJsonSchemaData": { "properties": { "enable_roles": { "description": "Enable roles", "type": "boolean" }, "external_id": { "description": "External ID", "type": "string" }, "is_multiselect": { "description": "Is multiselect", "type": "boolean" }, "name": { "description": "Name of the organization", "type": "string" }, "teams": { "items": { "$ref": "#/components/schemas/HrisOrganizationStructuresExternalExternalIdPatchRequestBodyContentApplicationJsonSchemaDataTeamsItems" }, "type": "array" } }, "required": [ "teams" ], "title": "HrisOrganizationStructuresExternalExternalIdPatchRequestBodyContentApplicationJsonSchemaData", "type": "object" }, "HrisOrganizationStructuresExternalExternalIdPatchRequestBodyContentApplicationJsonSchemaDataTeamsItems": { "properties": {}, "title": "HrisOrganizationStructuresExternalExternalIdPatchRequestBodyContentApplicationJsonSchemaDataTeamsItems", "type": "object" }, "HrisOrganizationStructuresExternalExternalIdPatchResponsesContentApplicationJsonSchemaErrorsItems": { "properties": { "code": { "type": "string" }, "field": { "type": "string" }, "message": { "type": "string" } }, "required": [ "code", "message" ], "title": "HrisOrganizationStructuresExternalExternalIdPatchResponsesContentApplicationJsonSchemaErrorsItems", "type": "object" }, "HrisOrganizationStructuresGetResponsesContentApplicationJsonSchemaDataItems": { "properties": { "created_at": { "description": "The date and time when the Org Structure was created.", "format": "date-time", "type": "string" }, "enable_roles": { "description": "Whether the Org Structure has Roles enabled.", "type": "boolean" }, "external_id": { "description": "The external identifier of the Org Structure.", "type": [ "string", "null" ] }, "id": { "description": "The unique identifier of the Org Structure.", "format": "uuid", "type": "string" }, "is_multiselect": { "description": "Whether the Org Structure is multiselect.", "type": "boolean" }, "name": { "description": "The name of the Org Structure.", "type": "string" }, "roles": { "items": { "$ref": "#/components/schemas/HrisOrganizationStructuresGetResponsesContentApplicationJsonSchemaDataItemsRolesItems" }, "type": "array" }, "teams": { "items": { "$ref": "#/components/schemas/HrisOrganizationStructuresGetResponsesContentApplicationJsonSchemaDataItemsTeamsItems" }, "type": "array" }, "teams_count": { "description": "The number of Teams in the Org Structure.", "type": "integer" }, "type": { "description": "The type of the Org Structure.", "type": "string" } }, "title": "HrisOrganizationStructuresGetResponsesContentApplicationJsonSchemaDataItems", "type": "object" }, "HrisOrganizationStructuresGetResponsesContentApplicationJsonSchemaDataItemsRolesItems": { "properties": { "id": { "description": "The unique identifier of the Role.", "format": "uuid", "type": "string" }, "name": { "description": "The name of the Role.", "type": "string" } }, "title": "HrisOrganizationStructuresGetResponsesContentApplicationJsonSchemaDataItemsRolesItems", "type": "object" }, "HrisOrganizationStructuresGetResponsesContentApplicationJsonSchemaDataItemsTeamsItems": { "properties": { "children": { "items": { "$ref": "#/components/schemas/HrisOrganizationStructuresGetResponsesContentApplicationJsonSchemaDataItemsTeamsItemsChildrenItems" }, "type": "array" }, "created_at": { "description": "The date and time when the Org Structure was created.", "format": "date-time", "type": "string" }, "external_id": { "description": "The external identifier of the Team.", "type": [ "string", "null" ] }, "id": { "description": "The unique identifier of the Team.", "format": "uuid", "type": "string" }, "name": { "description": "The name of the Team.", "type": "string" }, "name_route": { "description": "The route name of the Team.", "type": [ "string", "null" ] }, "parent": { "description": "The name of the parent Org Structure.", "type": [ "string", "null" ] } }, "title": "HrisOrganizationStructuresGetResponsesContentApplicationJsonSchemaDataItemsTeamsItems", "type": "object" }, "HrisOrganizationStructuresGetResponsesContentApplicationJsonSchemaDataItemsTeamsItemsChildrenItems": { "properties": {}, "title": "HrisOrganizationStructuresGetResponsesContentApplicationJsonSchemaDataItemsTeamsItemsChildrenItems", "type": "object" }, "HrisOrganizationStructuresHrisOrgStructureIdDeleteResponsesContentApplicationJsonSchemaErrorsItems": { "properties": { "code": { "description": "Machine-readable error code", "type": "string" }, "message": { "description": "Human-readable explanation of the error", "type": "string" } }, "title": "HrisOrganizationStructuresHrisOrgStructureIdDeleteResponsesContentApplicationJsonSchemaErrorsItems", "type": "object" }, "HrisOrganizationStructuresHrisOrgStructureIdGetResponsesContentApplicationJsonSchemaData": { "properties": { "enable_roles": { "description": "HRIS Organization Structure Enable Roles", "type": "boolean" }, "external_id": { "description": "HRIS Organization Structure External ID", "type": "string" }, "id": { "description": "HRIS Organization Structure ID", "format": "uuid", "type": "string" }, "is_multiselect": { "description": "HRIS Organization Structure Is Multiselect", "type": "boolean" }, "name": { "description": "HRIS Organization Structure Name", "type": "string" }, "roles": { "items": { "$ref": "#/components/schemas/HrisOrganizationStructuresHrisOrgStructureIdGetResponsesContentApplicationJsonSchemaDataRolesItems" }, "type": "array" }, "teams": { "items": { "$ref": "#/components/schemas/HrisOrganizationStructuresHrisOrgStructureIdGetResponsesContentApplicationJsonSchemaDataTeamsItems" }, "type": "array" }, "teams_count": { "description": "HRIS Organization Structure Teams Count", "type": "integer" }, "type": { "description": "HRIS Organization Structure Type", "type": "string" } }, "title": "HrisOrganizationStructuresHrisOrgStructureIdGetResponsesContentApplicationJsonSchemaData", "type": "object" }, "HrisOrganizationStructuresHrisOrgStructureIdGetResponsesContentApplicationJsonSchemaDataRolesItems": { "properties": { "id": { "description": "Role ID", "type": "integer" }, "name": { "description": "Role Name", "type": "string" } }, "title": "HrisOrganizationStructuresHrisOrgStructureIdGetResponsesContentApplicationJsonSchemaDataRolesItems", "type": "object" }, "HrisOrganizationStructuresHrisOrgStructureIdGetResponsesContentApplicationJsonSchemaDataTeamsItems": { "properties": {}, "title": "HrisOrganizationStructuresHrisOrgStructureIdGetResponsesContentApplicationJsonSchemaDataTeamsItems", "type": "object" }, "HrisOrganizationStructuresHrisOrgStructureIdGetResponsesContentApplicationJsonSchemaErrorsItems": { "properties": { "code": { "type": "string" }, "field": { "type": "string" }, "message": { "type": "string" } }, "required": [ "code", "message" ], "title": "HrisOrganizationStructuresHrisOrgStructureIdGetResponsesContentApplicationJsonSchemaErrorsItems", "type": "object" }, "HrisOrganizationStructuresHrisOrgStructureIdPatchRequestBodyContentApplicationJsonSchemaData": { "properties": { "enable_roles": { "description": "Enable roles for the Org Structure", "type": "boolean" }, "external_id": { "description": "External ID of the Org Structure", "type": "string" }, "is_multiselect": { "description": "Enable multiselect for the Org Structure", "type": "boolean" }, "name": { "description": "Name of the Org Structure", "type": "string" }, "teams": { "items": { "$ref": "#/components/schemas/HrisOrganizationStructuresHrisOrgStructureIdPatchRequestBodyContentApplicationJsonSchemaDataTeamsItems" }, "type": "array" } }, "required": [ "teams" ], "title": "HrisOrganizationStructuresHrisOrgStructureIdPatchRequestBodyContentApplicationJsonSchemaData", "type": "object" }, "HrisOrganizationStructuresHrisOrgStructureIdPatchRequestBodyContentApplicationJsonSchemaDataTeamsItems": { "properties": {}, "title": "HrisOrganizationStructuresHrisOrgStructureIdPatchRequestBodyContentApplicationJsonSchemaDataTeamsItems", "type": "object" }, "HrisOrganizationStructuresHrisOrgStructureIdPatchResponsesContentApplicationJsonSchemaErrorsItems": { "properties": { "code": { "description": "Machine-readable error code", "type": "string" }, "message": { "description": "Human-readable explanation of the error", "type": "string" } }, "title": "HrisOrganizationStructuresHrisOrgStructureIdPatchResponsesContentApplicationJsonSchemaErrorsItems", "type": "object" }, "HrisOrganizationStructuresPostRequestBodyContentApplicationJsonSchemaData": { "properties": { "enable_roles": { "default": true, "description": "Whether roles are enabled for the organization structure.", "type": "boolean" }, "external_id": { "description": "The external identifier of the organization structure.", "type": "string" }, "is_multiple_select": { "default": true, "description": "Whether multiple selection is enabled for the organization structure.", "type": "boolean" }, "name": { "description": "The name of the organization structure.", "type": "string" }, "teams": { "items": { "$ref": "#/components/schemas/HrisOrganizationStructuresPostRequestBodyContentApplicationJsonSchemaDataTeamsItems" }, "type": "array" } }, "title": "HrisOrganizationStructuresPostRequestBodyContentApplicationJsonSchemaData", "type": "object" }, "HrisOrganizationStructuresPostRequestBodyContentApplicationJsonSchemaDataTeamsItems": { "properties": { "external_id": { "description": "The external identifier of the team.", "type": "string" }, "name": { "description": "The name of the team.", "type": "string" } }, "title": "HrisOrganizationStructuresPostRequestBodyContentApplicationJsonSchemaDataTeamsItems", "type": "object" }, "HrisOrganizationStructuresPostResponsesContentApplicationJsonSchemaData": { "properties": { "created_at": { "description": "The date and time when the organization structure was created.", "format": "date-time", "type": "string" }, "enable_roles": { "description": "Whether roles are enabled for the organization structure.", "type": "boolean" }, "external_id": { "description": "The external identifier of the organization structure.", "type": "string" }, "id": { "description": "The unique identifier of the organization structure.", "type": "string" }, "is_multi_select": { "description": "Whether multiple selection is enabled for the organization structure.", "type": "boolean" }, "name": { "description": "The name of the organization structure.", "type": "string" }, "organization_id": { "description": "The unique identifier of the organization.", "type": "integer" }, "type": { "description": "The type of the organization structure.", "type": "string" }, "updated_at": { "description": "The date and time when the organization structure was last updated.", "format": "date-time", "type": "string" } }, "title": "HrisOrganizationStructuresPostResponsesContentApplicationJsonSchemaData", "type": "object" }, "HrisOrganizationStructuresPostResponsesContentApplicationJsonSchemaErrorsItems": { "properties": { "code": { "description": "Machine-readable error code", "type": "string" }, "message": { "description": "Human-readable explanation of the error", "type": "string" } }, "title": "HrisOrganizationStructuresPostResponsesContentApplicationJsonSchemaErrorsItems", "type": "object" }, "HrisPositionsApplyChangesPostRequestBodyContentApplicationJsonSchemaData": { "description": "The request payload containing the position changes to apply.", "properties": { "add": { "items": { "$ref": "#/components/schemas/HrisPositionsApplyChangesPostRequestBodyContentApplicationJsonSchemaDataAddItems" }, "type": "array" }, "delete": { "items": { "$ref": "#/components/schemas/HrisPositionsApplyChangesPostRequestBodyContentApplicationJsonSchemaDataDeleteItems" }, "type": "array" }, "edit": { "items": { "$ref": "#/components/schemas/HrisPositionsApplyChangesPostRequestBodyContentApplicationJsonSchemaDataEditItems" }, "type": "array" }, "profile_id": { "description": "Id of the profile to which the positions belong.", "format": "uuid", "type": "string" } }, "required": [ "profile_id" ], "title": "HrisPositionsApplyChangesPostRequestBodyContentApplicationJsonSchemaData", "type": "object" }, "HrisPositionsApplyChangesPostRequestBodyContentApplicationJsonSchemaDataAddItems": { "properties": { "is_supportive": { "description": "Flag to indicate if the position is supportive.", "type": "boolean" }, "role_id": { "description": "Id of the role to be assigned to the position.", "format": "uuid", "type": [ "string", "null" ] }, "team_id": { "description": "Id of the team to be assigned to the position.", "format": "uuid", "type": "string" } }, "required": [ "team_id" ], "title": "HrisPositionsApplyChangesPostRequestBodyContentApplicationJsonSchemaDataAddItems", "type": "object" }, "HrisPositionsApplyChangesPostRequestBodyContentApplicationJsonSchemaDataDeleteItems": { "properties": { "id": { "description": "Id of the position to be deleted.", "format": "uuid", "type": "string" } }, "required": [ "id" ], "title": "HrisPositionsApplyChangesPostRequestBodyContentApplicationJsonSchemaDataDeleteItems", "type": "object" }, "HrisPositionsApplyChangesPostRequestBodyContentApplicationJsonSchemaDataEditItems": { "properties": { "id": { "description": "Id of the position to be edited.", "format": "uuid", "type": "string" }, "is_supportive": { "description": "Flag to indicate if the position is supportive.", "type": "boolean" }, "role_id": { "description": "Id of the role to be assigned to the position.", "format": "uuid", "type": [ "string", "null" ] } }, "required": [ "id" ], "title": "HrisPositionsApplyChangesPostRequestBodyContentApplicationJsonSchemaDataEditItems", "type": "object" }, "HrisPositionsProfileHrisProfileIdGetResponsesContentApplicationJsonSchemaDataItems": { "properties": { "id": { "description": "HRIS Position ID", "format": "uuid", "type": "string" }, "is_supportive": { "description": "Is Supportive Position", "type": "boolean" }, "role": { "$ref": "#/components/schemas/HrisPositionsProfileHrisProfileIdGetResponsesContentApplicationJsonSchemaDataItemsRole" }, "team": { "$ref": "#/components/schemas/HrisPositionsProfileHrisProfileIdGetResponsesContentApplicationJsonSchemaDataItemsTeam" } }, "title": "HrisPositionsProfileHrisProfileIdGetResponsesContentApplicationJsonSchemaDataItems", "type": "object" }, "HrisPositionsProfileHrisProfileIdGetResponsesContentApplicationJsonSchemaDataItemsRole": { "properties": { "id": { "description": "Role ID", "format": "uuid", "type": "string" }, "name": { "description": "Role Name", "type": "string" } }, "title": "HrisPositionsProfileHrisProfileIdGetResponsesContentApplicationJsonSchemaDataItemsRole", "type": "object" }, "HrisPositionsProfileHrisProfileIdGetResponsesContentApplicationJsonSchemaDataItemsTeam": { "properties": { "id": { "description": "Team ID", "format": "uuid", "type": "string" }, "name": { "description": "Team Name", "type": "string" }, "organization_structure": { "$ref": "#/components/schemas/HrisPositionsProfileHrisProfileIdGetResponsesContentApplicationJsonSchemaDataItemsTeamOrganizationStructure" } }, "title": "HrisPositionsProfileHrisProfileIdGetResponsesContentApplicationJsonSchemaDataItemsTeam", "type": "object" }, "HrisPositionsProfileHrisProfileIdGetResponsesContentApplicationJsonSchemaDataItemsTeamOrganizationStructure": { "properties": { "id": { "description": "Organization Structure ID", "format": "uuid", "type": "string" }, "name": { "description": "Organization Structure Name", "type": "string" } }, "title": "HrisPositionsProfileHrisProfileIdGetResponsesContentApplicationJsonSchemaDataItemsTeamOrganizationStructure", "type": "object" }, "HrisPositionsProfileHrisProfileIdGetResponsesContentApplicationJsonSchemaErrorsItems": { "properties": { "code": { "type": "string" }, "field": { "type": "string" }, "message": { "type": "string" } }, "required": [ "code", "message" ], "title": "HrisPositionsProfileHrisProfileIdGetResponsesContentApplicationJsonSchemaErrorsItems", "type": "object" }, "HrisWorkerRelationsProfileExternalPostRequestBodyContentApplicationJsonSchemaData": { "properties": { "child_hris_profile_ids": { "description": "An array containing the secondary HrisProfiles external IDs and the relation external ID.", "items": { "$ref": "#/components/schemas/HrisWorkerRelationsProfileExternalPostRequestBodyContentApplicationJsonSchemaDataChildHrisProfileIdsItems" }, "type": "array" }, "hris_relationship_type_external_id": { "description": "The external ID of the Worker Relation Type.", "maxLength": 100, "type": "string" }, "parent_external_hris_profile_id": { "description": "Primary HrisProfile external ID", "maxLength": 100, "type": "string" } }, "required": [ "child_hris_profile_ids", "parent_external_hris_profile_id", "hris_relationship_type_external_id" ], "title": "HrisWorkerRelationsProfileExternalPostRequestBodyContentApplicationJsonSchemaData", "type": "object" }, "HrisWorkerRelationsProfileExternalPostRequestBodyContentApplicationJsonSchemaDataChildHrisProfileIdsItems": { "properties": { "external_hris_profile_id": { "description": "The external ID of the secondary HrisProfile.", "maxLength": 100, "type": "string" }, "relation_external_id": { "description": "A custom ID to set to the relation.", "maxLength": 100, "type": "string" } }, "required": [ "relation_external_id", "external_hris_profile_id" ], "title": "HrisWorkerRelationsProfileExternalPostRequestBodyContentApplicationJsonSchemaDataChildHrisProfileIdsItems", "type": "object" }, "HrisWorkerRelationsProfileExternalProfileIdChildPutRequestBodyContentApplicationJsonSchemaData": { "properties": { "child_hris_profile_ids": { "items": { "$ref": "#/components/schemas/HrisWorkerRelationsProfileExternalProfileIdChildPutRequestBodyContentApplicationJsonSchemaDataChildHrisProfileIdsItems" }, "type": "array" }, "hris_relationship_type_external_id": { "format": "uuid", "type": "string" } }, "required": [ "child_hris_profile_ids" ], "title": "HrisWorkerRelationsProfileExternalProfileIdChildPutRequestBodyContentApplicationJsonSchemaData", "type": "object" }, "HrisWorkerRelationsProfileExternalProfileIdChildPutRequestBodyContentApplicationJsonSchemaDataChildHrisProfileIdsItems": { "oneOf": [ { "$ref": "#/components/schemas/HrisWorkerRelationsProfileExternalProfileIdChildPutRequestBodyContentApplicationJsonSchemaDataChildHrisProfileIdsItems0" } ], "title": "HrisWorkerRelationsProfileExternalProfileIdChildPutRequestBodyContentApplicationJsonSchemaDataChildHrisProfileIdsItems" }, "HrisWorkerRelationsProfileExternalProfileIdChildPutRequestBodyContentApplicationJsonSchemaDataChildHrisProfileIdsItems0": { "properties": { "external_hris_profile_id": { "maxLength": 100, "type": "string" }, "relation_external_id": { "maxLength": 100, "type": "string" } }, "required": [ "relation_external_id", "external_hris_profile_id" ], "title": "HrisWorkerRelationsProfileExternalProfileIdChildPutRequestBodyContentApplicationJsonSchemaDataChildHrisProfileIdsItems0", "type": "object" }, "HrisWorkerRelationsProfileExternalProfileIdGetResponsesContentApplicationJsonSchemaDataItems": { "properties": { "child_relationships": { "description": "An array containing the information about the child profiles in the relation.", "items": { "$ref": "#/components/schemas/HrisWorkerRelationsProfileExternalProfileIdGetResponsesContentApplicationJsonSchemaDataItemsChildRelationshipsItems" }, "type": "array" }, "id": { "description": "The ID of the relation type", "format": "uuid", "type": "string" }, "is_default": { "description": "Whether this relation is default or not", "type": "boolean" }, "is_parent": { "description": "Whether this relation is the parent or not", "type": "boolean" }, "name": { "description": "The name of the relation type", "type": "string" }, "parent_relationship": { "$ref": "#/components/schemas/HrisWorkerRelationsProfileExternalProfileIdGetResponsesContentApplicationJsonSchemaDataItemsParentRelationship", "description": "An object that has information about the parent profile in the relation." } }, "title": "HrisWorkerRelationsProfileExternalProfileIdGetResponsesContentApplicationJsonSchemaDataItems", "type": "object" }, "HrisWorkerRelationsProfileExternalProfileIdGetResponsesContentApplicationJsonSchemaDataItemsChildRelationshipsItems": { "properties": { "external_id": { "description": "The external ID of the child profile", "type": "string" }, "first_name": { "description": "The first name of the child profile", "type": "string" }, "last_name": { "description": "The last name of the child profile", "type": "string" }, "profile_id": { "description": "The ID of the child profile", "format": "uuid", "type": "string" }, "relation_id": { "description": "The ID of the relation between the profiles", "format": "uuid", "type": "string" } }, "title": "HrisWorkerRelationsProfileExternalProfileIdGetResponsesContentApplicationJsonSchemaDataItemsChildRelationshipsItems", "type": "object" }, "HrisWorkerRelationsProfileExternalProfileIdGetResponsesContentApplicationJsonSchemaDataItemsParentRelationship": { "description": "An object that has information about the parent profile in the relation.", "properties": { "first_name": { "description": "The first name of the parent profile", "type": "string" }, "last_name": { "description": "The last name of the parent profile", "type": "string" }, "profile_external_id": { "description": "The external ID of the parent profile", "type": "string" }, "profile_id": { "description": "The ID of the parent profile", "format": "uuid", "type": "string" }, "relation_external_id": { "description": "The external ID of the relation", "type": "string" }, "relation_id": { "description": "The ID of the relation between the profiles", "format": "uuid", "type": "string" } }, "title": "HrisWorkerRelationsProfileExternalProfileIdGetResponsesContentApplicationJsonSchemaDataItemsParentRelationship", "type": "object" }, "HrisWorkerRelationsProfileExternalProfileIdGetResponsesContentApplicationJsonSchemaErrorsItems": { "properties": { "code": { "type": "string" }, "field": { "type": "string" }, "message": { "type": "string" } }, "required": [ "code", "message" ], "title": "HrisWorkerRelationsProfileExternalProfileIdGetResponsesContentApplicationJsonSchemaErrorsItems", "type": "object" }, "HrisWorkerRelationsProfileExternalProfileIdParentPutRequestBodyContentApplicationJsonSchemaData": { "description": "The request payload containing parent relationship details.", "properties": { "hris_relationship_type_external_id": { "description": "The external identifier of the relationship type to apply.", "maxLength": 100, "type": "string" }, "parent_profile_external_id": { "description": "The external identifier of the parent HRIS Profile. Pass null to remove the existing parent relationship.", "maxLength": 100, "type": [ "string", "null" ] }, "relation_external_id": { "description": "The external identifier for this specific relation record.", "maxLength": 100, "type": [ "string", "null" ] } }, "required": [ "parent_profile_external_id", "hris_relationship_type_external_id" ], "title": "HrisWorkerRelationsProfileExternalProfileIdParentPutRequestBodyContentApplicationJsonSchemaData", "type": "object" }, "HrisWorkerRelationsProfileExternalProfileIdParentPutResponsesContentApplicationJsonSchemaErrorsItems": { "properties": { "code": { "type": "string" }, "field": { "type": "string" }, "message": { "type": "string" } }, "required": [ "code", "message" ], "title": "HrisWorkerRelationsProfileExternalProfileIdParentPutResponsesContentApplicationJsonSchemaErrorsItems", "type": "object" }, "HrisWorkerRelationsProfileHrisProfileOidChildPutRequestBodyContentApplicationJsonSchemaData": { "properties": { "hris_relationship_type_id": { "description": "The ID of the relationship type", "format": "uuid", "type": "string" }, "ids": { "description": "An array containing the IDs of the child profiles", "items": { "format": "uuid", "type": "string" }, "type": "array" } }, "required": [ "ids", "hris_relationship_type_id" ], "title": "HrisWorkerRelationsProfileHrisProfileOidChildPutRequestBodyContentApplicationJsonSchemaData", "type": "object" }, "HrisWorkerRelationsProfileHrisProfileOidChildPutResponsesContentApplicationJsonSchemaErrorsItems": { "properties": { "code": { "type": "string" }, "field": { "type": "string" }, "message": { "type": "string" } }, "required": [ "code", "message" ], "title": "HrisWorkerRelationsProfileHrisProfileOidChildPutResponsesContentApplicationJsonSchemaErrorsItems", "type": "object" }, "HrisWorkerRelationsProfileHrisProfileOidGetResponsesContentApplicationJsonSchemaDataItems": { "properties": { "child_relationships": { "description": "An array containing the information about the child profiles in the relation.", "items": { "$ref": "#/components/schemas/HrisWorkerRelationsProfileHrisProfileOidGetResponsesContentApplicationJsonSchemaDataItemsChildRelationshipsItems" }, "type": "array" }, "id": { "description": "The ID of the relation type", "format": "uuid", "type": "string" }, "is_default": { "description": "Whether this relation is default or not", "type": "boolean" }, "is_parent": { "description": "Whether this relation is the parent or not", "type": "boolean" }, "name": { "description": "The name of the relation type", "type": "string" }, "parent_relationship": { "description": "An object that has information about the parent profile in the relation.", "oneOf": [ { "$ref": "#/components/schemas/HrisWorkerRelationsProfileHrisProfileOidGetResponsesContentApplicationJsonSchemaDataItemsParentRelationship" }, { "type": "null" } ] } }, "title": "HrisWorkerRelationsProfileHrisProfileOidGetResponsesContentApplicationJsonSchemaDataItems", "type": "object" }, "HrisWorkerRelationsProfileHrisProfileOidGetResponsesContentApplicationJsonSchemaDataItemsChildRelationshipsItems": { "properties": { "first_name": { "description": "The first name of the child profile", "type": "string" }, "last_name": { "description": "The last name of the child profile", "type": "string" }, "profile_id": { "description": "The ID of the child profile", "format": "uuid", "type": "string" }, "relation_id": { "description": "The ID of the relation between the profiles", "format": "uuid", "type": "string" } }, "title": "HrisWorkerRelationsProfileHrisProfileOidGetResponsesContentApplicationJsonSchemaDataItemsChildRelationshipsItems", "type": "object" }, "HrisWorkerRelationsProfileHrisProfileOidGetResponsesContentApplicationJsonSchemaDataItemsParentRelationship": { "description": "An object that has information about the parent profile in the relation.", "properties": { "first_name": { "description": "The first name of the parent profile", "type": "string" }, "last_name": { "description": "The last name of the parent profile", "type": "string" }, "profile_id": { "description": "The ID of the parent profile", "format": "uuid", "type": "string" }, "relation_id": { "description": "The ID of the relation between the profiles", "format": "uuid", "type": "string" } }, "title": "HrisWorkerRelationsProfileHrisProfileOidGetResponsesContentApplicationJsonSchemaDataItemsParentRelationship", "type": "object" }, "HrisWorkerRelationsProfileHrisProfileOidParentPutRequestBodyContentApplicationJsonSchemaData": { "properties": { "hris_relationship_type_id": { "description": "The ID of the relationship type", "format": "uuid", "type": "string" }, "id": { "description": "The ID of the parent profile", "format": "uuid", "type": "string" } }, "required": [ "id", "hris_relationship_type_id" ], "title": "HrisWorkerRelationsProfileHrisProfileOidParentPutRequestBodyContentApplicationJsonSchemaData", "type": "object" }, "HrisWorkerRelationsProfilePostRequestBodyContentApplicationJsonSchemaData": { "description": "The request payload containing the relationship details.", "properties": { "child_hris_profile_ids": { "description": "An array containing the secondary HrisProfiles IDs.", "items": { "format": "uuid", "type": "string" }, "type": "array" }, "hris_relationship_type_id": { "description": "The ID of the Worker Relation Type.", "format": "uuid", "type": "string" }, "parent_hris_profile_id": { "description": "Primary HrisProfile ID", "format": "uuid", "type": "string" } }, "required": [ "child_hris_profile_ids", "parent_hris_profile_id", "hris_relationship_type_id" ], "title": "HrisWorkerRelationsProfilePostRequestBodyContentApplicationJsonSchemaData", "type": "object" }, "HrisWorkerRelationsProfilePostResponsesContentApplicationJsonSchemaErrorsItems": { "properties": { "code": { "type": "string" }, "field": { "type": "string" }, "message": { "type": "string" } }, "required": [ "code", "message" ], "title": "HrisWorkerRelationsProfilePostResponsesContentApplicationJsonSchemaErrorsItems", "type": "object" }, "HrisWorkerRelationsTypesExternalExternalIdPatchRequestBodyContentApplicationJsonSchemaData": { "properties": { "child_name": { "description": "The name of the secondary party in the relationship", "maxLength": 100, "type": "string" }, "external_id": { "description": "A custom ID for the relation type", "maxLength": 100, "type": "string" }, "parent_name": { "description": "The name of the primary party in the relationship", "maxLength": 100, "type": "string" } }, "title": "HrisWorkerRelationsTypesExternalExternalIdPatchRequestBodyContentApplicationJsonSchemaData", "type": "object" }, "HrisWorkerRelationsTypesGetResponsesContentApplicationJsonSchemaDataItems": { "properties": { "child_name": { "description": "The name of the secondary party in the relationship", "type": "string" }, "external_id": { "description": "A custom ID for the relation type", "maxLength": 100, "type": [ "string", "null" ] }, "id": { "description": "The ID of the relation type", "format": "uuid", "type": "string" }, "is_default": { "description": "Whether this relation is default or not", "type": "boolean" }, "parent_name": { "description": "The name of the primary party in the relationship", "type": "string" } }, "title": "HrisWorkerRelationsTypesGetResponsesContentApplicationJsonSchemaDataItems", "type": "object" }, "HrisWorkerRelationsTypesGetResponsesContentApplicationJsonSchemaErrorsItems": { "properties": { "code": { "description": "Machine-readable error code", "type": "string" }, "message": { "description": "Human-readable explanation of the error", "type": "string" } }, "title": "HrisWorkerRelationsTypesGetResponsesContentApplicationJsonSchemaErrorsItems", "type": "object" }, "HrisWorkerRelationsTypesPostRequestBodyContentApplicationJsonSchemaData": { "properties": { "child_name": { "description": "The name of the secondary party in the relationship", "maxLength": 100, "type": "string" }, "external_id": { "description": "A custom ID for the relation type", "maxLength": 100, "type": "string" }, "is_default": { "default": false, "description": "Whether this relation is default or not", "type": "boolean" }, "parent_name": { "description": "The name of the primary party in the relationship", "maxLength": 100, "type": "string" } }, "title": "HrisWorkerRelationsTypesPostRequestBodyContentApplicationJsonSchemaData", "type": "object" }, "HrisWorkerRelationsTypesPostResponsesContentApplicationJsonSchemaData": { "properties": { "child_name": { "description": "The name of the secondary party in the relationship", "type": "string" }, "external_id": { "description": "A custom ID for the relation type", "type": "string" }, "id": { "description": "The ID of the relation type", "format": "uuid", "type": "string" }, "is_default": { "description": "Whether this relation is default or not", "type": "boolean" }, "parent_name": { "description": "The name of the primary party in the relationship", "type": "string" } }, "title": "HrisWorkerRelationsTypesPostResponsesContentApplicationJsonSchemaData", "type": "object" }, "HrisWorkerRelationsTypesPostResponsesContentApplicationJsonSchemaErrorsItems": { "properties": { "code": { "description": "Machine-readable error code", "type": "string" }, "message": { "description": "Human-readable explanation of the error", "type": "string" } }, "title": "HrisWorkerRelationsTypesPostResponsesContentApplicationJsonSchemaErrorsItems", "type": "object" }, "HrisWorkerRelationsTypesTypeIdDeleteResponsesContentApplicationJsonSchemaErrorsItems": { "properties": { "code": { "description": "Machine-readable error code", "type": "string" }, "message": { "description": "Human-readable explanation of the error", "type": "string" } }, "title": "HrisWorkerRelationsTypesTypeIdDeleteResponsesContentApplicationJsonSchemaErrorsItems", "type": "object" }, "HrisWorkerRelationsTypesTypeIdPatchRequestBodyContentApplicationJsonSchemaData": { "properties": { "child_name": { "description": "The name of the secondary party in the relationship", "maxLength": 100, "type": "string" }, "external_id": { "description": "A custom ID for the relation type", "maxLength": 100, "type": "string" }, "parent_name": { "description": "The name of the primary party in the relationship", "maxLength": 100, "type": "string" } }, "title": "HrisWorkerRelationsTypesTypeIdPatchRequestBodyContentApplicationJsonSchemaData", "type": "object" }, "HrisWorkersWorkerIdBanksGetResponsesContentApplicationJsonSchemaDataItems": { "properties": { "account_number": { "description": "Bank account number", "type": "string" }, "bank_name": { "description": "Bank name", "type": "string" }, "full_name": { "description": "Account holder name", "type": "string" }, "iban": { "description": "International Bank Account Number", "type": "string" }, "id": { "description": "Bank account ID", "type": "string" }, "status": { "description": "Account status", "type": "string" } }, "title": "HrisWorkersWorkerIdBanksGetResponsesContentApplicationJsonSchemaDataItems", "type": "object" }, "IC_invoicing_taxes_createIcInvoicingTax-v2026-01-01_Response_201": { "description": "Empty response body", "properties": {}, "title": "IC invoicing taxes_createIcInvoicingTax-v2026-01-01_Response_201", "type": "object" }, "IC_invoicing_taxes_getIcInvoicingTaxes-v2026-01-01_Response_200": { "properties": { "data": { "$ref": "#/components/schemas/ContractsContractIdIcInvoicingTaxesGetResponsesContentApplicationJsonSchemaData" } }, "title": "IC invoicing taxes_getIcInvoicingTaxes-v2026-01-01_Response_200", "type": "object" }, "IT_agreements_listItAgreements-v2026-09-15_Response_200": { "properties": { "data": { "items": { "$ref": "#/components/schemas/ItAgreementsGetResponsesContentApplicationJsonSchemaDataItems" }, "type": "array" }, "has_more": { "description": "Whether there are more results available", "type": "boolean" }, "next_cursor": { "description": "Cursor to the next page", "type": [ "string", "null" ] }, "total_count": { "description": "Total number of records", "format": "int64", "type": "integer" } }, "required": [ "data", "has_more", "next_cursor", "total_count" ], "title": "IT agreements_listItAgreements-v2026-09-15_Response_200", "type": "object" }, "IT_agreements_reassignItAgreement-v2026-09-17_Response_200": { "properties": { "data": { "$ref": "#/components/schemas/ItAgreementsAgreementIdReassignPostResponsesContentApplicationJsonSchemaData" } }, "required": [ "data" ], "title": "IT agreements_reassignItAgreement-v2026-09-17_Response_200", "type": "object" }, "IT_agreements_retrieveAnItAgreement-v2026-09-15_Response_200": { "properties": { "data": { "$ref": "#/components/schemas/ItAgreementsAgreementIdGetResponsesContentApplicationJsonSchemaData" } }, "required": [ "data" ], "title": "IT agreements_retrieveAnItAgreement-v2026-09-15_Response_200", "type": "object" }, "IT_assets_archiveAsset-v2026-09-17_Response_200": { "properties": { "data": { "$ref": "#/components/schemas/ItAssetsAssetIdArchivePostResponsesContentApplicationJsonSchemaData" } }, "required": [ "data" ], "title": "IT assets_archiveAsset-v2026-09-17_Response_200", "type": "object" }, "IT_assets_collectItAsset-v2026-09-15_Response_200": { "properties": { "data": { "$ref": "#/components/schemas/ItAssetsAssetIdCollectPostResponsesContentApplicationJsonSchemaData" } }, "required": [ "data" ], "title": "IT assets_collectItAsset-v2026-09-15_Response_200", "type": "object" }, "IT_assets_createAsset-v2026-09-15_Response_201": { "properties": { "data": { "$ref": "#/components/schemas/ItAssetsPostResponsesContentApplicationJsonSchemaData" } }, "required": [ "data" ], "title": "IT assets_createAsset-v2026-09-15_Response_201", "type": "object" }, "IT_assets_deliverItAsset-v2026-09-15_Response_200": { "properties": { "data": { "$ref": "#/components/schemas/ItAssetsAssetIdDeliverPostResponsesContentApplicationJsonSchemaData" } }, "required": [ "data" ], "title": "IT assets_deliverItAsset-v2026-09-15_Response_200", "type": "object" }, "IT_assets_enrolAssetIntoAddon-v2026-10-09_Response_200": { "properties": { "data": { "$ref": "#/components/schemas/ItAssetsAssetIdAddonsAddonIdAssignPostResponsesContentApplicationJsonSchemaData" } }, "required": [ "data" ], "title": "IT assets_enrolAssetIntoAddon-v2026-10-09_Response_200", "type": "object" }, "IT_assets_listItAssets-v2026-01-01_Response_200": { "properties": { "data": { "items": { "$ref": "#/components/schemas/ItAssetsGetResponsesContentApplicationJsonSchemaDataItems" }, "type": "array" }, "has_more": { "description": "Whether there are more results available", "type": "boolean" }, "next_cursor": { "description": "Cursor to the next page", "type": [ "string", "null" ] }, "total_count": { "description": "Total number of records", "format": "int64", "type": "integer" } }, "required": [ "data", "has_more", "next_cursor", "total_count" ], "title": "IT assets_listItAssets-v2026-01-01_Response_200", "type": "object" }, "IT_assets_retrieveAnItAsset-v2026-01-01_Response_200": { "properties": { "data": { "$ref": "#/components/schemas/ItAssetsAssetIdGetResponsesContentApplicationJsonSchemaData" } }, "required": [ "data" ], "title": "IT assets_retrieveAnItAsset-v2026-01-01_Response_200", "type": "object" }, "IT_assets_transferItAsset-v2026-09-17_Response_200": { "properties": { "data": { "$ref": "#/components/schemas/ItAssetsAssetIdTransferPostResponsesContentApplicationJsonSchemaData" } }, "required": [ "data" ], "title": "IT assets_transferItAsset-v2026-09-17_Response_200", "type": "object" }, "IT_assets_unarchiveAsset-v2026-09-17_Response_200": { "properties": { "data": { "$ref": "#/components/schemas/ItAssetsAssetIdUnarchivePostResponsesContentApplicationJsonSchemaData" } }, "required": [ "data" ], "title": "IT assets_unarchiveAsset-v2026-09-17_Response_200", "type": "object" }, "IT_assets_updateAsset-v2026-09-29_Response_200": { "properties": { "data": { "$ref": "#/components/schemas/ItAssetsAssetIdPatchResponsesContentApplicationJsonSchemaData" } }, "required": [ "data" ], "title": "IT assets_updateAsset-v2026-09-29_Response_200", "type": "object" }, "IT_assets_updateAssetLocation-v2026-09-15_Response_200": { "properties": { "data": { "$ref": "#/components/schemas/ItAssetsAssetIdLocationPostResponsesContentApplicationJsonSchemaData" } }, "required": [ "data" ], "title": "IT assets_updateAssetLocation-v2026-09-15_Response_200", "type": "object" }, "IT_orders_approveItOrder-v2026-09-30_Response_200": { "properties": { "data": { "$ref": "#/components/schemas/ItOrdersOrderIdApprovePostResponsesContentApplicationJsonSchemaData" } }, "required": [ "data" ], "title": "IT orders_approveItOrder-v2026-09-30_Response_200", "type": "object" }, "IT_orders_cancelItOrder-v2026-09-15_Response_200": { "properties": { "data": { "$ref": "#/components/schemas/ItOrdersOrderIdCancelPostResponsesContentApplicationJsonSchemaData" } }, "required": [ "data" ], "title": "IT orders_cancelItOrder-v2026-09-15_Response_200", "type": "object" }, "IT_orders_createItOrder-v2026-09-17_Response_201": { "properties": { "data": { "$ref": "#/components/schemas/ItOrdersPostResponsesContentApplicationJsonSchemaData" } }, "required": [ "data" ], "title": "IT orders_createItOrder-v2026-09-17_Response_201", "type": "object" }, "IT_orders_declineItOrder-v2026-09-30_Response_200": { "properties": { "data": { "$ref": "#/components/schemas/ItOrdersOrderIdDeclinePostResponsesContentApplicationJsonSchemaData" } }, "required": [ "data" ], "title": "IT orders_declineItOrder-v2026-09-30_Response_200", "type": "object" }, "IT_orders_listItOrders-v2026-01-01_Response_200": { "properties": { "data": { "items": { "$ref": "#/components/schemas/ItOrdersGetResponsesContentApplicationJsonSchemaDataItems" }, "type": "array" }, "has_more": { "description": "Whether there are more results available", "type": "boolean" }, "next_cursor": { "description": "Cursor to the next page", "type": [ "string", "null" ] }, "total_count": { "description": "Total number of records", "format": "int64", "type": "integer" } }, "required": [ "data", "has_more", "next_cursor", "total_count" ], "title": "IT orders_listItOrders-v2026-01-01_Response_200", "type": "object" }, "IT_orders_retrieveAnItOrder-v2026-01-01_Response_200": { "properties": { "data": { "$ref": "#/components/schemas/ItOrdersOrderIdGetResponsesContentApplicationJsonSchemaData" } }, "required": [ "data" ], "title": "IT orders_retrieveAnItOrder-v2026-01-01_Response_200", "type": "object" }, "IT_policies_listItHardwarePolicies-v2026-01-01_Response_200": { "properties": { "data": { "items": { "$ref": "#/components/schemas/ItPoliciesGetResponsesContentApplicationJsonSchemaDataItems" }, "type": "array" } }, "required": [ "data" ], "title": "IT policies_listItHardwarePolicies-v2026-01-01_Response_200", "type": "object" }, "IT_policies_listItPolicyUsers-v2026-09-17_Response_200": { "properties": { "data": { "items": { "$ref": "#/components/schemas/ItPoliciesPolicyIdUsersGetResponsesContentApplicationJsonSchemaDataItems" }, "type": "array" }, "has_more": { "description": "Whether there are more results available", "type": "boolean" }, "next_cursor": { "description": "Cursor to the next page", "type": [ "string", "null" ] }, "total_count": { "description": "Total number of records", "format": "int64", "type": "integer" } }, "required": [ "data", "has_more", "next_cursor", "total_count" ], "title": "IT policies_listItPolicyUsers-v2026-09-17_Response_200", "type": "object" }, "IT_policies_listItPolicyUsers-v2026-09-25_Response_200": { "properties": { "data": { "items": { "$ref": "#/components/schemas/ItPoliciesPolicyIdSeatsGetResponsesContentApplicationJsonSchemaDataItems" }, "type": "array" }, "has_more": { "description": "Whether there are more results available", "type": "boolean" }, "next_cursor": { "description": "Cursor to the next page", "type": [ "string", "null" ] }, "total_count": { "description": "Total number of records", "format": "int64", "type": "integer" } }, "required": [ "data", "has_more", "next_cursor", "total_count" ], "title": "IT policies_listItPolicyUsers-v2026-09-25_Response_200", "type": "object" }, "IT_products_listItProducts-v2026-09-17_Response_200": { "properties": { "data": { "items": { "$ref": "#/components/schemas/ItProductsGetResponsesContentApplicationJsonSchemaDataItems" }, "type": "array" }, "has_more": { "description": "Whether there are more results available", "type": "boolean" }, "next_cursor": { "description": "Cursor to the next page", "type": [ "string", "null" ] }, "total_count": { "description": "Total number of records", "format": "int64", "type": "integer" } }, "required": [ "data", "has_more", "next_cursor", "total_count" ], "title": "IT products_listItProducts-v2026-09-17_Response_200", "type": "object" }, "IT_products_retrieveAnItProduct-v2026-09-17_Response_200": { "properties": { "data": { "$ref": "#/components/schemas/ItProductsProductIdGetResponsesContentApplicationJsonSchemaData" } }, "required": [ "data" ], "title": "IT products_retrieveAnItProduct-v2026-09-17_Response_200", "type": "object" }, "IT_seats_listItSeats-v2026-09-25_Response_200": { "properties": { "data": { "items": { "$ref": "#/components/schemas/ItSeatsGetResponsesContentApplicationJsonSchemaDataItems" }, "type": "array" }, "has_more": { "description": "Whether there are more results available", "type": "boolean" }, "next_cursor": { "description": "Cursor to the next page", "type": [ "string", "null" ] }, "total_count": { "description": "Total number of records", "format": "int64", "type": "integer" } }, "required": [ "data", "has_more", "next_cursor", "total_count" ], "title": "IT seats_listItSeats-v2026-09-25_Response_200", "type": "object" }, "IT_seats_retrieveTheItSeatContract-v2026-09-25_Response_200": { "properties": { "data": { "$ref": "#/components/schemas/ItSeatsStatusGetResponsesContentApplicationJsonSchemaData" } }, "required": [ "data" ], "title": "IT seats_retrieveTheItSeatContract-v2026-09-25_Response_200", "type": "object" }, "IT_warehouses_listItWarehouses-v2026-09-15_Response_200": { "properties": { "data": { "items": { "$ref": "#/components/schemas/ItWarehousesGetResponsesContentApplicationJsonSchemaDataItems" }, "type": "array" }, "has_more": { "description": "Whether there are more results available", "type": "boolean" }, "next_cursor": { "description": "Cursor to the next page", "type": [ "string", "null" ] }, "total_count": { "description": "Total number of records", "format": "int64", "type": "integer" } }, "required": [ "data", "has_more", "next_cursor", "total_count" ], "title": "IT warehouses_listItWarehouses-v2026-09-15_Response_200", "type": "object" }, "IT_warehouses_retrieveAnItWarehouse-v2026-09-15_Response_200": { "properties": { "data": { "$ref": "#/components/schemas/ItWarehousesWarehouseIdGetResponsesContentApplicationJsonSchemaData" } }, "required": [ "data" ], "title": "IT warehouses_retrieveAnItWarehouse-v2026-09-15_Response_200", "type": "object" }, "IcWorkersInvoicesInvoiceIdGetResponsesContentApplicationJsonSchemaData": { "description": "Invoice summary (snake_case; display card fields, amounts, and payment display).", "properties": { "amount": { "description": "Amount before fees.", "type": [ "string", "null" ] }, "created_at": { "description": "When the invoice record was created (ISO-8601).", "format": "date-time", "type": "string" }, "currency": { "description": "Three-letter currency code.", "maxLength": 3, "minLength": 3, "pattern": "^[A-Z]{3}$", "type": "string" }, "id": { "description": "Public invoice id.", "type": "string" }, "issued_at": { "description": "When the invoice was issued, if applicable.", "format": "date-time", "type": [ "string", "null" ] }, "payment_display_status": { "$ref": "#/components/schemas/IcWorkersInvoicesInvoiceIdGetResponsesContentApplicationJsonSchemaDataPaymentDisplayStatus", "description": "Derived payment display state for the invoice." }, "status": { "description": "Invoice workflow status.", "type": "string" }, "title": { "description": "Display title.", "type": "string" }, "total": { "description": "Total including fees.", "type": [ "string", "null" ] } }, "required": [ "id", "status", "currency", "created_at" ], "title": "IcWorkersInvoicesInvoiceIdGetResponsesContentApplicationJsonSchemaData", "type": "object" }, "IcWorkersInvoicesInvoiceIdGetResponsesContentApplicationJsonSchemaDataPaymentDisplayStatus": { "description": "Derived payment display state for the invoice.", "properties": { "key": { "description": "Stable machine key.", "type": "string" }, "label": { "description": "Human-readable label.", "type": "string" } }, "required": [ "key", "label" ], "title": "IcWorkersInvoicesInvoiceIdGetResponsesContentApplicationJsonSchemaDataPaymentDisplayStatus", "type": "object" }, "IcWorkersInvoicesInvoiceIdGetResponsesContentApplicationJsonSchemaErrorsItems": { "properties": { "code": { "description": "Machine-readable error code.", "type": "string" }, "details": { "additionalProperties": { "description": "Any type" }, "description": "Optional structured context for the error.", "type": "object" }, "field": { "description": "JSON pointer to the invalid field, when applicable.", "type": "string" }, "message": { "description": "Human-readable explanation of the error.", "type": "string" } }, "required": [ "code", "message" ], "title": "IcWorkersInvoicesInvoiceIdGetResponsesContentApplicationJsonSchemaErrorsItems", "type": "object" }, "IcWorkersInvoicesInvoiceIdGetResponsesContentApplicationJsonSchemaRequest": { "description": "Present for some public API responses (e.g. when `x-is-api-call` is set).", "properties": { "method": { "type": "string" }, "status": { "type": "integer" }, "url": { "type": "string" } }, "title": "IcWorkersInvoicesInvoiceIdGetResponsesContentApplicationJsonSchemaRequest", "type": "object" }, "IcWorkersInvoicesInvoiceIdPdf-v2026-01-01RequestBadRequestError": { "properties": { "errors": { "items": { "$ref": "#/components/schemas/IcWorkersInvoicesInvoiceIdPdfGetResponsesContentApplicationJsonSchemaErrorsItems" }, "type": "array" } }, "required": [ "errors" ], "title": "IcWorkersInvoicesInvoiceIdPdf-v2026-01-01RequestBadRequestError", "type": "object" }, "IcWorkersInvoicesInvoiceIdPdf-v2026-01-01RequestForbiddenError": { "properties": { "errors": { "items": { "$ref": "#/components/schemas/IcWorkersInvoicesInvoiceIdPdfGetResponsesContentApplicationJsonSchemaErrorsItems" }, "type": "array" }, "request": { "$ref": "#/components/schemas/IcWorkersInvoicesInvoiceIdPdfGetResponsesContentApplicationJsonSchemaRequest", "description": "Present for some public API responses (e.g. when x-is-api-call is set)." } }, "required": [ "errors" ], "title": "IcWorkersInvoicesInvoiceIdPdf-v2026-01-01RequestForbiddenError", "type": "object" }, "IcWorkersInvoicesInvoiceIdPdf-v2026-01-01RequestInternalServerError": { "properties": { "errors": { "items": { "$ref": "#/components/schemas/IcWorkersInvoicesInvoiceIdPdfGetResponsesContentApplicationJsonSchemaErrorsItems" }, "type": "array" } }, "required": [ "errors" ], "title": "IcWorkersInvoicesInvoiceIdPdf-v2026-01-01RequestInternalServerError", "type": "object" }, "IcWorkersInvoicesInvoiceIdPdf-v2026-01-01RequestPreconditionFailedError": { "properties": { "errors": { "items": { "$ref": "#/components/schemas/IcWorkersInvoicesInvoiceIdPdfGetResponsesContentApplicationJsonSchemaErrorsItems" }, "type": "array" } }, "required": [ "errors" ], "title": "IcWorkersInvoicesInvoiceIdPdf-v2026-01-01RequestPreconditionFailedError", "type": "object" }, "IcWorkersInvoicesInvoiceIdPdf-v2026-01-01RequestUnauthorizedError": { "properties": { "errors": { "items": { "$ref": "#/components/schemas/IcWorkersInvoicesInvoiceIdPdfGetResponsesContentApplicationJsonSchemaErrorsItems" }, "type": "array" } }, "required": [ "errors" ], "title": "IcWorkersInvoicesInvoiceIdPdf-v2026-01-01RequestUnauthorizedError", "type": "object" }, "IcWorkersInvoicesInvoiceIdPdfGetResponsesContentApplicationJsonSchemaData": { "description": "Payload with the signed download URL.", "properties": { "url": { "description": "HTTPS URL to download the invoice PDF.", "format": "uri", "type": "string" } }, "required": [ "url" ], "title": "IcWorkersInvoicesInvoiceIdPdfGetResponsesContentApplicationJsonSchemaData", "type": "object" }, "IcWorkersInvoicesInvoiceIdPdfGetResponsesContentApplicationJsonSchemaErrorsItems": { "properties": { "code": { "type": "string" }, "details": { "additionalProperties": { "description": "Any type" }, "type": "object" }, "field": { "type": "string" }, "message": { "type": "string" } }, "required": [ "code", "message" ], "title": "IcWorkersInvoicesInvoiceIdPdfGetResponsesContentApplicationJsonSchemaErrorsItems", "type": "object" }, "IcWorkersInvoicesInvoiceIdPdfGetResponsesContentApplicationJsonSchemaRequest": { "description": "Present for some public API responses (e.g. when x-is-api-call is set).", "properties": { "method": { "type": "string" }, "status": { "type": "integer" }, "url": { "type": "string" } }, "title": "IcWorkersInvoicesInvoiceIdPdfGetResponsesContentApplicationJsonSchemaRequest", "type": "object" }, "ImmigrationCasesCaseIdTimelineGetParametersXBeta": { "default": "true", "enum": [ "true" ], "title": "ImmigrationCasesCaseIdTimelineGetParametersXBeta", "type": "string" }, "ImmigrationCasesCaseIdTimelineGetResponsesContentApplicationJsonSchemaData": { "properties": { "ongoing_actions": { "description": "Number of actions currently waiting on the client or the employee.", "type": "integer" }, "processes": { "description": "Processes of the case in order.", "items": { "$ref": "#/components/schemas/ImmigrationCasesCaseIdTimelineGetResponsesContentApplicationJsonSchemaDataProcessesItems" }, "type": "array" } }, "required": [ "processes", "ongoing_actions" ], "title": "ImmigrationCasesCaseIdTimelineGetResponsesContentApplicationJsonSchemaData", "type": "object" }, "ImmigrationCasesCaseIdTimelineGetResponsesContentApplicationJsonSchemaDataProcessesItems": { "properties": { "id": { "description": "The unique identifier of the process.", "type": "string" }, "name": { "description": "Display name of the process.", "type": "string" }, "state": { "$ref": "#/components/schemas/ImmigrationCasesCaseIdTimelineGetResponsesContentApplicationJsonSchemaDataProcessesItemsState", "description": "Whether the process is not started, active or completed." }, "steps": { "description": "Steps of the process in order.", "items": { "$ref": "#/components/schemas/ImmigrationCasesCaseIdTimelineGetResponsesContentApplicationJsonSchemaDataProcessesItemsStepsItems" }, "type": "array" } }, "required": [ "id", "name", "state", "steps" ], "title": "ImmigrationCasesCaseIdTimelineGetResponsesContentApplicationJsonSchemaDataProcessesItems", "type": "object" }, "ImmigrationCasesCaseIdTimelineGetResponsesContentApplicationJsonSchemaDataProcessesItemsState": { "description": "Whether the process is not started, active or completed.", "enum": [ "ACTIVE", "COMPLETED", "NOT_STARTED" ], "title": "ImmigrationCasesCaseIdTimelineGetResponsesContentApplicationJsonSchemaDataProcessesItemsState", "type": "string" }, "ImmigrationCasesCaseIdTimelineGetResponsesContentApplicationJsonSchemaDataProcessesItemsStepsItems": { "properties": { "actions": { "description": "Actions attached to the step, earliest due first.", "items": { "$ref": "#/components/schemas/ImmigrationCasesCaseIdTimelineGetResponsesContentApplicationJsonSchemaDataProcessesItemsStepsItemsActionsItems" }, "type": "array" }, "activated_at": { "description": "UTC timestamp when the step became active. Null while the step has not started.", "format": "date-time", "type": [ "string", "null" ] }, "completed_at": { "description": "UTC timestamp when the step was completed. Null while the step is open.", "format": "date-time", "type": [ "string", "null" ] }, "id": { "description": "The unique identifier of the step.", "type": "string" }, "name": { "description": "Display name of the step.", "type": "string" }, "state": { "$ref": "#/components/schemas/ImmigrationCasesCaseIdTimelineGetResponsesContentApplicationJsonSchemaDataProcessesItemsStepsItemsState", "description": "Whether the step is not started, active or completed." } }, "required": [ "id", "name", "state", "actions", "activated_at", "completed_at" ], "title": "ImmigrationCasesCaseIdTimelineGetResponsesContentApplicationJsonSchemaDataProcessesItemsStepsItems", "type": "object" }, "ImmigrationCasesCaseIdTimelineGetResponsesContentApplicationJsonSchemaDataProcessesItemsStepsItemsActionsItems": { "properties": { "completed_at": { "description": "UTC timestamp when the action was completed. Null while the action is open.", "format": "date-time", "type": [ "string", "null" ] }, "description": { "description": "What the assigned party has to do.", "type": "string" }, "due_date": { "description": "UTC timestamp by which the action is expected to be completed.", "format": "date-time", "type": [ "string", "null" ] }, "id": { "description": "The unique identifier of the action.", "type": [ "string", "null" ] }, "name": { "description": "Short title of the action.", "type": [ "string", "null" ] }, "status": { "description": "Progress of the action.", "oneOf": [ { "$ref": "#/components/schemas/ImmigrationCasesCaseIdTimelineGetResponsesContentApplicationJsonSchemaDataProcessesItemsStepsItemsActionsItemsStatus" }, { "type": "null" } ] }, "type": { "$ref": "#/components/schemas/ImmigrationCasesCaseIdTimelineGetResponsesContentApplicationJsonSchemaDataProcessesItemsStepsItemsActionsItemsType", "description": "The kind of action expected from the assigned party." }, "user_type": { "$ref": "#/components/schemas/ImmigrationCasesCaseIdTimelineGetResponsesContentApplicationJsonSchemaDataProcessesItemsStepsItemsActionsItemsUserType", "description": "The party expected to complete the action: the client organization or the employee." } }, "required": [ "id", "name", "type", "status", "due_date", "user_type", "description", "completed_at" ], "title": "ImmigrationCasesCaseIdTimelineGetResponsesContentApplicationJsonSchemaDataProcessesItemsStepsItemsActionsItems", "type": "object" }, "ImmigrationCasesCaseIdTimelineGetResponsesContentApplicationJsonSchemaDataProcessesItemsStepsItemsActionsItemsStatus": { "description": "Progress of the action.", "enum": [ "TODO", "ONGOING", "COMPLETED", "ARCHIVED" ], "title": "ImmigrationCasesCaseIdTimelineGetResponsesContentApplicationJsonSchemaDataProcessesItemsStepsItemsActionsItemsStatus", "type": "string" }, "ImmigrationCasesCaseIdTimelineGetResponsesContentApplicationJsonSchemaDataProcessesItemsStepsItemsActionsItemsType": { "description": "The kind of action expected from the assigned party.", "enum": [ "FILL_FORM", "REVIEW_REOPENED_FORM", "DOWNLOAD_BUSINESS_LETTER", "AGENT_REVIEW_BUSINESS_LETTER", "CLIENT_REVIEW_BUSINESS_LETTER", "GENERATE_BUSINESS_VISA_LETTER", "AGENT_REVIEW", "CLIENT_REVIEW_DOCUMENT", "AGENT_STATUS_UPDATE", "QUOTE_CREATE", "QUOTE_DRAFT", "QUOTE_APPROVAL", "QUOTE_PAYMENT_REQUEST", "QUOTE_REJECTED", "QUOTE_APPROVAL_EMPLOYEE", "UPLOAD_DOCUMENT", "UPLOAD_ADDITIONAL_DOCUMENT", "FILL_ADDITIONAL_FORM", "AGENT_ADD_SALESFORCE_URL", "AGENT_STATUS_UPDATE_SLA_BREACH", "FILL_REQUIRED_ROLES", "REVIEW_SUBMITTED_FORM", "REVIEW_FORM", "REVIEW_UPLOADED_DOCUMENT", "REVIEW_ZENDESK_COMMENT", "SIGNATURE_PENDING", "PETITION_AI_REVIEW", "AMENDMENT_DETAIL_REVIEW", "REVIEW_GOOGLE_DOCUMENT", "PAY_INVOICE_ACTION", "ESTIMATED_COMPLETION", "REVIEW_VENDOR_ASSIGNMENT", "UPDATE_VISA_TYPE", "CUSTOM_TASK", "AGENT_ADD_USCIS_RECEIPT_NUMBER", "AGENT_ADD_SHIPPING_NUMBER", "IDENTITY_VERIFICATION", "IDENTITY_VERIFICATION_VERIFF", "IDENTITY_VERIFICATION_REVIEW", "SEND_VISA_APPLICATION_QUOTE", "REVIEW_VISA_APPLICATION_QUOTE", "COMPLIANCE_VERIFF", "RTW_VERIFICATION_DOCUMENT_REVIEW", "UPLOAD_REQUIRED_DOCUMENT", "REVIEW_REQUIRED_DOCUMENT", "ADD_BUSINESS_VISA_DETAILS", "ADD_UK_SHARECODE", "RUN_AI_AGENT", "REVIEW_VISA_AUTOMATION_PAYLOAD", "PRE_HIRE_DOCUMENT_REVIEW", "ACKNOWLEDGE_CONTENT", "PETITION_AUTONOMOUS_BUILD", "PAY_MILESTONE_INVOICE", "AGENT_ADD_RFE_DEADLINE" ], "title": "ImmigrationCasesCaseIdTimelineGetResponsesContentApplicationJsonSchemaDataProcessesItemsStepsItemsActionsItemsType", "type": "string" }, "ImmigrationCasesCaseIdTimelineGetResponsesContentApplicationJsonSchemaDataProcessesItemsStepsItemsActionsItemsUserType": { "description": "The party expected to complete the action: the client organization or the employee.", "enum": [ "CLIENT", "APPLICANT" ], "title": "ImmigrationCasesCaseIdTimelineGetResponsesContentApplicationJsonSchemaDataProcessesItemsStepsItemsActionsItemsUserType", "type": "string" }, "ImmigrationCasesCaseIdTimelineGetResponsesContentApplicationJsonSchemaDataProcessesItemsStepsItemsState": { "description": "Whether the step is not started, active or completed.", "enum": [ "ACTIVE", "COMPLETED", "NOT_STARTED" ], "title": "ImmigrationCasesCaseIdTimelineGetResponsesContentApplicationJsonSchemaDataProcessesItemsStepsItemsState", "type": "string" }, "ImmigrationCasesCaseIdTimelineGetResponsesContentApplicationJsonSchemaErrorsItems": { "properties": { "code": { "description": "The error code.", "type": "string" }, "message": { "description": "Human-readable explanation of the error.", "type": "string" } }, "title": "ImmigrationCasesCaseIdTimelineGetResponsesContentApplicationJsonSchemaErrorsItems", "type": "object" }, "ImmigrationClientCasesGetParametersStatusesSchemaItems": { "enum": [ "OPEN", "ON_HOLD", "CLOSED" ], "title": "ImmigrationClientCasesGetParametersStatusesSchemaItems", "type": "string" }, "ImmigrationClientCasesGetResponsesContentApplicationJsonSchemaDataItems": { "properties": { "applicant": { "description": "Applicant associated with the immigration case.", "oneOf": [ { "$ref": "#/components/schemas/ImmigrationClientCasesGetResponsesContentApplicationJsonSchemaDataItemsApplicant" }, { "type": "null" } ] }, "case_type": { "$ref": "#/components/schemas/ImmigrationClientCasesGetResponsesContentApplicationJsonSchemaDataItemsCaseType", "description": "Type of immigration case." }, "closure": { "description": "Closure details of the case if the case has been closed.", "oneOf": [ { "$ref": "#/components/schemas/ImmigrationClientCasesGetResponsesContentApplicationJsonSchemaDataItemsClosure" }, { "type": "null" } ] }, "created_at": { "description": "Timestamp indicating when the case was created.", "format": "date-time", "type": "string" }, "id": { "description": "Unique identifier of the immigration case.", "format": "uuid", "type": "string" }, "process": { "$ref": "#/components/schemas/ImmigrationClientCasesGetResponsesContentApplicationJsonSchemaDataItemsProcess", "description": "Current active process associated with the case." }, "status": { "$ref": "#/components/schemas/ImmigrationClientCasesGetResponsesContentApplicationJsonSchemaDataItemsStatus", "description": "Current lifecycle status of the immigration case." }, "updated_at": { "description": "Timestamp indicating when the case was last updated.", "format": "date-time", "type": "string" } }, "required": [ "id", "status", "closure", "process", "applicant", "case_type", "created_at", "updated_at" ], "title": "ImmigrationClientCasesGetResponsesContentApplicationJsonSchemaDataItems", "type": "object" }, "ImmigrationClientCasesGetResponsesContentApplicationJsonSchemaDataItemsApplicant": { "description": "Applicant associated with the immigration case.", "properties": { "id": { "description": "Unique identifier of the applicant.", "format": "uuid", "type": [ "string", "null" ] }, "name": { "description": "Full name of the applicant.", "maxLength": 255, "type": "string" } }, "required": [ "name" ], "title": "ImmigrationClientCasesGetResponsesContentApplicationJsonSchemaDataItemsApplicant", "type": "object" }, "ImmigrationClientCasesGetResponsesContentApplicationJsonSchemaDataItemsCaseType": { "description": "Type of immigration case.", "properties": { "id": { "description": "Unique identifier of the case type.", "format": "uuid", "type": "string" }, "name": { "description": "Human-readable name of the case type.", "maxLength": 255, "type": "string" } }, "required": [ "id", "name" ], "title": "ImmigrationClientCasesGetResponsesContentApplicationJsonSchemaDataItemsCaseType", "type": "object" }, "ImmigrationClientCasesGetResponsesContentApplicationJsonSchemaDataItemsClosure": { "description": "Closure details of the case if the case has been closed.", "properties": { "note": { "description": "Additional notes explaining the case closure.", "maxLength": 400, "type": [ "string", "null" ] }, "reason": { "description": "Reason why the immigration case was closed.", "oneOf": [ { "$ref": "#/components/schemas/ImmigrationClientCasesGetResponsesContentApplicationJsonSchemaDataItemsClosureReason" }, { "type": "null" } ] } }, "required": [ "note", "reason" ], "title": "ImmigrationClientCasesGetResponsesContentApplicationJsonSchemaDataItemsClosure", "type": "object" }, "ImmigrationClientCasesGetResponsesContentApplicationJsonSchemaDataItemsClosureReason": { "description": "Reason why the immigration case was closed.", "enum": [ "CONTRACT_CANCELLED", "NATIONALITY_CHANGE", "NEW_CASE_TYPE_IS_REQUIRED", "ONBOARDING_RELEASED", "TERMINATION_REVERSED", "CONVERTED_TO_VISA_APPLICATION", "OTHER" ], "title": "ImmigrationClientCasesGetResponsesContentApplicationJsonSchemaDataItemsClosureReason", "type": "string" }, "ImmigrationClientCasesGetResponsesContentApplicationJsonSchemaDataItemsProcess": { "description": "Current active process associated with the case.", "properties": { "id": { "description": "Unique identifier of the current process.", "format": "uuid", "type": "string" }, "name": { "description": "Human-readable name of the current process step.", "maxLength": 255, "type": "string" }, "status": { "$ref": "#/components/schemas/ImmigrationClientCasesGetResponsesContentApplicationJsonSchemaDataItemsProcessStatus", "description": "Current status of the process." } }, "required": [ "id", "name", "status" ], "title": "ImmigrationClientCasesGetResponsesContentApplicationJsonSchemaDataItemsProcess", "type": "object" }, "ImmigrationClientCasesGetResponsesContentApplicationJsonSchemaDataItemsProcessStatus": { "description": "Current status of the process.", "properties": { "id": { "description": "Unique identifier of the process status.", "format": "uuid", "type": [ "string", "null" ] }, "name": { "description": "Human-readable name of the process status.", "maxLength": 255, "type": [ "string", "null" ] } }, "required": [ "id", "name" ], "title": "ImmigrationClientCasesGetResponsesContentApplicationJsonSchemaDataItemsProcessStatus", "type": "object" }, "ImmigrationClientCasesGetResponsesContentApplicationJsonSchemaDataItemsStatus": { "description": "Current lifecycle status of the immigration case.", "enum": [ "OPEN", "CLOSED", "ON_HOLD" ], "title": "ImmigrationClientCasesGetResponsesContentApplicationJsonSchemaDataItemsStatus", "type": "string" }, "ImmigrationClientCasesGetResponsesContentApplicationJsonSchemaErrorsItems": { "properties": { "code": { "description": "Machine-readable error code", "type": "string" }, "message": { "description": "Human-readable explanation of the error", "type": "string" } }, "title": "ImmigrationClientCasesGetResponsesContentApplicationJsonSchemaErrorsItems", "type": "object" }, "ImmigrationClientCasesIdGetResponsesContentApplicationJsonSchemaData": { "properties": { "applicant": { "oneOf": [ { "$ref": "#/components/schemas/ImmigrationClientCasesIdGetResponsesContentApplicationJsonSchemaDataApplicant" }, { "type": "null" } ] }, "case_created_at": { "description": "Creation date of the immigration case.", "format": "date-time", "type": "string" }, "case_type": { "description": "Name of the case type", "type": "string" }, "country_code": { "description": "The country of the immigration case.", "type": "string" }, "documents": { "items": { "$ref": "#/components/schemas/ImmigrationClientCasesIdGetResponsesContentApplicationJsonSchemaDataDocumentsItems" }, "type": "array" }, "estimated_completion_date": { "description": "Estimated completion date of the immigration case.", "format": "date-time", "type": [ "string", "null" ] }, "id": { "description": "Unique identifier of immigration case.", "type": "string" }, "last_update_at": { "description": "Last activity on the immigration case.", "format": "date-time", "type": "string" }, "process": { "$ref": "#/components/schemas/ImmigrationClientCasesIdGetResponsesContentApplicationJsonSchemaDataProcess" }, "status": { "$ref": "#/components/schemas/ImmigrationClientCasesIdGetResponsesContentApplicationJsonSchemaDataStatus", "description": "Status of the immigration case." }, "visa_type": { "description": "The type of the the visa.", "type": [ "string", "null" ] } }, "title": "ImmigrationClientCasesIdGetResponsesContentApplicationJsonSchemaData", "type": "object" }, "ImmigrationClientCasesIdGetResponsesContentApplicationJsonSchemaDataApplicant": { "properties": { "external_id": { "description": "External identifier of the applicant.", "type": [ "string", "null" ] }, "id": { "description": "Unique identifier of the applicant profile id.", "type": "string" } }, "title": "ImmigrationClientCasesIdGetResponsesContentApplicationJsonSchemaDataApplicant", "type": "object" }, "ImmigrationClientCasesIdGetResponsesContentApplicationJsonSchemaDataDocumentsItems": { "properties": { "document_type": { "description": "The type of the document. Represents the visa type for right to work cases.", "type": [ "string", "null" ] }, "expiration_date": { "description": "Expiry date of the document.", "format": "date-time", "type": [ "string", "null" ] }, "id": { "description": "Unique identifier of the document.", "type": "string" }, "status": { "$ref": "#/components/schemas/ImmigrationClientCasesIdGetResponsesContentApplicationJsonSchemaDataDocumentsItemsStatus", "description": "Status of the document." } }, "title": "ImmigrationClientCasesIdGetResponsesContentApplicationJsonSchemaDataDocumentsItems", "type": "object" }, "ImmigrationClientCasesIdGetResponsesContentApplicationJsonSchemaDataDocumentsItemsStatus": { "description": "Status of the document.", "enum": [ "IN_REVIEW", "ACTIVE", "EXPIRED", "EXPIRING", "UNKNOWN" ], "title": "ImmigrationClientCasesIdGetResponsesContentApplicationJsonSchemaDataDocumentsItemsStatus", "type": "string" }, "ImmigrationClientCasesIdGetResponsesContentApplicationJsonSchemaDataProcess": { "properties": { "id": { "description": "Unique identifier of the current active process.", "type": "string" }, "name": { "description": "Name of the current active process.", "type": "string" }, "status": { "description": "Status of the current active process.", "type": "string" } }, "title": "ImmigrationClientCasesIdGetResponsesContentApplicationJsonSchemaDataProcess", "type": "object" }, "ImmigrationClientCasesIdGetResponsesContentApplicationJsonSchemaDataStatus": { "description": "Status of the immigration case.", "enum": [ "OPEN", "CLOSED", "ON_HOLD" ], "title": "ImmigrationClientCasesIdGetResponsesContentApplicationJsonSchemaDataStatus", "type": "string" }, "ImmigrationClientCasesIdGetResponsesContentApplicationJsonSchemaErrorsItems": { "properties": { "code": { "description": "Machine-readable error code", "type": "string" }, "message": { "description": "Human-readable explanation of the error", "type": "string" } }, "title": "ImmigrationClientCasesIdGetResponsesContentApplicationJsonSchemaErrorsItems", "type": "object" }, "ImmigrationClientCasesPostRequestBodyContentApplicationJsonSchemaData": { "oneOf": [ { "$ref": "#/components/schemas/ImmigrationClientCasesPostRequestBodyContentApplicationJsonSchemaData0" }, { "$ref": "#/components/schemas/ImmigrationClientCasesPostRequestBodyContentApplicationJsonSchemaData1" }, { "$ref": "#/components/schemas/ImmigrationClientCasesPostRequestBodyContentApplicationJsonSchemaData2" }, { "$ref": "#/components/schemas/ImmigrationClientCasesPostRequestBodyContentApplicationJsonSchemaData3" }, { "$ref": "#/components/schemas/ImmigrationClientCasesPostRequestBodyContentApplicationJsonSchemaData4" }, { "$ref": "#/components/schemas/ImmigrationClientCasesPostRequestBodyContentApplicationJsonSchemaData5" } ], "title": "ImmigrationClientCasesPostRequestBodyContentApplicationJsonSchemaData" }, "ImmigrationClientCasesPostRequestBodyContentApplicationJsonSchemaData0": { "properties": { "case_type": { "$ref": "#/components/schemas/ImmigrationClientCasesPostRequestBodyContentApplicationJsonSchemaDataOneOf0CaseType", "description": "The type of immigration case to be created. Determines the workflow and requirements" }, "contract_id": { "description": "The contract object identifier. Required for document reviews and visa applications", "maxLength": 20, "type": "string" }, "country_code": { "description": "ISO 3166-1 alpha-2 country code where the immigration case needs to be processed", "maxLength": 2, "type": "string" } }, "required": [ "case_type", "contract_id", "country_code" ], "title": "ImmigrationClientCasesPostRequestBodyContentApplicationJsonSchemaData0", "type": "object" }, "ImmigrationClientCasesPostRequestBodyContentApplicationJsonSchemaData1": { "properties": { "case_type": { "$ref": "#/components/schemas/ImmigrationClientCasesPostRequestBodyContentApplicationJsonSchemaDataOneOf1CaseType", "description": "The type of immigration case to be created. Determines the workflow and requirements" }, "contract_id": { "description": "The contract object identifier. Required for document reviews and visa applications", "maxLength": 20, "type": "string" }, "country_code": { "description": "ISO 3166-1 alpha-2 country code where the immigration case needs to be processed", "maxLength": 2, "type": "string" }, "visa_type_id": { "description": "The id of visa type that is being applied for. Identifies the type of the visa.", "format": "uuid", "type": "string" } }, "required": [ "case_type", "contract_id", "country_code" ], "title": "ImmigrationClientCasesPostRequestBodyContentApplicationJsonSchemaData1", "type": "object" }, "ImmigrationClientCasesPostRequestBodyContentApplicationJsonSchemaData2": { "properties": { "case_type": { "$ref": "#/components/schemas/ImmigrationClientCasesPostRequestBodyContentApplicationJsonSchemaDataOneOf2CaseType", "description": "The type of immigration case to be created. Determines the workflow and requirements" }, "contract_id": { "description": "The contract object identifier. Required for document reviews and visa applications", "maxLength": 20, "type": "string" }, "country_code": { "description": "ISO 3166-1 alpha-2 country code where the immigration case needs to be processed", "maxLength": 2, "type": "string" }, "entity_id": { "description": "The unique identifier of the entity sponsoring the visa. Required for sponsored visa applications", "format": "uuid", "type": "string" }, "visa_type_id": { "description": "The id of visa type that is being applied for. Identifies the type of the visa.", "format": "uuid", "type": "string" } }, "required": [ "case_type", "entity_id", "contract_id", "country_code" ], "title": "ImmigrationClientCasesPostRequestBodyContentApplicationJsonSchemaData2", "type": "object" }, "ImmigrationClientCasesPostRequestBodyContentApplicationJsonSchemaData3": { "properties": { "case_type": { "$ref": "#/components/schemas/ImmigrationClientCasesPostRequestBodyContentApplicationJsonSchemaDataOneOf3CaseType", "description": "The type of immigration case to be created. Determines the workflow and requirements" }, "country_code": { "description": "ISO 3166-1 alpha-2 country code where the immigration case needs to be processed", "maxLength": 2, "type": "string" }, "team_id": { "description": "The unique identifier of the team for which the pre-hire visa case is being created", "format": "uuid", "type": "string" }, "visa_type_id": { "description": "The id of visa type that is being applied for. Identifies the type of the visa.", "format": "uuid", "type": "string" } }, "required": [ "team_id", "case_type", "country_code" ], "title": "ImmigrationClientCasesPostRequestBodyContentApplicationJsonSchemaData3", "type": "object" }, "ImmigrationClientCasesPostRequestBodyContentApplicationJsonSchemaData4": { "properties": { "case_type": { "$ref": "#/components/schemas/ImmigrationClientCasesPostRequestBodyContentApplicationJsonSchemaDataOneOf4CaseType", "description": "The type of immigration case to be created. Determines the workflow and requirements" }, "country_code": { "description": "ISO 3166-1 alpha-2 country code where the immigration case needs to be processed", "maxLength": 2, "type": "string" }, "entity_id": { "description": "The unique identifier of the entity sponsoring the visa. Required for sponsored visa applications", "format": "uuid", "type": "string" }, "team_id": { "description": "The unique identifier of the team for which the pre-hire sponsorship visa case is being created", "format": "uuid", "type": "string" }, "visa_type_id": { "description": "The id of visa type that is being applied for. Identifies the type of the visa.", "format": "uuid", "type": "string" } }, "required": [ "team_id", "case_type", "country_code" ], "title": "ImmigrationClientCasesPostRequestBodyContentApplicationJsonSchemaData4", "type": "object" }, "ImmigrationClientCasesPostRequestBodyContentApplicationJsonSchemaData5": { "properties": { "case_type": { "$ref": "#/components/schemas/ImmigrationClientCasesPostRequestBodyContentApplicationJsonSchemaDataOneOf5CaseType", "description": "The type of immigration case to be created. Determines the workflow and requirements" }, "contract_id": { "description": "The contract object identifier. If not provided, team_id is required and employee_details must include first_name, last_name, and email.", "maxLength": 20, "type": "string" }, "country_code": { "description": "ISO 3166-1 alpha-2 country code where the immigration case needs to be processed", "maxLength": 2, "type": "string" }, "employee_details": { "$ref": "#/components/schemas/ImmigrationClientCasesPostRequestBodyContentApplicationJsonSchemaDataOneOf5EmployeeDetails", "description": "Employee information. Citizenships and residence attributes are always required for business visa cases. The remaining fields are only required when no contract_id is present." }, "entity_id": { "description": "The unique identifier of the entity sponsoring the visa. Required for sponsored visa applications", "format": "uuid", "type": "string" }, "team_id": { "description": "The id of the team for which the employee will be added to. Required if contract_id is not provided", "format": "uuid", "type": "string" }, "travel_information": { "$ref": "#/components/schemas/ImmigrationClientCasesPostRequestBodyContentApplicationJsonSchemaDataOneOf5TravelInformation", "description": "Travel details for the business visa" }, "visa_type_id": { "description": "The id of visa type that is being applied for. Identifies the type of the visa", "format": "uuid", "type": "string" } }, "required": [ "case_type", "country_code", "visa_type_id", "employee_details", "travel_information" ], "title": "ImmigrationClientCasesPostRequestBodyContentApplicationJsonSchemaData5", "type": "object" }, "ImmigrationClientCasesPostRequestBodyContentApplicationJsonSchemaDataOneOf0CaseType": { "description": "The type of immigration case to be created. Determines the workflow and requirements", "enum": [ "RIGHT_TO_WORK" ], "title": "ImmigrationClientCasesPostRequestBodyContentApplicationJsonSchemaDataOneOf0CaseType", "type": "string" }, "ImmigrationClientCasesPostRequestBodyContentApplicationJsonSchemaDataOneOf1CaseType": { "description": "The type of immigration case to be created. Determines the workflow and requirements", "enum": [ "EOR_VISA" ], "title": "ImmigrationClientCasesPostRequestBodyContentApplicationJsonSchemaDataOneOf1CaseType", "type": "string" }, "ImmigrationClientCasesPostRequestBodyContentApplicationJsonSchemaDataOneOf2CaseType": { "description": "The type of immigration case to be created. Determines the workflow and requirements", "enum": [ "SPONSORED_VISA" ], "title": "ImmigrationClientCasesPostRequestBodyContentApplicationJsonSchemaDataOneOf2CaseType", "type": "string" }, "ImmigrationClientCasesPostRequestBodyContentApplicationJsonSchemaDataOneOf3CaseType": { "description": "The type of immigration case to be created. Determines the workflow and requirements", "enum": [ "PRE_HIRE_EOR_VISA" ], "title": "ImmigrationClientCasesPostRequestBodyContentApplicationJsonSchemaDataOneOf3CaseType", "type": "string" }, "ImmigrationClientCasesPostRequestBodyContentApplicationJsonSchemaDataOneOf4CaseType": { "description": "The type of immigration case to be created. Determines the workflow and requirements", "enum": [ "PRE_HIRE_SPONSORSHIP_VISA" ], "title": "ImmigrationClientCasesPostRequestBodyContentApplicationJsonSchemaDataOneOf4CaseType", "type": "string" }, "ImmigrationClientCasesPostRequestBodyContentApplicationJsonSchemaDataOneOf5CaseType": { "description": "The type of immigration case to be created. Determines the workflow and requirements", "enum": [ "BUSINESS_VISA" ], "title": "ImmigrationClientCasesPostRequestBodyContentApplicationJsonSchemaDataOneOf5CaseType", "type": "string" }, "ImmigrationClientCasesPostRequestBodyContentApplicationJsonSchemaDataOneOf5EmployeeDetails": { "description": "Employee information. Citizenships and residence attributes are always required for business visa cases. The remaining fields are only required when no contract_id is present.", "properties": { "citizenships": { "description": "List of ISO 3166-1 alpha-2 country codes representing employee's citizenships", "items": { "maxLength": 2, "minLength": 2, "type": "string" }, "type": "array" }, "email": { "description": "Employee's email address. Required if contract_id is not provided", "format": "email", "maxLength": 255, "minLength": 3, "type": "string" }, "first_name": { "description": "Employee's first name. Required if contract_id is not provided", "maxLength": 100, "minLength": 3, "type": "string" }, "last_name": { "description": "Employee's last name. Required if contract_id is not provided", "maxLength": 100, "minLength": 3, "type": "string" }, "residence": { "description": "ISO 3166-1 alpha-2 country code of employee's current residence", "maxLength": 2, "minLength": 2, "type": "string" } }, "required": [ "residence", "citizenships" ], "title": "ImmigrationClientCasesPostRequestBodyContentApplicationJsonSchemaDataOneOf5EmployeeDetails", "type": "object" }, "ImmigrationClientCasesPostRequestBodyContentApplicationJsonSchemaDataOneOf5TravelInformation": { "description": "Travel details for the business visa", "properties": { "end_date": { "description": "Trip end date in YYYY-MM-DD format", "format": "date", "type": "string" }, "purpose": { "$ref": "#/components/schemas/ImmigrationClientCasesPostRequestBodyContentApplicationJsonSchemaDataOneOf5TravelInformationPurpose", "description": "The purpose of the business trip" }, "start_date": { "description": "Trip start date in YYYY-MM-DD format", "format": "date", "type": "string" } }, "required": [ "purpose", "end_date", "start_date" ], "title": "ImmigrationClientCasesPostRequestBodyContentApplicationJsonSchemaDataOneOf5TravelInformation", "type": "object" }, "ImmigrationClientCasesPostRequestBodyContentApplicationJsonSchemaDataOneOf5TravelInformationPurpose": { "description": "The purpose of the business trip", "enum": [ "INTERNAL_BUSINESS_WITH_WORK_FOR_CLIENT", "INTERNAL_BUSINESS_WITHOUT_WORK_FOR_CLIENT", "MEETINGS_WITH_OR_FOR_A_CLIENT", "MEETINGS_WITH_POTENTIAL_CLIENTS", "NEGOTIATING_CONTRACTS_OR_SIGNING_AGREEMENTS", "OTHER_EXTERNAL_BUSINESS", "CONFERENCE", "TEAM_OFFSITE", "SPEAKING_AT_CONFERENCE_UNPAID", "SPEAKING_AT_CONFERENCE_PAID", "ATTENDING_INTERNAL_TRAINING", "ATTENDING_EXTERNAL_TRAINING", "DELIVERING_TRAINING_TO_INTERNAL_PARTICIPANTS", "DELIVERING_TRAINING_TO_EXTERNAL_PARTICIPANTS_UNPAID", "DELIVERING_TRAINING_TO_EXTERNAL_PARTICIPANTS_PAID", "PARTICIPATION_IN_RESEARCH_PROJECTS_AND_STUDIES", "ASSEMBLY_MAINTENANCE_REPAIR_INSTALLATION", "TECHNICAL_SUPPORT_OR_SUPERVISION", "OTHER_HANDS_ON_LABOUR", "MARKET_RESEARCH_AND_EXPLORING_INVESTMENT_OPPORTUNITIES", "OTHER" ], "title": "ImmigrationClientCasesPostRequestBodyContentApplicationJsonSchemaDataOneOf5TravelInformationPurpose", "type": "string" }, "ImmigrationClientCasesPostResponsesContentApplicationJsonSchemaData": { "description": "The immigration case data returned after successful creation", "properties": { "closure_note": { "description": "Optional note explaining why the case was closed", "maxLength": 400, "type": [ "string", "null" ] }, "closure_reason": { "description": "Standardized reason for case closure", "type": [ "string", "null" ] }, "created_at": { "description": "Timestamp when the case was created", "format": "date-time", "type": "string" }, "id": { "description": "Unique identifier for the case", "format": "uuid", "type": "string" }, "process": { "$ref": "#/components/schemas/ImmigrationClientCasesPostResponsesContentApplicationJsonSchemaDataProcess", "description": "Details about the current immigration process associated with the case" }, "status": { "$ref": "#/components/schemas/ImmigrationClientCasesPostResponsesContentApplicationJsonSchemaDataStatus", "description": "Current status of the case" }, "updated_at": { "description": "Timestamp when the case was last updated", "format": "date-time", "type": "string" } }, "required": [ "id", "status", "process", "created_at", "updated_at" ], "title": "ImmigrationClientCasesPostResponsesContentApplicationJsonSchemaData", "type": "object" }, "ImmigrationClientCasesPostResponsesContentApplicationJsonSchemaDataProcess": { "description": "Details about the current immigration process associated with the case", "properties": { "id": { "description": "Unique identifier for the process", "format": "uuid", "type": "string" }, "process_name": { "description": "Name of the immigration process", "type": "string" }, "status_name": { "description": "Human-readable status of the process", "type": "string" } }, "required": [ "id", "status_name", "process_name" ], "title": "ImmigrationClientCasesPostResponsesContentApplicationJsonSchemaDataProcess", "type": "object" }, "ImmigrationClientCasesPostResponsesContentApplicationJsonSchemaDataStatus": { "description": "Current status of the case", "enum": [ "OPEN", "CLOSED", "ON_HOLD" ], "title": "ImmigrationClientCasesPostResponsesContentApplicationJsonSchemaDataStatus", "type": "string" }, "ImmigrationClientCasesPostResponsesContentApplicationJsonSchemaErrorsItems": { "properties": { "code": { "description": "Machine-readable error code", "type": "string" }, "message": { "description": "Human-readable explanation of the error", "type": "string" } }, "title": "ImmigrationClientCasesPostResponsesContentApplicationJsonSchemaErrorsItems", "type": "object" }, "ImmigrationDocument-v2026-01-01RequestBadRequestError": { "properties": { "errors": { "items": { "$ref": "#/components/schemas/ImmigrationDocumentsIdGetResponsesContentApplicationJsonSchemaErrorsItems" }, "type": "array" } }, "title": "ImmigrationDocument-v2026-01-01RequestBadRequestError", "type": "object" }, "ImmigrationDocument-v2026-01-01RequestInternalServerError": { "properties": { "errors": { "items": { "$ref": "#/components/schemas/ImmigrationDocumentsIdGetResponsesContentApplicationJsonSchemaErrorsItems" }, "type": "array" } }, "title": "ImmigrationDocument-v2026-01-01RequestInternalServerError", "type": "object" }, "ImmigrationDocumentsIdGetResponsesContentApplicationJsonSchemaData": { "properties": { "document_type": { "description": "The type of the document. Represents the visa type for right to work cases.", "type": [ "string", "null" ] }, "download_link": { "description": "S3 download link of all the files uploaded within current document record.", "items": { "type": "string" }, "type": "array" }, "expiration_date": { "description": "Expiry date of the document.", "format": "date-time", "type": [ "string", "null" ] }, "id": { "description": "The UUID of document entity.", "type": "string" }, "status": { "description": "Current status of the document.", "oneOf": [ { "$ref": "#/components/schemas/ImmigrationDocumentsIdGetResponsesContentApplicationJsonSchemaDataStatus" }, { "type": "null" } ] } }, "title": "ImmigrationDocumentsIdGetResponsesContentApplicationJsonSchemaData", "type": "object" }, "ImmigrationDocumentsIdGetResponsesContentApplicationJsonSchemaDataStatus": { "description": "Current status of the document.", "enum": [ "IN_REVIEW", "APPROVED", "REJECTED" ], "title": "ImmigrationDocumentsIdGetResponsesContentApplicationJsonSchemaDataStatus", "type": "string" }, "ImmigrationDocumentsIdGetResponsesContentApplicationJsonSchemaErrorsItems": { "properties": { "code": { "description": "Machine-readable error code", "type": "string" }, "message": { "description": "Human-readable explanation of the error", "type": "string" } }, "title": "ImmigrationDocumentsIdGetResponsesContentApplicationJsonSchemaErrorsItems", "type": "object" }, "ImmigrationInvoicesGetParametersXBeta": { "default": "true", "enum": [ "true" ], "title": "ImmigrationInvoicesGetParametersXBeta", "type": "string" }, "ImmigrationInvoicesGetResponsesContentApplicationJsonSchemaDataItems": { "properties": { "amount": { "description": "Invoiced amount in the invoice currency.", "format": "double", "type": "number" }, "currency": { "description": "ISO 4217 currency code of the invoiced amount.", "type": "string" }, "due_date": { "description": "UTC timestamp by which the invoice is due.", "format": "date-time", "type": "string" }, "id": { "description": "The public identifier of the invoice, as shown in the Deel platform.", "type": "string" }, "is_paid": { "description": "Whether the invoice has been settled.", "type": "boolean" }, "issued_at": { "description": "UTC timestamp when the invoice was issued.", "format": "date-time", "type": "string" }, "paid_at": { "description": "UTC timestamp when the invoice was paid. Null while unpaid.", "format": "date-time", "type": [ "string", "null" ] }, "quote_id": { "description": "The unique identifier of the quote the invoice was issued for.", "format": "uuid", "type": "string" }, "status": { "$ref": "#/components/schemas/ImmigrationInvoicesGetResponsesContentApplicationJsonSchemaDataItemsStatus", "description": "Payment status of the invoice." } }, "required": [ "id", "amount", "status", "is_paid", "paid_at", "currency", "due_date", "quote_id", "issued_at" ], "title": "ImmigrationInvoicesGetResponsesContentApplicationJsonSchemaDataItems", "type": "object" }, "ImmigrationInvoicesGetResponsesContentApplicationJsonSchemaDataItemsStatus": { "description": "Payment status of the invoice.", "enum": [ "PENDING", "PROCESSING", "PREPROCESSING", "PAID", "CANCELLED", "OPEN", "AWAITING_PAYMENT", "FAILED", "SKIPPED", "UNPAYABLE", "REFUNDED", "PROCESSED", "CREDITED" ], "title": "ImmigrationInvoicesGetResponsesContentApplicationJsonSchemaDataItemsStatus", "type": "string" }, "ImmigrationInvoicesGetResponsesContentApplicationJsonSchemaErrorsItems": { "properties": { "code": { "description": "The error code.", "type": "string" }, "message": { "description": "Human-readable explanation of the error.", "type": "string" } }, "title": "ImmigrationInvoicesGetResponsesContentApplicationJsonSchemaErrorsItems", "type": "object" }, "ImmigrationNotesGetResponsesContentApplicationJsonSchemaDataItems": { "properties": { "created_at": { "description": "UTC timestamp when the note was created.", "format": "date-time", "type": "string" }, "id": { "description": "The unique identifier of the note.", "type": "string" }, "message": { "description": "Note content.", "type": "string" }, "note_type": { "$ref": "#/components/schemas/ImmigrationNotesGetResponsesContentApplicationJsonSchemaDataItemsNoteType", "description": "The type of note. Only externally-visible note types are returned by this endpoint." } }, "required": [ "id", "message", "note_type", "created_at" ], "title": "ImmigrationNotesGetResponsesContentApplicationJsonSchemaDataItems", "type": "object" }, "ImmigrationNotesGetResponsesContentApplicationJsonSchemaDataItemsNoteType": { "description": "The type of note. Only externally-visible note types are returned by this endpoint.", "enum": [ "EXTERNAL", "USCIS_STATUS_UPDATE" ], "title": "ImmigrationNotesGetResponsesContentApplicationJsonSchemaDataItemsNoteType", "type": "string" }, "ImmigrationNotesGetResponsesContentApplicationJsonSchemaErrorsItems": { "properties": { "code": { "description": "The error code.", "type": "string" }, "message": { "description": "Human-readable explanation of the error.", "type": "string" } }, "title": "ImmigrationNotesGetResponsesContentApplicationJsonSchemaErrorsItems", "type": "object" }, "ImmigrationVisaApplicationQuotesGetParametersXBeta": { "default": "true", "enum": [ "true" ], "title": "ImmigrationVisaApplicationQuotesGetParametersXBeta", "type": "string" }, "ImmigrationVisaApplicationQuotesGetResponsesContentApplicationJsonSchemaDataItems": { "properties": { "case_id": { "description": "The unique identifier of the eligibility check case the visa application quote was proposed on.", "format": "uuid", "type": "string" }, "created_at": { "description": "UTC timestamp when the visa application quote was created.", "format": "date-time", "type": "string" }, "description": { "description": "Approval details of the visa application quote.", "type": [ "string", "null" ] }, "due_date": { "description": "UTC timestamp by which the quoted fees are due once approved.", "format": "date-time", "type": [ "string", "null" ] }, "generated_case_id": { "description": "The unique identifier of the visa application case opened when the visa application quote was approved. Null while it is in review.", "format": "uuid", "type": [ "string", "null" ] }, "id": { "description": "The unique identifier of the visa application quote.", "format": "uuid", "type": "string" }, "items": { "description": "The fees that make up the visa application quote.", "items": { "$ref": "#/components/schemas/ImmigrationVisaApplicationQuotesGetResponsesContentApplicationJsonSchemaDataItemsItemsItems" }, "type": "array" }, "status": { "$ref": "#/components/schemas/ImmigrationVisaApplicationQuotesGetResponsesContentApplicationJsonSchemaDataItemsStatus", "description": "IN_REVIEW while the visa application quote waits for the organization to approve it, APPROVED once approved." }, "updated_at": { "description": "UTC timestamp of the last change to the visa application quote.", "format": "date-time", "type": "string" } }, "required": [ "id", "items", "status", "case_id", "due_date", "created_at", "updated_at", "description", "generated_case_id" ], "title": "ImmigrationVisaApplicationQuotesGetResponsesContentApplicationJsonSchemaDataItems", "type": "object" }, "ImmigrationVisaApplicationQuotesGetResponsesContentApplicationJsonSchemaDataItemsItemsItems": { "properties": { "amount": { "description": "Amount of the fee.", "format": "double", "type": "number" }, "currency": { "description": "ISO 4217 currency code of the fee.", "type": "string" }, "description": { "description": "Description of the quoted fee.", "type": [ "string", "null" ] }, "name": { "description": "Name of the quoted fee.", "type": [ "string", "null" ] } }, "required": [ "name", "amount", "currency", "description" ], "title": "ImmigrationVisaApplicationQuotesGetResponsesContentApplicationJsonSchemaDataItemsItemsItems", "type": "object" }, "ImmigrationVisaApplicationQuotesGetResponsesContentApplicationJsonSchemaDataItemsStatus": { "description": "IN_REVIEW while the visa application quote waits for the organization to approve it, APPROVED once approved.", "enum": [ "IN_REVIEW", "APPROVED" ], "title": "ImmigrationVisaApplicationQuotesGetResponsesContentApplicationJsonSchemaDataItemsStatus", "type": "string" }, "ImmigrationVisaApplicationQuotesGetResponsesContentApplicationJsonSchemaErrorsItems": { "properties": { "code": { "description": "The error code.", "type": "string" }, "message": { "description": "Human-readable explanation of the error.", "type": "string" } }, "title": "ImmigrationVisaApplicationQuotesGetResponsesContentApplicationJsonSchemaErrorsItems", "type": "object" }, "ImmigrationVisaApplicationQuotesVisaApplicationQuoteIdApprovePostParametersXBeta": { "default": "true", "enum": [ "true" ], "title": "ImmigrationVisaApplicationQuotesVisaApplicationQuoteIdApprovePostParametersXBeta", "type": "string" }, "ImmigrationVisaApplicationQuotesVisaApplicationQuoteIdApprovePostResponsesContentApplicationJsonSchemaData": { "properties": { "case_id": { "description": "The unique identifier of the eligibility check case the visa application quote was proposed on.", "format": "uuid", "type": "string" }, "created_at": { "description": "UTC timestamp when the visa application quote was created.", "format": "date-time", "type": "string" }, "description": { "description": "Approval details of the visa application quote.", "type": [ "string", "null" ] }, "due_date": { "description": "UTC timestamp by which the quoted fees are due once approved.", "format": "date-time", "type": [ "string", "null" ] }, "generated_case_id": { "description": "The unique identifier of the visa application case opened when the visa application quote was approved. Null while it is in review.", "format": "uuid", "type": [ "string", "null" ] }, "id": { "description": "The unique identifier of the visa application quote.", "format": "uuid", "type": "string" }, "items": { "description": "The fees that make up the visa application quote.", "items": { "$ref": "#/components/schemas/ImmigrationVisaApplicationQuotesVisaApplicationQuoteIdApprovePostResponsesContentApplicationJsonSchemaDataItemsItems" }, "type": "array" }, "status": { "$ref": "#/components/schemas/ImmigrationVisaApplicationQuotesVisaApplicationQuoteIdApprovePostResponsesContentApplicationJsonSchemaDataStatus", "description": "IN_REVIEW while the visa application quote waits for the organization to approve it, APPROVED once approved." }, "updated_at": { "description": "UTC timestamp of the last change to the visa application quote.", "format": "date-time", "type": "string" } }, "required": [ "id", "items", "status", "case_id", "due_date", "created_at", "updated_at", "description", "generated_case_id" ], "title": "ImmigrationVisaApplicationQuotesVisaApplicationQuoteIdApprovePostResponsesContentApplicationJsonSchemaData", "type": "object" }, "ImmigrationVisaApplicationQuotesVisaApplicationQuoteIdApprovePostResponsesContentApplicationJsonSchemaDataItemsItems": { "properties": { "amount": { "description": "Amount of the fee.", "format": "double", "type": "number" }, "currency": { "description": "ISO 4217 currency code of the fee.", "type": "string" }, "description": { "description": "Description of the quoted fee.", "type": [ "string", "null" ] }, "name": { "description": "Name of the quoted fee.", "type": [ "string", "null" ] } }, "required": [ "name", "amount", "currency", "description" ], "title": "ImmigrationVisaApplicationQuotesVisaApplicationQuoteIdApprovePostResponsesContentApplicationJsonSchemaDataItemsItems", "type": "object" }, "ImmigrationVisaApplicationQuotesVisaApplicationQuoteIdApprovePostResponsesContentApplicationJsonSchemaDataStatus": { "description": "IN_REVIEW while the visa application quote waits for the organization to approve it, APPROVED once approved.", "enum": [ "IN_REVIEW", "APPROVED" ], "title": "ImmigrationVisaApplicationQuotesVisaApplicationQuoteIdApprovePostResponsesContentApplicationJsonSchemaDataStatus", "type": "string" }, "ImmigrationVisaApplicationQuotesVisaApplicationQuoteIdApprovePostResponsesContentApplicationJsonSchemaErrorsItems": { "properties": { "code": { "description": "The error code.", "type": "string" }, "message": { "description": "Human-readable explanation of the error.", "type": "string" } }, "title": "ImmigrationVisaApplicationQuotesVisaApplicationQuoteIdApprovePostResponsesContentApplicationJsonSchemaErrorsItems", "type": "object" }, "ImmigrationVisaRequirementBusinessGetParametersTripReason": { "enum": [ "INTERNAL_BUSINESS_WITH_WORK_FOR_CLIENT", "INTERNAL_BUSINESS_WITHOUT_WORK_FOR_CLIENT", "MEETINGS_WITH_OR_FOR_A_CLIENT", "MEETINGS_WITH_POTENTIAL_CLIENTS", "NEGOTIATING_CONTRACTS_OR_SIGNING_AGREEMENTS", "OTHER_EXTERNAL_BUSINESS", "CONFERENCE", "TEAM_OFFSITE", "SPEAKING_AT_CONFERENCE_UNPAID", "SPEAKING_AT_CONFERENCE_PAID", "ATTENDING_INTERNAL_TRAINING", "ATTENDING_EXTERNAL_TRAINING", "DELIVERING_TRAINING_TO_INTERNAL_PARTICIPANTS", "DELIVERING_TRAINING_TO_EXTERNAL_PARTICIPANTS_UNPAID", "DELIVERING_TRAINING_TO_EXTERNAL_PARTICIPANTS_PAID", "PARTICIPATION_IN_RESEARCH_PROJECTS_AND_STUDIES", "ASSEMBLY_MAINTENANCE_REPAIR_INSTALLATION", "TECHNICAL_SUPPORT_OR_SUPERVISION", "OTHER_HANDS_ON_LABOUR", "MARKET_RESEARCH_AND_EXPLORING_INVESTMENT_OPPORTUNITIES", "OTHER" ], "title": "ImmigrationVisaRequirementBusinessGetParametersTripReason", "type": "string" }, "ImmigrationVisaRequirementBusinessGetResponsesContentApplicationJsonSchemaData": { "properties": { "description": { "description": "Description of the visa type", "type": "string" }, "estimated_timeline": { "description": "Estimated processing timeline, in weeks, months or years", "oneOf": [ { "$ref": "#/components/schemas/ImmigrationVisaRequirementBusinessGetResponsesContentApplicationJsonSchemaDataEstimatedTimeline" }, { "type": "null" } ] }, "fee": { "description": "Fee amount", "format": "double", "type": [ "number", "null" ] }, "fee_currency": { "description": "Currency code for the fee in ISO 4217 format", "pattern": "^[A-Z]{3}$", "type": [ "string", "null" ] }, "name": { "description": "Name of the visa type", "type": [ "string", "null" ] }, "qualification": { "$ref": "#/components/schemas/ImmigrationVisaRequirementBusinessGetResponsesContentApplicationJsonSchemaDataQualification", "description": "Visa qualification status, whether it is required or not. It can be also unsupported if the country does not support business visa options." }, "visa_type_id": { "description": "Unique identifier of the visa type. This can be used to create a new business visa case on the create cases endpoint.", "format": "uuid", "type": [ "string", "null" ] } }, "required": [ "fee", "name", "description", "fee_currency", "visa_type_id", "qualification", "estimated_timeline" ], "title": "ImmigrationVisaRequirementBusinessGetResponsesContentApplicationJsonSchemaData", "type": "object" }, "ImmigrationVisaRequirementBusinessGetResponsesContentApplicationJsonSchemaDataEstimatedTimeline": { "description": "Estimated processing timeline, in weeks, months or years", "enum": [ "SIX_WEEKS", "THREE_MONTHS", "ONE_WEEK", "THREE_WEEKS", "ONE_YEAR", "TWO_WEEKS", "FIVE_WEEKS", "TWO_MONTHS", "FIVE_MONTHS", "FOUR_MONTHS", "SIX_MONTHS", "FOUR_WEEKS" ], "title": "ImmigrationVisaRequirementBusinessGetResponsesContentApplicationJsonSchemaDataEstimatedTimeline", "type": "string" }, "ImmigrationVisaRequirementBusinessGetResponsesContentApplicationJsonSchemaDataQualification": { "description": "Visa qualification status, whether it is required or not. It can be also unsupported if the country does not support business visa options.", "enum": [ "VISA_REQUIRED", "NO_VISA_REQUIRED", "UNSUPPORTED" ], "title": "ImmigrationVisaRequirementBusinessGetResponsesContentApplicationJsonSchemaDataQualification", "type": "string" }, "ImmigrationVisaRequirementBusinessGetResponsesContentApplicationJsonSchemaErrorsItems": { "properties": { "code": { "description": "Machine-readable error code", "type": "string" }, "message": { "description": "Human-readable explanation of the error", "type": "string" } }, "title": "ImmigrationVisaRequirementBusinessGetResponsesContentApplicationJsonSchemaErrorsItems", "type": "object" }, "ImmigrationVisaTypesCountryCodeGetResponsesContentApplicationJsonSchemaDataItems": { "properties": { "id": { "description": "The unique identifier of a visa type.", "type": "string" }, "name": { "description": "The name of a visa.", "type": "string" } }, "title": "ImmigrationVisaTypesCountryCodeGetResponsesContentApplicationJsonSchemaDataItems", "type": "object" }, "ImmigrationWorkersCasesCaseIdGetResponsesContentApplicationJsonSchemaData": { "properties": { "applicant": { "description": "The employee for which this Right to Work case has been created for", "oneOf": [ { "$ref": "#/components/schemas/ImmigrationWorkersCasesCaseIdGetResponsesContentApplicationJsonSchemaDataApplicant" }, { "type": "null" } ] }, "case_type": { "description": " Type of the case.", "type": "string" }, "contract": { "$ref": "#/components/schemas/ImmigrationWorkersCasesCaseIdGetResponsesContentApplicationJsonSchemaDataContract", "description": "The contract associated with the returned immigration case" }, "country_code": { "description": "The country of the immigration case.", "type": "string" }, "created_at": { "description": "Creation date of the immigration case.", "format": "date-time", "type": "string" }, "documents": { "description": "A list of documents associated to the immigration case", "items": { "$ref": "#/components/schemas/ImmigrationWorkersCasesCaseIdGetResponsesContentApplicationJsonSchemaDataDocumentsItems" }, "type": "array" }, "estimated_completion_date": { "description": "Estimated completion date of the immigration case.", "format": "date-time", "type": [ "string", "null" ] }, "id": { "description": "Unique identifier of immigration case.", "type": "string" }, "process": { "$ref": "#/components/schemas/ImmigrationWorkersCasesCaseIdGetResponsesContentApplicationJsonSchemaDataProcess", "description": "The current active process" }, "status": { "$ref": "#/components/schemas/ImmigrationWorkersCasesCaseIdGetResponsesContentApplicationJsonSchemaDataStatus", "description": "Status of the immigration case." }, "updated_at": { "description": "Last activity on the immigration case.", "format": "date-time", "type": "string" }, "visa_type": { "description": "The type of the visa.", "type": [ "string", "null" ] } }, "title": "ImmigrationWorkersCasesCaseIdGetResponsesContentApplicationJsonSchemaData", "type": "object" }, "ImmigrationWorkersCasesCaseIdGetResponsesContentApplicationJsonSchemaDataApplicant": { "description": "The employee for which this Right to Work case has been created for", "properties": { "external_id": { "description": "External identifier of the applicant (from partner system or third party).", "type": [ "string", "null" ] }, "id": { "description": "Unique identifier of the applicant profile id.", "type": "string" } }, "title": "ImmigrationWorkersCasesCaseIdGetResponsesContentApplicationJsonSchemaDataApplicant", "type": "object" }, "ImmigrationWorkersCasesCaseIdGetResponsesContentApplicationJsonSchemaDataContract": { "description": "The contract associated with the returned immigration case", "properties": { "id": { "description": "Id of the contract associated with the immigration case", "type": [ "string", "null" ] } }, "title": "ImmigrationWorkersCasesCaseIdGetResponsesContentApplicationJsonSchemaDataContract", "type": "object" }, "ImmigrationWorkersCasesCaseIdGetResponsesContentApplicationJsonSchemaDataDocumentsItems": { "properties": { "document_type": { "description": "The type of the document. Represents the visa type for right to work cases.", "type": [ "string", "null" ] }, "expiration_date": { "description": "Expiry date of the document. If document does not expire, it will be null", "format": "date-time", "type": [ "string", "null" ] }, "id": { "description": "Unique identifier of the document.", "type": "string" }, "status": { "$ref": "#/components/schemas/ImmigrationWorkersCasesCaseIdGetResponsesContentApplicationJsonSchemaDataDocumentsItemsStatus", "description": "Status of the document." } }, "title": "ImmigrationWorkersCasesCaseIdGetResponsesContentApplicationJsonSchemaDataDocumentsItems", "type": "object" }, "ImmigrationWorkersCasesCaseIdGetResponsesContentApplicationJsonSchemaDataDocumentsItemsStatus": { "description": "Status of the document.", "enum": [ "IN_REVIEW", "ACTIVE", "EXPIRED", "EXPIRING", "PENDING", "REJECTED", "COMPLETED", "FAILED", "PROCESSING", "UNKNOWN" ], "title": "ImmigrationWorkersCasesCaseIdGetResponsesContentApplicationJsonSchemaDataDocumentsItemsStatus", "type": "string" }, "ImmigrationWorkersCasesCaseIdGetResponsesContentApplicationJsonSchemaDataProcess": { "description": "The current active process", "properties": { "id": { "description": "Unique identifier of the current active process.", "type": "string" }, "name": { "description": "Name of the current active process.", "type": "string" }, "rejection_note": { "description": "A detailed description of why the case was rejected. Only available if the case status is REJECTED.", "type": "string" }, "rejection_reason": { "description": "The reason why the case was rejected. Only available if the case status is REJECTED.", "type": "string" }, "status": { "description": "Status of the current active process.", "type": "string" } }, "title": "ImmigrationWorkersCasesCaseIdGetResponsesContentApplicationJsonSchemaDataProcess", "type": "object" }, "ImmigrationWorkersCasesCaseIdGetResponsesContentApplicationJsonSchemaDataStatus": { "description": "Status of the immigration case.", "enum": [ "OPEN", "CLOSED", "ON_HOLD" ], "title": "ImmigrationWorkersCasesCaseIdGetResponsesContentApplicationJsonSchemaDataStatus", "type": "string" }, "ImmigrationWorkersCasesCaseIdGetResponsesContentApplicationJsonSchemaErrorsItems": { "properties": { "code": { "description": "Machine-readable error code", "type": "string" }, "message": { "description": "Human-readable explanation of the error", "type": "string" } }, "title": "ImmigrationWorkersCasesCaseIdGetResponsesContentApplicationJsonSchemaErrorsItems", "type": "object" }, "ImmigrationWorkersCasesGetParametersStatusesSchemaItems": { "enum": [ "OPEN", "ON_HOLD", "CLOSED" ], "title": "ImmigrationWorkersCasesGetParametersStatusesSchemaItems", "type": "string" }, "ImmigrationWorkersCasesGetResponsesContentApplicationJsonSchemaDataItems": { "properties": { "applicant": { "description": "Applicant associated with the immigration case.", "oneOf": [ { "$ref": "#/components/schemas/ImmigrationWorkersCasesGetResponsesContentApplicationJsonSchemaDataItemsApplicant" }, { "type": "null" } ] }, "case_type": { "$ref": "#/components/schemas/ImmigrationWorkersCasesGetResponsesContentApplicationJsonSchemaDataItemsCaseType", "description": "Type of immigration case." }, "closure": { "description": "Closure details of the case if the case has been closed.", "oneOf": [ { "$ref": "#/components/schemas/ImmigrationWorkersCasesGetResponsesContentApplicationJsonSchemaDataItemsClosure" }, { "type": "null" } ] }, "created_at": { "description": "Timestamp indicating when the case was created.", "format": "date-time", "type": "string" }, "id": { "description": "Unique identifier of the immigration case.", "format": "uuid", "type": "string" }, "process": { "$ref": "#/components/schemas/ImmigrationWorkersCasesGetResponsesContentApplicationJsonSchemaDataItemsProcess", "description": "Current active process associated with the case." }, "status": { "$ref": "#/components/schemas/ImmigrationWorkersCasesGetResponsesContentApplicationJsonSchemaDataItemsStatus", "description": "Current lifecycle status of the immigration case." }, "updated_at": { "description": "Timestamp indicating when the case was last updated.", "format": "date-time", "type": "string" } }, "required": [ "id", "status", "closure", "process", "applicant", "case_type", "created_at", "updated_at" ], "title": "ImmigrationWorkersCasesGetResponsesContentApplicationJsonSchemaDataItems", "type": "object" }, "ImmigrationWorkersCasesGetResponsesContentApplicationJsonSchemaDataItemsApplicant": { "description": "Applicant associated with the immigration case.", "properties": { "id": { "description": "Unique identifier of the applicant.", "format": "uuid", "type": [ "string", "null" ] }, "name": { "description": "Full name of the applicant.", "maxLength": 255, "type": "string" } }, "required": [ "name" ], "title": "ImmigrationWorkersCasesGetResponsesContentApplicationJsonSchemaDataItemsApplicant", "type": "object" }, "ImmigrationWorkersCasesGetResponsesContentApplicationJsonSchemaDataItemsCaseType": { "description": "Type of immigration case.", "properties": { "id": { "description": "Unique identifier of the case type.", "format": "uuid", "type": "string" }, "name": { "description": "Human-readable name of the case type.", "maxLength": 255, "type": "string" } }, "required": [ "id", "name" ], "title": "ImmigrationWorkersCasesGetResponsesContentApplicationJsonSchemaDataItemsCaseType", "type": "object" }, "ImmigrationWorkersCasesGetResponsesContentApplicationJsonSchemaDataItemsClosure": { "description": "Closure details of the case if the case has been closed.", "properties": { "note": { "description": "Additional notes explaining the case closure.", "maxLength": 400, "type": [ "string", "null" ] }, "reason": { "description": "Reason why the immigration case was closed.", "oneOf": [ { "$ref": "#/components/schemas/ImmigrationWorkersCasesGetResponsesContentApplicationJsonSchemaDataItemsClosureReason" }, { "type": "null" } ] } }, "required": [ "note", "reason" ], "title": "ImmigrationWorkersCasesGetResponsesContentApplicationJsonSchemaDataItemsClosure", "type": "object" }, "ImmigrationWorkersCasesGetResponsesContentApplicationJsonSchemaDataItemsClosureReason": { "description": "Reason why the immigration case was closed.", "enum": [ "CONTRACT_CANCELLED", "NATIONALITY_CHANGE", "NEW_CASE_TYPE_IS_REQUIRED", "ONBOARDING_RELEASED", "OTHER" ], "title": "ImmigrationWorkersCasesGetResponsesContentApplicationJsonSchemaDataItemsClosureReason", "type": "string" }, "ImmigrationWorkersCasesGetResponsesContentApplicationJsonSchemaDataItemsProcess": { "description": "Current active process associated with the case.", "properties": { "id": { "description": "Unique identifier of the current process.", "format": "uuid", "type": "string" }, "name": { "description": "Human-readable name of the current process step.", "maxLength": 255, "type": "string" }, "status": { "$ref": "#/components/schemas/ImmigrationWorkersCasesGetResponsesContentApplicationJsonSchemaDataItemsProcessStatus", "description": "Current status of the process." } }, "required": [ "id", "name", "status" ], "title": "ImmigrationWorkersCasesGetResponsesContentApplicationJsonSchemaDataItemsProcess", "type": "object" }, "ImmigrationWorkersCasesGetResponsesContentApplicationJsonSchemaDataItemsProcessStatus": { "description": "Current status of the process.", "properties": { "id": { "description": "Unique identifier of the process status.", "format": "uuid", "type": [ "string", "null" ] }, "name": { "description": "Human-readable name of the process status.", "maxLength": 255, "type": [ "string", "null" ] } }, "required": [ "id", "name" ], "title": "ImmigrationWorkersCasesGetResponsesContentApplicationJsonSchemaDataItemsProcessStatus", "type": "object" }, "ImmigrationWorkersCasesGetResponsesContentApplicationJsonSchemaDataItemsStatus": { "description": "Current lifecycle status of the immigration case.", "enum": [ "OPEN", "CLOSED", "ON_HOLD" ], "title": "ImmigrationWorkersCasesGetResponsesContentApplicationJsonSchemaDataItemsStatus", "type": "string" }, "ImmigrationWorkersCasesGetResponsesContentApplicationJsonSchemaErrorsItems": { "properties": { "code": { "description": "Machine-readable error code", "type": "string" }, "message": { "description": "Human-readable explanation of the error", "type": "string" } }, "title": "ImmigrationWorkersCasesGetResponsesContentApplicationJsonSchemaErrorsItems", "type": "object" }, "ImmigrationWorkersWorkerIdCasesCaseIdRequiredDocumentDocumentRequestIdPostRequestBodyContentMultipartFormDataSchemaData": { "description": "Details of immigration document upload", "properties": { "file": { "description": "Immigration right to work document. More than 1 document can be uploaded at the same time (e.g.: front and back)", "format": "binary", "minLength": 1, "type": "string" } }, "required": [ "file" ], "title": "ImmigrationWorkersWorkerIdCasesCaseIdRequiredDocumentDocumentRequestIdPostRequestBodyContentMultipartFormDataSchemaData", "type": "object" }, "ImmigrationWorkersWorkerIdCasesCaseIdRequiredDocumentDocumentRequestIdPostResponsesContentApplicationJsonSchemaData": { "properties": { "created_at": { "description": "Creation date of the document.", "format": "date-time", "type": "string" }, "id": { "description": "Unique identifier of the document.", "type": "string" }, "status": { "$ref": "#/components/schemas/ImmigrationWorkersWorkerIdCasesCaseIdRequiredDocumentDocumentRequestIdPostResponsesContentApplicationJsonSchemaDataStatus", "description": "Status of the document." }, "updated_at": { "description": "Last update date of the document.", "format": "date-time", "type": "string" } }, "title": "ImmigrationWorkersWorkerIdCasesCaseIdRequiredDocumentDocumentRequestIdPostResponsesContentApplicationJsonSchemaData", "type": "object" }, "ImmigrationWorkersWorkerIdCasesCaseIdRequiredDocumentDocumentRequestIdPostResponsesContentApplicationJsonSchemaDataStatus": { "description": "Status of the document.", "enum": [ "IN_REVIEW" ], "title": "ImmigrationWorkersWorkerIdCasesCaseIdRequiredDocumentDocumentRequestIdPostResponsesContentApplicationJsonSchemaDataStatus", "type": "string" }, "ImmigrationWorkersWorkerIdCasesCaseIdRequiredDocumentGetResponsesContentApplicationJsonSchemaData": { "properties": { "created_at": { "description": "Creation date of the document request.", "format": "date-time", "type": "string" }, "description": { "description": "A short text description of the document requirement to be uploaded.", "type": "string" }, "document": { "$ref": "#/components/schemas/ImmigrationWorkersWorkerIdCasesCaseIdRequiredDocumentGetResponsesContentApplicationJsonSchemaDataDocument" }, "id": { "description": "The unique identifier of the document requirement.", "type": "string" }, "immigration_document_requirement_id": { "description": "The unique identifier of the immigration document requirement.", "type": "string" }, "name": { "description": "The name of the document requirement to be uploaded.", "type": "string" }, "previous_rejected_document": { "$ref": "#/components/schemas/ImmigrationWorkersWorkerIdCasesCaseIdRequiredDocumentGetResponsesContentApplicationJsonSchemaDataPreviousRejectedDocument" }, "updated_at": { "description": "Last update date of the document request.", "format": "date-time", "type": "string" } }, "title": "ImmigrationWorkersWorkerIdCasesCaseIdRequiredDocumentGetResponsesContentApplicationJsonSchemaData", "type": "object" }, "ImmigrationWorkersWorkerIdCasesCaseIdRequiredDocumentGetResponsesContentApplicationJsonSchemaDataDocument": { "properties": { "expiration_date": { "description": "Expiration date of the document. If document does not expire, it will be null", "format": "date-time", "type": [ "string", "null" ] }, "id": { "description": "Unique identifier of the document.", "type": "string" }, "name": { "description": "The name of the document.", "type": "string" }, "status": { "$ref": "#/components/schemas/ImmigrationWorkersWorkerIdCasesCaseIdRequiredDocumentGetResponsesContentApplicationJsonSchemaDataDocumentStatus", "description": "Status of the document." } }, "title": "ImmigrationWorkersWorkerIdCasesCaseIdRequiredDocumentGetResponsesContentApplicationJsonSchemaDataDocument", "type": "object" }, "ImmigrationWorkersWorkerIdCasesCaseIdRequiredDocumentGetResponsesContentApplicationJsonSchemaDataDocumentStatus": { "description": "Status of the document.", "enum": [ "PENDING", "IN_REVIEW", "ACTIVE", "EXPIRING", "EXPIRED" ], "title": "ImmigrationWorkersWorkerIdCasesCaseIdRequiredDocumentGetResponsesContentApplicationJsonSchemaDataDocumentStatus", "type": "string" }, "ImmigrationWorkersWorkerIdCasesCaseIdRequiredDocumentGetResponsesContentApplicationJsonSchemaDataPreviousRejectedDocument": { "properties": { "id": { "description": "The unique identifier of the document.", "type": "string" }, "rejection_note": { "description": "A detailed description about why the document was rejected.", "type": [ "string", "null" ] }, "rejection_reason": { "description": "The reason why the document was rejected.", "type": [ "string", "null" ] }, "status": { "$ref": "#/components/schemas/ImmigrationWorkersWorkerIdCasesCaseIdRequiredDocumentGetResponsesContentApplicationJsonSchemaDataPreviousRejectedDocumentStatus", "description": "Status of the document." } }, "title": "ImmigrationWorkersWorkerIdCasesCaseIdRequiredDocumentGetResponsesContentApplicationJsonSchemaDataPreviousRejectedDocument", "type": "object" }, "ImmigrationWorkersWorkerIdCasesCaseIdRequiredDocumentGetResponsesContentApplicationJsonSchemaDataPreviousRejectedDocumentStatus": { "description": "Status of the document.", "enum": [ "REJECTED" ], "title": "ImmigrationWorkersWorkerIdCasesCaseIdRequiredDocumentGetResponsesContentApplicationJsonSchemaDataPreviousRejectedDocumentStatus", "type": "string" }, "ImmigrationWorkersWorkerIdOnboardingCaseGetResponsesContentApplicationJsonSchemaData": { "properties": { "applicant": { "description": "The employee for which this Right to Work case has been created for", "oneOf": [ { "$ref": "#/components/schemas/ImmigrationWorkersWorkerIdOnboardingCaseGetResponsesContentApplicationJsonSchemaDataApplicant" }, { "type": "null" } ] }, "case_type": { "$ref": "#/components/schemas/ImmigrationWorkersWorkerIdOnboardingCaseGetResponsesContentApplicationJsonSchemaDataCaseType", "description": " Type of the case. It will always be IMMIGRATION_DOCUMENT_REVIEW for this endpoint." }, "contract": { "$ref": "#/components/schemas/ImmigrationWorkersWorkerIdOnboardingCaseGetResponsesContentApplicationJsonSchemaDataContract", "description": "The contract associated with the returned immigration case" }, "country_code": { "description": "The country of the immigration case.", "type": "string" }, "created_at": { "description": "Creation date of the immigration case.", "format": "date-time", "type": "string" }, "documents": { "description": "A list of documents associated to the immigration case", "items": { "$ref": "#/components/schemas/ImmigrationWorkersWorkerIdOnboardingCaseGetResponsesContentApplicationJsonSchemaDataDocumentsItems" }, "type": "array" }, "estimated_completion_date": { "description": "Estimated completion date of the immigration case.", "format": "date-time", "type": [ "string", "null" ] }, "id": { "description": "Unique identifier of immigration case.", "type": "string" }, "process": { "$ref": "#/components/schemas/ImmigrationWorkersWorkerIdOnboardingCaseGetResponsesContentApplicationJsonSchemaDataProcess", "description": "The current active process" }, "status": { "$ref": "#/components/schemas/ImmigrationWorkersWorkerIdOnboardingCaseGetResponsesContentApplicationJsonSchemaDataStatus", "description": "Status of the immigration case." }, "updated_at": { "description": "Last activity on the immigration case.", "format": "date-time", "type": "string" }, "visa_type": { "description": "The type of the visa.", "type": [ "string", "null" ] } }, "title": "ImmigrationWorkersWorkerIdOnboardingCaseGetResponsesContentApplicationJsonSchemaData", "type": "object" }, "ImmigrationWorkersWorkerIdOnboardingCaseGetResponsesContentApplicationJsonSchemaDataApplicant": { "description": "The employee for which this Right to Work case has been created for", "properties": { "external_id": { "description": "External identifier of the applicant (from partner system or third party).", "type": [ "string", "null" ] }, "id": { "description": "Unique identifier of the applicant profile id.", "type": "string" } }, "title": "ImmigrationWorkersWorkerIdOnboardingCaseGetResponsesContentApplicationJsonSchemaDataApplicant", "type": "object" }, "ImmigrationWorkersWorkerIdOnboardingCaseGetResponsesContentApplicationJsonSchemaDataCaseType": { "description": " Type of the case. It will always be IMMIGRATION_DOCUMENT_REVIEW for this endpoint.", "enum": [ "IMMIGRATION_DOCUMENT_REVIEW" ], "title": "ImmigrationWorkersWorkerIdOnboardingCaseGetResponsesContentApplicationJsonSchemaDataCaseType", "type": "string" }, "ImmigrationWorkersWorkerIdOnboardingCaseGetResponsesContentApplicationJsonSchemaDataContract": { "description": "The contract associated with the returned immigration case", "properties": { "id": { "description": "Id of the contract associated with the immigration case", "type": [ "string", "null" ] } }, "title": "ImmigrationWorkersWorkerIdOnboardingCaseGetResponsesContentApplicationJsonSchemaDataContract", "type": "object" }, "ImmigrationWorkersWorkerIdOnboardingCaseGetResponsesContentApplicationJsonSchemaDataDocumentsItems": { "properties": { "document_type": { "description": "The type of the document. Represents the visa type for right to work cases.", "type": [ "string", "null" ] }, "expiration_date": { "description": "Expiry date of the document. If document does not expire, it will be null", "format": "date-time", "type": [ "string", "null" ] }, "id": { "description": "Unique identifier of the document.", "type": "string" }, "status": { "$ref": "#/components/schemas/ImmigrationWorkersWorkerIdOnboardingCaseGetResponsesContentApplicationJsonSchemaDataDocumentsItemsStatus", "description": "Status of the document." } }, "title": "ImmigrationWorkersWorkerIdOnboardingCaseGetResponsesContentApplicationJsonSchemaDataDocumentsItems", "type": "object" }, "ImmigrationWorkersWorkerIdOnboardingCaseGetResponsesContentApplicationJsonSchemaDataDocumentsItemsStatus": { "description": "Status of the document.", "enum": [ "IN_REVIEW", "ACTIVE", "EXPIRED", "EXPIRING" ], "title": "ImmigrationWorkersWorkerIdOnboardingCaseGetResponsesContentApplicationJsonSchemaDataDocumentsItemsStatus", "type": "string" }, "ImmigrationWorkersWorkerIdOnboardingCaseGetResponsesContentApplicationJsonSchemaDataProcess": { "description": "The current active process", "properties": { "id": { "description": "Unique identifier of the current active process.", "type": "string" }, "name": { "$ref": "#/components/schemas/ImmigrationWorkersWorkerIdOnboardingCaseGetResponsesContentApplicationJsonSchemaDataProcessName", "description": "Name of the current active process." }, "rejection_note": { "description": "A detailed description of why the case was rejected. Only available if the case status is REJECTED.", "type": "string" }, "rejection_reason": { "description": "The reason why the case was rejected. Only available if the case status is REJECTED.", "type": "string" }, "status": { "$ref": "#/components/schemas/ImmigrationWorkersWorkerIdOnboardingCaseGetResponsesContentApplicationJsonSchemaDataProcessStatus", "description": "Status of the current active process." } }, "title": "ImmigrationWorkersWorkerIdOnboardingCaseGetResponsesContentApplicationJsonSchemaDataProcess", "type": "object" }, "ImmigrationWorkersWorkerIdOnboardingCaseGetResponsesContentApplicationJsonSchemaDataProcessName": { "description": "Name of the current active process.", "enum": [ "WORK_AUTHORIZATION_VERIFICATION" ], "title": "ImmigrationWorkersWorkerIdOnboardingCaseGetResponsesContentApplicationJsonSchemaDataProcessName", "type": "string" }, "ImmigrationWorkersWorkerIdOnboardingCaseGetResponsesContentApplicationJsonSchemaDataProcessStatus": { "description": "Status of the current active process.", "enum": [ "CANCELLED", "AWAITING_DOCUMENTS", "IN_REVIEW", "APPROVED", "REJECTED" ], "title": "ImmigrationWorkersWorkerIdOnboardingCaseGetResponsesContentApplicationJsonSchemaDataProcessStatus", "type": "string" }, "ImmigrationWorkersWorkerIdOnboardingCaseGetResponsesContentApplicationJsonSchemaDataStatus": { "description": "Status of the immigration case.", "enum": [ "OPEN", "CLOSED", "ON_HOLD" ], "title": "ImmigrationWorkersWorkerIdOnboardingCaseGetResponsesContentApplicationJsonSchemaDataStatus", "type": "string" }, "ImmigrationWorkersWorkerIdOnboardingCaseGetResponsesContentApplicationJsonSchemaErrorsItems": { "properties": { "code": { "description": "Machine-readable error code", "type": "string" }, "message": { "description": "Human-readable explanation of the error", "type": "string" } }, "title": "ImmigrationWorkersWorkerIdOnboardingCaseGetResponsesContentApplicationJsonSchemaErrorsItems", "type": "object" }, "Immigration_approveVisaApplicationQuote-v2026-10-14_Response_200": { "properties": { "data": { "$ref": "#/components/schemas/ImmigrationVisaApplicationQuotesVisaApplicationQuoteIdApprovePostResponsesContentApplicationJsonSchemaData" } }, "required": [ "data" ], "title": "Immigration_approveVisaApplicationQuote-v2026-10-14_Response_200", "type": "object" }, "Immigration_getCaseTimeline-v2026-10-14_Response_200": { "properties": { "data": { "$ref": "#/components/schemas/ImmigrationCasesCaseIdTimelineGetResponsesContentApplicationJsonSchemaData" } }, "required": [ "data" ], "title": "Immigration_getCaseTimeline-v2026-10-14_Response_200", "type": "object" }, "Immigration_listCaseInvoices-v2026-10-14_Response_200": { "properties": { "data": { "items": { "$ref": "#/components/schemas/ImmigrationInvoicesGetResponsesContentApplicationJsonSchemaDataItems" }, "type": "array" }, "has_more": { "description": "Whether more items are available beyond this page.", "type": "boolean" }, "next_cursor": { "description": "Cursor to pass as cursor to fetch the next page. Null when there is no next page.", "type": [ "string", "null" ] }, "total_count": { "description": "Total number of invoices issued to the organization for the case.", "type": [ "integer", "null" ] } }, "required": [ "data", "has_more", "next_cursor", "total_count" ], "title": "Immigration_listCaseInvoices-v2026-10-14_Response_200", "type": "object" }, "Immigration_listCaseNotes-v2026-08-10_Response_200": { "properties": { "data": { "items": { "$ref": "#/components/schemas/ImmigrationNotesGetResponsesContentApplicationJsonSchemaDataItems" }, "type": "array" }, "has_more": { "description": "Whether more notes are available beyond this page.", "type": "boolean" }, "next_cursor": { "description": "Cursor to pass as cursor to fetch the next page. Null when there is no next page.", "type": [ "string", "null" ] }, "total_count": { "description": "Total number of externally-visible notes for the case, when available.", "type": [ "integer", "null" ] } }, "required": [ "data", "has_more", "next_cursor", "total_count" ], "title": "Immigration_listCaseNotes-v2026-08-10_Response_200", "type": "object" }, "Immigration_listCaseVisaApplicationQuotes-v2026-10-14_Response_200": { "properties": { "data": { "items": { "$ref": "#/components/schemas/ImmigrationVisaApplicationQuotesGetResponsesContentApplicationJsonSchemaDataItems" }, "type": "array" } }, "required": [ "data" ], "title": "Immigration_listCaseVisaApplicationQuotes-v2026-10-14_Response_200", "type": "object" }, "ImportPayrollMigrationFiles-v2026-09-14RequestBadRequestError": { "properties": { "code": { "type": "string" }, "data": { "$ref": "#/components/schemas/GpLegalEntitiesLegalEntityIdPayrollMigrationImportsPostResponsesContentApplicationJsonSchemaData" }, "defined": { "type": "boolean" }, "message": { "default": "One or more files could not be claimed - check that each upload finished its security scan.", "type": "string" }, "status": { "format": "double", "type": "number" } }, "required": [ "code", "status", "defined", "message" ], "title": "ImportPayrollMigrationFiles-v2026-09-14RequestBadRequestError", "type": "object" }, "ImportPayrollMigrationFiles-v2026-09-14RequestConflictError": { "properties": { "code": { "type": "string" }, "data": { "$ref": "#/components/schemas/GpLegalEntitiesLegalEntityIdPayrollMigrationImportsPostResponsesContentApplicationJsonSchemaData" }, "defined": { "type": "boolean" }, "message": { "default": "One or more files are already attached to this payroll migration import.", "type": "string" }, "status": { "format": "double", "type": "number" } }, "required": [ "code", "status", "defined", "message" ], "title": "ImportPayrollMigrationFiles-v2026-09-14RequestConflictError", "type": "object" }, "ImportPayrollMigrationFiles-v2026-09-14RequestForbiddenError": { "properties": { "code": { "type": "string" }, "data": { "description": "Any type" }, "defined": { "type": "boolean" }, "message": { "default": "The caller is not authorized to act on this legal entity.", "type": "string" }, "status": { "format": "double", "type": "number" } }, "required": [ "code", "status", "defined", "message" ], "title": "ImportPayrollMigrationFiles-v2026-09-14RequestForbiddenError", "type": "object" }, "ImportPayrollMigrationFiles-v2026-09-14RequestInternalServerError": { "properties": { "code": { "type": "string" }, "data": { "description": "Any type" }, "defined": { "type": "boolean" }, "message": { "default": "Internal server error.", "type": "string" }, "status": { "format": "double", "type": "number" } }, "required": [ "code", "status", "defined", "message" ], "title": "ImportPayrollMigrationFiles-v2026-09-14RequestInternalServerError", "type": "object" }, "ImportPayrollMigrationFiles-v2026-09-14RequestNotFoundError": { "properties": { "code": { "type": "string" }, "data": { "description": "Any type" }, "defined": { "type": "boolean" }, "message": { "default": "Legal entity not found.", "type": "string" }, "status": { "format": "double", "type": "number" } }, "required": [ "code", "status", "defined", "message" ], "title": "ImportPayrollMigrationFiles-v2026-09-14RequestNotFoundError", "type": "object" }, "ImportPayrollMigrationFiles-v2026-09-14RequestUnauthorizedError": { "properties": { "code": { "type": "string" }, "data": { "description": "Any type" }, "defined": { "type": "boolean" }, "message": { "default": "The request carries no caller identity the gateway could resolve.", "type": "string" }, "status": { "format": "double", "type": "number" } }, "required": [ "code", "status", "defined", "message" ], "title": "ImportPayrollMigrationFiles-v2026-09-14RequestUnauthorizedError", "type": "object" }, "IndustriesGetParametersOrder": { "default": "ASC", "enum": [ "ASC", "DESC" ], "title": "IndustriesGetParametersOrder", "type": "string" }, "IndustriesGetParametersSortBy": { "default": "categoryName", "enum": [ "subcategoryName", "categoryName" ], "title": "IndustriesGetParametersSortBy", "type": "string" }, "IndustriesGetResponsesContentApplicationJsonSchemaDataItems": { "properties": { "category_name": { "description": "Name of the associated industry category.", "type": [ "string", "null" ] }, "created_at": { "description": "Date and time when the subcategory was created.", "format": "date-time", "type": "string" }, "id": { "description": "UUID of the subcategory.", "format": "uuid", "type": "string" }, "name": { "description": "Name of the industry subcategory.", "type": "string" }, "updated_at": { "description": "Date and time when the subcategory was last updated.", "format": "date-time", "type": "string" } }, "required": [ "id", "name", "created_at", "updated_at", "category_name" ], "title": "IndustriesGetResponsesContentApplicationJsonSchemaDataItems", "type": "object" }, "IndustriesGetResponsesContentApplicationJsonSchemaErrorsItems": { "properties": { "message": { "description": "A description of the returned error", "type": "string" }, "path": { "description": "The JSON path where input validation failed", "type": "string" } }, "title": "IndustriesGetResponsesContentApplicationJsonSchemaErrorsItems", "type": "object" }, "IndustriesGetResponsesContentApplicationJsonSchemaRequest": { "properties": { "api_req_id": { "description": "The request ID of the failed request", "type": "string" }, "code": { "description": "The code of the source handler which produced the returned error", "format": "double", "type": "number" }, "docs": { "description": "A link to the official documentation for the requested endpoint resource", "type": "string" }, "method": { "description": "The HTTP method of the failed request", "type": "string" }, "source": { "description": "The source handler which produced the returned error", "type": "string" }, "status": { "description": "The status code of the response", "format": "double", "type": "number" }, "url": { "description": "The relative URL of the failed request", "type": "string" } }, "title": "IndustriesGetResponsesContentApplicationJsonSchemaRequest", "type": "object" }, "InitiateEorContractTerminationRequest-v2026-01-01RequestBadRequestError": { "properties": { "errors": { "items": { "$ref": "#/components/schemas/EorContractsContractIdOffboardingTerminationPostResponsesContentApplicationJsonSchemaErrorsItems" }, "type": "array" } }, "title": "InitiateEorContractTerminationRequest-v2026-01-01RequestBadRequestError", "type": "object" }, "InitiateEorContractTerminationRequest-v2026-01-01RequestForbiddenError": { "properties": { "errors": { "items": { "$ref": "#/components/schemas/EorContractsContractIdOffboardingTerminationPostResponsesContentApplicationJsonSchemaErrorsItems" }, "type": "array" } }, "title": "InitiateEorContractTerminationRequest-v2026-01-01RequestForbiddenError", "type": "object" }, "InitiateEorContractTerminationRequest-v2026-01-01RequestInternalServerError": { "properties": { "errors": { "items": { "$ref": "#/components/schemas/EorContractsContractIdOffboardingTerminationPostResponsesContentApplicationJsonSchemaErrorsItems" }, "type": "array" } }, "title": "InitiateEorContractTerminationRequest-v2026-01-01RequestInternalServerError", "type": "object" }, "InitiateEorContractTerminationRequest-v2026-01-01RequestUnauthorizedError": { "properties": { "errors": { "items": { "$ref": "#/components/schemas/EorContractsContractIdOffboardingTerminationPostResponsesContentApplicationJsonSchemaErrorsItems" }, "type": "array" } }, "title": "InitiateEorContractTerminationRequest-v2026-01-01RequestUnauthorizedError", "type": "object" }, "IntegrationsConsentGetResponsesContentApplicationJsonSchemaData": { "properties": { "client_id": { "description": "Client ID associated with the consent.", "type": "string" }, "created_at": { "description": "Creation date for the consent.", "type": "string" }, "expires_at": { "description": "Expiration date for the consent.", "type": "string" }, "id": { "description": "Unique identifier for the consent.", "type": "string" }, "organization_id": { "description": "Organization ID associated with the consent.", "type": [ "string", "null" ] }, "profile_id": { "description": "Profile ID associated with the consent.", "type": [ "string", "null" ] }, "redirect_uri": { "description": "Redirect URI for the consent.", "type": "string" }, "scope": { "description": "Scope of the consent.", "type": "string" }, "state": { "description": "State of the consent.", "type": "string" }, "status": { "description": "Status of the consent.", "type": "string" }, "updated_at": { "description": "Update date for the consent.", "type": "string" }, "user_email": { "description": "User email associated with the consent.", "type": [ "string", "null" ] }, "user_id": { "description": "User ID associated with the consent.", "type": [ "string", "null" ] }, "user_name": { "description": "User name associated with the consent.", "type": [ "string", "null" ] } }, "title": "IntegrationsConsentGetResponsesContentApplicationJsonSchemaData", "type": "object" }, "Integrations_getIntegrationConsent-v2026-01-01_Response_200": { "properties": { "data": { "$ref": "#/components/schemas/IntegrationsConsentGetResponsesContentApplicationJsonSchemaData" } }, "title": "Integrations_getIntegrationConsent-v2026-01-01_Response_200", "type": "object" }, "InvoiceAdjustmentsGetParametersContractTypesSchemaItems": { "description": "Type of a contract", "enum": [ "ongoing_time_based", "pay_as_you_go_time_based", "payg_milestones", "payg_tasks" ], "title": "InvoiceAdjustmentsGetParametersContractTypesSchemaItems", "type": "string" }, "InvoiceAdjustmentsGetParametersStatusesSchemaItems": { "description": "status of invoice adjustment", "enum": [ "approved", "declined", "not_payable", "paid", "pending", "processing" ], "title": "InvoiceAdjustmentsGetParametersStatusesSchemaItems", "type": "string" }, "InvoiceAdjustmentsGetParametersTypesSchemaItems": { "description": "Type of invoice adjustment.", "enum": [ "accrued_holiday", "additional_fee", "allowance", "bonus", "commission", "deduction", "deposit", "deposit_refund", "employer_cost", "expense", "health_allowance", "health_benefit", "health_insurance_fee", "legal_fee", "management_fee", "milestone", "offcycle", "other", "overtime", "pension", "pro_rata", "setup_fee", "severance", "shield_service", "signing_bonus", "signing_bonus_employer_cost", "refund", "task", "time_off", "vat", "withholding_tax", "work" ], "title": "InvoiceAdjustmentsGetParametersTypesSchemaItems", "type": "string" }, "InvoiceAdjustmentsGetResponsesContentApplicationJsonSchemaDataItems": { "properties": { "attachment": { "description": "File attachment linked to the invoice adjustment.", "oneOf": [ { "$ref": "#/components/schemas/InvoiceAdjustmentsGetResponsesContentApplicationJsonSchemaDataItemsAttachment" }, { "type": "null" } ] }, "contract": { "$ref": "#/components/schemas/InvoiceAdjustmentsGetResponsesContentApplicationJsonSchemaDataItemsContract", "description": "Contract associated with this invoice adjustment." }, "created_at": { "description": "Timestamp when the adjustment was created (ISO-8601).", "format": "date-time", "type": "string" }, "currency_code": { "description": "ISO 4217 currency code used for the amount.", "maxLength": 3, "minLength": 3, "pattern": "^[A-Z]{3}$", "type": "string" }, "custom_scale": { "description": "Custom scale label defined by the client.", "type": [ "string", "null" ] }, "date_submitted": { "description": "Timestamp when the adjustment was submitted for review.", "format": "date-time", "type": [ "string", "null" ] }, "description": { "description": "Human-readable explanation of the invoice adjustment.", "type": [ "string", "null" ] }, "hourlyReportPreset": { "oneOf": [ { "$ref": "#/components/schemas/InvoiceAdjustmentsGetResponsesContentApplicationJsonSchemaDataItemsHourlyReportPreset" }, { "type": "null" } ] }, "id": { "description": "Unique identifier of this invoice adjustment.", "format": "uuid", "type": [ "string", "null" ] }, "invoice_id": { "description": "Identifier of the generated invoice this adjustment belongs to.", "format": "double", "type": [ "number", "null" ] }, "payment_cycle": { "$ref": "#/components/schemas/InvoiceAdjustmentsGetResponsesContentApplicationJsonSchemaDataItemsPaymentCycle", "description": "Payment cycle associated with this adjustment." }, "quantity": { "description": "Quantity used to calculate the total amount.", "format": "double", "type": [ "number", "null" ] }, "reported_by": { "$ref": "#/components/schemas/InvoiceAdjustmentsGetResponsesContentApplicationJsonSchemaDataItemsReportedBy", "description": "User who reported the invoice adjustment." }, "reviewed_by": { "description": "Reviewer information if the adjustment has been reviewed.", "oneOf": [ { "$ref": "#/components/schemas/InvoiceAdjustmentsGetResponsesContentApplicationJsonSchemaDataItemsReviewedBy" }, { "type": "null" } ] }, "scale": { "description": "Predefined scale used to calculate the adjustment amount.", "type": [ "string", "null" ] }, "status": { "description": "Current processing status of the invoice adjustment.", "oneOf": [ { "$ref": "#/components/schemas/InvoiceAdjustmentsGetResponsesContentApplicationJsonSchemaDataItemsStatus" }, { "type": "null" } ] }, "total_amount": { "description": "Total monetary value of the invoice adjustment.", "type": "string" }, "type": { "$ref": "#/components/schemas/InvoiceAdjustmentsGetResponsesContentApplicationJsonSchemaDataItemsType", "description": "Type of invoice adjustment." }, "worksheet": { "description": "Breakdown of time used for time-based calculations.", "oneOf": [ { "$ref": "#/components/schemas/InvoiceAdjustmentsGetResponsesContentApplicationJsonSchemaDataItemsWorksheet" }, { "type": "null" } ] } }, "required": [ "id", "type", "status", "contract", "quantity", "worksheet", "attachment", "created_at", "description", "reported_by", "reviewed_by", "total_amount", "currency_code", "payment_cycle" ], "title": "InvoiceAdjustmentsGetResponsesContentApplicationJsonSchemaDataItems", "type": "object" }, "InvoiceAdjustmentsGetResponsesContentApplicationJsonSchemaDataItemsAttachment": { "description": "File attachment linked to the invoice adjustment.", "properties": { "filename": { "description": "Original filename of the uploaded attachment, download link can be found on the individual invoice adjustment endpoint", "type": "string" }, "key": { "description": "Storage key returned from the attachments endpoint, can be used as a unique identifier for the file", "type": "string" } }, "required": [ "key", "filename" ], "title": "InvoiceAdjustmentsGetResponsesContentApplicationJsonSchemaDataItemsAttachment", "type": "object" }, "InvoiceAdjustmentsGetResponsesContentApplicationJsonSchemaDataItemsContract": { "description": "Contract associated with this invoice adjustment.", "properties": { "id": { "description": "Unique identifier of the contract.", "type": "string" }, "title": { "description": "Human-readable contract title.", "type": "string" }, "type": { "$ref": "#/components/schemas/InvoiceAdjustmentsGetResponsesContentApplicationJsonSchemaDataItemsContractType", "description": "Type of the contract." } }, "required": [ "id", "type", "title" ], "title": "InvoiceAdjustmentsGetResponsesContentApplicationJsonSchemaDataItemsContract", "type": "object" }, "InvoiceAdjustmentsGetResponsesContentApplicationJsonSchemaDataItemsContractType": { "description": "Type of the contract.", "enum": [ "ongoing_time_based", "milestones", "time_based", "pay_as_you_go_time_based", "commission", "payg_milestones", "payg_tasks", "eor", "unknown", "employee", "global_payroll", "shield_msa", "hris_direct_employee", "peo" ], "title": "InvoiceAdjustmentsGetResponsesContentApplicationJsonSchemaDataItemsContractType", "type": "string" }, "InvoiceAdjustmentsGetResponsesContentApplicationJsonSchemaDataItemsHourlyReportPreset": { "properties": { "id": { "description": "Id of assigned preset", "format": "uuid", "type": "string" }, "rate": { "description": "Assigned preset rate", "format": "double", "type": [ "number", "null" ] }, "title": { "description": "Description of assigned preset", "type": "string" } }, "title": "InvoiceAdjustmentsGetResponsesContentApplicationJsonSchemaDataItemsHourlyReportPreset", "type": "object" }, "InvoiceAdjustmentsGetResponsesContentApplicationJsonSchemaDataItemsPaymentCycle": { "description": "Payment cycle associated with this adjustment.", "properties": { "end": { "description": "End date of the payment cycle.", "format": "date-time", "type": [ "string", "null" ] }, "start": { "description": "Start date of the payment cycle.", "format": "date-time", "type": [ "string", "null" ] } }, "title": "InvoiceAdjustmentsGetResponsesContentApplicationJsonSchemaDataItemsPaymentCycle", "type": "object" }, "InvoiceAdjustmentsGetResponsesContentApplicationJsonSchemaDataItemsReportedBy": { "description": "User who reported the invoice adjustment.", "properties": { "full_name": { "description": "Full name of the reporting user.", "type": "string" }, "id": { "$ref": "#/components/schemas/InvoiceAdjustmentsGetResponsesContentApplicationJsonSchemaDataItemsReportedById", "description": "Unique identifier of the reporting user." } }, "required": [ "id" ], "title": "InvoiceAdjustmentsGetResponsesContentApplicationJsonSchemaDataItemsReportedBy", "type": "object" }, "InvoiceAdjustmentsGetResponsesContentApplicationJsonSchemaDataItemsReportedById": { "description": "Unique identifier of the reporting user.", "oneOf": [ { "type": "string" }, { "format": "int64", "type": "integer" } ], "title": "InvoiceAdjustmentsGetResponsesContentApplicationJsonSchemaDataItemsReportedById" }, "InvoiceAdjustmentsGetResponsesContentApplicationJsonSchemaDataItemsReviewedBy": { "description": "Reviewer information if the adjustment has been reviewed.", "properties": { "full_name": { "description": "Full name of the reviewer.", "type": "string" }, "id": { "$ref": "#/components/schemas/InvoiceAdjustmentsGetResponsesContentApplicationJsonSchemaDataItemsReviewedById", "description": "Unique identifier of the reviewer." }, "remarks": { "description": "Reviewer remarks or decision notes.", "type": [ "string", "null" ] }, "reviewed_at": { "description": "Timestamp when the review occurred.", "type": [ "string", "null" ] } }, "required": [ "id", "remarks", "reviewed_at" ], "title": "InvoiceAdjustmentsGetResponsesContentApplicationJsonSchemaDataItemsReviewedBy", "type": "object" }, "InvoiceAdjustmentsGetResponsesContentApplicationJsonSchemaDataItemsReviewedById": { "description": "Unique identifier of the reviewer.", "oneOf": [ { "type": "string" }, { "format": "int64", "type": "integer" } ], "title": "InvoiceAdjustmentsGetResponsesContentApplicationJsonSchemaDataItemsReviewedById" }, "InvoiceAdjustmentsGetResponsesContentApplicationJsonSchemaDataItemsStatus": { "description": "Current processing status of the invoice adjustment.", "enum": [ "approved", "declined", "not_payable", "paid", "pending", "processing" ], "title": "InvoiceAdjustmentsGetResponsesContentApplicationJsonSchemaDataItemsStatus", "type": "string" }, "InvoiceAdjustmentsGetResponsesContentApplicationJsonSchemaDataItemsType": { "description": "Type of invoice adjustment.", "enum": [ "accrued_holiday", "additional_fee", "allowance", "bonus", "commission", "deduction", "deposit", "deposit_refund", "employer_cost", "expense", "health_allowance", "health_benefit", "health_insurance_fee", "legal_fee", "management_fee", "milestone", "offcycle", "other", "overtime", "pension", "pro_rata", "setup_fee", "severance", "shield_service", "signing_bonus", "signing_bonus_employer_cost", "refund", "task", "time_off", "vat", "withholding_tax", "work" ], "title": "InvoiceAdjustmentsGetResponsesContentApplicationJsonSchemaDataItemsType", "type": "string" }, "InvoiceAdjustmentsGetResponsesContentApplicationJsonSchemaDataItemsWorksheet": { "description": "Breakdown of time used for time-based calculations.", "properties": { "days": { "description": "Number of days reported.", "format": "double", "type": "number" }, "hours": { "description": "Number of hours reported.", "format": "double", "type": "number" }, "minutes": { "description": "Number of minutes reported.", "format": "double", "type": "number" }, "weeks": { "description": "Number of weeks reported.", "format": "double", "type": "number" } }, "required": [ "days", "hours", "weeks", "minutes" ], "title": "InvoiceAdjustmentsGetResponsesContentApplicationJsonSchemaDataItemsWorksheet", "type": "object" }, "InvoiceAdjustmentsGetResponsesContentApplicationJsonSchemaPage": { "description": "Pagination metadata for the response.", "properties": { "items_per_page": { "description": "Number of records returned per page.", "format": "double", "maximum": 100, "minimum": 1, "type": "number" }, "offset": { "description": "Index of the first record in the current page.", "format": "double", "maximum": 999999999, "minimum": 0, "type": "number" }, "total_rows": { "description": "Total number of records available.", "format": "double", "type": "number" } }, "required": [ "offset", "total_rows", "items_per_page" ], "title": "InvoiceAdjustmentsGetResponsesContentApplicationJsonSchemaPage", "type": "object" }, "InvoiceAdjustmentsIdDeleteResponsesContentApplicationJsonSchemaData": { "properties": { "deleted": { "description": "Confirms the deletion.", "type": "boolean" } }, "required": [ "deleted" ], "title": "InvoiceAdjustmentsIdDeleteResponsesContentApplicationJsonSchemaData", "type": "object" }, "InvoiceAdjustmentsIdGetResponsesContentApplicationJsonSchemaData": { "properties": { "approvers": { "items": { "$ref": "#/components/schemas/InvoiceAdjustmentsIdGetResponsesContentApplicationJsonSchemaDataApproversItems" }, "type": "array" }, "attachment": { "description": "File attachment linked to the invoice adjustment.", "oneOf": [ { "$ref": "#/components/schemas/InvoiceAdjustmentsIdGetResponsesContentApplicationJsonSchemaDataAttachment" }, { "type": "null" } ] }, "contract": { "$ref": "#/components/schemas/InvoiceAdjustmentsIdGetResponsesContentApplicationJsonSchemaDataContract" }, "created_at": { "description": "Long date-time format following ISO-8601", "format": "date-time", "type": "string" }, "currency_code": { "description": "Three-letter ISO-4217 currency code.", "maxLength": 3, "minLength": 3, "pattern": "^[A-Z]{3}$", "type": "string" }, "custom_scale": { "description": "A custom unit of measurement if the standard 'scale' is not applicable.", "type": [ "string", "null" ] }, "date_submitted": { "description": "Long date-time format following ISO-8601", "format": "date-time", "type": "string" }, "description": { "description": "Details or notes regarding the adjustment.", "type": "string" }, "id": { "description": "Unique identifier of this resource.", "format": "uuid", "type": [ "string", "null" ] }, "invoice_id": { "description": "Deprecated. No longer used", "format": "double", "type": [ "number", "null" ] }, "invoice_public_id": { "description": "Public Identifier for the associated invoice.", "type": [ "string", "null" ] }, "payment_cycle": { "$ref": "#/components/schemas/InvoiceAdjustmentsIdGetResponsesContentApplicationJsonSchemaDataPaymentCycle" }, "quantity": { "description": "The quantity/number of units applied.", "format": "double", "type": [ "number", "null" ] }, "reported_by": { "$ref": "#/components/schemas/InvoiceAdjustmentsIdGetResponsesContentApplicationJsonSchemaDataReportedBy", "description": "The user who reported/submitted the adjustment." }, "reviewed_by": { "description": "The user who reviewed the adjustment.", "oneOf": [ { "$ref": "#/components/schemas/InvoiceAdjustmentsIdGetResponsesContentApplicationJsonSchemaDataReviewedBy" }, { "type": "null" } ] }, "scale": { "description": "The scale used for calculation (e.g., hourly, daily).", "type": [ "string", "null" ] }, "status": { "description": "status of invoice adjustment", "oneOf": [ { "$ref": "#/components/schemas/InvoiceAdjustmentsIdGetResponsesContentApplicationJsonSchemaDataStatus" }, { "type": "null" } ] }, "total_amount": { "description": "The total monetary value of the adjustment.", "type": "string" }, "type": { "$ref": "#/components/schemas/InvoiceAdjustmentsIdGetResponsesContentApplicationJsonSchemaDataType", "description": "Type of invoice adjustment." }, "worksheet": { "description": "Breakdown of the time/effort involved in the adjustment.", "oneOf": [ { "$ref": "#/components/schemas/InvoiceAdjustmentsIdGetResponsesContentApplicationJsonSchemaDataWorksheet" }, { "type": "null" } ] } }, "required": [ "id", "type", "status", "contract", "quantity", "worksheet", "attachment", "created_at", "description", "reported_by", "reviewed_by", "total_amount", "currency_code", "payment_cycle", "date_submitted" ], "title": "InvoiceAdjustmentsIdGetResponsesContentApplicationJsonSchemaData", "type": "object" }, "InvoiceAdjustmentsIdGetResponsesContentApplicationJsonSchemaDataApproversItems": { "properties": { "approved": { "description": "Whether the specific approver has approved the adjustment.", "type": "boolean" }, "email": { "description": "Email address of the approver.", "type": "string" }, "full_name": { "description": "Full name of the approver.", "type": "string" } }, "required": [ "approved" ], "title": "InvoiceAdjustmentsIdGetResponsesContentApplicationJsonSchemaDataApproversItems", "type": "object" }, "InvoiceAdjustmentsIdGetResponsesContentApplicationJsonSchemaDataAttachment": { "description": "File attachment linked to the invoice adjustment.", "properties": { "download_url": { "description": "URL used to download the uploaded attachment file.", "type": [ "string", "null" ] }, "filename": { "description": "Original filename of the uploaded attachment", "type": "string" }, "key": { "description": "Storage key returned from the attachments endpoint, can be used as a unique identifier for the file", "type": "string" } }, "required": [ "key", "filename" ], "title": "InvoiceAdjustmentsIdGetResponsesContentApplicationJsonSchemaDataAttachment", "type": "object" }, "InvoiceAdjustmentsIdGetResponsesContentApplicationJsonSchemaDataContract": { "properties": { "id": { "description": "The unique identifier of the contract.", "type": "string" }, "title": { "description": "The display title of the contract.", "type": "string" }, "type": { "$ref": "#/components/schemas/InvoiceAdjustmentsIdGetResponsesContentApplicationJsonSchemaDataContractType", "description": "Type of a contract" } }, "required": [ "id", "type", "title" ], "title": "InvoiceAdjustmentsIdGetResponsesContentApplicationJsonSchemaDataContract", "type": "object" }, "InvoiceAdjustmentsIdGetResponsesContentApplicationJsonSchemaDataContractType": { "description": "Type of a contract", "enum": [ "ongoing_time_based", "milestones", "time_based", "pay_as_you_go_time_based", "commission", "payg_milestones", "payg_tasks", "eor", "unknown", "employee", "global_payroll", "shield_msa", "hris_direct_employee", "peo" ], "title": "InvoiceAdjustmentsIdGetResponsesContentApplicationJsonSchemaDataContractType", "type": "string" }, "InvoiceAdjustmentsIdGetResponsesContentApplicationJsonSchemaDataPaymentCycle": { "properties": { "end_date": { "description": "Long date-time format following ISO-8601", "format": "date-time", "type": "string" }, "start_date": { "description": "Long date-time format following ISO-8601", "format": "date-time", "type": "string" } }, "required": [ "end_date", "start_date" ], "title": "InvoiceAdjustmentsIdGetResponsesContentApplicationJsonSchemaDataPaymentCycle", "type": "object" }, "InvoiceAdjustmentsIdGetResponsesContentApplicationJsonSchemaDataReportedBy": { "description": "The user who reported/submitted the adjustment.", "properties": { "full_name": { "description": "Full name of the reporter.", "type": "string" }, "id": { "$ref": "#/components/schemas/InvoiceAdjustmentsIdGetResponsesContentApplicationJsonSchemaDataReportedById" } }, "required": [ "id" ], "title": "InvoiceAdjustmentsIdGetResponsesContentApplicationJsonSchemaDataReportedBy", "type": "object" }, "InvoiceAdjustmentsIdGetResponsesContentApplicationJsonSchemaDataReportedById": { "oneOf": [ { "type": "string" }, { "format": "int64", "type": "integer" } ], "title": "InvoiceAdjustmentsIdGetResponsesContentApplicationJsonSchemaDataReportedById" }, "InvoiceAdjustmentsIdGetResponsesContentApplicationJsonSchemaDataReviewedBy": { "description": "The user who reviewed the adjustment.", "properties": { "full_name": { "description": "Full name of the reviewer.", "type": "string" }, "id": { "$ref": "#/components/schemas/InvoiceAdjustmentsIdGetResponsesContentApplicationJsonSchemaDataReviewedById" }, "remarks": { "description": "Comments or notes left by the reviewer.", "type": "string" }, "reviewed_at": { "description": "The timestamp when the review occurred.", "type": "string" } }, "required": [ "id", "remarks", "reviewed_at" ], "title": "InvoiceAdjustmentsIdGetResponsesContentApplicationJsonSchemaDataReviewedBy", "type": "object" }, "InvoiceAdjustmentsIdGetResponsesContentApplicationJsonSchemaDataReviewedById": { "oneOf": [ { "type": "string" }, { "format": "int64", "type": "integer" } ], "title": "InvoiceAdjustmentsIdGetResponsesContentApplicationJsonSchemaDataReviewedById" }, "InvoiceAdjustmentsIdGetResponsesContentApplicationJsonSchemaDataStatus": { "description": "status of invoice adjustment", "enum": [ "approved", "declined", "not_payable", "paid", "pending", "processing" ], "title": "InvoiceAdjustmentsIdGetResponsesContentApplicationJsonSchemaDataStatus", "type": "string" }, "InvoiceAdjustmentsIdGetResponsesContentApplicationJsonSchemaDataType": { "description": "Type of invoice adjustment.", "enum": [ "accrued_holiday", "additional_fee", "allowance", "bonus", "commission", "deduction", "deposit", "deposit_refund", "employer_cost", "expense", "health_allowance", "health_benefit", "health_insurance_fee", "legal_fee", "management_fee", "milestone", "offcycle", "other", "overtime", "pension", "pro_rata", "setup_fee", "severance", "shield_service", "signing_bonus", "signing_bonus_employer_cost", "refund", "task", "time_off", "vat", "withholding_tax", "work" ], "title": "InvoiceAdjustmentsIdGetResponsesContentApplicationJsonSchemaDataType", "type": "string" }, "InvoiceAdjustmentsIdGetResponsesContentApplicationJsonSchemaDataWorksheet": { "description": "Breakdown of the time/effort involved in the adjustment.", "properties": { "days": { "description": "Number of days.", "format": "double", "minimum": 0, "type": "number" }, "hours": { "description": "Number of hours.", "format": "double", "minimum": 0, "type": "number" }, "minutes": { "description": "Number of minutes.", "format": "double", "minimum": 0, "type": "number" }, "weeks": { "description": "Number of weeks.", "format": "double", "minimum": 0, "type": "number" } }, "required": [ "days", "hours", "weeks", "minutes" ], "title": "InvoiceAdjustmentsIdGetResponsesContentApplicationJsonSchemaDataWorksheet", "type": "object" }, "InvoiceAdjustmentsIdGetResponsesContentApplicationJsonSchemaErrorsItems": { "properties": { "code": { "description": "Machine-readable error code", "type": "string" }, "field": { "description": "Name of the field causing the error (for validation issues)", "type": "string" }, "message": { "description": "Human-readable explanation of the error", "type": "string" } }, "title": "InvoiceAdjustmentsIdGetResponsesContentApplicationJsonSchemaErrorsItems", "type": "object" }, "InvoiceAdjustmentsIdPatchRequestBodyContentApplicationJsonSchemaData": { "description": "Details of adjustment to update", "properties": { "amount": { "description": "Amount of adjustment.", "format": "double", "type": "number" }, "description": { "description": "Description of adjustment.", "type": "string" }, "title": { "description": "Title of adjustment.", "type": "string" } }, "title": "InvoiceAdjustmentsIdPatchRequestBodyContentApplicationJsonSchemaData", "type": "object" }, "InvoiceAdjustmentsIdPatchResponsesContentApplicationJsonSchemaData": { "properties": { "updated": { "description": "Confirms the update.", "type": "boolean" } }, "required": [ "updated" ], "title": "InvoiceAdjustmentsIdPatchResponsesContentApplicationJsonSchemaData", "type": "object" }, "InvoiceAdjustmentsIdPatchResponsesContentApplicationJsonSchemaErrorsItems": { "properties": { "code": { "description": "Machine-readable error code identifying the failure category.", "type": "string" }, "message": { "description": "Human-readable error message describing the unexpected condition.", "type": "string" } }, "required": [ "message" ], "title": "InvoiceAdjustmentsIdPatchResponsesContentApplicationJsonSchemaErrorsItems", "type": "object" }, "InvoiceAdjustmentsIdReviewsPostRequestBodyContentApplicationJsonSchemaData": { "properties": { "reason": { "description": "The reason for the adjustment update.", "maxLength": 200, "type": [ "string", "null" ] }, "status": { "$ref": "#/components/schemas/InvoiceAdjustmentsIdReviewsPostRequestBodyContentApplicationJsonSchemaDataStatus", "description": "The status of the adjustment." } }, "required": [ "status" ], "title": "InvoiceAdjustmentsIdReviewsPostRequestBodyContentApplicationJsonSchemaData", "type": "object" }, "InvoiceAdjustmentsIdReviewsPostRequestBodyContentApplicationJsonSchemaDataStatus": { "description": "The status of the adjustment.", "enum": [ "approved", "declined" ], "title": "InvoiceAdjustmentsIdReviewsPostRequestBodyContentApplicationJsonSchemaDataStatus", "type": "string" }, "InvoiceAdjustmentsIdReviewsPostResponsesContentApplicationJsonSchemaData": { "properties": { "created": { "description": "Confirms the review was applied to the invoice adjustment.", "type": "boolean" } }, "required": [ "created" ], "title": "InvoiceAdjustmentsIdReviewsPostResponsesContentApplicationJsonSchemaData", "type": "object" }, "InvoiceAdjustmentsIdReviewsPostResponsesContentApplicationJsonSchemaErrorsItems": { "properties": { "code": { "description": "Machine-readable error code identifying the failure category.", "type": "string" }, "message": { "description": "Human-readable error message describing the unexpected condition.", "type": "string" } }, "required": [ "message" ], "title": "InvoiceAdjustmentsIdReviewsPostResponsesContentApplicationJsonSchemaErrorsItems", "type": "object" }, "InvoiceAdjustmentsPostRequestBodyContentApplicationJsonSchemaData": { "description": "Payload attributes required to create one invoice adjustment with optional approval, preset, and grouping metadata.", "properties": { "amount": { "description": "Monetary amount to apply for this invoice adjustment, expressed in the contract currency as a positive number.", "format": "double", "minimum": 0, "type": "number" }, "contract_id": { "description": "Unique Deel contract identifier (public id) that receives this invoice adjustment line item.", "type": "string" }, "date_submitted": { "description": "Submission date in ISO-8601 short-date format (YYYY-MM-DD) used for filtering, reporting, and approvals.", "format": "date", "type": "string" }, "description": { "description": "Detailed human-readable explanation that appears on invoices and audit records visible to both parties.", "maxLength": 30000, "type": "string" }, "group_key": { "description": "When provided, invoice adjustments sharing the same group_key within the same payment cycle are merged into a single aggregated line item on the invoice. Requires is_auto_approved to be true.", "maxLength": 300, "type": [ "string", "null" ] }, "hourly_report_preset_id": { "description": "Identifier of an existing hourly report preset used to link standardized rate and scale metadata to this entry.", "format": "uuid", "type": [ "string", "null" ] }, "is_auto_approved": { "description": "When true, the created invoice adjustment skips manual approval and is approved immediately on creation.", "type": "boolean" }, "paymentCycleId": { "description": "Public id (UUID) of the active payment cycle required when creating VAT-related invoice adjustment entries against a specific cycle.", "format": "uuid", "type": [ "string", "null" ] }, "type": { "$ref": "#/components/schemas/InvoiceAdjustmentsPostRequestBodyContentApplicationJsonSchemaDataType", "description": "Invoice adjustment category that determines business rules and downstream invoicing behavior." } }, "required": [ "type", "amount", "contract_id", "description", "date_submitted" ], "title": "InvoiceAdjustmentsPostRequestBodyContentApplicationJsonSchemaData", "type": "object" }, "InvoiceAdjustmentsPostRequestBodyContentApplicationJsonSchemaDataType": { "description": "Invoice adjustment category that determines business rules and downstream invoicing behavior.", "enum": [ "bonus", "commission", "deduction", "expense", "other", "overtime", "time_off", "vat" ], "title": "InvoiceAdjustmentsPostRequestBodyContentApplicationJsonSchemaDataType", "type": "string" }, "InvoiceAdjustmentsPostResponsesContentApplicationJsonSchemaData": { "description": "Container object with identifiers, status, and creation metadata for the newly created invoice adjustment.", "properties": { "created": { "description": "Indicates whether the invoice adjustment record was successfully created by this request.", "type": "boolean" }, "created_at": { "description": "ISO-8601 timestamp recording the exact moment the invoice adjustment was created in the system.", "format": "date-time", "type": [ "string", "null" ] }, "id": { "$ref": "#/components/schemas/InvoiceAdjustmentsPostResponsesContentApplicationJsonSchemaDataId", "description": "Unique identifier returned for the created invoice adjustment resource after persistence succeeds." }, "status": { "description": "Current processing status assigned to the invoice adjustment after the create workflow finishes executing.", "oneOf": [ { "$ref": "#/components/schemas/InvoiceAdjustmentsPostResponsesContentApplicationJsonSchemaDataStatus" }, { "type": "null" } ] } }, "required": [ "created" ], "title": "InvoiceAdjustmentsPostResponsesContentApplicationJsonSchemaData", "type": "object" }, "InvoiceAdjustmentsPostResponsesContentApplicationJsonSchemaDataId": { "description": "Unique identifier returned for the created invoice adjustment resource after persistence succeeds.", "oneOf": [ { "type": "string" }, { "format": "int64", "type": "integer" } ], "title": "InvoiceAdjustmentsPostResponsesContentApplicationJsonSchemaDataId" }, "InvoiceAdjustmentsPostResponsesContentApplicationJsonSchemaDataStatus": { "description": "Current processing status assigned to the invoice adjustment after the create workflow finishes executing.", "enum": [ "approved", "declined", "not_payable", "paid", "pending", "processing" ], "title": "InvoiceAdjustmentsPostResponsesContentApplicationJsonSchemaDataStatus", "type": "string" }, "InvoiceAdjustmentsPostResponsesContentApplicationJsonSchemaErrorsItems": { "properties": { "code": { "description": "Stable machine-readable error code identifying the upstream or internal failure category.", "type": "string" }, "message": { "description": "Human-readable error message describing the unexpected condition that prevented completing the request.", "type": "string" } }, "required": [ "message" ], "title": "InvoiceAdjustmentsPostResponsesContentApplicationJsonSchemaErrorsItems", "type": "object" }, "InvoiceLineItemById-v2026-01-01RequestBadRequestError": { "properties": { "errors": { "items": { "$ref": "#/components/schemas/InvoiceAdjustmentsIdGetResponsesContentApplicationJsonSchemaErrorsItems" }, "type": "array" } }, "title": "InvoiceLineItemById-v2026-01-01RequestBadRequestError", "type": "object" }, "InvoiceLineItemsByContract-v2026-01-01RequestBadRequestError": { "properties": { "errors": { "description": "Error messages", "items": { "$ref": "#/components/schemas/ContractsContractIdInvoiceAdjustmentsGetResponsesContentApplicationJsonSchemaErrorsItems" }, "type": "array" }, "request": { "$ref": "#/components/schemas/ContractsContractIdInvoiceAdjustmentsGetResponsesContentApplicationJsonSchemaRequest", "description": "Error request details" } }, "required": [ "errors" ], "title": "InvoiceLineItemsByContract-v2026-01-01RequestBadRequestError", "type": "object" }, "InvoicesDeelGetResponsesContentApplicationJsonSchemaDataItems": { "properties": { "created_at": { "description": "Long date-time format following ISO-8601", "format": "date-time", "type": [ "string", "null" ] }, "currency": { "description": "Currency code.", "maxLength": 3, "minLength": 3, "pattern": "^[A-Z]{3}$", "type": "string" }, "id": { "description": "Unique identifier of the invoice.", "type": "string" }, "label": { "description": "Label of the invoice.", "type": "string" }, "status": { "$ref": "#/components/schemas/InvoicesDeelGetResponsesContentApplicationJsonSchemaDataItemsStatus", "description": "Current status of the invoice." }, "total": { "description": "Total invoice amount including Fee and VAT.", "type": "string" } }, "required": [ "id", "label", "total", "status", "currency", "created_at" ], "title": "InvoicesDeelGetResponsesContentApplicationJsonSchemaDataItems", "type": "object" }, "InvoicesDeelGetResponsesContentApplicationJsonSchemaDataItemsStatus": { "description": "Current status of the invoice.", "enum": [ "pending", "paid", "processing", "canceled", "skipped", "failed", "refunded" ], "title": "InvoicesDeelGetResponsesContentApplicationJsonSchemaDataItemsStatus", "type": "string" }, "InvoicesDeelGetResponsesContentApplicationJsonSchemaErrorsItems": { "properties": { "message": { "description": "A description of the returned error", "type": "string" } }, "required": [ "message" ], "title": "InvoicesDeelGetResponsesContentApplicationJsonSchemaErrorsItems", "type": "object" }, "InvoicesDeelGetResponsesContentApplicationJsonSchemaPage": { "properties": { "items_per_page": { "description": "Number of items per page", "format": "double", "maximum": 99, "minimum": 1, "type": "number" }, "offset": { "description": "Offset", "format": "double", "maximum": 999999999, "minimum": 0, "type": "number" }, "total_rows": { "description": "Total number of rows", "format": "double", "type": "number" } }, "required": [ "offset", "total_rows", "items_per_page" ], "title": "InvoicesDeelGetResponsesContentApplicationJsonSchemaPage", "type": "object" }, "InvoicesGetParametersInclude": { "enum": [ "cor" ], "title": "InvoicesGetParametersInclude", "type": "string" }, "InvoicesGetParametersStatus": { "enum": [ "all" ], "title": "InvoicesGetParametersStatus", "type": "string" }, "InvoicesGetResponsesContentApplicationJsonSchemaDataItems": { "properties": { "amount": { "description": "Billed amount of the invoice.", "type": [ "string", "null" ] }, "contract_id": { "description": "Unique identifier of the related contract.", "type": [ "string", "null" ] }, "created_at": { "description": "Date and time when the invoice was created (ISO-8601 format).", "format": "date-time", "type": "string" }, "currency": { "description": "Three-letter currency code for the invoice.", "maxLength": 3, "minLength": 3, "pattern": "^[A-Z]{3}$", "type": "string" }, "deel_fee": { "description": "Fee charged by Deel.", "type": [ "string", "null" ] }, "due_date": { "description": "Date and time when the invoice is due (ISO-8601 format).", "format": "date-time", "type": [ "string", "null" ] }, "id": { "description": "Unique identifier of this resource.", "type": "string" }, "is_overdue": { "description": "Indicates whether the invoice is overdue.", "type": [ "boolean", "null" ] }, "issued_at": { "description": "Date and time when the invoice was issued (ISO-8601 format).", "format": "date-time", "type": [ "string", "null" ] }, "label": { "description": "Label or reference number of the invoice.", "type": "string" }, "paid_at": { "$ref": "#/components/schemas/InvoicesGetResponsesContentApplicationJsonSchemaDataItemsPaidAt", "description": "Date/time when the invoice was paid (ISO-8601). May be null or empty string." }, "recipient_legal_entity_id": { "description": "Unique identifier for the recipient legal entity", "format": "uuid", "type": "string" }, "status": { "$ref": "#/components/schemas/InvoicesGetResponsesContentApplicationJsonSchemaDataItemsStatus", "description": "Current status of the invoice." }, "total": { "description": "Total invoice amount, including fees and VAT.", "type": "string" }, "vat_id": { "description": "VAT identification number related to the invoice.", "type": [ "string", "null" ] }, "vat_percentage": { "description": "Percentage of VAT charged on the invoice.", "type": [ "string", "null" ] }, "vat_total": { "description": "Total amount of VAT charged on the invoice.", "type": [ "string", "null" ] } }, "required": [ "id", "label", "total", "status", "vat_id", "paid_at", "currency", "due_date", "issued_at", "vat_total", "created_at", "is_overdue", "contract_id", "vat_percentage" ], "title": "InvoicesGetResponsesContentApplicationJsonSchemaDataItems", "type": "object" }, "InvoicesGetResponsesContentApplicationJsonSchemaDataItemsPaidAt": { "description": "Date/time when the invoice was paid (ISO-8601). May be null or empty string.", "oneOf": [ { "format": "date-time", "type": "string" }, { "type": "string" } ], "title": "InvoicesGetResponsesContentApplicationJsonSchemaDataItemsPaidAt" }, "InvoicesGetResponsesContentApplicationJsonSchemaDataItemsStatus": { "description": "Current status of the invoice.", "enum": [ "pending", "paid", "processing", "credited", "refunded" ], "title": "InvoicesGetResponsesContentApplicationJsonSchemaDataItemsStatus", "type": "string" }, "InvoicesGetResponsesContentApplicationJsonSchemaItems": { "properties": { "code": { "description": "Machine readable error", "type": "string" }, "message": { "description": "Description of the returned error", "type": "string" } }, "title": "InvoicesGetResponsesContentApplicationJsonSchemaItems", "type": "object" }, "InvoicesGetResponsesContentApplicationJsonSchemaPage": { "properties": { "cursor": { "description": "Cursor for paginated results.", "type": [ "string", "null" ] }, "items_per_page": { "description": "Number of items displayed per page.", "format": "double", "maximum": 99, "minimum": 1, "type": "number" }, "offset": { "description": "The starting position of the current page of results.", "format": "double", "maximum": 999999999, "minimum": 0, "type": "number" }, "total_rows": { "description": "Total number of rows available for the query.", "format": "double", "type": "number" } }, "required": [ "offset", "total_rows", "items_per_page" ], "title": "InvoicesGetResponsesContentApplicationJsonSchemaPage", "type": "object" }, "InvoicesIdDownloadGetResponsesContentApplicationJsonSchemaData": { "properties": { "expires_at": { "description": "The expiration date and time of the download URL, after which the URL will no longer be accessible.", "format": "date-time", "type": "string" }, "id": { "description": "Unique identifier of the invoice.", "type": "string" }, "url": { "description": "URL to the requested invoice for download. This URL may expire after a certain duration.", "type": [ "string", "null" ] } }, "required": [ "url" ], "title": "InvoicesIdDownloadGetResponsesContentApplicationJsonSchemaData", "type": "object" }, "InvoicesIdDownloadGetResponsesContentApplicationJsonSchemaErrorsItems": { "properties": { "code": { "description": "A machine-readable error code", "type": "string" }, "details": { "$ref": "#/components/schemas/InvoicesIdDownloadGetResponsesContentApplicationJsonSchemaErrorsItemsDetails", "description": "Additional error context, when applicable" }, "field": { "description": "The request field the error relates to, when applicable", "type": "string" }, "message": { "description": "A description of the returned error", "type": "string" } }, "required": [ "code", "message" ], "title": "InvoicesIdDownloadGetResponsesContentApplicationJsonSchemaErrorsItems", "type": "object" }, "InvoicesIdDownloadGetResponsesContentApplicationJsonSchemaErrorsItemsDetails": { "description": "Additional error context, when applicable", "properties": {}, "title": "InvoicesIdDownloadGetResponsesContentApplicationJsonSchemaErrorsItemsDetails", "type": "object" }, "InvoicesInvoiceIdGetResponsesContentApplicationJsonSchemaData": { "description": "The invoice resource returned", "properties": { "created_at": { "description": "Timestamp of when the invoice was created in the system", "format": "date-time", "type": "string" }, "currency": { "description": "Currency code for the invoice total", "type": "string" }, "due_date": { "description": "The due date for the invoice payment", "format": "date-time", "type": "string" }, "id": { "description": "Unique identifier for the invoice", "type": "string" }, "issued_at": { "description": "Date and time when the invoice was issued", "format": "date-time", "type": "string" }, "label": { "description": "Human-readable label or reference number for the invoice", "type": "string" }, "line_items": { "description": "The individual line items associated with the invoice", "items": { "$ref": "#/components/schemas/InvoicesInvoiceIdGetResponsesContentApplicationJsonSchemaDataLineItemsItems" }, "type": "array" }, "paid_at": { "description": "Date and time when the invoice was paid", "format": "date-time", "type": "string" }, "recipient_legal_entity_id": { "description": "Unique identifier for the recipient legal entity", "format": "uuid", "type": "string" }, "status": { "$ref": "#/components/schemas/InvoicesInvoiceIdGetResponsesContentApplicationJsonSchemaDataStatus", "description": "Current payment status of the invoice." }, "total": { "description": "Total amount of the invoice", "type": "string" }, "worker_id": { "description": "Unique identifier for the worker profile", "format": "uuid", "type": "string" } }, "title": "InvoicesInvoiceIdGetResponsesContentApplicationJsonSchemaData", "type": "object" }, "InvoicesInvoiceIdGetResponsesContentApplicationJsonSchemaDataLineItemsItems": { "properties": { "adjustment_id": { "description": "For line items sourced from an EOR adjustment payout, the id of the originating adjustment — matches the id returned by the Retrieve adjustments API (GET /contracts/{contract_id}/adjustments). Null for non-adjustment line items (e.g. fees, deposits). Global Payroll adjustment correlation is not yet supported. Note: for legacy (pre-migration) EOR adjustments the Retrieve adjustments API may return a legacy id instead; those historical line items may not correlate.", "type": [ "string", "null" ] }, "description": { "description": "Main description of the line item", "type": "string" }, "fx_rate": { "description": "Exchange rate used for this line item", "type": "string" }, "id": { "description": "Unique identifier for the line item", "type": "string" }, "price_per_unit": { "description": "Price charged per unit", "format": "double", "type": "number" }, "pricing_fx_rate": { "description": "Exchange rate used for pricing calculations on this line item", "type": "string" }, "quantity": { "description": "Quantity of units billed in this line item", "type": "integer" }, "sub_description": { "description": "Optional additional description or detail", "type": "string" }, "tax_rate": { "description": "Tax rate applied to this line item", "type": "string" }, "tax_type": { "description": "Type of tax applied (if any); can be null", "type": [ "string", "null" ] }, "total": { "description": "Total amount for this line item", "type": "string" }, "type": { "$ref": "#/components/schemas/InvoicesInvoiceIdGetResponsesContentApplicationJsonSchemaDataLineItemsItemsType", "description": "The type of this line item" } }, "title": "InvoicesInvoiceIdGetResponsesContentApplicationJsonSchemaDataLineItemsItems", "type": "object" }, "InvoicesInvoiceIdGetResponsesContentApplicationJsonSchemaDataLineItemsItemsType": { "description": "The type of this line item", "enum": [ "AI_WORKFORCE_MONTHLY_FEE", "ANON_REPORT_FEE", "ANYTIME_PAY_GP_RESERVE", "ASO_FEE", "ASO_PAYROLL_FUNDING", "ATS_LINKEDIN_PREMIUM_FEE", "BACKGROUND_CHECK_FEE", "BANK_ACCOUNT_OPENING_FEE", "BANK_FILE_FEE", "BENEFITS_ADMIN_MONTHLY_PLATFORM_FEE", "CLIENT_PREFUNDING_AMOUNT", "COR_LOCAL_COLLECTION_FEE", "COR_START_DELAY", "CUSTOM_DOMAIN_FEE", "CUSTOM_ONE_OFF_COST", "CUSTOM_ONE_OFF_FEE", "DEEL_ATS_SUBSCRIPTIONS", "DEEL_COMPENSATION_FEE", "DEEL_ENGAGE_ATS_FEE", "DEEL_ENGAGE_MONTHLY_SUBSCRIPTION_FEE", "DEEL_FIELD_SERVICES_EOR_FEES", "DEEL_FIELD_SERVICES_PASSTHROUGH_FEES", "DEEL_FIELD_SERVICES_SWM_FEES", "DEEL_HR_FEE", "DEEL_HRIS_FEE", "DEEL_IT_ACCESSORY_REPLACEMENT", "DEEL_IT_APP_RESALE", "DEEL_IT_ASSEMBLED_DELIVERY", "DEEL_IT_BYOD_ACTIVATION_FEE", "DEEL_IT_BYOD_STORAGE_FEE", "DEEL_IT_CANCELLATION", "DEEL_IT_CERTIFIED_DATA_ERASURE", "DEEL_IT_CLEARANCE", "DEEL_IT_CUSTOM_SHIPPING", "DEEL_IT_CUSTOM_SOURCING", "DEEL_IT_DEVICE_UNLOCK_FEE", "DEEL_IT_ENDPOINT_PROTECTION_FEES", "DEEL_IT_ENDPOINT_PROTECTION_FEES_OVERAGES", "DEEL_IT_END_OF_CONTRACT_PURCHASE", "DEEL_IT_EXPRESS_SHIPPING", "DEEL_IT_EXTENDED_WARRANTY", "DEEL_IT_IDENTITY_FEES", "DEEL_IT_IDENTITY_FEES_OVERAGES", "DEEL_IT_IT_SEAT", "DEEL_IT_IT_SERVICE_DESK", "DEEL_IT_JC_PLATFORM_FEES", "DEEL_IT_JC_PLATFORM_FEES_OVERAGES", "DEEL_IT_JC_PLATFORMPRIME_FEES", "DEEL_IT_JC_PLATFORMPRIME_FEES_OVERAGES", "DEEL_IT_LAPTOP_CONFIG", "DEEL_IT_LOANER", "DEEL_IT_MDM", "DEEL_IT_MDM_OVERAGES", "DEEL_IT_NON_DEEL_IT_DEVICE_CHARGE", "DEEL_IT_PACKAGING", "DEEL_IT_PURCHASE", "DEEL_IT_REDISTRIBUTION_FEE", "DEEL_IT_RENTAL", "DEEL_IT_REPAIR", "DEEL_IT_REPAIR_WITH_PARTS", "DEEL_IT_REPLACEMENT", "DEEL_IT_SAAS", "DEEL_IT_SERVICE", "DEEL_IT_SERVICE_BUNDLE", "DEEL_IT_SHIPPING", "DEEL_IT_SINGLE_ITEM_FEE", "DEEL_IT_STOREFRONT_FEE", "DEEL_IT_STORE_AND_REUSE_CUSTOMER_OWNED_FEE", "DEEL_IT_STORE_AND_REUSE_CUSTOMER_OWNED_STORAGE_FEE", "DEEL_IT_STORE_AND_REUSE_FEE", "DEEL_IT_VAT", "DEEL_IT_WELCOME_PACK", "DEEL_MAINTENANCE_FEE", "DEEL_TALENT_CLIENT_SAAS_FEE_ONE_OFF", "DEEL_TALENT_CLIENT_SAAS_FEE_RECURRING", "DEEL_TALENT_TP_SAAS_FEE_ONE_OFF", "DEEL_TALENT_TP_SAAS_FEE_RECURRING", "DEEL_WORKFORCE_PLANNING_SUBSCRIPTIONS", "DEPOSIT_REFUND", "DISCOUNT", "DPA_AGREEMENT_FEE", "EMPLOYEE_NAVIGATOR_IMPLEMENTATION_FEE", "EMPLOYEE_NAVIGATOR_PEPM_FEE", "ENGAGE_HR_SUITE_SUBSCRIPTION_FEE", "ENGAGE_PLUGINS_SUBSCRIPTION_FEE", "ENGAGE_ZAVVY_LEGACY_SUBSCRIPTION_FEE", "ENTITY_MANAGEMENT_PLATFORM_FEE", "ENTITY_SETUP_FEE", "EOR_13_TH_14_TH_MONTH_SALARY", "EOR_13_TH_MONTH_SALARY", "EOR_ACCIDENT_AND_DISABILITY", "EOR_ACCIDENT_AND_DISABILITY_FEE", "EOR_ACCRUED_HOLIDAY", "EOR_ADDITIONAL_FEE", "EOR_ALLOWANCE", "EOR_ANYTIME_PAYROLL_FEE", "EOR_BENEFIT_IN_KIND_WITHHELD_AMOUNT", "EOR_BONUS", "EOR_COMPANY_DOCTOR_COST", "EOR_DEDUCTION", "EOR_DEPOSIT", "EOR_EARLY_INVOICING_FUNDING_AMOUNT", "EOR_EMPLOYER_COST", "EOR_EQUITY_TAX_WITHHELD", "EOR_EXPENSE", "EOR_EXTERNAL_LEGAL_ADVISORY_COST", "EOR_FERTILITY", "EOR_FERTILITY_FEE", "EOR_FERTILITY_PLAN_COST", "EOR_FOREIGN_CURRENCY_CONTRACT_FEE", "EOR_FOREIGN_CURRENCY_FEE", "EOR_HEALTH_ALLOWANCE", "EOR_HEALTH_ALLOWANCE_PLAN_COST", "EOR_HEALTH_AND_SAFETY_TRAINING_COST", "EOR_HEALTH_BENEFIT", "EOR_HEALTH_BENEFIT_PLAN_COST", "EOR_HEALTH_INSURANCE_FEE", "EOR_LEGAL_FEE", "EOR_LEGAL_SETTLEMENT_PAYOUT", "EOR_LIFE_INSURANCE", "EOR_LIFE_INSURANCE_FEE", "EOR_LIFE_INSURANCE_PLAN_COST", "EOR_LOCAL_COLLECTION_FEE", "EOR_MANAGEMENT_FEE", "EOR_MEAL_VOUCHER", "EOR_MEAL_VOUCHER_FEE", "EOR_MEAL_VOUCHER_PLAN_COST", "EOR_MEDICAL_ONBOARDING_COST", "EOR_MENTAL_HEALTH", "EOR_MENTAL_HEALTH_FEE", "EOR_MENTAL_HEALTH_PLAN_COST", "EOR_NON_STATUTORY_EMPLOYER_COST", "EOR_OFFCYCLE", "EOR_OFF_BOARDING_FEE", "EOR_OTHER", "EOR_PENSION", "EOR_PENSION_FEE", "EOR_PENSION_PLAN_COST", "EOR_QES_FEE", "EOR_SALARY_ADVANCE", "EOR_SETUP_FEE", "EOR_SEVERANCE", "EOR_SIGNING_BONUS", "EOR_SIGNING_BONUS_DEDUCTION", "EOR_SIGNING_BONUS_EMPLOYER_COST", "EOR_SIGNING_BONUS_EMPLOYER_COST_DEDUCTION", "EOR_SINGLE_TERMINATION_FEE", "EOR_START_DELAY", "EOR_STUDY_FUND", "EOR_STUDY_FUND_FEE", "EOR_STUDY_FUND_PLAN_COST", "EOR_TAX_RULING", "EOR_TAX_VAT", "EOR_TIME_OFF", "EOR_TRAVEL_INSURANCE_ANNUAL_SUBSCRIPTION_FEE", "EOR_TRAVEL_INSURANCE_MONTHLY_SUBSCRIPTION_FEE", "EOR_VISA_MANAGEMENT_FEE", "EOR_WET_INK_FEE", "EOR_WORK", "EQUITY_ANNUAL_SUBSCRIPTION_FEE", "EQUITY_EOR_PER_HEAD_FEE", "EQUITY_IMPLEMENTATION_FEE", "EQUITY_MAINTENANCE_FEE", "EXPENSE_CARD", "EXPENSE_CARD_FEE", "G2N_BENEFITS", "G2N_BENEFIT_IN_KIND", "G2N_EMPLOYER_CONTRIBUTIONS", "G2N_EOR_NET_PAY_WITHOUT_EXPENSES", "G2N_GROSS_DEDUCTIONS", "G2N_GROSS_TAXABLE", "G2N_NET_ADDITIONS", "G2N_NET_DEDUCTIONS", "G2N_NET_PAY", "G2N_ODP_OFFSET", "G2N_ON_CALL_OVERTIME", "G2N_OTHER_ADJUSTMENTS", "G2N_PAY_RATE", "G2N_SEVERANCE", "G2N_TOTAL_EXPENSES", "G2N_VACATION_PAYOUT", "G2N_WAGE_ADDITIONS", "G2N_WORKER_TAX_AND_CONTRIBUTIONS", "GLOBAL_HR_CONSULTING_ANNUAL_SUBSCRIPTION_FEE", "GLOBAL_HR_CONSULTING_EOR_MASS_TERMINATION_FEE", "GLOBAL_HR_CONSULTING_MANAGED_HR_MONTHLY_SUBSCRIPTION_FEE", "GLOBAL_HR_CONSULTING_MONTHLY_SUBSCRIPTION_FEE", "GLOBAL_HR_CONSULTING_PROJECT_FEE", "GLOBAL_HR_DPO_AS_A_SERVICE_ANNUAL_SUBSCRIPTION_FEE", "GLOBAL_HR_EU_UK_REPRESENTATIVE_SERVICE_ANNUAL_SUBSCRIPTION_FEE", "GLOBAL_HR_PRIVACY_CONSULTING_SERVICES_ANNUAL_SUBSCRIPTION_FEE", "GLOBAL_HR_PRIVACY_SERVICES_ANNUAL_SUBSCRIPTION_FEE", "GL_CUSTOM_CONFIGURATION", "GP_ADD_ON_FEE", "GP_ADVANCE_PAYMENTS_FEE", "GP_BANK_ACCOUNTS_OPENED", "GP_CHINA_DECLARATIONS", "GP_DEEL_LIABILITY", "GP_DEPOSIT", "GP_EARLY_TERMINATION_FEE", "GP_ELECTRONIC_SAFE_PAYSLIPS", "GP_EMPLOYEE_AGREEMENTS_EFE", "GP_EMPLOYEE_FUNDING", "GP_EXCEPTIONAL_MATTERS_HOURS_FEE", "GP_EXPENSES_FEE", "GP_GB_PENSION_FUND_MANAGEMENT", "GP_GLOBAL_RERUN_OF_PAYROLL_REPORTS_FEE", "GP_LEGAL_CONTROL_ASSISTANCE_HOURS_FEE", "GP_MEAL_VOUCHERS", "GP_MEDICAL_VISITS", "GP_NEW_BRANCH_CREATION_ASSISTANCES", "GP_NEW_REPORTS_AND_MODIFICATIONS_FEE", "GP_NON_AUTOMATED_LODGEMENTS_FEE", "GP_OFFCYCLE_MODIFICATIONS_OR_RERUN_FEE", "GP_PARALLEL_RUN_FEE", "GP_PAYROLL_CONNECT_FEE", "GP_PAYROLL_CONNECT_SETUP_ENTITY_FEE_FLAT", "GP_PAYROLL_EMPLOYEE_FEE", "GP_PAYROLL_EMPLOYEE_SERVICE_FEE", "GP_PAYROLL_ENTITY_SETUP_FEE", "GP_PAYROLL_FEE", "GP_PAYROLL_FEE_PER_COUNTRY", "GP_PAYROLL_FUNDING_FEE", "GP_PAYROLL_OFFBOARDING_FEE", "GP_PAYROLL_ONBOARDING_FEE", "GP_PAYROLL_SOFTWARE_FEE", "GP_START_DELAY", "GP_VAT_TAX", "GP_WORK_VISAS", "GP_YEARLY_CLOSING_FEE", "HEALTH_INSURANCE_ANNUAL_SUBSCRIPTION_FEE", "HEALTH_INSURANCE_FEE", "HEALTH_INSURANCE_MONTHLY_SUBSCRIPTION_FEE", "HOFY_EQUIPMENT_MONTHLY_SUBSCRIPTION_FEE", "HOFY_EQUIPMENT_SEMIANNUAL_SUBSCRIPTION_FEE", "HOFY_EQUIPMENT_SERVICE", "HOFY_EQUIPMENT_TERMINATION_FEE", "IC_BONUS", "IC_COMMISSION", "IC_DEDUCTION", "IC_DEEL_PERCENTAGE_FEE", "IC_DEEL_PREMIUM", "IC_EXPENSE", "IC_MILESTONE", "IC_OFFCYCLE", "IC_OTHER", "IC_OVERTIME", "IC_PRO_RATA", "IC_SAAS_FLAT", "IC_SAAS_MISSING_FEES", "IC_SAAS_PER_CONTRACT", "IC_START_DELAY", "IC_TASK", "IC_TAX_VAT", "IC_TIME_OFF", "IC_WITHHOLDING_TAX", "IC_WORK", "INTEGRATION_HRIS_FEE", "INTERCOMPANY_MARKUP_SALARY_EXPENSES", "INTERCOMPANY_OTHER_FINANCIAL_EXPENSES", "INTERCOMPANY_OTHER_FINANCIAL_INCOME", "INTERCOMPANY_PAYMENTS_LEASE_SERVICES", "INTERCOMPANY_PAYMENTS_MARKET_PENETRATION", "INTERCOMPANY_PAYMENT_EOR_GP_SERVICES", "INTERCOMPANY_PAYMENT_EOR_SERVICES", "INTERCOMPANY_PAYMENT_GP_SERVICES", "INTERCOMPANY_PAYMENT_TECHNOLOGY_BASED_SERVICES", "INTERCOMPANY_PROVISION_COGS_SERVICES", "INTERCOMPANY_PROVISION_G_AND_A_SERVICES", "INTERCOMPANY_PROVISION_PRE_POST_SALES_SERVICES", "INTERCOMPANY_PROVISION_R_AND_D_SERVICES", "INTERCOMPANY_SALARY_EXPENSES_PARTICIPATION", "LATE_PAYMENT_FEE", "LOCAL_TAX_REIMBURSEMENT_FEE", "MANAGED_HR_MONTHLY_SUBSCRIPTION_FEE", "MOBILITY_BUSINESS_VISA_APPLICATION", "MOBILITY_BUSINESS_VISA_DOCUMENT_PREPARATION", "MOBILITY_BUSINESS_VISA_ISSUANCE", "MOBILITY_BUSINESS_VISA_TRAVEL_LETTER", "MOBILITY_DOCUMENTATION_FEE", "MOBILITY_DOCUMENT_A_ONE_CERTIFICATE", "MOBILITY_DOCUMENT_COLLECTION", "MOBILITY_DOCUMENT_ISSUANCE", "MOBILITY_DOCUMENT_MANAGEMENT", "MOBILITY_DOCUMENT_PREPARATION", "MOBILITY_DOCUMENT_REVIEW", "MOBILITY_EXPENSE_GOVERNMENT_FEES", "MOBILITY_EXPENSE_MAIL_TRANSPORTATION", "MOBILITY_EXPENSE_OTHER", "MOBILITY_EXPENSE_PRINTING", "MOBILITY_EXPENSE_TRANSLATION", "MOBILITY_GOVERNMENT_STATUTORY_LEGAL_FEE", "MOBILITY_H1_B_LOTTERY", "MOBILITY_IMMIGRATION_CONSULTATION", "MOBILITY_IMMIGRATION_DEPENDANT", "MOBILITY_IMMIGRATION_DEPENDANT_RENEWAL", "MOBILITY_IMMIGRATION_EMPLOYER_TRANSFER", "MOBILITY_IMMIGRATION_FAST_TRACK", "MOBILITY_IMMIGRATION_PROCESSING_FEE", "MOBILITY_IMMIGRATION_RENEWAL_EXTENSION", "MOBILITY_IMMIGRATION_VISA_CANCELLATION", "MOBILITY_IMMIGRATION_WORK_PERMIT", "MOBILITY_NOTIFICATION_CHANGE_OF_EMPLOYER", "MOBILITY_NOTIFICATION_GENERAL", "MOBILITY_NOTIFICATION_PREFECTURE", "MOBILITY_USCIS_PREMIUM_PROCESSING", "NETX_FEE", "OFFICE_SOLUTION_COST", "OFFICE_SOLUTION_FEE", "PAYGROUP_ASTUTE_CUSTOM_DEVELOPMENT_FEE", "PAYGROUP_ASTUTE_FEE", "PAYGROUP_ASTUTE_IMPLEMENTATION_FEE", "PAYGROUP_ASTUTE_INTEGRATION_FEE", "PAYGROUP_COR_CONTRACTOR_COST", "PAYGROUP_COR_MANAGEMENT_FEE", "PAYGROUP_EOR_DEPOSIT", "PAYGROUP_EOR_EMPLOYEE_COST", "PAYGROUP_EOR_MANAGEMENT_FEE", "PAYGROUP_FLARE_REFERRAL_FEE", "PAYGROUP_GP_ADDITIONAL_PROCESSING_FEE_OFFCYCLES", "PAYGROUP_GP_ADDITIONAL_PROCESSING_FEE_ONBOARDING", "PAYGROUP_GP_ADDITIONAL_PROCESSING_FEE_TERMINATIONS", "PAYGROUP_GP_ANNUAL_LODGEMENT_PROCESSING_FEE", "PAYGROUP_GP_ANNUAL_PAYMENT_SUMMARY_FEE", "PAYGROUP_GP_EMPLOYEE_REPORT_FEE", "PAYGROUP_GP_IMPLEMENTATION_FEE", "PAYGROUP_GP_LODGEMENT_FEE", "PAYGROUP_GP_TREASURY_FEE", "PAYGROUP_HR_MANAGEMENT_FEE", "PAYGROUP_HR_MANAGER_FEE", "PAYGROUP_IWS_BAS_LODGEMENT_FEE", "PAYGROUP_IWS_BOOKKEEPING_FEE", "PAYGROUP_IWS_IMPLEMENTATION_FEE", "PAYGROUP_IWS_ROSTERING_FEE", "PAYGROUP_PAYROLL_PROCESSING_FEE", "PAYGROUP_RECRUITMENT_FEE", "PAYGROUP_SMS_FEE", "PAYGROUP_TALENTOZ_ANNUAL_SUBSCRIPTION_FEE", "PAYGROUP_TALENTOZ_IMPLEMENTATION_FEE", "PAYGROUP_TAX_CGST", "PAYGROUP_TAX_CONSUMPTION", "PAYGROUP_TAX_GST", "PAYGROUP_TAX_IGST", "PAYGROUP_TAX_SGST", "PAYGROUP_TAX_SST", "PAYGROUP_TAX_VAT", "PAYMENT_PROCESSING_FEE", "PEO_CARROT_FERTILITY_JOURNEY_FEE", "PEO_COBRA_CONTINUATION_FEE", "PEO_EARLY_TERMINATION_FEE", "PEO_EMPLOYEE_FUNDING", "PEO_EXPENSES_FEE", "PEO_FEE", "PEO_LATE_PAYMENT_FEE", "PEO_OFFCYCLE_FEE", "PEO_NON_PEO_EE_MINERAL_ACCESS_FEE", "PEO_PAYROLL_COST", "PEO_POSTERS", "PEO_RETIREMENT_PLAN_ADMIN_FEE", "PEO_RETIREMENT_PLAN_ESTABLISHMENT_FEE", "PEO_RETROACTIVE_FEE", "PEO_TIMECO_FEE", "PEO_WC_BILLING_ND", "PEO_WC_BILLING_OH", "PEO_WC_BILLING_WA", "PEO_WC_BILLING_WY", "PEO_DELIVERY_FEE", "PEO_IMPLEMENTATION_FEE", "POST_REGISTRATION_FEE", "PREPAID_BILLING_CONTRACTOR", "PREPAID_BILLING_EOR", "PREPAID_BILLING_EXPIRED_CREDITS", "PREPAID_BILLING_FUNDING_AMOUNT", "PRE_REGISTRATION_FEE", "REFUND", "SAAS_PER_EQUIPMENT_FEE", "SERVICE_REFUND", "SHIELD_DEPOSIT", "SHIELD_MANAGEMENT_FEE", "SHIELD_PAYROLL_COSTS", "SYSTEM_INTEGRATOR_FEE", "TALENT_FEE", "TAX_CUSTOM", "TRAVEL_INSURANCE_ANNUAL_SUBSCRIPTION_FEE", "TRAVEL_INSURANCE_FEE", "TRAVEL_INSURANCE_MONTHLY_SUBSCRIPTION_FEE", "UNSPECIFIED", "US_OFFCYCLE_MODIFICATIONS_OR_RERUN_FEE", "US_PAYROLL_CERTIFICATE_OF_GOOD_STANDING_FEE", "US_PAYROLL_DUPLICATE_FILING_FEE", "US_PAYROLL_EMPLOYEE_FEE", "US_PAYROLL_EMPLOYEE_FUNDING", "US_PAYROLL_EXPENSES_FEE", "US_PAYROLL_FRANCHISE_REGISTRATION_SETUP_FEE", "US_PAYROLL_FRANCHISE_REGISTRATION_STATE_FILING_FEE", "US_PAYROLL_FUNDING_FEE", "US_PAYROLL_MAILING_FEE", "US_PAYROLL_OFFBOARDING_FEE", "US_PAYROLL_ONBOARDING_FEE", "US_PAYROLL_PAYROLL_REGISTRATION_SETUP_FEE", "US_PAYROLL_PLATFORM_FEE", "US_PAYROLL_REGISTERED_AGENT_ANNUAL_SUBSCRIPTION_FEE", "VMS_TALENT_PARTNER_FEE", "WEWORK_ACCESS_FEE", "WITHHOLDING_TAX", "EOR_HEALTH_AND_SAFETY_TRAINING_FEE" ], "title": "InvoicesInvoiceIdGetResponsesContentApplicationJsonSchemaDataLineItemsItemsType", "type": "string" }, "InvoicesInvoiceIdGetResponsesContentApplicationJsonSchemaDataStatus": { "description": "Current payment status of the invoice.", "enum": [ "open", "pending", "skipped", "preprocessing", "processing", "credited", "processed", "paid", "failed", "cancelled", "refunded", "unpayable", "awaiting_payment" ], "title": "InvoicesInvoiceIdGetResponsesContentApplicationJsonSchemaDataStatus", "type": "string" }, "InvoicesInvoiceIdGetResponsesContentApplicationJsonSchemaErrorsItems": { "properties": { "message": { "description": "Error response", "type": "string" } }, "required": [ "message" ], "title": "InvoicesInvoiceIdGetResponsesContentApplicationJsonSchemaErrorsItems", "type": "object" }, "InvoicesInvoiceIdGetResponsesContentApplicationJsonSchemaRequest": { "description": "Error request details", "properties": { "method": { "description": "Method of the API", "type": "string" }, "status": { "description": "Status of API response", "format": "double", "type": "number" } }, "title": "InvoicesInvoiceIdGetResponsesContentApplicationJsonSchemaRequest", "type": "object" }, "ItAgreementsAgreementIdGetParametersXBeta": { "default": "true", "enum": [ "true" ], "title": "ItAgreementsAgreementIdGetParametersXBeta", "type": "string" }, "ItAgreementsAgreementIdGetResponsesContentApplicationJsonSchemaData": { "properties": { "actions": { "$ref": "#/components/schemas/ItAgreementsAgreementIdGetResponsesContentApplicationJsonSchemaDataActions", "description": "Snapshot of which agreement-level actions are currently callable on this agreement." }, "assigned_hris_profile": { "description": "Current holder of the agreement, if any. `null` while the agreement is between users\n(e.g. after POST /assets/{id}/store).", "oneOf": [ { "$ref": "#/components/schemas/ItAgreementsAgreementIdGetResponsesContentApplicationJsonSchemaDataAssignedHrisProfile" }, { "type": "null" } ] }, "billing_entity_id": { "description": "ID of the billing entity that pays for this agreement. `null` when the billing entity is\nno longer active.", "format": "uuid", "type": [ "string", "null" ] }, "created_at": { "description": "When the agreement was created.", "format": "date-time", "type": "string" }, "end_date": { "description": "Agreement end date. `null` while the agreement is open.", "format": "date", "type": [ "string", "null" ] }, "id": { "description": "Unique identifier of the agreement.", "format": "uuid", "type": "string" }, "product": { "$ref": "#/components/schemas/ItAgreementsAgreementIdGetResponsesContentApplicationJsonSchemaDataProduct", "description": "The product this agreement is for." }, "public_id": { "description": "Public identifier of the agreement.", "type": "string" }, "start_date": { "description": "Agreement start date.", "format": "date", "type": [ "string", "null" ] }, "status": { "$ref": "#/components/schemas/ItAgreementsAgreementIdGetResponsesContentApplicationJsonSchemaDataStatus", "description": "Normalised agreement status." }, "store_and_reuse": { "description": "Store-and-reuse block. Present only when the agreement is a rental with store-and-reuse\nenabled.", "oneOf": [ { "$ref": "#/components/schemas/ItAgreementsAgreementIdGetResponsesContentApplicationJsonSchemaDataStoreAndReuse" }, { "type": "null" } ] }, "type": { "$ref": "#/components/schemas/ItAgreementsAgreementIdGetResponsesContentApplicationJsonSchemaDataType", "description": "Agreement type." }, "updated_at": { "description": "When the agreement was last updated.", "format": "date-time", "type": "string" }, "variant_id": { "description": "The currently-assigned product variant.", "format": "uuid", "type": "string" } }, "required": [ "id", "type", "status", "actions", "product", "end_date", "public_id", "created_at", "start_date", "updated_at", "variant_id", "store_and_reuse", "billing_entity_id", "assigned_hris_profile" ], "title": "ItAgreementsAgreementIdGetResponsesContentApplicationJsonSchemaData", "type": "object" }, "ItAgreementsAgreementIdGetResponsesContentApplicationJsonSchemaDataActions": { "description": "Snapshot of which agreement-level actions are currently callable on this agreement.", "properties": { "reuse": { "$ref": "#/components/schemas/ItAgreementsAgreementIdGetResponsesContentApplicationJsonSchemaDataActionsReuse", "description": "Backs POST /agreements/{agreement_id}/reassign." } }, "required": [ "reuse" ], "title": "ItAgreementsAgreementIdGetResponsesContentApplicationJsonSchemaDataActions", "type": "object" }, "ItAgreementsAgreementIdGetResponsesContentApplicationJsonSchemaDataActionsReuse": { "description": "Backs POST /agreements/{agreement_id}/reassign.", "properties": { "details": { "description": "Populated when `enabled = true` and the action has caller-relevant context to surface\n(see per-slot documentation). Null otherwise.", "oneOf": [ { "$ref": "#/components/schemas/ItAgreementsAgreementIdGetResponsesContentApplicationJsonSchemaDataActionsReuseDetails" }, { "type": "null" } ] }, "disabled_reason": { "description": "Populated when `is_enabled = false`; the single reason code the storefront gave for the\ndisabled state. Not a list — matches V2 action-slot semantics.", "oneOf": [ { "$ref": "#/components/schemas/ItAgreementsAgreementIdGetResponsesContentApplicationJsonSchemaDataActionsReuseDisabledReason" }, { "type": "null" } ] }, "is_enabled": { "description": "Whether the action is currently callable on this agreement.", "type": "boolean" } }, "required": [ "details", "is_enabled", "disabled_reason" ], "title": "ItAgreementsAgreementIdGetResponsesContentApplicationJsonSchemaDataActionsReuse", "type": "object" }, "ItAgreementsAgreementIdGetResponsesContentApplicationJsonSchemaDataActionsReuseDetails": { "description": "Populated when `enabled = true` and the action has caller-relevant context to surface\n(see per-slot documentation). Null otherwise.", "properties": { "reassignable_in": { "description": "Countries the contract can currently be reassigned to (customs / entity constraints).", "items": { "$ref": "#/components/schemas/ItAgreementsAgreementIdGetResponsesContentApplicationJsonSchemaDataActionsReuseDetailsReassignableInItems" }, "type": "array" }, "reusable_variants": { "description": "The subset of the parent product's variants that can be reassigned via store-and-reuse.\nThe original contract variant is appended as a fallback when the store-and-reuse filter\nreturns none.", "items": { "$ref": "#/components/schemas/ItAgreementsAgreementIdGetResponsesContentApplicationJsonSchemaDataActionsReuseDetailsReusableVariantsItems" }, "type": "array" } }, "required": [ "reassignable_in", "reusable_variants" ], "title": "ItAgreementsAgreementIdGetResponsesContentApplicationJsonSchemaDataActionsReuseDetails", "type": "object" }, "ItAgreementsAgreementIdGetResponsesContentApplicationJsonSchemaDataActionsReuseDetailsReassignableInItems": { "enum": [ "AD", "AE", "AF", "AG", "AI", "AL", "AM", "AN", "AO", "AQ", "AR", "AS", "AT", "AU", "AW", "AX", "AZ", "BA", "BB", "BD", "BE", "BF", "BG", "BH", "BI", "BJ", "BL", "BM", "BN", "BO", "BQ", "BR", "BS", "BT", "BV", "BW", "BY", "BZ", "CA", "CC", "CD", "CF", "CG", "CH", "CI", "CK", "CL", "CM", "CN", "CO", "CR", "CU", "CV", "CW", "CX", "CY", "CZ", "DE", "DJ", "DK", "DM", "DO", "DZ", "EC", "EE", "EG", "EH", "ER", "ES", "ET", "FI", "FJ", "FK", "FM", "FO", "FR", "GA", "GB", "GD", "GE", "GF", "GG", "GH", "GI", "GL", "GM", "GN", "GP", "GQ", "GR", "GS", "GT", "GU", "GW", "GY", "HK", "HM", "HN", "HR", "HT", "HU", "IC", "ID", "IE", "IL", "IM", "IN", "IO", "IQ", "IR", "IS", "IT", "JE", "JM", "JO", "JP", "KE", "KG", "KH", "KI", "KM", "KN", "KP", "KR", "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", "XK", "YE", "YT", "ZA", "ZM", "ZW" ], "title": "ItAgreementsAgreementIdGetResponsesContentApplicationJsonSchemaDataActionsReuseDetailsReassignableInItems", "type": "string" }, "ItAgreementsAgreementIdGetResponsesContentApplicationJsonSchemaDataActionsReuseDetailsReusableVariantsItems": { "properties": { "allowed_acquisition_types": { "description": "Acquisition types allowed for this variant", "items": { "$ref": "#/components/schemas/ItAgreementsAgreementIdGetResponsesContentApplicationJsonSchemaDataActionsReuseDetailsReusableVariantsItemsAllowedAcquisitionTypesItems" }, "type": "array" }, "allowed_rental_terms": { "description": "Rental terms permitted for this variant. Empty for non-rental variants.", "items": { "$ref": "#/components/schemas/ItAgreementsAgreementIdGetResponsesContentApplicationJsonSchemaDataActionsReuseDetailsReusableVariantsItemsAllowedRentalTermsItems" }, "type": "array" }, "available_countries": { "description": "ISO 3166 alpha-2 country codes where this variant can be ordered", "items": { "$ref": "#/components/schemas/ItAgreementsAgreementIdGetResponsesContentApplicationJsonSchemaDataActionsReuseDetailsReusableVariantsItemsAvailableCountriesItems" }, "type": "array" }, "id": { "description": "Unique identifier of the variant", "format": "uuid", "type": "string" }, "image": { "description": "Image of this variant, null when the variant has no image", "oneOf": [ { "$ref": "#/components/schemas/ItAgreementsAgreementIdGetResponsesContentApplicationJsonSchemaDataActionsReuseDetailsReusableVariantsItemsImage" }, { "type": "null" } ] }, "keyboard_layout": { "description": "Physical keyboard layout (laptops only)", "oneOf": [ { "$ref": "#/components/schemas/ItAgreementsAgreementIdGetResponsesContentApplicationJsonSchemaDataActionsReuseDetailsReusableVariantsItemsKeyboardLayout" }, { "type": "null" } ] }, "operating_system": { "description": "Operating system installed on this variant (devices only)", "oneOf": [ { "$ref": "#/components/schemas/ItAgreementsAgreementIdGetResponsesContentApplicationJsonSchemaDataActionsReuseDetailsReusableVariantsItemsOperatingSystem" }, { "type": "null" } ] }, "public_id": { "description": "Public identifier of the variant", "type": "string" }, "size": { "description": "Physical size or dimension label — style + size together uniquely identify a variant within a product", "type": [ "string", "null" ] }, "sku": { "description": "SKU of the variant", "type": [ "string", "null" ] }, "style": { "description": "Marketing style (colour, tier, etc.) — style + size together uniquely identify a variant within a product", "type": [ "string", "null" ] } }, "required": [ "id", "sku", "size", "image", "style", "public_id", "keyboard_layout", "operating_system", "available_countries", "allowed_rental_terms", "allowed_acquisition_types" ], "title": "ItAgreementsAgreementIdGetResponsesContentApplicationJsonSchemaDataActionsReuseDetailsReusableVariantsItems", "type": "object" }, "ItAgreementsAgreementIdGetResponsesContentApplicationJsonSchemaDataActionsReuseDetailsReusableVariantsItemsAllowedAcquisitionTypesItems": { "enum": [ "PURCHASE", "RENTAL", "REUSE" ], "title": "ItAgreementsAgreementIdGetResponsesContentApplicationJsonSchemaDataActionsReuseDetailsReusableVariantsItemsAllowedAcquisitionTypesItems", "type": "string" }, "ItAgreementsAgreementIdGetResponsesContentApplicationJsonSchemaDataActionsReuseDetailsReusableVariantsItemsAllowedRentalTermsItems": { "enum": [ "MONTH_12", "MONTH_24" ], "title": "ItAgreementsAgreementIdGetResponsesContentApplicationJsonSchemaDataActionsReuseDetailsReusableVariantsItemsAllowedRentalTermsItems", "type": "string" }, "ItAgreementsAgreementIdGetResponsesContentApplicationJsonSchemaDataActionsReuseDetailsReusableVariantsItemsAvailableCountriesItems": { "enum": [ "AD", "AE", "AF", "AG", "AI", "AL", "AM", "AN", "AO", "AQ", "AR", "AS", "AT", "AU", "AW", "AX", "AZ", "BA", "BB", "BD", "BE", "BF", "BG", "BH", "BI", "BJ", "BL", "BM", "BN", "BO", "BQ", "BR", "BS", "BT", "BV", "BW", "BY", "BZ", "CA", "CC", "CD", "CF", "CG", "CH", "CI", "CK", "CL", "CM", "CN", "CO", "CR", "CU", "CV", "CW", "CX", "CY", "CZ", "DE", "DJ", "DK", "DM", "DO", "DZ", "EC", "EE", "EG", "EH", "ER", "ES", "ET", "FI", "FJ", "FK", "FM", "FO", "FR", "GA", "GB", "GD", "GE", "GF", "GG", "GH", "GI", "GL", "GM", "GN", "GP", "GQ", "GR", "GS", "GT", "GU", "GW", "GY", "HK", "HM", "HN", "HR", "HT", "HU", "IC", "ID", "IE", "IL", "IM", "IN", "IO", "IQ", "IR", "IS", "IT", "JE", "JM", "JO", "JP", "KE", "KG", "KH", "KI", "KM", "KN", "KP", "KR", "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", "XK", "YE", "YT", "ZA", "ZM", "ZW" ], "title": "ItAgreementsAgreementIdGetResponsesContentApplicationJsonSchemaDataActionsReuseDetailsReusableVariantsItemsAvailableCountriesItems", "type": "string" }, "ItAgreementsAgreementIdGetResponsesContentApplicationJsonSchemaDataActionsReuseDetailsReusableVariantsItemsImage": { "description": "Image of this variant, null when the variant has no image", "properties": { "id": { "description": "Unique identifier of the image", "format": "uuid", "type": "string" }, "url": { "description": "Public URL of the image", "type": "string" } }, "required": [ "id", "url" ], "title": "ItAgreementsAgreementIdGetResponsesContentApplicationJsonSchemaDataActionsReuseDetailsReusableVariantsItemsImage", "type": "object" }, "ItAgreementsAgreementIdGetResponsesContentApplicationJsonSchemaDataActionsReuseDetailsReusableVariantsItemsKeyboardLayout": { "description": "Physical keyboard layout (laptops only)", "enum": [ "BELGIAN_AZERTY", "CANADIAN_MULTILINGUAL_STANDARD_QWERTY", "CZECH_QWERTY", "DANISH_QWERTY", "DUTCH_QWERTY", "EGYPTIAN_LOCAL", "ENGLISH_RUSSIAN_QWERTY", "EU_STANDARD_QWERTY", "FRENCH_AZERTY", "GERMAN_QWERTZ", "INDIAN_QWERTY", "INTERNATIONAL_ENGLISH_QWERTY", "ITALIAN_QWERTY", "JAPANESE_QWERTY", "KOREAN_QWERTY", "LATAM_QWERTY", "NORWEGIAN_QWERTY", "PORTUGUESE_QWERTY", "SPANISH_QWERTY", "SWEDISH_QWERTY", "SWISS_FRENCH_QWERTZ", "SWISS_GERMAN_QWERTZ", "TURKISH_QWERTY", "UK_ENGLISH_QWERTY", "UNKNOWN", "US_ENGLISH_QWERTY" ], "title": "ItAgreementsAgreementIdGetResponsesContentApplicationJsonSchemaDataActionsReuseDetailsReusableVariantsItemsKeyboardLayout", "type": "string" }, "ItAgreementsAgreementIdGetResponsesContentApplicationJsonSchemaDataActionsReuseDetailsReusableVariantsItemsOperatingSystem": { "description": "Operating system installed on this variant (devices only)", "enum": [ "ANDROID_PHONE", "ANDROID_TABLET", "CHROME_OS", "IOS_PHONE", "IOS_TABLET", "LINUX", "MACOS", "WINDOWS" ], "title": "ItAgreementsAgreementIdGetResponsesContentApplicationJsonSchemaDataActionsReuseDetailsReusableVariantsItemsOperatingSystem", "type": "string" }, "ItAgreementsAgreementIdGetResponsesContentApplicationJsonSchemaDataActionsReuseDisabledReason": { "description": "Populated when `is_enabled = false`; the single reason code the storefront gave for the\ndisabled state. Not a list — matches V2 action-slot semantics.", "enum": [ "CONTRACT_HAS_ACTIVE_ASSIGNMENT", "CONTRACT_IS_NOT_ACTIVE", "CONTRACT_IS_NOT_RENTAL", "CONTRACT_IS_NOT_REUSE_ENABLED", "CONTRACT_TYPE_NOT_ALLOWED", "ORGANIZATION_NOT_ACTIVE" ], "title": "ItAgreementsAgreementIdGetResponsesContentApplicationJsonSchemaDataActionsReuseDisabledReason", "type": "string" }, "ItAgreementsAgreementIdGetResponsesContentApplicationJsonSchemaDataAssignedHrisProfile": { "description": "Current holder of the agreement, if any. `null` while the agreement is between users\n(e.g. after POST /assets/{id}/store).", "properties": { "emails": { "description": "Array of user email addresses", "items": { "format": "email", "type": "string" }, "type": "array" }, "first_name": { "description": "First name of the user", "type": "string" }, "hris_profile_id": { "description": "The unique identifier of the HRIS profile of the assigned user", "format": "uuid", "type": "string" }, "last_name": { "description": "Last name of the user", "type": "string" } }, "required": [ "emails", "last_name", "first_name", "hris_profile_id" ], "title": "ItAgreementsAgreementIdGetResponsesContentApplicationJsonSchemaDataAssignedHrisProfile", "type": "object" }, "ItAgreementsAgreementIdGetResponsesContentApplicationJsonSchemaDataProduct": { "description": "The product this agreement is for.", "properties": { "brand": { "description": "Product brand", "type": "string" }, "category": { "$ref": "#/components/schemas/ItAgreementsAgreementIdGetResponsesContentApplicationJsonSchemaDataProductCategory", "description": "Product category" }, "id": { "description": "Unique identifier of the product", "format": "uuid", "type": "string" }, "name": { "description": "Product name", "type": "string" } }, "required": [ "id", "name", "brand", "category" ], "title": "ItAgreementsAgreementIdGetResponsesContentApplicationJsonSchemaDataProduct", "type": "object" }, "ItAgreementsAgreementIdGetResponsesContentApplicationJsonSchemaDataProductCategory": { "description": "Product category", "enum": [ "ADAPTER", "CABLE", "CHAIR", "CHARGER", "COMPACT_DESKTOP", "DESK", "DESKTOP", "DESK_RISER", "DESK_TIDY", "DOCKING_STATION", "DONGLE", "FOOTREST", "HEADSET", "KEYBOARD", "LAPTOP", "LAPTOP_STAND", "MICE_TRACKPAD", "MOBILE_DEVICE", "MONITOR", "MONITOR_ARM", "OTHER", "PRINTER", "SHREDDER", "STANDING_MAT", "TABLET", "TASK_LIGHT", "WEBCAM", "WELCOME_PACK", "WIFI_RANGE_EXTENDER" ], "title": "ItAgreementsAgreementIdGetResponsesContentApplicationJsonSchemaDataProductCategory", "type": "string" }, "ItAgreementsAgreementIdGetResponsesContentApplicationJsonSchemaDataStatus": { "description": "Normalised agreement status.", "enum": [ "ACTIVE", "CANCELED", "ENDED", "PENDING" ], "title": "ItAgreementsAgreementIdGetResponsesContentApplicationJsonSchemaDataStatus", "type": "string" }, "ItAgreementsAgreementIdGetResponsesContentApplicationJsonSchemaDataStoreAndReuse": { "description": "Store-and-reuse block. Present only when the agreement is a rental with store-and-reuse\nenabled.", "properties": { "status": { "$ref": "#/components/schemas/ItAgreementsAgreementIdGetResponsesContentApplicationJsonSchemaDataStoreAndReuseStatus", "description": "Current state of the store-and-reuse lifecycle for this rental contract." } }, "required": [ "status" ], "title": "ItAgreementsAgreementIdGetResponsesContentApplicationJsonSchemaDataStoreAndReuse", "type": "object" }, "ItAgreementsAgreementIdGetResponsesContentApplicationJsonSchemaDataStoreAndReuseStatus": { "description": "Current state of the store-and-reuse lifecycle for this rental contract.", "enum": [ "COMPLETED", "IN_PROGRESS", "READY" ], "title": "ItAgreementsAgreementIdGetResponsesContentApplicationJsonSchemaDataStoreAndReuseStatus", "type": "string" }, "ItAgreementsAgreementIdGetResponsesContentApplicationJsonSchemaDataType": { "description": "Agreement type.", "enum": [ "MANAGEMENT", "PURCHASE", "RENTAL" ], "title": "ItAgreementsAgreementIdGetResponsesContentApplicationJsonSchemaDataType", "type": "string" }, "ItAgreementsAgreementIdGetResponsesContentApplicationJsonSchemaErrorsItems": { "properties": { "code": { "description": "Error code of the handler which produced the returned error", "type": "string" }, "field": { "description": "The field name where input validation failed", "type": [ "string", "null" ] }, "message": { "description": "Description of the returned error", "type": "string" } }, "required": [ "code", "field", "message" ], "title": "ItAgreementsAgreementIdGetResponsesContentApplicationJsonSchemaErrorsItems", "type": "object" }, "ItAgreementsAgreementIdReassignPostParametersXBeta": { "default": "true", "enum": [ "true" ], "title": "ItAgreementsAgreementIdReassignPostParametersXBeta", "type": "string" }, "ItAgreementsAgreementIdReassignPostRequestBodyContentApplicationJsonSchemaData": { "description": "Reassignment payload.", "properties": { "delivery_address": { "$ref": "#/components/schemas/ItAgreementsAgreementIdReassignPostRequestBodyContentApplicationJsonSchemaDataDeliveryAddress", "description": "Delivery address for the new holder. Country must appear in `actions.reuse.details.reassignable_in`." }, "hris_profile_id": { "description": "HRIS profile identifier of the new holder.", "format": "uuid", "type": "string" }, "is_express_delivery_requested": { "description": "Charges the express-delivery fee when the destination country supports it. Defaults to `false`.", "type": "boolean" }, "variant_id": { "description": "Product variant to reassign the agreement to. Must be one of the variants returned in `actions.reuse.details.reusable_variants` on `GET /agreements/{agreement_id}`.", "format": "uuid", "type": "string" } }, "required": [ "variant_id", "hris_profile_id", "delivery_address" ], "title": "ItAgreementsAgreementIdReassignPostRequestBodyContentApplicationJsonSchemaData", "type": "object" }, "ItAgreementsAgreementIdReassignPostRequestBodyContentApplicationJsonSchemaDataDeliveryAddress": { "description": "Delivery address for the new holder. Country must appear in `actions.reuse.details.reassignable_in`.", "properties": { "city": { "description": "City name.", "type": "string" }, "country": { "$ref": "#/components/schemas/ItAgreementsAgreementIdReassignPostRequestBodyContentApplicationJsonSchemaDataDeliveryAddressCountry", "description": "Country code (ISO 3166 alpha-2)." }, "date_of_birth": { "description": "Date of birth.", "format": "date", "type": "string" }, "delivery_instructions": { "description": "Delivery instructions for the courier.", "type": "string" }, "line1": { "description": "Address line 1.", "type": "string" }, "line2": { "description": "Address line 2.", "type": "string" }, "passport_number": { "description": "Passport number.", "type": "string" }, "phone_number": { "description": "Phone number in E.164 format.", "type": "string" }, "post_code": { "description": "Post code.", "type": "string" }, "state": { "description": "State or region name.", "type": "string" }, "tax_id_number": { "description": "Tax ID number.", "type": "string" } }, "required": [ "country" ], "title": "ItAgreementsAgreementIdReassignPostRequestBodyContentApplicationJsonSchemaDataDeliveryAddress", "type": "object" }, "ItAgreementsAgreementIdReassignPostRequestBodyContentApplicationJsonSchemaDataDeliveryAddressCountry": { "description": "Country code (ISO 3166 alpha-2).", "enum": [ "AD", "AE", "AF", "AG", "AI", "AL", "AM", "AN", "AO", "AQ", "AR", "AS", "AT", "AU", "AW", "AX", "AZ", "BA", "BB", "BD", "BE", "BF", "BG", "BH", "BI", "BJ", "BL", "BM", "BN", "BO", "BQ", "BR", "BS", "BT", "BV", "BW", "BY", "BZ", "CA", "CC", "CD", "CF", "CG", "CH", "CI", "CK", "CL", "CM", "CN", "CO", "CR", "CU", "CV", "CW", "CX", "CY", "CZ", "DE", "DJ", "DK", "DM", "DO", "DZ", "EC", "EE", "EG", "EH", "ER", "ES", "ET", "FI", "FJ", "FK", "FM", "FO", "FR", "GA", "GB", "GD", "GE", "GF", "GG", "GH", "GI", "GL", "GM", "GN", "GP", "GQ", "GR", "GS", "GT", "GU", "GW", "GY", "HK", "HM", "HN", "HR", "HT", "HU", "IC", "ID", "IE", "IL", "IM", "IN", "IO", "IQ", "IR", "IS", "IT", "JE", "JM", "JO", "JP", "KE", "KG", "KH", "KI", "KM", "KN", "KP", "KR", "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", "XK", "YE", "YT", "ZA", "ZM", "ZW" ], "title": "ItAgreementsAgreementIdReassignPostRequestBodyContentApplicationJsonSchemaDataDeliveryAddressCountry", "type": "string" }, "ItAgreementsAgreementIdReassignPostResponsesContentApplicationJsonSchemaData": { "properties": { "actions": { "$ref": "#/components/schemas/ItAgreementsAgreementIdReassignPostResponsesContentApplicationJsonSchemaDataActions", "description": "Snapshot of which agreement-level actions are currently callable on this agreement." }, "assigned_hris_profile": { "description": "Current holder of the agreement, if any. `null` while the agreement is between users\n(e.g. after POST /assets/{id}/store).", "oneOf": [ { "$ref": "#/components/schemas/ItAgreementsAgreementIdReassignPostResponsesContentApplicationJsonSchemaDataAssignedHrisProfile" }, { "type": "null" } ] }, "billing_entity_id": { "description": "ID of the billing entity that pays for this agreement. `null` when the billing entity is\nno longer active.", "format": "uuid", "type": [ "string", "null" ] }, "created_at": { "description": "When the agreement was created.", "format": "date-time", "type": "string" }, "end_date": { "description": "Agreement end date. `null` while the agreement is open.", "format": "date", "type": [ "string", "null" ] }, "id": { "description": "Unique identifier of the agreement.", "format": "uuid", "type": "string" }, "product": { "$ref": "#/components/schemas/ItAgreementsAgreementIdReassignPostResponsesContentApplicationJsonSchemaDataProduct", "description": "The product this agreement is for." }, "public_id": { "description": "Public identifier of the agreement.", "type": "string" }, "start_date": { "description": "Agreement start date.", "format": "date", "type": [ "string", "null" ] }, "status": { "$ref": "#/components/schemas/ItAgreementsAgreementIdReassignPostResponsesContentApplicationJsonSchemaDataStatus", "description": "Normalised agreement status." }, "store_and_reuse": { "description": "Store-and-reuse block. Present only when the agreement is a rental with store-and-reuse\nenabled.", "oneOf": [ { "$ref": "#/components/schemas/ItAgreementsAgreementIdReassignPostResponsesContentApplicationJsonSchemaDataStoreAndReuse" }, { "type": "null" } ] }, "type": { "$ref": "#/components/schemas/ItAgreementsAgreementIdReassignPostResponsesContentApplicationJsonSchemaDataType", "description": "Agreement type." }, "updated_at": { "description": "When the agreement was last updated.", "format": "date-time", "type": "string" }, "variant_id": { "description": "The currently-assigned product variant.", "format": "uuid", "type": "string" } }, "required": [ "id", "type", "status", "actions", "product", "end_date", "public_id", "created_at", "start_date", "updated_at", "variant_id", "store_and_reuse", "billing_entity_id", "assigned_hris_profile" ], "title": "ItAgreementsAgreementIdReassignPostResponsesContentApplicationJsonSchemaData", "type": "object" }, "ItAgreementsAgreementIdReassignPostResponsesContentApplicationJsonSchemaDataActions": { "description": "Snapshot of which agreement-level actions are currently callable on this agreement.", "properties": { "reuse": { "$ref": "#/components/schemas/ItAgreementsAgreementIdReassignPostResponsesContentApplicationJsonSchemaDataActionsReuse", "description": "Backs POST /agreements/{agreement_id}/reassign." } }, "required": [ "reuse" ], "title": "ItAgreementsAgreementIdReassignPostResponsesContentApplicationJsonSchemaDataActions", "type": "object" }, "ItAgreementsAgreementIdReassignPostResponsesContentApplicationJsonSchemaDataActionsReuse": { "description": "Backs POST /agreements/{agreement_id}/reassign.", "properties": { "details": { "description": "Populated when `enabled = true` and the action has caller-relevant context to surface\n(see per-slot documentation). Null otherwise.", "oneOf": [ { "$ref": "#/components/schemas/ItAgreementsAgreementIdReassignPostResponsesContentApplicationJsonSchemaDataActionsReuseDetails" }, { "type": "null" } ] }, "disabled_reason": { "description": "Populated when `is_enabled = false`; the single reason code the storefront gave for the\ndisabled state. Not a list — matches V2 action-slot semantics.", "oneOf": [ { "$ref": "#/components/schemas/ItAgreementsAgreementIdReassignPostResponsesContentApplicationJsonSchemaDataActionsReuseDisabledReason" }, { "type": "null" } ] }, "is_enabled": { "description": "Whether the action is currently callable on this agreement.", "type": "boolean" } }, "required": [ "details", "is_enabled", "disabled_reason" ], "title": "ItAgreementsAgreementIdReassignPostResponsesContentApplicationJsonSchemaDataActionsReuse", "type": "object" }, "ItAgreementsAgreementIdReassignPostResponsesContentApplicationJsonSchemaDataActionsReuseDetails": { "description": "Populated when `enabled = true` and the action has caller-relevant context to surface\n(see per-slot documentation). Null otherwise.", "properties": { "reassignable_in": { "description": "Countries the contract can currently be reassigned to (customs / entity constraints).", "items": { "$ref": "#/components/schemas/ItAgreementsAgreementIdReassignPostResponsesContentApplicationJsonSchemaDataActionsReuseDetailsReassignableInItems" }, "type": "array" }, "reusable_variants": { "description": "The subset of the parent product's variants that can be reassigned via store-and-reuse.\nThe original contract variant is appended as a fallback when the store-and-reuse filter\nreturns none.", "items": { "$ref": "#/components/schemas/ItAgreementsAgreementIdReassignPostResponsesContentApplicationJsonSchemaDataActionsReuseDetailsReusableVariantsItems" }, "type": "array" } }, "required": [ "reassignable_in", "reusable_variants" ], "title": "ItAgreementsAgreementIdReassignPostResponsesContentApplicationJsonSchemaDataActionsReuseDetails", "type": "object" }, "ItAgreementsAgreementIdReassignPostResponsesContentApplicationJsonSchemaDataActionsReuseDetailsReassignableInItems": { "enum": [ "AD", "AE", "AF", "AG", "AI", "AL", "AM", "AN", "AO", "AQ", "AR", "AS", "AT", "AU", "AW", "AX", "AZ", "BA", "BB", "BD", "BE", "BF", "BG", "BH", "BI", "BJ", "BL", "BM", "BN", "BO", "BQ", "BR", "BS", "BT", "BV", "BW", "BY", "BZ", "CA", "CC", "CD", "CF", "CG", "CH", "CI", "CK", "CL", "CM", "CN", "CO", "CR", "CU", "CV", "CW", "CX", "CY", "CZ", "DE", "DJ", "DK", "DM", "DO", "DZ", "EC", "EE", "EG", "EH", "ER", "ES", "ET", "FI", "FJ", "FK", "FM", "FO", "FR", "GA", "GB", "GD", "GE", "GF", "GG", "GH", "GI", "GL", "GM", "GN", "GP", "GQ", "GR", "GS", "GT", "GU", "GW", "GY", "HK", "HM", "HN", "HR", "HT", "HU", "IC", "ID", "IE", "IL", "IM", "IN", "IO", "IQ", "IR", "IS", "IT", "JE", "JM", "JO", "JP", "KE", "KG", "KH", "KI", "KM", "KN", "KP", "KR", "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", "XK", "YE", "YT", "ZA", "ZM", "ZW" ], "title": "ItAgreementsAgreementIdReassignPostResponsesContentApplicationJsonSchemaDataActionsReuseDetailsReassignableInItems", "type": "string" }, "ItAgreementsAgreementIdReassignPostResponsesContentApplicationJsonSchemaDataActionsReuseDetailsReusableVariantsItems": { "properties": { "allowed_acquisition_types": { "description": "Acquisition types allowed for this variant", "items": { "$ref": "#/components/schemas/ItAgreementsAgreementIdReassignPostResponsesContentApplicationJsonSchemaDataActionsReuseDetailsReusableVariantsItemsAllowedAcquisitionTypesItems" }, "type": "array" }, "allowed_rental_terms": { "description": "Rental terms permitted for this variant. Empty for non-rental variants.", "items": { "$ref": "#/components/schemas/ItAgreementsAgreementIdReassignPostResponsesContentApplicationJsonSchemaDataActionsReuseDetailsReusableVariantsItemsAllowedRentalTermsItems" }, "type": "array" }, "available_countries": { "description": "ISO 3166 alpha-2 country codes where this variant can be ordered", "items": { "$ref": "#/components/schemas/ItAgreementsAgreementIdReassignPostResponsesContentApplicationJsonSchemaDataActionsReuseDetailsReusableVariantsItemsAvailableCountriesItems" }, "type": "array" }, "id": { "description": "Unique identifier of the variant", "format": "uuid", "type": "string" }, "image": { "description": "Image of this variant, null when the variant has no image", "oneOf": [ { "$ref": "#/components/schemas/ItAgreementsAgreementIdReassignPostResponsesContentApplicationJsonSchemaDataActionsReuseDetailsReusableVariantsItemsImage" }, { "type": "null" } ] }, "keyboard_layout": { "description": "Physical keyboard layout (laptops only)", "oneOf": [ { "$ref": "#/components/schemas/ItAgreementsAgreementIdReassignPostResponsesContentApplicationJsonSchemaDataActionsReuseDetailsReusableVariantsItemsKeyboardLayout" }, { "type": "null" } ] }, "operating_system": { "description": "Operating system installed on this variant (devices only)", "oneOf": [ { "$ref": "#/components/schemas/ItAgreementsAgreementIdReassignPostResponsesContentApplicationJsonSchemaDataActionsReuseDetailsReusableVariantsItemsOperatingSystem" }, { "type": "null" } ] }, "public_id": { "description": "Public identifier of the variant", "type": "string" }, "size": { "description": "Physical size or dimension label — style + size together uniquely identify a variant within a product", "type": [ "string", "null" ] }, "sku": { "description": "SKU of the variant", "type": [ "string", "null" ] }, "style": { "description": "Marketing style (colour, tier, etc.) — style + size together uniquely identify a variant within a product", "type": [ "string", "null" ] } }, "required": [ "id", "sku", "size", "image", "style", "public_id", "keyboard_layout", "operating_system", "available_countries", "allowed_rental_terms", "allowed_acquisition_types" ], "title": "ItAgreementsAgreementIdReassignPostResponsesContentApplicationJsonSchemaDataActionsReuseDetailsReusableVariantsItems", "type": "object" }, "ItAgreementsAgreementIdReassignPostResponsesContentApplicationJsonSchemaDataActionsReuseDetailsReusableVariantsItemsAllowedAcquisitionTypesItems": { "enum": [ "PURCHASE", "RENTAL", "REUSE" ], "title": "ItAgreementsAgreementIdReassignPostResponsesContentApplicationJsonSchemaDataActionsReuseDetailsReusableVariantsItemsAllowedAcquisitionTypesItems", "type": "string" }, "ItAgreementsAgreementIdReassignPostResponsesContentApplicationJsonSchemaDataActionsReuseDetailsReusableVariantsItemsAllowedRentalTermsItems": { "enum": [ "MONTH_12", "MONTH_24" ], "title": "ItAgreementsAgreementIdReassignPostResponsesContentApplicationJsonSchemaDataActionsReuseDetailsReusableVariantsItemsAllowedRentalTermsItems", "type": "string" }, "ItAgreementsAgreementIdReassignPostResponsesContentApplicationJsonSchemaDataActionsReuseDetailsReusableVariantsItemsAvailableCountriesItems": { "enum": [ "AD", "AE", "AF", "AG", "AI", "AL", "AM", "AN", "AO", "AQ", "AR", "AS", "AT", "AU", "AW", "AX", "AZ", "BA", "BB", "BD", "BE", "BF", "BG", "BH", "BI", "BJ", "BL", "BM", "BN", "BO", "BQ", "BR", "BS", "BT", "BV", "BW", "BY", "BZ", "CA", "CC", "CD", "CF", "CG", "CH", "CI", "CK", "CL", "CM", "CN", "CO", "CR", "CU", "CV", "CW", "CX", "CY", "CZ", "DE", "DJ", "DK", "DM", "DO", "DZ", "EC", "EE", "EG", "EH", "ER", "ES", "ET", "FI", "FJ", "FK", "FM", "FO", "FR", "GA", "GB", "GD", "GE", "GF", "GG", "GH", "GI", "GL", "GM", "GN", "GP", "GQ", "GR", "GS", "GT", "GU", "GW", "GY", "HK", "HM", "HN", "HR", "HT", "HU", "IC", "ID", "IE", "IL", "IM", "IN", "IO", "IQ", "IR", "IS", "IT", "JE", "JM", "JO", "JP", "KE", "KG", "KH", "KI", "KM", "KN", "KP", "KR", "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", "XK", "YE", "YT", "ZA", "ZM", "ZW" ], "title": "ItAgreementsAgreementIdReassignPostResponsesContentApplicationJsonSchemaDataActionsReuseDetailsReusableVariantsItemsAvailableCountriesItems", "type": "string" }, "ItAgreementsAgreementIdReassignPostResponsesContentApplicationJsonSchemaDataActionsReuseDetailsReusableVariantsItemsImage": { "description": "Image of this variant, null when the variant has no image", "properties": { "id": { "description": "Unique identifier of the image", "format": "uuid", "type": "string" }, "url": { "description": "Public URL of the image", "type": "string" } }, "required": [ "id", "url" ], "title": "ItAgreementsAgreementIdReassignPostResponsesContentApplicationJsonSchemaDataActionsReuseDetailsReusableVariantsItemsImage", "type": "object" }, "ItAgreementsAgreementIdReassignPostResponsesContentApplicationJsonSchemaDataActionsReuseDetailsReusableVariantsItemsKeyboardLayout": { "description": "Physical keyboard layout (laptops only)", "enum": [ "BELGIAN_AZERTY", "CANADIAN_MULTILINGUAL_STANDARD_QWERTY", "CZECH_QWERTY", "DANISH_QWERTY", "DUTCH_QWERTY", "EGYPTIAN_LOCAL", "ENGLISH_RUSSIAN_QWERTY", "EU_STANDARD_QWERTY", "FRENCH_AZERTY", "GERMAN_QWERTZ", "INDIAN_QWERTY", "INTERNATIONAL_ENGLISH_QWERTY", "ITALIAN_QWERTY", "JAPANESE_QWERTY", "KOREAN_QWERTY", "LATAM_QWERTY", "NORWEGIAN_QWERTY", "PORTUGUESE_QWERTY", "SPANISH_QWERTY", "SWEDISH_QWERTY", "SWISS_FRENCH_QWERTZ", "SWISS_GERMAN_QWERTZ", "TURKISH_QWERTY", "UK_ENGLISH_QWERTY", "UNKNOWN", "US_ENGLISH_QWERTY" ], "title": "ItAgreementsAgreementIdReassignPostResponsesContentApplicationJsonSchemaDataActionsReuseDetailsReusableVariantsItemsKeyboardLayout", "type": "string" }, "ItAgreementsAgreementIdReassignPostResponsesContentApplicationJsonSchemaDataActionsReuseDetailsReusableVariantsItemsOperatingSystem": { "description": "Operating system installed on this variant (devices only)", "enum": [ "ANDROID_PHONE", "ANDROID_TABLET", "CHROME_OS", "IOS_PHONE", "IOS_TABLET", "LINUX", "MACOS", "WINDOWS" ], "title": "ItAgreementsAgreementIdReassignPostResponsesContentApplicationJsonSchemaDataActionsReuseDetailsReusableVariantsItemsOperatingSystem", "type": "string" }, "ItAgreementsAgreementIdReassignPostResponsesContentApplicationJsonSchemaDataActionsReuseDisabledReason": { "description": "Populated when `is_enabled = false`; the single reason code the storefront gave for the\ndisabled state. Not a list — matches V2 action-slot semantics.", "enum": [ "CONTRACT_HAS_ACTIVE_ASSIGNMENT", "CONTRACT_IS_NOT_ACTIVE", "CONTRACT_IS_NOT_RENTAL", "CONTRACT_IS_NOT_REUSE_ENABLED", "CONTRACT_TYPE_NOT_ALLOWED", "ORGANIZATION_NOT_ACTIVE" ], "title": "ItAgreementsAgreementIdReassignPostResponsesContentApplicationJsonSchemaDataActionsReuseDisabledReason", "type": "string" }, "ItAgreementsAgreementIdReassignPostResponsesContentApplicationJsonSchemaDataAssignedHrisProfile": { "description": "Current holder of the agreement, if any. `null` while the agreement is between users\n(e.g. after POST /assets/{id}/store).", "properties": { "emails": { "description": "Array of user email addresses", "items": { "format": "email", "type": "string" }, "type": "array" }, "first_name": { "description": "First name of the user", "type": "string" }, "hris_profile_id": { "description": "The unique identifier of the HRIS profile of the assigned user", "format": "uuid", "type": "string" }, "last_name": { "description": "Last name of the user", "type": "string" } }, "required": [ "emails", "last_name", "first_name", "hris_profile_id" ], "title": "ItAgreementsAgreementIdReassignPostResponsesContentApplicationJsonSchemaDataAssignedHrisProfile", "type": "object" }, "ItAgreementsAgreementIdReassignPostResponsesContentApplicationJsonSchemaDataProduct": { "description": "The product this agreement is for.", "properties": { "brand": { "description": "Product brand", "type": "string" }, "category": { "$ref": "#/components/schemas/ItAgreementsAgreementIdReassignPostResponsesContentApplicationJsonSchemaDataProductCategory", "description": "Product category" }, "id": { "description": "Unique identifier of the product", "format": "uuid", "type": "string" }, "name": { "description": "Product name", "type": "string" } }, "required": [ "id", "name", "brand", "category" ], "title": "ItAgreementsAgreementIdReassignPostResponsesContentApplicationJsonSchemaDataProduct", "type": "object" }, "ItAgreementsAgreementIdReassignPostResponsesContentApplicationJsonSchemaDataProductCategory": { "description": "Product category", "enum": [ "ADAPTER", "CABLE", "CHAIR", "CHARGER", "COMPACT_DESKTOP", "DESK", "DESKTOP", "DESK_RISER", "DESK_TIDY", "DOCKING_STATION", "DONGLE", "FOOTREST", "HEADSET", "KEYBOARD", "LAPTOP", "LAPTOP_STAND", "MICE_TRACKPAD", "MOBILE_DEVICE", "MONITOR", "MONITOR_ARM", "OTHER", "PRINTER", "SHREDDER", "STANDING_MAT", "TABLET", "TASK_LIGHT", "WEBCAM", "WELCOME_PACK", "WIFI_RANGE_EXTENDER" ], "title": "ItAgreementsAgreementIdReassignPostResponsesContentApplicationJsonSchemaDataProductCategory", "type": "string" }, "ItAgreementsAgreementIdReassignPostResponsesContentApplicationJsonSchemaDataStatus": { "description": "Normalised agreement status.", "enum": [ "ACTIVE", "CANCELED", "ENDED", "PENDING" ], "title": "ItAgreementsAgreementIdReassignPostResponsesContentApplicationJsonSchemaDataStatus", "type": "string" }, "ItAgreementsAgreementIdReassignPostResponsesContentApplicationJsonSchemaDataStoreAndReuse": { "description": "Store-and-reuse block. Present only when the agreement is a rental with store-and-reuse\nenabled.", "properties": { "status": { "$ref": "#/components/schemas/ItAgreementsAgreementIdReassignPostResponsesContentApplicationJsonSchemaDataStoreAndReuseStatus", "description": "Current state of the store-and-reuse lifecycle for this rental contract." } }, "required": [ "status" ], "title": "ItAgreementsAgreementIdReassignPostResponsesContentApplicationJsonSchemaDataStoreAndReuse", "type": "object" }, "ItAgreementsAgreementIdReassignPostResponsesContentApplicationJsonSchemaDataStoreAndReuseStatus": { "description": "Current state of the store-and-reuse lifecycle for this rental contract.", "enum": [ "COMPLETED", "IN_PROGRESS", "READY" ], "title": "ItAgreementsAgreementIdReassignPostResponsesContentApplicationJsonSchemaDataStoreAndReuseStatus", "type": "string" }, "ItAgreementsAgreementIdReassignPostResponsesContentApplicationJsonSchemaDataType": { "description": "Agreement type.", "enum": [ "MANAGEMENT", "PURCHASE", "RENTAL" ], "title": "ItAgreementsAgreementIdReassignPostResponsesContentApplicationJsonSchemaDataType", "type": "string" }, "ItAgreementsAgreementIdReassignPostResponsesContentApplicationJsonSchemaErrorsItems": { "properties": { "code": { "description": "Error code of the handler which produced the returned error", "type": "string" }, "field": { "description": "The field name where input validation failed", "type": [ "string", "null" ] }, "message": { "description": "Description of the returned error", "type": "string" } }, "required": [ "code", "field", "message" ], "title": "ItAgreementsAgreementIdReassignPostResponsesContentApplicationJsonSchemaErrorsItems", "type": "object" }, "ItAgreementsGetParametersStatus": { "enum": [ "ACTIVE", "CANCELED", "ENDED", "PENDING" ], "title": "ItAgreementsGetParametersStatus", "type": "string" }, "ItAgreementsGetParametersStoreAndReuseStatus": { "enum": [ "COMPLETED", "IN_PROGRESS", "READY" ], "title": "ItAgreementsGetParametersStoreAndReuseStatus", "type": "string" }, "ItAgreementsGetParametersType": { "enum": [ "MANAGEMENT", "PURCHASE", "RENTAL" ], "title": "ItAgreementsGetParametersType", "type": "string" }, "ItAgreementsGetParametersXBeta": { "default": "true", "enum": [ "true" ], "title": "ItAgreementsGetParametersXBeta", "type": "string" }, "ItAgreementsGetResponsesContentApplicationJsonSchemaDataItems": { "properties": { "actions": { "$ref": "#/components/schemas/ItAgreementsGetResponsesContentApplicationJsonSchemaDataItemsActions", "description": "Snapshot of which agreement-level actions are currently callable on this agreement." }, "assigned_hris_profile": { "description": "Current holder of the agreement, if any. `null` while the agreement is between users\n(e.g. after POST /assets/{id}/store).", "oneOf": [ { "$ref": "#/components/schemas/ItAgreementsGetResponsesContentApplicationJsonSchemaDataItemsAssignedHrisProfile" }, { "type": "null" } ] }, "billing_entity_id": { "description": "ID of the billing entity that pays for this agreement. `null` when the billing entity is\nno longer active.", "format": "uuid", "type": [ "string", "null" ] }, "created_at": { "description": "When the agreement was created.", "format": "date-time", "type": "string" }, "end_date": { "description": "Agreement end date. `null` while the agreement is open.", "format": "date", "type": [ "string", "null" ] }, "id": { "description": "Unique identifier of the agreement.", "format": "uuid", "type": "string" }, "product": { "$ref": "#/components/schemas/ItAgreementsGetResponsesContentApplicationJsonSchemaDataItemsProduct", "description": "The product this agreement is for." }, "public_id": { "description": "Public identifier of the agreement.", "type": "string" }, "start_date": { "description": "Agreement start date.", "format": "date", "type": [ "string", "null" ] }, "status": { "$ref": "#/components/schemas/ItAgreementsGetResponsesContentApplicationJsonSchemaDataItemsStatus", "description": "Normalised agreement status." }, "store_and_reuse": { "description": "Store-and-reuse block. Present only when the agreement is a rental with store-and-reuse\nenabled.", "oneOf": [ { "$ref": "#/components/schemas/ItAgreementsGetResponsesContentApplicationJsonSchemaDataItemsStoreAndReuse" }, { "type": "null" } ] }, "type": { "$ref": "#/components/schemas/ItAgreementsGetResponsesContentApplicationJsonSchemaDataItemsType", "description": "Agreement type." }, "updated_at": { "description": "When the agreement was last updated.", "format": "date-time", "type": "string" }, "variant_id": { "description": "The currently-assigned product variant.", "format": "uuid", "type": "string" } }, "required": [ "id", "type", "status", "actions", "product", "end_date", "public_id", "created_at", "start_date", "updated_at", "variant_id", "store_and_reuse", "billing_entity_id", "assigned_hris_profile" ], "title": "ItAgreementsGetResponsesContentApplicationJsonSchemaDataItems", "type": "object" }, "ItAgreementsGetResponsesContentApplicationJsonSchemaDataItemsActions": { "description": "Snapshot of which agreement-level actions are currently callable on this agreement.", "properties": { "reuse": { "$ref": "#/components/schemas/ItAgreementsGetResponsesContentApplicationJsonSchemaDataItemsActionsReuse", "description": "Backs POST /agreements/{agreement_id}/reassign." } }, "required": [ "reuse" ], "title": "ItAgreementsGetResponsesContentApplicationJsonSchemaDataItemsActions", "type": "object" }, "ItAgreementsGetResponsesContentApplicationJsonSchemaDataItemsActionsReuse": { "description": "Backs POST /agreements/{agreement_id}/reassign.", "properties": { "details": { "description": "Populated when `enabled = true` and the action has caller-relevant context to surface\n(see per-slot documentation). Null otherwise.", "oneOf": [ { "$ref": "#/components/schemas/ItAgreementsGetResponsesContentApplicationJsonSchemaDataItemsActionsReuseDetails" }, { "type": "null" } ] }, "disabled_reason": { "description": "Populated when `is_enabled = false`; the single reason code the storefront gave for the\ndisabled state. Not a list — matches V2 action-slot semantics.", "oneOf": [ { "$ref": "#/components/schemas/ItAgreementsGetResponsesContentApplicationJsonSchemaDataItemsActionsReuseDisabledReason" }, { "type": "null" } ] }, "is_enabled": { "description": "Whether the action is currently callable on this agreement.", "type": "boolean" } }, "required": [ "details", "is_enabled", "disabled_reason" ], "title": "ItAgreementsGetResponsesContentApplicationJsonSchemaDataItemsActionsReuse", "type": "object" }, "ItAgreementsGetResponsesContentApplicationJsonSchemaDataItemsActionsReuseDetails": { "description": "Populated when `enabled = true` and the action has caller-relevant context to surface\n(see per-slot documentation). Null otherwise.", "properties": { "reassignable_in": { "description": "Countries the contract can currently be reassigned to (customs / entity constraints).", "items": { "$ref": "#/components/schemas/ItAgreementsGetResponsesContentApplicationJsonSchemaDataItemsActionsReuseDetailsReassignableInItems" }, "type": "array" }, "reusable_variants": { "description": "The subset of the parent product's variants that can be reassigned via store-and-reuse.\nThe original contract variant is appended as a fallback when the store-and-reuse filter\nreturns none.", "items": { "$ref": "#/components/schemas/ItAgreementsGetResponsesContentApplicationJsonSchemaDataItemsActionsReuseDetailsReusableVariantsItems" }, "type": "array" } }, "required": [ "reassignable_in", "reusable_variants" ], "title": "ItAgreementsGetResponsesContentApplicationJsonSchemaDataItemsActionsReuseDetails", "type": "object" }, "ItAgreementsGetResponsesContentApplicationJsonSchemaDataItemsActionsReuseDetailsReassignableInItems": { "enum": [ "AD", "AE", "AF", "AG", "AI", "AL", "AM", "AN", "AO", "AQ", "AR", "AS", "AT", "AU", "AW", "AX", "AZ", "BA", "BB", "BD", "BE", "BF", "BG", "BH", "BI", "BJ", "BL", "BM", "BN", "BO", "BQ", "BR", "BS", "BT", "BV", "BW", "BY", "BZ", "CA", "CC", "CD", "CF", "CG", "CH", "CI", "CK", "CL", "CM", "CN", "CO", "CR", "CU", "CV", "CW", "CX", "CY", "CZ", "DE", "DJ", "DK", "DM", "DO", "DZ", "EC", "EE", "EG", "EH", "ER", "ES", "ET", "FI", "FJ", "FK", "FM", "FO", "FR", "GA", "GB", "GD", "GE", "GF", "GG", "GH", "GI", "GL", "GM", "GN", "GP", "GQ", "GR", "GS", "GT", "GU", "GW", "GY", "HK", "HM", "HN", "HR", "HT", "HU", "IC", "ID", "IE", "IL", "IM", "IN", "IO", "IQ", "IR", "IS", "IT", "JE", "JM", "JO", "JP", "KE", "KG", "KH", "KI", "KM", "KN", "KP", "KR", "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", "XK", "YE", "YT", "ZA", "ZM", "ZW" ], "title": "ItAgreementsGetResponsesContentApplicationJsonSchemaDataItemsActionsReuseDetailsReassignableInItems", "type": "string" }, "ItAgreementsGetResponsesContentApplicationJsonSchemaDataItemsActionsReuseDetailsReusableVariantsItems": { "properties": { "allowed_acquisition_types": { "description": "Acquisition types allowed for this variant", "items": { "$ref": "#/components/schemas/ItAgreementsGetResponsesContentApplicationJsonSchemaDataItemsActionsReuseDetailsReusableVariantsItemsAllowedAcquisitionTypesItems" }, "type": "array" }, "allowed_rental_terms": { "description": "Rental terms permitted for this variant. Empty for non-rental variants.", "items": { "$ref": "#/components/schemas/ItAgreementsGetResponsesContentApplicationJsonSchemaDataItemsActionsReuseDetailsReusableVariantsItemsAllowedRentalTermsItems" }, "type": "array" }, "available_countries": { "description": "ISO 3166 alpha-2 country codes where this variant can be ordered", "items": { "$ref": "#/components/schemas/ItAgreementsGetResponsesContentApplicationJsonSchemaDataItemsActionsReuseDetailsReusableVariantsItemsAvailableCountriesItems" }, "type": "array" }, "id": { "description": "Unique identifier of the variant", "format": "uuid", "type": "string" }, "image": { "description": "Image of this variant, null when the variant has no image", "oneOf": [ { "$ref": "#/components/schemas/ItAgreementsGetResponsesContentApplicationJsonSchemaDataItemsActionsReuseDetailsReusableVariantsItemsImage" }, { "type": "null" } ] }, "keyboard_layout": { "description": "Physical keyboard layout (laptops only)", "oneOf": [ { "$ref": "#/components/schemas/ItAgreementsGetResponsesContentApplicationJsonSchemaDataItemsActionsReuseDetailsReusableVariantsItemsKeyboardLayout" }, { "type": "null" } ] }, "operating_system": { "description": "Operating system installed on this variant (devices only)", "oneOf": [ { "$ref": "#/components/schemas/ItAgreementsGetResponsesContentApplicationJsonSchemaDataItemsActionsReuseDetailsReusableVariantsItemsOperatingSystem" }, { "type": "null" } ] }, "public_id": { "description": "Public identifier of the variant", "type": "string" }, "size": { "description": "Physical size or dimension label — style + size together uniquely identify a variant within a product", "type": [ "string", "null" ] }, "sku": { "description": "SKU of the variant", "type": [ "string", "null" ] }, "style": { "description": "Marketing style (colour, tier, etc.) — style + size together uniquely identify a variant within a product", "type": [ "string", "null" ] } }, "required": [ "id", "sku", "size", "image", "style", "public_id", "keyboard_layout", "operating_system", "available_countries", "allowed_rental_terms", "allowed_acquisition_types" ], "title": "ItAgreementsGetResponsesContentApplicationJsonSchemaDataItemsActionsReuseDetailsReusableVariantsItems", "type": "object" }, "ItAgreementsGetResponsesContentApplicationJsonSchemaDataItemsActionsReuseDetailsReusableVariantsItemsAllowedAcquisitionTypesItems": { "enum": [ "PURCHASE", "RENTAL", "REUSE" ], "title": "ItAgreementsGetResponsesContentApplicationJsonSchemaDataItemsActionsReuseDetailsReusableVariantsItemsAllowedAcquisitionTypesItems", "type": "string" }, "ItAgreementsGetResponsesContentApplicationJsonSchemaDataItemsActionsReuseDetailsReusableVariantsItemsAllowedRentalTermsItems": { "enum": [ "MONTH_12", "MONTH_24" ], "title": "ItAgreementsGetResponsesContentApplicationJsonSchemaDataItemsActionsReuseDetailsReusableVariantsItemsAllowedRentalTermsItems", "type": "string" }, "ItAgreementsGetResponsesContentApplicationJsonSchemaDataItemsActionsReuseDetailsReusableVariantsItemsAvailableCountriesItems": { "enum": [ "AD", "AE", "AF", "AG", "AI", "AL", "AM", "AN", "AO", "AQ", "AR", "AS", "AT", "AU", "AW", "AX", "AZ", "BA", "BB", "BD", "BE", "BF", "BG", "BH", "BI", "BJ", "BL", "BM", "BN", "BO", "BQ", "BR", "BS", "BT", "BV", "BW", "BY", "BZ", "CA", "CC", "CD", "CF", "CG", "CH", "CI", "CK", "CL", "CM", "CN", "CO", "CR", "CU", "CV", "CW", "CX", "CY", "CZ", "DE", "DJ", "DK", "DM", "DO", "DZ", "EC", "EE", "EG", "EH", "ER", "ES", "ET", "FI", "FJ", "FK", "FM", "FO", "FR", "GA", "GB", "GD", "GE", "GF", "GG", "GH", "GI", "GL", "GM", "GN", "GP", "GQ", "GR", "GS", "GT", "GU", "GW", "GY", "HK", "HM", "HN", "HR", "HT", "HU", "IC", "ID", "IE", "IL", "IM", "IN", "IO", "IQ", "IR", "IS", "IT", "JE", "JM", "JO", "JP", "KE", "KG", "KH", "KI", "KM", "KN", "KP", "KR", "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", "XK", "YE", "YT", "ZA", "ZM", "ZW" ], "title": "ItAgreementsGetResponsesContentApplicationJsonSchemaDataItemsActionsReuseDetailsReusableVariantsItemsAvailableCountriesItems", "type": "string" }, "ItAgreementsGetResponsesContentApplicationJsonSchemaDataItemsActionsReuseDetailsReusableVariantsItemsImage": { "description": "Image of this variant, null when the variant has no image", "properties": { "id": { "description": "Unique identifier of the image", "format": "uuid", "type": "string" }, "url": { "description": "Public URL of the image", "type": "string" } }, "required": [ "id", "url" ], "title": "ItAgreementsGetResponsesContentApplicationJsonSchemaDataItemsActionsReuseDetailsReusableVariantsItemsImage", "type": "object" }, "ItAgreementsGetResponsesContentApplicationJsonSchemaDataItemsActionsReuseDetailsReusableVariantsItemsKeyboardLayout": { "description": "Physical keyboard layout (laptops only)", "enum": [ "BELGIAN_AZERTY", "CANADIAN_MULTILINGUAL_STANDARD_QWERTY", "CZECH_QWERTY", "DANISH_QWERTY", "DUTCH_QWERTY", "EGYPTIAN_LOCAL", "ENGLISH_RUSSIAN_QWERTY", "EU_STANDARD_QWERTY", "FRENCH_AZERTY", "GERMAN_QWERTZ", "INDIAN_QWERTY", "INTERNATIONAL_ENGLISH_QWERTY", "ITALIAN_QWERTY", "JAPANESE_QWERTY", "KOREAN_QWERTY", "LATAM_QWERTY", "NORWEGIAN_QWERTY", "PORTUGUESE_QWERTY", "SPANISH_QWERTY", "SWEDISH_QWERTY", "SWISS_FRENCH_QWERTZ", "SWISS_GERMAN_QWERTZ", "TURKISH_QWERTY", "UK_ENGLISH_QWERTY", "UNKNOWN", "US_ENGLISH_QWERTY" ], "title": "ItAgreementsGetResponsesContentApplicationJsonSchemaDataItemsActionsReuseDetailsReusableVariantsItemsKeyboardLayout", "type": "string" }, "ItAgreementsGetResponsesContentApplicationJsonSchemaDataItemsActionsReuseDetailsReusableVariantsItemsOperatingSystem": { "description": "Operating system installed on this variant (devices only)", "enum": [ "ANDROID_PHONE", "ANDROID_TABLET", "CHROME_OS", "IOS_PHONE", "IOS_TABLET", "LINUX", "MACOS", "WINDOWS" ], "title": "ItAgreementsGetResponsesContentApplicationJsonSchemaDataItemsActionsReuseDetailsReusableVariantsItemsOperatingSystem", "type": "string" }, "ItAgreementsGetResponsesContentApplicationJsonSchemaDataItemsActionsReuseDisabledReason": { "description": "Populated when `is_enabled = false`; the single reason code the storefront gave for the\ndisabled state. Not a list — matches V2 action-slot semantics.", "enum": [ "CONTRACT_HAS_ACTIVE_ASSIGNMENT", "CONTRACT_IS_NOT_ACTIVE", "CONTRACT_IS_NOT_RENTAL", "CONTRACT_IS_NOT_REUSE_ENABLED", "CONTRACT_TYPE_NOT_ALLOWED", "ORGANIZATION_NOT_ACTIVE" ], "title": "ItAgreementsGetResponsesContentApplicationJsonSchemaDataItemsActionsReuseDisabledReason", "type": "string" }, "ItAgreementsGetResponsesContentApplicationJsonSchemaDataItemsAssignedHrisProfile": { "description": "Current holder of the agreement, if any. `null` while the agreement is between users\n(e.g. after POST /assets/{id}/store).", "properties": { "emails": { "description": "Array of user email addresses", "items": { "format": "email", "type": "string" }, "type": "array" }, "first_name": { "description": "First name of the user", "type": "string" }, "hris_profile_id": { "description": "The unique identifier of the HRIS profile of the assigned user", "format": "uuid", "type": "string" }, "last_name": { "description": "Last name of the user", "type": "string" } }, "required": [ "emails", "last_name", "first_name", "hris_profile_id" ], "title": "ItAgreementsGetResponsesContentApplicationJsonSchemaDataItemsAssignedHrisProfile", "type": "object" }, "ItAgreementsGetResponsesContentApplicationJsonSchemaDataItemsProduct": { "description": "The product this agreement is for.", "properties": { "brand": { "description": "Product brand", "type": "string" }, "category": { "$ref": "#/components/schemas/ItAgreementsGetResponsesContentApplicationJsonSchemaDataItemsProductCategory", "description": "Product category" }, "id": { "description": "Unique identifier of the product", "format": "uuid", "type": "string" }, "name": { "description": "Product name", "type": "string" } }, "required": [ "id", "name", "brand", "category" ], "title": "ItAgreementsGetResponsesContentApplicationJsonSchemaDataItemsProduct", "type": "object" }, "ItAgreementsGetResponsesContentApplicationJsonSchemaDataItemsProductCategory": { "description": "Product category", "enum": [ "ADAPTER", "CABLE", "CHAIR", "CHARGER", "COMPACT_DESKTOP", "DESK", "DESKTOP", "DESK_RISER", "DESK_TIDY", "DOCKING_STATION", "DONGLE", "FOOTREST", "HEADSET", "KEYBOARD", "LAPTOP", "LAPTOP_STAND", "MICE_TRACKPAD", "MOBILE_DEVICE", "MONITOR", "MONITOR_ARM", "OTHER", "PRINTER", "SHREDDER", "STANDING_MAT", "TABLET", "TASK_LIGHT", "WEBCAM", "WELCOME_PACK", "WIFI_RANGE_EXTENDER" ], "title": "ItAgreementsGetResponsesContentApplicationJsonSchemaDataItemsProductCategory", "type": "string" }, "ItAgreementsGetResponsesContentApplicationJsonSchemaDataItemsStatus": { "description": "Normalised agreement status.", "enum": [ "ACTIVE", "CANCELED", "ENDED", "PENDING" ], "title": "ItAgreementsGetResponsesContentApplicationJsonSchemaDataItemsStatus", "type": "string" }, "ItAgreementsGetResponsesContentApplicationJsonSchemaDataItemsStoreAndReuse": { "description": "Store-and-reuse block. Present only when the agreement is a rental with store-and-reuse\nenabled.", "properties": { "status": { "$ref": "#/components/schemas/ItAgreementsGetResponsesContentApplicationJsonSchemaDataItemsStoreAndReuseStatus", "description": "Current state of the store-and-reuse lifecycle for this rental contract." } }, "required": [ "status" ], "title": "ItAgreementsGetResponsesContentApplicationJsonSchemaDataItemsStoreAndReuse", "type": "object" }, "ItAgreementsGetResponsesContentApplicationJsonSchemaDataItemsStoreAndReuseStatus": { "description": "Current state of the store-and-reuse lifecycle for this rental contract.", "enum": [ "COMPLETED", "IN_PROGRESS", "READY" ], "title": "ItAgreementsGetResponsesContentApplicationJsonSchemaDataItemsStoreAndReuseStatus", "type": "string" }, "ItAgreementsGetResponsesContentApplicationJsonSchemaDataItemsType": { "description": "Agreement type.", "enum": [ "MANAGEMENT", "PURCHASE", "RENTAL" ], "title": "ItAgreementsGetResponsesContentApplicationJsonSchemaDataItemsType", "type": "string" }, "ItAgreementsGetResponsesContentApplicationJsonSchemaErrorsItems": { "properties": { "code": { "description": "Error code of the handler which produced the returned error", "type": "string" }, "field": { "description": "The field name where input validation failed", "type": [ "string", "null" ] }, "message": { "description": "Description of the returned error", "type": "string" } }, "required": [ "code", "field", "message" ], "title": "ItAgreementsGetResponsesContentApplicationJsonSchemaErrorsItems", "type": "object" }, "ItAssetsAssetIdAddonsAddonIdAssignPostParametersXBeta": { "default": "true", "enum": [ "true" ], "title": "ItAssetsAssetIdAddonsAddonIdAssignPostParametersXBeta", "type": "string" }, "ItAssetsAssetIdAddonsAddonIdAssignPostResponsesContentApplicationJsonSchemaData": { "properties": { "actions": { "$ref": "#/components/schemas/ItAssetsAssetIdAddonsAddonIdAssignPostResponsesContentApplicationJsonSchemaDataActions", "description": "Actions the caller can execute on this asset, with availability status per action" }, "assigned_user": { "description": "Details of the user with asset possession", "oneOf": [ { "$ref": "#/components/schemas/ItAssetsAssetIdAddonsAddonIdAssignPostResponsesContentApplicationJsonSchemaDataAssignedUser" }, { "type": "null" } ] }, "assigned_warehouse": { "description": "Details of the warehouse with asset possession", "oneOf": [ { "$ref": "#/components/schemas/ItAssetsAssetIdAddonsAddonIdAssignPostResponsesContentApplicationJsonSchemaDataAssignedWarehouse" }, { "type": "null" } ] }, "created_at": { "description": "Creation timestamp of the asset", "format": "date-time", "type": "string" }, "grade": { "$ref": "#/components/schemas/ItAssetsAssetIdAddonsAddonIdAssignPostResponsesContentApplicationJsonSchemaDataGrade", "description": "The condition grade of the asset" }, "id": { "description": "Unique identifier of the item", "format": "uuid", "type": "string" }, "location": { "$ref": "#/components/schemas/ItAssetsAssetIdAddonsAddonIdAssignPostResponsesContentApplicationJsonSchemaDataLocation", "description": "Current location type of the asset" }, "ownership": { "$ref": "#/components/schemas/ItAssetsAssetIdAddonsAddonIdAssignPostResponsesContentApplicationJsonSchemaDataOwnership", "description": "Asset owner" }, "product": { "$ref": "#/components/schemas/ItAssetsAssetIdAddonsAddonIdAssignPostResponsesContentApplicationJsonSchemaDataProduct", "description": "Product details" }, "public_id": { "description": "Public identifier of the item", "type": "string" }, "purchase_date": { "description": "Purchase date of the asset", "format": "date", "type": [ "string", "null" ] }, "purchase_value": { "description": "Purchase value of the asset", "oneOf": [ { "$ref": "#/components/schemas/ItAssetsAssetIdAddonsAddonIdAssignPostResponsesContentApplicationJsonSchemaDataPurchaseValue" }, { "type": "null" } ] }, "serial_number": { "description": "Asset serial number", "type": [ "string", "null" ] }, "status": { "$ref": "#/components/schemas/ItAssetsAssetIdAddonsAddonIdAssignPostResponsesContentApplicationJsonSchemaDataStatus", "description": "Current state of the asset" }, "updated_at": { "description": "Last update timestamp of the asset", "format": "date-time", "type": "string" } }, "required": [ "id", "grade", "status", "actions", "product", "location", "ownership", "public_id", "created_at", "updated_at", "assigned_user", "purchase_date", "serial_number", "purchase_value", "assigned_warehouse" ], "title": "ItAssetsAssetIdAddonsAddonIdAssignPostResponsesContentApplicationJsonSchemaData", "type": "object" }, "ItAssetsAssetIdAddonsAddonIdAssignPostResponsesContentApplicationJsonSchemaDataActions": { "description": "Actions the caller can execute on this asset, with availability status per action", "properties": { "archive_own_asset": { "$ref": "#/components/schemas/ItAssetsAssetIdAddonsAddonIdAssignPostResponsesContentApplicationJsonSchemaDataActionsArchiveOwnAsset", "description": "Archive an organization-owned asset" }, "asset_country": { "description": "Resolved country used for asset actions. Derived from the asset's country,\nits assigned rental contract billing entity country, or the last active\nassignment delivery country. Null when the country cannot be determined\n(e.g. asset was returned to Deel)", "oneOf": [ { "$ref": "#/components/schemas/ItAssetsAssetIdAddonsAddonIdAssignPostResponsesContentApplicationJsonSchemaDataActionsAssetCountry" }, { "type": "null" } ] }, "assign_addon_to_own_asset": { "$ref": "#/components/schemas/ItAssetsAssetIdAddonsAddonIdAssignPostResponsesContentApplicationJsonSchemaDataActionsAssignAddonToOwnAsset", "description": "Assign an add-on to an organization-owned asset" }, "clear_own_asset": { "$ref": "#/components/schemas/ItAssetsAssetIdAddonsAddonIdAssignPostResponsesContentApplicationJsonSchemaDataActionsClearOwnAsset", "description": "Clear an organization-owned asset from the fleet" }, "manage_end_of_rental_contract_actions": { "$ref": "#/components/schemas/ItAssetsAssetIdAddonsAddonIdAssignPostResponsesContentApplicationJsonSchemaDataActionsManageEndOfRentalContractActions", "description": "Manage end-of-rental options for a Deel-owned rental asset" }, "purchase_rental": { "$ref": "#/components/schemas/ItAssetsAssetIdAddonsAddonIdAssignPostResponsesContentApplicationJsonSchemaDataActionsPurchaseRental", "description": "Purchase a Deel-owned rental asset at end of contract" }, "return_rental_to_deel": { "$ref": "#/components/schemas/ItAssetsAssetIdAddonsAddonIdAssignPostResponsesContentApplicationJsonSchemaDataActionsReturnRentalToDeel", "description": "Return a Deel-owned rental asset back to Deel" }, "reuse_own_asset_from_deel": { "$ref": "#/components/schemas/ItAssetsAssetIdAddonsAddonIdAssignPostResponsesContentApplicationJsonSchemaDataActionsReuseOwnAssetFromDeel", "description": "Redeploy an organization-owned asset stored at a Deel warehouse" }, "reuse_own_asset_from_own_location": { "$ref": "#/components/schemas/ItAssetsAssetIdAddonsAddonIdAssignPostResponsesContentApplicationJsonSchemaDataActionsReuseOwnAssetFromOwnLocation", "description": "Redeploy an organization-owned asset from an organization-owned location" }, "store_own_asset_at_deel_for_hub": { "$ref": "#/components/schemas/ItAssetsAssetIdAddonsAddonIdAssignPostResponsesContentApplicationJsonSchemaDataActionsStoreOwnAssetAtDeelForHub", "description": "Store an organization-owned asset at a Deel hub warehouse" }, "store_own_asset_at_deel_for_local": { "$ref": "#/components/schemas/ItAssetsAssetIdAddonsAddonIdAssignPostResponsesContentApplicationJsonSchemaDataActionsStoreOwnAssetAtDeelForLocal", "description": "Store an organization-owned asset at a Deel local warehouse" }, "store_own_asset_at_own_location": { "$ref": "#/components/schemas/ItAssetsAssetIdAddonsAddonIdAssignPostResponsesContentApplicationJsonSchemaDataActionsStoreOwnAssetAtOwnLocation", "description": "Store an organization-owned asset at an organization-owned location" }, "store_rental_at_deel_for_local": { "$ref": "#/components/schemas/ItAssetsAssetIdAddonsAddonIdAssignPostResponsesContentApplicationJsonSchemaDataActionsStoreRentalAtDeelForLocal", "description": "Store a Deel-owned rental asset at a Deel local warehouse" }, "store_rental_at_deel_for_zone1": { "$ref": "#/components/schemas/ItAssetsAssetIdAddonsAddonIdAssignPostResponsesContentApplicationJsonSchemaDataActionsStoreRentalAtDeelForZone1", "description": "Store a Deel-owned rental asset at a Deel zone-1 warehouse" }, "transfer_own_asset": { "$ref": "#/components/schemas/ItAssetsAssetIdAddonsAddonIdAssignPostResponsesContentApplicationJsonSchemaDataActionsTransferOwnAsset", "description": "Transfer an organization-owned asset to another user" }, "transfer_rental": { "$ref": "#/components/schemas/ItAssetsAssetIdAddonsAddonIdAssignPostResponsesContentApplicationJsonSchemaDataActionsTransferRental", "description": "Transfer a Deel-owned rental asset to another user" }, "unarchive_own_asset": { "$ref": "#/components/schemas/ItAssetsAssetIdAddonsAddonIdAssignPostResponsesContentApplicationJsonSchemaDataActionsUnarchiveOwnAsset", "description": "Unarchive a previously archived organization-owned asset" }, "update_location_location_to_user": { "$ref": "#/components/schemas/ItAssetsAssetIdAddonsAddonIdAssignPostResponsesContentApplicationJsonSchemaDataActionsUpdateLocationLocationToUser", "description": "Update the location of an asset from a warehouse to a user" }, "update_location_user_to_location": { "$ref": "#/components/schemas/ItAssetsAssetIdAddonsAddonIdAssignPostResponsesContentApplicationJsonSchemaDataActionsUpdateLocationUserToLocation", "description": "Update the location of an asset from a user to a warehouse" }, "update_location_user_to_user": { "$ref": "#/components/schemas/ItAssetsAssetIdAddonsAddonIdAssignPostResponsesContentApplicationJsonSchemaDataActionsUpdateLocationUserToUser", "description": "Update the assigned user of an asset that is currently with a user" }, "update_own_asset_details": { "$ref": "#/components/schemas/ItAssetsAssetIdAddonsAddonIdAssignPostResponsesContentApplicationJsonSchemaDataActionsUpdateOwnAssetDetails", "description": "Update editable details of an organization-owned asset" } }, "required": [ "asset_country", "clear_own_asset", "purchase_rental", "transfer_rental", "archive_own_asset", "transfer_own_asset", "unarchive_own_asset", "return_rental_to_deel", "update_own_asset_details", "assign_addon_to_own_asset", "reuse_own_asset_from_deel", "update_location_user_to_user", "store_rental_at_deel_for_local", "store_rental_at_deel_for_zone1", "store_own_asset_at_deel_for_hub", "store_own_asset_at_own_location", "update_location_location_to_user", "update_location_user_to_location", "reuse_own_asset_from_own_location", "store_own_asset_at_deel_for_local", "manage_end_of_rental_contract_actions" ], "title": "ItAssetsAssetIdAddonsAddonIdAssignPostResponsesContentApplicationJsonSchemaDataActions", "type": "object" }, "ItAssetsAssetIdAddonsAddonIdAssignPostResponsesContentApplicationJsonSchemaDataActionsArchiveOwnAsset": { "description": "Archive an organization-owned asset", "properties": { "details": { "description": "Action-specific context needed to perform the action. Populated for enabled and\ndisabled actions (so callers can see what a successful attempt would look like);\nnull when the action is not applicable to this asset.", "oneOf": [ { "$ref": "#/components/schemas/ItAssetsAssetIdAddonsAddonIdAssignPostResponsesContentApplicationJsonSchemaDataActionsArchiveOwnAssetDetails" }, { "type": "null" } ] }, "disabled_reasons": { "description": "Reasons why the action is disabled. Empty when the action is enabled or not applicable", "items": { "$ref": "#/components/schemas/ItAssetsAssetIdAddonsAddonIdAssignPostResponsesContentApplicationJsonSchemaDataActionsArchiveOwnAssetDisabledReasonsItems" }, "type": "array" }, "status": { "$ref": "#/components/schemas/ItAssetsAssetIdAddonsAddonIdAssignPostResponsesContentApplicationJsonSchemaDataActionsArchiveOwnAssetStatus", "description": "Whether the action is currently available for this asset" } }, "required": [ "status", "details", "disabled_reasons" ], "title": "ItAssetsAssetIdAddonsAddonIdAssignPostResponsesContentApplicationJsonSchemaDataActionsArchiveOwnAsset", "type": "object" }, "ItAssetsAssetIdAddonsAddonIdAssignPostResponsesContentApplicationJsonSchemaDataActionsArchiveOwnAssetDetails": { "description": "Action-specific context needed to perform the action. Populated for enabled and\ndisabled actions (so callers can see what a successful attempt would look like);\nnull when the action is not applicable to this asset.", "properties": { "allowed_statuses": { "description": "Statuses that can be passed as the archive reason when archiving the asset", "items": { "$ref": "#/components/schemas/ItAssetsAssetIdAddonsAddonIdAssignPostResponsesContentApplicationJsonSchemaDataActionsArchiveOwnAssetDetailsAllowedStatusesItems" }, "type": "array" } }, "required": [ "allowed_statuses" ], "title": "ItAssetsAssetIdAddonsAddonIdAssignPostResponsesContentApplicationJsonSchemaDataActionsArchiveOwnAssetDetails", "type": "object" }, "ItAssetsAssetIdAddonsAddonIdAssignPostResponsesContentApplicationJsonSchemaDataActionsArchiveOwnAssetDetailsAllowedStatusesItems": { "enum": [ "ADDED_BY_MISTAKE", "BINNED", "BROKEN_AT_WAREHOUSE", "BROKEN_BY_USER", "BROKEN_IN_TRANSIT", "DAMAGED_AT_WAREHOUSE", "DAMAGED_BY_USER", "DAMAGED_IN_TRANSIT", "LEFT_WITH_USER", "LOST_IN_TRANSIT", "RETURNED_TO_DEEL", "SHRINKAGE", "STOLEN", "SUPPLIER_RETURN" ], "title": "ItAssetsAssetIdAddonsAddonIdAssignPostResponsesContentApplicationJsonSchemaDataActionsArchiveOwnAssetDetailsAllowedStatusesItems", "type": "string" }, "ItAssetsAssetIdAddonsAddonIdAssignPostResponsesContentApplicationJsonSchemaDataActionsArchiveOwnAssetDisabledReasonsItems": { "enum": [ "ARCHIVED", "AT_DEEL_WAREHOUSE", "BEING_REPAIRED", "CONSUMABLE", "CONTROLLED_BY_DEEL", "COUNTRY_NOT_SUPPORTED_FOR_HUB", "COUNTRY_NOT_SUPPORTED_FOR_LOCAL", "DEEL_OWNED_ITEM_WITHOUT_RENTAL_CONTRACT", "DESKTOP_STORAGE", "ENDING_CONTRACT", "HUB_IN_SAME_REGION_AS_LOCAL", "INACTIVE", "INVALID_ITEM_LOCATION", "INVALID_ORGANIZATION_STATUS", "INVALID_STATE", "ITEM_CONDITIONS_TO_UNARCHIVE_NOT_MET", "ITEM_NOT_VISIBLE_FOR_ORGANIZATION", "NON_DEVICE", "NOT_AT_WAREHOUSE", "NOT_AVAILABLE_FOR_REUSE", "NOT_A_RENTAL", "NOT_MANAGEABLE_BY_ORGANIZATION", "NOT_WITH_ASSIGNMENT", "NOT_WITH_USER", "NO_ACTIVE_ADDONS", "NO_ACTIVE_STORAGE_CONTRACT", "NO_LOCATION_FOR_STORAGE", "NO_LOGISTICS_FOR_STORAGE", "NO_VALID_ADDONS", "ONGOING_SERVICE", "OWNED_BY_DEEL", "OWNED_BY_ORGANIZATION", "OWNED_BY_PARTNER_ORGANIZATION", "PARTNER_CHILD_CONTRACT", "PENDING_DEVICE_REFRESH", "RENTAL_CONTRACT_AND_USER_REGION_DO_NOT_MATCH", "TEMPORARILY_UNAVAILABLE", "UNKNOWN", "USER_HAS_NO_COUNTRY", "USER_HAS_NO_SEAT", "WAITING_FOR_CLEARANCE", "WITH_LOANER_ASSIGNMENT", "WITH_NON_COLLECTED_ASSIGNMENT", "WITH_NON_DELIVERED_ASSIGNMENT", "WITH_PENDING_ASSIGNMENT", "WRONG_ASSIGNMENT_STATUS", "WRONG_CONTRACT_STATUS", "WRONG_TERMS_AND_CONDITIONS" ], "title": "ItAssetsAssetIdAddonsAddonIdAssignPostResponsesContentApplicationJsonSchemaDataActionsArchiveOwnAssetDisabledReasonsItems", "type": "string" }, "ItAssetsAssetIdAddonsAddonIdAssignPostResponsesContentApplicationJsonSchemaDataActionsArchiveOwnAssetStatus": { "description": "Whether the action is currently available for this asset", "enum": [ "DISABLED", "ENABLED", "NOT_APPLICABLE" ], "title": "ItAssetsAssetIdAddonsAddonIdAssignPostResponsesContentApplicationJsonSchemaDataActionsArchiveOwnAssetStatus", "type": "string" }, "ItAssetsAssetIdAddonsAddonIdAssignPostResponsesContentApplicationJsonSchemaDataActionsAssetCountry": { "description": "Resolved country used for asset actions. Derived from the asset's country,\nits assigned rental contract billing entity country, or the last active\nassignment delivery country. Null when the country cannot be determined\n(e.g. asset was returned to Deel)", "enum": [ "AD", "AE", "AF", "AG", "AI", "AL", "AM", "AN", "AO", "AQ", "AR", "AS", "AT", "AU", "AW", "AX", "AZ", "BA", "BB", "BD", "BE", "BF", "BG", "BH", "BI", "BJ", "BL", "BM", "BN", "BO", "BQ", "BR", "BS", "BT", "BV", "BW", "BY", "BZ", "CA", "CC", "CD", "CF", "CG", "CH", "CI", "CK", "CL", "CM", "CN", "CO", "CR", "CU", "CV", "CW", "CX", "CY", "CZ", "DE", "DJ", "DK", "DM", "DO", "DZ", "EC", "EE", "EG", "EH", "ER", "ES", "ET", "FI", "FJ", "FK", "FM", "FO", "FR", "GA", "GB", "GD", "GE", "GF", "GG", "GH", "GI", "GL", "GM", "GN", "GP", "GQ", "GR", "GS", "GT", "GU", "GW", "GY", "HK", "HM", "HN", "HR", "HT", "HU", "IC", "ID", "IE", "IL", "IM", "IN", "IO", "IQ", "IR", "IS", "IT", "JE", "JM", "JO", "JP", "KE", "KG", "KH", "KI", "KM", "KN", "KP", "KR", "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", "XK", "YE", "YT", "ZA", "ZM", "ZW" ], "title": "ItAssetsAssetIdAddonsAddonIdAssignPostResponsesContentApplicationJsonSchemaDataActionsAssetCountry", "type": "string" }, "ItAssetsAssetIdAddonsAddonIdAssignPostResponsesContentApplicationJsonSchemaDataActionsAssignAddonToOwnAsset": { "description": "Assign an add-on to an organization-owned asset", "properties": { "details": { "description": "Action-specific context needed to perform the action. Populated for enabled and\ndisabled actions (so callers can see what a successful attempt would look like);\nnull when the action is not applicable to this asset.", "oneOf": [ { "$ref": "#/components/schemas/ItAssetsAssetIdAddonsAddonIdAssignPostResponsesContentApplicationJsonSchemaDataActionsAssignAddonToOwnAssetDetails" }, { "type": "null" } ] }, "disabled_reasons": { "description": "Reasons why the action is disabled. Empty when the action is enabled or not applicable", "items": { "$ref": "#/components/schemas/ItAssetsAssetIdAddonsAddonIdAssignPostResponsesContentApplicationJsonSchemaDataActionsAssignAddonToOwnAssetDisabledReasonsItems" }, "type": "array" }, "status": { "$ref": "#/components/schemas/ItAssetsAssetIdAddonsAddonIdAssignPostResponsesContentApplicationJsonSchemaDataActionsAssignAddonToOwnAssetStatus", "description": "Whether the action is currently available for this asset" } }, "required": [ "status", "details", "disabled_reasons" ], "title": "ItAssetsAssetIdAddonsAddonIdAssignPostResponsesContentApplicationJsonSchemaDataActionsAssignAddonToOwnAsset", "type": "object" }, "ItAssetsAssetIdAddonsAddonIdAssignPostResponsesContentApplicationJsonSchemaDataActionsAssignAddonToOwnAssetDetails": { "description": "Action-specific context needed to perform the action. Populated for enabled and\ndisabled actions (so callers can see what a successful attempt would look like);\nnull when the action is not applicable to this asset.", "properties": { "addons": { "description": "Add-ons that can be assigned to the asset, with a fail reason for those that don't qualify", "items": { "$ref": "#/components/schemas/ItAssetsAssetIdAddonsAddonIdAssignPostResponsesContentApplicationJsonSchemaDataActionsAssignAddonToOwnAssetDetailsAddonsItems" }, "type": "array" } }, "required": [ "addons" ], "title": "ItAssetsAssetIdAddonsAddonIdAssignPostResponsesContentApplicationJsonSchemaDataActionsAssignAddonToOwnAssetDetails", "type": "object" }, "ItAssetsAssetIdAddonsAddonIdAssignPostResponsesContentApplicationJsonSchemaDataActionsAssignAddonToOwnAssetDetailsAddonsItems": { "properties": { "addon": { "$ref": "#/components/schemas/ItAssetsAssetIdAddonsAddonIdAssignPostResponsesContentApplicationJsonSchemaDataActionsAssignAddonToOwnAssetDetailsAddonsItemsAddon", "description": "Add-on that can be assigned to the asset" }, "fail_reason": { "description": "Reason the add-on cannot be assigned to the asset. Null when assignment is allowed", "oneOf": [ { "$ref": "#/components/schemas/ItAssetsAssetIdAddonsAddonIdAssignPostResponsesContentApplicationJsonSchemaDataActionsAssignAddonToOwnAssetDetailsAddonsItemsFailReason" }, { "type": "null" } ] } }, "required": [ "addon", "fail_reason" ], "title": "ItAssetsAssetIdAddonsAddonIdAssignPostResponsesContentApplicationJsonSchemaDataActionsAssignAddonToOwnAssetDetailsAddonsItems", "type": "object" }, "ItAssetsAssetIdAddonsAddonIdAssignPostResponsesContentApplicationJsonSchemaDataActionsAssignAddonToOwnAssetDetailsAddonsItemsAddon": { "description": "Add-on that can be assigned to the asset", "properties": { "id": { "description": "ID of the add-on", "format": "uuid", "type": "string" }, "name": { "description": "Public display name of the add-on", "type": "string" } }, "required": [ "id", "name" ], "title": "ItAssetsAssetIdAddonsAddonIdAssignPostResponsesContentApplicationJsonSchemaDataActionsAssignAddonToOwnAssetDetailsAddonsItemsAddon", "type": "object" }, "ItAssetsAssetIdAddonsAddonIdAssignPostResponsesContentApplicationJsonSchemaDataActionsAssignAddonToOwnAssetDetailsAddonsItemsFailReason": { "description": "Reason the add-on cannot be assigned to the asset. Null when assignment is allowed", "enum": [ "ADDON_NOT_AVAILABLE_TO_ORGANIZATION", "ALREADY_ASSIGNED", "HAS_ACTIVE_SERVICE_ADDON", "INVALID_ASSET_AGE", "INVALID_CONTRACT_TYPE", "INVALID_DURATION", "INVALID_PAYMENT_SCHEMA", "INVALID_PLATFORM_TIER", "INVALID_PRODUCT_BRAND", "INVALID_PRODUCT_CATEGORY", "INVALID_PRODUCT_PARENT_CATEGORY", "INVALID_RENTAL_TERM", "NO_MATCHING_ORGANIZATION_CONTRACT", "OTHER" ], "title": "ItAssetsAssetIdAddonsAddonIdAssignPostResponsesContentApplicationJsonSchemaDataActionsAssignAddonToOwnAssetDetailsAddonsItemsFailReason", "type": "string" }, "ItAssetsAssetIdAddonsAddonIdAssignPostResponsesContentApplicationJsonSchemaDataActionsAssignAddonToOwnAssetDisabledReasonsItems": { "enum": [ "ARCHIVED", "AT_DEEL_WAREHOUSE", "BEING_REPAIRED", "CONSUMABLE", "CONTROLLED_BY_DEEL", "COUNTRY_NOT_SUPPORTED_FOR_HUB", "COUNTRY_NOT_SUPPORTED_FOR_LOCAL", "DEEL_OWNED_ITEM_WITHOUT_RENTAL_CONTRACT", "DESKTOP_STORAGE", "ENDING_CONTRACT", "HUB_IN_SAME_REGION_AS_LOCAL", "INACTIVE", "INVALID_ITEM_LOCATION", "INVALID_ORGANIZATION_STATUS", "INVALID_STATE", "ITEM_CONDITIONS_TO_UNARCHIVE_NOT_MET", "ITEM_NOT_VISIBLE_FOR_ORGANIZATION", "NON_DEVICE", "NOT_AT_WAREHOUSE", "NOT_AVAILABLE_FOR_REUSE", "NOT_A_RENTAL", "NOT_MANAGEABLE_BY_ORGANIZATION", "NOT_WITH_ASSIGNMENT", "NOT_WITH_USER", "NO_ACTIVE_ADDONS", "NO_ACTIVE_STORAGE_CONTRACT", "NO_LOCATION_FOR_STORAGE", "NO_LOGISTICS_FOR_STORAGE", "NO_VALID_ADDONS", "ONGOING_SERVICE", "OWNED_BY_DEEL", "OWNED_BY_ORGANIZATION", "OWNED_BY_PARTNER_ORGANIZATION", "PARTNER_CHILD_CONTRACT", "PENDING_DEVICE_REFRESH", "RENTAL_CONTRACT_AND_USER_REGION_DO_NOT_MATCH", "TEMPORARILY_UNAVAILABLE", "UNKNOWN", "USER_HAS_NO_COUNTRY", "USER_HAS_NO_SEAT", "WAITING_FOR_CLEARANCE", "WITH_LOANER_ASSIGNMENT", "WITH_NON_COLLECTED_ASSIGNMENT", "WITH_NON_DELIVERED_ASSIGNMENT", "WITH_PENDING_ASSIGNMENT", "WRONG_ASSIGNMENT_STATUS", "WRONG_CONTRACT_STATUS", "WRONG_TERMS_AND_CONDITIONS" ], "title": "ItAssetsAssetIdAddonsAddonIdAssignPostResponsesContentApplicationJsonSchemaDataActionsAssignAddonToOwnAssetDisabledReasonsItems", "type": "string" }, "ItAssetsAssetIdAddonsAddonIdAssignPostResponsesContentApplicationJsonSchemaDataActionsAssignAddonToOwnAssetStatus": { "description": "Whether the action is currently available for this asset", "enum": [ "DISABLED", "ENABLED", "NOT_APPLICABLE" ], "title": "ItAssetsAssetIdAddonsAddonIdAssignPostResponsesContentApplicationJsonSchemaDataActionsAssignAddonToOwnAssetStatus", "type": "string" }, "ItAssetsAssetIdAddonsAddonIdAssignPostResponsesContentApplicationJsonSchemaDataActionsClearOwnAsset": { "description": "Clear an organization-owned asset from the fleet", "properties": { "disabled_reasons": { "description": "Reasons why the action is disabled. Empty when the action is enabled or not applicable", "items": { "$ref": "#/components/schemas/ItAssetsAssetIdAddonsAddonIdAssignPostResponsesContentApplicationJsonSchemaDataActionsClearOwnAssetDisabledReasonsItems" }, "type": "array" }, "status": { "$ref": "#/components/schemas/ItAssetsAssetIdAddonsAddonIdAssignPostResponsesContentApplicationJsonSchemaDataActionsClearOwnAssetStatus", "description": "Whether the action is currently available for this asset" } }, "required": [ "status", "disabled_reasons" ], "title": "ItAssetsAssetIdAddonsAddonIdAssignPostResponsesContentApplicationJsonSchemaDataActionsClearOwnAsset", "type": "object" }, "ItAssetsAssetIdAddonsAddonIdAssignPostResponsesContentApplicationJsonSchemaDataActionsClearOwnAssetDisabledReasonsItems": { "enum": [ "ARCHIVED", "AT_DEEL_WAREHOUSE", "BEING_REPAIRED", "CONSUMABLE", "CONTROLLED_BY_DEEL", "COUNTRY_NOT_SUPPORTED_FOR_HUB", "COUNTRY_NOT_SUPPORTED_FOR_LOCAL", "DEEL_OWNED_ITEM_WITHOUT_RENTAL_CONTRACT", "DESKTOP_STORAGE", "ENDING_CONTRACT", "HUB_IN_SAME_REGION_AS_LOCAL", "INACTIVE", "INVALID_ITEM_LOCATION", "INVALID_ORGANIZATION_STATUS", "INVALID_STATE", "ITEM_CONDITIONS_TO_UNARCHIVE_NOT_MET", "ITEM_NOT_VISIBLE_FOR_ORGANIZATION", "NON_DEVICE", "NOT_AT_WAREHOUSE", "NOT_AVAILABLE_FOR_REUSE", "NOT_A_RENTAL", "NOT_MANAGEABLE_BY_ORGANIZATION", "NOT_WITH_ASSIGNMENT", "NOT_WITH_USER", "NO_ACTIVE_ADDONS", "NO_ACTIVE_STORAGE_CONTRACT", "NO_LOCATION_FOR_STORAGE", "NO_LOGISTICS_FOR_STORAGE", "NO_VALID_ADDONS", "ONGOING_SERVICE", "OWNED_BY_DEEL", "OWNED_BY_ORGANIZATION", "OWNED_BY_PARTNER_ORGANIZATION", "PARTNER_CHILD_CONTRACT", "PENDING_DEVICE_REFRESH", "RENTAL_CONTRACT_AND_USER_REGION_DO_NOT_MATCH", "TEMPORARILY_UNAVAILABLE", "UNKNOWN", "USER_HAS_NO_COUNTRY", "USER_HAS_NO_SEAT", "WAITING_FOR_CLEARANCE", "WITH_LOANER_ASSIGNMENT", "WITH_NON_COLLECTED_ASSIGNMENT", "WITH_NON_DELIVERED_ASSIGNMENT", "WITH_PENDING_ASSIGNMENT", "WRONG_ASSIGNMENT_STATUS", "WRONG_CONTRACT_STATUS", "WRONG_TERMS_AND_CONDITIONS" ], "title": "ItAssetsAssetIdAddonsAddonIdAssignPostResponsesContentApplicationJsonSchemaDataActionsClearOwnAssetDisabledReasonsItems", "type": "string" }, "ItAssetsAssetIdAddonsAddonIdAssignPostResponsesContentApplicationJsonSchemaDataActionsClearOwnAssetStatus": { "description": "Whether the action is currently available for this asset", "enum": [ "DISABLED", "ENABLED", "NOT_APPLICABLE" ], "title": "ItAssetsAssetIdAddonsAddonIdAssignPostResponsesContentApplicationJsonSchemaDataActionsClearOwnAssetStatus", "type": "string" }, "ItAssetsAssetIdAddonsAddonIdAssignPostResponsesContentApplicationJsonSchemaDataActionsManageEndOfRentalContractActions": { "description": "Manage end-of-rental options for a Deel-owned rental asset", "properties": { "disabled_reasons": { "description": "Reasons why the action is disabled. Empty when the action is enabled or not applicable", "items": { "$ref": "#/components/schemas/ItAssetsAssetIdAddonsAddonIdAssignPostResponsesContentApplicationJsonSchemaDataActionsManageEndOfRentalContractActionsDisabledReasonsItems" }, "type": "array" }, "status": { "$ref": "#/components/schemas/ItAssetsAssetIdAddonsAddonIdAssignPostResponsesContentApplicationJsonSchemaDataActionsManageEndOfRentalContractActionsStatus", "description": "Whether the action is currently available for this asset" } }, "required": [ "status", "disabled_reasons" ], "title": "ItAssetsAssetIdAddonsAddonIdAssignPostResponsesContentApplicationJsonSchemaDataActionsManageEndOfRentalContractActions", "type": "object" }, "ItAssetsAssetIdAddonsAddonIdAssignPostResponsesContentApplicationJsonSchemaDataActionsManageEndOfRentalContractActionsDisabledReasonsItems": { "enum": [ "ARCHIVED", "AT_DEEL_WAREHOUSE", "BEING_REPAIRED", "CONSUMABLE", "CONTROLLED_BY_DEEL", "COUNTRY_NOT_SUPPORTED_FOR_HUB", "COUNTRY_NOT_SUPPORTED_FOR_LOCAL", "DEEL_OWNED_ITEM_WITHOUT_RENTAL_CONTRACT", "DESKTOP_STORAGE", "ENDING_CONTRACT", "HUB_IN_SAME_REGION_AS_LOCAL", "INACTIVE", "INVALID_ITEM_LOCATION", "INVALID_ORGANIZATION_STATUS", "INVALID_STATE", "ITEM_CONDITIONS_TO_UNARCHIVE_NOT_MET", "ITEM_NOT_VISIBLE_FOR_ORGANIZATION", "NON_DEVICE", "NOT_AT_WAREHOUSE", "NOT_AVAILABLE_FOR_REUSE", "NOT_A_RENTAL", "NOT_MANAGEABLE_BY_ORGANIZATION", "NOT_WITH_ASSIGNMENT", "NOT_WITH_USER", "NO_ACTIVE_ADDONS", "NO_ACTIVE_STORAGE_CONTRACT", "NO_LOCATION_FOR_STORAGE", "NO_LOGISTICS_FOR_STORAGE", "NO_VALID_ADDONS", "ONGOING_SERVICE", "OWNED_BY_DEEL", "OWNED_BY_ORGANIZATION", "OWNED_BY_PARTNER_ORGANIZATION", "PARTNER_CHILD_CONTRACT", "PENDING_DEVICE_REFRESH", "RENTAL_CONTRACT_AND_USER_REGION_DO_NOT_MATCH", "TEMPORARILY_UNAVAILABLE", "UNKNOWN", "USER_HAS_NO_COUNTRY", "USER_HAS_NO_SEAT", "WAITING_FOR_CLEARANCE", "WITH_LOANER_ASSIGNMENT", "WITH_NON_COLLECTED_ASSIGNMENT", "WITH_NON_DELIVERED_ASSIGNMENT", "WITH_PENDING_ASSIGNMENT", "WRONG_ASSIGNMENT_STATUS", "WRONG_CONTRACT_STATUS", "WRONG_TERMS_AND_CONDITIONS" ], "title": "ItAssetsAssetIdAddonsAddonIdAssignPostResponsesContentApplicationJsonSchemaDataActionsManageEndOfRentalContractActionsDisabledReasonsItems", "type": "string" }, "ItAssetsAssetIdAddonsAddonIdAssignPostResponsesContentApplicationJsonSchemaDataActionsManageEndOfRentalContractActionsStatus": { "description": "Whether the action is currently available for this asset", "enum": [ "DISABLED", "ENABLED", "NOT_APPLICABLE" ], "title": "ItAssetsAssetIdAddonsAddonIdAssignPostResponsesContentApplicationJsonSchemaDataActionsManageEndOfRentalContractActionsStatus", "type": "string" }, "ItAssetsAssetIdAddonsAddonIdAssignPostResponsesContentApplicationJsonSchemaDataActionsPurchaseRental": { "description": "Purchase a Deel-owned rental asset at end of contract", "properties": { "details": { "description": "Action-specific context needed to perform the action. Populated for enabled and\ndisabled actions (so callers can see what a successful attempt would look like);\nnull when the action is not applicable to this asset.", "oneOf": [ { "$ref": "#/components/schemas/ItAssetsAssetIdAddonsAddonIdAssignPostResponsesContentApplicationJsonSchemaDataActionsPurchaseRentalDetails" }, { "type": "null" } ] }, "disabled_reasons": { "description": "Reasons why the action is disabled. Empty when the action is enabled or not applicable", "items": { "$ref": "#/components/schemas/ItAssetsAssetIdAddonsAddonIdAssignPostResponsesContentApplicationJsonSchemaDataActionsPurchaseRentalDisabledReasonsItems" }, "type": "array" }, "status": { "$ref": "#/components/schemas/ItAssetsAssetIdAddonsAddonIdAssignPostResponsesContentApplicationJsonSchemaDataActionsPurchaseRentalStatus", "description": "Whether the action is currently available for this asset" } }, "required": [ "status", "details", "disabled_reasons" ], "title": "ItAssetsAssetIdAddonsAddonIdAssignPostResponsesContentApplicationJsonSchemaDataActionsPurchaseRental", "type": "object" }, "ItAssetsAssetIdAddonsAddonIdAssignPostResponsesContentApplicationJsonSchemaDataActionsPurchaseRentalDetails": { "description": "Action-specific context needed to perform the action. Populated for enabled and\ndisabled actions (so callers can see what a successful attempt would look like);\nnull when the action is not applicable to this asset.", "properties": { "purchase_price": { "description": "Estimated price to purchase the asset at the end of the rental contract", "oneOf": [ { "$ref": "#/components/schemas/ItAssetsAssetIdAddonsAddonIdAssignPostResponsesContentApplicationJsonSchemaDataActionsPurchaseRentalDetailsPurchasePrice" }, { "type": "null" } ] }, "remaining_contract_value": { "$ref": "#/components/schemas/ItAssetsAssetIdAddonsAddonIdAssignPostResponsesContentApplicationJsonSchemaDataActionsPurchaseRentalDetailsRemainingContractValue", "description": "Estimated remaining value of the rental contract" }, "total_purchase_price": { "description": "Estimated total price of the purchase, including any remaining contract value", "oneOf": [ { "$ref": "#/components/schemas/ItAssetsAssetIdAddonsAddonIdAssignPostResponsesContentApplicationJsonSchemaDataActionsPurchaseRentalDetailsTotalPurchasePrice" }, { "type": "null" } ] } }, "required": [ "purchase_price", "total_purchase_price", "remaining_contract_value" ], "title": "ItAssetsAssetIdAddonsAddonIdAssignPostResponsesContentApplicationJsonSchemaDataActionsPurchaseRentalDetails", "type": "object" }, "ItAssetsAssetIdAddonsAddonIdAssignPostResponsesContentApplicationJsonSchemaDataActionsPurchaseRentalDetailsPurchasePrice": { "description": "Estimated price to purchase the asset at the end of the rental contract", "properties": { "amount": { "description": "Amount", "format": "decimal", "type": "string" }, "currency": { "$ref": "#/components/schemas/ItAssetsAssetIdAddonsAddonIdAssignPostResponsesContentApplicationJsonSchemaDataActionsPurchaseRentalDetailsPurchasePriceCurrency", "description": "Three-letter currency code for the price" } }, "required": [ "amount", "currency" ], "title": "ItAssetsAssetIdAddonsAddonIdAssignPostResponsesContentApplicationJsonSchemaDataActionsPurchaseRentalDetailsPurchasePrice", "type": "object" }, "ItAssetsAssetIdAddonsAddonIdAssignPostResponsesContentApplicationJsonSchemaDataActionsPurchaseRentalDetailsPurchasePriceCurrency": { "description": "Three-letter currency code for the price", "enum": [ "AED", "AFN", "ALL", "AMD", "ANG", "AOA", "ARS", "AUD", "AWG", "AZN", "BAM", "BDT", "BGN", "BHD", "BIF", "BMD", "BOB", "BRL", "BSD", "BTN", "BWP", "BYN", "BZD", "CAD", "CDF", "CHF", "CLP", "CNY", "COP", "CRC", "CUC", "CVE", "CZK", "DJF", "DKK", "DOP", "DZD", "EGP", "ERN", "ETB", "EUR", "FJD", "FKP", "GBP", "GEL", "GHS", "GIP", "GMD", "GNF", "GTQ", "GYD", "HKD", "HNL", "HRK", "HTG", "HUF", "IDR", "ILS", "INR", "IQD", "IRR", "ISK", "JMD", "JOD", "JPY", "KES", "KGS", "KHR", "KMF", "KPW", "KRW", "KWD", "KYD", "KZT", "LAK", "LBP", "LKR", "LRD", "LSL", "LTL", "LYD", "MAD", "MDL", "MGA", "MKD", "MMK", "MNT", "MRU", "MUR", "MVR", "MWK", "MXN", "MYR", "MZN", "NAD", "NGN", "NIO", "NOK", "NPR", "NZD", "OMR", "PAB", "PEN", "PGK", "PHP", "PKR", "PLN", "PYG", "QAR", "RON", "RSD", "RUB", "RWF", "SAR", "SBD", "SCR", "SDG", "SEK", "SGD", "SHP", "SLL", "SOS", "SRD", "SSP", "STD", "SYP", "SZL", "THB", "TJS", "TMT", "TND", "TOP", "TRY", "TTD", "TWD", "TZS", "UAH", "UGX", "USD", "UYU", "UZS", "VEF", "VND", "VUV", "WST", "XAF", "XCD", "XOF", "XPF", "YER", "ZAR", "ZMW", "ZWD" ], "title": "ItAssetsAssetIdAddonsAddonIdAssignPostResponsesContentApplicationJsonSchemaDataActionsPurchaseRentalDetailsPurchasePriceCurrency", "type": "string" }, "ItAssetsAssetIdAddonsAddonIdAssignPostResponsesContentApplicationJsonSchemaDataActionsPurchaseRentalDetailsRemainingContractValue": { "description": "Estimated remaining value of the rental contract", "properties": { "amount": { "description": "Amount", "format": "decimal", "type": "string" }, "currency": { "$ref": "#/components/schemas/ItAssetsAssetIdAddonsAddonIdAssignPostResponsesContentApplicationJsonSchemaDataActionsPurchaseRentalDetailsRemainingContractValueCurrency", "description": "Three-letter currency code for the price" } }, "required": [ "amount", "currency" ], "title": "ItAssetsAssetIdAddonsAddonIdAssignPostResponsesContentApplicationJsonSchemaDataActionsPurchaseRentalDetailsRemainingContractValue", "type": "object" }, "ItAssetsAssetIdAddonsAddonIdAssignPostResponsesContentApplicationJsonSchemaDataActionsPurchaseRentalDetailsRemainingContractValueCurrency": { "description": "Three-letter currency code for the price", "enum": [ "AED", "AFN", "ALL", "AMD", "ANG", "AOA", "ARS", "AUD", "AWG", "AZN", "BAM", "BDT", "BGN", "BHD", "BIF", "BMD", "BOB", "BRL", "BSD", "BTN", "BWP", "BYN", "BZD", "CAD", "CDF", "CHF", "CLP", "CNY", "COP", "CRC", "CUC", "CVE", "CZK", "DJF", "DKK", "DOP", "DZD", "EGP", "ERN", "ETB", "EUR", "FJD", "FKP", "GBP", "GEL", "GHS", "GIP", "GMD", "GNF", "GTQ", "GYD", "HKD", "HNL", "HRK", "HTG", "HUF", "IDR", "ILS", "INR", "IQD", "IRR", "ISK", "JMD", "JOD", "JPY", "KES", "KGS", "KHR", "KMF", "KPW", "KRW", "KWD", "KYD", "KZT", "LAK", "LBP", "LKR", "LRD", "LSL", "LTL", "LYD", "MAD", "MDL", "MGA", "MKD", "MMK", "MNT", "MRU", "MUR", "MVR", "MWK", "MXN", "MYR", "MZN", "NAD", "NGN", "NIO", "NOK", "NPR", "NZD", "OMR", "PAB", "PEN", "PGK", "PHP", "PKR", "PLN", "PYG", "QAR", "RON", "RSD", "RUB", "RWF", "SAR", "SBD", "SCR", "SDG", "SEK", "SGD", "SHP", "SLL", "SOS", "SRD", "SSP", "STD", "SYP", "SZL", "THB", "TJS", "TMT", "TND", "TOP", "TRY", "TTD", "TWD", "TZS", "UAH", "UGX", "USD", "UYU", "UZS", "VEF", "VND", "VUV", "WST", "XAF", "XCD", "XOF", "XPF", "YER", "ZAR", "ZMW", "ZWD" ], "title": "ItAssetsAssetIdAddonsAddonIdAssignPostResponsesContentApplicationJsonSchemaDataActionsPurchaseRentalDetailsRemainingContractValueCurrency", "type": "string" }, "ItAssetsAssetIdAddonsAddonIdAssignPostResponsesContentApplicationJsonSchemaDataActionsPurchaseRentalDetailsTotalPurchasePrice": { "description": "Estimated total price of the purchase, including any remaining contract value", "properties": { "amount": { "description": "Amount", "format": "decimal", "type": "string" }, "currency": { "$ref": "#/components/schemas/ItAssetsAssetIdAddonsAddonIdAssignPostResponsesContentApplicationJsonSchemaDataActionsPurchaseRentalDetailsTotalPurchasePriceCurrency", "description": "Three-letter currency code for the price" } }, "required": [ "amount", "currency" ], "title": "ItAssetsAssetIdAddonsAddonIdAssignPostResponsesContentApplicationJsonSchemaDataActionsPurchaseRentalDetailsTotalPurchasePrice", "type": "object" }, "ItAssetsAssetIdAddonsAddonIdAssignPostResponsesContentApplicationJsonSchemaDataActionsPurchaseRentalDetailsTotalPurchasePriceCurrency": { "description": "Three-letter currency code for the price", "enum": [ "AED", "AFN", "ALL", "AMD", "ANG", "AOA", "ARS", "AUD", "AWG", "AZN", "BAM", "BDT", "BGN", "BHD", "BIF", "BMD", "BOB", "BRL", "BSD", "BTN", "BWP", "BYN", "BZD", "CAD", "CDF", "CHF", "CLP", "CNY", "COP", "CRC", "CUC", "CVE", "CZK", "DJF", "DKK", "DOP", "DZD", "EGP", "ERN", "ETB", "EUR", "FJD", "FKP", "GBP", "GEL", "GHS", "GIP", "GMD", "GNF", "GTQ", "GYD", "HKD", "HNL", "HRK", "HTG", "HUF", "IDR", "ILS", "INR", "IQD", "IRR", "ISK", "JMD", "JOD", "JPY", "KES", "KGS", "KHR", "KMF", "KPW", "KRW", "KWD", "KYD", "KZT", "LAK", "LBP", "LKR", "LRD", "LSL", "LTL", "LYD", "MAD", "MDL", "MGA", "MKD", "MMK", "MNT", "MRU", "MUR", "MVR", "MWK", "MXN", "MYR", "MZN", "NAD", "NGN", "NIO", "NOK", "NPR", "NZD", "OMR", "PAB", "PEN", "PGK", "PHP", "PKR", "PLN", "PYG", "QAR", "RON", "RSD", "RUB", "RWF", "SAR", "SBD", "SCR", "SDG", "SEK", "SGD", "SHP", "SLL", "SOS", "SRD", "SSP", "STD", "SYP", "SZL", "THB", "TJS", "TMT", "TND", "TOP", "TRY", "TTD", "TWD", "TZS", "UAH", "UGX", "USD", "UYU", "UZS", "VEF", "VND", "VUV", "WST", "XAF", "XCD", "XOF", "XPF", "YER", "ZAR", "ZMW", "ZWD" ], "title": "ItAssetsAssetIdAddonsAddonIdAssignPostResponsesContentApplicationJsonSchemaDataActionsPurchaseRentalDetailsTotalPurchasePriceCurrency", "type": "string" }, "ItAssetsAssetIdAddonsAddonIdAssignPostResponsesContentApplicationJsonSchemaDataActionsPurchaseRentalDisabledReasonsItems": { "enum": [ "ARCHIVED", "AT_DEEL_WAREHOUSE", "BEING_REPAIRED", "CONSUMABLE", "CONTROLLED_BY_DEEL", "COUNTRY_NOT_SUPPORTED_FOR_HUB", "COUNTRY_NOT_SUPPORTED_FOR_LOCAL", "DEEL_OWNED_ITEM_WITHOUT_RENTAL_CONTRACT", "DESKTOP_STORAGE", "ENDING_CONTRACT", "HUB_IN_SAME_REGION_AS_LOCAL", "INACTIVE", "INVALID_ITEM_LOCATION", "INVALID_ORGANIZATION_STATUS", "INVALID_STATE", "ITEM_CONDITIONS_TO_UNARCHIVE_NOT_MET", "ITEM_NOT_VISIBLE_FOR_ORGANIZATION", "NON_DEVICE", "NOT_AT_WAREHOUSE", "NOT_AVAILABLE_FOR_REUSE", "NOT_A_RENTAL", "NOT_MANAGEABLE_BY_ORGANIZATION", "NOT_WITH_ASSIGNMENT", "NOT_WITH_USER", "NO_ACTIVE_ADDONS", "NO_ACTIVE_STORAGE_CONTRACT", "NO_LOCATION_FOR_STORAGE", "NO_LOGISTICS_FOR_STORAGE", "NO_VALID_ADDONS", "ONGOING_SERVICE", "OWNED_BY_DEEL", "OWNED_BY_ORGANIZATION", "OWNED_BY_PARTNER_ORGANIZATION", "PARTNER_CHILD_CONTRACT", "PENDING_DEVICE_REFRESH", "RENTAL_CONTRACT_AND_USER_REGION_DO_NOT_MATCH", "TEMPORARILY_UNAVAILABLE", "UNKNOWN", "USER_HAS_NO_COUNTRY", "USER_HAS_NO_SEAT", "WAITING_FOR_CLEARANCE", "WITH_LOANER_ASSIGNMENT", "WITH_NON_COLLECTED_ASSIGNMENT", "WITH_NON_DELIVERED_ASSIGNMENT", "WITH_PENDING_ASSIGNMENT", "WRONG_ASSIGNMENT_STATUS", "WRONG_CONTRACT_STATUS", "WRONG_TERMS_AND_CONDITIONS" ], "title": "ItAssetsAssetIdAddonsAddonIdAssignPostResponsesContentApplicationJsonSchemaDataActionsPurchaseRentalDisabledReasonsItems", "type": "string" }, "ItAssetsAssetIdAddonsAddonIdAssignPostResponsesContentApplicationJsonSchemaDataActionsPurchaseRentalStatus": { "description": "Whether the action is currently available for this asset", "enum": [ "DISABLED", "ENABLED", "NOT_APPLICABLE" ], "title": "ItAssetsAssetIdAddonsAddonIdAssignPostResponsesContentApplicationJsonSchemaDataActionsPurchaseRentalStatus", "type": "string" }, "ItAssetsAssetIdAddonsAddonIdAssignPostResponsesContentApplicationJsonSchemaDataActionsReturnRentalToDeel": { "description": "Return a Deel-owned rental asset back to Deel", "properties": { "details": { "description": "Action-specific context needed to perform the action. Populated for enabled and\ndisabled actions (so callers can see what a successful attempt would look like);\nnull when the action is not applicable to this asset.", "oneOf": [ { "$ref": "#/components/schemas/ItAssetsAssetIdAddonsAddonIdAssignPostResponsesContentApplicationJsonSchemaDataActionsReturnRentalToDeelDetails" }, { "type": "null" } ] }, "disabled_reasons": { "description": "Reasons why the action is disabled. Empty when the action is enabled or not applicable", "items": { "$ref": "#/components/schemas/ItAssetsAssetIdAddonsAddonIdAssignPostResponsesContentApplicationJsonSchemaDataActionsReturnRentalToDeelDisabledReasonsItems" }, "type": "array" }, "status": { "$ref": "#/components/schemas/ItAssetsAssetIdAddonsAddonIdAssignPostResponsesContentApplicationJsonSchemaDataActionsReturnRentalToDeelStatus", "description": "Whether the action is currently available for this asset" } }, "required": [ "status", "details", "disabled_reasons" ], "title": "ItAssetsAssetIdAddonsAddonIdAssignPostResponsesContentApplicationJsonSchemaDataActionsReturnRentalToDeel", "type": "object" }, "ItAssetsAssetIdAddonsAddonIdAssignPostResponsesContentApplicationJsonSchemaDataActionsReturnRentalToDeelDetails": { "description": "Action-specific context needed to perform the action. Populated for enabled and\ndisabled actions (so callers can see what a successful attempt would look like);\nnull when the action is not applicable to this asset.", "properties": { "end_contract_price": { "$ref": "#/components/schemas/ItAssetsAssetIdAddonsAddonIdAssignPostResponsesContentApplicationJsonSchemaDataActionsReturnRentalToDeelDetailsEndContractPrice", "description": "Estimated end-of-contract price charged when returning the asset" } }, "required": [ "end_contract_price" ], "title": "ItAssetsAssetIdAddonsAddonIdAssignPostResponsesContentApplicationJsonSchemaDataActionsReturnRentalToDeelDetails", "type": "object" }, "ItAssetsAssetIdAddonsAddonIdAssignPostResponsesContentApplicationJsonSchemaDataActionsReturnRentalToDeelDetailsEndContractPrice": { "description": "Estimated end-of-contract price charged when returning the asset", "properties": { "amount": { "description": "Amount", "format": "decimal", "type": "string" }, "currency": { "$ref": "#/components/schemas/ItAssetsAssetIdAddonsAddonIdAssignPostResponsesContentApplicationJsonSchemaDataActionsReturnRentalToDeelDetailsEndContractPriceCurrency", "description": "Three-letter currency code for the price" } }, "required": [ "amount", "currency" ], "title": "ItAssetsAssetIdAddonsAddonIdAssignPostResponsesContentApplicationJsonSchemaDataActionsReturnRentalToDeelDetailsEndContractPrice", "type": "object" }, "ItAssetsAssetIdAddonsAddonIdAssignPostResponsesContentApplicationJsonSchemaDataActionsReturnRentalToDeelDetailsEndContractPriceCurrency": { "description": "Three-letter currency code for the price", "enum": [ "AED", "AFN", "ALL", "AMD", "ANG", "AOA", "ARS", "AUD", "AWG", "AZN", "BAM", "BDT", "BGN", "BHD", "BIF", "BMD", "BOB", "BRL", "BSD", "BTN", "BWP", "BYN", "BZD", "CAD", "CDF", "CHF", "CLP", "CNY", "COP", "CRC", "CUC", "CVE", "CZK", "DJF", "DKK", "DOP", "DZD", "EGP", "ERN", "ETB", "EUR", "FJD", "FKP", "GBP", "GEL", "GHS", "GIP", "GMD", "GNF", "GTQ", "GYD", "HKD", "HNL", "HRK", "HTG", "HUF", "IDR", "ILS", "INR", "IQD", "IRR", "ISK", "JMD", "JOD", "JPY", "KES", "KGS", "KHR", "KMF", "KPW", "KRW", "KWD", "KYD", "KZT", "LAK", "LBP", "LKR", "LRD", "LSL", "LTL", "LYD", "MAD", "MDL", "MGA", "MKD", "MMK", "MNT", "MRU", "MUR", "MVR", "MWK", "MXN", "MYR", "MZN", "NAD", "NGN", "NIO", "NOK", "NPR", "NZD", "OMR", "PAB", "PEN", "PGK", "PHP", "PKR", "PLN", "PYG", "QAR", "RON", "RSD", "RUB", "RWF", "SAR", "SBD", "SCR", "SDG", "SEK", "SGD", "SHP", "SLL", "SOS", "SRD", "SSP", "STD", "SYP", "SZL", "THB", "TJS", "TMT", "TND", "TOP", "TRY", "TTD", "TWD", "TZS", "UAH", "UGX", "USD", "UYU", "UZS", "VEF", "VND", "VUV", "WST", "XAF", "XCD", "XOF", "XPF", "YER", "ZAR", "ZMW", "ZWD" ], "title": "ItAssetsAssetIdAddonsAddonIdAssignPostResponsesContentApplicationJsonSchemaDataActionsReturnRentalToDeelDetailsEndContractPriceCurrency", "type": "string" }, "ItAssetsAssetIdAddonsAddonIdAssignPostResponsesContentApplicationJsonSchemaDataActionsReturnRentalToDeelDisabledReasonsItems": { "enum": [ "ARCHIVED", "AT_DEEL_WAREHOUSE", "BEING_REPAIRED", "CONSUMABLE", "CONTROLLED_BY_DEEL", "COUNTRY_NOT_SUPPORTED_FOR_HUB", "COUNTRY_NOT_SUPPORTED_FOR_LOCAL", "DEEL_OWNED_ITEM_WITHOUT_RENTAL_CONTRACT", "DESKTOP_STORAGE", "ENDING_CONTRACT", "HUB_IN_SAME_REGION_AS_LOCAL", "INACTIVE", "INVALID_ITEM_LOCATION", "INVALID_ORGANIZATION_STATUS", "INVALID_STATE", "ITEM_CONDITIONS_TO_UNARCHIVE_NOT_MET", "ITEM_NOT_VISIBLE_FOR_ORGANIZATION", "NON_DEVICE", "NOT_AT_WAREHOUSE", "NOT_AVAILABLE_FOR_REUSE", "NOT_A_RENTAL", "NOT_MANAGEABLE_BY_ORGANIZATION", "NOT_WITH_ASSIGNMENT", "NOT_WITH_USER", "NO_ACTIVE_ADDONS", "NO_ACTIVE_STORAGE_CONTRACT", "NO_LOCATION_FOR_STORAGE", "NO_LOGISTICS_FOR_STORAGE", "NO_VALID_ADDONS", "ONGOING_SERVICE", "OWNED_BY_DEEL", "OWNED_BY_ORGANIZATION", "OWNED_BY_PARTNER_ORGANIZATION", "PARTNER_CHILD_CONTRACT", "PENDING_DEVICE_REFRESH", "RENTAL_CONTRACT_AND_USER_REGION_DO_NOT_MATCH", "TEMPORARILY_UNAVAILABLE", "UNKNOWN", "USER_HAS_NO_COUNTRY", "USER_HAS_NO_SEAT", "WAITING_FOR_CLEARANCE", "WITH_LOANER_ASSIGNMENT", "WITH_NON_COLLECTED_ASSIGNMENT", "WITH_NON_DELIVERED_ASSIGNMENT", "WITH_PENDING_ASSIGNMENT", "WRONG_ASSIGNMENT_STATUS", "WRONG_CONTRACT_STATUS", "WRONG_TERMS_AND_CONDITIONS" ], "title": "ItAssetsAssetIdAddonsAddonIdAssignPostResponsesContentApplicationJsonSchemaDataActionsReturnRentalToDeelDisabledReasonsItems", "type": "string" }, "ItAssetsAssetIdAddonsAddonIdAssignPostResponsesContentApplicationJsonSchemaDataActionsReturnRentalToDeelStatus": { "description": "Whether the action is currently available for this asset", "enum": [ "DISABLED", "ENABLED", "NOT_APPLICABLE" ], "title": "ItAssetsAssetIdAddonsAddonIdAssignPostResponsesContentApplicationJsonSchemaDataActionsReturnRentalToDeelStatus", "type": "string" }, "ItAssetsAssetIdAddonsAddonIdAssignPostResponsesContentApplicationJsonSchemaDataActionsReuseOwnAssetFromDeel": { "description": "Redeploy an organization-owned asset stored at a Deel warehouse", "properties": { "details": { "description": "Action-specific context needed to perform the action. Populated for enabled and\ndisabled actions (so callers can see what a successful attempt would look like);\nnull when the action is not applicable to this asset.", "oneOf": [ { "$ref": "#/components/schemas/ItAssetsAssetIdAddonsAddonIdAssignPostResponsesContentApplicationJsonSchemaDataActionsReuseOwnAssetFromDeelDetails" }, { "type": "null" } ] }, "disabled_reasons": { "description": "Reasons why the action is disabled. Empty when the action is enabled or not applicable", "items": { "$ref": "#/components/schemas/ItAssetsAssetIdAddonsAddonIdAssignPostResponsesContentApplicationJsonSchemaDataActionsReuseOwnAssetFromDeelDisabledReasonsItems" }, "type": "array" }, "status": { "$ref": "#/components/schemas/ItAssetsAssetIdAddonsAddonIdAssignPostResponsesContentApplicationJsonSchemaDataActionsReuseOwnAssetFromDeelStatus", "description": "Whether the action is currently available for this asset" } }, "required": [ "status", "details", "disabled_reasons" ], "title": "ItAssetsAssetIdAddonsAddonIdAssignPostResponsesContentApplicationJsonSchemaDataActionsReuseOwnAssetFromDeel", "type": "object" }, "ItAssetsAssetIdAddonsAddonIdAssignPostResponsesContentApplicationJsonSchemaDataActionsReuseOwnAssetFromDeelDetails": { "description": "Action-specific context needed to perform the action. Populated for enabled and\ndisabled actions (so callers can see what a successful attempt would look like);\nnull when the action is not applicable to this asset.", "properties": { "eligible_countries": { "description": "Countries where the asset can be redeployed from Deel", "items": { "$ref": "#/components/schemas/ItAssetsAssetIdAddonsAddonIdAssignPostResponsesContentApplicationJsonSchemaDataActionsReuseOwnAssetFromDeelDetailsEligibleCountriesItems" }, "type": "array" }, "express_delivery": { "description": "Express delivery availability and per-country fees. Null when express delivery is not supported", "oneOf": [ { "$ref": "#/components/schemas/ItAssetsAssetIdAddonsAddonIdAssignPostResponsesContentApplicationJsonSchemaDataActionsReuseOwnAssetFromDeelDetailsExpressDelivery" }, { "type": "null" } ] } }, "required": [ "express_delivery", "eligible_countries" ], "title": "ItAssetsAssetIdAddonsAddonIdAssignPostResponsesContentApplicationJsonSchemaDataActionsReuseOwnAssetFromDeelDetails", "type": "object" }, "ItAssetsAssetIdAddonsAddonIdAssignPostResponsesContentApplicationJsonSchemaDataActionsReuseOwnAssetFromDeelDetailsEligibleCountriesItems": { "enum": [ "AD", "AE", "AF", "AG", "AI", "AL", "AM", "AN", "AO", "AQ", "AR", "AS", "AT", "AU", "AW", "AX", "AZ", "BA", "BB", "BD", "BE", "BF", "BG", "BH", "BI", "BJ", "BL", "BM", "BN", "BO", "BQ", "BR", "BS", "BT", "BV", "BW", "BY", "BZ", "CA", "CC", "CD", "CF", "CG", "CH", "CI", "CK", "CL", "CM", "CN", "CO", "CR", "CU", "CV", "CW", "CX", "CY", "CZ", "DE", "DJ", "DK", "DM", "DO", "DZ", "EC", "EE", "EG", "EH", "ER", "ES", "ET", "FI", "FJ", "FK", "FM", "FO", "FR", "GA", "GB", "GD", "GE", "GF", "GG", "GH", "GI", "GL", "GM", "GN", "GP", "GQ", "GR", "GS", "GT", "GU", "GW", "GY", "HK", "HM", "HN", "HR", "HT", "HU", "IC", "ID", "IE", "IL", "IM", "IN", "IO", "IQ", "IR", "IS", "IT", "JE", "JM", "JO", "JP", "KE", "KG", "KH", "KI", "KM", "KN", "KP", "KR", "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", "XK", "YE", "YT", "ZA", "ZM", "ZW" ], "title": "ItAssetsAssetIdAddonsAddonIdAssignPostResponsesContentApplicationJsonSchemaDataActionsReuseOwnAssetFromDeelDetailsEligibleCountriesItems", "type": "string" }, "ItAssetsAssetIdAddonsAddonIdAssignPostResponsesContentApplicationJsonSchemaDataActionsReuseOwnAssetFromDeelDetailsExpressDelivery": { "description": "Express delivery availability and per-country fees. Null when express delivery is not supported", "properties": { "country_fees": { "additionalProperties": { "$ref": "#/components/schemas/ItAssetsAssetIdAddonsAddonIdAssignPostResponsesContentApplicationJsonSchemaDataActionsReuseOwnAssetFromDeelDetailsExpressDeliveryCountryFees" }, "description": "Express delivery fees keyed by destination country.", "type": "object" } }, "required": [ "country_fees" ], "title": "ItAssetsAssetIdAddonsAddonIdAssignPostResponsesContentApplicationJsonSchemaDataActionsReuseOwnAssetFromDeelDetailsExpressDelivery", "type": "object" }, "ItAssetsAssetIdAddonsAddonIdAssignPostResponsesContentApplicationJsonSchemaDataActionsReuseOwnAssetFromDeelDetailsExpressDeliveryCountryFees": { "properties": { "amount": { "description": "Amount", "format": "decimal", "type": "string" }, "currency": { "$ref": "#/components/schemas/ItAssetsAssetIdAddonsAddonIdAssignPostResponsesContentApplicationJsonSchemaDataActionsReuseOwnAssetFromDeelDetailsExpressDeliveryCountryFeesCurrency", "description": "Three-letter currency code for the price" } }, "required": [ "amount", "currency" ], "title": "ItAssetsAssetIdAddonsAddonIdAssignPostResponsesContentApplicationJsonSchemaDataActionsReuseOwnAssetFromDeelDetailsExpressDeliveryCountryFees", "type": "object" }, "ItAssetsAssetIdAddonsAddonIdAssignPostResponsesContentApplicationJsonSchemaDataActionsReuseOwnAssetFromDeelDetailsExpressDeliveryCountryFeesCurrency": { "description": "Three-letter currency code for the price", "enum": [ "AED", "AFN", "ALL", "AMD", "ANG", "AOA", "ARS", "AUD", "AWG", "AZN", "BAM", "BDT", "BGN", "BHD", "BIF", "BMD", "BOB", "BRL", "BSD", "BTN", "BWP", "BYN", "BZD", "CAD", "CDF", "CHF", "CLP", "CNY", "COP", "CRC", "CUC", "CVE", "CZK", "DJF", "DKK", "DOP", "DZD", "EGP", "ERN", "ETB", "EUR", "FJD", "FKP", "GBP", "GEL", "GHS", "GIP", "GMD", "GNF", "GTQ", "GYD", "HKD", "HNL", "HRK", "HTG", "HUF", "IDR", "ILS", "INR", "IQD", "IRR", "ISK", "JMD", "JOD", "JPY", "KES", "KGS", "KHR", "KMF", "KPW", "KRW", "KWD", "KYD", "KZT", "LAK", "LBP", "LKR", "LRD", "LSL", "LTL", "LYD", "MAD", "MDL", "MGA", "MKD", "MMK", "MNT", "MRU", "MUR", "MVR", "MWK", "MXN", "MYR", "MZN", "NAD", "NGN", "NIO", "NOK", "NPR", "NZD", "OMR", "PAB", "PEN", "PGK", "PHP", "PKR", "PLN", "PYG", "QAR", "RON", "RSD", "RUB", "RWF", "SAR", "SBD", "SCR", "SDG", "SEK", "SGD", "SHP", "SLL", "SOS", "SRD", "SSP", "STD", "SYP", "SZL", "THB", "TJS", "TMT", "TND", "TOP", "TRY", "TTD", "TWD", "TZS", "UAH", "UGX", "USD", "UYU", "UZS", "VEF", "VND", "VUV", "WST", "XAF", "XCD", "XOF", "XPF", "YER", "ZAR", "ZMW", "ZWD" ], "title": "ItAssetsAssetIdAddonsAddonIdAssignPostResponsesContentApplicationJsonSchemaDataActionsReuseOwnAssetFromDeelDetailsExpressDeliveryCountryFeesCurrency", "type": "string" }, "ItAssetsAssetIdAddonsAddonIdAssignPostResponsesContentApplicationJsonSchemaDataActionsReuseOwnAssetFromDeelDisabledReasonsItems": { "enum": [ "ARCHIVED", "AT_DEEL_WAREHOUSE", "BEING_REPAIRED", "CONSUMABLE", "CONTROLLED_BY_DEEL", "COUNTRY_NOT_SUPPORTED_FOR_HUB", "COUNTRY_NOT_SUPPORTED_FOR_LOCAL", "DEEL_OWNED_ITEM_WITHOUT_RENTAL_CONTRACT", "DESKTOP_STORAGE", "ENDING_CONTRACT", "HUB_IN_SAME_REGION_AS_LOCAL", "INACTIVE", "INVALID_ITEM_LOCATION", "INVALID_ORGANIZATION_STATUS", "INVALID_STATE", "ITEM_CONDITIONS_TO_UNARCHIVE_NOT_MET", "ITEM_NOT_VISIBLE_FOR_ORGANIZATION", "NON_DEVICE", "NOT_AT_WAREHOUSE", "NOT_AVAILABLE_FOR_REUSE", "NOT_A_RENTAL", "NOT_MANAGEABLE_BY_ORGANIZATION", "NOT_WITH_ASSIGNMENT", "NOT_WITH_USER", "NO_ACTIVE_ADDONS", "NO_ACTIVE_STORAGE_CONTRACT", "NO_LOCATION_FOR_STORAGE", "NO_LOGISTICS_FOR_STORAGE", "NO_VALID_ADDONS", "ONGOING_SERVICE", "OWNED_BY_DEEL", "OWNED_BY_ORGANIZATION", "OWNED_BY_PARTNER_ORGANIZATION", "PARTNER_CHILD_CONTRACT", "PENDING_DEVICE_REFRESH", "RENTAL_CONTRACT_AND_USER_REGION_DO_NOT_MATCH", "TEMPORARILY_UNAVAILABLE", "UNKNOWN", "USER_HAS_NO_COUNTRY", "USER_HAS_NO_SEAT", "WAITING_FOR_CLEARANCE", "WITH_LOANER_ASSIGNMENT", "WITH_NON_COLLECTED_ASSIGNMENT", "WITH_NON_DELIVERED_ASSIGNMENT", "WITH_PENDING_ASSIGNMENT", "WRONG_ASSIGNMENT_STATUS", "WRONG_CONTRACT_STATUS", "WRONG_TERMS_AND_CONDITIONS" ], "title": "ItAssetsAssetIdAddonsAddonIdAssignPostResponsesContentApplicationJsonSchemaDataActionsReuseOwnAssetFromDeelDisabledReasonsItems", "type": "string" }, "ItAssetsAssetIdAddonsAddonIdAssignPostResponsesContentApplicationJsonSchemaDataActionsReuseOwnAssetFromDeelStatus": { "description": "Whether the action is currently available for this asset", "enum": [ "DISABLED", "ENABLED", "NOT_APPLICABLE" ], "title": "ItAssetsAssetIdAddonsAddonIdAssignPostResponsesContentApplicationJsonSchemaDataActionsReuseOwnAssetFromDeelStatus", "type": "string" }, "ItAssetsAssetIdAddonsAddonIdAssignPostResponsesContentApplicationJsonSchemaDataActionsReuseOwnAssetFromOwnLocation": { "description": "Redeploy an organization-owned asset from an organization-owned location", "properties": { "details": { "description": "Action-specific context needed to perform the action. Populated for enabled and\ndisabled actions (so callers can see what a successful attempt would look like);\nnull when the action is not applicable to this asset.", "oneOf": [ { "$ref": "#/components/schemas/ItAssetsAssetIdAddonsAddonIdAssignPostResponsesContentApplicationJsonSchemaDataActionsReuseOwnAssetFromOwnLocationDetails" }, { "type": "null" } ] }, "disabled_reasons": { "description": "Reasons why the action is disabled. Empty when the action is enabled or not applicable", "items": { "$ref": "#/components/schemas/ItAssetsAssetIdAddonsAddonIdAssignPostResponsesContentApplicationJsonSchemaDataActionsReuseOwnAssetFromOwnLocationDisabledReasonsItems" }, "type": "array" }, "status": { "$ref": "#/components/schemas/ItAssetsAssetIdAddonsAddonIdAssignPostResponsesContentApplicationJsonSchemaDataActionsReuseOwnAssetFromOwnLocationStatus", "description": "Whether the action is currently available for this asset" } }, "required": [ "status", "details", "disabled_reasons" ], "title": "ItAssetsAssetIdAddonsAddonIdAssignPostResponsesContentApplicationJsonSchemaDataActionsReuseOwnAssetFromOwnLocation", "type": "object" }, "ItAssetsAssetIdAddonsAddonIdAssignPostResponsesContentApplicationJsonSchemaDataActionsReuseOwnAssetFromOwnLocationDetails": { "description": "Action-specific context needed to perform the action. Populated for enabled and\ndisabled actions (so callers can see what a successful attempt would look like);\nnull when the action is not applicable to this asset.", "properties": { "eligible_countries": { "description": "Countries where the asset can be redeployed from an organization-owned location", "items": { "$ref": "#/components/schemas/ItAssetsAssetIdAddonsAddonIdAssignPostResponsesContentApplicationJsonSchemaDataActionsReuseOwnAssetFromOwnLocationDetailsEligibleCountriesItems" }, "type": "array" }, "express_delivery": { "description": "Express delivery availability and per-country fees. Null when express delivery is not supported", "oneOf": [ { "$ref": "#/components/schemas/ItAssetsAssetIdAddonsAddonIdAssignPostResponsesContentApplicationJsonSchemaDataActionsReuseOwnAssetFromOwnLocationDetailsExpressDelivery" }, { "type": "null" } ] }, "service_cost": { "$ref": "#/components/schemas/ItAssetsAssetIdAddonsAddonIdAssignPostResponsesContentApplicationJsonSchemaDataActionsReuseOwnAssetFromOwnLocationDetailsServiceCost", "description": "Cost charged for the transfer service" } }, "required": [ "service_cost", "express_delivery", "eligible_countries" ], "title": "ItAssetsAssetIdAddonsAddonIdAssignPostResponsesContentApplicationJsonSchemaDataActionsReuseOwnAssetFromOwnLocationDetails", "type": "object" }, "ItAssetsAssetIdAddonsAddonIdAssignPostResponsesContentApplicationJsonSchemaDataActionsReuseOwnAssetFromOwnLocationDetailsEligibleCountriesItems": { "enum": [ "AD", "AE", "AF", "AG", "AI", "AL", "AM", "AN", "AO", "AQ", "AR", "AS", "AT", "AU", "AW", "AX", "AZ", "BA", "BB", "BD", "BE", "BF", "BG", "BH", "BI", "BJ", "BL", "BM", "BN", "BO", "BQ", "BR", "BS", "BT", "BV", "BW", "BY", "BZ", "CA", "CC", "CD", "CF", "CG", "CH", "CI", "CK", "CL", "CM", "CN", "CO", "CR", "CU", "CV", "CW", "CX", "CY", "CZ", "DE", "DJ", "DK", "DM", "DO", "DZ", "EC", "EE", "EG", "EH", "ER", "ES", "ET", "FI", "FJ", "FK", "FM", "FO", "FR", "GA", "GB", "GD", "GE", "GF", "GG", "GH", "GI", "GL", "GM", "GN", "GP", "GQ", "GR", "GS", "GT", "GU", "GW", "GY", "HK", "HM", "HN", "HR", "HT", "HU", "IC", "ID", "IE", "IL", "IM", "IN", "IO", "IQ", "IR", "IS", "IT", "JE", "JM", "JO", "JP", "KE", "KG", "KH", "KI", "KM", "KN", "KP", "KR", "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", "XK", "YE", "YT", "ZA", "ZM", "ZW" ], "title": "ItAssetsAssetIdAddonsAddonIdAssignPostResponsesContentApplicationJsonSchemaDataActionsReuseOwnAssetFromOwnLocationDetailsEligibleCountriesItems", "type": "string" }, "ItAssetsAssetIdAddonsAddonIdAssignPostResponsesContentApplicationJsonSchemaDataActionsReuseOwnAssetFromOwnLocationDetailsExpressDelivery": { "description": "Express delivery availability and per-country fees. Null when express delivery is not supported", "properties": { "country_fees": { "additionalProperties": { "$ref": "#/components/schemas/ItAssetsAssetIdAddonsAddonIdAssignPostResponsesContentApplicationJsonSchemaDataActionsReuseOwnAssetFromOwnLocationDetailsExpressDeliveryCountryFees" }, "description": "Express delivery fees keyed by destination country.", "type": "object" } }, "required": [ "country_fees" ], "title": "ItAssetsAssetIdAddonsAddonIdAssignPostResponsesContentApplicationJsonSchemaDataActionsReuseOwnAssetFromOwnLocationDetailsExpressDelivery", "type": "object" }, "ItAssetsAssetIdAddonsAddonIdAssignPostResponsesContentApplicationJsonSchemaDataActionsReuseOwnAssetFromOwnLocationDetailsExpressDeliveryCountryFees": { "properties": { "amount": { "description": "Amount", "format": "decimal", "type": "string" }, "currency": { "$ref": "#/components/schemas/ItAssetsAssetIdAddonsAddonIdAssignPostResponsesContentApplicationJsonSchemaDataActionsReuseOwnAssetFromOwnLocationDetailsExpressDeliveryCountryFeesCurrency", "description": "Three-letter currency code for the price" } }, "required": [ "amount", "currency" ], "title": "ItAssetsAssetIdAddonsAddonIdAssignPostResponsesContentApplicationJsonSchemaDataActionsReuseOwnAssetFromOwnLocationDetailsExpressDeliveryCountryFees", "type": "object" }, "ItAssetsAssetIdAddonsAddonIdAssignPostResponsesContentApplicationJsonSchemaDataActionsReuseOwnAssetFromOwnLocationDetailsExpressDeliveryCountryFeesCurrency": { "description": "Three-letter currency code for the price", "enum": [ "AED", "AFN", "ALL", "AMD", "ANG", "AOA", "ARS", "AUD", "AWG", "AZN", "BAM", "BDT", "BGN", "BHD", "BIF", "BMD", "BOB", "BRL", "BSD", "BTN", "BWP", "BYN", "BZD", "CAD", "CDF", "CHF", "CLP", "CNY", "COP", "CRC", "CUC", "CVE", "CZK", "DJF", "DKK", "DOP", "DZD", "EGP", "ERN", "ETB", "EUR", "FJD", "FKP", "GBP", "GEL", "GHS", "GIP", "GMD", "GNF", "GTQ", "GYD", "HKD", "HNL", "HRK", "HTG", "HUF", "IDR", "ILS", "INR", "IQD", "IRR", "ISK", "JMD", "JOD", "JPY", "KES", "KGS", "KHR", "KMF", "KPW", "KRW", "KWD", "KYD", "KZT", "LAK", "LBP", "LKR", "LRD", "LSL", "LTL", "LYD", "MAD", "MDL", "MGA", "MKD", "MMK", "MNT", "MRU", "MUR", "MVR", "MWK", "MXN", "MYR", "MZN", "NAD", "NGN", "NIO", "NOK", "NPR", "NZD", "OMR", "PAB", "PEN", "PGK", "PHP", "PKR", "PLN", "PYG", "QAR", "RON", "RSD", "RUB", "RWF", "SAR", "SBD", "SCR", "SDG", "SEK", "SGD", "SHP", "SLL", "SOS", "SRD", "SSP", "STD", "SYP", "SZL", "THB", "TJS", "TMT", "TND", "TOP", "TRY", "TTD", "TWD", "TZS", "UAH", "UGX", "USD", "UYU", "UZS", "VEF", "VND", "VUV", "WST", "XAF", "XCD", "XOF", "XPF", "YER", "ZAR", "ZMW", "ZWD" ], "title": "ItAssetsAssetIdAddonsAddonIdAssignPostResponsesContentApplicationJsonSchemaDataActionsReuseOwnAssetFromOwnLocationDetailsExpressDeliveryCountryFeesCurrency", "type": "string" }, "ItAssetsAssetIdAddonsAddonIdAssignPostResponsesContentApplicationJsonSchemaDataActionsReuseOwnAssetFromOwnLocationDetailsServiceCost": { "description": "Cost charged for the transfer service", "properties": { "billing_method": { "$ref": "#/components/schemas/ItAssetsAssetIdAddonsAddonIdAssignPostResponsesContentApplicationJsonSchemaDataActionsReuseOwnAssetFromOwnLocationDetailsServiceCostBillingMethod", "description": "How the action is charged. When \"TOKEN\", the fees are covered by an\nadd-on token pool; when \"CURRENCY\", the fees are billed in the currency\nspecified in the \"fees\" field." }, "fees": { "description": "Price charged for the action. Null when billing method is \"TOKEN\"", "oneOf": [ { "$ref": "#/components/schemas/ItAssetsAssetIdAddonsAddonIdAssignPostResponsesContentApplicationJsonSchemaDataActionsReuseOwnAssetFromOwnLocationDetailsServiceCostFees" }, { "type": "null" } ] }, "token_usage": { "description": "Add-on token consumption details. Null when billing method is \"CURRENCY\"", "oneOf": [ { "$ref": "#/components/schemas/ItAssetsAssetIdAddonsAddonIdAssignPostResponsesContentApplicationJsonSchemaDataActionsReuseOwnAssetFromOwnLocationDetailsServiceCostTokenUsage" }, { "type": "null" } ] } }, "required": [ "fees", "token_usage", "billing_method" ], "title": "ItAssetsAssetIdAddonsAddonIdAssignPostResponsesContentApplicationJsonSchemaDataActionsReuseOwnAssetFromOwnLocationDetailsServiceCost", "type": "object" }, "ItAssetsAssetIdAddonsAddonIdAssignPostResponsesContentApplicationJsonSchemaDataActionsReuseOwnAssetFromOwnLocationDetailsServiceCostBillingMethod": { "description": "How the action is charged. When \"TOKEN\", the fees are covered by an\nadd-on token pool; when \"CURRENCY\", the fees are billed in the currency\nspecified in the \"fees\" field.", "enum": [ "CURRENCY", "TOKEN" ], "title": "ItAssetsAssetIdAddonsAddonIdAssignPostResponsesContentApplicationJsonSchemaDataActionsReuseOwnAssetFromOwnLocationDetailsServiceCostBillingMethod", "type": "string" }, "ItAssetsAssetIdAddonsAddonIdAssignPostResponsesContentApplicationJsonSchemaDataActionsReuseOwnAssetFromOwnLocationDetailsServiceCostFees": { "description": "Price charged for the action. Null when billing method is \"TOKEN\"", "properties": { "amount": { "description": "Amount", "format": "decimal", "type": "string" }, "currency": { "$ref": "#/components/schemas/ItAssetsAssetIdAddonsAddonIdAssignPostResponsesContentApplicationJsonSchemaDataActionsReuseOwnAssetFromOwnLocationDetailsServiceCostFeesCurrency", "description": "Three-letter currency code for the price" } }, "required": [ "amount", "currency" ], "title": "ItAssetsAssetIdAddonsAddonIdAssignPostResponsesContentApplicationJsonSchemaDataActionsReuseOwnAssetFromOwnLocationDetailsServiceCostFees", "type": "object" }, "ItAssetsAssetIdAddonsAddonIdAssignPostResponsesContentApplicationJsonSchemaDataActionsReuseOwnAssetFromOwnLocationDetailsServiceCostFeesCurrency": { "description": "Three-letter currency code for the price", "enum": [ "AED", "AFN", "ALL", "AMD", "ANG", "AOA", "ARS", "AUD", "AWG", "AZN", "BAM", "BDT", "BGN", "BHD", "BIF", "BMD", "BOB", "BRL", "BSD", "BTN", "BWP", "BYN", "BZD", "CAD", "CDF", "CHF", "CLP", "CNY", "COP", "CRC", "CUC", "CVE", "CZK", "DJF", "DKK", "DOP", "DZD", "EGP", "ERN", "ETB", "EUR", "FJD", "FKP", "GBP", "GEL", "GHS", "GIP", "GMD", "GNF", "GTQ", "GYD", "HKD", "HNL", "HRK", "HTG", "HUF", "IDR", "ILS", "INR", "IQD", "IRR", "ISK", "JMD", "JOD", "JPY", "KES", "KGS", "KHR", "KMF", "KPW", "KRW", "KWD", "KYD", "KZT", "LAK", "LBP", "LKR", "LRD", "LSL", "LTL", "LYD", "MAD", "MDL", "MGA", "MKD", "MMK", "MNT", "MRU", "MUR", "MVR", "MWK", "MXN", "MYR", "MZN", "NAD", "NGN", "NIO", "NOK", "NPR", "NZD", "OMR", "PAB", "PEN", "PGK", "PHP", "PKR", "PLN", "PYG", "QAR", "RON", "RSD", "RUB", "RWF", "SAR", "SBD", "SCR", "SDG", "SEK", "SGD", "SHP", "SLL", "SOS", "SRD", "SSP", "STD", "SYP", "SZL", "THB", "TJS", "TMT", "TND", "TOP", "TRY", "TTD", "TWD", "TZS", "UAH", "UGX", "USD", "UYU", "UZS", "VEF", "VND", "VUV", "WST", "XAF", "XCD", "XOF", "XPF", "YER", "ZAR", "ZMW", "ZWD" ], "title": "ItAssetsAssetIdAddonsAddonIdAssignPostResponsesContentApplicationJsonSchemaDataActionsReuseOwnAssetFromOwnLocationDetailsServiceCostFeesCurrency", "type": "string" }, "ItAssetsAssetIdAddonsAddonIdAssignPostResponsesContentApplicationJsonSchemaDataActionsReuseOwnAssetFromOwnLocationDetailsServiceCostTokenUsage": { "description": "Add-on token consumption details. Null when billing method is \"CURRENCY\"", "properties": { "addon": { "$ref": "#/components/schemas/ItAssetsAssetIdAddonsAddonIdAssignPostResponsesContentApplicationJsonSchemaDataActionsReuseOwnAssetFromOwnLocationDetailsServiceCostTokenUsageAddon", "description": "The add-on that provides the tokens" }, "cost": { "description": "Number of tokens consumed by the action. Zero when the add-on covers the\nservice without drawing from a token pool", "format": "decimal", "type": "string" }, "tokens_left": { "description": "Number of tokens left in the pool after the action is performed. Null when\nthe add-on covers the service without a token pool", "format": "decimal", "type": [ "string", "null" ] } }, "required": [ "cost", "addon", "tokens_left" ], "title": "ItAssetsAssetIdAddonsAddonIdAssignPostResponsesContentApplicationJsonSchemaDataActionsReuseOwnAssetFromOwnLocationDetailsServiceCostTokenUsage", "type": "object" }, "ItAssetsAssetIdAddonsAddonIdAssignPostResponsesContentApplicationJsonSchemaDataActionsReuseOwnAssetFromOwnLocationDetailsServiceCostTokenUsageAddon": { "description": "The add-on that provides the tokens", "properties": { "id": { "description": "ID of the add-on", "format": "uuid", "type": "string" }, "name": { "description": "Public display name of the add-on", "type": "string" } }, "required": [ "id", "name" ], "title": "ItAssetsAssetIdAddonsAddonIdAssignPostResponsesContentApplicationJsonSchemaDataActionsReuseOwnAssetFromOwnLocationDetailsServiceCostTokenUsageAddon", "type": "object" }, "ItAssetsAssetIdAddonsAddonIdAssignPostResponsesContentApplicationJsonSchemaDataActionsReuseOwnAssetFromOwnLocationDisabledReasonsItems": { "enum": [ "ARCHIVED", "AT_DEEL_WAREHOUSE", "BEING_REPAIRED", "CONSUMABLE", "CONTROLLED_BY_DEEL", "COUNTRY_NOT_SUPPORTED_FOR_HUB", "COUNTRY_NOT_SUPPORTED_FOR_LOCAL", "DEEL_OWNED_ITEM_WITHOUT_RENTAL_CONTRACT", "DESKTOP_STORAGE", "ENDING_CONTRACT", "HUB_IN_SAME_REGION_AS_LOCAL", "INACTIVE", "INVALID_ITEM_LOCATION", "INVALID_ORGANIZATION_STATUS", "INVALID_STATE", "ITEM_CONDITIONS_TO_UNARCHIVE_NOT_MET", "ITEM_NOT_VISIBLE_FOR_ORGANIZATION", "NON_DEVICE", "NOT_AT_WAREHOUSE", "NOT_AVAILABLE_FOR_REUSE", "NOT_A_RENTAL", "NOT_MANAGEABLE_BY_ORGANIZATION", "NOT_WITH_ASSIGNMENT", "NOT_WITH_USER", "NO_ACTIVE_ADDONS", "NO_ACTIVE_STORAGE_CONTRACT", "NO_LOCATION_FOR_STORAGE", "NO_LOGISTICS_FOR_STORAGE", "NO_VALID_ADDONS", "ONGOING_SERVICE", "OWNED_BY_DEEL", "OWNED_BY_ORGANIZATION", "OWNED_BY_PARTNER_ORGANIZATION", "PARTNER_CHILD_CONTRACT", "PENDING_DEVICE_REFRESH", "RENTAL_CONTRACT_AND_USER_REGION_DO_NOT_MATCH", "TEMPORARILY_UNAVAILABLE", "UNKNOWN", "USER_HAS_NO_COUNTRY", "USER_HAS_NO_SEAT", "WAITING_FOR_CLEARANCE", "WITH_LOANER_ASSIGNMENT", "WITH_NON_COLLECTED_ASSIGNMENT", "WITH_NON_DELIVERED_ASSIGNMENT", "WITH_PENDING_ASSIGNMENT", "WRONG_ASSIGNMENT_STATUS", "WRONG_CONTRACT_STATUS", "WRONG_TERMS_AND_CONDITIONS" ], "title": "ItAssetsAssetIdAddonsAddonIdAssignPostResponsesContentApplicationJsonSchemaDataActionsReuseOwnAssetFromOwnLocationDisabledReasonsItems", "type": "string" }, "ItAssetsAssetIdAddonsAddonIdAssignPostResponsesContentApplicationJsonSchemaDataActionsReuseOwnAssetFromOwnLocationStatus": { "description": "Whether the action is currently available for this asset", "enum": [ "DISABLED", "ENABLED", "NOT_APPLICABLE" ], "title": "ItAssetsAssetIdAddonsAddonIdAssignPostResponsesContentApplicationJsonSchemaDataActionsReuseOwnAssetFromOwnLocationStatus", "type": "string" }, "ItAssetsAssetIdAddonsAddonIdAssignPostResponsesContentApplicationJsonSchemaDataActionsStoreOwnAssetAtDeelForHub": { "description": "Store an organization-owned asset at a Deel hub warehouse", "properties": { "details": { "description": "Action-specific context needed to perform the action. Populated for enabled and\ndisabled actions (so callers can see what a successful attempt would look like);\nnull when the action is not applicable to this asset.", "oneOf": [ { "$ref": "#/components/schemas/ItAssetsAssetIdAddonsAddonIdAssignPostResponsesContentApplicationJsonSchemaDataActionsStoreOwnAssetAtDeelForHubDetails" }, { "type": "null" } ] }, "disabled_reasons": { "description": "Reasons why the action is disabled. Empty when the action is enabled or not applicable", "items": { "$ref": "#/components/schemas/ItAssetsAssetIdAddonsAddonIdAssignPostResponsesContentApplicationJsonSchemaDataActionsStoreOwnAssetAtDeelForHubDisabledReasonsItems" }, "type": "array" }, "status": { "$ref": "#/components/schemas/ItAssetsAssetIdAddonsAddonIdAssignPostResponsesContentApplicationJsonSchemaDataActionsStoreOwnAssetAtDeelForHubStatus", "description": "Whether the action is currently available for this asset" } }, "required": [ "status", "details", "disabled_reasons" ], "title": "ItAssetsAssetIdAddonsAddonIdAssignPostResponsesContentApplicationJsonSchemaDataActionsStoreOwnAssetAtDeelForHub", "type": "object" }, "ItAssetsAssetIdAddonsAddonIdAssignPostResponsesContentApplicationJsonSchemaDataActionsStoreOwnAssetAtDeelForHubDetails": { "description": "Action-specific context needed to perform the action. Populated for enabled and\ndisabled actions (so callers can see what a successful attempt would look like);\nnull when the action is not applicable to this asset.", "properties": { "activation_cost": { "$ref": "#/components/schemas/ItAssetsAssetIdAddonsAddonIdAssignPostResponsesContentApplicationJsonSchemaDataActionsStoreOwnAssetAtDeelForHubDetailsActivationCost", "description": "Cost charged to activate storage" }, "destination_country": { "$ref": "#/components/schemas/ItAssetsAssetIdAddonsAddonIdAssignPostResponsesContentApplicationJsonSchemaDataActionsStoreOwnAssetAtDeelForHubDetailsDestinationCountry", "description": "ISO 3166-1 alpha-2 country of the Deel warehouse the asset will be shipped to" }, "grace_period_in_months": { "description": "Grace period in months during which storage is free before monthly fees apply", "format": "int64", "type": "integer" }, "monthly_fee": { "$ref": "#/components/schemas/ItAssetsAssetIdAddonsAddonIdAssignPostResponsesContentApplicationJsonSchemaDataActionsStoreOwnAssetAtDeelForHubDetailsMonthlyFee", "description": "Monthly storage fee charged after the grace period" } }, "required": [ "monthly_fee", "activation_cost", "destination_country", "grace_period_in_months" ], "title": "ItAssetsAssetIdAddonsAddonIdAssignPostResponsesContentApplicationJsonSchemaDataActionsStoreOwnAssetAtDeelForHubDetails", "type": "object" }, "ItAssetsAssetIdAddonsAddonIdAssignPostResponsesContentApplicationJsonSchemaDataActionsStoreOwnAssetAtDeelForHubDetailsActivationCost": { "description": "Cost charged to activate storage", "properties": { "billing_method": { "$ref": "#/components/schemas/ItAssetsAssetIdAddonsAddonIdAssignPostResponsesContentApplicationJsonSchemaDataActionsStoreOwnAssetAtDeelForHubDetailsActivationCostBillingMethod", "description": "How the action is charged. When \"TOKEN\", the fees are covered by an\nadd-on token pool; when \"CURRENCY\", the fees are billed in the currency\nspecified in the \"fees\" field." }, "fees": { "description": "Price charged for the action. Null when billing method is \"TOKEN\"", "oneOf": [ { "$ref": "#/components/schemas/ItAssetsAssetIdAddonsAddonIdAssignPostResponsesContentApplicationJsonSchemaDataActionsStoreOwnAssetAtDeelForHubDetailsActivationCostFees" }, { "type": "null" } ] }, "token_usage": { "description": "Add-on token consumption details. Null when billing method is \"CURRENCY\"", "oneOf": [ { "$ref": "#/components/schemas/ItAssetsAssetIdAddonsAddonIdAssignPostResponsesContentApplicationJsonSchemaDataActionsStoreOwnAssetAtDeelForHubDetailsActivationCostTokenUsage" }, { "type": "null" } ] } }, "required": [ "fees", "token_usage", "billing_method" ], "title": "ItAssetsAssetIdAddonsAddonIdAssignPostResponsesContentApplicationJsonSchemaDataActionsStoreOwnAssetAtDeelForHubDetailsActivationCost", "type": "object" }, "ItAssetsAssetIdAddonsAddonIdAssignPostResponsesContentApplicationJsonSchemaDataActionsStoreOwnAssetAtDeelForHubDetailsActivationCostBillingMethod": { "description": "How the action is charged. When \"TOKEN\", the fees are covered by an\nadd-on token pool; when \"CURRENCY\", the fees are billed in the currency\nspecified in the \"fees\" field.", "enum": [ "CURRENCY", "TOKEN" ], "title": "ItAssetsAssetIdAddonsAddonIdAssignPostResponsesContentApplicationJsonSchemaDataActionsStoreOwnAssetAtDeelForHubDetailsActivationCostBillingMethod", "type": "string" }, "ItAssetsAssetIdAddonsAddonIdAssignPostResponsesContentApplicationJsonSchemaDataActionsStoreOwnAssetAtDeelForHubDetailsActivationCostFees": { "description": "Price charged for the action. Null when billing method is \"TOKEN\"", "properties": { "amount": { "description": "Amount", "format": "decimal", "type": "string" }, "currency": { "$ref": "#/components/schemas/ItAssetsAssetIdAddonsAddonIdAssignPostResponsesContentApplicationJsonSchemaDataActionsStoreOwnAssetAtDeelForHubDetailsActivationCostFeesCurrency", "description": "Three-letter currency code for the price" } }, "required": [ "amount", "currency" ], "title": "ItAssetsAssetIdAddonsAddonIdAssignPostResponsesContentApplicationJsonSchemaDataActionsStoreOwnAssetAtDeelForHubDetailsActivationCostFees", "type": "object" }, "ItAssetsAssetIdAddonsAddonIdAssignPostResponsesContentApplicationJsonSchemaDataActionsStoreOwnAssetAtDeelForHubDetailsActivationCostFeesCurrency": { "description": "Three-letter currency code for the price", "enum": [ "AED", "AFN", "ALL", "AMD", "ANG", "AOA", "ARS", "AUD", "AWG", "AZN", "BAM", "BDT", "BGN", "BHD", "BIF", "BMD", "BOB", "BRL", "BSD", "BTN", "BWP", "BYN", "BZD", "CAD", "CDF", "CHF", "CLP", "CNY", "COP", "CRC", "CUC", "CVE", "CZK", "DJF", "DKK", "DOP", "DZD", "EGP", "ERN", "ETB", "EUR", "FJD", "FKP", "GBP", "GEL", "GHS", "GIP", "GMD", "GNF", "GTQ", "GYD", "HKD", "HNL", "HRK", "HTG", "HUF", "IDR", "ILS", "INR", "IQD", "IRR", "ISK", "JMD", "JOD", "JPY", "KES", "KGS", "KHR", "KMF", "KPW", "KRW", "KWD", "KYD", "KZT", "LAK", "LBP", "LKR", "LRD", "LSL", "LTL", "LYD", "MAD", "MDL", "MGA", "MKD", "MMK", "MNT", "MRU", "MUR", "MVR", "MWK", "MXN", "MYR", "MZN", "NAD", "NGN", "NIO", "NOK", "NPR", "NZD", "OMR", "PAB", "PEN", "PGK", "PHP", "PKR", "PLN", "PYG", "QAR", "RON", "RSD", "RUB", "RWF", "SAR", "SBD", "SCR", "SDG", "SEK", "SGD", "SHP", "SLL", "SOS", "SRD", "SSP", "STD", "SYP", "SZL", "THB", "TJS", "TMT", "TND", "TOP", "TRY", "TTD", "TWD", "TZS", "UAH", "UGX", "USD", "UYU", "UZS", "VEF", "VND", "VUV", "WST", "XAF", "XCD", "XOF", "XPF", "YER", "ZAR", "ZMW", "ZWD" ], "title": "ItAssetsAssetIdAddonsAddonIdAssignPostResponsesContentApplicationJsonSchemaDataActionsStoreOwnAssetAtDeelForHubDetailsActivationCostFeesCurrency", "type": "string" }, "ItAssetsAssetIdAddonsAddonIdAssignPostResponsesContentApplicationJsonSchemaDataActionsStoreOwnAssetAtDeelForHubDetailsActivationCostTokenUsage": { "description": "Add-on token consumption details. Null when billing method is \"CURRENCY\"", "properties": { "addon": { "$ref": "#/components/schemas/ItAssetsAssetIdAddonsAddonIdAssignPostResponsesContentApplicationJsonSchemaDataActionsStoreOwnAssetAtDeelForHubDetailsActivationCostTokenUsageAddon", "description": "The add-on that provides the tokens" }, "cost": { "description": "Number of tokens consumed by the action. Zero when the add-on covers the\nservice without drawing from a token pool", "format": "decimal", "type": "string" }, "tokens_left": { "description": "Number of tokens left in the pool after the action is performed. Null when\nthe add-on covers the service without a token pool", "format": "decimal", "type": [ "string", "null" ] } }, "required": [ "cost", "addon", "tokens_left" ], "title": "ItAssetsAssetIdAddonsAddonIdAssignPostResponsesContentApplicationJsonSchemaDataActionsStoreOwnAssetAtDeelForHubDetailsActivationCostTokenUsage", "type": "object" }, "ItAssetsAssetIdAddonsAddonIdAssignPostResponsesContentApplicationJsonSchemaDataActionsStoreOwnAssetAtDeelForHubDetailsActivationCostTokenUsageAddon": { "description": "The add-on that provides the tokens", "properties": { "id": { "description": "ID of the add-on", "format": "uuid", "type": "string" }, "name": { "description": "Public display name of the add-on", "type": "string" } }, "required": [ "id", "name" ], "title": "ItAssetsAssetIdAddonsAddonIdAssignPostResponsesContentApplicationJsonSchemaDataActionsStoreOwnAssetAtDeelForHubDetailsActivationCostTokenUsageAddon", "type": "object" }, "ItAssetsAssetIdAddonsAddonIdAssignPostResponsesContentApplicationJsonSchemaDataActionsStoreOwnAssetAtDeelForHubDetailsDestinationCountry": { "description": "ISO 3166-1 alpha-2 country of the Deel warehouse the asset will be shipped to", "enum": [ "AD", "AE", "AF", "AG", "AI", "AL", "AM", "AN", "AO", "AQ", "AR", "AS", "AT", "AU", "AW", "AX", "AZ", "BA", "BB", "BD", "BE", "BF", "BG", "BH", "BI", "BJ", "BL", "BM", "BN", "BO", "BQ", "BR", "BS", "BT", "BV", "BW", "BY", "BZ", "CA", "CC", "CD", "CF", "CG", "CH", "CI", "CK", "CL", "CM", "CN", "CO", "CR", "CU", "CV", "CW", "CX", "CY", "CZ", "DE", "DJ", "DK", "DM", "DO", "DZ", "EC", "EE", "EG", "EH", "ER", "ES", "ET", "FI", "FJ", "FK", "FM", "FO", "FR", "GA", "GB", "GD", "GE", "GF", "GG", "GH", "GI", "GL", "GM", "GN", "GP", "GQ", "GR", "GS", "GT", "GU", "GW", "GY", "HK", "HM", "HN", "HR", "HT", "HU", "IC", "ID", "IE", "IL", "IM", "IN", "IO", "IQ", "IR", "IS", "IT", "JE", "JM", "JO", "JP", "KE", "KG", "KH", "KI", "KM", "KN", "KP", "KR", "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", "XK", "YE", "YT", "ZA", "ZM", "ZW" ], "title": "ItAssetsAssetIdAddonsAddonIdAssignPostResponsesContentApplicationJsonSchemaDataActionsStoreOwnAssetAtDeelForHubDetailsDestinationCountry", "type": "string" }, "ItAssetsAssetIdAddonsAddonIdAssignPostResponsesContentApplicationJsonSchemaDataActionsStoreOwnAssetAtDeelForHubDetailsMonthlyFee": { "description": "Monthly storage fee charged after the grace period", "properties": { "amount": { "description": "Amount", "format": "decimal", "type": "string" }, "currency": { "$ref": "#/components/schemas/ItAssetsAssetIdAddonsAddonIdAssignPostResponsesContentApplicationJsonSchemaDataActionsStoreOwnAssetAtDeelForHubDetailsMonthlyFeeCurrency", "description": "Three-letter currency code for the price" } }, "required": [ "amount", "currency" ], "title": "ItAssetsAssetIdAddonsAddonIdAssignPostResponsesContentApplicationJsonSchemaDataActionsStoreOwnAssetAtDeelForHubDetailsMonthlyFee", "type": "object" }, "ItAssetsAssetIdAddonsAddonIdAssignPostResponsesContentApplicationJsonSchemaDataActionsStoreOwnAssetAtDeelForHubDetailsMonthlyFeeCurrency": { "description": "Three-letter currency code for the price", "enum": [ "AED", "AFN", "ALL", "AMD", "ANG", "AOA", "ARS", "AUD", "AWG", "AZN", "BAM", "BDT", "BGN", "BHD", "BIF", "BMD", "BOB", "BRL", "BSD", "BTN", "BWP", "BYN", "BZD", "CAD", "CDF", "CHF", "CLP", "CNY", "COP", "CRC", "CUC", "CVE", "CZK", "DJF", "DKK", "DOP", "DZD", "EGP", "ERN", "ETB", "EUR", "FJD", "FKP", "GBP", "GEL", "GHS", "GIP", "GMD", "GNF", "GTQ", "GYD", "HKD", "HNL", "HRK", "HTG", "HUF", "IDR", "ILS", "INR", "IQD", "IRR", "ISK", "JMD", "JOD", "JPY", "KES", "KGS", "KHR", "KMF", "KPW", "KRW", "KWD", "KYD", "KZT", "LAK", "LBP", "LKR", "LRD", "LSL", "LTL", "LYD", "MAD", "MDL", "MGA", "MKD", "MMK", "MNT", "MRU", "MUR", "MVR", "MWK", "MXN", "MYR", "MZN", "NAD", "NGN", "NIO", "NOK", "NPR", "NZD", "OMR", "PAB", "PEN", "PGK", "PHP", "PKR", "PLN", "PYG", "QAR", "RON", "RSD", "RUB", "RWF", "SAR", "SBD", "SCR", "SDG", "SEK", "SGD", "SHP", "SLL", "SOS", "SRD", "SSP", "STD", "SYP", "SZL", "THB", "TJS", "TMT", "TND", "TOP", "TRY", "TTD", "TWD", "TZS", "UAH", "UGX", "USD", "UYU", "UZS", "VEF", "VND", "VUV", "WST", "XAF", "XCD", "XOF", "XPF", "YER", "ZAR", "ZMW", "ZWD" ], "title": "ItAssetsAssetIdAddonsAddonIdAssignPostResponsesContentApplicationJsonSchemaDataActionsStoreOwnAssetAtDeelForHubDetailsMonthlyFeeCurrency", "type": "string" }, "ItAssetsAssetIdAddonsAddonIdAssignPostResponsesContentApplicationJsonSchemaDataActionsStoreOwnAssetAtDeelForHubDisabledReasonsItems": { "enum": [ "ARCHIVED", "AT_DEEL_WAREHOUSE", "BEING_REPAIRED", "CONSUMABLE", "CONTROLLED_BY_DEEL", "COUNTRY_NOT_SUPPORTED_FOR_HUB", "COUNTRY_NOT_SUPPORTED_FOR_LOCAL", "DEEL_OWNED_ITEM_WITHOUT_RENTAL_CONTRACT", "DESKTOP_STORAGE", "ENDING_CONTRACT", "HUB_IN_SAME_REGION_AS_LOCAL", "INACTIVE", "INVALID_ITEM_LOCATION", "INVALID_ORGANIZATION_STATUS", "INVALID_STATE", "ITEM_CONDITIONS_TO_UNARCHIVE_NOT_MET", "ITEM_NOT_VISIBLE_FOR_ORGANIZATION", "NON_DEVICE", "NOT_AT_WAREHOUSE", "NOT_AVAILABLE_FOR_REUSE", "NOT_A_RENTAL", "NOT_MANAGEABLE_BY_ORGANIZATION", "NOT_WITH_ASSIGNMENT", "NOT_WITH_USER", "NO_ACTIVE_ADDONS", "NO_ACTIVE_STORAGE_CONTRACT", "NO_LOCATION_FOR_STORAGE", "NO_LOGISTICS_FOR_STORAGE", "NO_VALID_ADDONS", "ONGOING_SERVICE", "OWNED_BY_DEEL", "OWNED_BY_ORGANIZATION", "OWNED_BY_PARTNER_ORGANIZATION", "PARTNER_CHILD_CONTRACT", "PENDING_DEVICE_REFRESH", "RENTAL_CONTRACT_AND_USER_REGION_DO_NOT_MATCH", "TEMPORARILY_UNAVAILABLE", "UNKNOWN", "USER_HAS_NO_COUNTRY", "USER_HAS_NO_SEAT", "WAITING_FOR_CLEARANCE", "WITH_LOANER_ASSIGNMENT", "WITH_NON_COLLECTED_ASSIGNMENT", "WITH_NON_DELIVERED_ASSIGNMENT", "WITH_PENDING_ASSIGNMENT", "WRONG_ASSIGNMENT_STATUS", "WRONG_CONTRACT_STATUS", "WRONG_TERMS_AND_CONDITIONS" ], "title": "ItAssetsAssetIdAddonsAddonIdAssignPostResponsesContentApplicationJsonSchemaDataActionsStoreOwnAssetAtDeelForHubDisabledReasonsItems", "type": "string" }, "ItAssetsAssetIdAddonsAddonIdAssignPostResponsesContentApplicationJsonSchemaDataActionsStoreOwnAssetAtDeelForHubStatus": { "description": "Whether the action is currently available for this asset", "enum": [ "DISABLED", "ENABLED", "NOT_APPLICABLE" ], "title": "ItAssetsAssetIdAddonsAddonIdAssignPostResponsesContentApplicationJsonSchemaDataActionsStoreOwnAssetAtDeelForHubStatus", "type": "string" }, "ItAssetsAssetIdAddonsAddonIdAssignPostResponsesContentApplicationJsonSchemaDataActionsStoreOwnAssetAtDeelForLocal": { "description": "Store an organization-owned asset at a Deel local warehouse", "properties": { "details": { "description": "Action-specific context needed to perform the action. Populated for enabled and\ndisabled actions (so callers can see what a successful attempt would look like);\nnull when the action is not applicable to this asset.", "oneOf": [ { "$ref": "#/components/schemas/ItAssetsAssetIdAddonsAddonIdAssignPostResponsesContentApplicationJsonSchemaDataActionsStoreOwnAssetAtDeelForLocalDetails" }, { "type": "null" } ] }, "disabled_reasons": { "description": "Reasons why the action is disabled. Empty when the action is enabled or not applicable", "items": { "$ref": "#/components/schemas/ItAssetsAssetIdAddonsAddonIdAssignPostResponsesContentApplicationJsonSchemaDataActionsStoreOwnAssetAtDeelForLocalDisabledReasonsItems" }, "type": "array" }, "status": { "$ref": "#/components/schemas/ItAssetsAssetIdAddonsAddonIdAssignPostResponsesContentApplicationJsonSchemaDataActionsStoreOwnAssetAtDeelForLocalStatus", "description": "Whether the action is currently available for this asset" } }, "required": [ "status", "details", "disabled_reasons" ], "title": "ItAssetsAssetIdAddonsAddonIdAssignPostResponsesContentApplicationJsonSchemaDataActionsStoreOwnAssetAtDeelForLocal", "type": "object" }, "ItAssetsAssetIdAddonsAddonIdAssignPostResponsesContentApplicationJsonSchemaDataActionsStoreOwnAssetAtDeelForLocalDetails": { "description": "Action-specific context needed to perform the action. Populated for enabled and\ndisabled actions (so callers can see what a successful attempt would look like);\nnull when the action is not applicable to this asset.", "properties": { "activation_cost": { "$ref": "#/components/schemas/ItAssetsAssetIdAddonsAddonIdAssignPostResponsesContentApplicationJsonSchemaDataActionsStoreOwnAssetAtDeelForLocalDetailsActivationCost", "description": "Cost charged to activate storage" }, "destination_country": { "$ref": "#/components/schemas/ItAssetsAssetIdAddonsAddonIdAssignPostResponsesContentApplicationJsonSchemaDataActionsStoreOwnAssetAtDeelForLocalDetailsDestinationCountry", "description": "ISO 3166-1 alpha-2 country of the Deel warehouse the asset will be shipped to" }, "grace_period_in_months": { "description": "Grace period in months during which storage is free before monthly fees apply", "format": "int64", "type": "integer" }, "monthly_fee": { "$ref": "#/components/schemas/ItAssetsAssetIdAddonsAddonIdAssignPostResponsesContentApplicationJsonSchemaDataActionsStoreOwnAssetAtDeelForLocalDetailsMonthlyFee", "description": "Monthly storage fee charged after the grace period" } }, "required": [ "monthly_fee", "activation_cost", "destination_country", "grace_period_in_months" ], "title": "ItAssetsAssetIdAddonsAddonIdAssignPostResponsesContentApplicationJsonSchemaDataActionsStoreOwnAssetAtDeelForLocalDetails", "type": "object" }, "ItAssetsAssetIdAddonsAddonIdAssignPostResponsesContentApplicationJsonSchemaDataActionsStoreOwnAssetAtDeelForLocalDetailsActivationCost": { "description": "Cost charged to activate storage", "properties": { "billing_method": { "$ref": "#/components/schemas/ItAssetsAssetIdAddonsAddonIdAssignPostResponsesContentApplicationJsonSchemaDataActionsStoreOwnAssetAtDeelForLocalDetailsActivationCostBillingMethod", "description": "How the action is charged. When \"TOKEN\", the fees are covered by an\nadd-on token pool; when \"CURRENCY\", the fees are billed in the currency\nspecified in the \"fees\" field." }, "fees": { "description": "Price charged for the action. Null when billing method is \"TOKEN\"", "oneOf": [ { "$ref": "#/components/schemas/ItAssetsAssetIdAddonsAddonIdAssignPostResponsesContentApplicationJsonSchemaDataActionsStoreOwnAssetAtDeelForLocalDetailsActivationCostFees" }, { "type": "null" } ] }, "token_usage": { "description": "Add-on token consumption details. Null when billing method is \"CURRENCY\"", "oneOf": [ { "$ref": "#/components/schemas/ItAssetsAssetIdAddonsAddonIdAssignPostResponsesContentApplicationJsonSchemaDataActionsStoreOwnAssetAtDeelForLocalDetailsActivationCostTokenUsage" }, { "type": "null" } ] } }, "required": [ "fees", "token_usage", "billing_method" ], "title": "ItAssetsAssetIdAddonsAddonIdAssignPostResponsesContentApplicationJsonSchemaDataActionsStoreOwnAssetAtDeelForLocalDetailsActivationCost", "type": "object" }, "ItAssetsAssetIdAddonsAddonIdAssignPostResponsesContentApplicationJsonSchemaDataActionsStoreOwnAssetAtDeelForLocalDetailsActivationCostBillingMethod": { "description": "How the action is charged. When \"TOKEN\", the fees are covered by an\nadd-on token pool; when \"CURRENCY\", the fees are billed in the currency\nspecified in the \"fees\" field.", "enum": [ "CURRENCY", "TOKEN" ], "title": "ItAssetsAssetIdAddonsAddonIdAssignPostResponsesContentApplicationJsonSchemaDataActionsStoreOwnAssetAtDeelForLocalDetailsActivationCostBillingMethod", "type": "string" }, "ItAssetsAssetIdAddonsAddonIdAssignPostResponsesContentApplicationJsonSchemaDataActionsStoreOwnAssetAtDeelForLocalDetailsActivationCostFees": { "description": "Price charged for the action. Null when billing method is \"TOKEN\"", "properties": { "amount": { "description": "Amount", "format": "decimal", "type": "string" }, "currency": { "$ref": "#/components/schemas/ItAssetsAssetIdAddonsAddonIdAssignPostResponsesContentApplicationJsonSchemaDataActionsStoreOwnAssetAtDeelForLocalDetailsActivationCostFeesCurrency", "description": "Three-letter currency code for the price" } }, "required": [ "amount", "currency" ], "title": "ItAssetsAssetIdAddonsAddonIdAssignPostResponsesContentApplicationJsonSchemaDataActionsStoreOwnAssetAtDeelForLocalDetailsActivationCostFees", "type": "object" }, "ItAssetsAssetIdAddonsAddonIdAssignPostResponsesContentApplicationJsonSchemaDataActionsStoreOwnAssetAtDeelForLocalDetailsActivationCostFeesCurrency": { "description": "Three-letter currency code for the price", "enum": [ "AED", "AFN", "ALL", "AMD", "ANG", "AOA", "ARS", "AUD", "AWG", "AZN", "BAM", "BDT", "BGN", "BHD", "BIF", "BMD", "BOB", "BRL", "BSD", "BTN", "BWP", "BYN", "BZD", "CAD", "CDF", "CHF", "CLP", "CNY", "COP", "CRC", "CUC", "CVE", "CZK", "DJF", "DKK", "DOP", "DZD", "EGP", "ERN", "ETB", "EUR", "FJD", "FKP", "GBP", "GEL", "GHS", "GIP", "GMD", "GNF", "GTQ", "GYD", "HKD", "HNL", "HRK", "HTG", "HUF", "IDR", "ILS", "INR", "IQD", "IRR", "ISK", "JMD", "JOD", "JPY", "KES", "KGS", "KHR", "KMF", "KPW", "KRW", "KWD", "KYD", "KZT", "LAK", "LBP", "LKR", "LRD", "LSL", "LTL", "LYD", "MAD", "MDL", "MGA", "MKD", "MMK", "MNT", "MRU", "MUR", "MVR", "MWK", "MXN", "MYR", "MZN", "NAD", "NGN", "NIO", "NOK", "NPR", "NZD", "OMR", "PAB", "PEN", "PGK", "PHP", "PKR", "PLN", "PYG", "QAR", "RON", "RSD", "RUB", "RWF", "SAR", "SBD", "SCR", "SDG", "SEK", "SGD", "SHP", "SLL", "SOS", "SRD", "SSP", "STD", "SYP", "SZL", "THB", "TJS", "TMT", "TND", "TOP", "TRY", "TTD", "TWD", "TZS", "UAH", "UGX", "USD", "UYU", "UZS", "VEF", "VND", "VUV", "WST", "XAF", "XCD", "XOF", "XPF", "YER", "ZAR", "ZMW", "ZWD" ], "title": "ItAssetsAssetIdAddonsAddonIdAssignPostResponsesContentApplicationJsonSchemaDataActionsStoreOwnAssetAtDeelForLocalDetailsActivationCostFeesCurrency", "type": "string" }, "ItAssetsAssetIdAddonsAddonIdAssignPostResponsesContentApplicationJsonSchemaDataActionsStoreOwnAssetAtDeelForLocalDetailsActivationCostTokenUsage": { "description": "Add-on token consumption details. Null when billing method is \"CURRENCY\"", "properties": { "addon": { "$ref": "#/components/schemas/ItAssetsAssetIdAddonsAddonIdAssignPostResponsesContentApplicationJsonSchemaDataActionsStoreOwnAssetAtDeelForLocalDetailsActivationCostTokenUsageAddon", "description": "The add-on that provides the tokens" }, "cost": { "description": "Number of tokens consumed by the action. Zero when the add-on covers the\nservice without drawing from a token pool", "format": "decimal", "type": "string" }, "tokens_left": { "description": "Number of tokens left in the pool after the action is performed. Null when\nthe add-on covers the service without a token pool", "format": "decimal", "type": [ "string", "null" ] } }, "required": [ "cost", "addon", "tokens_left" ], "title": "ItAssetsAssetIdAddonsAddonIdAssignPostResponsesContentApplicationJsonSchemaDataActionsStoreOwnAssetAtDeelForLocalDetailsActivationCostTokenUsage", "type": "object" }, "ItAssetsAssetIdAddonsAddonIdAssignPostResponsesContentApplicationJsonSchemaDataActionsStoreOwnAssetAtDeelForLocalDetailsActivationCostTokenUsageAddon": { "description": "The add-on that provides the tokens", "properties": { "id": { "description": "ID of the add-on", "format": "uuid", "type": "string" }, "name": { "description": "Public display name of the add-on", "type": "string" } }, "required": [ "id", "name" ], "title": "ItAssetsAssetIdAddonsAddonIdAssignPostResponsesContentApplicationJsonSchemaDataActionsStoreOwnAssetAtDeelForLocalDetailsActivationCostTokenUsageAddon", "type": "object" }, "ItAssetsAssetIdAddonsAddonIdAssignPostResponsesContentApplicationJsonSchemaDataActionsStoreOwnAssetAtDeelForLocalDetailsDestinationCountry": { "description": "ISO 3166-1 alpha-2 country of the Deel warehouse the asset will be shipped to", "enum": [ "AD", "AE", "AF", "AG", "AI", "AL", "AM", "AN", "AO", "AQ", "AR", "AS", "AT", "AU", "AW", "AX", "AZ", "BA", "BB", "BD", "BE", "BF", "BG", "BH", "BI", "BJ", "BL", "BM", "BN", "BO", "BQ", "BR", "BS", "BT", "BV", "BW", "BY", "BZ", "CA", "CC", "CD", "CF", "CG", "CH", "CI", "CK", "CL", "CM", "CN", "CO", "CR", "CU", "CV", "CW", "CX", "CY", "CZ", "DE", "DJ", "DK", "DM", "DO", "DZ", "EC", "EE", "EG", "EH", "ER", "ES", "ET", "FI", "FJ", "FK", "FM", "FO", "FR", "GA", "GB", "GD", "GE", "GF", "GG", "GH", "GI", "GL", "GM", "GN", "GP", "GQ", "GR", "GS", "GT", "GU", "GW", "GY", "HK", "HM", "HN", "HR", "HT", "HU", "IC", "ID", "IE", "IL", "IM", "IN", "IO", "IQ", "IR", "IS", "IT", "JE", "JM", "JO", "JP", "KE", "KG", "KH", "KI", "KM", "KN", "KP", "KR", "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", "XK", "YE", "YT", "ZA", "ZM", "ZW" ], "title": "ItAssetsAssetIdAddonsAddonIdAssignPostResponsesContentApplicationJsonSchemaDataActionsStoreOwnAssetAtDeelForLocalDetailsDestinationCountry", "type": "string" }, "ItAssetsAssetIdAddonsAddonIdAssignPostResponsesContentApplicationJsonSchemaDataActionsStoreOwnAssetAtDeelForLocalDetailsMonthlyFee": { "description": "Monthly storage fee charged after the grace period", "properties": { "amount": { "description": "Amount", "format": "decimal", "type": "string" }, "currency": { "$ref": "#/components/schemas/ItAssetsAssetIdAddonsAddonIdAssignPostResponsesContentApplicationJsonSchemaDataActionsStoreOwnAssetAtDeelForLocalDetailsMonthlyFeeCurrency", "description": "Three-letter currency code for the price" } }, "required": [ "amount", "currency" ], "title": "ItAssetsAssetIdAddonsAddonIdAssignPostResponsesContentApplicationJsonSchemaDataActionsStoreOwnAssetAtDeelForLocalDetailsMonthlyFee", "type": "object" }, "ItAssetsAssetIdAddonsAddonIdAssignPostResponsesContentApplicationJsonSchemaDataActionsStoreOwnAssetAtDeelForLocalDetailsMonthlyFeeCurrency": { "description": "Three-letter currency code for the price", "enum": [ "AED", "AFN", "ALL", "AMD", "ANG", "AOA", "ARS", "AUD", "AWG", "AZN", "BAM", "BDT", "BGN", "BHD", "BIF", "BMD", "BOB", "BRL", "BSD", "BTN", "BWP", "BYN", "BZD", "CAD", "CDF", "CHF", "CLP", "CNY", "COP", "CRC", "CUC", "CVE", "CZK", "DJF", "DKK", "DOP", "DZD", "EGP", "ERN", "ETB", "EUR", "FJD", "FKP", "GBP", "GEL", "GHS", "GIP", "GMD", "GNF", "GTQ", "GYD", "HKD", "HNL", "HRK", "HTG", "HUF", "IDR", "ILS", "INR", "IQD", "IRR", "ISK", "JMD", "JOD", "JPY", "KES", "KGS", "KHR", "KMF", "KPW", "KRW", "KWD", "KYD", "KZT", "LAK", "LBP", "LKR", "LRD", "LSL", "LTL", "LYD", "MAD", "MDL", "MGA", "MKD", "MMK", "MNT", "MRU", "MUR", "MVR", "MWK", "MXN", "MYR", "MZN", "NAD", "NGN", "NIO", "NOK", "NPR", "NZD", "OMR", "PAB", "PEN", "PGK", "PHP", "PKR", "PLN", "PYG", "QAR", "RON", "RSD", "RUB", "RWF", "SAR", "SBD", "SCR", "SDG", "SEK", "SGD", "SHP", "SLL", "SOS", "SRD", "SSP", "STD", "SYP", "SZL", "THB", "TJS", "TMT", "TND", "TOP", "TRY", "TTD", "TWD", "TZS", "UAH", "UGX", "USD", "UYU", "UZS", "VEF", "VND", "VUV", "WST", "XAF", "XCD", "XOF", "XPF", "YER", "ZAR", "ZMW", "ZWD" ], "title": "ItAssetsAssetIdAddonsAddonIdAssignPostResponsesContentApplicationJsonSchemaDataActionsStoreOwnAssetAtDeelForLocalDetailsMonthlyFeeCurrency", "type": "string" }, "ItAssetsAssetIdAddonsAddonIdAssignPostResponsesContentApplicationJsonSchemaDataActionsStoreOwnAssetAtDeelForLocalDisabledReasonsItems": { "enum": [ "ARCHIVED", "AT_DEEL_WAREHOUSE", "BEING_REPAIRED", "CONSUMABLE", "CONTROLLED_BY_DEEL", "COUNTRY_NOT_SUPPORTED_FOR_HUB", "COUNTRY_NOT_SUPPORTED_FOR_LOCAL", "DEEL_OWNED_ITEM_WITHOUT_RENTAL_CONTRACT", "DESKTOP_STORAGE", "ENDING_CONTRACT", "HUB_IN_SAME_REGION_AS_LOCAL", "INACTIVE", "INVALID_ITEM_LOCATION", "INVALID_ORGANIZATION_STATUS", "INVALID_STATE", "ITEM_CONDITIONS_TO_UNARCHIVE_NOT_MET", "ITEM_NOT_VISIBLE_FOR_ORGANIZATION", "NON_DEVICE", "NOT_AT_WAREHOUSE", "NOT_AVAILABLE_FOR_REUSE", "NOT_A_RENTAL", "NOT_MANAGEABLE_BY_ORGANIZATION", "NOT_WITH_ASSIGNMENT", "NOT_WITH_USER", "NO_ACTIVE_ADDONS", "NO_ACTIVE_STORAGE_CONTRACT", "NO_LOCATION_FOR_STORAGE", "NO_LOGISTICS_FOR_STORAGE", "NO_VALID_ADDONS", "ONGOING_SERVICE", "OWNED_BY_DEEL", "OWNED_BY_ORGANIZATION", "OWNED_BY_PARTNER_ORGANIZATION", "PARTNER_CHILD_CONTRACT", "PENDING_DEVICE_REFRESH", "RENTAL_CONTRACT_AND_USER_REGION_DO_NOT_MATCH", "TEMPORARILY_UNAVAILABLE", "UNKNOWN", "USER_HAS_NO_COUNTRY", "USER_HAS_NO_SEAT", "WAITING_FOR_CLEARANCE", "WITH_LOANER_ASSIGNMENT", "WITH_NON_COLLECTED_ASSIGNMENT", "WITH_NON_DELIVERED_ASSIGNMENT", "WITH_PENDING_ASSIGNMENT", "WRONG_ASSIGNMENT_STATUS", "WRONG_CONTRACT_STATUS", "WRONG_TERMS_AND_CONDITIONS" ], "title": "ItAssetsAssetIdAddonsAddonIdAssignPostResponsesContentApplicationJsonSchemaDataActionsStoreOwnAssetAtDeelForLocalDisabledReasonsItems", "type": "string" }, "ItAssetsAssetIdAddonsAddonIdAssignPostResponsesContentApplicationJsonSchemaDataActionsStoreOwnAssetAtDeelForLocalStatus": { "description": "Whether the action is currently available for this asset", "enum": [ "DISABLED", "ENABLED", "NOT_APPLICABLE" ], "title": "ItAssetsAssetIdAddonsAddonIdAssignPostResponsesContentApplicationJsonSchemaDataActionsStoreOwnAssetAtDeelForLocalStatus", "type": "string" }, "ItAssetsAssetIdAddonsAddonIdAssignPostResponsesContentApplicationJsonSchemaDataActionsStoreOwnAssetAtOwnLocation": { "description": "Store an organization-owned asset at an organization-owned location", "properties": { "details": { "description": "Action-specific context needed to perform the action. Populated for enabled and\ndisabled actions (so callers can see what a successful attempt would look like);\nnull when the action is not applicable to this asset.", "oneOf": [ { "$ref": "#/components/schemas/ItAssetsAssetIdAddonsAddonIdAssignPostResponsesContentApplicationJsonSchemaDataActionsStoreOwnAssetAtOwnLocationDetails" }, { "type": "null" } ] }, "disabled_reasons": { "description": "Reasons why the action is disabled. Empty when the action is enabled or not applicable", "items": { "$ref": "#/components/schemas/ItAssetsAssetIdAddonsAddonIdAssignPostResponsesContentApplicationJsonSchemaDataActionsStoreOwnAssetAtOwnLocationDisabledReasonsItems" }, "type": "array" }, "status": { "$ref": "#/components/schemas/ItAssetsAssetIdAddonsAddonIdAssignPostResponsesContentApplicationJsonSchemaDataActionsStoreOwnAssetAtOwnLocationStatus", "description": "Whether the action is currently available for this asset" } }, "required": [ "status", "details", "disabled_reasons" ], "title": "ItAssetsAssetIdAddonsAddonIdAssignPostResponsesContentApplicationJsonSchemaDataActionsStoreOwnAssetAtOwnLocation", "type": "object" }, "ItAssetsAssetIdAddonsAddonIdAssignPostResponsesContentApplicationJsonSchemaDataActionsStoreOwnAssetAtOwnLocationDetails": { "description": "Action-specific context needed to perform the action. Populated for enabled and\ndisabled actions (so callers can see what a successful attempt would look like);\nnull when the action is not applicable to this asset.", "properties": { "eligible_countries": { "description": "Countries where the asset can be stored at an organization-owned location", "items": { "$ref": "#/components/schemas/ItAssetsAssetIdAddonsAddonIdAssignPostResponsesContentApplicationJsonSchemaDataActionsStoreOwnAssetAtOwnLocationDetailsEligibleCountriesItems" }, "type": "array" }, "service_cost": { "$ref": "#/components/schemas/ItAssetsAssetIdAddonsAddonIdAssignPostResponsesContentApplicationJsonSchemaDataActionsStoreOwnAssetAtOwnLocationDetailsServiceCost", "description": "Cost charged for the transfer service" } }, "required": [ "service_cost", "eligible_countries" ], "title": "ItAssetsAssetIdAddonsAddonIdAssignPostResponsesContentApplicationJsonSchemaDataActionsStoreOwnAssetAtOwnLocationDetails", "type": "object" }, "ItAssetsAssetIdAddonsAddonIdAssignPostResponsesContentApplicationJsonSchemaDataActionsStoreOwnAssetAtOwnLocationDetailsEligibleCountriesItems": { "enum": [ "AD", "AE", "AF", "AG", "AI", "AL", "AM", "AN", "AO", "AQ", "AR", "AS", "AT", "AU", "AW", "AX", "AZ", "BA", "BB", "BD", "BE", "BF", "BG", "BH", "BI", "BJ", "BL", "BM", "BN", "BO", "BQ", "BR", "BS", "BT", "BV", "BW", "BY", "BZ", "CA", "CC", "CD", "CF", "CG", "CH", "CI", "CK", "CL", "CM", "CN", "CO", "CR", "CU", "CV", "CW", "CX", "CY", "CZ", "DE", "DJ", "DK", "DM", "DO", "DZ", "EC", "EE", "EG", "EH", "ER", "ES", "ET", "FI", "FJ", "FK", "FM", "FO", "FR", "GA", "GB", "GD", "GE", "GF", "GG", "GH", "GI", "GL", "GM", "GN", "GP", "GQ", "GR", "GS", "GT", "GU", "GW", "GY", "HK", "HM", "HN", "HR", "HT", "HU", "IC", "ID", "IE", "IL", "IM", "IN", "IO", "IQ", "IR", "IS", "IT", "JE", "JM", "JO", "JP", "KE", "KG", "KH", "KI", "KM", "KN", "KP", "KR", "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", "XK", "YE", "YT", "ZA", "ZM", "ZW" ], "title": "ItAssetsAssetIdAddonsAddonIdAssignPostResponsesContentApplicationJsonSchemaDataActionsStoreOwnAssetAtOwnLocationDetailsEligibleCountriesItems", "type": "string" }, "ItAssetsAssetIdAddonsAddonIdAssignPostResponsesContentApplicationJsonSchemaDataActionsStoreOwnAssetAtOwnLocationDetailsServiceCost": { "description": "Cost charged for the transfer service", "properties": { "billing_method": { "$ref": "#/components/schemas/ItAssetsAssetIdAddonsAddonIdAssignPostResponsesContentApplicationJsonSchemaDataActionsStoreOwnAssetAtOwnLocationDetailsServiceCostBillingMethod", "description": "How the action is charged. When \"TOKEN\", the fees are covered by an\nadd-on token pool; when \"CURRENCY\", the fees are billed in the currency\nspecified in the \"fees\" field." }, "fees": { "description": "Price charged for the action. Null when billing method is \"TOKEN\"", "oneOf": [ { "$ref": "#/components/schemas/ItAssetsAssetIdAddonsAddonIdAssignPostResponsesContentApplicationJsonSchemaDataActionsStoreOwnAssetAtOwnLocationDetailsServiceCostFees" }, { "type": "null" } ] }, "token_usage": { "description": "Add-on token consumption details. Null when billing method is \"CURRENCY\"", "oneOf": [ { "$ref": "#/components/schemas/ItAssetsAssetIdAddonsAddonIdAssignPostResponsesContentApplicationJsonSchemaDataActionsStoreOwnAssetAtOwnLocationDetailsServiceCostTokenUsage" }, { "type": "null" } ] } }, "required": [ "fees", "token_usage", "billing_method" ], "title": "ItAssetsAssetIdAddonsAddonIdAssignPostResponsesContentApplicationJsonSchemaDataActionsStoreOwnAssetAtOwnLocationDetailsServiceCost", "type": "object" }, "ItAssetsAssetIdAddonsAddonIdAssignPostResponsesContentApplicationJsonSchemaDataActionsStoreOwnAssetAtOwnLocationDetailsServiceCostBillingMethod": { "description": "How the action is charged. When \"TOKEN\", the fees are covered by an\nadd-on token pool; when \"CURRENCY\", the fees are billed in the currency\nspecified in the \"fees\" field.", "enum": [ "CURRENCY", "TOKEN" ], "title": "ItAssetsAssetIdAddonsAddonIdAssignPostResponsesContentApplicationJsonSchemaDataActionsStoreOwnAssetAtOwnLocationDetailsServiceCostBillingMethod", "type": "string" }, "ItAssetsAssetIdAddonsAddonIdAssignPostResponsesContentApplicationJsonSchemaDataActionsStoreOwnAssetAtOwnLocationDetailsServiceCostFees": { "description": "Price charged for the action. Null when billing method is \"TOKEN\"", "properties": { "amount": { "description": "Amount", "format": "decimal", "type": "string" }, "currency": { "$ref": "#/components/schemas/ItAssetsAssetIdAddonsAddonIdAssignPostResponsesContentApplicationJsonSchemaDataActionsStoreOwnAssetAtOwnLocationDetailsServiceCostFeesCurrency", "description": "Three-letter currency code for the price" } }, "required": [ "amount", "currency" ], "title": "ItAssetsAssetIdAddonsAddonIdAssignPostResponsesContentApplicationJsonSchemaDataActionsStoreOwnAssetAtOwnLocationDetailsServiceCostFees", "type": "object" }, "ItAssetsAssetIdAddonsAddonIdAssignPostResponsesContentApplicationJsonSchemaDataActionsStoreOwnAssetAtOwnLocationDetailsServiceCostFeesCurrency": { "description": "Three-letter currency code for the price", "enum": [ "AED", "AFN", "ALL", "AMD", "ANG", "AOA", "ARS", "AUD", "AWG", "AZN", "BAM", "BDT", "BGN", "BHD", "BIF", "BMD", "BOB", "BRL", "BSD", "BTN", "BWP", "BYN", "BZD", "CAD", "CDF", "CHF", "CLP", "CNY", "COP", "CRC", "CUC", "CVE", "CZK", "DJF", "DKK", "DOP", "DZD", "EGP", "ERN", "ETB", "EUR", "FJD", "FKP", "GBP", "GEL", "GHS", "GIP", "GMD", "GNF", "GTQ", "GYD", "HKD", "HNL", "HRK", "HTG", "HUF", "IDR", "ILS", "INR", "IQD", "IRR", "ISK", "JMD", "JOD", "JPY", "KES", "KGS", "KHR", "KMF", "KPW", "KRW", "KWD", "KYD", "KZT", "LAK", "LBP", "LKR", "LRD", "LSL", "LTL", "LYD", "MAD", "MDL", "MGA", "MKD", "MMK", "MNT", "MRU", "MUR", "MVR", "MWK", "MXN", "MYR", "MZN", "NAD", "NGN", "NIO", "NOK", "NPR", "NZD", "OMR", "PAB", "PEN", "PGK", "PHP", "PKR", "PLN", "PYG", "QAR", "RON", "RSD", "RUB", "RWF", "SAR", "SBD", "SCR", "SDG", "SEK", "SGD", "SHP", "SLL", "SOS", "SRD", "SSP", "STD", "SYP", "SZL", "THB", "TJS", "TMT", "TND", "TOP", "TRY", "TTD", "TWD", "TZS", "UAH", "UGX", "USD", "UYU", "UZS", "VEF", "VND", "VUV", "WST", "XAF", "XCD", "XOF", "XPF", "YER", "ZAR", "ZMW", "ZWD" ], "title": "ItAssetsAssetIdAddonsAddonIdAssignPostResponsesContentApplicationJsonSchemaDataActionsStoreOwnAssetAtOwnLocationDetailsServiceCostFeesCurrency", "type": "string" }, "ItAssetsAssetIdAddonsAddonIdAssignPostResponsesContentApplicationJsonSchemaDataActionsStoreOwnAssetAtOwnLocationDetailsServiceCostTokenUsage": { "description": "Add-on token consumption details. Null when billing method is \"CURRENCY\"", "properties": { "addon": { "$ref": "#/components/schemas/ItAssetsAssetIdAddonsAddonIdAssignPostResponsesContentApplicationJsonSchemaDataActionsStoreOwnAssetAtOwnLocationDetailsServiceCostTokenUsageAddon", "description": "The add-on that provides the tokens" }, "cost": { "description": "Number of tokens consumed by the action. Zero when the add-on covers the\nservice without drawing from a token pool", "format": "decimal", "type": "string" }, "tokens_left": { "description": "Number of tokens left in the pool after the action is performed. Null when\nthe add-on covers the service without a token pool", "format": "decimal", "type": [ "string", "null" ] } }, "required": [ "cost", "addon", "tokens_left" ], "title": "ItAssetsAssetIdAddonsAddonIdAssignPostResponsesContentApplicationJsonSchemaDataActionsStoreOwnAssetAtOwnLocationDetailsServiceCostTokenUsage", "type": "object" }, "ItAssetsAssetIdAddonsAddonIdAssignPostResponsesContentApplicationJsonSchemaDataActionsStoreOwnAssetAtOwnLocationDetailsServiceCostTokenUsageAddon": { "description": "The add-on that provides the tokens", "properties": { "id": { "description": "ID of the add-on", "format": "uuid", "type": "string" }, "name": { "description": "Public display name of the add-on", "type": "string" } }, "required": [ "id", "name" ], "title": "ItAssetsAssetIdAddonsAddonIdAssignPostResponsesContentApplicationJsonSchemaDataActionsStoreOwnAssetAtOwnLocationDetailsServiceCostTokenUsageAddon", "type": "object" }, "ItAssetsAssetIdAddonsAddonIdAssignPostResponsesContentApplicationJsonSchemaDataActionsStoreOwnAssetAtOwnLocationDisabledReasonsItems": { "enum": [ "ARCHIVED", "AT_DEEL_WAREHOUSE", "BEING_REPAIRED", "CONSUMABLE", "CONTROLLED_BY_DEEL", "COUNTRY_NOT_SUPPORTED_FOR_HUB", "COUNTRY_NOT_SUPPORTED_FOR_LOCAL", "DEEL_OWNED_ITEM_WITHOUT_RENTAL_CONTRACT", "DESKTOP_STORAGE", "ENDING_CONTRACT", "HUB_IN_SAME_REGION_AS_LOCAL", "INACTIVE", "INVALID_ITEM_LOCATION", "INVALID_ORGANIZATION_STATUS", "INVALID_STATE", "ITEM_CONDITIONS_TO_UNARCHIVE_NOT_MET", "ITEM_NOT_VISIBLE_FOR_ORGANIZATION", "NON_DEVICE", "NOT_AT_WAREHOUSE", "NOT_AVAILABLE_FOR_REUSE", "NOT_A_RENTAL", "NOT_MANAGEABLE_BY_ORGANIZATION", "NOT_WITH_ASSIGNMENT", "NOT_WITH_USER", "NO_ACTIVE_ADDONS", "NO_ACTIVE_STORAGE_CONTRACT", "NO_LOCATION_FOR_STORAGE", "NO_LOGISTICS_FOR_STORAGE", "NO_VALID_ADDONS", "ONGOING_SERVICE", "OWNED_BY_DEEL", "OWNED_BY_ORGANIZATION", "OWNED_BY_PARTNER_ORGANIZATION", "PARTNER_CHILD_CONTRACT", "PENDING_DEVICE_REFRESH", "RENTAL_CONTRACT_AND_USER_REGION_DO_NOT_MATCH", "TEMPORARILY_UNAVAILABLE", "UNKNOWN", "USER_HAS_NO_COUNTRY", "USER_HAS_NO_SEAT", "WAITING_FOR_CLEARANCE", "WITH_LOANER_ASSIGNMENT", "WITH_NON_COLLECTED_ASSIGNMENT", "WITH_NON_DELIVERED_ASSIGNMENT", "WITH_PENDING_ASSIGNMENT", "WRONG_ASSIGNMENT_STATUS", "WRONG_CONTRACT_STATUS", "WRONG_TERMS_AND_CONDITIONS" ], "title": "ItAssetsAssetIdAddonsAddonIdAssignPostResponsesContentApplicationJsonSchemaDataActionsStoreOwnAssetAtOwnLocationDisabledReasonsItems", "type": "string" }, "ItAssetsAssetIdAddonsAddonIdAssignPostResponsesContentApplicationJsonSchemaDataActionsStoreOwnAssetAtOwnLocationStatus": { "description": "Whether the action is currently available for this asset", "enum": [ "DISABLED", "ENABLED", "NOT_APPLICABLE" ], "title": "ItAssetsAssetIdAddonsAddonIdAssignPostResponsesContentApplicationJsonSchemaDataActionsStoreOwnAssetAtOwnLocationStatus", "type": "string" }, "ItAssetsAssetIdAddonsAddonIdAssignPostResponsesContentApplicationJsonSchemaDataActionsStoreRentalAtDeelForLocal": { "description": "Store a Deel-owned rental asset at a Deel local warehouse", "properties": { "details": { "description": "Action-specific context needed to perform the action. Populated for enabled and\ndisabled actions (so callers can see what a successful attempt would look like);\nnull when the action is not applicable to this asset.", "oneOf": [ { "$ref": "#/components/schemas/ItAssetsAssetIdAddonsAddonIdAssignPostResponsesContentApplicationJsonSchemaDataActionsStoreRentalAtDeelForLocalDetails" }, { "type": "null" } ] }, "disabled_reasons": { "description": "Reasons why the action is disabled. Empty when the action is enabled or not applicable", "items": { "$ref": "#/components/schemas/ItAssetsAssetIdAddonsAddonIdAssignPostResponsesContentApplicationJsonSchemaDataActionsStoreRentalAtDeelForLocalDisabledReasonsItems" }, "type": "array" }, "status": { "$ref": "#/components/schemas/ItAssetsAssetIdAddonsAddonIdAssignPostResponsesContentApplicationJsonSchemaDataActionsStoreRentalAtDeelForLocalStatus", "description": "Whether the action is currently available for this asset" } }, "required": [ "status", "details", "disabled_reasons" ], "title": "ItAssetsAssetIdAddonsAddonIdAssignPostResponsesContentApplicationJsonSchemaDataActionsStoreRentalAtDeelForLocal", "type": "object" }, "ItAssetsAssetIdAddonsAddonIdAssignPostResponsesContentApplicationJsonSchemaDataActionsStoreRentalAtDeelForLocalDetails": { "description": "Action-specific context needed to perform the action. Populated for enabled and\ndisabled actions (so callers can see what a successful attempt would look like);\nnull when the action is not applicable to this asset.", "properties": { "activation_cost": { "$ref": "#/components/schemas/ItAssetsAssetIdAddonsAddonIdAssignPostResponsesContentApplicationJsonSchemaDataActionsStoreRentalAtDeelForLocalDetailsActivationCost", "description": "Cost charged to activate local storage" } }, "required": [ "activation_cost" ], "title": "ItAssetsAssetIdAddonsAddonIdAssignPostResponsesContentApplicationJsonSchemaDataActionsStoreRentalAtDeelForLocalDetails", "type": "object" }, "ItAssetsAssetIdAddonsAddonIdAssignPostResponsesContentApplicationJsonSchemaDataActionsStoreRentalAtDeelForLocalDetailsActivationCost": { "description": "Cost charged to activate local storage", "properties": { "billing_method": { "$ref": "#/components/schemas/ItAssetsAssetIdAddonsAddonIdAssignPostResponsesContentApplicationJsonSchemaDataActionsStoreRentalAtDeelForLocalDetailsActivationCostBillingMethod", "description": "How the action is charged. When \"TOKEN\", the fees are covered by an\nadd-on token pool; when \"CURRENCY\", the fees are billed in the currency\nspecified in the \"fees\" field." }, "fees": { "description": "Price charged for the action. Null when billing method is \"TOKEN\"", "oneOf": [ { "$ref": "#/components/schemas/ItAssetsAssetIdAddonsAddonIdAssignPostResponsesContentApplicationJsonSchemaDataActionsStoreRentalAtDeelForLocalDetailsActivationCostFees" }, { "type": "null" } ] }, "token_usage": { "description": "Add-on token consumption details. Null when billing method is \"CURRENCY\"", "oneOf": [ { "$ref": "#/components/schemas/ItAssetsAssetIdAddonsAddonIdAssignPostResponsesContentApplicationJsonSchemaDataActionsStoreRentalAtDeelForLocalDetailsActivationCostTokenUsage" }, { "type": "null" } ] } }, "required": [ "fees", "token_usage", "billing_method" ], "title": "ItAssetsAssetIdAddonsAddonIdAssignPostResponsesContentApplicationJsonSchemaDataActionsStoreRentalAtDeelForLocalDetailsActivationCost", "type": "object" }, "ItAssetsAssetIdAddonsAddonIdAssignPostResponsesContentApplicationJsonSchemaDataActionsStoreRentalAtDeelForLocalDetailsActivationCostBillingMethod": { "description": "How the action is charged. When \"TOKEN\", the fees are covered by an\nadd-on token pool; when \"CURRENCY\", the fees are billed in the currency\nspecified in the \"fees\" field.", "enum": [ "CURRENCY", "TOKEN" ], "title": "ItAssetsAssetIdAddonsAddonIdAssignPostResponsesContentApplicationJsonSchemaDataActionsStoreRentalAtDeelForLocalDetailsActivationCostBillingMethod", "type": "string" }, "ItAssetsAssetIdAddonsAddonIdAssignPostResponsesContentApplicationJsonSchemaDataActionsStoreRentalAtDeelForLocalDetailsActivationCostFees": { "description": "Price charged for the action. Null when billing method is \"TOKEN\"", "properties": { "amount": { "description": "Amount", "format": "decimal", "type": "string" }, "currency": { "$ref": "#/components/schemas/ItAssetsAssetIdAddonsAddonIdAssignPostResponsesContentApplicationJsonSchemaDataActionsStoreRentalAtDeelForLocalDetailsActivationCostFeesCurrency", "description": "Three-letter currency code for the price" } }, "required": [ "amount", "currency" ], "title": "ItAssetsAssetIdAddonsAddonIdAssignPostResponsesContentApplicationJsonSchemaDataActionsStoreRentalAtDeelForLocalDetailsActivationCostFees", "type": "object" }, "ItAssetsAssetIdAddonsAddonIdAssignPostResponsesContentApplicationJsonSchemaDataActionsStoreRentalAtDeelForLocalDetailsActivationCostFeesCurrency": { "description": "Three-letter currency code for the price", "enum": [ "AED", "AFN", "ALL", "AMD", "ANG", "AOA", "ARS", "AUD", "AWG", "AZN", "BAM", "BDT", "BGN", "BHD", "BIF", "BMD", "BOB", "BRL", "BSD", "BTN", "BWP", "BYN", "BZD", "CAD", "CDF", "CHF", "CLP", "CNY", "COP", "CRC", "CUC", "CVE", "CZK", "DJF", "DKK", "DOP", "DZD", "EGP", "ERN", "ETB", "EUR", "FJD", "FKP", "GBP", "GEL", "GHS", "GIP", "GMD", "GNF", "GTQ", "GYD", "HKD", "HNL", "HRK", "HTG", "HUF", "IDR", "ILS", "INR", "IQD", "IRR", "ISK", "JMD", "JOD", "JPY", "KES", "KGS", "KHR", "KMF", "KPW", "KRW", "KWD", "KYD", "KZT", "LAK", "LBP", "LKR", "LRD", "LSL", "LTL", "LYD", "MAD", "MDL", "MGA", "MKD", "MMK", "MNT", "MRU", "MUR", "MVR", "MWK", "MXN", "MYR", "MZN", "NAD", "NGN", "NIO", "NOK", "NPR", "NZD", "OMR", "PAB", "PEN", "PGK", "PHP", "PKR", "PLN", "PYG", "QAR", "RON", "RSD", "RUB", "RWF", "SAR", "SBD", "SCR", "SDG", "SEK", "SGD", "SHP", "SLL", "SOS", "SRD", "SSP", "STD", "SYP", "SZL", "THB", "TJS", "TMT", "TND", "TOP", "TRY", "TTD", "TWD", "TZS", "UAH", "UGX", "USD", "UYU", "UZS", "VEF", "VND", "VUV", "WST", "XAF", "XCD", "XOF", "XPF", "YER", "ZAR", "ZMW", "ZWD" ], "title": "ItAssetsAssetIdAddonsAddonIdAssignPostResponsesContentApplicationJsonSchemaDataActionsStoreRentalAtDeelForLocalDetailsActivationCostFeesCurrency", "type": "string" }, "ItAssetsAssetIdAddonsAddonIdAssignPostResponsesContentApplicationJsonSchemaDataActionsStoreRentalAtDeelForLocalDetailsActivationCostTokenUsage": { "description": "Add-on token consumption details. Null when billing method is \"CURRENCY\"", "properties": { "addon": { "$ref": "#/components/schemas/ItAssetsAssetIdAddonsAddonIdAssignPostResponsesContentApplicationJsonSchemaDataActionsStoreRentalAtDeelForLocalDetailsActivationCostTokenUsageAddon", "description": "The add-on that provides the tokens" }, "cost": { "description": "Number of tokens consumed by the action. Zero when the add-on covers the\nservice without drawing from a token pool", "format": "decimal", "type": "string" }, "tokens_left": { "description": "Number of tokens left in the pool after the action is performed. Null when\nthe add-on covers the service without a token pool", "format": "decimal", "type": [ "string", "null" ] } }, "required": [ "cost", "addon", "tokens_left" ], "title": "ItAssetsAssetIdAddonsAddonIdAssignPostResponsesContentApplicationJsonSchemaDataActionsStoreRentalAtDeelForLocalDetailsActivationCostTokenUsage", "type": "object" }, "ItAssetsAssetIdAddonsAddonIdAssignPostResponsesContentApplicationJsonSchemaDataActionsStoreRentalAtDeelForLocalDetailsActivationCostTokenUsageAddon": { "description": "The add-on that provides the tokens", "properties": { "id": { "description": "ID of the add-on", "format": "uuid", "type": "string" }, "name": { "description": "Public display name of the add-on", "type": "string" } }, "required": [ "id", "name" ], "title": "ItAssetsAssetIdAddonsAddonIdAssignPostResponsesContentApplicationJsonSchemaDataActionsStoreRentalAtDeelForLocalDetailsActivationCostTokenUsageAddon", "type": "object" }, "ItAssetsAssetIdAddonsAddonIdAssignPostResponsesContentApplicationJsonSchemaDataActionsStoreRentalAtDeelForLocalDisabledReasonsItems": { "enum": [ "ARCHIVED", "AT_DEEL_WAREHOUSE", "BEING_REPAIRED", "CONSUMABLE", "CONTROLLED_BY_DEEL", "COUNTRY_NOT_SUPPORTED_FOR_HUB", "COUNTRY_NOT_SUPPORTED_FOR_LOCAL", "DEEL_OWNED_ITEM_WITHOUT_RENTAL_CONTRACT", "DESKTOP_STORAGE", "ENDING_CONTRACT", "HUB_IN_SAME_REGION_AS_LOCAL", "INACTIVE", "INVALID_ITEM_LOCATION", "INVALID_ORGANIZATION_STATUS", "INVALID_STATE", "ITEM_CONDITIONS_TO_UNARCHIVE_NOT_MET", "ITEM_NOT_VISIBLE_FOR_ORGANIZATION", "NON_DEVICE", "NOT_AT_WAREHOUSE", "NOT_AVAILABLE_FOR_REUSE", "NOT_A_RENTAL", "NOT_MANAGEABLE_BY_ORGANIZATION", "NOT_WITH_ASSIGNMENT", "NOT_WITH_USER", "NO_ACTIVE_ADDONS", "NO_ACTIVE_STORAGE_CONTRACT", "NO_LOCATION_FOR_STORAGE", "NO_LOGISTICS_FOR_STORAGE", "NO_VALID_ADDONS", "ONGOING_SERVICE", "OWNED_BY_DEEL", "OWNED_BY_ORGANIZATION", "OWNED_BY_PARTNER_ORGANIZATION", "PARTNER_CHILD_CONTRACT", "PENDING_DEVICE_REFRESH", "RENTAL_CONTRACT_AND_USER_REGION_DO_NOT_MATCH", "TEMPORARILY_UNAVAILABLE", "UNKNOWN", "USER_HAS_NO_COUNTRY", "USER_HAS_NO_SEAT", "WAITING_FOR_CLEARANCE", "WITH_LOANER_ASSIGNMENT", "WITH_NON_COLLECTED_ASSIGNMENT", "WITH_NON_DELIVERED_ASSIGNMENT", "WITH_PENDING_ASSIGNMENT", "WRONG_ASSIGNMENT_STATUS", "WRONG_CONTRACT_STATUS", "WRONG_TERMS_AND_CONDITIONS" ], "title": "ItAssetsAssetIdAddonsAddonIdAssignPostResponsesContentApplicationJsonSchemaDataActionsStoreRentalAtDeelForLocalDisabledReasonsItems", "type": "string" }, "ItAssetsAssetIdAddonsAddonIdAssignPostResponsesContentApplicationJsonSchemaDataActionsStoreRentalAtDeelForLocalStatus": { "description": "Whether the action is currently available for this asset", "enum": [ "DISABLED", "ENABLED", "NOT_APPLICABLE" ], "title": "ItAssetsAssetIdAddonsAddonIdAssignPostResponsesContentApplicationJsonSchemaDataActionsStoreRentalAtDeelForLocalStatus", "type": "string" }, "ItAssetsAssetIdAddonsAddonIdAssignPostResponsesContentApplicationJsonSchemaDataActionsStoreRentalAtDeelForZone1": { "description": "Store a Deel-owned rental asset at a Deel zone-1 warehouse", "properties": { "details": { "description": "Action-specific context needed to perform the action. Populated for enabled and\ndisabled actions (so callers can see what a successful attempt would look like);\nnull when the action is not applicable to this asset.", "oneOf": [ { "$ref": "#/components/schemas/ItAssetsAssetIdAddonsAddonIdAssignPostResponsesContentApplicationJsonSchemaDataActionsStoreRentalAtDeelForZone1Details" }, { "type": "null" } ] }, "disabled_reasons": { "description": "Reasons why the action is disabled. Empty when the action is enabled or not applicable", "items": { "$ref": "#/components/schemas/ItAssetsAssetIdAddonsAddonIdAssignPostResponsesContentApplicationJsonSchemaDataActionsStoreRentalAtDeelForZone1DisabledReasonsItems" }, "type": "array" }, "status": { "$ref": "#/components/schemas/ItAssetsAssetIdAddonsAddonIdAssignPostResponsesContentApplicationJsonSchemaDataActionsStoreRentalAtDeelForZone1Status", "description": "Whether the action is currently available for this asset" } }, "required": [ "status", "details", "disabled_reasons" ], "title": "ItAssetsAssetIdAddonsAddonIdAssignPostResponsesContentApplicationJsonSchemaDataActionsStoreRentalAtDeelForZone1", "type": "object" }, "ItAssetsAssetIdAddonsAddonIdAssignPostResponsesContentApplicationJsonSchemaDataActionsStoreRentalAtDeelForZone1Details": { "description": "Action-specific context needed to perform the action. Populated for enabled and\ndisabled actions (so callers can see what a successful attempt would look like);\nnull when the action is not applicable to this asset.", "properties": { "activation_cost": { "$ref": "#/components/schemas/ItAssetsAssetIdAddonsAddonIdAssignPostResponsesContentApplicationJsonSchemaDataActionsStoreRentalAtDeelForZone1DetailsActivationCost", "description": "Cost charged to activate zone-1 storage" } }, "required": [ "activation_cost" ], "title": "ItAssetsAssetIdAddonsAddonIdAssignPostResponsesContentApplicationJsonSchemaDataActionsStoreRentalAtDeelForZone1Details", "type": "object" }, "ItAssetsAssetIdAddonsAddonIdAssignPostResponsesContentApplicationJsonSchemaDataActionsStoreRentalAtDeelForZone1DetailsActivationCost": { "description": "Cost charged to activate zone-1 storage", "properties": { "billing_method": { "$ref": "#/components/schemas/ItAssetsAssetIdAddonsAddonIdAssignPostResponsesContentApplicationJsonSchemaDataActionsStoreRentalAtDeelForZone1DetailsActivationCostBillingMethod", "description": "How the action is charged. When \"TOKEN\", the fees are covered by an\nadd-on token pool; when \"CURRENCY\", the fees are billed in the currency\nspecified in the \"fees\" field." }, "fees": { "description": "Price charged for the action. Null when billing method is \"TOKEN\"", "oneOf": [ { "$ref": "#/components/schemas/ItAssetsAssetIdAddonsAddonIdAssignPostResponsesContentApplicationJsonSchemaDataActionsStoreRentalAtDeelForZone1DetailsActivationCostFees" }, { "type": "null" } ] }, "token_usage": { "description": "Add-on token consumption details. Null when billing method is \"CURRENCY\"", "oneOf": [ { "$ref": "#/components/schemas/ItAssetsAssetIdAddonsAddonIdAssignPostResponsesContentApplicationJsonSchemaDataActionsStoreRentalAtDeelForZone1DetailsActivationCostTokenUsage" }, { "type": "null" } ] } }, "required": [ "fees", "token_usage", "billing_method" ], "title": "ItAssetsAssetIdAddonsAddonIdAssignPostResponsesContentApplicationJsonSchemaDataActionsStoreRentalAtDeelForZone1DetailsActivationCost", "type": "object" }, "ItAssetsAssetIdAddonsAddonIdAssignPostResponsesContentApplicationJsonSchemaDataActionsStoreRentalAtDeelForZone1DetailsActivationCostBillingMethod": { "description": "How the action is charged. When \"TOKEN\", the fees are covered by an\nadd-on token pool; when \"CURRENCY\", the fees are billed in the currency\nspecified in the \"fees\" field.", "enum": [ "CURRENCY", "TOKEN" ], "title": "ItAssetsAssetIdAddonsAddonIdAssignPostResponsesContentApplicationJsonSchemaDataActionsStoreRentalAtDeelForZone1DetailsActivationCostBillingMethod", "type": "string" }, "ItAssetsAssetIdAddonsAddonIdAssignPostResponsesContentApplicationJsonSchemaDataActionsStoreRentalAtDeelForZone1DetailsActivationCostFees": { "description": "Price charged for the action. Null when billing method is \"TOKEN\"", "properties": { "amount": { "description": "Amount", "format": "decimal", "type": "string" }, "currency": { "$ref": "#/components/schemas/ItAssetsAssetIdAddonsAddonIdAssignPostResponsesContentApplicationJsonSchemaDataActionsStoreRentalAtDeelForZone1DetailsActivationCostFeesCurrency", "description": "Three-letter currency code for the price" } }, "required": [ "amount", "currency" ], "title": "ItAssetsAssetIdAddonsAddonIdAssignPostResponsesContentApplicationJsonSchemaDataActionsStoreRentalAtDeelForZone1DetailsActivationCostFees", "type": "object" }, "ItAssetsAssetIdAddonsAddonIdAssignPostResponsesContentApplicationJsonSchemaDataActionsStoreRentalAtDeelForZone1DetailsActivationCostFeesCurrency": { "description": "Three-letter currency code for the price", "enum": [ "AED", "AFN", "ALL", "AMD", "ANG", "AOA", "ARS", "AUD", "AWG", "AZN", "BAM", "BDT", "BGN", "BHD", "BIF", "BMD", "BOB", "BRL", "BSD", "BTN", "BWP", "BYN", "BZD", "CAD", "CDF", "CHF", "CLP", "CNY", "COP", "CRC", "CUC", "CVE", "CZK", "DJF", "DKK", "DOP", "DZD", "EGP", "ERN", "ETB", "EUR", "FJD", "FKP", "GBP", "GEL", "GHS", "GIP", "GMD", "GNF", "GTQ", "GYD", "HKD", "HNL", "HRK", "HTG", "HUF", "IDR", "ILS", "INR", "IQD", "IRR", "ISK", "JMD", "JOD", "JPY", "KES", "KGS", "KHR", "KMF", "KPW", "KRW", "KWD", "KYD", "KZT", "LAK", "LBP", "LKR", "LRD", "LSL", "LTL", "LYD", "MAD", "MDL", "MGA", "MKD", "MMK", "MNT", "MRU", "MUR", "MVR", "MWK", "MXN", "MYR", "MZN", "NAD", "NGN", "NIO", "NOK", "NPR", "NZD", "OMR", "PAB", "PEN", "PGK", "PHP", "PKR", "PLN", "PYG", "QAR", "RON", "RSD", "RUB", "RWF", "SAR", "SBD", "SCR", "SDG", "SEK", "SGD", "SHP", "SLL", "SOS", "SRD", "SSP", "STD", "SYP", "SZL", "THB", "TJS", "TMT", "TND", "TOP", "TRY", "TTD", "TWD", "TZS", "UAH", "UGX", "USD", "UYU", "UZS", "VEF", "VND", "VUV", "WST", "XAF", "XCD", "XOF", "XPF", "YER", "ZAR", "ZMW", "ZWD" ], "title": "ItAssetsAssetIdAddonsAddonIdAssignPostResponsesContentApplicationJsonSchemaDataActionsStoreRentalAtDeelForZone1DetailsActivationCostFeesCurrency", "type": "string" }, "ItAssetsAssetIdAddonsAddonIdAssignPostResponsesContentApplicationJsonSchemaDataActionsStoreRentalAtDeelForZone1DetailsActivationCostTokenUsage": { "description": "Add-on token consumption details. Null when billing method is \"CURRENCY\"", "properties": { "addon": { "$ref": "#/components/schemas/ItAssetsAssetIdAddonsAddonIdAssignPostResponsesContentApplicationJsonSchemaDataActionsStoreRentalAtDeelForZone1DetailsActivationCostTokenUsageAddon", "description": "The add-on that provides the tokens" }, "cost": { "description": "Number of tokens consumed by the action. Zero when the add-on covers the\nservice without drawing from a token pool", "format": "decimal", "type": "string" }, "tokens_left": { "description": "Number of tokens left in the pool after the action is performed. Null when\nthe add-on covers the service without a token pool", "format": "decimal", "type": [ "string", "null" ] } }, "required": [ "cost", "addon", "tokens_left" ], "title": "ItAssetsAssetIdAddonsAddonIdAssignPostResponsesContentApplicationJsonSchemaDataActionsStoreRentalAtDeelForZone1DetailsActivationCostTokenUsage", "type": "object" }, "ItAssetsAssetIdAddonsAddonIdAssignPostResponsesContentApplicationJsonSchemaDataActionsStoreRentalAtDeelForZone1DetailsActivationCostTokenUsageAddon": { "description": "The add-on that provides the tokens", "properties": { "id": { "description": "ID of the add-on", "format": "uuid", "type": "string" }, "name": { "description": "Public display name of the add-on", "type": "string" } }, "required": [ "id", "name" ], "title": "ItAssetsAssetIdAddonsAddonIdAssignPostResponsesContentApplicationJsonSchemaDataActionsStoreRentalAtDeelForZone1DetailsActivationCostTokenUsageAddon", "type": "object" }, "ItAssetsAssetIdAddonsAddonIdAssignPostResponsesContentApplicationJsonSchemaDataActionsStoreRentalAtDeelForZone1DisabledReasonsItems": { "enum": [ "ARCHIVED", "AT_DEEL_WAREHOUSE", "BEING_REPAIRED", "CONSUMABLE", "CONTROLLED_BY_DEEL", "COUNTRY_NOT_SUPPORTED_FOR_HUB", "COUNTRY_NOT_SUPPORTED_FOR_LOCAL", "DEEL_OWNED_ITEM_WITHOUT_RENTAL_CONTRACT", "DESKTOP_STORAGE", "ENDING_CONTRACT", "HUB_IN_SAME_REGION_AS_LOCAL", "INACTIVE", "INVALID_ITEM_LOCATION", "INVALID_ORGANIZATION_STATUS", "INVALID_STATE", "ITEM_CONDITIONS_TO_UNARCHIVE_NOT_MET", "ITEM_NOT_VISIBLE_FOR_ORGANIZATION", "NON_DEVICE", "NOT_AT_WAREHOUSE", "NOT_AVAILABLE_FOR_REUSE", "NOT_A_RENTAL", "NOT_MANAGEABLE_BY_ORGANIZATION", "NOT_WITH_ASSIGNMENT", "NOT_WITH_USER", "NO_ACTIVE_ADDONS", "NO_ACTIVE_STORAGE_CONTRACT", "NO_LOCATION_FOR_STORAGE", "NO_LOGISTICS_FOR_STORAGE", "NO_VALID_ADDONS", "ONGOING_SERVICE", "OWNED_BY_DEEL", "OWNED_BY_ORGANIZATION", "OWNED_BY_PARTNER_ORGANIZATION", "PARTNER_CHILD_CONTRACT", "PENDING_DEVICE_REFRESH", "RENTAL_CONTRACT_AND_USER_REGION_DO_NOT_MATCH", "TEMPORARILY_UNAVAILABLE", "UNKNOWN", "USER_HAS_NO_COUNTRY", "USER_HAS_NO_SEAT", "WAITING_FOR_CLEARANCE", "WITH_LOANER_ASSIGNMENT", "WITH_NON_COLLECTED_ASSIGNMENT", "WITH_NON_DELIVERED_ASSIGNMENT", "WITH_PENDING_ASSIGNMENT", "WRONG_ASSIGNMENT_STATUS", "WRONG_CONTRACT_STATUS", "WRONG_TERMS_AND_CONDITIONS" ], "title": "ItAssetsAssetIdAddonsAddonIdAssignPostResponsesContentApplicationJsonSchemaDataActionsStoreRentalAtDeelForZone1DisabledReasonsItems", "type": "string" }, "ItAssetsAssetIdAddonsAddonIdAssignPostResponsesContentApplicationJsonSchemaDataActionsStoreRentalAtDeelForZone1Status": { "description": "Whether the action is currently available for this asset", "enum": [ "DISABLED", "ENABLED", "NOT_APPLICABLE" ], "title": "ItAssetsAssetIdAddonsAddonIdAssignPostResponsesContentApplicationJsonSchemaDataActionsStoreRentalAtDeelForZone1Status", "type": "string" }, "ItAssetsAssetIdAddonsAddonIdAssignPostResponsesContentApplicationJsonSchemaDataActionsTransferOwnAsset": { "description": "Transfer an organization-owned asset to another user", "properties": { "details": { "description": "Action-specific context needed to perform the action. Populated for enabled and\ndisabled actions (so callers can see what a successful attempt would look like);\nnull when the action is not applicable to this asset.", "oneOf": [ { "$ref": "#/components/schemas/ItAssetsAssetIdAddonsAddonIdAssignPostResponsesContentApplicationJsonSchemaDataActionsTransferOwnAssetDetails" }, { "type": "null" } ] }, "disabled_reasons": { "description": "Reasons why the action is disabled. Empty when the action is enabled or not applicable", "items": { "$ref": "#/components/schemas/ItAssetsAssetIdAddonsAddonIdAssignPostResponsesContentApplicationJsonSchemaDataActionsTransferOwnAssetDisabledReasonsItems" }, "type": "array" }, "status": { "$ref": "#/components/schemas/ItAssetsAssetIdAddonsAddonIdAssignPostResponsesContentApplicationJsonSchemaDataActionsTransferOwnAssetStatus", "description": "Whether the action is currently available for this asset" } }, "required": [ "status", "details", "disabled_reasons" ], "title": "ItAssetsAssetIdAddonsAddonIdAssignPostResponsesContentApplicationJsonSchemaDataActionsTransferOwnAsset", "type": "object" }, "ItAssetsAssetIdAddonsAddonIdAssignPostResponsesContentApplicationJsonSchemaDataActionsTransferOwnAssetDetails": { "description": "Action-specific context needed to perform the action. Populated for enabled and\ndisabled actions (so callers can see what a successful attempt would look like);\nnull when the action is not applicable to this asset.", "properties": { "eligible_countries": { "description": "Countries the asset can be transferred to", "items": { "$ref": "#/components/schemas/ItAssetsAssetIdAddonsAddonIdAssignPostResponsesContentApplicationJsonSchemaDataActionsTransferOwnAssetDetailsEligibleCountriesItems" }, "type": "array" }, "transfer_cost": { "$ref": "#/components/schemas/ItAssetsAssetIdAddonsAddonIdAssignPostResponsesContentApplicationJsonSchemaDataActionsTransferOwnAssetDetailsTransferCost", "description": "Cost charged for the transfer service" } }, "required": [ "transfer_cost", "eligible_countries" ], "title": "ItAssetsAssetIdAddonsAddonIdAssignPostResponsesContentApplicationJsonSchemaDataActionsTransferOwnAssetDetails", "type": "object" }, "ItAssetsAssetIdAddonsAddonIdAssignPostResponsesContentApplicationJsonSchemaDataActionsTransferOwnAssetDetailsEligibleCountriesItems": { "enum": [ "AD", "AE", "AF", "AG", "AI", "AL", "AM", "AN", "AO", "AQ", "AR", "AS", "AT", "AU", "AW", "AX", "AZ", "BA", "BB", "BD", "BE", "BF", "BG", "BH", "BI", "BJ", "BL", "BM", "BN", "BO", "BQ", "BR", "BS", "BT", "BV", "BW", "BY", "BZ", "CA", "CC", "CD", "CF", "CG", "CH", "CI", "CK", "CL", "CM", "CN", "CO", "CR", "CU", "CV", "CW", "CX", "CY", "CZ", "DE", "DJ", "DK", "DM", "DO", "DZ", "EC", "EE", "EG", "EH", "ER", "ES", "ET", "FI", "FJ", "FK", "FM", "FO", "FR", "GA", "GB", "GD", "GE", "GF", "GG", "GH", "GI", "GL", "GM", "GN", "GP", "GQ", "GR", "GS", "GT", "GU", "GW", "GY", "HK", "HM", "HN", "HR", "HT", "HU", "IC", "ID", "IE", "IL", "IM", "IN", "IO", "IQ", "IR", "IS", "IT", "JE", "JM", "JO", "JP", "KE", "KG", "KH", "KI", "KM", "KN", "KP", "KR", "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", "XK", "YE", "YT", "ZA", "ZM", "ZW" ], "title": "ItAssetsAssetIdAddonsAddonIdAssignPostResponsesContentApplicationJsonSchemaDataActionsTransferOwnAssetDetailsEligibleCountriesItems", "type": "string" }, "ItAssetsAssetIdAddonsAddonIdAssignPostResponsesContentApplicationJsonSchemaDataActionsTransferOwnAssetDetailsTransferCost": { "description": "Cost charged for the transfer service", "properties": { "billing_method": { "$ref": "#/components/schemas/ItAssetsAssetIdAddonsAddonIdAssignPostResponsesContentApplicationJsonSchemaDataActionsTransferOwnAssetDetailsTransferCostBillingMethod", "description": "How the action is charged. When \"TOKEN\", the fees are covered by an\nadd-on token pool; when \"CURRENCY\", the fees are billed in the currency\nspecified in the \"fees\" field." }, "fees": { "description": "Price charged for the action. Null when billing method is \"TOKEN\"", "oneOf": [ { "$ref": "#/components/schemas/ItAssetsAssetIdAddonsAddonIdAssignPostResponsesContentApplicationJsonSchemaDataActionsTransferOwnAssetDetailsTransferCostFees" }, { "type": "null" } ] }, "token_usage": { "description": "Add-on token consumption details. Null when billing method is \"CURRENCY\"", "oneOf": [ { "$ref": "#/components/schemas/ItAssetsAssetIdAddonsAddonIdAssignPostResponsesContentApplicationJsonSchemaDataActionsTransferOwnAssetDetailsTransferCostTokenUsage" }, { "type": "null" } ] } }, "required": [ "fees", "token_usage", "billing_method" ], "title": "ItAssetsAssetIdAddonsAddonIdAssignPostResponsesContentApplicationJsonSchemaDataActionsTransferOwnAssetDetailsTransferCost", "type": "object" }, "ItAssetsAssetIdAddonsAddonIdAssignPostResponsesContentApplicationJsonSchemaDataActionsTransferOwnAssetDetailsTransferCostBillingMethod": { "description": "How the action is charged. When \"TOKEN\", the fees are covered by an\nadd-on token pool; when \"CURRENCY\", the fees are billed in the currency\nspecified in the \"fees\" field.", "enum": [ "CURRENCY", "TOKEN" ], "title": "ItAssetsAssetIdAddonsAddonIdAssignPostResponsesContentApplicationJsonSchemaDataActionsTransferOwnAssetDetailsTransferCostBillingMethod", "type": "string" }, "ItAssetsAssetIdAddonsAddonIdAssignPostResponsesContentApplicationJsonSchemaDataActionsTransferOwnAssetDetailsTransferCostFees": { "description": "Price charged for the action. Null when billing method is \"TOKEN\"", "properties": { "amount": { "description": "Amount", "format": "decimal", "type": "string" }, "currency": { "$ref": "#/components/schemas/ItAssetsAssetIdAddonsAddonIdAssignPostResponsesContentApplicationJsonSchemaDataActionsTransferOwnAssetDetailsTransferCostFeesCurrency", "description": "Three-letter currency code for the price" } }, "required": [ "amount", "currency" ], "title": "ItAssetsAssetIdAddonsAddonIdAssignPostResponsesContentApplicationJsonSchemaDataActionsTransferOwnAssetDetailsTransferCostFees", "type": "object" }, "ItAssetsAssetIdAddonsAddonIdAssignPostResponsesContentApplicationJsonSchemaDataActionsTransferOwnAssetDetailsTransferCostFeesCurrency": { "description": "Three-letter currency code for the price", "enum": [ "AED", "AFN", "ALL", "AMD", "ANG", "AOA", "ARS", "AUD", "AWG", "AZN", "BAM", "BDT", "BGN", "BHD", "BIF", "BMD", "BOB", "BRL", "BSD", "BTN", "BWP", "BYN", "BZD", "CAD", "CDF", "CHF", "CLP", "CNY", "COP", "CRC", "CUC", "CVE", "CZK", "DJF", "DKK", "DOP", "DZD", "EGP", "ERN", "ETB", "EUR", "FJD", "FKP", "GBP", "GEL", "GHS", "GIP", "GMD", "GNF", "GTQ", "GYD", "HKD", "HNL", "HRK", "HTG", "HUF", "IDR", "ILS", "INR", "IQD", "IRR", "ISK", "JMD", "JOD", "JPY", "KES", "KGS", "KHR", "KMF", "KPW", "KRW", "KWD", "KYD", "KZT", "LAK", "LBP", "LKR", "LRD", "LSL", "LTL", "LYD", "MAD", "MDL", "MGA", "MKD", "MMK", "MNT", "MRU", "MUR", "MVR", "MWK", "MXN", "MYR", "MZN", "NAD", "NGN", "NIO", "NOK", "NPR", "NZD", "OMR", "PAB", "PEN", "PGK", "PHP", "PKR", "PLN", "PYG", "QAR", "RON", "RSD", "RUB", "RWF", "SAR", "SBD", "SCR", "SDG", "SEK", "SGD", "SHP", "SLL", "SOS", "SRD", "SSP", "STD", "SYP", "SZL", "THB", "TJS", "TMT", "TND", "TOP", "TRY", "TTD", "TWD", "TZS", "UAH", "UGX", "USD", "UYU", "UZS", "VEF", "VND", "VUV", "WST", "XAF", "XCD", "XOF", "XPF", "YER", "ZAR", "ZMW", "ZWD" ], "title": "ItAssetsAssetIdAddonsAddonIdAssignPostResponsesContentApplicationJsonSchemaDataActionsTransferOwnAssetDetailsTransferCostFeesCurrency", "type": "string" }, "ItAssetsAssetIdAddonsAddonIdAssignPostResponsesContentApplicationJsonSchemaDataActionsTransferOwnAssetDetailsTransferCostTokenUsage": { "description": "Add-on token consumption details. Null when billing method is \"CURRENCY\"", "properties": { "addon": { "$ref": "#/components/schemas/ItAssetsAssetIdAddonsAddonIdAssignPostResponsesContentApplicationJsonSchemaDataActionsTransferOwnAssetDetailsTransferCostTokenUsageAddon", "description": "The add-on that provides the tokens" }, "cost": { "description": "Number of tokens consumed by the action. Zero when the add-on covers the\nservice without drawing from a token pool", "format": "decimal", "type": "string" }, "tokens_left": { "description": "Number of tokens left in the pool after the action is performed. Null when\nthe add-on covers the service without a token pool", "format": "decimal", "type": [ "string", "null" ] } }, "required": [ "cost", "addon", "tokens_left" ], "title": "ItAssetsAssetIdAddonsAddonIdAssignPostResponsesContentApplicationJsonSchemaDataActionsTransferOwnAssetDetailsTransferCostTokenUsage", "type": "object" }, "ItAssetsAssetIdAddonsAddonIdAssignPostResponsesContentApplicationJsonSchemaDataActionsTransferOwnAssetDetailsTransferCostTokenUsageAddon": { "description": "The add-on that provides the tokens", "properties": { "id": { "description": "ID of the add-on", "format": "uuid", "type": "string" }, "name": { "description": "Public display name of the add-on", "type": "string" } }, "required": [ "id", "name" ], "title": "ItAssetsAssetIdAddonsAddonIdAssignPostResponsesContentApplicationJsonSchemaDataActionsTransferOwnAssetDetailsTransferCostTokenUsageAddon", "type": "object" }, "ItAssetsAssetIdAddonsAddonIdAssignPostResponsesContentApplicationJsonSchemaDataActionsTransferOwnAssetDisabledReasonsItems": { "enum": [ "ARCHIVED", "AT_DEEL_WAREHOUSE", "BEING_REPAIRED", "CONSUMABLE", "CONTROLLED_BY_DEEL", "COUNTRY_NOT_SUPPORTED_FOR_HUB", "COUNTRY_NOT_SUPPORTED_FOR_LOCAL", "DEEL_OWNED_ITEM_WITHOUT_RENTAL_CONTRACT", "DESKTOP_STORAGE", "ENDING_CONTRACT", "HUB_IN_SAME_REGION_AS_LOCAL", "INACTIVE", "INVALID_ITEM_LOCATION", "INVALID_ORGANIZATION_STATUS", "INVALID_STATE", "ITEM_CONDITIONS_TO_UNARCHIVE_NOT_MET", "ITEM_NOT_VISIBLE_FOR_ORGANIZATION", "NON_DEVICE", "NOT_AT_WAREHOUSE", "NOT_AVAILABLE_FOR_REUSE", "NOT_A_RENTAL", "NOT_MANAGEABLE_BY_ORGANIZATION", "NOT_WITH_ASSIGNMENT", "NOT_WITH_USER", "NO_ACTIVE_ADDONS", "NO_ACTIVE_STORAGE_CONTRACT", "NO_LOCATION_FOR_STORAGE", "NO_LOGISTICS_FOR_STORAGE", "NO_VALID_ADDONS", "ONGOING_SERVICE", "OWNED_BY_DEEL", "OWNED_BY_ORGANIZATION", "OWNED_BY_PARTNER_ORGANIZATION", "PARTNER_CHILD_CONTRACT", "PENDING_DEVICE_REFRESH", "RENTAL_CONTRACT_AND_USER_REGION_DO_NOT_MATCH", "TEMPORARILY_UNAVAILABLE", "UNKNOWN", "USER_HAS_NO_COUNTRY", "USER_HAS_NO_SEAT", "WAITING_FOR_CLEARANCE", "WITH_LOANER_ASSIGNMENT", "WITH_NON_COLLECTED_ASSIGNMENT", "WITH_NON_DELIVERED_ASSIGNMENT", "WITH_PENDING_ASSIGNMENT", "WRONG_ASSIGNMENT_STATUS", "WRONG_CONTRACT_STATUS", "WRONG_TERMS_AND_CONDITIONS" ], "title": "ItAssetsAssetIdAddonsAddonIdAssignPostResponsesContentApplicationJsonSchemaDataActionsTransferOwnAssetDisabledReasonsItems", "type": "string" }, "ItAssetsAssetIdAddonsAddonIdAssignPostResponsesContentApplicationJsonSchemaDataActionsTransferOwnAssetStatus": { "description": "Whether the action is currently available for this asset", "enum": [ "DISABLED", "ENABLED", "NOT_APPLICABLE" ], "title": "ItAssetsAssetIdAddonsAddonIdAssignPostResponsesContentApplicationJsonSchemaDataActionsTransferOwnAssetStatus", "type": "string" }, "ItAssetsAssetIdAddonsAddonIdAssignPostResponsesContentApplicationJsonSchemaDataActionsTransferRental": { "description": "Transfer a Deel-owned rental asset to another user", "properties": { "details": { "description": "Action-specific context needed to perform the action. Populated for enabled and\ndisabled actions (so callers can see what a successful attempt would look like);\nnull when the action is not applicable to this asset.", "oneOf": [ { "$ref": "#/components/schemas/ItAssetsAssetIdAddonsAddonIdAssignPostResponsesContentApplicationJsonSchemaDataActionsTransferRentalDetails" }, { "type": "null" } ] }, "disabled_reasons": { "description": "Reasons why the action is disabled. Empty when the action is enabled or not applicable", "items": { "$ref": "#/components/schemas/ItAssetsAssetIdAddonsAddonIdAssignPostResponsesContentApplicationJsonSchemaDataActionsTransferRentalDisabledReasonsItems" }, "type": "array" }, "status": { "$ref": "#/components/schemas/ItAssetsAssetIdAddonsAddonIdAssignPostResponsesContentApplicationJsonSchemaDataActionsTransferRentalStatus", "description": "Whether the action is currently available for this asset" } }, "required": [ "status", "details", "disabled_reasons" ], "title": "ItAssetsAssetIdAddonsAddonIdAssignPostResponsesContentApplicationJsonSchemaDataActionsTransferRental", "type": "object" }, "ItAssetsAssetIdAddonsAddonIdAssignPostResponsesContentApplicationJsonSchemaDataActionsTransferRentalDetails": { "description": "Action-specific context needed to perform the action. Populated for enabled and\ndisabled actions (so callers can see what a successful attempt would look like);\nnull when the action is not applicable to this asset.", "properties": { "eligible_countries": { "description": "Countries the asset can be transferred to", "items": { "$ref": "#/components/schemas/ItAssetsAssetIdAddonsAddonIdAssignPostResponsesContentApplicationJsonSchemaDataActionsTransferRentalDetailsEligibleCountriesItems" }, "type": "array" }, "transfer_cost": { "$ref": "#/components/schemas/ItAssetsAssetIdAddonsAddonIdAssignPostResponsesContentApplicationJsonSchemaDataActionsTransferRentalDetailsTransferCost", "description": "Cost charged for the transfer service" } }, "required": [ "transfer_cost", "eligible_countries" ], "title": "ItAssetsAssetIdAddonsAddonIdAssignPostResponsesContentApplicationJsonSchemaDataActionsTransferRentalDetails", "type": "object" }, "ItAssetsAssetIdAddonsAddonIdAssignPostResponsesContentApplicationJsonSchemaDataActionsTransferRentalDetailsEligibleCountriesItems": { "enum": [ "AD", "AE", "AF", "AG", "AI", "AL", "AM", "AN", "AO", "AQ", "AR", "AS", "AT", "AU", "AW", "AX", "AZ", "BA", "BB", "BD", "BE", "BF", "BG", "BH", "BI", "BJ", "BL", "BM", "BN", "BO", "BQ", "BR", "BS", "BT", "BV", "BW", "BY", "BZ", "CA", "CC", "CD", "CF", "CG", "CH", "CI", "CK", "CL", "CM", "CN", "CO", "CR", "CU", "CV", "CW", "CX", "CY", "CZ", "DE", "DJ", "DK", "DM", "DO", "DZ", "EC", "EE", "EG", "EH", "ER", "ES", "ET", "FI", "FJ", "FK", "FM", "FO", "FR", "GA", "GB", "GD", "GE", "GF", "GG", "GH", "GI", "GL", "GM", "GN", "GP", "GQ", "GR", "GS", "GT", "GU", "GW", "GY", "HK", "HM", "HN", "HR", "HT", "HU", "IC", "ID", "IE", "IL", "IM", "IN", "IO", "IQ", "IR", "IS", "IT", "JE", "JM", "JO", "JP", "KE", "KG", "KH", "KI", "KM", "KN", "KP", "KR", "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", "XK", "YE", "YT", "ZA", "ZM", "ZW" ], "title": "ItAssetsAssetIdAddonsAddonIdAssignPostResponsesContentApplicationJsonSchemaDataActionsTransferRentalDetailsEligibleCountriesItems", "type": "string" }, "ItAssetsAssetIdAddonsAddonIdAssignPostResponsesContentApplicationJsonSchemaDataActionsTransferRentalDetailsTransferCost": { "description": "Cost charged for the transfer service", "properties": { "billing_method": { "$ref": "#/components/schemas/ItAssetsAssetIdAddonsAddonIdAssignPostResponsesContentApplicationJsonSchemaDataActionsTransferRentalDetailsTransferCostBillingMethod", "description": "How the action is charged. When \"TOKEN\", the fees are covered by an\nadd-on token pool; when \"CURRENCY\", the fees are billed in the currency\nspecified in the \"fees\" field." }, "fees": { "description": "Price charged for the action. Null when billing method is \"TOKEN\"", "oneOf": [ { "$ref": "#/components/schemas/ItAssetsAssetIdAddonsAddonIdAssignPostResponsesContentApplicationJsonSchemaDataActionsTransferRentalDetailsTransferCostFees" }, { "type": "null" } ] }, "token_usage": { "description": "Add-on token consumption details. Null when billing method is \"CURRENCY\"", "oneOf": [ { "$ref": "#/components/schemas/ItAssetsAssetIdAddonsAddonIdAssignPostResponsesContentApplicationJsonSchemaDataActionsTransferRentalDetailsTransferCostTokenUsage" }, { "type": "null" } ] } }, "required": [ "fees", "token_usage", "billing_method" ], "title": "ItAssetsAssetIdAddonsAddonIdAssignPostResponsesContentApplicationJsonSchemaDataActionsTransferRentalDetailsTransferCost", "type": "object" }, "ItAssetsAssetIdAddonsAddonIdAssignPostResponsesContentApplicationJsonSchemaDataActionsTransferRentalDetailsTransferCostBillingMethod": { "description": "How the action is charged. When \"TOKEN\", the fees are covered by an\nadd-on token pool; when \"CURRENCY\", the fees are billed in the currency\nspecified in the \"fees\" field.", "enum": [ "CURRENCY", "TOKEN" ], "title": "ItAssetsAssetIdAddonsAddonIdAssignPostResponsesContentApplicationJsonSchemaDataActionsTransferRentalDetailsTransferCostBillingMethod", "type": "string" }, "ItAssetsAssetIdAddonsAddonIdAssignPostResponsesContentApplicationJsonSchemaDataActionsTransferRentalDetailsTransferCostFees": { "description": "Price charged for the action. Null when billing method is \"TOKEN\"", "properties": { "amount": { "description": "Amount", "format": "decimal", "type": "string" }, "currency": { "$ref": "#/components/schemas/ItAssetsAssetIdAddonsAddonIdAssignPostResponsesContentApplicationJsonSchemaDataActionsTransferRentalDetailsTransferCostFeesCurrency", "description": "Three-letter currency code for the price" } }, "required": [ "amount", "currency" ], "title": "ItAssetsAssetIdAddonsAddonIdAssignPostResponsesContentApplicationJsonSchemaDataActionsTransferRentalDetailsTransferCostFees", "type": "object" }, "ItAssetsAssetIdAddonsAddonIdAssignPostResponsesContentApplicationJsonSchemaDataActionsTransferRentalDetailsTransferCostFeesCurrency": { "description": "Three-letter currency code for the price", "enum": [ "AED", "AFN", "ALL", "AMD", "ANG", "AOA", "ARS", "AUD", "AWG", "AZN", "BAM", "BDT", "BGN", "BHD", "BIF", "BMD", "BOB", "BRL", "BSD", "BTN", "BWP", "BYN", "BZD", "CAD", "CDF", "CHF", "CLP", "CNY", "COP", "CRC", "CUC", "CVE", "CZK", "DJF", "DKK", "DOP", "DZD", "EGP", "ERN", "ETB", "EUR", "FJD", "FKP", "GBP", "GEL", "GHS", "GIP", "GMD", "GNF", "GTQ", "GYD", "HKD", "HNL", "HRK", "HTG", "HUF", "IDR", "ILS", "INR", "IQD", "IRR", "ISK", "JMD", "JOD", "JPY", "KES", "KGS", "KHR", "KMF", "KPW", "KRW", "KWD", "KYD", "KZT", "LAK", "LBP", "LKR", "LRD", "LSL", "LTL", "LYD", "MAD", "MDL", "MGA", "MKD", "MMK", "MNT", "MRU", "MUR", "MVR", "MWK", "MXN", "MYR", "MZN", "NAD", "NGN", "NIO", "NOK", "NPR", "NZD", "OMR", "PAB", "PEN", "PGK", "PHP", "PKR", "PLN", "PYG", "QAR", "RON", "RSD", "RUB", "RWF", "SAR", "SBD", "SCR", "SDG", "SEK", "SGD", "SHP", "SLL", "SOS", "SRD", "SSP", "STD", "SYP", "SZL", "THB", "TJS", "TMT", "TND", "TOP", "TRY", "TTD", "TWD", "TZS", "UAH", "UGX", "USD", "UYU", "UZS", "VEF", "VND", "VUV", "WST", "XAF", "XCD", "XOF", "XPF", "YER", "ZAR", "ZMW", "ZWD" ], "title": "ItAssetsAssetIdAddonsAddonIdAssignPostResponsesContentApplicationJsonSchemaDataActionsTransferRentalDetailsTransferCostFeesCurrency", "type": "string" }, "ItAssetsAssetIdAddonsAddonIdAssignPostResponsesContentApplicationJsonSchemaDataActionsTransferRentalDetailsTransferCostTokenUsage": { "description": "Add-on token consumption details. Null when billing method is \"CURRENCY\"", "properties": { "addon": { "$ref": "#/components/schemas/ItAssetsAssetIdAddonsAddonIdAssignPostResponsesContentApplicationJsonSchemaDataActionsTransferRentalDetailsTransferCostTokenUsageAddon", "description": "The add-on that provides the tokens" }, "cost": { "description": "Number of tokens consumed by the action. Zero when the add-on covers the\nservice without drawing from a token pool", "format": "decimal", "type": "string" }, "tokens_left": { "description": "Number of tokens left in the pool after the action is performed. Null when\nthe add-on covers the service without a token pool", "format": "decimal", "type": [ "string", "null" ] } }, "required": [ "cost", "addon", "tokens_left" ], "title": "ItAssetsAssetIdAddonsAddonIdAssignPostResponsesContentApplicationJsonSchemaDataActionsTransferRentalDetailsTransferCostTokenUsage", "type": "object" }, "ItAssetsAssetIdAddonsAddonIdAssignPostResponsesContentApplicationJsonSchemaDataActionsTransferRentalDetailsTransferCostTokenUsageAddon": { "description": "The add-on that provides the tokens", "properties": { "id": { "description": "ID of the add-on", "format": "uuid", "type": "string" }, "name": { "description": "Public display name of the add-on", "type": "string" } }, "required": [ "id", "name" ], "title": "ItAssetsAssetIdAddonsAddonIdAssignPostResponsesContentApplicationJsonSchemaDataActionsTransferRentalDetailsTransferCostTokenUsageAddon", "type": "object" }, "ItAssetsAssetIdAddonsAddonIdAssignPostResponsesContentApplicationJsonSchemaDataActionsTransferRentalDisabledReasonsItems": { "enum": [ "ARCHIVED", "AT_DEEL_WAREHOUSE", "BEING_REPAIRED", "CONSUMABLE", "CONTROLLED_BY_DEEL", "COUNTRY_NOT_SUPPORTED_FOR_HUB", "COUNTRY_NOT_SUPPORTED_FOR_LOCAL", "DEEL_OWNED_ITEM_WITHOUT_RENTAL_CONTRACT", "DESKTOP_STORAGE", "ENDING_CONTRACT", "HUB_IN_SAME_REGION_AS_LOCAL", "INACTIVE", "INVALID_ITEM_LOCATION", "INVALID_ORGANIZATION_STATUS", "INVALID_STATE", "ITEM_CONDITIONS_TO_UNARCHIVE_NOT_MET", "ITEM_NOT_VISIBLE_FOR_ORGANIZATION", "NON_DEVICE", "NOT_AT_WAREHOUSE", "NOT_AVAILABLE_FOR_REUSE", "NOT_A_RENTAL", "NOT_MANAGEABLE_BY_ORGANIZATION", "NOT_WITH_ASSIGNMENT", "NOT_WITH_USER", "NO_ACTIVE_ADDONS", "NO_ACTIVE_STORAGE_CONTRACT", "NO_LOCATION_FOR_STORAGE", "NO_LOGISTICS_FOR_STORAGE", "NO_VALID_ADDONS", "ONGOING_SERVICE", "OWNED_BY_DEEL", "OWNED_BY_ORGANIZATION", "OWNED_BY_PARTNER_ORGANIZATION", "PARTNER_CHILD_CONTRACT", "PENDING_DEVICE_REFRESH", "RENTAL_CONTRACT_AND_USER_REGION_DO_NOT_MATCH", "TEMPORARILY_UNAVAILABLE", "UNKNOWN", "USER_HAS_NO_COUNTRY", "USER_HAS_NO_SEAT", "WAITING_FOR_CLEARANCE", "WITH_LOANER_ASSIGNMENT", "WITH_NON_COLLECTED_ASSIGNMENT", "WITH_NON_DELIVERED_ASSIGNMENT", "WITH_PENDING_ASSIGNMENT", "WRONG_ASSIGNMENT_STATUS", "WRONG_CONTRACT_STATUS", "WRONG_TERMS_AND_CONDITIONS" ], "title": "ItAssetsAssetIdAddonsAddonIdAssignPostResponsesContentApplicationJsonSchemaDataActionsTransferRentalDisabledReasonsItems", "type": "string" }, "ItAssetsAssetIdAddonsAddonIdAssignPostResponsesContentApplicationJsonSchemaDataActionsTransferRentalStatus": { "description": "Whether the action is currently available for this asset", "enum": [ "DISABLED", "ENABLED", "NOT_APPLICABLE" ], "title": "ItAssetsAssetIdAddonsAddonIdAssignPostResponsesContentApplicationJsonSchemaDataActionsTransferRentalStatus", "type": "string" }, "ItAssetsAssetIdAddonsAddonIdAssignPostResponsesContentApplicationJsonSchemaDataActionsUnarchiveOwnAsset": { "description": "Unarchive a previously archived organization-owned asset", "properties": { "disabled_reasons": { "description": "Reasons why the action is disabled. Empty when the action is enabled or not applicable", "items": { "$ref": "#/components/schemas/ItAssetsAssetIdAddonsAddonIdAssignPostResponsesContentApplicationJsonSchemaDataActionsUnarchiveOwnAssetDisabledReasonsItems" }, "type": "array" }, "status": { "$ref": "#/components/schemas/ItAssetsAssetIdAddonsAddonIdAssignPostResponsesContentApplicationJsonSchemaDataActionsUnarchiveOwnAssetStatus", "description": "Whether the action is currently available for this asset" } }, "required": [ "status", "disabled_reasons" ], "title": "ItAssetsAssetIdAddonsAddonIdAssignPostResponsesContentApplicationJsonSchemaDataActionsUnarchiveOwnAsset", "type": "object" }, "ItAssetsAssetIdAddonsAddonIdAssignPostResponsesContentApplicationJsonSchemaDataActionsUnarchiveOwnAssetDisabledReasonsItems": { "enum": [ "ARCHIVED", "AT_DEEL_WAREHOUSE", "BEING_REPAIRED", "CONSUMABLE", "CONTROLLED_BY_DEEL", "COUNTRY_NOT_SUPPORTED_FOR_HUB", "COUNTRY_NOT_SUPPORTED_FOR_LOCAL", "DEEL_OWNED_ITEM_WITHOUT_RENTAL_CONTRACT", "DESKTOP_STORAGE", "ENDING_CONTRACT", "HUB_IN_SAME_REGION_AS_LOCAL", "INACTIVE", "INVALID_ITEM_LOCATION", "INVALID_ORGANIZATION_STATUS", "INVALID_STATE", "ITEM_CONDITIONS_TO_UNARCHIVE_NOT_MET", "ITEM_NOT_VISIBLE_FOR_ORGANIZATION", "NON_DEVICE", "NOT_AT_WAREHOUSE", "NOT_AVAILABLE_FOR_REUSE", "NOT_A_RENTAL", "NOT_MANAGEABLE_BY_ORGANIZATION", "NOT_WITH_ASSIGNMENT", "NOT_WITH_USER", "NO_ACTIVE_ADDONS", "NO_ACTIVE_STORAGE_CONTRACT", "NO_LOCATION_FOR_STORAGE", "NO_LOGISTICS_FOR_STORAGE", "NO_VALID_ADDONS", "ONGOING_SERVICE", "OWNED_BY_DEEL", "OWNED_BY_ORGANIZATION", "OWNED_BY_PARTNER_ORGANIZATION", "PARTNER_CHILD_CONTRACT", "PENDING_DEVICE_REFRESH", "RENTAL_CONTRACT_AND_USER_REGION_DO_NOT_MATCH", "TEMPORARILY_UNAVAILABLE", "UNKNOWN", "USER_HAS_NO_COUNTRY", "USER_HAS_NO_SEAT", "WAITING_FOR_CLEARANCE", "WITH_LOANER_ASSIGNMENT", "WITH_NON_COLLECTED_ASSIGNMENT", "WITH_NON_DELIVERED_ASSIGNMENT", "WITH_PENDING_ASSIGNMENT", "WRONG_ASSIGNMENT_STATUS", "WRONG_CONTRACT_STATUS", "WRONG_TERMS_AND_CONDITIONS" ], "title": "ItAssetsAssetIdAddonsAddonIdAssignPostResponsesContentApplicationJsonSchemaDataActionsUnarchiveOwnAssetDisabledReasonsItems", "type": "string" }, "ItAssetsAssetIdAddonsAddonIdAssignPostResponsesContentApplicationJsonSchemaDataActionsUnarchiveOwnAssetStatus": { "description": "Whether the action is currently available for this asset", "enum": [ "DISABLED", "ENABLED", "NOT_APPLICABLE" ], "title": "ItAssetsAssetIdAddonsAddonIdAssignPostResponsesContentApplicationJsonSchemaDataActionsUnarchiveOwnAssetStatus", "type": "string" }, "ItAssetsAssetIdAddonsAddonIdAssignPostResponsesContentApplicationJsonSchemaDataActionsUpdateLocationLocationToUser": { "description": "Update the location of an asset from a warehouse to a user", "properties": { "disabled_reasons": { "description": "Reasons why the action is disabled. Empty when the action is enabled or not applicable", "items": { "$ref": "#/components/schemas/ItAssetsAssetIdAddonsAddonIdAssignPostResponsesContentApplicationJsonSchemaDataActionsUpdateLocationLocationToUserDisabledReasonsItems" }, "type": "array" }, "status": { "$ref": "#/components/schemas/ItAssetsAssetIdAddonsAddonIdAssignPostResponsesContentApplicationJsonSchemaDataActionsUpdateLocationLocationToUserStatus", "description": "Whether the action is currently available for this asset" } }, "required": [ "status", "disabled_reasons" ], "title": "ItAssetsAssetIdAddonsAddonIdAssignPostResponsesContentApplicationJsonSchemaDataActionsUpdateLocationLocationToUser", "type": "object" }, "ItAssetsAssetIdAddonsAddonIdAssignPostResponsesContentApplicationJsonSchemaDataActionsUpdateLocationLocationToUserDisabledReasonsItems": { "enum": [ "ARCHIVED", "AT_DEEL_WAREHOUSE", "BEING_REPAIRED", "CONSUMABLE", "CONTROLLED_BY_DEEL", "COUNTRY_NOT_SUPPORTED_FOR_HUB", "COUNTRY_NOT_SUPPORTED_FOR_LOCAL", "DEEL_OWNED_ITEM_WITHOUT_RENTAL_CONTRACT", "DESKTOP_STORAGE", "ENDING_CONTRACT", "HUB_IN_SAME_REGION_AS_LOCAL", "INACTIVE", "INVALID_ITEM_LOCATION", "INVALID_ORGANIZATION_STATUS", "INVALID_STATE", "ITEM_CONDITIONS_TO_UNARCHIVE_NOT_MET", "ITEM_NOT_VISIBLE_FOR_ORGANIZATION", "NON_DEVICE", "NOT_AT_WAREHOUSE", "NOT_AVAILABLE_FOR_REUSE", "NOT_A_RENTAL", "NOT_MANAGEABLE_BY_ORGANIZATION", "NOT_WITH_ASSIGNMENT", "NOT_WITH_USER", "NO_ACTIVE_ADDONS", "NO_ACTIVE_STORAGE_CONTRACT", "NO_LOCATION_FOR_STORAGE", "NO_LOGISTICS_FOR_STORAGE", "NO_VALID_ADDONS", "ONGOING_SERVICE", "OWNED_BY_DEEL", "OWNED_BY_ORGANIZATION", "OWNED_BY_PARTNER_ORGANIZATION", "PARTNER_CHILD_CONTRACT", "PENDING_DEVICE_REFRESH", "RENTAL_CONTRACT_AND_USER_REGION_DO_NOT_MATCH", "TEMPORARILY_UNAVAILABLE", "UNKNOWN", "USER_HAS_NO_COUNTRY", "USER_HAS_NO_SEAT", "WAITING_FOR_CLEARANCE", "WITH_LOANER_ASSIGNMENT", "WITH_NON_COLLECTED_ASSIGNMENT", "WITH_NON_DELIVERED_ASSIGNMENT", "WITH_PENDING_ASSIGNMENT", "WRONG_ASSIGNMENT_STATUS", "WRONG_CONTRACT_STATUS", "WRONG_TERMS_AND_CONDITIONS" ], "title": "ItAssetsAssetIdAddonsAddonIdAssignPostResponsesContentApplicationJsonSchemaDataActionsUpdateLocationLocationToUserDisabledReasonsItems", "type": "string" }, "ItAssetsAssetIdAddonsAddonIdAssignPostResponsesContentApplicationJsonSchemaDataActionsUpdateLocationLocationToUserStatus": { "description": "Whether the action is currently available for this asset", "enum": [ "DISABLED", "ENABLED", "NOT_APPLICABLE" ], "title": "ItAssetsAssetIdAddonsAddonIdAssignPostResponsesContentApplicationJsonSchemaDataActionsUpdateLocationLocationToUserStatus", "type": "string" }, "ItAssetsAssetIdAddonsAddonIdAssignPostResponsesContentApplicationJsonSchemaDataActionsUpdateLocationUserToLocation": { "description": "Update the location of an asset from a user to a warehouse", "properties": { "disabled_reasons": { "description": "Reasons why the action is disabled. Empty when the action is enabled or not applicable", "items": { "$ref": "#/components/schemas/ItAssetsAssetIdAddonsAddonIdAssignPostResponsesContentApplicationJsonSchemaDataActionsUpdateLocationUserToLocationDisabledReasonsItems" }, "type": "array" }, "status": { "$ref": "#/components/schemas/ItAssetsAssetIdAddonsAddonIdAssignPostResponsesContentApplicationJsonSchemaDataActionsUpdateLocationUserToLocationStatus", "description": "Whether the action is currently available for this asset" } }, "required": [ "status", "disabled_reasons" ], "title": "ItAssetsAssetIdAddonsAddonIdAssignPostResponsesContentApplicationJsonSchemaDataActionsUpdateLocationUserToLocation", "type": "object" }, "ItAssetsAssetIdAddonsAddonIdAssignPostResponsesContentApplicationJsonSchemaDataActionsUpdateLocationUserToLocationDisabledReasonsItems": { "enum": [ "ARCHIVED", "AT_DEEL_WAREHOUSE", "BEING_REPAIRED", "CONSUMABLE", "CONTROLLED_BY_DEEL", "COUNTRY_NOT_SUPPORTED_FOR_HUB", "COUNTRY_NOT_SUPPORTED_FOR_LOCAL", "DEEL_OWNED_ITEM_WITHOUT_RENTAL_CONTRACT", "DESKTOP_STORAGE", "ENDING_CONTRACT", "HUB_IN_SAME_REGION_AS_LOCAL", "INACTIVE", "INVALID_ITEM_LOCATION", "INVALID_ORGANIZATION_STATUS", "INVALID_STATE", "ITEM_CONDITIONS_TO_UNARCHIVE_NOT_MET", "ITEM_NOT_VISIBLE_FOR_ORGANIZATION", "NON_DEVICE", "NOT_AT_WAREHOUSE", "NOT_AVAILABLE_FOR_REUSE", "NOT_A_RENTAL", "NOT_MANAGEABLE_BY_ORGANIZATION", "NOT_WITH_ASSIGNMENT", "NOT_WITH_USER", "NO_ACTIVE_ADDONS", "NO_ACTIVE_STORAGE_CONTRACT", "NO_LOCATION_FOR_STORAGE", "NO_LOGISTICS_FOR_STORAGE", "NO_VALID_ADDONS", "ONGOING_SERVICE", "OWNED_BY_DEEL", "OWNED_BY_ORGANIZATION", "OWNED_BY_PARTNER_ORGANIZATION", "PARTNER_CHILD_CONTRACT", "PENDING_DEVICE_REFRESH", "RENTAL_CONTRACT_AND_USER_REGION_DO_NOT_MATCH", "TEMPORARILY_UNAVAILABLE", "UNKNOWN", "USER_HAS_NO_COUNTRY", "USER_HAS_NO_SEAT", "WAITING_FOR_CLEARANCE", "WITH_LOANER_ASSIGNMENT", "WITH_NON_COLLECTED_ASSIGNMENT", "WITH_NON_DELIVERED_ASSIGNMENT", "WITH_PENDING_ASSIGNMENT", "WRONG_ASSIGNMENT_STATUS", "WRONG_CONTRACT_STATUS", "WRONG_TERMS_AND_CONDITIONS" ], "title": "ItAssetsAssetIdAddonsAddonIdAssignPostResponsesContentApplicationJsonSchemaDataActionsUpdateLocationUserToLocationDisabledReasonsItems", "type": "string" }, "ItAssetsAssetIdAddonsAddonIdAssignPostResponsesContentApplicationJsonSchemaDataActionsUpdateLocationUserToLocationStatus": { "description": "Whether the action is currently available for this asset", "enum": [ "DISABLED", "ENABLED", "NOT_APPLICABLE" ], "title": "ItAssetsAssetIdAddonsAddonIdAssignPostResponsesContentApplicationJsonSchemaDataActionsUpdateLocationUserToLocationStatus", "type": "string" }, "ItAssetsAssetIdAddonsAddonIdAssignPostResponsesContentApplicationJsonSchemaDataActionsUpdateLocationUserToUser": { "description": "Update the assigned user of an asset that is currently with a user", "properties": { "disabled_reasons": { "description": "Reasons why the action is disabled. Empty when the action is enabled or not applicable", "items": { "$ref": "#/components/schemas/ItAssetsAssetIdAddonsAddonIdAssignPostResponsesContentApplicationJsonSchemaDataActionsUpdateLocationUserToUserDisabledReasonsItems" }, "type": "array" }, "status": { "$ref": "#/components/schemas/ItAssetsAssetIdAddonsAddonIdAssignPostResponsesContentApplicationJsonSchemaDataActionsUpdateLocationUserToUserStatus", "description": "Whether the action is currently available for this asset" } }, "required": [ "status", "disabled_reasons" ], "title": "ItAssetsAssetIdAddonsAddonIdAssignPostResponsesContentApplicationJsonSchemaDataActionsUpdateLocationUserToUser", "type": "object" }, "ItAssetsAssetIdAddonsAddonIdAssignPostResponsesContentApplicationJsonSchemaDataActionsUpdateLocationUserToUserDisabledReasonsItems": { "enum": [ "ARCHIVED", "AT_DEEL_WAREHOUSE", "BEING_REPAIRED", "CONSUMABLE", "CONTROLLED_BY_DEEL", "COUNTRY_NOT_SUPPORTED_FOR_HUB", "COUNTRY_NOT_SUPPORTED_FOR_LOCAL", "DEEL_OWNED_ITEM_WITHOUT_RENTAL_CONTRACT", "DESKTOP_STORAGE", "ENDING_CONTRACT", "HUB_IN_SAME_REGION_AS_LOCAL", "INACTIVE", "INVALID_ITEM_LOCATION", "INVALID_ORGANIZATION_STATUS", "INVALID_STATE", "ITEM_CONDITIONS_TO_UNARCHIVE_NOT_MET", "ITEM_NOT_VISIBLE_FOR_ORGANIZATION", "NON_DEVICE", "NOT_AT_WAREHOUSE", "NOT_AVAILABLE_FOR_REUSE", "NOT_A_RENTAL", "NOT_MANAGEABLE_BY_ORGANIZATION", "NOT_WITH_ASSIGNMENT", "NOT_WITH_USER", "NO_ACTIVE_ADDONS", "NO_ACTIVE_STORAGE_CONTRACT", "NO_LOCATION_FOR_STORAGE", "NO_LOGISTICS_FOR_STORAGE", "NO_VALID_ADDONS", "ONGOING_SERVICE", "OWNED_BY_DEEL", "OWNED_BY_ORGANIZATION", "OWNED_BY_PARTNER_ORGANIZATION", "PARTNER_CHILD_CONTRACT", "PENDING_DEVICE_REFRESH", "RENTAL_CONTRACT_AND_USER_REGION_DO_NOT_MATCH", "TEMPORARILY_UNAVAILABLE", "UNKNOWN", "USER_HAS_NO_COUNTRY", "USER_HAS_NO_SEAT", "WAITING_FOR_CLEARANCE", "WITH_LOANER_ASSIGNMENT", "WITH_NON_COLLECTED_ASSIGNMENT", "WITH_NON_DELIVERED_ASSIGNMENT", "WITH_PENDING_ASSIGNMENT", "WRONG_ASSIGNMENT_STATUS", "WRONG_CONTRACT_STATUS", "WRONG_TERMS_AND_CONDITIONS" ], "title": "ItAssetsAssetIdAddonsAddonIdAssignPostResponsesContentApplicationJsonSchemaDataActionsUpdateLocationUserToUserDisabledReasonsItems", "type": "string" }, "ItAssetsAssetIdAddonsAddonIdAssignPostResponsesContentApplicationJsonSchemaDataActionsUpdateLocationUserToUserStatus": { "description": "Whether the action is currently available for this asset", "enum": [ "DISABLED", "ENABLED", "NOT_APPLICABLE" ], "title": "ItAssetsAssetIdAddonsAddonIdAssignPostResponsesContentApplicationJsonSchemaDataActionsUpdateLocationUserToUserStatus", "type": "string" }, "ItAssetsAssetIdAddonsAddonIdAssignPostResponsesContentApplicationJsonSchemaDataActionsUpdateOwnAssetDetails": { "description": "Update editable details of an organization-owned asset", "properties": { "disabled_reasons": { "description": "Reasons why the action is disabled. Empty when the action is enabled or not applicable", "items": { "$ref": "#/components/schemas/ItAssetsAssetIdAddonsAddonIdAssignPostResponsesContentApplicationJsonSchemaDataActionsUpdateOwnAssetDetailsDisabledReasonsItems" }, "type": "array" }, "status": { "$ref": "#/components/schemas/ItAssetsAssetIdAddonsAddonIdAssignPostResponsesContentApplicationJsonSchemaDataActionsUpdateOwnAssetDetailsStatus", "description": "Whether the action is currently available for this asset" } }, "required": [ "status", "disabled_reasons" ], "title": "ItAssetsAssetIdAddonsAddonIdAssignPostResponsesContentApplicationJsonSchemaDataActionsUpdateOwnAssetDetails", "type": "object" }, "ItAssetsAssetIdAddonsAddonIdAssignPostResponsesContentApplicationJsonSchemaDataActionsUpdateOwnAssetDetailsDisabledReasonsItems": { "enum": [ "ARCHIVED", "AT_DEEL_WAREHOUSE", "BEING_REPAIRED", "CONSUMABLE", "CONTROLLED_BY_DEEL", "COUNTRY_NOT_SUPPORTED_FOR_HUB", "COUNTRY_NOT_SUPPORTED_FOR_LOCAL", "DEEL_OWNED_ITEM_WITHOUT_RENTAL_CONTRACT", "DESKTOP_STORAGE", "ENDING_CONTRACT", "HUB_IN_SAME_REGION_AS_LOCAL", "INACTIVE", "INVALID_ITEM_LOCATION", "INVALID_ORGANIZATION_STATUS", "INVALID_STATE", "ITEM_CONDITIONS_TO_UNARCHIVE_NOT_MET", "ITEM_NOT_VISIBLE_FOR_ORGANIZATION", "NON_DEVICE", "NOT_AT_WAREHOUSE", "NOT_AVAILABLE_FOR_REUSE", "NOT_A_RENTAL", "NOT_MANAGEABLE_BY_ORGANIZATION", "NOT_WITH_ASSIGNMENT", "NOT_WITH_USER", "NO_ACTIVE_ADDONS", "NO_ACTIVE_STORAGE_CONTRACT", "NO_LOCATION_FOR_STORAGE", "NO_LOGISTICS_FOR_STORAGE", "NO_VALID_ADDONS", "ONGOING_SERVICE", "OWNED_BY_DEEL", "OWNED_BY_ORGANIZATION", "OWNED_BY_PARTNER_ORGANIZATION", "PARTNER_CHILD_CONTRACT", "PENDING_DEVICE_REFRESH", "RENTAL_CONTRACT_AND_USER_REGION_DO_NOT_MATCH", "TEMPORARILY_UNAVAILABLE", "UNKNOWN", "USER_HAS_NO_COUNTRY", "USER_HAS_NO_SEAT", "WAITING_FOR_CLEARANCE", "WITH_LOANER_ASSIGNMENT", "WITH_NON_COLLECTED_ASSIGNMENT", "WITH_NON_DELIVERED_ASSIGNMENT", "WITH_PENDING_ASSIGNMENT", "WRONG_ASSIGNMENT_STATUS", "WRONG_CONTRACT_STATUS", "WRONG_TERMS_AND_CONDITIONS" ], "title": "ItAssetsAssetIdAddonsAddonIdAssignPostResponsesContentApplicationJsonSchemaDataActionsUpdateOwnAssetDetailsDisabledReasonsItems", "type": "string" }, "ItAssetsAssetIdAddonsAddonIdAssignPostResponsesContentApplicationJsonSchemaDataActionsUpdateOwnAssetDetailsStatus": { "description": "Whether the action is currently available for this asset", "enum": [ "DISABLED", "ENABLED", "NOT_APPLICABLE" ], "title": "ItAssetsAssetIdAddonsAddonIdAssignPostResponsesContentApplicationJsonSchemaDataActionsUpdateOwnAssetDetailsStatus", "type": "string" }, "ItAssetsAssetIdAddonsAddonIdAssignPostResponsesContentApplicationJsonSchemaDataAssignedUser": { "description": "Details of the user with asset possession", "properties": { "emails": { "description": "Array of user email addresses", "items": { "format": "email", "type": "string" }, "type": "array" }, "first_name": { "description": "First name of the user", "type": "string" }, "hris_profile_id": { "description": "The unique identifier of the HRIS profile of the assigned user", "format": "uuid", "type": "string" }, "last_name": { "description": "Last name of the user", "type": "string" } }, "required": [ "emails", "last_name", "first_name", "hris_profile_id" ], "title": "ItAssetsAssetIdAddonsAddonIdAssignPostResponsesContentApplicationJsonSchemaDataAssignedUser", "type": "object" }, "ItAssetsAssetIdAddonsAddonIdAssignPostResponsesContentApplicationJsonSchemaDataAssignedWarehouse": { "description": "Details of the warehouse with asset possession", "properties": { "address": { "$ref": "#/components/schemas/ItAssetsAssetIdAddonsAddonIdAssignPostResponsesContentApplicationJsonSchemaDataAssignedWarehouseAddress", "description": "Warehouse address details" }, "id": { "description": "Unique identifier of the warehouse", "format": "uuid", "type": "string" }, "name": { "description": "Warehouse or storage location name", "type": "string" }, "ownership": { "$ref": "#/components/schemas/ItAssetsAssetIdAddonsAddonIdAssignPostResponsesContentApplicationJsonSchemaDataAssignedWarehouseOwnership", "description": "Warehouse ownership type" }, "public_id": { "description": "Public identifier of the warehouse", "type": "string" }, "warehouse_type": { "$ref": "#/components/schemas/ItAssetsAssetIdAddonsAddonIdAssignPostResponsesContentApplicationJsonSchemaDataAssignedWarehouseWarehouseType", "description": "Warehouse type" } }, "required": [ "id", "name", "address", "ownership", "public_id", "warehouse_type" ], "title": "ItAssetsAssetIdAddonsAddonIdAssignPostResponsesContentApplicationJsonSchemaDataAssignedWarehouse", "type": "object" }, "ItAssetsAssetIdAddonsAddonIdAssignPostResponsesContentApplicationJsonSchemaDataAssignedWarehouseAddress": { "description": "Warehouse address details", "properties": { "city": { "description": "City name", "type": [ "string", "null" ] }, "country": { "$ref": "#/components/schemas/ItAssetsAssetIdAddonsAddonIdAssignPostResponsesContentApplicationJsonSchemaDataAssignedWarehouseAddressCountry", "description": "Country code" }, "date_of_birth": { "description": "Date of birth (applicable for some address types)", "format": "date", "type": [ "string", "null" ] }, "delivery_instructions": { "description": "Special instructions for deliveries", "type": [ "string", "null" ] }, "id": { "description": "Unique identifier of the address", "format": "uuid", "type": "string" }, "is_valid": { "description": "Whether the address passes validation", "type": "boolean" }, "line1": { "description": "Address line 1", "type": [ "string", "null" ] }, "line2": { "description": "Address line 2", "type": [ "string", "null" ] }, "passport_number": { "description": "Passport number (applicable for some address types)", "type": [ "string", "null" ] }, "phone_number": { "description": "Phone number", "type": [ "string", "null" ] }, "post_code": { "description": "Post code", "type": [ "string", "null" ] }, "state": { "description": "State code or name", "type": [ "string", "null" ] }, "tax_id_number": { "description": "Tax ID number (applicable for some address types)", "type": [ "string", "null" ] }, "type": { "$ref": "#/components/schemas/ItAssetsAssetIdAddonsAddonIdAssignPostResponsesContentApplicationJsonSchemaDataAssignedWarehouseAddressType", "description": "Type of the address" } }, "required": [ "id", "city", "type", "line1", "line2", "state", "country", "is_valid", "post_code", "phone_number", "date_of_birth", "tax_id_number", "passport_number", "delivery_instructions" ], "title": "ItAssetsAssetIdAddonsAddonIdAssignPostResponsesContentApplicationJsonSchemaDataAssignedWarehouseAddress", "type": "object" }, "ItAssetsAssetIdAddonsAddonIdAssignPostResponsesContentApplicationJsonSchemaDataAssignedWarehouseAddressCountry": { "description": "Country code", "enum": [ "AD", "AE", "AF", "AG", "AI", "AL", "AM", "AN", "AO", "AQ", "AR", "AS", "AT", "AU", "AW", "AX", "AZ", "BA", "BB", "BD", "BE", "BF", "BG", "BH", "BI", "BJ", "BL", "BM", "BN", "BO", "BQ", "BR", "BS", "BT", "BV", "BW", "BY", "BZ", "CA", "CC", "CD", "CF", "CG", "CH", "CI", "CK", "CL", "CM", "CN", "CO", "CR", "CU", "CV", "CW", "CX", "CY", "CZ", "DE", "DJ", "DK", "DM", "DO", "DZ", "EC", "EE", "EG", "EH", "ER", "ES", "ET", "FI", "FJ", "FK", "FM", "FO", "FR", "GA", "GB", "GD", "GE", "GF", "GG", "GH", "GI", "GL", "GM", "GN", "GP", "GQ", "GR", "GS", "GT", "GU", "GW", "GY", "HK", "HM", "HN", "HR", "HT", "HU", "IC", "ID", "IE", "IL", "IM", "IN", "IO", "IQ", "IR", "IS", "IT", "JE", "JM", "JO", "JP", "KE", "KG", "KH", "KI", "KM", "KN", "KP", "KR", "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", "XK", "YE", "YT", "ZA", "ZM", "ZW" ], "title": "ItAssetsAssetIdAddonsAddonIdAssignPostResponsesContentApplicationJsonSchemaDataAssignedWarehouseAddressCountry", "type": "string" }, "ItAssetsAssetIdAddonsAddonIdAssignPostResponsesContentApplicationJsonSchemaDataAssignedWarehouseAddressType": { "description": "Type of the address", "enum": [ "BILLING", "COLLECTION", "DELIVERY", "ENTITY", "PARTIAL", "PII", "SUPPLIER" ], "title": "ItAssetsAssetIdAddonsAddonIdAssignPostResponsesContentApplicationJsonSchemaDataAssignedWarehouseAddressType", "type": "string" }, "ItAssetsAssetIdAddonsAddonIdAssignPostResponsesContentApplicationJsonSchemaDataAssignedWarehouseOwnership": { "description": "Warehouse ownership type", "enum": [ "DEEL", "ORGANIZATION" ], "title": "ItAssetsAssetIdAddonsAddonIdAssignPostResponsesContentApplicationJsonSchemaDataAssignedWarehouseOwnership", "type": "string" }, "ItAssetsAssetIdAddonsAddonIdAssignPostResponsesContentApplicationJsonSchemaDataAssignedWarehouseWarehouseType": { "description": "Warehouse type", "enum": [ "CLEARANCE", "DEEL", "ORGANIZATION" ], "title": "ItAssetsAssetIdAddonsAddonIdAssignPostResponsesContentApplicationJsonSchemaDataAssignedWarehouseWarehouseType", "type": "string" }, "ItAssetsAssetIdAddonsAddonIdAssignPostResponsesContentApplicationJsonSchemaDataGrade": { "description": "The condition grade of the asset", "enum": [ "A", "B", "C", "D", "F", "NEW" ], "title": "ItAssetsAssetIdAddonsAddonIdAssignPostResponsesContentApplicationJsonSchemaDataGrade", "type": "string" }, "ItAssetsAssetIdAddonsAddonIdAssignPostResponsesContentApplicationJsonSchemaDataLocation": { "description": "Current location type of the asset", "enum": [ "AT_WAREHOUSE", "CLEARANCE_WAREHOUSE", "DEEL_WAREHOUSE", "ORGANIZATION_WAREHOUSE", "SUPPLIER", "WITH_COURIER", "WITH_USER", "WRITE_OFF" ], "title": "ItAssetsAssetIdAddonsAddonIdAssignPostResponsesContentApplicationJsonSchemaDataLocation", "type": "string" }, "ItAssetsAssetIdAddonsAddonIdAssignPostResponsesContentApplicationJsonSchemaDataOwnership": { "description": "Asset owner", "properties": { "name": { "description": "Asset owner name", "type": "string" }, "type": { "$ref": "#/components/schemas/ItAssetsAssetIdAddonsAddonIdAssignPostResponsesContentApplicationJsonSchemaDataOwnershipType", "description": "Asset owner type" } }, "required": [ "name", "type" ], "title": "ItAssetsAssetIdAddonsAddonIdAssignPostResponsesContentApplicationJsonSchemaDataOwnership", "type": "object" }, "ItAssetsAssetIdAddonsAddonIdAssignPostResponsesContentApplicationJsonSchemaDataOwnershipType": { "description": "Asset owner type", "enum": [ "DEEL", "ORGANIZATION" ], "title": "ItAssetsAssetIdAddonsAddonIdAssignPostResponsesContentApplicationJsonSchemaDataOwnershipType", "type": "string" }, "ItAssetsAssetIdAddonsAddonIdAssignPostResponsesContentApplicationJsonSchemaDataProduct": { "description": "Product details", "properties": { "brand": { "description": "Product brand", "type": "string" }, "category": { "$ref": "#/components/schemas/ItAssetsAssetIdAddonsAddonIdAssignPostResponsesContentApplicationJsonSchemaDataProductCategory", "description": "Product category" }, "id": { "description": "Unique identifier of the product", "format": "uuid", "type": "string" }, "name": { "description": "Product name", "type": "string" }, "specifications": { "description": "Specifications of the product", "items": { "$ref": "#/components/schemas/ItAssetsAssetIdAddonsAddonIdAssignPostResponsesContentApplicationJsonSchemaDataProductSpecificationsItems" }, "type": "array" } }, "required": [ "id", "name", "brand", "category", "specifications" ], "title": "ItAssetsAssetIdAddonsAddonIdAssignPostResponsesContentApplicationJsonSchemaDataProduct", "type": "object" }, "ItAssetsAssetIdAddonsAddonIdAssignPostResponsesContentApplicationJsonSchemaDataProductCategory": { "description": "Product category", "enum": [ "ADAPTER", "CABLE", "CHAIR", "CHARGER", "COMPACT_DESKTOP", "DESK", "DESKTOP", "DESK_RISER", "DESK_TIDY", "DOCKING_STATION", "DONGLE", "FOOTREST", "HEADSET", "KEYBOARD", "LAPTOP", "LAPTOP_STAND", "MICE_TRACKPAD", "MOBILE_DEVICE", "MONITOR", "MONITOR_ARM", "OTHER", "PRINTER", "SHREDDER", "STANDING_MAT", "TABLET", "TASK_LIGHT", "WEBCAM", "WELCOME_PACK", "WIFI_RANGE_EXTENDER" ], "title": "ItAssetsAssetIdAddonsAddonIdAssignPostResponsesContentApplicationJsonSchemaDataProductCategory", "type": "string" }, "ItAssetsAssetIdAddonsAddonIdAssignPostResponsesContentApplicationJsonSchemaDataProductSpecificationsItems": { "properties": { "name": { "description": "Specification name", "type": "string" }, "value": { "description": "Specification value", "type": "string" } }, "required": [ "name", "value" ], "title": "ItAssetsAssetIdAddonsAddonIdAssignPostResponsesContentApplicationJsonSchemaDataProductSpecificationsItems", "type": "object" }, "ItAssetsAssetIdAddonsAddonIdAssignPostResponsesContentApplicationJsonSchemaDataPurchaseValue": { "description": "Purchase value of the asset", "properties": { "amount": { "description": "Amount", "format": "decimal", "type": "string" }, "currency": { "$ref": "#/components/schemas/ItAssetsAssetIdAddonsAddonIdAssignPostResponsesContentApplicationJsonSchemaDataPurchaseValueCurrency", "description": "Three-letter currency code for the price" } }, "required": [ "amount", "currency" ], "title": "ItAssetsAssetIdAddonsAddonIdAssignPostResponsesContentApplicationJsonSchemaDataPurchaseValue", "type": "object" }, "ItAssetsAssetIdAddonsAddonIdAssignPostResponsesContentApplicationJsonSchemaDataPurchaseValueCurrency": { "description": "Three-letter currency code for the price", "enum": [ "AED", "AFN", "ALL", "AMD", "ANG", "AOA", "ARS", "AUD", "AWG", "AZN", "BAM", "BDT", "BGN", "BHD", "BIF", "BMD", "BOB", "BRL", "BSD", "BTN", "BWP", "BYN", "BZD", "CAD", "CDF", "CHF", "CLP", "CNY", "COP", "CRC", "CUC", "CVE", "CZK", "DJF", "DKK", "DOP", "DZD", "EGP", "ERN", "ETB", "EUR", "FJD", "FKP", "GBP", "GEL", "GHS", "GIP", "GMD", "GNF", "GTQ", "GYD", "HKD", "HNL", "HRK", "HTG", "HUF", "IDR", "ILS", "INR", "IQD", "IRR", "ISK", "JMD", "JOD", "JPY", "KES", "KGS", "KHR", "KMF", "KPW", "KRW", "KWD", "KYD", "KZT", "LAK", "LBP", "LKR", "LRD", "LSL", "LTL", "LYD", "MAD", "MDL", "MGA", "MKD", "MMK", "MNT", "MRU", "MUR", "MVR", "MWK", "MXN", "MYR", "MZN", "NAD", "NGN", "NIO", "NOK", "NPR", "NZD", "OMR", "PAB", "PEN", "PGK", "PHP", "PKR", "PLN", "PYG", "QAR", "RON", "RSD", "RUB", "RWF", "SAR", "SBD", "SCR", "SDG", "SEK", "SGD", "SHP", "SLL", "SOS", "SRD", "SSP", "STD", "SYP", "SZL", "THB", "TJS", "TMT", "TND", "TOP", "TRY", "TTD", "TWD", "TZS", "UAH", "UGX", "USD", "UYU", "UZS", "VEF", "VND", "VUV", "WST", "XAF", "XCD", "XOF", "XPF", "YER", "ZAR", "ZMW", "ZWD" ], "title": "ItAssetsAssetIdAddonsAddonIdAssignPostResponsesContentApplicationJsonSchemaDataPurchaseValueCurrency", "type": "string" }, "ItAssetsAssetIdAddonsAddonIdAssignPostResponsesContentApplicationJsonSchemaDataStatus": { "description": "Current state of the asset", "enum": [ "ACTIVE", "ADDED_BY_MISTAKE", "BEING_REPAIRED", "BINNED", "BROKEN_AT_WAREHOUSE", "BROKEN_BY_USER", "BROKEN_IN_TRANSIT", "CLEARED", "DAMAGED_AT_WAREHOUSE", "DAMAGED_BY_USER", "DAMAGED_IN_TRANSIT", "LEFT_WITH_USER", "LOST_IN_TRANSIT", "RETURNED_TO_DEEL", "SHRINKAGE", "STOLEN", "SUPPLIER_RETURN", "WAITING_FOR_CLEARANCE" ], "title": "ItAssetsAssetIdAddonsAddonIdAssignPostResponsesContentApplicationJsonSchemaDataStatus", "type": "string" }, "ItAssetsAssetIdAddonsAddonIdAssignPostResponsesContentApplicationJsonSchemaErrorsItems": { "properties": { "code": { "description": "Error code of the handler which produced the returned error", "type": "string" }, "field": { "description": "The field name where input validation failed", "type": [ "string", "null" ] }, "message": { "description": "Description of the returned error", "type": "string" } }, "required": [ "code", "field", "message" ], "title": "ItAssetsAssetIdAddonsAddonIdAssignPostResponsesContentApplicationJsonSchemaErrorsItems", "type": "object" }, "ItAssetsAssetIdArchivePostParametersXBeta": { "default": "true", "enum": [ "true" ], "title": "ItAssetsAssetIdArchivePostParametersXBeta", "type": "string" }, "ItAssetsAssetIdArchivePostRequestBodyContentApplicationJsonSchemaData": { "properties": { "note": { "description": "Optional human-readable note explaining the reason for archiving.", "type": "string" }, "status": { "$ref": "#/components/schemas/ItAssetsAssetIdArchivePostRequestBodyContentApplicationJsonSchemaDataStatus", "description": "Terminal status that describes why the asset is being archived." } }, "required": [ "status" ], "title": "ItAssetsAssetIdArchivePostRequestBodyContentApplicationJsonSchemaData", "type": "object" }, "ItAssetsAssetIdArchivePostRequestBodyContentApplicationJsonSchemaDataStatus": { "description": "Terminal status that describes why the asset is being archived.", "enum": [ "ADDED_BY_MISTAKE", "BINNED", "BROKEN_AT_WAREHOUSE", "BROKEN_BY_USER", "BROKEN_IN_TRANSIT", "DAMAGED_AT_WAREHOUSE", "DAMAGED_BY_USER", "DAMAGED_IN_TRANSIT", "LEFT_WITH_USER", "LOST_IN_TRANSIT", "RETURNED_TO_DEEL", "SHRINKAGE", "STOLEN", "SUPPLIER_RETURN" ], "title": "ItAssetsAssetIdArchivePostRequestBodyContentApplicationJsonSchemaDataStatus", "type": "string" }, "ItAssetsAssetIdArchivePostResponsesContentApplicationJsonSchemaData": { "properties": { "actions": { "$ref": "#/components/schemas/ItAssetsAssetIdArchivePostResponsesContentApplicationJsonSchemaDataActions", "description": "Actions the caller can execute on this asset, with availability status per action" }, "assigned_user": { "description": "Details of the user with asset possession", "oneOf": [ { "$ref": "#/components/schemas/ItAssetsAssetIdArchivePostResponsesContentApplicationJsonSchemaDataAssignedUser" }, { "type": "null" } ] }, "assigned_warehouse": { "description": "Details of the warehouse with asset possession", "oneOf": [ { "$ref": "#/components/schemas/ItAssetsAssetIdArchivePostResponsesContentApplicationJsonSchemaDataAssignedWarehouse" }, { "type": "null" } ] }, "created_at": { "description": "Creation timestamp of the asset", "format": "date-time", "type": "string" }, "grade": { "$ref": "#/components/schemas/ItAssetsAssetIdArchivePostResponsesContentApplicationJsonSchemaDataGrade", "description": "The condition grade of the asset" }, "id": { "description": "Unique identifier of the item", "format": "uuid", "type": "string" }, "location": { "$ref": "#/components/schemas/ItAssetsAssetIdArchivePostResponsesContentApplicationJsonSchemaDataLocation", "description": "Current location type of the asset" }, "ownership": { "$ref": "#/components/schemas/ItAssetsAssetIdArchivePostResponsesContentApplicationJsonSchemaDataOwnership", "description": "Asset owner" }, "product": { "$ref": "#/components/schemas/ItAssetsAssetIdArchivePostResponsesContentApplicationJsonSchemaDataProduct", "description": "Product details" }, "public_id": { "description": "Public identifier of the item", "type": "string" }, "purchase_date": { "description": "Purchase date of the asset", "format": "date", "type": [ "string", "null" ] }, "purchase_value": { "description": "Purchase value of the asset", "oneOf": [ { "$ref": "#/components/schemas/ItAssetsAssetIdArchivePostResponsesContentApplicationJsonSchemaDataPurchaseValue" }, { "type": "null" } ] }, "serial_number": { "description": "Asset serial number", "type": [ "string", "null" ] }, "status": { "$ref": "#/components/schemas/ItAssetsAssetIdArchivePostResponsesContentApplicationJsonSchemaDataStatus", "description": "Current state of the asset" }, "updated_at": { "description": "Last update timestamp of the asset", "format": "date-time", "type": "string" } }, "required": [ "id", "grade", "status", "actions", "product", "location", "ownership", "public_id", "created_at", "updated_at", "assigned_user", "purchase_date", "serial_number", "purchase_value", "assigned_warehouse" ], "title": "ItAssetsAssetIdArchivePostResponsesContentApplicationJsonSchemaData", "type": "object" }, "ItAssetsAssetIdArchivePostResponsesContentApplicationJsonSchemaDataActions": { "description": "Actions the caller can execute on this asset, with availability status per action", "properties": { "archive_own_asset": { "$ref": "#/components/schemas/ItAssetsAssetIdArchivePostResponsesContentApplicationJsonSchemaDataActionsArchiveOwnAsset", "description": "Archive an organization-owned asset" }, "asset_country": { "description": "Resolved country used for asset actions. Derived from the asset's country,\nits assigned rental contract billing entity country, or the last active\nassignment delivery country. Null when the country cannot be determined\n(e.g. asset was returned to Deel)", "oneOf": [ { "$ref": "#/components/schemas/ItAssetsAssetIdArchivePostResponsesContentApplicationJsonSchemaDataActionsAssetCountry" }, { "type": "null" } ] }, "assign_addon_to_own_asset": { "$ref": "#/components/schemas/ItAssetsAssetIdArchivePostResponsesContentApplicationJsonSchemaDataActionsAssignAddonToOwnAsset", "description": "Assign an add-on to an organization-owned asset" }, "clear_own_asset": { "$ref": "#/components/schemas/ItAssetsAssetIdArchivePostResponsesContentApplicationJsonSchemaDataActionsClearOwnAsset", "description": "Clear an organization-owned asset from the fleet" }, "manage_end_of_rental_contract_actions": { "$ref": "#/components/schemas/ItAssetsAssetIdArchivePostResponsesContentApplicationJsonSchemaDataActionsManageEndOfRentalContractActions", "description": "Manage end-of-rental options for a Deel-owned rental asset" }, "purchase_rental": { "$ref": "#/components/schemas/ItAssetsAssetIdArchivePostResponsesContentApplicationJsonSchemaDataActionsPurchaseRental", "description": "Purchase a Deel-owned rental asset at end of contract" }, "return_rental_to_deel": { "$ref": "#/components/schemas/ItAssetsAssetIdArchivePostResponsesContentApplicationJsonSchemaDataActionsReturnRentalToDeel", "description": "Return a Deel-owned rental asset back to Deel" }, "reuse_own_asset_from_deel": { "$ref": "#/components/schemas/ItAssetsAssetIdArchivePostResponsesContentApplicationJsonSchemaDataActionsReuseOwnAssetFromDeel", "description": "Redeploy an organization-owned asset stored at a Deel warehouse" }, "reuse_own_asset_from_own_location": { "$ref": "#/components/schemas/ItAssetsAssetIdArchivePostResponsesContentApplicationJsonSchemaDataActionsReuseOwnAssetFromOwnLocation", "description": "Redeploy an organization-owned asset from an organization-owned location" }, "store_own_asset_at_deel_for_hub": { "$ref": "#/components/schemas/ItAssetsAssetIdArchivePostResponsesContentApplicationJsonSchemaDataActionsStoreOwnAssetAtDeelForHub", "description": "Store an organization-owned asset at a Deel hub warehouse" }, "store_own_asset_at_deel_for_local": { "$ref": "#/components/schemas/ItAssetsAssetIdArchivePostResponsesContentApplicationJsonSchemaDataActionsStoreOwnAssetAtDeelForLocal", "description": "Store an organization-owned asset at a Deel local warehouse" }, "store_own_asset_at_own_location": { "$ref": "#/components/schemas/ItAssetsAssetIdArchivePostResponsesContentApplicationJsonSchemaDataActionsStoreOwnAssetAtOwnLocation", "description": "Store an organization-owned asset at an organization-owned location" }, "store_rental_at_deel_for_local": { "$ref": "#/components/schemas/ItAssetsAssetIdArchivePostResponsesContentApplicationJsonSchemaDataActionsStoreRentalAtDeelForLocal", "description": "Store a Deel-owned rental asset at a Deel local warehouse" }, "store_rental_at_deel_for_zone1": { "$ref": "#/components/schemas/ItAssetsAssetIdArchivePostResponsesContentApplicationJsonSchemaDataActionsStoreRentalAtDeelForZone1", "description": "Store a Deel-owned rental asset at a Deel zone-1 warehouse" }, "transfer_own_asset": { "$ref": "#/components/schemas/ItAssetsAssetIdArchivePostResponsesContentApplicationJsonSchemaDataActionsTransferOwnAsset", "description": "Transfer an organization-owned asset to another user" }, "transfer_rental": { "$ref": "#/components/schemas/ItAssetsAssetIdArchivePostResponsesContentApplicationJsonSchemaDataActionsTransferRental", "description": "Transfer a Deel-owned rental asset to another user" }, "unarchive_own_asset": { "$ref": "#/components/schemas/ItAssetsAssetIdArchivePostResponsesContentApplicationJsonSchemaDataActionsUnarchiveOwnAsset", "description": "Unarchive a previously archived organization-owned asset" }, "update_location_location_to_user": { "$ref": "#/components/schemas/ItAssetsAssetIdArchivePostResponsesContentApplicationJsonSchemaDataActionsUpdateLocationLocationToUser", "description": "Update the location of an asset from a warehouse to a user" }, "update_location_user_to_location": { "$ref": "#/components/schemas/ItAssetsAssetIdArchivePostResponsesContentApplicationJsonSchemaDataActionsUpdateLocationUserToLocation", "description": "Update the location of an asset from a user to a warehouse" }, "update_location_user_to_user": { "$ref": "#/components/schemas/ItAssetsAssetIdArchivePostResponsesContentApplicationJsonSchemaDataActionsUpdateLocationUserToUser", "description": "Update the assigned user of an asset that is currently with a user" }, "update_own_asset_details": { "$ref": "#/components/schemas/ItAssetsAssetIdArchivePostResponsesContentApplicationJsonSchemaDataActionsUpdateOwnAssetDetails", "description": "Update editable details of an organization-owned asset" } }, "required": [ "asset_country", "clear_own_asset", "purchase_rental", "transfer_rental", "archive_own_asset", "transfer_own_asset", "unarchive_own_asset", "return_rental_to_deel", "update_own_asset_details", "assign_addon_to_own_asset", "reuse_own_asset_from_deel", "update_location_user_to_user", "store_rental_at_deel_for_local", "store_rental_at_deel_for_zone1", "store_own_asset_at_deel_for_hub", "store_own_asset_at_own_location", "update_location_location_to_user", "update_location_user_to_location", "reuse_own_asset_from_own_location", "store_own_asset_at_deel_for_local", "manage_end_of_rental_contract_actions" ], "title": "ItAssetsAssetIdArchivePostResponsesContentApplicationJsonSchemaDataActions", "type": "object" }, "ItAssetsAssetIdArchivePostResponsesContentApplicationJsonSchemaDataActionsArchiveOwnAsset": { "description": "Archive an organization-owned asset", "properties": { "details": { "description": "Action-specific context needed to perform the action. Populated for enabled and\ndisabled actions (so callers can see what a successful attempt would look like);\nnull when the action is not applicable to this asset.", "oneOf": [ { "$ref": "#/components/schemas/ItAssetsAssetIdArchivePostResponsesContentApplicationJsonSchemaDataActionsArchiveOwnAssetDetails" }, { "type": "null" } ] }, "disabled_reasons": { "description": "Reasons why the action is disabled. Empty when the action is enabled or not applicable", "items": { "$ref": "#/components/schemas/ItAssetsAssetIdArchivePostResponsesContentApplicationJsonSchemaDataActionsArchiveOwnAssetDisabledReasonsItems" }, "type": "array" }, "status": { "$ref": "#/components/schemas/ItAssetsAssetIdArchivePostResponsesContentApplicationJsonSchemaDataActionsArchiveOwnAssetStatus", "description": "Whether the action is currently available for this asset" } }, "required": [ "status", "details", "disabled_reasons" ], "title": "ItAssetsAssetIdArchivePostResponsesContentApplicationJsonSchemaDataActionsArchiveOwnAsset", "type": "object" }, "ItAssetsAssetIdArchivePostResponsesContentApplicationJsonSchemaDataActionsArchiveOwnAssetDetails": { "description": "Action-specific context needed to perform the action. Populated for enabled and\ndisabled actions (so callers can see what a successful attempt would look like);\nnull when the action is not applicable to this asset.", "properties": { "allowed_statuses": { "description": "Statuses that can be passed as the archive reason when archiving the asset", "items": { "$ref": "#/components/schemas/ItAssetsAssetIdArchivePostResponsesContentApplicationJsonSchemaDataActionsArchiveOwnAssetDetailsAllowedStatusesItems" }, "type": "array" } }, "required": [ "allowed_statuses" ], "title": "ItAssetsAssetIdArchivePostResponsesContentApplicationJsonSchemaDataActionsArchiveOwnAssetDetails", "type": "object" }, "ItAssetsAssetIdArchivePostResponsesContentApplicationJsonSchemaDataActionsArchiveOwnAssetDetailsAllowedStatusesItems": { "enum": [ "ADDED_BY_MISTAKE", "BINNED", "BROKEN_AT_WAREHOUSE", "BROKEN_BY_USER", "BROKEN_IN_TRANSIT", "DAMAGED_AT_WAREHOUSE", "DAMAGED_BY_USER", "DAMAGED_IN_TRANSIT", "LEFT_WITH_USER", "LOST_IN_TRANSIT", "RETURNED_TO_DEEL", "SHRINKAGE", "STOLEN", "SUPPLIER_RETURN" ], "title": "ItAssetsAssetIdArchivePostResponsesContentApplicationJsonSchemaDataActionsArchiveOwnAssetDetailsAllowedStatusesItems", "type": "string" }, "ItAssetsAssetIdArchivePostResponsesContentApplicationJsonSchemaDataActionsArchiveOwnAssetDisabledReasonsItems": { "enum": [ "ARCHIVED", "AT_DEEL_WAREHOUSE", "BEING_REPAIRED", "CONSUMABLE", "CONTROLLED_BY_DEEL", "COUNTRY_NOT_SUPPORTED_FOR_HUB", "COUNTRY_NOT_SUPPORTED_FOR_LOCAL", "DEEL_OWNED_ITEM_WITHOUT_RENTAL_CONTRACT", "DESKTOP_STORAGE", "ENDING_CONTRACT", "HUB_IN_SAME_REGION_AS_LOCAL", "INACTIVE", "INVALID_ITEM_LOCATION", "INVALID_ORGANIZATION_STATUS", "INVALID_STATE", "ITEM_CONDITIONS_TO_UNARCHIVE_NOT_MET", "ITEM_NOT_VISIBLE_FOR_ORGANIZATION", "NON_DEVICE", "NOT_AT_WAREHOUSE", "NOT_AVAILABLE_FOR_REUSE", "NOT_A_RENTAL", "NOT_MANAGEABLE_BY_ORGANIZATION", "NOT_WITH_ASSIGNMENT", "NOT_WITH_USER", "NO_ACTIVE_ADDONS", "NO_ACTIVE_STORAGE_CONTRACT", "NO_LOCATION_FOR_STORAGE", "NO_LOGISTICS_FOR_STORAGE", "NO_VALID_ADDONS", "ONGOING_SERVICE", "OWNED_BY_DEEL", "OWNED_BY_ORGANIZATION", "OWNED_BY_PARTNER_ORGANIZATION", "PARTNER_CHILD_CONTRACT", "PENDING_DEVICE_REFRESH", "RENTAL_CONTRACT_AND_USER_REGION_DO_NOT_MATCH", "TEMPORARILY_UNAVAILABLE", "UNKNOWN", "USER_HAS_NO_COUNTRY", "USER_HAS_NO_SEAT", "WAITING_FOR_CLEARANCE", "WITH_LOANER_ASSIGNMENT", "WITH_NON_COLLECTED_ASSIGNMENT", "WITH_NON_DELIVERED_ASSIGNMENT", "WITH_PENDING_ASSIGNMENT", "WRONG_ASSIGNMENT_STATUS", "WRONG_CONTRACT_STATUS", "WRONG_TERMS_AND_CONDITIONS" ], "title": "ItAssetsAssetIdArchivePostResponsesContentApplicationJsonSchemaDataActionsArchiveOwnAssetDisabledReasonsItems", "type": "string" }, "ItAssetsAssetIdArchivePostResponsesContentApplicationJsonSchemaDataActionsArchiveOwnAssetStatus": { "description": "Whether the action is currently available for this asset", "enum": [ "DISABLED", "ENABLED", "NOT_APPLICABLE" ], "title": "ItAssetsAssetIdArchivePostResponsesContentApplicationJsonSchemaDataActionsArchiveOwnAssetStatus", "type": "string" }, "ItAssetsAssetIdArchivePostResponsesContentApplicationJsonSchemaDataActionsAssetCountry": { "description": "Resolved country used for asset actions. Derived from the asset's country,\nits assigned rental contract billing entity country, or the last active\nassignment delivery country. Null when the country cannot be determined\n(e.g. asset was returned to Deel)", "enum": [ "AD", "AE", "AF", "AG", "AI", "AL", "AM", "AN", "AO", "AQ", "AR", "AS", "AT", "AU", "AW", "AX", "AZ", "BA", "BB", "BD", "BE", "BF", "BG", "BH", "BI", "BJ", "BL", "BM", "BN", "BO", "BQ", "BR", "BS", "BT", "BV", "BW", "BY", "BZ", "CA", "CC", "CD", "CF", "CG", "CH", "CI", "CK", "CL", "CM", "CN", "CO", "CR", "CU", "CV", "CW", "CX", "CY", "CZ", "DE", "DJ", "DK", "DM", "DO", "DZ", "EC", "EE", "EG", "EH", "ER", "ES", "ET", "FI", "FJ", "FK", "FM", "FO", "FR", "GA", "GB", "GD", "GE", "GF", "GG", "GH", "GI", "GL", "GM", "GN", "GP", "GQ", "GR", "GS", "GT", "GU", "GW", "GY", "HK", "HM", "HN", "HR", "HT", "HU", "IC", "ID", "IE", "IL", "IM", "IN", "IO", "IQ", "IR", "IS", "IT", "JE", "JM", "JO", "JP", "KE", "KG", "KH", "KI", "KM", "KN", "KP", "KR", "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", "XK", "YE", "YT", "ZA", "ZM", "ZW" ], "title": "ItAssetsAssetIdArchivePostResponsesContentApplicationJsonSchemaDataActionsAssetCountry", "type": "string" }, "ItAssetsAssetIdArchivePostResponsesContentApplicationJsonSchemaDataActionsAssignAddonToOwnAsset": { "description": "Assign an add-on to an organization-owned asset", "properties": { "details": { "description": "Action-specific context needed to perform the action. Populated for enabled and\ndisabled actions (so callers can see what a successful attempt would look like);\nnull when the action is not applicable to this asset.", "oneOf": [ { "$ref": "#/components/schemas/ItAssetsAssetIdArchivePostResponsesContentApplicationJsonSchemaDataActionsAssignAddonToOwnAssetDetails" }, { "type": "null" } ] }, "disabled_reasons": { "description": "Reasons why the action is disabled. Empty when the action is enabled or not applicable", "items": { "$ref": "#/components/schemas/ItAssetsAssetIdArchivePostResponsesContentApplicationJsonSchemaDataActionsAssignAddonToOwnAssetDisabledReasonsItems" }, "type": "array" }, "status": { "$ref": "#/components/schemas/ItAssetsAssetIdArchivePostResponsesContentApplicationJsonSchemaDataActionsAssignAddonToOwnAssetStatus", "description": "Whether the action is currently available for this asset" } }, "required": [ "status", "details", "disabled_reasons" ], "title": "ItAssetsAssetIdArchivePostResponsesContentApplicationJsonSchemaDataActionsAssignAddonToOwnAsset", "type": "object" }, "ItAssetsAssetIdArchivePostResponsesContentApplicationJsonSchemaDataActionsAssignAddonToOwnAssetDetails": { "description": "Action-specific context needed to perform the action. Populated for enabled and\ndisabled actions (so callers can see what a successful attempt would look like);\nnull when the action is not applicable to this asset.", "properties": { "addons": { "description": "Add-ons that can be assigned to the asset, with a fail reason for those that don't qualify", "items": { "$ref": "#/components/schemas/ItAssetsAssetIdArchivePostResponsesContentApplicationJsonSchemaDataActionsAssignAddonToOwnAssetDetailsAddonsItems" }, "type": "array" } }, "required": [ "addons" ], "title": "ItAssetsAssetIdArchivePostResponsesContentApplicationJsonSchemaDataActionsAssignAddonToOwnAssetDetails", "type": "object" }, "ItAssetsAssetIdArchivePostResponsesContentApplicationJsonSchemaDataActionsAssignAddonToOwnAssetDetailsAddonsItems": { "properties": { "addon": { "$ref": "#/components/schemas/ItAssetsAssetIdArchivePostResponsesContentApplicationJsonSchemaDataActionsAssignAddonToOwnAssetDetailsAddonsItemsAddon", "description": "Add-on that can be assigned to the asset" }, "fail_reason": { "description": "Reason the add-on cannot be assigned to the asset. Null when assignment is allowed", "oneOf": [ { "$ref": "#/components/schemas/ItAssetsAssetIdArchivePostResponsesContentApplicationJsonSchemaDataActionsAssignAddonToOwnAssetDetailsAddonsItemsFailReason" }, { "type": "null" } ] } }, "required": [ "addon", "fail_reason" ], "title": "ItAssetsAssetIdArchivePostResponsesContentApplicationJsonSchemaDataActionsAssignAddonToOwnAssetDetailsAddonsItems", "type": "object" }, "ItAssetsAssetIdArchivePostResponsesContentApplicationJsonSchemaDataActionsAssignAddonToOwnAssetDetailsAddonsItemsAddon": { "description": "Add-on that can be assigned to the asset", "properties": { "id": { "description": "ID of the add-on", "format": "uuid", "type": "string" }, "name": { "description": "Public display name of the add-on", "type": "string" } }, "required": [ "id", "name" ], "title": "ItAssetsAssetIdArchivePostResponsesContentApplicationJsonSchemaDataActionsAssignAddonToOwnAssetDetailsAddonsItemsAddon", "type": "object" }, "ItAssetsAssetIdArchivePostResponsesContentApplicationJsonSchemaDataActionsAssignAddonToOwnAssetDetailsAddonsItemsFailReason": { "description": "Reason the add-on cannot be assigned to the asset. Null when assignment is allowed", "enum": [ "ADDON_NOT_AVAILABLE_TO_ORGANIZATION", "ALREADY_ASSIGNED", "HAS_ACTIVE_SERVICE_ADDON", "INVALID_ASSET_AGE", "INVALID_CONTRACT_TYPE", "INVALID_DURATION", "INVALID_PAYMENT_SCHEMA", "INVALID_PLATFORM_TIER", "INVALID_PRODUCT_BRAND", "INVALID_PRODUCT_CATEGORY", "INVALID_PRODUCT_PARENT_CATEGORY", "INVALID_RENTAL_TERM", "NO_MATCHING_ORGANIZATION_CONTRACT", "OTHER" ], "title": "ItAssetsAssetIdArchivePostResponsesContentApplicationJsonSchemaDataActionsAssignAddonToOwnAssetDetailsAddonsItemsFailReason", "type": "string" }, "ItAssetsAssetIdArchivePostResponsesContentApplicationJsonSchemaDataActionsAssignAddonToOwnAssetDisabledReasonsItems": { "enum": [ "ARCHIVED", "AT_DEEL_WAREHOUSE", "BEING_REPAIRED", "CONSUMABLE", "CONTROLLED_BY_DEEL", "COUNTRY_NOT_SUPPORTED_FOR_HUB", "COUNTRY_NOT_SUPPORTED_FOR_LOCAL", "DEEL_OWNED_ITEM_WITHOUT_RENTAL_CONTRACT", "DESKTOP_STORAGE", "ENDING_CONTRACT", "HUB_IN_SAME_REGION_AS_LOCAL", "INACTIVE", "INVALID_ITEM_LOCATION", "INVALID_ORGANIZATION_STATUS", "INVALID_STATE", "ITEM_CONDITIONS_TO_UNARCHIVE_NOT_MET", "ITEM_NOT_VISIBLE_FOR_ORGANIZATION", "NON_DEVICE", "NOT_AT_WAREHOUSE", "NOT_AVAILABLE_FOR_REUSE", "NOT_A_RENTAL", "NOT_MANAGEABLE_BY_ORGANIZATION", "NOT_WITH_ASSIGNMENT", "NOT_WITH_USER", "NO_ACTIVE_ADDONS", "NO_ACTIVE_STORAGE_CONTRACT", "NO_LOCATION_FOR_STORAGE", "NO_LOGISTICS_FOR_STORAGE", "NO_VALID_ADDONS", "ONGOING_SERVICE", "OWNED_BY_DEEL", "OWNED_BY_ORGANIZATION", "OWNED_BY_PARTNER_ORGANIZATION", "PARTNER_CHILD_CONTRACT", "PENDING_DEVICE_REFRESH", "RENTAL_CONTRACT_AND_USER_REGION_DO_NOT_MATCH", "TEMPORARILY_UNAVAILABLE", "UNKNOWN", "USER_HAS_NO_COUNTRY", "USER_HAS_NO_SEAT", "WAITING_FOR_CLEARANCE", "WITH_LOANER_ASSIGNMENT", "WITH_NON_COLLECTED_ASSIGNMENT", "WITH_NON_DELIVERED_ASSIGNMENT", "WITH_PENDING_ASSIGNMENT", "WRONG_ASSIGNMENT_STATUS", "WRONG_CONTRACT_STATUS", "WRONG_TERMS_AND_CONDITIONS" ], "title": "ItAssetsAssetIdArchivePostResponsesContentApplicationJsonSchemaDataActionsAssignAddonToOwnAssetDisabledReasonsItems", "type": "string" }, "ItAssetsAssetIdArchivePostResponsesContentApplicationJsonSchemaDataActionsAssignAddonToOwnAssetStatus": { "description": "Whether the action is currently available for this asset", "enum": [ "DISABLED", "ENABLED", "NOT_APPLICABLE" ], "title": "ItAssetsAssetIdArchivePostResponsesContentApplicationJsonSchemaDataActionsAssignAddonToOwnAssetStatus", "type": "string" }, "ItAssetsAssetIdArchivePostResponsesContentApplicationJsonSchemaDataActionsClearOwnAsset": { "description": "Clear an organization-owned asset from the fleet", "properties": { "disabled_reasons": { "description": "Reasons why the action is disabled. Empty when the action is enabled or not applicable", "items": { "$ref": "#/components/schemas/ItAssetsAssetIdArchivePostResponsesContentApplicationJsonSchemaDataActionsClearOwnAssetDisabledReasonsItems" }, "type": "array" }, "status": { "$ref": "#/components/schemas/ItAssetsAssetIdArchivePostResponsesContentApplicationJsonSchemaDataActionsClearOwnAssetStatus", "description": "Whether the action is currently available for this asset" } }, "required": [ "status", "disabled_reasons" ], "title": "ItAssetsAssetIdArchivePostResponsesContentApplicationJsonSchemaDataActionsClearOwnAsset", "type": "object" }, "ItAssetsAssetIdArchivePostResponsesContentApplicationJsonSchemaDataActionsClearOwnAssetDisabledReasonsItems": { "enum": [ "ARCHIVED", "AT_DEEL_WAREHOUSE", "BEING_REPAIRED", "CONSUMABLE", "CONTROLLED_BY_DEEL", "COUNTRY_NOT_SUPPORTED_FOR_HUB", "COUNTRY_NOT_SUPPORTED_FOR_LOCAL", "DEEL_OWNED_ITEM_WITHOUT_RENTAL_CONTRACT", "DESKTOP_STORAGE", "ENDING_CONTRACT", "HUB_IN_SAME_REGION_AS_LOCAL", "INACTIVE", "INVALID_ITEM_LOCATION", "INVALID_ORGANIZATION_STATUS", "INVALID_STATE", "ITEM_CONDITIONS_TO_UNARCHIVE_NOT_MET", "ITEM_NOT_VISIBLE_FOR_ORGANIZATION", "NON_DEVICE", "NOT_AT_WAREHOUSE", "NOT_AVAILABLE_FOR_REUSE", "NOT_A_RENTAL", "NOT_MANAGEABLE_BY_ORGANIZATION", "NOT_WITH_ASSIGNMENT", "NOT_WITH_USER", "NO_ACTIVE_ADDONS", "NO_ACTIVE_STORAGE_CONTRACT", "NO_LOCATION_FOR_STORAGE", "NO_LOGISTICS_FOR_STORAGE", "NO_VALID_ADDONS", "ONGOING_SERVICE", "OWNED_BY_DEEL", "OWNED_BY_ORGANIZATION", "OWNED_BY_PARTNER_ORGANIZATION", "PARTNER_CHILD_CONTRACT", "PENDING_DEVICE_REFRESH", "RENTAL_CONTRACT_AND_USER_REGION_DO_NOT_MATCH", "TEMPORARILY_UNAVAILABLE", "UNKNOWN", "USER_HAS_NO_COUNTRY", "USER_HAS_NO_SEAT", "WAITING_FOR_CLEARANCE", "WITH_LOANER_ASSIGNMENT", "WITH_NON_COLLECTED_ASSIGNMENT", "WITH_NON_DELIVERED_ASSIGNMENT", "WITH_PENDING_ASSIGNMENT", "WRONG_ASSIGNMENT_STATUS", "WRONG_CONTRACT_STATUS", "WRONG_TERMS_AND_CONDITIONS" ], "title": "ItAssetsAssetIdArchivePostResponsesContentApplicationJsonSchemaDataActionsClearOwnAssetDisabledReasonsItems", "type": "string" }, "ItAssetsAssetIdArchivePostResponsesContentApplicationJsonSchemaDataActionsClearOwnAssetStatus": { "description": "Whether the action is currently available for this asset", "enum": [ "DISABLED", "ENABLED", "NOT_APPLICABLE" ], "title": "ItAssetsAssetIdArchivePostResponsesContentApplicationJsonSchemaDataActionsClearOwnAssetStatus", "type": "string" }, "ItAssetsAssetIdArchivePostResponsesContentApplicationJsonSchemaDataActionsManageEndOfRentalContractActions": { "description": "Manage end-of-rental options for a Deel-owned rental asset", "properties": { "disabled_reasons": { "description": "Reasons why the action is disabled. Empty when the action is enabled or not applicable", "items": { "$ref": "#/components/schemas/ItAssetsAssetIdArchivePostResponsesContentApplicationJsonSchemaDataActionsManageEndOfRentalContractActionsDisabledReasonsItems" }, "type": "array" }, "status": { "$ref": "#/components/schemas/ItAssetsAssetIdArchivePostResponsesContentApplicationJsonSchemaDataActionsManageEndOfRentalContractActionsStatus", "description": "Whether the action is currently available for this asset" } }, "required": [ "status", "disabled_reasons" ], "title": "ItAssetsAssetIdArchivePostResponsesContentApplicationJsonSchemaDataActionsManageEndOfRentalContractActions", "type": "object" }, "ItAssetsAssetIdArchivePostResponsesContentApplicationJsonSchemaDataActionsManageEndOfRentalContractActionsDisabledReasonsItems": { "enum": [ "ARCHIVED", "AT_DEEL_WAREHOUSE", "BEING_REPAIRED", "CONSUMABLE", "CONTROLLED_BY_DEEL", "COUNTRY_NOT_SUPPORTED_FOR_HUB", "COUNTRY_NOT_SUPPORTED_FOR_LOCAL", "DEEL_OWNED_ITEM_WITHOUT_RENTAL_CONTRACT", "DESKTOP_STORAGE", "ENDING_CONTRACT", "HUB_IN_SAME_REGION_AS_LOCAL", "INACTIVE", "INVALID_ITEM_LOCATION", "INVALID_ORGANIZATION_STATUS", "INVALID_STATE", "ITEM_CONDITIONS_TO_UNARCHIVE_NOT_MET", "ITEM_NOT_VISIBLE_FOR_ORGANIZATION", "NON_DEVICE", "NOT_AT_WAREHOUSE", "NOT_AVAILABLE_FOR_REUSE", "NOT_A_RENTAL", "NOT_MANAGEABLE_BY_ORGANIZATION", "NOT_WITH_ASSIGNMENT", "NOT_WITH_USER", "NO_ACTIVE_ADDONS", "NO_ACTIVE_STORAGE_CONTRACT", "NO_LOCATION_FOR_STORAGE", "NO_LOGISTICS_FOR_STORAGE", "NO_VALID_ADDONS", "ONGOING_SERVICE", "OWNED_BY_DEEL", "OWNED_BY_ORGANIZATION", "OWNED_BY_PARTNER_ORGANIZATION", "PARTNER_CHILD_CONTRACT", "PENDING_DEVICE_REFRESH", "RENTAL_CONTRACT_AND_USER_REGION_DO_NOT_MATCH", "TEMPORARILY_UNAVAILABLE", "UNKNOWN", "USER_HAS_NO_COUNTRY", "USER_HAS_NO_SEAT", "WAITING_FOR_CLEARANCE", "WITH_LOANER_ASSIGNMENT", "WITH_NON_COLLECTED_ASSIGNMENT", "WITH_NON_DELIVERED_ASSIGNMENT", "WITH_PENDING_ASSIGNMENT", "WRONG_ASSIGNMENT_STATUS", "WRONG_CONTRACT_STATUS", "WRONG_TERMS_AND_CONDITIONS" ], "title": "ItAssetsAssetIdArchivePostResponsesContentApplicationJsonSchemaDataActionsManageEndOfRentalContractActionsDisabledReasonsItems", "type": "string" }, "ItAssetsAssetIdArchivePostResponsesContentApplicationJsonSchemaDataActionsManageEndOfRentalContractActionsStatus": { "description": "Whether the action is currently available for this asset", "enum": [ "DISABLED", "ENABLED", "NOT_APPLICABLE" ], "title": "ItAssetsAssetIdArchivePostResponsesContentApplicationJsonSchemaDataActionsManageEndOfRentalContractActionsStatus", "type": "string" }, "ItAssetsAssetIdArchivePostResponsesContentApplicationJsonSchemaDataActionsPurchaseRental": { "description": "Purchase a Deel-owned rental asset at end of contract", "properties": { "details": { "description": "Action-specific context needed to perform the action. Populated for enabled and\ndisabled actions (so callers can see what a successful attempt would look like);\nnull when the action is not applicable to this asset.", "oneOf": [ { "$ref": "#/components/schemas/ItAssetsAssetIdArchivePostResponsesContentApplicationJsonSchemaDataActionsPurchaseRentalDetails" }, { "type": "null" } ] }, "disabled_reasons": { "description": "Reasons why the action is disabled. Empty when the action is enabled or not applicable", "items": { "$ref": "#/components/schemas/ItAssetsAssetIdArchivePostResponsesContentApplicationJsonSchemaDataActionsPurchaseRentalDisabledReasonsItems" }, "type": "array" }, "status": { "$ref": "#/components/schemas/ItAssetsAssetIdArchivePostResponsesContentApplicationJsonSchemaDataActionsPurchaseRentalStatus", "description": "Whether the action is currently available for this asset" } }, "required": [ "status", "details", "disabled_reasons" ], "title": "ItAssetsAssetIdArchivePostResponsesContentApplicationJsonSchemaDataActionsPurchaseRental", "type": "object" }, "ItAssetsAssetIdArchivePostResponsesContentApplicationJsonSchemaDataActionsPurchaseRentalDetails": { "description": "Action-specific context needed to perform the action. Populated for enabled and\ndisabled actions (so callers can see what a successful attempt would look like);\nnull when the action is not applicable to this asset.", "properties": { "purchase_price": { "description": "Estimated price to purchase the asset at the end of the rental contract", "oneOf": [ { "$ref": "#/components/schemas/ItAssetsAssetIdArchivePostResponsesContentApplicationJsonSchemaDataActionsPurchaseRentalDetailsPurchasePrice" }, { "type": "null" } ] }, "remaining_contract_value": { "$ref": "#/components/schemas/ItAssetsAssetIdArchivePostResponsesContentApplicationJsonSchemaDataActionsPurchaseRentalDetailsRemainingContractValue", "description": "Estimated remaining value of the rental contract" }, "total_purchase_price": { "description": "Estimated total price of the purchase, including any remaining contract value", "oneOf": [ { "$ref": "#/components/schemas/ItAssetsAssetIdArchivePostResponsesContentApplicationJsonSchemaDataActionsPurchaseRentalDetailsTotalPurchasePrice" }, { "type": "null" } ] } }, "required": [ "purchase_price", "total_purchase_price", "remaining_contract_value" ], "title": "ItAssetsAssetIdArchivePostResponsesContentApplicationJsonSchemaDataActionsPurchaseRentalDetails", "type": "object" }, "ItAssetsAssetIdArchivePostResponsesContentApplicationJsonSchemaDataActionsPurchaseRentalDetailsPurchasePrice": { "description": "Estimated price to purchase the asset at the end of the rental contract", "properties": { "amount": { "description": "Amount", "format": "decimal", "type": "string" }, "currency": { "$ref": "#/components/schemas/ItAssetsAssetIdArchivePostResponsesContentApplicationJsonSchemaDataActionsPurchaseRentalDetailsPurchasePriceCurrency", "description": "Three-letter currency code for the price" } }, "required": [ "amount", "currency" ], "title": "ItAssetsAssetIdArchivePostResponsesContentApplicationJsonSchemaDataActionsPurchaseRentalDetailsPurchasePrice", "type": "object" }, "ItAssetsAssetIdArchivePostResponsesContentApplicationJsonSchemaDataActionsPurchaseRentalDetailsPurchasePriceCurrency": { "description": "Three-letter currency code for the price", "enum": [ "AED", "AFN", "ALL", "AMD", "ANG", "AOA", "ARS", "AUD", "AWG", "AZN", "BAM", "BDT", "BGN", "BHD", "BIF", "BMD", "BOB", "BRL", "BSD", "BTN", "BWP", "BYN", "BZD", "CAD", "CDF", "CHF", "CLP", "CNY", "COP", "CRC", "CUC", "CVE", "CZK", "DJF", "DKK", "DOP", "DZD", "EGP", "ERN", "ETB", "EUR", "FJD", "FKP", "GBP", "GEL", "GHS", "GIP", "GMD", "GNF", "GTQ", "GYD", "HKD", "HNL", "HRK", "HTG", "HUF", "IDR", "ILS", "INR", "IQD", "IRR", "ISK", "JMD", "JOD", "JPY", "KES", "KGS", "KHR", "KMF", "KPW", "KRW", "KWD", "KYD", "KZT", "LAK", "LBP", "LKR", "LRD", "LSL", "LTL", "LYD", "MAD", "MDL", "MGA", "MKD", "MMK", "MNT", "MRU", "MUR", "MVR", "MWK", "MXN", "MYR", "MZN", "NAD", "NGN", "NIO", "NOK", "NPR", "NZD", "OMR", "PAB", "PEN", "PGK", "PHP", "PKR", "PLN", "PYG", "QAR", "RON", "RSD", "RUB", "RWF", "SAR", "SBD", "SCR", "SDG", "SEK", "SGD", "SHP", "SLL", "SOS", "SRD", "SSP", "STD", "SYP", "SZL", "THB", "TJS", "TMT", "TND", "TOP", "TRY", "TTD", "TWD", "TZS", "UAH", "UGX", "USD", "UYU", "UZS", "VEF", "VND", "VUV", "WST", "XAF", "XCD", "XOF", "XPF", "YER", "ZAR", "ZMW", "ZWD" ], "title": "ItAssetsAssetIdArchivePostResponsesContentApplicationJsonSchemaDataActionsPurchaseRentalDetailsPurchasePriceCurrency", "type": "string" }, "ItAssetsAssetIdArchivePostResponsesContentApplicationJsonSchemaDataActionsPurchaseRentalDetailsRemainingContractValue": { "description": "Estimated remaining value of the rental contract", "properties": { "amount": { "description": "Amount", "format": "decimal", "type": "string" }, "currency": { "$ref": "#/components/schemas/ItAssetsAssetIdArchivePostResponsesContentApplicationJsonSchemaDataActionsPurchaseRentalDetailsRemainingContractValueCurrency", "description": "Three-letter currency code for the price" } }, "required": [ "amount", "currency" ], "title": "ItAssetsAssetIdArchivePostResponsesContentApplicationJsonSchemaDataActionsPurchaseRentalDetailsRemainingContractValue", "type": "object" }, "ItAssetsAssetIdArchivePostResponsesContentApplicationJsonSchemaDataActionsPurchaseRentalDetailsRemainingContractValueCurrency": { "description": "Three-letter currency code for the price", "enum": [ "AED", "AFN", "ALL", "AMD", "ANG", "AOA", "ARS", "AUD", "AWG", "AZN", "BAM", "BDT", "BGN", "BHD", "BIF", "BMD", "BOB", "BRL", "BSD", "BTN", "BWP", "BYN", "BZD", "CAD", "CDF", "CHF", "CLP", "CNY", "COP", "CRC", "CUC", "CVE", "CZK", "DJF", "DKK", "DOP", "DZD", "EGP", "ERN", "ETB", "EUR", "FJD", "FKP", "GBP", "GEL", "GHS", "GIP", "GMD", "GNF", "GTQ", "GYD", "HKD", "HNL", "HRK", "HTG", "HUF", "IDR", "ILS", "INR", "IQD", "IRR", "ISK", "JMD", "JOD", "JPY", "KES", "KGS", "KHR", "KMF", "KPW", "KRW", "KWD", "KYD", "KZT", "LAK", "LBP", "LKR", "LRD", "LSL", "LTL", "LYD", "MAD", "MDL", "MGA", "MKD", "MMK", "MNT", "MRU", "MUR", "MVR", "MWK", "MXN", "MYR", "MZN", "NAD", "NGN", "NIO", "NOK", "NPR", "NZD", "OMR", "PAB", "PEN", "PGK", "PHP", "PKR", "PLN", "PYG", "QAR", "RON", "RSD", "RUB", "RWF", "SAR", "SBD", "SCR", "SDG", "SEK", "SGD", "SHP", "SLL", "SOS", "SRD", "SSP", "STD", "SYP", "SZL", "THB", "TJS", "TMT", "TND", "TOP", "TRY", "TTD", "TWD", "TZS", "UAH", "UGX", "USD", "UYU", "UZS", "VEF", "VND", "VUV", "WST", "XAF", "XCD", "XOF", "XPF", "YER", "ZAR", "ZMW", "ZWD" ], "title": "ItAssetsAssetIdArchivePostResponsesContentApplicationJsonSchemaDataActionsPurchaseRentalDetailsRemainingContractValueCurrency", "type": "string" }, "ItAssetsAssetIdArchivePostResponsesContentApplicationJsonSchemaDataActionsPurchaseRentalDetailsTotalPurchasePrice": { "description": "Estimated total price of the purchase, including any remaining contract value", "properties": { "amount": { "description": "Amount", "format": "decimal", "type": "string" }, "currency": { "$ref": "#/components/schemas/ItAssetsAssetIdArchivePostResponsesContentApplicationJsonSchemaDataActionsPurchaseRentalDetailsTotalPurchasePriceCurrency", "description": "Three-letter currency code for the price" } }, "required": [ "amount", "currency" ], "title": "ItAssetsAssetIdArchivePostResponsesContentApplicationJsonSchemaDataActionsPurchaseRentalDetailsTotalPurchasePrice", "type": "object" }, "ItAssetsAssetIdArchivePostResponsesContentApplicationJsonSchemaDataActionsPurchaseRentalDetailsTotalPurchasePriceCurrency": { "description": "Three-letter currency code for the price", "enum": [ "AED", "AFN", "ALL", "AMD", "ANG", "AOA", "ARS", "AUD", "AWG", "AZN", "BAM", "BDT", "BGN", "BHD", "BIF", "BMD", "BOB", "BRL", "BSD", "BTN", "BWP", "BYN", "BZD", "CAD", "CDF", "CHF", "CLP", "CNY", "COP", "CRC", "CUC", "CVE", "CZK", "DJF", "DKK", "DOP", "DZD", "EGP", "ERN", "ETB", "EUR", "FJD", "FKP", "GBP", "GEL", "GHS", "GIP", "GMD", "GNF", "GTQ", "GYD", "HKD", "HNL", "HRK", "HTG", "HUF", "IDR", "ILS", "INR", "IQD", "IRR", "ISK", "JMD", "JOD", "JPY", "KES", "KGS", "KHR", "KMF", "KPW", "KRW", "KWD", "KYD", "KZT", "LAK", "LBP", "LKR", "LRD", "LSL", "LTL", "LYD", "MAD", "MDL", "MGA", "MKD", "MMK", "MNT", "MRU", "MUR", "MVR", "MWK", "MXN", "MYR", "MZN", "NAD", "NGN", "NIO", "NOK", "NPR", "NZD", "OMR", "PAB", "PEN", "PGK", "PHP", "PKR", "PLN", "PYG", "QAR", "RON", "RSD", "RUB", "RWF", "SAR", "SBD", "SCR", "SDG", "SEK", "SGD", "SHP", "SLL", "SOS", "SRD", "SSP", "STD", "SYP", "SZL", "THB", "TJS", "TMT", "TND", "TOP", "TRY", "TTD", "TWD", "TZS", "UAH", "UGX", "USD", "UYU", "UZS", "VEF", "VND", "VUV", "WST", "XAF", "XCD", "XOF", "XPF", "YER", "ZAR", "ZMW", "ZWD" ], "title": "ItAssetsAssetIdArchivePostResponsesContentApplicationJsonSchemaDataActionsPurchaseRentalDetailsTotalPurchasePriceCurrency", "type": "string" }, "ItAssetsAssetIdArchivePostResponsesContentApplicationJsonSchemaDataActionsPurchaseRentalDisabledReasonsItems": { "enum": [ "ARCHIVED", "AT_DEEL_WAREHOUSE", "BEING_REPAIRED", "CONSUMABLE", "CONTROLLED_BY_DEEL", "COUNTRY_NOT_SUPPORTED_FOR_HUB", "COUNTRY_NOT_SUPPORTED_FOR_LOCAL", "DEEL_OWNED_ITEM_WITHOUT_RENTAL_CONTRACT", "DESKTOP_STORAGE", "ENDING_CONTRACT", "HUB_IN_SAME_REGION_AS_LOCAL", "INACTIVE", "INVALID_ITEM_LOCATION", "INVALID_ORGANIZATION_STATUS", "INVALID_STATE", "ITEM_CONDITIONS_TO_UNARCHIVE_NOT_MET", "ITEM_NOT_VISIBLE_FOR_ORGANIZATION", "NON_DEVICE", "NOT_AT_WAREHOUSE", "NOT_AVAILABLE_FOR_REUSE", "NOT_A_RENTAL", "NOT_MANAGEABLE_BY_ORGANIZATION", "NOT_WITH_ASSIGNMENT", "NOT_WITH_USER", "NO_ACTIVE_ADDONS", "NO_ACTIVE_STORAGE_CONTRACT", "NO_LOCATION_FOR_STORAGE", "NO_LOGISTICS_FOR_STORAGE", "NO_VALID_ADDONS", "ONGOING_SERVICE", "OWNED_BY_DEEL", "OWNED_BY_ORGANIZATION", "OWNED_BY_PARTNER_ORGANIZATION", "PARTNER_CHILD_CONTRACT", "PENDING_DEVICE_REFRESH", "RENTAL_CONTRACT_AND_USER_REGION_DO_NOT_MATCH", "TEMPORARILY_UNAVAILABLE", "UNKNOWN", "USER_HAS_NO_COUNTRY", "USER_HAS_NO_SEAT", "WAITING_FOR_CLEARANCE", "WITH_LOANER_ASSIGNMENT", "WITH_NON_COLLECTED_ASSIGNMENT", "WITH_NON_DELIVERED_ASSIGNMENT", "WITH_PENDING_ASSIGNMENT", "WRONG_ASSIGNMENT_STATUS", "WRONG_CONTRACT_STATUS", "WRONG_TERMS_AND_CONDITIONS" ], "title": "ItAssetsAssetIdArchivePostResponsesContentApplicationJsonSchemaDataActionsPurchaseRentalDisabledReasonsItems", "type": "string" }, "ItAssetsAssetIdArchivePostResponsesContentApplicationJsonSchemaDataActionsPurchaseRentalStatus": { "description": "Whether the action is currently available for this asset", "enum": [ "DISABLED", "ENABLED", "NOT_APPLICABLE" ], "title": "ItAssetsAssetIdArchivePostResponsesContentApplicationJsonSchemaDataActionsPurchaseRentalStatus", "type": "string" }, "ItAssetsAssetIdArchivePostResponsesContentApplicationJsonSchemaDataActionsReturnRentalToDeel": { "description": "Return a Deel-owned rental asset back to Deel", "properties": { "details": { "description": "Action-specific context needed to perform the action. Populated for enabled and\ndisabled actions (so callers can see what a successful attempt would look like);\nnull when the action is not applicable to this asset.", "oneOf": [ { "$ref": "#/components/schemas/ItAssetsAssetIdArchivePostResponsesContentApplicationJsonSchemaDataActionsReturnRentalToDeelDetails" }, { "type": "null" } ] }, "disabled_reasons": { "description": "Reasons why the action is disabled. Empty when the action is enabled or not applicable", "items": { "$ref": "#/components/schemas/ItAssetsAssetIdArchivePostResponsesContentApplicationJsonSchemaDataActionsReturnRentalToDeelDisabledReasonsItems" }, "type": "array" }, "status": { "$ref": "#/components/schemas/ItAssetsAssetIdArchivePostResponsesContentApplicationJsonSchemaDataActionsReturnRentalToDeelStatus", "description": "Whether the action is currently available for this asset" } }, "required": [ "status", "details", "disabled_reasons" ], "title": "ItAssetsAssetIdArchivePostResponsesContentApplicationJsonSchemaDataActionsReturnRentalToDeel", "type": "object" }, "ItAssetsAssetIdArchivePostResponsesContentApplicationJsonSchemaDataActionsReturnRentalToDeelDetails": { "description": "Action-specific context needed to perform the action. Populated for enabled and\ndisabled actions (so callers can see what a successful attempt would look like);\nnull when the action is not applicable to this asset.", "properties": { "end_contract_price": { "$ref": "#/components/schemas/ItAssetsAssetIdArchivePostResponsesContentApplicationJsonSchemaDataActionsReturnRentalToDeelDetailsEndContractPrice", "description": "Estimated end-of-contract price charged when returning the asset" } }, "required": [ "end_contract_price" ], "title": "ItAssetsAssetIdArchivePostResponsesContentApplicationJsonSchemaDataActionsReturnRentalToDeelDetails", "type": "object" }, "ItAssetsAssetIdArchivePostResponsesContentApplicationJsonSchemaDataActionsReturnRentalToDeelDetailsEndContractPrice": { "description": "Estimated end-of-contract price charged when returning the asset", "properties": { "amount": { "description": "Amount", "format": "decimal", "type": "string" }, "currency": { "$ref": "#/components/schemas/ItAssetsAssetIdArchivePostResponsesContentApplicationJsonSchemaDataActionsReturnRentalToDeelDetailsEndContractPriceCurrency", "description": "Three-letter currency code for the price" } }, "required": [ "amount", "currency" ], "title": "ItAssetsAssetIdArchivePostResponsesContentApplicationJsonSchemaDataActionsReturnRentalToDeelDetailsEndContractPrice", "type": "object" }, "ItAssetsAssetIdArchivePostResponsesContentApplicationJsonSchemaDataActionsReturnRentalToDeelDetailsEndContractPriceCurrency": { "description": "Three-letter currency code for the price", "enum": [ "AED", "AFN", "ALL", "AMD", "ANG", "AOA", "ARS", "AUD", "AWG", "AZN", "BAM", "BDT", "BGN", "BHD", "BIF", "BMD", "BOB", "BRL", "BSD", "BTN", "BWP", "BYN", "BZD", "CAD", "CDF", "CHF", "CLP", "CNY", "COP", "CRC", "CUC", "CVE", "CZK", "DJF", "DKK", "DOP", "DZD", "EGP", "ERN", "ETB", "EUR", "FJD", "FKP", "GBP", "GEL", "GHS", "GIP", "GMD", "GNF", "GTQ", "GYD", "HKD", "HNL", "HRK", "HTG", "HUF", "IDR", "ILS", "INR", "IQD", "IRR", "ISK", "JMD", "JOD", "JPY", "KES", "KGS", "KHR", "KMF", "KPW", "KRW", "KWD", "KYD", "KZT", "LAK", "LBP", "LKR", "LRD", "LSL", "LTL", "LYD", "MAD", "MDL", "MGA", "MKD", "MMK", "MNT", "MRU", "MUR", "MVR", "MWK", "MXN", "MYR", "MZN", "NAD", "NGN", "NIO", "NOK", "NPR", "NZD", "OMR", "PAB", "PEN", "PGK", "PHP", "PKR", "PLN", "PYG", "QAR", "RON", "RSD", "RUB", "RWF", "SAR", "SBD", "SCR", "SDG", "SEK", "SGD", "SHP", "SLL", "SOS", "SRD", "SSP", "STD", "SYP", "SZL", "THB", "TJS", "TMT", "TND", "TOP", "TRY", "TTD", "TWD", "TZS", "UAH", "UGX", "USD", "UYU", "UZS", "VEF", "VND", "VUV", "WST", "XAF", "XCD", "XOF", "XPF", "YER", "ZAR", "ZMW", "ZWD" ], "title": "ItAssetsAssetIdArchivePostResponsesContentApplicationJsonSchemaDataActionsReturnRentalToDeelDetailsEndContractPriceCurrency", "type": "string" }, "ItAssetsAssetIdArchivePostResponsesContentApplicationJsonSchemaDataActionsReturnRentalToDeelDisabledReasonsItems": { "enum": [ "ARCHIVED", "AT_DEEL_WAREHOUSE", "BEING_REPAIRED", "CONSUMABLE", "CONTROLLED_BY_DEEL", "COUNTRY_NOT_SUPPORTED_FOR_HUB", "COUNTRY_NOT_SUPPORTED_FOR_LOCAL", "DEEL_OWNED_ITEM_WITHOUT_RENTAL_CONTRACT", "DESKTOP_STORAGE", "ENDING_CONTRACT", "HUB_IN_SAME_REGION_AS_LOCAL", "INACTIVE", "INVALID_ITEM_LOCATION", "INVALID_ORGANIZATION_STATUS", "INVALID_STATE", "ITEM_CONDITIONS_TO_UNARCHIVE_NOT_MET", "ITEM_NOT_VISIBLE_FOR_ORGANIZATION", "NON_DEVICE", "NOT_AT_WAREHOUSE", "NOT_AVAILABLE_FOR_REUSE", "NOT_A_RENTAL", "NOT_MANAGEABLE_BY_ORGANIZATION", "NOT_WITH_ASSIGNMENT", "NOT_WITH_USER", "NO_ACTIVE_ADDONS", "NO_ACTIVE_STORAGE_CONTRACT", "NO_LOCATION_FOR_STORAGE", "NO_LOGISTICS_FOR_STORAGE", "NO_VALID_ADDONS", "ONGOING_SERVICE", "OWNED_BY_DEEL", "OWNED_BY_ORGANIZATION", "OWNED_BY_PARTNER_ORGANIZATION", "PARTNER_CHILD_CONTRACT", "PENDING_DEVICE_REFRESH", "RENTAL_CONTRACT_AND_USER_REGION_DO_NOT_MATCH", "TEMPORARILY_UNAVAILABLE", "UNKNOWN", "USER_HAS_NO_COUNTRY", "USER_HAS_NO_SEAT", "WAITING_FOR_CLEARANCE", "WITH_LOANER_ASSIGNMENT", "WITH_NON_COLLECTED_ASSIGNMENT", "WITH_NON_DELIVERED_ASSIGNMENT", "WITH_PENDING_ASSIGNMENT", "WRONG_ASSIGNMENT_STATUS", "WRONG_CONTRACT_STATUS", "WRONG_TERMS_AND_CONDITIONS" ], "title": "ItAssetsAssetIdArchivePostResponsesContentApplicationJsonSchemaDataActionsReturnRentalToDeelDisabledReasonsItems", "type": "string" }, "ItAssetsAssetIdArchivePostResponsesContentApplicationJsonSchemaDataActionsReturnRentalToDeelStatus": { "description": "Whether the action is currently available for this asset", "enum": [ "DISABLED", "ENABLED", "NOT_APPLICABLE" ], "title": "ItAssetsAssetIdArchivePostResponsesContentApplicationJsonSchemaDataActionsReturnRentalToDeelStatus", "type": "string" }, "ItAssetsAssetIdArchivePostResponsesContentApplicationJsonSchemaDataActionsReuseOwnAssetFromDeel": { "description": "Redeploy an organization-owned asset stored at a Deel warehouse", "properties": { "details": { "description": "Action-specific context needed to perform the action. Populated for enabled and\ndisabled actions (so callers can see what a successful attempt would look like);\nnull when the action is not applicable to this asset.", "oneOf": [ { "$ref": "#/components/schemas/ItAssetsAssetIdArchivePostResponsesContentApplicationJsonSchemaDataActionsReuseOwnAssetFromDeelDetails" }, { "type": "null" } ] }, "disabled_reasons": { "description": "Reasons why the action is disabled. Empty when the action is enabled or not applicable", "items": { "$ref": "#/components/schemas/ItAssetsAssetIdArchivePostResponsesContentApplicationJsonSchemaDataActionsReuseOwnAssetFromDeelDisabledReasonsItems" }, "type": "array" }, "status": { "$ref": "#/components/schemas/ItAssetsAssetIdArchivePostResponsesContentApplicationJsonSchemaDataActionsReuseOwnAssetFromDeelStatus", "description": "Whether the action is currently available for this asset" } }, "required": [ "status", "details", "disabled_reasons" ], "title": "ItAssetsAssetIdArchivePostResponsesContentApplicationJsonSchemaDataActionsReuseOwnAssetFromDeel", "type": "object" }, "ItAssetsAssetIdArchivePostResponsesContentApplicationJsonSchemaDataActionsReuseOwnAssetFromDeelDetails": { "description": "Action-specific context needed to perform the action. Populated for enabled and\ndisabled actions (so callers can see what a successful attempt would look like);\nnull when the action is not applicable to this asset.", "properties": { "eligible_countries": { "description": "Countries where the asset can be redeployed from Deel", "items": { "$ref": "#/components/schemas/ItAssetsAssetIdArchivePostResponsesContentApplicationJsonSchemaDataActionsReuseOwnAssetFromDeelDetailsEligibleCountriesItems" }, "type": "array" }, "express_delivery": { "description": "Express delivery availability and per-country fees. Null when express delivery is not supported", "oneOf": [ { "$ref": "#/components/schemas/ItAssetsAssetIdArchivePostResponsesContentApplicationJsonSchemaDataActionsReuseOwnAssetFromDeelDetailsExpressDelivery" }, { "type": "null" } ] } }, "required": [ "express_delivery", "eligible_countries" ], "title": "ItAssetsAssetIdArchivePostResponsesContentApplicationJsonSchemaDataActionsReuseOwnAssetFromDeelDetails", "type": "object" }, "ItAssetsAssetIdArchivePostResponsesContentApplicationJsonSchemaDataActionsReuseOwnAssetFromDeelDetailsEligibleCountriesItems": { "enum": [ "AD", "AE", "AF", "AG", "AI", "AL", "AM", "AN", "AO", "AQ", "AR", "AS", "AT", "AU", "AW", "AX", "AZ", "BA", "BB", "BD", "BE", "BF", "BG", "BH", "BI", "BJ", "BL", "BM", "BN", "BO", "BQ", "BR", "BS", "BT", "BV", "BW", "BY", "BZ", "CA", "CC", "CD", "CF", "CG", "CH", "CI", "CK", "CL", "CM", "CN", "CO", "CR", "CU", "CV", "CW", "CX", "CY", "CZ", "DE", "DJ", "DK", "DM", "DO", "DZ", "EC", "EE", "EG", "EH", "ER", "ES", "ET", "FI", "FJ", "FK", "FM", "FO", "FR", "GA", "GB", "GD", "GE", "GF", "GG", "GH", "GI", "GL", "GM", "GN", "GP", "GQ", "GR", "GS", "GT", "GU", "GW", "GY", "HK", "HM", "HN", "HR", "HT", "HU", "IC", "ID", "IE", "IL", "IM", "IN", "IO", "IQ", "IR", "IS", "IT", "JE", "JM", "JO", "JP", "KE", "KG", "KH", "KI", "KM", "KN", "KP", "KR", "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", "XK", "YE", "YT", "ZA", "ZM", "ZW" ], "title": "ItAssetsAssetIdArchivePostResponsesContentApplicationJsonSchemaDataActionsReuseOwnAssetFromDeelDetailsEligibleCountriesItems", "type": "string" }, "ItAssetsAssetIdArchivePostResponsesContentApplicationJsonSchemaDataActionsReuseOwnAssetFromDeelDetailsExpressDelivery": { "description": "Express delivery availability and per-country fees. Null when express delivery is not supported", "properties": { "country_fees": { "additionalProperties": { "$ref": "#/components/schemas/ItAssetsAssetIdArchivePostResponsesContentApplicationJsonSchemaDataActionsReuseOwnAssetFromDeelDetailsExpressDeliveryCountryFees" }, "description": "Express delivery fees keyed by destination country.", "type": "object" } }, "required": [ "country_fees" ], "title": "ItAssetsAssetIdArchivePostResponsesContentApplicationJsonSchemaDataActionsReuseOwnAssetFromDeelDetailsExpressDelivery", "type": "object" }, "ItAssetsAssetIdArchivePostResponsesContentApplicationJsonSchemaDataActionsReuseOwnAssetFromDeelDetailsExpressDeliveryCountryFees": { "properties": { "amount": { "description": "Amount", "format": "decimal", "type": "string" }, "currency": { "$ref": "#/components/schemas/ItAssetsAssetIdArchivePostResponsesContentApplicationJsonSchemaDataActionsReuseOwnAssetFromDeelDetailsExpressDeliveryCountryFeesCurrency", "description": "Three-letter currency code for the price" } }, "required": [ "amount", "currency" ], "title": "ItAssetsAssetIdArchivePostResponsesContentApplicationJsonSchemaDataActionsReuseOwnAssetFromDeelDetailsExpressDeliveryCountryFees", "type": "object" }, "ItAssetsAssetIdArchivePostResponsesContentApplicationJsonSchemaDataActionsReuseOwnAssetFromDeelDetailsExpressDeliveryCountryFeesCurrency": { "description": "Three-letter currency code for the price", "enum": [ "AED", "AFN", "ALL", "AMD", "ANG", "AOA", "ARS", "AUD", "AWG", "AZN", "BAM", "BDT", "BGN", "BHD", "BIF", "BMD", "BOB", "BRL", "BSD", "BTN", "BWP", "BYN", "BZD", "CAD", "CDF", "CHF", "CLP", "CNY", "COP", "CRC", "CUC", "CVE", "CZK", "DJF", "DKK", "DOP", "DZD", "EGP", "ERN", "ETB", "EUR", "FJD", "FKP", "GBP", "GEL", "GHS", "GIP", "GMD", "GNF", "GTQ", "GYD", "HKD", "HNL", "HRK", "HTG", "HUF", "IDR", "ILS", "INR", "IQD", "IRR", "ISK", "JMD", "JOD", "JPY", "KES", "KGS", "KHR", "KMF", "KPW", "KRW", "KWD", "KYD", "KZT", "LAK", "LBP", "LKR", "LRD", "LSL", "LTL", "LYD", "MAD", "MDL", "MGA", "MKD", "MMK", "MNT", "MRU", "MUR", "MVR", "MWK", "MXN", "MYR", "MZN", "NAD", "NGN", "NIO", "NOK", "NPR", "NZD", "OMR", "PAB", "PEN", "PGK", "PHP", "PKR", "PLN", "PYG", "QAR", "RON", "RSD", "RUB", "RWF", "SAR", "SBD", "SCR", "SDG", "SEK", "SGD", "SHP", "SLL", "SOS", "SRD", "SSP", "STD", "SYP", "SZL", "THB", "TJS", "TMT", "TND", "TOP", "TRY", "TTD", "TWD", "TZS", "UAH", "UGX", "USD", "UYU", "UZS", "VEF", "VND", "VUV", "WST", "XAF", "XCD", "XOF", "XPF", "YER", "ZAR", "ZMW", "ZWD" ], "title": "ItAssetsAssetIdArchivePostResponsesContentApplicationJsonSchemaDataActionsReuseOwnAssetFromDeelDetailsExpressDeliveryCountryFeesCurrency", "type": "string" }, "ItAssetsAssetIdArchivePostResponsesContentApplicationJsonSchemaDataActionsReuseOwnAssetFromDeelDisabledReasonsItems": { "enum": [ "ARCHIVED", "AT_DEEL_WAREHOUSE", "BEING_REPAIRED", "CONSUMABLE", "CONTROLLED_BY_DEEL", "COUNTRY_NOT_SUPPORTED_FOR_HUB", "COUNTRY_NOT_SUPPORTED_FOR_LOCAL", "DEEL_OWNED_ITEM_WITHOUT_RENTAL_CONTRACT", "DESKTOP_STORAGE", "ENDING_CONTRACT", "HUB_IN_SAME_REGION_AS_LOCAL", "INACTIVE", "INVALID_ITEM_LOCATION", "INVALID_ORGANIZATION_STATUS", "INVALID_STATE", "ITEM_CONDITIONS_TO_UNARCHIVE_NOT_MET", "ITEM_NOT_VISIBLE_FOR_ORGANIZATION", "NON_DEVICE", "NOT_AT_WAREHOUSE", "NOT_AVAILABLE_FOR_REUSE", "NOT_A_RENTAL", "NOT_MANAGEABLE_BY_ORGANIZATION", "NOT_WITH_ASSIGNMENT", "NOT_WITH_USER", "NO_ACTIVE_ADDONS", "NO_ACTIVE_STORAGE_CONTRACT", "NO_LOCATION_FOR_STORAGE", "NO_LOGISTICS_FOR_STORAGE", "NO_VALID_ADDONS", "ONGOING_SERVICE", "OWNED_BY_DEEL", "OWNED_BY_ORGANIZATION", "OWNED_BY_PARTNER_ORGANIZATION", "PARTNER_CHILD_CONTRACT", "PENDING_DEVICE_REFRESH", "RENTAL_CONTRACT_AND_USER_REGION_DO_NOT_MATCH", "TEMPORARILY_UNAVAILABLE", "UNKNOWN", "USER_HAS_NO_COUNTRY", "USER_HAS_NO_SEAT", "WAITING_FOR_CLEARANCE", "WITH_LOANER_ASSIGNMENT", "WITH_NON_COLLECTED_ASSIGNMENT", "WITH_NON_DELIVERED_ASSIGNMENT", "WITH_PENDING_ASSIGNMENT", "WRONG_ASSIGNMENT_STATUS", "WRONG_CONTRACT_STATUS", "WRONG_TERMS_AND_CONDITIONS" ], "title": "ItAssetsAssetIdArchivePostResponsesContentApplicationJsonSchemaDataActionsReuseOwnAssetFromDeelDisabledReasonsItems", "type": "string" }, "ItAssetsAssetIdArchivePostResponsesContentApplicationJsonSchemaDataActionsReuseOwnAssetFromDeelStatus": { "description": "Whether the action is currently available for this asset", "enum": [ "DISABLED", "ENABLED", "NOT_APPLICABLE" ], "title": "ItAssetsAssetIdArchivePostResponsesContentApplicationJsonSchemaDataActionsReuseOwnAssetFromDeelStatus", "type": "string" }, "ItAssetsAssetIdArchivePostResponsesContentApplicationJsonSchemaDataActionsReuseOwnAssetFromOwnLocation": { "description": "Redeploy an organization-owned asset from an organization-owned location", "properties": { "details": { "description": "Action-specific context needed to perform the action. Populated for enabled and\ndisabled actions (so callers can see what a successful attempt would look like);\nnull when the action is not applicable to this asset.", "oneOf": [ { "$ref": "#/components/schemas/ItAssetsAssetIdArchivePostResponsesContentApplicationJsonSchemaDataActionsReuseOwnAssetFromOwnLocationDetails" }, { "type": "null" } ] }, "disabled_reasons": { "description": "Reasons why the action is disabled. Empty when the action is enabled or not applicable", "items": { "$ref": "#/components/schemas/ItAssetsAssetIdArchivePostResponsesContentApplicationJsonSchemaDataActionsReuseOwnAssetFromOwnLocationDisabledReasonsItems" }, "type": "array" }, "status": { "$ref": "#/components/schemas/ItAssetsAssetIdArchivePostResponsesContentApplicationJsonSchemaDataActionsReuseOwnAssetFromOwnLocationStatus", "description": "Whether the action is currently available for this asset" } }, "required": [ "status", "details", "disabled_reasons" ], "title": "ItAssetsAssetIdArchivePostResponsesContentApplicationJsonSchemaDataActionsReuseOwnAssetFromOwnLocation", "type": "object" }, "ItAssetsAssetIdArchivePostResponsesContentApplicationJsonSchemaDataActionsReuseOwnAssetFromOwnLocationDetails": { "description": "Action-specific context needed to perform the action. Populated for enabled and\ndisabled actions (so callers can see what a successful attempt would look like);\nnull when the action is not applicable to this asset.", "properties": { "eligible_countries": { "description": "Countries where the asset can be redeployed from an organization-owned location", "items": { "$ref": "#/components/schemas/ItAssetsAssetIdArchivePostResponsesContentApplicationJsonSchemaDataActionsReuseOwnAssetFromOwnLocationDetailsEligibleCountriesItems" }, "type": "array" }, "express_delivery": { "description": "Express delivery availability and per-country fees. Null when express delivery is not supported", "oneOf": [ { "$ref": "#/components/schemas/ItAssetsAssetIdArchivePostResponsesContentApplicationJsonSchemaDataActionsReuseOwnAssetFromOwnLocationDetailsExpressDelivery" }, { "type": "null" } ] }, "service_cost": { "$ref": "#/components/schemas/ItAssetsAssetIdArchivePostResponsesContentApplicationJsonSchemaDataActionsReuseOwnAssetFromOwnLocationDetailsServiceCost", "description": "Cost charged for the transfer service" } }, "required": [ "service_cost", "express_delivery", "eligible_countries" ], "title": "ItAssetsAssetIdArchivePostResponsesContentApplicationJsonSchemaDataActionsReuseOwnAssetFromOwnLocationDetails", "type": "object" }, "ItAssetsAssetIdArchivePostResponsesContentApplicationJsonSchemaDataActionsReuseOwnAssetFromOwnLocationDetailsEligibleCountriesItems": { "enum": [ "AD", "AE", "AF", "AG", "AI", "AL", "AM", "AN", "AO", "AQ", "AR", "AS", "AT", "AU", "AW", "AX", "AZ", "BA", "BB", "BD", "BE", "BF", "BG", "BH", "BI", "BJ", "BL", "BM", "BN", "BO", "BQ", "BR", "BS", "BT", "BV", "BW", "BY", "BZ", "CA", "CC", "CD", "CF", "CG", "CH", "CI", "CK", "CL", "CM", "CN", "CO", "CR", "CU", "CV", "CW", "CX", "CY", "CZ", "DE", "DJ", "DK", "DM", "DO", "DZ", "EC", "EE", "EG", "EH", "ER", "ES", "ET", "FI", "FJ", "FK", "FM", "FO", "FR", "GA", "GB", "GD", "GE", "GF", "GG", "GH", "GI", "GL", "GM", "GN", "GP", "GQ", "GR", "GS", "GT", "GU", "GW", "GY", "HK", "HM", "HN", "HR", "HT", "HU", "IC", "ID", "IE", "IL", "IM", "IN", "IO", "IQ", "IR", "IS", "IT", "JE", "JM", "JO", "JP", "KE", "KG", "KH", "KI", "KM", "KN", "KP", "KR", "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", "XK", "YE", "YT", "ZA", "ZM", "ZW" ], "title": "ItAssetsAssetIdArchivePostResponsesContentApplicationJsonSchemaDataActionsReuseOwnAssetFromOwnLocationDetailsEligibleCountriesItems", "type": "string" }, "ItAssetsAssetIdArchivePostResponsesContentApplicationJsonSchemaDataActionsReuseOwnAssetFromOwnLocationDetailsExpressDelivery": { "description": "Express delivery availability and per-country fees. Null when express delivery is not supported", "properties": { "country_fees": { "additionalProperties": { "$ref": "#/components/schemas/ItAssetsAssetIdArchivePostResponsesContentApplicationJsonSchemaDataActionsReuseOwnAssetFromOwnLocationDetailsExpressDeliveryCountryFees" }, "description": "Express delivery fees keyed by destination country.", "type": "object" } }, "required": [ "country_fees" ], "title": "ItAssetsAssetIdArchivePostResponsesContentApplicationJsonSchemaDataActionsReuseOwnAssetFromOwnLocationDetailsExpressDelivery", "type": "object" }, "ItAssetsAssetIdArchivePostResponsesContentApplicationJsonSchemaDataActionsReuseOwnAssetFromOwnLocationDetailsExpressDeliveryCountryFees": { "properties": { "amount": { "description": "Amount", "format": "decimal", "type": "string" }, "currency": { "$ref": "#/components/schemas/ItAssetsAssetIdArchivePostResponsesContentApplicationJsonSchemaDataActionsReuseOwnAssetFromOwnLocationDetailsExpressDeliveryCountryFeesCurrency", "description": "Three-letter currency code for the price" } }, "required": [ "amount", "currency" ], "title": "ItAssetsAssetIdArchivePostResponsesContentApplicationJsonSchemaDataActionsReuseOwnAssetFromOwnLocationDetailsExpressDeliveryCountryFees", "type": "object" }, "ItAssetsAssetIdArchivePostResponsesContentApplicationJsonSchemaDataActionsReuseOwnAssetFromOwnLocationDetailsExpressDeliveryCountryFeesCurrency": { "description": "Three-letter currency code for the price", "enum": [ "AED", "AFN", "ALL", "AMD", "ANG", "AOA", "ARS", "AUD", "AWG", "AZN", "BAM", "BDT", "BGN", "BHD", "BIF", "BMD", "BOB", "BRL", "BSD", "BTN", "BWP", "BYN", "BZD", "CAD", "CDF", "CHF", "CLP", "CNY", "COP", "CRC", "CUC", "CVE", "CZK", "DJF", "DKK", "DOP", "DZD", "EGP", "ERN", "ETB", "EUR", "FJD", "FKP", "GBP", "GEL", "GHS", "GIP", "GMD", "GNF", "GTQ", "GYD", "HKD", "HNL", "HRK", "HTG", "HUF", "IDR", "ILS", "INR", "IQD", "IRR", "ISK", "JMD", "JOD", "JPY", "KES", "KGS", "KHR", "KMF", "KPW", "KRW", "KWD", "KYD", "KZT", "LAK", "LBP", "LKR", "LRD", "LSL", "LTL", "LYD", "MAD", "MDL", "MGA", "MKD", "MMK", "MNT", "MRU", "MUR", "MVR", "MWK", "MXN", "MYR", "MZN", "NAD", "NGN", "NIO", "NOK", "NPR", "NZD", "OMR", "PAB", "PEN", "PGK", "PHP", "PKR", "PLN", "PYG", "QAR", "RON", "RSD", "RUB", "RWF", "SAR", "SBD", "SCR", "SDG", "SEK", "SGD", "SHP", "SLL", "SOS", "SRD", "SSP", "STD", "SYP", "SZL", "THB", "TJS", "TMT", "TND", "TOP", "TRY", "TTD", "TWD", "TZS", "UAH", "UGX", "USD", "UYU", "UZS", "VEF", "VND", "VUV", "WST", "XAF", "XCD", "XOF", "XPF", "YER", "ZAR", "ZMW", "ZWD" ], "title": "ItAssetsAssetIdArchivePostResponsesContentApplicationJsonSchemaDataActionsReuseOwnAssetFromOwnLocationDetailsExpressDeliveryCountryFeesCurrency", "type": "string" }, "ItAssetsAssetIdArchivePostResponsesContentApplicationJsonSchemaDataActionsReuseOwnAssetFromOwnLocationDetailsServiceCost": { "description": "Cost charged for the transfer service", "properties": { "billing_method": { "$ref": "#/components/schemas/ItAssetsAssetIdArchivePostResponsesContentApplicationJsonSchemaDataActionsReuseOwnAssetFromOwnLocationDetailsServiceCostBillingMethod", "description": "How the action is charged. When \"TOKEN\", the fees are covered by an\nadd-on token pool; when \"CURRENCY\", the fees are billed in the currency\nspecified in the \"fees\" field." }, "fees": { "description": "Price charged for the action. Null when billing method is \"TOKEN\"", "oneOf": [ { "$ref": "#/components/schemas/ItAssetsAssetIdArchivePostResponsesContentApplicationJsonSchemaDataActionsReuseOwnAssetFromOwnLocationDetailsServiceCostFees" }, { "type": "null" } ] }, "token_usage": { "description": "Add-on token consumption details. Null when billing method is \"CURRENCY\"", "oneOf": [ { "$ref": "#/components/schemas/ItAssetsAssetIdArchivePostResponsesContentApplicationJsonSchemaDataActionsReuseOwnAssetFromOwnLocationDetailsServiceCostTokenUsage" }, { "type": "null" } ] } }, "required": [ "fees", "token_usage", "billing_method" ], "title": "ItAssetsAssetIdArchivePostResponsesContentApplicationJsonSchemaDataActionsReuseOwnAssetFromOwnLocationDetailsServiceCost", "type": "object" }, "ItAssetsAssetIdArchivePostResponsesContentApplicationJsonSchemaDataActionsReuseOwnAssetFromOwnLocationDetailsServiceCostBillingMethod": { "description": "How the action is charged. When \"TOKEN\", the fees are covered by an\nadd-on token pool; when \"CURRENCY\", the fees are billed in the currency\nspecified in the \"fees\" field.", "enum": [ "CURRENCY", "TOKEN" ], "title": "ItAssetsAssetIdArchivePostResponsesContentApplicationJsonSchemaDataActionsReuseOwnAssetFromOwnLocationDetailsServiceCostBillingMethod", "type": "string" }, "ItAssetsAssetIdArchivePostResponsesContentApplicationJsonSchemaDataActionsReuseOwnAssetFromOwnLocationDetailsServiceCostFees": { "description": "Price charged for the action. Null when billing method is \"TOKEN\"", "properties": { "amount": { "description": "Amount", "format": "decimal", "type": "string" }, "currency": { "$ref": "#/components/schemas/ItAssetsAssetIdArchivePostResponsesContentApplicationJsonSchemaDataActionsReuseOwnAssetFromOwnLocationDetailsServiceCostFeesCurrency", "description": "Three-letter currency code for the price" } }, "required": [ "amount", "currency" ], "title": "ItAssetsAssetIdArchivePostResponsesContentApplicationJsonSchemaDataActionsReuseOwnAssetFromOwnLocationDetailsServiceCostFees", "type": "object" }, "ItAssetsAssetIdArchivePostResponsesContentApplicationJsonSchemaDataActionsReuseOwnAssetFromOwnLocationDetailsServiceCostFeesCurrency": { "description": "Three-letter currency code for the price", "enum": [ "AED", "AFN", "ALL", "AMD", "ANG", "AOA", "ARS", "AUD", "AWG", "AZN", "BAM", "BDT", "BGN", "BHD", "BIF", "BMD", "BOB", "BRL", "BSD", "BTN", "BWP", "BYN", "BZD", "CAD", "CDF", "CHF", "CLP", "CNY", "COP", "CRC", "CUC", "CVE", "CZK", "DJF", "DKK", "DOP", "DZD", "EGP", "ERN", "ETB", "EUR", "FJD", "FKP", "GBP", "GEL", "GHS", "GIP", "GMD", "GNF", "GTQ", "GYD", "HKD", "HNL", "HRK", "HTG", "HUF", "IDR", "ILS", "INR", "IQD", "IRR", "ISK", "JMD", "JOD", "JPY", "KES", "KGS", "KHR", "KMF", "KPW", "KRW", "KWD", "KYD", "KZT", "LAK", "LBP", "LKR", "LRD", "LSL", "LTL", "LYD", "MAD", "MDL", "MGA", "MKD", "MMK", "MNT", "MRU", "MUR", "MVR", "MWK", "MXN", "MYR", "MZN", "NAD", "NGN", "NIO", "NOK", "NPR", "NZD", "OMR", "PAB", "PEN", "PGK", "PHP", "PKR", "PLN", "PYG", "QAR", "RON", "RSD", "RUB", "RWF", "SAR", "SBD", "SCR", "SDG", "SEK", "SGD", "SHP", "SLL", "SOS", "SRD", "SSP", "STD", "SYP", "SZL", "THB", "TJS", "TMT", "TND", "TOP", "TRY", "TTD", "TWD", "TZS", "UAH", "UGX", "USD", "UYU", "UZS", "VEF", "VND", "VUV", "WST", "XAF", "XCD", "XOF", "XPF", "YER", "ZAR", "ZMW", "ZWD" ], "title": "ItAssetsAssetIdArchivePostResponsesContentApplicationJsonSchemaDataActionsReuseOwnAssetFromOwnLocationDetailsServiceCostFeesCurrency", "type": "string" }, "ItAssetsAssetIdArchivePostResponsesContentApplicationJsonSchemaDataActionsReuseOwnAssetFromOwnLocationDetailsServiceCostTokenUsage": { "description": "Add-on token consumption details. Null when billing method is \"CURRENCY\"", "properties": { "addon": { "$ref": "#/components/schemas/ItAssetsAssetIdArchivePostResponsesContentApplicationJsonSchemaDataActionsReuseOwnAssetFromOwnLocationDetailsServiceCostTokenUsageAddon", "description": "The add-on that provides the tokens" }, "cost": { "description": "Number of tokens consumed by the action. Zero when the add-on covers the\nservice without drawing from a token pool", "format": "decimal", "type": "string" }, "tokens_left": { "description": "Number of tokens left in the pool after the action is performed. Null when\nthe add-on covers the service without a token pool", "format": "decimal", "type": [ "string", "null" ] } }, "required": [ "cost", "addon", "tokens_left" ], "title": "ItAssetsAssetIdArchivePostResponsesContentApplicationJsonSchemaDataActionsReuseOwnAssetFromOwnLocationDetailsServiceCostTokenUsage", "type": "object" }, "ItAssetsAssetIdArchivePostResponsesContentApplicationJsonSchemaDataActionsReuseOwnAssetFromOwnLocationDetailsServiceCostTokenUsageAddon": { "description": "The add-on that provides the tokens", "properties": { "id": { "description": "ID of the add-on", "format": "uuid", "type": "string" }, "name": { "description": "Public display name of the add-on", "type": "string" } }, "required": [ "id", "name" ], "title": "ItAssetsAssetIdArchivePostResponsesContentApplicationJsonSchemaDataActionsReuseOwnAssetFromOwnLocationDetailsServiceCostTokenUsageAddon", "type": "object" }, "ItAssetsAssetIdArchivePostResponsesContentApplicationJsonSchemaDataActionsReuseOwnAssetFromOwnLocationDisabledReasonsItems": { "enum": [ "ARCHIVED", "AT_DEEL_WAREHOUSE", "BEING_REPAIRED", "CONSUMABLE", "CONTROLLED_BY_DEEL", "COUNTRY_NOT_SUPPORTED_FOR_HUB", "COUNTRY_NOT_SUPPORTED_FOR_LOCAL", "DEEL_OWNED_ITEM_WITHOUT_RENTAL_CONTRACT", "DESKTOP_STORAGE", "ENDING_CONTRACT", "HUB_IN_SAME_REGION_AS_LOCAL", "INACTIVE", "INVALID_ITEM_LOCATION", "INVALID_ORGANIZATION_STATUS", "INVALID_STATE", "ITEM_CONDITIONS_TO_UNARCHIVE_NOT_MET", "ITEM_NOT_VISIBLE_FOR_ORGANIZATION", "NON_DEVICE", "NOT_AT_WAREHOUSE", "NOT_AVAILABLE_FOR_REUSE", "NOT_A_RENTAL", "NOT_MANAGEABLE_BY_ORGANIZATION", "NOT_WITH_ASSIGNMENT", "NOT_WITH_USER", "NO_ACTIVE_ADDONS", "NO_ACTIVE_STORAGE_CONTRACT", "NO_LOCATION_FOR_STORAGE", "NO_LOGISTICS_FOR_STORAGE", "NO_VALID_ADDONS", "ONGOING_SERVICE", "OWNED_BY_DEEL", "OWNED_BY_ORGANIZATION", "OWNED_BY_PARTNER_ORGANIZATION", "PARTNER_CHILD_CONTRACT", "PENDING_DEVICE_REFRESH", "RENTAL_CONTRACT_AND_USER_REGION_DO_NOT_MATCH", "TEMPORARILY_UNAVAILABLE", "UNKNOWN", "USER_HAS_NO_COUNTRY", "USER_HAS_NO_SEAT", "WAITING_FOR_CLEARANCE", "WITH_LOANER_ASSIGNMENT", "WITH_NON_COLLECTED_ASSIGNMENT", "WITH_NON_DELIVERED_ASSIGNMENT", "WITH_PENDING_ASSIGNMENT", "WRONG_ASSIGNMENT_STATUS", "WRONG_CONTRACT_STATUS", "WRONG_TERMS_AND_CONDITIONS" ], "title": "ItAssetsAssetIdArchivePostResponsesContentApplicationJsonSchemaDataActionsReuseOwnAssetFromOwnLocationDisabledReasonsItems", "type": "string" }, "ItAssetsAssetIdArchivePostResponsesContentApplicationJsonSchemaDataActionsReuseOwnAssetFromOwnLocationStatus": { "description": "Whether the action is currently available for this asset", "enum": [ "DISABLED", "ENABLED", "NOT_APPLICABLE" ], "title": "ItAssetsAssetIdArchivePostResponsesContentApplicationJsonSchemaDataActionsReuseOwnAssetFromOwnLocationStatus", "type": "string" }, "ItAssetsAssetIdArchivePostResponsesContentApplicationJsonSchemaDataActionsStoreOwnAssetAtDeelForHub": { "description": "Store an organization-owned asset at a Deel hub warehouse", "properties": { "details": { "description": "Action-specific context needed to perform the action. Populated for enabled and\ndisabled actions (so callers can see what a successful attempt would look like);\nnull when the action is not applicable to this asset.", "oneOf": [ { "$ref": "#/components/schemas/ItAssetsAssetIdArchivePostResponsesContentApplicationJsonSchemaDataActionsStoreOwnAssetAtDeelForHubDetails" }, { "type": "null" } ] }, "disabled_reasons": { "description": "Reasons why the action is disabled. Empty when the action is enabled or not applicable", "items": { "$ref": "#/components/schemas/ItAssetsAssetIdArchivePostResponsesContentApplicationJsonSchemaDataActionsStoreOwnAssetAtDeelForHubDisabledReasonsItems" }, "type": "array" }, "status": { "$ref": "#/components/schemas/ItAssetsAssetIdArchivePostResponsesContentApplicationJsonSchemaDataActionsStoreOwnAssetAtDeelForHubStatus", "description": "Whether the action is currently available for this asset" } }, "required": [ "status", "details", "disabled_reasons" ], "title": "ItAssetsAssetIdArchivePostResponsesContentApplicationJsonSchemaDataActionsStoreOwnAssetAtDeelForHub", "type": "object" }, "ItAssetsAssetIdArchivePostResponsesContentApplicationJsonSchemaDataActionsStoreOwnAssetAtDeelForHubDetails": { "description": "Action-specific context needed to perform the action. Populated for enabled and\ndisabled actions (so callers can see what a successful attempt would look like);\nnull when the action is not applicable to this asset.", "properties": { "activation_cost": { "$ref": "#/components/schemas/ItAssetsAssetIdArchivePostResponsesContentApplicationJsonSchemaDataActionsStoreOwnAssetAtDeelForHubDetailsActivationCost", "description": "Cost charged to activate storage" }, "destination_country": { "$ref": "#/components/schemas/ItAssetsAssetIdArchivePostResponsesContentApplicationJsonSchemaDataActionsStoreOwnAssetAtDeelForHubDetailsDestinationCountry", "description": "ISO 3166-1 alpha-2 country of the Deel warehouse the asset will be shipped to" }, "grace_period_in_months": { "description": "Grace period in months during which storage is free before monthly fees apply", "format": "int64", "type": "integer" }, "monthly_fee": { "$ref": "#/components/schemas/ItAssetsAssetIdArchivePostResponsesContentApplicationJsonSchemaDataActionsStoreOwnAssetAtDeelForHubDetailsMonthlyFee", "description": "Monthly storage fee charged after the grace period" } }, "required": [ "monthly_fee", "activation_cost", "destination_country", "grace_period_in_months" ], "title": "ItAssetsAssetIdArchivePostResponsesContentApplicationJsonSchemaDataActionsStoreOwnAssetAtDeelForHubDetails", "type": "object" }, "ItAssetsAssetIdArchivePostResponsesContentApplicationJsonSchemaDataActionsStoreOwnAssetAtDeelForHubDetailsActivationCost": { "description": "Cost charged to activate storage", "properties": { "billing_method": { "$ref": "#/components/schemas/ItAssetsAssetIdArchivePostResponsesContentApplicationJsonSchemaDataActionsStoreOwnAssetAtDeelForHubDetailsActivationCostBillingMethod", "description": "How the action is charged. When \"TOKEN\", the fees are covered by an\nadd-on token pool; when \"CURRENCY\", the fees are billed in the currency\nspecified in the \"fees\" field." }, "fees": { "description": "Price charged for the action. Null when billing method is \"TOKEN\"", "oneOf": [ { "$ref": "#/components/schemas/ItAssetsAssetIdArchivePostResponsesContentApplicationJsonSchemaDataActionsStoreOwnAssetAtDeelForHubDetailsActivationCostFees" }, { "type": "null" } ] }, "token_usage": { "description": "Add-on token consumption details. Null when billing method is \"CURRENCY\"", "oneOf": [ { "$ref": "#/components/schemas/ItAssetsAssetIdArchivePostResponsesContentApplicationJsonSchemaDataActionsStoreOwnAssetAtDeelForHubDetailsActivationCostTokenUsage" }, { "type": "null" } ] } }, "required": [ "fees", "token_usage", "billing_method" ], "title": "ItAssetsAssetIdArchivePostResponsesContentApplicationJsonSchemaDataActionsStoreOwnAssetAtDeelForHubDetailsActivationCost", "type": "object" }, "ItAssetsAssetIdArchivePostResponsesContentApplicationJsonSchemaDataActionsStoreOwnAssetAtDeelForHubDetailsActivationCostBillingMethod": { "description": "How the action is charged. When \"TOKEN\", the fees are covered by an\nadd-on token pool; when \"CURRENCY\", the fees are billed in the currency\nspecified in the \"fees\" field.", "enum": [ "CURRENCY", "TOKEN" ], "title": "ItAssetsAssetIdArchivePostResponsesContentApplicationJsonSchemaDataActionsStoreOwnAssetAtDeelForHubDetailsActivationCostBillingMethod", "type": "string" }, "ItAssetsAssetIdArchivePostResponsesContentApplicationJsonSchemaDataActionsStoreOwnAssetAtDeelForHubDetailsActivationCostFees": { "description": "Price charged for the action. Null when billing method is \"TOKEN\"", "properties": { "amount": { "description": "Amount", "format": "decimal", "type": "string" }, "currency": { "$ref": "#/components/schemas/ItAssetsAssetIdArchivePostResponsesContentApplicationJsonSchemaDataActionsStoreOwnAssetAtDeelForHubDetailsActivationCostFeesCurrency", "description": "Three-letter currency code for the price" } }, "required": [ "amount", "currency" ], "title": "ItAssetsAssetIdArchivePostResponsesContentApplicationJsonSchemaDataActionsStoreOwnAssetAtDeelForHubDetailsActivationCostFees", "type": "object" }, "ItAssetsAssetIdArchivePostResponsesContentApplicationJsonSchemaDataActionsStoreOwnAssetAtDeelForHubDetailsActivationCostFeesCurrency": { "description": "Three-letter currency code for the price", "enum": [ "AED", "AFN", "ALL", "AMD", "ANG", "AOA", "ARS", "AUD", "AWG", "AZN", "BAM", "BDT", "BGN", "BHD", "BIF", "BMD", "BOB", "BRL", "BSD", "BTN", "BWP", "BYN", "BZD", "CAD", "CDF", "CHF", "CLP", "CNY", "COP", "CRC", "CUC", "CVE", "CZK", "DJF", "DKK", "DOP", "DZD", "EGP", "ERN", "ETB", "EUR", "FJD", "FKP", "GBP", "GEL", "GHS", "GIP", "GMD", "GNF", "GTQ", "GYD", "HKD", "HNL", "HRK", "HTG", "HUF", "IDR", "ILS", "INR", "IQD", "IRR", "ISK", "JMD", "JOD", "JPY", "KES", "KGS", "KHR", "KMF", "KPW", "KRW", "KWD", "KYD", "KZT", "LAK", "LBP", "LKR", "LRD", "LSL", "LTL", "LYD", "MAD", "MDL", "MGA", "MKD", "MMK", "MNT", "MRU", "MUR", "MVR", "MWK", "MXN", "MYR", "MZN", "NAD", "NGN", "NIO", "NOK", "NPR", "NZD", "OMR", "PAB", "PEN", "PGK", "PHP", "PKR", "PLN", "PYG", "QAR", "RON", "RSD", "RUB", "RWF", "SAR", "SBD", "SCR", "SDG", "SEK", "SGD", "SHP", "SLL", "SOS", "SRD", "SSP", "STD", "SYP", "SZL", "THB", "TJS", "TMT", "TND", "TOP", "TRY", "TTD", "TWD", "TZS", "UAH", "UGX", "USD", "UYU", "UZS", "VEF", "VND", "VUV", "WST", "XAF", "XCD", "XOF", "XPF", "YER", "ZAR", "ZMW", "ZWD" ], "title": "ItAssetsAssetIdArchivePostResponsesContentApplicationJsonSchemaDataActionsStoreOwnAssetAtDeelForHubDetailsActivationCostFeesCurrency", "type": "string" }, "ItAssetsAssetIdArchivePostResponsesContentApplicationJsonSchemaDataActionsStoreOwnAssetAtDeelForHubDetailsActivationCostTokenUsage": { "description": "Add-on token consumption details. Null when billing method is \"CURRENCY\"", "properties": { "addon": { "$ref": "#/components/schemas/ItAssetsAssetIdArchivePostResponsesContentApplicationJsonSchemaDataActionsStoreOwnAssetAtDeelForHubDetailsActivationCostTokenUsageAddon", "description": "The add-on that provides the tokens" }, "cost": { "description": "Number of tokens consumed by the action. Zero when the add-on covers the\nservice without drawing from a token pool", "format": "decimal", "type": "string" }, "tokens_left": { "description": "Number of tokens left in the pool after the action is performed. Null when\nthe add-on covers the service without a token pool", "format": "decimal", "type": [ "string", "null" ] } }, "required": [ "cost", "addon", "tokens_left" ], "title": "ItAssetsAssetIdArchivePostResponsesContentApplicationJsonSchemaDataActionsStoreOwnAssetAtDeelForHubDetailsActivationCostTokenUsage", "type": "object" }, "ItAssetsAssetIdArchivePostResponsesContentApplicationJsonSchemaDataActionsStoreOwnAssetAtDeelForHubDetailsActivationCostTokenUsageAddon": { "description": "The add-on that provides the tokens", "properties": { "id": { "description": "ID of the add-on", "format": "uuid", "type": "string" }, "name": { "description": "Public display name of the add-on", "type": "string" } }, "required": [ "id", "name" ], "title": "ItAssetsAssetIdArchivePostResponsesContentApplicationJsonSchemaDataActionsStoreOwnAssetAtDeelForHubDetailsActivationCostTokenUsageAddon", "type": "object" }, "ItAssetsAssetIdArchivePostResponsesContentApplicationJsonSchemaDataActionsStoreOwnAssetAtDeelForHubDetailsDestinationCountry": { "description": "ISO 3166-1 alpha-2 country of the Deel warehouse the asset will be shipped to", "enum": [ "AD", "AE", "AF", "AG", "AI", "AL", "AM", "AN", "AO", "AQ", "AR", "AS", "AT", "AU", "AW", "AX", "AZ", "BA", "BB", "BD", "BE", "BF", "BG", "BH", "BI", "BJ", "BL", "BM", "BN", "BO", "BQ", "BR", "BS", "BT", "BV", "BW", "BY", "BZ", "CA", "CC", "CD", "CF", "CG", "CH", "CI", "CK", "CL", "CM", "CN", "CO", "CR", "CU", "CV", "CW", "CX", "CY", "CZ", "DE", "DJ", "DK", "DM", "DO", "DZ", "EC", "EE", "EG", "EH", "ER", "ES", "ET", "FI", "FJ", "FK", "FM", "FO", "FR", "GA", "GB", "GD", "GE", "GF", "GG", "GH", "GI", "GL", "GM", "GN", "GP", "GQ", "GR", "GS", "GT", "GU", "GW", "GY", "HK", "HM", "HN", "HR", "HT", "HU", "IC", "ID", "IE", "IL", "IM", "IN", "IO", "IQ", "IR", "IS", "IT", "JE", "JM", "JO", "JP", "KE", "KG", "KH", "KI", "KM", "KN", "KP", "KR", "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", "XK", "YE", "YT", "ZA", "ZM", "ZW" ], "title": "ItAssetsAssetIdArchivePostResponsesContentApplicationJsonSchemaDataActionsStoreOwnAssetAtDeelForHubDetailsDestinationCountry", "type": "string" }, "ItAssetsAssetIdArchivePostResponsesContentApplicationJsonSchemaDataActionsStoreOwnAssetAtDeelForHubDetailsMonthlyFee": { "description": "Monthly storage fee charged after the grace period", "properties": { "amount": { "description": "Amount", "format": "decimal", "type": "string" }, "currency": { "$ref": "#/components/schemas/ItAssetsAssetIdArchivePostResponsesContentApplicationJsonSchemaDataActionsStoreOwnAssetAtDeelForHubDetailsMonthlyFeeCurrency", "description": "Three-letter currency code for the price" } }, "required": [ "amount", "currency" ], "title": "ItAssetsAssetIdArchivePostResponsesContentApplicationJsonSchemaDataActionsStoreOwnAssetAtDeelForHubDetailsMonthlyFee", "type": "object" }, "ItAssetsAssetIdArchivePostResponsesContentApplicationJsonSchemaDataActionsStoreOwnAssetAtDeelForHubDetailsMonthlyFeeCurrency": { "description": "Three-letter currency code for the price", "enum": [ "AED", "AFN", "ALL", "AMD", "ANG", "AOA", "ARS", "AUD", "AWG", "AZN", "BAM", "BDT", "BGN", "BHD", "BIF", "BMD", "BOB", "BRL", "BSD", "BTN", "BWP", "BYN", "BZD", "CAD", "CDF", "CHF", "CLP", "CNY", "COP", "CRC", "CUC", "CVE", "CZK", "DJF", "DKK", "DOP", "DZD", "EGP", "ERN", "ETB", "EUR", "FJD", "FKP", "GBP", "GEL", "GHS", "GIP", "GMD", "GNF", "GTQ", "GYD", "HKD", "HNL", "HRK", "HTG", "HUF", "IDR", "ILS", "INR", "IQD", "IRR", "ISK", "JMD", "JOD", "JPY", "KES", "KGS", "KHR", "KMF", "KPW", "KRW", "KWD", "KYD", "KZT", "LAK", "LBP", "LKR", "LRD", "LSL", "LTL", "LYD", "MAD", "MDL", "MGA", "MKD", "MMK", "MNT", "MRU", "MUR", "MVR", "MWK", "MXN", "MYR", "MZN", "NAD", "NGN", "NIO", "NOK", "NPR", "NZD", "OMR", "PAB", "PEN", "PGK", "PHP", "PKR", "PLN", "PYG", "QAR", "RON", "RSD", "RUB", "RWF", "SAR", "SBD", "SCR", "SDG", "SEK", "SGD", "SHP", "SLL", "SOS", "SRD", "SSP", "STD", "SYP", "SZL", "THB", "TJS", "TMT", "TND", "TOP", "TRY", "TTD", "TWD", "TZS", "UAH", "UGX", "USD", "UYU", "UZS", "VEF", "VND", "VUV", "WST", "XAF", "XCD", "XOF", "XPF", "YER", "ZAR", "ZMW", "ZWD" ], "title": "ItAssetsAssetIdArchivePostResponsesContentApplicationJsonSchemaDataActionsStoreOwnAssetAtDeelForHubDetailsMonthlyFeeCurrency", "type": "string" }, "ItAssetsAssetIdArchivePostResponsesContentApplicationJsonSchemaDataActionsStoreOwnAssetAtDeelForHubDisabledReasonsItems": { "enum": [ "ARCHIVED", "AT_DEEL_WAREHOUSE", "BEING_REPAIRED", "CONSUMABLE", "CONTROLLED_BY_DEEL", "COUNTRY_NOT_SUPPORTED_FOR_HUB", "COUNTRY_NOT_SUPPORTED_FOR_LOCAL", "DEEL_OWNED_ITEM_WITHOUT_RENTAL_CONTRACT", "DESKTOP_STORAGE", "ENDING_CONTRACT", "HUB_IN_SAME_REGION_AS_LOCAL", "INACTIVE", "INVALID_ITEM_LOCATION", "INVALID_ORGANIZATION_STATUS", "INVALID_STATE", "ITEM_CONDITIONS_TO_UNARCHIVE_NOT_MET", "ITEM_NOT_VISIBLE_FOR_ORGANIZATION", "NON_DEVICE", "NOT_AT_WAREHOUSE", "NOT_AVAILABLE_FOR_REUSE", "NOT_A_RENTAL", "NOT_MANAGEABLE_BY_ORGANIZATION", "NOT_WITH_ASSIGNMENT", "NOT_WITH_USER", "NO_ACTIVE_ADDONS", "NO_ACTIVE_STORAGE_CONTRACT", "NO_LOCATION_FOR_STORAGE", "NO_LOGISTICS_FOR_STORAGE", "NO_VALID_ADDONS", "ONGOING_SERVICE", "OWNED_BY_DEEL", "OWNED_BY_ORGANIZATION", "OWNED_BY_PARTNER_ORGANIZATION", "PARTNER_CHILD_CONTRACT", "PENDING_DEVICE_REFRESH", "RENTAL_CONTRACT_AND_USER_REGION_DO_NOT_MATCH", "TEMPORARILY_UNAVAILABLE", "UNKNOWN", "USER_HAS_NO_COUNTRY", "USER_HAS_NO_SEAT", "WAITING_FOR_CLEARANCE", "WITH_LOANER_ASSIGNMENT", "WITH_NON_COLLECTED_ASSIGNMENT", "WITH_NON_DELIVERED_ASSIGNMENT", "WITH_PENDING_ASSIGNMENT", "WRONG_ASSIGNMENT_STATUS", "WRONG_CONTRACT_STATUS", "WRONG_TERMS_AND_CONDITIONS" ], "title": "ItAssetsAssetIdArchivePostResponsesContentApplicationJsonSchemaDataActionsStoreOwnAssetAtDeelForHubDisabledReasonsItems", "type": "string" }, "ItAssetsAssetIdArchivePostResponsesContentApplicationJsonSchemaDataActionsStoreOwnAssetAtDeelForHubStatus": { "description": "Whether the action is currently available for this asset", "enum": [ "DISABLED", "ENABLED", "NOT_APPLICABLE" ], "title": "ItAssetsAssetIdArchivePostResponsesContentApplicationJsonSchemaDataActionsStoreOwnAssetAtDeelForHubStatus", "type": "string" }, "ItAssetsAssetIdArchivePostResponsesContentApplicationJsonSchemaDataActionsStoreOwnAssetAtDeelForLocal": { "description": "Store an organization-owned asset at a Deel local warehouse", "properties": { "details": { "description": "Action-specific context needed to perform the action. Populated for enabled and\ndisabled actions (so callers can see what a successful attempt would look like);\nnull when the action is not applicable to this asset.", "oneOf": [ { "$ref": "#/components/schemas/ItAssetsAssetIdArchivePostResponsesContentApplicationJsonSchemaDataActionsStoreOwnAssetAtDeelForLocalDetails" }, { "type": "null" } ] }, "disabled_reasons": { "description": "Reasons why the action is disabled. Empty when the action is enabled or not applicable", "items": { "$ref": "#/components/schemas/ItAssetsAssetIdArchivePostResponsesContentApplicationJsonSchemaDataActionsStoreOwnAssetAtDeelForLocalDisabledReasonsItems" }, "type": "array" }, "status": { "$ref": "#/components/schemas/ItAssetsAssetIdArchivePostResponsesContentApplicationJsonSchemaDataActionsStoreOwnAssetAtDeelForLocalStatus", "description": "Whether the action is currently available for this asset" } }, "required": [ "status", "details", "disabled_reasons" ], "title": "ItAssetsAssetIdArchivePostResponsesContentApplicationJsonSchemaDataActionsStoreOwnAssetAtDeelForLocal", "type": "object" }, "ItAssetsAssetIdArchivePostResponsesContentApplicationJsonSchemaDataActionsStoreOwnAssetAtDeelForLocalDetails": { "description": "Action-specific context needed to perform the action. Populated for enabled and\ndisabled actions (so callers can see what a successful attempt would look like);\nnull when the action is not applicable to this asset.", "properties": { "activation_cost": { "$ref": "#/components/schemas/ItAssetsAssetIdArchivePostResponsesContentApplicationJsonSchemaDataActionsStoreOwnAssetAtDeelForLocalDetailsActivationCost", "description": "Cost charged to activate storage" }, "destination_country": { "$ref": "#/components/schemas/ItAssetsAssetIdArchivePostResponsesContentApplicationJsonSchemaDataActionsStoreOwnAssetAtDeelForLocalDetailsDestinationCountry", "description": "ISO 3166-1 alpha-2 country of the Deel warehouse the asset will be shipped to" }, "grace_period_in_months": { "description": "Grace period in months during which storage is free before monthly fees apply", "format": "int64", "type": "integer" }, "monthly_fee": { "$ref": "#/components/schemas/ItAssetsAssetIdArchivePostResponsesContentApplicationJsonSchemaDataActionsStoreOwnAssetAtDeelForLocalDetailsMonthlyFee", "description": "Monthly storage fee charged after the grace period" } }, "required": [ "monthly_fee", "activation_cost", "destination_country", "grace_period_in_months" ], "title": "ItAssetsAssetIdArchivePostResponsesContentApplicationJsonSchemaDataActionsStoreOwnAssetAtDeelForLocalDetails", "type": "object" }, "ItAssetsAssetIdArchivePostResponsesContentApplicationJsonSchemaDataActionsStoreOwnAssetAtDeelForLocalDetailsActivationCost": { "description": "Cost charged to activate storage", "properties": { "billing_method": { "$ref": "#/components/schemas/ItAssetsAssetIdArchivePostResponsesContentApplicationJsonSchemaDataActionsStoreOwnAssetAtDeelForLocalDetailsActivationCostBillingMethod", "description": "How the action is charged. When \"TOKEN\", the fees are covered by an\nadd-on token pool; when \"CURRENCY\", the fees are billed in the currency\nspecified in the \"fees\" field." }, "fees": { "description": "Price charged for the action. Null when billing method is \"TOKEN\"", "oneOf": [ { "$ref": "#/components/schemas/ItAssetsAssetIdArchivePostResponsesContentApplicationJsonSchemaDataActionsStoreOwnAssetAtDeelForLocalDetailsActivationCostFees" }, { "type": "null" } ] }, "token_usage": { "description": "Add-on token consumption details. Null when billing method is \"CURRENCY\"", "oneOf": [ { "$ref": "#/components/schemas/ItAssetsAssetIdArchivePostResponsesContentApplicationJsonSchemaDataActionsStoreOwnAssetAtDeelForLocalDetailsActivationCostTokenUsage" }, { "type": "null" } ] } }, "required": [ "fees", "token_usage", "billing_method" ], "title": "ItAssetsAssetIdArchivePostResponsesContentApplicationJsonSchemaDataActionsStoreOwnAssetAtDeelForLocalDetailsActivationCost", "type": "object" }, "ItAssetsAssetIdArchivePostResponsesContentApplicationJsonSchemaDataActionsStoreOwnAssetAtDeelForLocalDetailsActivationCostBillingMethod": { "description": "How the action is charged. When \"TOKEN\", the fees are covered by an\nadd-on token pool; when \"CURRENCY\", the fees are billed in the currency\nspecified in the \"fees\" field.", "enum": [ "CURRENCY", "TOKEN" ], "title": "ItAssetsAssetIdArchivePostResponsesContentApplicationJsonSchemaDataActionsStoreOwnAssetAtDeelForLocalDetailsActivationCostBillingMethod", "type": "string" }, "ItAssetsAssetIdArchivePostResponsesContentApplicationJsonSchemaDataActionsStoreOwnAssetAtDeelForLocalDetailsActivationCostFees": { "description": "Price charged for the action. Null when billing method is \"TOKEN\"", "properties": { "amount": { "description": "Amount", "format": "decimal", "type": "string" }, "currency": { "$ref": "#/components/schemas/ItAssetsAssetIdArchivePostResponsesContentApplicationJsonSchemaDataActionsStoreOwnAssetAtDeelForLocalDetailsActivationCostFeesCurrency", "description": "Three-letter currency code for the price" } }, "required": [ "amount", "currency" ], "title": "ItAssetsAssetIdArchivePostResponsesContentApplicationJsonSchemaDataActionsStoreOwnAssetAtDeelForLocalDetailsActivationCostFees", "type": "object" }, "ItAssetsAssetIdArchivePostResponsesContentApplicationJsonSchemaDataActionsStoreOwnAssetAtDeelForLocalDetailsActivationCostFeesCurrency": { "description": "Three-letter currency code for the price", "enum": [ "AED", "AFN", "ALL", "AMD", "ANG", "AOA", "ARS", "AUD", "AWG", "AZN", "BAM", "BDT", "BGN", "BHD", "BIF", "BMD", "BOB", "BRL", "BSD", "BTN", "BWP", "BYN", "BZD", "CAD", "CDF", "CHF", "CLP", "CNY", "COP", "CRC", "CUC", "CVE", "CZK", "DJF", "DKK", "DOP", "DZD", "EGP", "ERN", "ETB", "EUR", "FJD", "FKP", "GBP", "GEL", "GHS", "GIP", "GMD", "GNF", "GTQ", "GYD", "HKD", "HNL", "HRK", "HTG", "HUF", "IDR", "ILS", "INR", "IQD", "IRR", "ISK", "JMD", "JOD", "JPY", "KES", "KGS", "KHR", "KMF", "KPW", "KRW", "KWD", "KYD", "KZT", "LAK", "LBP", "LKR", "LRD", "LSL", "LTL", "LYD", "MAD", "MDL", "MGA", "MKD", "MMK", "MNT", "MRU", "MUR", "MVR", "MWK", "MXN", "MYR", "MZN", "NAD", "NGN", "NIO", "NOK", "NPR", "NZD", "OMR", "PAB", "PEN", "PGK", "PHP", "PKR", "PLN", "PYG", "QAR", "RON", "RSD", "RUB", "RWF", "SAR", "SBD", "SCR", "SDG", "SEK", "SGD", "SHP", "SLL", "SOS", "SRD", "SSP", "STD", "SYP", "SZL", "THB", "TJS", "TMT", "TND", "TOP", "TRY", "TTD", "TWD", "TZS", "UAH", "UGX", "USD", "UYU", "UZS", "VEF", "VND", "VUV", "WST", "XAF", "XCD", "XOF", "XPF", "YER", "ZAR", "ZMW", "ZWD" ], "title": "ItAssetsAssetIdArchivePostResponsesContentApplicationJsonSchemaDataActionsStoreOwnAssetAtDeelForLocalDetailsActivationCostFeesCurrency", "type": "string" }, "ItAssetsAssetIdArchivePostResponsesContentApplicationJsonSchemaDataActionsStoreOwnAssetAtDeelForLocalDetailsActivationCostTokenUsage": { "description": "Add-on token consumption details. Null when billing method is \"CURRENCY\"", "properties": { "addon": { "$ref": "#/components/schemas/ItAssetsAssetIdArchivePostResponsesContentApplicationJsonSchemaDataActionsStoreOwnAssetAtDeelForLocalDetailsActivationCostTokenUsageAddon", "description": "The add-on that provides the tokens" }, "cost": { "description": "Number of tokens consumed by the action. Zero when the add-on covers the\nservice without drawing from a token pool", "format": "decimal", "type": "string" }, "tokens_left": { "description": "Number of tokens left in the pool after the action is performed. Null when\nthe add-on covers the service without a token pool", "format": "decimal", "type": [ "string", "null" ] } }, "required": [ "cost", "addon", "tokens_left" ], "title": "ItAssetsAssetIdArchivePostResponsesContentApplicationJsonSchemaDataActionsStoreOwnAssetAtDeelForLocalDetailsActivationCostTokenUsage", "type": "object" }, "ItAssetsAssetIdArchivePostResponsesContentApplicationJsonSchemaDataActionsStoreOwnAssetAtDeelForLocalDetailsActivationCostTokenUsageAddon": { "description": "The add-on that provides the tokens", "properties": { "id": { "description": "ID of the add-on", "format": "uuid", "type": "string" }, "name": { "description": "Public display name of the add-on", "type": "string" } }, "required": [ "id", "name" ], "title": "ItAssetsAssetIdArchivePostResponsesContentApplicationJsonSchemaDataActionsStoreOwnAssetAtDeelForLocalDetailsActivationCostTokenUsageAddon", "type": "object" }, "ItAssetsAssetIdArchivePostResponsesContentApplicationJsonSchemaDataActionsStoreOwnAssetAtDeelForLocalDetailsDestinationCountry": { "description": "ISO 3166-1 alpha-2 country of the Deel warehouse the asset will be shipped to", "enum": [ "AD", "AE", "AF", "AG", "AI", "AL", "AM", "AN", "AO", "AQ", "AR", "AS", "AT", "AU", "AW", "AX", "AZ", "BA", "BB", "BD", "BE", "BF", "BG", "BH", "BI", "BJ", "BL", "BM", "BN", "BO", "BQ", "BR", "BS", "BT", "BV", "BW", "BY", "BZ", "CA", "CC", "CD", "CF", "CG", "CH", "CI", "CK", "CL", "CM", "CN", "CO", "CR", "CU", "CV", "CW", "CX", "CY", "CZ", "DE", "DJ", "DK", "DM", "DO", "DZ", "EC", "EE", "EG", "EH", "ER", "ES", "ET", "FI", "FJ", "FK", "FM", "FO", "FR", "GA", "GB", "GD", "GE", "GF", "GG", "GH", "GI", "GL", "GM", "GN", "GP", "GQ", "GR", "GS", "GT", "GU", "GW", "GY", "HK", "HM", "HN", "HR", "HT", "HU", "IC", "ID", "IE", "IL", "IM", "IN", "IO", "IQ", "IR", "IS", "IT", "JE", "JM", "JO", "JP", "KE", "KG", "KH", "KI", "KM", "KN", "KP", "KR", "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", "XK", "YE", "YT", "ZA", "ZM", "ZW" ], "title": "ItAssetsAssetIdArchivePostResponsesContentApplicationJsonSchemaDataActionsStoreOwnAssetAtDeelForLocalDetailsDestinationCountry", "type": "string" }, "ItAssetsAssetIdArchivePostResponsesContentApplicationJsonSchemaDataActionsStoreOwnAssetAtDeelForLocalDetailsMonthlyFee": { "description": "Monthly storage fee charged after the grace period", "properties": { "amount": { "description": "Amount", "format": "decimal", "type": "string" }, "currency": { "$ref": "#/components/schemas/ItAssetsAssetIdArchivePostResponsesContentApplicationJsonSchemaDataActionsStoreOwnAssetAtDeelForLocalDetailsMonthlyFeeCurrency", "description": "Three-letter currency code for the price" } }, "required": [ "amount", "currency" ], "title": "ItAssetsAssetIdArchivePostResponsesContentApplicationJsonSchemaDataActionsStoreOwnAssetAtDeelForLocalDetailsMonthlyFee", "type": "object" }, "ItAssetsAssetIdArchivePostResponsesContentApplicationJsonSchemaDataActionsStoreOwnAssetAtDeelForLocalDetailsMonthlyFeeCurrency": { "description": "Three-letter currency code for the price", "enum": [ "AED", "AFN", "ALL", "AMD", "ANG", "AOA", "ARS", "AUD", "AWG", "AZN", "BAM", "BDT", "BGN", "BHD", "BIF", "BMD", "BOB", "BRL", "BSD", "BTN", "BWP", "BYN", "BZD", "CAD", "CDF", "CHF", "CLP", "CNY", "COP", "CRC", "CUC", "CVE", "CZK", "DJF", "DKK", "DOP", "DZD", "EGP", "ERN", "ETB", "EUR", "FJD", "FKP", "GBP", "GEL", "GHS", "GIP", "GMD", "GNF", "GTQ", "GYD", "HKD", "HNL", "HRK", "HTG", "HUF", "IDR", "ILS", "INR", "IQD", "IRR", "ISK", "JMD", "JOD", "JPY", "KES", "KGS", "KHR", "KMF", "KPW", "KRW", "KWD", "KYD", "KZT", "LAK", "LBP", "LKR", "LRD", "LSL", "LTL", "LYD", "MAD", "MDL", "MGA", "MKD", "MMK", "MNT", "MRU", "MUR", "MVR", "MWK", "MXN", "MYR", "MZN", "NAD", "NGN", "NIO", "NOK", "NPR", "NZD", "OMR", "PAB", "PEN", "PGK", "PHP", "PKR", "PLN", "PYG", "QAR", "RON", "RSD", "RUB", "RWF", "SAR", "SBD", "SCR", "SDG", "SEK", "SGD", "SHP", "SLL", "SOS", "SRD", "SSP", "STD", "SYP", "SZL", "THB", "TJS", "TMT", "TND", "TOP", "TRY", "TTD", "TWD", "TZS", "UAH", "UGX", "USD", "UYU", "UZS", "VEF", "VND", "VUV", "WST", "XAF", "XCD", "XOF", "XPF", "YER", "ZAR", "ZMW", "ZWD" ], "title": "ItAssetsAssetIdArchivePostResponsesContentApplicationJsonSchemaDataActionsStoreOwnAssetAtDeelForLocalDetailsMonthlyFeeCurrency", "type": "string" }, "ItAssetsAssetIdArchivePostResponsesContentApplicationJsonSchemaDataActionsStoreOwnAssetAtDeelForLocalDisabledReasonsItems": { "enum": [ "ARCHIVED", "AT_DEEL_WAREHOUSE", "BEING_REPAIRED", "CONSUMABLE", "CONTROLLED_BY_DEEL", "COUNTRY_NOT_SUPPORTED_FOR_HUB", "COUNTRY_NOT_SUPPORTED_FOR_LOCAL", "DEEL_OWNED_ITEM_WITHOUT_RENTAL_CONTRACT", "DESKTOP_STORAGE", "ENDING_CONTRACT", "HUB_IN_SAME_REGION_AS_LOCAL", "INACTIVE", "INVALID_ITEM_LOCATION", "INVALID_ORGANIZATION_STATUS", "INVALID_STATE", "ITEM_CONDITIONS_TO_UNARCHIVE_NOT_MET", "ITEM_NOT_VISIBLE_FOR_ORGANIZATION", "NON_DEVICE", "NOT_AT_WAREHOUSE", "NOT_AVAILABLE_FOR_REUSE", "NOT_A_RENTAL", "NOT_MANAGEABLE_BY_ORGANIZATION", "NOT_WITH_ASSIGNMENT", "NOT_WITH_USER", "NO_ACTIVE_ADDONS", "NO_ACTIVE_STORAGE_CONTRACT", "NO_LOCATION_FOR_STORAGE", "NO_LOGISTICS_FOR_STORAGE", "NO_VALID_ADDONS", "ONGOING_SERVICE", "OWNED_BY_DEEL", "OWNED_BY_ORGANIZATION", "OWNED_BY_PARTNER_ORGANIZATION", "PARTNER_CHILD_CONTRACT", "PENDING_DEVICE_REFRESH", "RENTAL_CONTRACT_AND_USER_REGION_DO_NOT_MATCH", "TEMPORARILY_UNAVAILABLE", "UNKNOWN", "USER_HAS_NO_COUNTRY", "USER_HAS_NO_SEAT", "WAITING_FOR_CLEARANCE", "WITH_LOANER_ASSIGNMENT", "WITH_NON_COLLECTED_ASSIGNMENT", "WITH_NON_DELIVERED_ASSIGNMENT", "WITH_PENDING_ASSIGNMENT", "WRONG_ASSIGNMENT_STATUS", "WRONG_CONTRACT_STATUS", "WRONG_TERMS_AND_CONDITIONS" ], "title": "ItAssetsAssetIdArchivePostResponsesContentApplicationJsonSchemaDataActionsStoreOwnAssetAtDeelForLocalDisabledReasonsItems", "type": "string" }, "ItAssetsAssetIdArchivePostResponsesContentApplicationJsonSchemaDataActionsStoreOwnAssetAtDeelForLocalStatus": { "description": "Whether the action is currently available for this asset", "enum": [ "DISABLED", "ENABLED", "NOT_APPLICABLE" ], "title": "ItAssetsAssetIdArchivePostResponsesContentApplicationJsonSchemaDataActionsStoreOwnAssetAtDeelForLocalStatus", "type": "string" }, "ItAssetsAssetIdArchivePostResponsesContentApplicationJsonSchemaDataActionsStoreOwnAssetAtOwnLocation": { "description": "Store an organization-owned asset at an organization-owned location", "properties": { "details": { "description": "Action-specific context needed to perform the action. Populated for enabled and\ndisabled actions (so callers can see what a successful attempt would look like);\nnull when the action is not applicable to this asset.", "oneOf": [ { "$ref": "#/components/schemas/ItAssetsAssetIdArchivePostResponsesContentApplicationJsonSchemaDataActionsStoreOwnAssetAtOwnLocationDetails" }, { "type": "null" } ] }, "disabled_reasons": { "description": "Reasons why the action is disabled. Empty when the action is enabled or not applicable", "items": { "$ref": "#/components/schemas/ItAssetsAssetIdArchivePostResponsesContentApplicationJsonSchemaDataActionsStoreOwnAssetAtOwnLocationDisabledReasonsItems" }, "type": "array" }, "status": { "$ref": "#/components/schemas/ItAssetsAssetIdArchivePostResponsesContentApplicationJsonSchemaDataActionsStoreOwnAssetAtOwnLocationStatus", "description": "Whether the action is currently available for this asset" } }, "required": [ "status", "details", "disabled_reasons" ], "title": "ItAssetsAssetIdArchivePostResponsesContentApplicationJsonSchemaDataActionsStoreOwnAssetAtOwnLocation", "type": "object" }, "ItAssetsAssetIdArchivePostResponsesContentApplicationJsonSchemaDataActionsStoreOwnAssetAtOwnLocationDetails": { "description": "Action-specific context needed to perform the action. Populated for enabled and\ndisabled actions (so callers can see what a successful attempt would look like);\nnull when the action is not applicable to this asset.", "properties": { "eligible_countries": { "description": "Countries where the asset can be stored at an organization-owned location", "items": { "$ref": "#/components/schemas/ItAssetsAssetIdArchivePostResponsesContentApplicationJsonSchemaDataActionsStoreOwnAssetAtOwnLocationDetailsEligibleCountriesItems" }, "type": "array" }, "service_cost": { "$ref": "#/components/schemas/ItAssetsAssetIdArchivePostResponsesContentApplicationJsonSchemaDataActionsStoreOwnAssetAtOwnLocationDetailsServiceCost", "description": "Cost charged for the transfer service" } }, "required": [ "service_cost", "eligible_countries" ], "title": "ItAssetsAssetIdArchivePostResponsesContentApplicationJsonSchemaDataActionsStoreOwnAssetAtOwnLocationDetails", "type": "object" }, "ItAssetsAssetIdArchivePostResponsesContentApplicationJsonSchemaDataActionsStoreOwnAssetAtOwnLocationDetailsEligibleCountriesItems": { "enum": [ "AD", "AE", "AF", "AG", "AI", "AL", "AM", "AN", "AO", "AQ", "AR", "AS", "AT", "AU", "AW", "AX", "AZ", "BA", "BB", "BD", "BE", "BF", "BG", "BH", "BI", "BJ", "BL", "BM", "BN", "BO", "BQ", "BR", "BS", "BT", "BV", "BW", "BY", "BZ", "CA", "CC", "CD", "CF", "CG", "CH", "CI", "CK", "CL", "CM", "CN", "CO", "CR", "CU", "CV", "CW", "CX", "CY", "CZ", "DE", "DJ", "DK", "DM", "DO", "DZ", "EC", "EE", "EG", "EH", "ER", "ES", "ET", "FI", "FJ", "FK", "FM", "FO", "FR", "GA", "GB", "GD", "GE", "GF", "GG", "GH", "GI", "GL", "GM", "GN", "GP", "GQ", "GR", "GS", "GT", "GU", "GW", "GY", "HK", "HM", "HN", "HR", "HT", "HU", "IC", "ID", "IE", "IL", "IM", "IN", "IO", "IQ", "IR", "IS", "IT", "JE", "JM", "JO", "JP", "KE", "KG", "KH", "KI", "KM", "KN", "KP", "KR", "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", "XK", "YE", "YT", "ZA", "ZM", "ZW" ], "title": "ItAssetsAssetIdArchivePostResponsesContentApplicationJsonSchemaDataActionsStoreOwnAssetAtOwnLocationDetailsEligibleCountriesItems", "type": "string" }, "ItAssetsAssetIdArchivePostResponsesContentApplicationJsonSchemaDataActionsStoreOwnAssetAtOwnLocationDetailsServiceCost": { "description": "Cost charged for the transfer service", "properties": { "billing_method": { "$ref": "#/components/schemas/ItAssetsAssetIdArchivePostResponsesContentApplicationJsonSchemaDataActionsStoreOwnAssetAtOwnLocationDetailsServiceCostBillingMethod", "description": "How the action is charged. When \"TOKEN\", the fees are covered by an\nadd-on token pool; when \"CURRENCY\", the fees are billed in the currency\nspecified in the \"fees\" field." }, "fees": { "description": "Price charged for the action. Null when billing method is \"TOKEN\"", "oneOf": [ { "$ref": "#/components/schemas/ItAssetsAssetIdArchivePostResponsesContentApplicationJsonSchemaDataActionsStoreOwnAssetAtOwnLocationDetailsServiceCostFees" }, { "type": "null" } ] }, "token_usage": { "description": "Add-on token consumption details. Null when billing method is \"CURRENCY\"", "oneOf": [ { "$ref": "#/components/schemas/ItAssetsAssetIdArchivePostResponsesContentApplicationJsonSchemaDataActionsStoreOwnAssetAtOwnLocationDetailsServiceCostTokenUsage" }, { "type": "null" } ] } }, "required": [ "fees", "token_usage", "billing_method" ], "title": "ItAssetsAssetIdArchivePostResponsesContentApplicationJsonSchemaDataActionsStoreOwnAssetAtOwnLocationDetailsServiceCost", "type": "object" }, "ItAssetsAssetIdArchivePostResponsesContentApplicationJsonSchemaDataActionsStoreOwnAssetAtOwnLocationDetailsServiceCostBillingMethod": { "description": "How the action is charged. When \"TOKEN\", the fees are covered by an\nadd-on token pool; when \"CURRENCY\", the fees are billed in the currency\nspecified in the \"fees\" field.", "enum": [ "CURRENCY", "TOKEN" ], "title": "ItAssetsAssetIdArchivePostResponsesContentApplicationJsonSchemaDataActionsStoreOwnAssetAtOwnLocationDetailsServiceCostBillingMethod", "type": "string" }, "ItAssetsAssetIdArchivePostResponsesContentApplicationJsonSchemaDataActionsStoreOwnAssetAtOwnLocationDetailsServiceCostFees": { "description": "Price charged for the action. Null when billing method is \"TOKEN\"", "properties": { "amount": { "description": "Amount", "format": "decimal", "type": "string" }, "currency": { "$ref": "#/components/schemas/ItAssetsAssetIdArchivePostResponsesContentApplicationJsonSchemaDataActionsStoreOwnAssetAtOwnLocationDetailsServiceCostFeesCurrency", "description": "Three-letter currency code for the price" } }, "required": [ "amount", "currency" ], "title": "ItAssetsAssetIdArchivePostResponsesContentApplicationJsonSchemaDataActionsStoreOwnAssetAtOwnLocationDetailsServiceCostFees", "type": "object" }, "ItAssetsAssetIdArchivePostResponsesContentApplicationJsonSchemaDataActionsStoreOwnAssetAtOwnLocationDetailsServiceCostFeesCurrency": { "description": "Three-letter currency code for the price", "enum": [ "AED", "AFN", "ALL", "AMD", "ANG", "AOA", "ARS", "AUD", "AWG", "AZN", "BAM", "BDT", "BGN", "BHD", "BIF", "BMD", "BOB", "BRL", "BSD", "BTN", "BWP", "BYN", "BZD", "CAD", "CDF", "CHF", "CLP", "CNY", "COP", "CRC", "CUC", "CVE", "CZK", "DJF", "DKK", "DOP", "DZD", "EGP", "ERN", "ETB", "EUR", "FJD", "FKP", "GBP", "GEL", "GHS", "GIP", "GMD", "GNF", "GTQ", "GYD", "HKD", "HNL", "HRK", "HTG", "HUF", "IDR", "ILS", "INR", "IQD", "IRR", "ISK", "JMD", "JOD", "JPY", "KES", "KGS", "KHR", "KMF", "KPW", "KRW", "KWD", "KYD", "KZT", "LAK", "LBP", "LKR", "LRD", "LSL", "LTL", "LYD", "MAD", "MDL", "MGA", "MKD", "MMK", "MNT", "MRU", "MUR", "MVR", "MWK", "MXN", "MYR", "MZN", "NAD", "NGN", "NIO", "NOK", "NPR", "NZD", "OMR", "PAB", "PEN", "PGK", "PHP", "PKR", "PLN", "PYG", "QAR", "RON", "RSD", "RUB", "RWF", "SAR", "SBD", "SCR", "SDG", "SEK", "SGD", "SHP", "SLL", "SOS", "SRD", "SSP", "STD", "SYP", "SZL", "THB", "TJS", "TMT", "TND", "TOP", "TRY", "TTD", "TWD", "TZS", "UAH", "UGX", "USD", "UYU", "UZS", "VEF", "VND", "VUV", "WST", "XAF", "XCD", "XOF", "XPF", "YER", "ZAR", "ZMW", "ZWD" ], "title": "ItAssetsAssetIdArchivePostResponsesContentApplicationJsonSchemaDataActionsStoreOwnAssetAtOwnLocationDetailsServiceCostFeesCurrency", "type": "string" }, "ItAssetsAssetIdArchivePostResponsesContentApplicationJsonSchemaDataActionsStoreOwnAssetAtOwnLocationDetailsServiceCostTokenUsage": { "description": "Add-on token consumption details. Null when billing method is \"CURRENCY\"", "properties": { "addon": { "$ref": "#/components/schemas/ItAssetsAssetIdArchivePostResponsesContentApplicationJsonSchemaDataActionsStoreOwnAssetAtOwnLocationDetailsServiceCostTokenUsageAddon", "description": "The add-on that provides the tokens" }, "cost": { "description": "Number of tokens consumed by the action. Zero when the add-on covers the\nservice without drawing from a token pool", "format": "decimal", "type": "string" }, "tokens_left": { "description": "Number of tokens left in the pool after the action is performed. Null when\nthe add-on covers the service without a token pool", "format": "decimal", "type": [ "string", "null" ] } }, "required": [ "cost", "addon", "tokens_left" ], "title": "ItAssetsAssetIdArchivePostResponsesContentApplicationJsonSchemaDataActionsStoreOwnAssetAtOwnLocationDetailsServiceCostTokenUsage", "type": "object" }, "ItAssetsAssetIdArchivePostResponsesContentApplicationJsonSchemaDataActionsStoreOwnAssetAtOwnLocationDetailsServiceCostTokenUsageAddon": { "description": "The add-on that provides the tokens", "properties": { "id": { "description": "ID of the add-on", "format": "uuid", "type": "string" }, "name": { "description": "Public display name of the add-on", "type": "string" } }, "required": [ "id", "name" ], "title": "ItAssetsAssetIdArchivePostResponsesContentApplicationJsonSchemaDataActionsStoreOwnAssetAtOwnLocationDetailsServiceCostTokenUsageAddon", "type": "object" }, "ItAssetsAssetIdArchivePostResponsesContentApplicationJsonSchemaDataActionsStoreOwnAssetAtOwnLocationDisabledReasonsItems": { "enum": [ "ARCHIVED", "AT_DEEL_WAREHOUSE", "BEING_REPAIRED", "CONSUMABLE", "CONTROLLED_BY_DEEL", "COUNTRY_NOT_SUPPORTED_FOR_HUB", "COUNTRY_NOT_SUPPORTED_FOR_LOCAL", "DEEL_OWNED_ITEM_WITHOUT_RENTAL_CONTRACT", "DESKTOP_STORAGE", "ENDING_CONTRACT", "HUB_IN_SAME_REGION_AS_LOCAL", "INACTIVE", "INVALID_ITEM_LOCATION", "INVALID_ORGANIZATION_STATUS", "INVALID_STATE", "ITEM_CONDITIONS_TO_UNARCHIVE_NOT_MET", "ITEM_NOT_VISIBLE_FOR_ORGANIZATION", "NON_DEVICE", "NOT_AT_WAREHOUSE", "NOT_AVAILABLE_FOR_REUSE", "NOT_A_RENTAL", "NOT_MANAGEABLE_BY_ORGANIZATION", "NOT_WITH_ASSIGNMENT", "NOT_WITH_USER", "NO_ACTIVE_ADDONS", "NO_ACTIVE_STORAGE_CONTRACT", "NO_LOCATION_FOR_STORAGE", "NO_LOGISTICS_FOR_STORAGE", "NO_VALID_ADDONS", "ONGOING_SERVICE", "OWNED_BY_DEEL", "OWNED_BY_ORGANIZATION", "OWNED_BY_PARTNER_ORGANIZATION", "PARTNER_CHILD_CONTRACT", "PENDING_DEVICE_REFRESH", "RENTAL_CONTRACT_AND_USER_REGION_DO_NOT_MATCH", "TEMPORARILY_UNAVAILABLE", "UNKNOWN", "USER_HAS_NO_COUNTRY", "USER_HAS_NO_SEAT", "WAITING_FOR_CLEARANCE", "WITH_LOANER_ASSIGNMENT", "WITH_NON_COLLECTED_ASSIGNMENT", "WITH_NON_DELIVERED_ASSIGNMENT", "WITH_PENDING_ASSIGNMENT", "WRONG_ASSIGNMENT_STATUS", "WRONG_CONTRACT_STATUS", "WRONG_TERMS_AND_CONDITIONS" ], "title": "ItAssetsAssetIdArchivePostResponsesContentApplicationJsonSchemaDataActionsStoreOwnAssetAtOwnLocationDisabledReasonsItems", "type": "string" }, "ItAssetsAssetIdArchivePostResponsesContentApplicationJsonSchemaDataActionsStoreOwnAssetAtOwnLocationStatus": { "description": "Whether the action is currently available for this asset", "enum": [ "DISABLED", "ENABLED", "NOT_APPLICABLE" ], "title": "ItAssetsAssetIdArchivePostResponsesContentApplicationJsonSchemaDataActionsStoreOwnAssetAtOwnLocationStatus", "type": "string" }, "ItAssetsAssetIdArchivePostResponsesContentApplicationJsonSchemaDataActionsStoreRentalAtDeelForLocal": { "description": "Store a Deel-owned rental asset at a Deel local warehouse", "properties": { "details": { "description": "Action-specific context needed to perform the action. Populated for enabled and\ndisabled actions (so callers can see what a successful attempt would look like);\nnull when the action is not applicable to this asset.", "oneOf": [ { "$ref": "#/components/schemas/ItAssetsAssetIdArchivePostResponsesContentApplicationJsonSchemaDataActionsStoreRentalAtDeelForLocalDetails" }, { "type": "null" } ] }, "disabled_reasons": { "description": "Reasons why the action is disabled. Empty when the action is enabled or not applicable", "items": { "$ref": "#/components/schemas/ItAssetsAssetIdArchivePostResponsesContentApplicationJsonSchemaDataActionsStoreRentalAtDeelForLocalDisabledReasonsItems" }, "type": "array" }, "status": { "$ref": "#/components/schemas/ItAssetsAssetIdArchivePostResponsesContentApplicationJsonSchemaDataActionsStoreRentalAtDeelForLocalStatus", "description": "Whether the action is currently available for this asset" } }, "required": [ "status", "details", "disabled_reasons" ], "title": "ItAssetsAssetIdArchivePostResponsesContentApplicationJsonSchemaDataActionsStoreRentalAtDeelForLocal", "type": "object" }, "ItAssetsAssetIdArchivePostResponsesContentApplicationJsonSchemaDataActionsStoreRentalAtDeelForLocalDetails": { "description": "Action-specific context needed to perform the action. Populated for enabled and\ndisabled actions (so callers can see what a successful attempt would look like);\nnull when the action is not applicable to this asset.", "properties": { "activation_cost": { "$ref": "#/components/schemas/ItAssetsAssetIdArchivePostResponsesContentApplicationJsonSchemaDataActionsStoreRentalAtDeelForLocalDetailsActivationCost", "description": "Cost charged to activate local storage" } }, "required": [ "activation_cost" ], "title": "ItAssetsAssetIdArchivePostResponsesContentApplicationJsonSchemaDataActionsStoreRentalAtDeelForLocalDetails", "type": "object" }, "ItAssetsAssetIdArchivePostResponsesContentApplicationJsonSchemaDataActionsStoreRentalAtDeelForLocalDetailsActivationCost": { "description": "Cost charged to activate local storage", "properties": { "billing_method": { "$ref": "#/components/schemas/ItAssetsAssetIdArchivePostResponsesContentApplicationJsonSchemaDataActionsStoreRentalAtDeelForLocalDetailsActivationCostBillingMethod", "description": "How the action is charged. When \"TOKEN\", the fees are covered by an\nadd-on token pool; when \"CURRENCY\", the fees are billed in the currency\nspecified in the \"fees\" field." }, "fees": { "description": "Price charged for the action. Null when billing method is \"TOKEN\"", "oneOf": [ { "$ref": "#/components/schemas/ItAssetsAssetIdArchivePostResponsesContentApplicationJsonSchemaDataActionsStoreRentalAtDeelForLocalDetailsActivationCostFees" }, { "type": "null" } ] }, "token_usage": { "description": "Add-on token consumption details. Null when billing method is \"CURRENCY\"", "oneOf": [ { "$ref": "#/components/schemas/ItAssetsAssetIdArchivePostResponsesContentApplicationJsonSchemaDataActionsStoreRentalAtDeelForLocalDetailsActivationCostTokenUsage" }, { "type": "null" } ] } }, "required": [ "fees", "token_usage", "billing_method" ], "title": "ItAssetsAssetIdArchivePostResponsesContentApplicationJsonSchemaDataActionsStoreRentalAtDeelForLocalDetailsActivationCost", "type": "object" }, "ItAssetsAssetIdArchivePostResponsesContentApplicationJsonSchemaDataActionsStoreRentalAtDeelForLocalDetailsActivationCostBillingMethod": { "description": "How the action is charged. When \"TOKEN\", the fees are covered by an\nadd-on token pool; when \"CURRENCY\", the fees are billed in the currency\nspecified in the \"fees\" field.", "enum": [ "CURRENCY", "TOKEN" ], "title": "ItAssetsAssetIdArchivePostResponsesContentApplicationJsonSchemaDataActionsStoreRentalAtDeelForLocalDetailsActivationCostBillingMethod", "type": "string" }, "ItAssetsAssetIdArchivePostResponsesContentApplicationJsonSchemaDataActionsStoreRentalAtDeelForLocalDetailsActivationCostFees": { "description": "Price charged for the action. Null when billing method is \"TOKEN\"", "properties": { "amount": { "description": "Amount", "format": "decimal", "type": "string" }, "currency": { "$ref": "#/components/schemas/ItAssetsAssetIdArchivePostResponsesContentApplicationJsonSchemaDataActionsStoreRentalAtDeelForLocalDetailsActivationCostFeesCurrency", "description": "Three-letter currency code for the price" } }, "required": [ "amount", "currency" ], "title": "ItAssetsAssetIdArchivePostResponsesContentApplicationJsonSchemaDataActionsStoreRentalAtDeelForLocalDetailsActivationCostFees", "type": "object" }, "ItAssetsAssetIdArchivePostResponsesContentApplicationJsonSchemaDataActionsStoreRentalAtDeelForLocalDetailsActivationCostFeesCurrency": { "description": "Three-letter currency code for the price", "enum": [ "AED", "AFN", "ALL", "AMD", "ANG", "AOA", "ARS", "AUD", "AWG", "AZN", "BAM", "BDT", "BGN", "BHD", "BIF", "BMD", "BOB", "BRL", "BSD", "BTN", "BWP", "BYN", "BZD", "CAD", "CDF", "CHF", "CLP", "CNY", "COP", "CRC", "CUC", "CVE", "CZK", "DJF", "DKK", "DOP", "DZD", "EGP", "ERN", "ETB", "EUR", "FJD", "FKP", "GBP", "GEL", "GHS", "GIP", "GMD", "GNF", "GTQ", "GYD", "HKD", "HNL", "HRK", "HTG", "HUF", "IDR", "ILS", "INR", "IQD", "IRR", "ISK", "JMD", "JOD", "JPY", "KES", "KGS", "KHR", "KMF", "KPW", "KRW", "KWD", "KYD", "KZT", "LAK", "LBP", "LKR", "LRD", "LSL", "LTL", "LYD", "MAD", "MDL", "MGA", "MKD", "MMK", "MNT", "MRU", "MUR", "MVR", "MWK", "MXN", "MYR", "MZN", "NAD", "NGN", "NIO", "NOK", "NPR", "NZD", "OMR", "PAB", "PEN", "PGK", "PHP", "PKR", "PLN", "PYG", "QAR", "RON", "RSD", "RUB", "RWF", "SAR", "SBD", "SCR", "SDG", "SEK", "SGD", "SHP", "SLL", "SOS", "SRD", "SSP", "STD", "SYP", "SZL", "THB", "TJS", "TMT", "TND", "TOP", "TRY", "TTD", "TWD", "TZS", "UAH", "UGX", "USD", "UYU", "UZS", "VEF", "VND", "VUV", "WST", "XAF", "XCD", "XOF", "XPF", "YER", "ZAR", "ZMW", "ZWD" ], "title": "ItAssetsAssetIdArchivePostResponsesContentApplicationJsonSchemaDataActionsStoreRentalAtDeelForLocalDetailsActivationCostFeesCurrency", "type": "string" }, "ItAssetsAssetIdArchivePostResponsesContentApplicationJsonSchemaDataActionsStoreRentalAtDeelForLocalDetailsActivationCostTokenUsage": { "description": "Add-on token consumption details. Null when billing method is \"CURRENCY\"", "properties": { "addon": { "$ref": "#/components/schemas/ItAssetsAssetIdArchivePostResponsesContentApplicationJsonSchemaDataActionsStoreRentalAtDeelForLocalDetailsActivationCostTokenUsageAddon", "description": "The add-on that provides the tokens" }, "cost": { "description": "Number of tokens consumed by the action. Zero when the add-on covers the\nservice without drawing from a token pool", "format": "decimal", "type": "string" }, "tokens_left": { "description": "Number of tokens left in the pool after the action is performed. Null when\nthe add-on covers the service without a token pool", "format": "decimal", "type": [ "string", "null" ] } }, "required": [ "cost", "addon", "tokens_left" ], "title": "ItAssetsAssetIdArchivePostResponsesContentApplicationJsonSchemaDataActionsStoreRentalAtDeelForLocalDetailsActivationCostTokenUsage", "type": "object" }, "ItAssetsAssetIdArchivePostResponsesContentApplicationJsonSchemaDataActionsStoreRentalAtDeelForLocalDetailsActivationCostTokenUsageAddon": { "description": "The add-on that provides the tokens", "properties": { "id": { "description": "ID of the add-on", "format": "uuid", "type": "string" }, "name": { "description": "Public display name of the add-on", "type": "string" } }, "required": [ "id", "name" ], "title": "ItAssetsAssetIdArchivePostResponsesContentApplicationJsonSchemaDataActionsStoreRentalAtDeelForLocalDetailsActivationCostTokenUsageAddon", "type": "object" }, "ItAssetsAssetIdArchivePostResponsesContentApplicationJsonSchemaDataActionsStoreRentalAtDeelForLocalDisabledReasonsItems": { "enum": [ "ARCHIVED", "AT_DEEL_WAREHOUSE", "BEING_REPAIRED", "CONSUMABLE", "CONTROLLED_BY_DEEL", "COUNTRY_NOT_SUPPORTED_FOR_HUB", "COUNTRY_NOT_SUPPORTED_FOR_LOCAL", "DEEL_OWNED_ITEM_WITHOUT_RENTAL_CONTRACT", "DESKTOP_STORAGE", "ENDING_CONTRACT", "HUB_IN_SAME_REGION_AS_LOCAL", "INACTIVE", "INVALID_ITEM_LOCATION", "INVALID_ORGANIZATION_STATUS", "INVALID_STATE", "ITEM_CONDITIONS_TO_UNARCHIVE_NOT_MET", "ITEM_NOT_VISIBLE_FOR_ORGANIZATION", "NON_DEVICE", "NOT_AT_WAREHOUSE", "NOT_AVAILABLE_FOR_REUSE", "NOT_A_RENTAL", "NOT_MANAGEABLE_BY_ORGANIZATION", "NOT_WITH_ASSIGNMENT", "NOT_WITH_USER", "NO_ACTIVE_ADDONS", "NO_ACTIVE_STORAGE_CONTRACT", "NO_LOCATION_FOR_STORAGE", "NO_LOGISTICS_FOR_STORAGE", "NO_VALID_ADDONS", "ONGOING_SERVICE", "OWNED_BY_DEEL", "OWNED_BY_ORGANIZATION", "OWNED_BY_PARTNER_ORGANIZATION", "PARTNER_CHILD_CONTRACT", "PENDING_DEVICE_REFRESH", "RENTAL_CONTRACT_AND_USER_REGION_DO_NOT_MATCH", "TEMPORARILY_UNAVAILABLE", "UNKNOWN", "USER_HAS_NO_COUNTRY", "USER_HAS_NO_SEAT", "WAITING_FOR_CLEARANCE", "WITH_LOANER_ASSIGNMENT", "WITH_NON_COLLECTED_ASSIGNMENT", "WITH_NON_DELIVERED_ASSIGNMENT", "WITH_PENDING_ASSIGNMENT", "WRONG_ASSIGNMENT_STATUS", "WRONG_CONTRACT_STATUS", "WRONG_TERMS_AND_CONDITIONS" ], "title": "ItAssetsAssetIdArchivePostResponsesContentApplicationJsonSchemaDataActionsStoreRentalAtDeelForLocalDisabledReasonsItems", "type": "string" }, "ItAssetsAssetIdArchivePostResponsesContentApplicationJsonSchemaDataActionsStoreRentalAtDeelForLocalStatus": { "description": "Whether the action is currently available for this asset", "enum": [ "DISABLED", "ENABLED", "NOT_APPLICABLE" ], "title": "ItAssetsAssetIdArchivePostResponsesContentApplicationJsonSchemaDataActionsStoreRentalAtDeelForLocalStatus", "type": "string" }, "ItAssetsAssetIdArchivePostResponsesContentApplicationJsonSchemaDataActionsStoreRentalAtDeelForZone1": { "description": "Store a Deel-owned rental asset at a Deel zone-1 warehouse", "properties": { "details": { "description": "Action-specific context needed to perform the action. Populated for enabled and\ndisabled actions (so callers can see what a successful attempt would look like);\nnull when the action is not applicable to this asset.", "oneOf": [ { "$ref": "#/components/schemas/ItAssetsAssetIdArchivePostResponsesContentApplicationJsonSchemaDataActionsStoreRentalAtDeelForZone1Details" }, { "type": "null" } ] }, "disabled_reasons": { "description": "Reasons why the action is disabled. Empty when the action is enabled or not applicable", "items": { "$ref": "#/components/schemas/ItAssetsAssetIdArchivePostResponsesContentApplicationJsonSchemaDataActionsStoreRentalAtDeelForZone1DisabledReasonsItems" }, "type": "array" }, "status": { "$ref": "#/components/schemas/ItAssetsAssetIdArchivePostResponsesContentApplicationJsonSchemaDataActionsStoreRentalAtDeelForZone1Status", "description": "Whether the action is currently available for this asset" } }, "required": [ "status", "details", "disabled_reasons" ], "title": "ItAssetsAssetIdArchivePostResponsesContentApplicationJsonSchemaDataActionsStoreRentalAtDeelForZone1", "type": "object" }, "ItAssetsAssetIdArchivePostResponsesContentApplicationJsonSchemaDataActionsStoreRentalAtDeelForZone1Details": { "description": "Action-specific context needed to perform the action. Populated for enabled and\ndisabled actions (so callers can see what a successful attempt would look like);\nnull when the action is not applicable to this asset.", "properties": { "activation_cost": { "$ref": "#/components/schemas/ItAssetsAssetIdArchivePostResponsesContentApplicationJsonSchemaDataActionsStoreRentalAtDeelForZone1DetailsActivationCost", "description": "Cost charged to activate zone-1 storage" } }, "required": [ "activation_cost" ], "title": "ItAssetsAssetIdArchivePostResponsesContentApplicationJsonSchemaDataActionsStoreRentalAtDeelForZone1Details", "type": "object" }, "ItAssetsAssetIdArchivePostResponsesContentApplicationJsonSchemaDataActionsStoreRentalAtDeelForZone1DetailsActivationCost": { "description": "Cost charged to activate zone-1 storage", "properties": { "billing_method": { "$ref": "#/components/schemas/ItAssetsAssetIdArchivePostResponsesContentApplicationJsonSchemaDataActionsStoreRentalAtDeelForZone1DetailsActivationCostBillingMethod", "description": "How the action is charged. When \"TOKEN\", the fees are covered by an\nadd-on token pool; when \"CURRENCY\", the fees are billed in the currency\nspecified in the \"fees\" field." }, "fees": { "description": "Price charged for the action. Null when billing method is \"TOKEN\"", "oneOf": [ { "$ref": "#/components/schemas/ItAssetsAssetIdArchivePostResponsesContentApplicationJsonSchemaDataActionsStoreRentalAtDeelForZone1DetailsActivationCostFees" }, { "type": "null" } ] }, "token_usage": { "description": "Add-on token consumption details. Null when billing method is \"CURRENCY\"", "oneOf": [ { "$ref": "#/components/schemas/ItAssetsAssetIdArchivePostResponsesContentApplicationJsonSchemaDataActionsStoreRentalAtDeelForZone1DetailsActivationCostTokenUsage" }, { "type": "null" } ] } }, "required": [ "fees", "token_usage", "billing_method" ], "title": "ItAssetsAssetIdArchivePostResponsesContentApplicationJsonSchemaDataActionsStoreRentalAtDeelForZone1DetailsActivationCost", "type": "object" }, "ItAssetsAssetIdArchivePostResponsesContentApplicationJsonSchemaDataActionsStoreRentalAtDeelForZone1DetailsActivationCostBillingMethod": { "description": "How the action is charged. When \"TOKEN\", the fees are covered by an\nadd-on token pool; when \"CURRENCY\", the fees are billed in the currency\nspecified in the \"fees\" field.", "enum": [ "CURRENCY", "TOKEN" ], "title": "ItAssetsAssetIdArchivePostResponsesContentApplicationJsonSchemaDataActionsStoreRentalAtDeelForZone1DetailsActivationCostBillingMethod", "type": "string" }, "ItAssetsAssetIdArchivePostResponsesContentApplicationJsonSchemaDataActionsStoreRentalAtDeelForZone1DetailsActivationCostFees": { "description": "Price charged for the action. Null when billing method is \"TOKEN\"", "properties": { "amount": { "description": "Amount", "format": "decimal", "type": "string" }, "currency": { "$ref": "#/components/schemas/ItAssetsAssetIdArchivePostResponsesContentApplicationJsonSchemaDataActionsStoreRentalAtDeelForZone1DetailsActivationCostFeesCurrency", "description": "Three-letter currency code for the price" } }, "required": [ "amount", "currency" ], "title": "ItAssetsAssetIdArchivePostResponsesContentApplicationJsonSchemaDataActionsStoreRentalAtDeelForZone1DetailsActivationCostFees", "type": "object" }, "ItAssetsAssetIdArchivePostResponsesContentApplicationJsonSchemaDataActionsStoreRentalAtDeelForZone1DetailsActivationCostFeesCurrency": { "description": "Three-letter currency code for the price", "enum": [ "AED", "AFN", "ALL", "AMD", "ANG", "AOA", "ARS", "AUD", "AWG", "AZN", "BAM", "BDT", "BGN", "BHD", "BIF", "BMD", "BOB", "BRL", "BSD", "BTN", "BWP", "BYN", "BZD", "CAD", "CDF", "CHF", "CLP", "CNY", "COP", "CRC", "CUC", "CVE", "CZK", "DJF", "DKK", "DOP", "DZD", "EGP", "ERN", "ETB", "EUR", "FJD", "FKP", "GBP", "GEL", "GHS", "GIP", "GMD", "GNF", "GTQ", "GYD", "HKD", "HNL", "HRK", "HTG", "HUF", "IDR", "ILS", "INR", "IQD", "IRR", "ISK", "JMD", "JOD", "JPY", "KES", "KGS", "KHR", "KMF", "KPW", "KRW", "KWD", "KYD", "KZT", "LAK", "LBP", "LKR", "LRD", "LSL", "LTL", "LYD", "MAD", "MDL", "MGA", "MKD", "MMK", "MNT", "MRU", "MUR", "MVR", "MWK", "MXN", "MYR", "MZN", "NAD", "NGN", "NIO", "NOK", "NPR", "NZD", "OMR", "PAB", "PEN", "PGK", "PHP", "PKR", "PLN", "PYG", "QAR", "RON", "RSD", "RUB", "RWF", "SAR", "SBD", "SCR", "SDG", "SEK", "SGD", "SHP", "SLL", "SOS", "SRD", "SSP", "STD", "SYP", "SZL", "THB", "TJS", "TMT", "TND", "TOP", "TRY", "TTD", "TWD", "TZS", "UAH", "UGX", "USD", "UYU", "UZS", "VEF", "VND", "VUV", "WST", "XAF", "XCD", "XOF", "XPF", "YER", "ZAR", "ZMW", "ZWD" ], "title": "ItAssetsAssetIdArchivePostResponsesContentApplicationJsonSchemaDataActionsStoreRentalAtDeelForZone1DetailsActivationCostFeesCurrency", "type": "string" }, "ItAssetsAssetIdArchivePostResponsesContentApplicationJsonSchemaDataActionsStoreRentalAtDeelForZone1DetailsActivationCostTokenUsage": { "description": "Add-on token consumption details. Null when billing method is \"CURRENCY\"", "properties": { "addon": { "$ref": "#/components/schemas/ItAssetsAssetIdArchivePostResponsesContentApplicationJsonSchemaDataActionsStoreRentalAtDeelForZone1DetailsActivationCostTokenUsageAddon", "description": "The add-on that provides the tokens" }, "cost": { "description": "Number of tokens consumed by the action. Zero when the add-on covers the\nservice without drawing from a token pool", "format": "decimal", "type": "string" }, "tokens_left": { "description": "Number of tokens left in the pool after the action is performed. Null when\nthe add-on covers the service without a token pool", "format": "decimal", "type": [ "string", "null" ] } }, "required": [ "cost", "addon", "tokens_left" ], "title": "ItAssetsAssetIdArchivePostResponsesContentApplicationJsonSchemaDataActionsStoreRentalAtDeelForZone1DetailsActivationCostTokenUsage", "type": "object" }, "ItAssetsAssetIdArchivePostResponsesContentApplicationJsonSchemaDataActionsStoreRentalAtDeelForZone1DetailsActivationCostTokenUsageAddon": { "description": "The add-on that provides the tokens", "properties": { "id": { "description": "ID of the add-on", "format": "uuid", "type": "string" }, "name": { "description": "Public display name of the add-on", "type": "string" } }, "required": [ "id", "name" ], "title": "ItAssetsAssetIdArchivePostResponsesContentApplicationJsonSchemaDataActionsStoreRentalAtDeelForZone1DetailsActivationCostTokenUsageAddon", "type": "object" }, "ItAssetsAssetIdArchivePostResponsesContentApplicationJsonSchemaDataActionsStoreRentalAtDeelForZone1DisabledReasonsItems": { "enum": [ "ARCHIVED", "AT_DEEL_WAREHOUSE", "BEING_REPAIRED", "CONSUMABLE", "CONTROLLED_BY_DEEL", "COUNTRY_NOT_SUPPORTED_FOR_HUB", "COUNTRY_NOT_SUPPORTED_FOR_LOCAL", "DEEL_OWNED_ITEM_WITHOUT_RENTAL_CONTRACT", "DESKTOP_STORAGE", "ENDING_CONTRACT", "HUB_IN_SAME_REGION_AS_LOCAL", "INACTIVE", "INVALID_ITEM_LOCATION", "INVALID_ORGANIZATION_STATUS", "INVALID_STATE", "ITEM_CONDITIONS_TO_UNARCHIVE_NOT_MET", "ITEM_NOT_VISIBLE_FOR_ORGANIZATION", "NON_DEVICE", "NOT_AT_WAREHOUSE", "NOT_AVAILABLE_FOR_REUSE", "NOT_A_RENTAL", "NOT_MANAGEABLE_BY_ORGANIZATION", "NOT_WITH_ASSIGNMENT", "NOT_WITH_USER", "NO_ACTIVE_ADDONS", "NO_ACTIVE_STORAGE_CONTRACT", "NO_LOCATION_FOR_STORAGE", "NO_LOGISTICS_FOR_STORAGE", "NO_VALID_ADDONS", "ONGOING_SERVICE", "OWNED_BY_DEEL", "OWNED_BY_ORGANIZATION", "OWNED_BY_PARTNER_ORGANIZATION", "PARTNER_CHILD_CONTRACT", "PENDING_DEVICE_REFRESH", "RENTAL_CONTRACT_AND_USER_REGION_DO_NOT_MATCH", "TEMPORARILY_UNAVAILABLE", "UNKNOWN", "USER_HAS_NO_COUNTRY", "USER_HAS_NO_SEAT", "WAITING_FOR_CLEARANCE", "WITH_LOANER_ASSIGNMENT", "WITH_NON_COLLECTED_ASSIGNMENT", "WITH_NON_DELIVERED_ASSIGNMENT", "WITH_PENDING_ASSIGNMENT", "WRONG_ASSIGNMENT_STATUS", "WRONG_CONTRACT_STATUS", "WRONG_TERMS_AND_CONDITIONS" ], "title": "ItAssetsAssetIdArchivePostResponsesContentApplicationJsonSchemaDataActionsStoreRentalAtDeelForZone1DisabledReasonsItems", "type": "string" }, "ItAssetsAssetIdArchivePostResponsesContentApplicationJsonSchemaDataActionsStoreRentalAtDeelForZone1Status": { "description": "Whether the action is currently available for this asset", "enum": [ "DISABLED", "ENABLED", "NOT_APPLICABLE" ], "title": "ItAssetsAssetIdArchivePostResponsesContentApplicationJsonSchemaDataActionsStoreRentalAtDeelForZone1Status", "type": "string" }, "ItAssetsAssetIdArchivePostResponsesContentApplicationJsonSchemaDataActionsTransferOwnAsset": { "description": "Transfer an organization-owned asset to another user", "properties": { "details": { "description": "Action-specific context needed to perform the action. Populated for enabled and\ndisabled actions (so callers can see what a successful attempt would look like);\nnull when the action is not applicable to this asset.", "oneOf": [ { "$ref": "#/components/schemas/ItAssetsAssetIdArchivePostResponsesContentApplicationJsonSchemaDataActionsTransferOwnAssetDetails" }, { "type": "null" } ] }, "disabled_reasons": { "description": "Reasons why the action is disabled. Empty when the action is enabled or not applicable", "items": { "$ref": "#/components/schemas/ItAssetsAssetIdArchivePostResponsesContentApplicationJsonSchemaDataActionsTransferOwnAssetDisabledReasonsItems" }, "type": "array" }, "status": { "$ref": "#/components/schemas/ItAssetsAssetIdArchivePostResponsesContentApplicationJsonSchemaDataActionsTransferOwnAssetStatus", "description": "Whether the action is currently available for this asset" } }, "required": [ "status", "details", "disabled_reasons" ], "title": "ItAssetsAssetIdArchivePostResponsesContentApplicationJsonSchemaDataActionsTransferOwnAsset", "type": "object" }, "ItAssetsAssetIdArchivePostResponsesContentApplicationJsonSchemaDataActionsTransferOwnAssetDetails": { "description": "Action-specific context needed to perform the action. Populated for enabled and\ndisabled actions (so callers can see what a successful attempt would look like);\nnull when the action is not applicable to this asset.", "properties": { "eligible_countries": { "description": "Countries the asset can be transferred to", "items": { "$ref": "#/components/schemas/ItAssetsAssetIdArchivePostResponsesContentApplicationJsonSchemaDataActionsTransferOwnAssetDetailsEligibleCountriesItems" }, "type": "array" }, "transfer_cost": { "$ref": "#/components/schemas/ItAssetsAssetIdArchivePostResponsesContentApplicationJsonSchemaDataActionsTransferOwnAssetDetailsTransferCost", "description": "Cost charged for the transfer service" } }, "required": [ "transfer_cost", "eligible_countries" ], "title": "ItAssetsAssetIdArchivePostResponsesContentApplicationJsonSchemaDataActionsTransferOwnAssetDetails", "type": "object" }, "ItAssetsAssetIdArchivePostResponsesContentApplicationJsonSchemaDataActionsTransferOwnAssetDetailsEligibleCountriesItems": { "enum": [ "AD", "AE", "AF", "AG", "AI", "AL", "AM", "AN", "AO", "AQ", "AR", "AS", "AT", "AU", "AW", "AX", "AZ", "BA", "BB", "BD", "BE", "BF", "BG", "BH", "BI", "BJ", "BL", "BM", "BN", "BO", "BQ", "BR", "BS", "BT", "BV", "BW", "BY", "BZ", "CA", "CC", "CD", "CF", "CG", "CH", "CI", "CK", "CL", "CM", "CN", "CO", "CR", "CU", "CV", "CW", "CX", "CY", "CZ", "DE", "DJ", "DK", "DM", "DO", "DZ", "EC", "EE", "EG", "EH", "ER", "ES", "ET", "FI", "FJ", "FK", "FM", "FO", "FR", "GA", "GB", "GD", "GE", "GF", "GG", "GH", "GI", "GL", "GM", "GN", "GP", "GQ", "GR", "GS", "GT", "GU", "GW", "GY", "HK", "HM", "HN", "HR", "HT", "HU", "IC", "ID", "IE", "IL", "IM", "IN", "IO", "IQ", "IR", "IS", "IT", "JE", "JM", "JO", "JP", "KE", "KG", "KH", "KI", "KM", "KN", "KP", "KR", "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", "XK", "YE", "YT", "ZA", "ZM", "ZW" ], "title": "ItAssetsAssetIdArchivePostResponsesContentApplicationJsonSchemaDataActionsTransferOwnAssetDetailsEligibleCountriesItems", "type": "string" }, "ItAssetsAssetIdArchivePostResponsesContentApplicationJsonSchemaDataActionsTransferOwnAssetDetailsTransferCost": { "description": "Cost charged for the transfer service", "properties": { "billing_method": { "$ref": "#/components/schemas/ItAssetsAssetIdArchivePostResponsesContentApplicationJsonSchemaDataActionsTransferOwnAssetDetailsTransferCostBillingMethod", "description": "How the action is charged. When \"TOKEN\", the fees are covered by an\nadd-on token pool; when \"CURRENCY\", the fees are billed in the currency\nspecified in the \"fees\" field." }, "fees": { "description": "Price charged for the action. Null when billing method is \"TOKEN\"", "oneOf": [ { "$ref": "#/components/schemas/ItAssetsAssetIdArchivePostResponsesContentApplicationJsonSchemaDataActionsTransferOwnAssetDetailsTransferCostFees" }, { "type": "null" } ] }, "token_usage": { "description": "Add-on token consumption details. Null when billing method is \"CURRENCY\"", "oneOf": [ { "$ref": "#/components/schemas/ItAssetsAssetIdArchivePostResponsesContentApplicationJsonSchemaDataActionsTransferOwnAssetDetailsTransferCostTokenUsage" }, { "type": "null" } ] } }, "required": [ "fees", "token_usage", "billing_method" ], "title": "ItAssetsAssetIdArchivePostResponsesContentApplicationJsonSchemaDataActionsTransferOwnAssetDetailsTransferCost", "type": "object" }, "ItAssetsAssetIdArchivePostResponsesContentApplicationJsonSchemaDataActionsTransferOwnAssetDetailsTransferCostBillingMethod": { "description": "How the action is charged. When \"TOKEN\", the fees are covered by an\nadd-on token pool; when \"CURRENCY\", the fees are billed in the currency\nspecified in the \"fees\" field.", "enum": [ "CURRENCY", "TOKEN" ], "title": "ItAssetsAssetIdArchivePostResponsesContentApplicationJsonSchemaDataActionsTransferOwnAssetDetailsTransferCostBillingMethod", "type": "string" }, "ItAssetsAssetIdArchivePostResponsesContentApplicationJsonSchemaDataActionsTransferOwnAssetDetailsTransferCostFees": { "description": "Price charged for the action. Null when billing method is \"TOKEN\"", "properties": { "amount": { "description": "Amount", "format": "decimal", "type": "string" }, "currency": { "$ref": "#/components/schemas/ItAssetsAssetIdArchivePostResponsesContentApplicationJsonSchemaDataActionsTransferOwnAssetDetailsTransferCostFeesCurrency", "description": "Three-letter currency code for the price" } }, "required": [ "amount", "currency" ], "title": "ItAssetsAssetIdArchivePostResponsesContentApplicationJsonSchemaDataActionsTransferOwnAssetDetailsTransferCostFees", "type": "object" }, "ItAssetsAssetIdArchivePostResponsesContentApplicationJsonSchemaDataActionsTransferOwnAssetDetailsTransferCostFeesCurrency": { "description": "Three-letter currency code for the price", "enum": [ "AED", "AFN", "ALL", "AMD", "ANG", "AOA", "ARS", "AUD", "AWG", "AZN", "BAM", "BDT", "BGN", "BHD", "BIF", "BMD", "BOB", "BRL", "BSD", "BTN", "BWP", "BYN", "BZD", "CAD", "CDF", "CHF", "CLP", "CNY", "COP", "CRC", "CUC", "CVE", "CZK", "DJF", "DKK", "DOP", "DZD", "EGP", "ERN", "ETB", "EUR", "FJD", "FKP", "GBP", "GEL", "GHS", "GIP", "GMD", "GNF", "GTQ", "GYD", "HKD", "HNL", "HRK", "HTG", "HUF", "IDR", "ILS", "INR", "IQD", "IRR", "ISK", "JMD", "JOD", "JPY", "KES", "KGS", "KHR", "KMF", "KPW", "KRW", "KWD", "KYD", "KZT", "LAK", "LBP", "LKR", "LRD", "LSL", "LTL", "LYD", "MAD", "MDL", "MGA", "MKD", "MMK", "MNT", "MRU", "MUR", "MVR", "MWK", "MXN", "MYR", "MZN", "NAD", "NGN", "NIO", "NOK", "NPR", "NZD", "OMR", "PAB", "PEN", "PGK", "PHP", "PKR", "PLN", "PYG", "QAR", "RON", "RSD", "RUB", "RWF", "SAR", "SBD", "SCR", "SDG", "SEK", "SGD", "SHP", "SLL", "SOS", "SRD", "SSP", "STD", "SYP", "SZL", "THB", "TJS", "TMT", "TND", "TOP", "TRY", "TTD", "TWD", "TZS", "UAH", "UGX", "USD", "UYU", "UZS", "VEF", "VND", "VUV", "WST", "XAF", "XCD", "XOF", "XPF", "YER", "ZAR", "ZMW", "ZWD" ], "title": "ItAssetsAssetIdArchivePostResponsesContentApplicationJsonSchemaDataActionsTransferOwnAssetDetailsTransferCostFeesCurrency", "type": "string" }, "ItAssetsAssetIdArchivePostResponsesContentApplicationJsonSchemaDataActionsTransferOwnAssetDetailsTransferCostTokenUsage": { "description": "Add-on token consumption details. Null when billing method is \"CURRENCY\"", "properties": { "addon": { "$ref": "#/components/schemas/ItAssetsAssetIdArchivePostResponsesContentApplicationJsonSchemaDataActionsTransferOwnAssetDetailsTransferCostTokenUsageAddon", "description": "The add-on that provides the tokens" }, "cost": { "description": "Number of tokens consumed by the action. Zero when the add-on covers the\nservice without drawing from a token pool", "format": "decimal", "type": "string" }, "tokens_left": { "description": "Number of tokens left in the pool after the action is performed. Null when\nthe add-on covers the service without a token pool", "format": "decimal", "type": [ "string", "null" ] } }, "required": [ "cost", "addon", "tokens_left" ], "title": "ItAssetsAssetIdArchivePostResponsesContentApplicationJsonSchemaDataActionsTransferOwnAssetDetailsTransferCostTokenUsage", "type": "object" }, "ItAssetsAssetIdArchivePostResponsesContentApplicationJsonSchemaDataActionsTransferOwnAssetDetailsTransferCostTokenUsageAddon": { "description": "The add-on that provides the tokens", "properties": { "id": { "description": "ID of the add-on", "format": "uuid", "type": "string" }, "name": { "description": "Public display name of the add-on", "type": "string" } }, "required": [ "id", "name" ], "title": "ItAssetsAssetIdArchivePostResponsesContentApplicationJsonSchemaDataActionsTransferOwnAssetDetailsTransferCostTokenUsageAddon", "type": "object" }, "ItAssetsAssetIdArchivePostResponsesContentApplicationJsonSchemaDataActionsTransferOwnAssetDisabledReasonsItems": { "enum": [ "ARCHIVED", "AT_DEEL_WAREHOUSE", "BEING_REPAIRED", "CONSUMABLE", "CONTROLLED_BY_DEEL", "COUNTRY_NOT_SUPPORTED_FOR_HUB", "COUNTRY_NOT_SUPPORTED_FOR_LOCAL", "DEEL_OWNED_ITEM_WITHOUT_RENTAL_CONTRACT", "DESKTOP_STORAGE", "ENDING_CONTRACT", "HUB_IN_SAME_REGION_AS_LOCAL", "INACTIVE", "INVALID_ITEM_LOCATION", "INVALID_ORGANIZATION_STATUS", "INVALID_STATE", "ITEM_CONDITIONS_TO_UNARCHIVE_NOT_MET", "ITEM_NOT_VISIBLE_FOR_ORGANIZATION", "NON_DEVICE", "NOT_AT_WAREHOUSE", "NOT_AVAILABLE_FOR_REUSE", "NOT_A_RENTAL", "NOT_MANAGEABLE_BY_ORGANIZATION", "NOT_WITH_ASSIGNMENT", "NOT_WITH_USER", "NO_ACTIVE_ADDONS", "NO_ACTIVE_STORAGE_CONTRACT", "NO_LOCATION_FOR_STORAGE", "NO_LOGISTICS_FOR_STORAGE", "NO_VALID_ADDONS", "ONGOING_SERVICE", "OWNED_BY_DEEL", "OWNED_BY_ORGANIZATION", "OWNED_BY_PARTNER_ORGANIZATION", "PARTNER_CHILD_CONTRACT", "PENDING_DEVICE_REFRESH", "RENTAL_CONTRACT_AND_USER_REGION_DO_NOT_MATCH", "TEMPORARILY_UNAVAILABLE", "UNKNOWN", "USER_HAS_NO_COUNTRY", "USER_HAS_NO_SEAT", "WAITING_FOR_CLEARANCE", "WITH_LOANER_ASSIGNMENT", "WITH_NON_COLLECTED_ASSIGNMENT", "WITH_NON_DELIVERED_ASSIGNMENT", "WITH_PENDING_ASSIGNMENT", "WRONG_ASSIGNMENT_STATUS", "WRONG_CONTRACT_STATUS", "WRONG_TERMS_AND_CONDITIONS" ], "title": "ItAssetsAssetIdArchivePostResponsesContentApplicationJsonSchemaDataActionsTransferOwnAssetDisabledReasonsItems", "type": "string" }, "ItAssetsAssetIdArchivePostResponsesContentApplicationJsonSchemaDataActionsTransferOwnAssetStatus": { "description": "Whether the action is currently available for this asset", "enum": [ "DISABLED", "ENABLED", "NOT_APPLICABLE" ], "title": "ItAssetsAssetIdArchivePostResponsesContentApplicationJsonSchemaDataActionsTransferOwnAssetStatus", "type": "string" }, "ItAssetsAssetIdArchivePostResponsesContentApplicationJsonSchemaDataActionsTransferRental": { "description": "Transfer a Deel-owned rental asset to another user", "properties": { "details": { "description": "Action-specific context needed to perform the action. Populated for enabled and\ndisabled actions (so callers can see what a successful attempt would look like);\nnull when the action is not applicable to this asset.", "oneOf": [ { "$ref": "#/components/schemas/ItAssetsAssetIdArchivePostResponsesContentApplicationJsonSchemaDataActionsTransferRentalDetails" }, { "type": "null" } ] }, "disabled_reasons": { "description": "Reasons why the action is disabled. Empty when the action is enabled or not applicable", "items": { "$ref": "#/components/schemas/ItAssetsAssetIdArchivePostResponsesContentApplicationJsonSchemaDataActionsTransferRentalDisabledReasonsItems" }, "type": "array" }, "status": { "$ref": "#/components/schemas/ItAssetsAssetIdArchivePostResponsesContentApplicationJsonSchemaDataActionsTransferRentalStatus", "description": "Whether the action is currently available for this asset" } }, "required": [ "status", "details", "disabled_reasons" ], "title": "ItAssetsAssetIdArchivePostResponsesContentApplicationJsonSchemaDataActionsTransferRental", "type": "object" }, "ItAssetsAssetIdArchivePostResponsesContentApplicationJsonSchemaDataActionsTransferRentalDetails": { "description": "Action-specific context needed to perform the action. Populated for enabled and\ndisabled actions (so callers can see what a successful attempt would look like);\nnull when the action is not applicable to this asset.", "properties": { "eligible_countries": { "description": "Countries the asset can be transferred to", "items": { "$ref": "#/components/schemas/ItAssetsAssetIdArchivePostResponsesContentApplicationJsonSchemaDataActionsTransferRentalDetailsEligibleCountriesItems" }, "type": "array" }, "transfer_cost": { "$ref": "#/components/schemas/ItAssetsAssetIdArchivePostResponsesContentApplicationJsonSchemaDataActionsTransferRentalDetailsTransferCost", "description": "Cost charged for the transfer service" } }, "required": [ "transfer_cost", "eligible_countries" ], "title": "ItAssetsAssetIdArchivePostResponsesContentApplicationJsonSchemaDataActionsTransferRentalDetails", "type": "object" }, "ItAssetsAssetIdArchivePostResponsesContentApplicationJsonSchemaDataActionsTransferRentalDetailsEligibleCountriesItems": { "enum": [ "AD", "AE", "AF", "AG", "AI", "AL", "AM", "AN", "AO", "AQ", "AR", "AS", "AT", "AU", "AW", "AX", "AZ", "BA", "BB", "BD", "BE", "BF", "BG", "BH", "BI", "BJ", "BL", "BM", "BN", "BO", "BQ", "BR", "BS", "BT", "BV", "BW", "BY", "BZ", "CA", "CC", "CD", "CF", "CG", "CH", "CI", "CK", "CL", "CM", "CN", "CO", "CR", "CU", "CV", "CW", "CX", "CY", "CZ", "DE", "DJ", "DK", "DM", "DO", "DZ", "EC", "EE", "EG", "EH", "ER", "ES", "ET", "FI", "FJ", "FK", "FM", "FO", "FR", "GA", "GB", "GD", "GE", "GF", "GG", "GH", "GI", "GL", "GM", "GN", "GP", "GQ", "GR", "GS", "GT", "GU", "GW", "GY", "HK", "HM", "HN", "HR", "HT", "HU", "IC", "ID", "IE", "IL", "IM", "IN", "IO", "IQ", "IR", "IS", "IT", "JE", "JM", "JO", "JP", "KE", "KG", "KH", "KI", "KM", "KN", "KP", "KR", "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", "XK", "YE", "YT", "ZA", "ZM", "ZW" ], "title": "ItAssetsAssetIdArchivePostResponsesContentApplicationJsonSchemaDataActionsTransferRentalDetailsEligibleCountriesItems", "type": "string" }, "ItAssetsAssetIdArchivePostResponsesContentApplicationJsonSchemaDataActionsTransferRentalDetailsTransferCost": { "description": "Cost charged for the transfer service", "properties": { "billing_method": { "$ref": "#/components/schemas/ItAssetsAssetIdArchivePostResponsesContentApplicationJsonSchemaDataActionsTransferRentalDetailsTransferCostBillingMethod", "description": "How the action is charged. When \"TOKEN\", the fees are covered by an\nadd-on token pool; when \"CURRENCY\", the fees are billed in the currency\nspecified in the \"fees\" field." }, "fees": { "description": "Price charged for the action. Null when billing method is \"TOKEN\"", "oneOf": [ { "$ref": "#/components/schemas/ItAssetsAssetIdArchivePostResponsesContentApplicationJsonSchemaDataActionsTransferRentalDetailsTransferCostFees" }, { "type": "null" } ] }, "token_usage": { "description": "Add-on token consumption details. Null when billing method is \"CURRENCY\"", "oneOf": [ { "$ref": "#/components/schemas/ItAssetsAssetIdArchivePostResponsesContentApplicationJsonSchemaDataActionsTransferRentalDetailsTransferCostTokenUsage" }, { "type": "null" } ] } }, "required": [ "fees", "token_usage", "billing_method" ], "title": "ItAssetsAssetIdArchivePostResponsesContentApplicationJsonSchemaDataActionsTransferRentalDetailsTransferCost", "type": "object" }, "ItAssetsAssetIdArchivePostResponsesContentApplicationJsonSchemaDataActionsTransferRentalDetailsTransferCostBillingMethod": { "description": "How the action is charged. When \"TOKEN\", the fees are covered by an\nadd-on token pool; when \"CURRENCY\", the fees are billed in the currency\nspecified in the \"fees\" field.", "enum": [ "CURRENCY", "TOKEN" ], "title": "ItAssetsAssetIdArchivePostResponsesContentApplicationJsonSchemaDataActionsTransferRentalDetailsTransferCostBillingMethod", "type": "string" }, "ItAssetsAssetIdArchivePostResponsesContentApplicationJsonSchemaDataActionsTransferRentalDetailsTransferCostFees": { "description": "Price charged for the action. Null when billing method is \"TOKEN\"", "properties": { "amount": { "description": "Amount", "format": "decimal", "type": "string" }, "currency": { "$ref": "#/components/schemas/ItAssetsAssetIdArchivePostResponsesContentApplicationJsonSchemaDataActionsTransferRentalDetailsTransferCostFeesCurrency", "description": "Three-letter currency code for the price" } }, "required": [ "amount", "currency" ], "title": "ItAssetsAssetIdArchivePostResponsesContentApplicationJsonSchemaDataActionsTransferRentalDetailsTransferCostFees", "type": "object" }, "ItAssetsAssetIdArchivePostResponsesContentApplicationJsonSchemaDataActionsTransferRentalDetailsTransferCostFeesCurrency": { "description": "Three-letter currency code for the price", "enum": [ "AED", "AFN", "ALL", "AMD", "ANG", "AOA", "ARS", "AUD", "AWG", "AZN", "BAM", "BDT", "BGN", "BHD", "BIF", "BMD", "BOB", "BRL", "BSD", "BTN", "BWP", "BYN", "BZD", "CAD", "CDF", "CHF", "CLP", "CNY", "COP", "CRC", "CUC", "CVE", "CZK", "DJF", "DKK", "DOP", "DZD", "EGP", "ERN", "ETB", "EUR", "FJD", "FKP", "GBP", "GEL", "GHS", "GIP", "GMD", "GNF", "GTQ", "GYD", "HKD", "HNL", "HRK", "HTG", "HUF", "IDR", "ILS", "INR", "IQD", "IRR", "ISK", "JMD", "JOD", "JPY", "KES", "KGS", "KHR", "KMF", "KPW", "KRW", "KWD", "KYD", "KZT", "LAK", "LBP", "LKR", "LRD", "LSL", "LTL", "LYD", "MAD", "MDL", "MGA", "MKD", "MMK", "MNT", "MRU", "MUR", "MVR", "MWK", "MXN", "MYR", "MZN", "NAD", "NGN", "NIO", "NOK", "NPR", "NZD", "OMR", "PAB", "PEN", "PGK", "PHP", "PKR", "PLN", "PYG", "QAR", "RON", "RSD", "RUB", "RWF", "SAR", "SBD", "SCR", "SDG", "SEK", "SGD", "SHP", "SLL", "SOS", "SRD", "SSP", "STD", "SYP", "SZL", "THB", "TJS", "TMT", "TND", "TOP", "TRY", "TTD", "TWD", "TZS", "UAH", "UGX", "USD", "UYU", "UZS", "VEF", "VND", "VUV", "WST", "XAF", "XCD", "XOF", "XPF", "YER", "ZAR", "ZMW", "ZWD" ], "title": "ItAssetsAssetIdArchivePostResponsesContentApplicationJsonSchemaDataActionsTransferRentalDetailsTransferCostFeesCurrency", "type": "string" }, "ItAssetsAssetIdArchivePostResponsesContentApplicationJsonSchemaDataActionsTransferRentalDetailsTransferCostTokenUsage": { "description": "Add-on token consumption details. Null when billing method is \"CURRENCY\"", "properties": { "addon": { "$ref": "#/components/schemas/ItAssetsAssetIdArchivePostResponsesContentApplicationJsonSchemaDataActionsTransferRentalDetailsTransferCostTokenUsageAddon", "description": "The add-on that provides the tokens" }, "cost": { "description": "Number of tokens consumed by the action. Zero when the add-on covers the\nservice without drawing from a token pool", "format": "decimal", "type": "string" }, "tokens_left": { "description": "Number of tokens left in the pool after the action is performed. Null when\nthe add-on covers the service without a token pool", "format": "decimal", "type": [ "string", "null" ] } }, "required": [ "cost", "addon", "tokens_left" ], "title": "ItAssetsAssetIdArchivePostResponsesContentApplicationJsonSchemaDataActionsTransferRentalDetailsTransferCostTokenUsage", "type": "object" }, "ItAssetsAssetIdArchivePostResponsesContentApplicationJsonSchemaDataActionsTransferRentalDetailsTransferCostTokenUsageAddon": { "description": "The add-on that provides the tokens", "properties": { "id": { "description": "ID of the add-on", "format": "uuid", "type": "string" }, "name": { "description": "Public display name of the add-on", "type": "string" } }, "required": [ "id", "name" ], "title": "ItAssetsAssetIdArchivePostResponsesContentApplicationJsonSchemaDataActionsTransferRentalDetailsTransferCostTokenUsageAddon", "type": "object" }, "ItAssetsAssetIdArchivePostResponsesContentApplicationJsonSchemaDataActionsTransferRentalDisabledReasonsItems": { "enum": [ "ARCHIVED", "AT_DEEL_WAREHOUSE", "BEING_REPAIRED", "CONSUMABLE", "CONTROLLED_BY_DEEL", "COUNTRY_NOT_SUPPORTED_FOR_HUB", "COUNTRY_NOT_SUPPORTED_FOR_LOCAL", "DEEL_OWNED_ITEM_WITHOUT_RENTAL_CONTRACT", "DESKTOP_STORAGE", "ENDING_CONTRACT", "HUB_IN_SAME_REGION_AS_LOCAL", "INACTIVE", "INVALID_ITEM_LOCATION", "INVALID_ORGANIZATION_STATUS", "INVALID_STATE", "ITEM_CONDITIONS_TO_UNARCHIVE_NOT_MET", "ITEM_NOT_VISIBLE_FOR_ORGANIZATION", "NON_DEVICE", "NOT_AT_WAREHOUSE", "NOT_AVAILABLE_FOR_REUSE", "NOT_A_RENTAL", "NOT_MANAGEABLE_BY_ORGANIZATION", "NOT_WITH_ASSIGNMENT", "NOT_WITH_USER", "NO_ACTIVE_ADDONS", "NO_ACTIVE_STORAGE_CONTRACT", "NO_LOCATION_FOR_STORAGE", "NO_LOGISTICS_FOR_STORAGE", "NO_VALID_ADDONS", "ONGOING_SERVICE", "OWNED_BY_DEEL", "OWNED_BY_ORGANIZATION", "OWNED_BY_PARTNER_ORGANIZATION", "PARTNER_CHILD_CONTRACT", "PENDING_DEVICE_REFRESH", "RENTAL_CONTRACT_AND_USER_REGION_DO_NOT_MATCH", "TEMPORARILY_UNAVAILABLE", "UNKNOWN", "USER_HAS_NO_COUNTRY", "USER_HAS_NO_SEAT", "WAITING_FOR_CLEARANCE", "WITH_LOANER_ASSIGNMENT", "WITH_NON_COLLECTED_ASSIGNMENT", "WITH_NON_DELIVERED_ASSIGNMENT", "WITH_PENDING_ASSIGNMENT", "WRONG_ASSIGNMENT_STATUS", "WRONG_CONTRACT_STATUS", "WRONG_TERMS_AND_CONDITIONS" ], "title": "ItAssetsAssetIdArchivePostResponsesContentApplicationJsonSchemaDataActionsTransferRentalDisabledReasonsItems", "type": "string" }, "ItAssetsAssetIdArchivePostResponsesContentApplicationJsonSchemaDataActionsTransferRentalStatus": { "description": "Whether the action is currently available for this asset", "enum": [ "DISABLED", "ENABLED", "NOT_APPLICABLE" ], "title": "ItAssetsAssetIdArchivePostResponsesContentApplicationJsonSchemaDataActionsTransferRentalStatus", "type": "string" }, "ItAssetsAssetIdArchivePostResponsesContentApplicationJsonSchemaDataActionsUnarchiveOwnAsset": { "description": "Unarchive a previously archived organization-owned asset", "properties": { "disabled_reasons": { "description": "Reasons why the action is disabled. Empty when the action is enabled or not applicable", "items": { "$ref": "#/components/schemas/ItAssetsAssetIdArchivePostResponsesContentApplicationJsonSchemaDataActionsUnarchiveOwnAssetDisabledReasonsItems" }, "type": "array" }, "status": { "$ref": "#/components/schemas/ItAssetsAssetIdArchivePostResponsesContentApplicationJsonSchemaDataActionsUnarchiveOwnAssetStatus", "description": "Whether the action is currently available for this asset" } }, "required": [ "status", "disabled_reasons" ], "title": "ItAssetsAssetIdArchivePostResponsesContentApplicationJsonSchemaDataActionsUnarchiveOwnAsset", "type": "object" }, "ItAssetsAssetIdArchivePostResponsesContentApplicationJsonSchemaDataActionsUnarchiveOwnAssetDisabledReasonsItems": { "enum": [ "ARCHIVED", "AT_DEEL_WAREHOUSE", "BEING_REPAIRED", "CONSUMABLE", "CONTROLLED_BY_DEEL", "COUNTRY_NOT_SUPPORTED_FOR_HUB", "COUNTRY_NOT_SUPPORTED_FOR_LOCAL", "DEEL_OWNED_ITEM_WITHOUT_RENTAL_CONTRACT", "DESKTOP_STORAGE", "ENDING_CONTRACT", "HUB_IN_SAME_REGION_AS_LOCAL", "INACTIVE", "INVALID_ITEM_LOCATION", "INVALID_ORGANIZATION_STATUS", "INVALID_STATE", "ITEM_CONDITIONS_TO_UNARCHIVE_NOT_MET", "ITEM_NOT_VISIBLE_FOR_ORGANIZATION", "NON_DEVICE", "NOT_AT_WAREHOUSE", "NOT_AVAILABLE_FOR_REUSE", "NOT_A_RENTAL", "NOT_MANAGEABLE_BY_ORGANIZATION", "NOT_WITH_ASSIGNMENT", "NOT_WITH_USER", "NO_ACTIVE_ADDONS", "NO_ACTIVE_STORAGE_CONTRACT", "NO_LOCATION_FOR_STORAGE", "NO_LOGISTICS_FOR_STORAGE", "NO_VALID_ADDONS", "ONGOING_SERVICE", "OWNED_BY_DEEL", "OWNED_BY_ORGANIZATION", "OWNED_BY_PARTNER_ORGANIZATION", "PARTNER_CHILD_CONTRACT", "PENDING_DEVICE_REFRESH", "RENTAL_CONTRACT_AND_USER_REGION_DO_NOT_MATCH", "TEMPORARILY_UNAVAILABLE", "UNKNOWN", "USER_HAS_NO_COUNTRY", "USER_HAS_NO_SEAT", "WAITING_FOR_CLEARANCE", "WITH_LOANER_ASSIGNMENT", "WITH_NON_COLLECTED_ASSIGNMENT", "WITH_NON_DELIVERED_ASSIGNMENT", "WITH_PENDING_ASSIGNMENT", "WRONG_ASSIGNMENT_STATUS", "WRONG_CONTRACT_STATUS", "WRONG_TERMS_AND_CONDITIONS" ], "title": "ItAssetsAssetIdArchivePostResponsesContentApplicationJsonSchemaDataActionsUnarchiveOwnAssetDisabledReasonsItems", "type": "string" }, "ItAssetsAssetIdArchivePostResponsesContentApplicationJsonSchemaDataActionsUnarchiveOwnAssetStatus": { "description": "Whether the action is currently available for this asset", "enum": [ "DISABLED", "ENABLED", "NOT_APPLICABLE" ], "title": "ItAssetsAssetIdArchivePostResponsesContentApplicationJsonSchemaDataActionsUnarchiveOwnAssetStatus", "type": "string" }, "ItAssetsAssetIdArchivePostResponsesContentApplicationJsonSchemaDataActionsUpdateLocationLocationToUser": { "description": "Update the location of an asset from a warehouse to a user", "properties": { "disabled_reasons": { "description": "Reasons why the action is disabled. Empty when the action is enabled or not applicable", "items": { "$ref": "#/components/schemas/ItAssetsAssetIdArchivePostResponsesContentApplicationJsonSchemaDataActionsUpdateLocationLocationToUserDisabledReasonsItems" }, "type": "array" }, "status": { "$ref": "#/components/schemas/ItAssetsAssetIdArchivePostResponsesContentApplicationJsonSchemaDataActionsUpdateLocationLocationToUserStatus", "description": "Whether the action is currently available for this asset" } }, "required": [ "status", "disabled_reasons" ], "title": "ItAssetsAssetIdArchivePostResponsesContentApplicationJsonSchemaDataActionsUpdateLocationLocationToUser", "type": "object" }, "ItAssetsAssetIdArchivePostResponsesContentApplicationJsonSchemaDataActionsUpdateLocationLocationToUserDisabledReasonsItems": { "enum": [ "ARCHIVED", "AT_DEEL_WAREHOUSE", "BEING_REPAIRED", "CONSUMABLE", "CONTROLLED_BY_DEEL", "COUNTRY_NOT_SUPPORTED_FOR_HUB", "COUNTRY_NOT_SUPPORTED_FOR_LOCAL", "DEEL_OWNED_ITEM_WITHOUT_RENTAL_CONTRACT", "DESKTOP_STORAGE", "ENDING_CONTRACT", "HUB_IN_SAME_REGION_AS_LOCAL", "INACTIVE", "INVALID_ITEM_LOCATION", "INVALID_ORGANIZATION_STATUS", "INVALID_STATE", "ITEM_CONDITIONS_TO_UNARCHIVE_NOT_MET", "ITEM_NOT_VISIBLE_FOR_ORGANIZATION", "NON_DEVICE", "NOT_AT_WAREHOUSE", "NOT_AVAILABLE_FOR_REUSE", "NOT_A_RENTAL", "NOT_MANAGEABLE_BY_ORGANIZATION", "NOT_WITH_ASSIGNMENT", "NOT_WITH_USER", "NO_ACTIVE_ADDONS", "NO_ACTIVE_STORAGE_CONTRACT", "NO_LOCATION_FOR_STORAGE", "NO_LOGISTICS_FOR_STORAGE", "NO_VALID_ADDONS", "ONGOING_SERVICE", "OWNED_BY_DEEL", "OWNED_BY_ORGANIZATION", "OWNED_BY_PARTNER_ORGANIZATION", "PARTNER_CHILD_CONTRACT", "PENDING_DEVICE_REFRESH", "RENTAL_CONTRACT_AND_USER_REGION_DO_NOT_MATCH", "TEMPORARILY_UNAVAILABLE", "UNKNOWN", "USER_HAS_NO_COUNTRY", "USER_HAS_NO_SEAT", "WAITING_FOR_CLEARANCE", "WITH_LOANER_ASSIGNMENT", "WITH_NON_COLLECTED_ASSIGNMENT", "WITH_NON_DELIVERED_ASSIGNMENT", "WITH_PENDING_ASSIGNMENT", "WRONG_ASSIGNMENT_STATUS", "WRONG_CONTRACT_STATUS", "WRONG_TERMS_AND_CONDITIONS" ], "title": "ItAssetsAssetIdArchivePostResponsesContentApplicationJsonSchemaDataActionsUpdateLocationLocationToUserDisabledReasonsItems", "type": "string" }, "ItAssetsAssetIdArchivePostResponsesContentApplicationJsonSchemaDataActionsUpdateLocationLocationToUserStatus": { "description": "Whether the action is currently available for this asset", "enum": [ "DISABLED", "ENABLED", "NOT_APPLICABLE" ], "title": "ItAssetsAssetIdArchivePostResponsesContentApplicationJsonSchemaDataActionsUpdateLocationLocationToUserStatus", "type": "string" }, "ItAssetsAssetIdArchivePostResponsesContentApplicationJsonSchemaDataActionsUpdateLocationUserToLocation": { "description": "Update the location of an asset from a user to a warehouse", "properties": { "disabled_reasons": { "description": "Reasons why the action is disabled. Empty when the action is enabled or not applicable", "items": { "$ref": "#/components/schemas/ItAssetsAssetIdArchivePostResponsesContentApplicationJsonSchemaDataActionsUpdateLocationUserToLocationDisabledReasonsItems" }, "type": "array" }, "status": { "$ref": "#/components/schemas/ItAssetsAssetIdArchivePostResponsesContentApplicationJsonSchemaDataActionsUpdateLocationUserToLocationStatus", "description": "Whether the action is currently available for this asset" } }, "required": [ "status", "disabled_reasons" ], "title": "ItAssetsAssetIdArchivePostResponsesContentApplicationJsonSchemaDataActionsUpdateLocationUserToLocation", "type": "object" }, "ItAssetsAssetIdArchivePostResponsesContentApplicationJsonSchemaDataActionsUpdateLocationUserToLocationDisabledReasonsItems": { "enum": [ "ARCHIVED", "AT_DEEL_WAREHOUSE", "BEING_REPAIRED", "CONSUMABLE", "CONTROLLED_BY_DEEL", "COUNTRY_NOT_SUPPORTED_FOR_HUB", "COUNTRY_NOT_SUPPORTED_FOR_LOCAL", "DEEL_OWNED_ITEM_WITHOUT_RENTAL_CONTRACT", "DESKTOP_STORAGE", "ENDING_CONTRACT", "HUB_IN_SAME_REGION_AS_LOCAL", "INACTIVE", "INVALID_ITEM_LOCATION", "INVALID_ORGANIZATION_STATUS", "INVALID_STATE", "ITEM_CONDITIONS_TO_UNARCHIVE_NOT_MET", "ITEM_NOT_VISIBLE_FOR_ORGANIZATION", "NON_DEVICE", "NOT_AT_WAREHOUSE", "NOT_AVAILABLE_FOR_REUSE", "NOT_A_RENTAL", "NOT_MANAGEABLE_BY_ORGANIZATION", "NOT_WITH_ASSIGNMENT", "NOT_WITH_USER", "NO_ACTIVE_ADDONS", "NO_ACTIVE_STORAGE_CONTRACT", "NO_LOCATION_FOR_STORAGE", "NO_LOGISTICS_FOR_STORAGE", "NO_VALID_ADDONS", "ONGOING_SERVICE", "OWNED_BY_DEEL", "OWNED_BY_ORGANIZATION", "OWNED_BY_PARTNER_ORGANIZATION", "PARTNER_CHILD_CONTRACT", "PENDING_DEVICE_REFRESH", "RENTAL_CONTRACT_AND_USER_REGION_DO_NOT_MATCH", "TEMPORARILY_UNAVAILABLE", "UNKNOWN", "USER_HAS_NO_COUNTRY", "USER_HAS_NO_SEAT", "WAITING_FOR_CLEARANCE", "WITH_LOANER_ASSIGNMENT", "WITH_NON_COLLECTED_ASSIGNMENT", "WITH_NON_DELIVERED_ASSIGNMENT", "WITH_PENDING_ASSIGNMENT", "WRONG_ASSIGNMENT_STATUS", "WRONG_CONTRACT_STATUS", "WRONG_TERMS_AND_CONDITIONS" ], "title": "ItAssetsAssetIdArchivePostResponsesContentApplicationJsonSchemaDataActionsUpdateLocationUserToLocationDisabledReasonsItems", "type": "string" }, "ItAssetsAssetIdArchivePostResponsesContentApplicationJsonSchemaDataActionsUpdateLocationUserToLocationStatus": { "description": "Whether the action is currently available for this asset", "enum": [ "DISABLED", "ENABLED", "NOT_APPLICABLE" ], "title": "ItAssetsAssetIdArchivePostResponsesContentApplicationJsonSchemaDataActionsUpdateLocationUserToLocationStatus", "type": "string" }, "ItAssetsAssetIdArchivePostResponsesContentApplicationJsonSchemaDataActionsUpdateLocationUserToUser": { "description": "Update the assigned user of an asset that is currently with a user", "properties": { "disabled_reasons": { "description": "Reasons why the action is disabled. Empty when the action is enabled or not applicable", "items": { "$ref": "#/components/schemas/ItAssetsAssetIdArchivePostResponsesContentApplicationJsonSchemaDataActionsUpdateLocationUserToUserDisabledReasonsItems" }, "type": "array" }, "status": { "$ref": "#/components/schemas/ItAssetsAssetIdArchivePostResponsesContentApplicationJsonSchemaDataActionsUpdateLocationUserToUserStatus", "description": "Whether the action is currently available for this asset" } }, "required": [ "status", "disabled_reasons" ], "title": "ItAssetsAssetIdArchivePostResponsesContentApplicationJsonSchemaDataActionsUpdateLocationUserToUser", "type": "object" }, "ItAssetsAssetIdArchivePostResponsesContentApplicationJsonSchemaDataActionsUpdateLocationUserToUserDisabledReasonsItems": { "enum": [ "ARCHIVED", "AT_DEEL_WAREHOUSE", "BEING_REPAIRED", "CONSUMABLE", "CONTROLLED_BY_DEEL", "COUNTRY_NOT_SUPPORTED_FOR_HUB", "COUNTRY_NOT_SUPPORTED_FOR_LOCAL", "DEEL_OWNED_ITEM_WITHOUT_RENTAL_CONTRACT", "DESKTOP_STORAGE", "ENDING_CONTRACT", "HUB_IN_SAME_REGION_AS_LOCAL", "INACTIVE", "INVALID_ITEM_LOCATION", "INVALID_ORGANIZATION_STATUS", "INVALID_STATE", "ITEM_CONDITIONS_TO_UNARCHIVE_NOT_MET", "ITEM_NOT_VISIBLE_FOR_ORGANIZATION", "NON_DEVICE", "NOT_AT_WAREHOUSE", "NOT_AVAILABLE_FOR_REUSE", "NOT_A_RENTAL", "NOT_MANAGEABLE_BY_ORGANIZATION", "NOT_WITH_ASSIGNMENT", "NOT_WITH_USER", "NO_ACTIVE_ADDONS", "NO_ACTIVE_STORAGE_CONTRACT", "NO_LOCATION_FOR_STORAGE", "NO_LOGISTICS_FOR_STORAGE", "NO_VALID_ADDONS", "ONGOING_SERVICE", "OWNED_BY_DEEL", "OWNED_BY_ORGANIZATION", "OWNED_BY_PARTNER_ORGANIZATION", "PARTNER_CHILD_CONTRACT", "PENDING_DEVICE_REFRESH", "RENTAL_CONTRACT_AND_USER_REGION_DO_NOT_MATCH", "TEMPORARILY_UNAVAILABLE", "UNKNOWN", "USER_HAS_NO_COUNTRY", "USER_HAS_NO_SEAT", "WAITING_FOR_CLEARANCE", "WITH_LOANER_ASSIGNMENT", "WITH_NON_COLLECTED_ASSIGNMENT", "WITH_NON_DELIVERED_ASSIGNMENT", "WITH_PENDING_ASSIGNMENT", "WRONG_ASSIGNMENT_STATUS", "WRONG_CONTRACT_STATUS", "WRONG_TERMS_AND_CONDITIONS" ], "title": "ItAssetsAssetIdArchivePostResponsesContentApplicationJsonSchemaDataActionsUpdateLocationUserToUserDisabledReasonsItems", "type": "string" }, "ItAssetsAssetIdArchivePostResponsesContentApplicationJsonSchemaDataActionsUpdateLocationUserToUserStatus": { "description": "Whether the action is currently available for this asset", "enum": [ "DISABLED", "ENABLED", "NOT_APPLICABLE" ], "title": "ItAssetsAssetIdArchivePostResponsesContentApplicationJsonSchemaDataActionsUpdateLocationUserToUserStatus", "type": "string" }, "ItAssetsAssetIdArchivePostResponsesContentApplicationJsonSchemaDataActionsUpdateOwnAssetDetails": { "description": "Update editable details of an organization-owned asset", "properties": { "disabled_reasons": { "description": "Reasons why the action is disabled. Empty when the action is enabled or not applicable", "items": { "$ref": "#/components/schemas/ItAssetsAssetIdArchivePostResponsesContentApplicationJsonSchemaDataActionsUpdateOwnAssetDetailsDisabledReasonsItems" }, "type": "array" }, "status": { "$ref": "#/components/schemas/ItAssetsAssetIdArchivePostResponsesContentApplicationJsonSchemaDataActionsUpdateOwnAssetDetailsStatus", "description": "Whether the action is currently available for this asset" } }, "required": [ "status", "disabled_reasons" ], "title": "ItAssetsAssetIdArchivePostResponsesContentApplicationJsonSchemaDataActionsUpdateOwnAssetDetails", "type": "object" }, "ItAssetsAssetIdArchivePostResponsesContentApplicationJsonSchemaDataActionsUpdateOwnAssetDetailsDisabledReasonsItems": { "enum": [ "ARCHIVED", "AT_DEEL_WAREHOUSE", "BEING_REPAIRED", "CONSUMABLE", "CONTROLLED_BY_DEEL", "COUNTRY_NOT_SUPPORTED_FOR_HUB", "COUNTRY_NOT_SUPPORTED_FOR_LOCAL", "DEEL_OWNED_ITEM_WITHOUT_RENTAL_CONTRACT", "DESKTOP_STORAGE", "ENDING_CONTRACT", "HUB_IN_SAME_REGION_AS_LOCAL", "INACTIVE", "INVALID_ITEM_LOCATION", "INVALID_ORGANIZATION_STATUS", "INVALID_STATE", "ITEM_CONDITIONS_TO_UNARCHIVE_NOT_MET", "ITEM_NOT_VISIBLE_FOR_ORGANIZATION", "NON_DEVICE", "NOT_AT_WAREHOUSE", "NOT_AVAILABLE_FOR_REUSE", "NOT_A_RENTAL", "NOT_MANAGEABLE_BY_ORGANIZATION", "NOT_WITH_ASSIGNMENT", "NOT_WITH_USER", "NO_ACTIVE_ADDONS", "NO_ACTIVE_STORAGE_CONTRACT", "NO_LOCATION_FOR_STORAGE", "NO_LOGISTICS_FOR_STORAGE", "NO_VALID_ADDONS", "ONGOING_SERVICE", "OWNED_BY_DEEL", "OWNED_BY_ORGANIZATION", "OWNED_BY_PARTNER_ORGANIZATION", "PARTNER_CHILD_CONTRACT", "PENDING_DEVICE_REFRESH", "RENTAL_CONTRACT_AND_USER_REGION_DO_NOT_MATCH", "TEMPORARILY_UNAVAILABLE", "UNKNOWN", "USER_HAS_NO_COUNTRY", "USER_HAS_NO_SEAT", "WAITING_FOR_CLEARANCE", "WITH_LOANER_ASSIGNMENT", "WITH_NON_COLLECTED_ASSIGNMENT", "WITH_NON_DELIVERED_ASSIGNMENT", "WITH_PENDING_ASSIGNMENT", "WRONG_ASSIGNMENT_STATUS", "WRONG_CONTRACT_STATUS", "WRONG_TERMS_AND_CONDITIONS" ], "title": "ItAssetsAssetIdArchivePostResponsesContentApplicationJsonSchemaDataActionsUpdateOwnAssetDetailsDisabledReasonsItems", "type": "string" }, "ItAssetsAssetIdArchivePostResponsesContentApplicationJsonSchemaDataActionsUpdateOwnAssetDetailsStatus": { "description": "Whether the action is currently available for this asset", "enum": [ "DISABLED", "ENABLED", "NOT_APPLICABLE" ], "title": "ItAssetsAssetIdArchivePostResponsesContentApplicationJsonSchemaDataActionsUpdateOwnAssetDetailsStatus", "type": "string" }, "ItAssetsAssetIdArchivePostResponsesContentApplicationJsonSchemaDataAssignedUser": { "description": "Details of the user with asset possession", "properties": { "emails": { "description": "Array of user email addresses", "items": { "format": "email", "type": "string" }, "type": "array" }, "first_name": { "description": "First name of the user", "type": "string" }, "hris_profile_id": { "description": "The unique identifier of the HRIS profile of the assigned user", "format": "uuid", "type": "string" }, "last_name": { "description": "Last name of the user", "type": "string" } }, "required": [ "emails", "last_name", "first_name", "hris_profile_id" ], "title": "ItAssetsAssetIdArchivePostResponsesContentApplicationJsonSchemaDataAssignedUser", "type": "object" }, "ItAssetsAssetIdArchivePostResponsesContentApplicationJsonSchemaDataAssignedWarehouse": { "description": "Details of the warehouse with asset possession", "properties": { "address": { "$ref": "#/components/schemas/ItAssetsAssetIdArchivePostResponsesContentApplicationJsonSchemaDataAssignedWarehouseAddress", "description": "Warehouse address details" }, "id": { "description": "Unique identifier of the warehouse", "format": "uuid", "type": "string" }, "name": { "description": "Warehouse or storage location name", "type": "string" }, "ownership": { "$ref": "#/components/schemas/ItAssetsAssetIdArchivePostResponsesContentApplicationJsonSchemaDataAssignedWarehouseOwnership", "description": "Warehouse ownership type" }, "public_id": { "description": "Public identifier of the warehouse", "type": "string" }, "warehouse_type": { "$ref": "#/components/schemas/ItAssetsAssetIdArchivePostResponsesContentApplicationJsonSchemaDataAssignedWarehouseWarehouseType", "description": "Warehouse type" } }, "required": [ "id", "name", "address", "ownership", "public_id", "warehouse_type" ], "title": "ItAssetsAssetIdArchivePostResponsesContentApplicationJsonSchemaDataAssignedWarehouse", "type": "object" }, "ItAssetsAssetIdArchivePostResponsesContentApplicationJsonSchemaDataAssignedWarehouseAddress": { "description": "Warehouse address details", "properties": { "city": { "description": "City name", "type": [ "string", "null" ] }, "country": { "$ref": "#/components/schemas/ItAssetsAssetIdArchivePostResponsesContentApplicationJsonSchemaDataAssignedWarehouseAddressCountry", "description": "Country code" }, "date_of_birth": { "description": "Date of birth (applicable for some address types)", "format": "date", "type": [ "string", "null" ] }, "delivery_instructions": { "description": "Special instructions for deliveries", "type": [ "string", "null" ] }, "id": { "description": "Unique identifier of the address", "format": "uuid", "type": "string" }, "is_valid": { "description": "Whether the address passes validation", "type": "boolean" }, "line1": { "description": "Address line 1", "type": [ "string", "null" ] }, "line2": { "description": "Address line 2", "type": [ "string", "null" ] }, "passport_number": { "description": "Passport number (applicable for some address types)", "type": [ "string", "null" ] }, "phone_number": { "description": "Phone number", "type": [ "string", "null" ] }, "post_code": { "description": "Post code", "type": [ "string", "null" ] }, "state": { "description": "State code or name", "type": [ "string", "null" ] }, "tax_id_number": { "description": "Tax ID number (applicable for some address types)", "type": [ "string", "null" ] }, "type": { "$ref": "#/components/schemas/ItAssetsAssetIdArchivePostResponsesContentApplicationJsonSchemaDataAssignedWarehouseAddressType", "description": "Type of the address" } }, "required": [ "id", "city", "type", "line1", "line2", "state", "country", "is_valid", "post_code", "phone_number", "date_of_birth", "tax_id_number", "passport_number", "delivery_instructions" ], "title": "ItAssetsAssetIdArchivePostResponsesContentApplicationJsonSchemaDataAssignedWarehouseAddress", "type": "object" }, "ItAssetsAssetIdArchivePostResponsesContentApplicationJsonSchemaDataAssignedWarehouseAddressCountry": { "description": "Country code", "enum": [ "AD", "AE", "AF", "AG", "AI", "AL", "AM", "AN", "AO", "AQ", "AR", "AS", "AT", "AU", "AW", "AX", "AZ", "BA", "BB", "BD", "BE", "BF", "BG", "BH", "BI", "BJ", "BL", "BM", "BN", "BO", "BQ", "BR", "BS", "BT", "BV", "BW", "BY", "BZ", "CA", "CC", "CD", "CF", "CG", "CH", "CI", "CK", "CL", "CM", "CN", "CO", "CR", "CU", "CV", "CW", "CX", "CY", "CZ", "DE", "DJ", "DK", "DM", "DO", "DZ", "EC", "EE", "EG", "EH", "ER", "ES", "ET", "FI", "FJ", "FK", "FM", "FO", "FR", "GA", "GB", "GD", "GE", "GF", "GG", "GH", "GI", "GL", "GM", "GN", "GP", "GQ", "GR", "GS", "GT", "GU", "GW", "GY", "HK", "HM", "HN", "HR", "HT", "HU", "IC", "ID", "IE", "IL", "IM", "IN", "IO", "IQ", "IR", "IS", "IT", "JE", "JM", "JO", "JP", "KE", "KG", "KH", "KI", "KM", "KN", "KP", "KR", "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", "XK", "YE", "YT", "ZA", "ZM", "ZW" ], "title": "ItAssetsAssetIdArchivePostResponsesContentApplicationJsonSchemaDataAssignedWarehouseAddressCountry", "type": "string" }, "ItAssetsAssetIdArchivePostResponsesContentApplicationJsonSchemaDataAssignedWarehouseAddressType": { "description": "Type of the address", "enum": [ "BILLING", "COLLECTION", "DELIVERY", "ENTITY", "PARTIAL", "PII", "SUPPLIER" ], "title": "ItAssetsAssetIdArchivePostResponsesContentApplicationJsonSchemaDataAssignedWarehouseAddressType", "type": "string" }, "ItAssetsAssetIdArchivePostResponsesContentApplicationJsonSchemaDataAssignedWarehouseOwnership": { "description": "Warehouse ownership type", "enum": [ "DEEL", "ORGANIZATION" ], "title": "ItAssetsAssetIdArchivePostResponsesContentApplicationJsonSchemaDataAssignedWarehouseOwnership", "type": "string" }, "ItAssetsAssetIdArchivePostResponsesContentApplicationJsonSchemaDataAssignedWarehouseWarehouseType": { "description": "Warehouse type", "enum": [ "CLEARANCE", "DEEL", "ORGANIZATION" ], "title": "ItAssetsAssetIdArchivePostResponsesContentApplicationJsonSchemaDataAssignedWarehouseWarehouseType", "type": "string" }, "ItAssetsAssetIdArchivePostResponsesContentApplicationJsonSchemaDataGrade": { "description": "The condition grade of the asset", "enum": [ "A", "B", "C", "D", "F", "NEW" ], "title": "ItAssetsAssetIdArchivePostResponsesContentApplicationJsonSchemaDataGrade", "type": "string" }, "ItAssetsAssetIdArchivePostResponsesContentApplicationJsonSchemaDataLocation": { "description": "Current location type of the asset", "enum": [ "AT_WAREHOUSE", "CLEARANCE_WAREHOUSE", "DEEL_WAREHOUSE", "ORGANIZATION_WAREHOUSE", "SUPPLIER", "WITH_COURIER", "WITH_USER", "WRITE_OFF" ], "title": "ItAssetsAssetIdArchivePostResponsesContentApplicationJsonSchemaDataLocation", "type": "string" }, "ItAssetsAssetIdArchivePostResponsesContentApplicationJsonSchemaDataOwnership": { "description": "Asset owner", "properties": { "name": { "description": "Asset owner name", "type": "string" }, "type": { "$ref": "#/components/schemas/ItAssetsAssetIdArchivePostResponsesContentApplicationJsonSchemaDataOwnershipType", "description": "Asset owner type" } }, "required": [ "name", "type" ], "title": "ItAssetsAssetIdArchivePostResponsesContentApplicationJsonSchemaDataOwnership", "type": "object" }, "ItAssetsAssetIdArchivePostResponsesContentApplicationJsonSchemaDataOwnershipType": { "description": "Asset owner type", "enum": [ "DEEL", "ORGANIZATION" ], "title": "ItAssetsAssetIdArchivePostResponsesContentApplicationJsonSchemaDataOwnershipType", "type": "string" }, "ItAssetsAssetIdArchivePostResponsesContentApplicationJsonSchemaDataProduct": { "description": "Product details", "properties": { "brand": { "description": "Product brand", "type": "string" }, "category": { "$ref": "#/components/schemas/ItAssetsAssetIdArchivePostResponsesContentApplicationJsonSchemaDataProductCategory", "description": "Product category" }, "id": { "description": "Unique identifier of the product", "format": "uuid", "type": "string" }, "name": { "description": "Product name", "type": "string" }, "specifications": { "description": "Specifications of the product", "items": { "$ref": "#/components/schemas/ItAssetsAssetIdArchivePostResponsesContentApplicationJsonSchemaDataProductSpecificationsItems" }, "type": "array" } }, "required": [ "id", "name", "brand", "category", "specifications" ], "title": "ItAssetsAssetIdArchivePostResponsesContentApplicationJsonSchemaDataProduct", "type": "object" }, "ItAssetsAssetIdArchivePostResponsesContentApplicationJsonSchemaDataProductCategory": { "description": "Product category", "enum": [ "ADAPTER", "CABLE", "CHAIR", "CHARGER", "COMPACT_DESKTOP", "DESK", "DESKTOP", "DESK_RISER", "DESK_TIDY", "DOCKING_STATION", "DONGLE", "FOOTREST", "HEADSET", "KEYBOARD", "LAPTOP", "LAPTOP_STAND", "MICE_TRACKPAD", "MOBILE_DEVICE", "MONITOR", "MONITOR_ARM", "OTHER", "PRINTER", "SHREDDER", "STANDING_MAT", "TABLET", "TASK_LIGHT", "WEBCAM", "WELCOME_PACK", "WIFI_RANGE_EXTENDER" ], "title": "ItAssetsAssetIdArchivePostResponsesContentApplicationJsonSchemaDataProductCategory", "type": "string" }, "ItAssetsAssetIdArchivePostResponsesContentApplicationJsonSchemaDataProductSpecificationsItems": { "properties": { "name": { "description": "Specification name", "type": "string" }, "value": { "description": "Specification value", "type": "string" } }, "required": [ "name", "value" ], "title": "ItAssetsAssetIdArchivePostResponsesContentApplicationJsonSchemaDataProductSpecificationsItems", "type": "object" }, "ItAssetsAssetIdArchivePostResponsesContentApplicationJsonSchemaDataPurchaseValue": { "description": "Purchase value of the asset", "properties": { "amount": { "description": "Amount", "format": "decimal", "type": "string" }, "currency": { "$ref": "#/components/schemas/ItAssetsAssetIdArchivePostResponsesContentApplicationJsonSchemaDataPurchaseValueCurrency", "description": "Three-letter currency code for the price" } }, "required": [ "amount", "currency" ], "title": "ItAssetsAssetIdArchivePostResponsesContentApplicationJsonSchemaDataPurchaseValue", "type": "object" }, "ItAssetsAssetIdArchivePostResponsesContentApplicationJsonSchemaDataPurchaseValueCurrency": { "description": "Three-letter currency code for the price", "enum": [ "AED", "AFN", "ALL", "AMD", "ANG", "AOA", "ARS", "AUD", "AWG", "AZN", "BAM", "BDT", "BGN", "BHD", "BIF", "BMD", "BOB", "BRL", "BSD", "BTN", "BWP", "BYN", "BZD", "CAD", "CDF", "CHF", "CLP", "CNY", "COP", "CRC", "CUC", "CVE", "CZK", "DJF", "DKK", "DOP", "DZD", "EGP", "ERN", "ETB", "EUR", "FJD", "FKP", "GBP", "GEL", "GHS", "GIP", "GMD", "GNF", "GTQ", "GYD", "HKD", "HNL", "HRK", "HTG", "HUF", "IDR", "ILS", "INR", "IQD", "IRR", "ISK", "JMD", "JOD", "JPY", "KES", "KGS", "KHR", "KMF", "KPW", "KRW", "KWD", "KYD", "KZT", "LAK", "LBP", "LKR", "LRD", "LSL", "LTL", "LYD", "MAD", "MDL", "MGA", "MKD", "MMK", "MNT", "MRU", "MUR", "MVR", "MWK", "MXN", "MYR", "MZN", "NAD", "NGN", "NIO", "NOK", "NPR", "NZD", "OMR", "PAB", "PEN", "PGK", "PHP", "PKR", "PLN", "PYG", "QAR", "RON", "RSD", "RUB", "RWF", "SAR", "SBD", "SCR", "SDG", "SEK", "SGD", "SHP", "SLL", "SOS", "SRD", "SSP", "STD", "SYP", "SZL", "THB", "TJS", "TMT", "TND", "TOP", "TRY", "TTD", "TWD", "TZS", "UAH", "UGX", "USD", "UYU", "UZS", "VEF", "VND", "VUV", "WST", "XAF", "XCD", "XOF", "XPF", "YER", "ZAR", "ZMW", "ZWD" ], "title": "ItAssetsAssetIdArchivePostResponsesContentApplicationJsonSchemaDataPurchaseValueCurrency", "type": "string" }, "ItAssetsAssetIdArchivePostResponsesContentApplicationJsonSchemaDataStatus": { "description": "Current state of the asset", "enum": [ "ACTIVE", "ADDED_BY_MISTAKE", "BEING_REPAIRED", "BINNED", "BROKEN_AT_WAREHOUSE", "BROKEN_BY_USER", "BROKEN_IN_TRANSIT", "CLEARED", "DAMAGED_AT_WAREHOUSE", "DAMAGED_BY_USER", "DAMAGED_IN_TRANSIT", "LEFT_WITH_USER", "LOST_IN_TRANSIT", "RETURNED_TO_DEEL", "SHRINKAGE", "STOLEN", "SUPPLIER_RETURN", "WAITING_FOR_CLEARANCE" ], "title": "ItAssetsAssetIdArchivePostResponsesContentApplicationJsonSchemaDataStatus", "type": "string" }, "ItAssetsAssetIdArchivePostResponsesContentApplicationJsonSchemaErrorsItems": { "properties": { "code": { "description": "Error code of the handler which produced the returned error", "type": "string" }, "field": { "description": "The field name where input validation failed", "type": [ "string", "null" ] }, "message": { "description": "Description of the returned error", "type": "string" } }, "required": [ "code", "field", "message" ], "title": "ItAssetsAssetIdArchivePostResponsesContentApplicationJsonSchemaErrorsItems", "type": "object" }, "ItAssetsAssetIdClearPostParametersXBeta": { "default": "true", "enum": [ "true" ], "title": "ItAssetsAssetIdClearPostParametersXBeta", "type": "string" }, "ItAssetsAssetIdClearPostRequestBodyContentApplicationJsonSchemaData": { "properties": { "manager_hris_profile_id": { "description": "HRIS profile identifier of the manager attributed as the requester of the clearance. Must be a manager in the same organization.", "format": "uuid", "type": "string" } }, "required": [ "manager_hris_profile_id" ], "title": "ItAssetsAssetIdClearPostRequestBodyContentApplicationJsonSchemaData", "type": "object" }, "ItAssetsAssetIdClearPostResponsesContentApplicationJsonSchemaData": { "properties": { "cancelled_reason": { "description": "Reason the clearance request was cancelled, absent unless the status is CANCELLED", "oneOf": [ { "$ref": "#/components/schemas/ItAssetsAssetIdClearPostResponsesContentApplicationJsonSchemaDataCancelledReason" }, { "type": "null" } ] }, "created_at": { "description": "Creation timestamp of the clearance request", "format": "date-time", "type": "string" }, "expires_at": { "description": "Timestamp indicating when the request expires and the manager can no longer take action, absent when no deadline applies", "format": "date-time", "type": [ "string", "null" ] }, "id": { "description": "Unique identifier of the clearance request", "format": "uuid", "type": "string" }, "public_id": { "description": "Public identifier of the clearance request", "type": "string" }, "request_items": { "description": "Items included in this clearance request, one per asset being cleared", "items": { "$ref": "#/components/schemas/ItAssetsAssetIdClearPostResponsesContentApplicationJsonSchemaDataRequestItemsItems" }, "type": "array" }, "status": { "$ref": "#/components/schemas/ItAssetsAssetIdClearPostResponsesContentApplicationJsonSchemaDataStatus", "description": "Current state of the clearance request" } }, "required": [ "id", "status", "public_id", "created_at", "expires_at", "request_items", "cancelled_reason" ], "title": "ItAssetsAssetIdClearPostResponsesContentApplicationJsonSchemaData", "type": "object" }, "ItAssetsAssetIdClearPostResponsesContentApplicationJsonSchemaDataCancelledReason": { "description": "Reason the clearance request was cancelled, absent unless the status is CANCELLED", "enum": [ "DEADLINE_EXCEEDED", "REQUESTED_BY_CUSTOMER" ], "title": "ItAssetsAssetIdClearPostResponsesContentApplicationJsonSchemaDataCancelledReason", "type": "string" }, "ItAssetsAssetIdClearPostResponsesContentApplicationJsonSchemaDataRequestItemsItems": { "properties": { "asset": { "$ref": "#/components/schemas/ItAssetsAssetIdClearPostResponsesContentApplicationJsonSchemaDataRequestItemsItemsAsset", "description": "Asset being cleared as part of this clearance request item" }, "id": { "description": "Unique identifier of the clearance request item", "format": "uuid", "type": "string" }, "quote_price": { "description": "Quote price offered by the clearance partner for the asset, absent until a quote is received", "oneOf": [ { "$ref": "#/components/schemas/ItAssetsAssetIdClearPostResponsesContentApplicationJsonSchemaDataRequestItemsItemsQuotePrice" }, { "type": "null" } ] }, "status": { "$ref": "#/components/schemas/ItAssetsAssetIdClearPostResponsesContentApplicationJsonSchemaDataRequestItemsItemsStatus", "description": "Current state of the item within the clearance request lifecycle" } }, "required": [ "id", "asset", "status", "quote_price" ], "title": "ItAssetsAssetIdClearPostResponsesContentApplicationJsonSchemaDataRequestItemsItems", "type": "object" }, "ItAssetsAssetIdClearPostResponsesContentApplicationJsonSchemaDataRequestItemsItemsAsset": { "description": "Asset being cleared as part of this clearance request item", "properties": { "id": { "description": "Unique identifier of the asset", "format": "uuid", "type": "string" }, "product": { "$ref": "#/components/schemas/ItAssetsAssetIdClearPostResponsesContentApplicationJsonSchemaDataRequestItemsItemsAssetProduct", "description": "Product details of the asset" }, "public_id": { "description": "Public identifier of the asset", "type": "string" }, "serial_number": { "description": "Asset serial number, absent when the manufacturer did not assign one", "type": [ "string", "null" ] } }, "required": [ "id", "product", "public_id", "serial_number" ], "title": "ItAssetsAssetIdClearPostResponsesContentApplicationJsonSchemaDataRequestItemsItemsAsset", "type": "object" }, "ItAssetsAssetIdClearPostResponsesContentApplicationJsonSchemaDataRequestItemsItemsAssetProduct": { "description": "Product details of the asset", "properties": { "brand": { "description": "Product brand", "type": "string" }, "category": { "$ref": "#/components/schemas/ItAssetsAssetIdClearPostResponsesContentApplicationJsonSchemaDataRequestItemsItemsAssetProductCategory", "description": "Product category" }, "id": { "description": "Unique identifier of the product", "format": "uuid", "type": "string" }, "name": { "description": "Product name", "type": "string" } }, "required": [ "id", "name", "brand", "category" ], "title": "ItAssetsAssetIdClearPostResponsesContentApplicationJsonSchemaDataRequestItemsItemsAssetProduct", "type": "object" }, "ItAssetsAssetIdClearPostResponsesContentApplicationJsonSchemaDataRequestItemsItemsAssetProductCategory": { "description": "Product category", "enum": [ "ADAPTER", "CABLE", "CHAIR", "CHARGER", "COMPACT_DESKTOP", "DESK", "DESKTOP", "DESK_RISER", "DESK_TIDY", "DOCKING_STATION", "DONGLE", "FOOTREST", "HEADSET", "KEYBOARD", "LAPTOP", "LAPTOP_STAND", "MICE_TRACKPAD", "MOBILE_DEVICE", "MONITOR", "MONITOR_ARM", "OTHER", "PRINTER", "SHREDDER", "STANDING_MAT", "TABLET", "TASK_LIGHT", "WEBCAM", "WELCOME_PACK", "WIFI_RANGE_EXTENDER" ], "title": "ItAssetsAssetIdClearPostResponsesContentApplicationJsonSchemaDataRequestItemsItemsAssetProductCategory", "type": "string" }, "ItAssetsAssetIdClearPostResponsesContentApplicationJsonSchemaDataRequestItemsItemsQuotePrice": { "description": "Quote price offered by the clearance partner for the asset, absent until a quote is received", "properties": { "amount": { "description": "Amount", "format": "decimal", "type": "string" }, "currency": { "$ref": "#/components/schemas/ItAssetsAssetIdClearPostResponsesContentApplicationJsonSchemaDataRequestItemsItemsQuotePriceCurrency", "description": "Three-letter currency code for the price" } }, "required": [ "amount", "currency" ], "title": "ItAssetsAssetIdClearPostResponsesContentApplicationJsonSchemaDataRequestItemsItemsQuotePrice", "type": "object" }, "ItAssetsAssetIdClearPostResponsesContentApplicationJsonSchemaDataRequestItemsItemsQuotePriceCurrency": { "description": "Three-letter currency code for the price", "enum": [ "AED", "AFN", "ALL", "AMD", "ANG", "AOA", "ARS", "AUD", "AWG", "AZN", "BAM", "BDT", "BGN", "BHD", "BIF", "BMD", "BOB", "BRL", "BSD", "BTN", "BWP", "BYN", "BZD", "CAD", "CDF", "CHF", "CLP", "CNY", "COP", "CRC", "CUC", "CVE", "CZK", "DJF", "DKK", "DOP", "DZD", "EGP", "ERN", "ETB", "EUR", "FJD", "FKP", "GBP", "GEL", "GHS", "GIP", "GMD", "GNF", "GTQ", "GYD", "HKD", "HNL", "HRK", "HTG", "HUF", "IDR", "ILS", "INR", "IQD", "IRR", "ISK", "JMD", "JOD", "JPY", "KES", "KGS", "KHR", "KMF", "KPW", "KRW", "KWD", "KYD", "KZT", "LAK", "LBP", "LKR", "LRD", "LSL", "LTL", "LYD", "MAD", "MDL", "MGA", "MKD", "MMK", "MNT", "MRU", "MUR", "MVR", "MWK", "MXN", "MYR", "MZN", "NAD", "NGN", "NIO", "NOK", "NPR", "NZD", "OMR", "PAB", "PEN", "PGK", "PHP", "PKR", "PLN", "PYG", "QAR", "RON", "RSD", "RUB", "RWF", "SAR", "SBD", "SCR", "SDG", "SEK", "SGD", "SHP", "SLL", "SOS", "SRD", "SSP", "STD", "SYP", "SZL", "THB", "TJS", "TMT", "TND", "TOP", "TRY", "TTD", "TWD", "TZS", "UAH", "UGX", "USD", "UYU", "UZS", "VEF", "VND", "VUV", "WST", "XAF", "XCD", "XOF", "XPF", "YER", "ZAR", "ZMW", "ZWD" ], "title": "ItAssetsAssetIdClearPostResponsesContentApplicationJsonSchemaDataRequestItemsItemsQuotePriceCurrency", "type": "string" }, "ItAssetsAssetIdClearPostResponsesContentApplicationJsonSchemaDataRequestItemsItemsStatus": { "description": "Current state of the item within the clearance request lifecycle", "enum": [ "CANCELLED", "CUSTOMER_ACCEPTED_QUOTE", "CUSTOMER_REJECTED_QUOTE", "PENDING_CUSTOMER_DECISION", "PENDING_QUOTE", "SKIPPED_QUOTE" ], "title": "ItAssetsAssetIdClearPostResponsesContentApplicationJsonSchemaDataRequestItemsItemsStatus", "type": "string" }, "ItAssetsAssetIdClearPostResponsesContentApplicationJsonSchemaDataStatus": { "description": "Current state of the clearance request", "enum": [ "CANCELLED", "COMPLETED", "DECIDED", "PENDING_DECISION", "PENDING_QUOTE", "PENDING_RETURN" ], "title": "ItAssetsAssetIdClearPostResponsesContentApplicationJsonSchemaDataStatus", "type": "string" }, "ItAssetsAssetIdClearPostResponsesContentApplicationJsonSchemaErrorsItems": { "properties": { "code": { "description": "Error code of the handler which produced the returned error", "type": "string" }, "field": { "description": "The field name where input validation failed", "type": [ "string", "null" ] }, "message": { "description": "Description of the returned error", "type": "string" } }, "required": [ "code", "field", "message" ], "title": "ItAssetsAssetIdClearPostResponsesContentApplicationJsonSchemaErrorsItems", "type": "object" }, "ItAssetsAssetIdCollectPostParametersXBeta": { "default": "true", "enum": [ "true" ], "title": "ItAssetsAssetIdCollectPostParametersXBeta", "type": "string" }, "ItAssetsAssetIdCollectPostRequestBodyContentApplicationJsonSchemaData": { "properties": { "collection_address": { "$ref": "#/components/schemas/ItAssetsAssetIdCollectPostRequestBodyContentApplicationJsonSchemaDataCollectionAddress", "description": "Location the asset is being collected from." }, "not_before": { "description": "Earliest date Deel logistics may execute the pickup.", "format": "date", "type": "string" }, "shipment_insurance": { "$ref": "#/components/schemas/ItAssetsAssetIdCollectPostRequestBodyContentApplicationJsonSchemaDataShipmentInsurance", "description": "Insurance-consent flag and optional purchase details Deel records against the asset. May be omitted (or sent with `is_waived: false` and no `purchase_details`) if the asset already has a purchase price and date on record." }, "store_and_reuse_location": { "$ref": "#/components/schemas/ItAssetsAssetIdCollectPostRequestBodyContentApplicationJsonSchemaDataStoreAndReuseLocation", "description": "Deel-managed reuse destination for the collection. Mutually exclusive with `warehouse_id`." }, "warehouse_id": { "description": "Destination warehouse identifier for the collection. Mutually exclusive with `store_and_reuse_location`.", "format": "uuid", "type": "string" } }, "required": [ "collection_address" ], "title": "ItAssetsAssetIdCollectPostRequestBodyContentApplicationJsonSchemaData", "type": "object" }, "ItAssetsAssetIdCollectPostRequestBodyContentApplicationJsonSchemaDataCollectionAddress": { "description": "Location the asset is being collected from.", "properties": { "country": { "$ref": "#/components/schemas/ItAssetsAssetIdCollectPostRequestBodyContentApplicationJsonSchemaDataCollectionAddressCountry", "description": "Country the asset is being picked up from. Overrides the country the asset-action validator derives from asset state." } }, "title": "ItAssetsAssetIdCollectPostRequestBodyContentApplicationJsonSchemaDataCollectionAddress", "type": "object" }, "ItAssetsAssetIdCollectPostRequestBodyContentApplicationJsonSchemaDataCollectionAddressCountry": { "description": "Country the asset is being picked up from. Overrides the country the asset-action validator derives from asset state.", "enum": [ "AD", "AE", "AF", "AG", "AI", "AL", "AM", "AN", "AO", "AQ", "AR", "AS", "AT", "AU", "AW", "AX", "AZ", "BA", "BB", "BD", "BE", "BF", "BG", "BH", "BI", "BJ", "BL", "BM", "BN", "BO", "BQ", "BR", "BS", "BT", "BV", "BW", "BY", "BZ", "CA", "CC", "CD", "CF", "CG", "CH", "CI", "CK", "CL", "CM", "CN", "CO", "CR", "CU", "CV", "CW", "CX", "CY", "CZ", "DE", "DJ", "DK", "DM", "DO", "DZ", "EC", "EE", "EG", "EH", "ER", "ES", "ET", "FI", "FJ", "FK", "FM", "FO", "FR", "GA", "GB", "GD", "GE", "GF", "GG", "GH", "GI", "GL", "GM", "GN", "GP", "GQ", "GR", "GS", "GT", "GU", "GW", "GY", "HK", "HM", "HN", "HR", "HT", "HU", "IC", "ID", "IE", "IL", "IM", "IN", "IO", "IQ", "IR", "IS", "IT", "JE", "JM", "JO", "JP", "KE", "KG", "KH", "KI", "KM", "KN", "KP", "KR", "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", "XK", "YE", "YT", "ZA", "ZM", "ZW" ], "title": "ItAssetsAssetIdCollectPostRequestBodyContentApplicationJsonSchemaDataCollectionAddressCountry", "type": "string" }, "ItAssetsAssetIdCollectPostRequestBodyContentApplicationJsonSchemaDataShipmentInsurance": { "description": "Insurance-consent flag and optional purchase details Deel records against the asset. May be omitted (or sent with `is_waived: false` and no `purchase_details`) if the asset already has a purchase price and date on record.", "properties": { "is_waived": { "description": "Consent to ship without insurance. When true, `purchase_details` must be omitted and Deel will not record a purchase price against the asset.", "type": "boolean" }, "purchase_details": { "$ref": "#/components/schemas/ItAssetsAssetIdCollectPostRequestBodyContentApplicationJsonSchemaDataShipmentInsurancePurchaseDetails", "description": "Purchase details Deel records against the asset. Omit to fall back to purchase details already stored on the asset, if any. Must be omitted when `is_waived` is true." } }, "required": [ "is_waived" ], "title": "ItAssetsAssetIdCollectPostRequestBodyContentApplicationJsonSchemaDataShipmentInsurance", "type": "object" }, "ItAssetsAssetIdCollectPostRequestBodyContentApplicationJsonSchemaDataShipmentInsurancePurchaseDetails": { "description": "Purchase details Deel records against the asset. Omit to fall back to purchase details already stored on the asset, if any. Must be omitted when `is_waived` is true.", "properties": { "date": { "description": "Date the asset was purchased.", "format": "date", "type": "string" }, "price": { "$ref": "#/components/schemas/ItAssetsAssetIdCollectPostRequestBodyContentApplicationJsonSchemaDataShipmentInsurancePurchaseDetailsPrice", "description": "Purchase price paid for the asset." } }, "required": [ "date", "price" ], "title": "ItAssetsAssetIdCollectPostRequestBodyContentApplicationJsonSchemaDataShipmentInsurancePurchaseDetails", "type": "object" }, "ItAssetsAssetIdCollectPostRequestBodyContentApplicationJsonSchemaDataShipmentInsurancePurchaseDetailsPrice": { "description": "Purchase price paid for the asset.", "properties": { "amount": { "description": "Amount", "format": "decimal", "type": "string" }, "currency": { "$ref": "#/components/schemas/ItAssetsAssetIdCollectPostRequestBodyContentApplicationJsonSchemaDataShipmentInsurancePurchaseDetailsPriceCurrency", "description": "Three-letter currency code for the price" } }, "required": [ "amount", "currency" ], "title": "ItAssetsAssetIdCollectPostRequestBodyContentApplicationJsonSchemaDataShipmentInsurancePurchaseDetailsPrice", "type": "object" }, "ItAssetsAssetIdCollectPostRequestBodyContentApplicationJsonSchemaDataShipmentInsurancePurchaseDetailsPriceCurrency": { "description": "Three-letter currency code for the price", "enum": [ "AED", "AFN", "ALL", "AMD", "ANG", "AOA", "ARS", "AUD", "AWG", "AZN", "BAM", "BDT", "BGN", "BHD", "BIF", "BMD", "BOB", "BRL", "BSD", "BTN", "BWP", "BYN", "BZD", "CAD", "CDF", "CHF", "CLP", "CNY", "COP", "CRC", "CUC", "CVE", "CZK", "DJF", "DKK", "DOP", "DZD", "EGP", "ERN", "ETB", "EUR", "FJD", "FKP", "GBP", "GEL", "GHS", "GIP", "GMD", "GNF", "GTQ", "GYD", "HKD", "HNL", "HRK", "HTG", "HUF", "IDR", "ILS", "INR", "IQD", "IRR", "ISK", "JMD", "JOD", "JPY", "KES", "KGS", "KHR", "KMF", "KPW", "KRW", "KWD", "KYD", "KZT", "LAK", "LBP", "LKR", "LRD", "LSL", "LTL", "LYD", "MAD", "MDL", "MGA", "MKD", "MMK", "MNT", "MRU", "MUR", "MVR", "MWK", "MXN", "MYR", "MZN", "NAD", "NGN", "NIO", "NOK", "NPR", "NZD", "OMR", "PAB", "PEN", "PGK", "PHP", "PKR", "PLN", "PYG", "QAR", "RON", "RSD", "RUB", "RWF", "SAR", "SBD", "SCR", "SDG", "SEK", "SGD", "SHP", "SLL", "SOS", "SRD", "SSP", "STD", "SYP", "SZL", "THB", "TJS", "TMT", "TND", "TOP", "TRY", "TTD", "TWD", "TZS", "UAH", "UGX", "USD", "UYU", "UZS", "VEF", "VND", "VUV", "WST", "XAF", "XCD", "XOF", "XPF", "YER", "ZAR", "ZMW", "ZWD" ], "title": "ItAssetsAssetIdCollectPostRequestBodyContentApplicationJsonSchemaDataShipmentInsurancePurchaseDetailsPriceCurrency", "type": "string" }, "ItAssetsAssetIdCollectPostRequestBodyContentApplicationJsonSchemaDataStoreAndReuseLocation": { "description": "Deel-managed reuse destination for the collection. Mutually exclusive with `warehouse_id`.", "enum": [ "DEEL_HUB", "LOCAL_HUB" ], "title": "ItAssetsAssetIdCollectPostRequestBodyContentApplicationJsonSchemaDataStoreAndReuseLocation", "type": "string" }, "ItAssetsAssetIdCollectPostResponsesContentApplicationJsonSchemaData": { "properties": { "actions": { "$ref": "#/components/schemas/ItAssetsAssetIdCollectPostResponsesContentApplicationJsonSchemaDataActions", "description": "Actions the caller can execute on this asset, with availability status per action" }, "assigned_user": { "description": "Details of the user with asset possession", "oneOf": [ { "$ref": "#/components/schemas/ItAssetsAssetIdCollectPostResponsesContentApplicationJsonSchemaDataAssignedUser" }, { "type": "null" } ] }, "assigned_warehouse": { "description": "Details of the warehouse with asset possession", "oneOf": [ { "$ref": "#/components/schemas/ItAssetsAssetIdCollectPostResponsesContentApplicationJsonSchemaDataAssignedWarehouse" }, { "type": "null" } ] }, "created_at": { "description": "Creation timestamp of the asset", "format": "date-time", "type": "string" }, "grade": { "$ref": "#/components/schemas/ItAssetsAssetIdCollectPostResponsesContentApplicationJsonSchemaDataGrade", "description": "The condition grade of the asset" }, "id": { "description": "Unique identifier of the item", "format": "uuid", "type": "string" }, "location": { "$ref": "#/components/schemas/ItAssetsAssetIdCollectPostResponsesContentApplicationJsonSchemaDataLocation", "description": "Current location type of the asset" }, "ownership": { "$ref": "#/components/schemas/ItAssetsAssetIdCollectPostResponsesContentApplicationJsonSchemaDataOwnership", "description": "Asset owner" }, "product": { "$ref": "#/components/schemas/ItAssetsAssetIdCollectPostResponsesContentApplicationJsonSchemaDataProduct", "description": "Product details" }, "public_id": { "description": "Public identifier of the item", "type": "string" }, "purchase_date": { "description": "Purchase date of the asset", "format": "date", "type": [ "string", "null" ] }, "purchase_value": { "description": "Purchase value of the asset", "oneOf": [ { "$ref": "#/components/schemas/ItAssetsAssetIdCollectPostResponsesContentApplicationJsonSchemaDataPurchaseValue" }, { "type": "null" } ] }, "serial_number": { "description": "Asset serial number", "type": [ "string", "null" ] }, "status": { "$ref": "#/components/schemas/ItAssetsAssetIdCollectPostResponsesContentApplicationJsonSchemaDataStatus", "description": "Current state of the asset" }, "updated_at": { "description": "Last update timestamp of the asset", "format": "date-time", "type": "string" } }, "required": [ "id", "grade", "status", "actions", "product", "location", "ownership", "public_id", "created_at", "updated_at", "assigned_user", "purchase_date", "serial_number", "purchase_value", "assigned_warehouse" ], "title": "ItAssetsAssetIdCollectPostResponsesContentApplicationJsonSchemaData", "type": "object" }, "ItAssetsAssetIdCollectPostResponsesContentApplicationJsonSchemaDataActions": { "description": "Actions the caller can execute on this asset, with availability status per action", "properties": { "archive_own_asset": { "$ref": "#/components/schemas/ItAssetsAssetIdCollectPostResponsesContentApplicationJsonSchemaDataActionsArchiveOwnAsset", "description": "Archive an organization-owned asset" }, "asset_country": { "description": "Resolved country used for asset actions. Derived from the asset's country,\nits assigned rental contract billing entity country, or the last active\nassignment delivery country. Null when the country cannot be determined\n(e.g. asset was returned to Deel)", "oneOf": [ { "$ref": "#/components/schemas/ItAssetsAssetIdCollectPostResponsesContentApplicationJsonSchemaDataActionsAssetCountry" }, { "type": "null" } ] }, "assign_addon_to_own_asset": { "$ref": "#/components/schemas/ItAssetsAssetIdCollectPostResponsesContentApplicationJsonSchemaDataActionsAssignAddonToOwnAsset", "description": "Assign an add-on to an organization-owned asset" }, "clear_own_asset": { "$ref": "#/components/schemas/ItAssetsAssetIdCollectPostResponsesContentApplicationJsonSchemaDataActionsClearOwnAsset", "description": "Clear an organization-owned asset from the fleet" }, "manage_end_of_rental_contract_actions": { "$ref": "#/components/schemas/ItAssetsAssetIdCollectPostResponsesContentApplicationJsonSchemaDataActionsManageEndOfRentalContractActions", "description": "Manage end-of-rental options for a Deel-owned rental asset" }, "purchase_rental": { "$ref": "#/components/schemas/ItAssetsAssetIdCollectPostResponsesContentApplicationJsonSchemaDataActionsPurchaseRental", "description": "Purchase a Deel-owned rental asset at end of contract" }, "return_rental_to_deel": { "$ref": "#/components/schemas/ItAssetsAssetIdCollectPostResponsesContentApplicationJsonSchemaDataActionsReturnRentalToDeel", "description": "Return a Deel-owned rental asset back to Deel" }, "reuse_own_asset_from_deel": { "$ref": "#/components/schemas/ItAssetsAssetIdCollectPostResponsesContentApplicationJsonSchemaDataActionsReuseOwnAssetFromDeel", "description": "Redeploy an organization-owned asset stored at a Deel warehouse" }, "reuse_own_asset_from_own_location": { "$ref": "#/components/schemas/ItAssetsAssetIdCollectPostResponsesContentApplicationJsonSchemaDataActionsReuseOwnAssetFromOwnLocation", "description": "Redeploy an organization-owned asset from an organization-owned location" }, "store_own_asset_at_deel_for_hub": { "$ref": "#/components/schemas/ItAssetsAssetIdCollectPostResponsesContentApplicationJsonSchemaDataActionsStoreOwnAssetAtDeelForHub", "description": "Store an organization-owned asset at a Deel hub warehouse" }, "store_own_asset_at_deel_for_local": { "$ref": "#/components/schemas/ItAssetsAssetIdCollectPostResponsesContentApplicationJsonSchemaDataActionsStoreOwnAssetAtDeelForLocal", "description": "Store an organization-owned asset at a Deel local warehouse" }, "store_own_asset_at_own_location": { "$ref": "#/components/schemas/ItAssetsAssetIdCollectPostResponsesContentApplicationJsonSchemaDataActionsStoreOwnAssetAtOwnLocation", "description": "Store an organization-owned asset at an organization-owned location" }, "store_rental_at_deel_for_local": { "$ref": "#/components/schemas/ItAssetsAssetIdCollectPostResponsesContentApplicationJsonSchemaDataActionsStoreRentalAtDeelForLocal", "description": "Store a Deel-owned rental asset at a Deel local warehouse" }, "store_rental_at_deel_for_zone1": { "$ref": "#/components/schemas/ItAssetsAssetIdCollectPostResponsesContentApplicationJsonSchemaDataActionsStoreRentalAtDeelForZone1", "description": "Store a Deel-owned rental asset at a Deel zone-1 warehouse" }, "transfer_own_asset": { "$ref": "#/components/schemas/ItAssetsAssetIdCollectPostResponsesContentApplicationJsonSchemaDataActionsTransferOwnAsset", "description": "Transfer an organization-owned asset to another user" }, "transfer_rental": { "$ref": "#/components/schemas/ItAssetsAssetIdCollectPostResponsesContentApplicationJsonSchemaDataActionsTransferRental", "description": "Transfer a Deel-owned rental asset to another user" }, "unarchive_own_asset": { "$ref": "#/components/schemas/ItAssetsAssetIdCollectPostResponsesContentApplicationJsonSchemaDataActionsUnarchiveOwnAsset", "description": "Unarchive a previously archived organization-owned asset" }, "update_location_location_to_user": { "$ref": "#/components/schemas/ItAssetsAssetIdCollectPostResponsesContentApplicationJsonSchemaDataActionsUpdateLocationLocationToUser", "description": "Update the location of an asset from a warehouse to a user" }, "update_location_user_to_location": { "$ref": "#/components/schemas/ItAssetsAssetIdCollectPostResponsesContentApplicationJsonSchemaDataActionsUpdateLocationUserToLocation", "description": "Update the location of an asset from a user to a warehouse" }, "update_location_user_to_user": { "$ref": "#/components/schemas/ItAssetsAssetIdCollectPostResponsesContentApplicationJsonSchemaDataActionsUpdateLocationUserToUser", "description": "Update the assigned user of an asset that is currently with a user" }, "update_own_asset_details": { "$ref": "#/components/schemas/ItAssetsAssetIdCollectPostResponsesContentApplicationJsonSchemaDataActionsUpdateOwnAssetDetails", "description": "Update editable details of an organization-owned asset" } }, "required": [ "asset_country", "clear_own_asset", "purchase_rental", "transfer_rental", "archive_own_asset", "transfer_own_asset", "unarchive_own_asset", "return_rental_to_deel", "update_own_asset_details", "assign_addon_to_own_asset", "reuse_own_asset_from_deel", "update_location_user_to_user", "store_rental_at_deel_for_local", "store_rental_at_deel_for_zone1", "store_own_asset_at_deel_for_hub", "store_own_asset_at_own_location", "update_location_location_to_user", "update_location_user_to_location", "reuse_own_asset_from_own_location", "store_own_asset_at_deel_for_local", "manage_end_of_rental_contract_actions" ], "title": "ItAssetsAssetIdCollectPostResponsesContentApplicationJsonSchemaDataActions", "type": "object" }, "ItAssetsAssetIdCollectPostResponsesContentApplicationJsonSchemaDataActionsArchiveOwnAsset": { "description": "Archive an organization-owned asset", "properties": { "details": { "description": "Action-specific context needed to perform the action. Populated for enabled and\ndisabled actions (so callers can see what a successful attempt would look like);\nnull when the action is not applicable to this asset.", "oneOf": [ { "$ref": "#/components/schemas/ItAssetsAssetIdCollectPostResponsesContentApplicationJsonSchemaDataActionsArchiveOwnAssetDetails" }, { "type": "null" } ] }, "disabled_reasons": { "description": "Reasons why the action is disabled. Empty when the action is enabled or not applicable", "items": { "$ref": "#/components/schemas/ItAssetsAssetIdCollectPostResponsesContentApplicationJsonSchemaDataActionsArchiveOwnAssetDisabledReasonsItems" }, "type": "array" }, "status": { "$ref": "#/components/schemas/ItAssetsAssetIdCollectPostResponsesContentApplicationJsonSchemaDataActionsArchiveOwnAssetStatus", "description": "Whether the action is currently available for this asset" } }, "required": [ "status", "details", "disabled_reasons" ], "title": "ItAssetsAssetIdCollectPostResponsesContentApplicationJsonSchemaDataActionsArchiveOwnAsset", "type": "object" }, "ItAssetsAssetIdCollectPostResponsesContentApplicationJsonSchemaDataActionsArchiveOwnAssetDetails": { "description": "Action-specific context needed to perform the action. Populated for enabled and\ndisabled actions (so callers can see what a successful attempt would look like);\nnull when the action is not applicable to this asset.", "properties": { "allowed_statuses": { "description": "Statuses that can be passed as the archive reason when archiving the asset", "items": { "$ref": "#/components/schemas/ItAssetsAssetIdCollectPostResponsesContentApplicationJsonSchemaDataActionsArchiveOwnAssetDetailsAllowedStatusesItems" }, "type": "array" } }, "required": [ "allowed_statuses" ], "title": "ItAssetsAssetIdCollectPostResponsesContentApplicationJsonSchemaDataActionsArchiveOwnAssetDetails", "type": "object" }, "ItAssetsAssetIdCollectPostResponsesContentApplicationJsonSchemaDataActionsArchiveOwnAssetDetailsAllowedStatusesItems": { "enum": [ "ADDED_BY_MISTAKE", "BINNED", "BROKEN_AT_WAREHOUSE", "BROKEN_BY_USER", "BROKEN_IN_TRANSIT", "DAMAGED_AT_WAREHOUSE", "DAMAGED_BY_USER", "DAMAGED_IN_TRANSIT", "LEFT_WITH_USER", "LOST_IN_TRANSIT", "RETURNED_TO_DEEL", "SHRINKAGE", "STOLEN", "SUPPLIER_RETURN" ], "title": "ItAssetsAssetIdCollectPostResponsesContentApplicationJsonSchemaDataActionsArchiveOwnAssetDetailsAllowedStatusesItems", "type": "string" }, "ItAssetsAssetIdCollectPostResponsesContentApplicationJsonSchemaDataActionsArchiveOwnAssetDisabledReasonsItems": { "enum": [ "ARCHIVED", "AT_DEEL_WAREHOUSE", "BEING_REPAIRED", "CONSUMABLE", "CONTROLLED_BY_DEEL", "COUNTRY_NOT_SUPPORTED_FOR_HUB", "COUNTRY_NOT_SUPPORTED_FOR_LOCAL", "DEEL_OWNED_ITEM_WITHOUT_RENTAL_CONTRACT", "DESKTOP_STORAGE", "ENDING_CONTRACT", "HUB_IN_SAME_REGION_AS_LOCAL", "INACTIVE", "INVALID_ITEM_LOCATION", "INVALID_ORGANIZATION_STATUS", "INVALID_STATE", "ITEM_CONDITIONS_TO_UNARCHIVE_NOT_MET", "ITEM_NOT_VISIBLE_FOR_ORGANIZATION", "NON_DEVICE", "NOT_AT_WAREHOUSE", "NOT_AVAILABLE_FOR_REUSE", "NOT_A_RENTAL", "NOT_MANAGEABLE_BY_ORGANIZATION", "NOT_WITH_ASSIGNMENT", "NOT_WITH_USER", "NO_ACTIVE_ADDONS", "NO_ACTIVE_STORAGE_CONTRACT", "NO_LOCATION_FOR_STORAGE", "NO_LOGISTICS_FOR_STORAGE", "NO_VALID_ADDONS", "ONGOING_SERVICE", "OWNED_BY_DEEL", "OWNED_BY_ORGANIZATION", "OWNED_BY_PARTNER_ORGANIZATION", "PARTNER_CHILD_CONTRACT", "PENDING_DEVICE_REFRESH", "RENTAL_CONTRACT_AND_USER_REGION_DO_NOT_MATCH", "TEMPORARILY_UNAVAILABLE", "UNKNOWN", "USER_HAS_NO_COUNTRY", "USER_HAS_NO_SEAT", "WAITING_FOR_CLEARANCE", "WITH_LOANER_ASSIGNMENT", "WITH_NON_COLLECTED_ASSIGNMENT", "WITH_NON_DELIVERED_ASSIGNMENT", "WITH_PENDING_ASSIGNMENT", "WRONG_ASSIGNMENT_STATUS", "WRONG_CONTRACT_STATUS", "WRONG_TERMS_AND_CONDITIONS" ], "title": "ItAssetsAssetIdCollectPostResponsesContentApplicationJsonSchemaDataActionsArchiveOwnAssetDisabledReasonsItems", "type": "string" }, "ItAssetsAssetIdCollectPostResponsesContentApplicationJsonSchemaDataActionsArchiveOwnAssetStatus": { "description": "Whether the action is currently available for this asset", "enum": [ "DISABLED", "ENABLED", "NOT_APPLICABLE" ], "title": "ItAssetsAssetIdCollectPostResponsesContentApplicationJsonSchemaDataActionsArchiveOwnAssetStatus", "type": "string" }, "ItAssetsAssetIdCollectPostResponsesContentApplicationJsonSchemaDataActionsAssetCountry": { "description": "Resolved country used for asset actions. Derived from the asset's country,\nits assigned rental contract billing entity country, or the last active\nassignment delivery country. Null when the country cannot be determined\n(e.g. asset was returned to Deel)", "enum": [ "AD", "AE", "AF", "AG", "AI", "AL", "AM", "AN", "AO", "AQ", "AR", "AS", "AT", "AU", "AW", "AX", "AZ", "BA", "BB", "BD", "BE", "BF", "BG", "BH", "BI", "BJ", "BL", "BM", "BN", "BO", "BQ", "BR", "BS", "BT", "BV", "BW", "BY", "BZ", "CA", "CC", "CD", "CF", "CG", "CH", "CI", "CK", "CL", "CM", "CN", "CO", "CR", "CU", "CV", "CW", "CX", "CY", "CZ", "DE", "DJ", "DK", "DM", "DO", "DZ", "EC", "EE", "EG", "EH", "ER", "ES", "ET", "FI", "FJ", "FK", "FM", "FO", "FR", "GA", "GB", "GD", "GE", "GF", "GG", "GH", "GI", "GL", "GM", "GN", "GP", "GQ", "GR", "GS", "GT", "GU", "GW", "GY", "HK", "HM", "HN", "HR", "HT", "HU", "IC", "ID", "IE", "IL", "IM", "IN", "IO", "IQ", "IR", "IS", "IT", "JE", "JM", "JO", "JP", "KE", "KG", "KH", "KI", "KM", "KN", "KP", "KR", "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", "XK", "YE", "YT", "ZA", "ZM", "ZW" ], "title": "ItAssetsAssetIdCollectPostResponsesContentApplicationJsonSchemaDataActionsAssetCountry", "type": "string" }, "ItAssetsAssetIdCollectPostResponsesContentApplicationJsonSchemaDataActionsAssignAddonToOwnAsset": { "description": "Assign an add-on to an organization-owned asset", "properties": { "details": { "description": "Action-specific context needed to perform the action. Populated for enabled and\ndisabled actions (so callers can see what a successful attempt would look like);\nnull when the action is not applicable to this asset.", "oneOf": [ { "$ref": "#/components/schemas/ItAssetsAssetIdCollectPostResponsesContentApplicationJsonSchemaDataActionsAssignAddonToOwnAssetDetails" }, { "type": "null" } ] }, "disabled_reasons": { "description": "Reasons why the action is disabled. Empty when the action is enabled or not applicable", "items": { "$ref": "#/components/schemas/ItAssetsAssetIdCollectPostResponsesContentApplicationJsonSchemaDataActionsAssignAddonToOwnAssetDisabledReasonsItems" }, "type": "array" }, "status": { "$ref": "#/components/schemas/ItAssetsAssetIdCollectPostResponsesContentApplicationJsonSchemaDataActionsAssignAddonToOwnAssetStatus", "description": "Whether the action is currently available for this asset" } }, "required": [ "status", "details", "disabled_reasons" ], "title": "ItAssetsAssetIdCollectPostResponsesContentApplicationJsonSchemaDataActionsAssignAddonToOwnAsset", "type": "object" }, "ItAssetsAssetIdCollectPostResponsesContentApplicationJsonSchemaDataActionsAssignAddonToOwnAssetDetails": { "description": "Action-specific context needed to perform the action. Populated for enabled and\ndisabled actions (so callers can see what a successful attempt would look like);\nnull when the action is not applicable to this asset.", "properties": { "addons": { "description": "Add-ons that can be assigned to the asset, with a fail reason for those that don't qualify", "items": { "$ref": "#/components/schemas/ItAssetsAssetIdCollectPostResponsesContentApplicationJsonSchemaDataActionsAssignAddonToOwnAssetDetailsAddonsItems" }, "type": "array" } }, "required": [ "addons" ], "title": "ItAssetsAssetIdCollectPostResponsesContentApplicationJsonSchemaDataActionsAssignAddonToOwnAssetDetails", "type": "object" }, "ItAssetsAssetIdCollectPostResponsesContentApplicationJsonSchemaDataActionsAssignAddonToOwnAssetDetailsAddonsItems": { "properties": { "addon": { "$ref": "#/components/schemas/ItAssetsAssetIdCollectPostResponsesContentApplicationJsonSchemaDataActionsAssignAddonToOwnAssetDetailsAddonsItemsAddon", "description": "Add-on that can be assigned to the asset" }, "fail_reason": { "description": "Reason the add-on cannot be assigned to the asset. Null when assignment is allowed", "oneOf": [ { "$ref": "#/components/schemas/ItAssetsAssetIdCollectPostResponsesContentApplicationJsonSchemaDataActionsAssignAddonToOwnAssetDetailsAddonsItemsFailReason" }, { "type": "null" } ] } }, "required": [ "addon", "fail_reason" ], "title": "ItAssetsAssetIdCollectPostResponsesContentApplicationJsonSchemaDataActionsAssignAddonToOwnAssetDetailsAddonsItems", "type": "object" }, "ItAssetsAssetIdCollectPostResponsesContentApplicationJsonSchemaDataActionsAssignAddonToOwnAssetDetailsAddonsItemsAddon": { "description": "Add-on that can be assigned to the asset", "properties": { "id": { "description": "ID of the add-on", "format": "uuid", "type": "string" }, "name": { "description": "Public display name of the add-on", "type": "string" } }, "required": [ "id", "name" ], "title": "ItAssetsAssetIdCollectPostResponsesContentApplicationJsonSchemaDataActionsAssignAddonToOwnAssetDetailsAddonsItemsAddon", "type": "object" }, "ItAssetsAssetIdCollectPostResponsesContentApplicationJsonSchemaDataActionsAssignAddonToOwnAssetDetailsAddonsItemsFailReason": { "description": "Reason the add-on cannot be assigned to the asset. Null when assignment is allowed", "enum": [ "ADDON_NOT_AVAILABLE_TO_ORGANIZATION", "ALREADY_ASSIGNED", "HAS_ACTIVE_SERVICE_ADDON", "INVALID_ASSET_AGE", "INVALID_CONTRACT_TYPE", "INVALID_DURATION", "INVALID_PAYMENT_SCHEMA", "INVALID_PLATFORM_TIER", "INVALID_PRODUCT_BRAND", "INVALID_PRODUCT_CATEGORY", "INVALID_PRODUCT_PARENT_CATEGORY", "INVALID_RENTAL_TERM", "NO_MATCHING_ORGANIZATION_CONTRACT", "OTHER" ], "title": "ItAssetsAssetIdCollectPostResponsesContentApplicationJsonSchemaDataActionsAssignAddonToOwnAssetDetailsAddonsItemsFailReason", "type": "string" }, "ItAssetsAssetIdCollectPostResponsesContentApplicationJsonSchemaDataActionsAssignAddonToOwnAssetDisabledReasonsItems": { "enum": [ "ARCHIVED", "AT_DEEL_WAREHOUSE", "BEING_REPAIRED", "CONSUMABLE", "CONTROLLED_BY_DEEL", "COUNTRY_NOT_SUPPORTED_FOR_HUB", "COUNTRY_NOT_SUPPORTED_FOR_LOCAL", "DEEL_OWNED_ITEM_WITHOUT_RENTAL_CONTRACT", "DESKTOP_STORAGE", "ENDING_CONTRACT", "HUB_IN_SAME_REGION_AS_LOCAL", "INACTIVE", "INVALID_ITEM_LOCATION", "INVALID_ORGANIZATION_STATUS", "INVALID_STATE", "ITEM_CONDITIONS_TO_UNARCHIVE_NOT_MET", "ITEM_NOT_VISIBLE_FOR_ORGANIZATION", "NON_DEVICE", "NOT_AT_WAREHOUSE", "NOT_AVAILABLE_FOR_REUSE", "NOT_A_RENTAL", "NOT_MANAGEABLE_BY_ORGANIZATION", "NOT_WITH_ASSIGNMENT", "NOT_WITH_USER", "NO_ACTIVE_ADDONS", "NO_ACTIVE_STORAGE_CONTRACT", "NO_LOCATION_FOR_STORAGE", "NO_LOGISTICS_FOR_STORAGE", "NO_VALID_ADDONS", "ONGOING_SERVICE", "OWNED_BY_DEEL", "OWNED_BY_ORGANIZATION", "OWNED_BY_PARTNER_ORGANIZATION", "PARTNER_CHILD_CONTRACT", "PENDING_DEVICE_REFRESH", "RENTAL_CONTRACT_AND_USER_REGION_DO_NOT_MATCH", "TEMPORARILY_UNAVAILABLE", "UNKNOWN", "USER_HAS_NO_COUNTRY", "USER_HAS_NO_SEAT", "WAITING_FOR_CLEARANCE", "WITH_LOANER_ASSIGNMENT", "WITH_NON_COLLECTED_ASSIGNMENT", "WITH_NON_DELIVERED_ASSIGNMENT", "WITH_PENDING_ASSIGNMENT", "WRONG_ASSIGNMENT_STATUS", "WRONG_CONTRACT_STATUS", "WRONG_TERMS_AND_CONDITIONS" ], "title": "ItAssetsAssetIdCollectPostResponsesContentApplicationJsonSchemaDataActionsAssignAddonToOwnAssetDisabledReasonsItems", "type": "string" }, "ItAssetsAssetIdCollectPostResponsesContentApplicationJsonSchemaDataActionsAssignAddonToOwnAssetStatus": { "description": "Whether the action is currently available for this asset", "enum": [ "DISABLED", "ENABLED", "NOT_APPLICABLE" ], "title": "ItAssetsAssetIdCollectPostResponsesContentApplicationJsonSchemaDataActionsAssignAddonToOwnAssetStatus", "type": "string" }, "ItAssetsAssetIdCollectPostResponsesContentApplicationJsonSchemaDataActionsClearOwnAsset": { "description": "Clear an organization-owned asset from the fleet", "properties": { "disabled_reasons": { "description": "Reasons why the action is disabled. Empty when the action is enabled or not applicable", "items": { "$ref": "#/components/schemas/ItAssetsAssetIdCollectPostResponsesContentApplicationJsonSchemaDataActionsClearOwnAssetDisabledReasonsItems" }, "type": "array" }, "status": { "$ref": "#/components/schemas/ItAssetsAssetIdCollectPostResponsesContentApplicationJsonSchemaDataActionsClearOwnAssetStatus", "description": "Whether the action is currently available for this asset" } }, "required": [ "status", "disabled_reasons" ], "title": "ItAssetsAssetIdCollectPostResponsesContentApplicationJsonSchemaDataActionsClearOwnAsset", "type": "object" }, "ItAssetsAssetIdCollectPostResponsesContentApplicationJsonSchemaDataActionsClearOwnAssetDisabledReasonsItems": { "enum": [ "ARCHIVED", "AT_DEEL_WAREHOUSE", "BEING_REPAIRED", "CONSUMABLE", "CONTROLLED_BY_DEEL", "COUNTRY_NOT_SUPPORTED_FOR_HUB", "COUNTRY_NOT_SUPPORTED_FOR_LOCAL", "DEEL_OWNED_ITEM_WITHOUT_RENTAL_CONTRACT", "DESKTOP_STORAGE", "ENDING_CONTRACT", "HUB_IN_SAME_REGION_AS_LOCAL", "INACTIVE", "INVALID_ITEM_LOCATION", "INVALID_ORGANIZATION_STATUS", "INVALID_STATE", "ITEM_CONDITIONS_TO_UNARCHIVE_NOT_MET", "ITEM_NOT_VISIBLE_FOR_ORGANIZATION", "NON_DEVICE", "NOT_AT_WAREHOUSE", "NOT_AVAILABLE_FOR_REUSE", "NOT_A_RENTAL", "NOT_MANAGEABLE_BY_ORGANIZATION", "NOT_WITH_ASSIGNMENT", "NOT_WITH_USER", "NO_ACTIVE_ADDONS", "NO_ACTIVE_STORAGE_CONTRACT", "NO_LOCATION_FOR_STORAGE", "NO_LOGISTICS_FOR_STORAGE", "NO_VALID_ADDONS", "ONGOING_SERVICE", "OWNED_BY_DEEL", "OWNED_BY_ORGANIZATION", "OWNED_BY_PARTNER_ORGANIZATION", "PARTNER_CHILD_CONTRACT", "PENDING_DEVICE_REFRESH", "RENTAL_CONTRACT_AND_USER_REGION_DO_NOT_MATCH", "TEMPORARILY_UNAVAILABLE", "UNKNOWN", "USER_HAS_NO_COUNTRY", "USER_HAS_NO_SEAT", "WAITING_FOR_CLEARANCE", "WITH_LOANER_ASSIGNMENT", "WITH_NON_COLLECTED_ASSIGNMENT", "WITH_NON_DELIVERED_ASSIGNMENT", "WITH_PENDING_ASSIGNMENT", "WRONG_ASSIGNMENT_STATUS", "WRONG_CONTRACT_STATUS", "WRONG_TERMS_AND_CONDITIONS" ], "title": "ItAssetsAssetIdCollectPostResponsesContentApplicationJsonSchemaDataActionsClearOwnAssetDisabledReasonsItems", "type": "string" }, "ItAssetsAssetIdCollectPostResponsesContentApplicationJsonSchemaDataActionsClearOwnAssetStatus": { "description": "Whether the action is currently available for this asset", "enum": [ "DISABLED", "ENABLED", "NOT_APPLICABLE" ], "title": "ItAssetsAssetIdCollectPostResponsesContentApplicationJsonSchemaDataActionsClearOwnAssetStatus", "type": "string" }, "ItAssetsAssetIdCollectPostResponsesContentApplicationJsonSchemaDataActionsManageEndOfRentalContractActions": { "description": "Manage end-of-rental options for a Deel-owned rental asset", "properties": { "disabled_reasons": { "description": "Reasons why the action is disabled. Empty when the action is enabled or not applicable", "items": { "$ref": "#/components/schemas/ItAssetsAssetIdCollectPostResponsesContentApplicationJsonSchemaDataActionsManageEndOfRentalContractActionsDisabledReasonsItems" }, "type": "array" }, "status": { "$ref": "#/components/schemas/ItAssetsAssetIdCollectPostResponsesContentApplicationJsonSchemaDataActionsManageEndOfRentalContractActionsStatus", "description": "Whether the action is currently available for this asset" } }, "required": [ "status", "disabled_reasons" ], "title": "ItAssetsAssetIdCollectPostResponsesContentApplicationJsonSchemaDataActionsManageEndOfRentalContractActions", "type": "object" }, "ItAssetsAssetIdCollectPostResponsesContentApplicationJsonSchemaDataActionsManageEndOfRentalContractActionsDisabledReasonsItems": { "enum": [ "ARCHIVED", "AT_DEEL_WAREHOUSE", "BEING_REPAIRED", "CONSUMABLE", "CONTROLLED_BY_DEEL", "COUNTRY_NOT_SUPPORTED_FOR_HUB", "COUNTRY_NOT_SUPPORTED_FOR_LOCAL", "DEEL_OWNED_ITEM_WITHOUT_RENTAL_CONTRACT", "DESKTOP_STORAGE", "ENDING_CONTRACT", "HUB_IN_SAME_REGION_AS_LOCAL", "INACTIVE", "INVALID_ITEM_LOCATION", "INVALID_ORGANIZATION_STATUS", "INVALID_STATE", "ITEM_CONDITIONS_TO_UNARCHIVE_NOT_MET", "ITEM_NOT_VISIBLE_FOR_ORGANIZATION", "NON_DEVICE", "NOT_AT_WAREHOUSE", "NOT_AVAILABLE_FOR_REUSE", "NOT_A_RENTAL", "NOT_MANAGEABLE_BY_ORGANIZATION", "NOT_WITH_ASSIGNMENT", "NOT_WITH_USER", "NO_ACTIVE_ADDONS", "NO_ACTIVE_STORAGE_CONTRACT", "NO_LOCATION_FOR_STORAGE", "NO_LOGISTICS_FOR_STORAGE", "NO_VALID_ADDONS", "ONGOING_SERVICE", "OWNED_BY_DEEL", "OWNED_BY_ORGANIZATION", "OWNED_BY_PARTNER_ORGANIZATION", "PARTNER_CHILD_CONTRACT", "PENDING_DEVICE_REFRESH", "RENTAL_CONTRACT_AND_USER_REGION_DO_NOT_MATCH", "TEMPORARILY_UNAVAILABLE", "UNKNOWN", "USER_HAS_NO_COUNTRY", "USER_HAS_NO_SEAT", "WAITING_FOR_CLEARANCE", "WITH_LOANER_ASSIGNMENT", "WITH_NON_COLLECTED_ASSIGNMENT", "WITH_NON_DELIVERED_ASSIGNMENT", "WITH_PENDING_ASSIGNMENT", "WRONG_ASSIGNMENT_STATUS", "WRONG_CONTRACT_STATUS", "WRONG_TERMS_AND_CONDITIONS" ], "title": "ItAssetsAssetIdCollectPostResponsesContentApplicationJsonSchemaDataActionsManageEndOfRentalContractActionsDisabledReasonsItems", "type": "string" }, "ItAssetsAssetIdCollectPostResponsesContentApplicationJsonSchemaDataActionsManageEndOfRentalContractActionsStatus": { "description": "Whether the action is currently available for this asset", "enum": [ "DISABLED", "ENABLED", "NOT_APPLICABLE" ], "title": "ItAssetsAssetIdCollectPostResponsesContentApplicationJsonSchemaDataActionsManageEndOfRentalContractActionsStatus", "type": "string" }, "ItAssetsAssetIdCollectPostResponsesContentApplicationJsonSchemaDataActionsPurchaseRental": { "description": "Purchase a Deel-owned rental asset at end of contract", "properties": { "details": { "description": "Action-specific context needed to perform the action. Populated for enabled and\ndisabled actions (so callers can see what a successful attempt would look like);\nnull when the action is not applicable to this asset.", "oneOf": [ { "$ref": "#/components/schemas/ItAssetsAssetIdCollectPostResponsesContentApplicationJsonSchemaDataActionsPurchaseRentalDetails" }, { "type": "null" } ] }, "disabled_reasons": { "description": "Reasons why the action is disabled. Empty when the action is enabled or not applicable", "items": { "$ref": "#/components/schemas/ItAssetsAssetIdCollectPostResponsesContentApplicationJsonSchemaDataActionsPurchaseRentalDisabledReasonsItems" }, "type": "array" }, "status": { "$ref": "#/components/schemas/ItAssetsAssetIdCollectPostResponsesContentApplicationJsonSchemaDataActionsPurchaseRentalStatus", "description": "Whether the action is currently available for this asset" } }, "required": [ "status", "details", "disabled_reasons" ], "title": "ItAssetsAssetIdCollectPostResponsesContentApplicationJsonSchemaDataActionsPurchaseRental", "type": "object" }, "ItAssetsAssetIdCollectPostResponsesContentApplicationJsonSchemaDataActionsPurchaseRentalDetails": { "description": "Action-specific context needed to perform the action. Populated for enabled and\ndisabled actions (so callers can see what a successful attempt would look like);\nnull when the action is not applicable to this asset.", "properties": { "purchase_price": { "description": "Estimated price to purchase the asset at the end of the rental contract", "oneOf": [ { "$ref": "#/components/schemas/ItAssetsAssetIdCollectPostResponsesContentApplicationJsonSchemaDataActionsPurchaseRentalDetailsPurchasePrice" }, { "type": "null" } ] }, "remaining_contract_value": { "$ref": "#/components/schemas/ItAssetsAssetIdCollectPostResponsesContentApplicationJsonSchemaDataActionsPurchaseRentalDetailsRemainingContractValue", "description": "Estimated remaining value of the rental contract" }, "total_purchase_price": { "description": "Estimated total price of the purchase, including any remaining contract value", "oneOf": [ { "$ref": "#/components/schemas/ItAssetsAssetIdCollectPostResponsesContentApplicationJsonSchemaDataActionsPurchaseRentalDetailsTotalPurchasePrice" }, { "type": "null" } ] } }, "required": [ "purchase_price", "total_purchase_price", "remaining_contract_value" ], "title": "ItAssetsAssetIdCollectPostResponsesContentApplicationJsonSchemaDataActionsPurchaseRentalDetails", "type": "object" }, "ItAssetsAssetIdCollectPostResponsesContentApplicationJsonSchemaDataActionsPurchaseRentalDetailsPurchasePrice": { "description": "Estimated price to purchase the asset at the end of the rental contract", "properties": { "amount": { "description": "Amount", "format": "decimal", "type": "string" }, "currency": { "$ref": "#/components/schemas/ItAssetsAssetIdCollectPostResponsesContentApplicationJsonSchemaDataActionsPurchaseRentalDetailsPurchasePriceCurrency", "description": "Three-letter currency code for the price" } }, "required": [ "amount", "currency" ], "title": "ItAssetsAssetIdCollectPostResponsesContentApplicationJsonSchemaDataActionsPurchaseRentalDetailsPurchasePrice", "type": "object" }, "ItAssetsAssetIdCollectPostResponsesContentApplicationJsonSchemaDataActionsPurchaseRentalDetailsPurchasePriceCurrency": { "description": "Three-letter currency code for the price", "enum": [ "AED", "AFN", "ALL", "AMD", "ANG", "AOA", "ARS", "AUD", "AWG", "AZN", "BAM", "BDT", "BGN", "BHD", "BIF", "BMD", "BOB", "BRL", "BSD", "BTN", "BWP", "BYN", "BZD", "CAD", "CDF", "CHF", "CLP", "CNY", "COP", "CRC", "CUC", "CVE", "CZK", "DJF", "DKK", "DOP", "DZD", "EGP", "ERN", "ETB", "EUR", "FJD", "FKP", "GBP", "GEL", "GHS", "GIP", "GMD", "GNF", "GTQ", "GYD", "HKD", "HNL", "HRK", "HTG", "HUF", "IDR", "ILS", "INR", "IQD", "IRR", "ISK", "JMD", "JOD", "JPY", "KES", "KGS", "KHR", "KMF", "KPW", "KRW", "KWD", "KYD", "KZT", "LAK", "LBP", "LKR", "LRD", "LSL", "LTL", "LYD", "MAD", "MDL", "MGA", "MKD", "MMK", "MNT", "MRU", "MUR", "MVR", "MWK", "MXN", "MYR", "MZN", "NAD", "NGN", "NIO", "NOK", "NPR", "NZD", "OMR", "PAB", "PEN", "PGK", "PHP", "PKR", "PLN", "PYG", "QAR", "RON", "RSD", "RUB", "RWF", "SAR", "SBD", "SCR", "SDG", "SEK", "SGD", "SHP", "SLL", "SOS", "SRD", "SSP", "STD", "SYP", "SZL", "THB", "TJS", "TMT", "TND", "TOP", "TRY", "TTD", "TWD", "TZS", "UAH", "UGX", "USD", "UYU", "UZS", "VEF", "VND", "VUV", "WST", "XAF", "XCD", "XOF", "XPF", "YER", "ZAR", "ZMW", "ZWD" ], "title": "ItAssetsAssetIdCollectPostResponsesContentApplicationJsonSchemaDataActionsPurchaseRentalDetailsPurchasePriceCurrency", "type": "string" }, "ItAssetsAssetIdCollectPostResponsesContentApplicationJsonSchemaDataActionsPurchaseRentalDetailsRemainingContractValue": { "description": "Estimated remaining value of the rental contract", "properties": { "amount": { "description": "Amount", "format": "decimal", "type": "string" }, "currency": { "$ref": "#/components/schemas/ItAssetsAssetIdCollectPostResponsesContentApplicationJsonSchemaDataActionsPurchaseRentalDetailsRemainingContractValueCurrency", "description": "Three-letter currency code for the price" } }, "required": [ "amount", "currency" ], "title": "ItAssetsAssetIdCollectPostResponsesContentApplicationJsonSchemaDataActionsPurchaseRentalDetailsRemainingContractValue", "type": "object" }, "ItAssetsAssetIdCollectPostResponsesContentApplicationJsonSchemaDataActionsPurchaseRentalDetailsRemainingContractValueCurrency": { "description": "Three-letter currency code for the price", "enum": [ "AED", "AFN", "ALL", "AMD", "ANG", "AOA", "ARS", "AUD", "AWG", "AZN", "BAM", "BDT", "BGN", "BHD", "BIF", "BMD", "BOB", "BRL", "BSD", "BTN", "BWP", "BYN", "BZD", "CAD", "CDF", "CHF", "CLP", "CNY", "COP", "CRC", "CUC", "CVE", "CZK", "DJF", "DKK", "DOP", "DZD", "EGP", "ERN", "ETB", "EUR", "FJD", "FKP", "GBP", "GEL", "GHS", "GIP", "GMD", "GNF", "GTQ", "GYD", "HKD", "HNL", "HRK", "HTG", "HUF", "IDR", "ILS", "INR", "IQD", "IRR", "ISK", "JMD", "JOD", "JPY", "KES", "KGS", "KHR", "KMF", "KPW", "KRW", "KWD", "KYD", "KZT", "LAK", "LBP", "LKR", "LRD", "LSL", "LTL", "LYD", "MAD", "MDL", "MGA", "MKD", "MMK", "MNT", "MRU", "MUR", "MVR", "MWK", "MXN", "MYR", "MZN", "NAD", "NGN", "NIO", "NOK", "NPR", "NZD", "OMR", "PAB", "PEN", "PGK", "PHP", "PKR", "PLN", "PYG", "QAR", "RON", "RSD", "RUB", "RWF", "SAR", "SBD", "SCR", "SDG", "SEK", "SGD", "SHP", "SLL", "SOS", "SRD", "SSP", "STD", "SYP", "SZL", "THB", "TJS", "TMT", "TND", "TOP", "TRY", "TTD", "TWD", "TZS", "UAH", "UGX", "USD", "UYU", "UZS", "VEF", "VND", "VUV", "WST", "XAF", "XCD", "XOF", "XPF", "YER", "ZAR", "ZMW", "ZWD" ], "title": "ItAssetsAssetIdCollectPostResponsesContentApplicationJsonSchemaDataActionsPurchaseRentalDetailsRemainingContractValueCurrency", "type": "string" }, "ItAssetsAssetIdCollectPostResponsesContentApplicationJsonSchemaDataActionsPurchaseRentalDetailsTotalPurchasePrice": { "description": "Estimated total price of the purchase, including any remaining contract value", "properties": { "amount": { "description": "Amount", "format": "decimal", "type": "string" }, "currency": { "$ref": "#/components/schemas/ItAssetsAssetIdCollectPostResponsesContentApplicationJsonSchemaDataActionsPurchaseRentalDetailsTotalPurchasePriceCurrency", "description": "Three-letter currency code for the price" } }, "required": [ "amount", "currency" ], "title": "ItAssetsAssetIdCollectPostResponsesContentApplicationJsonSchemaDataActionsPurchaseRentalDetailsTotalPurchasePrice", "type": "object" }, "ItAssetsAssetIdCollectPostResponsesContentApplicationJsonSchemaDataActionsPurchaseRentalDetailsTotalPurchasePriceCurrency": { "description": "Three-letter currency code for the price", "enum": [ "AED", "AFN", "ALL", "AMD", "ANG", "AOA", "ARS", "AUD", "AWG", "AZN", "BAM", "BDT", "BGN", "BHD", "BIF", "BMD", "BOB", "BRL", "BSD", "BTN", "BWP", "BYN", "BZD", "CAD", "CDF", "CHF", "CLP", "CNY", "COP", "CRC", "CUC", "CVE", "CZK", "DJF", "DKK", "DOP", "DZD", "EGP", "ERN", "ETB", "EUR", "FJD", "FKP", "GBP", "GEL", "GHS", "GIP", "GMD", "GNF", "GTQ", "GYD", "HKD", "HNL", "HRK", "HTG", "HUF", "IDR", "ILS", "INR", "IQD", "IRR", "ISK", "JMD", "JOD", "JPY", "KES", "KGS", "KHR", "KMF", "KPW", "KRW", "KWD", "KYD", "KZT", "LAK", "LBP", "LKR", "LRD", "LSL", "LTL", "LYD", "MAD", "MDL", "MGA", "MKD", "MMK", "MNT", "MRU", "MUR", "MVR", "MWK", "MXN", "MYR", "MZN", "NAD", "NGN", "NIO", "NOK", "NPR", "NZD", "OMR", "PAB", "PEN", "PGK", "PHP", "PKR", "PLN", "PYG", "QAR", "RON", "RSD", "RUB", "RWF", "SAR", "SBD", "SCR", "SDG", "SEK", "SGD", "SHP", "SLL", "SOS", "SRD", "SSP", "STD", "SYP", "SZL", "THB", "TJS", "TMT", "TND", "TOP", "TRY", "TTD", "TWD", "TZS", "UAH", "UGX", "USD", "UYU", "UZS", "VEF", "VND", "VUV", "WST", "XAF", "XCD", "XOF", "XPF", "YER", "ZAR", "ZMW", "ZWD" ], "title": "ItAssetsAssetIdCollectPostResponsesContentApplicationJsonSchemaDataActionsPurchaseRentalDetailsTotalPurchasePriceCurrency", "type": "string" }, "ItAssetsAssetIdCollectPostResponsesContentApplicationJsonSchemaDataActionsPurchaseRentalDisabledReasonsItems": { "enum": [ "ARCHIVED", "AT_DEEL_WAREHOUSE", "BEING_REPAIRED", "CONSUMABLE", "CONTROLLED_BY_DEEL", "COUNTRY_NOT_SUPPORTED_FOR_HUB", "COUNTRY_NOT_SUPPORTED_FOR_LOCAL", "DEEL_OWNED_ITEM_WITHOUT_RENTAL_CONTRACT", "DESKTOP_STORAGE", "ENDING_CONTRACT", "HUB_IN_SAME_REGION_AS_LOCAL", "INACTIVE", "INVALID_ITEM_LOCATION", "INVALID_ORGANIZATION_STATUS", "INVALID_STATE", "ITEM_CONDITIONS_TO_UNARCHIVE_NOT_MET", "ITEM_NOT_VISIBLE_FOR_ORGANIZATION", "NON_DEVICE", "NOT_AT_WAREHOUSE", "NOT_AVAILABLE_FOR_REUSE", "NOT_A_RENTAL", "NOT_MANAGEABLE_BY_ORGANIZATION", "NOT_WITH_ASSIGNMENT", "NOT_WITH_USER", "NO_ACTIVE_ADDONS", "NO_ACTIVE_STORAGE_CONTRACT", "NO_LOCATION_FOR_STORAGE", "NO_LOGISTICS_FOR_STORAGE", "NO_VALID_ADDONS", "ONGOING_SERVICE", "OWNED_BY_DEEL", "OWNED_BY_ORGANIZATION", "OWNED_BY_PARTNER_ORGANIZATION", "PARTNER_CHILD_CONTRACT", "PENDING_DEVICE_REFRESH", "RENTAL_CONTRACT_AND_USER_REGION_DO_NOT_MATCH", "TEMPORARILY_UNAVAILABLE", "UNKNOWN", "USER_HAS_NO_COUNTRY", "USER_HAS_NO_SEAT", "WAITING_FOR_CLEARANCE", "WITH_LOANER_ASSIGNMENT", "WITH_NON_COLLECTED_ASSIGNMENT", "WITH_NON_DELIVERED_ASSIGNMENT", "WITH_PENDING_ASSIGNMENT", "WRONG_ASSIGNMENT_STATUS", "WRONG_CONTRACT_STATUS", "WRONG_TERMS_AND_CONDITIONS" ], "title": "ItAssetsAssetIdCollectPostResponsesContentApplicationJsonSchemaDataActionsPurchaseRentalDisabledReasonsItems", "type": "string" }, "ItAssetsAssetIdCollectPostResponsesContentApplicationJsonSchemaDataActionsPurchaseRentalStatus": { "description": "Whether the action is currently available for this asset", "enum": [ "DISABLED", "ENABLED", "NOT_APPLICABLE" ], "title": "ItAssetsAssetIdCollectPostResponsesContentApplicationJsonSchemaDataActionsPurchaseRentalStatus", "type": "string" }, "ItAssetsAssetIdCollectPostResponsesContentApplicationJsonSchemaDataActionsReturnRentalToDeel": { "description": "Return a Deel-owned rental asset back to Deel", "properties": { "details": { "description": "Action-specific context needed to perform the action. Populated for enabled and\ndisabled actions (so callers can see what a successful attempt would look like);\nnull when the action is not applicable to this asset.", "oneOf": [ { "$ref": "#/components/schemas/ItAssetsAssetIdCollectPostResponsesContentApplicationJsonSchemaDataActionsReturnRentalToDeelDetails" }, { "type": "null" } ] }, "disabled_reasons": { "description": "Reasons why the action is disabled. Empty when the action is enabled or not applicable", "items": { "$ref": "#/components/schemas/ItAssetsAssetIdCollectPostResponsesContentApplicationJsonSchemaDataActionsReturnRentalToDeelDisabledReasonsItems" }, "type": "array" }, "status": { "$ref": "#/components/schemas/ItAssetsAssetIdCollectPostResponsesContentApplicationJsonSchemaDataActionsReturnRentalToDeelStatus", "description": "Whether the action is currently available for this asset" } }, "required": [ "status", "details", "disabled_reasons" ], "title": "ItAssetsAssetIdCollectPostResponsesContentApplicationJsonSchemaDataActionsReturnRentalToDeel", "type": "object" }, "ItAssetsAssetIdCollectPostResponsesContentApplicationJsonSchemaDataActionsReturnRentalToDeelDetails": { "description": "Action-specific context needed to perform the action. Populated for enabled and\ndisabled actions (so callers can see what a successful attempt would look like);\nnull when the action is not applicable to this asset.", "properties": { "end_contract_price": { "$ref": "#/components/schemas/ItAssetsAssetIdCollectPostResponsesContentApplicationJsonSchemaDataActionsReturnRentalToDeelDetailsEndContractPrice", "description": "Estimated end-of-contract price charged when returning the asset" } }, "required": [ "end_contract_price" ], "title": "ItAssetsAssetIdCollectPostResponsesContentApplicationJsonSchemaDataActionsReturnRentalToDeelDetails", "type": "object" }, "ItAssetsAssetIdCollectPostResponsesContentApplicationJsonSchemaDataActionsReturnRentalToDeelDetailsEndContractPrice": { "description": "Estimated end-of-contract price charged when returning the asset", "properties": { "amount": { "description": "Amount", "format": "decimal", "type": "string" }, "currency": { "$ref": "#/components/schemas/ItAssetsAssetIdCollectPostResponsesContentApplicationJsonSchemaDataActionsReturnRentalToDeelDetailsEndContractPriceCurrency", "description": "Three-letter currency code for the price" } }, "required": [ "amount", "currency" ], "title": "ItAssetsAssetIdCollectPostResponsesContentApplicationJsonSchemaDataActionsReturnRentalToDeelDetailsEndContractPrice", "type": "object" }, "ItAssetsAssetIdCollectPostResponsesContentApplicationJsonSchemaDataActionsReturnRentalToDeelDetailsEndContractPriceCurrency": { "description": "Three-letter currency code for the price", "enum": [ "AED", "AFN", "ALL", "AMD", "ANG", "AOA", "ARS", "AUD", "AWG", "AZN", "BAM", "BDT", "BGN", "BHD", "BIF", "BMD", "BOB", "BRL", "BSD", "BTN", "BWP", "BYN", "BZD", "CAD", "CDF", "CHF", "CLP", "CNY", "COP", "CRC", "CUC", "CVE", "CZK", "DJF", "DKK", "DOP", "DZD", "EGP", "ERN", "ETB", "EUR", "FJD", "FKP", "GBP", "GEL", "GHS", "GIP", "GMD", "GNF", "GTQ", "GYD", "HKD", "HNL", "HRK", "HTG", "HUF", "IDR", "ILS", "INR", "IQD", "IRR", "ISK", "JMD", "JOD", "JPY", "KES", "KGS", "KHR", "KMF", "KPW", "KRW", "KWD", "KYD", "KZT", "LAK", "LBP", "LKR", "LRD", "LSL", "LTL", "LYD", "MAD", "MDL", "MGA", "MKD", "MMK", "MNT", "MRU", "MUR", "MVR", "MWK", "MXN", "MYR", "MZN", "NAD", "NGN", "NIO", "NOK", "NPR", "NZD", "OMR", "PAB", "PEN", "PGK", "PHP", "PKR", "PLN", "PYG", "QAR", "RON", "RSD", "RUB", "RWF", "SAR", "SBD", "SCR", "SDG", "SEK", "SGD", "SHP", "SLL", "SOS", "SRD", "SSP", "STD", "SYP", "SZL", "THB", "TJS", "TMT", "TND", "TOP", "TRY", "TTD", "TWD", "TZS", "UAH", "UGX", "USD", "UYU", "UZS", "VEF", "VND", "VUV", "WST", "XAF", "XCD", "XOF", "XPF", "YER", "ZAR", "ZMW", "ZWD" ], "title": "ItAssetsAssetIdCollectPostResponsesContentApplicationJsonSchemaDataActionsReturnRentalToDeelDetailsEndContractPriceCurrency", "type": "string" }, "ItAssetsAssetIdCollectPostResponsesContentApplicationJsonSchemaDataActionsReturnRentalToDeelDisabledReasonsItems": { "enum": [ "ARCHIVED", "AT_DEEL_WAREHOUSE", "BEING_REPAIRED", "CONSUMABLE", "CONTROLLED_BY_DEEL", "COUNTRY_NOT_SUPPORTED_FOR_HUB", "COUNTRY_NOT_SUPPORTED_FOR_LOCAL", "DEEL_OWNED_ITEM_WITHOUT_RENTAL_CONTRACT", "DESKTOP_STORAGE", "ENDING_CONTRACT", "HUB_IN_SAME_REGION_AS_LOCAL", "INACTIVE", "INVALID_ITEM_LOCATION", "INVALID_ORGANIZATION_STATUS", "INVALID_STATE", "ITEM_CONDITIONS_TO_UNARCHIVE_NOT_MET", "ITEM_NOT_VISIBLE_FOR_ORGANIZATION", "NON_DEVICE", "NOT_AT_WAREHOUSE", "NOT_AVAILABLE_FOR_REUSE", "NOT_A_RENTAL", "NOT_MANAGEABLE_BY_ORGANIZATION", "NOT_WITH_ASSIGNMENT", "NOT_WITH_USER", "NO_ACTIVE_ADDONS", "NO_ACTIVE_STORAGE_CONTRACT", "NO_LOCATION_FOR_STORAGE", "NO_LOGISTICS_FOR_STORAGE", "NO_VALID_ADDONS", "ONGOING_SERVICE", "OWNED_BY_DEEL", "OWNED_BY_ORGANIZATION", "OWNED_BY_PARTNER_ORGANIZATION", "PARTNER_CHILD_CONTRACT", "PENDING_DEVICE_REFRESH", "RENTAL_CONTRACT_AND_USER_REGION_DO_NOT_MATCH", "TEMPORARILY_UNAVAILABLE", "UNKNOWN", "USER_HAS_NO_COUNTRY", "USER_HAS_NO_SEAT", "WAITING_FOR_CLEARANCE", "WITH_LOANER_ASSIGNMENT", "WITH_NON_COLLECTED_ASSIGNMENT", "WITH_NON_DELIVERED_ASSIGNMENT", "WITH_PENDING_ASSIGNMENT", "WRONG_ASSIGNMENT_STATUS", "WRONG_CONTRACT_STATUS", "WRONG_TERMS_AND_CONDITIONS" ], "title": "ItAssetsAssetIdCollectPostResponsesContentApplicationJsonSchemaDataActionsReturnRentalToDeelDisabledReasonsItems", "type": "string" }, "ItAssetsAssetIdCollectPostResponsesContentApplicationJsonSchemaDataActionsReturnRentalToDeelStatus": { "description": "Whether the action is currently available for this asset", "enum": [ "DISABLED", "ENABLED", "NOT_APPLICABLE" ], "title": "ItAssetsAssetIdCollectPostResponsesContentApplicationJsonSchemaDataActionsReturnRentalToDeelStatus", "type": "string" }, "ItAssetsAssetIdCollectPostResponsesContentApplicationJsonSchemaDataActionsReuseOwnAssetFromDeel": { "description": "Redeploy an organization-owned asset stored at a Deel warehouse", "properties": { "details": { "description": "Action-specific context needed to perform the action. Populated for enabled and\ndisabled actions (so callers can see what a successful attempt would look like);\nnull when the action is not applicable to this asset.", "oneOf": [ { "$ref": "#/components/schemas/ItAssetsAssetIdCollectPostResponsesContentApplicationJsonSchemaDataActionsReuseOwnAssetFromDeelDetails" }, { "type": "null" } ] }, "disabled_reasons": { "description": "Reasons why the action is disabled. Empty when the action is enabled or not applicable", "items": { "$ref": "#/components/schemas/ItAssetsAssetIdCollectPostResponsesContentApplicationJsonSchemaDataActionsReuseOwnAssetFromDeelDisabledReasonsItems" }, "type": "array" }, "status": { "$ref": "#/components/schemas/ItAssetsAssetIdCollectPostResponsesContentApplicationJsonSchemaDataActionsReuseOwnAssetFromDeelStatus", "description": "Whether the action is currently available for this asset" } }, "required": [ "status", "details", "disabled_reasons" ], "title": "ItAssetsAssetIdCollectPostResponsesContentApplicationJsonSchemaDataActionsReuseOwnAssetFromDeel", "type": "object" }, "ItAssetsAssetIdCollectPostResponsesContentApplicationJsonSchemaDataActionsReuseOwnAssetFromDeelDetails": { "description": "Action-specific context needed to perform the action. Populated for enabled and\ndisabled actions (so callers can see what a successful attempt would look like);\nnull when the action is not applicable to this asset.", "properties": { "eligible_countries": { "description": "Countries where the asset can be redeployed from Deel", "items": { "$ref": "#/components/schemas/ItAssetsAssetIdCollectPostResponsesContentApplicationJsonSchemaDataActionsReuseOwnAssetFromDeelDetailsEligibleCountriesItems" }, "type": "array" }, "express_delivery": { "description": "Express delivery availability and per-country fees. Null when express delivery is not supported", "oneOf": [ { "$ref": "#/components/schemas/ItAssetsAssetIdCollectPostResponsesContentApplicationJsonSchemaDataActionsReuseOwnAssetFromDeelDetailsExpressDelivery" }, { "type": "null" } ] } }, "required": [ "express_delivery", "eligible_countries" ], "title": "ItAssetsAssetIdCollectPostResponsesContentApplicationJsonSchemaDataActionsReuseOwnAssetFromDeelDetails", "type": "object" }, "ItAssetsAssetIdCollectPostResponsesContentApplicationJsonSchemaDataActionsReuseOwnAssetFromDeelDetailsEligibleCountriesItems": { "enum": [ "AD", "AE", "AF", "AG", "AI", "AL", "AM", "AN", "AO", "AQ", "AR", "AS", "AT", "AU", "AW", "AX", "AZ", "BA", "BB", "BD", "BE", "BF", "BG", "BH", "BI", "BJ", "BL", "BM", "BN", "BO", "BQ", "BR", "BS", "BT", "BV", "BW", "BY", "BZ", "CA", "CC", "CD", "CF", "CG", "CH", "CI", "CK", "CL", "CM", "CN", "CO", "CR", "CU", "CV", "CW", "CX", "CY", "CZ", "DE", "DJ", "DK", "DM", "DO", "DZ", "EC", "EE", "EG", "EH", "ER", "ES", "ET", "FI", "FJ", "FK", "FM", "FO", "FR", "GA", "GB", "GD", "GE", "GF", "GG", "GH", "GI", "GL", "GM", "GN", "GP", "GQ", "GR", "GS", "GT", "GU", "GW", "GY", "HK", "HM", "HN", "HR", "HT", "HU", "IC", "ID", "IE", "IL", "IM", "IN", "IO", "IQ", "IR", "IS", "IT", "JE", "JM", "JO", "JP", "KE", "KG", "KH", "KI", "KM", "KN", "KP", "KR", "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", "XK", "YE", "YT", "ZA", "ZM", "ZW" ], "title": "ItAssetsAssetIdCollectPostResponsesContentApplicationJsonSchemaDataActionsReuseOwnAssetFromDeelDetailsEligibleCountriesItems", "type": "string" }, "ItAssetsAssetIdCollectPostResponsesContentApplicationJsonSchemaDataActionsReuseOwnAssetFromDeelDetailsExpressDelivery": { "description": "Express delivery availability and per-country fees. Null when express delivery is not supported", "properties": { "country_fees": { "additionalProperties": { "$ref": "#/components/schemas/ItAssetsAssetIdCollectPostResponsesContentApplicationJsonSchemaDataActionsReuseOwnAssetFromDeelDetailsExpressDeliveryCountryFees" }, "description": "Express delivery fees keyed by destination country.", "type": "object" } }, "required": [ "country_fees" ], "title": "ItAssetsAssetIdCollectPostResponsesContentApplicationJsonSchemaDataActionsReuseOwnAssetFromDeelDetailsExpressDelivery", "type": "object" }, "ItAssetsAssetIdCollectPostResponsesContentApplicationJsonSchemaDataActionsReuseOwnAssetFromDeelDetailsExpressDeliveryCountryFees": { "properties": { "amount": { "description": "Amount", "format": "decimal", "type": "string" }, "currency": { "$ref": "#/components/schemas/ItAssetsAssetIdCollectPostResponsesContentApplicationJsonSchemaDataActionsReuseOwnAssetFromDeelDetailsExpressDeliveryCountryFeesCurrency", "description": "Three-letter currency code for the price" } }, "required": [ "amount", "currency" ], "title": "ItAssetsAssetIdCollectPostResponsesContentApplicationJsonSchemaDataActionsReuseOwnAssetFromDeelDetailsExpressDeliveryCountryFees", "type": "object" }, "ItAssetsAssetIdCollectPostResponsesContentApplicationJsonSchemaDataActionsReuseOwnAssetFromDeelDetailsExpressDeliveryCountryFeesCurrency": { "description": "Three-letter currency code for the price", "enum": [ "AED", "AFN", "ALL", "AMD", "ANG", "AOA", "ARS", "AUD", "AWG", "AZN", "BAM", "BDT", "BGN", "BHD", "BIF", "BMD", "BOB", "BRL", "BSD", "BTN", "BWP", "BYN", "BZD", "CAD", "CDF", "CHF", "CLP", "CNY", "COP", "CRC", "CUC", "CVE", "CZK", "DJF", "DKK", "DOP", "DZD", "EGP", "ERN", "ETB", "EUR", "FJD", "FKP", "GBP", "GEL", "GHS", "GIP", "GMD", "GNF", "GTQ", "GYD", "HKD", "HNL", "HRK", "HTG", "HUF", "IDR", "ILS", "INR", "IQD", "IRR", "ISK", "JMD", "JOD", "JPY", "KES", "KGS", "KHR", "KMF", "KPW", "KRW", "KWD", "KYD", "KZT", "LAK", "LBP", "LKR", "LRD", "LSL", "LTL", "LYD", "MAD", "MDL", "MGA", "MKD", "MMK", "MNT", "MRU", "MUR", "MVR", "MWK", "MXN", "MYR", "MZN", "NAD", "NGN", "NIO", "NOK", "NPR", "NZD", "OMR", "PAB", "PEN", "PGK", "PHP", "PKR", "PLN", "PYG", "QAR", "RON", "RSD", "RUB", "RWF", "SAR", "SBD", "SCR", "SDG", "SEK", "SGD", "SHP", "SLL", "SOS", "SRD", "SSP", "STD", "SYP", "SZL", "THB", "TJS", "TMT", "TND", "TOP", "TRY", "TTD", "TWD", "TZS", "UAH", "UGX", "USD", "UYU", "UZS", "VEF", "VND", "VUV", "WST", "XAF", "XCD", "XOF", "XPF", "YER", "ZAR", "ZMW", "ZWD" ], "title": "ItAssetsAssetIdCollectPostResponsesContentApplicationJsonSchemaDataActionsReuseOwnAssetFromDeelDetailsExpressDeliveryCountryFeesCurrency", "type": "string" }, "ItAssetsAssetIdCollectPostResponsesContentApplicationJsonSchemaDataActionsReuseOwnAssetFromDeelDisabledReasonsItems": { "enum": [ "ARCHIVED", "AT_DEEL_WAREHOUSE", "BEING_REPAIRED", "CONSUMABLE", "CONTROLLED_BY_DEEL", "COUNTRY_NOT_SUPPORTED_FOR_HUB", "COUNTRY_NOT_SUPPORTED_FOR_LOCAL", "DEEL_OWNED_ITEM_WITHOUT_RENTAL_CONTRACT", "DESKTOP_STORAGE", "ENDING_CONTRACT", "HUB_IN_SAME_REGION_AS_LOCAL", "INACTIVE", "INVALID_ITEM_LOCATION", "INVALID_ORGANIZATION_STATUS", "INVALID_STATE", "ITEM_CONDITIONS_TO_UNARCHIVE_NOT_MET", "ITEM_NOT_VISIBLE_FOR_ORGANIZATION", "NON_DEVICE", "NOT_AT_WAREHOUSE", "NOT_AVAILABLE_FOR_REUSE", "NOT_A_RENTAL", "NOT_MANAGEABLE_BY_ORGANIZATION", "NOT_WITH_ASSIGNMENT", "NOT_WITH_USER", "NO_ACTIVE_ADDONS", "NO_ACTIVE_STORAGE_CONTRACT", "NO_LOCATION_FOR_STORAGE", "NO_LOGISTICS_FOR_STORAGE", "NO_VALID_ADDONS", "ONGOING_SERVICE", "OWNED_BY_DEEL", "OWNED_BY_ORGANIZATION", "OWNED_BY_PARTNER_ORGANIZATION", "PARTNER_CHILD_CONTRACT", "PENDING_DEVICE_REFRESH", "RENTAL_CONTRACT_AND_USER_REGION_DO_NOT_MATCH", "TEMPORARILY_UNAVAILABLE", "UNKNOWN", "USER_HAS_NO_COUNTRY", "USER_HAS_NO_SEAT", "WAITING_FOR_CLEARANCE", "WITH_LOANER_ASSIGNMENT", "WITH_NON_COLLECTED_ASSIGNMENT", "WITH_NON_DELIVERED_ASSIGNMENT", "WITH_PENDING_ASSIGNMENT", "WRONG_ASSIGNMENT_STATUS", "WRONG_CONTRACT_STATUS", "WRONG_TERMS_AND_CONDITIONS" ], "title": "ItAssetsAssetIdCollectPostResponsesContentApplicationJsonSchemaDataActionsReuseOwnAssetFromDeelDisabledReasonsItems", "type": "string" }, "ItAssetsAssetIdCollectPostResponsesContentApplicationJsonSchemaDataActionsReuseOwnAssetFromDeelStatus": { "description": "Whether the action is currently available for this asset", "enum": [ "DISABLED", "ENABLED", "NOT_APPLICABLE" ], "title": "ItAssetsAssetIdCollectPostResponsesContentApplicationJsonSchemaDataActionsReuseOwnAssetFromDeelStatus", "type": "string" }, "ItAssetsAssetIdCollectPostResponsesContentApplicationJsonSchemaDataActionsReuseOwnAssetFromOwnLocation": { "description": "Redeploy an organization-owned asset from an organization-owned location", "properties": { "details": { "description": "Action-specific context needed to perform the action. Populated for enabled and\ndisabled actions (so callers can see what a successful attempt would look like);\nnull when the action is not applicable to this asset.", "oneOf": [ { "$ref": "#/components/schemas/ItAssetsAssetIdCollectPostResponsesContentApplicationJsonSchemaDataActionsReuseOwnAssetFromOwnLocationDetails" }, { "type": "null" } ] }, "disabled_reasons": { "description": "Reasons why the action is disabled. Empty when the action is enabled or not applicable", "items": { "$ref": "#/components/schemas/ItAssetsAssetIdCollectPostResponsesContentApplicationJsonSchemaDataActionsReuseOwnAssetFromOwnLocationDisabledReasonsItems" }, "type": "array" }, "status": { "$ref": "#/components/schemas/ItAssetsAssetIdCollectPostResponsesContentApplicationJsonSchemaDataActionsReuseOwnAssetFromOwnLocationStatus", "description": "Whether the action is currently available for this asset" } }, "required": [ "status", "details", "disabled_reasons" ], "title": "ItAssetsAssetIdCollectPostResponsesContentApplicationJsonSchemaDataActionsReuseOwnAssetFromOwnLocation", "type": "object" }, "ItAssetsAssetIdCollectPostResponsesContentApplicationJsonSchemaDataActionsReuseOwnAssetFromOwnLocationDetails": { "description": "Action-specific context needed to perform the action. Populated for enabled and\ndisabled actions (so callers can see what a successful attempt would look like);\nnull when the action is not applicable to this asset.", "properties": { "eligible_countries": { "description": "Countries where the asset can be redeployed from an organization-owned location", "items": { "$ref": "#/components/schemas/ItAssetsAssetIdCollectPostResponsesContentApplicationJsonSchemaDataActionsReuseOwnAssetFromOwnLocationDetailsEligibleCountriesItems" }, "type": "array" }, "express_delivery": { "description": "Express delivery availability and per-country fees. Null when express delivery is not supported", "oneOf": [ { "$ref": "#/components/schemas/ItAssetsAssetIdCollectPostResponsesContentApplicationJsonSchemaDataActionsReuseOwnAssetFromOwnLocationDetailsExpressDelivery" }, { "type": "null" } ] }, "service_cost": { "$ref": "#/components/schemas/ItAssetsAssetIdCollectPostResponsesContentApplicationJsonSchemaDataActionsReuseOwnAssetFromOwnLocationDetailsServiceCost", "description": "Cost charged for the transfer service" } }, "required": [ "service_cost", "express_delivery", "eligible_countries" ], "title": "ItAssetsAssetIdCollectPostResponsesContentApplicationJsonSchemaDataActionsReuseOwnAssetFromOwnLocationDetails", "type": "object" }, "ItAssetsAssetIdCollectPostResponsesContentApplicationJsonSchemaDataActionsReuseOwnAssetFromOwnLocationDetailsEligibleCountriesItems": { "enum": [ "AD", "AE", "AF", "AG", "AI", "AL", "AM", "AN", "AO", "AQ", "AR", "AS", "AT", "AU", "AW", "AX", "AZ", "BA", "BB", "BD", "BE", "BF", "BG", "BH", "BI", "BJ", "BL", "BM", "BN", "BO", "BQ", "BR", "BS", "BT", "BV", "BW", "BY", "BZ", "CA", "CC", "CD", "CF", "CG", "CH", "CI", "CK", "CL", "CM", "CN", "CO", "CR", "CU", "CV", "CW", "CX", "CY", "CZ", "DE", "DJ", "DK", "DM", "DO", "DZ", "EC", "EE", "EG", "EH", "ER", "ES", "ET", "FI", "FJ", "FK", "FM", "FO", "FR", "GA", "GB", "GD", "GE", "GF", "GG", "GH", "GI", "GL", "GM", "GN", "GP", "GQ", "GR", "GS", "GT", "GU", "GW", "GY", "HK", "HM", "HN", "HR", "HT", "HU", "IC", "ID", "IE", "IL", "IM", "IN", "IO", "IQ", "IR", "IS", "IT", "JE", "JM", "JO", "JP", "KE", "KG", "KH", "KI", "KM", "KN", "KP", "KR", "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", "XK", "YE", "YT", "ZA", "ZM", "ZW" ], "title": "ItAssetsAssetIdCollectPostResponsesContentApplicationJsonSchemaDataActionsReuseOwnAssetFromOwnLocationDetailsEligibleCountriesItems", "type": "string" }, "ItAssetsAssetIdCollectPostResponsesContentApplicationJsonSchemaDataActionsReuseOwnAssetFromOwnLocationDetailsExpressDelivery": { "description": "Express delivery availability and per-country fees. Null when express delivery is not supported", "properties": { "country_fees": { "additionalProperties": { "$ref": "#/components/schemas/ItAssetsAssetIdCollectPostResponsesContentApplicationJsonSchemaDataActionsReuseOwnAssetFromOwnLocationDetailsExpressDeliveryCountryFees" }, "description": "Express delivery fees keyed by destination country.", "type": "object" } }, "required": [ "country_fees" ], "title": "ItAssetsAssetIdCollectPostResponsesContentApplicationJsonSchemaDataActionsReuseOwnAssetFromOwnLocationDetailsExpressDelivery", "type": "object" }, "ItAssetsAssetIdCollectPostResponsesContentApplicationJsonSchemaDataActionsReuseOwnAssetFromOwnLocationDetailsExpressDeliveryCountryFees": { "properties": { "amount": { "description": "Amount", "format": "decimal", "type": "string" }, "currency": { "$ref": "#/components/schemas/ItAssetsAssetIdCollectPostResponsesContentApplicationJsonSchemaDataActionsReuseOwnAssetFromOwnLocationDetailsExpressDeliveryCountryFeesCurrency", "description": "Three-letter currency code for the price" } }, "required": [ "amount", "currency" ], "title": "ItAssetsAssetIdCollectPostResponsesContentApplicationJsonSchemaDataActionsReuseOwnAssetFromOwnLocationDetailsExpressDeliveryCountryFees", "type": "object" }, "ItAssetsAssetIdCollectPostResponsesContentApplicationJsonSchemaDataActionsReuseOwnAssetFromOwnLocationDetailsExpressDeliveryCountryFeesCurrency": { "description": "Three-letter currency code for the price", "enum": [ "AED", "AFN", "ALL", "AMD", "ANG", "AOA", "ARS", "AUD", "AWG", "AZN", "BAM", "BDT", "BGN", "BHD", "BIF", "BMD", "BOB", "BRL", "BSD", "BTN", "BWP", "BYN", "BZD", "CAD", "CDF", "CHF", "CLP", "CNY", "COP", "CRC", "CUC", "CVE", "CZK", "DJF", "DKK", "DOP", "DZD", "EGP", "ERN", "ETB", "EUR", "FJD", "FKP", "GBP", "GEL", "GHS", "GIP", "GMD", "GNF", "GTQ", "GYD", "HKD", "HNL", "HRK", "HTG", "HUF", "IDR", "ILS", "INR", "IQD", "IRR", "ISK", "JMD", "JOD", "JPY", "KES", "KGS", "KHR", "KMF", "KPW", "KRW", "KWD", "KYD", "KZT", "LAK", "LBP", "LKR", "LRD", "LSL", "LTL", "LYD", "MAD", "MDL", "MGA", "MKD", "MMK", "MNT", "MRU", "MUR", "MVR", "MWK", "MXN", "MYR", "MZN", "NAD", "NGN", "NIO", "NOK", "NPR", "NZD", "OMR", "PAB", "PEN", "PGK", "PHP", "PKR", "PLN", "PYG", "QAR", "RON", "RSD", "RUB", "RWF", "SAR", "SBD", "SCR", "SDG", "SEK", "SGD", "SHP", "SLL", "SOS", "SRD", "SSP", "STD", "SYP", "SZL", "THB", "TJS", "TMT", "TND", "TOP", "TRY", "TTD", "TWD", "TZS", "UAH", "UGX", "USD", "UYU", "UZS", "VEF", "VND", "VUV", "WST", "XAF", "XCD", "XOF", "XPF", "YER", "ZAR", "ZMW", "ZWD" ], "title": "ItAssetsAssetIdCollectPostResponsesContentApplicationJsonSchemaDataActionsReuseOwnAssetFromOwnLocationDetailsExpressDeliveryCountryFeesCurrency", "type": "string" }, "ItAssetsAssetIdCollectPostResponsesContentApplicationJsonSchemaDataActionsReuseOwnAssetFromOwnLocationDetailsServiceCost": { "description": "Cost charged for the transfer service", "properties": { "billing_method": { "$ref": "#/components/schemas/ItAssetsAssetIdCollectPostResponsesContentApplicationJsonSchemaDataActionsReuseOwnAssetFromOwnLocationDetailsServiceCostBillingMethod", "description": "How the action is charged. When \"TOKEN\", the fees are covered by an\nadd-on token pool; when \"CURRENCY\", the fees are billed in the currency\nspecified in the \"fees\" field." }, "fees": { "description": "Price charged for the action. Null when billing method is \"TOKEN\"", "oneOf": [ { "$ref": "#/components/schemas/ItAssetsAssetIdCollectPostResponsesContentApplicationJsonSchemaDataActionsReuseOwnAssetFromOwnLocationDetailsServiceCostFees" }, { "type": "null" } ] }, "token_usage": { "description": "Add-on token consumption details. Null when billing method is \"CURRENCY\"", "oneOf": [ { "$ref": "#/components/schemas/ItAssetsAssetIdCollectPostResponsesContentApplicationJsonSchemaDataActionsReuseOwnAssetFromOwnLocationDetailsServiceCostTokenUsage" }, { "type": "null" } ] } }, "required": [ "fees", "token_usage", "billing_method" ], "title": "ItAssetsAssetIdCollectPostResponsesContentApplicationJsonSchemaDataActionsReuseOwnAssetFromOwnLocationDetailsServiceCost", "type": "object" }, "ItAssetsAssetIdCollectPostResponsesContentApplicationJsonSchemaDataActionsReuseOwnAssetFromOwnLocationDetailsServiceCostBillingMethod": { "description": "How the action is charged. When \"TOKEN\", the fees are covered by an\nadd-on token pool; when \"CURRENCY\", the fees are billed in the currency\nspecified in the \"fees\" field.", "enum": [ "CURRENCY", "TOKEN" ], "title": "ItAssetsAssetIdCollectPostResponsesContentApplicationJsonSchemaDataActionsReuseOwnAssetFromOwnLocationDetailsServiceCostBillingMethod", "type": "string" }, "ItAssetsAssetIdCollectPostResponsesContentApplicationJsonSchemaDataActionsReuseOwnAssetFromOwnLocationDetailsServiceCostFees": { "description": "Price charged for the action. Null when billing method is \"TOKEN\"", "properties": { "amount": { "description": "Amount", "format": "decimal", "type": "string" }, "currency": { "$ref": "#/components/schemas/ItAssetsAssetIdCollectPostResponsesContentApplicationJsonSchemaDataActionsReuseOwnAssetFromOwnLocationDetailsServiceCostFeesCurrency", "description": "Three-letter currency code for the price" } }, "required": [ "amount", "currency" ], "title": "ItAssetsAssetIdCollectPostResponsesContentApplicationJsonSchemaDataActionsReuseOwnAssetFromOwnLocationDetailsServiceCostFees", "type": "object" }, "ItAssetsAssetIdCollectPostResponsesContentApplicationJsonSchemaDataActionsReuseOwnAssetFromOwnLocationDetailsServiceCostFeesCurrency": { "description": "Three-letter currency code for the price", "enum": [ "AED", "AFN", "ALL", "AMD", "ANG", "AOA", "ARS", "AUD", "AWG", "AZN", "BAM", "BDT", "BGN", "BHD", "BIF", "BMD", "BOB", "BRL", "BSD", "BTN", "BWP", "BYN", "BZD", "CAD", "CDF", "CHF", "CLP", "CNY", "COP", "CRC", "CUC", "CVE", "CZK", "DJF", "DKK", "DOP", "DZD", "EGP", "ERN", "ETB", "EUR", "FJD", "FKP", "GBP", "GEL", "GHS", "GIP", "GMD", "GNF", "GTQ", "GYD", "HKD", "HNL", "HRK", "HTG", "HUF", "IDR", "ILS", "INR", "IQD", "IRR", "ISK", "JMD", "JOD", "JPY", "KES", "KGS", "KHR", "KMF", "KPW", "KRW", "KWD", "KYD", "KZT", "LAK", "LBP", "LKR", "LRD", "LSL", "LTL", "LYD", "MAD", "MDL", "MGA", "MKD", "MMK", "MNT", "MRU", "MUR", "MVR", "MWK", "MXN", "MYR", "MZN", "NAD", "NGN", "NIO", "NOK", "NPR", "NZD", "OMR", "PAB", "PEN", "PGK", "PHP", "PKR", "PLN", "PYG", "QAR", "RON", "RSD", "RUB", "RWF", "SAR", "SBD", "SCR", "SDG", "SEK", "SGD", "SHP", "SLL", "SOS", "SRD", "SSP", "STD", "SYP", "SZL", "THB", "TJS", "TMT", "TND", "TOP", "TRY", "TTD", "TWD", "TZS", "UAH", "UGX", "USD", "UYU", "UZS", "VEF", "VND", "VUV", "WST", "XAF", "XCD", "XOF", "XPF", "YER", "ZAR", "ZMW", "ZWD" ], "title": "ItAssetsAssetIdCollectPostResponsesContentApplicationJsonSchemaDataActionsReuseOwnAssetFromOwnLocationDetailsServiceCostFeesCurrency", "type": "string" }, "ItAssetsAssetIdCollectPostResponsesContentApplicationJsonSchemaDataActionsReuseOwnAssetFromOwnLocationDetailsServiceCostTokenUsage": { "description": "Add-on token consumption details. Null when billing method is \"CURRENCY\"", "properties": { "addon": { "$ref": "#/components/schemas/ItAssetsAssetIdCollectPostResponsesContentApplicationJsonSchemaDataActionsReuseOwnAssetFromOwnLocationDetailsServiceCostTokenUsageAddon", "description": "The add-on that provides the tokens" }, "cost": { "description": "Number of tokens consumed by the action. Zero when the add-on covers the\nservice without drawing from a token pool", "format": "decimal", "type": "string" }, "tokens_left": { "description": "Number of tokens left in the pool after the action is performed. Null when\nthe add-on covers the service without a token pool", "format": "decimal", "type": [ "string", "null" ] } }, "required": [ "cost", "addon", "tokens_left" ], "title": "ItAssetsAssetIdCollectPostResponsesContentApplicationJsonSchemaDataActionsReuseOwnAssetFromOwnLocationDetailsServiceCostTokenUsage", "type": "object" }, "ItAssetsAssetIdCollectPostResponsesContentApplicationJsonSchemaDataActionsReuseOwnAssetFromOwnLocationDetailsServiceCostTokenUsageAddon": { "description": "The add-on that provides the tokens", "properties": { "id": { "description": "ID of the add-on", "format": "uuid", "type": "string" }, "name": { "description": "Public display name of the add-on", "type": "string" } }, "required": [ "id", "name" ], "title": "ItAssetsAssetIdCollectPostResponsesContentApplicationJsonSchemaDataActionsReuseOwnAssetFromOwnLocationDetailsServiceCostTokenUsageAddon", "type": "object" }, "ItAssetsAssetIdCollectPostResponsesContentApplicationJsonSchemaDataActionsReuseOwnAssetFromOwnLocationDisabledReasonsItems": { "enum": [ "ARCHIVED", "AT_DEEL_WAREHOUSE", "BEING_REPAIRED", "CONSUMABLE", "CONTROLLED_BY_DEEL", "COUNTRY_NOT_SUPPORTED_FOR_HUB", "COUNTRY_NOT_SUPPORTED_FOR_LOCAL", "DEEL_OWNED_ITEM_WITHOUT_RENTAL_CONTRACT", "DESKTOP_STORAGE", "ENDING_CONTRACT", "HUB_IN_SAME_REGION_AS_LOCAL", "INACTIVE", "INVALID_ITEM_LOCATION", "INVALID_ORGANIZATION_STATUS", "INVALID_STATE", "ITEM_CONDITIONS_TO_UNARCHIVE_NOT_MET", "ITEM_NOT_VISIBLE_FOR_ORGANIZATION", "NON_DEVICE", "NOT_AT_WAREHOUSE", "NOT_AVAILABLE_FOR_REUSE", "NOT_A_RENTAL", "NOT_MANAGEABLE_BY_ORGANIZATION", "NOT_WITH_ASSIGNMENT", "NOT_WITH_USER", "NO_ACTIVE_ADDONS", "NO_ACTIVE_STORAGE_CONTRACT", "NO_LOCATION_FOR_STORAGE", "NO_LOGISTICS_FOR_STORAGE", "NO_VALID_ADDONS", "ONGOING_SERVICE", "OWNED_BY_DEEL", "OWNED_BY_ORGANIZATION", "OWNED_BY_PARTNER_ORGANIZATION", "PARTNER_CHILD_CONTRACT", "PENDING_DEVICE_REFRESH", "RENTAL_CONTRACT_AND_USER_REGION_DO_NOT_MATCH", "TEMPORARILY_UNAVAILABLE", "UNKNOWN", "USER_HAS_NO_COUNTRY", "USER_HAS_NO_SEAT", "WAITING_FOR_CLEARANCE", "WITH_LOANER_ASSIGNMENT", "WITH_NON_COLLECTED_ASSIGNMENT", "WITH_NON_DELIVERED_ASSIGNMENT", "WITH_PENDING_ASSIGNMENT", "WRONG_ASSIGNMENT_STATUS", "WRONG_CONTRACT_STATUS", "WRONG_TERMS_AND_CONDITIONS" ], "title": "ItAssetsAssetIdCollectPostResponsesContentApplicationJsonSchemaDataActionsReuseOwnAssetFromOwnLocationDisabledReasonsItems", "type": "string" }, "ItAssetsAssetIdCollectPostResponsesContentApplicationJsonSchemaDataActionsReuseOwnAssetFromOwnLocationStatus": { "description": "Whether the action is currently available for this asset", "enum": [ "DISABLED", "ENABLED", "NOT_APPLICABLE" ], "title": "ItAssetsAssetIdCollectPostResponsesContentApplicationJsonSchemaDataActionsReuseOwnAssetFromOwnLocationStatus", "type": "string" }, "ItAssetsAssetIdCollectPostResponsesContentApplicationJsonSchemaDataActionsStoreOwnAssetAtDeelForHub": { "description": "Store an organization-owned asset at a Deel hub warehouse", "properties": { "details": { "description": "Action-specific context needed to perform the action. Populated for enabled and\ndisabled actions (so callers can see what a successful attempt would look like);\nnull when the action is not applicable to this asset.", "oneOf": [ { "$ref": "#/components/schemas/ItAssetsAssetIdCollectPostResponsesContentApplicationJsonSchemaDataActionsStoreOwnAssetAtDeelForHubDetails" }, { "type": "null" } ] }, "disabled_reasons": { "description": "Reasons why the action is disabled. Empty when the action is enabled or not applicable", "items": { "$ref": "#/components/schemas/ItAssetsAssetIdCollectPostResponsesContentApplicationJsonSchemaDataActionsStoreOwnAssetAtDeelForHubDisabledReasonsItems" }, "type": "array" }, "status": { "$ref": "#/components/schemas/ItAssetsAssetIdCollectPostResponsesContentApplicationJsonSchemaDataActionsStoreOwnAssetAtDeelForHubStatus", "description": "Whether the action is currently available for this asset" } }, "required": [ "status", "details", "disabled_reasons" ], "title": "ItAssetsAssetIdCollectPostResponsesContentApplicationJsonSchemaDataActionsStoreOwnAssetAtDeelForHub", "type": "object" }, "ItAssetsAssetIdCollectPostResponsesContentApplicationJsonSchemaDataActionsStoreOwnAssetAtDeelForHubDetails": { "description": "Action-specific context needed to perform the action. Populated for enabled and\ndisabled actions (so callers can see what a successful attempt would look like);\nnull when the action is not applicable to this asset.", "properties": { "activation_cost": { "$ref": "#/components/schemas/ItAssetsAssetIdCollectPostResponsesContentApplicationJsonSchemaDataActionsStoreOwnAssetAtDeelForHubDetailsActivationCost", "description": "Cost charged to activate storage" }, "destination_country": { "$ref": "#/components/schemas/ItAssetsAssetIdCollectPostResponsesContentApplicationJsonSchemaDataActionsStoreOwnAssetAtDeelForHubDetailsDestinationCountry", "description": "ISO 3166-1 alpha-2 country of the Deel warehouse the asset will be shipped to" }, "grace_period_in_months": { "description": "Grace period in months during which storage is free before monthly fees apply", "format": "int64", "type": "integer" }, "monthly_fee": { "$ref": "#/components/schemas/ItAssetsAssetIdCollectPostResponsesContentApplicationJsonSchemaDataActionsStoreOwnAssetAtDeelForHubDetailsMonthlyFee", "description": "Monthly storage fee charged after the grace period" } }, "required": [ "monthly_fee", "activation_cost", "destination_country", "grace_period_in_months" ], "title": "ItAssetsAssetIdCollectPostResponsesContentApplicationJsonSchemaDataActionsStoreOwnAssetAtDeelForHubDetails", "type": "object" }, "ItAssetsAssetIdCollectPostResponsesContentApplicationJsonSchemaDataActionsStoreOwnAssetAtDeelForHubDetailsActivationCost": { "description": "Cost charged to activate storage", "properties": { "billing_method": { "$ref": "#/components/schemas/ItAssetsAssetIdCollectPostResponsesContentApplicationJsonSchemaDataActionsStoreOwnAssetAtDeelForHubDetailsActivationCostBillingMethod", "description": "How the action is charged. When \"TOKEN\", the fees are covered by an\nadd-on token pool; when \"CURRENCY\", the fees are billed in the currency\nspecified in the \"fees\" field." }, "fees": { "description": "Price charged for the action. Null when billing method is \"TOKEN\"", "oneOf": [ { "$ref": "#/components/schemas/ItAssetsAssetIdCollectPostResponsesContentApplicationJsonSchemaDataActionsStoreOwnAssetAtDeelForHubDetailsActivationCostFees" }, { "type": "null" } ] }, "token_usage": { "description": "Add-on token consumption details. Null when billing method is \"CURRENCY\"", "oneOf": [ { "$ref": "#/components/schemas/ItAssetsAssetIdCollectPostResponsesContentApplicationJsonSchemaDataActionsStoreOwnAssetAtDeelForHubDetailsActivationCostTokenUsage" }, { "type": "null" } ] } }, "required": [ "fees", "token_usage", "billing_method" ], "title": "ItAssetsAssetIdCollectPostResponsesContentApplicationJsonSchemaDataActionsStoreOwnAssetAtDeelForHubDetailsActivationCost", "type": "object" }, "ItAssetsAssetIdCollectPostResponsesContentApplicationJsonSchemaDataActionsStoreOwnAssetAtDeelForHubDetailsActivationCostBillingMethod": { "description": "How the action is charged. When \"TOKEN\", the fees are covered by an\nadd-on token pool; when \"CURRENCY\", the fees are billed in the currency\nspecified in the \"fees\" field.", "enum": [ "CURRENCY", "TOKEN" ], "title": "ItAssetsAssetIdCollectPostResponsesContentApplicationJsonSchemaDataActionsStoreOwnAssetAtDeelForHubDetailsActivationCostBillingMethod", "type": "string" }, "ItAssetsAssetIdCollectPostResponsesContentApplicationJsonSchemaDataActionsStoreOwnAssetAtDeelForHubDetailsActivationCostFees": { "description": "Price charged for the action. Null when billing method is \"TOKEN\"", "properties": { "amount": { "description": "Amount", "format": "decimal", "type": "string" }, "currency": { "$ref": "#/components/schemas/ItAssetsAssetIdCollectPostResponsesContentApplicationJsonSchemaDataActionsStoreOwnAssetAtDeelForHubDetailsActivationCostFeesCurrency", "description": "Three-letter currency code for the price" } }, "required": [ "amount", "currency" ], "title": "ItAssetsAssetIdCollectPostResponsesContentApplicationJsonSchemaDataActionsStoreOwnAssetAtDeelForHubDetailsActivationCostFees", "type": "object" }, "ItAssetsAssetIdCollectPostResponsesContentApplicationJsonSchemaDataActionsStoreOwnAssetAtDeelForHubDetailsActivationCostFeesCurrency": { "description": "Three-letter currency code for the price", "enum": [ "AED", "AFN", "ALL", "AMD", "ANG", "AOA", "ARS", "AUD", "AWG", "AZN", "BAM", "BDT", "BGN", "BHD", "BIF", "BMD", "BOB", "BRL", "BSD", "BTN", "BWP", "BYN", "BZD", "CAD", "CDF", "CHF", "CLP", "CNY", "COP", "CRC", "CUC", "CVE", "CZK", "DJF", "DKK", "DOP", "DZD", "EGP", "ERN", "ETB", "EUR", "FJD", "FKP", "GBP", "GEL", "GHS", "GIP", "GMD", "GNF", "GTQ", "GYD", "HKD", "HNL", "HRK", "HTG", "HUF", "IDR", "ILS", "INR", "IQD", "IRR", "ISK", "JMD", "JOD", "JPY", "KES", "KGS", "KHR", "KMF", "KPW", "KRW", "KWD", "KYD", "KZT", "LAK", "LBP", "LKR", "LRD", "LSL", "LTL", "LYD", "MAD", "MDL", "MGA", "MKD", "MMK", "MNT", "MRU", "MUR", "MVR", "MWK", "MXN", "MYR", "MZN", "NAD", "NGN", "NIO", "NOK", "NPR", "NZD", "OMR", "PAB", "PEN", "PGK", "PHP", "PKR", "PLN", "PYG", "QAR", "RON", "RSD", "RUB", "RWF", "SAR", "SBD", "SCR", "SDG", "SEK", "SGD", "SHP", "SLL", "SOS", "SRD", "SSP", "STD", "SYP", "SZL", "THB", "TJS", "TMT", "TND", "TOP", "TRY", "TTD", "TWD", "TZS", "UAH", "UGX", "USD", "UYU", "UZS", "VEF", "VND", "VUV", "WST", "XAF", "XCD", "XOF", "XPF", "YER", "ZAR", "ZMW", "ZWD" ], "title": "ItAssetsAssetIdCollectPostResponsesContentApplicationJsonSchemaDataActionsStoreOwnAssetAtDeelForHubDetailsActivationCostFeesCurrency", "type": "string" }, "ItAssetsAssetIdCollectPostResponsesContentApplicationJsonSchemaDataActionsStoreOwnAssetAtDeelForHubDetailsActivationCostTokenUsage": { "description": "Add-on token consumption details. Null when billing method is \"CURRENCY\"", "properties": { "addon": { "$ref": "#/components/schemas/ItAssetsAssetIdCollectPostResponsesContentApplicationJsonSchemaDataActionsStoreOwnAssetAtDeelForHubDetailsActivationCostTokenUsageAddon", "description": "The add-on that provides the tokens" }, "cost": { "description": "Number of tokens consumed by the action. Zero when the add-on covers the\nservice without drawing from a token pool", "format": "decimal", "type": "string" }, "tokens_left": { "description": "Number of tokens left in the pool after the action is performed. Null when\nthe add-on covers the service without a token pool", "format": "decimal", "type": [ "string", "null" ] } }, "required": [ "cost", "addon", "tokens_left" ], "title": "ItAssetsAssetIdCollectPostResponsesContentApplicationJsonSchemaDataActionsStoreOwnAssetAtDeelForHubDetailsActivationCostTokenUsage", "type": "object" }, "ItAssetsAssetIdCollectPostResponsesContentApplicationJsonSchemaDataActionsStoreOwnAssetAtDeelForHubDetailsActivationCostTokenUsageAddon": { "description": "The add-on that provides the tokens", "properties": { "id": { "description": "ID of the add-on", "format": "uuid", "type": "string" }, "name": { "description": "Public display name of the add-on", "type": "string" } }, "required": [ "id", "name" ], "title": "ItAssetsAssetIdCollectPostResponsesContentApplicationJsonSchemaDataActionsStoreOwnAssetAtDeelForHubDetailsActivationCostTokenUsageAddon", "type": "object" }, "ItAssetsAssetIdCollectPostResponsesContentApplicationJsonSchemaDataActionsStoreOwnAssetAtDeelForHubDetailsDestinationCountry": { "description": "ISO 3166-1 alpha-2 country of the Deel warehouse the asset will be shipped to", "enum": [ "AD", "AE", "AF", "AG", "AI", "AL", "AM", "AN", "AO", "AQ", "AR", "AS", "AT", "AU", "AW", "AX", "AZ", "BA", "BB", "BD", "BE", "BF", "BG", "BH", "BI", "BJ", "BL", "BM", "BN", "BO", "BQ", "BR", "BS", "BT", "BV", "BW", "BY", "BZ", "CA", "CC", "CD", "CF", "CG", "CH", "CI", "CK", "CL", "CM", "CN", "CO", "CR", "CU", "CV", "CW", "CX", "CY", "CZ", "DE", "DJ", "DK", "DM", "DO", "DZ", "EC", "EE", "EG", "EH", "ER", "ES", "ET", "FI", "FJ", "FK", "FM", "FO", "FR", "GA", "GB", "GD", "GE", "GF", "GG", "GH", "GI", "GL", "GM", "GN", "GP", "GQ", "GR", "GS", "GT", "GU", "GW", "GY", "HK", "HM", "HN", "HR", "HT", "HU", "IC", "ID", "IE", "IL", "IM", "IN", "IO", "IQ", "IR", "IS", "IT", "JE", "JM", "JO", "JP", "KE", "KG", "KH", "KI", "KM", "KN", "KP", "KR", "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", "XK", "YE", "YT", "ZA", "ZM", "ZW" ], "title": "ItAssetsAssetIdCollectPostResponsesContentApplicationJsonSchemaDataActionsStoreOwnAssetAtDeelForHubDetailsDestinationCountry", "type": "string" }, "ItAssetsAssetIdCollectPostResponsesContentApplicationJsonSchemaDataActionsStoreOwnAssetAtDeelForHubDetailsMonthlyFee": { "description": "Monthly storage fee charged after the grace period", "properties": { "amount": { "description": "Amount", "format": "decimal", "type": "string" }, "currency": { "$ref": "#/components/schemas/ItAssetsAssetIdCollectPostResponsesContentApplicationJsonSchemaDataActionsStoreOwnAssetAtDeelForHubDetailsMonthlyFeeCurrency", "description": "Three-letter currency code for the price" } }, "required": [ "amount", "currency" ], "title": "ItAssetsAssetIdCollectPostResponsesContentApplicationJsonSchemaDataActionsStoreOwnAssetAtDeelForHubDetailsMonthlyFee", "type": "object" }, "ItAssetsAssetIdCollectPostResponsesContentApplicationJsonSchemaDataActionsStoreOwnAssetAtDeelForHubDetailsMonthlyFeeCurrency": { "description": "Three-letter currency code for the price", "enum": [ "AED", "AFN", "ALL", "AMD", "ANG", "AOA", "ARS", "AUD", "AWG", "AZN", "BAM", "BDT", "BGN", "BHD", "BIF", "BMD", "BOB", "BRL", "BSD", "BTN", "BWP", "BYN", "BZD", "CAD", "CDF", "CHF", "CLP", "CNY", "COP", "CRC", "CUC", "CVE", "CZK", "DJF", "DKK", "DOP", "DZD", "EGP", "ERN", "ETB", "EUR", "FJD", "FKP", "GBP", "GEL", "GHS", "GIP", "GMD", "GNF", "GTQ", "GYD", "HKD", "HNL", "HRK", "HTG", "HUF", "IDR", "ILS", "INR", "IQD", "IRR", "ISK", "JMD", "JOD", "JPY", "KES", "KGS", "KHR", "KMF", "KPW", "KRW", "KWD", "KYD", "KZT", "LAK", "LBP", "LKR", "LRD", "LSL", "LTL", "LYD", "MAD", "MDL", "MGA", "MKD", "MMK", "MNT", "MRU", "MUR", "MVR", "MWK", "MXN", "MYR", "MZN", "NAD", "NGN", "NIO", "NOK", "NPR", "NZD", "OMR", "PAB", "PEN", "PGK", "PHP", "PKR", "PLN", "PYG", "QAR", "RON", "RSD", "RUB", "RWF", "SAR", "SBD", "SCR", "SDG", "SEK", "SGD", "SHP", "SLL", "SOS", "SRD", "SSP", "STD", "SYP", "SZL", "THB", "TJS", "TMT", "TND", "TOP", "TRY", "TTD", "TWD", "TZS", "UAH", "UGX", "USD", "UYU", "UZS", "VEF", "VND", "VUV", "WST", "XAF", "XCD", "XOF", "XPF", "YER", "ZAR", "ZMW", "ZWD" ], "title": "ItAssetsAssetIdCollectPostResponsesContentApplicationJsonSchemaDataActionsStoreOwnAssetAtDeelForHubDetailsMonthlyFeeCurrency", "type": "string" }, "ItAssetsAssetIdCollectPostResponsesContentApplicationJsonSchemaDataActionsStoreOwnAssetAtDeelForHubDisabledReasonsItems": { "enum": [ "ARCHIVED", "AT_DEEL_WAREHOUSE", "BEING_REPAIRED", "CONSUMABLE", "CONTROLLED_BY_DEEL", "COUNTRY_NOT_SUPPORTED_FOR_HUB", "COUNTRY_NOT_SUPPORTED_FOR_LOCAL", "DEEL_OWNED_ITEM_WITHOUT_RENTAL_CONTRACT", "DESKTOP_STORAGE", "ENDING_CONTRACT", "HUB_IN_SAME_REGION_AS_LOCAL", "INACTIVE", "INVALID_ITEM_LOCATION", "INVALID_ORGANIZATION_STATUS", "INVALID_STATE", "ITEM_CONDITIONS_TO_UNARCHIVE_NOT_MET", "ITEM_NOT_VISIBLE_FOR_ORGANIZATION", "NON_DEVICE", "NOT_AT_WAREHOUSE", "NOT_AVAILABLE_FOR_REUSE", "NOT_A_RENTAL", "NOT_MANAGEABLE_BY_ORGANIZATION", "NOT_WITH_ASSIGNMENT", "NOT_WITH_USER", "NO_ACTIVE_ADDONS", "NO_ACTIVE_STORAGE_CONTRACT", "NO_LOCATION_FOR_STORAGE", "NO_LOGISTICS_FOR_STORAGE", "NO_VALID_ADDONS", "ONGOING_SERVICE", "OWNED_BY_DEEL", "OWNED_BY_ORGANIZATION", "OWNED_BY_PARTNER_ORGANIZATION", "PARTNER_CHILD_CONTRACT", "PENDING_DEVICE_REFRESH", "RENTAL_CONTRACT_AND_USER_REGION_DO_NOT_MATCH", "TEMPORARILY_UNAVAILABLE", "UNKNOWN", "USER_HAS_NO_COUNTRY", "USER_HAS_NO_SEAT", "WAITING_FOR_CLEARANCE", "WITH_LOANER_ASSIGNMENT", "WITH_NON_COLLECTED_ASSIGNMENT", "WITH_NON_DELIVERED_ASSIGNMENT", "WITH_PENDING_ASSIGNMENT", "WRONG_ASSIGNMENT_STATUS", "WRONG_CONTRACT_STATUS", "WRONG_TERMS_AND_CONDITIONS" ], "title": "ItAssetsAssetIdCollectPostResponsesContentApplicationJsonSchemaDataActionsStoreOwnAssetAtDeelForHubDisabledReasonsItems", "type": "string" }, "ItAssetsAssetIdCollectPostResponsesContentApplicationJsonSchemaDataActionsStoreOwnAssetAtDeelForHubStatus": { "description": "Whether the action is currently available for this asset", "enum": [ "DISABLED", "ENABLED", "NOT_APPLICABLE" ], "title": "ItAssetsAssetIdCollectPostResponsesContentApplicationJsonSchemaDataActionsStoreOwnAssetAtDeelForHubStatus", "type": "string" }, "ItAssetsAssetIdCollectPostResponsesContentApplicationJsonSchemaDataActionsStoreOwnAssetAtDeelForLocal": { "description": "Store an organization-owned asset at a Deel local warehouse", "properties": { "details": { "description": "Action-specific context needed to perform the action. Populated for enabled and\ndisabled actions (so callers can see what a successful attempt would look like);\nnull when the action is not applicable to this asset.", "oneOf": [ { "$ref": "#/components/schemas/ItAssetsAssetIdCollectPostResponsesContentApplicationJsonSchemaDataActionsStoreOwnAssetAtDeelForLocalDetails" }, { "type": "null" } ] }, "disabled_reasons": { "description": "Reasons why the action is disabled. Empty when the action is enabled or not applicable", "items": { "$ref": "#/components/schemas/ItAssetsAssetIdCollectPostResponsesContentApplicationJsonSchemaDataActionsStoreOwnAssetAtDeelForLocalDisabledReasonsItems" }, "type": "array" }, "status": { "$ref": "#/components/schemas/ItAssetsAssetIdCollectPostResponsesContentApplicationJsonSchemaDataActionsStoreOwnAssetAtDeelForLocalStatus", "description": "Whether the action is currently available for this asset" } }, "required": [ "status", "details", "disabled_reasons" ], "title": "ItAssetsAssetIdCollectPostResponsesContentApplicationJsonSchemaDataActionsStoreOwnAssetAtDeelForLocal", "type": "object" }, "ItAssetsAssetIdCollectPostResponsesContentApplicationJsonSchemaDataActionsStoreOwnAssetAtDeelForLocalDetails": { "description": "Action-specific context needed to perform the action. Populated for enabled and\ndisabled actions (so callers can see what a successful attempt would look like);\nnull when the action is not applicable to this asset.", "properties": { "activation_cost": { "$ref": "#/components/schemas/ItAssetsAssetIdCollectPostResponsesContentApplicationJsonSchemaDataActionsStoreOwnAssetAtDeelForLocalDetailsActivationCost", "description": "Cost charged to activate storage" }, "destination_country": { "$ref": "#/components/schemas/ItAssetsAssetIdCollectPostResponsesContentApplicationJsonSchemaDataActionsStoreOwnAssetAtDeelForLocalDetailsDestinationCountry", "description": "ISO 3166-1 alpha-2 country of the Deel warehouse the asset will be shipped to" }, "grace_period_in_months": { "description": "Grace period in months during which storage is free before monthly fees apply", "format": "int64", "type": "integer" }, "monthly_fee": { "$ref": "#/components/schemas/ItAssetsAssetIdCollectPostResponsesContentApplicationJsonSchemaDataActionsStoreOwnAssetAtDeelForLocalDetailsMonthlyFee", "description": "Monthly storage fee charged after the grace period" } }, "required": [ "monthly_fee", "activation_cost", "destination_country", "grace_period_in_months" ], "title": "ItAssetsAssetIdCollectPostResponsesContentApplicationJsonSchemaDataActionsStoreOwnAssetAtDeelForLocalDetails", "type": "object" }, "ItAssetsAssetIdCollectPostResponsesContentApplicationJsonSchemaDataActionsStoreOwnAssetAtDeelForLocalDetailsActivationCost": { "description": "Cost charged to activate storage", "properties": { "billing_method": { "$ref": "#/components/schemas/ItAssetsAssetIdCollectPostResponsesContentApplicationJsonSchemaDataActionsStoreOwnAssetAtDeelForLocalDetailsActivationCostBillingMethod", "description": "How the action is charged. When \"TOKEN\", the fees are covered by an\nadd-on token pool; when \"CURRENCY\", the fees are billed in the currency\nspecified in the \"fees\" field." }, "fees": { "description": "Price charged for the action. Null when billing method is \"TOKEN\"", "oneOf": [ { "$ref": "#/components/schemas/ItAssetsAssetIdCollectPostResponsesContentApplicationJsonSchemaDataActionsStoreOwnAssetAtDeelForLocalDetailsActivationCostFees" }, { "type": "null" } ] }, "token_usage": { "description": "Add-on token consumption details. Null when billing method is \"CURRENCY\"", "oneOf": [ { "$ref": "#/components/schemas/ItAssetsAssetIdCollectPostResponsesContentApplicationJsonSchemaDataActionsStoreOwnAssetAtDeelForLocalDetailsActivationCostTokenUsage" }, { "type": "null" } ] } }, "required": [ "fees", "token_usage", "billing_method" ], "title": "ItAssetsAssetIdCollectPostResponsesContentApplicationJsonSchemaDataActionsStoreOwnAssetAtDeelForLocalDetailsActivationCost", "type": "object" }, "ItAssetsAssetIdCollectPostResponsesContentApplicationJsonSchemaDataActionsStoreOwnAssetAtDeelForLocalDetailsActivationCostBillingMethod": { "description": "How the action is charged. When \"TOKEN\", the fees are covered by an\nadd-on token pool; when \"CURRENCY\", the fees are billed in the currency\nspecified in the \"fees\" field.", "enum": [ "CURRENCY", "TOKEN" ], "title": "ItAssetsAssetIdCollectPostResponsesContentApplicationJsonSchemaDataActionsStoreOwnAssetAtDeelForLocalDetailsActivationCostBillingMethod", "type": "string" }, "ItAssetsAssetIdCollectPostResponsesContentApplicationJsonSchemaDataActionsStoreOwnAssetAtDeelForLocalDetailsActivationCostFees": { "description": "Price charged for the action. Null when billing method is \"TOKEN\"", "properties": { "amount": { "description": "Amount", "format": "decimal", "type": "string" }, "currency": { "$ref": "#/components/schemas/ItAssetsAssetIdCollectPostResponsesContentApplicationJsonSchemaDataActionsStoreOwnAssetAtDeelForLocalDetailsActivationCostFeesCurrency", "description": "Three-letter currency code for the price" } }, "required": [ "amount", "currency" ], "title": "ItAssetsAssetIdCollectPostResponsesContentApplicationJsonSchemaDataActionsStoreOwnAssetAtDeelForLocalDetailsActivationCostFees", "type": "object" }, "ItAssetsAssetIdCollectPostResponsesContentApplicationJsonSchemaDataActionsStoreOwnAssetAtDeelForLocalDetailsActivationCostFeesCurrency": { "description": "Three-letter currency code for the price", "enum": [ "AED", "AFN", "ALL", "AMD", "ANG", "AOA", "ARS", "AUD", "AWG", "AZN", "BAM", "BDT", "BGN", "BHD", "BIF", "BMD", "BOB", "BRL", "BSD", "BTN", "BWP", "BYN", "BZD", "CAD", "CDF", "CHF", "CLP", "CNY", "COP", "CRC", "CUC", "CVE", "CZK", "DJF", "DKK", "DOP", "DZD", "EGP", "ERN", "ETB", "EUR", "FJD", "FKP", "GBP", "GEL", "GHS", "GIP", "GMD", "GNF", "GTQ", "GYD", "HKD", "HNL", "HRK", "HTG", "HUF", "IDR", "ILS", "INR", "IQD", "IRR", "ISK", "JMD", "JOD", "JPY", "KES", "KGS", "KHR", "KMF", "KPW", "KRW", "KWD", "KYD", "KZT", "LAK", "LBP", "LKR", "LRD", "LSL", "LTL", "LYD", "MAD", "MDL", "MGA", "MKD", "MMK", "MNT", "MRU", "MUR", "MVR", "MWK", "MXN", "MYR", "MZN", "NAD", "NGN", "NIO", "NOK", "NPR", "NZD", "OMR", "PAB", "PEN", "PGK", "PHP", "PKR", "PLN", "PYG", "QAR", "RON", "RSD", "RUB", "RWF", "SAR", "SBD", "SCR", "SDG", "SEK", "SGD", "SHP", "SLL", "SOS", "SRD", "SSP", "STD", "SYP", "SZL", "THB", "TJS", "TMT", "TND", "TOP", "TRY", "TTD", "TWD", "TZS", "UAH", "UGX", "USD", "UYU", "UZS", "VEF", "VND", "VUV", "WST", "XAF", "XCD", "XOF", "XPF", "YER", "ZAR", "ZMW", "ZWD" ], "title": "ItAssetsAssetIdCollectPostResponsesContentApplicationJsonSchemaDataActionsStoreOwnAssetAtDeelForLocalDetailsActivationCostFeesCurrency", "type": "string" }, "ItAssetsAssetIdCollectPostResponsesContentApplicationJsonSchemaDataActionsStoreOwnAssetAtDeelForLocalDetailsActivationCostTokenUsage": { "description": "Add-on token consumption details. Null when billing method is \"CURRENCY\"", "properties": { "addon": { "$ref": "#/components/schemas/ItAssetsAssetIdCollectPostResponsesContentApplicationJsonSchemaDataActionsStoreOwnAssetAtDeelForLocalDetailsActivationCostTokenUsageAddon", "description": "The add-on that provides the tokens" }, "cost": { "description": "Number of tokens consumed by the action. Zero when the add-on covers the\nservice without drawing from a token pool", "format": "decimal", "type": "string" }, "tokens_left": { "description": "Number of tokens left in the pool after the action is performed. Null when\nthe add-on covers the service without a token pool", "format": "decimal", "type": [ "string", "null" ] } }, "required": [ "cost", "addon", "tokens_left" ], "title": "ItAssetsAssetIdCollectPostResponsesContentApplicationJsonSchemaDataActionsStoreOwnAssetAtDeelForLocalDetailsActivationCostTokenUsage", "type": "object" }, "ItAssetsAssetIdCollectPostResponsesContentApplicationJsonSchemaDataActionsStoreOwnAssetAtDeelForLocalDetailsActivationCostTokenUsageAddon": { "description": "The add-on that provides the tokens", "properties": { "id": { "description": "ID of the add-on", "format": "uuid", "type": "string" }, "name": { "description": "Public display name of the add-on", "type": "string" } }, "required": [ "id", "name" ], "title": "ItAssetsAssetIdCollectPostResponsesContentApplicationJsonSchemaDataActionsStoreOwnAssetAtDeelForLocalDetailsActivationCostTokenUsageAddon", "type": "object" }, "ItAssetsAssetIdCollectPostResponsesContentApplicationJsonSchemaDataActionsStoreOwnAssetAtDeelForLocalDetailsDestinationCountry": { "description": "ISO 3166-1 alpha-2 country of the Deel warehouse the asset will be shipped to", "enum": [ "AD", "AE", "AF", "AG", "AI", "AL", "AM", "AN", "AO", "AQ", "AR", "AS", "AT", "AU", "AW", "AX", "AZ", "BA", "BB", "BD", "BE", "BF", "BG", "BH", "BI", "BJ", "BL", "BM", "BN", "BO", "BQ", "BR", "BS", "BT", "BV", "BW", "BY", "BZ", "CA", "CC", "CD", "CF", "CG", "CH", "CI", "CK", "CL", "CM", "CN", "CO", "CR", "CU", "CV", "CW", "CX", "CY", "CZ", "DE", "DJ", "DK", "DM", "DO", "DZ", "EC", "EE", "EG", "EH", "ER", "ES", "ET", "FI", "FJ", "FK", "FM", "FO", "FR", "GA", "GB", "GD", "GE", "GF", "GG", "GH", "GI", "GL", "GM", "GN", "GP", "GQ", "GR", "GS", "GT", "GU", "GW", "GY", "HK", "HM", "HN", "HR", "HT", "HU", "IC", "ID", "IE", "IL", "IM", "IN", "IO", "IQ", "IR", "IS", "IT", "JE", "JM", "JO", "JP", "KE", "KG", "KH", "KI", "KM", "KN", "KP", "KR", "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", "XK", "YE", "YT", "ZA", "ZM", "ZW" ], "title": "ItAssetsAssetIdCollectPostResponsesContentApplicationJsonSchemaDataActionsStoreOwnAssetAtDeelForLocalDetailsDestinationCountry", "type": "string" }, "ItAssetsAssetIdCollectPostResponsesContentApplicationJsonSchemaDataActionsStoreOwnAssetAtDeelForLocalDetailsMonthlyFee": { "description": "Monthly storage fee charged after the grace period", "properties": { "amount": { "description": "Amount", "format": "decimal", "type": "string" }, "currency": { "$ref": "#/components/schemas/ItAssetsAssetIdCollectPostResponsesContentApplicationJsonSchemaDataActionsStoreOwnAssetAtDeelForLocalDetailsMonthlyFeeCurrency", "description": "Three-letter currency code for the price" } }, "required": [ "amount", "currency" ], "title": "ItAssetsAssetIdCollectPostResponsesContentApplicationJsonSchemaDataActionsStoreOwnAssetAtDeelForLocalDetailsMonthlyFee", "type": "object" }, "ItAssetsAssetIdCollectPostResponsesContentApplicationJsonSchemaDataActionsStoreOwnAssetAtDeelForLocalDetailsMonthlyFeeCurrency": { "description": "Three-letter currency code for the price", "enum": [ "AED", "AFN", "ALL", "AMD", "ANG", "AOA", "ARS", "AUD", "AWG", "AZN", "BAM", "BDT", "BGN", "BHD", "BIF", "BMD", "BOB", "BRL", "BSD", "BTN", "BWP", "BYN", "BZD", "CAD", "CDF", "CHF", "CLP", "CNY", "COP", "CRC", "CUC", "CVE", "CZK", "DJF", "DKK", "DOP", "DZD", "EGP", "ERN", "ETB", "EUR", "FJD", "FKP", "GBP", "GEL", "GHS", "GIP", "GMD", "GNF", "GTQ", "GYD", "HKD", "HNL", "HRK", "HTG", "HUF", "IDR", "ILS", "INR", "IQD", "IRR", "ISK", "JMD", "JOD", "JPY", "KES", "KGS", "KHR", "KMF", "KPW", "KRW", "KWD", "KYD", "KZT", "LAK", "LBP", "LKR", "LRD", "LSL", "LTL", "LYD", "MAD", "MDL", "MGA", "MKD", "MMK", "MNT", "MRU", "MUR", "MVR", "MWK", "MXN", "MYR", "MZN", "NAD", "NGN", "NIO", "NOK", "NPR", "NZD", "OMR", "PAB", "PEN", "PGK", "PHP", "PKR", "PLN", "PYG", "QAR", "RON", "RSD", "RUB", "RWF", "SAR", "SBD", "SCR", "SDG", "SEK", "SGD", "SHP", "SLL", "SOS", "SRD", "SSP", "STD", "SYP", "SZL", "THB", "TJS", "TMT", "TND", "TOP", "TRY", "TTD", "TWD", "TZS", "UAH", "UGX", "USD", "UYU", "UZS", "VEF", "VND", "VUV", "WST", "XAF", "XCD", "XOF", "XPF", "YER", "ZAR", "ZMW", "ZWD" ], "title": "ItAssetsAssetIdCollectPostResponsesContentApplicationJsonSchemaDataActionsStoreOwnAssetAtDeelForLocalDetailsMonthlyFeeCurrency", "type": "string" }, "ItAssetsAssetIdCollectPostResponsesContentApplicationJsonSchemaDataActionsStoreOwnAssetAtDeelForLocalDisabledReasonsItems": { "enum": [ "ARCHIVED", "AT_DEEL_WAREHOUSE", "BEING_REPAIRED", "CONSUMABLE", "CONTROLLED_BY_DEEL", "COUNTRY_NOT_SUPPORTED_FOR_HUB", "COUNTRY_NOT_SUPPORTED_FOR_LOCAL", "DEEL_OWNED_ITEM_WITHOUT_RENTAL_CONTRACT", "DESKTOP_STORAGE", "ENDING_CONTRACT", "HUB_IN_SAME_REGION_AS_LOCAL", "INACTIVE", "INVALID_ITEM_LOCATION", "INVALID_ORGANIZATION_STATUS", "INVALID_STATE", "ITEM_CONDITIONS_TO_UNARCHIVE_NOT_MET", "ITEM_NOT_VISIBLE_FOR_ORGANIZATION", "NON_DEVICE", "NOT_AT_WAREHOUSE", "NOT_AVAILABLE_FOR_REUSE", "NOT_A_RENTAL", "NOT_MANAGEABLE_BY_ORGANIZATION", "NOT_WITH_ASSIGNMENT", "NOT_WITH_USER", "NO_ACTIVE_ADDONS", "NO_ACTIVE_STORAGE_CONTRACT", "NO_LOCATION_FOR_STORAGE", "NO_LOGISTICS_FOR_STORAGE", "NO_VALID_ADDONS", "ONGOING_SERVICE", "OWNED_BY_DEEL", "OWNED_BY_ORGANIZATION", "OWNED_BY_PARTNER_ORGANIZATION", "PARTNER_CHILD_CONTRACT", "PENDING_DEVICE_REFRESH", "RENTAL_CONTRACT_AND_USER_REGION_DO_NOT_MATCH", "TEMPORARILY_UNAVAILABLE", "UNKNOWN", "USER_HAS_NO_COUNTRY", "USER_HAS_NO_SEAT", "WAITING_FOR_CLEARANCE", "WITH_LOANER_ASSIGNMENT", "WITH_NON_COLLECTED_ASSIGNMENT", "WITH_NON_DELIVERED_ASSIGNMENT", "WITH_PENDING_ASSIGNMENT", "WRONG_ASSIGNMENT_STATUS", "WRONG_CONTRACT_STATUS", "WRONG_TERMS_AND_CONDITIONS" ], "title": "ItAssetsAssetIdCollectPostResponsesContentApplicationJsonSchemaDataActionsStoreOwnAssetAtDeelForLocalDisabledReasonsItems", "type": "string" }, "ItAssetsAssetIdCollectPostResponsesContentApplicationJsonSchemaDataActionsStoreOwnAssetAtDeelForLocalStatus": { "description": "Whether the action is currently available for this asset", "enum": [ "DISABLED", "ENABLED", "NOT_APPLICABLE" ], "title": "ItAssetsAssetIdCollectPostResponsesContentApplicationJsonSchemaDataActionsStoreOwnAssetAtDeelForLocalStatus", "type": "string" }, "ItAssetsAssetIdCollectPostResponsesContentApplicationJsonSchemaDataActionsStoreOwnAssetAtOwnLocation": { "description": "Store an organization-owned asset at an organization-owned location", "properties": { "details": { "description": "Action-specific context needed to perform the action. Populated for enabled and\ndisabled actions (so callers can see what a successful attempt would look like);\nnull when the action is not applicable to this asset.", "oneOf": [ { "$ref": "#/components/schemas/ItAssetsAssetIdCollectPostResponsesContentApplicationJsonSchemaDataActionsStoreOwnAssetAtOwnLocationDetails" }, { "type": "null" } ] }, "disabled_reasons": { "description": "Reasons why the action is disabled. Empty when the action is enabled or not applicable", "items": { "$ref": "#/components/schemas/ItAssetsAssetIdCollectPostResponsesContentApplicationJsonSchemaDataActionsStoreOwnAssetAtOwnLocationDisabledReasonsItems" }, "type": "array" }, "status": { "$ref": "#/components/schemas/ItAssetsAssetIdCollectPostResponsesContentApplicationJsonSchemaDataActionsStoreOwnAssetAtOwnLocationStatus", "description": "Whether the action is currently available for this asset" } }, "required": [ "status", "details", "disabled_reasons" ], "title": "ItAssetsAssetIdCollectPostResponsesContentApplicationJsonSchemaDataActionsStoreOwnAssetAtOwnLocation", "type": "object" }, "ItAssetsAssetIdCollectPostResponsesContentApplicationJsonSchemaDataActionsStoreOwnAssetAtOwnLocationDetails": { "description": "Action-specific context needed to perform the action. Populated for enabled and\ndisabled actions (so callers can see what a successful attempt would look like);\nnull when the action is not applicable to this asset.", "properties": { "eligible_countries": { "description": "Countries where the asset can be stored at an organization-owned location", "items": { "$ref": "#/components/schemas/ItAssetsAssetIdCollectPostResponsesContentApplicationJsonSchemaDataActionsStoreOwnAssetAtOwnLocationDetailsEligibleCountriesItems" }, "type": "array" }, "service_cost": { "$ref": "#/components/schemas/ItAssetsAssetIdCollectPostResponsesContentApplicationJsonSchemaDataActionsStoreOwnAssetAtOwnLocationDetailsServiceCost", "description": "Cost charged for the transfer service" } }, "required": [ "service_cost", "eligible_countries" ], "title": "ItAssetsAssetIdCollectPostResponsesContentApplicationJsonSchemaDataActionsStoreOwnAssetAtOwnLocationDetails", "type": "object" }, "ItAssetsAssetIdCollectPostResponsesContentApplicationJsonSchemaDataActionsStoreOwnAssetAtOwnLocationDetailsEligibleCountriesItems": { "enum": [ "AD", "AE", "AF", "AG", "AI", "AL", "AM", "AN", "AO", "AQ", "AR", "AS", "AT", "AU", "AW", "AX", "AZ", "BA", "BB", "BD", "BE", "BF", "BG", "BH", "BI", "BJ", "BL", "BM", "BN", "BO", "BQ", "BR", "BS", "BT", "BV", "BW", "BY", "BZ", "CA", "CC", "CD", "CF", "CG", "CH", "CI", "CK", "CL", "CM", "CN", "CO", "CR", "CU", "CV", "CW", "CX", "CY", "CZ", "DE", "DJ", "DK", "DM", "DO", "DZ", "EC", "EE", "EG", "EH", "ER", "ES", "ET", "FI", "FJ", "FK", "FM", "FO", "FR", "GA", "GB", "GD", "GE", "GF", "GG", "GH", "GI", "GL", "GM", "GN", "GP", "GQ", "GR", "GS", "GT", "GU", "GW", "GY", "HK", "HM", "HN", "HR", "HT", "HU", "IC", "ID", "IE", "IL", "IM", "IN", "IO", "IQ", "IR", "IS", "IT", "JE", "JM", "JO", "JP", "KE", "KG", "KH", "KI", "KM", "KN", "KP", "KR", "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", "XK", "YE", "YT", "ZA", "ZM", "ZW" ], "title": "ItAssetsAssetIdCollectPostResponsesContentApplicationJsonSchemaDataActionsStoreOwnAssetAtOwnLocationDetailsEligibleCountriesItems", "type": "string" }, "ItAssetsAssetIdCollectPostResponsesContentApplicationJsonSchemaDataActionsStoreOwnAssetAtOwnLocationDetailsServiceCost": { "description": "Cost charged for the transfer service", "properties": { "billing_method": { "$ref": "#/components/schemas/ItAssetsAssetIdCollectPostResponsesContentApplicationJsonSchemaDataActionsStoreOwnAssetAtOwnLocationDetailsServiceCostBillingMethod", "description": "How the action is charged. When \"TOKEN\", the fees are covered by an\nadd-on token pool; when \"CURRENCY\", the fees are billed in the currency\nspecified in the \"fees\" field." }, "fees": { "description": "Price charged for the action. Null when billing method is \"TOKEN\"", "oneOf": [ { "$ref": "#/components/schemas/ItAssetsAssetIdCollectPostResponsesContentApplicationJsonSchemaDataActionsStoreOwnAssetAtOwnLocationDetailsServiceCostFees" }, { "type": "null" } ] }, "token_usage": { "description": "Add-on token consumption details. Null when billing method is \"CURRENCY\"", "oneOf": [ { "$ref": "#/components/schemas/ItAssetsAssetIdCollectPostResponsesContentApplicationJsonSchemaDataActionsStoreOwnAssetAtOwnLocationDetailsServiceCostTokenUsage" }, { "type": "null" } ] } }, "required": [ "fees", "token_usage", "billing_method" ], "title": "ItAssetsAssetIdCollectPostResponsesContentApplicationJsonSchemaDataActionsStoreOwnAssetAtOwnLocationDetailsServiceCost", "type": "object" }, "ItAssetsAssetIdCollectPostResponsesContentApplicationJsonSchemaDataActionsStoreOwnAssetAtOwnLocationDetailsServiceCostBillingMethod": { "description": "How the action is charged. When \"TOKEN\", the fees are covered by an\nadd-on token pool; when \"CURRENCY\", the fees are billed in the currency\nspecified in the \"fees\" field.", "enum": [ "CURRENCY", "TOKEN" ], "title": "ItAssetsAssetIdCollectPostResponsesContentApplicationJsonSchemaDataActionsStoreOwnAssetAtOwnLocationDetailsServiceCostBillingMethod", "type": "string" }, "ItAssetsAssetIdCollectPostResponsesContentApplicationJsonSchemaDataActionsStoreOwnAssetAtOwnLocationDetailsServiceCostFees": { "description": "Price charged for the action. Null when billing method is \"TOKEN\"", "properties": { "amount": { "description": "Amount", "format": "decimal", "type": "string" }, "currency": { "$ref": "#/components/schemas/ItAssetsAssetIdCollectPostResponsesContentApplicationJsonSchemaDataActionsStoreOwnAssetAtOwnLocationDetailsServiceCostFeesCurrency", "description": "Three-letter currency code for the price" } }, "required": [ "amount", "currency" ], "title": "ItAssetsAssetIdCollectPostResponsesContentApplicationJsonSchemaDataActionsStoreOwnAssetAtOwnLocationDetailsServiceCostFees", "type": "object" }, "ItAssetsAssetIdCollectPostResponsesContentApplicationJsonSchemaDataActionsStoreOwnAssetAtOwnLocationDetailsServiceCostFeesCurrency": { "description": "Three-letter currency code for the price", "enum": [ "AED", "AFN", "ALL", "AMD", "ANG", "AOA", "ARS", "AUD", "AWG", "AZN", "BAM", "BDT", "BGN", "BHD", "BIF", "BMD", "BOB", "BRL", "BSD", "BTN", "BWP", "BYN", "BZD", "CAD", "CDF", "CHF", "CLP", "CNY", "COP", "CRC", "CUC", "CVE", "CZK", "DJF", "DKK", "DOP", "DZD", "EGP", "ERN", "ETB", "EUR", "FJD", "FKP", "GBP", "GEL", "GHS", "GIP", "GMD", "GNF", "GTQ", "GYD", "HKD", "HNL", "HRK", "HTG", "HUF", "IDR", "ILS", "INR", "IQD", "IRR", "ISK", "JMD", "JOD", "JPY", "KES", "KGS", "KHR", "KMF", "KPW", "KRW", "KWD", "KYD", "KZT", "LAK", "LBP", "LKR", "LRD", "LSL", "LTL", "LYD", "MAD", "MDL", "MGA", "MKD", "MMK", "MNT", "MRU", "MUR", "MVR", "MWK", "MXN", "MYR", "MZN", "NAD", "NGN", "NIO", "NOK", "NPR", "NZD", "OMR", "PAB", "PEN", "PGK", "PHP", "PKR", "PLN", "PYG", "QAR", "RON", "RSD", "RUB", "RWF", "SAR", "SBD", "SCR", "SDG", "SEK", "SGD", "SHP", "SLL", "SOS", "SRD", "SSP", "STD", "SYP", "SZL", "THB", "TJS", "TMT", "TND", "TOP", "TRY", "TTD", "TWD", "TZS", "UAH", "UGX", "USD", "UYU", "UZS", "VEF", "VND", "VUV", "WST", "XAF", "XCD", "XOF", "XPF", "YER", "ZAR", "ZMW", "ZWD" ], "title": "ItAssetsAssetIdCollectPostResponsesContentApplicationJsonSchemaDataActionsStoreOwnAssetAtOwnLocationDetailsServiceCostFeesCurrency", "type": "string" }, "ItAssetsAssetIdCollectPostResponsesContentApplicationJsonSchemaDataActionsStoreOwnAssetAtOwnLocationDetailsServiceCostTokenUsage": { "description": "Add-on token consumption details. Null when billing method is \"CURRENCY\"", "properties": { "addon": { "$ref": "#/components/schemas/ItAssetsAssetIdCollectPostResponsesContentApplicationJsonSchemaDataActionsStoreOwnAssetAtOwnLocationDetailsServiceCostTokenUsageAddon", "description": "The add-on that provides the tokens" }, "cost": { "description": "Number of tokens consumed by the action. Zero when the add-on covers the\nservice without drawing from a token pool", "format": "decimal", "type": "string" }, "tokens_left": { "description": "Number of tokens left in the pool after the action is performed. Null when\nthe add-on covers the service without a token pool", "format": "decimal", "type": [ "string", "null" ] } }, "required": [ "cost", "addon", "tokens_left" ], "title": "ItAssetsAssetIdCollectPostResponsesContentApplicationJsonSchemaDataActionsStoreOwnAssetAtOwnLocationDetailsServiceCostTokenUsage", "type": "object" }, "ItAssetsAssetIdCollectPostResponsesContentApplicationJsonSchemaDataActionsStoreOwnAssetAtOwnLocationDetailsServiceCostTokenUsageAddon": { "description": "The add-on that provides the tokens", "properties": { "id": { "description": "ID of the add-on", "format": "uuid", "type": "string" }, "name": { "description": "Public display name of the add-on", "type": "string" } }, "required": [ "id", "name" ], "title": "ItAssetsAssetIdCollectPostResponsesContentApplicationJsonSchemaDataActionsStoreOwnAssetAtOwnLocationDetailsServiceCostTokenUsageAddon", "type": "object" }, "ItAssetsAssetIdCollectPostResponsesContentApplicationJsonSchemaDataActionsStoreOwnAssetAtOwnLocationDisabledReasonsItems": { "enum": [ "ARCHIVED", "AT_DEEL_WAREHOUSE", "BEING_REPAIRED", "CONSUMABLE", "CONTROLLED_BY_DEEL", "COUNTRY_NOT_SUPPORTED_FOR_HUB", "COUNTRY_NOT_SUPPORTED_FOR_LOCAL", "DEEL_OWNED_ITEM_WITHOUT_RENTAL_CONTRACT", "DESKTOP_STORAGE", "ENDING_CONTRACT", "HUB_IN_SAME_REGION_AS_LOCAL", "INACTIVE", "INVALID_ITEM_LOCATION", "INVALID_ORGANIZATION_STATUS", "INVALID_STATE", "ITEM_CONDITIONS_TO_UNARCHIVE_NOT_MET", "ITEM_NOT_VISIBLE_FOR_ORGANIZATION", "NON_DEVICE", "NOT_AT_WAREHOUSE", "NOT_AVAILABLE_FOR_REUSE", "NOT_A_RENTAL", "NOT_MANAGEABLE_BY_ORGANIZATION", "NOT_WITH_ASSIGNMENT", "NOT_WITH_USER", "NO_ACTIVE_ADDONS", "NO_ACTIVE_STORAGE_CONTRACT", "NO_LOCATION_FOR_STORAGE", "NO_LOGISTICS_FOR_STORAGE", "NO_VALID_ADDONS", "ONGOING_SERVICE", "OWNED_BY_DEEL", "OWNED_BY_ORGANIZATION", "OWNED_BY_PARTNER_ORGANIZATION", "PARTNER_CHILD_CONTRACT", "PENDING_DEVICE_REFRESH", "RENTAL_CONTRACT_AND_USER_REGION_DO_NOT_MATCH", "TEMPORARILY_UNAVAILABLE", "UNKNOWN", "USER_HAS_NO_COUNTRY", "USER_HAS_NO_SEAT", "WAITING_FOR_CLEARANCE", "WITH_LOANER_ASSIGNMENT", "WITH_NON_COLLECTED_ASSIGNMENT", "WITH_NON_DELIVERED_ASSIGNMENT", "WITH_PENDING_ASSIGNMENT", "WRONG_ASSIGNMENT_STATUS", "WRONG_CONTRACT_STATUS", "WRONG_TERMS_AND_CONDITIONS" ], "title": "ItAssetsAssetIdCollectPostResponsesContentApplicationJsonSchemaDataActionsStoreOwnAssetAtOwnLocationDisabledReasonsItems", "type": "string" }, "ItAssetsAssetIdCollectPostResponsesContentApplicationJsonSchemaDataActionsStoreOwnAssetAtOwnLocationStatus": { "description": "Whether the action is currently available for this asset", "enum": [ "DISABLED", "ENABLED", "NOT_APPLICABLE" ], "title": "ItAssetsAssetIdCollectPostResponsesContentApplicationJsonSchemaDataActionsStoreOwnAssetAtOwnLocationStatus", "type": "string" }, "ItAssetsAssetIdCollectPostResponsesContentApplicationJsonSchemaDataActionsStoreRentalAtDeelForLocal": { "description": "Store a Deel-owned rental asset at a Deel local warehouse", "properties": { "details": { "description": "Action-specific context needed to perform the action. Populated for enabled and\ndisabled actions (so callers can see what a successful attempt would look like);\nnull when the action is not applicable to this asset.", "oneOf": [ { "$ref": "#/components/schemas/ItAssetsAssetIdCollectPostResponsesContentApplicationJsonSchemaDataActionsStoreRentalAtDeelForLocalDetails" }, { "type": "null" } ] }, "disabled_reasons": { "description": "Reasons why the action is disabled. Empty when the action is enabled or not applicable", "items": { "$ref": "#/components/schemas/ItAssetsAssetIdCollectPostResponsesContentApplicationJsonSchemaDataActionsStoreRentalAtDeelForLocalDisabledReasonsItems" }, "type": "array" }, "status": { "$ref": "#/components/schemas/ItAssetsAssetIdCollectPostResponsesContentApplicationJsonSchemaDataActionsStoreRentalAtDeelForLocalStatus", "description": "Whether the action is currently available for this asset" } }, "required": [ "status", "details", "disabled_reasons" ], "title": "ItAssetsAssetIdCollectPostResponsesContentApplicationJsonSchemaDataActionsStoreRentalAtDeelForLocal", "type": "object" }, "ItAssetsAssetIdCollectPostResponsesContentApplicationJsonSchemaDataActionsStoreRentalAtDeelForLocalDetails": { "description": "Action-specific context needed to perform the action. Populated for enabled and\ndisabled actions (so callers can see what a successful attempt would look like);\nnull when the action is not applicable to this asset.", "properties": { "activation_cost": { "$ref": "#/components/schemas/ItAssetsAssetIdCollectPostResponsesContentApplicationJsonSchemaDataActionsStoreRentalAtDeelForLocalDetailsActivationCost", "description": "Cost charged to activate local storage" } }, "required": [ "activation_cost" ], "title": "ItAssetsAssetIdCollectPostResponsesContentApplicationJsonSchemaDataActionsStoreRentalAtDeelForLocalDetails", "type": "object" }, "ItAssetsAssetIdCollectPostResponsesContentApplicationJsonSchemaDataActionsStoreRentalAtDeelForLocalDetailsActivationCost": { "description": "Cost charged to activate local storage", "properties": { "billing_method": { "$ref": "#/components/schemas/ItAssetsAssetIdCollectPostResponsesContentApplicationJsonSchemaDataActionsStoreRentalAtDeelForLocalDetailsActivationCostBillingMethod", "description": "How the action is charged. When \"TOKEN\", the fees are covered by an\nadd-on token pool; when \"CURRENCY\", the fees are billed in the currency\nspecified in the \"fees\" field." }, "fees": { "description": "Price charged for the action. Null when billing method is \"TOKEN\"", "oneOf": [ { "$ref": "#/components/schemas/ItAssetsAssetIdCollectPostResponsesContentApplicationJsonSchemaDataActionsStoreRentalAtDeelForLocalDetailsActivationCostFees" }, { "type": "null" } ] }, "token_usage": { "description": "Add-on token consumption details. Null when billing method is \"CURRENCY\"", "oneOf": [ { "$ref": "#/components/schemas/ItAssetsAssetIdCollectPostResponsesContentApplicationJsonSchemaDataActionsStoreRentalAtDeelForLocalDetailsActivationCostTokenUsage" }, { "type": "null" } ] } }, "required": [ "fees", "token_usage", "billing_method" ], "title": "ItAssetsAssetIdCollectPostResponsesContentApplicationJsonSchemaDataActionsStoreRentalAtDeelForLocalDetailsActivationCost", "type": "object" }, "ItAssetsAssetIdCollectPostResponsesContentApplicationJsonSchemaDataActionsStoreRentalAtDeelForLocalDetailsActivationCostBillingMethod": { "description": "How the action is charged. When \"TOKEN\", the fees are covered by an\nadd-on token pool; when \"CURRENCY\", the fees are billed in the currency\nspecified in the \"fees\" field.", "enum": [ "CURRENCY", "TOKEN" ], "title": "ItAssetsAssetIdCollectPostResponsesContentApplicationJsonSchemaDataActionsStoreRentalAtDeelForLocalDetailsActivationCostBillingMethod", "type": "string" }, "ItAssetsAssetIdCollectPostResponsesContentApplicationJsonSchemaDataActionsStoreRentalAtDeelForLocalDetailsActivationCostFees": { "description": "Price charged for the action. Null when billing method is \"TOKEN\"", "properties": { "amount": { "description": "Amount", "format": "decimal", "type": "string" }, "currency": { "$ref": "#/components/schemas/ItAssetsAssetIdCollectPostResponsesContentApplicationJsonSchemaDataActionsStoreRentalAtDeelForLocalDetailsActivationCostFeesCurrency", "description": "Three-letter currency code for the price" } }, "required": [ "amount", "currency" ], "title": "ItAssetsAssetIdCollectPostResponsesContentApplicationJsonSchemaDataActionsStoreRentalAtDeelForLocalDetailsActivationCostFees", "type": "object" }, "ItAssetsAssetIdCollectPostResponsesContentApplicationJsonSchemaDataActionsStoreRentalAtDeelForLocalDetailsActivationCostFeesCurrency": { "description": "Three-letter currency code for the price", "enum": [ "AED", "AFN", "ALL", "AMD", "ANG", "AOA", "ARS", "AUD", "AWG", "AZN", "BAM", "BDT", "BGN", "BHD", "BIF", "BMD", "BOB", "BRL", "BSD", "BTN", "BWP", "BYN", "BZD", "CAD", "CDF", "CHF", "CLP", "CNY", "COP", "CRC", "CUC", "CVE", "CZK", "DJF", "DKK", "DOP", "DZD", "EGP", "ERN", "ETB", "EUR", "FJD", "FKP", "GBP", "GEL", "GHS", "GIP", "GMD", "GNF", "GTQ", "GYD", "HKD", "HNL", "HRK", "HTG", "HUF", "IDR", "ILS", "INR", "IQD", "IRR", "ISK", "JMD", "JOD", "JPY", "KES", "KGS", "KHR", "KMF", "KPW", "KRW", "KWD", "KYD", "KZT", "LAK", "LBP", "LKR", "LRD", "LSL", "LTL", "LYD", "MAD", "MDL", "MGA", "MKD", "MMK", "MNT", "MRU", "MUR", "MVR", "MWK", "MXN", "MYR", "MZN", "NAD", "NGN", "NIO", "NOK", "NPR", "NZD", "OMR", "PAB", "PEN", "PGK", "PHP", "PKR", "PLN", "PYG", "QAR", "RON", "RSD", "RUB", "RWF", "SAR", "SBD", "SCR", "SDG", "SEK", "SGD", "SHP", "SLL", "SOS", "SRD", "SSP", "STD", "SYP", "SZL", "THB", "TJS", "TMT", "TND", "TOP", "TRY", "TTD", "TWD", "TZS", "UAH", "UGX", "USD", "UYU", "UZS", "VEF", "VND", "VUV", "WST", "XAF", "XCD", "XOF", "XPF", "YER", "ZAR", "ZMW", "ZWD" ], "title": "ItAssetsAssetIdCollectPostResponsesContentApplicationJsonSchemaDataActionsStoreRentalAtDeelForLocalDetailsActivationCostFeesCurrency", "type": "string" }, "ItAssetsAssetIdCollectPostResponsesContentApplicationJsonSchemaDataActionsStoreRentalAtDeelForLocalDetailsActivationCostTokenUsage": { "description": "Add-on token consumption details. Null when billing method is \"CURRENCY\"", "properties": { "addon": { "$ref": "#/components/schemas/ItAssetsAssetIdCollectPostResponsesContentApplicationJsonSchemaDataActionsStoreRentalAtDeelForLocalDetailsActivationCostTokenUsageAddon", "description": "The add-on that provides the tokens" }, "cost": { "description": "Number of tokens consumed by the action. Zero when the add-on covers the\nservice without drawing from a token pool", "format": "decimal", "type": "string" }, "tokens_left": { "description": "Number of tokens left in the pool after the action is performed. Null when\nthe add-on covers the service without a token pool", "format": "decimal", "type": [ "string", "null" ] } }, "required": [ "cost", "addon", "tokens_left" ], "title": "ItAssetsAssetIdCollectPostResponsesContentApplicationJsonSchemaDataActionsStoreRentalAtDeelForLocalDetailsActivationCostTokenUsage", "type": "object" }, "ItAssetsAssetIdCollectPostResponsesContentApplicationJsonSchemaDataActionsStoreRentalAtDeelForLocalDetailsActivationCostTokenUsageAddon": { "description": "The add-on that provides the tokens", "properties": { "id": { "description": "ID of the add-on", "format": "uuid", "type": "string" }, "name": { "description": "Public display name of the add-on", "type": "string" } }, "required": [ "id", "name" ], "title": "ItAssetsAssetIdCollectPostResponsesContentApplicationJsonSchemaDataActionsStoreRentalAtDeelForLocalDetailsActivationCostTokenUsageAddon", "type": "object" }, "ItAssetsAssetIdCollectPostResponsesContentApplicationJsonSchemaDataActionsStoreRentalAtDeelForLocalDisabledReasonsItems": { "enum": [ "ARCHIVED", "AT_DEEL_WAREHOUSE", "BEING_REPAIRED", "CONSUMABLE", "CONTROLLED_BY_DEEL", "COUNTRY_NOT_SUPPORTED_FOR_HUB", "COUNTRY_NOT_SUPPORTED_FOR_LOCAL", "DEEL_OWNED_ITEM_WITHOUT_RENTAL_CONTRACT", "DESKTOP_STORAGE", "ENDING_CONTRACT", "HUB_IN_SAME_REGION_AS_LOCAL", "INACTIVE", "INVALID_ITEM_LOCATION", "INVALID_ORGANIZATION_STATUS", "INVALID_STATE", "ITEM_CONDITIONS_TO_UNARCHIVE_NOT_MET", "ITEM_NOT_VISIBLE_FOR_ORGANIZATION", "NON_DEVICE", "NOT_AT_WAREHOUSE", "NOT_AVAILABLE_FOR_REUSE", "NOT_A_RENTAL", "NOT_MANAGEABLE_BY_ORGANIZATION", "NOT_WITH_ASSIGNMENT", "NOT_WITH_USER", "NO_ACTIVE_ADDONS", "NO_ACTIVE_STORAGE_CONTRACT", "NO_LOCATION_FOR_STORAGE", "NO_LOGISTICS_FOR_STORAGE", "NO_VALID_ADDONS", "ONGOING_SERVICE", "OWNED_BY_DEEL", "OWNED_BY_ORGANIZATION", "OWNED_BY_PARTNER_ORGANIZATION", "PARTNER_CHILD_CONTRACT", "PENDING_DEVICE_REFRESH", "RENTAL_CONTRACT_AND_USER_REGION_DO_NOT_MATCH", "TEMPORARILY_UNAVAILABLE", "UNKNOWN", "USER_HAS_NO_COUNTRY", "USER_HAS_NO_SEAT", "WAITING_FOR_CLEARANCE", "WITH_LOANER_ASSIGNMENT", "WITH_NON_COLLECTED_ASSIGNMENT", "WITH_NON_DELIVERED_ASSIGNMENT", "WITH_PENDING_ASSIGNMENT", "WRONG_ASSIGNMENT_STATUS", "WRONG_CONTRACT_STATUS", "WRONG_TERMS_AND_CONDITIONS" ], "title": "ItAssetsAssetIdCollectPostResponsesContentApplicationJsonSchemaDataActionsStoreRentalAtDeelForLocalDisabledReasonsItems", "type": "string" }, "ItAssetsAssetIdCollectPostResponsesContentApplicationJsonSchemaDataActionsStoreRentalAtDeelForLocalStatus": { "description": "Whether the action is currently available for this asset", "enum": [ "DISABLED", "ENABLED", "NOT_APPLICABLE" ], "title": "ItAssetsAssetIdCollectPostResponsesContentApplicationJsonSchemaDataActionsStoreRentalAtDeelForLocalStatus", "type": "string" }, "ItAssetsAssetIdCollectPostResponsesContentApplicationJsonSchemaDataActionsStoreRentalAtDeelForZone1": { "description": "Store a Deel-owned rental asset at a Deel zone-1 warehouse", "properties": { "details": { "description": "Action-specific context needed to perform the action. Populated for enabled and\ndisabled actions (so callers can see what a successful attempt would look like);\nnull when the action is not applicable to this asset.", "oneOf": [ { "$ref": "#/components/schemas/ItAssetsAssetIdCollectPostResponsesContentApplicationJsonSchemaDataActionsStoreRentalAtDeelForZone1Details" }, { "type": "null" } ] }, "disabled_reasons": { "description": "Reasons why the action is disabled. Empty when the action is enabled or not applicable", "items": { "$ref": "#/components/schemas/ItAssetsAssetIdCollectPostResponsesContentApplicationJsonSchemaDataActionsStoreRentalAtDeelForZone1DisabledReasonsItems" }, "type": "array" }, "status": { "$ref": "#/components/schemas/ItAssetsAssetIdCollectPostResponsesContentApplicationJsonSchemaDataActionsStoreRentalAtDeelForZone1Status", "description": "Whether the action is currently available for this asset" } }, "required": [ "status", "details", "disabled_reasons" ], "title": "ItAssetsAssetIdCollectPostResponsesContentApplicationJsonSchemaDataActionsStoreRentalAtDeelForZone1", "type": "object" }, "ItAssetsAssetIdCollectPostResponsesContentApplicationJsonSchemaDataActionsStoreRentalAtDeelForZone1Details": { "description": "Action-specific context needed to perform the action. Populated for enabled and\ndisabled actions (so callers can see what a successful attempt would look like);\nnull when the action is not applicable to this asset.", "properties": { "activation_cost": { "$ref": "#/components/schemas/ItAssetsAssetIdCollectPostResponsesContentApplicationJsonSchemaDataActionsStoreRentalAtDeelForZone1DetailsActivationCost", "description": "Cost charged to activate zone-1 storage" } }, "required": [ "activation_cost" ], "title": "ItAssetsAssetIdCollectPostResponsesContentApplicationJsonSchemaDataActionsStoreRentalAtDeelForZone1Details", "type": "object" }, "ItAssetsAssetIdCollectPostResponsesContentApplicationJsonSchemaDataActionsStoreRentalAtDeelForZone1DetailsActivationCost": { "description": "Cost charged to activate zone-1 storage", "properties": { "billing_method": { "$ref": "#/components/schemas/ItAssetsAssetIdCollectPostResponsesContentApplicationJsonSchemaDataActionsStoreRentalAtDeelForZone1DetailsActivationCostBillingMethod", "description": "How the action is charged. When \"TOKEN\", the fees are covered by an\nadd-on token pool; when \"CURRENCY\", the fees are billed in the currency\nspecified in the \"fees\" field." }, "fees": { "description": "Price charged for the action. Null when billing method is \"TOKEN\"", "oneOf": [ { "$ref": "#/components/schemas/ItAssetsAssetIdCollectPostResponsesContentApplicationJsonSchemaDataActionsStoreRentalAtDeelForZone1DetailsActivationCostFees" }, { "type": "null" } ] }, "token_usage": { "description": "Add-on token consumption details. Null when billing method is \"CURRENCY\"", "oneOf": [ { "$ref": "#/components/schemas/ItAssetsAssetIdCollectPostResponsesContentApplicationJsonSchemaDataActionsStoreRentalAtDeelForZone1DetailsActivationCostTokenUsage" }, { "type": "null" } ] } }, "required": [ "fees", "token_usage", "billing_method" ], "title": "ItAssetsAssetIdCollectPostResponsesContentApplicationJsonSchemaDataActionsStoreRentalAtDeelForZone1DetailsActivationCost", "type": "object" }, "ItAssetsAssetIdCollectPostResponsesContentApplicationJsonSchemaDataActionsStoreRentalAtDeelForZone1DetailsActivationCostBillingMethod": { "description": "How the action is charged. When \"TOKEN\", the fees are covered by an\nadd-on token pool; when \"CURRENCY\", the fees are billed in the currency\nspecified in the \"fees\" field.", "enum": [ "CURRENCY", "TOKEN" ], "title": "ItAssetsAssetIdCollectPostResponsesContentApplicationJsonSchemaDataActionsStoreRentalAtDeelForZone1DetailsActivationCostBillingMethod", "type": "string" }, "ItAssetsAssetIdCollectPostResponsesContentApplicationJsonSchemaDataActionsStoreRentalAtDeelForZone1DetailsActivationCostFees": { "description": "Price charged for the action. Null when billing method is \"TOKEN\"", "properties": { "amount": { "description": "Amount", "format": "decimal", "type": "string" }, "currency": { "$ref": "#/components/schemas/ItAssetsAssetIdCollectPostResponsesContentApplicationJsonSchemaDataActionsStoreRentalAtDeelForZone1DetailsActivationCostFeesCurrency", "description": "Three-letter currency code for the price" } }, "required": [ "amount", "currency" ], "title": "ItAssetsAssetIdCollectPostResponsesContentApplicationJsonSchemaDataActionsStoreRentalAtDeelForZone1DetailsActivationCostFees", "type": "object" }, "ItAssetsAssetIdCollectPostResponsesContentApplicationJsonSchemaDataActionsStoreRentalAtDeelForZone1DetailsActivationCostFeesCurrency": { "description": "Three-letter currency code for the price", "enum": [ "AED", "AFN", "ALL", "AMD", "ANG", "AOA", "ARS", "AUD", "AWG", "AZN", "BAM", "BDT", "BGN", "BHD", "BIF", "BMD", "BOB", "BRL", "BSD", "BTN", "BWP", "BYN", "BZD", "CAD", "CDF", "CHF", "CLP", "CNY", "COP", "CRC", "CUC", "CVE", "CZK", "DJF", "DKK", "DOP", "DZD", "EGP", "ERN", "ETB", "EUR", "FJD", "FKP", "GBP", "GEL", "GHS", "GIP", "GMD", "GNF", "GTQ", "GYD", "HKD", "HNL", "HRK", "HTG", "HUF", "IDR", "ILS", "INR", "IQD", "IRR", "ISK", "JMD", "JOD", "JPY", "KES", "KGS", "KHR", "KMF", "KPW", "KRW", "KWD", "KYD", "KZT", "LAK", "LBP", "LKR", "LRD", "LSL", "LTL", "LYD", "MAD", "MDL", "MGA", "MKD", "MMK", "MNT", "MRU", "MUR", "MVR", "MWK", "MXN", "MYR", "MZN", "NAD", "NGN", "NIO", "NOK", "NPR", "NZD", "OMR", "PAB", "PEN", "PGK", "PHP", "PKR", "PLN", "PYG", "QAR", "RON", "RSD", "RUB", "RWF", "SAR", "SBD", "SCR", "SDG", "SEK", "SGD", "SHP", "SLL", "SOS", "SRD", "SSP", "STD", "SYP", "SZL", "THB", "TJS", "TMT", "TND", "TOP", "TRY", "TTD", "TWD", "TZS", "UAH", "UGX", "USD", "UYU", "UZS", "VEF", "VND", "VUV", "WST", "XAF", "XCD", "XOF", "XPF", "YER", "ZAR", "ZMW", "ZWD" ], "title": "ItAssetsAssetIdCollectPostResponsesContentApplicationJsonSchemaDataActionsStoreRentalAtDeelForZone1DetailsActivationCostFeesCurrency", "type": "string" }, "ItAssetsAssetIdCollectPostResponsesContentApplicationJsonSchemaDataActionsStoreRentalAtDeelForZone1DetailsActivationCostTokenUsage": { "description": "Add-on token consumption details. Null when billing method is \"CURRENCY\"", "properties": { "addon": { "$ref": "#/components/schemas/ItAssetsAssetIdCollectPostResponsesContentApplicationJsonSchemaDataActionsStoreRentalAtDeelForZone1DetailsActivationCostTokenUsageAddon", "description": "The add-on that provides the tokens" }, "cost": { "description": "Number of tokens consumed by the action. Zero when the add-on covers the\nservice without drawing from a token pool", "format": "decimal", "type": "string" }, "tokens_left": { "description": "Number of tokens left in the pool after the action is performed. Null when\nthe add-on covers the service without a token pool", "format": "decimal", "type": [ "string", "null" ] } }, "required": [ "cost", "addon", "tokens_left" ], "title": "ItAssetsAssetIdCollectPostResponsesContentApplicationJsonSchemaDataActionsStoreRentalAtDeelForZone1DetailsActivationCostTokenUsage", "type": "object" }, "ItAssetsAssetIdCollectPostResponsesContentApplicationJsonSchemaDataActionsStoreRentalAtDeelForZone1DetailsActivationCostTokenUsageAddon": { "description": "The add-on that provides the tokens", "properties": { "id": { "description": "ID of the add-on", "format": "uuid", "type": "string" }, "name": { "description": "Public display name of the add-on", "type": "string" } }, "required": [ "id", "name" ], "title": "ItAssetsAssetIdCollectPostResponsesContentApplicationJsonSchemaDataActionsStoreRentalAtDeelForZone1DetailsActivationCostTokenUsageAddon", "type": "object" }, "ItAssetsAssetIdCollectPostResponsesContentApplicationJsonSchemaDataActionsStoreRentalAtDeelForZone1DisabledReasonsItems": { "enum": [ "ARCHIVED", "AT_DEEL_WAREHOUSE", "BEING_REPAIRED", "CONSUMABLE", "CONTROLLED_BY_DEEL", "COUNTRY_NOT_SUPPORTED_FOR_HUB", "COUNTRY_NOT_SUPPORTED_FOR_LOCAL", "DEEL_OWNED_ITEM_WITHOUT_RENTAL_CONTRACT", "DESKTOP_STORAGE", "ENDING_CONTRACT", "HUB_IN_SAME_REGION_AS_LOCAL", "INACTIVE", "INVALID_ITEM_LOCATION", "INVALID_ORGANIZATION_STATUS", "INVALID_STATE", "ITEM_CONDITIONS_TO_UNARCHIVE_NOT_MET", "ITEM_NOT_VISIBLE_FOR_ORGANIZATION", "NON_DEVICE", "NOT_AT_WAREHOUSE", "NOT_AVAILABLE_FOR_REUSE", "NOT_A_RENTAL", "NOT_MANAGEABLE_BY_ORGANIZATION", "NOT_WITH_ASSIGNMENT", "NOT_WITH_USER", "NO_ACTIVE_ADDONS", "NO_ACTIVE_STORAGE_CONTRACT", "NO_LOCATION_FOR_STORAGE", "NO_LOGISTICS_FOR_STORAGE", "NO_VALID_ADDONS", "ONGOING_SERVICE", "OWNED_BY_DEEL", "OWNED_BY_ORGANIZATION", "OWNED_BY_PARTNER_ORGANIZATION", "PARTNER_CHILD_CONTRACT", "PENDING_DEVICE_REFRESH", "RENTAL_CONTRACT_AND_USER_REGION_DO_NOT_MATCH", "TEMPORARILY_UNAVAILABLE", "UNKNOWN", "USER_HAS_NO_COUNTRY", "USER_HAS_NO_SEAT", "WAITING_FOR_CLEARANCE", "WITH_LOANER_ASSIGNMENT", "WITH_NON_COLLECTED_ASSIGNMENT", "WITH_NON_DELIVERED_ASSIGNMENT", "WITH_PENDING_ASSIGNMENT", "WRONG_ASSIGNMENT_STATUS", "WRONG_CONTRACT_STATUS", "WRONG_TERMS_AND_CONDITIONS" ], "title": "ItAssetsAssetIdCollectPostResponsesContentApplicationJsonSchemaDataActionsStoreRentalAtDeelForZone1DisabledReasonsItems", "type": "string" }, "ItAssetsAssetIdCollectPostResponsesContentApplicationJsonSchemaDataActionsStoreRentalAtDeelForZone1Status": { "description": "Whether the action is currently available for this asset", "enum": [ "DISABLED", "ENABLED", "NOT_APPLICABLE" ], "title": "ItAssetsAssetIdCollectPostResponsesContentApplicationJsonSchemaDataActionsStoreRentalAtDeelForZone1Status", "type": "string" }, "ItAssetsAssetIdCollectPostResponsesContentApplicationJsonSchemaDataActionsTransferOwnAsset": { "description": "Transfer an organization-owned asset to another user", "properties": { "details": { "description": "Action-specific context needed to perform the action. Populated for enabled and\ndisabled actions (so callers can see what a successful attempt would look like);\nnull when the action is not applicable to this asset.", "oneOf": [ { "$ref": "#/components/schemas/ItAssetsAssetIdCollectPostResponsesContentApplicationJsonSchemaDataActionsTransferOwnAssetDetails" }, { "type": "null" } ] }, "disabled_reasons": { "description": "Reasons why the action is disabled. Empty when the action is enabled or not applicable", "items": { "$ref": "#/components/schemas/ItAssetsAssetIdCollectPostResponsesContentApplicationJsonSchemaDataActionsTransferOwnAssetDisabledReasonsItems" }, "type": "array" }, "status": { "$ref": "#/components/schemas/ItAssetsAssetIdCollectPostResponsesContentApplicationJsonSchemaDataActionsTransferOwnAssetStatus", "description": "Whether the action is currently available for this asset" } }, "required": [ "status", "details", "disabled_reasons" ], "title": "ItAssetsAssetIdCollectPostResponsesContentApplicationJsonSchemaDataActionsTransferOwnAsset", "type": "object" }, "ItAssetsAssetIdCollectPostResponsesContentApplicationJsonSchemaDataActionsTransferOwnAssetDetails": { "description": "Action-specific context needed to perform the action. Populated for enabled and\ndisabled actions (so callers can see what a successful attempt would look like);\nnull when the action is not applicable to this asset.", "properties": { "eligible_countries": { "description": "Countries the asset can be transferred to", "items": { "$ref": "#/components/schemas/ItAssetsAssetIdCollectPostResponsesContentApplicationJsonSchemaDataActionsTransferOwnAssetDetailsEligibleCountriesItems" }, "type": "array" }, "transfer_cost": { "$ref": "#/components/schemas/ItAssetsAssetIdCollectPostResponsesContentApplicationJsonSchemaDataActionsTransferOwnAssetDetailsTransferCost", "description": "Cost charged for the transfer service" } }, "required": [ "transfer_cost", "eligible_countries" ], "title": "ItAssetsAssetIdCollectPostResponsesContentApplicationJsonSchemaDataActionsTransferOwnAssetDetails", "type": "object" }, "ItAssetsAssetIdCollectPostResponsesContentApplicationJsonSchemaDataActionsTransferOwnAssetDetailsEligibleCountriesItems": { "enum": [ "AD", "AE", "AF", "AG", "AI", "AL", "AM", "AN", "AO", "AQ", "AR", "AS", "AT", "AU", "AW", "AX", "AZ", "BA", "BB", "BD", "BE", "BF", "BG", "BH", "BI", "BJ", "BL", "BM", "BN", "BO", "BQ", "BR", "BS", "BT", "BV", "BW", "BY", "BZ", "CA", "CC", "CD", "CF", "CG", "CH", "CI", "CK", "CL", "CM", "CN", "CO", "CR", "CU", "CV", "CW", "CX", "CY", "CZ", "DE", "DJ", "DK", "DM", "DO", "DZ", "EC", "EE", "EG", "EH", "ER", "ES", "ET", "FI", "FJ", "FK", "FM", "FO", "FR", "GA", "GB", "GD", "GE", "GF", "GG", "GH", "GI", "GL", "GM", "GN", "GP", "GQ", "GR", "GS", "GT", "GU", "GW", "GY", "HK", "HM", "HN", "HR", "HT", "HU", "IC", "ID", "IE", "IL", "IM", "IN", "IO", "IQ", "IR", "IS", "IT", "JE", "JM", "JO", "JP", "KE", "KG", "KH", "KI", "KM", "KN", "KP", "KR", "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", "XK", "YE", "YT", "ZA", "ZM", "ZW" ], "title": "ItAssetsAssetIdCollectPostResponsesContentApplicationJsonSchemaDataActionsTransferOwnAssetDetailsEligibleCountriesItems", "type": "string" }, "ItAssetsAssetIdCollectPostResponsesContentApplicationJsonSchemaDataActionsTransferOwnAssetDetailsTransferCost": { "description": "Cost charged for the transfer service", "properties": { "billing_method": { "$ref": "#/components/schemas/ItAssetsAssetIdCollectPostResponsesContentApplicationJsonSchemaDataActionsTransferOwnAssetDetailsTransferCostBillingMethod", "description": "How the action is charged. When \"TOKEN\", the fees are covered by an\nadd-on token pool; when \"CURRENCY\", the fees are billed in the currency\nspecified in the \"fees\" field." }, "fees": { "description": "Price charged for the action. Null when billing method is \"TOKEN\"", "oneOf": [ { "$ref": "#/components/schemas/ItAssetsAssetIdCollectPostResponsesContentApplicationJsonSchemaDataActionsTransferOwnAssetDetailsTransferCostFees" }, { "type": "null" } ] }, "token_usage": { "description": "Add-on token consumption details. Null when billing method is \"CURRENCY\"", "oneOf": [ { "$ref": "#/components/schemas/ItAssetsAssetIdCollectPostResponsesContentApplicationJsonSchemaDataActionsTransferOwnAssetDetailsTransferCostTokenUsage" }, { "type": "null" } ] } }, "required": [ "fees", "token_usage", "billing_method" ], "title": "ItAssetsAssetIdCollectPostResponsesContentApplicationJsonSchemaDataActionsTransferOwnAssetDetailsTransferCost", "type": "object" }, "ItAssetsAssetIdCollectPostResponsesContentApplicationJsonSchemaDataActionsTransferOwnAssetDetailsTransferCostBillingMethod": { "description": "How the action is charged. When \"TOKEN\", the fees are covered by an\nadd-on token pool; when \"CURRENCY\", the fees are billed in the currency\nspecified in the \"fees\" field.", "enum": [ "CURRENCY", "TOKEN" ], "title": "ItAssetsAssetIdCollectPostResponsesContentApplicationJsonSchemaDataActionsTransferOwnAssetDetailsTransferCostBillingMethod", "type": "string" }, "ItAssetsAssetIdCollectPostResponsesContentApplicationJsonSchemaDataActionsTransferOwnAssetDetailsTransferCostFees": { "description": "Price charged for the action. Null when billing method is \"TOKEN\"", "properties": { "amount": { "description": "Amount", "format": "decimal", "type": "string" }, "currency": { "$ref": "#/components/schemas/ItAssetsAssetIdCollectPostResponsesContentApplicationJsonSchemaDataActionsTransferOwnAssetDetailsTransferCostFeesCurrency", "description": "Three-letter currency code for the price" } }, "required": [ "amount", "currency" ], "title": "ItAssetsAssetIdCollectPostResponsesContentApplicationJsonSchemaDataActionsTransferOwnAssetDetailsTransferCostFees", "type": "object" }, "ItAssetsAssetIdCollectPostResponsesContentApplicationJsonSchemaDataActionsTransferOwnAssetDetailsTransferCostFeesCurrency": { "description": "Three-letter currency code for the price", "enum": [ "AED", "AFN", "ALL", "AMD", "ANG", "AOA", "ARS", "AUD", "AWG", "AZN", "BAM", "BDT", "BGN", "BHD", "BIF", "BMD", "BOB", "BRL", "BSD", "BTN", "BWP", "BYN", "BZD", "CAD", "CDF", "CHF", "CLP", "CNY", "COP", "CRC", "CUC", "CVE", "CZK", "DJF", "DKK", "DOP", "DZD", "EGP", "ERN", "ETB", "EUR", "FJD", "FKP", "GBP", "GEL", "GHS", "GIP", "GMD", "GNF", "GTQ", "GYD", "HKD", "HNL", "HRK", "HTG", "HUF", "IDR", "ILS", "INR", "IQD", "IRR", "ISK", "JMD", "JOD", "JPY", "KES", "KGS", "KHR", "KMF", "KPW", "KRW", "KWD", "KYD", "KZT", "LAK", "LBP", "LKR", "LRD", "LSL", "LTL", "LYD", "MAD", "MDL", "MGA", "MKD", "MMK", "MNT", "MRU", "MUR", "MVR", "MWK", "MXN", "MYR", "MZN", "NAD", "NGN", "NIO", "NOK", "NPR", "NZD", "OMR", "PAB", "PEN", "PGK", "PHP", "PKR", "PLN", "PYG", "QAR", "RON", "RSD", "RUB", "RWF", "SAR", "SBD", "SCR", "SDG", "SEK", "SGD", "SHP", "SLL", "SOS", "SRD", "SSP", "STD", "SYP", "SZL", "THB", "TJS", "TMT", "TND", "TOP", "TRY", "TTD", "TWD", "TZS", "UAH", "UGX", "USD", "UYU", "UZS", "VEF", "VND", "VUV", "WST", "XAF", "XCD", "XOF", "XPF", "YER", "ZAR", "ZMW", "ZWD" ], "title": "ItAssetsAssetIdCollectPostResponsesContentApplicationJsonSchemaDataActionsTransferOwnAssetDetailsTransferCostFeesCurrency", "type": "string" }, "ItAssetsAssetIdCollectPostResponsesContentApplicationJsonSchemaDataActionsTransferOwnAssetDetailsTransferCostTokenUsage": { "description": "Add-on token consumption details. Null when billing method is \"CURRENCY\"", "properties": { "addon": { "$ref": "#/components/schemas/ItAssetsAssetIdCollectPostResponsesContentApplicationJsonSchemaDataActionsTransferOwnAssetDetailsTransferCostTokenUsageAddon", "description": "The add-on that provides the tokens" }, "cost": { "description": "Number of tokens consumed by the action. Zero when the add-on covers the\nservice without drawing from a token pool", "format": "decimal", "type": "string" }, "tokens_left": { "description": "Number of tokens left in the pool after the action is performed. Null when\nthe add-on covers the service without a token pool", "format": "decimal", "type": [ "string", "null" ] } }, "required": [ "cost", "addon", "tokens_left" ], "title": "ItAssetsAssetIdCollectPostResponsesContentApplicationJsonSchemaDataActionsTransferOwnAssetDetailsTransferCostTokenUsage", "type": "object" }, "ItAssetsAssetIdCollectPostResponsesContentApplicationJsonSchemaDataActionsTransferOwnAssetDetailsTransferCostTokenUsageAddon": { "description": "The add-on that provides the tokens", "properties": { "id": { "description": "ID of the add-on", "format": "uuid", "type": "string" }, "name": { "description": "Public display name of the add-on", "type": "string" } }, "required": [ "id", "name" ], "title": "ItAssetsAssetIdCollectPostResponsesContentApplicationJsonSchemaDataActionsTransferOwnAssetDetailsTransferCostTokenUsageAddon", "type": "object" }, "ItAssetsAssetIdCollectPostResponsesContentApplicationJsonSchemaDataActionsTransferOwnAssetDisabledReasonsItems": { "enum": [ "ARCHIVED", "AT_DEEL_WAREHOUSE", "BEING_REPAIRED", "CONSUMABLE", "CONTROLLED_BY_DEEL", "COUNTRY_NOT_SUPPORTED_FOR_HUB", "COUNTRY_NOT_SUPPORTED_FOR_LOCAL", "DEEL_OWNED_ITEM_WITHOUT_RENTAL_CONTRACT", "DESKTOP_STORAGE", "ENDING_CONTRACT", "HUB_IN_SAME_REGION_AS_LOCAL", "INACTIVE", "INVALID_ITEM_LOCATION", "INVALID_ORGANIZATION_STATUS", "INVALID_STATE", "ITEM_CONDITIONS_TO_UNARCHIVE_NOT_MET", "ITEM_NOT_VISIBLE_FOR_ORGANIZATION", "NON_DEVICE", "NOT_AT_WAREHOUSE", "NOT_AVAILABLE_FOR_REUSE", "NOT_A_RENTAL", "NOT_MANAGEABLE_BY_ORGANIZATION", "NOT_WITH_ASSIGNMENT", "NOT_WITH_USER", "NO_ACTIVE_ADDONS", "NO_ACTIVE_STORAGE_CONTRACT", "NO_LOCATION_FOR_STORAGE", "NO_LOGISTICS_FOR_STORAGE", "NO_VALID_ADDONS", "ONGOING_SERVICE", "OWNED_BY_DEEL", "OWNED_BY_ORGANIZATION", "OWNED_BY_PARTNER_ORGANIZATION", "PARTNER_CHILD_CONTRACT", "PENDING_DEVICE_REFRESH", "RENTAL_CONTRACT_AND_USER_REGION_DO_NOT_MATCH", "TEMPORARILY_UNAVAILABLE", "UNKNOWN", "USER_HAS_NO_COUNTRY", "USER_HAS_NO_SEAT", "WAITING_FOR_CLEARANCE", "WITH_LOANER_ASSIGNMENT", "WITH_NON_COLLECTED_ASSIGNMENT", "WITH_NON_DELIVERED_ASSIGNMENT", "WITH_PENDING_ASSIGNMENT", "WRONG_ASSIGNMENT_STATUS", "WRONG_CONTRACT_STATUS", "WRONG_TERMS_AND_CONDITIONS" ], "title": "ItAssetsAssetIdCollectPostResponsesContentApplicationJsonSchemaDataActionsTransferOwnAssetDisabledReasonsItems", "type": "string" }, "ItAssetsAssetIdCollectPostResponsesContentApplicationJsonSchemaDataActionsTransferOwnAssetStatus": { "description": "Whether the action is currently available for this asset", "enum": [ "DISABLED", "ENABLED", "NOT_APPLICABLE" ], "title": "ItAssetsAssetIdCollectPostResponsesContentApplicationJsonSchemaDataActionsTransferOwnAssetStatus", "type": "string" }, "ItAssetsAssetIdCollectPostResponsesContentApplicationJsonSchemaDataActionsTransferRental": { "description": "Transfer a Deel-owned rental asset to another user", "properties": { "details": { "description": "Action-specific context needed to perform the action. Populated for enabled and\ndisabled actions (so callers can see what a successful attempt would look like);\nnull when the action is not applicable to this asset.", "oneOf": [ { "$ref": "#/components/schemas/ItAssetsAssetIdCollectPostResponsesContentApplicationJsonSchemaDataActionsTransferRentalDetails" }, { "type": "null" } ] }, "disabled_reasons": { "description": "Reasons why the action is disabled. Empty when the action is enabled or not applicable", "items": { "$ref": "#/components/schemas/ItAssetsAssetIdCollectPostResponsesContentApplicationJsonSchemaDataActionsTransferRentalDisabledReasonsItems" }, "type": "array" }, "status": { "$ref": "#/components/schemas/ItAssetsAssetIdCollectPostResponsesContentApplicationJsonSchemaDataActionsTransferRentalStatus", "description": "Whether the action is currently available for this asset" } }, "required": [ "status", "details", "disabled_reasons" ], "title": "ItAssetsAssetIdCollectPostResponsesContentApplicationJsonSchemaDataActionsTransferRental", "type": "object" }, "ItAssetsAssetIdCollectPostResponsesContentApplicationJsonSchemaDataActionsTransferRentalDetails": { "description": "Action-specific context needed to perform the action. Populated for enabled and\ndisabled actions (so callers can see what a successful attempt would look like);\nnull when the action is not applicable to this asset.", "properties": { "eligible_countries": { "description": "Countries the asset can be transferred to", "items": { "$ref": "#/components/schemas/ItAssetsAssetIdCollectPostResponsesContentApplicationJsonSchemaDataActionsTransferRentalDetailsEligibleCountriesItems" }, "type": "array" }, "transfer_cost": { "$ref": "#/components/schemas/ItAssetsAssetIdCollectPostResponsesContentApplicationJsonSchemaDataActionsTransferRentalDetailsTransferCost", "description": "Cost charged for the transfer service" } }, "required": [ "transfer_cost", "eligible_countries" ], "title": "ItAssetsAssetIdCollectPostResponsesContentApplicationJsonSchemaDataActionsTransferRentalDetails", "type": "object" }, "ItAssetsAssetIdCollectPostResponsesContentApplicationJsonSchemaDataActionsTransferRentalDetailsEligibleCountriesItems": { "enum": [ "AD", "AE", "AF", "AG", "AI", "AL", "AM", "AN", "AO", "AQ", "AR", "AS", "AT", "AU", "AW", "AX", "AZ", "BA", "BB", "BD", "BE", "BF", "BG", "BH", "BI", "BJ", "BL", "BM", "BN", "BO", "BQ", "BR", "BS", "BT", "BV", "BW", "BY", "BZ", "CA", "CC", "CD", "CF", "CG", "CH", "CI", "CK", "CL", "CM", "CN", "CO", "CR", "CU", "CV", "CW", "CX", "CY", "CZ", "DE", "DJ", "DK", "DM", "DO", "DZ", "EC", "EE", "EG", "EH", "ER", "ES", "ET", "FI", "FJ", "FK", "FM", "FO", "FR", "GA", "GB", "GD", "GE", "GF", "GG", "GH", "GI", "GL", "GM", "GN", "GP", "GQ", "GR", "GS", "GT", "GU", "GW", "GY", "HK", "HM", "HN", "HR", "HT", "HU", "IC", "ID", "IE", "IL", "IM", "IN", "IO", "IQ", "IR", "IS", "IT", "JE", "JM", "JO", "JP", "KE", "KG", "KH", "KI", "KM", "KN", "KP", "KR", "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", "XK", "YE", "YT", "ZA", "ZM", "ZW" ], "title": "ItAssetsAssetIdCollectPostResponsesContentApplicationJsonSchemaDataActionsTransferRentalDetailsEligibleCountriesItems", "type": "string" }, "ItAssetsAssetIdCollectPostResponsesContentApplicationJsonSchemaDataActionsTransferRentalDetailsTransferCost": { "description": "Cost charged for the transfer service", "properties": { "billing_method": { "$ref": "#/components/schemas/ItAssetsAssetIdCollectPostResponsesContentApplicationJsonSchemaDataActionsTransferRentalDetailsTransferCostBillingMethod", "description": "How the action is charged. When \"TOKEN\", the fees are covered by an\nadd-on token pool; when \"CURRENCY\", the fees are billed in the currency\nspecified in the \"fees\" field." }, "fees": { "description": "Price charged for the action. Null when billing method is \"TOKEN\"", "oneOf": [ { "$ref": "#/components/schemas/ItAssetsAssetIdCollectPostResponsesContentApplicationJsonSchemaDataActionsTransferRentalDetailsTransferCostFees" }, { "type": "null" } ] }, "token_usage": { "description": "Add-on token consumption details. Null when billing method is \"CURRENCY\"", "oneOf": [ { "$ref": "#/components/schemas/ItAssetsAssetIdCollectPostResponsesContentApplicationJsonSchemaDataActionsTransferRentalDetailsTransferCostTokenUsage" }, { "type": "null" } ] } }, "required": [ "fees", "token_usage", "billing_method" ], "title": "ItAssetsAssetIdCollectPostResponsesContentApplicationJsonSchemaDataActionsTransferRentalDetailsTransferCost", "type": "object" }, "ItAssetsAssetIdCollectPostResponsesContentApplicationJsonSchemaDataActionsTransferRentalDetailsTransferCostBillingMethod": { "description": "How the action is charged. When \"TOKEN\", the fees are covered by an\nadd-on token pool; when \"CURRENCY\", the fees are billed in the currency\nspecified in the \"fees\" field.", "enum": [ "CURRENCY", "TOKEN" ], "title": "ItAssetsAssetIdCollectPostResponsesContentApplicationJsonSchemaDataActionsTransferRentalDetailsTransferCostBillingMethod", "type": "string" }, "ItAssetsAssetIdCollectPostResponsesContentApplicationJsonSchemaDataActionsTransferRentalDetailsTransferCostFees": { "description": "Price charged for the action. Null when billing method is \"TOKEN\"", "properties": { "amount": { "description": "Amount", "format": "decimal", "type": "string" }, "currency": { "$ref": "#/components/schemas/ItAssetsAssetIdCollectPostResponsesContentApplicationJsonSchemaDataActionsTransferRentalDetailsTransferCostFeesCurrency", "description": "Three-letter currency code for the price" } }, "required": [ "amount", "currency" ], "title": "ItAssetsAssetIdCollectPostResponsesContentApplicationJsonSchemaDataActionsTransferRentalDetailsTransferCostFees", "type": "object" }, "ItAssetsAssetIdCollectPostResponsesContentApplicationJsonSchemaDataActionsTransferRentalDetailsTransferCostFeesCurrency": { "description": "Three-letter currency code for the price", "enum": [ "AED", "AFN", "ALL", "AMD", "ANG", "AOA", "ARS", "AUD", "AWG", "AZN", "BAM", "BDT", "BGN", "BHD", "BIF", "BMD", "BOB", "BRL", "BSD", "BTN", "BWP", "BYN", "BZD", "CAD", "CDF", "CHF", "CLP", "CNY", "COP", "CRC", "CUC", "CVE", "CZK", "DJF", "DKK", "DOP", "DZD", "EGP", "ERN", "ETB", "EUR", "FJD", "FKP", "GBP", "GEL", "GHS", "GIP", "GMD", "GNF", "GTQ", "GYD", "HKD", "HNL", "HRK", "HTG", "HUF", "IDR", "ILS", "INR", "IQD", "IRR", "ISK", "JMD", "JOD", "JPY", "KES", "KGS", "KHR", "KMF", "KPW", "KRW", "KWD", "KYD", "KZT", "LAK", "LBP", "LKR", "LRD", "LSL", "LTL", "LYD", "MAD", "MDL", "MGA", "MKD", "MMK", "MNT", "MRU", "MUR", "MVR", "MWK", "MXN", "MYR", "MZN", "NAD", "NGN", "NIO", "NOK", "NPR", "NZD", "OMR", "PAB", "PEN", "PGK", "PHP", "PKR", "PLN", "PYG", "QAR", "RON", "RSD", "RUB", "RWF", "SAR", "SBD", "SCR", "SDG", "SEK", "SGD", "SHP", "SLL", "SOS", "SRD", "SSP", "STD", "SYP", "SZL", "THB", "TJS", "TMT", "TND", "TOP", "TRY", "TTD", "TWD", "TZS", "UAH", "UGX", "USD", "UYU", "UZS", "VEF", "VND", "VUV", "WST", "XAF", "XCD", "XOF", "XPF", "YER", "ZAR", "ZMW", "ZWD" ], "title": "ItAssetsAssetIdCollectPostResponsesContentApplicationJsonSchemaDataActionsTransferRentalDetailsTransferCostFeesCurrency", "type": "string" }, "ItAssetsAssetIdCollectPostResponsesContentApplicationJsonSchemaDataActionsTransferRentalDetailsTransferCostTokenUsage": { "description": "Add-on token consumption details. Null when billing method is \"CURRENCY\"", "properties": { "addon": { "$ref": "#/components/schemas/ItAssetsAssetIdCollectPostResponsesContentApplicationJsonSchemaDataActionsTransferRentalDetailsTransferCostTokenUsageAddon", "description": "The add-on that provides the tokens" }, "cost": { "description": "Number of tokens consumed by the action. Zero when the add-on covers the\nservice without drawing from a token pool", "format": "decimal", "type": "string" }, "tokens_left": { "description": "Number of tokens left in the pool after the action is performed. Null when\nthe add-on covers the service without a token pool", "format": "decimal", "type": [ "string", "null" ] } }, "required": [ "cost", "addon", "tokens_left" ], "title": "ItAssetsAssetIdCollectPostResponsesContentApplicationJsonSchemaDataActionsTransferRentalDetailsTransferCostTokenUsage", "type": "object" }, "ItAssetsAssetIdCollectPostResponsesContentApplicationJsonSchemaDataActionsTransferRentalDetailsTransferCostTokenUsageAddon": { "description": "The add-on that provides the tokens", "properties": { "id": { "description": "ID of the add-on", "format": "uuid", "type": "string" }, "name": { "description": "Public display name of the add-on", "type": "string" } }, "required": [ "id", "name" ], "title": "ItAssetsAssetIdCollectPostResponsesContentApplicationJsonSchemaDataActionsTransferRentalDetailsTransferCostTokenUsageAddon", "type": "object" }, "ItAssetsAssetIdCollectPostResponsesContentApplicationJsonSchemaDataActionsTransferRentalDisabledReasonsItems": { "enum": [ "ARCHIVED", "AT_DEEL_WAREHOUSE", "BEING_REPAIRED", "CONSUMABLE", "CONTROLLED_BY_DEEL", "COUNTRY_NOT_SUPPORTED_FOR_HUB", "COUNTRY_NOT_SUPPORTED_FOR_LOCAL", "DEEL_OWNED_ITEM_WITHOUT_RENTAL_CONTRACT", "DESKTOP_STORAGE", "ENDING_CONTRACT", "HUB_IN_SAME_REGION_AS_LOCAL", "INACTIVE", "INVALID_ITEM_LOCATION", "INVALID_ORGANIZATION_STATUS", "INVALID_STATE", "ITEM_CONDITIONS_TO_UNARCHIVE_NOT_MET", "ITEM_NOT_VISIBLE_FOR_ORGANIZATION", "NON_DEVICE", "NOT_AT_WAREHOUSE", "NOT_AVAILABLE_FOR_REUSE", "NOT_A_RENTAL", "NOT_MANAGEABLE_BY_ORGANIZATION", "NOT_WITH_ASSIGNMENT", "NOT_WITH_USER", "NO_ACTIVE_ADDONS", "NO_ACTIVE_STORAGE_CONTRACT", "NO_LOCATION_FOR_STORAGE", "NO_LOGISTICS_FOR_STORAGE", "NO_VALID_ADDONS", "ONGOING_SERVICE", "OWNED_BY_DEEL", "OWNED_BY_ORGANIZATION", "OWNED_BY_PARTNER_ORGANIZATION", "PARTNER_CHILD_CONTRACT", "PENDING_DEVICE_REFRESH", "RENTAL_CONTRACT_AND_USER_REGION_DO_NOT_MATCH", "TEMPORARILY_UNAVAILABLE", "UNKNOWN", "USER_HAS_NO_COUNTRY", "USER_HAS_NO_SEAT", "WAITING_FOR_CLEARANCE", "WITH_LOANER_ASSIGNMENT", "WITH_NON_COLLECTED_ASSIGNMENT", "WITH_NON_DELIVERED_ASSIGNMENT", "WITH_PENDING_ASSIGNMENT", "WRONG_ASSIGNMENT_STATUS", "WRONG_CONTRACT_STATUS", "WRONG_TERMS_AND_CONDITIONS" ], "title": "ItAssetsAssetIdCollectPostResponsesContentApplicationJsonSchemaDataActionsTransferRentalDisabledReasonsItems", "type": "string" }, "ItAssetsAssetIdCollectPostResponsesContentApplicationJsonSchemaDataActionsTransferRentalStatus": { "description": "Whether the action is currently available for this asset", "enum": [ "DISABLED", "ENABLED", "NOT_APPLICABLE" ], "title": "ItAssetsAssetIdCollectPostResponsesContentApplicationJsonSchemaDataActionsTransferRentalStatus", "type": "string" }, "ItAssetsAssetIdCollectPostResponsesContentApplicationJsonSchemaDataActionsUnarchiveOwnAsset": { "description": "Unarchive a previously archived organization-owned asset", "properties": { "disabled_reasons": { "description": "Reasons why the action is disabled. Empty when the action is enabled or not applicable", "items": { "$ref": "#/components/schemas/ItAssetsAssetIdCollectPostResponsesContentApplicationJsonSchemaDataActionsUnarchiveOwnAssetDisabledReasonsItems" }, "type": "array" }, "status": { "$ref": "#/components/schemas/ItAssetsAssetIdCollectPostResponsesContentApplicationJsonSchemaDataActionsUnarchiveOwnAssetStatus", "description": "Whether the action is currently available for this asset" } }, "required": [ "status", "disabled_reasons" ], "title": "ItAssetsAssetIdCollectPostResponsesContentApplicationJsonSchemaDataActionsUnarchiveOwnAsset", "type": "object" }, "ItAssetsAssetIdCollectPostResponsesContentApplicationJsonSchemaDataActionsUnarchiveOwnAssetDisabledReasonsItems": { "enum": [ "ARCHIVED", "AT_DEEL_WAREHOUSE", "BEING_REPAIRED", "CONSUMABLE", "CONTROLLED_BY_DEEL", "COUNTRY_NOT_SUPPORTED_FOR_HUB", "COUNTRY_NOT_SUPPORTED_FOR_LOCAL", "DEEL_OWNED_ITEM_WITHOUT_RENTAL_CONTRACT", "DESKTOP_STORAGE", "ENDING_CONTRACT", "HUB_IN_SAME_REGION_AS_LOCAL", "INACTIVE", "INVALID_ITEM_LOCATION", "INVALID_ORGANIZATION_STATUS", "INVALID_STATE", "ITEM_CONDITIONS_TO_UNARCHIVE_NOT_MET", "ITEM_NOT_VISIBLE_FOR_ORGANIZATION", "NON_DEVICE", "NOT_AT_WAREHOUSE", "NOT_AVAILABLE_FOR_REUSE", "NOT_A_RENTAL", "NOT_MANAGEABLE_BY_ORGANIZATION", "NOT_WITH_ASSIGNMENT", "NOT_WITH_USER", "NO_ACTIVE_ADDONS", "NO_ACTIVE_STORAGE_CONTRACT", "NO_LOCATION_FOR_STORAGE", "NO_LOGISTICS_FOR_STORAGE", "NO_VALID_ADDONS", "ONGOING_SERVICE", "OWNED_BY_DEEL", "OWNED_BY_ORGANIZATION", "OWNED_BY_PARTNER_ORGANIZATION", "PARTNER_CHILD_CONTRACT", "PENDING_DEVICE_REFRESH", "RENTAL_CONTRACT_AND_USER_REGION_DO_NOT_MATCH", "TEMPORARILY_UNAVAILABLE", "UNKNOWN", "USER_HAS_NO_COUNTRY", "USER_HAS_NO_SEAT", "WAITING_FOR_CLEARANCE", "WITH_LOANER_ASSIGNMENT", "WITH_NON_COLLECTED_ASSIGNMENT", "WITH_NON_DELIVERED_ASSIGNMENT", "WITH_PENDING_ASSIGNMENT", "WRONG_ASSIGNMENT_STATUS", "WRONG_CONTRACT_STATUS", "WRONG_TERMS_AND_CONDITIONS" ], "title": "ItAssetsAssetIdCollectPostResponsesContentApplicationJsonSchemaDataActionsUnarchiveOwnAssetDisabledReasonsItems", "type": "string" }, "ItAssetsAssetIdCollectPostResponsesContentApplicationJsonSchemaDataActionsUnarchiveOwnAssetStatus": { "description": "Whether the action is currently available for this asset", "enum": [ "DISABLED", "ENABLED", "NOT_APPLICABLE" ], "title": "ItAssetsAssetIdCollectPostResponsesContentApplicationJsonSchemaDataActionsUnarchiveOwnAssetStatus", "type": "string" }, "ItAssetsAssetIdCollectPostResponsesContentApplicationJsonSchemaDataActionsUpdateLocationLocationToUser": { "description": "Update the location of an asset from a warehouse to a user", "properties": { "disabled_reasons": { "description": "Reasons why the action is disabled. Empty when the action is enabled or not applicable", "items": { "$ref": "#/components/schemas/ItAssetsAssetIdCollectPostResponsesContentApplicationJsonSchemaDataActionsUpdateLocationLocationToUserDisabledReasonsItems" }, "type": "array" }, "status": { "$ref": "#/components/schemas/ItAssetsAssetIdCollectPostResponsesContentApplicationJsonSchemaDataActionsUpdateLocationLocationToUserStatus", "description": "Whether the action is currently available for this asset" } }, "required": [ "status", "disabled_reasons" ], "title": "ItAssetsAssetIdCollectPostResponsesContentApplicationJsonSchemaDataActionsUpdateLocationLocationToUser", "type": "object" }, "ItAssetsAssetIdCollectPostResponsesContentApplicationJsonSchemaDataActionsUpdateLocationLocationToUserDisabledReasonsItems": { "enum": [ "ARCHIVED", "AT_DEEL_WAREHOUSE", "BEING_REPAIRED", "CONSUMABLE", "CONTROLLED_BY_DEEL", "COUNTRY_NOT_SUPPORTED_FOR_HUB", "COUNTRY_NOT_SUPPORTED_FOR_LOCAL", "DEEL_OWNED_ITEM_WITHOUT_RENTAL_CONTRACT", "DESKTOP_STORAGE", "ENDING_CONTRACT", "HUB_IN_SAME_REGION_AS_LOCAL", "INACTIVE", "INVALID_ITEM_LOCATION", "INVALID_ORGANIZATION_STATUS", "INVALID_STATE", "ITEM_CONDITIONS_TO_UNARCHIVE_NOT_MET", "ITEM_NOT_VISIBLE_FOR_ORGANIZATION", "NON_DEVICE", "NOT_AT_WAREHOUSE", "NOT_AVAILABLE_FOR_REUSE", "NOT_A_RENTAL", "NOT_MANAGEABLE_BY_ORGANIZATION", "NOT_WITH_ASSIGNMENT", "NOT_WITH_USER", "NO_ACTIVE_ADDONS", "NO_ACTIVE_STORAGE_CONTRACT", "NO_LOCATION_FOR_STORAGE", "NO_LOGISTICS_FOR_STORAGE", "NO_VALID_ADDONS", "ONGOING_SERVICE", "OWNED_BY_DEEL", "OWNED_BY_ORGANIZATION", "OWNED_BY_PARTNER_ORGANIZATION", "PARTNER_CHILD_CONTRACT", "PENDING_DEVICE_REFRESH", "RENTAL_CONTRACT_AND_USER_REGION_DO_NOT_MATCH", "TEMPORARILY_UNAVAILABLE", "UNKNOWN", "USER_HAS_NO_COUNTRY", "USER_HAS_NO_SEAT", "WAITING_FOR_CLEARANCE", "WITH_LOANER_ASSIGNMENT", "WITH_NON_COLLECTED_ASSIGNMENT", "WITH_NON_DELIVERED_ASSIGNMENT", "WITH_PENDING_ASSIGNMENT", "WRONG_ASSIGNMENT_STATUS", "WRONG_CONTRACT_STATUS", "WRONG_TERMS_AND_CONDITIONS" ], "title": "ItAssetsAssetIdCollectPostResponsesContentApplicationJsonSchemaDataActionsUpdateLocationLocationToUserDisabledReasonsItems", "type": "string" }, "ItAssetsAssetIdCollectPostResponsesContentApplicationJsonSchemaDataActionsUpdateLocationLocationToUserStatus": { "description": "Whether the action is currently available for this asset", "enum": [ "DISABLED", "ENABLED", "NOT_APPLICABLE" ], "title": "ItAssetsAssetIdCollectPostResponsesContentApplicationJsonSchemaDataActionsUpdateLocationLocationToUserStatus", "type": "string" }, "ItAssetsAssetIdCollectPostResponsesContentApplicationJsonSchemaDataActionsUpdateLocationUserToLocation": { "description": "Update the location of an asset from a user to a warehouse", "properties": { "disabled_reasons": { "description": "Reasons why the action is disabled. Empty when the action is enabled or not applicable", "items": { "$ref": "#/components/schemas/ItAssetsAssetIdCollectPostResponsesContentApplicationJsonSchemaDataActionsUpdateLocationUserToLocationDisabledReasonsItems" }, "type": "array" }, "status": { "$ref": "#/components/schemas/ItAssetsAssetIdCollectPostResponsesContentApplicationJsonSchemaDataActionsUpdateLocationUserToLocationStatus", "description": "Whether the action is currently available for this asset" } }, "required": [ "status", "disabled_reasons" ], "title": "ItAssetsAssetIdCollectPostResponsesContentApplicationJsonSchemaDataActionsUpdateLocationUserToLocation", "type": "object" }, "ItAssetsAssetIdCollectPostResponsesContentApplicationJsonSchemaDataActionsUpdateLocationUserToLocationDisabledReasonsItems": { "enum": [ "ARCHIVED", "AT_DEEL_WAREHOUSE", "BEING_REPAIRED", "CONSUMABLE", "CONTROLLED_BY_DEEL", "COUNTRY_NOT_SUPPORTED_FOR_HUB", "COUNTRY_NOT_SUPPORTED_FOR_LOCAL", "DEEL_OWNED_ITEM_WITHOUT_RENTAL_CONTRACT", "DESKTOP_STORAGE", "ENDING_CONTRACT", "HUB_IN_SAME_REGION_AS_LOCAL", "INACTIVE", "INVALID_ITEM_LOCATION", "INVALID_ORGANIZATION_STATUS", "INVALID_STATE", "ITEM_CONDITIONS_TO_UNARCHIVE_NOT_MET", "ITEM_NOT_VISIBLE_FOR_ORGANIZATION", "NON_DEVICE", "NOT_AT_WAREHOUSE", "NOT_AVAILABLE_FOR_REUSE", "NOT_A_RENTAL", "NOT_MANAGEABLE_BY_ORGANIZATION", "NOT_WITH_ASSIGNMENT", "NOT_WITH_USER", "NO_ACTIVE_ADDONS", "NO_ACTIVE_STORAGE_CONTRACT", "NO_LOCATION_FOR_STORAGE", "NO_LOGISTICS_FOR_STORAGE", "NO_VALID_ADDONS", "ONGOING_SERVICE", "OWNED_BY_DEEL", "OWNED_BY_ORGANIZATION", "OWNED_BY_PARTNER_ORGANIZATION", "PARTNER_CHILD_CONTRACT", "PENDING_DEVICE_REFRESH", "RENTAL_CONTRACT_AND_USER_REGION_DO_NOT_MATCH", "TEMPORARILY_UNAVAILABLE", "UNKNOWN", "USER_HAS_NO_COUNTRY", "USER_HAS_NO_SEAT", "WAITING_FOR_CLEARANCE", "WITH_LOANER_ASSIGNMENT", "WITH_NON_COLLECTED_ASSIGNMENT", "WITH_NON_DELIVERED_ASSIGNMENT", "WITH_PENDING_ASSIGNMENT", "WRONG_ASSIGNMENT_STATUS", "WRONG_CONTRACT_STATUS", "WRONG_TERMS_AND_CONDITIONS" ], "title": "ItAssetsAssetIdCollectPostResponsesContentApplicationJsonSchemaDataActionsUpdateLocationUserToLocationDisabledReasonsItems", "type": "string" }, "ItAssetsAssetIdCollectPostResponsesContentApplicationJsonSchemaDataActionsUpdateLocationUserToLocationStatus": { "description": "Whether the action is currently available for this asset", "enum": [ "DISABLED", "ENABLED", "NOT_APPLICABLE" ], "title": "ItAssetsAssetIdCollectPostResponsesContentApplicationJsonSchemaDataActionsUpdateLocationUserToLocationStatus", "type": "string" }, "ItAssetsAssetIdCollectPostResponsesContentApplicationJsonSchemaDataActionsUpdateLocationUserToUser": { "description": "Update the assigned user of an asset that is currently with a user", "properties": { "disabled_reasons": { "description": "Reasons why the action is disabled. Empty when the action is enabled or not applicable", "items": { "$ref": "#/components/schemas/ItAssetsAssetIdCollectPostResponsesContentApplicationJsonSchemaDataActionsUpdateLocationUserToUserDisabledReasonsItems" }, "type": "array" }, "status": { "$ref": "#/components/schemas/ItAssetsAssetIdCollectPostResponsesContentApplicationJsonSchemaDataActionsUpdateLocationUserToUserStatus", "description": "Whether the action is currently available for this asset" } }, "required": [ "status", "disabled_reasons" ], "title": "ItAssetsAssetIdCollectPostResponsesContentApplicationJsonSchemaDataActionsUpdateLocationUserToUser", "type": "object" }, "ItAssetsAssetIdCollectPostResponsesContentApplicationJsonSchemaDataActionsUpdateLocationUserToUserDisabledReasonsItems": { "enum": [ "ARCHIVED", "AT_DEEL_WAREHOUSE", "BEING_REPAIRED", "CONSUMABLE", "CONTROLLED_BY_DEEL", "COUNTRY_NOT_SUPPORTED_FOR_HUB", "COUNTRY_NOT_SUPPORTED_FOR_LOCAL", "DEEL_OWNED_ITEM_WITHOUT_RENTAL_CONTRACT", "DESKTOP_STORAGE", "ENDING_CONTRACT", "HUB_IN_SAME_REGION_AS_LOCAL", "INACTIVE", "INVALID_ITEM_LOCATION", "INVALID_ORGANIZATION_STATUS", "INVALID_STATE", "ITEM_CONDITIONS_TO_UNARCHIVE_NOT_MET", "ITEM_NOT_VISIBLE_FOR_ORGANIZATION", "NON_DEVICE", "NOT_AT_WAREHOUSE", "NOT_AVAILABLE_FOR_REUSE", "NOT_A_RENTAL", "NOT_MANAGEABLE_BY_ORGANIZATION", "NOT_WITH_ASSIGNMENT", "NOT_WITH_USER", "NO_ACTIVE_ADDONS", "NO_ACTIVE_STORAGE_CONTRACT", "NO_LOCATION_FOR_STORAGE", "NO_LOGISTICS_FOR_STORAGE", "NO_VALID_ADDONS", "ONGOING_SERVICE", "OWNED_BY_DEEL", "OWNED_BY_ORGANIZATION", "OWNED_BY_PARTNER_ORGANIZATION", "PARTNER_CHILD_CONTRACT", "PENDING_DEVICE_REFRESH", "RENTAL_CONTRACT_AND_USER_REGION_DO_NOT_MATCH", "TEMPORARILY_UNAVAILABLE", "UNKNOWN", "USER_HAS_NO_COUNTRY", "USER_HAS_NO_SEAT", "WAITING_FOR_CLEARANCE", "WITH_LOANER_ASSIGNMENT", "WITH_NON_COLLECTED_ASSIGNMENT", "WITH_NON_DELIVERED_ASSIGNMENT", "WITH_PENDING_ASSIGNMENT", "WRONG_ASSIGNMENT_STATUS", "WRONG_CONTRACT_STATUS", "WRONG_TERMS_AND_CONDITIONS" ], "title": "ItAssetsAssetIdCollectPostResponsesContentApplicationJsonSchemaDataActionsUpdateLocationUserToUserDisabledReasonsItems", "type": "string" }, "ItAssetsAssetIdCollectPostResponsesContentApplicationJsonSchemaDataActionsUpdateLocationUserToUserStatus": { "description": "Whether the action is currently available for this asset", "enum": [ "DISABLED", "ENABLED", "NOT_APPLICABLE" ], "title": "ItAssetsAssetIdCollectPostResponsesContentApplicationJsonSchemaDataActionsUpdateLocationUserToUserStatus", "type": "string" }, "ItAssetsAssetIdCollectPostResponsesContentApplicationJsonSchemaDataActionsUpdateOwnAssetDetails": { "description": "Update editable details of an organization-owned asset", "properties": { "disabled_reasons": { "description": "Reasons why the action is disabled. Empty when the action is enabled or not applicable", "items": { "$ref": "#/components/schemas/ItAssetsAssetIdCollectPostResponsesContentApplicationJsonSchemaDataActionsUpdateOwnAssetDetailsDisabledReasonsItems" }, "type": "array" }, "status": { "$ref": "#/components/schemas/ItAssetsAssetIdCollectPostResponsesContentApplicationJsonSchemaDataActionsUpdateOwnAssetDetailsStatus", "description": "Whether the action is currently available for this asset" } }, "required": [ "status", "disabled_reasons" ], "title": "ItAssetsAssetIdCollectPostResponsesContentApplicationJsonSchemaDataActionsUpdateOwnAssetDetails", "type": "object" }, "ItAssetsAssetIdCollectPostResponsesContentApplicationJsonSchemaDataActionsUpdateOwnAssetDetailsDisabledReasonsItems": { "enum": [ "ARCHIVED", "AT_DEEL_WAREHOUSE", "BEING_REPAIRED", "CONSUMABLE", "CONTROLLED_BY_DEEL", "COUNTRY_NOT_SUPPORTED_FOR_HUB", "COUNTRY_NOT_SUPPORTED_FOR_LOCAL", "DEEL_OWNED_ITEM_WITHOUT_RENTAL_CONTRACT", "DESKTOP_STORAGE", "ENDING_CONTRACT", "HUB_IN_SAME_REGION_AS_LOCAL", "INACTIVE", "INVALID_ITEM_LOCATION", "INVALID_ORGANIZATION_STATUS", "INVALID_STATE", "ITEM_CONDITIONS_TO_UNARCHIVE_NOT_MET", "ITEM_NOT_VISIBLE_FOR_ORGANIZATION", "NON_DEVICE", "NOT_AT_WAREHOUSE", "NOT_AVAILABLE_FOR_REUSE", "NOT_A_RENTAL", "NOT_MANAGEABLE_BY_ORGANIZATION", "NOT_WITH_ASSIGNMENT", "NOT_WITH_USER", "NO_ACTIVE_ADDONS", "NO_ACTIVE_STORAGE_CONTRACT", "NO_LOCATION_FOR_STORAGE", "NO_LOGISTICS_FOR_STORAGE", "NO_VALID_ADDONS", "ONGOING_SERVICE", "OWNED_BY_DEEL", "OWNED_BY_ORGANIZATION", "OWNED_BY_PARTNER_ORGANIZATION", "PARTNER_CHILD_CONTRACT", "PENDING_DEVICE_REFRESH", "RENTAL_CONTRACT_AND_USER_REGION_DO_NOT_MATCH", "TEMPORARILY_UNAVAILABLE", "UNKNOWN", "USER_HAS_NO_COUNTRY", "USER_HAS_NO_SEAT", "WAITING_FOR_CLEARANCE", "WITH_LOANER_ASSIGNMENT", "WITH_NON_COLLECTED_ASSIGNMENT", "WITH_NON_DELIVERED_ASSIGNMENT", "WITH_PENDING_ASSIGNMENT", "WRONG_ASSIGNMENT_STATUS", "WRONG_CONTRACT_STATUS", "WRONG_TERMS_AND_CONDITIONS" ], "title": "ItAssetsAssetIdCollectPostResponsesContentApplicationJsonSchemaDataActionsUpdateOwnAssetDetailsDisabledReasonsItems", "type": "string" }, "ItAssetsAssetIdCollectPostResponsesContentApplicationJsonSchemaDataActionsUpdateOwnAssetDetailsStatus": { "description": "Whether the action is currently available for this asset", "enum": [ "DISABLED", "ENABLED", "NOT_APPLICABLE" ], "title": "ItAssetsAssetIdCollectPostResponsesContentApplicationJsonSchemaDataActionsUpdateOwnAssetDetailsStatus", "type": "string" }, "ItAssetsAssetIdCollectPostResponsesContentApplicationJsonSchemaDataAssignedUser": { "description": "Details of the user with asset possession", "properties": { "emails": { "description": "Array of user email addresses", "items": { "format": "email", "type": "string" }, "type": "array" }, "first_name": { "description": "First name of the user", "type": "string" }, "hris_profile_id": { "description": "The unique identifier of the HRIS profile of the assigned user", "format": "uuid", "type": "string" }, "last_name": { "description": "Last name of the user", "type": "string" } }, "required": [ "emails", "last_name", "first_name", "hris_profile_id" ], "title": "ItAssetsAssetIdCollectPostResponsesContentApplicationJsonSchemaDataAssignedUser", "type": "object" }, "ItAssetsAssetIdCollectPostResponsesContentApplicationJsonSchemaDataAssignedWarehouse": { "description": "Details of the warehouse with asset possession", "properties": { "address": { "$ref": "#/components/schemas/ItAssetsAssetIdCollectPostResponsesContentApplicationJsonSchemaDataAssignedWarehouseAddress", "description": "Warehouse address details" }, "id": { "description": "Unique identifier of the warehouse", "format": "uuid", "type": "string" }, "name": { "description": "Warehouse or storage location name", "type": "string" }, "ownership": { "$ref": "#/components/schemas/ItAssetsAssetIdCollectPostResponsesContentApplicationJsonSchemaDataAssignedWarehouseOwnership", "description": "Warehouse ownership type" }, "public_id": { "description": "Public identifier of the warehouse", "type": "string" }, "warehouse_type": { "$ref": "#/components/schemas/ItAssetsAssetIdCollectPostResponsesContentApplicationJsonSchemaDataAssignedWarehouseWarehouseType", "description": "Warehouse type" } }, "required": [ "id", "name", "address", "ownership", "public_id", "warehouse_type" ], "title": "ItAssetsAssetIdCollectPostResponsesContentApplicationJsonSchemaDataAssignedWarehouse", "type": "object" }, "ItAssetsAssetIdCollectPostResponsesContentApplicationJsonSchemaDataAssignedWarehouseAddress": { "description": "Warehouse address details", "properties": { "city": { "description": "City name", "type": [ "string", "null" ] }, "country": { "$ref": "#/components/schemas/ItAssetsAssetIdCollectPostResponsesContentApplicationJsonSchemaDataAssignedWarehouseAddressCountry", "description": "Country code" }, "date_of_birth": { "description": "Date of birth (applicable for some address types)", "format": "date", "type": [ "string", "null" ] }, "delivery_instructions": { "description": "Special instructions for deliveries", "type": [ "string", "null" ] }, "id": { "description": "Unique identifier of the address", "format": "uuid", "type": "string" }, "is_valid": { "description": "Whether the address passes validation", "type": "boolean" }, "line1": { "description": "Address line 1", "type": [ "string", "null" ] }, "line2": { "description": "Address line 2", "type": [ "string", "null" ] }, "passport_number": { "description": "Passport number (applicable for some address types)", "type": [ "string", "null" ] }, "phone_number": { "description": "Phone number", "type": [ "string", "null" ] }, "post_code": { "description": "Post code", "type": [ "string", "null" ] }, "state": { "description": "State code or name", "type": [ "string", "null" ] }, "tax_id_number": { "description": "Tax ID number (applicable for some address types)", "type": [ "string", "null" ] }, "type": { "$ref": "#/components/schemas/ItAssetsAssetIdCollectPostResponsesContentApplicationJsonSchemaDataAssignedWarehouseAddressType", "description": "Type of the address" } }, "required": [ "id", "city", "type", "line1", "line2", "state", "country", "is_valid", "post_code", "phone_number", "date_of_birth", "tax_id_number", "passport_number", "delivery_instructions" ], "title": "ItAssetsAssetIdCollectPostResponsesContentApplicationJsonSchemaDataAssignedWarehouseAddress", "type": "object" }, "ItAssetsAssetIdCollectPostResponsesContentApplicationJsonSchemaDataAssignedWarehouseAddressCountry": { "description": "Country code", "enum": [ "AD", "AE", "AF", "AG", "AI", "AL", "AM", "AN", "AO", "AQ", "AR", "AS", "AT", "AU", "AW", "AX", "AZ", "BA", "BB", "BD", "BE", "BF", "BG", "BH", "BI", "BJ", "BL", "BM", "BN", "BO", "BQ", "BR", "BS", "BT", "BV", "BW", "BY", "BZ", "CA", "CC", "CD", "CF", "CG", "CH", "CI", "CK", "CL", "CM", "CN", "CO", "CR", "CU", "CV", "CW", "CX", "CY", "CZ", "DE", "DJ", "DK", "DM", "DO", "DZ", "EC", "EE", "EG", "EH", "ER", "ES", "ET", "FI", "FJ", "FK", "FM", "FO", "FR", "GA", "GB", "GD", "GE", "GF", "GG", "GH", "GI", "GL", "GM", "GN", "GP", "GQ", "GR", "GS", "GT", "GU", "GW", "GY", "HK", "HM", "HN", "HR", "HT", "HU", "IC", "ID", "IE", "IL", "IM", "IN", "IO", "IQ", "IR", "IS", "IT", "JE", "JM", "JO", "JP", "KE", "KG", "KH", "KI", "KM", "KN", "KP", "KR", "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", "XK", "YE", "YT", "ZA", "ZM", "ZW" ], "title": "ItAssetsAssetIdCollectPostResponsesContentApplicationJsonSchemaDataAssignedWarehouseAddressCountry", "type": "string" }, "ItAssetsAssetIdCollectPostResponsesContentApplicationJsonSchemaDataAssignedWarehouseAddressType": { "description": "Type of the address", "enum": [ "BILLING", "COLLECTION", "DELIVERY", "ENTITY", "PARTIAL", "PII", "SUPPLIER" ], "title": "ItAssetsAssetIdCollectPostResponsesContentApplicationJsonSchemaDataAssignedWarehouseAddressType", "type": "string" }, "ItAssetsAssetIdCollectPostResponsesContentApplicationJsonSchemaDataAssignedWarehouseOwnership": { "description": "Warehouse ownership type", "enum": [ "DEEL", "ORGANIZATION" ], "title": "ItAssetsAssetIdCollectPostResponsesContentApplicationJsonSchemaDataAssignedWarehouseOwnership", "type": "string" }, "ItAssetsAssetIdCollectPostResponsesContentApplicationJsonSchemaDataAssignedWarehouseWarehouseType": { "description": "Warehouse type", "enum": [ "CLEARANCE", "DEEL", "ORGANIZATION" ], "title": "ItAssetsAssetIdCollectPostResponsesContentApplicationJsonSchemaDataAssignedWarehouseWarehouseType", "type": "string" }, "ItAssetsAssetIdCollectPostResponsesContentApplicationJsonSchemaDataGrade": { "description": "The condition grade of the asset", "enum": [ "A", "B", "C", "D", "F", "NEW" ], "title": "ItAssetsAssetIdCollectPostResponsesContentApplicationJsonSchemaDataGrade", "type": "string" }, "ItAssetsAssetIdCollectPostResponsesContentApplicationJsonSchemaDataLocation": { "description": "Current location type of the asset", "enum": [ "AT_WAREHOUSE", "CLEARANCE_WAREHOUSE", "DEEL_WAREHOUSE", "ORGANIZATION_WAREHOUSE", "SUPPLIER", "WITH_COURIER", "WITH_USER", "WRITE_OFF" ], "title": "ItAssetsAssetIdCollectPostResponsesContentApplicationJsonSchemaDataLocation", "type": "string" }, "ItAssetsAssetIdCollectPostResponsesContentApplicationJsonSchemaDataOwnership": { "description": "Asset owner", "properties": { "name": { "description": "Asset owner name", "type": "string" }, "type": { "$ref": "#/components/schemas/ItAssetsAssetIdCollectPostResponsesContentApplicationJsonSchemaDataOwnershipType", "description": "Asset owner type" } }, "required": [ "name", "type" ], "title": "ItAssetsAssetIdCollectPostResponsesContentApplicationJsonSchemaDataOwnership", "type": "object" }, "ItAssetsAssetIdCollectPostResponsesContentApplicationJsonSchemaDataOwnershipType": { "description": "Asset owner type", "enum": [ "DEEL", "ORGANIZATION" ], "title": "ItAssetsAssetIdCollectPostResponsesContentApplicationJsonSchemaDataOwnershipType", "type": "string" }, "ItAssetsAssetIdCollectPostResponsesContentApplicationJsonSchemaDataProduct": { "description": "Product details", "properties": { "brand": { "description": "Product brand", "type": "string" }, "category": { "$ref": "#/components/schemas/ItAssetsAssetIdCollectPostResponsesContentApplicationJsonSchemaDataProductCategory", "description": "Product category" }, "id": { "description": "Unique identifier of the product", "format": "uuid", "type": "string" }, "name": { "description": "Product name", "type": "string" }, "specifications": { "description": "Specifications of the product", "items": { "$ref": "#/components/schemas/ItAssetsAssetIdCollectPostResponsesContentApplicationJsonSchemaDataProductSpecificationsItems" }, "type": "array" } }, "required": [ "id", "name", "brand", "category", "specifications" ], "title": "ItAssetsAssetIdCollectPostResponsesContentApplicationJsonSchemaDataProduct", "type": "object" }, "ItAssetsAssetIdCollectPostResponsesContentApplicationJsonSchemaDataProductCategory": { "description": "Product category", "enum": [ "ADAPTER", "CABLE", "CHAIR", "CHARGER", "COMPACT_DESKTOP", "DESK", "DESKTOP", "DESK_RISER", "DESK_TIDY", "DOCKING_STATION", "DONGLE", "FOOTREST", "HEADSET", "KEYBOARD", "LAPTOP", "LAPTOP_STAND", "MICE_TRACKPAD", "MOBILE_DEVICE", "MONITOR", "MONITOR_ARM", "OTHER", "PRINTER", "SHREDDER", "STANDING_MAT", "TABLET", "TASK_LIGHT", "WEBCAM", "WELCOME_PACK", "WIFI_RANGE_EXTENDER" ], "title": "ItAssetsAssetIdCollectPostResponsesContentApplicationJsonSchemaDataProductCategory", "type": "string" }, "ItAssetsAssetIdCollectPostResponsesContentApplicationJsonSchemaDataProductSpecificationsItems": { "properties": { "name": { "description": "Specification name", "type": "string" }, "value": { "description": "Specification value", "type": "string" } }, "required": [ "name", "value" ], "title": "ItAssetsAssetIdCollectPostResponsesContentApplicationJsonSchemaDataProductSpecificationsItems", "type": "object" }, "ItAssetsAssetIdCollectPostResponsesContentApplicationJsonSchemaDataPurchaseValue": { "description": "Purchase value of the asset", "properties": { "amount": { "description": "Amount", "format": "decimal", "type": "string" }, "currency": { "$ref": "#/components/schemas/ItAssetsAssetIdCollectPostResponsesContentApplicationJsonSchemaDataPurchaseValueCurrency", "description": "Three-letter currency code for the price" } }, "required": [ "amount", "currency" ], "title": "ItAssetsAssetIdCollectPostResponsesContentApplicationJsonSchemaDataPurchaseValue", "type": "object" }, "ItAssetsAssetIdCollectPostResponsesContentApplicationJsonSchemaDataPurchaseValueCurrency": { "description": "Three-letter currency code for the price", "enum": [ "AED", "AFN", "ALL", "AMD", "ANG", "AOA", "ARS", "AUD", "AWG", "AZN", "BAM", "BDT", "BGN", "BHD", "BIF", "BMD", "BOB", "BRL", "BSD", "BTN", "BWP", "BYN", "BZD", "CAD", "CDF", "CHF", "CLP", "CNY", "COP", "CRC", "CUC", "CVE", "CZK", "DJF", "DKK", "DOP", "DZD", "EGP", "ERN", "ETB", "EUR", "FJD", "FKP", "GBP", "GEL", "GHS", "GIP", "GMD", "GNF", "GTQ", "GYD", "HKD", "HNL", "HRK", "HTG", "HUF", "IDR", "ILS", "INR", "IQD", "IRR", "ISK", "JMD", "JOD", "JPY", "KES", "KGS", "KHR", "KMF", "KPW", "KRW", "KWD", "KYD", "KZT", "LAK", "LBP", "LKR", "LRD", "LSL", "LTL", "LYD", "MAD", "MDL", "MGA", "MKD", "MMK", "MNT", "MRU", "MUR", "MVR", "MWK", "MXN", "MYR", "MZN", "NAD", "NGN", "NIO", "NOK", "NPR", "NZD", "OMR", "PAB", "PEN", "PGK", "PHP", "PKR", "PLN", "PYG", "QAR", "RON", "RSD", "RUB", "RWF", "SAR", "SBD", "SCR", "SDG", "SEK", "SGD", "SHP", "SLL", "SOS", "SRD", "SSP", "STD", "SYP", "SZL", "THB", "TJS", "TMT", "TND", "TOP", "TRY", "TTD", "TWD", "TZS", "UAH", "UGX", "USD", "UYU", "UZS", "VEF", "VND", "VUV", "WST", "XAF", "XCD", "XOF", "XPF", "YER", "ZAR", "ZMW", "ZWD" ], "title": "ItAssetsAssetIdCollectPostResponsesContentApplicationJsonSchemaDataPurchaseValueCurrency", "type": "string" }, "ItAssetsAssetIdCollectPostResponsesContentApplicationJsonSchemaDataStatus": { "description": "Current state of the asset", "enum": [ "ACTIVE", "ADDED_BY_MISTAKE", "BEING_REPAIRED", "BINNED", "BROKEN_AT_WAREHOUSE", "BROKEN_BY_USER", "BROKEN_IN_TRANSIT", "CLEARED", "DAMAGED_AT_WAREHOUSE", "DAMAGED_BY_USER", "DAMAGED_IN_TRANSIT", "LEFT_WITH_USER", "LOST_IN_TRANSIT", "RETURNED_TO_DEEL", "SHRINKAGE", "STOLEN", "SUPPLIER_RETURN", "WAITING_FOR_CLEARANCE" ], "title": "ItAssetsAssetIdCollectPostResponsesContentApplicationJsonSchemaDataStatus", "type": "string" }, "ItAssetsAssetIdCollectPostResponsesContentApplicationJsonSchemaErrorsItems": { "properties": { "code": { "description": "Error code of the handler which produced the returned error", "type": "string" }, "field": { "description": "The field name where input validation failed", "type": [ "string", "null" ] }, "message": { "description": "Description of the returned error", "type": "string" } }, "required": [ "code", "field", "message" ], "title": "ItAssetsAssetIdCollectPostResponsesContentApplicationJsonSchemaErrorsItems", "type": "object" }, "ItAssetsAssetIdDeliverPostParametersXBeta": { "default": "true", "enum": [ "true" ], "title": "ItAssetsAssetIdDeliverPostParametersXBeta", "type": "string" }, "ItAssetsAssetIdDeliverPostRequestBodyContentApplicationJsonSchemaData": { "properties": { "delivery_address": { "$ref": "#/components/schemas/ItAssetsAssetIdDeliverPostRequestBodyContentApplicationJsonSchemaDataDeliveryAddress", "description": "Delivery address for the recipient. Optional when the HRIS profile already has a valid delivery address on file." }, "hris_profile_id": { "description": "HRIS profile identifier of the recipient.", "format": "uuid", "type": "string" }, "is_express_delivery": { "description": "Whether express delivery is requested. Defaults to false. Charges an express fee where the country supports express delivery.", "type": "boolean" }, "shipment_insurance": { "$ref": "#/components/schemas/ItAssetsAssetIdDeliverPostRequestBodyContentApplicationJsonSchemaDataShipmentInsurance", "description": "Insurance-consent flag and optional purchase details Deel records against the asset. Required unless the asset is already at a Deel warehouse." } }, "required": [ "hris_profile_id", "is_express_delivery" ], "title": "ItAssetsAssetIdDeliverPostRequestBodyContentApplicationJsonSchemaData", "type": "object" }, "ItAssetsAssetIdDeliverPostRequestBodyContentApplicationJsonSchemaDataDeliveryAddress": { "description": "Delivery address for the recipient. Optional when the HRIS profile already has a valid delivery address on file.", "properties": { "city": { "description": "City name", "type": "string" }, "country": { "$ref": "#/components/schemas/ItAssetsAssetIdDeliverPostRequestBodyContentApplicationJsonSchemaDataDeliveryAddressCountry", "description": "Country code (ISO 3166 alpha-2)" }, "date_of_birth": { "description": "Date of birth", "format": "date", "type": "string" }, "delivery_instructions": { "description": "Delivery instructions for the courier", "type": "string" }, "line1": { "description": "Address line 1", "type": "string" }, "line2": { "description": "Address line 2", "type": "string" }, "passport_number": { "description": "Passport number", "type": "string" }, "phone_number": { "description": "Phone number in E.164 format", "type": "string" }, "post_code": { "description": "Post code", "type": "string" }, "state": { "description": "State or region name", "type": "string" }, "tax_id_number": { "description": "Tax ID number", "type": "string" } }, "required": [ "country" ], "title": "ItAssetsAssetIdDeliverPostRequestBodyContentApplicationJsonSchemaDataDeliveryAddress", "type": "object" }, "ItAssetsAssetIdDeliverPostRequestBodyContentApplicationJsonSchemaDataDeliveryAddressCountry": { "description": "Country code (ISO 3166 alpha-2)", "enum": [ "AD", "AE", "AF", "AG", "AI", "AL", "AM", "AN", "AO", "AQ", "AR", "AS", "AT", "AU", "AW", "AX", "AZ", "BA", "BB", "BD", "BE", "BF", "BG", "BH", "BI", "BJ", "BL", "BM", "BN", "BO", "BQ", "BR", "BS", "BT", "BV", "BW", "BY", "BZ", "CA", "CC", "CD", "CF", "CG", "CH", "CI", "CK", "CL", "CM", "CN", "CO", "CR", "CU", "CV", "CW", "CX", "CY", "CZ", "DE", "DJ", "DK", "DM", "DO", "DZ", "EC", "EE", "EG", "EH", "ER", "ES", "ET", "FI", "FJ", "FK", "FM", "FO", "FR", "GA", "GB", "GD", "GE", "GF", "GG", "GH", "GI", "GL", "GM", "GN", "GP", "GQ", "GR", "GS", "GT", "GU", "GW", "GY", "HK", "HM", "HN", "HR", "HT", "HU", "IC", "ID", "IE", "IL", "IM", "IN", "IO", "IQ", "IR", "IS", "IT", "JE", "JM", "JO", "JP", "KE", "KG", "KH", "KI", "KM", "KN", "KP", "KR", "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", "XK", "YE", "YT", "ZA", "ZM", "ZW" ], "title": "ItAssetsAssetIdDeliverPostRequestBodyContentApplicationJsonSchemaDataDeliveryAddressCountry", "type": "string" }, "ItAssetsAssetIdDeliverPostRequestBodyContentApplicationJsonSchemaDataShipmentInsurance": { "description": "Insurance-consent flag and optional purchase details Deel records against the asset. Required unless the asset is already at a Deel warehouse.", "properties": { "is_waived": { "description": "Consent to ship without insurance. When true, `purchase_details` must be omitted and Deel will not record a purchase price against the asset.", "type": "boolean" }, "purchase_details": { "$ref": "#/components/schemas/ItAssetsAssetIdDeliverPostRequestBodyContentApplicationJsonSchemaDataShipmentInsurancePurchaseDetails", "description": "Purchase details Deel records against the asset. Omit to fall back to purchase details already stored on the asset, if any. Must be omitted when `is_waived` is true." } }, "required": [ "is_waived" ], "title": "ItAssetsAssetIdDeliverPostRequestBodyContentApplicationJsonSchemaDataShipmentInsurance", "type": "object" }, "ItAssetsAssetIdDeliverPostRequestBodyContentApplicationJsonSchemaDataShipmentInsurancePurchaseDetails": { "description": "Purchase details Deel records against the asset. Omit to fall back to purchase details already stored on the asset, if any. Must be omitted when `is_waived` is true.", "properties": { "date": { "description": "Date the asset was purchased.", "format": "date", "type": "string" }, "price": { "$ref": "#/components/schemas/ItAssetsAssetIdDeliverPostRequestBodyContentApplicationJsonSchemaDataShipmentInsurancePurchaseDetailsPrice", "description": "Purchase price paid for the asset." } }, "required": [ "date", "price" ], "title": "ItAssetsAssetIdDeliverPostRequestBodyContentApplicationJsonSchemaDataShipmentInsurancePurchaseDetails", "type": "object" }, "ItAssetsAssetIdDeliverPostRequestBodyContentApplicationJsonSchemaDataShipmentInsurancePurchaseDetailsPrice": { "description": "Purchase price paid for the asset.", "properties": { "amount": { "description": "Amount", "format": "decimal", "type": "string" }, "currency": { "$ref": "#/components/schemas/ItAssetsAssetIdDeliverPostRequestBodyContentApplicationJsonSchemaDataShipmentInsurancePurchaseDetailsPriceCurrency", "description": "Three-letter currency code for the price" } }, "required": [ "amount", "currency" ], "title": "ItAssetsAssetIdDeliverPostRequestBodyContentApplicationJsonSchemaDataShipmentInsurancePurchaseDetailsPrice", "type": "object" }, "ItAssetsAssetIdDeliverPostRequestBodyContentApplicationJsonSchemaDataShipmentInsurancePurchaseDetailsPriceCurrency": { "description": "Three-letter currency code for the price", "enum": [ "AED", "AFN", "ALL", "AMD", "ANG", "AOA", "ARS", "AUD", "AWG", "AZN", "BAM", "BDT", "BGN", "BHD", "BIF", "BMD", "BOB", "BRL", "BSD", "BTN", "BWP", "BYN", "BZD", "CAD", "CDF", "CHF", "CLP", "CNY", "COP", "CRC", "CUC", "CVE", "CZK", "DJF", "DKK", "DOP", "DZD", "EGP", "ERN", "ETB", "EUR", "FJD", "FKP", "GBP", "GEL", "GHS", "GIP", "GMD", "GNF", "GTQ", "GYD", "HKD", "HNL", "HRK", "HTG", "HUF", "IDR", "ILS", "INR", "IQD", "IRR", "ISK", "JMD", "JOD", "JPY", "KES", "KGS", "KHR", "KMF", "KPW", "KRW", "KWD", "KYD", "KZT", "LAK", "LBP", "LKR", "LRD", "LSL", "LTL", "LYD", "MAD", "MDL", "MGA", "MKD", "MMK", "MNT", "MRU", "MUR", "MVR", "MWK", "MXN", "MYR", "MZN", "NAD", "NGN", "NIO", "NOK", "NPR", "NZD", "OMR", "PAB", "PEN", "PGK", "PHP", "PKR", "PLN", "PYG", "QAR", "RON", "RSD", "RUB", "RWF", "SAR", "SBD", "SCR", "SDG", "SEK", "SGD", "SHP", "SLL", "SOS", "SRD", "SSP", "STD", "SYP", "SZL", "THB", "TJS", "TMT", "TND", "TOP", "TRY", "TTD", "TWD", "TZS", "UAH", "UGX", "USD", "UYU", "UZS", "VEF", "VND", "VUV", "WST", "XAF", "XCD", "XOF", "XPF", "YER", "ZAR", "ZMW", "ZWD" ], "title": "ItAssetsAssetIdDeliverPostRequestBodyContentApplicationJsonSchemaDataShipmentInsurancePurchaseDetailsPriceCurrency", "type": "string" }, "ItAssetsAssetIdDeliverPostResponsesContentApplicationJsonSchemaData": { "properties": { "actions": { "$ref": "#/components/schemas/ItAssetsAssetIdDeliverPostResponsesContentApplicationJsonSchemaDataActions", "description": "Actions the caller can execute on this asset, with availability status per action" }, "assigned_user": { "description": "Details of the user with asset possession", "oneOf": [ { "$ref": "#/components/schemas/ItAssetsAssetIdDeliverPostResponsesContentApplicationJsonSchemaDataAssignedUser" }, { "type": "null" } ] }, "assigned_warehouse": { "description": "Details of the warehouse with asset possession", "oneOf": [ { "$ref": "#/components/schemas/ItAssetsAssetIdDeliverPostResponsesContentApplicationJsonSchemaDataAssignedWarehouse" }, { "type": "null" } ] }, "created_at": { "description": "Creation timestamp of the asset", "format": "date-time", "type": "string" }, "grade": { "$ref": "#/components/schemas/ItAssetsAssetIdDeliverPostResponsesContentApplicationJsonSchemaDataGrade", "description": "The condition grade of the asset" }, "id": { "description": "Unique identifier of the item", "format": "uuid", "type": "string" }, "location": { "$ref": "#/components/schemas/ItAssetsAssetIdDeliverPostResponsesContentApplicationJsonSchemaDataLocation", "description": "Current location type of the asset" }, "ownership": { "$ref": "#/components/schemas/ItAssetsAssetIdDeliverPostResponsesContentApplicationJsonSchemaDataOwnership", "description": "Asset owner" }, "product": { "$ref": "#/components/schemas/ItAssetsAssetIdDeliverPostResponsesContentApplicationJsonSchemaDataProduct", "description": "Product details" }, "public_id": { "description": "Public identifier of the item", "type": "string" }, "purchase_date": { "description": "Purchase date of the asset", "format": "date", "type": [ "string", "null" ] }, "purchase_value": { "description": "Purchase value of the asset", "oneOf": [ { "$ref": "#/components/schemas/ItAssetsAssetIdDeliverPostResponsesContentApplicationJsonSchemaDataPurchaseValue" }, { "type": "null" } ] }, "serial_number": { "description": "Asset serial number", "type": [ "string", "null" ] }, "status": { "$ref": "#/components/schemas/ItAssetsAssetIdDeliverPostResponsesContentApplicationJsonSchemaDataStatus", "description": "Current state of the asset" }, "updated_at": { "description": "Last update timestamp of the asset", "format": "date-time", "type": "string" } }, "required": [ "id", "grade", "status", "actions", "product", "location", "ownership", "public_id", "created_at", "updated_at", "assigned_user", "purchase_date", "serial_number", "purchase_value", "assigned_warehouse" ], "title": "ItAssetsAssetIdDeliverPostResponsesContentApplicationJsonSchemaData", "type": "object" }, "ItAssetsAssetIdDeliverPostResponsesContentApplicationJsonSchemaDataActions": { "description": "Actions the caller can execute on this asset, with availability status per action", "properties": { "archive_own_asset": { "$ref": "#/components/schemas/ItAssetsAssetIdDeliverPostResponsesContentApplicationJsonSchemaDataActionsArchiveOwnAsset", "description": "Archive an organization-owned asset" }, "asset_country": { "description": "Resolved country used for asset actions. Derived from the asset's country,\nits assigned rental contract billing entity country, or the last active\nassignment delivery country. Null when the country cannot be determined\n(e.g. asset was returned to Deel)", "oneOf": [ { "$ref": "#/components/schemas/ItAssetsAssetIdDeliverPostResponsesContentApplicationJsonSchemaDataActionsAssetCountry" }, { "type": "null" } ] }, "assign_addon_to_own_asset": { "$ref": "#/components/schemas/ItAssetsAssetIdDeliverPostResponsesContentApplicationJsonSchemaDataActionsAssignAddonToOwnAsset", "description": "Assign an add-on to an organization-owned asset" }, "clear_own_asset": { "$ref": "#/components/schemas/ItAssetsAssetIdDeliverPostResponsesContentApplicationJsonSchemaDataActionsClearOwnAsset", "description": "Clear an organization-owned asset from the fleet" }, "manage_end_of_rental_contract_actions": { "$ref": "#/components/schemas/ItAssetsAssetIdDeliverPostResponsesContentApplicationJsonSchemaDataActionsManageEndOfRentalContractActions", "description": "Manage end-of-rental options for a Deel-owned rental asset" }, "purchase_rental": { "$ref": "#/components/schemas/ItAssetsAssetIdDeliverPostResponsesContentApplicationJsonSchemaDataActionsPurchaseRental", "description": "Purchase a Deel-owned rental asset at end of contract" }, "return_rental_to_deel": { "$ref": "#/components/schemas/ItAssetsAssetIdDeliverPostResponsesContentApplicationJsonSchemaDataActionsReturnRentalToDeel", "description": "Return a Deel-owned rental asset back to Deel" }, "reuse_own_asset_from_deel": { "$ref": "#/components/schemas/ItAssetsAssetIdDeliverPostResponsesContentApplicationJsonSchemaDataActionsReuseOwnAssetFromDeel", "description": "Redeploy an organization-owned asset stored at a Deel warehouse" }, "reuse_own_asset_from_own_location": { "$ref": "#/components/schemas/ItAssetsAssetIdDeliverPostResponsesContentApplicationJsonSchemaDataActionsReuseOwnAssetFromOwnLocation", "description": "Redeploy an organization-owned asset from an organization-owned location" }, "store_own_asset_at_deel_for_hub": { "$ref": "#/components/schemas/ItAssetsAssetIdDeliverPostResponsesContentApplicationJsonSchemaDataActionsStoreOwnAssetAtDeelForHub", "description": "Store an organization-owned asset at a Deel hub warehouse" }, "store_own_asset_at_deel_for_local": { "$ref": "#/components/schemas/ItAssetsAssetIdDeliverPostResponsesContentApplicationJsonSchemaDataActionsStoreOwnAssetAtDeelForLocal", "description": "Store an organization-owned asset at a Deel local warehouse" }, "store_own_asset_at_own_location": { "$ref": "#/components/schemas/ItAssetsAssetIdDeliverPostResponsesContentApplicationJsonSchemaDataActionsStoreOwnAssetAtOwnLocation", "description": "Store an organization-owned asset at an organization-owned location" }, "store_rental_at_deel_for_local": { "$ref": "#/components/schemas/ItAssetsAssetIdDeliverPostResponsesContentApplicationJsonSchemaDataActionsStoreRentalAtDeelForLocal", "description": "Store a Deel-owned rental asset at a Deel local warehouse" }, "store_rental_at_deel_for_zone1": { "$ref": "#/components/schemas/ItAssetsAssetIdDeliverPostResponsesContentApplicationJsonSchemaDataActionsStoreRentalAtDeelForZone1", "description": "Store a Deel-owned rental asset at a Deel zone-1 warehouse" }, "transfer_own_asset": { "$ref": "#/components/schemas/ItAssetsAssetIdDeliverPostResponsesContentApplicationJsonSchemaDataActionsTransferOwnAsset", "description": "Transfer an organization-owned asset to another user" }, "transfer_rental": { "$ref": "#/components/schemas/ItAssetsAssetIdDeliverPostResponsesContentApplicationJsonSchemaDataActionsTransferRental", "description": "Transfer a Deel-owned rental asset to another user" }, "unarchive_own_asset": { "$ref": "#/components/schemas/ItAssetsAssetIdDeliverPostResponsesContentApplicationJsonSchemaDataActionsUnarchiveOwnAsset", "description": "Unarchive a previously archived organization-owned asset" }, "update_location_location_to_user": { "$ref": "#/components/schemas/ItAssetsAssetIdDeliverPostResponsesContentApplicationJsonSchemaDataActionsUpdateLocationLocationToUser", "description": "Update the location of an asset from a warehouse to a user" }, "update_location_user_to_location": { "$ref": "#/components/schemas/ItAssetsAssetIdDeliverPostResponsesContentApplicationJsonSchemaDataActionsUpdateLocationUserToLocation", "description": "Update the location of an asset from a user to a warehouse" }, "update_location_user_to_user": { "$ref": "#/components/schemas/ItAssetsAssetIdDeliverPostResponsesContentApplicationJsonSchemaDataActionsUpdateLocationUserToUser", "description": "Update the assigned user of an asset that is currently with a user" }, "update_own_asset_details": { "$ref": "#/components/schemas/ItAssetsAssetIdDeliverPostResponsesContentApplicationJsonSchemaDataActionsUpdateOwnAssetDetails", "description": "Update editable details of an organization-owned asset" } }, "required": [ "asset_country", "clear_own_asset", "purchase_rental", "transfer_rental", "archive_own_asset", "transfer_own_asset", "unarchive_own_asset", "return_rental_to_deel", "update_own_asset_details", "assign_addon_to_own_asset", "reuse_own_asset_from_deel", "update_location_user_to_user", "store_rental_at_deel_for_local", "store_rental_at_deel_for_zone1", "store_own_asset_at_deel_for_hub", "store_own_asset_at_own_location", "update_location_location_to_user", "update_location_user_to_location", "reuse_own_asset_from_own_location", "store_own_asset_at_deel_for_local", "manage_end_of_rental_contract_actions" ], "title": "ItAssetsAssetIdDeliverPostResponsesContentApplicationJsonSchemaDataActions", "type": "object" }, "ItAssetsAssetIdDeliverPostResponsesContentApplicationJsonSchemaDataActionsArchiveOwnAsset": { "description": "Archive an organization-owned asset", "properties": { "details": { "description": "Action-specific context needed to perform the action. Populated for enabled and\ndisabled actions (so callers can see what a successful attempt would look like);\nnull when the action is not applicable to this asset.", "oneOf": [ { "$ref": "#/components/schemas/ItAssetsAssetIdDeliverPostResponsesContentApplicationJsonSchemaDataActionsArchiveOwnAssetDetails" }, { "type": "null" } ] }, "disabled_reasons": { "description": "Reasons why the action is disabled. Empty when the action is enabled or not applicable", "items": { "$ref": "#/components/schemas/ItAssetsAssetIdDeliverPostResponsesContentApplicationJsonSchemaDataActionsArchiveOwnAssetDisabledReasonsItems" }, "type": "array" }, "status": { "$ref": "#/components/schemas/ItAssetsAssetIdDeliverPostResponsesContentApplicationJsonSchemaDataActionsArchiveOwnAssetStatus", "description": "Whether the action is currently available for this asset" } }, "required": [ "status", "details", "disabled_reasons" ], "title": "ItAssetsAssetIdDeliverPostResponsesContentApplicationJsonSchemaDataActionsArchiveOwnAsset", "type": "object" }, "ItAssetsAssetIdDeliverPostResponsesContentApplicationJsonSchemaDataActionsArchiveOwnAssetDetails": { "description": "Action-specific context needed to perform the action. Populated for enabled and\ndisabled actions (so callers can see what a successful attempt would look like);\nnull when the action is not applicable to this asset.", "properties": { "allowed_statuses": { "description": "Statuses that can be passed as the archive reason when archiving the asset", "items": { "$ref": "#/components/schemas/ItAssetsAssetIdDeliverPostResponsesContentApplicationJsonSchemaDataActionsArchiveOwnAssetDetailsAllowedStatusesItems" }, "type": "array" } }, "required": [ "allowed_statuses" ], "title": "ItAssetsAssetIdDeliverPostResponsesContentApplicationJsonSchemaDataActionsArchiveOwnAssetDetails", "type": "object" }, "ItAssetsAssetIdDeliverPostResponsesContentApplicationJsonSchemaDataActionsArchiveOwnAssetDetailsAllowedStatusesItems": { "enum": [ "ADDED_BY_MISTAKE", "BINNED", "BROKEN_AT_WAREHOUSE", "BROKEN_BY_USER", "BROKEN_IN_TRANSIT", "DAMAGED_AT_WAREHOUSE", "DAMAGED_BY_USER", "DAMAGED_IN_TRANSIT", "LEFT_WITH_USER", "LOST_IN_TRANSIT", "RETURNED_TO_DEEL", "SHRINKAGE", "STOLEN", "SUPPLIER_RETURN" ], "title": "ItAssetsAssetIdDeliverPostResponsesContentApplicationJsonSchemaDataActionsArchiveOwnAssetDetailsAllowedStatusesItems", "type": "string" }, "ItAssetsAssetIdDeliverPostResponsesContentApplicationJsonSchemaDataActionsArchiveOwnAssetDisabledReasonsItems": { "enum": [ "ARCHIVED", "AT_DEEL_WAREHOUSE", "BEING_REPAIRED", "CONSUMABLE", "CONTROLLED_BY_DEEL", "COUNTRY_NOT_SUPPORTED_FOR_HUB", "COUNTRY_NOT_SUPPORTED_FOR_LOCAL", "DEEL_OWNED_ITEM_WITHOUT_RENTAL_CONTRACT", "DESKTOP_STORAGE", "ENDING_CONTRACT", "HUB_IN_SAME_REGION_AS_LOCAL", "INACTIVE", "INVALID_ITEM_LOCATION", "INVALID_ORGANIZATION_STATUS", "INVALID_STATE", "ITEM_CONDITIONS_TO_UNARCHIVE_NOT_MET", "ITEM_NOT_VISIBLE_FOR_ORGANIZATION", "NON_DEVICE", "NOT_AT_WAREHOUSE", "NOT_AVAILABLE_FOR_REUSE", "NOT_A_RENTAL", "NOT_MANAGEABLE_BY_ORGANIZATION", "NOT_WITH_ASSIGNMENT", "NOT_WITH_USER", "NO_ACTIVE_ADDONS", "NO_ACTIVE_STORAGE_CONTRACT", "NO_LOCATION_FOR_STORAGE", "NO_LOGISTICS_FOR_STORAGE", "NO_VALID_ADDONS", "ONGOING_SERVICE", "OWNED_BY_DEEL", "OWNED_BY_ORGANIZATION", "OWNED_BY_PARTNER_ORGANIZATION", "PARTNER_CHILD_CONTRACT", "PENDING_DEVICE_REFRESH", "RENTAL_CONTRACT_AND_USER_REGION_DO_NOT_MATCH", "TEMPORARILY_UNAVAILABLE", "UNKNOWN", "USER_HAS_NO_COUNTRY", "USER_HAS_NO_SEAT", "WAITING_FOR_CLEARANCE", "WITH_LOANER_ASSIGNMENT", "WITH_NON_COLLECTED_ASSIGNMENT", "WITH_NON_DELIVERED_ASSIGNMENT", "WITH_PENDING_ASSIGNMENT", "WRONG_ASSIGNMENT_STATUS", "WRONG_CONTRACT_STATUS", "WRONG_TERMS_AND_CONDITIONS" ], "title": "ItAssetsAssetIdDeliverPostResponsesContentApplicationJsonSchemaDataActionsArchiveOwnAssetDisabledReasonsItems", "type": "string" }, "ItAssetsAssetIdDeliverPostResponsesContentApplicationJsonSchemaDataActionsArchiveOwnAssetStatus": { "description": "Whether the action is currently available for this asset", "enum": [ "DISABLED", "ENABLED", "NOT_APPLICABLE" ], "title": "ItAssetsAssetIdDeliverPostResponsesContentApplicationJsonSchemaDataActionsArchiveOwnAssetStatus", "type": "string" }, "ItAssetsAssetIdDeliverPostResponsesContentApplicationJsonSchemaDataActionsAssetCountry": { "description": "Resolved country used for asset actions. Derived from the asset's country,\nits assigned rental contract billing entity country, or the last active\nassignment delivery country. Null when the country cannot be determined\n(e.g. asset was returned to Deel)", "enum": [ "AD", "AE", "AF", "AG", "AI", "AL", "AM", "AN", "AO", "AQ", "AR", "AS", "AT", "AU", "AW", "AX", "AZ", "BA", "BB", "BD", "BE", "BF", "BG", "BH", "BI", "BJ", "BL", "BM", "BN", "BO", "BQ", "BR", "BS", "BT", "BV", "BW", "BY", "BZ", "CA", "CC", "CD", "CF", "CG", "CH", "CI", "CK", "CL", "CM", "CN", "CO", "CR", "CU", "CV", "CW", "CX", "CY", "CZ", "DE", "DJ", "DK", "DM", "DO", "DZ", "EC", "EE", "EG", "EH", "ER", "ES", "ET", "FI", "FJ", "FK", "FM", "FO", "FR", "GA", "GB", "GD", "GE", "GF", "GG", "GH", "GI", "GL", "GM", "GN", "GP", "GQ", "GR", "GS", "GT", "GU", "GW", "GY", "HK", "HM", "HN", "HR", "HT", "HU", "IC", "ID", "IE", "IL", "IM", "IN", "IO", "IQ", "IR", "IS", "IT", "JE", "JM", "JO", "JP", "KE", "KG", "KH", "KI", "KM", "KN", "KP", "KR", "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", "XK", "YE", "YT", "ZA", "ZM", "ZW" ], "title": "ItAssetsAssetIdDeliverPostResponsesContentApplicationJsonSchemaDataActionsAssetCountry", "type": "string" }, "ItAssetsAssetIdDeliverPostResponsesContentApplicationJsonSchemaDataActionsAssignAddonToOwnAsset": { "description": "Assign an add-on to an organization-owned asset", "properties": { "details": { "description": "Action-specific context needed to perform the action. Populated for enabled and\ndisabled actions (so callers can see what a successful attempt would look like);\nnull when the action is not applicable to this asset.", "oneOf": [ { "$ref": "#/components/schemas/ItAssetsAssetIdDeliverPostResponsesContentApplicationJsonSchemaDataActionsAssignAddonToOwnAssetDetails" }, { "type": "null" } ] }, "disabled_reasons": { "description": "Reasons why the action is disabled. Empty when the action is enabled or not applicable", "items": { "$ref": "#/components/schemas/ItAssetsAssetIdDeliverPostResponsesContentApplicationJsonSchemaDataActionsAssignAddonToOwnAssetDisabledReasonsItems" }, "type": "array" }, "status": { "$ref": "#/components/schemas/ItAssetsAssetIdDeliverPostResponsesContentApplicationJsonSchemaDataActionsAssignAddonToOwnAssetStatus", "description": "Whether the action is currently available for this asset" } }, "required": [ "status", "details", "disabled_reasons" ], "title": "ItAssetsAssetIdDeliverPostResponsesContentApplicationJsonSchemaDataActionsAssignAddonToOwnAsset", "type": "object" }, "ItAssetsAssetIdDeliverPostResponsesContentApplicationJsonSchemaDataActionsAssignAddonToOwnAssetDetails": { "description": "Action-specific context needed to perform the action. Populated for enabled and\ndisabled actions (so callers can see what a successful attempt would look like);\nnull when the action is not applicable to this asset.", "properties": { "addons": { "description": "Add-ons that can be assigned to the asset, with a fail reason for those that don't qualify", "items": { "$ref": "#/components/schemas/ItAssetsAssetIdDeliverPostResponsesContentApplicationJsonSchemaDataActionsAssignAddonToOwnAssetDetailsAddonsItems" }, "type": "array" } }, "required": [ "addons" ], "title": "ItAssetsAssetIdDeliverPostResponsesContentApplicationJsonSchemaDataActionsAssignAddonToOwnAssetDetails", "type": "object" }, "ItAssetsAssetIdDeliverPostResponsesContentApplicationJsonSchemaDataActionsAssignAddonToOwnAssetDetailsAddonsItems": { "properties": { "addon": { "$ref": "#/components/schemas/ItAssetsAssetIdDeliverPostResponsesContentApplicationJsonSchemaDataActionsAssignAddonToOwnAssetDetailsAddonsItemsAddon", "description": "Add-on that can be assigned to the asset" }, "fail_reason": { "description": "Reason the add-on cannot be assigned to the asset. Null when assignment is allowed", "oneOf": [ { "$ref": "#/components/schemas/ItAssetsAssetIdDeliverPostResponsesContentApplicationJsonSchemaDataActionsAssignAddonToOwnAssetDetailsAddonsItemsFailReason" }, { "type": "null" } ] } }, "required": [ "addon", "fail_reason" ], "title": "ItAssetsAssetIdDeliverPostResponsesContentApplicationJsonSchemaDataActionsAssignAddonToOwnAssetDetailsAddonsItems", "type": "object" }, "ItAssetsAssetIdDeliverPostResponsesContentApplicationJsonSchemaDataActionsAssignAddonToOwnAssetDetailsAddonsItemsAddon": { "description": "Add-on that can be assigned to the asset", "properties": { "id": { "description": "ID of the add-on", "format": "uuid", "type": "string" }, "name": { "description": "Public display name of the add-on", "type": "string" } }, "required": [ "id", "name" ], "title": "ItAssetsAssetIdDeliverPostResponsesContentApplicationJsonSchemaDataActionsAssignAddonToOwnAssetDetailsAddonsItemsAddon", "type": "object" }, "ItAssetsAssetIdDeliverPostResponsesContentApplicationJsonSchemaDataActionsAssignAddonToOwnAssetDetailsAddonsItemsFailReason": { "description": "Reason the add-on cannot be assigned to the asset. Null when assignment is allowed", "enum": [ "ADDON_NOT_AVAILABLE_TO_ORGANIZATION", "ALREADY_ASSIGNED", "HAS_ACTIVE_SERVICE_ADDON", "INVALID_ASSET_AGE", "INVALID_CONTRACT_TYPE", "INVALID_DURATION", "INVALID_PAYMENT_SCHEMA", "INVALID_PLATFORM_TIER", "INVALID_PRODUCT_BRAND", "INVALID_PRODUCT_CATEGORY", "INVALID_PRODUCT_PARENT_CATEGORY", "INVALID_RENTAL_TERM", "NO_MATCHING_ORGANIZATION_CONTRACT", "OTHER" ], "title": "ItAssetsAssetIdDeliverPostResponsesContentApplicationJsonSchemaDataActionsAssignAddonToOwnAssetDetailsAddonsItemsFailReason", "type": "string" }, "ItAssetsAssetIdDeliverPostResponsesContentApplicationJsonSchemaDataActionsAssignAddonToOwnAssetDisabledReasonsItems": { "enum": [ "ARCHIVED", "AT_DEEL_WAREHOUSE", "BEING_REPAIRED", "CONSUMABLE", "CONTROLLED_BY_DEEL", "COUNTRY_NOT_SUPPORTED_FOR_HUB", "COUNTRY_NOT_SUPPORTED_FOR_LOCAL", "DEEL_OWNED_ITEM_WITHOUT_RENTAL_CONTRACT", "DESKTOP_STORAGE", "ENDING_CONTRACT", "HUB_IN_SAME_REGION_AS_LOCAL", "INACTIVE", "INVALID_ITEM_LOCATION", "INVALID_ORGANIZATION_STATUS", "INVALID_STATE", "ITEM_CONDITIONS_TO_UNARCHIVE_NOT_MET", "ITEM_NOT_VISIBLE_FOR_ORGANIZATION", "NON_DEVICE", "NOT_AT_WAREHOUSE", "NOT_AVAILABLE_FOR_REUSE", "NOT_A_RENTAL", "NOT_MANAGEABLE_BY_ORGANIZATION", "NOT_WITH_ASSIGNMENT", "NOT_WITH_USER", "NO_ACTIVE_ADDONS", "NO_ACTIVE_STORAGE_CONTRACT", "NO_LOCATION_FOR_STORAGE", "NO_LOGISTICS_FOR_STORAGE", "NO_VALID_ADDONS", "ONGOING_SERVICE", "OWNED_BY_DEEL", "OWNED_BY_ORGANIZATION", "OWNED_BY_PARTNER_ORGANIZATION", "PARTNER_CHILD_CONTRACT", "PENDING_DEVICE_REFRESH", "RENTAL_CONTRACT_AND_USER_REGION_DO_NOT_MATCH", "TEMPORARILY_UNAVAILABLE", "UNKNOWN", "USER_HAS_NO_COUNTRY", "USER_HAS_NO_SEAT", "WAITING_FOR_CLEARANCE", "WITH_LOANER_ASSIGNMENT", "WITH_NON_COLLECTED_ASSIGNMENT", "WITH_NON_DELIVERED_ASSIGNMENT", "WITH_PENDING_ASSIGNMENT", "WRONG_ASSIGNMENT_STATUS", "WRONG_CONTRACT_STATUS", "WRONG_TERMS_AND_CONDITIONS" ], "title": "ItAssetsAssetIdDeliverPostResponsesContentApplicationJsonSchemaDataActionsAssignAddonToOwnAssetDisabledReasonsItems", "type": "string" }, "ItAssetsAssetIdDeliverPostResponsesContentApplicationJsonSchemaDataActionsAssignAddonToOwnAssetStatus": { "description": "Whether the action is currently available for this asset", "enum": [ "DISABLED", "ENABLED", "NOT_APPLICABLE" ], "title": "ItAssetsAssetIdDeliverPostResponsesContentApplicationJsonSchemaDataActionsAssignAddonToOwnAssetStatus", "type": "string" }, "ItAssetsAssetIdDeliverPostResponsesContentApplicationJsonSchemaDataActionsClearOwnAsset": { "description": "Clear an organization-owned asset from the fleet", "properties": { "disabled_reasons": { "description": "Reasons why the action is disabled. Empty when the action is enabled or not applicable", "items": { "$ref": "#/components/schemas/ItAssetsAssetIdDeliverPostResponsesContentApplicationJsonSchemaDataActionsClearOwnAssetDisabledReasonsItems" }, "type": "array" }, "status": { "$ref": "#/components/schemas/ItAssetsAssetIdDeliverPostResponsesContentApplicationJsonSchemaDataActionsClearOwnAssetStatus", "description": "Whether the action is currently available for this asset" } }, "required": [ "status", "disabled_reasons" ], "title": "ItAssetsAssetIdDeliverPostResponsesContentApplicationJsonSchemaDataActionsClearOwnAsset", "type": "object" }, "ItAssetsAssetIdDeliverPostResponsesContentApplicationJsonSchemaDataActionsClearOwnAssetDisabledReasonsItems": { "enum": [ "ARCHIVED", "AT_DEEL_WAREHOUSE", "BEING_REPAIRED", "CONSUMABLE", "CONTROLLED_BY_DEEL", "COUNTRY_NOT_SUPPORTED_FOR_HUB", "COUNTRY_NOT_SUPPORTED_FOR_LOCAL", "DEEL_OWNED_ITEM_WITHOUT_RENTAL_CONTRACT", "DESKTOP_STORAGE", "ENDING_CONTRACT", "HUB_IN_SAME_REGION_AS_LOCAL", "INACTIVE", "INVALID_ITEM_LOCATION", "INVALID_ORGANIZATION_STATUS", "INVALID_STATE", "ITEM_CONDITIONS_TO_UNARCHIVE_NOT_MET", "ITEM_NOT_VISIBLE_FOR_ORGANIZATION", "NON_DEVICE", "NOT_AT_WAREHOUSE", "NOT_AVAILABLE_FOR_REUSE", "NOT_A_RENTAL", "NOT_MANAGEABLE_BY_ORGANIZATION", "NOT_WITH_ASSIGNMENT", "NOT_WITH_USER", "NO_ACTIVE_ADDONS", "NO_ACTIVE_STORAGE_CONTRACT", "NO_LOCATION_FOR_STORAGE", "NO_LOGISTICS_FOR_STORAGE", "NO_VALID_ADDONS", "ONGOING_SERVICE", "OWNED_BY_DEEL", "OWNED_BY_ORGANIZATION", "OWNED_BY_PARTNER_ORGANIZATION", "PARTNER_CHILD_CONTRACT", "PENDING_DEVICE_REFRESH", "RENTAL_CONTRACT_AND_USER_REGION_DO_NOT_MATCH", "TEMPORARILY_UNAVAILABLE", "UNKNOWN", "USER_HAS_NO_COUNTRY", "USER_HAS_NO_SEAT", "WAITING_FOR_CLEARANCE", "WITH_LOANER_ASSIGNMENT", "WITH_NON_COLLECTED_ASSIGNMENT", "WITH_NON_DELIVERED_ASSIGNMENT", "WITH_PENDING_ASSIGNMENT", "WRONG_ASSIGNMENT_STATUS", "WRONG_CONTRACT_STATUS", "WRONG_TERMS_AND_CONDITIONS" ], "title": "ItAssetsAssetIdDeliverPostResponsesContentApplicationJsonSchemaDataActionsClearOwnAssetDisabledReasonsItems", "type": "string" }, "ItAssetsAssetIdDeliverPostResponsesContentApplicationJsonSchemaDataActionsClearOwnAssetStatus": { "description": "Whether the action is currently available for this asset", "enum": [ "DISABLED", "ENABLED", "NOT_APPLICABLE" ], "title": "ItAssetsAssetIdDeliverPostResponsesContentApplicationJsonSchemaDataActionsClearOwnAssetStatus", "type": "string" }, "ItAssetsAssetIdDeliverPostResponsesContentApplicationJsonSchemaDataActionsManageEndOfRentalContractActions": { "description": "Manage end-of-rental options for a Deel-owned rental asset", "properties": { "disabled_reasons": { "description": "Reasons why the action is disabled. Empty when the action is enabled or not applicable", "items": { "$ref": "#/components/schemas/ItAssetsAssetIdDeliverPostResponsesContentApplicationJsonSchemaDataActionsManageEndOfRentalContractActionsDisabledReasonsItems" }, "type": "array" }, "status": { "$ref": "#/components/schemas/ItAssetsAssetIdDeliverPostResponsesContentApplicationJsonSchemaDataActionsManageEndOfRentalContractActionsStatus", "description": "Whether the action is currently available for this asset" } }, "required": [ "status", "disabled_reasons" ], "title": "ItAssetsAssetIdDeliverPostResponsesContentApplicationJsonSchemaDataActionsManageEndOfRentalContractActions", "type": "object" }, "ItAssetsAssetIdDeliverPostResponsesContentApplicationJsonSchemaDataActionsManageEndOfRentalContractActionsDisabledReasonsItems": { "enum": [ "ARCHIVED", "AT_DEEL_WAREHOUSE", "BEING_REPAIRED", "CONSUMABLE", "CONTROLLED_BY_DEEL", "COUNTRY_NOT_SUPPORTED_FOR_HUB", "COUNTRY_NOT_SUPPORTED_FOR_LOCAL", "DEEL_OWNED_ITEM_WITHOUT_RENTAL_CONTRACT", "DESKTOP_STORAGE", "ENDING_CONTRACT", "HUB_IN_SAME_REGION_AS_LOCAL", "INACTIVE", "INVALID_ITEM_LOCATION", "INVALID_ORGANIZATION_STATUS", "INVALID_STATE", "ITEM_CONDITIONS_TO_UNARCHIVE_NOT_MET", "ITEM_NOT_VISIBLE_FOR_ORGANIZATION", "NON_DEVICE", "NOT_AT_WAREHOUSE", "NOT_AVAILABLE_FOR_REUSE", "NOT_A_RENTAL", "NOT_MANAGEABLE_BY_ORGANIZATION", "NOT_WITH_ASSIGNMENT", "NOT_WITH_USER", "NO_ACTIVE_ADDONS", "NO_ACTIVE_STORAGE_CONTRACT", "NO_LOCATION_FOR_STORAGE", "NO_LOGISTICS_FOR_STORAGE", "NO_VALID_ADDONS", "ONGOING_SERVICE", "OWNED_BY_DEEL", "OWNED_BY_ORGANIZATION", "OWNED_BY_PARTNER_ORGANIZATION", "PARTNER_CHILD_CONTRACT", "PENDING_DEVICE_REFRESH", "RENTAL_CONTRACT_AND_USER_REGION_DO_NOT_MATCH", "TEMPORARILY_UNAVAILABLE", "UNKNOWN", "USER_HAS_NO_COUNTRY", "USER_HAS_NO_SEAT", "WAITING_FOR_CLEARANCE", "WITH_LOANER_ASSIGNMENT", "WITH_NON_COLLECTED_ASSIGNMENT", "WITH_NON_DELIVERED_ASSIGNMENT", "WITH_PENDING_ASSIGNMENT", "WRONG_ASSIGNMENT_STATUS", "WRONG_CONTRACT_STATUS", "WRONG_TERMS_AND_CONDITIONS" ], "title": "ItAssetsAssetIdDeliverPostResponsesContentApplicationJsonSchemaDataActionsManageEndOfRentalContractActionsDisabledReasonsItems", "type": "string" }, "ItAssetsAssetIdDeliverPostResponsesContentApplicationJsonSchemaDataActionsManageEndOfRentalContractActionsStatus": { "description": "Whether the action is currently available for this asset", "enum": [ "DISABLED", "ENABLED", "NOT_APPLICABLE" ], "title": "ItAssetsAssetIdDeliverPostResponsesContentApplicationJsonSchemaDataActionsManageEndOfRentalContractActionsStatus", "type": "string" }, "ItAssetsAssetIdDeliverPostResponsesContentApplicationJsonSchemaDataActionsPurchaseRental": { "description": "Purchase a Deel-owned rental asset at end of contract", "properties": { "details": { "description": "Action-specific context needed to perform the action. Populated for enabled and\ndisabled actions (so callers can see what a successful attempt would look like);\nnull when the action is not applicable to this asset.", "oneOf": [ { "$ref": "#/components/schemas/ItAssetsAssetIdDeliverPostResponsesContentApplicationJsonSchemaDataActionsPurchaseRentalDetails" }, { "type": "null" } ] }, "disabled_reasons": { "description": "Reasons why the action is disabled. Empty when the action is enabled or not applicable", "items": { "$ref": "#/components/schemas/ItAssetsAssetIdDeliverPostResponsesContentApplicationJsonSchemaDataActionsPurchaseRentalDisabledReasonsItems" }, "type": "array" }, "status": { "$ref": "#/components/schemas/ItAssetsAssetIdDeliverPostResponsesContentApplicationJsonSchemaDataActionsPurchaseRentalStatus", "description": "Whether the action is currently available for this asset" } }, "required": [ "status", "details", "disabled_reasons" ], "title": "ItAssetsAssetIdDeliverPostResponsesContentApplicationJsonSchemaDataActionsPurchaseRental", "type": "object" }, "ItAssetsAssetIdDeliverPostResponsesContentApplicationJsonSchemaDataActionsPurchaseRentalDetails": { "description": "Action-specific context needed to perform the action. Populated for enabled and\ndisabled actions (so callers can see what a successful attempt would look like);\nnull when the action is not applicable to this asset.", "properties": { "purchase_price": { "description": "Estimated price to purchase the asset at the end of the rental contract", "oneOf": [ { "$ref": "#/components/schemas/ItAssetsAssetIdDeliverPostResponsesContentApplicationJsonSchemaDataActionsPurchaseRentalDetailsPurchasePrice" }, { "type": "null" } ] }, "remaining_contract_value": { "$ref": "#/components/schemas/ItAssetsAssetIdDeliverPostResponsesContentApplicationJsonSchemaDataActionsPurchaseRentalDetailsRemainingContractValue", "description": "Estimated remaining value of the rental contract" }, "total_purchase_price": { "description": "Estimated total price of the purchase, including any remaining contract value", "oneOf": [ { "$ref": "#/components/schemas/ItAssetsAssetIdDeliverPostResponsesContentApplicationJsonSchemaDataActionsPurchaseRentalDetailsTotalPurchasePrice" }, { "type": "null" } ] } }, "required": [ "purchase_price", "total_purchase_price", "remaining_contract_value" ], "title": "ItAssetsAssetIdDeliverPostResponsesContentApplicationJsonSchemaDataActionsPurchaseRentalDetails", "type": "object" }, "ItAssetsAssetIdDeliverPostResponsesContentApplicationJsonSchemaDataActionsPurchaseRentalDetailsPurchasePrice": { "description": "Estimated price to purchase the asset at the end of the rental contract", "properties": { "amount": { "description": "Amount", "format": "decimal", "type": "string" }, "currency": { "$ref": "#/components/schemas/ItAssetsAssetIdDeliverPostResponsesContentApplicationJsonSchemaDataActionsPurchaseRentalDetailsPurchasePriceCurrency", "description": "Three-letter currency code for the price" } }, "required": [ "amount", "currency" ], "title": "ItAssetsAssetIdDeliverPostResponsesContentApplicationJsonSchemaDataActionsPurchaseRentalDetailsPurchasePrice", "type": "object" }, "ItAssetsAssetIdDeliverPostResponsesContentApplicationJsonSchemaDataActionsPurchaseRentalDetailsPurchasePriceCurrency": { "description": "Three-letter currency code for the price", "enum": [ "AED", "AFN", "ALL", "AMD", "ANG", "AOA", "ARS", "AUD", "AWG", "AZN", "BAM", "BDT", "BGN", "BHD", "BIF", "BMD", "BOB", "BRL", "BSD", "BTN", "BWP", "BYN", "BZD", "CAD", "CDF", "CHF", "CLP", "CNY", "COP", "CRC", "CUC", "CVE", "CZK", "DJF", "DKK", "DOP", "DZD", "EGP", "ERN", "ETB", "EUR", "FJD", "FKP", "GBP", "GEL", "GHS", "GIP", "GMD", "GNF", "GTQ", "GYD", "HKD", "HNL", "HRK", "HTG", "HUF", "IDR", "ILS", "INR", "IQD", "IRR", "ISK", "JMD", "JOD", "JPY", "KES", "KGS", "KHR", "KMF", "KPW", "KRW", "KWD", "KYD", "KZT", "LAK", "LBP", "LKR", "LRD", "LSL", "LTL", "LYD", "MAD", "MDL", "MGA", "MKD", "MMK", "MNT", "MRU", "MUR", "MVR", "MWK", "MXN", "MYR", "MZN", "NAD", "NGN", "NIO", "NOK", "NPR", "NZD", "OMR", "PAB", "PEN", "PGK", "PHP", "PKR", "PLN", "PYG", "QAR", "RON", "RSD", "RUB", "RWF", "SAR", "SBD", "SCR", "SDG", "SEK", "SGD", "SHP", "SLL", "SOS", "SRD", "SSP", "STD", "SYP", "SZL", "THB", "TJS", "TMT", "TND", "TOP", "TRY", "TTD", "TWD", "TZS", "UAH", "UGX", "USD", "UYU", "UZS", "VEF", "VND", "VUV", "WST", "XAF", "XCD", "XOF", "XPF", "YER", "ZAR", "ZMW", "ZWD" ], "title": "ItAssetsAssetIdDeliverPostResponsesContentApplicationJsonSchemaDataActionsPurchaseRentalDetailsPurchasePriceCurrency", "type": "string" }, "ItAssetsAssetIdDeliverPostResponsesContentApplicationJsonSchemaDataActionsPurchaseRentalDetailsRemainingContractValue": { "description": "Estimated remaining value of the rental contract", "properties": { "amount": { "description": "Amount", "format": "decimal", "type": "string" }, "currency": { "$ref": "#/components/schemas/ItAssetsAssetIdDeliverPostResponsesContentApplicationJsonSchemaDataActionsPurchaseRentalDetailsRemainingContractValueCurrency", "description": "Three-letter currency code for the price" } }, "required": [ "amount", "currency" ], "title": "ItAssetsAssetIdDeliverPostResponsesContentApplicationJsonSchemaDataActionsPurchaseRentalDetailsRemainingContractValue", "type": "object" }, "ItAssetsAssetIdDeliverPostResponsesContentApplicationJsonSchemaDataActionsPurchaseRentalDetailsRemainingContractValueCurrency": { "description": "Three-letter currency code for the price", "enum": [ "AED", "AFN", "ALL", "AMD", "ANG", "AOA", "ARS", "AUD", "AWG", "AZN", "BAM", "BDT", "BGN", "BHD", "BIF", "BMD", "BOB", "BRL", "BSD", "BTN", "BWP", "BYN", "BZD", "CAD", "CDF", "CHF", "CLP", "CNY", "COP", "CRC", "CUC", "CVE", "CZK", "DJF", "DKK", "DOP", "DZD", "EGP", "ERN", "ETB", "EUR", "FJD", "FKP", "GBP", "GEL", "GHS", "GIP", "GMD", "GNF", "GTQ", "GYD", "HKD", "HNL", "HRK", "HTG", "HUF", "IDR", "ILS", "INR", "IQD", "IRR", "ISK", "JMD", "JOD", "JPY", "KES", "KGS", "KHR", "KMF", "KPW", "KRW", "KWD", "KYD", "KZT", "LAK", "LBP", "LKR", "LRD", "LSL", "LTL", "LYD", "MAD", "MDL", "MGA", "MKD", "MMK", "MNT", "MRU", "MUR", "MVR", "MWK", "MXN", "MYR", "MZN", "NAD", "NGN", "NIO", "NOK", "NPR", "NZD", "OMR", "PAB", "PEN", "PGK", "PHP", "PKR", "PLN", "PYG", "QAR", "RON", "RSD", "RUB", "RWF", "SAR", "SBD", "SCR", "SDG", "SEK", "SGD", "SHP", "SLL", "SOS", "SRD", "SSP", "STD", "SYP", "SZL", "THB", "TJS", "TMT", "TND", "TOP", "TRY", "TTD", "TWD", "TZS", "UAH", "UGX", "USD", "UYU", "UZS", "VEF", "VND", "VUV", "WST", "XAF", "XCD", "XOF", "XPF", "YER", "ZAR", "ZMW", "ZWD" ], "title": "ItAssetsAssetIdDeliverPostResponsesContentApplicationJsonSchemaDataActionsPurchaseRentalDetailsRemainingContractValueCurrency", "type": "string" }, "ItAssetsAssetIdDeliverPostResponsesContentApplicationJsonSchemaDataActionsPurchaseRentalDetailsTotalPurchasePrice": { "description": "Estimated total price of the purchase, including any remaining contract value", "properties": { "amount": { "description": "Amount", "format": "decimal", "type": "string" }, "currency": { "$ref": "#/components/schemas/ItAssetsAssetIdDeliverPostResponsesContentApplicationJsonSchemaDataActionsPurchaseRentalDetailsTotalPurchasePriceCurrency", "description": "Three-letter currency code for the price" } }, "required": [ "amount", "currency" ], "title": "ItAssetsAssetIdDeliverPostResponsesContentApplicationJsonSchemaDataActionsPurchaseRentalDetailsTotalPurchasePrice", "type": "object" }, "ItAssetsAssetIdDeliverPostResponsesContentApplicationJsonSchemaDataActionsPurchaseRentalDetailsTotalPurchasePriceCurrency": { "description": "Three-letter currency code for the price", "enum": [ "AED", "AFN", "ALL", "AMD", "ANG", "AOA", "ARS", "AUD", "AWG", "AZN", "BAM", "BDT", "BGN", "BHD", "BIF", "BMD", "BOB", "BRL", "BSD", "BTN", "BWP", "BYN", "BZD", "CAD", "CDF", "CHF", "CLP", "CNY", "COP", "CRC", "CUC", "CVE", "CZK", "DJF", "DKK", "DOP", "DZD", "EGP", "ERN", "ETB", "EUR", "FJD", "FKP", "GBP", "GEL", "GHS", "GIP", "GMD", "GNF", "GTQ", "GYD", "HKD", "HNL", "HRK", "HTG", "HUF", "IDR", "ILS", "INR", "IQD", "IRR", "ISK", "JMD", "JOD", "JPY", "KES", "KGS", "KHR", "KMF", "KPW", "KRW", "KWD", "KYD", "KZT", "LAK", "LBP", "LKR", "LRD", "LSL", "LTL", "LYD", "MAD", "MDL", "MGA", "MKD", "MMK", "MNT", "MRU", "MUR", "MVR", "MWK", "MXN", "MYR", "MZN", "NAD", "NGN", "NIO", "NOK", "NPR", "NZD", "OMR", "PAB", "PEN", "PGK", "PHP", "PKR", "PLN", "PYG", "QAR", "RON", "RSD", "RUB", "RWF", "SAR", "SBD", "SCR", "SDG", "SEK", "SGD", "SHP", "SLL", "SOS", "SRD", "SSP", "STD", "SYP", "SZL", "THB", "TJS", "TMT", "TND", "TOP", "TRY", "TTD", "TWD", "TZS", "UAH", "UGX", "USD", "UYU", "UZS", "VEF", "VND", "VUV", "WST", "XAF", "XCD", "XOF", "XPF", "YER", "ZAR", "ZMW", "ZWD" ], "title": "ItAssetsAssetIdDeliverPostResponsesContentApplicationJsonSchemaDataActionsPurchaseRentalDetailsTotalPurchasePriceCurrency", "type": "string" }, "ItAssetsAssetIdDeliverPostResponsesContentApplicationJsonSchemaDataActionsPurchaseRentalDisabledReasonsItems": { "enum": [ "ARCHIVED", "AT_DEEL_WAREHOUSE", "BEING_REPAIRED", "CONSUMABLE", "CONTROLLED_BY_DEEL", "COUNTRY_NOT_SUPPORTED_FOR_HUB", "COUNTRY_NOT_SUPPORTED_FOR_LOCAL", "DEEL_OWNED_ITEM_WITHOUT_RENTAL_CONTRACT", "DESKTOP_STORAGE", "ENDING_CONTRACT", "HUB_IN_SAME_REGION_AS_LOCAL", "INACTIVE", "INVALID_ITEM_LOCATION", "INVALID_ORGANIZATION_STATUS", "INVALID_STATE", "ITEM_CONDITIONS_TO_UNARCHIVE_NOT_MET", "ITEM_NOT_VISIBLE_FOR_ORGANIZATION", "NON_DEVICE", "NOT_AT_WAREHOUSE", "NOT_AVAILABLE_FOR_REUSE", "NOT_A_RENTAL", "NOT_MANAGEABLE_BY_ORGANIZATION", "NOT_WITH_ASSIGNMENT", "NOT_WITH_USER", "NO_ACTIVE_ADDONS", "NO_ACTIVE_STORAGE_CONTRACT", "NO_LOCATION_FOR_STORAGE", "NO_LOGISTICS_FOR_STORAGE", "NO_VALID_ADDONS", "ONGOING_SERVICE", "OWNED_BY_DEEL", "OWNED_BY_ORGANIZATION", "OWNED_BY_PARTNER_ORGANIZATION", "PARTNER_CHILD_CONTRACT", "PENDING_DEVICE_REFRESH", "RENTAL_CONTRACT_AND_USER_REGION_DO_NOT_MATCH", "TEMPORARILY_UNAVAILABLE", "UNKNOWN", "USER_HAS_NO_COUNTRY", "USER_HAS_NO_SEAT", "WAITING_FOR_CLEARANCE", "WITH_LOANER_ASSIGNMENT", "WITH_NON_COLLECTED_ASSIGNMENT", "WITH_NON_DELIVERED_ASSIGNMENT", "WITH_PENDING_ASSIGNMENT", "WRONG_ASSIGNMENT_STATUS", "WRONG_CONTRACT_STATUS", "WRONG_TERMS_AND_CONDITIONS" ], "title": "ItAssetsAssetIdDeliverPostResponsesContentApplicationJsonSchemaDataActionsPurchaseRentalDisabledReasonsItems", "type": "string" }, "ItAssetsAssetIdDeliverPostResponsesContentApplicationJsonSchemaDataActionsPurchaseRentalStatus": { "description": "Whether the action is currently available for this asset", "enum": [ "DISABLED", "ENABLED", "NOT_APPLICABLE" ], "title": "ItAssetsAssetIdDeliverPostResponsesContentApplicationJsonSchemaDataActionsPurchaseRentalStatus", "type": "string" }, "ItAssetsAssetIdDeliverPostResponsesContentApplicationJsonSchemaDataActionsReturnRentalToDeel": { "description": "Return a Deel-owned rental asset back to Deel", "properties": { "details": { "description": "Action-specific context needed to perform the action. Populated for enabled and\ndisabled actions (so callers can see what a successful attempt would look like);\nnull when the action is not applicable to this asset.", "oneOf": [ { "$ref": "#/components/schemas/ItAssetsAssetIdDeliverPostResponsesContentApplicationJsonSchemaDataActionsReturnRentalToDeelDetails" }, { "type": "null" } ] }, "disabled_reasons": { "description": "Reasons why the action is disabled. Empty when the action is enabled or not applicable", "items": { "$ref": "#/components/schemas/ItAssetsAssetIdDeliverPostResponsesContentApplicationJsonSchemaDataActionsReturnRentalToDeelDisabledReasonsItems" }, "type": "array" }, "status": { "$ref": "#/components/schemas/ItAssetsAssetIdDeliverPostResponsesContentApplicationJsonSchemaDataActionsReturnRentalToDeelStatus", "description": "Whether the action is currently available for this asset" } }, "required": [ "status", "details", "disabled_reasons" ], "title": "ItAssetsAssetIdDeliverPostResponsesContentApplicationJsonSchemaDataActionsReturnRentalToDeel", "type": "object" }, "ItAssetsAssetIdDeliverPostResponsesContentApplicationJsonSchemaDataActionsReturnRentalToDeelDetails": { "description": "Action-specific context needed to perform the action. Populated for enabled and\ndisabled actions (so callers can see what a successful attempt would look like);\nnull when the action is not applicable to this asset.", "properties": { "end_contract_price": { "$ref": "#/components/schemas/ItAssetsAssetIdDeliverPostResponsesContentApplicationJsonSchemaDataActionsReturnRentalToDeelDetailsEndContractPrice", "description": "Estimated end-of-contract price charged when returning the asset" } }, "required": [ "end_contract_price" ], "title": "ItAssetsAssetIdDeliverPostResponsesContentApplicationJsonSchemaDataActionsReturnRentalToDeelDetails", "type": "object" }, "ItAssetsAssetIdDeliverPostResponsesContentApplicationJsonSchemaDataActionsReturnRentalToDeelDetailsEndContractPrice": { "description": "Estimated end-of-contract price charged when returning the asset", "properties": { "amount": { "description": "Amount", "format": "decimal", "type": "string" }, "currency": { "$ref": "#/components/schemas/ItAssetsAssetIdDeliverPostResponsesContentApplicationJsonSchemaDataActionsReturnRentalToDeelDetailsEndContractPriceCurrency", "description": "Three-letter currency code for the price" } }, "required": [ "amount", "currency" ], "title": "ItAssetsAssetIdDeliverPostResponsesContentApplicationJsonSchemaDataActionsReturnRentalToDeelDetailsEndContractPrice", "type": "object" }, "ItAssetsAssetIdDeliverPostResponsesContentApplicationJsonSchemaDataActionsReturnRentalToDeelDetailsEndContractPriceCurrency": { "description": "Three-letter currency code for the price", "enum": [ "AED", "AFN", "ALL", "AMD", "ANG", "AOA", "ARS", "AUD", "AWG", "AZN", "BAM", "BDT", "BGN", "BHD", "BIF", "BMD", "BOB", "BRL", "BSD", "BTN", "BWP", "BYN", "BZD", "CAD", "CDF", "CHF", "CLP", "CNY", "COP", "CRC", "CUC", "CVE", "CZK", "DJF", "DKK", "DOP", "DZD", "EGP", "ERN", "ETB", "EUR", "FJD", "FKP", "GBP", "GEL", "GHS", "GIP", "GMD", "GNF", "GTQ", "GYD", "HKD", "HNL", "HRK", "HTG", "HUF", "IDR", "ILS", "INR", "IQD", "IRR", "ISK", "JMD", "JOD", "JPY", "KES", "KGS", "KHR", "KMF", "KPW", "KRW", "KWD", "KYD", "KZT", "LAK", "LBP", "LKR", "LRD", "LSL", "LTL", "LYD", "MAD", "MDL", "MGA", "MKD", "MMK", "MNT", "MRU", "MUR", "MVR", "MWK", "MXN", "MYR", "MZN", "NAD", "NGN", "NIO", "NOK", "NPR", "NZD", "OMR", "PAB", "PEN", "PGK", "PHP", "PKR", "PLN", "PYG", "QAR", "RON", "RSD", "RUB", "RWF", "SAR", "SBD", "SCR", "SDG", "SEK", "SGD", "SHP", "SLL", "SOS", "SRD", "SSP", "STD", "SYP", "SZL", "THB", "TJS", "TMT", "TND", "TOP", "TRY", "TTD", "TWD", "TZS", "UAH", "UGX", "USD", "UYU", "UZS", "VEF", "VND", "VUV", "WST", "XAF", "XCD", "XOF", "XPF", "YER", "ZAR", "ZMW", "ZWD" ], "title": "ItAssetsAssetIdDeliverPostResponsesContentApplicationJsonSchemaDataActionsReturnRentalToDeelDetailsEndContractPriceCurrency", "type": "string" }, "ItAssetsAssetIdDeliverPostResponsesContentApplicationJsonSchemaDataActionsReturnRentalToDeelDisabledReasonsItems": { "enum": [ "ARCHIVED", "AT_DEEL_WAREHOUSE", "BEING_REPAIRED", "CONSUMABLE", "CONTROLLED_BY_DEEL", "COUNTRY_NOT_SUPPORTED_FOR_HUB", "COUNTRY_NOT_SUPPORTED_FOR_LOCAL", "DEEL_OWNED_ITEM_WITHOUT_RENTAL_CONTRACT", "DESKTOP_STORAGE", "ENDING_CONTRACT", "HUB_IN_SAME_REGION_AS_LOCAL", "INACTIVE", "INVALID_ITEM_LOCATION", "INVALID_ORGANIZATION_STATUS", "INVALID_STATE", "ITEM_CONDITIONS_TO_UNARCHIVE_NOT_MET", "ITEM_NOT_VISIBLE_FOR_ORGANIZATION", "NON_DEVICE", "NOT_AT_WAREHOUSE", "NOT_AVAILABLE_FOR_REUSE", "NOT_A_RENTAL", "NOT_MANAGEABLE_BY_ORGANIZATION", "NOT_WITH_ASSIGNMENT", "NOT_WITH_USER", "NO_ACTIVE_ADDONS", "NO_ACTIVE_STORAGE_CONTRACT", "NO_LOCATION_FOR_STORAGE", "NO_LOGISTICS_FOR_STORAGE", "NO_VALID_ADDONS", "ONGOING_SERVICE", "OWNED_BY_DEEL", "OWNED_BY_ORGANIZATION", "OWNED_BY_PARTNER_ORGANIZATION", "PARTNER_CHILD_CONTRACT", "PENDING_DEVICE_REFRESH", "RENTAL_CONTRACT_AND_USER_REGION_DO_NOT_MATCH", "TEMPORARILY_UNAVAILABLE", "UNKNOWN", "USER_HAS_NO_COUNTRY", "USER_HAS_NO_SEAT", "WAITING_FOR_CLEARANCE", "WITH_LOANER_ASSIGNMENT", "WITH_NON_COLLECTED_ASSIGNMENT", "WITH_NON_DELIVERED_ASSIGNMENT", "WITH_PENDING_ASSIGNMENT", "WRONG_ASSIGNMENT_STATUS", "WRONG_CONTRACT_STATUS", "WRONG_TERMS_AND_CONDITIONS" ], "title": "ItAssetsAssetIdDeliverPostResponsesContentApplicationJsonSchemaDataActionsReturnRentalToDeelDisabledReasonsItems", "type": "string" }, "ItAssetsAssetIdDeliverPostResponsesContentApplicationJsonSchemaDataActionsReturnRentalToDeelStatus": { "description": "Whether the action is currently available for this asset", "enum": [ "DISABLED", "ENABLED", "NOT_APPLICABLE" ], "title": "ItAssetsAssetIdDeliverPostResponsesContentApplicationJsonSchemaDataActionsReturnRentalToDeelStatus", "type": "string" }, "ItAssetsAssetIdDeliverPostResponsesContentApplicationJsonSchemaDataActionsReuseOwnAssetFromDeel": { "description": "Redeploy an organization-owned asset stored at a Deel warehouse", "properties": { "details": { "description": "Action-specific context needed to perform the action. Populated for enabled and\ndisabled actions (so callers can see what a successful attempt would look like);\nnull when the action is not applicable to this asset.", "oneOf": [ { "$ref": "#/components/schemas/ItAssetsAssetIdDeliverPostResponsesContentApplicationJsonSchemaDataActionsReuseOwnAssetFromDeelDetails" }, { "type": "null" } ] }, "disabled_reasons": { "description": "Reasons why the action is disabled. Empty when the action is enabled or not applicable", "items": { "$ref": "#/components/schemas/ItAssetsAssetIdDeliverPostResponsesContentApplicationJsonSchemaDataActionsReuseOwnAssetFromDeelDisabledReasonsItems" }, "type": "array" }, "status": { "$ref": "#/components/schemas/ItAssetsAssetIdDeliverPostResponsesContentApplicationJsonSchemaDataActionsReuseOwnAssetFromDeelStatus", "description": "Whether the action is currently available for this asset" } }, "required": [ "status", "details", "disabled_reasons" ], "title": "ItAssetsAssetIdDeliverPostResponsesContentApplicationJsonSchemaDataActionsReuseOwnAssetFromDeel", "type": "object" }, "ItAssetsAssetIdDeliverPostResponsesContentApplicationJsonSchemaDataActionsReuseOwnAssetFromDeelDetails": { "description": "Action-specific context needed to perform the action. Populated for enabled and\ndisabled actions (so callers can see what a successful attempt would look like);\nnull when the action is not applicable to this asset.", "properties": { "eligible_countries": { "description": "Countries where the asset can be redeployed from Deel", "items": { "$ref": "#/components/schemas/ItAssetsAssetIdDeliverPostResponsesContentApplicationJsonSchemaDataActionsReuseOwnAssetFromDeelDetailsEligibleCountriesItems" }, "type": "array" }, "express_delivery": { "description": "Express delivery availability and per-country fees. Null when express delivery is not supported", "oneOf": [ { "$ref": "#/components/schemas/ItAssetsAssetIdDeliverPostResponsesContentApplicationJsonSchemaDataActionsReuseOwnAssetFromDeelDetailsExpressDelivery" }, { "type": "null" } ] } }, "required": [ "express_delivery", "eligible_countries" ], "title": "ItAssetsAssetIdDeliverPostResponsesContentApplicationJsonSchemaDataActionsReuseOwnAssetFromDeelDetails", "type": "object" }, "ItAssetsAssetIdDeliverPostResponsesContentApplicationJsonSchemaDataActionsReuseOwnAssetFromDeelDetailsEligibleCountriesItems": { "enum": [ "AD", "AE", "AF", "AG", "AI", "AL", "AM", "AN", "AO", "AQ", "AR", "AS", "AT", "AU", "AW", "AX", "AZ", "BA", "BB", "BD", "BE", "BF", "BG", "BH", "BI", "BJ", "BL", "BM", "BN", "BO", "BQ", "BR", "BS", "BT", "BV", "BW", "BY", "BZ", "CA", "CC", "CD", "CF", "CG", "CH", "CI", "CK", "CL", "CM", "CN", "CO", "CR", "CU", "CV", "CW", "CX", "CY", "CZ", "DE", "DJ", "DK", "DM", "DO", "DZ", "EC", "EE", "EG", "EH", "ER", "ES", "ET", "FI", "FJ", "FK", "FM", "FO", "FR", "GA", "GB", "GD", "GE", "GF", "GG", "GH", "GI", "GL", "GM", "GN", "GP", "GQ", "GR", "GS", "GT", "GU", "GW", "GY", "HK", "HM", "HN", "HR", "HT", "HU", "IC", "ID", "IE", "IL", "IM", "IN", "IO", "IQ", "IR", "IS", "IT", "JE", "JM", "JO", "JP", "KE", "KG", "KH", "KI", "KM", "KN", "KP", "KR", "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", "XK", "YE", "YT", "ZA", "ZM", "ZW" ], "title": "ItAssetsAssetIdDeliverPostResponsesContentApplicationJsonSchemaDataActionsReuseOwnAssetFromDeelDetailsEligibleCountriesItems", "type": "string" }, "ItAssetsAssetIdDeliverPostResponsesContentApplicationJsonSchemaDataActionsReuseOwnAssetFromDeelDetailsExpressDelivery": { "description": "Express delivery availability and per-country fees. Null when express delivery is not supported", "properties": { "country_fees": { "additionalProperties": { "$ref": "#/components/schemas/ItAssetsAssetIdDeliverPostResponsesContentApplicationJsonSchemaDataActionsReuseOwnAssetFromDeelDetailsExpressDeliveryCountryFees" }, "description": "Express delivery fees keyed by destination country.", "type": "object" } }, "required": [ "country_fees" ], "title": "ItAssetsAssetIdDeliverPostResponsesContentApplicationJsonSchemaDataActionsReuseOwnAssetFromDeelDetailsExpressDelivery", "type": "object" }, "ItAssetsAssetIdDeliverPostResponsesContentApplicationJsonSchemaDataActionsReuseOwnAssetFromDeelDetailsExpressDeliveryCountryFees": { "properties": { "amount": { "description": "Amount", "format": "decimal", "type": "string" }, "currency": { "$ref": "#/components/schemas/ItAssetsAssetIdDeliverPostResponsesContentApplicationJsonSchemaDataActionsReuseOwnAssetFromDeelDetailsExpressDeliveryCountryFeesCurrency", "description": "Three-letter currency code for the price" } }, "required": [ "amount", "currency" ], "title": "ItAssetsAssetIdDeliverPostResponsesContentApplicationJsonSchemaDataActionsReuseOwnAssetFromDeelDetailsExpressDeliveryCountryFees", "type": "object" }, "ItAssetsAssetIdDeliverPostResponsesContentApplicationJsonSchemaDataActionsReuseOwnAssetFromDeelDetailsExpressDeliveryCountryFeesCurrency": { "description": "Three-letter currency code for the price", "enum": [ "AED", "AFN", "ALL", "AMD", "ANG", "AOA", "ARS", "AUD", "AWG", "AZN", "BAM", "BDT", "BGN", "BHD", "BIF", "BMD", "BOB", "BRL", "BSD", "BTN", "BWP", "BYN", "BZD", "CAD", "CDF", "CHF", "CLP", "CNY", "COP", "CRC", "CUC", "CVE", "CZK", "DJF", "DKK", "DOP", "DZD", "EGP", "ERN", "ETB", "EUR", "FJD", "FKP", "GBP", "GEL", "GHS", "GIP", "GMD", "GNF", "GTQ", "GYD", "HKD", "HNL", "HRK", "HTG", "HUF", "IDR", "ILS", "INR", "IQD", "IRR", "ISK", "JMD", "JOD", "JPY", "KES", "KGS", "KHR", "KMF", "KPW", "KRW", "KWD", "KYD", "KZT", "LAK", "LBP", "LKR", "LRD", "LSL", "LTL", "LYD", "MAD", "MDL", "MGA", "MKD", "MMK", "MNT", "MRU", "MUR", "MVR", "MWK", "MXN", "MYR", "MZN", "NAD", "NGN", "NIO", "NOK", "NPR", "NZD", "OMR", "PAB", "PEN", "PGK", "PHP", "PKR", "PLN", "PYG", "QAR", "RON", "RSD", "RUB", "RWF", "SAR", "SBD", "SCR", "SDG", "SEK", "SGD", "SHP", "SLL", "SOS", "SRD", "SSP", "STD", "SYP", "SZL", "THB", "TJS", "TMT", "TND", "TOP", "TRY", "TTD", "TWD", "TZS", "UAH", "UGX", "USD", "UYU", "UZS", "VEF", "VND", "VUV", "WST", "XAF", "XCD", "XOF", "XPF", "YER", "ZAR", "ZMW", "ZWD" ], "title": "ItAssetsAssetIdDeliverPostResponsesContentApplicationJsonSchemaDataActionsReuseOwnAssetFromDeelDetailsExpressDeliveryCountryFeesCurrency", "type": "string" }, "ItAssetsAssetIdDeliverPostResponsesContentApplicationJsonSchemaDataActionsReuseOwnAssetFromDeelDisabledReasonsItems": { "enum": [ "ARCHIVED", "AT_DEEL_WAREHOUSE", "BEING_REPAIRED", "CONSUMABLE", "CONTROLLED_BY_DEEL", "COUNTRY_NOT_SUPPORTED_FOR_HUB", "COUNTRY_NOT_SUPPORTED_FOR_LOCAL", "DEEL_OWNED_ITEM_WITHOUT_RENTAL_CONTRACT", "DESKTOP_STORAGE", "ENDING_CONTRACT", "HUB_IN_SAME_REGION_AS_LOCAL", "INACTIVE", "INVALID_ITEM_LOCATION", "INVALID_ORGANIZATION_STATUS", "INVALID_STATE", "ITEM_CONDITIONS_TO_UNARCHIVE_NOT_MET", "ITEM_NOT_VISIBLE_FOR_ORGANIZATION", "NON_DEVICE", "NOT_AT_WAREHOUSE", "NOT_AVAILABLE_FOR_REUSE", "NOT_A_RENTAL", "NOT_MANAGEABLE_BY_ORGANIZATION", "NOT_WITH_ASSIGNMENT", "NOT_WITH_USER", "NO_ACTIVE_ADDONS", "NO_ACTIVE_STORAGE_CONTRACT", "NO_LOCATION_FOR_STORAGE", "NO_LOGISTICS_FOR_STORAGE", "NO_VALID_ADDONS", "ONGOING_SERVICE", "OWNED_BY_DEEL", "OWNED_BY_ORGANIZATION", "OWNED_BY_PARTNER_ORGANIZATION", "PARTNER_CHILD_CONTRACT", "PENDING_DEVICE_REFRESH", "RENTAL_CONTRACT_AND_USER_REGION_DO_NOT_MATCH", "TEMPORARILY_UNAVAILABLE", "UNKNOWN", "USER_HAS_NO_COUNTRY", "USER_HAS_NO_SEAT", "WAITING_FOR_CLEARANCE", "WITH_LOANER_ASSIGNMENT", "WITH_NON_COLLECTED_ASSIGNMENT", "WITH_NON_DELIVERED_ASSIGNMENT", "WITH_PENDING_ASSIGNMENT", "WRONG_ASSIGNMENT_STATUS", "WRONG_CONTRACT_STATUS", "WRONG_TERMS_AND_CONDITIONS" ], "title": "ItAssetsAssetIdDeliverPostResponsesContentApplicationJsonSchemaDataActionsReuseOwnAssetFromDeelDisabledReasonsItems", "type": "string" }, "ItAssetsAssetIdDeliverPostResponsesContentApplicationJsonSchemaDataActionsReuseOwnAssetFromDeelStatus": { "description": "Whether the action is currently available for this asset", "enum": [ "DISABLED", "ENABLED", "NOT_APPLICABLE" ], "title": "ItAssetsAssetIdDeliverPostResponsesContentApplicationJsonSchemaDataActionsReuseOwnAssetFromDeelStatus", "type": "string" }, "ItAssetsAssetIdDeliverPostResponsesContentApplicationJsonSchemaDataActionsReuseOwnAssetFromOwnLocation": { "description": "Redeploy an organization-owned asset from an organization-owned location", "properties": { "details": { "description": "Action-specific context needed to perform the action. Populated for enabled and\ndisabled actions (so callers can see what a successful attempt would look like);\nnull when the action is not applicable to this asset.", "oneOf": [ { "$ref": "#/components/schemas/ItAssetsAssetIdDeliverPostResponsesContentApplicationJsonSchemaDataActionsReuseOwnAssetFromOwnLocationDetails" }, { "type": "null" } ] }, "disabled_reasons": { "description": "Reasons why the action is disabled. Empty when the action is enabled or not applicable", "items": { "$ref": "#/components/schemas/ItAssetsAssetIdDeliverPostResponsesContentApplicationJsonSchemaDataActionsReuseOwnAssetFromOwnLocationDisabledReasonsItems" }, "type": "array" }, "status": { "$ref": "#/components/schemas/ItAssetsAssetIdDeliverPostResponsesContentApplicationJsonSchemaDataActionsReuseOwnAssetFromOwnLocationStatus", "description": "Whether the action is currently available for this asset" } }, "required": [ "status", "details", "disabled_reasons" ], "title": "ItAssetsAssetIdDeliverPostResponsesContentApplicationJsonSchemaDataActionsReuseOwnAssetFromOwnLocation", "type": "object" }, "ItAssetsAssetIdDeliverPostResponsesContentApplicationJsonSchemaDataActionsReuseOwnAssetFromOwnLocationDetails": { "description": "Action-specific context needed to perform the action. Populated for enabled and\ndisabled actions (so callers can see what a successful attempt would look like);\nnull when the action is not applicable to this asset.", "properties": { "eligible_countries": { "description": "Countries where the asset can be redeployed from an organization-owned location", "items": { "$ref": "#/components/schemas/ItAssetsAssetIdDeliverPostResponsesContentApplicationJsonSchemaDataActionsReuseOwnAssetFromOwnLocationDetailsEligibleCountriesItems" }, "type": "array" }, "express_delivery": { "description": "Express delivery availability and per-country fees. Null when express delivery is not supported", "oneOf": [ { "$ref": "#/components/schemas/ItAssetsAssetIdDeliverPostResponsesContentApplicationJsonSchemaDataActionsReuseOwnAssetFromOwnLocationDetailsExpressDelivery" }, { "type": "null" } ] }, "service_cost": { "$ref": "#/components/schemas/ItAssetsAssetIdDeliverPostResponsesContentApplicationJsonSchemaDataActionsReuseOwnAssetFromOwnLocationDetailsServiceCost", "description": "Cost charged for the transfer service" } }, "required": [ "service_cost", "express_delivery", "eligible_countries" ], "title": "ItAssetsAssetIdDeliverPostResponsesContentApplicationJsonSchemaDataActionsReuseOwnAssetFromOwnLocationDetails", "type": "object" }, "ItAssetsAssetIdDeliverPostResponsesContentApplicationJsonSchemaDataActionsReuseOwnAssetFromOwnLocationDetailsEligibleCountriesItems": { "enum": [ "AD", "AE", "AF", "AG", "AI", "AL", "AM", "AN", "AO", "AQ", "AR", "AS", "AT", "AU", "AW", "AX", "AZ", "BA", "BB", "BD", "BE", "BF", "BG", "BH", "BI", "BJ", "BL", "BM", "BN", "BO", "BQ", "BR", "BS", "BT", "BV", "BW", "BY", "BZ", "CA", "CC", "CD", "CF", "CG", "CH", "CI", "CK", "CL", "CM", "CN", "CO", "CR", "CU", "CV", "CW", "CX", "CY", "CZ", "DE", "DJ", "DK", "DM", "DO", "DZ", "EC", "EE", "EG", "EH", "ER", "ES", "ET", "FI", "FJ", "FK", "FM", "FO", "FR", "GA", "GB", "GD", "GE", "GF", "GG", "GH", "GI", "GL", "GM", "GN", "GP", "GQ", "GR", "GS", "GT", "GU", "GW", "GY", "HK", "HM", "HN", "HR", "HT", "HU", "IC", "ID", "IE", "IL", "IM", "IN", "IO", "IQ", "IR", "IS", "IT", "JE", "JM", "JO", "JP", "KE", "KG", "KH", "KI", "KM", "KN", "KP", "KR", "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", "XK", "YE", "YT", "ZA", "ZM", "ZW" ], "title": "ItAssetsAssetIdDeliverPostResponsesContentApplicationJsonSchemaDataActionsReuseOwnAssetFromOwnLocationDetailsEligibleCountriesItems", "type": "string" }, "ItAssetsAssetIdDeliverPostResponsesContentApplicationJsonSchemaDataActionsReuseOwnAssetFromOwnLocationDetailsExpressDelivery": { "description": "Express delivery availability and per-country fees. Null when express delivery is not supported", "properties": { "country_fees": { "additionalProperties": { "$ref": "#/components/schemas/ItAssetsAssetIdDeliverPostResponsesContentApplicationJsonSchemaDataActionsReuseOwnAssetFromOwnLocationDetailsExpressDeliveryCountryFees" }, "description": "Express delivery fees keyed by destination country.", "type": "object" } }, "required": [ "country_fees" ], "title": "ItAssetsAssetIdDeliverPostResponsesContentApplicationJsonSchemaDataActionsReuseOwnAssetFromOwnLocationDetailsExpressDelivery", "type": "object" }, "ItAssetsAssetIdDeliverPostResponsesContentApplicationJsonSchemaDataActionsReuseOwnAssetFromOwnLocationDetailsExpressDeliveryCountryFees": { "properties": { "amount": { "description": "Amount", "format": "decimal", "type": "string" }, "currency": { "$ref": "#/components/schemas/ItAssetsAssetIdDeliverPostResponsesContentApplicationJsonSchemaDataActionsReuseOwnAssetFromOwnLocationDetailsExpressDeliveryCountryFeesCurrency", "description": "Three-letter currency code for the price" } }, "required": [ "amount", "currency" ], "title": "ItAssetsAssetIdDeliverPostResponsesContentApplicationJsonSchemaDataActionsReuseOwnAssetFromOwnLocationDetailsExpressDeliveryCountryFees", "type": "object" }, "ItAssetsAssetIdDeliverPostResponsesContentApplicationJsonSchemaDataActionsReuseOwnAssetFromOwnLocationDetailsExpressDeliveryCountryFeesCurrency": { "description": "Three-letter currency code for the price", "enum": [ "AED", "AFN", "ALL", "AMD", "ANG", "AOA", "ARS", "AUD", "AWG", "AZN", "BAM", "BDT", "BGN", "BHD", "BIF", "BMD", "BOB", "BRL", "BSD", "BTN", "BWP", "BYN", "BZD", "CAD", "CDF", "CHF", "CLP", "CNY", "COP", "CRC", "CUC", "CVE", "CZK", "DJF", "DKK", "DOP", "DZD", "EGP", "ERN", "ETB", "EUR", "FJD", "FKP", "GBP", "GEL", "GHS", "GIP", "GMD", "GNF", "GTQ", "GYD", "HKD", "HNL", "HRK", "HTG", "HUF", "IDR", "ILS", "INR", "IQD", "IRR", "ISK", "JMD", "JOD", "JPY", "KES", "KGS", "KHR", "KMF", "KPW", "KRW", "KWD", "KYD", "KZT", "LAK", "LBP", "LKR", "LRD", "LSL", "LTL", "LYD", "MAD", "MDL", "MGA", "MKD", "MMK", "MNT", "MRU", "MUR", "MVR", "MWK", "MXN", "MYR", "MZN", "NAD", "NGN", "NIO", "NOK", "NPR", "NZD", "OMR", "PAB", "PEN", "PGK", "PHP", "PKR", "PLN", "PYG", "QAR", "RON", "RSD", "RUB", "RWF", "SAR", "SBD", "SCR", "SDG", "SEK", "SGD", "SHP", "SLL", "SOS", "SRD", "SSP", "STD", "SYP", "SZL", "THB", "TJS", "TMT", "TND", "TOP", "TRY", "TTD", "TWD", "TZS", "UAH", "UGX", "USD", "UYU", "UZS", "VEF", "VND", "VUV", "WST", "XAF", "XCD", "XOF", "XPF", "YER", "ZAR", "ZMW", "ZWD" ], "title": "ItAssetsAssetIdDeliverPostResponsesContentApplicationJsonSchemaDataActionsReuseOwnAssetFromOwnLocationDetailsExpressDeliveryCountryFeesCurrency", "type": "string" }, "ItAssetsAssetIdDeliverPostResponsesContentApplicationJsonSchemaDataActionsReuseOwnAssetFromOwnLocationDetailsServiceCost": { "description": "Cost charged for the transfer service", "properties": { "billing_method": { "$ref": "#/components/schemas/ItAssetsAssetIdDeliverPostResponsesContentApplicationJsonSchemaDataActionsReuseOwnAssetFromOwnLocationDetailsServiceCostBillingMethod", "description": "How the action is charged. When \"TOKEN\", the fees are covered by an\nadd-on token pool; when \"CURRENCY\", the fees are billed in the currency\nspecified in the \"fees\" field." }, "fees": { "description": "Price charged for the action. Null when billing method is \"TOKEN\"", "oneOf": [ { "$ref": "#/components/schemas/ItAssetsAssetIdDeliverPostResponsesContentApplicationJsonSchemaDataActionsReuseOwnAssetFromOwnLocationDetailsServiceCostFees" }, { "type": "null" } ] }, "token_usage": { "description": "Add-on token consumption details. Null when billing method is \"CURRENCY\"", "oneOf": [ { "$ref": "#/components/schemas/ItAssetsAssetIdDeliverPostResponsesContentApplicationJsonSchemaDataActionsReuseOwnAssetFromOwnLocationDetailsServiceCostTokenUsage" }, { "type": "null" } ] } }, "required": [ "fees", "token_usage", "billing_method" ], "title": "ItAssetsAssetIdDeliverPostResponsesContentApplicationJsonSchemaDataActionsReuseOwnAssetFromOwnLocationDetailsServiceCost", "type": "object" }, "ItAssetsAssetIdDeliverPostResponsesContentApplicationJsonSchemaDataActionsReuseOwnAssetFromOwnLocationDetailsServiceCostBillingMethod": { "description": "How the action is charged. When \"TOKEN\", the fees are covered by an\nadd-on token pool; when \"CURRENCY\", the fees are billed in the currency\nspecified in the \"fees\" field.", "enum": [ "CURRENCY", "TOKEN" ], "title": "ItAssetsAssetIdDeliverPostResponsesContentApplicationJsonSchemaDataActionsReuseOwnAssetFromOwnLocationDetailsServiceCostBillingMethod", "type": "string" }, "ItAssetsAssetIdDeliverPostResponsesContentApplicationJsonSchemaDataActionsReuseOwnAssetFromOwnLocationDetailsServiceCostFees": { "description": "Price charged for the action. Null when billing method is \"TOKEN\"", "properties": { "amount": { "description": "Amount", "format": "decimal", "type": "string" }, "currency": { "$ref": "#/components/schemas/ItAssetsAssetIdDeliverPostResponsesContentApplicationJsonSchemaDataActionsReuseOwnAssetFromOwnLocationDetailsServiceCostFeesCurrency", "description": "Three-letter currency code for the price" } }, "required": [ "amount", "currency" ], "title": "ItAssetsAssetIdDeliverPostResponsesContentApplicationJsonSchemaDataActionsReuseOwnAssetFromOwnLocationDetailsServiceCostFees", "type": "object" }, "ItAssetsAssetIdDeliverPostResponsesContentApplicationJsonSchemaDataActionsReuseOwnAssetFromOwnLocationDetailsServiceCostFeesCurrency": { "description": "Three-letter currency code for the price", "enum": [ "AED", "AFN", "ALL", "AMD", "ANG", "AOA", "ARS", "AUD", "AWG", "AZN", "BAM", "BDT", "BGN", "BHD", "BIF", "BMD", "BOB", "BRL", "BSD", "BTN", "BWP", "BYN", "BZD", "CAD", "CDF", "CHF", "CLP", "CNY", "COP", "CRC", "CUC", "CVE", "CZK", "DJF", "DKK", "DOP", "DZD", "EGP", "ERN", "ETB", "EUR", "FJD", "FKP", "GBP", "GEL", "GHS", "GIP", "GMD", "GNF", "GTQ", "GYD", "HKD", "HNL", "HRK", "HTG", "HUF", "IDR", "ILS", "INR", "IQD", "IRR", "ISK", "JMD", "JOD", "JPY", "KES", "KGS", "KHR", "KMF", "KPW", "KRW", "KWD", "KYD", "KZT", "LAK", "LBP", "LKR", "LRD", "LSL", "LTL", "LYD", "MAD", "MDL", "MGA", "MKD", "MMK", "MNT", "MRU", "MUR", "MVR", "MWK", "MXN", "MYR", "MZN", "NAD", "NGN", "NIO", "NOK", "NPR", "NZD", "OMR", "PAB", "PEN", "PGK", "PHP", "PKR", "PLN", "PYG", "QAR", "RON", "RSD", "RUB", "RWF", "SAR", "SBD", "SCR", "SDG", "SEK", "SGD", "SHP", "SLL", "SOS", "SRD", "SSP", "STD", "SYP", "SZL", "THB", "TJS", "TMT", "TND", "TOP", "TRY", "TTD", "TWD", "TZS", "UAH", "UGX", "USD", "UYU", "UZS", "VEF", "VND", "VUV", "WST", "XAF", "XCD", "XOF", "XPF", "YER", "ZAR", "ZMW", "ZWD" ], "title": "ItAssetsAssetIdDeliverPostResponsesContentApplicationJsonSchemaDataActionsReuseOwnAssetFromOwnLocationDetailsServiceCostFeesCurrency", "type": "string" }, "ItAssetsAssetIdDeliverPostResponsesContentApplicationJsonSchemaDataActionsReuseOwnAssetFromOwnLocationDetailsServiceCostTokenUsage": { "description": "Add-on token consumption details. Null when billing method is \"CURRENCY\"", "properties": { "addon": { "$ref": "#/components/schemas/ItAssetsAssetIdDeliverPostResponsesContentApplicationJsonSchemaDataActionsReuseOwnAssetFromOwnLocationDetailsServiceCostTokenUsageAddon", "description": "The add-on that provides the tokens" }, "cost": { "description": "Number of tokens consumed by the action. Zero when the add-on covers the\nservice without drawing from a token pool", "format": "decimal", "type": "string" }, "tokens_left": { "description": "Number of tokens left in the pool after the action is performed. Null when\nthe add-on covers the service without a token pool", "format": "decimal", "type": [ "string", "null" ] } }, "required": [ "cost", "addon", "tokens_left" ], "title": "ItAssetsAssetIdDeliverPostResponsesContentApplicationJsonSchemaDataActionsReuseOwnAssetFromOwnLocationDetailsServiceCostTokenUsage", "type": "object" }, "ItAssetsAssetIdDeliverPostResponsesContentApplicationJsonSchemaDataActionsReuseOwnAssetFromOwnLocationDetailsServiceCostTokenUsageAddon": { "description": "The add-on that provides the tokens", "properties": { "id": { "description": "ID of the add-on", "format": "uuid", "type": "string" }, "name": { "description": "Public display name of the add-on", "type": "string" } }, "required": [ "id", "name" ], "title": "ItAssetsAssetIdDeliverPostResponsesContentApplicationJsonSchemaDataActionsReuseOwnAssetFromOwnLocationDetailsServiceCostTokenUsageAddon", "type": "object" }, "ItAssetsAssetIdDeliverPostResponsesContentApplicationJsonSchemaDataActionsReuseOwnAssetFromOwnLocationDisabledReasonsItems": { "enum": [ "ARCHIVED", "AT_DEEL_WAREHOUSE", "BEING_REPAIRED", "CONSUMABLE", "CONTROLLED_BY_DEEL", "COUNTRY_NOT_SUPPORTED_FOR_HUB", "COUNTRY_NOT_SUPPORTED_FOR_LOCAL", "DEEL_OWNED_ITEM_WITHOUT_RENTAL_CONTRACT", "DESKTOP_STORAGE", "ENDING_CONTRACT", "HUB_IN_SAME_REGION_AS_LOCAL", "INACTIVE", "INVALID_ITEM_LOCATION", "INVALID_ORGANIZATION_STATUS", "INVALID_STATE", "ITEM_CONDITIONS_TO_UNARCHIVE_NOT_MET", "ITEM_NOT_VISIBLE_FOR_ORGANIZATION", "NON_DEVICE", "NOT_AT_WAREHOUSE", "NOT_AVAILABLE_FOR_REUSE", "NOT_A_RENTAL", "NOT_MANAGEABLE_BY_ORGANIZATION", "NOT_WITH_ASSIGNMENT", "NOT_WITH_USER", "NO_ACTIVE_ADDONS", "NO_ACTIVE_STORAGE_CONTRACT", "NO_LOCATION_FOR_STORAGE", "NO_LOGISTICS_FOR_STORAGE", "NO_VALID_ADDONS", "ONGOING_SERVICE", "OWNED_BY_DEEL", "OWNED_BY_ORGANIZATION", "OWNED_BY_PARTNER_ORGANIZATION", "PARTNER_CHILD_CONTRACT", "PENDING_DEVICE_REFRESH", "RENTAL_CONTRACT_AND_USER_REGION_DO_NOT_MATCH", "TEMPORARILY_UNAVAILABLE", "UNKNOWN", "USER_HAS_NO_COUNTRY", "USER_HAS_NO_SEAT", "WAITING_FOR_CLEARANCE", "WITH_LOANER_ASSIGNMENT", "WITH_NON_COLLECTED_ASSIGNMENT", "WITH_NON_DELIVERED_ASSIGNMENT", "WITH_PENDING_ASSIGNMENT", "WRONG_ASSIGNMENT_STATUS", "WRONG_CONTRACT_STATUS", "WRONG_TERMS_AND_CONDITIONS" ], "title": "ItAssetsAssetIdDeliverPostResponsesContentApplicationJsonSchemaDataActionsReuseOwnAssetFromOwnLocationDisabledReasonsItems", "type": "string" }, "ItAssetsAssetIdDeliverPostResponsesContentApplicationJsonSchemaDataActionsReuseOwnAssetFromOwnLocationStatus": { "description": "Whether the action is currently available for this asset", "enum": [ "DISABLED", "ENABLED", "NOT_APPLICABLE" ], "title": "ItAssetsAssetIdDeliverPostResponsesContentApplicationJsonSchemaDataActionsReuseOwnAssetFromOwnLocationStatus", "type": "string" }, "ItAssetsAssetIdDeliverPostResponsesContentApplicationJsonSchemaDataActionsStoreOwnAssetAtDeelForHub": { "description": "Store an organization-owned asset at a Deel hub warehouse", "properties": { "details": { "description": "Action-specific context needed to perform the action. Populated for enabled and\ndisabled actions (so callers can see what a successful attempt would look like);\nnull when the action is not applicable to this asset.", "oneOf": [ { "$ref": "#/components/schemas/ItAssetsAssetIdDeliverPostResponsesContentApplicationJsonSchemaDataActionsStoreOwnAssetAtDeelForHubDetails" }, { "type": "null" } ] }, "disabled_reasons": { "description": "Reasons why the action is disabled. Empty when the action is enabled or not applicable", "items": { "$ref": "#/components/schemas/ItAssetsAssetIdDeliverPostResponsesContentApplicationJsonSchemaDataActionsStoreOwnAssetAtDeelForHubDisabledReasonsItems" }, "type": "array" }, "status": { "$ref": "#/components/schemas/ItAssetsAssetIdDeliverPostResponsesContentApplicationJsonSchemaDataActionsStoreOwnAssetAtDeelForHubStatus", "description": "Whether the action is currently available for this asset" } }, "required": [ "status", "details", "disabled_reasons" ], "title": "ItAssetsAssetIdDeliverPostResponsesContentApplicationJsonSchemaDataActionsStoreOwnAssetAtDeelForHub", "type": "object" }, "ItAssetsAssetIdDeliverPostResponsesContentApplicationJsonSchemaDataActionsStoreOwnAssetAtDeelForHubDetails": { "description": "Action-specific context needed to perform the action. Populated for enabled and\ndisabled actions (so callers can see what a successful attempt would look like);\nnull when the action is not applicable to this asset.", "properties": { "activation_cost": { "$ref": "#/components/schemas/ItAssetsAssetIdDeliverPostResponsesContentApplicationJsonSchemaDataActionsStoreOwnAssetAtDeelForHubDetailsActivationCost", "description": "Cost charged to activate storage" }, "destination_country": { "$ref": "#/components/schemas/ItAssetsAssetIdDeliverPostResponsesContentApplicationJsonSchemaDataActionsStoreOwnAssetAtDeelForHubDetailsDestinationCountry", "description": "ISO 3166-1 alpha-2 country of the Deel warehouse the asset will be shipped to" }, "grace_period_in_months": { "description": "Grace period in months during which storage is free before monthly fees apply", "format": "int64", "type": "integer" }, "monthly_fee": { "$ref": "#/components/schemas/ItAssetsAssetIdDeliverPostResponsesContentApplicationJsonSchemaDataActionsStoreOwnAssetAtDeelForHubDetailsMonthlyFee", "description": "Monthly storage fee charged after the grace period" } }, "required": [ "monthly_fee", "activation_cost", "destination_country", "grace_period_in_months" ], "title": "ItAssetsAssetIdDeliverPostResponsesContentApplicationJsonSchemaDataActionsStoreOwnAssetAtDeelForHubDetails", "type": "object" }, "ItAssetsAssetIdDeliverPostResponsesContentApplicationJsonSchemaDataActionsStoreOwnAssetAtDeelForHubDetailsActivationCost": { "description": "Cost charged to activate storage", "properties": { "billing_method": { "$ref": "#/components/schemas/ItAssetsAssetIdDeliverPostResponsesContentApplicationJsonSchemaDataActionsStoreOwnAssetAtDeelForHubDetailsActivationCostBillingMethod", "description": "How the action is charged. When \"TOKEN\", the fees are covered by an\nadd-on token pool; when \"CURRENCY\", the fees are billed in the currency\nspecified in the \"fees\" field." }, "fees": { "description": "Price charged for the action. Null when billing method is \"TOKEN\"", "oneOf": [ { "$ref": "#/components/schemas/ItAssetsAssetIdDeliverPostResponsesContentApplicationJsonSchemaDataActionsStoreOwnAssetAtDeelForHubDetailsActivationCostFees" }, { "type": "null" } ] }, "token_usage": { "description": "Add-on token consumption details. Null when billing method is \"CURRENCY\"", "oneOf": [ { "$ref": "#/components/schemas/ItAssetsAssetIdDeliverPostResponsesContentApplicationJsonSchemaDataActionsStoreOwnAssetAtDeelForHubDetailsActivationCostTokenUsage" }, { "type": "null" } ] } }, "required": [ "fees", "token_usage", "billing_method" ], "title": "ItAssetsAssetIdDeliverPostResponsesContentApplicationJsonSchemaDataActionsStoreOwnAssetAtDeelForHubDetailsActivationCost", "type": "object" }, "ItAssetsAssetIdDeliverPostResponsesContentApplicationJsonSchemaDataActionsStoreOwnAssetAtDeelForHubDetailsActivationCostBillingMethod": { "description": "How the action is charged. When \"TOKEN\", the fees are covered by an\nadd-on token pool; when \"CURRENCY\", the fees are billed in the currency\nspecified in the \"fees\" field.", "enum": [ "CURRENCY", "TOKEN" ], "title": "ItAssetsAssetIdDeliverPostResponsesContentApplicationJsonSchemaDataActionsStoreOwnAssetAtDeelForHubDetailsActivationCostBillingMethod", "type": "string" }, "ItAssetsAssetIdDeliverPostResponsesContentApplicationJsonSchemaDataActionsStoreOwnAssetAtDeelForHubDetailsActivationCostFees": { "description": "Price charged for the action. Null when billing method is \"TOKEN\"", "properties": { "amount": { "description": "Amount", "format": "decimal", "type": "string" }, "currency": { "$ref": "#/components/schemas/ItAssetsAssetIdDeliverPostResponsesContentApplicationJsonSchemaDataActionsStoreOwnAssetAtDeelForHubDetailsActivationCostFeesCurrency", "description": "Three-letter currency code for the price" } }, "required": [ "amount", "currency" ], "title": "ItAssetsAssetIdDeliverPostResponsesContentApplicationJsonSchemaDataActionsStoreOwnAssetAtDeelForHubDetailsActivationCostFees", "type": "object" }, "ItAssetsAssetIdDeliverPostResponsesContentApplicationJsonSchemaDataActionsStoreOwnAssetAtDeelForHubDetailsActivationCostFeesCurrency": { "description": "Three-letter currency code for the price", "enum": [ "AED", "AFN", "ALL", "AMD", "ANG", "AOA", "ARS", "AUD", "AWG", "AZN", "BAM", "BDT", "BGN", "BHD", "BIF", "BMD", "BOB", "BRL", "BSD", "BTN", "BWP", "BYN", "BZD", "CAD", "CDF", "CHF", "CLP", "CNY", "COP", "CRC", "CUC", "CVE", "CZK", "DJF", "DKK", "DOP", "DZD", "EGP", "ERN", "ETB", "EUR", "FJD", "FKP", "GBP", "GEL", "GHS", "GIP", "GMD", "GNF", "GTQ", "GYD", "HKD", "HNL", "HRK", "HTG", "HUF", "IDR", "ILS", "INR", "IQD", "IRR", "ISK", "JMD", "JOD", "JPY", "KES", "KGS", "KHR", "KMF", "KPW", "KRW", "KWD", "KYD", "KZT", "LAK", "LBP", "LKR", "LRD", "LSL", "LTL", "LYD", "MAD", "MDL", "MGA", "MKD", "MMK", "MNT", "MRU", "MUR", "MVR", "MWK", "MXN", "MYR", "MZN", "NAD", "NGN", "NIO", "NOK", "NPR", "NZD", "OMR", "PAB", "PEN", "PGK", "PHP", "PKR", "PLN", "PYG", "QAR", "RON", "RSD", "RUB", "RWF", "SAR", "SBD", "SCR", "SDG", "SEK", "SGD", "SHP", "SLL", "SOS", "SRD", "SSP", "STD", "SYP", "SZL", "THB", "TJS", "TMT", "TND", "TOP", "TRY", "TTD", "TWD", "TZS", "UAH", "UGX", "USD", "UYU", "UZS", "VEF", "VND", "VUV", "WST", "XAF", "XCD", "XOF", "XPF", "YER", "ZAR", "ZMW", "ZWD" ], "title": "ItAssetsAssetIdDeliverPostResponsesContentApplicationJsonSchemaDataActionsStoreOwnAssetAtDeelForHubDetailsActivationCostFeesCurrency", "type": "string" }, "ItAssetsAssetIdDeliverPostResponsesContentApplicationJsonSchemaDataActionsStoreOwnAssetAtDeelForHubDetailsActivationCostTokenUsage": { "description": "Add-on token consumption details. Null when billing method is \"CURRENCY\"", "properties": { "addon": { "$ref": "#/components/schemas/ItAssetsAssetIdDeliverPostResponsesContentApplicationJsonSchemaDataActionsStoreOwnAssetAtDeelForHubDetailsActivationCostTokenUsageAddon", "description": "The add-on that provides the tokens" }, "cost": { "description": "Number of tokens consumed by the action. Zero when the add-on covers the\nservice without drawing from a token pool", "format": "decimal", "type": "string" }, "tokens_left": { "description": "Number of tokens left in the pool after the action is performed. Null when\nthe add-on covers the service without a token pool", "format": "decimal", "type": [ "string", "null" ] } }, "required": [ "cost", "addon", "tokens_left" ], "title": "ItAssetsAssetIdDeliverPostResponsesContentApplicationJsonSchemaDataActionsStoreOwnAssetAtDeelForHubDetailsActivationCostTokenUsage", "type": "object" }, "ItAssetsAssetIdDeliverPostResponsesContentApplicationJsonSchemaDataActionsStoreOwnAssetAtDeelForHubDetailsActivationCostTokenUsageAddon": { "description": "The add-on that provides the tokens", "properties": { "id": { "description": "ID of the add-on", "format": "uuid", "type": "string" }, "name": { "description": "Public display name of the add-on", "type": "string" } }, "required": [ "id", "name" ], "title": "ItAssetsAssetIdDeliverPostResponsesContentApplicationJsonSchemaDataActionsStoreOwnAssetAtDeelForHubDetailsActivationCostTokenUsageAddon", "type": "object" }, "ItAssetsAssetIdDeliverPostResponsesContentApplicationJsonSchemaDataActionsStoreOwnAssetAtDeelForHubDetailsDestinationCountry": { "description": "ISO 3166-1 alpha-2 country of the Deel warehouse the asset will be shipped to", "enum": [ "AD", "AE", "AF", "AG", "AI", "AL", "AM", "AN", "AO", "AQ", "AR", "AS", "AT", "AU", "AW", "AX", "AZ", "BA", "BB", "BD", "BE", "BF", "BG", "BH", "BI", "BJ", "BL", "BM", "BN", "BO", "BQ", "BR", "BS", "BT", "BV", "BW", "BY", "BZ", "CA", "CC", "CD", "CF", "CG", "CH", "CI", "CK", "CL", "CM", "CN", "CO", "CR", "CU", "CV", "CW", "CX", "CY", "CZ", "DE", "DJ", "DK", "DM", "DO", "DZ", "EC", "EE", "EG", "EH", "ER", "ES", "ET", "FI", "FJ", "FK", "FM", "FO", "FR", "GA", "GB", "GD", "GE", "GF", "GG", "GH", "GI", "GL", "GM", "GN", "GP", "GQ", "GR", "GS", "GT", "GU", "GW", "GY", "HK", "HM", "HN", "HR", "HT", "HU", "IC", "ID", "IE", "IL", "IM", "IN", "IO", "IQ", "IR", "IS", "IT", "JE", "JM", "JO", "JP", "KE", "KG", "KH", "KI", "KM", "KN", "KP", "KR", "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", "XK", "YE", "YT", "ZA", "ZM", "ZW" ], "title": "ItAssetsAssetIdDeliverPostResponsesContentApplicationJsonSchemaDataActionsStoreOwnAssetAtDeelForHubDetailsDestinationCountry", "type": "string" }, "ItAssetsAssetIdDeliverPostResponsesContentApplicationJsonSchemaDataActionsStoreOwnAssetAtDeelForHubDetailsMonthlyFee": { "description": "Monthly storage fee charged after the grace period", "properties": { "amount": { "description": "Amount", "format": "decimal", "type": "string" }, "currency": { "$ref": "#/components/schemas/ItAssetsAssetIdDeliverPostResponsesContentApplicationJsonSchemaDataActionsStoreOwnAssetAtDeelForHubDetailsMonthlyFeeCurrency", "description": "Three-letter currency code for the price" } }, "required": [ "amount", "currency" ], "title": "ItAssetsAssetIdDeliverPostResponsesContentApplicationJsonSchemaDataActionsStoreOwnAssetAtDeelForHubDetailsMonthlyFee", "type": "object" }, "ItAssetsAssetIdDeliverPostResponsesContentApplicationJsonSchemaDataActionsStoreOwnAssetAtDeelForHubDetailsMonthlyFeeCurrency": { "description": "Three-letter currency code for the price", "enum": [ "AED", "AFN", "ALL", "AMD", "ANG", "AOA", "ARS", "AUD", "AWG", "AZN", "BAM", "BDT", "BGN", "BHD", "BIF", "BMD", "BOB", "BRL", "BSD", "BTN", "BWP", "BYN", "BZD", "CAD", "CDF", "CHF", "CLP", "CNY", "COP", "CRC", "CUC", "CVE", "CZK", "DJF", "DKK", "DOP", "DZD", "EGP", "ERN", "ETB", "EUR", "FJD", "FKP", "GBP", "GEL", "GHS", "GIP", "GMD", "GNF", "GTQ", "GYD", "HKD", "HNL", "HRK", "HTG", "HUF", "IDR", "ILS", "INR", "IQD", "IRR", "ISK", "JMD", "JOD", "JPY", "KES", "KGS", "KHR", "KMF", "KPW", "KRW", "KWD", "KYD", "KZT", "LAK", "LBP", "LKR", "LRD", "LSL", "LTL", "LYD", "MAD", "MDL", "MGA", "MKD", "MMK", "MNT", "MRU", "MUR", "MVR", "MWK", "MXN", "MYR", "MZN", "NAD", "NGN", "NIO", "NOK", "NPR", "NZD", "OMR", "PAB", "PEN", "PGK", "PHP", "PKR", "PLN", "PYG", "QAR", "RON", "RSD", "RUB", "RWF", "SAR", "SBD", "SCR", "SDG", "SEK", "SGD", "SHP", "SLL", "SOS", "SRD", "SSP", "STD", "SYP", "SZL", "THB", "TJS", "TMT", "TND", "TOP", "TRY", "TTD", "TWD", "TZS", "UAH", "UGX", "USD", "UYU", "UZS", "VEF", "VND", "VUV", "WST", "XAF", "XCD", "XOF", "XPF", "YER", "ZAR", "ZMW", "ZWD" ], "title": "ItAssetsAssetIdDeliverPostResponsesContentApplicationJsonSchemaDataActionsStoreOwnAssetAtDeelForHubDetailsMonthlyFeeCurrency", "type": "string" }, "ItAssetsAssetIdDeliverPostResponsesContentApplicationJsonSchemaDataActionsStoreOwnAssetAtDeelForHubDisabledReasonsItems": { "enum": [ "ARCHIVED", "AT_DEEL_WAREHOUSE", "BEING_REPAIRED", "CONSUMABLE", "CONTROLLED_BY_DEEL", "COUNTRY_NOT_SUPPORTED_FOR_HUB", "COUNTRY_NOT_SUPPORTED_FOR_LOCAL", "DEEL_OWNED_ITEM_WITHOUT_RENTAL_CONTRACT", "DESKTOP_STORAGE", "ENDING_CONTRACT", "HUB_IN_SAME_REGION_AS_LOCAL", "INACTIVE", "INVALID_ITEM_LOCATION", "INVALID_ORGANIZATION_STATUS", "INVALID_STATE", "ITEM_CONDITIONS_TO_UNARCHIVE_NOT_MET", "ITEM_NOT_VISIBLE_FOR_ORGANIZATION", "NON_DEVICE", "NOT_AT_WAREHOUSE", "NOT_AVAILABLE_FOR_REUSE", "NOT_A_RENTAL", "NOT_MANAGEABLE_BY_ORGANIZATION", "NOT_WITH_ASSIGNMENT", "NOT_WITH_USER", "NO_ACTIVE_ADDONS", "NO_ACTIVE_STORAGE_CONTRACT", "NO_LOCATION_FOR_STORAGE", "NO_LOGISTICS_FOR_STORAGE", "NO_VALID_ADDONS", "ONGOING_SERVICE", "OWNED_BY_DEEL", "OWNED_BY_ORGANIZATION", "OWNED_BY_PARTNER_ORGANIZATION", "PARTNER_CHILD_CONTRACT", "PENDING_DEVICE_REFRESH", "RENTAL_CONTRACT_AND_USER_REGION_DO_NOT_MATCH", "TEMPORARILY_UNAVAILABLE", "UNKNOWN", "USER_HAS_NO_COUNTRY", "USER_HAS_NO_SEAT", "WAITING_FOR_CLEARANCE", "WITH_LOANER_ASSIGNMENT", "WITH_NON_COLLECTED_ASSIGNMENT", "WITH_NON_DELIVERED_ASSIGNMENT", "WITH_PENDING_ASSIGNMENT", "WRONG_ASSIGNMENT_STATUS", "WRONG_CONTRACT_STATUS", "WRONG_TERMS_AND_CONDITIONS" ], "title": "ItAssetsAssetIdDeliverPostResponsesContentApplicationJsonSchemaDataActionsStoreOwnAssetAtDeelForHubDisabledReasonsItems", "type": "string" }, "ItAssetsAssetIdDeliverPostResponsesContentApplicationJsonSchemaDataActionsStoreOwnAssetAtDeelForHubStatus": { "description": "Whether the action is currently available for this asset", "enum": [ "DISABLED", "ENABLED", "NOT_APPLICABLE" ], "title": "ItAssetsAssetIdDeliverPostResponsesContentApplicationJsonSchemaDataActionsStoreOwnAssetAtDeelForHubStatus", "type": "string" }, "ItAssetsAssetIdDeliverPostResponsesContentApplicationJsonSchemaDataActionsStoreOwnAssetAtDeelForLocal": { "description": "Store an organization-owned asset at a Deel local warehouse", "properties": { "details": { "description": "Action-specific context needed to perform the action. Populated for enabled and\ndisabled actions (so callers can see what a successful attempt would look like);\nnull when the action is not applicable to this asset.", "oneOf": [ { "$ref": "#/components/schemas/ItAssetsAssetIdDeliverPostResponsesContentApplicationJsonSchemaDataActionsStoreOwnAssetAtDeelForLocalDetails" }, { "type": "null" } ] }, "disabled_reasons": { "description": "Reasons why the action is disabled. Empty when the action is enabled or not applicable", "items": { "$ref": "#/components/schemas/ItAssetsAssetIdDeliverPostResponsesContentApplicationJsonSchemaDataActionsStoreOwnAssetAtDeelForLocalDisabledReasonsItems" }, "type": "array" }, "status": { "$ref": "#/components/schemas/ItAssetsAssetIdDeliverPostResponsesContentApplicationJsonSchemaDataActionsStoreOwnAssetAtDeelForLocalStatus", "description": "Whether the action is currently available for this asset" } }, "required": [ "status", "details", "disabled_reasons" ], "title": "ItAssetsAssetIdDeliverPostResponsesContentApplicationJsonSchemaDataActionsStoreOwnAssetAtDeelForLocal", "type": "object" }, "ItAssetsAssetIdDeliverPostResponsesContentApplicationJsonSchemaDataActionsStoreOwnAssetAtDeelForLocalDetails": { "description": "Action-specific context needed to perform the action. Populated for enabled and\ndisabled actions (so callers can see what a successful attempt would look like);\nnull when the action is not applicable to this asset.", "properties": { "activation_cost": { "$ref": "#/components/schemas/ItAssetsAssetIdDeliverPostResponsesContentApplicationJsonSchemaDataActionsStoreOwnAssetAtDeelForLocalDetailsActivationCost", "description": "Cost charged to activate storage" }, "destination_country": { "$ref": "#/components/schemas/ItAssetsAssetIdDeliverPostResponsesContentApplicationJsonSchemaDataActionsStoreOwnAssetAtDeelForLocalDetailsDestinationCountry", "description": "ISO 3166-1 alpha-2 country of the Deel warehouse the asset will be shipped to" }, "grace_period_in_months": { "description": "Grace period in months during which storage is free before monthly fees apply", "format": "int64", "type": "integer" }, "monthly_fee": { "$ref": "#/components/schemas/ItAssetsAssetIdDeliverPostResponsesContentApplicationJsonSchemaDataActionsStoreOwnAssetAtDeelForLocalDetailsMonthlyFee", "description": "Monthly storage fee charged after the grace period" } }, "required": [ "monthly_fee", "activation_cost", "destination_country", "grace_period_in_months" ], "title": "ItAssetsAssetIdDeliverPostResponsesContentApplicationJsonSchemaDataActionsStoreOwnAssetAtDeelForLocalDetails", "type": "object" }, "ItAssetsAssetIdDeliverPostResponsesContentApplicationJsonSchemaDataActionsStoreOwnAssetAtDeelForLocalDetailsActivationCost": { "description": "Cost charged to activate storage", "properties": { "billing_method": { "$ref": "#/components/schemas/ItAssetsAssetIdDeliverPostResponsesContentApplicationJsonSchemaDataActionsStoreOwnAssetAtDeelForLocalDetailsActivationCostBillingMethod", "description": "How the action is charged. When \"TOKEN\", the fees are covered by an\nadd-on token pool; when \"CURRENCY\", the fees are billed in the currency\nspecified in the \"fees\" field." }, "fees": { "description": "Price charged for the action. Null when billing method is \"TOKEN\"", "oneOf": [ { "$ref": "#/components/schemas/ItAssetsAssetIdDeliverPostResponsesContentApplicationJsonSchemaDataActionsStoreOwnAssetAtDeelForLocalDetailsActivationCostFees" }, { "type": "null" } ] }, "token_usage": { "description": "Add-on token consumption details. Null when billing method is \"CURRENCY\"", "oneOf": [ { "$ref": "#/components/schemas/ItAssetsAssetIdDeliverPostResponsesContentApplicationJsonSchemaDataActionsStoreOwnAssetAtDeelForLocalDetailsActivationCostTokenUsage" }, { "type": "null" } ] } }, "required": [ "fees", "token_usage", "billing_method" ], "title": "ItAssetsAssetIdDeliverPostResponsesContentApplicationJsonSchemaDataActionsStoreOwnAssetAtDeelForLocalDetailsActivationCost", "type": "object" }, "ItAssetsAssetIdDeliverPostResponsesContentApplicationJsonSchemaDataActionsStoreOwnAssetAtDeelForLocalDetailsActivationCostBillingMethod": { "description": "How the action is charged. When \"TOKEN\", the fees are covered by an\nadd-on token pool; when \"CURRENCY\", the fees are billed in the currency\nspecified in the \"fees\" field.", "enum": [ "CURRENCY", "TOKEN" ], "title": "ItAssetsAssetIdDeliverPostResponsesContentApplicationJsonSchemaDataActionsStoreOwnAssetAtDeelForLocalDetailsActivationCostBillingMethod", "type": "string" }, "ItAssetsAssetIdDeliverPostResponsesContentApplicationJsonSchemaDataActionsStoreOwnAssetAtDeelForLocalDetailsActivationCostFees": { "description": "Price charged for the action. Null when billing method is \"TOKEN\"", "properties": { "amount": { "description": "Amount", "format": "decimal", "type": "string" }, "currency": { "$ref": "#/components/schemas/ItAssetsAssetIdDeliverPostResponsesContentApplicationJsonSchemaDataActionsStoreOwnAssetAtDeelForLocalDetailsActivationCostFeesCurrency", "description": "Three-letter currency code for the price" } }, "required": [ "amount", "currency" ], "title": "ItAssetsAssetIdDeliverPostResponsesContentApplicationJsonSchemaDataActionsStoreOwnAssetAtDeelForLocalDetailsActivationCostFees", "type": "object" }, "ItAssetsAssetIdDeliverPostResponsesContentApplicationJsonSchemaDataActionsStoreOwnAssetAtDeelForLocalDetailsActivationCostFeesCurrency": { "description": "Three-letter currency code for the price", "enum": [ "AED", "AFN", "ALL", "AMD", "ANG", "AOA", "ARS", "AUD", "AWG", "AZN", "BAM", "BDT", "BGN", "BHD", "BIF", "BMD", "BOB", "BRL", "BSD", "BTN", "BWP", "BYN", "BZD", "CAD", "CDF", "CHF", "CLP", "CNY", "COP", "CRC", "CUC", "CVE", "CZK", "DJF", "DKK", "DOP", "DZD", "EGP", "ERN", "ETB", "EUR", "FJD", "FKP", "GBP", "GEL", "GHS", "GIP", "GMD", "GNF", "GTQ", "GYD", "HKD", "HNL", "HRK", "HTG", "HUF", "IDR", "ILS", "INR", "IQD", "IRR", "ISK", "JMD", "JOD", "JPY", "KES", "KGS", "KHR", "KMF", "KPW", "KRW", "KWD", "KYD", "KZT", "LAK", "LBP", "LKR", "LRD", "LSL", "LTL", "LYD", "MAD", "MDL", "MGA", "MKD", "MMK", "MNT", "MRU", "MUR", "MVR", "MWK", "MXN", "MYR", "MZN", "NAD", "NGN", "NIO", "NOK", "NPR", "NZD", "OMR", "PAB", "PEN", "PGK", "PHP", "PKR", "PLN", "PYG", "QAR", "RON", "RSD", "RUB", "RWF", "SAR", "SBD", "SCR", "SDG", "SEK", "SGD", "SHP", "SLL", "SOS", "SRD", "SSP", "STD", "SYP", "SZL", "THB", "TJS", "TMT", "TND", "TOP", "TRY", "TTD", "TWD", "TZS", "UAH", "UGX", "USD", "UYU", "UZS", "VEF", "VND", "VUV", "WST", "XAF", "XCD", "XOF", "XPF", "YER", "ZAR", "ZMW", "ZWD" ], "title": "ItAssetsAssetIdDeliverPostResponsesContentApplicationJsonSchemaDataActionsStoreOwnAssetAtDeelForLocalDetailsActivationCostFeesCurrency", "type": "string" }, "ItAssetsAssetIdDeliverPostResponsesContentApplicationJsonSchemaDataActionsStoreOwnAssetAtDeelForLocalDetailsActivationCostTokenUsage": { "description": "Add-on token consumption details. Null when billing method is \"CURRENCY\"", "properties": { "addon": { "$ref": "#/components/schemas/ItAssetsAssetIdDeliverPostResponsesContentApplicationJsonSchemaDataActionsStoreOwnAssetAtDeelForLocalDetailsActivationCostTokenUsageAddon", "description": "The add-on that provides the tokens" }, "cost": { "description": "Number of tokens consumed by the action. Zero when the add-on covers the\nservice without drawing from a token pool", "format": "decimal", "type": "string" }, "tokens_left": { "description": "Number of tokens left in the pool after the action is performed. Null when\nthe add-on covers the service without a token pool", "format": "decimal", "type": [ "string", "null" ] } }, "required": [ "cost", "addon", "tokens_left" ], "title": "ItAssetsAssetIdDeliverPostResponsesContentApplicationJsonSchemaDataActionsStoreOwnAssetAtDeelForLocalDetailsActivationCostTokenUsage", "type": "object" }, "ItAssetsAssetIdDeliverPostResponsesContentApplicationJsonSchemaDataActionsStoreOwnAssetAtDeelForLocalDetailsActivationCostTokenUsageAddon": { "description": "The add-on that provides the tokens", "properties": { "id": { "description": "ID of the add-on", "format": "uuid", "type": "string" }, "name": { "description": "Public display name of the add-on", "type": "string" } }, "required": [ "id", "name" ], "title": "ItAssetsAssetIdDeliverPostResponsesContentApplicationJsonSchemaDataActionsStoreOwnAssetAtDeelForLocalDetailsActivationCostTokenUsageAddon", "type": "object" }, "ItAssetsAssetIdDeliverPostResponsesContentApplicationJsonSchemaDataActionsStoreOwnAssetAtDeelForLocalDetailsDestinationCountry": { "description": "ISO 3166-1 alpha-2 country of the Deel warehouse the asset will be shipped to", "enum": [ "AD", "AE", "AF", "AG", "AI", "AL", "AM", "AN", "AO", "AQ", "AR", "AS", "AT", "AU", "AW", "AX", "AZ", "BA", "BB", "BD", "BE", "BF", "BG", "BH", "BI", "BJ", "BL", "BM", "BN", "BO", "BQ", "BR", "BS", "BT", "BV", "BW", "BY", "BZ", "CA", "CC", "CD", "CF", "CG", "CH", "CI", "CK", "CL", "CM", "CN", "CO", "CR", "CU", "CV", "CW", "CX", "CY", "CZ", "DE", "DJ", "DK", "DM", "DO", "DZ", "EC", "EE", "EG", "EH", "ER", "ES", "ET", "FI", "FJ", "FK", "FM", "FO", "FR", "GA", "GB", "GD", "GE", "GF", "GG", "GH", "GI", "GL", "GM", "GN", "GP", "GQ", "GR", "GS", "GT", "GU", "GW", "GY", "HK", "HM", "HN", "HR", "HT", "HU", "IC", "ID", "IE", "IL", "IM", "IN", "IO", "IQ", "IR", "IS", "IT", "JE", "JM", "JO", "JP", "KE", "KG", "KH", "KI", "KM", "KN", "KP", "KR", "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", "XK", "YE", "YT", "ZA", "ZM", "ZW" ], "title": "ItAssetsAssetIdDeliverPostResponsesContentApplicationJsonSchemaDataActionsStoreOwnAssetAtDeelForLocalDetailsDestinationCountry", "type": "string" }, "ItAssetsAssetIdDeliverPostResponsesContentApplicationJsonSchemaDataActionsStoreOwnAssetAtDeelForLocalDetailsMonthlyFee": { "description": "Monthly storage fee charged after the grace period", "properties": { "amount": { "description": "Amount", "format": "decimal", "type": "string" }, "currency": { "$ref": "#/components/schemas/ItAssetsAssetIdDeliverPostResponsesContentApplicationJsonSchemaDataActionsStoreOwnAssetAtDeelForLocalDetailsMonthlyFeeCurrency", "description": "Three-letter currency code for the price" } }, "required": [ "amount", "currency" ], "title": "ItAssetsAssetIdDeliverPostResponsesContentApplicationJsonSchemaDataActionsStoreOwnAssetAtDeelForLocalDetailsMonthlyFee", "type": "object" }, "ItAssetsAssetIdDeliverPostResponsesContentApplicationJsonSchemaDataActionsStoreOwnAssetAtDeelForLocalDetailsMonthlyFeeCurrency": { "description": "Three-letter currency code for the price", "enum": [ "AED", "AFN", "ALL", "AMD", "ANG", "AOA", "ARS", "AUD", "AWG", "AZN", "BAM", "BDT", "BGN", "BHD", "BIF", "BMD", "BOB", "BRL", "BSD", "BTN", "BWP", "BYN", "BZD", "CAD", "CDF", "CHF", "CLP", "CNY", "COP", "CRC", "CUC", "CVE", "CZK", "DJF", "DKK", "DOP", "DZD", "EGP", "ERN", "ETB", "EUR", "FJD", "FKP", "GBP", "GEL", "GHS", "GIP", "GMD", "GNF", "GTQ", "GYD", "HKD", "HNL", "HRK", "HTG", "HUF", "IDR", "ILS", "INR", "IQD", "IRR", "ISK", "JMD", "JOD", "JPY", "KES", "KGS", "KHR", "KMF", "KPW", "KRW", "KWD", "KYD", "KZT", "LAK", "LBP", "LKR", "LRD", "LSL", "LTL", "LYD", "MAD", "MDL", "MGA", "MKD", "MMK", "MNT", "MRU", "MUR", "MVR", "MWK", "MXN", "MYR", "MZN", "NAD", "NGN", "NIO", "NOK", "NPR", "NZD", "OMR", "PAB", "PEN", "PGK", "PHP", "PKR", "PLN", "PYG", "QAR", "RON", "RSD", "RUB", "RWF", "SAR", "SBD", "SCR", "SDG", "SEK", "SGD", "SHP", "SLL", "SOS", "SRD", "SSP", "STD", "SYP", "SZL", "THB", "TJS", "TMT", "TND", "TOP", "TRY", "TTD", "TWD", "TZS", "UAH", "UGX", "USD", "UYU", "UZS", "VEF", "VND", "VUV", "WST", "XAF", "XCD", "XOF", "XPF", "YER", "ZAR", "ZMW", "ZWD" ], "title": "ItAssetsAssetIdDeliverPostResponsesContentApplicationJsonSchemaDataActionsStoreOwnAssetAtDeelForLocalDetailsMonthlyFeeCurrency", "type": "string" }, "ItAssetsAssetIdDeliverPostResponsesContentApplicationJsonSchemaDataActionsStoreOwnAssetAtDeelForLocalDisabledReasonsItems": { "enum": [ "ARCHIVED", "AT_DEEL_WAREHOUSE", "BEING_REPAIRED", "CONSUMABLE", "CONTROLLED_BY_DEEL", "COUNTRY_NOT_SUPPORTED_FOR_HUB", "COUNTRY_NOT_SUPPORTED_FOR_LOCAL", "DEEL_OWNED_ITEM_WITHOUT_RENTAL_CONTRACT", "DESKTOP_STORAGE", "ENDING_CONTRACT", "HUB_IN_SAME_REGION_AS_LOCAL", "INACTIVE", "INVALID_ITEM_LOCATION", "INVALID_ORGANIZATION_STATUS", "INVALID_STATE", "ITEM_CONDITIONS_TO_UNARCHIVE_NOT_MET", "ITEM_NOT_VISIBLE_FOR_ORGANIZATION", "NON_DEVICE", "NOT_AT_WAREHOUSE", "NOT_AVAILABLE_FOR_REUSE", "NOT_A_RENTAL", "NOT_MANAGEABLE_BY_ORGANIZATION", "NOT_WITH_ASSIGNMENT", "NOT_WITH_USER", "NO_ACTIVE_ADDONS", "NO_ACTIVE_STORAGE_CONTRACT", "NO_LOCATION_FOR_STORAGE", "NO_LOGISTICS_FOR_STORAGE", "NO_VALID_ADDONS", "ONGOING_SERVICE", "OWNED_BY_DEEL", "OWNED_BY_ORGANIZATION", "OWNED_BY_PARTNER_ORGANIZATION", "PARTNER_CHILD_CONTRACT", "PENDING_DEVICE_REFRESH", "RENTAL_CONTRACT_AND_USER_REGION_DO_NOT_MATCH", "TEMPORARILY_UNAVAILABLE", "UNKNOWN", "USER_HAS_NO_COUNTRY", "USER_HAS_NO_SEAT", "WAITING_FOR_CLEARANCE", "WITH_LOANER_ASSIGNMENT", "WITH_NON_COLLECTED_ASSIGNMENT", "WITH_NON_DELIVERED_ASSIGNMENT", "WITH_PENDING_ASSIGNMENT", "WRONG_ASSIGNMENT_STATUS", "WRONG_CONTRACT_STATUS", "WRONG_TERMS_AND_CONDITIONS" ], "title": "ItAssetsAssetIdDeliverPostResponsesContentApplicationJsonSchemaDataActionsStoreOwnAssetAtDeelForLocalDisabledReasonsItems", "type": "string" }, "ItAssetsAssetIdDeliverPostResponsesContentApplicationJsonSchemaDataActionsStoreOwnAssetAtDeelForLocalStatus": { "description": "Whether the action is currently available for this asset", "enum": [ "DISABLED", "ENABLED", "NOT_APPLICABLE" ], "title": "ItAssetsAssetIdDeliverPostResponsesContentApplicationJsonSchemaDataActionsStoreOwnAssetAtDeelForLocalStatus", "type": "string" }, "ItAssetsAssetIdDeliverPostResponsesContentApplicationJsonSchemaDataActionsStoreOwnAssetAtOwnLocation": { "description": "Store an organization-owned asset at an organization-owned location", "properties": { "details": { "description": "Action-specific context needed to perform the action. Populated for enabled and\ndisabled actions (so callers can see what a successful attempt would look like);\nnull when the action is not applicable to this asset.", "oneOf": [ { "$ref": "#/components/schemas/ItAssetsAssetIdDeliverPostResponsesContentApplicationJsonSchemaDataActionsStoreOwnAssetAtOwnLocationDetails" }, { "type": "null" } ] }, "disabled_reasons": { "description": "Reasons why the action is disabled. Empty when the action is enabled or not applicable", "items": { "$ref": "#/components/schemas/ItAssetsAssetIdDeliverPostResponsesContentApplicationJsonSchemaDataActionsStoreOwnAssetAtOwnLocationDisabledReasonsItems" }, "type": "array" }, "status": { "$ref": "#/components/schemas/ItAssetsAssetIdDeliverPostResponsesContentApplicationJsonSchemaDataActionsStoreOwnAssetAtOwnLocationStatus", "description": "Whether the action is currently available for this asset" } }, "required": [ "status", "details", "disabled_reasons" ], "title": "ItAssetsAssetIdDeliverPostResponsesContentApplicationJsonSchemaDataActionsStoreOwnAssetAtOwnLocation", "type": "object" }, "ItAssetsAssetIdDeliverPostResponsesContentApplicationJsonSchemaDataActionsStoreOwnAssetAtOwnLocationDetails": { "description": "Action-specific context needed to perform the action. Populated for enabled and\ndisabled actions (so callers can see what a successful attempt would look like);\nnull when the action is not applicable to this asset.", "properties": { "eligible_countries": { "description": "Countries where the asset can be stored at an organization-owned location", "items": { "$ref": "#/components/schemas/ItAssetsAssetIdDeliverPostResponsesContentApplicationJsonSchemaDataActionsStoreOwnAssetAtOwnLocationDetailsEligibleCountriesItems" }, "type": "array" }, "service_cost": { "$ref": "#/components/schemas/ItAssetsAssetIdDeliverPostResponsesContentApplicationJsonSchemaDataActionsStoreOwnAssetAtOwnLocationDetailsServiceCost", "description": "Cost charged for the transfer service" } }, "required": [ "service_cost", "eligible_countries" ], "title": "ItAssetsAssetIdDeliverPostResponsesContentApplicationJsonSchemaDataActionsStoreOwnAssetAtOwnLocationDetails", "type": "object" }, "ItAssetsAssetIdDeliverPostResponsesContentApplicationJsonSchemaDataActionsStoreOwnAssetAtOwnLocationDetailsEligibleCountriesItems": { "enum": [ "AD", "AE", "AF", "AG", "AI", "AL", "AM", "AN", "AO", "AQ", "AR", "AS", "AT", "AU", "AW", "AX", "AZ", "BA", "BB", "BD", "BE", "BF", "BG", "BH", "BI", "BJ", "BL", "BM", "BN", "BO", "BQ", "BR", "BS", "BT", "BV", "BW", "BY", "BZ", "CA", "CC", "CD", "CF", "CG", "CH", "CI", "CK", "CL", "CM", "CN", "CO", "CR", "CU", "CV", "CW", "CX", "CY", "CZ", "DE", "DJ", "DK", "DM", "DO", "DZ", "EC", "EE", "EG", "EH", "ER", "ES", "ET", "FI", "FJ", "FK", "FM", "FO", "FR", "GA", "GB", "GD", "GE", "GF", "GG", "GH", "GI", "GL", "GM", "GN", "GP", "GQ", "GR", "GS", "GT", "GU", "GW", "GY", "HK", "HM", "HN", "HR", "HT", "HU", "IC", "ID", "IE", "IL", "IM", "IN", "IO", "IQ", "IR", "IS", "IT", "JE", "JM", "JO", "JP", "KE", "KG", "KH", "KI", "KM", "KN", "KP", "KR", "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", "XK", "YE", "YT", "ZA", "ZM", "ZW" ], "title": "ItAssetsAssetIdDeliverPostResponsesContentApplicationJsonSchemaDataActionsStoreOwnAssetAtOwnLocationDetailsEligibleCountriesItems", "type": "string" }, "ItAssetsAssetIdDeliverPostResponsesContentApplicationJsonSchemaDataActionsStoreOwnAssetAtOwnLocationDetailsServiceCost": { "description": "Cost charged for the transfer service", "properties": { "billing_method": { "$ref": "#/components/schemas/ItAssetsAssetIdDeliverPostResponsesContentApplicationJsonSchemaDataActionsStoreOwnAssetAtOwnLocationDetailsServiceCostBillingMethod", "description": "How the action is charged. When \"TOKEN\", the fees are covered by an\nadd-on token pool; when \"CURRENCY\", the fees are billed in the currency\nspecified in the \"fees\" field." }, "fees": { "description": "Price charged for the action. Null when billing method is \"TOKEN\"", "oneOf": [ { "$ref": "#/components/schemas/ItAssetsAssetIdDeliverPostResponsesContentApplicationJsonSchemaDataActionsStoreOwnAssetAtOwnLocationDetailsServiceCostFees" }, { "type": "null" } ] }, "token_usage": { "description": "Add-on token consumption details. Null when billing method is \"CURRENCY\"", "oneOf": [ { "$ref": "#/components/schemas/ItAssetsAssetIdDeliverPostResponsesContentApplicationJsonSchemaDataActionsStoreOwnAssetAtOwnLocationDetailsServiceCostTokenUsage" }, { "type": "null" } ] } }, "required": [ "fees", "token_usage", "billing_method" ], "title": "ItAssetsAssetIdDeliverPostResponsesContentApplicationJsonSchemaDataActionsStoreOwnAssetAtOwnLocationDetailsServiceCost", "type": "object" }, "ItAssetsAssetIdDeliverPostResponsesContentApplicationJsonSchemaDataActionsStoreOwnAssetAtOwnLocationDetailsServiceCostBillingMethod": { "description": "How the action is charged. When \"TOKEN\", the fees are covered by an\nadd-on token pool; when \"CURRENCY\", the fees are billed in the currency\nspecified in the \"fees\" field.", "enum": [ "CURRENCY", "TOKEN" ], "title": "ItAssetsAssetIdDeliverPostResponsesContentApplicationJsonSchemaDataActionsStoreOwnAssetAtOwnLocationDetailsServiceCostBillingMethod", "type": "string" }, "ItAssetsAssetIdDeliverPostResponsesContentApplicationJsonSchemaDataActionsStoreOwnAssetAtOwnLocationDetailsServiceCostFees": { "description": "Price charged for the action. Null when billing method is \"TOKEN\"", "properties": { "amount": { "description": "Amount", "format": "decimal", "type": "string" }, "currency": { "$ref": "#/components/schemas/ItAssetsAssetIdDeliverPostResponsesContentApplicationJsonSchemaDataActionsStoreOwnAssetAtOwnLocationDetailsServiceCostFeesCurrency", "description": "Three-letter currency code for the price" } }, "required": [ "amount", "currency" ], "title": "ItAssetsAssetIdDeliverPostResponsesContentApplicationJsonSchemaDataActionsStoreOwnAssetAtOwnLocationDetailsServiceCostFees", "type": "object" }, "ItAssetsAssetIdDeliverPostResponsesContentApplicationJsonSchemaDataActionsStoreOwnAssetAtOwnLocationDetailsServiceCostFeesCurrency": { "description": "Three-letter currency code for the price", "enum": [ "AED", "AFN", "ALL", "AMD", "ANG", "AOA", "ARS", "AUD", "AWG", "AZN", "BAM", "BDT", "BGN", "BHD", "BIF", "BMD", "BOB", "BRL", "BSD", "BTN", "BWP", "BYN", "BZD", "CAD", "CDF", "CHF", "CLP", "CNY", "COP", "CRC", "CUC", "CVE", "CZK", "DJF", "DKK", "DOP", "DZD", "EGP", "ERN", "ETB", "EUR", "FJD", "FKP", "GBP", "GEL", "GHS", "GIP", "GMD", "GNF", "GTQ", "GYD", "HKD", "HNL", "HRK", "HTG", "HUF", "IDR", "ILS", "INR", "IQD", "IRR", "ISK", "JMD", "JOD", "JPY", "KES", "KGS", "KHR", "KMF", "KPW", "KRW", "KWD", "KYD", "KZT", "LAK", "LBP", "LKR", "LRD", "LSL", "LTL", "LYD", "MAD", "MDL", "MGA", "MKD", "MMK", "MNT", "MRU", "MUR", "MVR", "MWK", "MXN", "MYR", "MZN", "NAD", "NGN", "NIO", "NOK", "NPR", "NZD", "OMR", "PAB", "PEN", "PGK", "PHP", "PKR", "PLN", "PYG", "QAR", "RON", "RSD", "RUB", "RWF", "SAR", "SBD", "SCR", "SDG", "SEK", "SGD", "SHP", "SLL", "SOS", "SRD", "SSP", "STD", "SYP", "SZL", "THB", "TJS", "TMT", "TND", "TOP", "TRY", "TTD", "TWD", "TZS", "UAH", "UGX", "USD", "UYU", "UZS", "VEF", "VND", "VUV", "WST", "XAF", "XCD", "XOF", "XPF", "YER", "ZAR", "ZMW", "ZWD" ], "title": "ItAssetsAssetIdDeliverPostResponsesContentApplicationJsonSchemaDataActionsStoreOwnAssetAtOwnLocationDetailsServiceCostFeesCurrency", "type": "string" }, "ItAssetsAssetIdDeliverPostResponsesContentApplicationJsonSchemaDataActionsStoreOwnAssetAtOwnLocationDetailsServiceCostTokenUsage": { "description": "Add-on token consumption details. Null when billing method is \"CURRENCY\"", "properties": { "addon": { "$ref": "#/components/schemas/ItAssetsAssetIdDeliverPostResponsesContentApplicationJsonSchemaDataActionsStoreOwnAssetAtOwnLocationDetailsServiceCostTokenUsageAddon", "description": "The add-on that provides the tokens" }, "cost": { "description": "Number of tokens consumed by the action. Zero when the add-on covers the\nservice without drawing from a token pool", "format": "decimal", "type": "string" }, "tokens_left": { "description": "Number of tokens left in the pool after the action is performed. Null when\nthe add-on covers the service without a token pool", "format": "decimal", "type": [ "string", "null" ] } }, "required": [ "cost", "addon", "tokens_left" ], "title": "ItAssetsAssetIdDeliverPostResponsesContentApplicationJsonSchemaDataActionsStoreOwnAssetAtOwnLocationDetailsServiceCostTokenUsage", "type": "object" }, "ItAssetsAssetIdDeliverPostResponsesContentApplicationJsonSchemaDataActionsStoreOwnAssetAtOwnLocationDetailsServiceCostTokenUsageAddon": { "description": "The add-on that provides the tokens", "properties": { "id": { "description": "ID of the add-on", "format": "uuid", "type": "string" }, "name": { "description": "Public display name of the add-on", "type": "string" } }, "required": [ "id", "name" ], "title": "ItAssetsAssetIdDeliverPostResponsesContentApplicationJsonSchemaDataActionsStoreOwnAssetAtOwnLocationDetailsServiceCostTokenUsageAddon", "type": "object" }, "ItAssetsAssetIdDeliverPostResponsesContentApplicationJsonSchemaDataActionsStoreOwnAssetAtOwnLocationDisabledReasonsItems": { "enum": [ "ARCHIVED", "AT_DEEL_WAREHOUSE", "BEING_REPAIRED", "CONSUMABLE", "CONTROLLED_BY_DEEL", "COUNTRY_NOT_SUPPORTED_FOR_HUB", "COUNTRY_NOT_SUPPORTED_FOR_LOCAL", "DEEL_OWNED_ITEM_WITHOUT_RENTAL_CONTRACT", "DESKTOP_STORAGE", "ENDING_CONTRACT", "HUB_IN_SAME_REGION_AS_LOCAL", "INACTIVE", "INVALID_ITEM_LOCATION", "INVALID_ORGANIZATION_STATUS", "INVALID_STATE", "ITEM_CONDITIONS_TO_UNARCHIVE_NOT_MET", "ITEM_NOT_VISIBLE_FOR_ORGANIZATION", "NON_DEVICE", "NOT_AT_WAREHOUSE", "NOT_AVAILABLE_FOR_REUSE", "NOT_A_RENTAL", "NOT_MANAGEABLE_BY_ORGANIZATION", "NOT_WITH_ASSIGNMENT", "NOT_WITH_USER", "NO_ACTIVE_ADDONS", "NO_ACTIVE_STORAGE_CONTRACT", "NO_LOCATION_FOR_STORAGE", "NO_LOGISTICS_FOR_STORAGE", "NO_VALID_ADDONS", "ONGOING_SERVICE", "OWNED_BY_DEEL", "OWNED_BY_ORGANIZATION", "OWNED_BY_PARTNER_ORGANIZATION", "PARTNER_CHILD_CONTRACT", "PENDING_DEVICE_REFRESH", "RENTAL_CONTRACT_AND_USER_REGION_DO_NOT_MATCH", "TEMPORARILY_UNAVAILABLE", "UNKNOWN", "USER_HAS_NO_COUNTRY", "USER_HAS_NO_SEAT", "WAITING_FOR_CLEARANCE", "WITH_LOANER_ASSIGNMENT", "WITH_NON_COLLECTED_ASSIGNMENT", "WITH_NON_DELIVERED_ASSIGNMENT", "WITH_PENDING_ASSIGNMENT", "WRONG_ASSIGNMENT_STATUS", "WRONG_CONTRACT_STATUS", "WRONG_TERMS_AND_CONDITIONS" ], "title": "ItAssetsAssetIdDeliverPostResponsesContentApplicationJsonSchemaDataActionsStoreOwnAssetAtOwnLocationDisabledReasonsItems", "type": "string" }, "ItAssetsAssetIdDeliverPostResponsesContentApplicationJsonSchemaDataActionsStoreOwnAssetAtOwnLocationStatus": { "description": "Whether the action is currently available for this asset", "enum": [ "DISABLED", "ENABLED", "NOT_APPLICABLE" ], "title": "ItAssetsAssetIdDeliverPostResponsesContentApplicationJsonSchemaDataActionsStoreOwnAssetAtOwnLocationStatus", "type": "string" }, "ItAssetsAssetIdDeliverPostResponsesContentApplicationJsonSchemaDataActionsStoreRentalAtDeelForLocal": { "description": "Store a Deel-owned rental asset at a Deel local warehouse", "properties": { "details": { "description": "Action-specific context needed to perform the action. Populated for enabled and\ndisabled actions (so callers can see what a successful attempt would look like);\nnull when the action is not applicable to this asset.", "oneOf": [ { "$ref": "#/components/schemas/ItAssetsAssetIdDeliverPostResponsesContentApplicationJsonSchemaDataActionsStoreRentalAtDeelForLocalDetails" }, { "type": "null" } ] }, "disabled_reasons": { "description": "Reasons why the action is disabled. Empty when the action is enabled or not applicable", "items": { "$ref": "#/components/schemas/ItAssetsAssetIdDeliverPostResponsesContentApplicationJsonSchemaDataActionsStoreRentalAtDeelForLocalDisabledReasonsItems" }, "type": "array" }, "status": { "$ref": "#/components/schemas/ItAssetsAssetIdDeliverPostResponsesContentApplicationJsonSchemaDataActionsStoreRentalAtDeelForLocalStatus", "description": "Whether the action is currently available for this asset" } }, "required": [ "status", "details", "disabled_reasons" ], "title": "ItAssetsAssetIdDeliverPostResponsesContentApplicationJsonSchemaDataActionsStoreRentalAtDeelForLocal", "type": "object" }, "ItAssetsAssetIdDeliverPostResponsesContentApplicationJsonSchemaDataActionsStoreRentalAtDeelForLocalDetails": { "description": "Action-specific context needed to perform the action. Populated for enabled and\ndisabled actions (so callers can see what a successful attempt would look like);\nnull when the action is not applicable to this asset.", "properties": { "activation_cost": { "$ref": "#/components/schemas/ItAssetsAssetIdDeliverPostResponsesContentApplicationJsonSchemaDataActionsStoreRentalAtDeelForLocalDetailsActivationCost", "description": "Cost charged to activate local storage" } }, "required": [ "activation_cost" ], "title": "ItAssetsAssetIdDeliverPostResponsesContentApplicationJsonSchemaDataActionsStoreRentalAtDeelForLocalDetails", "type": "object" }, "ItAssetsAssetIdDeliverPostResponsesContentApplicationJsonSchemaDataActionsStoreRentalAtDeelForLocalDetailsActivationCost": { "description": "Cost charged to activate local storage", "properties": { "billing_method": { "$ref": "#/components/schemas/ItAssetsAssetIdDeliverPostResponsesContentApplicationJsonSchemaDataActionsStoreRentalAtDeelForLocalDetailsActivationCostBillingMethod", "description": "How the action is charged. When \"TOKEN\", the fees are covered by an\nadd-on token pool; when \"CURRENCY\", the fees are billed in the currency\nspecified in the \"fees\" field." }, "fees": { "description": "Price charged for the action. Null when billing method is \"TOKEN\"", "oneOf": [ { "$ref": "#/components/schemas/ItAssetsAssetIdDeliverPostResponsesContentApplicationJsonSchemaDataActionsStoreRentalAtDeelForLocalDetailsActivationCostFees" }, { "type": "null" } ] }, "token_usage": { "description": "Add-on token consumption details. Null when billing method is \"CURRENCY\"", "oneOf": [ { "$ref": "#/components/schemas/ItAssetsAssetIdDeliverPostResponsesContentApplicationJsonSchemaDataActionsStoreRentalAtDeelForLocalDetailsActivationCostTokenUsage" }, { "type": "null" } ] } }, "required": [ "fees", "token_usage", "billing_method" ], "title": "ItAssetsAssetIdDeliverPostResponsesContentApplicationJsonSchemaDataActionsStoreRentalAtDeelForLocalDetailsActivationCost", "type": "object" }, "ItAssetsAssetIdDeliverPostResponsesContentApplicationJsonSchemaDataActionsStoreRentalAtDeelForLocalDetailsActivationCostBillingMethod": { "description": "How the action is charged. When \"TOKEN\", the fees are covered by an\nadd-on token pool; when \"CURRENCY\", the fees are billed in the currency\nspecified in the \"fees\" field.", "enum": [ "CURRENCY", "TOKEN" ], "title": "ItAssetsAssetIdDeliverPostResponsesContentApplicationJsonSchemaDataActionsStoreRentalAtDeelForLocalDetailsActivationCostBillingMethod", "type": "string" }, "ItAssetsAssetIdDeliverPostResponsesContentApplicationJsonSchemaDataActionsStoreRentalAtDeelForLocalDetailsActivationCostFees": { "description": "Price charged for the action. Null when billing method is \"TOKEN\"", "properties": { "amount": { "description": "Amount", "format": "decimal", "type": "string" }, "currency": { "$ref": "#/components/schemas/ItAssetsAssetIdDeliverPostResponsesContentApplicationJsonSchemaDataActionsStoreRentalAtDeelForLocalDetailsActivationCostFeesCurrency", "description": "Three-letter currency code for the price" } }, "required": [ "amount", "currency" ], "title": "ItAssetsAssetIdDeliverPostResponsesContentApplicationJsonSchemaDataActionsStoreRentalAtDeelForLocalDetailsActivationCostFees", "type": "object" }, "ItAssetsAssetIdDeliverPostResponsesContentApplicationJsonSchemaDataActionsStoreRentalAtDeelForLocalDetailsActivationCostFeesCurrency": { "description": "Three-letter currency code for the price", "enum": [ "AED", "AFN", "ALL", "AMD", "ANG", "AOA", "ARS", "AUD", "AWG", "AZN", "BAM", "BDT", "BGN", "BHD", "BIF", "BMD", "BOB", "BRL", "BSD", "BTN", "BWP", "BYN", "BZD", "CAD", "CDF", "CHF", "CLP", "CNY", "COP", "CRC", "CUC", "CVE", "CZK", "DJF", "DKK", "DOP", "DZD", "EGP", "ERN", "ETB", "EUR", "FJD", "FKP", "GBP", "GEL", "GHS", "GIP", "GMD", "GNF", "GTQ", "GYD", "HKD", "HNL", "HRK", "HTG", "HUF", "IDR", "ILS", "INR", "IQD", "IRR", "ISK", "JMD", "JOD", "JPY", "KES", "KGS", "KHR", "KMF", "KPW", "KRW", "KWD", "KYD", "KZT", "LAK", "LBP", "LKR", "LRD", "LSL", "LTL", "LYD", "MAD", "MDL", "MGA", "MKD", "MMK", "MNT", "MRU", "MUR", "MVR", "MWK", "MXN", "MYR", "MZN", "NAD", "NGN", "NIO", "NOK", "NPR", "NZD", "OMR", "PAB", "PEN", "PGK", "PHP", "PKR", "PLN", "PYG", "QAR", "RON", "RSD", "RUB", "RWF", "SAR", "SBD", "SCR", "SDG", "SEK", "SGD", "SHP", "SLL", "SOS", "SRD", "SSP", "STD", "SYP", "SZL", "THB", "TJS", "TMT", "TND", "TOP", "TRY", "TTD", "TWD", "TZS", "UAH", "UGX", "USD", "UYU", "UZS", "VEF", "VND", "VUV", "WST", "XAF", "XCD", "XOF", "XPF", "YER", "ZAR", "ZMW", "ZWD" ], "title": "ItAssetsAssetIdDeliverPostResponsesContentApplicationJsonSchemaDataActionsStoreRentalAtDeelForLocalDetailsActivationCostFeesCurrency", "type": "string" }, "ItAssetsAssetIdDeliverPostResponsesContentApplicationJsonSchemaDataActionsStoreRentalAtDeelForLocalDetailsActivationCostTokenUsage": { "description": "Add-on token consumption details. Null when billing method is \"CURRENCY\"", "properties": { "addon": { "$ref": "#/components/schemas/ItAssetsAssetIdDeliverPostResponsesContentApplicationJsonSchemaDataActionsStoreRentalAtDeelForLocalDetailsActivationCostTokenUsageAddon", "description": "The add-on that provides the tokens" }, "cost": { "description": "Number of tokens consumed by the action. Zero when the add-on covers the\nservice without drawing from a token pool", "format": "decimal", "type": "string" }, "tokens_left": { "description": "Number of tokens left in the pool after the action is performed. Null when\nthe add-on covers the service without a token pool", "format": "decimal", "type": [ "string", "null" ] } }, "required": [ "cost", "addon", "tokens_left" ], "title": "ItAssetsAssetIdDeliverPostResponsesContentApplicationJsonSchemaDataActionsStoreRentalAtDeelForLocalDetailsActivationCostTokenUsage", "type": "object" }, "ItAssetsAssetIdDeliverPostResponsesContentApplicationJsonSchemaDataActionsStoreRentalAtDeelForLocalDetailsActivationCostTokenUsageAddon": { "description": "The add-on that provides the tokens", "properties": { "id": { "description": "ID of the add-on", "format": "uuid", "type": "string" }, "name": { "description": "Public display name of the add-on", "type": "string" } }, "required": [ "id", "name" ], "title": "ItAssetsAssetIdDeliverPostResponsesContentApplicationJsonSchemaDataActionsStoreRentalAtDeelForLocalDetailsActivationCostTokenUsageAddon", "type": "object" }, "ItAssetsAssetIdDeliverPostResponsesContentApplicationJsonSchemaDataActionsStoreRentalAtDeelForLocalDisabledReasonsItems": { "enum": [ "ARCHIVED", "AT_DEEL_WAREHOUSE", "BEING_REPAIRED", "CONSUMABLE", "CONTROLLED_BY_DEEL", "COUNTRY_NOT_SUPPORTED_FOR_HUB", "COUNTRY_NOT_SUPPORTED_FOR_LOCAL", "DEEL_OWNED_ITEM_WITHOUT_RENTAL_CONTRACT", "DESKTOP_STORAGE", "ENDING_CONTRACT", "HUB_IN_SAME_REGION_AS_LOCAL", "INACTIVE", "INVALID_ITEM_LOCATION", "INVALID_ORGANIZATION_STATUS", "INVALID_STATE", "ITEM_CONDITIONS_TO_UNARCHIVE_NOT_MET", "ITEM_NOT_VISIBLE_FOR_ORGANIZATION", "NON_DEVICE", "NOT_AT_WAREHOUSE", "NOT_AVAILABLE_FOR_REUSE", "NOT_A_RENTAL", "NOT_MANAGEABLE_BY_ORGANIZATION", "NOT_WITH_ASSIGNMENT", "NOT_WITH_USER", "NO_ACTIVE_ADDONS", "NO_ACTIVE_STORAGE_CONTRACT", "NO_LOCATION_FOR_STORAGE", "NO_LOGISTICS_FOR_STORAGE", "NO_VALID_ADDONS", "ONGOING_SERVICE", "OWNED_BY_DEEL", "OWNED_BY_ORGANIZATION", "OWNED_BY_PARTNER_ORGANIZATION", "PARTNER_CHILD_CONTRACT", "PENDING_DEVICE_REFRESH", "RENTAL_CONTRACT_AND_USER_REGION_DO_NOT_MATCH", "TEMPORARILY_UNAVAILABLE", "UNKNOWN", "USER_HAS_NO_COUNTRY", "USER_HAS_NO_SEAT", "WAITING_FOR_CLEARANCE", "WITH_LOANER_ASSIGNMENT", "WITH_NON_COLLECTED_ASSIGNMENT", "WITH_NON_DELIVERED_ASSIGNMENT", "WITH_PENDING_ASSIGNMENT", "WRONG_ASSIGNMENT_STATUS", "WRONG_CONTRACT_STATUS", "WRONG_TERMS_AND_CONDITIONS" ], "title": "ItAssetsAssetIdDeliverPostResponsesContentApplicationJsonSchemaDataActionsStoreRentalAtDeelForLocalDisabledReasonsItems", "type": "string" }, "ItAssetsAssetIdDeliverPostResponsesContentApplicationJsonSchemaDataActionsStoreRentalAtDeelForLocalStatus": { "description": "Whether the action is currently available for this asset", "enum": [ "DISABLED", "ENABLED", "NOT_APPLICABLE" ], "title": "ItAssetsAssetIdDeliverPostResponsesContentApplicationJsonSchemaDataActionsStoreRentalAtDeelForLocalStatus", "type": "string" }, "ItAssetsAssetIdDeliverPostResponsesContentApplicationJsonSchemaDataActionsStoreRentalAtDeelForZone1": { "description": "Store a Deel-owned rental asset at a Deel zone-1 warehouse", "properties": { "details": { "description": "Action-specific context needed to perform the action. Populated for enabled and\ndisabled actions (so callers can see what a successful attempt would look like);\nnull when the action is not applicable to this asset.", "oneOf": [ { "$ref": "#/components/schemas/ItAssetsAssetIdDeliverPostResponsesContentApplicationJsonSchemaDataActionsStoreRentalAtDeelForZone1Details" }, { "type": "null" } ] }, "disabled_reasons": { "description": "Reasons why the action is disabled. Empty when the action is enabled or not applicable", "items": { "$ref": "#/components/schemas/ItAssetsAssetIdDeliverPostResponsesContentApplicationJsonSchemaDataActionsStoreRentalAtDeelForZone1DisabledReasonsItems" }, "type": "array" }, "status": { "$ref": "#/components/schemas/ItAssetsAssetIdDeliverPostResponsesContentApplicationJsonSchemaDataActionsStoreRentalAtDeelForZone1Status", "description": "Whether the action is currently available for this asset" } }, "required": [ "status", "details", "disabled_reasons" ], "title": "ItAssetsAssetIdDeliverPostResponsesContentApplicationJsonSchemaDataActionsStoreRentalAtDeelForZone1", "type": "object" }, "ItAssetsAssetIdDeliverPostResponsesContentApplicationJsonSchemaDataActionsStoreRentalAtDeelForZone1Details": { "description": "Action-specific context needed to perform the action. Populated for enabled and\ndisabled actions (so callers can see what a successful attempt would look like);\nnull when the action is not applicable to this asset.", "properties": { "activation_cost": { "$ref": "#/components/schemas/ItAssetsAssetIdDeliverPostResponsesContentApplicationJsonSchemaDataActionsStoreRentalAtDeelForZone1DetailsActivationCost", "description": "Cost charged to activate zone-1 storage" } }, "required": [ "activation_cost" ], "title": "ItAssetsAssetIdDeliverPostResponsesContentApplicationJsonSchemaDataActionsStoreRentalAtDeelForZone1Details", "type": "object" }, "ItAssetsAssetIdDeliverPostResponsesContentApplicationJsonSchemaDataActionsStoreRentalAtDeelForZone1DetailsActivationCost": { "description": "Cost charged to activate zone-1 storage", "properties": { "billing_method": { "$ref": "#/components/schemas/ItAssetsAssetIdDeliverPostResponsesContentApplicationJsonSchemaDataActionsStoreRentalAtDeelForZone1DetailsActivationCostBillingMethod", "description": "How the action is charged. When \"TOKEN\", the fees are covered by an\nadd-on token pool; when \"CURRENCY\", the fees are billed in the currency\nspecified in the \"fees\" field." }, "fees": { "description": "Price charged for the action. Null when billing method is \"TOKEN\"", "oneOf": [ { "$ref": "#/components/schemas/ItAssetsAssetIdDeliverPostResponsesContentApplicationJsonSchemaDataActionsStoreRentalAtDeelForZone1DetailsActivationCostFees" }, { "type": "null" } ] }, "token_usage": { "description": "Add-on token consumption details. Null when billing method is \"CURRENCY\"", "oneOf": [ { "$ref": "#/components/schemas/ItAssetsAssetIdDeliverPostResponsesContentApplicationJsonSchemaDataActionsStoreRentalAtDeelForZone1DetailsActivationCostTokenUsage" }, { "type": "null" } ] } }, "required": [ "fees", "token_usage", "billing_method" ], "title": "ItAssetsAssetIdDeliverPostResponsesContentApplicationJsonSchemaDataActionsStoreRentalAtDeelForZone1DetailsActivationCost", "type": "object" }, "ItAssetsAssetIdDeliverPostResponsesContentApplicationJsonSchemaDataActionsStoreRentalAtDeelForZone1DetailsActivationCostBillingMethod": { "description": "How the action is charged. When \"TOKEN\", the fees are covered by an\nadd-on token pool; when \"CURRENCY\", the fees are billed in the currency\nspecified in the \"fees\" field.", "enum": [ "CURRENCY", "TOKEN" ], "title": "ItAssetsAssetIdDeliverPostResponsesContentApplicationJsonSchemaDataActionsStoreRentalAtDeelForZone1DetailsActivationCostBillingMethod", "type": "string" }, "ItAssetsAssetIdDeliverPostResponsesContentApplicationJsonSchemaDataActionsStoreRentalAtDeelForZone1DetailsActivationCostFees": { "description": "Price charged for the action. Null when billing method is \"TOKEN\"", "properties": { "amount": { "description": "Amount", "format": "decimal", "type": "string" }, "currency": { "$ref": "#/components/schemas/ItAssetsAssetIdDeliverPostResponsesContentApplicationJsonSchemaDataActionsStoreRentalAtDeelForZone1DetailsActivationCostFeesCurrency", "description": "Three-letter currency code for the price" } }, "required": [ "amount", "currency" ], "title": "ItAssetsAssetIdDeliverPostResponsesContentApplicationJsonSchemaDataActionsStoreRentalAtDeelForZone1DetailsActivationCostFees", "type": "object" }, "ItAssetsAssetIdDeliverPostResponsesContentApplicationJsonSchemaDataActionsStoreRentalAtDeelForZone1DetailsActivationCostFeesCurrency": { "description": "Three-letter currency code for the price", "enum": [ "AED", "AFN", "ALL", "AMD", "ANG", "AOA", "ARS", "AUD", "AWG", "AZN", "BAM", "BDT", "BGN", "BHD", "BIF", "BMD", "BOB", "BRL", "BSD", "BTN", "BWP", "BYN", "BZD", "CAD", "CDF", "CHF", "CLP", "CNY", "COP", "CRC", "CUC", "CVE", "CZK", "DJF", "DKK", "DOP", "DZD", "EGP", "ERN", "ETB", "EUR", "FJD", "FKP", "GBP", "GEL", "GHS", "GIP", "GMD", "GNF", "GTQ", "GYD", "HKD", "HNL", "HRK", "HTG", "HUF", "IDR", "ILS", "INR", "IQD", "IRR", "ISK", "JMD", "JOD", "JPY", "KES", "KGS", "KHR", "KMF", "KPW", "KRW", "KWD", "KYD", "KZT", "LAK", "LBP", "LKR", "LRD", "LSL", "LTL", "LYD", "MAD", "MDL", "MGA", "MKD", "MMK", "MNT", "MRU", "MUR", "MVR", "MWK", "MXN", "MYR", "MZN", "NAD", "NGN", "NIO", "NOK", "NPR", "NZD", "OMR", "PAB", "PEN", "PGK", "PHP", "PKR", "PLN", "PYG", "QAR", "RON", "RSD", "RUB", "RWF", "SAR", "SBD", "SCR", "SDG", "SEK", "SGD", "SHP", "SLL", "SOS", "SRD", "SSP", "STD", "SYP", "SZL", "THB", "TJS", "TMT", "TND", "TOP", "TRY", "TTD", "TWD", "TZS", "UAH", "UGX", "USD", "UYU", "UZS", "VEF", "VND", "VUV", "WST", "XAF", "XCD", "XOF", "XPF", "YER", "ZAR", "ZMW", "ZWD" ], "title": "ItAssetsAssetIdDeliverPostResponsesContentApplicationJsonSchemaDataActionsStoreRentalAtDeelForZone1DetailsActivationCostFeesCurrency", "type": "string" }, "ItAssetsAssetIdDeliverPostResponsesContentApplicationJsonSchemaDataActionsStoreRentalAtDeelForZone1DetailsActivationCostTokenUsage": { "description": "Add-on token consumption details. Null when billing method is \"CURRENCY\"", "properties": { "addon": { "$ref": "#/components/schemas/ItAssetsAssetIdDeliverPostResponsesContentApplicationJsonSchemaDataActionsStoreRentalAtDeelForZone1DetailsActivationCostTokenUsageAddon", "description": "The add-on that provides the tokens" }, "cost": { "description": "Number of tokens consumed by the action. Zero when the add-on covers the\nservice without drawing from a token pool", "format": "decimal", "type": "string" }, "tokens_left": { "description": "Number of tokens left in the pool after the action is performed. Null when\nthe add-on covers the service without a token pool", "format": "decimal", "type": [ "string", "null" ] } }, "required": [ "cost", "addon", "tokens_left" ], "title": "ItAssetsAssetIdDeliverPostResponsesContentApplicationJsonSchemaDataActionsStoreRentalAtDeelForZone1DetailsActivationCostTokenUsage", "type": "object" }, "ItAssetsAssetIdDeliverPostResponsesContentApplicationJsonSchemaDataActionsStoreRentalAtDeelForZone1DetailsActivationCostTokenUsageAddon": { "description": "The add-on that provides the tokens", "properties": { "id": { "description": "ID of the add-on", "format": "uuid", "type": "string" }, "name": { "description": "Public display name of the add-on", "type": "string" } }, "required": [ "id", "name" ], "title": "ItAssetsAssetIdDeliverPostResponsesContentApplicationJsonSchemaDataActionsStoreRentalAtDeelForZone1DetailsActivationCostTokenUsageAddon", "type": "object" }, "ItAssetsAssetIdDeliverPostResponsesContentApplicationJsonSchemaDataActionsStoreRentalAtDeelForZone1DisabledReasonsItems": { "enum": [ "ARCHIVED", "AT_DEEL_WAREHOUSE", "BEING_REPAIRED", "CONSUMABLE", "CONTROLLED_BY_DEEL", "COUNTRY_NOT_SUPPORTED_FOR_HUB", "COUNTRY_NOT_SUPPORTED_FOR_LOCAL", "DEEL_OWNED_ITEM_WITHOUT_RENTAL_CONTRACT", "DESKTOP_STORAGE", "ENDING_CONTRACT", "HUB_IN_SAME_REGION_AS_LOCAL", "INACTIVE", "INVALID_ITEM_LOCATION", "INVALID_ORGANIZATION_STATUS", "INVALID_STATE", "ITEM_CONDITIONS_TO_UNARCHIVE_NOT_MET", "ITEM_NOT_VISIBLE_FOR_ORGANIZATION", "NON_DEVICE", "NOT_AT_WAREHOUSE", "NOT_AVAILABLE_FOR_REUSE", "NOT_A_RENTAL", "NOT_MANAGEABLE_BY_ORGANIZATION", "NOT_WITH_ASSIGNMENT", "NOT_WITH_USER", "NO_ACTIVE_ADDONS", "NO_ACTIVE_STORAGE_CONTRACT", "NO_LOCATION_FOR_STORAGE", "NO_LOGISTICS_FOR_STORAGE", "NO_VALID_ADDONS", "ONGOING_SERVICE", "OWNED_BY_DEEL", "OWNED_BY_ORGANIZATION", "OWNED_BY_PARTNER_ORGANIZATION", "PARTNER_CHILD_CONTRACT", "PENDING_DEVICE_REFRESH", "RENTAL_CONTRACT_AND_USER_REGION_DO_NOT_MATCH", "TEMPORARILY_UNAVAILABLE", "UNKNOWN", "USER_HAS_NO_COUNTRY", "USER_HAS_NO_SEAT", "WAITING_FOR_CLEARANCE", "WITH_LOANER_ASSIGNMENT", "WITH_NON_COLLECTED_ASSIGNMENT", "WITH_NON_DELIVERED_ASSIGNMENT", "WITH_PENDING_ASSIGNMENT", "WRONG_ASSIGNMENT_STATUS", "WRONG_CONTRACT_STATUS", "WRONG_TERMS_AND_CONDITIONS" ], "title": "ItAssetsAssetIdDeliverPostResponsesContentApplicationJsonSchemaDataActionsStoreRentalAtDeelForZone1DisabledReasonsItems", "type": "string" }, "ItAssetsAssetIdDeliverPostResponsesContentApplicationJsonSchemaDataActionsStoreRentalAtDeelForZone1Status": { "description": "Whether the action is currently available for this asset", "enum": [ "DISABLED", "ENABLED", "NOT_APPLICABLE" ], "title": "ItAssetsAssetIdDeliverPostResponsesContentApplicationJsonSchemaDataActionsStoreRentalAtDeelForZone1Status", "type": "string" }, "ItAssetsAssetIdDeliverPostResponsesContentApplicationJsonSchemaDataActionsTransferOwnAsset": { "description": "Transfer an organization-owned asset to another user", "properties": { "details": { "description": "Action-specific context needed to perform the action. Populated for enabled and\ndisabled actions (so callers can see what a successful attempt would look like);\nnull when the action is not applicable to this asset.", "oneOf": [ { "$ref": "#/components/schemas/ItAssetsAssetIdDeliverPostResponsesContentApplicationJsonSchemaDataActionsTransferOwnAssetDetails" }, { "type": "null" } ] }, "disabled_reasons": { "description": "Reasons why the action is disabled. Empty when the action is enabled or not applicable", "items": { "$ref": "#/components/schemas/ItAssetsAssetIdDeliverPostResponsesContentApplicationJsonSchemaDataActionsTransferOwnAssetDisabledReasonsItems" }, "type": "array" }, "status": { "$ref": "#/components/schemas/ItAssetsAssetIdDeliverPostResponsesContentApplicationJsonSchemaDataActionsTransferOwnAssetStatus", "description": "Whether the action is currently available for this asset" } }, "required": [ "status", "details", "disabled_reasons" ], "title": "ItAssetsAssetIdDeliverPostResponsesContentApplicationJsonSchemaDataActionsTransferOwnAsset", "type": "object" }, "ItAssetsAssetIdDeliverPostResponsesContentApplicationJsonSchemaDataActionsTransferOwnAssetDetails": { "description": "Action-specific context needed to perform the action. Populated for enabled and\ndisabled actions (so callers can see what a successful attempt would look like);\nnull when the action is not applicable to this asset.", "properties": { "eligible_countries": { "description": "Countries the asset can be transferred to", "items": { "$ref": "#/components/schemas/ItAssetsAssetIdDeliverPostResponsesContentApplicationJsonSchemaDataActionsTransferOwnAssetDetailsEligibleCountriesItems" }, "type": "array" }, "transfer_cost": { "$ref": "#/components/schemas/ItAssetsAssetIdDeliverPostResponsesContentApplicationJsonSchemaDataActionsTransferOwnAssetDetailsTransferCost", "description": "Cost charged for the transfer service" } }, "required": [ "transfer_cost", "eligible_countries" ], "title": "ItAssetsAssetIdDeliverPostResponsesContentApplicationJsonSchemaDataActionsTransferOwnAssetDetails", "type": "object" }, "ItAssetsAssetIdDeliverPostResponsesContentApplicationJsonSchemaDataActionsTransferOwnAssetDetailsEligibleCountriesItems": { "enum": [ "AD", "AE", "AF", "AG", "AI", "AL", "AM", "AN", "AO", "AQ", "AR", "AS", "AT", "AU", "AW", "AX", "AZ", "BA", "BB", "BD", "BE", "BF", "BG", "BH", "BI", "BJ", "BL", "BM", "BN", "BO", "BQ", "BR", "BS", "BT", "BV", "BW", "BY", "BZ", "CA", "CC", "CD", "CF", "CG", "CH", "CI", "CK", "CL", "CM", "CN", "CO", "CR", "CU", "CV", "CW", "CX", "CY", "CZ", "DE", "DJ", "DK", "DM", "DO", "DZ", "EC", "EE", "EG", "EH", "ER", "ES", "ET", "FI", "FJ", "FK", "FM", "FO", "FR", "GA", "GB", "GD", "GE", "GF", "GG", "GH", "GI", "GL", "GM", "GN", "GP", "GQ", "GR", "GS", "GT", "GU", "GW", "GY", "HK", "HM", "HN", "HR", "HT", "HU", "IC", "ID", "IE", "IL", "IM", "IN", "IO", "IQ", "IR", "IS", "IT", "JE", "JM", "JO", "JP", "KE", "KG", "KH", "KI", "KM", "KN", "KP", "KR", "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", "XK", "YE", "YT", "ZA", "ZM", "ZW" ], "title": "ItAssetsAssetIdDeliverPostResponsesContentApplicationJsonSchemaDataActionsTransferOwnAssetDetailsEligibleCountriesItems", "type": "string" }, "ItAssetsAssetIdDeliverPostResponsesContentApplicationJsonSchemaDataActionsTransferOwnAssetDetailsTransferCost": { "description": "Cost charged for the transfer service", "properties": { "billing_method": { "$ref": "#/components/schemas/ItAssetsAssetIdDeliverPostResponsesContentApplicationJsonSchemaDataActionsTransferOwnAssetDetailsTransferCostBillingMethod", "description": "How the action is charged. When \"TOKEN\", the fees are covered by an\nadd-on token pool; when \"CURRENCY\", the fees are billed in the currency\nspecified in the \"fees\" field." }, "fees": { "description": "Price charged for the action. Null when billing method is \"TOKEN\"", "oneOf": [ { "$ref": "#/components/schemas/ItAssetsAssetIdDeliverPostResponsesContentApplicationJsonSchemaDataActionsTransferOwnAssetDetailsTransferCostFees" }, { "type": "null" } ] }, "token_usage": { "description": "Add-on token consumption details. Null when billing method is \"CURRENCY\"", "oneOf": [ { "$ref": "#/components/schemas/ItAssetsAssetIdDeliverPostResponsesContentApplicationJsonSchemaDataActionsTransferOwnAssetDetailsTransferCostTokenUsage" }, { "type": "null" } ] } }, "required": [ "fees", "token_usage", "billing_method" ], "title": "ItAssetsAssetIdDeliverPostResponsesContentApplicationJsonSchemaDataActionsTransferOwnAssetDetailsTransferCost", "type": "object" }, "ItAssetsAssetIdDeliverPostResponsesContentApplicationJsonSchemaDataActionsTransferOwnAssetDetailsTransferCostBillingMethod": { "description": "How the action is charged. When \"TOKEN\", the fees are covered by an\nadd-on token pool; when \"CURRENCY\", the fees are billed in the currency\nspecified in the \"fees\" field.", "enum": [ "CURRENCY", "TOKEN" ], "title": "ItAssetsAssetIdDeliverPostResponsesContentApplicationJsonSchemaDataActionsTransferOwnAssetDetailsTransferCostBillingMethod", "type": "string" }, "ItAssetsAssetIdDeliverPostResponsesContentApplicationJsonSchemaDataActionsTransferOwnAssetDetailsTransferCostFees": { "description": "Price charged for the action. Null when billing method is \"TOKEN\"", "properties": { "amount": { "description": "Amount", "format": "decimal", "type": "string" }, "currency": { "$ref": "#/components/schemas/ItAssetsAssetIdDeliverPostResponsesContentApplicationJsonSchemaDataActionsTransferOwnAssetDetailsTransferCostFeesCurrency", "description": "Three-letter currency code for the price" } }, "required": [ "amount", "currency" ], "title": "ItAssetsAssetIdDeliverPostResponsesContentApplicationJsonSchemaDataActionsTransferOwnAssetDetailsTransferCostFees", "type": "object" }, "ItAssetsAssetIdDeliverPostResponsesContentApplicationJsonSchemaDataActionsTransferOwnAssetDetailsTransferCostFeesCurrency": { "description": "Three-letter currency code for the price", "enum": [ "AED", "AFN", "ALL", "AMD", "ANG", "AOA", "ARS", "AUD", "AWG", "AZN", "BAM", "BDT", "BGN", "BHD", "BIF", "BMD", "BOB", "BRL", "BSD", "BTN", "BWP", "BYN", "BZD", "CAD", "CDF", "CHF", "CLP", "CNY", "COP", "CRC", "CUC", "CVE", "CZK", "DJF", "DKK", "DOP", "DZD", "EGP", "ERN", "ETB", "EUR", "FJD", "FKP", "GBP", "GEL", "GHS", "GIP", "GMD", "GNF", "GTQ", "GYD", "HKD", "HNL", "HRK", "HTG", "HUF", "IDR", "ILS", "INR", "IQD", "IRR", "ISK", "JMD", "JOD", "JPY", "KES", "KGS", "KHR", "KMF", "KPW", "KRW", "KWD", "KYD", "KZT", "LAK", "LBP", "LKR", "LRD", "LSL", "LTL", "LYD", "MAD", "MDL", "MGA", "MKD", "MMK", "MNT", "MRU", "MUR", "MVR", "MWK", "MXN", "MYR", "MZN", "NAD", "NGN", "NIO", "NOK", "NPR", "NZD", "OMR", "PAB", "PEN", "PGK", "PHP", "PKR", "PLN", "PYG", "QAR", "RON", "RSD", "RUB", "RWF", "SAR", "SBD", "SCR", "SDG", "SEK", "SGD", "SHP", "SLL", "SOS", "SRD", "SSP", "STD", "SYP", "SZL", "THB", "TJS", "TMT", "TND", "TOP", "TRY", "TTD", "TWD", "TZS", "UAH", "UGX", "USD", "UYU", "UZS", "VEF", "VND", "VUV", "WST", "XAF", "XCD", "XOF", "XPF", "YER", "ZAR", "ZMW", "ZWD" ], "title": "ItAssetsAssetIdDeliverPostResponsesContentApplicationJsonSchemaDataActionsTransferOwnAssetDetailsTransferCostFeesCurrency", "type": "string" }, "ItAssetsAssetIdDeliverPostResponsesContentApplicationJsonSchemaDataActionsTransferOwnAssetDetailsTransferCostTokenUsage": { "description": "Add-on token consumption details. Null when billing method is \"CURRENCY\"", "properties": { "addon": { "$ref": "#/components/schemas/ItAssetsAssetIdDeliverPostResponsesContentApplicationJsonSchemaDataActionsTransferOwnAssetDetailsTransferCostTokenUsageAddon", "description": "The add-on that provides the tokens" }, "cost": { "description": "Number of tokens consumed by the action. Zero when the add-on covers the\nservice without drawing from a token pool", "format": "decimal", "type": "string" }, "tokens_left": { "description": "Number of tokens left in the pool after the action is performed. Null when\nthe add-on covers the service without a token pool", "format": "decimal", "type": [ "string", "null" ] } }, "required": [ "cost", "addon", "tokens_left" ], "title": "ItAssetsAssetIdDeliverPostResponsesContentApplicationJsonSchemaDataActionsTransferOwnAssetDetailsTransferCostTokenUsage", "type": "object" }, "ItAssetsAssetIdDeliverPostResponsesContentApplicationJsonSchemaDataActionsTransferOwnAssetDetailsTransferCostTokenUsageAddon": { "description": "The add-on that provides the tokens", "properties": { "id": { "description": "ID of the add-on", "format": "uuid", "type": "string" }, "name": { "description": "Public display name of the add-on", "type": "string" } }, "required": [ "id", "name" ], "title": "ItAssetsAssetIdDeliverPostResponsesContentApplicationJsonSchemaDataActionsTransferOwnAssetDetailsTransferCostTokenUsageAddon", "type": "object" }, "ItAssetsAssetIdDeliverPostResponsesContentApplicationJsonSchemaDataActionsTransferOwnAssetDisabledReasonsItems": { "enum": [ "ARCHIVED", "AT_DEEL_WAREHOUSE", "BEING_REPAIRED", "CONSUMABLE", "CONTROLLED_BY_DEEL", "COUNTRY_NOT_SUPPORTED_FOR_HUB", "COUNTRY_NOT_SUPPORTED_FOR_LOCAL", "DEEL_OWNED_ITEM_WITHOUT_RENTAL_CONTRACT", "DESKTOP_STORAGE", "ENDING_CONTRACT", "HUB_IN_SAME_REGION_AS_LOCAL", "INACTIVE", "INVALID_ITEM_LOCATION", "INVALID_ORGANIZATION_STATUS", "INVALID_STATE", "ITEM_CONDITIONS_TO_UNARCHIVE_NOT_MET", "ITEM_NOT_VISIBLE_FOR_ORGANIZATION", "NON_DEVICE", "NOT_AT_WAREHOUSE", "NOT_AVAILABLE_FOR_REUSE", "NOT_A_RENTAL", "NOT_MANAGEABLE_BY_ORGANIZATION", "NOT_WITH_ASSIGNMENT", "NOT_WITH_USER", "NO_ACTIVE_ADDONS", "NO_ACTIVE_STORAGE_CONTRACT", "NO_LOCATION_FOR_STORAGE", "NO_LOGISTICS_FOR_STORAGE", "NO_VALID_ADDONS", "ONGOING_SERVICE", "OWNED_BY_DEEL", "OWNED_BY_ORGANIZATION", "OWNED_BY_PARTNER_ORGANIZATION", "PARTNER_CHILD_CONTRACT", "PENDING_DEVICE_REFRESH", "RENTAL_CONTRACT_AND_USER_REGION_DO_NOT_MATCH", "TEMPORARILY_UNAVAILABLE", "UNKNOWN", "USER_HAS_NO_COUNTRY", "USER_HAS_NO_SEAT", "WAITING_FOR_CLEARANCE", "WITH_LOANER_ASSIGNMENT", "WITH_NON_COLLECTED_ASSIGNMENT", "WITH_NON_DELIVERED_ASSIGNMENT", "WITH_PENDING_ASSIGNMENT", "WRONG_ASSIGNMENT_STATUS", "WRONG_CONTRACT_STATUS", "WRONG_TERMS_AND_CONDITIONS" ], "title": "ItAssetsAssetIdDeliverPostResponsesContentApplicationJsonSchemaDataActionsTransferOwnAssetDisabledReasonsItems", "type": "string" }, "ItAssetsAssetIdDeliverPostResponsesContentApplicationJsonSchemaDataActionsTransferOwnAssetStatus": { "description": "Whether the action is currently available for this asset", "enum": [ "DISABLED", "ENABLED", "NOT_APPLICABLE" ], "title": "ItAssetsAssetIdDeliverPostResponsesContentApplicationJsonSchemaDataActionsTransferOwnAssetStatus", "type": "string" }, "ItAssetsAssetIdDeliverPostResponsesContentApplicationJsonSchemaDataActionsTransferRental": { "description": "Transfer a Deel-owned rental asset to another user", "properties": { "details": { "description": "Action-specific context needed to perform the action. Populated for enabled and\ndisabled actions (so callers can see what a successful attempt would look like);\nnull when the action is not applicable to this asset.", "oneOf": [ { "$ref": "#/components/schemas/ItAssetsAssetIdDeliverPostResponsesContentApplicationJsonSchemaDataActionsTransferRentalDetails" }, { "type": "null" } ] }, "disabled_reasons": { "description": "Reasons why the action is disabled. Empty when the action is enabled or not applicable", "items": { "$ref": "#/components/schemas/ItAssetsAssetIdDeliverPostResponsesContentApplicationJsonSchemaDataActionsTransferRentalDisabledReasonsItems" }, "type": "array" }, "status": { "$ref": "#/components/schemas/ItAssetsAssetIdDeliverPostResponsesContentApplicationJsonSchemaDataActionsTransferRentalStatus", "description": "Whether the action is currently available for this asset" } }, "required": [ "status", "details", "disabled_reasons" ], "title": "ItAssetsAssetIdDeliverPostResponsesContentApplicationJsonSchemaDataActionsTransferRental", "type": "object" }, "ItAssetsAssetIdDeliverPostResponsesContentApplicationJsonSchemaDataActionsTransferRentalDetails": { "description": "Action-specific context needed to perform the action. Populated for enabled and\ndisabled actions (so callers can see what a successful attempt would look like);\nnull when the action is not applicable to this asset.", "properties": { "eligible_countries": { "description": "Countries the asset can be transferred to", "items": { "$ref": "#/components/schemas/ItAssetsAssetIdDeliverPostResponsesContentApplicationJsonSchemaDataActionsTransferRentalDetailsEligibleCountriesItems" }, "type": "array" }, "transfer_cost": { "$ref": "#/components/schemas/ItAssetsAssetIdDeliverPostResponsesContentApplicationJsonSchemaDataActionsTransferRentalDetailsTransferCost", "description": "Cost charged for the transfer service" } }, "required": [ "transfer_cost", "eligible_countries" ], "title": "ItAssetsAssetIdDeliverPostResponsesContentApplicationJsonSchemaDataActionsTransferRentalDetails", "type": "object" }, "ItAssetsAssetIdDeliverPostResponsesContentApplicationJsonSchemaDataActionsTransferRentalDetailsEligibleCountriesItems": { "enum": [ "AD", "AE", "AF", "AG", "AI", "AL", "AM", "AN", "AO", "AQ", "AR", "AS", "AT", "AU", "AW", "AX", "AZ", "BA", "BB", "BD", "BE", "BF", "BG", "BH", "BI", "BJ", "BL", "BM", "BN", "BO", "BQ", "BR", "BS", "BT", "BV", "BW", "BY", "BZ", "CA", "CC", "CD", "CF", "CG", "CH", "CI", "CK", "CL", "CM", "CN", "CO", "CR", "CU", "CV", "CW", "CX", "CY", "CZ", "DE", "DJ", "DK", "DM", "DO", "DZ", "EC", "EE", "EG", "EH", "ER", "ES", "ET", "FI", "FJ", "FK", "FM", "FO", "FR", "GA", "GB", "GD", "GE", "GF", "GG", "GH", "GI", "GL", "GM", "GN", "GP", "GQ", "GR", "GS", "GT", "GU", "GW", "GY", "HK", "HM", "HN", "HR", "HT", "HU", "IC", "ID", "IE", "IL", "IM", "IN", "IO", "IQ", "IR", "IS", "IT", "JE", "JM", "JO", "JP", "KE", "KG", "KH", "KI", "KM", "KN", "KP", "KR", "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", "XK", "YE", "YT", "ZA", "ZM", "ZW" ], "title": "ItAssetsAssetIdDeliverPostResponsesContentApplicationJsonSchemaDataActionsTransferRentalDetailsEligibleCountriesItems", "type": "string" }, "ItAssetsAssetIdDeliverPostResponsesContentApplicationJsonSchemaDataActionsTransferRentalDetailsTransferCost": { "description": "Cost charged for the transfer service", "properties": { "billing_method": { "$ref": "#/components/schemas/ItAssetsAssetIdDeliverPostResponsesContentApplicationJsonSchemaDataActionsTransferRentalDetailsTransferCostBillingMethod", "description": "How the action is charged. When \"TOKEN\", the fees are covered by an\nadd-on token pool; when \"CURRENCY\", the fees are billed in the currency\nspecified in the \"fees\" field." }, "fees": { "description": "Price charged for the action. Null when billing method is \"TOKEN\"", "oneOf": [ { "$ref": "#/components/schemas/ItAssetsAssetIdDeliverPostResponsesContentApplicationJsonSchemaDataActionsTransferRentalDetailsTransferCostFees" }, { "type": "null" } ] }, "token_usage": { "description": "Add-on token consumption details. Null when billing method is \"CURRENCY\"", "oneOf": [ { "$ref": "#/components/schemas/ItAssetsAssetIdDeliverPostResponsesContentApplicationJsonSchemaDataActionsTransferRentalDetailsTransferCostTokenUsage" }, { "type": "null" } ] } }, "required": [ "fees", "token_usage", "billing_method" ], "title": "ItAssetsAssetIdDeliverPostResponsesContentApplicationJsonSchemaDataActionsTransferRentalDetailsTransferCost", "type": "object" }, "ItAssetsAssetIdDeliverPostResponsesContentApplicationJsonSchemaDataActionsTransferRentalDetailsTransferCostBillingMethod": { "description": "How the action is charged. When \"TOKEN\", the fees are covered by an\nadd-on token pool; when \"CURRENCY\", the fees are billed in the currency\nspecified in the \"fees\" field.", "enum": [ "CURRENCY", "TOKEN" ], "title": "ItAssetsAssetIdDeliverPostResponsesContentApplicationJsonSchemaDataActionsTransferRentalDetailsTransferCostBillingMethod", "type": "string" }, "ItAssetsAssetIdDeliverPostResponsesContentApplicationJsonSchemaDataActionsTransferRentalDetailsTransferCostFees": { "description": "Price charged for the action. Null when billing method is \"TOKEN\"", "properties": { "amount": { "description": "Amount", "format": "decimal", "type": "string" }, "currency": { "$ref": "#/components/schemas/ItAssetsAssetIdDeliverPostResponsesContentApplicationJsonSchemaDataActionsTransferRentalDetailsTransferCostFeesCurrency", "description": "Three-letter currency code for the price" } }, "required": [ "amount", "currency" ], "title": "ItAssetsAssetIdDeliverPostResponsesContentApplicationJsonSchemaDataActionsTransferRentalDetailsTransferCostFees", "type": "object" }, "ItAssetsAssetIdDeliverPostResponsesContentApplicationJsonSchemaDataActionsTransferRentalDetailsTransferCostFeesCurrency": { "description": "Three-letter currency code for the price", "enum": [ "AED", "AFN", "ALL", "AMD", "ANG", "AOA", "ARS", "AUD", "AWG", "AZN", "BAM", "BDT", "BGN", "BHD", "BIF", "BMD", "BOB", "BRL", "BSD", "BTN", "BWP", "BYN", "BZD", "CAD", "CDF", "CHF", "CLP", "CNY", "COP", "CRC", "CUC", "CVE", "CZK", "DJF", "DKK", "DOP", "DZD", "EGP", "ERN", "ETB", "EUR", "FJD", "FKP", "GBP", "GEL", "GHS", "GIP", "GMD", "GNF", "GTQ", "GYD", "HKD", "HNL", "HRK", "HTG", "HUF", "IDR", "ILS", "INR", "IQD", "IRR", "ISK", "JMD", "JOD", "JPY", "KES", "KGS", "KHR", "KMF", "KPW", "KRW", "KWD", "KYD", "KZT", "LAK", "LBP", "LKR", "LRD", "LSL", "LTL", "LYD", "MAD", "MDL", "MGA", "MKD", "MMK", "MNT", "MRU", "MUR", "MVR", "MWK", "MXN", "MYR", "MZN", "NAD", "NGN", "NIO", "NOK", "NPR", "NZD", "OMR", "PAB", "PEN", "PGK", "PHP", "PKR", "PLN", "PYG", "QAR", "RON", "RSD", "RUB", "RWF", "SAR", "SBD", "SCR", "SDG", "SEK", "SGD", "SHP", "SLL", "SOS", "SRD", "SSP", "STD", "SYP", "SZL", "THB", "TJS", "TMT", "TND", "TOP", "TRY", "TTD", "TWD", "TZS", "UAH", "UGX", "USD", "UYU", "UZS", "VEF", "VND", "VUV", "WST", "XAF", "XCD", "XOF", "XPF", "YER", "ZAR", "ZMW", "ZWD" ], "title": "ItAssetsAssetIdDeliverPostResponsesContentApplicationJsonSchemaDataActionsTransferRentalDetailsTransferCostFeesCurrency", "type": "string" }, "ItAssetsAssetIdDeliverPostResponsesContentApplicationJsonSchemaDataActionsTransferRentalDetailsTransferCostTokenUsage": { "description": "Add-on token consumption details. Null when billing method is \"CURRENCY\"", "properties": { "addon": { "$ref": "#/components/schemas/ItAssetsAssetIdDeliverPostResponsesContentApplicationJsonSchemaDataActionsTransferRentalDetailsTransferCostTokenUsageAddon", "description": "The add-on that provides the tokens" }, "cost": { "description": "Number of tokens consumed by the action. Zero when the add-on covers the\nservice without drawing from a token pool", "format": "decimal", "type": "string" }, "tokens_left": { "description": "Number of tokens left in the pool after the action is performed. Null when\nthe add-on covers the service without a token pool", "format": "decimal", "type": [ "string", "null" ] } }, "required": [ "cost", "addon", "tokens_left" ], "title": "ItAssetsAssetIdDeliverPostResponsesContentApplicationJsonSchemaDataActionsTransferRentalDetailsTransferCostTokenUsage", "type": "object" }, "ItAssetsAssetIdDeliverPostResponsesContentApplicationJsonSchemaDataActionsTransferRentalDetailsTransferCostTokenUsageAddon": { "description": "The add-on that provides the tokens", "properties": { "id": { "description": "ID of the add-on", "format": "uuid", "type": "string" }, "name": { "description": "Public display name of the add-on", "type": "string" } }, "required": [ "id", "name" ], "title": "ItAssetsAssetIdDeliverPostResponsesContentApplicationJsonSchemaDataActionsTransferRentalDetailsTransferCostTokenUsageAddon", "type": "object" }, "ItAssetsAssetIdDeliverPostResponsesContentApplicationJsonSchemaDataActionsTransferRentalDisabledReasonsItems": { "enum": [ "ARCHIVED", "AT_DEEL_WAREHOUSE", "BEING_REPAIRED", "CONSUMABLE", "CONTROLLED_BY_DEEL", "COUNTRY_NOT_SUPPORTED_FOR_HUB", "COUNTRY_NOT_SUPPORTED_FOR_LOCAL", "DEEL_OWNED_ITEM_WITHOUT_RENTAL_CONTRACT", "DESKTOP_STORAGE", "ENDING_CONTRACT", "HUB_IN_SAME_REGION_AS_LOCAL", "INACTIVE", "INVALID_ITEM_LOCATION", "INVALID_ORGANIZATION_STATUS", "INVALID_STATE", "ITEM_CONDITIONS_TO_UNARCHIVE_NOT_MET", "ITEM_NOT_VISIBLE_FOR_ORGANIZATION", "NON_DEVICE", "NOT_AT_WAREHOUSE", "NOT_AVAILABLE_FOR_REUSE", "NOT_A_RENTAL", "NOT_MANAGEABLE_BY_ORGANIZATION", "NOT_WITH_ASSIGNMENT", "NOT_WITH_USER", "NO_ACTIVE_ADDONS", "NO_ACTIVE_STORAGE_CONTRACT", "NO_LOCATION_FOR_STORAGE", "NO_LOGISTICS_FOR_STORAGE", "NO_VALID_ADDONS", "ONGOING_SERVICE", "OWNED_BY_DEEL", "OWNED_BY_ORGANIZATION", "OWNED_BY_PARTNER_ORGANIZATION", "PARTNER_CHILD_CONTRACT", "PENDING_DEVICE_REFRESH", "RENTAL_CONTRACT_AND_USER_REGION_DO_NOT_MATCH", "TEMPORARILY_UNAVAILABLE", "UNKNOWN", "USER_HAS_NO_COUNTRY", "USER_HAS_NO_SEAT", "WAITING_FOR_CLEARANCE", "WITH_LOANER_ASSIGNMENT", "WITH_NON_COLLECTED_ASSIGNMENT", "WITH_NON_DELIVERED_ASSIGNMENT", "WITH_PENDING_ASSIGNMENT", "WRONG_ASSIGNMENT_STATUS", "WRONG_CONTRACT_STATUS", "WRONG_TERMS_AND_CONDITIONS" ], "title": "ItAssetsAssetIdDeliverPostResponsesContentApplicationJsonSchemaDataActionsTransferRentalDisabledReasonsItems", "type": "string" }, "ItAssetsAssetIdDeliverPostResponsesContentApplicationJsonSchemaDataActionsTransferRentalStatus": { "description": "Whether the action is currently available for this asset", "enum": [ "DISABLED", "ENABLED", "NOT_APPLICABLE" ], "title": "ItAssetsAssetIdDeliverPostResponsesContentApplicationJsonSchemaDataActionsTransferRentalStatus", "type": "string" }, "ItAssetsAssetIdDeliverPostResponsesContentApplicationJsonSchemaDataActionsUnarchiveOwnAsset": { "description": "Unarchive a previously archived organization-owned asset", "properties": { "disabled_reasons": { "description": "Reasons why the action is disabled. Empty when the action is enabled or not applicable", "items": { "$ref": "#/components/schemas/ItAssetsAssetIdDeliverPostResponsesContentApplicationJsonSchemaDataActionsUnarchiveOwnAssetDisabledReasonsItems" }, "type": "array" }, "status": { "$ref": "#/components/schemas/ItAssetsAssetIdDeliverPostResponsesContentApplicationJsonSchemaDataActionsUnarchiveOwnAssetStatus", "description": "Whether the action is currently available for this asset" } }, "required": [ "status", "disabled_reasons" ], "title": "ItAssetsAssetIdDeliverPostResponsesContentApplicationJsonSchemaDataActionsUnarchiveOwnAsset", "type": "object" }, "ItAssetsAssetIdDeliverPostResponsesContentApplicationJsonSchemaDataActionsUnarchiveOwnAssetDisabledReasonsItems": { "enum": [ "ARCHIVED", "AT_DEEL_WAREHOUSE", "BEING_REPAIRED", "CONSUMABLE", "CONTROLLED_BY_DEEL", "COUNTRY_NOT_SUPPORTED_FOR_HUB", "COUNTRY_NOT_SUPPORTED_FOR_LOCAL", "DEEL_OWNED_ITEM_WITHOUT_RENTAL_CONTRACT", "DESKTOP_STORAGE", "ENDING_CONTRACT", "HUB_IN_SAME_REGION_AS_LOCAL", "INACTIVE", "INVALID_ITEM_LOCATION", "INVALID_ORGANIZATION_STATUS", "INVALID_STATE", "ITEM_CONDITIONS_TO_UNARCHIVE_NOT_MET", "ITEM_NOT_VISIBLE_FOR_ORGANIZATION", "NON_DEVICE", "NOT_AT_WAREHOUSE", "NOT_AVAILABLE_FOR_REUSE", "NOT_A_RENTAL", "NOT_MANAGEABLE_BY_ORGANIZATION", "NOT_WITH_ASSIGNMENT", "NOT_WITH_USER", "NO_ACTIVE_ADDONS", "NO_ACTIVE_STORAGE_CONTRACT", "NO_LOCATION_FOR_STORAGE", "NO_LOGISTICS_FOR_STORAGE", "NO_VALID_ADDONS", "ONGOING_SERVICE", "OWNED_BY_DEEL", "OWNED_BY_ORGANIZATION", "OWNED_BY_PARTNER_ORGANIZATION", "PARTNER_CHILD_CONTRACT", "PENDING_DEVICE_REFRESH", "RENTAL_CONTRACT_AND_USER_REGION_DO_NOT_MATCH", "TEMPORARILY_UNAVAILABLE", "UNKNOWN", "USER_HAS_NO_COUNTRY", "USER_HAS_NO_SEAT", "WAITING_FOR_CLEARANCE", "WITH_LOANER_ASSIGNMENT", "WITH_NON_COLLECTED_ASSIGNMENT", "WITH_NON_DELIVERED_ASSIGNMENT", "WITH_PENDING_ASSIGNMENT", "WRONG_ASSIGNMENT_STATUS", "WRONG_CONTRACT_STATUS", "WRONG_TERMS_AND_CONDITIONS" ], "title": "ItAssetsAssetIdDeliverPostResponsesContentApplicationJsonSchemaDataActionsUnarchiveOwnAssetDisabledReasonsItems", "type": "string" }, "ItAssetsAssetIdDeliverPostResponsesContentApplicationJsonSchemaDataActionsUnarchiveOwnAssetStatus": { "description": "Whether the action is currently available for this asset", "enum": [ "DISABLED", "ENABLED", "NOT_APPLICABLE" ], "title": "ItAssetsAssetIdDeliverPostResponsesContentApplicationJsonSchemaDataActionsUnarchiveOwnAssetStatus", "type": "string" }, "ItAssetsAssetIdDeliverPostResponsesContentApplicationJsonSchemaDataActionsUpdateLocationLocationToUser": { "description": "Update the location of an asset from a warehouse to a user", "properties": { "disabled_reasons": { "description": "Reasons why the action is disabled. Empty when the action is enabled or not applicable", "items": { "$ref": "#/components/schemas/ItAssetsAssetIdDeliverPostResponsesContentApplicationJsonSchemaDataActionsUpdateLocationLocationToUserDisabledReasonsItems" }, "type": "array" }, "status": { "$ref": "#/components/schemas/ItAssetsAssetIdDeliverPostResponsesContentApplicationJsonSchemaDataActionsUpdateLocationLocationToUserStatus", "description": "Whether the action is currently available for this asset" } }, "required": [ "status", "disabled_reasons" ], "title": "ItAssetsAssetIdDeliverPostResponsesContentApplicationJsonSchemaDataActionsUpdateLocationLocationToUser", "type": "object" }, "ItAssetsAssetIdDeliverPostResponsesContentApplicationJsonSchemaDataActionsUpdateLocationLocationToUserDisabledReasonsItems": { "enum": [ "ARCHIVED", "AT_DEEL_WAREHOUSE", "BEING_REPAIRED", "CONSUMABLE", "CONTROLLED_BY_DEEL", "COUNTRY_NOT_SUPPORTED_FOR_HUB", "COUNTRY_NOT_SUPPORTED_FOR_LOCAL", "DEEL_OWNED_ITEM_WITHOUT_RENTAL_CONTRACT", "DESKTOP_STORAGE", "ENDING_CONTRACT", "HUB_IN_SAME_REGION_AS_LOCAL", "INACTIVE", "INVALID_ITEM_LOCATION", "INVALID_ORGANIZATION_STATUS", "INVALID_STATE", "ITEM_CONDITIONS_TO_UNARCHIVE_NOT_MET", "ITEM_NOT_VISIBLE_FOR_ORGANIZATION", "NON_DEVICE", "NOT_AT_WAREHOUSE", "NOT_AVAILABLE_FOR_REUSE", "NOT_A_RENTAL", "NOT_MANAGEABLE_BY_ORGANIZATION", "NOT_WITH_ASSIGNMENT", "NOT_WITH_USER", "NO_ACTIVE_ADDONS", "NO_ACTIVE_STORAGE_CONTRACT", "NO_LOCATION_FOR_STORAGE", "NO_LOGISTICS_FOR_STORAGE", "NO_VALID_ADDONS", "ONGOING_SERVICE", "OWNED_BY_DEEL", "OWNED_BY_ORGANIZATION", "OWNED_BY_PARTNER_ORGANIZATION", "PARTNER_CHILD_CONTRACT", "PENDING_DEVICE_REFRESH", "RENTAL_CONTRACT_AND_USER_REGION_DO_NOT_MATCH", "TEMPORARILY_UNAVAILABLE", "UNKNOWN", "USER_HAS_NO_COUNTRY", "USER_HAS_NO_SEAT", "WAITING_FOR_CLEARANCE", "WITH_LOANER_ASSIGNMENT", "WITH_NON_COLLECTED_ASSIGNMENT", "WITH_NON_DELIVERED_ASSIGNMENT", "WITH_PENDING_ASSIGNMENT", "WRONG_ASSIGNMENT_STATUS", "WRONG_CONTRACT_STATUS", "WRONG_TERMS_AND_CONDITIONS" ], "title": "ItAssetsAssetIdDeliverPostResponsesContentApplicationJsonSchemaDataActionsUpdateLocationLocationToUserDisabledReasonsItems", "type": "string" }, "ItAssetsAssetIdDeliverPostResponsesContentApplicationJsonSchemaDataActionsUpdateLocationLocationToUserStatus": { "description": "Whether the action is currently available for this asset", "enum": [ "DISABLED", "ENABLED", "NOT_APPLICABLE" ], "title": "ItAssetsAssetIdDeliverPostResponsesContentApplicationJsonSchemaDataActionsUpdateLocationLocationToUserStatus", "type": "string" }, "ItAssetsAssetIdDeliverPostResponsesContentApplicationJsonSchemaDataActionsUpdateLocationUserToLocation": { "description": "Update the location of an asset from a user to a warehouse", "properties": { "disabled_reasons": { "description": "Reasons why the action is disabled. Empty when the action is enabled or not applicable", "items": { "$ref": "#/components/schemas/ItAssetsAssetIdDeliverPostResponsesContentApplicationJsonSchemaDataActionsUpdateLocationUserToLocationDisabledReasonsItems" }, "type": "array" }, "status": { "$ref": "#/components/schemas/ItAssetsAssetIdDeliverPostResponsesContentApplicationJsonSchemaDataActionsUpdateLocationUserToLocationStatus", "description": "Whether the action is currently available for this asset" } }, "required": [ "status", "disabled_reasons" ], "title": "ItAssetsAssetIdDeliverPostResponsesContentApplicationJsonSchemaDataActionsUpdateLocationUserToLocation", "type": "object" }, "ItAssetsAssetIdDeliverPostResponsesContentApplicationJsonSchemaDataActionsUpdateLocationUserToLocationDisabledReasonsItems": { "enum": [ "ARCHIVED", "AT_DEEL_WAREHOUSE", "BEING_REPAIRED", "CONSUMABLE", "CONTROLLED_BY_DEEL", "COUNTRY_NOT_SUPPORTED_FOR_HUB", "COUNTRY_NOT_SUPPORTED_FOR_LOCAL", "DEEL_OWNED_ITEM_WITHOUT_RENTAL_CONTRACT", "DESKTOP_STORAGE", "ENDING_CONTRACT", "HUB_IN_SAME_REGION_AS_LOCAL", "INACTIVE", "INVALID_ITEM_LOCATION", "INVALID_ORGANIZATION_STATUS", "INVALID_STATE", "ITEM_CONDITIONS_TO_UNARCHIVE_NOT_MET", "ITEM_NOT_VISIBLE_FOR_ORGANIZATION", "NON_DEVICE", "NOT_AT_WAREHOUSE", "NOT_AVAILABLE_FOR_REUSE", "NOT_A_RENTAL", "NOT_MANAGEABLE_BY_ORGANIZATION", "NOT_WITH_ASSIGNMENT", "NOT_WITH_USER", "NO_ACTIVE_ADDONS", "NO_ACTIVE_STORAGE_CONTRACT", "NO_LOCATION_FOR_STORAGE", "NO_LOGISTICS_FOR_STORAGE", "NO_VALID_ADDONS", "ONGOING_SERVICE", "OWNED_BY_DEEL", "OWNED_BY_ORGANIZATION", "OWNED_BY_PARTNER_ORGANIZATION", "PARTNER_CHILD_CONTRACT", "PENDING_DEVICE_REFRESH", "RENTAL_CONTRACT_AND_USER_REGION_DO_NOT_MATCH", "TEMPORARILY_UNAVAILABLE", "UNKNOWN", "USER_HAS_NO_COUNTRY", "USER_HAS_NO_SEAT", "WAITING_FOR_CLEARANCE", "WITH_LOANER_ASSIGNMENT", "WITH_NON_COLLECTED_ASSIGNMENT", "WITH_NON_DELIVERED_ASSIGNMENT", "WITH_PENDING_ASSIGNMENT", "WRONG_ASSIGNMENT_STATUS", "WRONG_CONTRACT_STATUS", "WRONG_TERMS_AND_CONDITIONS" ], "title": "ItAssetsAssetIdDeliverPostResponsesContentApplicationJsonSchemaDataActionsUpdateLocationUserToLocationDisabledReasonsItems", "type": "string" }, "ItAssetsAssetIdDeliverPostResponsesContentApplicationJsonSchemaDataActionsUpdateLocationUserToLocationStatus": { "description": "Whether the action is currently available for this asset", "enum": [ "DISABLED", "ENABLED", "NOT_APPLICABLE" ], "title": "ItAssetsAssetIdDeliverPostResponsesContentApplicationJsonSchemaDataActionsUpdateLocationUserToLocationStatus", "type": "string" }, "ItAssetsAssetIdDeliverPostResponsesContentApplicationJsonSchemaDataActionsUpdateLocationUserToUser": { "description": "Update the assigned user of an asset that is currently with a user", "properties": { "disabled_reasons": { "description": "Reasons why the action is disabled. Empty when the action is enabled or not applicable", "items": { "$ref": "#/components/schemas/ItAssetsAssetIdDeliverPostResponsesContentApplicationJsonSchemaDataActionsUpdateLocationUserToUserDisabledReasonsItems" }, "type": "array" }, "status": { "$ref": "#/components/schemas/ItAssetsAssetIdDeliverPostResponsesContentApplicationJsonSchemaDataActionsUpdateLocationUserToUserStatus", "description": "Whether the action is currently available for this asset" } }, "required": [ "status", "disabled_reasons" ], "title": "ItAssetsAssetIdDeliverPostResponsesContentApplicationJsonSchemaDataActionsUpdateLocationUserToUser", "type": "object" }, "ItAssetsAssetIdDeliverPostResponsesContentApplicationJsonSchemaDataActionsUpdateLocationUserToUserDisabledReasonsItems": { "enum": [ "ARCHIVED", "AT_DEEL_WAREHOUSE", "BEING_REPAIRED", "CONSUMABLE", "CONTROLLED_BY_DEEL", "COUNTRY_NOT_SUPPORTED_FOR_HUB", "COUNTRY_NOT_SUPPORTED_FOR_LOCAL", "DEEL_OWNED_ITEM_WITHOUT_RENTAL_CONTRACT", "DESKTOP_STORAGE", "ENDING_CONTRACT", "HUB_IN_SAME_REGION_AS_LOCAL", "INACTIVE", "INVALID_ITEM_LOCATION", "INVALID_ORGANIZATION_STATUS", "INVALID_STATE", "ITEM_CONDITIONS_TO_UNARCHIVE_NOT_MET", "ITEM_NOT_VISIBLE_FOR_ORGANIZATION", "NON_DEVICE", "NOT_AT_WAREHOUSE", "NOT_AVAILABLE_FOR_REUSE", "NOT_A_RENTAL", "NOT_MANAGEABLE_BY_ORGANIZATION", "NOT_WITH_ASSIGNMENT", "NOT_WITH_USER", "NO_ACTIVE_ADDONS", "NO_ACTIVE_STORAGE_CONTRACT", "NO_LOCATION_FOR_STORAGE", "NO_LOGISTICS_FOR_STORAGE", "NO_VALID_ADDONS", "ONGOING_SERVICE", "OWNED_BY_DEEL", "OWNED_BY_ORGANIZATION", "OWNED_BY_PARTNER_ORGANIZATION", "PARTNER_CHILD_CONTRACT", "PENDING_DEVICE_REFRESH", "RENTAL_CONTRACT_AND_USER_REGION_DO_NOT_MATCH", "TEMPORARILY_UNAVAILABLE", "UNKNOWN", "USER_HAS_NO_COUNTRY", "USER_HAS_NO_SEAT", "WAITING_FOR_CLEARANCE", "WITH_LOANER_ASSIGNMENT", "WITH_NON_COLLECTED_ASSIGNMENT", "WITH_NON_DELIVERED_ASSIGNMENT", "WITH_PENDING_ASSIGNMENT", "WRONG_ASSIGNMENT_STATUS", "WRONG_CONTRACT_STATUS", "WRONG_TERMS_AND_CONDITIONS" ], "title": "ItAssetsAssetIdDeliverPostResponsesContentApplicationJsonSchemaDataActionsUpdateLocationUserToUserDisabledReasonsItems", "type": "string" }, "ItAssetsAssetIdDeliverPostResponsesContentApplicationJsonSchemaDataActionsUpdateLocationUserToUserStatus": { "description": "Whether the action is currently available for this asset", "enum": [ "DISABLED", "ENABLED", "NOT_APPLICABLE" ], "title": "ItAssetsAssetIdDeliverPostResponsesContentApplicationJsonSchemaDataActionsUpdateLocationUserToUserStatus", "type": "string" }, "ItAssetsAssetIdDeliverPostResponsesContentApplicationJsonSchemaDataActionsUpdateOwnAssetDetails": { "description": "Update editable details of an organization-owned asset", "properties": { "disabled_reasons": { "description": "Reasons why the action is disabled. Empty when the action is enabled or not applicable", "items": { "$ref": "#/components/schemas/ItAssetsAssetIdDeliverPostResponsesContentApplicationJsonSchemaDataActionsUpdateOwnAssetDetailsDisabledReasonsItems" }, "type": "array" }, "status": { "$ref": "#/components/schemas/ItAssetsAssetIdDeliverPostResponsesContentApplicationJsonSchemaDataActionsUpdateOwnAssetDetailsStatus", "description": "Whether the action is currently available for this asset" } }, "required": [ "status", "disabled_reasons" ], "title": "ItAssetsAssetIdDeliverPostResponsesContentApplicationJsonSchemaDataActionsUpdateOwnAssetDetails", "type": "object" }, "ItAssetsAssetIdDeliverPostResponsesContentApplicationJsonSchemaDataActionsUpdateOwnAssetDetailsDisabledReasonsItems": { "enum": [ "ARCHIVED", "AT_DEEL_WAREHOUSE", "BEING_REPAIRED", "CONSUMABLE", "CONTROLLED_BY_DEEL", "COUNTRY_NOT_SUPPORTED_FOR_HUB", "COUNTRY_NOT_SUPPORTED_FOR_LOCAL", "DEEL_OWNED_ITEM_WITHOUT_RENTAL_CONTRACT", "DESKTOP_STORAGE", "ENDING_CONTRACT", "HUB_IN_SAME_REGION_AS_LOCAL", "INACTIVE", "INVALID_ITEM_LOCATION", "INVALID_ORGANIZATION_STATUS", "INVALID_STATE", "ITEM_CONDITIONS_TO_UNARCHIVE_NOT_MET", "ITEM_NOT_VISIBLE_FOR_ORGANIZATION", "NON_DEVICE", "NOT_AT_WAREHOUSE", "NOT_AVAILABLE_FOR_REUSE", "NOT_A_RENTAL", "NOT_MANAGEABLE_BY_ORGANIZATION", "NOT_WITH_ASSIGNMENT", "NOT_WITH_USER", "NO_ACTIVE_ADDONS", "NO_ACTIVE_STORAGE_CONTRACT", "NO_LOCATION_FOR_STORAGE", "NO_LOGISTICS_FOR_STORAGE", "NO_VALID_ADDONS", "ONGOING_SERVICE", "OWNED_BY_DEEL", "OWNED_BY_ORGANIZATION", "OWNED_BY_PARTNER_ORGANIZATION", "PARTNER_CHILD_CONTRACT", "PENDING_DEVICE_REFRESH", "RENTAL_CONTRACT_AND_USER_REGION_DO_NOT_MATCH", "TEMPORARILY_UNAVAILABLE", "UNKNOWN", "USER_HAS_NO_COUNTRY", "USER_HAS_NO_SEAT", "WAITING_FOR_CLEARANCE", "WITH_LOANER_ASSIGNMENT", "WITH_NON_COLLECTED_ASSIGNMENT", "WITH_NON_DELIVERED_ASSIGNMENT", "WITH_PENDING_ASSIGNMENT", "WRONG_ASSIGNMENT_STATUS", "WRONG_CONTRACT_STATUS", "WRONG_TERMS_AND_CONDITIONS" ], "title": "ItAssetsAssetIdDeliverPostResponsesContentApplicationJsonSchemaDataActionsUpdateOwnAssetDetailsDisabledReasonsItems", "type": "string" }, "ItAssetsAssetIdDeliverPostResponsesContentApplicationJsonSchemaDataActionsUpdateOwnAssetDetailsStatus": { "description": "Whether the action is currently available for this asset", "enum": [ "DISABLED", "ENABLED", "NOT_APPLICABLE" ], "title": "ItAssetsAssetIdDeliverPostResponsesContentApplicationJsonSchemaDataActionsUpdateOwnAssetDetailsStatus", "type": "string" }, "ItAssetsAssetIdDeliverPostResponsesContentApplicationJsonSchemaDataAssignedUser": { "description": "Details of the user with asset possession", "properties": { "emails": { "description": "Array of user email addresses", "items": { "format": "email", "type": "string" }, "type": "array" }, "first_name": { "description": "First name of the user", "type": "string" }, "hris_profile_id": { "description": "The unique identifier of the HRIS profile of the assigned user", "format": "uuid", "type": "string" }, "last_name": { "description": "Last name of the user", "type": "string" } }, "required": [ "emails", "last_name", "first_name", "hris_profile_id" ], "title": "ItAssetsAssetIdDeliverPostResponsesContentApplicationJsonSchemaDataAssignedUser", "type": "object" }, "ItAssetsAssetIdDeliverPostResponsesContentApplicationJsonSchemaDataAssignedWarehouse": { "description": "Details of the warehouse with asset possession", "properties": { "address": { "$ref": "#/components/schemas/ItAssetsAssetIdDeliverPostResponsesContentApplicationJsonSchemaDataAssignedWarehouseAddress", "description": "Warehouse address details" }, "id": { "description": "Unique identifier of the warehouse", "format": "uuid", "type": "string" }, "name": { "description": "Warehouse or storage location name", "type": "string" }, "ownership": { "$ref": "#/components/schemas/ItAssetsAssetIdDeliverPostResponsesContentApplicationJsonSchemaDataAssignedWarehouseOwnership", "description": "Warehouse ownership type" }, "public_id": { "description": "Public identifier of the warehouse", "type": "string" }, "warehouse_type": { "$ref": "#/components/schemas/ItAssetsAssetIdDeliverPostResponsesContentApplicationJsonSchemaDataAssignedWarehouseWarehouseType", "description": "Warehouse type" } }, "required": [ "id", "name", "address", "ownership", "public_id", "warehouse_type" ], "title": "ItAssetsAssetIdDeliverPostResponsesContentApplicationJsonSchemaDataAssignedWarehouse", "type": "object" }, "ItAssetsAssetIdDeliverPostResponsesContentApplicationJsonSchemaDataAssignedWarehouseAddress": { "description": "Warehouse address details", "properties": { "city": { "description": "City name", "type": [ "string", "null" ] }, "country": { "$ref": "#/components/schemas/ItAssetsAssetIdDeliverPostResponsesContentApplicationJsonSchemaDataAssignedWarehouseAddressCountry", "description": "Country code" }, "date_of_birth": { "description": "Date of birth (applicable for some address types)", "format": "date", "type": [ "string", "null" ] }, "delivery_instructions": { "description": "Special instructions for deliveries", "type": [ "string", "null" ] }, "id": { "description": "Unique identifier of the address", "format": "uuid", "type": "string" }, "is_valid": { "description": "Whether the address passes validation", "type": "boolean" }, "line1": { "description": "Address line 1", "type": [ "string", "null" ] }, "line2": { "description": "Address line 2", "type": [ "string", "null" ] }, "passport_number": { "description": "Passport number (applicable for some address types)", "type": [ "string", "null" ] }, "phone_number": { "description": "Phone number", "type": [ "string", "null" ] }, "post_code": { "description": "Post code", "type": [ "string", "null" ] }, "state": { "description": "State code or name", "type": [ "string", "null" ] }, "tax_id_number": { "description": "Tax ID number (applicable for some address types)", "type": [ "string", "null" ] }, "type": { "$ref": "#/components/schemas/ItAssetsAssetIdDeliverPostResponsesContentApplicationJsonSchemaDataAssignedWarehouseAddressType", "description": "Type of the address" } }, "required": [ "id", "city", "type", "line1", "line2", "state", "country", "is_valid", "post_code", "phone_number", "date_of_birth", "tax_id_number", "passport_number", "delivery_instructions" ], "title": "ItAssetsAssetIdDeliverPostResponsesContentApplicationJsonSchemaDataAssignedWarehouseAddress", "type": "object" }, "ItAssetsAssetIdDeliverPostResponsesContentApplicationJsonSchemaDataAssignedWarehouseAddressCountry": { "description": "Country code", "enum": [ "AD", "AE", "AF", "AG", "AI", "AL", "AM", "AN", "AO", "AQ", "AR", "AS", "AT", "AU", "AW", "AX", "AZ", "BA", "BB", "BD", "BE", "BF", "BG", "BH", "BI", "BJ", "BL", "BM", "BN", "BO", "BQ", "BR", "BS", "BT", "BV", "BW", "BY", "BZ", "CA", "CC", "CD", "CF", "CG", "CH", "CI", "CK", "CL", "CM", "CN", "CO", "CR", "CU", "CV", "CW", "CX", "CY", "CZ", "DE", "DJ", "DK", "DM", "DO", "DZ", "EC", "EE", "EG", "EH", "ER", "ES", "ET", "FI", "FJ", "FK", "FM", "FO", "FR", "GA", "GB", "GD", "GE", "GF", "GG", "GH", "GI", "GL", "GM", "GN", "GP", "GQ", "GR", "GS", "GT", "GU", "GW", "GY", "HK", "HM", "HN", "HR", "HT", "HU", "IC", "ID", "IE", "IL", "IM", "IN", "IO", "IQ", "IR", "IS", "IT", "JE", "JM", "JO", "JP", "KE", "KG", "KH", "KI", "KM", "KN", "KP", "KR", "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", "XK", "YE", "YT", "ZA", "ZM", "ZW" ], "title": "ItAssetsAssetIdDeliverPostResponsesContentApplicationJsonSchemaDataAssignedWarehouseAddressCountry", "type": "string" }, "ItAssetsAssetIdDeliverPostResponsesContentApplicationJsonSchemaDataAssignedWarehouseAddressType": { "description": "Type of the address", "enum": [ "BILLING", "COLLECTION", "DELIVERY", "ENTITY", "PARTIAL", "PII", "SUPPLIER" ], "title": "ItAssetsAssetIdDeliverPostResponsesContentApplicationJsonSchemaDataAssignedWarehouseAddressType", "type": "string" }, "ItAssetsAssetIdDeliverPostResponsesContentApplicationJsonSchemaDataAssignedWarehouseOwnership": { "description": "Warehouse ownership type", "enum": [ "DEEL", "ORGANIZATION" ], "title": "ItAssetsAssetIdDeliverPostResponsesContentApplicationJsonSchemaDataAssignedWarehouseOwnership", "type": "string" }, "ItAssetsAssetIdDeliverPostResponsesContentApplicationJsonSchemaDataAssignedWarehouseWarehouseType": { "description": "Warehouse type", "enum": [ "CLEARANCE", "DEEL", "ORGANIZATION" ], "title": "ItAssetsAssetIdDeliverPostResponsesContentApplicationJsonSchemaDataAssignedWarehouseWarehouseType", "type": "string" }, "ItAssetsAssetIdDeliverPostResponsesContentApplicationJsonSchemaDataGrade": { "description": "The condition grade of the asset", "enum": [ "A", "B", "C", "D", "F", "NEW" ], "title": "ItAssetsAssetIdDeliverPostResponsesContentApplicationJsonSchemaDataGrade", "type": "string" }, "ItAssetsAssetIdDeliverPostResponsesContentApplicationJsonSchemaDataLocation": { "description": "Current location type of the asset", "enum": [ "AT_WAREHOUSE", "CLEARANCE_WAREHOUSE", "DEEL_WAREHOUSE", "ORGANIZATION_WAREHOUSE", "SUPPLIER", "WITH_COURIER", "WITH_USER", "WRITE_OFF" ], "title": "ItAssetsAssetIdDeliverPostResponsesContentApplicationJsonSchemaDataLocation", "type": "string" }, "ItAssetsAssetIdDeliverPostResponsesContentApplicationJsonSchemaDataOwnership": { "description": "Asset owner", "properties": { "name": { "description": "Asset owner name", "type": "string" }, "type": { "$ref": "#/components/schemas/ItAssetsAssetIdDeliverPostResponsesContentApplicationJsonSchemaDataOwnershipType", "description": "Asset owner type" } }, "required": [ "name", "type" ], "title": "ItAssetsAssetIdDeliverPostResponsesContentApplicationJsonSchemaDataOwnership", "type": "object" }, "ItAssetsAssetIdDeliverPostResponsesContentApplicationJsonSchemaDataOwnershipType": { "description": "Asset owner type", "enum": [ "DEEL", "ORGANIZATION" ], "title": "ItAssetsAssetIdDeliverPostResponsesContentApplicationJsonSchemaDataOwnershipType", "type": "string" }, "ItAssetsAssetIdDeliverPostResponsesContentApplicationJsonSchemaDataProduct": { "description": "Product details", "properties": { "brand": { "description": "Product brand", "type": "string" }, "category": { "$ref": "#/components/schemas/ItAssetsAssetIdDeliverPostResponsesContentApplicationJsonSchemaDataProductCategory", "description": "Product category" }, "id": { "description": "Unique identifier of the product", "format": "uuid", "type": "string" }, "name": { "description": "Product name", "type": "string" }, "specifications": { "description": "Specifications of the product", "items": { "$ref": "#/components/schemas/ItAssetsAssetIdDeliverPostResponsesContentApplicationJsonSchemaDataProductSpecificationsItems" }, "type": "array" } }, "required": [ "id", "name", "brand", "category", "specifications" ], "title": "ItAssetsAssetIdDeliverPostResponsesContentApplicationJsonSchemaDataProduct", "type": "object" }, "ItAssetsAssetIdDeliverPostResponsesContentApplicationJsonSchemaDataProductCategory": { "description": "Product category", "enum": [ "ADAPTER", "CABLE", "CHAIR", "CHARGER", "COMPACT_DESKTOP", "DESK", "DESKTOP", "DESK_RISER", "DESK_TIDY", "DOCKING_STATION", "DONGLE", "FOOTREST", "HEADSET", "KEYBOARD", "LAPTOP", "LAPTOP_STAND", "MICE_TRACKPAD", "MOBILE_DEVICE", "MONITOR", "MONITOR_ARM", "OTHER", "PRINTER", "SHREDDER", "STANDING_MAT", "TABLET", "TASK_LIGHT", "WEBCAM", "WELCOME_PACK", "WIFI_RANGE_EXTENDER" ], "title": "ItAssetsAssetIdDeliverPostResponsesContentApplicationJsonSchemaDataProductCategory", "type": "string" }, "ItAssetsAssetIdDeliverPostResponsesContentApplicationJsonSchemaDataProductSpecificationsItems": { "properties": { "name": { "description": "Specification name", "type": "string" }, "value": { "description": "Specification value", "type": "string" } }, "required": [ "name", "value" ], "title": "ItAssetsAssetIdDeliverPostResponsesContentApplicationJsonSchemaDataProductSpecificationsItems", "type": "object" }, "ItAssetsAssetIdDeliverPostResponsesContentApplicationJsonSchemaDataPurchaseValue": { "description": "Purchase value of the asset", "properties": { "amount": { "description": "Amount", "format": "decimal", "type": "string" }, "currency": { "$ref": "#/components/schemas/ItAssetsAssetIdDeliverPostResponsesContentApplicationJsonSchemaDataPurchaseValueCurrency", "description": "Three-letter currency code for the price" } }, "required": [ "amount", "currency" ], "title": "ItAssetsAssetIdDeliverPostResponsesContentApplicationJsonSchemaDataPurchaseValue", "type": "object" }, "ItAssetsAssetIdDeliverPostResponsesContentApplicationJsonSchemaDataPurchaseValueCurrency": { "description": "Three-letter currency code for the price", "enum": [ "AED", "AFN", "ALL", "AMD", "ANG", "AOA", "ARS", "AUD", "AWG", "AZN", "BAM", "BDT", "BGN", "BHD", "BIF", "BMD", "BOB", "BRL", "BSD", "BTN", "BWP", "BYN", "BZD", "CAD", "CDF", "CHF", "CLP", "CNY", "COP", "CRC", "CUC", "CVE", "CZK", "DJF", "DKK", "DOP", "DZD", "EGP", "ERN", "ETB", "EUR", "FJD", "FKP", "GBP", "GEL", "GHS", "GIP", "GMD", "GNF", "GTQ", "GYD", "HKD", "HNL", "HRK", "HTG", "HUF", "IDR", "ILS", "INR", "IQD", "IRR", "ISK", "JMD", "JOD", "JPY", "KES", "KGS", "KHR", "KMF", "KPW", "KRW", "KWD", "KYD", "KZT", "LAK", "LBP", "LKR", "LRD", "LSL", "LTL", "LYD", "MAD", "MDL", "MGA", "MKD", "MMK", "MNT", "MRU", "MUR", "MVR", "MWK", "MXN", "MYR", "MZN", "NAD", "NGN", "NIO", "NOK", "NPR", "NZD", "OMR", "PAB", "PEN", "PGK", "PHP", "PKR", "PLN", "PYG", "QAR", "RON", "RSD", "RUB", "RWF", "SAR", "SBD", "SCR", "SDG", "SEK", "SGD", "SHP", "SLL", "SOS", "SRD", "SSP", "STD", "SYP", "SZL", "THB", "TJS", "TMT", "TND", "TOP", "TRY", "TTD", "TWD", "TZS", "UAH", "UGX", "USD", "UYU", "UZS", "VEF", "VND", "VUV", "WST", "XAF", "XCD", "XOF", "XPF", "YER", "ZAR", "ZMW", "ZWD" ], "title": "ItAssetsAssetIdDeliverPostResponsesContentApplicationJsonSchemaDataPurchaseValueCurrency", "type": "string" }, "ItAssetsAssetIdDeliverPostResponsesContentApplicationJsonSchemaDataStatus": { "description": "Current state of the asset", "enum": [ "ACTIVE", "ADDED_BY_MISTAKE", "BEING_REPAIRED", "BINNED", "BROKEN_AT_WAREHOUSE", "BROKEN_BY_USER", "BROKEN_IN_TRANSIT", "CLEARED", "DAMAGED_AT_WAREHOUSE", "DAMAGED_BY_USER", "DAMAGED_IN_TRANSIT", "LEFT_WITH_USER", "LOST_IN_TRANSIT", "RETURNED_TO_DEEL", "SHRINKAGE", "STOLEN", "SUPPLIER_RETURN", "WAITING_FOR_CLEARANCE" ], "title": "ItAssetsAssetIdDeliverPostResponsesContentApplicationJsonSchemaDataStatus", "type": "string" }, "ItAssetsAssetIdDeliverPostResponsesContentApplicationJsonSchemaErrorsItems": { "properties": { "code": { "description": "Error code of the handler which produced the returned error", "type": "string" }, "field": { "description": "The field name where input validation failed", "type": [ "string", "null" ] }, "message": { "description": "Description of the returned error", "type": "string" } }, "required": [ "code", "field", "message" ], "title": "ItAssetsAssetIdDeliverPostResponsesContentApplicationJsonSchemaErrorsItems", "type": "object" }, "ItAssetsAssetIdGetResponsesContentApplicationJsonSchemaData": { "properties": { "actions": { "$ref": "#/components/schemas/ItAssetsAssetIdGetResponsesContentApplicationJsonSchemaDataActions", "description": "Actions the caller can execute on this asset, with availability status per action" }, "assigned_user": { "description": "Details of the user with asset possession", "oneOf": [ { "$ref": "#/components/schemas/ItAssetsAssetIdGetResponsesContentApplicationJsonSchemaDataAssignedUser" }, { "type": "null" } ] }, "assigned_warehouse": { "description": "Details of the warehouse with asset possession", "oneOf": [ { "$ref": "#/components/schemas/ItAssetsAssetIdGetResponsesContentApplicationJsonSchemaDataAssignedWarehouse" }, { "type": "null" } ] }, "created_at": { "description": "Creation timestamp of the asset", "format": "date-time", "type": "string" }, "grade": { "$ref": "#/components/schemas/ItAssetsAssetIdGetResponsesContentApplicationJsonSchemaDataGrade", "description": "The condition grade of the asset" }, "id": { "description": "Unique identifier of the item", "format": "uuid", "type": "string" }, "location": { "$ref": "#/components/schemas/ItAssetsAssetIdGetResponsesContentApplicationJsonSchemaDataLocation", "description": "Current location type of the asset" }, "ownership": { "$ref": "#/components/schemas/ItAssetsAssetIdGetResponsesContentApplicationJsonSchemaDataOwnership", "description": "Asset owner" }, "product": { "$ref": "#/components/schemas/ItAssetsAssetIdGetResponsesContentApplicationJsonSchemaDataProduct", "description": "Product details" }, "public_id": { "description": "Public identifier of the item", "type": "string" }, "purchase_date": { "description": "Purchase date of the asset", "format": "date", "type": [ "string", "null" ] }, "purchase_value": { "description": "Purchase value of the asset", "oneOf": [ { "$ref": "#/components/schemas/ItAssetsAssetIdGetResponsesContentApplicationJsonSchemaDataPurchaseValue" }, { "type": "null" } ] }, "serial_number": { "description": "Asset serial number", "type": [ "string", "null" ] }, "status": { "$ref": "#/components/schemas/ItAssetsAssetIdGetResponsesContentApplicationJsonSchemaDataStatus", "description": "Current state of the asset" }, "updated_at": { "description": "Last update timestamp of the asset", "format": "date-time", "type": "string" } }, "required": [ "id", "grade", "status", "actions", "product", "location", "ownership", "public_id", "created_at", "updated_at", "assigned_user", "purchase_date", "serial_number", "purchase_value", "assigned_warehouse" ], "title": "ItAssetsAssetIdGetResponsesContentApplicationJsonSchemaData", "type": "object" }, "ItAssetsAssetIdGetResponsesContentApplicationJsonSchemaDataActions": { "description": "Actions the caller can execute on this asset, with availability status per action", "properties": { "archive_own_asset": { "$ref": "#/components/schemas/ItAssetsAssetIdGetResponsesContentApplicationJsonSchemaDataActionsArchiveOwnAsset", "description": "Archive an organization-owned asset" }, "asset_country": { "description": "Resolved country used for asset actions. Derived from the asset's country,\nits assigned rental contract billing entity country, or the last active\nassignment delivery country. Null when the country cannot be determined\n(e.g. asset was returned to Deel)", "oneOf": [ { "$ref": "#/components/schemas/ItAssetsAssetIdGetResponsesContentApplicationJsonSchemaDataActionsAssetCountry" }, { "type": "null" } ] }, "assign_addon_to_own_asset": { "$ref": "#/components/schemas/ItAssetsAssetIdGetResponsesContentApplicationJsonSchemaDataActionsAssignAddonToOwnAsset", "description": "Assign an add-on to an organization-owned asset" }, "clear_own_asset": { "$ref": "#/components/schemas/ItAssetsAssetIdGetResponsesContentApplicationJsonSchemaDataActionsClearOwnAsset", "description": "Clear an organization-owned asset from the fleet" }, "manage_end_of_rental_contract_actions": { "$ref": "#/components/schemas/ItAssetsAssetIdGetResponsesContentApplicationJsonSchemaDataActionsManageEndOfRentalContractActions", "description": "Manage end-of-rental options for a Deel-owned rental asset" }, "purchase_rental": { "$ref": "#/components/schemas/ItAssetsAssetIdGetResponsesContentApplicationJsonSchemaDataActionsPurchaseRental", "description": "Purchase a Deel-owned rental asset at end of contract" }, "return_rental_to_deel": { "$ref": "#/components/schemas/ItAssetsAssetIdGetResponsesContentApplicationJsonSchemaDataActionsReturnRentalToDeel", "description": "Return a Deel-owned rental asset back to Deel" }, "reuse_own_asset_from_deel": { "$ref": "#/components/schemas/ItAssetsAssetIdGetResponsesContentApplicationJsonSchemaDataActionsReuseOwnAssetFromDeel", "description": "Redeploy an organization-owned asset stored at a Deel warehouse" }, "reuse_own_asset_from_own_location": { "$ref": "#/components/schemas/ItAssetsAssetIdGetResponsesContentApplicationJsonSchemaDataActionsReuseOwnAssetFromOwnLocation", "description": "Redeploy an organization-owned asset from an organization-owned location" }, "store_own_asset_at_deel_for_hub": { "$ref": "#/components/schemas/ItAssetsAssetIdGetResponsesContentApplicationJsonSchemaDataActionsStoreOwnAssetAtDeelForHub", "description": "Store an organization-owned asset at a Deel hub warehouse" }, "store_own_asset_at_deel_for_local": { "$ref": "#/components/schemas/ItAssetsAssetIdGetResponsesContentApplicationJsonSchemaDataActionsStoreOwnAssetAtDeelForLocal", "description": "Store an organization-owned asset at a Deel local warehouse" }, "store_own_asset_at_own_location": { "$ref": "#/components/schemas/ItAssetsAssetIdGetResponsesContentApplicationJsonSchemaDataActionsStoreOwnAssetAtOwnLocation", "description": "Store an organization-owned asset at an organization-owned location" }, "store_rental_at_deel_for_local": { "$ref": "#/components/schemas/ItAssetsAssetIdGetResponsesContentApplicationJsonSchemaDataActionsStoreRentalAtDeelForLocal", "description": "Store a Deel-owned rental asset at a Deel local warehouse" }, "store_rental_at_deel_for_zone1": { "$ref": "#/components/schemas/ItAssetsAssetIdGetResponsesContentApplicationJsonSchemaDataActionsStoreRentalAtDeelForZone1", "description": "Store a Deel-owned rental asset at a Deel zone-1 warehouse" }, "transfer_own_asset": { "$ref": "#/components/schemas/ItAssetsAssetIdGetResponsesContentApplicationJsonSchemaDataActionsTransferOwnAsset", "description": "Transfer an organization-owned asset to another user" }, "transfer_rental": { "$ref": "#/components/schemas/ItAssetsAssetIdGetResponsesContentApplicationJsonSchemaDataActionsTransferRental", "description": "Transfer a Deel-owned rental asset to another user" }, "unarchive_own_asset": { "$ref": "#/components/schemas/ItAssetsAssetIdGetResponsesContentApplicationJsonSchemaDataActionsUnarchiveOwnAsset", "description": "Unarchive a previously archived organization-owned asset" }, "update_location_location_to_user": { "$ref": "#/components/schemas/ItAssetsAssetIdGetResponsesContentApplicationJsonSchemaDataActionsUpdateLocationLocationToUser", "description": "Update the location of an asset from a warehouse to a user" }, "update_location_user_to_location": { "$ref": "#/components/schemas/ItAssetsAssetIdGetResponsesContentApplicationJsonSchemaDataActionsUpdateLocationUserToLocation", "description": "Update the location of an asset from a user to a warehouse" }, "update_location_user_to_user": { "$ref": "#/components/schemas/ItAssetsAssetIdGetResponsesContentApplicationJsonSchemaDataActionsUpdateLocationUserToUser", "description": "Update the assigned user of an asset that is currently with a user" }, "update_own_asset_details": { "$ref": "#/components/schemas/ItAssetsAssetIdGetResponsesContentApplicationJsonSchemaDataActionsUpdateOwnAssetDetails", "description": "Update editable details of an organization-owned asset" } }, "required": [ "asset_country", "clear_own_asset", "purchase_rental", "transfer_rental", "archive_own_asset", "transfer_own_asset", "unarchive_own_asset", "return_rental_to_deel", "update_own_asset_details", "assign_addon_to_own_asset", "reuse_own_asset_from_deel", "update_location_user_to_user", "store_rental_at_deel_for_local", "store_rental_at_deel_for_zone1", "store_own_asset_at_deel_for_hub", "store_own_asset_at_own_location", "update_location_location_to_user", "update_location_user_to_location", "reuse_own_asset_from_own_location", "store_own_asset_at_deel_for_local", "manage_end_of_rental_contract_actions" ], "title": "ItAssetsAssetIdGetResponsesContentApplicationJsonSchemaDataActions", "type": "object" }, "ItAssetsAssetIdGetResponsesContentApplicationJsonSchemaDataActionsArchiveOwnAsset": { "description": "Archive an organization-owned asset", "properties": { "details": { "description": "Action-specific context needed to perform the action. Populated for enabled and\ndisabled actions (so callers can see what a successful attempt would look like);\nnull when the action is not applicable to this asset.", "oneOf": [ { "$ref": "#/components/schemas/ItAssetsAssetIdGetResponsesContentApplicationJsonSchemaDataActionsArchiveOwnAssetDetails" }, { "type": "null" } ] }, "disabled_reasons": { "description": "Reasons why the action is disabled. Empty when the action is enabled or not applicable", "items": { "$ref": "#/components/schemas/ItAssetsAssetIdGetResponsesContentApplicationJsonSchemaDataActionsArchiveOwnAssetDisabledReasonsItems" }, "type": "array" }, "status": { "$ref": "#/components/schemas/ItAssetsAssetIdGetResponsesContentApplicationJsonSchemaDataActionsArchiveOwnAssetStatus", "description": "Whether the action is currently available for this asset" } }, "required": [ "status", "details", "disabled_reasons" ], "title": "ItAssetsAssetIdGetResponsesContentApplicationJsonSchemaDataActionsArchiveOwnAsset", "type": "object" }, "ItAssetsAssetIdGetResponsesContentApplicationJsonSchemaDataActionsArchiveOwnAssetDetails": { "description": "Action-specific context needed to perform the action. Populated for enabled and\ndisabled actions (so callers can see what a successful attempt would look like);\nnull when the action is not applicable to this asset.", "properties": { "allowed_statuses": { "description": "Statuses that can be passed as the archive reason when archiving the asset", "items": { "$ref": "#/components/schemas/ItAssetsAssetIdGetResponsesContentApplicationJsonSchemaDataActionsArchiveOwnAssetDetailsAllowedStatusesItems" }, "type": "array" } }, "required": [ "allowed_statuses" ], "title": "ItAssetsAssetIdGetResponsesContentApplicationJsonSchemaDataActionsArchiveOwnAssetDetails", "type": "object" }, "ItAssetsAssetIdGetResponsesContentApplicationJsonSchemaDataActionsArchiveOwnAssetDetailsAllowedStatusesItems": { "enum": [ "ADDED_BY_MISTAKE", "BINNED", "BROKEN_AT_WAREHOUSE", "BROKEN_BY_USER", "BROKEN_IN_TRANSIT", "DAMAGED_AT_WAREHOUSE", "DAMAGED_BY_USER", "DAMAGED_IN_TRANSIT", "LEFT_WITH_USER", "LOST_IN_TRANSIT", "RETURNED_TO_DEEL", "SHRINKAGE", "STOLEN", "SUPPLIER_RETURN" ], "title": "ItAssetsAssetIdGetResponsesContentApplicationJsonSchemaDataActionsArchiveOwnAssetDetailsAllowedStatusesItems", "type": "string" }, "ItAssetsAssetIdGetResponsesContentApplicationJsonSchemaDataActionsArchiveOwnAssetDisabledReasonsItems": { "enum": [ "ARCHIVED", "AT_DEEL_WAREHOUSE", "BEING_REPAIRED", "CONSUMABLE", "CONTROLLED_BY_DEEL", "COUNTRY_NOT_SUPPORTED_FOR_HUB", "COUNTRY_NOT_SUPPORTED_FOR_LOCAL", "DEEL_OWNED_ITEM_WITHOUT_RENTAL_CONTRACT", "DESKTOP_STORAGE", "ENDING_CONTRACT", "HUB_IN_SAME_REGION_AS_LOCAL", "INACTIVE", "INVALID_ITEM_LOCATION", "INVALID_ORGANIZATION_STATUS", "INVALID_STATE", "ITEM_CONDITIONS_TO_UNARCHIVE_NOT_MET", "ITEM_NOT_VISIBLE_FOR_ORGANIZATION", "NON_DEVICE", "NOT_AT_WAREHOUSE", "NOT_AVAILABLE_FOR_REUSE", "NOT_A_RENTAL", "NOT_MANAGEABLE_BY_ORGANIZATION", "NOT_WITH_ASSIGNMENT", "NOT_WITH_USER", "NO_ACTIVE_ADDONS", "NO_ACTIVE_STORAGE_CONTRACT", "NO_LOCATION_FOR_STORAGE", "NO_LOGISTICS_FOR_STORAGE", "NO_VALID_ADDONS", "ONGOING_SERVICE", "OWNED_BY_DEEL", "OWNED_BY_ORGANIZATION", "OWNED_BY_PARTNER_ORGANIZATION", "PARTNER_CHILD_CONTRACT", "PENDING_DEVICE_REFRESH", "RENTAL_CONTRACT_AND_USER_REGION_DO_NOT_MATCH", "TEMPORARILY_UNAVAILABLE", "UNKNOWN", "USER_HAS_NO_COUNTRY", "USER_HAS_NO_SEAT", "WAITING_FOR_CLEARANCE", "WITH_LOANER_ASSIGNMENT", "WITH_NON_COLLECTED_ASSIGNMENT", "WITH_NON_DELIVERED_ASSIGNMENT", "WITH_PENDING_ASSIGNMENT", "WRONG_ASSIGNMENT_STATUS", "WRONG_CONTRACT_STATUS", "WRONG_TERMS_AND_CONDITIONS" ], "title": "ItAssetsAssetIdGetResponsesContentApplicationJsonSchemaDataActionsArchiveOwnAssetDisabledReasonsItems", "type": "string" }, "ItAssetsAssetIdGetResponsesContentApplicationJsonSchemaDataActionsArchiveOwnAssetStatus": { "description": "Whether the action is currently available for this asset", "enum": [ "DISABLED", "ENABLED", "NOT_APPLICABLE" ], "title": "ItAssetsAssetIdGetResponsesContentApplicationJsonSchemaDataActionsArchiveOwnAssetStatus", "type": "string" }, "ItAssetsAssetIdGetResponsesContentApplicationJsonSchemaDataActionsAssetCountry": { "description": "Resolved country used for asset actions. Derived from the asset's country,\nits assigned rental contract billing entity country, or the last active\nassignment delivery country. Null when the country cannot be determined\n(e.g. asset was returned to Deel)", "enum": [ "AD", "AE", "AF", "AG", "AI", "AL", "AM", "AN", "AO", "AQ", "AR", "AS", "AT", "AU", "AW", "AX", "AZ", "BA", "BB", "BD", "BE", "BF", "BG", "BH", "BI", "BJ", "BL", "BM", "BN", "BO", "BQ", "BR", "BS", "BT", "BV", "BW", "BY", "BZ", "CA", "CC", "CD", "CF", "CG", "CH", "CI", "CK", "CL", "CM", "CN", "CO", "CR", "CU", "CV", "CW", "CX", "CY", "CZ", "DE", "DJ", "DK", "DM", "DO", "DZ", "EC", "EE", "EG", "EH", "ER", "ES", "ET", "FI", "FJ", "FK", "FM", "FO", "FR", "GA", "GB", "GD", "GE", "GF", "GG", "GH", "GI", "GL", "GM", "GN", "GP", "GQ", "GR", "GS", "GT", "GU", "GW", "GY", "HK", "HM", "HN", "HR", "HT", "HU", "IC", "ID", "IE", "IL", "IM", "IN", "IO", "IQ", "IR", "IS", "IT", "JE", "JM", "JO", "JP", "KE", "KG", "KH", "KI", "KM", "KN", "KP", "KR", "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", "XK", "YE", "YT", "ZA", "ZM", "ZW" ], "title": "ItAssetsAssetIdGetResponsesContentApplicationJsonSchemaDataActionsAssetCountry", "type": "string" }, "ItAssetsAssetIdGetResponsesContentApplicationJsonSchemaDataActionsAssignAddonToOwnAsset": { "description": "Assign an add-on to an organization-owned asset", "properties": { "details": { "description": "Action-specific context needed to perform the action. Populated for enabled and\ndisabled actions (so callers can see what a successful attempt would look like);\nnull when the action is not applicable to this asset.", "oneOf": [ { "$ref": "#/components/schemas/ItAssetsAssetIdGetResponsesContentApplicationJsonSchemaDataActionsAssignAddonToOwnAssetDetails" }, { "type": "null" } ] }, "disabled_reasons": { "description": "Reasons why the action is disabled. Empty when the action is enabled or not applicable", "items": { "$ref": "#/components/schemas/ItAssetsAssetIdGetResponsesContentApplicationJsonSchemaDataActionsAssignAddonToOwnAssetDisabledReasonsItems" }, "type": "array" }, "status": { "$ref": "#/components/schemas/ItAssetsAssetIdGetResponsesContentApplicationJsonSchemaDataActionsAssignAddonToOwnAssetStatus", "description": "Whether the action is currently available for this asset" } }, "required": [ "status", "details", "disabled_reasons" ], "title": "ItAssetsAssetIdGetResponsesContentApplicationJsonSchemaDataActionsAssignAddonToOwnAsset", "type": "object" }, "ItAssetsAssetIdGetResponsesContentApplicationJsonSchemaDataActionsAssignAddonToOwnAssetDetails": { "description": "Action-specific context needed to perform the action. Populated for enabled and\ndisabled actions (so callers can see what a successful attempt would look like);\nnull when the action is not applicable to this asset.", "properties": { "addons": { "description": "Add-ons that can be assigned to the asset, with a fail reason for those that don't qualify", "items": { "$ref": "#/components/schemas/ItAssetsAssetIdGetResponsesContentApplicationJsonSchemaDataActionsAssignAddonToOwnAssetDetailsAddonsItems" }, "type": "array" } }, "required": [ "addons" ], "title": "ItAssetsAssetIdGetResponsesContentApplicationJsonSchemaDataActionsAssignAddonToOwnAssetDetails", "type": "object" }, "ItAssetsAssetIdGetResponsesContentApplicationJsonSchemaDataActionsAssignAddonToOwnAssetDetailsAddonsItems": { "properties": { "addon": { "$ref": "#/components/schemas/ItAssetsAssetIdGetResponsesContentApplicationJsonSchemaDataActionsAssignAddonToOwnAssetDetailsAddonsItemsAddon", "description": "Add-on that can be assigned to the asset" }, "fail_reason": { "description": "Reason the add-on cannot be assigned to the asset. Null when assignment is allowed", "oneOf": [ { "$ref": "#/components/schemas/ItAssetsAssetIdGetResponsesContentApplicationJsonSchemaDataActionsAssignAddonToOwnAssetDetailsAddonsItemsFailReason" }, { "type": "null" } ] } }, "required": [ "addon", "fail_reason" ], "title": "ItAssetsAssetIdGetResponsesContentApplicationJsonSchemaDataActionsAssignAddonToOwnAssetDetailsAddonsItems", "type": "object" }, "ItAssetsAssetIdGetResponsesContentApplicationJsonSchemaDataActionsAssignAddonToOwnAssetDetailsAddonsItemsAddon": { "description": "Add-on that can be assigned to the asset", "properties": { "id": { "description": "ID of the add-on", "format": "uuid", "type": "string" }, "name": { "description": "Public display name of the add-on", "type": "string" } }, "required": [ "id", "name" ], "title": "ItAssetsAssetIdGetResponsesContentApplicationJsonSchemaDataActionsAssignAddonToOwnAssetDetailsAddonsItemsAddon", "type": "object" }, "ItAssetsAssetIdGetResponsesContentApplicationJsonSchemaDataActionsAssignAddonToOwnAssetDetailsAddonsItemsFailReason": { "description": "Reason the add-on cannot be assigned to the asset. Null when assignment is allowed", "enum": [ "ADDON_NOT_AVAILABLE_TO_ORGANIZATION", "ALREADY_ASSIGNED", "HAS_ACTIVE_SERVICE_ADDON", "INVALID_ASSET_AGE", "INVALID_CONTRACT_TYPE", "INVALID_DURATION", "INVALID_PAYMENT_SCHEMA", "INVALID_PLATFORM_TIER", "INVALID_PRODUCT_BRAND", "INVALID_PRODUCT_CATEGORY", "INVALID_PRODUCT_PARENT_CATEGORY", "INVALID_RENTAL_TERM", "NO_MATCHING_ORGANIZATION_CONTRACT", "OTHER" ], "title": "ItAssetsAssetIdGetResponsesContentApplicationJsonSchemaDataActionsAssignAddonToOwnAssetDetailsAddonsItemsFailReason", "type": "string" }, "ItAssetsAssetIdGetResponsesContentApplicationJsonSchemaDataActionsAssignAddonToOwnAssetDisabledReasonsItems": { "enum": [ "ARCHIVED", "AT_DEEL_WAREHOUSE", "BEING_REPAIRED", "CONSUMABLE", "CONTROLLED_BY_DEEL", "COUNTRY_NOT_SUPPORTED_FOR_HUB", "COUNTRY_NOT_SUPPORTED_FOR_LOCAL", "DEEL_OWNED_ITEM_WITHOUT_RENTAL_CONTRACT", "DESKTOP_STORAGE", "ENDING_CONTRACT", "HUB_IN_SAME_REGION_AS_LOCAL", "INACTIVE", "INVALID_ITEM_LOCATION", "INVALID_ORGANIZATION_STATUS", "INVALID_STATE", "ITEM_CONDITIONS_TO_UNARCHIVE_NOT_MET", "ITEM_NOT_VISIBLE_FOR_ORGANIZATION", "NON_DEVICE", "NOT_AT_WAREHOUSE", "NOT_AVAILABLE_FOR_REUSE", "NOT_A_RENTAL", "NOT_MANAGEABLE_BY_ORGANIZATION", "NOT_WITH_ASSIGNMENT", "NOT_WITH_USER", "NO_ACTIVE_ADDONS", "NO_ACTIVE_STORAGE_CONTRACT", "NO_LOCATION_FOR_STORAGE", "NO_LOGISTICS_FOR_STORAGE", "NO_VALID_ADDONS", "ONGOING_SERVICE", "OWNED_BY_DEEL", "OWNED_BY_ORGANIZATION", "OWNED_BY_PARTNER_ORGANIZATION", "PARTNER_CHILD_CONTRACT", "PENDING_DEVICE_REFRESH", "RENTAL_CONTRACT_AND_USER_REGION_DO_NOT_MATCH", "TEMPORARILY_UNAVAILABLE", "UNKNOWN", "USER_HAS_NO_COUNTRY", "USER_HAS_NO_SEAT", "WAITING_FOR_CLEARANCE", "WITH_LOANER_ASSIGNMENT", "WITH_NON_COLLECTED_ASSIGNMENT", "WITH_NON_DELIVERED_ASSIGNMENT", "WITH_PENDING_ASSIGNMENT", "WRONG_ASSIGNMENT_STATUS", "WRONG_CONTRACT_STATUS", "WRONG_TERMS_AND_CONDITIONS" ], "title": "ItAssetsAssetIdGetResponsesContentApplicationJsonSchemaDataActionsAssignAddonToOwnAssetDisabledReasonsItems", "type": "string" }, "ItAssetsAssetIdGetResponsesContentApplicationJsonSchemaDataActionsAssignAddonToOwnAssetStatus": { "description": "Whether the action is currently available for this asset", "enum": [ "DISABLED", "ENABLED", "NOT_APPLICABLE" ], "title": "ItAssetsAssetIdGetResponsesContentApplicationJsonSchemaDataActionsAssignAddonToOwnAssetStatus", "type": "string" }, "ItAssetsAssetIdGetResponsesContentApplicationJsonSchemaDataActionsClearOwnAsset": { "description": "Clear an organization-owned asset from the fleet", "properties": { "disabled_reasons": { "description": "Reasons why the action is disabled. Empty when the action is enabled or not applicable", "items": { "$ref": "#/components/schemas/ItAssetsAssetIdGetResponsesContentApplicationJsonSchemaDataActionsClearOwnAssetDisabledReasonsItems" }, "type": "array" }, "status": { "$ref": "#/components/schemas/ItAssetsAssetIdGetResponsesContentApplicationJsonSchemaDataActionsClearOwnAssetStatus", "description": "Whether the action is currently available for this asset" } }, "required": [ "status", "disabled_reasons" ], "title": "ItAssetsAssetIdGetResponsesContentApplicationJsonSchemaDataActionsClearOwnAsset", "type": "object" }, "ItAssetsAssetIdGetResponsesContentApplicationJsonSchemaDataActionsClearOwnAssetDisabledReasonsItems": { "enum": [ "ARCHIVED", "AT_DEEL_WAREHOUSE", "BEING_REPAIRED", "CONSUMABLE", "CONTROLLED_BY_DEEL", "COUNTRY_NOT_SUPPORTED_FOR_HUB", "COUNTRY_NOT_SUPPORTED_FOR_LOCAL", "DEEL_OWNED_ITEM_WITHOUT_RENTAL_CONTRACT", "DESKTOP_STORAGE", "ENDING_CONTRACT", "HUB_IN_SAME_REGION_AS_LOCAL", "INACTIVE", "INVALID_ITEM_LOCATION", "INVALID_ORGANIZATION_STATUS", "INVALID_STATE", "ITEM_CONDITIONS_TO_UNARCHIVE_NOT_MET", "ITEM_NOT_VISIBLE_FOR_ORGANIZATION", "NON_DEVICE", "NOT_AT_WAREHOUSE", "NOT_AVAILABLE_FOR_REUSE", "NOT_A_RENTAL", "NOT_MANAGEABLE_BY_ORGANIZATION", "NOT_WITH_ASSIGNMENT", "NOT_WITH_USER", "NO_ACTIVE_ADDONS", "NO_ACTIVE_STORAGE_CONTRACT", "NO_LOCATION_FOR_STORAGE", "NO_LOGISTICS_FOR_STORAGE", "NO_VALID_ADDONS", "ONGOING_SERVICE", "OWNED_BY_DEEL", "OWNED_BY_ORGANIZATION", "OWNED_BY_PARTNER_ORGANIZATION", "PARTNER_CHILD_CONTRACT", "PENDING_DEVICE_REFRESH", "RENTAL_CONTRACT_AND_USER_REGION_DO_NOT_MATCH", "TEMPORARILY_UNAVAILABLE", "UNKNOWN", "USER_HAS_NO_COUNTRY", "USER_HAS_NO_SEAT", "WAITING_FOR_CLEARANCE", "WITH_LOANER_ASSIGNMENT", "WITH_NON_COLLECTED_ASSIGNMENT", "WITH_NON_DELIVERED_ASSIGNMENT", "WITH_PENDING_ASSIGNMENT", "WRONG_ASSIGNMENT_STATUS", "WRONG_CONTRACT_STATUS", "WRONG_TERMS_AND_CONDITIONS" ], "title": "ItAssetsAssetIdGetResponsesContentApplicationJsonSchemaDataActionsClearOwnAssetDisabledReasonsItems", "type": "string" }, "ItAssetsAssetIdGetResponsesContentApplicationJsonSchemaDataActionsClearOwnAssetStatus": { "description": "Whether the action is currently available for this asset", "enum": [ "DISABLED", "ENABLED", "NOT_APPLICABLE" ], "title": "ItAssetsAssetIdGetResponsesContentApplicationJsonSchemaDataActionsClearOwnAssetStatus", "type": "string" }, "ItAssetsAssetIdGetResponsesContentApplicationJsonSchemaDataActionsManageEndOfRentalContractActions": { "description": "Manage end-of-rental options for a Deel-owned rental asset", "properties": { "disabled_reasons": { "description": "Reasons why the action is disabled. Empty when the action is enabled or not applicable", "items": { "$ref": "#/components/schemas/ItAssetsAssetIdGetResponsesContentApplicationJsonSchemaDataActionsManageEndOfRentalContractActionsDisabledReasonsItems" }, "type": "array" }, "status": { "$ref": "#/components/schemas/ItAssetsAssetIdGetResponsesContentApplicationJsonSchemaDataActionsManageEndOfRentalContractActionsStatus", "description": "Whether the action is currently available for this asset" } }, "required": [ "status", "disabled_reasons" ], "title": "ItAssetsAssetIdGetResponsesContentApplicationJsonSchemaDataActionsManageEndOfRentalContractActions", "type": "object" }, "ItAssetsAssetIdGetResponsesContentApplicationJsonSchemaDataActionsManageEndOfRentalContractActionsDisabledReasonsItems": { "enum": [ "ARCHIVED", "AT_DEEL_WAREHOUSE", "BEING_REPAIRED", "CONSUMABLE", "CONTROLLED_BY_DEEL", "COUNTRY_NOT_SUPPORTED_FOR_HUB", "COUNTRY_NOT_SUPPORTED_FOR_LOCAL", "DEEL_OWNED_ITEM_WITHOUT_RENTAL_CONTRACT", "DESKTOP_STORAGE", "ENDING_CONTRACT", "HUB_IN_SAME_REGION_AS_LOCAL", "INACTIVE", "INVALID_ITEM_LOCATION", "INVALID_ORGANIZATION_STATUS", "INVALID_STATE", "ITEM_CONDITIONS_TO_UNARCHIVE_NOT_MET", "ITEM_NOT_VISIBLE_FOR_ORGANIZATION", "NON_DEVICE", "NOT_AT_WAREHOUSE", "NOT_AVAILABLE_FOR_REUSE", "NOT_A_RENTAL", "NOT_MANAGEABLE_BY_ORGANIZATION", "NOT_WITH_ASSIGNMENT", "NOT_WITH_USER", "NO_ACTIVE_ADDONS", "NO_ACTIVE_STORAGE_CONTRACT", "NO_LOCATION_FOR_STORAGE", "NO_LOGISTICS_FOR_STORAGE", "NO_VALID_ADDONS", "ONGOING_SERVICE", "OWNED_BY_DEEL", "OWNED_BY_ORGANIZATION", "OWNED_BY_PARTNER_ORGANIZATION", "PARTNER_CHILD_CONTRACT", "PENDING_DEVICE_REFRESH", "RENTAL_CONTRACT_AND_USER_REGION_DO_NOT_MATCH", "TEMPORARILY_UNAVAILABLE", "UNKNOWN", "USER_HAS_NO_COUNTRY", "USER_HAS_NO_SEAT", "WAITING_FOR_CLEARANCE", "WITH_LOANER_ASSIGNMENT", "WITH_NON_COLLECTED_ASSIGNMENT", "WITH_NON_DELIVERED_ASSIGNMENT", "WITH_PENDING_ASSIGNMENT", "WRONG_ASSIGNMENT_STATUS", "WRONG_CONTRACT_STATUS", "WRONG_TERMS_AND_CONDITIONS" ], "title": "ItAssetsAssetIdGetResponsesContentApplicationJsonSchemaDataActionsManageEndOfRentalContractActionsDisabledReasonsItems", "type": "string" }, "ItAssetsAssetIdGetResponsesContentApplicationJsonSchemaDataActionsManageEndOfRentalContractActionsStatus": { "description": "Whether the action is currently available for this asset", "enum": [ "DISABLED", "ENABLED", "NOT_APPLICABLE" ], "title": "ItAssetsAssetIdGetResponsesContentApplicationJsonSchemaDataActionsManageEndOfRentalContractActionsStatus", "type": "string" }, "ItAssetsAssetIdGetResponsesContentApplicationJsonSchemaDataActionsPurchaseRental": { "description": "Purchase a Deel-owned rental asset at end of contract", "properties": { "details": { "description": "Action-specific context needed to perform the action. Populated for enabled and\ndisabled actions (so callers can see what a successful attempt would look like);\nnull when the action is not applicable to this asset.", "oneOf": [ { "$ref": "#/components/schemas/ItAssetsAssetIdGetResponsesContentApplicationJsonSchemaDataActionsPurchaseRentalDetails" }, { "type": "null" } ] }, "disabled_reasons": { "description": "Reasons why the action is disabled. Empty when the action is enabled or not applicable", "items": { "$ref": "#/components/schemas/ItAssetsAssetIdGetResponsesContentApplicationJsonSchemaDataActionsPurchaseRentalDisabledReasonsItems" }, "type": "array" }, "status": { "$ref": "#/components/schemas/ItAssetsAssetIdGetResponsesContentApplicationJsonSchemaDataActionsPurchaseRentalStatus", "description": "Whether the action is currently available for this asset" } }, "required": [ "status", "details", "disabled_reasons" ], "title": "ItAssetsAssetIdGetResponsesContentApplicationJsonSchemaDataActionsPurchaseRental", "type": "object" }, "ItAssetsAssetIdGetResponsesContentApplicationJsonSchemaDataActionsPurchaseRentalDetails": { "description": "Action-specific context needed to perform the action. Populated for enabled and\ndisabled actions (so callers can see what a successful attempt would look like);\nnull when the action is not applicable to this asset.", "properties": { "purchase_price": { "description": "Estimated price to purchase the asset at the end of the rental contract", "oneOf": [ { "$ref": "#/components/schemas/ItAssetsAssetIdGetResponsesContentApplicationJsonSchemaDataActionsPurchaseRentalDetailsPurchasePrice" }, { "type": "null" } ] }, "remaining_contract_value": { "$ref": "#/components/schemas/ItAssetsAssetIdGetResponsesContentApplicationJsonSchemaDataActionsPurchaseRentalDetailsRemainingContractValue", "description": "Estimated remaining value of the rental contract" }, "total_purchase_price": { "description": "Estimated total price of the purchase, including any remaining contract value", "oneOf": [ { "$ref": "#/components/schemas/ItAssetsAssetIdGetResponsesContentApplicationJsonSchemaDataActionsPurchaseRentalDetailsTotalPurchasePrice" }, { "type": "null" } ] } }, "required": [ "purchase_price", "total_purchase_price", "remaining_contract_value" ], "title": "ItAssetsAssetIdGetResponsesContentApplicationJsonSchemaDataActionsPurchaseRentalDetails", "type": "object" }, "ItAssetsAssetIdGetResponsesContentApplicationJsonSchemaDataActionsPurchaseRentalDetailsPurchasePrice": { "description": "Estimated price to purchase the asset at the end of the rental contract", "properties": { "amount": { "description": "Amount", "format": "decimal", "type": "string" }, "currency": { "$ref": "#/components/schemas/ItAssetsAssetIdGetResponsesContentApplicationJsonSchemaDataActionsPurchaseRentalDetailsPurchasePriceCurrency", "description": "Three-letter currency code for the price" } }, "required": [ "amount", "currency" ], "title": "ItAssetsAssetIdGetResponsesContentApplicationJsonSchemaDataActionsPurchaseRentalDetailsPurchasePrice", "type": "object" }, "ItAssetsAssetIdGetResponsesContentApplicationJsonSchemaDataActionsPurchaseRentalDetailsPurchasePriceCurrency": { "description": "Three-letter currency code for the price", "enum": [ "AED", "AFN", "ALL", "AMD", "ANG", "AOA", "ARS", "AUD", "AWG", "AZN", "BAM", "BDT", "BGN", "BHD", "BIF", "BMD", "BOB", "BRL", "BSD", "BTN", "BWP", "BYN", "BZD", "CAD", "CDF", "CHF", "CLP", "CNY", "COP", "CRC", "CUC", "CVE", "CZK", "DJF", "DKK", "DOP", "DZD", "EGP", "ERN", "ETB", "EUR", "FJD", "FKP", "GBP", "GEL", "GHS", "GIP", "GMD", "GNF", "GTQ", "GYD", "HKD", "HNL", "HRK", "HTG", "HUF", "IDR", "ILS", "INR", "IQD", "IRR", "ISK", "JMD", "JOD", "JPY", "KES", "KGS", "KHR", "KMF", "KPW", "KRW", "KWD", "KYD", "KZT", "LAK", "LBP", "LKR", "LRD", "LSL", "LTL", "LYD", "MAD", "MDL", "MGA", "MKD", "MMK", "MNT", "MRU", "MUR", "MVR", "MWK", "MXN", "MYR", "MZN", "NAD", "NGN", "NIO", "NOK", "NPR", "NZD", "OMR", "PAB", "PEN", "PGK", "PHP", "PKR", "PLN", "PYG", "QAR", "RON", "RSD", "RUB", "RWF", "SAR", "SBD", "SCR", "SDG", "SEK", "SGD", "SHP", "SLL", "SOS", "SRD", "SSP", "STD", "SYP", "SZL", "THB", "TJS", "TMT", "TND", "TOP", "TRY", "TTD", "TWD", "TZS", "UAH", "UGX", "USD", "UYU", "UZS", "VEF", "VND", "VUV", "WST", "XAF", "XCD", "XOF", "XPF", "YER", "ZAR", "ZMW", "ZWD" ], "title": "ItAssetsAssetIdGetResponsesContentApplicationJsonSchemaDataActionsPurchaseRentalDetailsPurchasePriceCurrency", "type": "string" }, "ItAssetsAssetIdGetResponsesContentApplicationJsonSchemaDataActionsPurchaseRentalDetailsRemainingContractValue": { "description": "Estimated remaining value of the rental contract", "properties": { "amount": { "description": "Amount", "format": "decimal", "type": "string" }, "currency": { "$ref": "#/components/schemas/ItAssetsAssetIdGetResponsesContentApplicationJsonSchemaDataActionsPurchaseRentalDetailsRemainingContractValueCurrency", "description": "Three-letter currency code for the price" } }, "required": [ "amount", "currency" ], "title": "ItAssetsAssetIdGetResponsesContentApplicationJsonSchemaDataActionsPurchaseRentalDetailsRemainingContractValue", "type": "object" }, "ItAssetsAssetIdGetResponsesContentApplicationJsonSchemaDataActionsPurchaseRentalDetailsRemainingContractValueCurrency": { "description": "Three-letter currency code for the price", "enum": [ "AED", "AFN", "ALL", "AMD", "ANG", "AOA", "ARS", "AUD", "AWG", "AZN", "BAM", "BDT", "BGN", "BHD", "BIF", "BMD", "BOB", "BRL", "BSD", "BTN", "BWP", "BYN", "BZD", "CAD", "CDF", "CHF", "CLP", "CNY", "COP", "CRC", "CUC", "CVE", "CZK", "DJF", "DKK", "DOP", "DZD", "EGP", "ERN", "ETB", "EUR", "FJD", "FKP", "GBP", "GEL", "GHS", "GIP", "GMD", "GNF", "GTQ", "GYD", "HKD", "HNL", "HRK", "HTG", "HUF", "IDR", "ILS", "INR", "IQD", "IRR", "ISK", "JMD", "JOD", "JPY", "KES", "KGS", "KHR", "KMF", "KPW", "KRW", "KWD", "KYD", "KZT", "LAK", "LBP", "LKR", "LRD", "LSL", "LTL", "LYD", "MAD", "MDL", "MGA", "MKD", "MMK", "MNT", "MRU", "MUR", "MVR", "MWK", "MXN", "MYR", "MZN", "NAD", "NGN", "NIO", "NOK", "NPR", "NZD", "OMR", "PAB", "PEN", "PGK", "PHP", "PKR", "PLN", "PYG", "QAR", "RON", "RSD", "RUB", "RWF", "SAR", "SBD", "SCR", "SDG", "SEK", "SGD", "SHP", "SLL", "SOS", "SRD", "SSP", "STD", "SYP", "SZL", "THB", "TJS", "TMT", "TND", "TOP", "TRY", "TTD", "TWD", "TZS", "UAH", "UGX", "USD", "UYU", "UZS", "VEF", "VND", "VUV", "WST", "XAF", "XCD", "XOF", "XPF", "YER", "ZAR", "ZMW", "ZWD" ], "title": "ItAssetsAssetIdGetResponsesContentApplicationJsonSchemaDataActionsPurchaseRentalDetailsRemainingContractValueCurrency", "type": "string" }, "ItAssetsAssetIdGetResponsesContentApplicationJsonSchemaDataActionsPurchaseRentalDetailsTotalPurchasePrice": { "description": "Estimated total price of the purchase, including any remaining contract value", "properties": { "amount": { "description": "Amount", "format": "decimal", "type": "string" }, "currency": { "$ref": "#/components/schemas/ItAssetsAssetIdGetResponsesContentApplicationJsonSchemaDataActionsPurchaseRentalDetailsTotalPurchasePriceCurrency", "description": "Three-letter currency code for the price" } }, "required": [ "amount", "currency" ], "title": "ItAssetsAssetIdGetResponsesContentApplicationJsonSchemaDataActionsPurchaseRentalDetailsTotalPurchasePrice", "type": "object" }, "ItAssetsAssetIdGetResponsesContentApplicationJsonSchemaDataActionsPurchaseRentalDetailsTotalPurchasePriceCurrency": { "description": "Three-letter currency code for the price", "enum": [ "AED", "AFN", "ALL", "AMD", "ANG", "AOA", "ARS", "AUD", "AWG", "AZN", "BAM", "BDT", "BGN", "BHD", "BIF", "BMD", "BOB", "BRL", "BSD", "BTN", "BWP", "BYN", "BZD", "CAD", "CDF", "CHF", "CLP", "CNY", "COP", "CRC", "CUC", "CVE", "CZK", "DJF", "DKK", "DOP", "DZD", "EGP", "ERN", "ETB", "EUR", "FJD", "FKP", "GBP", "GEL", "GHS", "GIP", "GMD", "GNF", "GTQ", "GYD", "HKD", "HNL", "HRK", "HTG", "HUF", "IDR", "ILS", "INR", "IQD", "IRR", "ISK", "JMD", "JOD", "JPY", "KES", "KGS", "KHR", "KMF", "KPW", "KRW", "KWD", "KYD", "KZT", "LAK", "LBP", "LKR", "LRD", "LSL", "LTL", "LYD", "MAD", "MDL", "MGA", "MKD", "MMK", "MNT", "MRU", "MUR", "MVR", "MWK", "MXN", "MYR", "MZN", "NAD", "NGN", "NIO", "NOK", "NPR", "NZD", "OMR", "PAB", "PEN", "PGK", "PHP", "PKR", "PLN", "PYG", "QAR", "RON", "RSD", "RUB", "RWF", "SAR", "SBD", "SCR", "SDG", "SEK", "SGD", "SHP", "SLL", "SOS", "SRD", "SSP", "STD", "SYP", "SZL", "THB", "TJS", "TMT", "TND", "TOP", "TRY", "TTD", "TWD", "TZS", "UAH", "UGX", "USD", "UYU", "UZS", "VEF", "VND", "VUV", "WST", "XAF", "XCD", "XOF", "XPF", "YER", "ZAR", "ZMW", "ZWD" ], "title": "ItAssetsAssetIdGetResponsesContentApplicationJsonSchemaDataActionsPurchaseRentalDetailsTotalPurchasePriceCurrency", "type": "string" }, "ItAssetsAssetIdGetResponsesContentApplicationJsonSchemaDataActionsPurchaseRentalDisabledReasonsItems": { "enum": [ "ARCHIVED", "AT_DEEL_WAREHOUSE", "BEING_REPAIRED", "CONSUMABLE", "CONTROLLED_BY_DEEL", "COUNTRY_NOT_SUPPORTED_FOR_HUB", "COUNTRY_NOT_SUPPORTED_FOR_LOCAL", "DEEL_OWNED_ITEM_WITHOUT_RENTAL_CONTRACT", "DESKTOP_STORAGE", "ENDING_CONTRACT", "HUB_IN_SAME_REGION_AS_LOCAL", "INACTIVE", "INVALID_ITEM_LOCATION", "INVALID_ORGANIZATION_STATUS", "INVALID_STATE", "ITEM_CONDITIONS_TO_UNARCHIVE_NOT_MET", "ITEM_NOT_VISIBLE_FOR_ORGANIZATION", "NON_DEVICE", "NOT_AT_WAREHOUSE", "NOT_AVAILABLE_FOR_REUSE", "NOT_A_RENTAL", "NOT_MANAGEABLE_BY_ORGANIZATION", "NOT_WITH_ASSIGNMENT", "NOT_WITH_USER", "NO_ACTIVE_ADDONS", "NO_ACTIVE_STORAGE_CONTRACT", "NO_LOCATION_FOR_STORAGE", "NO_LOGISTICS_FOR_STORAGE", "NO_VALID_ADDONS", "ONGOING_SERVICE", "OWNED_BY_DEEL", "OWNED_BY_ORGANIZATION", "OWNED_BY_PARTNER_ORGANIZATION", "PARTNER_CHILD_CONTRACT", "PENDING_DEVICE_REFRESH", "RENTAL_CONTRACT_AND_USER_REGION_DO_NOT_MATCH", "TEMPORARILY_UNAVAILABLE", "UNKNOWN", "USER_HAS_NO_COUNTRY", "USER_HAS_NO_SEAT", "WAITING_FOR_CLEARANCE", "WITH_LOANER_ASSIGNMENT", "WITH_NON_COLLECTED_ASSIGNMENT", "WITH_NON_DELIVERED_ASSIGNMENT", "WITH_PENDING_ASSIGNMENT", "WRONG_ASSIGNMENT_STATUS", "WRONG_CONTRACT_STATUS", "WRONG_TERMS_AND_CONDITIONS" ], "title": "ItAssetsAssetIdGetResponsesContentApplicationJsonSchemaDataActionsPurchaseRentalDisabledReasonsItems", "type": "string" }, "ItAssetsAssetIdGetResponsesContentApplicationJsonSchemaDataActionsPurchaseRentalStatus": { "description": "Whether the action is currently available for this asset", "enum": [ "DISABLED", "ENABLED", "NOT_APPLICABLE" ], "title": "ItAssetsAssetIdGetResponsesContentApplicationJsonSchemaDataActionsPurchaseRentalStatus", "type": "string" }, "ItAssetsAssetIdGetResponsesContentApplicationJsonSchemaDataActionsReturnRentalToDeel": { "description": "Return a Deel-owned rental asset back to Deel", "properties": { "details": { "description": "Action-specific context needed to perform the action. Populated for enabled and\ndisabled actions (so callers can see what a successful attempt would look like);\nnull when the action is not applicable to this asset.", "oneOf": [ { "$ref": "#/components/schemas/ItAssetsAssetIdGetResponsesContentApplicationJsonSchemaDataActionsReturnRentalToDeelDetails" }, { "type": "null" } ] }, "disabled_reasons": { "description": "Reasons why the action is disabled. Empty when the action is enabled or not applicable", "items": { "$ref": "#/components/schemas/ItAssetsAssetIdGetResponsesContentApplicationJsonSchemaDataActionsReturnRentalToDeelDisabledReasonsItems" }, "type": "array" }, "status": { "$ref": "#/components/schemas/ItAssetsAssetIdGetResponsesContentApplicationJsonSchemaDataActionsReturnRentalToDeelStatus", "description": "Whether the action is currently available for this asset" } }, "required": [ "status", "details", "disabled_reasons" ], "title": "ItAssetsAssetIdGetResponsesContentApplicationJsonSchemaDataActionsReturnRentalToDeel", "type": "object" }, "ItAssetsAssetIdGetResponsesContentApplicationJsonSchemaDataActionsReturnRentalToDeelDetails": { "description": "Action-specific context needed to perform the action. Populated for enabled and\ndisabled actions (so callers can see what a successful attempt would look like);\nnull when the action is not applicable to this asset.", "properties": { "end_contract_price": { "$ref": "#/components/schemas/ItAssetsAssetIdGetResponsesContentApplicationJsonSchemaDataActionsReturnRentalToDeelDetailsEndContractPrice", "description": "Estimated end-of-contract price charged when returning the asset" } }, "required": [ "end_contract_price" ], "title": "ItAssetsAssetIdGetResponsesContentApplicationJsonSchemaDataActionsReturnRentalToDeelDetails", "type": "object" }, "ItAssetsAssetIdGetResponsesContentApplicationJsonSchemaDataActionsReturnRentalToDeelDetailsEndContractPrice": { "description": "Estimated end-of-contract price charged when returning the asset", "properties": { "amount": { "description": "Amount", "format": "decimal", "type": "string" }, "currency": { "$ref": "#/components/schemas/ItAssetsAssetIdGetResponsesContentApplicationJsonSchemaDataActionsReturnRentalToDeelDetailsEndContractPriceCurrency", "description": "Three-letter currency code for the price" } }, "required": [ "amount", "currency" ], "title": "ItAssetsAssetIdGetResponsesContentApplicationJsonSchemaDataActionsReturnRentalToDeelDetailsEndContractPrice", "type": "object" }, "ItAssetsAssetIdGetResponsesContentApplicationJsonSchemaDataActionsReturnRentalToDeelDetailsEndContractPriceCurrency": { "description": "Three-letter currency code for the price", "enum": [ "AED", "AFN", "ALL", "AMD", "ANG", "AOA", "ARS", "AUD", "AWG", "AZN", "BAM", "BDT", "BGN", "BHD", "BIF", "BMD", "BOB", "BRL", "BSD", "BTN", "BWP", "BYN", "BZD", "CAD", "CDF", "CHF", "CLP", "CNY", "COP", "CRC", "CUC", "CVE", "CZK", "DJF", "DKK", "DOP", "DZD", "EGP", "ERN", "ETB", "EUR", "FJD", "FKP", "GBP", "GEL", "GHS", "GIP", "GMD", "GNF", "GTQ", "GYD", "HKD", "HNL", "HRK", "HTG", "HUF", "IDR", "ILS", "INR", "IQD", "IRR", "ISK", "JMD", "JOD", "JPY", "KES", "KGS", "KHR", "KMF", "KPW", "KRW", "KWD", "KYD", "KZT", "LAK", "LBP", "LKR", "LRD", "LSL", "LTL", "LYD", "MAD", "MDL", "MGA", "MKD", "MMK", "MNT", "MRU", "MUR", "MVR", "MWK", "MXN", "MYR", "MZN", "NAD", "NGN", "NIO", "NOK", "NPR", "NZD", "OMR", "PAB", "PEN", "PGK", "PHP", "PKR", "PLN", "PYG", "QAR", "RON", "RSD", "RUB", "RWF", "SAR", "SBD", "SCR", "SDG", "SEK", "SGD", "SHP", "SLL", "SOS", "SRD", "SSP", "STD", "SYP", "SZL", "THB", "TJS", "TMT", "TND", "TOP", "TRY", "TTD", "TWD", "TZS", "UAH", "UGX", "USD", "UYU", "UZS", "VEF", "VND", "VUV", "WST", "XAF", "XCD", "XOF", "XPF", "YER", "ZAR", "ZMW", "ZWD" ], "title": "ItAssetsAssetIdGetResponsesContentApplicationJsonSchemaDataActionsReturnRentalToDeelDetailsEndContractPriceCurrency", "type": "string" }, "ItAssetsAssetIdGetResponsesContentApplicationJsonSchemaDataActionsReturnRentalToDeelDisabledReasonsItems": { "enum": [ "ARCHIVED", "AT_DEEL_WAREHOUSE", "BEING_REPAIRED", "CONSUMABLE", "CONTROLLED_BY_DEEL", "COUNTRY_NOT_SUPPORTED_FOR_HUB", "COUNTRY_NOT_SUPPORTED_FOR_LOCAL", "DEEL_OWNED_ITEM_WITHOUT_RENTAL_CONTRACT", "DESKTOP_STORAGE", "ENDING_CONTRACT", "HUB_IN_SAME_REGION_AS_LOCAL", "INACTIVE", "INVALID_ITEM_LOCATION", "INVALID_ORGANIZATION_STATUS", "INVALID_STATE", "ITEM_CONDITIONS_TO_UNARCHIVE_NOT_MET", "ITEM_NOT_VISIBLE_FOR_ORGANIZATION", "NON_DEVICE", "NOT_AT_WAREHOUSE", "NOT_AVAILABLE_FOR_REUSE", "NOT_A_RENTAL", "NOT_MANAGEABLE_BY_ORGANIZATION", "NOT_WITH_ASSIGNMENT", "NOT_WITH_USER", "NO_ACTIVE_ADDONS", "NO_ACTIVE_STORAGE_CONTRACT", "NO_LOCATION_FOR_STORAGE", "NO_LOGISTICS_FOR_STORAGE", "NO_VALID_ADDONS", "ONGOING_SERVICE", "OWNED_BY_DEEL", "OWNED_BY_ORGANIZATION", "OWNED_BY_PARTNER_ORGANIZATION", "PARTNER_CHILD_CONTRACT", "PENDING_DEVICE_REFRESH", "RENTAL_CONTRACT_AND_USER_REGION_DO_NOT_MATCH", "TEMPORARILY_UNAVAILABLE", "UNKNOWN", "USER_HAS_NO_COUNTRY", "USER_HAS_NO_SEAT", "WAITING_FOR_CLEARANCE", "WITH_LOANER_ASSIGNMENT", "WITH_NON_COLLECTED_ASSIGNMENT", "WITH_NON_DELIVERED_ASSIGNMENT", "WITH_PENDING_ASSIGNMENT", "WRONG_ASSIGNMENT_STATUS", "WRONG_CONTRACT_STATUS", "WRONG_TERMS_AND_CONDITIONS" ], "title": "ItAssetsAssetIdGetResponsesContentApplicationJsonSchemaDataActionsReturnRentalToDeelDisabledReasonsItems", "type": "string" }, "ItAssetsAssetIdGetResponsesContentApplicationJsonSchemaDataActionsReturnRentalToDeelStatus": { "description": "Whether the action is currently available for this asset", "enum": [ "DISABLED", "ENABLED", "NOT_APPLICABLE" ], "title": "ItAssetsAssetIdGetResponsesContentApplicationJsonSchemaDataActionsReturnRentalToDeelStatus", "type": "string" }, "ItAssetsAssetIdGetResponsesContentApplicationJsonSchemaDataActionsReuseOwnAssetFromDeel": { "description": "Redeploy an organization-owned asset stored at a Deel warehouse", "properties": { "details": { "description": "Action-specific context needed to perform the action. Populated for enabled and\ndisabled actions (so callers can see what a successful attempt would look like);\nnull when the action is not applicable to this asset.", "oneOf": [ { "$ref": "#/components/schemas/ItAssetsAssetIdGetResponsesContentApplicationJsonSchemaDataActionsReuseOwnAssetFromDeelDetails" }, { "type": "null" } ] }, "disabled_reasons": { "description": "Reasons why the action is disabled. Empty when the action is enabled or not applicable", "items": { "$ref": "#/components/schemas/ItAssetsAssetIdGetResponsesContentApplicationJsonSchemaDataActionsReuseOwnAssetFromDeelDisabledReasonsItems" }, "type": "array" }, "status": { "$ref": "#/components/schemas/ItAssetsAssetIdGetResponsesContentApplicationJsonSchemaDataActionsReuseOwnAssetFromDeelStatus", "description": "Whether the action is currently available for this asset" } }, "required": [ "status", "details", "disabled_reasons" ], "title": "ItAssetsAssetIdGetResponsesContentApplicationJsonSchemaDataActionsReuseOwnAssetFromDeel", "type": "object" }, "ItAssetsAssetIdGetResponsesContentApplicationJsonSchemaDataActionsReuseOwnAssetFromDeelDetails": { "description": "Action-specific context needed to perform the action. Populated for enabled and\ndisabled actions (so callers can see what a successful attempt would look like);\nnull when the action is not applicable to this asset.", "properties": { "eligible_countries": { "description": "Countries where the asset can be redeployed from Deel", "items": { "$ref": "#/components/schemas/ItAssetsAssetIdGetResponsesContentApplicationJsonSchemaDataActionsReuseOwnAssetFromDeelDetailsEligibleCountriesItems" }, "type": "array" }, "express_delivery": { "description": "Express delivery availability and per-country fees. Null when express delivery is not supported", "oneOf": [ { "$ref": "#/components/schemas/ItAssetsAssetIdGetResponsesContentApplicationJsonSchemaDataActionsReuseOwnAssetFromDeelDetailsExpressDelivery" }, { "type": "null" } ] } }, "required": [ "express_delivery", "eligible_countries" ], "title": "ItAssetsAssetIdGetResponsesContentApplicationJsonSchemaDataActionsReuseOwnAssetFromDeelDetails", "type": "object" }, "ItAssetsAssetIdGetResponsesContentApplicationJsonSchemaDataActionsReuseOwnAssetFromDeelDetailsEligibleCountriesItems": { "enum": [ "AD", "AE", "AF", "AG", "AI", "AL", "AM", "AN", "AO", "AQ", "AR", "AS", "AT", "AU", "AW", "AX", "AZ", "BA", "BB", "BD", "BE", "BF", "BG", "BH", "BI", "BJ", "BL", "BM", "BN", "BO", "BQ", "BR", "BS", "BT", "BV", "BW", "BY", "BZ", "CA", "CC", "CD", "CF", "CG", "CH", "CI", "CK", "CL", "CM", "CN", "CO", "CR", "CU", "CV", "CW", "CX", "CY", "CZ", "DE", "DJ", "DK", "DM", "DO", "DZ", "EC", "EE", "EG", "EH", "ER", "ES", "ET", "FI", "FJ", "FK", "FM", "FO", "FR", "GA", "GB", "GD", "GE", "GF", "GG", "GH", "GI", "GL", "GM", "GN", "GP", "GQ", "GR", "GS", "GT", "GU", "GW", "GY", "HK", "HM", "HN", "HR", "HT", "HU", "IC", "ID", "IE", "IL", "IM", "IN", "IO", "IQ", "IR", "IS", "IT", "JE", "JM", "JO", "JP", "KE", "KG", "KH", "KI", "KM", "KN", "KP", "KR", "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", "XK", "YE", "YT", "ZA", "ZM", "ZW" ], "title": "ItAssetsAssetIdGetResponsesContentApplicationJsonSchemaDataActionsReuseOwnAssetFromDeelDetailsEligibleCountriesItems", "type": "string" }, "ItAssetsAssetIdGetResponsesContentApplicationJsonSchemaDataActionsReuseOwnAssetFromDeelDetailsExpressDelivery": { "description": "Express delivery availability and per-country fees. Null when express delivery is not supported", "properties": { "country_fees": { "additionalProperties": { "$ref": "#/components/schemas/ItAssetsAssetIdGetResponsesContentApplicationJsonSchemaDataActionsReuseOwnAssetFromDeelDetailsExpressDeliveryCountryFees" }, "description": "Express delivery fees keyed by destination country.", "type": "object" } }, "required": [ "country_fees" ], "title": "ItAssetsAssetIdGetResponsesContentApplicationJsonSchemaDataActionsReuseOwnAssetFromDeelDetailsExpressDelivery", "type": "object" }, "ItAssetsAssetIdGetResponsesContentApplicationJsonSchemaDataActionsReuseOwnAssetFromDeelDetailsExpressDeliveryCountryFees": { "properties": { "amount": { "description": "Amount", "format": "decimal", "type": "string" }, "currency": { "$ref": "#/components/schemas/ItAssetsAssetIdGetResponsesContentApplicationJsonSchemaDataActionsReuseOwnAssetFromDeelDetailsExpressDeliveryCountryFeesCurrency", "description": "Three-letter currency code for the price" } }, "required": [ "amount", "currency" ], "title": "ItAssetsAssetIdGetResponsesContentApplicationJsonSchemaDataActionsReuseOwnAssetFromDeelDetailsExpressDeliveryCountryFees", "type": "object" }, "ItAssetsAssetIdGetResponsesContentApplicationJsonSchemaDataActionsReuseOwnAssetFromDeelDetailsExpressDeliveryCountryFeesCurrency": { "description": "Three-letter currency code for the price", "enum": [ "AED", "AFN", "ALL", "AMD", "ANG", "AOA", "ARS", "AUD", "AWG", "AZN", "BAM", "BDT", "BGN", "BHD", "BIF", "BMD", "BOB", "BRL", "BSD", "BTN", "BWP", "BYN", "BZD", "CAD", "CDF", "CHF", "CLP", "CNY", "COP", "CRC", "CUC", "CVE", "CZK", "DJF", "DKK", "DOP", "DZD", "EGP", "ERN", "ETB", "EUR", "FJD", "FKP", "GBP", "GEL", "GHS", "GIP", "GMD", "GNF", "GTQ", "GYD", "HKD", "HNL", "HRK", "HTG", "HUF", "IDR", "ILS", "INR", "IQD", "IRR", "ISK", "JMD", "JOD", "JPY", "KES", "KGS", "KHR", "KMF", "KPW", "KRW", "KWD", "KYD", "KZT", "LAK", "LBP", "LKR", "LRD", "LSL", "LTL", "LYD", "MAD", "MDL", "MGA", "MKD", "MMK", "MNT", "MRU", "MUR", "MVR", "MWK", "MXN", "MYR", "MZN", "NAD", "NGN", "NIO", "NOK", "NPR", "NZD", "OMR", "PAB", "PEN", "PGK", "PHP", "PKR", "PLN", "PYG", "QAR", "RON", "RSD", "RUB", "RWF", "SAR", "SBD", "SCR", "SDG", "SEK", "SGD", "SHP", "SLL", "SOS", "SRD", "SSP", "STD", "SYP", "SZL", "THB", "TJS", "TMT", "TND", "TOP", "TRY", "TTD", "TWD", "TZS", "UAH", "UGX", "USD", "UYU", "UZS", "VEF", "VND", "VUV", "WST", "XAF", "XCD", "XOF", "XPF", "YER", "ZAR", "ZMW", "ZWD" ], "title": "ItAssetsAssetIdGetResponsesContentApplicationJsonSchemaDataActionsReuseOwnAssetFromDeelDetailsExpressDeliveryCountryFeesCurrency", "type": "string" }, "ItAssetsAssetIdGetResponsesContentApplicationJsonSchemaDataActionsReuseOwnAssetFromDeelDisabledReasonsItems": { "enum": [ "ARCHIVED", "AT_DEEL_WAREHOUSE", "BEING_REPAIRED", "CONSUMABLE", "CONTROLLED_BY_DEEL", "COUNTRY_NOT_SUPPORTED_FOR_HUB", "COUNTRY_NOT_SUPPORTED_FOR_LOCAL", "DEEL_OWNED_ITEM_WITHOUT_RENTAL_CONTRACT", "DESKTOP_STORAGE", "ENDING_CONTRACT", "HUB_IN_SAME_REGION_AS_LOCAL", "INACTIVE", "INVALID_ITEM_LOCATION", "INVALID_ORGANIZATION_STATUS", "INVALID_STATE", "ITEM_CONDITIONS_TO_UNARCHIVE_NOT_MET", "ITEM_NOT_VISIBLE_FOR_ORGANIZATION", "NON_DEVICE", "NOT_AT_WAREHOUSE", "NOT_AVAILABLE_FOR_REUSE", "NOT_A_RENTAL", "NOT_MANAGEABLE_BY_ORGANIZATION", "NOT_WITH_ASSIGNMENT", "NOT_WITH_USER", "NO_ACTIVE_ADDONS", "NO_ACTIVE_STORAGE_CONTRACT", "NO_LOCATION_FOR_STORAGE", "NO_LOGISTICS_FOR_STORAGE", "NO_VALID_ADDONS", "ONGOING_SERVICE", "OWNED_BY_DEEL", "OWNED_BY_ORGANIZATION", "OWNED_BY_PARTNER_ORGANIZATION", "PARTNER_CHILD_CONTRACT", "PENDING_DEVICE_REFRESH", "RENTAL_CONTRACT_AND_USER_REGION_DO_NOT_MATCH", "TEMPORARILY_UNAVAILABLE", "UNKNOWN", "USER_HAS_NO_COUNTRY", "USER_HAS_NO_SEAT", "WAITING_FOR_CLEARANCE", "WITH_LOANER_ASSIGNMENT", "WITH_NON_COLLECTED_ASSIGNMENT", "WITH_NON_DELIVERED_ASSIGNMENT", "WITH_PENDING_ASSIGNMENT", "WRONG_ASSIGNMENT_STATUS", "WRONG_CONTRACT_STATUS", "WRONG_TERMS_AND_CONDITIONS" ], "title": "ItAssetsAssetIdGetResponsesContentApplicationJsonSchemaDataActionsReuseOwnAssetFromDeelDisabledReasonsItems", "type": "string" }, "ItAssetsAssetIdGetResponsesContentApplicationJsonSchemaDataActionsReuseOwnAssetFromDeelStatus": { "description": "Whether the action is currently available for this asset", "enum": [ "DISABLED", "ENABLED", "NOT_APPLICABLE" ], "title": "ItAssetsAssetIdGetResponsesContentApplicationJsonSchemaDataActionsReuseOwnAssetFromDeelStatus", "type": "string" }, "ItAssetsAssetIdGetResponsesContentApplicationJsonSchemaDataActionsReuseOwnAssetFromOwnLocation": { "description": "Redeploy an organization-owned asset from an organization-owned location", "properties": { "details": { "description": "Action-specific context needed to perform the action. Populated for enabled and\ndisabled actions (so callers can see what a successful attempt would look like);\nnull when the action is not applicable to this asset.", "oneOf": [ { "$ref": "#/components/schemas/ItAssetsAssetIdGetResponsesContentApplicationJsonSchemaDataActionsReuseOwnAssetFromOwnLocationDetails" }, { "type": "null" } ] }, "disabled_reasons": { "description": "Reasons why the action is disabled. Empty when the action is enabled or not applicable", "items": { "$ref": "#/components/schemas/ItAssetsAssetIdGetResponsesContentApplicationJsonSchemaDataActionsReuseOwnAssetFromOwnLocationDisabledReasonsItems" }, "type": "array" }, "status": { "$ref": "#/components/schemas/ItAssetsAssetIdGetResponsesContentApplicationJsonSchemaDataActionsReuseOwnAssetFromOwnLocationStatus", "description": "Whether the action is currently available for this asset" } }, "required": [ "status", "details", "disabled_reasons" ], "title": "ItAssetsAssetIdGetResponsesContentApplicationJsonSchemaDataActionsReuseOwnAssetFromOwnLocation", "type": "object" }, "ItAssetsAssetIdGetResponsesContentApplicationJsonSchemaDataActionsReuseOwnAssetFromOwnLocationDetails": { "description": "Action-specific context needed to perform the action. Populated for enabled and\ndisabled actions (so callers can see what a successful attempt would look like);\nnull when the action is not applicable to this asset.", "properties": { "eligible_countries": { "description": "Countries where the asset can be redeployed from an organization-owned location", "items": { "$ref": "#/components/schemas/ItAssetsAssetIdGetResponsesContentApplicationJsonSchemaDataActionsReuseOwnAssetFromOwnLocationDetailsEligibleCountriesItems" }, "type": "array" }, "express_delivery": { "description": "Express delivery availability and per-country fees. Null when express delivery is not supported", "oneOf": [ { "$ref": "#/components/schemas/ItAssetsAssetIdGetResponsesContentApplicationJsonSchemaDataActionsReuseOwnAssetFromOwnLocationDetailsExpressDelivery" }, { "type": "null" } ] }, "service_cost": { "$ref": "#/components/schemas/ItAssetsAssetIdGetResponsesContentApplicationJsonSchemaDataActionsReuseOwnAssetFromOwnLocationDetailsServiceCost", "description": "Cost charged for the transfer service" } }, "required": [ "service_cost", "express_delivery", "eligible_countries" ], "title": "ItAssetsAssetIdGetResponsesContentApplicationJsonSchemaDataActionsReuseOwnAssetFromOwnLocationDetails", "type": "object" }, "ItAssetsAssetIdGetResponsesContentApplicationJsonSchemaDataActionsReuseOwnAssetFromOwnLocationDetailsEligibleCountriesItems": { "enum": [ "AD", "AE", "AF", "AG", "AI", "AL", "AM", "AN", "AO", "AQ", "AR", "AS", "AT", "AU", "AW", "AX", "AZ", "BA", "BB", "BD", "BE", "BF", "BG", "BH", "BI", "BJ", "BL", "BM", "BN", "BO", "BQ", "BR", "BS", "BT", "BV", "BW", "BY", "BZ", "CA", "CC", "CD", "CF", "CG", "CH", "CI", "CK", "CL", "CM", "CN", "CO", "CR", "CU", "CV", "CW", "CX", "CY", "CZ", "DE", "DJ", "DK", "DM", "DO", "DZ", "EC", "EE", "EG", "EH", "ER", "ES", "ET", "FI", "FJ", "FK", "FM", "FO", "FR", "GA", "GB", "GD", "GE", "GF", "GG", "GH", "GI", "GL", "GM", "GN", "GP", "GQ", "GR", "GS", "GT", "GU", "GW", "GY", "HK", "HM", "HN", "HR", "HT", "HU", "IC", "ID", "IE", "IL", "IM", "IN", "IO", "IQ", "IR", "IS", "IT", "JE", "JM", "JO", "JP", "KE", "KG", "KH", "KI", "KM", "KN", "KP", "KR", "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", "XK", "YE", "YT", "ZA", "ZM", "ZW" ], "title": "ItAssetsAssetIdGetResponsesContentApplicationJsonSchemaDataActionsReuseOwnAssetFromOwnLocationDetailsEligibleCountriesItems", "type": "string" }, "ItAssetsAssetIdGetResponsesContentApplicationJsonSchemaDataActionsReuseOwnAssetFromOwnLocationDetailsExpressDelivery": { "description": "Express delivery availability and per-country fees. Null when express delivery is not supported", "properties": { "country_fees": { "additionalProperties": { "$ref": "#/components/schemas/ItAssetsAssetIdGetResponsesContentApplicationJsonSchemaDataActionsReuseOwnAssetFromOwnLocationDetailsExpressDeliveryCountryFees" }, "description": "Express delivery fees keyed by destination country.", "type": "object" } }, "required": [ "country_fees" ], "title": "ItAssetsAssetIdGetResponsesContentApplicationJsonSchemaDataActionsReuseOwnAssetFromOwnLocationDetailsExpressDelivery", "type": "object" }, "ItAssetsAssetIdGetResponsesContentApplicationJsonSchemaDataActionsReuseOwnAssetFromOwnLocationDetailsExpressDeliveryCountryFees": { "properties": { "amount": { "description": "Amount", "format": "decimal", "type": "string" }, "currency": { "$ref": "#/components/schemas/ItAssetsAssetIdGetResponsesContentApplicationJsonSchemaDataActionsReuseOwnAssetFromOwnLocationDetailsExpressDeliveryCountryFeesCurrency", "description": "Three-letter currency code for the price" } }, "required": [ "amount", "currency" ], "title": "ItAssetsAssetIdGetResponsesContentApplicationJsonSchemaDataActionsReuseOwnAssetFromOwnLocationDetailsExpressDeliveryCountryFees", "type": "object" }, "ItAssetsAssetIdGetResponsesContentApplicationJsonSchemaDataActionsReuseOwnAssetFromOwnLocationDetailsExpressDeliveryCountryFeesCurrency": { "description": "Three-letter currency code for the price", "enum": [ "AED", "AFN", "ALL", "AMD", "ANG", "AOA", "ARS", "AUD", "AWG", "AZN", "BAM", "BDT", "BGN", "BHD", "BIF", "BMD", "BOB", "BRL", "BSD", "BTN", "BWP", "BYN", "BZD", "CAD", "CDF", "CHF", "CLP", "CNY", "COP", "CRC", "CUC", "CVE", "CZK", "DJF", "DKK", "DOP", "DZD", "EGP", "ERN", "ETB", "EUR", "FJD", "FKP", "GBP", "GEL", "GHS", "GIP", "GMD", "GNF", "GTQ", "GYD", "HKD", "HNL", "HRK", "HTG", "HUF", "IDR", "ILS", "INR", "IQD", "IRR", "ISK", "JMD", "JOD", "JPY", "KES", "KGS", "KHR", "KMF", "KPW", "KRW", "KWD", "KYD", "KZT", "LAK", "LBP", "LKR", "LRD", "LSL", "LTL", "LYD", "MAD", "MDL", "MGA", "MKD", "MMK", "MNT", "MRU", "MUR", "MVR", "MWK", "MXN", "MYR", "MZN", "NAD", "NGN", "NIO", "NOK", "NPR", "NZD", "OMR", "PAB", "PEN", "PGK", "PHP", "PKR", "PLN", "PYG", "QAR", "RON", "RSD", "RUB", "RWF", "SAR", "SBD", "SCR", "SDG", "SEK", "SGD", "SHP", "SLL", "SOS", "SRD", "SSP", "STD", "SYP", "SZL", "THB", "TJS", "TMT", "TND", "TOP", "TRY", "TTD", "TWD", "TZS", "UAH", "UGX", "USD", "UYU", "UZS", "VEF", "VND", "VUV", "WST", "XAF", "XCD", "XOF", "XPF", "YER", "ZAR", "ZMW", "ZWD" ], "title": "ItAssetsAssetIdGetResponsesContentApplicationJsonSchemaDataActionsReuseOwnAssetFromOwnLocationDetailsExpressDeliveryCountryFeesCurrency", "type": "string" }, "ItAssetsAssetIdGetResponsesContentApplicationJsonSchemaDataActionsReuseOwnAssetFromOwnLocationDetailsServiceCost": { "description": "Cost charged for the transfer service", "properties": { "billing_method": { "$ref": "#/components/schemas/ItAssetsAssetIdGetResponsesContentApplicationJsonSchemaDataActionsReuseOwnAssetFromOwnLocationDetailsServiceCostBillingMethod", "description": "How the action is charged. When \"TOKEN\", the fees are covered by an\nadd-on token pool; when \"CURRENCY\", the fees are billed in the currency\nspecified in the \"fees\" field." }, "fees": { "description": "Price charged for the action. Null when billing method is \"TOKEN\"", "oneOf": [ { "$ref": "#/components/schemas/ItAssetsAssetIdGetResponsesContentApplicationJsonSchemaDataActionsReuseOwnAssetFromOwnLocationDetailsServiceCostFees" }, { "type": "null" } ] }, "token_usage": { "description": "Add-on token consumption details. Null when billing method is \"CURRENCY\"", "oneOf": [ { "$ref": "#/components/schemas/ItAssetsAssetIdGetResponsesContentApplicationJsonSchemaDataActionsReuseOwnAssetFromOwnLocationDetailsServiceCostTokenUsage" }, { "type": "null" } ] } }, "required": [ "fees", "token_usage", "billing_method" ], "title": "ItAssetsAssetIdGetResponsesContentApplicationJsonSchemaDataActionsReuseOwnAssetFromOwnLocationDetailsServiceCost", "type": "object" }, "ItAssetsAssetIdGetResponsesContentApplicationJsonSchemaDataActionsReuseOwnAssetFromOwnLocationDetailsServiceCostBillingMethod": { "description": "How the action is charged. When \"TOKEN\", the fees are covered by an\nadd-on token pool; when \"CURRENCY\", the fees are billed in the currency\nspecified in the \"fees\" field.", "enum": [ "CURRENCY", "TOKEN" ], "title": "ItAssetsAssetIdGetResponsesContentApplicationJsonSchemaDataActionsReuseOwnAssetFromOwnLocationDetailsServiceCostBillingMethod", "type": "string" }, "ItAssetsAssetIdGetResponsesContentApplicationJsonSchemaDataActionsReuseOwnAssetFromOwnLocationDetailsServiceCostFees": { "description": "Price charged for the action. Null when billing method is \"TOKEN\"", "properties": { "amount": { "description": "Amount", "format": "decimal", "type": "string" }, "currency": { "$ref": "#/components/schemas/ItAssetsAssetIdGetResponsesContentApplicationJsonSchemaDataActionsReuseOwnAssetFromOwnLocationDetailsServiceCostFeesCurrency", "description": "Three-letter currency code for the price" } }, "required": [ "amount", "currency" ], "title": "ItAssetsAssetIdGetResponsesContentApplicationJsonSchemaDataActionsReuseOwnAssetFromOwnLocationDetailsServiceCostFees", "type": "object" }, "ItAssetsAssetIdGetResponsesContentApplicationJsonSchemaDataActionsReuseOwnAssetFromOwnLocationDetailsServiceCostFeesCurrency": { "description": "Three-letter currency code for the price", "enum": [ "AED", "AFN", "ALL", "AMD", "ANG", "AOA", "ARS", "AUD", "AWG", "AZN", "BAM", "BDT", "BGN", "BHD", "BIF", "BMD", "BOB", "BRL", "BSD", "BTN", "BWP", "BYN", "BZD", "CAD", "CDF", "CHF", "CLP", "CNY", "COP", "CRC", "CUC", "CVE", "CZK", "DJF", "DKK", "DOP", "DZD", "EGP", "ERN", "ETB", "EUR", "FJD", "FKP", "GBP", "GEL", "GHS", "GIP", "GMD", "GNF", "GTQ", "GYD", "HKD", "HNL", "HRK", "HTG", "HUF", "IDR", "ILS", "INR", "IQD", "IRR", "ISK", "JMD", "JOD", "JPY", "KES", "KGS", "KHR", "KMF", "KPW", "KRW", "KWD", "KYD", "KZT", "LAK", "LBP", "LKR", "LRD", "LSL", "LTL", "LYD", "MAD", "MDL", "MGA", "MKD", "MMK", "MNT", "MRU", "MUR", "MVR", "MWK", "MXN", "MYR", "MZN", "NAD", "NGN", "NIO", "NOK", "NPR", "NZD", "OMR", "PAB", "PEN", "PGK", "PHP", "PKR", "PLN", "PYG", "QAR", "RON", "RSD", "RUB", "RWF", "SAR", "SBD", "SCR", "SDG", "SEK", "SGD", "SHP", "SLL", "SOS", "SRD", "SSP", "STD", "SYP", "SZL", "THB", "TJS", "TMT", "TND", "TOP", "TRY", "TTD", "TWD", "TZS", "UAH", "UGX", "USD", "UYU", "UZS", "VEF", "VND", "VUV", "WST", "XAF", "XCD", "XOF", "XPF", "YER", "ZAR", "ZMW", "ZWD" ], "title": "ItAssetsAssetIdGetResponsesContentApplicationJsonSchemaDataActionsReuseOwnAssetFromOwnLocationDetailsServiceCostFeesCurrency", "type": "string" }, "ItAssetsAssetIdGetResponsesContentApplicationJsonSchemaDataActionsReuseOwnAssetFromOwnLocationDetailsServiceCostTokenUsage": { "description": "Add-on token consumption details. Null when billing method is \"CURRENCY\"", "properties": { "addon": { "$ref": "#/components/schemas/ItAssetsAssetIdGetResponsesContentApplicationJsonSchemaDataActionsReuseOwnAssetFromOwnLocationDetailsServiceCostTokenUsageAddon", "description": "The add-on that provides the tokens" }, "cost": { "description": "Number of tokens consumed by the action. Zero when the add-on covers the\nservice without drawing from a token pool", "format": "decimal", "type": "string" }, "tokens_left": { "description": "Number of tokens left in the pool after the action is performed. Null when\nthe add-on covers the service without a token pool", "format": "decimal", "type": [ "string", "null" ] } }, "required": [ "cost", "addon", "tokens_left" ], "title": "ItAssetsAssetIdGetResponsesContentApplicationJsonSchemaDataActionsReuseOwnAssetFromOwnLocationDetailsServiceCostTokenUsage", "type": "object" }, "ItAssetsAssetIdGetResponsesContentApplicationJsonSchemaDataActionsReuseOwnAssetFromOwnLocationDetailsServiceCostTokenUsageAddon": { "description": "The add-on that provides the tokens", "properties": { "id": { "description": "ID of the add-on", "format": "uuid", "type": "string" }, "name": { "description": "Public display name of the add-on", "type": "string" } }, "required": [ "id", "name" ], "title": "ItAssetsAssetIdGetResponsesContentApplicationJsonSchemaDataActionsReuseOwnAssetFromOwnLocationDetailsServiceCostTokenUsageAddon", "type": "object" }, "ItAssetsAssetIdGetResponsesContentApplicationJsonSchemaDataActionsReuseOwnAssetFromOwnLocationDisabledReasonsItems": { "enum": [ "ARCHIVED", "AT_DEEL_WAREHOUSE", "BEING_REPAIRED", "CONSUMABLE", "CONTROLLED_BY_DEEL", "COUNTRY_NOT_SUPPORTED_FOR_HUB", "COUNTRY_NOT_SUPPORTED_FOR_LOCAL", "DEEL_OWNED_ITEM_WITHOUT_RENTAL_CONTRACT", "DESKTOP_STORAGE", "ENDING_CONTRACT", "HUB_IN_SAME_REGION_AS_LOCAL", "INACTIVE", "INVALID_ITEM_LOCATION", "INVALID_ORGANIZATION_STATUS", "INVALID_STATE", "ITEM_CONDITIONS_TO_UNARCHIVE_NOT_MET", "ITEM_NOT_VISIBLE_FOR_ORGANIZATION", "NON_DEVICE", "NOT_AT_WAREHOUSE", "NOT_AVAILABLE_FOR_REUSE", "NOT_A_RENTAL", "NOT_MANAGEABLE_BY_ORGANIZATION", "NOT_WITH_ASSIGNMENT", "NOT_WITH_USER", "NO_ACTIVE_ADDONS", "NO_ACTIVE_STORAGE_CONTRACT", "NO_LOCATION_FOR_STORAGE", "NO_LOGISTICS_FOR_STORAGE", "NO_VALID_ADDONS", "ONGOING_SERVICE", "OWNED_BY_DEEL", "OWNED_BY_ORGANIZATION", "OWNED_BY_PARTNER_ORGANIZATION", "PARTNER_CHILD_CONTRACT", "PENDING_DEVICE_REFRESH", "RENTAL_CONTRACT_AND_USER_REGION_DO_NOT_MATCH", "TEMPORARILY_UNAVAILABLE", "UNKNOWN", "USER_HAS_NO_COUNTRY", "USER_HAS_NO_SEAT", "WAITING_FOR_CLEARANCE", "WITH_LOANER_ASSIGNMENT", "WITH_NON_COLLECTED_ASSIGNMENT", "WITH_NON_DELIVERED_ASSIGNMENT", "WITH_PENDING_ASSIGNMENT", "WRONG_ASSIGNMENT_STATUS", "WRONG_CONTRACT_STATUS", "WRONG_TERMS_AND_CONDITIONS" ], "title": "ItAssetsAssetIdGetResponsesContentApplicationJsonSchemaDataActionsReuseOwnAssetFromOwnLocationDisabledReasonsItems", "type": "string" }, "ItAssetsAssetIdGetResponsesContentApplicationJsonSchemaDataActionsReuseOwnAssetFromOwnLocationStatus": { "description": "Whether the action is currently available for this asset", "enum": [ "DISABLED", "ENABLED", "NOT_APPLICABLE" ], "title": "ItAssetsAssetIdGetResponsesContentApplicationJsonSchemaDataActionsReuseOwnAssetFromOwnLocationStatus", "type": "string" }, "ItAssetsAssetIdGetResponsesContentApplicationJsonSchemaDataActionsStoreOwnAssetAtDeelForHub": { "description": "Store an organization-owned asset at a Deel hub warehouse", "properties": { "details": { "description": "Action-specific context needed to perform the action. Populated for enabled and\ndisabled actions (so callers can see what a successful attempt would look like);\nnull when the action is not applicable to this asset.", "oneOf": [ { "$ref": "#/components/schemas/ItAssetsAssetIdGetResponsesContentApplicationJsonSchemaDataActionsStoreOwnAssetAtDeelForHubDetails" }, { "type": "null" } ] }, "disabled_reasons": { "description": "Reasons why the action is disabled. Empty when the action is enabled or not applicable", "items": { "$ref": "#/components/schemas/ItAssetsAssetIdGetResponsesContentApplicationJsonSchemaDataActionsStoreOwnAssetAtDeelForHubDisabledReasonsItems" }, "type": "array" }, "status": { "$ref": "#/components/schemas/ItAssetsAssetIdGetResponsesContentApplicationJsonSchemaDataActionsStoreOwnAssetAtDeelForHubStatus", "description": "Whether the action is currently available for this asset" } }, "required": [ "status", "details", "disabled_reasons" ], "title": "ItAssetsAssetIdGetResponsesContentApplicationJsonSchemaDataActionsStoreOwnAssetAtDeelForHub", "type": "object" }, "ItAssetsAssetIdGetResponsesContentApplicationJsonSchemaDataActionsStoreOwnAssetAtDeelForHubDetails": { "description": "Action-specific context needed to perform the action. Populated for enabled and\ndisabled actions (so callers can see what a successful attempt would look like);\nnull when the action is not applicable to this asset.", "properties": { "activation_cost": { "$ref": "#/components/schemas/ItAssetsAssetIdGetResponsesContentApplicationJsonSchemaDataActionsStoreOwnAssetAtDeelForHubDetailsActivationCost", "description": "Cost charged to activate storage" }, "destination_country": { "$ref": "#/components/schemas/ItAssetsAssetIdGetResponsesContentApplicationJsonSchemaDataActionsStoreOwnAssetAtDeelForHubDetailsDestinationCountry", "description": "ISO 3166-1 alpha-2 country of the Deel warehouse the asset will be shipped to" }, "grace_period_in_months": { "description": "Grace period in months during which storage is free before monthly fees apply", "format": "int64", "type": "integer" }, "monthly_fee": { "$ref": "#/components/schemas/ItAssetsAssetIdGetResponsesContentApplicationJsonSchemaDataActionsStoreOwnAssetAtDeelForHubDetailsMonthlyFee", "description": "Monthly storage fee charged after the grace period" } }, "required": [ "monthly_fee", "activation_cost", "destination_country", "grace_period_in_months" ], "title": "ItAssetsAssetIdGetResponsesContentApplicationJsonSchemaDataActionsStoreOwnAssetAtDeelForHubDetails", "type": "object" }, "ItAssetsAssetIdGetResponsesContentApplicationJsonSchemaDataActionsStoreOwnAssetAtDeelForHubDetailsActivationCost": { "description": "Cost charged to activate storage", "properties": { "billing_method": { "$ref": "#/components/schemas/ItAssetsAssetIdGetResponsesContentApplicationJsonSchemaDataActionsStoreOwnAssetAtDeelForHubDetailsActivationCostBillingMethod", "description": "How the action is charged. When \"TOKEN\", the fees are covered by an\nadd-on token pool; when \"CURRENCY\", the fees are billed in the currency\nspecified in the \"fees\" field." }, "fees": { "description": "Price charged for the action. Null when billing method is \"TOKEN\"", "oneOf": [ { "$ref": "#/components/schemas/ItAssetsAssetIdGetResponsesContentApplicationJsonSchemaDataActionsStoreOwnAssetAtDeelForHubDetailsActivationCostFees" }, { "type": "null" } ] }, "token_usage": { "description": "Add-on token consumption details. Null when billing method is \"CURRENCY\"", "oneOf": [ { "$ref": "#/components/schemas/ItAssetsAssetIdGetResponsesContentApplicationJsonSchemaDataActionsStoreOwnAssetAtDeelForHubDetailsActivationCostTokenUsage" }, { "type": "null" } ] } }, "required": [ "fees", "token_usage", "billing_method" ], "title": "ItAssetsAssetIdGetResponsesContentApplicationJsonSchemaDataActionsStoreOwnAssetAtDeelForHubDetailsActivationCost", "type": "object" }, "ItAssetsAssetIdGetResponsesContentApplicationJsonSchemaDataActionsStoreOwnAssetAtDeelForHubDetailsActivationCostBillingMethod": { "description": "How the action is charged. When \"TOKEN\", the fees are covered by an\nadd-on token pool; when \"CURRENCY\", the fees are billed in the currency\nspecified in the \"fees\" field.", "enum": [ "CURRENCY", "TOKEN" ], "title": "ItAssetsAssetIdGetResponsesContentApplicationJsonSchemaDataActionsStoreOwnAssetAtDeelForHubDetailsActivationCostBillingMethod", "type": "string" }, "ItAssetsAssetIdGetResponsesContentApplicationJsonSchemaDataActionsStoreOwnAssetAtDeelForHubDetailsActivationCostFees": { "description": "Price charged for the action. Null when billing method is \"TOKEN\"", "properties": { "amount": { "description": "Amount", "format": "decimal", "type": "string" }, "currency": { "$ref": "#/components/schemas/ItAssetsAssetIdGetResponsesContentApplicationJsonSchemaDataActionsStoreOwnAssetAtDeelForHubDetailsActivationCostFeesCurrency", "description": "Three-letter currency code for the price" } }, "required": [ "amount", "currency" ], "title": "ItAssetsAssetIdGetResponsesContentApplicationJsonSchemaDataActionsStoreOwnAssetAtDeelForHubDetailsActivationCostFees", "type": "object" }, "ItAssetsAssetIdGetResponsesContentApplicationJsonSchemaDataActionsStoreOwnAssetAtDeelForHubDetailsActivationCostFeesCurrency": { "description": "Three-letter currency code for the price", "enum": [ "AED", "AFN", "ALL", "AMD", "ANG", "AOA", "ARS", "AUD", "AWG", "AZN", "BAM", "BDT", "BGN", "BHD", "BIF", "BMD", "BOB", "BRL", "BSD", "BTN", "BWP", "BYN", "BZD", "CAD", "CDF", "CHF", "CLP", "CNY", "COP", "CRC", "CUC", "CVE", "CZK", "DJF", "DKK", "DOP", "DZD", "EGP", "ERN", "ETB", "EUR", "FJD", "FKP", "GBP", "GEL", "GHS", "GIP", "GMD", "GNF", "GTQ", "GYD", "HKD", "HNL", "HRK", "HTG", "HUF", "IDR", "ILS", "INR", "IQD", "IRR", "ISK", "JMD", "JOD", "JPY", "KES", "KGS", "KHR", "KMF", "KPW", "KRW", "KWD", "KYD", "KZT", "LAK", "LBP", "LKR", "LRD", "LSL", "LTL", "LYD", "MAD", "MDL", "MGA", "MKD", "MMK", "MNT", "MRU", "MUR", "MVR", "MWK", "MXN", "MYR", "MZN", "NAD", "NGN", "NIO", "NOK", "NPR", "NZD", "OMR", "PAB", "PEN", "PGK", "PHP", "PKR", "PLN", "PYG", "QAR", "RON", "RSD", "RUB", "RWF", "SAR", "SBD", "SCR", "SDG", "SEK", "SGD", "SHP", "SLL", "SOS", "SRD", "SSP", "STD", "SYP", "SZL", "THB", "TJS", "TMT", "TND", "TOP", "TRY", "TTD", "TWD", "TZS", "UAH", "UGX", "USD", "UYU", "UZS", "VEF", "VND", "VUV", "WST", "XAF", "XCD", "XOF", "XPF", "YER", "ZAR", "ZMW", "ZWD" ], "title": "ItAssetsAssetIdGetResponsesContentApplicationJsonSchemaDataActionsStoreOwnAssetAtDeelForHubDetailsActivationCostFeesCurrency", "type": "string" }, "ItAssetsAssetIdGetResponsesContentApplicationJsonSchemaDataActionsStoreOwnAssetAtDeelForHubDetailsActivationCostTokenUsage": { "description": "Add-on token consumption details. Null when billing method is \"CURRENCY\"", "properties": { "addon": { "$ref": "#/components/schemas/ItAssetsAssetIdGetResponsesContentApplicationJsonSchemaDataActionsStoreOwnAssetAtDeelForHubDetailsActivationCostTokenUsageAddon", "description": "The add-on that provides the tokens" }, "cost": { "description": "Number of tokens consumed by the action. Zero when the add-on covers the\nservice without drawing from a token pool", "format": "decimal", "type": "string" }, "tokens_left": { "description": "Number of tokens left in the pool after the action is performed. Null when\nthe add-on covers the service without a token pool", "format": "decimal", "type": [ "string", "null" ] } }, "required": [ "cost", "addon", "tokens_left" ], "title": "ItAssetsAssetIdGetResponsesContentApplicationJsonSchemaDataActionsStoreOwnAssetAtDeelForHubDetailsActivationCostTokenUsage", "type": "object" }, "ItAssetsAssetIdGetResponsesContentApplicationJsonSchemaDataActionsStoreOwnAssetAtDeelForHubDetailsActivationCostTokenUsageAddon": { "description": "The add-on that provides the tokens", "properties": { "id": { "description": "ID of the add-on", "format": "uuid", "type": "string" }, "name": { "description": "Public display name of the add-on", "type": "string" } }, "required": [ "id", "name" ], "title": "ItAssetsAssetIdGetResponsesContentApplicationJsonSchemaDataActionsStoreOwnAssetAtDeelForHubDetailsActivationCostTokenUsageAddon", "type": "object" }, "ItAssetsAssetIdGetResponsesContentApplicationJsonSchemaDataActionsStoreOwnAssetAtDeelForHubDetailsDestinationCountry": { "description": "ISO 3166-1 alpha-2 country of the Deel warehouse the asset will be shipped to", "enum": [ "AD", "AE", "AF", "AG", "AI", "AL", "AM", "AN", "AO", "AQ", "AR", "AS", "AT", "AU", "AW", "AX", "AZ", "BA", "BB", "BD", "BE", "BF", "BG", "BH", "BI", "BJ", "BL", "BM", "BN", "BO", "BQ", "BR", "BS", "BT", "BV", "BW", "BY", "BZ", "CA", "CC", "CD", "CF", "CG", "CH", "CI", "CK", "CL", "CM", "CN", "CO", "CR", "CU", "CV", "CW", "CX", "CY", "CZ", "DE", "DJ", "DK", "DM", "DO", "DZ", "EC", "EE", "EG", "EH", "ER", "ES", "ET", "FI", "FJ", "FK", "FM", "FO", "FR", "GA", "GB", "GD", "GE", "GF", "GG", "GH", "GI", "GL", "GM", "GN", "GP", "GQ", "GR", "GS", "GT", "GU", "GW", "GY", "HK", "HM", "HN", "HR", "HT", "HU", "IC", "ID", "IE", "IL", "IM", "IN", "IO", "IQ", "IR", "IS", "IT", "JE", "JM", "JO", "JP", "KE", "KG", "KH", "KI", "KM", "KN", "KP", "KR", "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", "XK", "YE", "YT", "ZA", "ZM", "ZW" ], "title": "ItAssetsAssetIdGetResponsesContentApplicationJsonSchemaDataActionsStoreOwnAssetAtDeelForHubDetailsDestinationCountry", "type": "string" }, "ItAssetsAssetIdGetResponsesContentApplicationJsonSchemaDataActionsStoreOwnAssetAtDeelForHubDetailsMonthlyFee": { "description": "Monthly storage fee charged after the grace period", "properties": { "amount": { "description": "Amount", "format": "decimal", "type": "string" }, "currency": { "$ref": "#/components/schemas/ItAssetsAssetIdGetResponsesContentApplicationJsonSchemaDataActionsStoreOwnAssetAtDeelForHubDetailsMonthlyFeeCurrency", "description": "Three-letter currency code for the price" } }, "required": [ "amount", "currency" ], "title": "ItAssetsAssetIdGetResponsesContentApplicationJsonSchemaDataActionsStoreOwnAssetAtDeelForHubDetailsMonthlyFee", "type": "object" }, "ItAssetsAssetIdGetResponsesContentApplicationJsonSchemaDataActionsStoreOwnAssetAtDeelForHubDetailsMonthlyFeeCurrency": { "description": "Three-letter currency code for the price", "enum": [ "AED", "AFN", "ALL", "AMD", "ANG", "AOA", "ARS", "AUD", "AWG", "AZN", "BAM", "BDT", "BGN", "BHD", "BIF", "BMD", "BOB", "BRL", "BSD", "BTN", "BWP", "BYN", "BZD", "CAD", "CDF", "CHF", "CLP", "CNY", "COP", "CRC", "CUC", "CVE", "CZK", "DJF", "DKK", "DOP", "DZD", "EGP", "ERN", "ETB", "EUR", "FJD", "FKP", "GBP", "GEL", "GHS", "GIP", "GMD", "GNF", "GTQ", "GYD", "HKD", "HNL", "HRK", "HTG", "HUF", "IDR", "ILS", "INR", "IQD", "IRR", "ISK", "JMD", "JOD", "JPY", "KES", "KGS", "KHR", "KMF", "KPW", "KRW", "KWD", "KYD", "KZT", "LAK", "LBP", "LKR", "LRD", "LSL", "LTL", "LYD", "MAD", "MDL", "MGA", "MKD", "MMK", "MNT", "MRU", "MUR", "MVR", "MWK", "MXN", "MYR", "MZN", "NAD", "NGN", "NIO", "NOK", "NPR", "NZD", "OMR", "PAB", "PEN", "PGK", "PHP", "PKR", "PLN", "PYG", "QAR", "RON", "RSD", "RUB", "RWF", "SAR", "SBD", "SCR", "SDG", "SEK", "SGD", "SHP", "SLL", "SOS", "SRD", "SSP", "STD", "SYP", "SZL", "THB", "TJS", "TMT", "TND", "TOP", "TRY", "TTD", "TWD", "TZS", "UAH", "UGX", "USD", "UYU", "UZS", "VEF", "VND", "VUV", "WST", "XAF", "XCD", "XOF", "XPF", "YER", "ZAR", "ZMW", "ZWD" ], "title": "ItAssetsAssetIdGetResponsesContentApplicationJsonSchemaDataActionsStoreOwnAssetAtDeelForHubDetailsMonthlyFeeCurrency", "type": "string" }, "ItAssetsAssetIdGetResponsesContentApplicationJsonSchemaDataActionsStoreOwnAssetAtDeelForHubDisabledReasonsItems": { "enum": [ "ARCHIVED", "AT_DEEL_WAREHOUSE", "BEING_REPAIRED", "CONSUMABLE", "CONTROLLED_BY_DEEL", "COUNTRY_NOT_SUPPORTED_FOR_HUB", "COUNTRY_NOT_SUPPORTED_FOR_LOCAL", "DEEL_OWNED_ITEM_WITHOUT_RENTAL_CONTRACT", "DESKTOP_STORAGE", "ENDING_CONTRACT", "HUB_IN_SAME_REGION_AS_LOCAL", "INACTIVE", "INVALID_ITEM_LOCATION", "INVALID_ORGANIZATION_STATUS", "INVALID_STATE", "ITEM_CONDITIONS_TO_UNARCHIVE_NOT_MET", "ITEM_NOT_VISIBLE_FOR_ORGANIZATION", "NON_DEVICE", "NOT_AT_WAREHOUSE", "NOT_AVAILABLE_FOR_REUSE", "NOT_A_RENTAL", "NOT_MANAGEABLE_BY_ORGANIZATION", "NOT_WITH_ASSIGNMENT", "NOT_WITH_USER", "NO_ACTIVE_ADDONS", "NO_ACTIVE_STORAGE_CONTRACT", "NO_LOCATION_FOR_STORAGE", "NO_LOGISTICS_FOR_STORAGE", "NO_VALID_ADDONS", "ONGOING_SERVICE", "OWNED_BY_DEEL", "OWNED_BY_ORGANIZATION", "OWNED_BY_PARTNER_ORGANIZATION", "PARTNER_CHILD_CONTRACT", "PENDING_DEVICE_REFRESH", "RENTAL_CONTRACT_AND_USER_REGION_DO_NOT_MATCH", "TEMPORARILY_UNAVAILABLE", "UNKNOWN", "USER_HAS_NO_COUNTRY", "USER_HAS_NO_SEAT", "WAITING_FOR_CLEARANCE", "WITH_LOANER_ASSIGNMENT", "WITH_NON_COLLECTED_ASSIGNMENT", "WITH_NON_DELIVERED_ASSIGNMENT", "WITH_PENDING_ASSIGNMENT", "WRONG_ASSIGNMENT_STATUS", "WRONG_CONTRACT_STATUS", "WRONG_TERMS_AND_CONDITIONS" ], "title": "ItAssetsAssetIdGetResponsesContentApplicationJsonSchemaDataActionsStoreOwnAssetAtDeelForHubDisabledReasonsItems", "type": "string" }, "ItAssetsAssetIdGetResponsesContentApplicationJsonSchemaDataActionsStoreOwnAssetAtDeelForHubStatus": { "description": "Whether the action is currently available for this asset", "enum": [ "DISABLED", "ENABLED", "NOT_APPLICABLE" ], "title": "ItAssetsAssetIdGetResponsesContentApplicationJsonSchemaDataActionsStoreOwnAssetAtDeelForHubStatus", "type": "string" }, "ItAssetsAssetIdGetResponsesContentApplicationJsonSchemaDataActionsStoreOwnAssetAtDeelForLocal": { "description": "Store an organization-owned asset at a Deel local warehouse", "properties": { "details": { "description": "Action-specific context needed to perform the action. Populated for enabled and\ndisabled actions (so callers can see what a successful attempt would look like);\nnull when the action is not applicable to this asset.", "oneOf": [ { "$ref": "#/components/schemas/ItAssetsAssetIdGetResponsesContentApplicationJsonSchemaDataActionsStoreOwnAssetAtDeelForLocalDetails" }, { "type": "null" } ] }, "disabled_reasons": { "description": "Reasons why the action is disabled. Empty when the action is enabled or not applicable", "items": { "$ref": "#/components/schemas/ItAssetsAssetIdGetResponsesContentApplicationJsonSchemaDataActionsStoreOwnAssetAtDeelForLocalDisabledReasonsItems" }, "type": "array" }, "status": { "$ref": "#/components/schemas/ItAssetsAssetIdGetResponsesContentApplicationJsonSchemaDataActionsStoreOwnAssetAtDeelForLocalStatus", "description": "Whether the action is currently available for this asset" } }, "required": [ "status", "details", "disabled_reasons" ], "title": "ItAssetsAssetIdGetResponsesContentApplicationJsonSchemaDataActionsStoreOwnAssetAtDeelForLocal", "type": "object" }, "ItAssetsAssetIdGetResponsesContentApplicationJsonSchemaDataActionsStoreOwnAssetAtDeelForLocalDetails": { "description": "Action-specific context needed to perform the action. Populated for enabled and\ndisabled actions (so callers can see what a successful attempt would look like);\nnull when the action is not applicable to this asset.", "properties": { "activation_cost": { "$ref": "#/components/schemas/ItAssetsAssetIdGetResponsesContentApplicationJsonSchemaDataActionsStoreOwnAssetAtDeelForLocalDetailsActivationCost", "description": "Cost charged to activate storage" }, "destination_country": { "$ref": "#/components/schemas/ItAssetsAssetIdGetResponsesContentApplicationJsonSchemaDataActionsStoreOwnAssetAtDeelForLocalDetailsDestinationCountry", "description": "ISO 3166-1 alpha-2 country of the Deel warehouse the asset will be shipped to" }, "grace_period_in_months": { "description": "Grace period in months during which storage is free before monthly fees apply", "format": "int64", "type": "integer" }, "monthly_fee": { "$ref": "#/components/schemas/ItAssetsAssetIdGetResponsesContentApplicationJsonSchemaDataActionsStoreOwnAssetAtDeelForLocalDetailsMonthlyFee", "description": "Monthly storage fee charged after the grace period" } }, "required": [ "monthly_fee", "activation_cost", "destination_country", "grace_period_in_months" ], "title": "ItAssetsAssetIdGetResponsesContentApplicationJsonSchemaDataActionsStoreOwnAssetAtDeelForLocalDetails", "type": "object" }, "ItAssetsAssetIdGetResponsesContentApplicationJsonSchemaDataActionsStoreOwnAssetAtDeelForLocalDetailsActivationCost": { "description": "Cost charged to activate storage", "properties": { "billing_method": { "$ref": "#/components/schemas/ItAssetsAssetIdGetResponsesContentApplicationJsonSchemaDataActionsStoreOwnAssetAtDeelForLocalDetailsActivationCostBillingMethod", "description": "How the action is charged. When \"TOKEN\", the fees are covered by an\nadd-on token pool; when \"CURRENCY\", the fees are billed in the currency\nspecified in the \"fees\" field." }, "fees": { "description": "Price charged for the action. Null when billing method is \"TOKEN\"", "oneOf": [ { "$ref": "#/components/schemas/ItAssetsAssetIdGetResponsesContentApplicationJsonSchemaDataActionsStoreOwnAssetAtDeelForLocalDetailsActivationCostFees" }, { "type": "null" } ] }, "token_usage": { "description": "Add-on token consumption details. Null when billing method is \"CURRENCY\"", "oneOf": [ { "$ref": "#/components/schemas/ItAssetsAssetIdGetResponsesContentApplicationJsonSchemaDataActionsStoreOwnAssetAtDeelForLocalDetailsActivationCostTokenUsage" }, { "type": "null" } ] } }, "required": [ "fees", "token_usage", "billing_method" ], "title": "ItAssetsAssetIdGetResponsesContentApplicationJsonSchemaDataActionsStoreOwnAssetAtDeelForLocalDetailsActivationCost", "type": "object" }, "ItAssetsAssetIdGetResponsesContentApplicationJsonSchemaDataActionsStoreOwnAssetAtDeelForLocalDetailsActivationCostBillingMethod": { "description": "How the action is charged. When \"TOKEN\", the fees are covered by an\nadd-on token pool; when \"CURRENCY\", the fees are billed in the currency\nspecified in the \"fees\" field.", "enum": [ "CURRENCY", "TOKEN" ], "title": "ItAssetsAssetIdGetResponsesContentApplicationJsonSchemaDataActionsStoreOwnAssetAtDeelForLocalDetailsActivationCostBillingMethod", "type": "string" }, "ItAssetsAssetIdGetResponsesContentApplicationJsonSchemaDataActionsStoreOwnAssetAtDeelForLocalDetailsActivationCostFees": { "description": "Price charged for the action. Null when billing method is \"TOKEN\"", "properties": { "amount": { "description": "Amount", "format": "decimal", "type": "string" }, "currency": { "$ref": "#/components/schemas/ItAssetsAssetIdGetResponsesContentApplicationJsonSchemaDataActionsStoreOwnAssetAtDeelForLocalDetailsActivationCostFeesCurrency", "description": "Three-letter currency code for the price" } }, "required": [ "amount", "currency" ], "title": "ItAssetsAssetIdGetResponsesContentApplicationJsonSchemaDataActionsStoreOwnAssetAtDeelForLocalDetailsActivationCostFees", "type": "object" }, "ItAssetsAssetIdGetResponsesContentApplicationJsonSchemaDataActionsStoreOwnAssetAtDeelForLocalDetailsActivationCostFeesCurrency": { "description": "Three-letter currency code for the price", "enum": [ "AED", "AFN", "ALL", "AMD", "ANG", "AOA", "ARS", "AUD", "AWG", "AZN", "BAM", "BDT", "BGN", "BHD", "BIF", "BMD", "BOB", "BRL", "BSD", "BTN", "BWP", "BYN", "BZD", "CAD", "CDF", "CHF", "CLP", "CNY", "COP", "CRC", "CUC", "CVE", "CZK", "DJF", "DKK", "DOP", "DZD", "EGP", "ERN", "ETB", "EUR", "FJD", "FKP", "GBP", "GEL", "GHS", "GIP", "GMD", "GNF", "GTQ", "GYD", "HKD", "HNL", "HRK", "HTG", "HUF", "IDR", "ILS", "INR", "IQD", "IRR", "ISK", "JMD", "JOD", "JPY", "KES", "KGS", "KHR", "KMF", "KPW", "KRW", "KWD", "KYD", "KZT", "LAK", "LBP", "LKR", "LRD", "LSL", "LTL", "LYD", "MAD", "MDL", "MGA", "MKD", "MMK", "MNT", "MRU", "MUR", "MVR", "MWK", "MXN", "MYR", "MZN", "NAD", "NGN", "NIO", "NOK", "NPR", "NZD", "OMR", "PAB", "PEN", "PGK", "PHP", "PKR", "PLN", "PYG", "QAR", "RON", "RSD", "RUB", "RWF", "SAR", "SBD", "SCR", "SDG", "SEK", "SGD", "SHP", "SLL", "SOS", "SRD", "SSP", "STD", "SYP", "SZL", "THB", "TJS", "TMT", "TND", "TOP", "TRY", "TTD", "TWD", "TZS", "UAH", "UGX", "USD", "UYU", "UZS", "VEF", "VND", "VUV", "WST", "XAF", "XCD", "XOF", "XPF", "YER", "ZAR", "ZMW", "ZWD" ], "title": "ItAssetsAssetIdGetResponsesContentApplicationJsonSchemaDataActionsStoreOwnAssetAtDeelForLocalDetailsActivationCostFeesCurrency", "type": "string" }, "ItAssetsAssetIdGetResponsesContentApplicationJsonSchemaDataActionsStoreOwnAssetAtDeelForLocalDetailsActivationCostTokenUsage": { "description": "Add-on token consumption details. Null when billing method is \"CURRENCY\"", "properties": { "addon": { "$ref": "#/components/schemas/ItAssetsAssetIdGetResponsesContentApplicationJsonSchemaDataActionsStoreOwnAssetAtDeelForLocalDetailsActivationCostTokenUsageAddon", "description": "The add-on that provides the tokens" }, "cost": { "description": "Number of tokens consumed by the action. Zero when the add-on covers the\nservice without drawing from a token pool", "format": "decimal", "type": "string" }, "tokens_left": { "description": "Number of tokens left in the pool after the action is performed. Null when\nthe add-on covers the service without a token pool", "format": "decimal", "type": [ "string", "null" ] } }, "required": [ "cost", "addon", "tokens_left" ], "title": "ItAssetsAssetIdGetResponsesContentApplicationJsonSchemaDataActionsStoreOwnAssetAtDeelForLocalDetailsActivationCostTokenUsage", "type": "object" }, "ItAssetsAssetIdGetResponsesContentApplicationJsonSchemaDataActionsStoreOwnAssetAtDeelForLocalDetailsActivationCostTokenUsageAddon": { "description": "The add-on that provides the tokens", "properties": { "id": { "description": "ID of the add-on", "format": "uuid", "type": "string" }, "name": { "description": "Public display name of the add-on", "type": "string" } }, "required": [ "id", "name" ], "title": "ItAssetsAssetIdGetResponsesContentApplicationJsonSchemaDataActionsStoreOwnAssetAtDeelForLocalDetailsActivationCostTokenUsageAddon", "type": "object" }, "ItAssetsAssetIdGetResponsesContentApplicationJsonSchemaDataActionsStoreOwnAssetAtDeelForLocalDetailsDestinationCountry": { "description": "ISO 3166-1 alpha-2 country of the Deel warehouse the asset will be shipped to", "enum": [ "AD", "AE", "AF", "AG", "AI", "AL", "AM", "AN", "AO", "AQ", "AR", "AS", "AT", "AU", "AW", "AX", "AZ", "BA", "BB", "BD", "BE", "BF", "BG", "BH", "BI", "BJ", "BL", "BM", "BN", "BO", "BQ", "BR", "BS", "BT", "BV", "BW", "BY", "BZ", "CA", "CC", "CD", "CF", "CG", "CH", "CI", "CK", "CL", "CM", "CN", "CO", "CR", "CU", "CV", "CW", "CX", "CY", "CZ", "DE", "DJ", "DK", "DM", "DO", "DZ", "EC", "EE", "EG", "EH", "ER", "ES", "ET", "FI", "FJ", "FK", "FM", "FO", "FR", "GA", "GB", "GD", "GE", "GF", "GG", "GH", "GI", "GL", "GM", "GN", "GP", "GQ", "GR", "GS", "GT", "GU", "GW", "GY", "HK", "HM", "HN", "HR", "HT", "HU", "IC", "ID", "IE", "IL", "IM", "IN", "IO", "IQ", "IR", "IS", "IT", "JE", "JM", "JO", "JP", "KE", "KG", "KH", "KI", "KM", "KN", "KP", "KR", "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", "XK", "YE", "YT", "ZA", "ZM", "ZW" ], "title": "ItAssetsAssetIdGetResponsesContentApplicationJsonSchemaDataActionsStoreOwnAssetAtDeelForLocalDetailsDestinationCountry", "type": "string" }, "ItAssetsAssetIdGetResponsesContentApplicationJsonSchemaDataActionsStoreOwnAssetAtDeelForLocalDetailsMonthlyFee": { "description": "Monthly storage fee charged after the grace period", "properties": { "amount": { "description": "Amount", "format": "decimal", "type": "string" }, "currency": { "$ref": "#/components/schemas/ItAssetsAssetIdGetResponsesContentApplicationJsonSchemaDataActionsStoreOwnAssetAtDeelForLocalDetailsMonthlyFeeCurrency", "description": "Three-letter currency code for the price" } }, "required": [ "amount", "currency" ], "title": "ItAssetsAssetIdGetResponsesContentApplicationJsonSchemaDataActionsStoreOwnAssetAtDeelForLocalDetailsMonthlyFee", "type": "object" }, "ItAssetsAssetIdGetResponsesContentApplicationJsonSchemaDataActionsStoreOwnAssetAtDeelForLocalDetailsMonthlyFeeCurrency": { "description": "Three-letter currency code for the price", "enum": [ "AED", "AFN", "ALL", "AMD", "ANG", "AOA", "ARS", "AUD", "AWG", "AZN", "BAM", "BDT", "BGN", "BHD", "BIF", "BMD", "BOB", "BRL", "BSD", "BTN", "BWP", "BYN", "BZD", "CAD", "CDF", "CHF", "CLP", "CNY", "COP", "CRC", "CUC", "CVE", "CZK", "DJF", "DKK", "DOP", "DZD", "EGP", "ERN", "ETB", "EUR", "FJD", "FKP", "GBP", "GEL", "GHS", "GIP", "GMD", "GNF", "GTQ", "GYD", "HKD", "HNL", "HRK", "HTG", "HUF", "IDR", "ILS", "INR", "IQD", "IRR", "ISK", "JMD", "JOD", "JPY", "KES", "KGS", "KHR", "KMF", "KPW", "KRW", "KWD", "KYD", "KZT", "LAK", "LBP", "LKR", "LRD", "LSL", "LTL", "LYD", "MAD", "MDL", "MGA", "MKD", "MMK", "MNT", "MRU", "MUR", "MVR", "MWK", "MXN", "MYR", "MZN", "NAD", "NGN", "NIO", "NOK", "NPR", "NZD", "OMR", "PAB", "PEN", "PGK", "PHP", "PKR", "PLN", "PYG", "QAR", "RON", "RSD", "RUB", "RWF", "SAR", "SBD", "SCR", "SDG", "SEK", "SGD", "SHP", "SLL", "SOS", "SRD", "SSP", "STD", "SYP", "SZL", "THB", "TJS", "TMT", "TND", "TOP", "TRY", "TTD", "TWD", "TZS", "UAH", "UGX", "USD", "UYU", "UZS", "VEF", "VND", "VUV", "WST", "XAF", "XCD", "XOF", "XPF", "YER", "ZAR", "ZMW", "ZWD" ], "title": "ItAssetsAssetIdGetResponsesContentApplicationJsonSchemaDataActionsStoreOwnAssetAtDeelForLocalDetailsMonthlyFeeCurrency", "type": "string" }, "ItAssetsAssetIdGetResponsesContentApplicationJsonSchemaDataActionsStoreOwnAssetAtDeelForLocalDisabledReasonsItems": { "enum": [ "ARCHIVED", "AT_DEEL_WAREHOUSE", "BEING_REPAIRED", "CONSUMABLE", "CONTROLLED_BY_DEEL", "COUNTRY_NOT_SUPPORTED_FOR_HUB", "COUNTRY_NOT_SUPPORTED_FOR_LOCAL", "DEEL_OWNED_ITEM_WITHOUT_RENTAL_CONTRACT", "DESKTOP_STORAGE", "ENDING_CONTRACT", "HUB_IN_SAME_REGION_AS_LOCAL", "INACTIVE", "INVALID_ITEM_LOCATION", "INVALID_ORGANIZATION_STATUS", "INVALID_STATE", "ITEM_CONDITIONS_TO_UNARCHIVE_NOT_MET", "ITEM_NOT_VISIBLE_FOR_ORGANIZATION", "NON_DEVICE", "NOT_AT_WAREHOUSE", "NOT_AVAILABLE_FOR_REUSE", "NOT_A_RENTAL", "NOT_MANAGEABLE_BY_ORGANIZATION", "NOT_WITH_ASSIGNMENT", "NOT_WITH_USER", "NO_ACTIVE_ADDONS", "NO_ACTIVE_STORAGE_CONTRACT", "NO_LOCATION_FOR_STORAGE", "NO_LOGISTICS_FOR_STORAGE", "NO_VALID_ADDONS", "ONGOING_SERVICE", "OWNED_BY_DEEL", "OWNED_BY_ORGANIZATION", "OWNED_BY_PARTNER_ORGANIZATION", "PARTNER_CHILD_CONTRACT", "PENDING_DEVICE_REFRESH", "RENTAL_CONTRACT_AND_USER_REGION_DO_NOT_MATCH", "TEMPORARILY_UNAVAILABLE", "UNKNOWN", "USER_HAS_NO_COUNTRY", "USER_HAS_NO_SEAT", "WAITING_FOR_CLEARANCE", "WITH_LOANER_ASSIGNMENT", "WITH_NON_COLLECTED_ASSIGNMENT", "WITH_NON_DELIVERED_ASSIGNMENT", "WITH_PENDING_ASSIGNMENT", "WRONG_ASSIGNMENT_STATUS", "WRONG_CONTRACT_STATUS", "WRONG_TERMS_AND_CONDITIONS" ], "title": "ItAssetsAssetIdGetResponsesContentApplicationJsonSchemaDataActionsStoreOwnAssetAtDeelForLocalDisabledReasonsItems", "type": "string" }, "ItAssetsAssetIdGetResponsesContentApplicationJsonSchemaDataActionsStoreOwnAssetAtDeelForLocalStatus": { "description": "Whether the action is currently available for this asset", "enum": [ "DISABLED", "ENABLED", "NOT_APPLICABLE" ], "title": "ItAssetsAssetIdGetResponsesContentApplicationJsonSchemaDataActionsStoreOwnAssetAtDeelForLocalStatus", "type": "string" }, "ItAssetsAssetIdGetResponsesContentApplicationJsonSchemaDataActionsStoreOwnAssetAtOwnLocation": { "description": "Store an organization-owned asset at an organization-owned location", "properties": { "details": { "description": "Action-specific context needed to perform the action. Populated for enabled and\ndisabled actions (so callers can see what a successful attempt would look like);\nnull when the action is not applicable to this asset.", "oneOf": [ { "$ref": "#/components/schemas/ItAssetsAssetIdGetResponsesContentApplicationJsonSchemaDataActionsStoreOwnAssetAtOwnLocationDetails" }, { "type": "null" } ] }, "disabled_reasons": { "description": "Reasons why the action is disabled. Empty when the action is enabled or not applicable", "items": { "$ref": "#/components/schemas/ItAssetsAssetIdGetResponsesContentApplicationJsonSchemaDataActionsStoreOwnAssetAtOwnLocationDisabledReasonsItems" }, "type": "array" }, "status": { "$ref": "#/components/schemas/ItAssetsAssetIdGetResponsesContentApplicationJsonSchemaDataActionsStoreOwnAssetAtOwnLocationStatus", "description": "Whether the action is currently available for this asset" } }, "required": [ "status", "details", "disabled_reasons" ], "title": "ItAssetsAssetIdGetResponsesContentApplicationJsonSchemaDataActionsStoreOwnAssetAtOwnLocation", "type": "object" }, "ItAssetsAssetIdGetResponsesContentApplicationJsonSchemaDataActionsStoreOwnAssetAtOwnLocationDetails": { "description": "Action-specific context needed to perform the action. Populated for enabled and\ndisabled actions (so callers can see what a successful attempt would look like);\nnull when the action is not applicable to this asset.", "properties": { "eligible_countries": { "description": "Countries where the asset can be stored at an organization-owned location", "items": { "$ref": "#/components/schemas/ItAssetsAssetIdGetResponsesContentApplicationJsonSchemaDataActionsStoreOwnAssetAtOwnLocationDetailsEligibleCountriesItems" }, "type": "array" }, "service_cost": { "$ref": "#/components/schemas/ItAssetsAssetIdGetResponsesContentApplicationJsonSchemaDataActionsStoreOwnAssetAtOwnLocationDetailsServiceCost", "description": "Cost charged for the transfer service" } }, "required": [ "service_cost", "eligible_countries" ], "title": "ItAssetsAssetIdGetResponsesContentApplicationJsonSchemaDataActionsStoreOwnAssetAtOwnLocationDetails", "type": "object" }, "ItAssetsAssetIdGetResponsesContentApplicationJsonSchemaDataActionsStoreOwnAssetAtOwnLocationDetailsEligibleCountriesItems": { "enum": [ "AD", "AE", "AF", "AG", "AI", "AL", "AM", "AN", "AO", "AQ", "AR", "AS", "AT", "AU", "AW", "AX", "AZ", "BA", "BB", "BD", "BE", "BF", "BG", "BH", "BI", "BJ", "BL", "BM", "BN", "BO", "BQ", "BR", "BS", "BT", "BV", "BW", "BY", "BZ", "CA", "CC", "CD", "CF", "CG", "CH", "CI", "CK", "CL", "CM", "CN", "CO", "CR", "CU", "CV", "CW", "CX", "CY", "CZ", "DE", "DJ", "DK", "DM", "DO", "DZ", "EC", "EE", "EG", "EH", "ER", "ES", "ET", "FI", "FJ", "FK", "FM", "FO", "FR", "GA", "GB", "GD", "GE", "GF", "GG", "GH", "GI", "GL", "GM", "GN", "GP", "GQ", "GR", "GS", "GT", "GU", "GW", "GY", "HK", "HM", "HN", "HR", "HT", "HU", "IC", "ID", "IE", "IL", "IM", "IN", "IO", "IQ", "IR", "IS", "IT", "JE", "JM", "JO", "JP", "KE", "KG", "KH", "KI", "KM", "KN", "KP", "KR", "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", "XK", "YE", "YT", "ZA", "ZM", "ZW" ], "title": "ItAssetsAssetIdGetResponsesContentApplicationJsonSchemaDataActionsStoreOwnAssetAtOwnLocationDetailsEligibleCountriesItems", "type": "string" }, "ItAssetsAssetIdGetResponsesContentApplicationJsonSchemaDataActionsStoreOwnAssetAtOwnLocationDetailsServiceCost": { "description": "Cost charged for the transfer service", "properties": { "billing_method": { "$ref": "#/components/schemas/ItAssetsAssetIdGetResponsesContentApplicationJsonSchemaDataActionsStoreOwnAssetAtOwnLocationDetailsServiceCostBillingMethod", "description": "How the action is charged. When \"TOKEN\", the fees are covered by an\nadd-on token pool; when \"CURRENCY\", the fees are billed in the currency\nspecified in the \"fees\" field." }, "fees": { "description": "Price charged for the action. Null when billing method is \"TOKEN\"", "oneOf": [ { "$ref": "#/components/schemas/ItAssetsAssetIdGetResponsesContentApplicationJsonSchemaDataActionsStoreOwnAssetAtOwnLocationDetailsServiceCostFees" }, { "type": "null" } ] }, "token_usage": { "description": "Add-on token consumption details. Null when billing method is \"CURRENCY\"", "oneOf": [ { "$ref": "#/components/schemas/ItAssetsAssetIdGetResponsesContentApplicationJsonSchemaDataActionsStoreOwnAssetAtOwnLocationDetailsServiceCostTokenUsage" }, { "type": "null" } ] } }, "required": [ "fees", "token_usage", "billing_method" ], "title": "ItAssetsAssetIdGetResponsesContentApplicationJsonSchemaDataActionsStoreOwnAssetAtOwnLocationDetailsServiceCost", "type": "object" }, "ItAssetsAssetIdGetResponsesContentApplicationJsonSchemaDataActionsStoreOwnAssetAtOwnLocationDetailsServiceCostBillingMethod": { "description": "How the action is charged. When \"TOKEN\", the fees are covered by an\nadd-on token pool; when \"CURRENCY\", the fees are billed in the currency\nspecified in the \"fees\" field.", "enum": [ "CURRENCY", "TOKEN" ], "title": "ItAssetsAssetIdGetResponsesContentApplicationJsonSchemaDataActionsStoreOwnAssetAtOwnLocationDetailsServiceCostBillingMethod", "type": "string" }, "ItAssetsAssetIdGetResponsesContentApplicationJsonSchemaDataActionsStoreOwnAssetAtOwnLocationDetailsServiceCostFees": { "description": "Price charged for the action. Null when billing method is \"TOKEN\"", "properties": { "amount": { "description": "Amount", "format": "decimal", "type": "string" }, "currency": { "$ref": "#/components/schemas/ItAssetsAssetIdGetResponsesContentApplicationJsonSchemaDataActionsStoreOwnAssetAtOwnLocationDetailsServiceCostFeesCurrency", "description": "Three-letter currency code for the price" } }, "required": [ "amount", "currency" ], "title": "ItAssetsAssetIdGetResponsesContentApplicationJsonSchemaDataActionsStoreOwnAssetAtOwnLocationDetailsServiceCostFees", "type": "object" }, "ItAssetsAssetIdGetResponsesContentApplicationJsonSchemaDataActionsStoreOwnAssetAtOwnLocationDetailsServiceCostFeesCurrency": { "description": "Three-letter currency code for the price", "enum": [ "AED", "AFN", "ALL", "AMD", "ANG", "AOA", "ARS", "AUD", "AWG", "AZN", "BAM", "BDT", "BGN", "BHD", "BIF", "BMD", "BOB", "BRL", "BSD", "BTN", "BWP", "BYN", "BZD", "CAD", "CDF", "CHF", "CLP", "CNY", "COP", "CRC", "CUC", "CVE", "CZK", "DJF", "DKK", "DOP", "DZD", "EGP", "ERN", "ETB", "EUR", "FJD", "FKP", "GBP", "GEL", "GHS", "GIP", "GMD", "GNF", "GTQ", "GYD", "HKD", "HNL", "HRK", "HTG", "HUF", "IDR", "ILS", "INR", "IQD", "IRR", "ISK", "JMD", "JOD", "JPY", "KES", "KGS", "KHR", "KMF", "KPW", "KRW", "KWD", "KYD", "KZT", "LAK", "LBP", "LKR", "LRD", "LSL", "LTL", "LYD", "MAD", "MDL", "MGA", "MKD", "MMK", "MNT", "MRU", "MUR", "MVR", "MWK", "MXN", "MYR", "MZN", "NAD", "NGN", "NIO", "NOK", "NPR", "NZD", "OMR", "PAB", "PEN", "PGK", "PHP", "PKR", "PLN", "PYG", "QAR", "RON", "RSD", "RUB", "RWF", "SAR", "SBD", "SCR", "SDG", "SEK", "SGD", "SHP", "SLL", "SOS", "SRD", "SSP", "STD", "SYP", "SZL", "THB", "TJS", "TMT", "TND", "TOP", "TRY", "TTD", "TWD", "TZS", "UAH", "UGX", "USD", "UYU", "UZS", "VEF", "VND", "VUV", "WST", "XAF", "XCD", "XOF", "XPF", "YER", "ZAR", "ZMW", "ZWD" ], "title": "ItAssetsAssetIdGetResponsesContentApplicationJsonSchemaDataActionsStoreOwnAssetAtOwnLocationDetailsServiceCostFeesCurrency", "type": "string" }, "ItAssetsAssetIdGetResponsesContentApplicationJsonSchemaDataActionsStoreOwnAssetAtOwnLocationDetailsServiceCostTokenUsage": { "description": "Add-on token consumption details. Null when billing method is \"CURRENCY\"", "properties": { "addon": { "$ref": "#/components/schemas/ItAssetsAssetIdGetResponsesContentApplicationJsonSchemaDataActionsStoreOwnAssetAtOwnLocationDetailsServiceCostTokenUsageAddon", "description": "The add-on that provides the tokens" }, "cost": { "description": "Number of tokens consumed by the action. Zero when the add-on covers the\nservice without drawing from a token pool", "format": "decimal", "type": "string" }, "tokens_left": { "description": "Number of tokens left in the pool after the action is performed. Null when\nthe add-on covers the service without a token pool", "format": "decimal", "type": [ "string", "null" ] } }, "required": [ "cost", "addon", "tokens_left" ], "title": "ItAssetsAssetIdGetResponsesContentApplicationJsonSchemaDataActionsStoreOwnAssetAtOwnLocationDetailsServiceCostTokenUsage", "type": "object" }, "ItAssetsAssetIdGetResponsesContentApplicationJsonSchemaDataActionsStoreOwnAssetAtOwnLocationDetailsServiceCostTokenUsageAddon": { "description": "The add-on that provides the tokens", "properties": { "id": { "description": "ID of the add-on", "format": "uuid", "type": "string" }, "name": { "description": "Public display name of the add-on", "type": "string" } }, "required": [ "id", "name" ], "title": "ItAssetsAssetIdGetResponsesContentApplicationJsonSchemaDataActionsStoreOwnAssetAtOwnLocationDetailsServiceCostTokenUsageAddon", "type": "object" }, "ItAssetsAssetIdGetResponsesContentApplicationJsonSchemaDataActionsStoreOwnAssetAtOwnLocationDisabledReasonsItems": { "enum": [ "ARCHIVED", "AT_DEEL_WAREHOUSE", "BEING_REPAIRED", "CONSUMABLE", "CONTROLLED_BY_DEEL", "COUNTRY_NOT_SUPPORTED_FOR_HUB", "COUNTRY_NOT_SUPPORTED_FOR_LOCAL", "DEEL_OWNED_ITEM_WITHOUT_RENTAL_CONTRACT", "DESKTOP_STORAGE", "ENDING_CONTRACT", "HUB_IN_SAME_REGION_AS_LOCAL", "INACTIVE", "INVALID_ITEM_LOCATION", "INVALID_ORGANIZATION_STATUS", "INVALID_STATE", "ITEM_CONDITIONS_TO_UNARCHIVE_NOT_MET", "ITEM_NOT_VISIBLE_FOR_ORGANIZATION", "NON_DEVICE", "NOT_AT_WAREHOUSE", "NOT_AVAILABLE_FOR_REUSE", "NOT_A_RENTAL", "NOT_MANAGEABLE_BY_ORGANIZATION", "NOT_WITH_ASSIGNMENT", "NOT_WITH_USER", "NO_ACTIVE_ADDONS", "NO_ACTIVE_STORAGE_CONTRACT", "NO_LOCATION_FOR_STORAGE", "NO_LOGISTICS_FOR_STORAGE", "NO_VALID_ADDONS", "ONGOING_SERVICE", "OWNED_BY_DEEL", "OWNED_BY_ORGANIZATION", "OWNED_BY_PARTNER_ORGANIZATION", "PARTNER_CHILD_CONTRACT", "PENDING_DEVICE_REFRESH", "RENTAL_CONTRACT_AND_USER_REGION_DO_NOT_MATCH", "TEMPORARILY_UNAVAILABLE", "UNKNOWN", "USER_HAS_NO_COUNTRY", "USER_HAS_NO_SEAT", "WAITING_FOR_CLEARANCE", "WITH_LOANER_ASSIGNMENT", "WITH_NON_COLLECTED_ASSIGNMENT", "WITH_NON_DELIVERED_ASSIGNMENT", "WITH_PENDING_ASSIGNMENT", "WRONG_ASSIGNMENT_STATUS", "WRONG_CONTRACT_STATUS", "WRONG_TERMS_AND_CONDITIONS" ], "title": "ItAssetsAssetIdGetResponsesContentApplicationJsonSchemaDataActionsStoreOwnAssetAtOwnLocationDisabledReasonsItems", "type": "string" }, "ItAssetsAssetIdGetResponsesContentApplicationJsonSchemaDataActionsStoreOwnAssetAtOwnLocationStatus": { "description": "Whether the action is currently available for this asset", "enum": [ "DISABLED", "ENABLED", "NOT_APPLICABLE" ], "title": "ItAssetsAssetIdGetResponsesContentApplicationJsonSchemaDataActionsStoreOwnAssetAtOwnLocationStatus", "type": "string" }, "ItAssetsAssetIdGetResponsesContentApplicationJsonSchemaDataActionsStoreRentalAtDeelForLocal": { "description": "Store a Deel-owned rental asset at a Deel local warehouse", "properties": { "details": { "description": "Action-specific context needed to perform the action. Populated for enabled and\ndisabled actions (so callers can see what a successful attempt would look like);\nnull when the action is not applicable to this asset.", "oneOf": [ { "$ref": "#/components/schemas/ItAssetsAssetIdGetResponsesContentApplicationJsonSchemaDataActionsStoreRentalAtDeelForLocalDetails" }, { "type": "null" } ] }, "disabled_reasons": { "description": "Reasons why the action is disabled. Empty when the action is enabled or not applicable", "items": { "$ref": "#/components/schemas/ItAssetsAssetIdGetResponsesContentApplicationJsonSchemaDataActionsStoreRentalAtDeelForLocalDisabledReasonsItems" }, "type": "array" }, "status": { "$ref": "#/components/schemas/ItAssetsAssetIdGetResponsesContentApplicationJsonSchemaDataActionsStoreRentalAtDeelForLocalStatus", "description": "Whether the action is currently available for this asset" } }, "required": [ "status", "details", "disabled_reasons" ], "title": "ItAssetsAssetIdGetResponsesContentApplicationJsonSchemaDataActionsStoreRentalAtDeelForLocal", "type": "object" }, "ItAssetsAssetIdGetResponsesContentApplicationJsonSchemaDataActionsStoreRentalAtDeelForLocalDetails": { "description": "Action-specific context needed to perform the action. Populated for enabled and\ndisabled actions (so callers can see what a successful attempt would look like);\nnull when the action is not applicable to this asset.", "properties": { "activation_cost": { "$ref": "#/components/schemas/ItAssetsAssetIdGetResponsesContentApplicationJsonSchemaDataActionsStoreRentalAtDeelForLocalDetailsActivationCost", "description": "Cost charged to activate local storage" } }, "required": [ "activation_cost" ], "title": "ItAssetsAssetIdGetResponsesContentApplicationJsonSchemaDataActionsStoreRentalAtDeelForLocalDetails", "type": "object" }, "ItAssetsAssetIdGetResponsesContentApplicationJsonSchemaDataActionsStoreRentalAtDeelForLocalDetailsActivationCost": { "description": "Cost charged to activate local storage", "properties": { "billing_method": { "$ref": "#/components/schemas/ItAssetsAssetIdGetResponsesContentApplicationJsonSchemaDataActionsStoreRentalAtDeelForLocalDetailsActivationCostBillingMethod", "description": "How the action is charged. When \"TOKEN\", the fees are covered by an\nadd-on token pool; when \"CURRENCY\", the fees are billed in the currency\nspecified in the \"fees\" field." }, "fees": { "description": "Price charged for the action. Null when billing method is \"TOKEN\"", "oneOf": [ { "$ref": "#/components/schemas/ItAssetsAssetIdGetResponsesContentApplicationJsonSchemaDataActionsStoreRentalAtDeelForLocalDetailsActivationCostFees" }, { "type": "null" } ] }, "token_usage": { "description": "Add-on token consumption details. Null when billing method is \"CURRENCY\"", "oneOf": [ { "$ref": "#/components/schemas/ItAssetsAssetIdGetResponsesContentApplicationJsonSchemaDataActionsStoreRentalAtDeelForLocalDetailsActivationCostTokenUsage" }, { "type": "null" } ] } }, "required": [ "fees", "token_usage", "billing_method" ], "title": "ItAssetsAssetIdGetResponsesContentApplicationJsonSchemaDataActionsStoreRentalAtDeelForLocalDetailsActivationCost", "type": "object" }, "ItAssetsAssetIdGetResponsesContentApplicationJsonSchemaDataActionsStoreRentalAtDeelForLocalDetailsActivationCostBillingMethod": { "description": "How the action is charged. When \"TOKEN\", the fees are covered by an\nadd-on token pool; when \"CURRENCY\", the fees are billed in the currency\nspecified in the \"fees\" field.", "enum": [ "CURRENCY", "TOKEN" ], "title": "ItAssetsAssetIdGetResponsesContentApplicationJsonSchemaDataActionsStoreRentalAtDeelForLocalDetailsActivationCostBillingMethod", "type": "string" }, "ItAssetsAssetIdGetResponsesContentApplicationJsonSchemaDataActionsStoreRentalAtDeelForLocalDetailsActivationCostFees": { "description": "Price charged for the action. Null when billing method is \"TOKEN\"", "properties": { "amount": { "description": "Amount", "format": "decimal", "type": "string" }, "currency": { "$ref": "#/components/schemas/ItAssetsAssetIdGetResponsesContentApplicationJsonSchemaDataActionsStoreRentalAtDeelForLocalDetailsActivationCostFeesCurrency", "description": "Three-letter currency code for the price" } }, "required": [ "amount", "currency" ], "title": "ItAssetsAssetIdGetResponsesContentApplicationJsonSchemaDataActionsStoreRentalAtDeelForLocalDetailsActivationCostFees", "type": "object" }, "ItAssetsAssetIdGetResponsesContentApplicationJsonSchemaDataActionsStoreRentalAtDeelForLocalDetailsActivationCostFeesCurrency": { "description": "Three-letter currency code for the price", "enum": [ "AED", "AFN", "ALL", "AMD", "ANG", "AOA", "ARS", "AUD", "AWG", "AZN", "BAM", "BDT", "BGN", "BHD", "BIF", "BMD", "BOB", "BRL", "BSD", "BTN", "BWP", "BYN", "BZD", "CAD", "CDF", "CHF", "CLP", "CNY", "COP", "CRC", "CUC", "CVE", "CZK", "DJF", "DKK", "DOP", "DZD", "EGP", "ERN", "ETB", "EUR", "FJD", "FKP", "GBP", "GEL", "GHS", "GIP", "GMD", "GNF", "GTQ", "GYD", "HKD", "HNL", "HRK", "HTG", "HUF", "IDR", "ILS", "INR", "IQD", "IRR", "ISK", "JMD", "JOD", "JPY", "KES", "KGS", "KHR", "KMF", "KPW", "KRW", "KWD", "KYD", "KZT", "LAK", "LBP", "LKR", "LRD", "LSL", "LTL", "LYD", "MAD", "MDL", "MGA", "MKD", "MMK", "MNT", "MRU", "MUR", "MVR", "MWK", "MXN", "MYR", "MZN", "NAD", "NGN", "NIO", "NOK", "NPR", "NZD", "OMR", "PAB", "PEN", "PGK", "PHP", "PKR", "PLN", "PYG", "QAR", "RON", "RSD", "RUB", "RWF", "SAR", "SBD", "SCR", "SDG", "SEK", "SGD", "SHP", "SLL", "SOS", "SRD", "SSP", "STD", "SYP", "SZL", "THB", "TJS", "TMT", "TND", "TOP", "TRY", "TTD", "TWD", "TZS", "UAH", "UGX", "USD", "UYU", "UZS", "VEF", "VND", "VUV", "WST", "XAF", "XCD", "XOF", "XPF", "YER", "ZAR", "ZMW", "ZWD" ], "title": "ItAssetsAssetIdGetResponsesContentApplicationJsonSchemaDataActionsStoreRentalAtDeelForLocalDetailsActivationCostFeesCurrency", "type": "string" }, "ItAssetsAssetIdGetResponsesContentApplicationJsonSchemaDataActionsStoreRentalAtDeelForLocalDetailsActivationCostTokenUsage": { "description": "Add-on token consumption details. Null when billing method is \"CURRENCY\"", "properties": { "addon": { "$ref": "#/components/schemas/ItAssetsAssetIdGetResponsesContentApplicationJsonSchemaDataActionsStoreRentalAtDeelForLocalDetailsActivationCostTokenUsageAddon", "description": "The add-on that provides the tokens" }, "cost": { "description": "Number of tokens consumed by the action. Zero when the add-on covers the\nservice without drawing from a token pool", "format": "decimal", "type": "string" }, "tokens_left": { "description": "Number of tokens left in the pool after the action is performed. Null when\nthe add-on covers the service without a token pool", "format": "decimal", "type": [ "string", "null" ] } }, "required": [ "cost", "addon", "tokens_left" ], "title": "ItAssetsAssetIdGetResponsesContentApplicationJsonSchemaDataActionsStoreRentalAtDeelForLocalDetailsActivationCostTokenUsage", "type": "object" }, "ItAssetsAssetIdGetResponsesContentApplicationJsonSchemaDataActionsStoreRentalAtDeelForLocalDetailsActivationCostTokenUsageAddon": { "description": "The add-on that provides the tokens", "properties": { "id": { "description": "ID of the add-on", "format": "uuid", "type": "string" }, "name": { "description": "Public display name of the add-on", "type": "string" } }, "required": [ "id", "name" ], "title": "ItAssetsAssetIdGetResponsesContentApplicationJsonSchemaDataActionsStoreRentalAtDeelForLocalDetailsActivationCostTokenUsageAddon", "type": "object" }, "ItAssetsAssetIdGetResponsesContentApplicationJsonSchemaDataActionsStoreRentalAtDeelForLocalDisabledReasonsItems": { "enum": [ "ARCHIVED", "AT_DEEL_WAREHOUSE", "BEING_REPAIRED", "CONSUMABLE", "CONTROLLED_BY_DEEL", "COUNTRY_NOT_SUPPORTED_FOR_HUB", "COUNTRY_NOT_SUPPORTED_FOR_LOCAL", "DEEL_OWNED_ITEM_WITHOUT_RENTAL_CONTRACT", "DESKTOP_STORAGE", "ENDING_CONTRACT", "HUB_IN_SAME_REGION_AS_LOCAL", "INACTIVE", "INVALID_ITEM_LOCATION", "INVALID_ORGANIZATION_STATUS", "INVALID_STATE", "ITEM_CONDITIONS_TO_UNARCHIVE_NOT_MET", "ITEM_NOT_VISIBLE_FOR_ORGANIZATION", "NON_DEVICE", "NOT_AT_WAREHOUSE", "NOT_AVAILABLE_FOR_REUSE", "NOT_A_RENTAL", "NOT_MANAGEABLE_BY_ORGANIZATION", "NOT_WITH_ASSIGNMENT", "NOT_WITH_USER", "NO_ACTIVE_ADDONS", "NO_ACTIVE_STORAGE_CONTRACT", "NO_LOCATION_FOR_STORAGE", "NO_LOGISTICS_FOR_STORAGE", "NO_VALID_ADDONS", "ONGOING_SERVICE", "OWNED_BY_DEEL", "OWNED_BY_ORGANIZATION", "OWNED_BY_PARTNER_ORGANIZATION", "PARTNER_CHILD_CONTRACT", "PENDING_DEVICE_REFRESH", "RENTAL_CONTRACT_AND_USER_REGION_DO_NOT_MATCH", "TEMPORARILY_UNAVAILABLE", "UNKNOWN", "USER_HAS_NO_COUNTRY", "USER_HAS_NO_SEAT", "WAITING_FOR_CLEARANCE", "WITH_LOANER_ASSIGNMENT", "WITH_NON_COLLECTED_ASSIGNMENT", "WITH_NON_DELIVERED_ASSIGNMENT", "WITH_PENDING_ASSIGNMENT", "WRONG_ASSIGNMENT_STATUS", "WRONG_CONTRACT_STATUS", "WRONG_TERMS_AND_CONDITIONS" ], "title": "ItAssetsAssetIdGetResponsesContentApplicationJsonSchemaDataActionsStoreRentalAtDeelForLocalDisabledReasonsItems", "type": "string" }, "ItAssetsAssetIdGetResponsesContentApplicationJsonSchemaDataActionsStoreRentalAtDeelForLocalStatus": { "description": "Whether the action is currently available for this asset", "enum": [ "DISABLED", "ENABLED", "NOT_APPLICABLE" ], "title": "ItAssetsAssetIdGetResponsesContentApplicationJsonSchemaDataActionsStoreRentalAtDeelForLocalStatus", "type": "string" }, "ItAssetsAssetIdGetResponsesContentApplicationJsonSchemaDataActionsStoreRentalAtDeelForZone1": { "description": "Store a Deel-owned rental asset at a Deel zone-1 warehouse", "properties": { "details": { "description": "Action-specific context needed to perform the action. Populated for enabled and\ndisabled actions (so callers can see what a successful attempt would look like);\nnull when the action is not applicable to this asset.", "oneOf": [ { "$ref": "#/components/schemas/ItAssetsAssetIdGetResponsesContentApplicationJsonSchemaDataActionsStoreRentalAtDeelForZone1Details" }, { "type": "null" } ] }, "disabled_reasons": { "description": "Reasons why the action is disabled. Empty when the action is enabled or not applicable", "items": { "$ref": "#/components/schemas/ItAssetsAssetIdGetResponsesContentApplicationJsonSchemaDataActionsStoreRentalAtDeelForZone1DisabledReasonsItems" }, "type": "array" }, "status": { "$ref": "#/components/schemas/ItAssetsAssetIdGetResponsesContentApplicationJsonSchemaDataActionsStoreRentalAtDeelForZone1Status", "description": "Whether the action is currently available for this asset" } }, "required": [ "status", "details", "disabled_reasons" ], "title": "ItAssetsAssetIdGetResponsesContentApplicationJsonSchemaDataActionsStoreRentalAtDeelForZone1", "type": "object" }, "ItAssetsAssetIdGetResponsesContentApplicationJsonSchemaDataActionsStoreRentalAtDeelForZone1Details": { "description": "Action-specific context needed to perform the action. Populated for enabled and\ndisabled actions (so callers can see what a successful attempt would look like);\nnull when the action is not applicable to this asset.", "properties": { "activation_cost": { "$ref": "#/components/schemas/ItAssetsAssetIdGetResponsesContentApplicationJsonSchemaDataActionsStoreRentalAtDeelForZone1DetailsActivationCost", "description": "Cost charged to activate zone-1 storage" } }, "required": [ "activation_cost" ], "title": "ItAssetsAssetIdGetResponsesContentApplicationJsonSchemaDataActionsStoreRentalAtDeelForZone1Details", "type": "object" }, "ItAssetsAssetIdGetResponsesContentApplicationJsonSchemaDataActionsStoreRentalAtDeelForZone1DetailsActivationCost": { "description": "Cost charged to activate zone-1 storage", "properties": { "billing_method": { "$ref": "#/components/schemas/ItAssetsAssetIdGetResponsesContentApplicationJsonSchemaDataActionsStoreRentalAtDeelForZone1DetailsActivationCostBillingMethod", "description": "How the action is charged. When \"TOKEN\", the fees are covered by an\nadd-on token pool; when \"CURRENCY\", the fees are billed in the currency\nspecified in the \"fees\" field." }, "fees": { "description": "Price charged for the action. Null when billing method is \"TOKEN\"", "oneOf": [ { "$ref": "#/components/schemas/ItAssetsAssetIdGetResponsesContentApplicationJsonSchemaDataActionsStoreRentalAtDeelForZone1DetailsActivationCostFees" }, { "type": "null" } ] }, "token_usage": { "description": "Add-on token consumption details. Null when billing method is \"CURRENCY\"", "oneOf": [ { "$ref": "#/components/schemas/ItAssetsAssetIdGetResponsesContentApplicationJsonSchemaDataActionsStoreRentalAtDeelForZone1DetailsActivationCostTokenUsage" }, { "type": "null" } ] } }, "required": [ "fees", "token_usage", "billing_method" ], "title": "ItAssetsAssetIdGetResponsesContentApplicationJsonSchemaDataActionsStoreRentalAtDeelForZone1DetailsActivationCost", "type": "object" }, "ItAssetsAssetIdGetResponsesContentApplicationJsonSchemaDataActionsStoreRentalAtDeelForZone1DetailsActivationCostBillingMethod": { "description": "How the action is charged. When \"TOKEN\", the fees are covered by an\nadd-on token pool; when \"CURRENCY\", the fees are billed in the currency\nspecified in the \"fees\" field.", "enum": [ "CURRENCY", "TOKEN" ], "title": "ItAssetsAssetIdGetResponsesContentApplicationJsonSchemaDataActionsStoreRentalAtDeelForZone1DetailsActivationCostBillingMethod", "type": "string" }, "ItAssetsAssetIdGetResponsesContentApplicationJsonSchemaDataActionsStoreRentalAtDeelForZone1DetailsActivationCostFees": { "description": "Price charged for the action. Null when billing method is \"TOKEN\"", "properties": { "amount": { "description": "Amount", "format": "decimal", "type": "string" }, "currency": { "$ref": "#/components/schemas/ItAssetsAssetIdGetResponsesContentApplicationJsonSchemaDataActionsStoreRentalAtDeelForZone1DetailsActivationCostFeesCurrency", "description": "Three-letter currency code for the price" } }, "required": [ "amount", "currency" ], "title": "ItAssetsAssetIdGetResponsesContentApplicationJsonSchemaDataActionsStoreRentalAtDeelForZone1DetailsActivationCostFees", "type": "object" }, "ItAssetsAssetIdGetResponsesContentApplicationJsonSchemaDataActionsStoreRentalAtDeelForZone1DetailsActivationCostFeesCurrency": { "description": "Three-letter currency code for the price", "enum": [ "AED", "AFN", "ALL", "AMD", "ANG", "AOA", "ARS", "AUD", "AWG", "AZN", "BAM", "BDT", "BGN", "BHD", "BIF", "BMD", "BOB", "BRL", "BSD", "BTN", "BWP", "BYN", "BZD", "CAD", "CDF", "CHF", "CLP", "CNY", "COP", "CRC", "CUC", "CVE", "CZK", "DJF", "DKK", "DOP", "DZD", "EGP", "ERN", "ETB", "EUR", "FJD", "FKP", "GBP", "GEL", "GHS", "GIP", "GMD", "GNF", "GTQ", "GYD", "HKD", "HNL", "HRK", "HTG", "HUF", "IDR", "ILS", "INR", "IQD", "IRR", "ISK", "JMD", "JOD", "JPY", "KES", "KGS", "KHR", "KMF", "KPW", "KRW", "KWD", "KYD", "KZT", "LAK", "LBP", "LKR", "LRD", "LSL", "LTL", "LYD", "MAD", "MDL", "MGA", "MKD", "MMK", "MNT", "MRU", "MUR", "MVR", "MWK", "MXN", "MYR", "MZN", "NAD", "NGN", "NIO", "NOK", "NPR", "NZD", "OMR", "PAB", "PEN", "PGK", "PHP", "PKR", "PLN", "PYG", "QAR", "RON", "RSD", "RUB", "RWF", "SAR", "SBD", "SCR", "SDG", "SEK", "SGD", "SHP", "SLL", "SOS", "SRD", "SSP", "STD", "SYP", "SZL", "THB", "TJS", "TMT", "TND", "TOP", "TRY", "TTD", "TWD", "TZS", "UAH", "UGX", "USD", "UYU", "UZS", "VEF", "VND", "VUV", "WST", "XAF", "XCD", "XOF", "XPF", "YER", "ZAR", "ZMW", "ZWD" ], "title": "ItAssetsAssetIdGetResponsesContentApplicationJsonSchemaDataActionsStoreRentalAtDeelForZone1DetailsActivationCostFeesCurrency", "type": "string" }, "ItAssetsAssetIdGetResponsesContentApplicationJsonSchemaDataActionsStoreRentalAtDeelForZone1DetailsActivationCostTokenUsage": { "description": "Add-on token consumption details. Null when billing method is \"CURRENCY\"", "properties": { "addon": { "$ref": "#/components/schemas/ItAssetsAssetIdGetResponsesContentApplicationJsonSchemaDataActionsStoreRentalAtDeelForZone1DetailsActivationCostTokenUsageAddon", "description": "The add-on that provides the tokens" }, "cost": { "description": "Number of tokens consumed by the action. Zero when the add-on covers the\nservice without drawing from a token pool", "format": "decimal", "type": "string" }, "tokens_left": { "description": "Number of tokens left in the pool after the action is performed. Null when\nthe add-on covers the service without a token pool", "format": "decimal", "type": [ "string", "null" ] } }, "required": [ "cost", "addon", "tokens_left" ], "title": "ItAssetsAssetIdGetResponsesContentApplicationJsonSchemaDataActionsStoreRentalAtDeelForZone1DetailsActivationCostTokenUsage", "type": "object" }, "ItAssetsAssetIdGetResponsesContentApplicationJsonSchemaDataActionsStoreRentalAtDeelForZone1DetailsActivationCostTokenUsageAddon": { "description": "The add-on that provides the tokens", "properties": { "id": { "description": "ID of the add-on", "format": "uuid", "type": "string" }, "name": { "description": "Public display name of the add-on", "type": "string" } }, "required": [ "id", "name" ], "title": "ItAssetsAssetIdGetResponsesContentApplicationJsonSchemaDataActionsStoreRentalAtDeelForZone1DetailsActivationCostTokenUsageAddon", "type": "object" }, "ItAssetsAssetIdGetResponsesContentApplicationJsonSchemaDataActionsStoreRentalAtDeelForZone1DisabledReasonsItems": { "enum": [ "ARCHIVED", "AT_DEEL_WAREHOUSE", "BEING_REPAIRED", "CONSUMABLE", "CONTROLLED_BY_DEEL", "COUNTRY_NOT_SUPPORTED_FOR_HUB", "COUNTRY_NOT_SUPPORTED_FOR_LOCAL", "DEEL_OWNED_ITEM_WITHOUT_RENTAL_CONTRACT", "DESKTOP_STORAGE", "ENDING_CONTRACT", "HUB_IN_SAME_REGION_AS_LOCAL", "INACTIVE", "INVALID_ITEM_LOCATION", "INVALID_ORGANIZATION_STATUS", "INVALID_STATE", "ITEM_CONDITIONS_TO_UNARCHIVE_NOT_MET", "ITEM_NOT_VISIBLE_FOR_ORGANIZATION", "NON_DEVICE", "NOT_AT_WAREHOUSE", "NOT_AVAILABLE_FOR_REUSE", "NOT_A_RENTAL", "NOT_MANAGEABLE_BY_ORGANIZATION", "NOT_WITH_ASSIGNMENT", "NOT_WITH_USER", "NO_ACTIVE_ADDONS", "NO_ACTIVE_STORAGE_CONTRACT", "NO_LOCATION_FOR_STORAGE", "NO_LOGISTICS_FOR_STORAGE", "NO_VALID_ADDONS", "ONGOING_SERVICE", "OWNED_BY_DEEL", "OWNED_BY_ORGANIZATION", "OWNED_BY_PARTNER_ORGANIZATION", "PARTNER_CHILD_CONTRACT", "PENDING_DEVICE_REFRESH", "RENTAL_CONTRACT_AND_USER_REGION_DO_NOT_MATCH", "TEMPORARILY_UNAVAILABLE", "UNKNOWN", "USER_HAS_NO_COUNTRY", "USER_HAS_NO_SEAT", "WAITING_FOR_CLEARANCE", "WITH_LOANER_ASSIGNMENT", "WITH_NON_COLLECTED_ASSIGNMENT", "WITH_NON_DELIVERED_ASSIGNMENT", "WITH_PENDING_ASSIGNMENT", "WRONG_ASSIGNMENT_STATUS", "WRONG_CONTRACT_STATUS", "WRONG_TERMS_AND_CONDITIONS" ], "title": "ItAssetsAssetIdGetResponsesContentApplicationJsonSchemaDataActionsStoreRentalAtDeelForZone1DisabledReasonsItems", "type": "string" }, "ItAssetsAssetIdGetResponsesContentApplicationJsonSchemaDataActionsStoreRentalAtDeelForZone1Status": { "description": "Whether the action is currently available for this asset", "enum": [ "DISABLED", "ENABLED", "NOT_APPLICABLE" ], "title": "ItAssetsAssetIdGetResponsesContentApplicationJsonSchemaDataActionsStoreRentalAtDeelForZone1Status", "type": "string" }, "ItAssetsAssetIdGetResponsesContentApplicationJsonSchemaDataActionsTransferOwnAsset": { "description": "Transfer an organization-owned asset to another user", "properties": { "details": { "description": "Action-specific context needed to perform the action. Populated for enabled and\ndisabled actions (so callers can see what a successful attempt would look like);\nnull when the action is not applicable to this asset.", "oneOf": [ { "$ref": "#/components/schemas/ItAssetsAssetIdGetResponsesContentApplicationJsonSchemaDataActionsTransferOwnAssetDetails" }, { "type": "null" } ] }, "disabled_reasons": { "description": "Reasons why the action is disabled. Empty when the action is enabled or not applicable", "items": { "$ref": "#/components/schemas/ItAssetsAssetIdGetResponsesContentApplicationJsonSchemaDataActionsTransferOwnAssetDisabledReasonsItems" }, "type": "array" }, "status": { "$ref": "#/components/schemas/ItAssetsAssetIdGetResponsesContentApplicationJsonSchemaDataActionsTransferOwnAssetStatus", "description": "Whether the action is currently available for this asset" } }, "required": [ "status", "details", "disabled_reasons" ], "title": "ItAssetsAssetIdGetResponsesContentApplicationJsonSchemaDataActionsTransferOwnAsset", "type": "object" }, "ItAssetsAssetIdGetResponsesContentApplicationJsonSchemaDataActionsTransferOwnAssetDetails": { "description": "Action-specific context needed to perform the action. Populated for enabled and\ndisabled actions (so callers can see what a successful attempt would look like);\nnull when the action is not applicable to this asset.", "properties": { "eligible_countries": { "description": "Countries the asset can be transferred to", "items": { "$ref": "#/components/schemas/ItAssetsAssetIdGetResponsesContentApplicationJsonSchemaDataActionsTransferOwnAssetDetailsEligibleCountriesItems" }, "type": "array" }, "transfer_cost": { "$ref": "#/components/schemas/ItAssetsAssetIdGetResponsesContentApplicationJsonSchemaDataActionsTransferOwnAssetDetailsTransferCost", "description": "Cost charged for the transfer service" } }, "required": [ "transfer_cost", "eligible_countries" ], "title": "ItAssetsAssetIdGetResponsesContentApplicationJsonSchemaDataActionsTransferOwnAssetDetails", "type": "object" }, "ItAssetsAssetIdGetResponsesContentApplicationJsonSchemaDataActionsTransferOwnAssetDetailsEligibleCountriesItems": { "enum": [ "AD", "AE", "AF", "AG", "AI", "AL", "AM", "AN", "AO", "AQ", "AR", "AS", "AT", "AU", "AW", "AX", "AZ", "BA", "BB", "BD", "BE", "BF", "BG", "BH", "BI", "BJ", "BL", "BM", "BN", "BO", "BQ", "BR", "BS", "BT", "BV", "BW", "BY", "BZ", "CA", "CC", "CD", "CF", "CG", "CH", "CI", "CK", "CL", "CM", "CN", "CO", "CR", "CU", "CV", "CW", "CX", "CY", "CZ", "DE", "DJ", "DK", "DM", "DO", "DZ", "EC", "EE", "EG", "EH", "ER", "ES", "ET", "FI", "FJ", "FK", "FM", "FO", "FR", "GA", "GB", "GD", "GE", "GF", "GG", "GH", "GI", "GL", "GM", "GN", "GP", "GQ", "GR", "GS", "GT", "GU", "GW", "GY", "HK", "HM", "HN", "HR", "HT", "HU", "IC", "ID", "IE", "IL", "IM", "IN", "IO", "IQ", "IR", "IS", "IT", "JE", "JM", "JO", "JP", "KE", "KG", "KH", "KI", "KM", "KN", "KP", "KR", "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", "XK", "YE", "YT", "ZA", "ZM", "ZW" ], "title": "ItAssetsAssetIdGetResponsesContentApplicationJsonSchemaDataActionsTransferOwnAssetDetailsEligibleCountriesItems", "type": "string" }, "ItAssetsAssetIdGetResponsesContentApplicationJsonSchemaDataActionsTransferOwnAssetDetailsTransferCost": { "description": "Cost charged for the transfer service", "properties": { "billing_method": { "$ref": "#/components/schemas/ItAssetsAssetIdGetResponsesContentApplicationJsonSchemaDataActionsTransferOwnAssetDetailsTransferCostBillingMethod", "description": "How the action is charged. When \"TOKEN\", the fees are covered by an\nadd-on token pool; when \"CURRENCY\", the fees are billed in the currency\nspecified in the \"fees\" field." }, "fees": { "description": "Price charged for the action. Null when billing method is \"TOKEN\"", "oneOf": [ { "$ref": "#/components/schemas/ItAssetsAssetIdGetResponsesContentApplicationJsonSchemaDataActionsTransferOwnAssetDetailsTransferCostFees" }, { "type": "null" } ] }, "token_usage": { "description": "Add-on token consumption details. Null when billing method is \"CURRENCY\"", "oneOf": [ { "$ref": "#/components/schemas/ItAssetsAssetIdGetResponsesContentApplicationJsonSchemaDataActionsTransferOwnAssetDetailsTransferCostTokenUsage" }, { "type": "null" } ] } }, "required": [ "fees", "token_usage", "billing_method" ], "title": "ItAssetsAssetIdGetResponsesContentApplicationJsonSchemaDataActionsTransferOwnAssetDetailsTransferCost", "type": "object" }, "ItAssetsAssetIdGetResponsesContentApplicationJsonSchemaDataActionsTransferOwnAssetDetailsTransferCostBillingMethod": { "description": "How the action is charged. When \"TOKEN\", the fees are covered by an\nadd-on token pool; when \"CURRENCY\", the fees are billed in the currency\nspecified in the \"fees\" field.", "enum": [ "CURRENCY", "TOKEN" ], "title": "ItAssetsAssetIdGetResponsesContentApplicationJsonSchemaDataActionsTransferOwnAssetDetailsTransferCostBillingMethod", "type": "string" }, "ItAssetsAssetIdGetResponsesContentApplicationJsonSchemaDataActionsTransferOwnAssetDetailsTransferCostFees": { "description": "Price charged for the action. Null when billing method is \"TOKEN\"", "properties": { "amount": { "description": "Amount", "format": "decimal", "type": "string" }, "currency": { "$ref": "#/components/schemas/ItAssetsAssetIdGetResponsesContentApplicationJsonSchemaDataActionsTransferOwnAssetDetailsTransferCostFeesCurrency", "description": "Three-letter currency code for the price" } }, "required": [ "amount", "currency" ], "title": "ItAssetsAssetIdGetResponsesContentApplicationJsonSchemaDataActionsTransferOwnAssetDetailsTransferCostFees", "type": "object" }, "ItAssetsAssetIdGetResponsesContentApplicationJsonSchemaDataActionsTransferOwnAssetDetailsTransferCostFeesCurrency": { "description": "Three-letter currency code for the price", "enum": [ "AED", "AFN", "ALL", "AMD", "ANG", "AOA", "ARS", "AUD", "AWG", "AZN", "BAM", "BDT", "BGN", "BHD", "BIF", "BMD", "BOB", "BRL", "BSD", "BTN", "BWP", "BYN", "BZD", "CAD", "CDF", "CHF", "CLP", "CNY", "COP", "CRC", "CUC", "CVE", "CZK", "DJF", "DKK", "DOP", "DZD", "EGP", "ERN", "ETB", "EUR", "FJD", "FKP", "GBP", "GEL", "GHS", "GIP", "GMD", "GNF", "GTQ", "GYD", "HKD", "HNL", "HRK", "HTG", "HUF", "IDR", "ILS", "INR", "IQD", "IRR", "ISK", "JMD", "JOD", "JPY", "KES", "KGS", "KHR", "KMF", "KPW", "KRW", "KWD", "KYD", "KZT", "LAK", "LBP", "LKR", "LRD", "LSL", "LTL", "LYD", "MAD", "MDL", "MGA", "MKD", "MMK", "MNT", "MRU", "MUR", "MVR", "MWK", "MXN", "MYR", "MZN", "NAD", "NGN", "NIO", "NOK", "NPR", "NZD", "OMR", "PAB", "PEN", "PGK", "PHP", "PKR", "PLN", "PYG", "QAR", "RON", "RSD", "RUB", "RWF", "SAR", "SBD", "SCR", "SDG", "SEK", "SGD", "SHP", "SLL", "SOS", "SRD", "SSP", "STD", "SYP", "SZL", "THB", "TJS", "TMT", "TND", "TOP", "TRY", "TTD", "TWD", "TZS", "UAH", "UGX", "USD", "UYU", "UZS", "VEF", "VND", "VUV", "WST", "XAF", "XCD", "XOF", "XPF", "YER", "ZAR", "ZMW", "ZWD" ], "title": "ItAssetsAssetIdGetResponsesContentApplicationJsonSchemaDataActionsTransferOwnAssetDetailsTransferCostFeesCurrency", "type": "string" }, "ItAssetsAssetIdGetResponsesContentApplicationJsonSchemaDataActionsTransferOwnAssetDetailsTransferCostTokenUsage": { "description": "Add-on token consumption details. Null when billing method is \"CURRENCY\"", "properties": { "addon": { "$ref": "#/components/schemas/ItAssetsAssetIdGetResponsesContentApplicationJsonSchemaDataActionsTransferOwnAssetDetailsTransferCostTokenUsageAddon", "description": "The add-on that provides the tokens" }, "cost": { "description": "Number of tokens consumed by the action. Zero when the add-on covers the\nservice without drawing from a token pool", "format": "decimal", "type": "string" }, "tokens_left": { "description": "Number of tokens left in the pool after the action is performed. Null when\nthe add-on covers the service without a token pool", "format": "decimal", "type": [ "string", "null" ] } }, "required": [ "cost", "addon", "tokens_left" ], "title": "ItAssetsAssetIdGetResponsesContentApplicationJsonSchemaDataActionsTransferOwnAssetDetailsTransferCostTokenUsage", "type": "object" }, "ItAssetsAssetIdGetResponsesContentApplicationJsonSchemaDataActionsTransferOwnAssetDetailsTransferCostTokenUsageAddon": { "description": "The add-on that provides the tokens", "properties": { "id": { "description": "ID of the add-on", "format": "uuid", "type": "string" }, "name": { "description": "Public display name of the add-on", "type": "string" } }, "required": [ "id", "name" ], "title": "ItAssetsAssetIdGetResponsesContentApplicationJsonSchemaDataActionsTransferOwnAssetDetailsTransferCostTokenUsageAddon", "type": "object" }, "ItAssetsAssetIdGetResponsesContentApplicationJsonSchemaDataActionsTransferOwnAssetDisabledReasonsItems": { "enum": [ "ARCHIVED", "AT_DEEL_WAREHOUSE", "BEING_REPAIRED", "CONSUMABLE", "CONTROLLED_BY_DEEL", "COUNTRY_NOT_SUPPORTED_FOR_HUB", "COUNTRY_NOT_SUPPORTED_FOR_LOCAL", "DEEL_OWNED_ITEM_WITHOUT_RENTAL_CONTRACT", "DESKTOP_STORAGE", "ENDING_CONTRACT", "HUB_IN_SAME_REGION_AS_LOCAL", "INACTIVE", "INVALID_ITEM_LOCATION", "INVALID_ORGANIZATION_STATUS", "INVALID_STATE", "ITEM_CONDITIONS_TO_UNARCHIVE_NOT_MET", "ITEM_NOT_VISIBLE_FOR_ORGANIZATION", "NON_DEVICE", "NOT_AT_WAREHOUSE", "NOT_AVAILABLE_FOR_REUSE", "NOT_A_RENTAL", "NOT_MANAGEABLE_BY_ORGANIZATION", "NOT_WITH_ASSIGNMENT", "NOT_WITH_USER", "NO_ACTIVE_ADDONS", "NO_ACTIVE_STORAGE_CONTRACT", "NO_LOCATION_FOR_STORAGE", "NO_LOGISTICS_FOR_STORAGE", "NO_VALID_ADDONS", "ONGOING_SERVICE", "OWNED_BY_DEEL", "OWNED_BY_ORGANIZATION", "OWNED_BY_PARTNER_ORGANIZATION", "PARTNER_CHILD_CONTRACT", "PENDING_DEVICE_REFRESH", "RENTAL_CONTRACT_AND_USER_REGION_DO_NOT_MATCH", "TEMPORARILY_UNAVAILABLE", "UNKNOWN", "USER_HAS_NO_COUNTRY", "USER_HAS_NO_SEAT", "WAITING_FOR_CLEARANCE", "WITH_LOANER_ASSIGNMENT", "WITH_NON_COLLECTED_ASSIGNMENT", "WITH_NON_DELIVERED_ASSIGNMENT", "WITH_PENDING_ASSIGNMENT", "WRONG_ASSIGNMENT_STATUS", "WRONG_CONTRACT_STATUS", "WRONG_TERMS_AND_CONDITIONS" ], "title": "ItAssetsAssetIdGetResponsesContentApplicationJsonSchemaDataActionsTransferOwnAssetDisabledReasonsItems", "type": "string" }, "ItAssetsAssetIdGetResponsesContentApplicationJsonSchemaDataActionsTransferOwnAssetStatus": { "description": "Whether the action is currently available for this asset", "enum": [ "DISABLED", "ENABLED", "NOT_APPLICABLE" ], "title": "ItAssetsAssetIdGetResponsesContentApplicationJsonSchemaDataActionsTransferOwnAssetStatus", "type": "string" }, "ItAssetsAssetIdGetResponsesContentApplicationJsonSchemaDataActionsTransferRental": { "description": "Transfer a Deel-owned rental asset to another user", "properties": { "details": { "description": "Action-specific context needed to perform the action. Populated for enabled and\ndisabled actions (so callers can see what a successful attempt would look like);\nnull when the action is not applicable to this asset.", "oneOf": [ { "$ref": "#/components/schemas/ItAssetsAssetIdGetResponsesContentApplicationJsonSchemaDataActionsTransferRentalDetails" }, { "type": "null" } ] }, "disabled_reasons": { "description": "Reasons why the action is disabled. Empty when the action is enabled or not applicable", "items": { "$ref": "#/components/schemas/ItAssetsAssetIdGetResponsesContentApplicationJsonSchemaDataActionsTransferRentalDisabledReasonsItems" }, "type": "array" }, "status": { "$ref": "#/components/schemas/ItAssetsAssetIdGetResponsesContentApplicationJsonSchemaDataActionsTransferRentalStatus", "description": "Whether the action is currently available for this asset" } }, "required": [ "status", "details", "disabled_reasons" ], "title": "ItAssetsAssetIdGetResponsesContentApplicationJsonSchemaDataActionsTransferRental", "type": "object" }, "ItAssetsAssetIdGetResponsesContentApplicationJsonSchemaDataActionsTransferRentalDetails": { "description": "Action-specific context needed to perform the action. Populated for enabled and\ndisabled actions (so callers can see what a successful attempt would look like);\nnull when the action is not applicable to this asset.", "properties": { "eligible_countries": { "description": "Countries the asset can be transferred to", "items": { "$ref": "#/components/schemas/ItAssetsAssetIdGetResponsesContentApplicationJsonSchemaDataActionsTransferRentalDetailsEligibleCountriesItems" }, "type": "array" }, "transfer_cost": { "$ref": "#/components/schemas/ItAssetsAssetIdGetResponsesContentApplicationJsonSchemaDataActionsTransferRentalDetailsTransferCost", "description": "Cost charged for the transfer service" } }, "required": [ "transfer_cost", "eligible_countries" ], "title": "ItAssetsAssetIdGetResponsesContentApplicationJsonSchemaDataActionsTransferRentalDetails", "type": "object" }, "ItAssetsAssetIdGetResponsesContentApplicationJsonSchemaDataActionsTransferRentalDetailsEligibleCountriesItems": { "enum": [ "AD", "AE", "AF", "AG", "AI", "AL", "AM", "AN", "AO", "AQ", "AR", "AS", "AT", "AU", "AW", "AX", "AZ", "BA", "BB", "BD", "BE", "BF", "BG", "BH", "BI", "BJ", "BL", "BM", "BN", "BO", "BQ", "BR", "BS", "BT", "BV", "BW", "BY", "BZ", "CA", "CC", "CD", "CF", "CG", "CH", "CI", "CK", "CL", "CM", "CN", "CO", "CR", "CU", "CV", "CW", "CX", "CY", "CZ", "DE", "DJ", "DK", "DM", "DO", "DZ", "EC", "EE", "EG", "EH", "ER", "ES", "ET", "FI", "FJ", "FK", "FM", "FO", "FR", "GA", "GB", "GD", "GE", "GF", "GG", "GH", "GI", "GL", "GM", "GN", "GP", "GQ", "GR", "GS", "GT", "GU", "GW", "GY", "HK", "HM", "HN", "HR", "HT", "HU", "IC", "ID", "IE", "IL", "IM", "IN", "IO", "IQ", "IR", "IS", "IT", "JE", "JM", "JO", "JP", "KE", "KG", "KH", "KI", "KM", "KN", "KP", "KR", "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", "XK", "YE", "YT", "ZA", "ZM", "ZW" ], "title": "ItAssetsAssetIdGetResponsesContentApplicationJsonSchemaDataActionsTransferRentalDetailsEligibleCountriesItems", "type": "string" }, "ItAssetsAssetIdGetResponsesContentApplicationJsonSchemaDataActionsTransferRentalDetailsTransferCost": { "description": "Cost charged for the transfer service", "properties": { "billing_method": { "$ref": "#/components/schemas/ItAssetsAssetIdGetResponsesContentApplicationJsonSchemaDataActionsTransferRentalDetailsTransferCostBillingMethod", "description": "How the action is charged. When \"TOKEN\", the fees are covered by an\nadd-on token pool; when \"CURRENCY\", the fees are billed in the currency\nspecified in the \"fees\" field." }, "fees": { "description": "Price charged for the action. Null when billing method is \"TOKEN\"", "oneOf": [ { "$ref": "#/components/schemas/ItAssetsAssetIdGetResponsesContentApplicationJsonSchemaDataActionsTransferRentalDetailsTransferCostFees" }, { "type": "null" } ] }, "token_usage": { "description": "Add-on token consumption details. Null when billing method is \"CURRENCY\"", "oneOf": [ { "$ref": "#/components/schemas/ItAssetsAssetIdGetResponsesContentApplicationJsonSchemaDataActionsTransferRentalDetailsTransferCostTokenUsage" }, { "type": "null" } ] } }, "required": [ "fees", "token_usage", "billing_method" ], "title": "ItAssetsAssetIdGetResponsesContentApplicationJsonSchemaDataActionsTransferRentalDetailsTransferCost", "type": "object" }, "ItAssetsAssetIdGetResponsesContentApplicationJsonSchemaDataActionsTransferRentalDetailsTransferCostBillingMethod": { "description": "How the action is charged. When \"TOKEN\", the fees are covered by an\nadd-on token pool; when \"CURRENCY\", the fees are billed in the currency\nspecified in the \"fees\" field.", "enum": [ "CURRENCY", "TOKEN" ], "title": "ItAssetsAssetIdGetResponsesContentApplicationJsonSchemaDataActionsTransferRentalDetailsTransferCostBillingMethod", "type": "string" }, "ItAssetsAssetIdGetResponsesContentApplicationJsonSchemaDataActionsTransferRentalDetailsTransferCostFees": { "description": "Price charged for the action. Null when billing method is \"TOKEN\"", "properties": { "amount": { "description": "Amount", "format": "decimal", "type": "string" }, "currency": { "$ref": "#/components/schemas/ItAssetsAssetIdGetResponsesContentApplicationJsonSchemaDataActionsTransferRentalDetailsTransferCostFeesCurrency", "description": "Three-letter currency code for the price" } }, "required": [ "amount", "currency" ], "title": "ItAssetsAssetIdGetResponsesContentApplicationJsonSchemaDataActionsTransferRentalDetailsTransferCostFees", "type": "object" }, "ItAssetsAssetIdGetResponsesContentApplicationJsonSchemaDataActionsTransferRentalDetailsTransferCostFeesCurrency": { "description": "Three-letter currency code for the price", "enum": [ "AED", "AFN", "ALL", "AMD", "ANG", "AOA", "ARS", "AUD", "AWG", "AZN", "BAM", "BDT", "BGN", "BHD", "BIF", "BMD", "BOB", "BRL", "BSD", "BTN", "BWP", "BYN", "BZD", "CAD", "CDF", "CHF", "CLP", "CNY", "COP", "CRC", "CUC", "CVE", "CZK", "DJF", "DKK", "DOP", "DZD", "EGP", "ERN", "ETB", "EUR", "FJD", "FKP", "GBP", "GEL", "GHS", "GIP", "GMD", "GNF", "GTQ", "GYD", "HKD", "HNL", "HRK", "HTG", "HUF", "IDR", "ILS", "INR", "IQD", "IRR", "ISK", "JMD", "JOD", "JPY", "KES", "KGS", "KHR", "KMF", "KPW", "KRW", "KWD", "KYD", "KZT", "LAK", "LBP", "LKR", "LRD", "LSL", "LTL", "LYD", "MAD", "MDL", "MGA", "MKD", "MMK", "MNT", "MRU", "MUR", "MVR", "MWK", "MXN", "MYR", "MZN", "NAD", "NGN", "NIO", "NOK", "NPR", "NZD", "OMR", "PAB", "PEN", "PGK", "PHP", "PKR", "PLN", "PYG", "QAR", "RON", "RSD", "RUB", "RWF", "SAR", "SBD", "SCR", "SDG", "SEK", "SGD", "SHP", "SLL", "SOS", "SRD", "SSP", "STD", "SYP", "SZL", "THB", "TJS", "TMT", "TND", "TOP", "TRY", "TTD", "TWD", "TZS", "UAH", "UGX", "USD", "UYU", "UZS", "VEF", "VND", "VUV", "WST", "XAF", "XCD", "XOF", "XPF", "YER", "ZAR", "ZMW", "ZWD" ], "title": "ItAssetsAssetIdGetResponsesContentApplicationJsonSchemaDataActionsTransferRentalDetailsTransferCostFeesCurrency", "type": "string" }, "ItAssetsAssetIdGetResponsesContentApplicationJsonSchemaDataActionsTransferRentalDetailsTransferCostTokenUsage": { "description": "Add-on token consumption details. Null when billing method is \"CURRENCY\"", "properties": { "addon": { "$ref": "#/components/schemas/ItAssetsAssetIdGetResponsesContentApplicationJsonSchemaDataActionsTransferRentalDetailsTransferCostTokenUsageAddon", "description": "The add-on that provides the tokens" }, "cost": { "description": "Number of tokens consumed by the action. Zero when the add-on covers the\nservice without drawing from a token pool", "format": "decimal", "type": "string" }, "tokens_left": { "description": "Number of tokens left in the pool after the action is performed. Null when\nthe add-on covers the service without a token pool", "format": "decimal", "type": [ "string", "null" ] } }, "required": [ "cost", "addon", "tokens_left" ], "title": "ItAssetsAssetIdGetResponsesContentApplicationJsonSchemaDataActionsTransferRentalDetailsTransferCostTokenUsage", "type": "object" }, "ItAssetsAssetIdGetResponsesContentApplicationJsonSchemaDataActionsTransferRentalDetailsTransferCostTokenUsageAddon": { "description": "The add-on that provides the tokens", "properties": { "id": { "description": "ID of the add-on", "format": "uuid", "type": "string" }, "name": { "description": "Public display name of the add-on", "type": "string" } }, "required": [ "id", "name" ], "title": "ItAssetsAssetIdGetResponsesContentApplicationJsonSchemaDataActionsTransferRentalDetailsTransferCostTokenUsageAddon", "type": "object" }, "ItAssetsAssetIdGetResponsesContentApplicationJsonSchemaDataActionsTransferRentalDisabledReasonsItems": { "enum": [ "ARCHIVED", "AT_DEEL_WAREHOUSE", "BEING_REPAIRED", "CONSUMABLE", "CONTROLLED_BY_DEEL", "COUNTRY_NOT_SUPPORTED_FOR_HUB", "COUNTRY_NOT_SUPPORTED_FOR_LOCAL", "DEEL_OWNED_ITEM_WITHOUT_RENTAL_CONTRACT", "DESKTOP_STORAGE", "ENDING_CONTRACT", "HUB_IN_SAME_REGION_AS_LOCAL", "INACTIVE", "INVALID_ITEM_LOCATION", "INVALID_ORGANIZATION_STATUS", "INVALID_STATE", "ITEM_CONDITIONS_TO_UNARCHIVE_NOT_MET", "ITEM_NOT_VISIBLE_FOR_ORGANIZATION", "NON_DEVICE", "NOT_AT_WAREHOUSE", "NOT_AVAILABLE_FOR_REUSE", "NOT_A_RENTAL", "NOT_MANAGEABLE_BY_ORGANIZATION", "NOT_WITH_ASSIGNMENT", "NOT_WITH_USER", "NO_ACTIVE_ADDONS", "NO_ACTIVE_STORAGE_CONTRACT", "NO_LOCATION_FOR_STORAGE", "NO_LOGISTICS_FOR_STORAGE", "NO_VALID_ADDONS", "ONGOING_SERVICE", "OWNED_BY_DEEL", "OWNED_BY_ORGANIZATION", "OWNED_BY_PARTNER_ORGANIZATION", "PARTNER_CHILD_CONTRACT", "PENDING_DEVICE_REFRESH", "RENTAL_CONTRACT_AND_USER_REGION_DO_NOT_MATCH", "TEMPORARILY_UNAVAILABLE", "UNKNOWN", "USER_HAS_NO_COUNTRY", "USER_HAS_NO_SEAT", "WAITING_FOR_CLEARANCE", "WITH_LOANER_ASSIGNMENT", "WITH_NON_COLLECTED_ASSIGNMENT", "WITH_NON_DELIVERED_ASSIGNMENT", "WITH_PENDING_ASSIGNMENT", "WRONG_ASSIGNMENT_STATUS", "WRONG_CONTRACT_STATUS", "WRONG_TERMS_AND_CONDITIONS" ], "title": "ItAssetsAssetIdGetResponsesContentApplicationJsonSchemaDataActionsTransferRentalDisabledReasonsItems", "type": "string" }, "ItAssetsAssetIdGetResponsesContentApplicationJsonSchemaDataActionsTransferRentalStatus": { "description": "Whether the action is currently available for this asset", "enum": [ "DISABLED", "ENABLED", "NOT_APPLICABLE" ], "title": "ItAssetsAssetIdGetResponsesContentApplicationJsonSchemaDataActionsTransferRentalStatus", "type": "string" }, "ItAssetsAssetIdGetResponsesContentApplicationJsonSchemaDataActionsUnarchiveOwnAsset": { "description": "Unarchive a previously archived organization-owned asset", "properties": { "disabled_reasons": { "description": "Reasons why the action is disabled. Empty when the action is enabled or not applicable", "items": { "$ref": "#/components/schemas/ItAssetsAssetIdGetResponsesContentApplicationJsonSchemaDataActionsUnarchiveOwnAssetDisabledReasonsItems" }, "type": "array" }, "status": { "$ref": "#/components/schemas/ItAssetsAssetIdGetResponsesContentApplicationJsonSchemaDataActionsUnarchiveOwnAssetStatus", "description": "Whether the action is currently available for this asset" } }, "required": [ "status", "disabled_reasons" ], "title": "ItAssetsAssetIdGetResponsesContentApplicationJsonSchemaDataActionsUnarchiveOwnAsset", "type": "object" }, "ItAssetsAssetIdGetResponsesContentApplicationJsonSchemaDataActionsUnarchiveOwnAssetDisabledReasonsItems": { "enum": [ "ARCHIVED", "AT_DEEL_WAREHOUSE", "BEING_REPAIRED", "CONSUMABLE", "CONTROLLED_BY_DEEL", "COUNTRY_NOT_SUPPORTED_FOR_HUB", "COUNTRY_NOT_SUPPORTED_FOR_LOCAL", "DEEL_OWNED_ITEM_WITHOUT_RENTAL_CONTRACT", "DESKTOP_STORAGE", "ENDING_CONTRACT", "HUB_IN_SAME_REGION_AS_LOCAL", "INACTIVE", "INVALID_ITEM_LOCATION", "INVALID_ORGANIZATION_STATUS", "INVALID_STATE", "ITEM_CONDITIONS_TO_UNARCHIVE_NOT_MET", "ITEM_NOT_VISIBLE_FOR_ORGANIZATION", "NON_DEVICE", "NOT_AT_WAREHOUSE", "NOT_AVAILABLE_FOR_REUSE", "NOT_A_RENTAL", "NOT_MANAGEABLE_BY_ORGANIZATION", "NOT_WITH_ASSIGNMENT", "NOT_WITH_USER", "NO_ACTIVE_ADDONS", "NO_ACTIVE_STORAGE_CONTRACT", "NO_LOCATION_FOR_STORAGE", "NO_LOGISTICS_FOR_STORAGE", "NO_VALID_ADDONS", "ONGOING_SERVICE", "OWNED_BY_DEEL", "OWNED_BY_ORGANIZATION", "OWNED_BY_PARTNER_ORGANIZATION", "PARTNER_CHILD_CONTRACT", "PENDING_DEVICE_REFRESH", "RENTAL_CONTRACT_AND_USER_REGION_DO_NOT_MATCH", "TEMPORARILY_UNAVAILABLE", "UNKNOWN", "USER_HAS_NO_COUNTRY", "USER_HAS_NO_SEAT", "WAITING_FOR_CLEARANCE", "WITH_LOANER_ASSIGNMENT", "WITH_NON_COLLECTED_ASSIGNMENT", "WITH_NON_DELIVERED_ASSIGNMENT", "WITH_PENDING_ASSIGNMENT", "WRONG_ASSIGNMENT_STATUS", "WRONG_CONTRACT_STATUS", "WRONG_TERMS_AND_CONDITIONS" ], "title": "ItAssetsAssetIdGetResponsesContentApplicationJsonSchemaDataActionsUnarchiveOwnAssetDisabledReasonsItems", "type": "string" }, "ItAssetsAssetIdGetResponsesContentApplicationJsonSchemaDataActionsUnarchiveOwnAssetStatus": { "description": "Whether the action is currently available for this asset", "enum": [ "DISABLED", "ENABLED", "NOT_APPLICABLE" ], "title": "ItAssetsAssetIdGetResponsesContentApplicationJsonSchemaDataActionsUnarchiveOwnAssetStatus", "type": "string" }, "ItAssetsAssetIdGetResponsesContentApplicationJsonSchemaDataActionsUpdateLocationLocationToUser": { "description": "Update the location of an asset from a warehouse to a user", "properties": { "disabled_reasons": { "description": "Reasons why the action is disabled. Empty when the action is enabled or not applicable", "items": { "$ref": "#/components/schemas/ItAssetsAssetIdGetResponsesContentApplicationJsonSchemaDataActionsUpdateLocationLocationToUserDisabledReasonsItems" }, "type": "array" }, "status": { "$ref": "#/components/schemas/ItAssetsAssetIdGetResponsesContentApplicationJsonSchemaDataActionsUpdateLocationLocationToUserStatus", "description": "Whether the action is currently available for this asset" } }, "required": [ "status", "disabled_reasons" ], "title": "ItAssetsAssetIdGetResponsesContentApplicationJsonSchemaDataActionsUpdateLocationLocationToUser", "type": "object" }, "ItAssetsAssetIdGetResponsesContentApplicationJsonSchemaDataActionsUpdateLocationLocationToUserDisabledReasonsItems": { "enum": [ "ARCHIVED", "AT_DEEL_WAREHOUSE", "BEING_REPAIRED", "CONSUMABLE", "CONTROLLED_BY_DEEL", "COUNTRY_NOT_SUPPORTED_FOR_HUB", "COUNTRY_NOT_SUPPORTED_FOR_LOCAL", "DEEL_OWNED_ITEM_WITHOUT_RENTAL_CONTRACT", "DESKTOP_STORAGE", "ENDING_CONTRACT", "HUB_IN_SAME_REGION_AS_LOCAL", "INACTIVE", "INVALID_ITEM_LOCATION", "INVALID_ORGANIZATION_STATUS", "INVALID_STATE", "ITEM_CONDITIONS_TO_UNARCHIVE_NOT_MET", "ITEM_NOT_VISIBLE_FOR_ORGANIZATION", "NON_DEVICE", "NOT_AT_WAREHOUSE", "NOT_AVAILABLE_FOR_REUSE", "NOT_A_RENTAL", "NOT_MANAGEABLE_BY_ORGANIZATION", "NOT_WITH_ASSIGNMENT", "NOT_WITH_USER", "NO_ACTIVE_ADDONS", "NO_ACTIVE_STORAGE_CONTRACT", "NO_LOCATION_FOR_STORAGE", "NO_LOGISTICS_FOR_STORAGE", "NO_VALID_ADDONS", "ONGOING_SERVICE", "OWNED_BY_DEEL", "OWNED_BY_ORGANIZATION", "OWNED_BY_PARTNER_ORGANIZATION", "PARTNER_CHILD_CONTRACT", "PENDING_DEVICE_REFRESH", "RENTAL_CONTRACT_AND_USER_REGION_DO_NOT_MATCH", "TEMPORARILY_UNAVAILABLE", "UNKNOWN", "USER_HAS_NO_COUNTRY", "USER_HAS_NO_SEAT", "WAITING_FOR_CLEARANCE", "WITH_LOANER_ASSIGNMENT", "WITH_NON_COLLECTED_ASSIGNMENT", "WITH_NON_DELIVERED_ASSIGNMENT", "WITH_PENDING_ASSIGNMENT", "WRONG_ASSIGNMENT_STATUS", "WRONG_CONTRACT_STATUS", "WRONG_TERMS_AND_CONDITIONS" ], "title": "ItAssetsAssetIdGetResponsesContentApplicationJsonSchemaDataActionsUpdateLocationLocationToUserDisabledReasonsItems", "type": "string" }, "ItAssetsAssetIdGetResponsesContentApplicationJsonSchemaDataActionsUpdateLocationLocationToUserStatus": { "description": "Whether the action is currently available for this asset", "enum": [ "DISABLED", "ENABLED", "NOT_APPLICABLE" ], "title": "ItAssetsAssetIdGetResponsesContentApplicationJsonSchemaDataActionsUpdateLocationLocationToUserStatus", "type": "string" }, "ItAssetsAssetIdGetResponsesContentApplicationJsonSchemaDataActionsUpdateLocationUserToLocation": { "description": "Update the location of an asset from a user to a warehouse", "properties": { "disabled_reasons": { "description": "Reasons why the action is disabled. Empty when the action is enabled or not applicable", "items": { "$ref": "#/components/schemas/ItAssetsAssetIdGetResponsesContentApplicationJsonSchemaDataActionsUpdateLocationUserToLocationDisabledReasonsItems" }, "type": "array" }, "status": { "$ref": "#/components/schemas/ItAssetsAssetIdGetResponsesContentApplicationJsonSchemaDataActionsUpdateLocationUserToLocationStatus", "description": "Whether the action is currently available for this asset" } }, "required": [ "status", "disabled_reasons" ], "title": "ItAssetsAssetIdGetResponsesContentApplicationJsonSchemaDataActionsUpdateLocationUserToLocation", "type": "object" }, "ItAssetsAssetIdGetResponsesContentApplicationJsonSchemaDataActionsUpdateLocationUserToLocationDisabledReasonsItems": { "enum": [ "ARCHIVED", "AT_DEEL_WAREHOUSE", "BEING_REPAIRED", "CONSUMABLE", "CONTROLLED_BY_DEEL", "COUNTRY_NOT_SUPPORTED_FOR_HUB", "COUNTRY_NOT_SUPPORTED_FOR_LOCAL", "DEEL_OWNED_ITEM_WITHOUT_RENTAL_CONTRACT", "DESKTOP_STORAGE", "ENDING_CONTRACT", "HUB_IN_SAME_REGION_AS_LOCAL", "INACTIVE", "INVALID_ITEM_LOCATION", "INVALID_ORGANIZATION_STATUS", "INVALID_STATE", "ITEM_CONDITIONS_TO_UNARCHIVE_NOT_MET", "ITEM_NOT_VISIBLE_FOR_ORGANIZATION", "NON_DEVICE", "NOT_AT_WAREHOUSE", "NOT_AVAILABLE_FOR_REUSE", "NOT_A_RENTAL", "NOT_MANAGEABLE_BY_ORGANIZATION", "NOT_WITH_ASSIGNMENT", "NOT_WITH_USER", "NO_ACTIVE_ADDONS", "NO_ACTIVE_STORAGE_CONTRACT", "NO_LOCATION_FOR_STORAGE", "NO_LOGISTICS_FOR_STORAGE", "NO_VALID_ADDONS", "ONGOING_SERVICE", "OWNED_BY_DEEL", "OWNED_BY_ORGANIZATION", "OWNED_BY_PARTNER_ORGANIZATION", "PARTNER_CHILD_CONTRACT", "PENDING_DEVICE_REFRESH", "RENTAL_CONTRACT_AND_USER_REGION_DO_NOT_MATCH", "TEMPORARILY_UNAVAILABLE", "UNKNOWN", "USER_HAS_NO_COUNTRY", "USER_HAS_NO_SEAT", "WAITING_FOR_CLEARANCE", "WITH_LOANER_ASSIGNMENT", "WITH_NON_COLLECTED_ASSIGNMENT", "WITH_NON_DELIVERED_ASSIGNMENT", "WITH_PENDING_ASSIGNMENT", "WRONG_ASSIGNMENT_STATUS", "WRONG_CONTRACT_STATUS", "WRONG_TERMS_AND_CONDITIONS" ], "title": "ItAssetsAssetIdGetResponsesContentApplicationJsonSchemaDataActionsUpdateLocationUserToLocationDisabledReasonsItems", "type": "string" }, "ItAssetsAssetIdGetResponsesContentApplicationJsonSchemaDataActionsUpdateLocationUserToLocationStatus": { "description": "Whether the action is currently available for this asset", "enum": [ "DISABLED", "ENABLED", "NOT_APPLICABLE" ], "title": "ItAssetsAssetIdGetResponsesContentApplicationJsonSchemaDataActionsUpdateLocationUserToLocationStatus", "type": "string" }, "ItAssetsAssetIdGetResponsesContentApplicationJsonSchemaDataActionsUpdateLocationUserToUser": { "description": "Update the assigned user of an asset that is currently with a user", "properties": { "disabled_reasons": { "description": "Reasons why the action is disabled. Empty when the action is enabled or not applicable", "items": { "$ref": "#/components/schemas/ItAssetsAssetIdGetResponsesContentApplicationJsonSchemaDataActionsUpdateLocationUserToUserDisabledReasonsItems" }, "type": "array" }, "status": { "$ref": "#/components/schemas/ItAssetsAssetIdGetResponsesContentApplicationJsonSchemaDataActionsUpdateLocationUserToUserStatus", "description": "Whether the action is currently available for this asset" } }, "required": [ "status", "disabled_reasons" ], "title": "ItAssetsAssetIdGetResponsesContentApplicationJsonSchemaDataActionsUpdateLocationUserToUser", "type": "object" }, "ItAssetsAssetIdGetResponsesContentApplicationJsonSchemaDataActionsUpdateLocationUserToUserDisabledReasonsItems": { "enum": [ "ARCHIVED", "AT_DEEL_WAREHOUSE", "BEING_REPAIRED", "CONSUMABLE", "CONTROLLED_BY_DEEL", "COUNTRY_NOT_SUPPORTED_FOR_HUB", "COUNTRY_NOT_SUPPORTED_FOR_LOCAL", "DEEL_OWNED_ITEM_WITHOUT_RENTAL_CONTRACT", "DESKTOP_STORAGE", "ENDING_CONTRACT", "HUB_IN_SAME_REGION_AS_LOCAL", "INACTIVE", "INVALID_ITEM_LOCATION", "INVALID_ORGANIZATION_STATUS", "INVALID_STATE", "ITEM_CONDITIONS_TO_UNARCHIVE_NOT_MET", "ITEM_NOT_VISIBLE_FOR_ORGANIZATION", "NON_DEVICE", "NOT_AT_WAREHOUSE", "NOT_AVAILABLE_FOR_REUSE", "NOT_A_RENTAL", "NOT_MANAGEABLE_BY_ORGANIZATION", "NOT_WITH_ASSIGNMENT", "NOT_WITH_USER", "NO_ACTIVE_ADDONS", "NO_ACTIVE_STORAGE_CONTRACT", "NO_LOCATION_FOR_STORAGE", "NO_LOGISTICS_FOR_STORAGE", "NO_VALID_ADDONS", "ONGOING_SERVICE", "OWNED_BY_DEEL", "OWNED_BY_ORGANIZATION", "OWNED_BY_PARTNER_ORGANIZATION", "PARTNER_CHILD_CONTRACT", "PENDING_DEVICE_REFRESH", "RENTAL_CONTRACT_AND_USER_REGION_DO_NOT_MATCH", "TEMPORARILY_UNAVAILABLE", "UNKNOWN", "USER_HAS_NO_COUNTRY", "USER_HAS_NO_SEAT", "WAITING_FOR_CLEARANCE", "WITH_LOANER_ASSIGNMENT", "WITH_NON_COLLECTED_ASSIGNMENT", "WITH_NON_DELIVERED_ASSIGNMENT", "WITH_PENDING_ASSIGNMENT", "WRONG_ASSIGNMENT_STATUS", "WRONG_CONTRACT_STATUS", "WRONG_TERMS_AND_CONDITIONS" ], "title": "ItAssetsAssetIdGetResponsesContentApplicationJsonSchemaDataActionsUpdateLocationUserToUserDisabledReasonsItems", "type": "string" }, "ItAssetsAssetIdGetResponsesContentApplicationJsonSchemaDataActionsUpdateLocationUserToUserStatus": { "description": "Whether the action is currently available for this asset", "enum": [ "DISABLED", "ENABLED", "NOT_APPLICABLE" ], "title": "ItAssetsAssetIdGetResponsesContentApplicationJsonSchemaDataActionsUpdateLocationUserToUserStatus", "type": "string" }, "ItAssetsAssetIdGetResponsesContentApplicationJsonSchemaDataActionsUpdateOwnAssetDetails": { "description": "Update editable details of an organization-owned asset", "properties": { "disabled_reasons": { "description": "Reasons why the action is disabled. Empty when the action is enabled or not applicable", "items": { "$ref": "#/components/schemas/ItAssetsAssetIdGetResponsesContentApplicationJsonSchemaDataActionsUpdateOwnAssetDetailsDisabledReasonsItems" }, "type": "array" }, "status": { "$ref": "#/components/schemas/ItAssetsAssetIdGetResponsesContentApplicationJsonSchemaDataActionsUpdateOwnAssetDetailsStatus", "description": "Whether the action is currently available for this asset" } }, "required": [ "status", "disabled_reasons" ], "title": "ItAssetsAssetIdGetResponsesContentApplicationJsonSchemaDataActionsUpdateOwnAssetDetails", "type": "object" }, "ItAssetsAssetIdGetResponsesContentApplicationJsonSchemaDataActionsUpdateOwnAssetDetailsDisabledReasonsItems": { "enum": [ "ARCHIVED", "AT_DEEL_WAREHOUSE", "BEING_REPAIRED", "CONSUMABLE", "CONTROLLED_BY_DEEL", "COUNTRY_NOT_SUPPORTED_FOR_HUB", "COUNTRY_NOT_SUPPORTED_FOR_LOCAL", "DEEL_OWNED_ITEM_WITHOUT_RENTAL_CONTRACT", "DESKTOP_STORAGE", "ENDING_CONTRACT", "HUB_IN_SAME_REGION_AS_LOCAL", "INACTIVE", "INVALID_ITEM_LOCATION", "INVALID_ORGANIZATION_STATUS", "INVALID_STATE", "ITEM_CONDITIONS_TO_UNARCHIVE_NOT_MET", "ITEM_NOT_VISIBLE_FOR_ORGANIZATION", "NON_DEVICE", "NOT_AT_WAREHOUSE", "NOT_AVAILABLE_FOR_REUSE", "NOT_A_RENTAL", "NOT_MANAGEABLE_BY_ORGANIZATION", "NOT_WITH_ASSIGNMENT", "NOT_WITH_USER", "NO_ACTIVE_ADDONS", "NO_ACTIVE_STORAGE_CONTRACT", "NO_LOCATION_FOR_STORAGE", "NO_LOGISTICS_FOR_STORAGE", "NO_VALID_ADDONS", "ONGOING_SERVICE", "OWNED_BY_DEEL", "OWNED_BY_ORGANIZATION", "OWNED_BY_PARTNER_ORGANIZATION", "PARTNER_CHILD_CONTRACT", "PENDING_DEVICE_REFRESH", "RENTAL_CONTRACT_AND_USER_REGION_DO_NOT_MATCH", "TEMPORARILY_UNAVAILABLE", "UNKNOWN", "USER_HAS_NO_COUNTRY", "USER_HAS_NO_SEAT", "WAITING_FOR_CLEARANCE", "WITH_LOANER_ASSIGNMENT", "WITH_NON_COLLECTED_ASSIGNMENT", "WITH_NON_DELIVERED_ASSIGNMENT", "WITH_PENDING_ASSIGNMENT", "WRONG_ASSIGNMENT_STATUS", "WRONG_CONTRACT_STATUS", "WRONG_TERMS_AND_CONDITIONS" ], "title": "ItAssetsAssetIdGetResponsesContentApplicationJsonSchemaDataActionsUpdateOwnAssetDetailsDisabledReasonsItems", "type": "string" }, "ItAssetsAssetIdGetResponsesContentApplicationJsonSchemaDataActionsUpdateOwnAssetDetailsStatus": { "description": "Whether the action is currently available for this asset", "enum": [ "DISABLED", "ENABLED", "NOT_APPLICABLE" ], "title": "ItAssetsAssetIdGetResponsesContentApplicationJsonSchemaDataActionsUpdateOwnAssetDetailsStatus", "type": "string" }, "ItAssetsAssetIdGetResponsesContentApplicationJsonSchemaDataAssignedUser": { "description": "Details of the user with asset possession", "properties": { "address": { "$ref": "#/components/schemas/ItAssetsAssetIdGetResponsesContentApplicationJsonSchemaDataAssignedUserAddress", "description": "User address details" }, "emails": { "description": "Array of user email addresses", "items": { "format": "email", "type": "string" }, "type": "array" }, "first_name": { "description": "First name of the user", "type": "string" }, "hris_profile_id": { "description": "The unique identifier of the HRIS profile of the assigned user", "format": "uuid", "type": "string" }, "last_name": { "description": "Last name of the user", "type": "string" } }, "required": [ "emails", "address", "last_name", "first_name", "hris_profile_id" ], "title": "ItAssetsAssetIdGetResponsesContentApplicationJsonSchemaDataAssignedUser", "type": "object" }, "ItAssetsAssetIdGetResponsesContentApplicationJsonSchemaDataAssignedUserAddress": { "description": "User address details", "properties": { "city": { "description": "City name", "type": [ "string", "null" ] }, "country": { "$ref": "#/components/schemas/ItAssetsAssetIdGetResponsesContentApplicationJsonSchemaDataAssignedUserAddressCountry", "description": "Country code" }, "date_of_birth": { "description": "Date of birth (applicable for some address types)", "format": "date", "type": [ "string", "null" ] }, "delivery_instructions": { "description": "Special instructions for deliveries", "type": [ "string", "null" ] }, "id": { "description": "Unique identifier of the address", "format": "uuid", "type": "string" }, "is_valid": { "description": "Whether the address passes validation", "type": "boolean" }, "line1": { "description": "Address line 1", "type": [ "string", "null" ] }, "line2": { "description": "Address line 2", "type": [ "string", "null" ] }, "passport_number": { "description": "Passport number (applicable for some address types)", "type": [ "string", "null" ] }, "phone_number": { "description": "Phone number", "type": [ "string", "null" ] }, "post_code": { "description": "Post code", "type": [ "string", "null" ] }, "state": { "description": "State code or name", "type": [ "string", "null" ] }, "tax_id_number": { "description": "Tax ID number (applicable for some address types)", "type": [ "string", "null" ] }, "type": { "$ref": "#/components/schemas/ItAssetsAssetIdGetResponsesContentApplicationJsonSchemaDataAssignedUserAddressType", "description": "Type of the address" } }, "required": [ "id", "city", "type", "line1", "line2", "state", "country", "is_valid", "post_code", "phone_number", "date_of_birth", "tax_id_number", "passport_number", "delivery_instructions" ], "title": "ItAssetsAssetIdGetResponsesContentApplicationJsonSchemaDataAssignedUserAddress", "type": "object" }, "ItAssetsAssetIdGetResponsesContentApplicationJsonSchemaDataAssignedUserAddressCountry": { "description": "Country code", "enum": [ "AD", "AE", "AF", "AG", "AI", "AL", "AM", "AN", "AO", "AQ", "AR", "AS", "AT", "AU", "AW", "AX", "AZ", "BA", "BB", "BD", "BE", "BF", "BG", "BH", "BI", "BJ", "BL", "BM", "BN", "BO", "BQ", "BR", "BS", "BT", "BV", "BW", "BY", "BZ", "CA", "CC", "CD", "CF", "CG", "CH", "CI", "CK", "CL", "CM", "CN", "CO", "CR", "CU", "CV", "CW", "CX", "CY", "CZ", "DE", "DJ", "DK", "DM", "DO", "DZ", "EC", "EE", "EG", "EH", "ER", "ES", "ET", "FI", "FJ", "FK", "FM", "FO", "FR", "GA", "GB", "GD", "GE", "GF", "GG", "GH", "GI", "GL", "GM", "GN", "GP", "GQ", "GR", "GS", "GT", "GU", "GW", "GY", "HK", "HM", "HN", "HR", "HT", "HU", "IC", "ID", "IE", "IL", "IM", "IN", "IO", "IQ", "IR", "IS", "IT", "JE", "JM", "JO", "JP", "KE", "KG", "KH", "KI", "KM", "KN", "KP", "KR", "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", "XK", "YE", "YT", "ZA", "ZM", "ZW" ], "title": "ItAssetsAssetIdGetResponsesContentApplicationJsonSchemaDataAssignedUserAddressCountry", "type": "string" }, "ItAssetsAssetIdGetResponsesContentApplicationJsonSchemaDataAssignedUserAddressType": { "description": "Type of the address", "enum": [ "BILLING", "COLLECTION", "DELIVERY", "ENTITY", "PARTIAL", "PII", "SUPPLIER" ], "title": "ItAssetsAssetIdGetResponsesContentApplicationJsonSchemaDataAssignedUserAddressType", "type": "string" }, "ItAssetsAssetIdGetResponsesContentApplicationJsonSchemaDataAssignedWarehouse": { "description": "Details of the warehouse with asset possession", "properties": { "address": { "$ref": "#/components/schemas/ItAssetsAssetIdGetResponsesContentApplicationJsonSchemaDataAssignedWarehouseAddress", "description": "Warehouse address details" }, "id": { "description": "Unique identifier of the warehouse", "format": "uuid", "type": "string" }, "name": { "description": "Warehouse or storage location name", "type": "string" }, "ownership": { "$ref": "#/components/schemas/ItAssetsAssetIdGetResponsesContentApplicationJsonSchemaDataAssignedWarehouseOwnership", "description": "Warehouse ownership type" }, "public_id": { "description": "Public identifier of the warehouse", "type": "string" }, "warehouse_type": { "$ref": "#/components/schemas/ItAssetsAssetIdGetResponsesContentApplicationJsonSchemaDataAssignedWarehouseWarehouseType", "description": "Warehouse type" } }, "required": [ "id", "name", "address", "ownership", "public_id", "warehouse_type" ], "title": "ItAssetsAssetIdGetResponsesContentApplicationJsonSchemaDataAssignedWarehouse", "type": "object" }, "ItAssetsAssetIdGetResponsesContentApplicationJsonSchemaDataAssignedWarehouseAddress": { "description": "Warehouse address details", "properties": { "city": { "description": "City name", "type": [ "string", "null" ] }, "country": { "$ref": "#/components/schemas/ItAssetsAssetIdGetResponsesContentApplicationJsonSchemaDataAssignedWarehouseAddressCountry", "description": "Country code" }, "date_of_birth": { "description": "Date of birth (applicable for some address types)", "format": "date", "type": [ "string", "null" ] }, "delivery_instructions": { "description": "Special instructions for deliveries", "type": [ "string", "null" ] }, "id": { "description": "Unique identifier of the address", "format": "uuid", "type": "string" }, "is_valid": { "description": "Whether the address passes validation", "type": "boolean" }, "line1": { "description": "Address line 1", "type": [ "string", "null" ] }, "line2": { "description": "Address line 2", "type": [ "string", "null" ] }, "passport_number": { "description": "Passport number (applicable for some address types)", "type": [ "string", "null" ] }, "phone_number": { "description": "Phone number", "type": [ "string", "null" ] }, "post_code": { "description": "Post code", "type": [ "string", "null" ] }, "state": { "description": "State code or name", "type": [ "string", "null" ] }, "tax_id_number": { "description": "Tax ID number (applicable for some address types)", "type": [ "string", "null" ] }, "type": { "$ref": "#/components/schemas/ItAssetsAssetIdGetResponsesContentApplicationJsonSchemaDataAssignedWarehouseAddressType", "description": "Type of the address" } }, "required": [ "id", "city", "type", "line1", "line2", "state", "country", "is_valid", "post_code", "phone_number", "date_of_birth", "tax_id_number", "passport_number", "delivery_instructions" ], "title": "ItAssetsAssetIdGetResponsesContentApplicationJsonSchemaDataAssignedWarehouseAddress", "type": "object" }, "ItAssetsAssetIdGetResponsesContentApplicationJsonSchemaDataAssignedWarehouseAddressCountry": { "description": "Country code", "enum": [ "AD", "AE", "AF", "AG", "AI", "AL", "AM", "AN", "AO", "AQ", "AR", "AS", "AT", "AU", "AW", "AX", "AZ", "BA", "BB", "BD", "BE", "BF", "BG", "BH", "BI", "BJ", "BL", "BM", "BN", "BO", "BQ", "BR", "BS", "BT", "BV", "BW", "BY", "BZ", "CA", "CC", "CD", "CF", "CG", "CH", "CI", "CK", "CL", "CM", "CN", "CO", "CR", "CU", "CV", "CW", "CX", "CY", "CZ", "DE", "DJ", "DK", "DM", "DO", "DZ", "EC", "EE", "EG", "EH", "ER", "ES", "ET", "FI", "FJ", "FK", "FM", "FO", "FR", "GA", "GB", "GD", "GE", "GF", "GG", "GH", "GI", "GL", "GM", "GN", "GP", "GQ", "GR", "GS", "GT", "GU", "GW", "GY", "HK", "HM", "HN", "HR", "HT", "HU", "IC", "ID", "IE", "IL", "IM", "IN", "IO", "IQ", "IR", "IS", "IT", "JE", "JM", "JO", "JP", "KE", "KG", "KH", "KI", "KM", "KN", "KP", "KR", "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", "XK", "YE", "YT", "ZA", "ZM", "ZW" ], "title": "ItAssetsAssetIdGetResponsesContentApplicationJsonSchemaDataAssignedWarehouseAddressCountry", "type": "string" }, "ItAssetsAssetIdGetResponsesContentApplicationJsonSchemaDataAssignedWarehouseAddressType": { "description": "Type of the address", "enum": [ "BILLING", "COLLECTION", "DELIVERY", "ENTITY", "PARTIAL", "PII", "SUPPLIER" ], "title": "ItAssetsAssetIdGetResponsesContentApplicationJsonSchemaDataAssignedWarehouseAddressType", "type": "string" }, "ItAssetsAssetIdGetResponsesContentApplicationJsonSchemaDataAssignedWarehouseOwnership": { "description": "Warehouse ownership type", "enum": [ "DEEL", "ORGANIZATION" ], "title": "ItAssetsAssetIdGetResponsesContentApplicationJsonSchemaDataAssignedWarehouseOwnership", "type": "string" }, "ItAssetsAssetIdGetResponsesContentApplicationJsonSchemaDataAssignedWarehouseWarehouseType": { "description": "Warehouse type", "enum": [ "CLEARANCE", "DEEL", "ORGANIZATION" ], "title": "ItAssetsAssetIdGetResponsesContentApplicationJsonSchemaDataAssignedWarehouseWarehouseType", "type": "string" }, "ItAssetsAssetIdGetResponsesContentApplicationJsonSchemaDataGrade": { "description": "The condition grade of the asset", "enum": [ "A", "B", "C", "D", "F", "NEW" ], "title": "ItAssetsAssetIdGetResponsesContentApplicationJsonSchemaDataGrade", "type": "string" }, "ItAssetsAssetIdGetResponsesContentApplicationJsonSchemaDataLocation": { "description": "Current location type of the asset", "enum": [ "AT_WAREHOUSE", "CLEARANCE_WAREHOUSE", "DEEL_WAREHOUSE", "ORGANIZATION_WAREHOUSE", "SUPPLIER", "WITH_COURIER", "WITH_USER", "WRITE_OFF" ], "title": "ItAssetsAssetIdGetResponsesContentApplicationJsonSchemaDataLocation", "type": "string" }, "ItAssetsAssetIdGetResponsesContentApplicationJsonSchemaDataOwnership": { "description": "Asset owner", "properties": { "name": { "description": "Asset owner name", "type": "string" }, "type": { "$ref": "#/components/schemas/ItAssetsAssetIdGetResponsesContentApplicationJsonSchemaDataOwnershipType", "description": "Asset owner type" } }, "required": [ "name", "type" ], "title": "ItAssetsAssetIdGetResponsesContentApplicationJsonSchemaDataOwnership", "type": "object" }, "ItAssetsAssetIdGetResponsesContentApplicationJsonSchemaDataOwnershipType": { "description": "Asset owner type", "enum": [ "DEEL", "ORGANIZATION" ], "title": "ItAssetsAssetIdGetResponsesContentApplicationJsonSchemaDataOwnershipType", "type": "string" }, "ItAssetsAssetIdGetResponsesContentApplicationJsonSchemaDataProduct": { "description": "Product details", "properties": { "brand": { "description": "Product brand", "type": "string" }, "category": { "$ref": "#/components/schemas/ItAssetsAssetIdGetResponsesContentApplicationJsonSchemaDataProductCategory", "description": "Product category" }, "id": { "description": "Unique identifier of the product", "format": "uuid", "type": "string" }, "name": { "description": "Product name", "type": "string" }, "specifications": { "description": "Specifications of the product", "items": { "$ref": "#/components/schemas/ItAssetsAssetIdGetResponsesContentApplicationJsonSchemaDataProductSpecificationsItems" }, "type": "array" } }, "required": [ "id", "name", "brand", "category", "specifications" ], "title": "ItAssetsAssetIdGetResponsesContentApplicationJsonSchemaDataProduct", "type": "object" }, "ItAssetsAssetIdGetResponsesContentApplicationJsonSchemaDataProductCategory": { "description": "Product category", "enum": [ "ADAPTER", "CABLE", "CHAIR", "CHARGER", "COMPACT_DESKTOP", "DESK", "DESKTOP", "DESK_RISER", "DESK_TIDY", "DOCKING_STATION", "DONGLE", "FOOTREST", "HEADSET", "KEYBOARD", "LAPTOP", "LAPTOP_STAND", "MICE_TRACKPAD", "MOBILE_DEVICE", "MONITOR", "MONITOR_ARM", "OTHER", "PRINTER", "SHREDDER", "STANDING_MAT", "TABLET", "TASK_LIGHT", "WEBCAM", "WELCOME_PACK", "WIFI_RANGE_EXTENDER" ], "title": "ItAssetsAssetIdGetResponsesContentApplicationJsonSchemaDataProductCategory", "type": "string" }, "ItAssetsAssetIdGetResponsesContentApplicationJsonSchemaDataProductSpecificationsItems": { "properties": { "name": { "description": "Specification name", "type": "string" }, "value": { "description": "Specification value", "type": "string" } }, "required": [ "name", "value" ], "title": "ItAssetsAssetIdGetResponsesContentApplicationJsonSchemaDataProductSpecificationsItems", "type": "object" }, "ItAssetsAssetIdGetResponsesContentApplicationJsonSchemaDataPurchaseValue": { "description": "Purchase value of the asset", "properties": { "amount": { "description": "Amount", "format": "decimal", "type": "string" }, "currency": { "$ref": "#/components/schemas/ItAssetsAssetIdGetResponsesContentApplicationJsonSchemaDataPurchaseValueCurrency", "description": "Three-letter currency code for the price" } }, "required": [ "amount", "currency" ], "title": "ItAssetsAssetIdGetResponsesContentApplicationJsonSchemaDataPurchaseValue", "type": "object" }, "ItAssetsAssetIdGetResponsesContentApplicationJsonSchemaDataPurchaseValueCurrency": { "description": "Three-letter currency code for the price", "enum": [ "AED", "AFN", "ALL", "AMD", "ANG", "AOA", "ARS", "AUD", "AWG", "AZN", "BAM", "BDT", "BGN", "BHD", "BIF", "BMD", "BOB", "BRL", "BSD", "BTN", "BWP", "BYN", "BZD", "CAD", "CDF", "CHF", "CLP", "CNY", "COP", "CRC", "CUC", "CVE", "CZK", "DJF", "DKK", "DOP", "DZD", "EGP", "ERN", "ETB", "EUR", "FJD", "FKP", "GBP", "GEL", "GHS", "GIP", "GMD", "GNF", "GTQ", "GYD", "HKD", "HNL", "HRK", "HTG", "HUF", "IDR", "ILS", "INR", "IQD", "IRR", "ISK", "JMD", "JOD", "JPY", "KES", "KGS", "KHR", "KMF", "KPW", "KRW", "KWD", "KYD", "KZT", "LAK", "LBP", "LKR", "LRD", "LSL", "LTL", "LYD", "MAD", "MDL", "MGA", "MKD", "MMK", "MNT", "MRU", "MUR", "MVR", "MWK", "MXN", "MYR", "MZN", "NAD", "NGN", "NIO", "NOK", "NPR", "NZD", "OMR", "PAB", "PEN", "PGK", "PHP", "PKR", "PLN", "PYG", "QAR", "RON", "RSD", "RUB", "RWF", "SAR", "SBD", "SCR", "SDG", "SEK", "SGD", "SHP", "SLL", "SOS", "SRD", "SSP", "STD", "SYP", "SZL", "THB", "TJS", "TMT", "TND", "TOP", "TRY", "TTD", "TWD", "TZS", "UAH", "UGX", "USD", "UYU", "UZS", "VEF", "VND", "VUV", "WST", "XAF", "XCD", "XOF", "XPF", "YER", "ZAR", "ZMW", "ZWD" ], "title": "ItAssetsAssetIdGetResponsesContentApplicationJsonSchemaDataPurchaseValueCurrency", "type": "string" }, "ItAssetsAssetIdGetResponsesContentApplicationJsonSchemaDataStatus": { "description": "Current state of the asset", "enum": [ "ACTIVE", "ADDED_BY_MISTAKE", "BEING_REPAIRED", "BINNED", "BROKEN_AT_WAREHOUSE", "BROKEN_BY_USER", "BROKEN_IN_TRANSIT", "CLEARED", "DAMAGED_AT_WAREHOUSE", "DAMAGED_BY_USER", "DAMAGED_IN_TRANSIT", "LEFT_WITH_USER", "LOST_IN_TRANSIT", "RETURNED_TO_DEEL", "SHRINKAGE", "STOLEN", "SUPPLIER_RETURN", "WAITING_FOR_CLEARANCE" ], "title": "ItAssetsAssetIdGetResponsesContentApplicationJsonSchemaDataStatus", "type": "string" }, "ItAssetsAssetIdGetResponsesContentApplicationJsonSchemaErrorsItems": { "properties": { "code": { "description": "Error code of the handler which produced the returned error", "type": "string" }, "field": { "description": "The field name where input validation failed", "type": [ "string", "null" ] }, "message": { "description": "Description of the returned error", "type": "string" } }, "required": [ "code", "field", "message" ], "title": "ItAssetsAssetIdGetResponsesContentApplicationJsonSchemaErrorsItems", "type": "object" }, "ItAssetsAssetIdLocationPostParametersXBeta": { "default": "true", "enum": [ "true" ], "title": "ItAssetsAssetIdLocationPostParametersXBeta", "type": "string" }, "ItAssetsAssetIdLocationPostRequestBodyContentApplicationJsonSchemaData": { "properties": { "hris_profile_id": { "description": "HRIS profile ID of the user the asset is being moved to. Required when\nlocation is WITH_USER; ignored when location is AT_WAREHOUSE.", "format": "uuid", "type": "string" }, "location": { "$ref": "#/components/schemas/ItAssetsAssetIdLocationPostRequestBodyContentApplicationJsonSchemaDataLocation", "description": "Target location for the asset. Only WITH_USER and AT_WAREHOUSE are\naccepted; other ItemLocation values are managed by Deel logistics and\nrejected with 400. Supported values that produce a transition the\nunderlying self-serve workflow cannot perform (e.g. AT_WAREHOUSE ->\nAT_WAREHOUSE) are rejected with 409 by the workflow's own asset_not_*\nerrors." }, "warehouse_id": { "description": "ID of the organization storage location the asset is being moved to.\nRequired when location is AT_WAREHOUSE; ignored when location is WITH_USER.", "format": "uuid", "type": "string" } }, "required": [ "location" ], "title": "ItAssetsAssetIdLocationPostRequestBodyContentApplicationJsonSchemaData", "type": "object" }, "ItAssetsAssetIdLocationPostRequestBodyContentApplicationJsonSchemaDataLocation": { "description": "Target location for the asset. Only WITH_USER and AT_WAREHOUSE are\naccepted; other ItemLocation values are managed by Deel logistics and\nrejected with 400. Supported values that produce a transition the\nunderlying self-serve workflow cannot perform (e.g. AT_WAREHOUSE ->\nAT_WAREHOUSE) are rejected with 409 by the workflow's own asset_not_*\nerrors.", "enum": [ "AT_WAREHOUSE", "CLEARANCE_WAREHOUSE", "DEEL_WAREHOUSE", "ORGANIZATION_WAREHOUSE", "SUPPLIER", "WITH_COURIER", "WITH_USER", "WRITE_OFF" ], "title": "ItAssetsAssetIdLocationPostRequestBodyContentApplicationJsonSchemaDataLocation", "type": "string" }, "ItAssetsAssetIdLocationPostResponsesContentApplicationJsonSchemaData": { "properties": { "actions": { "$ref": "#/components/schemas/ItAssetsAssetIdLocationPostResponsesContentApplicationJsonSchemaDataActions", "description": "Actions the caller can execute on this asset, with availability status per action" }, "assigned_user": { "description": "Details of the user with asset possession", "oneOf": [ { "$ref": "#/components/schemas/ItAssetsAssetIdLocationPostResponsesContentApplicationJsonSchemaDataAssignedUser" }, { "type": "null" } ] }, "assigned_warehouse": { "description": "Details of the warehouse with asset possession", "oneOf": [ { "$ref": "#/components/schemas/ItAssetsAssetIdLocationPostResponsesContentApplicationJsonSchemaDataAssignedWarehouse" }, { "type": "null" } ] }, "created_at": { "description": "Creation timestamp of the asset", "format": "date-time", "type": "string" }, "grade": { "$ref": "#/components/schemas/ItAssetsAssetIdLocationPostResponsesContentApplicationJsonSchemaDataGrade", "description": "The condition grade of the asset" }, "id": { "description": "Unique identifier of the item", "format": "uuid", "type": "string" }, "location": { "$ref": "#/components/schemas/ItAssetsAssetIdLocationPostResponsesContentApplicationJsonSchemaDataLocation", "description": "Current location type of the asset" }, "ownership": { "$ref": "#/components/schemas/ItAssetsAssetIdLocationPostResponsesContentApplicationJsonSchemaDataOwnership", "description": "Asset owner" }, "product": { "$ref": "#/components/schemas/ItAssetsAssetIdLocationPostResponsesContentApplicationJsonSchemaDataProduct", "description": "Product details" }, "public_id": { "description": "Public identifier of the item", "type": "string" }, "purchase_date": { "description": "Purchase date of the asset", "format": "date", "type": [ "string", "null" ] }, "purchase_value": { "description": "Purchase value of the asset", "oneOf": [ { "$ref": "#/components/schemas/ItAssetsAssetIdLocationPostResponsesContentApplicationJsonSchemaDataPurchaseValue" }, { "type": "null" } ] }, "serial_number": { "description": "Asset serial number", "type": [ "string", "null" ] }, "status": { "$ref": "#/components/schemas/ItAssetsAssetIdLocationPostResponsesContentApplicationJsonSchemaDataStatus", "description": "Current state of the asset" }, "updated_at": { "description": "Last update timestamp of the asset", "format": "date-time", "type": "string" } }, "required": [ "id", "grade", "status", "actions", "product", "location", "ownership", "public_id", "created_at", "updated_at", "assigned_user", "purchase_date", "serial_number", "purchase_value", "assigned_warehouse" ], "title": "ItAssetsAssetIdLocationPostResponsesContentApplicationJsonSchemaData", "type": "object" }, "ItAssetsAssetIdLocationPostResponsesContentApplicationJsonSchemaDataActions": { "description": "Actions the caller can execute on this asset, with availability status per action", "properties": { "archive_own_asset": { "$ref": "#/components/schemas/ItAssetsAssetIdLocationPostResponsesContentApplicationJsonSchemaDataActionsArchiveOwnAsset", "description": "Archive an organization-owned asset" }, "asset_country": { "description": "Resolved country used for asset actions. Derived from the asset's country,\nits assigned rental contract billing entity country, or the last active\nassignment delivery country. Null when the country cannot be determined\n(e.g. asset was returned to Deel)", "oneOf": [ { "$ref": "#/components/schemas/ItAssetsAssetIdLocationPostResponsesContentApplicationJsonSchemaDataActionsAssetCountry" }, { "type": "null" } ] }, "assign_addon_to_own_asset": { "$ref": "#/components/schemas/ItAssetsAssetIdLocationPostResponsesContentApplicationJsonSchemaDataActionsAssignAddonToOwnAsset", "description": "Assign an add-on to an organization-owned asset" }, "clear_own_asset": { "$ref": "#/components/schemas/ItAssetsAssetIdLocationPostResponsesContentApplicationJsonSchemaDataActionsClearOwnAsset", "description": "Clear an organization-owned asset from the fleet" }, "manage_end_of_rental_contract_actions": { "$ref": "#/components/schemas/ItAssetsAssetIdLocationPostResponsesContentApplicationJsonSchemaDataActionsManageEndOfRentalContractActions", "description": "Manage end-of-rental options for a Deel-owned rental asset" }, "purchase_rental": { "$ref": "#/components/schemas/ItAssetsAssetIdLocationPostResponsesContentApplicationJsonSchemaDataActionsPurchaseRental", "description": "Purchase a Deel-owned rental asset at end of contract" }, "return_rental_to_deel": { "$ref": "#/components/schemas/ItAssetsAssetIdLocationPostResponsesContentApplicationJsonSchemaDataActionsReturnRentalToDeel", "description": "Return a Deel-owned rental asset back to Deel" }, "reuse_own_asset_from_deel": { "$ref": "#/components/schemas/ItAssetsAssetIdLocationPostResponsesContentApplicationJsonSchemaDataActionsReuseOwnAssetFromDeel", "description": "Redeploy an organization-owned asset stored at a Deel warehouse" }, "reuse_own_asset_from_own_location": { "$ref": "#/components/schemas/ItAssetsAssetIdLocationPostResponsesContentApplicationJsonSchemaDataActionsReuseOwnAssetFromOwnLocation", "description": "Redeploy an organization-owned asset from an organization-owned location" }, "store_own_asset_at_deel_for_hub": { "$ref": "#/components/schemas/ItAssetsAssetIdLocationPostResponsesContentApplicationJsonSchemaDataActionsStoreOwnAssetAtDeelForHub", "description": "Store an organization-owned asset at a Deel hub warehouse" }, "store_own_asset_at_deel_for_local": { "$ref": "#/components/schemas/ItAssetsAssetIdLocationPostResponsesContentApplicationJsonSchemaDataActionsStoreOwnAssetAtDeelForLocal", "description": "Store an organization-owned asset at a Deel local warehouse" }, "store_own_asset_at_own_location": { "$ref": "#/components/schemas/ItAssetsAssetIdLocationPostResponsesContentApplicationJsonSchemaDataActionsStoreOwnAssetAtOwnLocation", "description": "Store an organization-owned asset at an organization-owned location" }, "store_rental_at_deel_for_local": { "$ref": "#/components/schemas/ItAssetsAssetIdLocationPostResponsesContentApplicationJsonSchemaDataActionsStoreRentalAtDeelForLocal", "description": "Store a Deel-owned rental asset at a Deel local warehouse" }, "store_rental_at_deel_for_zone1": { "$ref": "#/components/schemas/ItAssetsAssetIdLocationPostResponsesContentApplicationJsonSchemaDataActionsStoreRentalAtDeelForZone1", "description": "Store a Deel-owned rental asset at a Deel zone-1 warehouse" }, "transfer_own_asset": { "$ref": "#/components/schemas/ItAssetsAssetIdLocationPostResponsesContentApplicationJsonSchemaDataActionsTransferOwnAsset", "description": "Transfer an organization-owned asset to another user" }, "transfer_rental": { "$ref": "#/components/schemas/ItAssetsAssetIdLocationPostResponsesContentApplicationJsonSchemaDataActionsTransferRental", "description": "Transfer a Deel-owned rental asset to another user" }, "unarchive_own_asset": { "$ref": "#/components/schemas/ItAssetsAssetIdLocationPostResponsesContentApplicationJsonSchemaDataActionsUnarchiveOwnAsset", "description": "Unarchive a previously archived organization-owned asset" }, "update_location_location_to_user": { "$ref": "#/components/schemas/ItAssetsAssetIdLocationPostResponsesContentApplicationJsonSchemaDataActionsUpdateLocationLocationToUser", "description": "Update the location of an asset from a warehouse to a user" }, "update_location_user_to_location": { "$ref": "#/components/schemas/ItAssetsAssetIdLocationPostResponsesContentApplicationJsonSchemaDataActionsUpdateLocationUserToLocation", "description": "Update the location of an asset from a user to a warehouse" }, "update_location_user_to_user": { "$ref": "#/components/schemas/ItAssetsAssetIdLocationPostResponsesContentApplicationJsonSchemaDataActionsUpdateLocationUserToUser", "description": "Update the assigned user of an asset that is currently with a user" }, "update_own_asset_details": { "$ref": "#/components/schemas/ItAssetsAssetIdLocationPostResponsesContentApplicationJsonSchemaDataActionsUpdateOwnAssetDetails", "description": "Update editable details of an organization-owned asset" } }, "required": [ "asset_country", "clear_own_asset", "purchase_rental", "transfer_rental", "archive_own_asset", "transfer_own_asset", "unarchive_own_asset", "return_rental_to_deel", "update_own_asset_details", "assign_addon_to_own_asset", "reuse_own_asset_from_deel", "update_location_user_to_user", "store_rental_at_deel_for_local", "store_rental_at_deel_for_zone1", "store_own_asset_at_deel_for_hub", "store_own_asset_at_own_location", "update_location_location_to_user", "update_location_user_to_location", "reuse_own_asset_from_own_location", "store_own_asset_at_deel_for_local", "manage_end_of_rental_contract_actions" ], "title": "ItAssetsAssetIdLocationPostResponsesContentApplicationJsonSchemaDataActions", "type": "object" }, "ItAssetsAssetIdLocationPostResponsesContentApplicationJsonSchemaDataActionsArchiveOwnAsset": { "description": "Archive an organization-owned asset", "properties": { "details": { "description": "Action-specific context needed to perform the action. Populated for enabled and\ndisabled actions (so callers can see what a successful attempt would look like);\nnull when the action is not applicable to this asset.", "oneOf": [ { "$ref": "#/components/schemas/ItAssetsAssetIdLocationPostResponsesContentApplicationJsonSchemaDataActionsArchiveOwnAssetDetails" }, { "type": "null" } ] }, "disabled_reasons": { "description": "Reasons why the action is disabled. Empty when the action is enabled or not applicable", "items": { "$ref": "#/components/schemas/ItAssetsAssetIdLocationPostResponsesContentApplicationJsonSchemaDataActionsArchiveOwnAssetDisabledReasonsItems" }, "type": "array" }, "status": { "$ref": "#/components/schemas/ItAssetsAssetIdLocationPostResponsesContentApplicationJsonSchemaDataActionsArchiveOwnAssetStatus", "description": "Whether the action is currently available for this asset" } }, "required": [ "status", "details", "disabled_reasons" ], "title": "ItAssetsAssetIdLocationPostResponsesContentApplicationJsonSchemaDataActionsArchiveOwnAsset", "type": "object" }, "ItAssetsAssetIdLocationPostResponsesContentApplicationJsonSchemaDataActionsArchiveOwnAssetDetails": { "description": "Action-specific context needed to perform the action. Populated for enabled and\ndisabled actions (so callers can see what a successful attempt would look like);\nnull when the action is not applicable to this asset.", "properties": { "allowed_statuses": { "description": "Statuses that can be passed as the archive reason when archiving the asset", "items": { "$ref": "#/components/schemas/ItAssetsAssetIdLocationPostResponsesContentApplicationJsonSchemaDataActionsArchiveOwnAssetDetailsAllowedStatusesItems" }, "type": "array" } }, "required": [ "allowed_statuses" ], "title": "ItAssetsAssetIdLocationPostResponsesContentApplicationJsonSchemaDataActionsArchiveOwnAssetDetails", "type": "object" }, "ItAssetsAssetIdLocationPostResponsesContentApplicationJsonSchemaDataActionsArchiveOwnAssetDetailsAllowedStatusesItems": { "enum": [ "ADDED_BY_MISTAKE", "BINNED", "BROKEN_AT_WAREHOUSE", "BROKEN_BY_USER", "BROKEN_IN_TRANSIT", "DAMAGED_AT_WAREHOUSE", "DAMAGED_BY_USER", "DAMAGED_IN_TRANSIT", "LEFT_WITH_USER", "LOST_IN_TRANSIT", "RETURNED_TO_DEEL", "SHRINKAGE", "STOLEN", "SUPPLIER_RETURN" ], "title": "ItAssetsAssetIdLocationPostResponsesContentApplicationJsonSchemaDataActionsArchiveOwnAssetDetailsAllowedStatusesItems", "type": "string" }, "ItAssetsAssetIdLocationPostResponsesContentApplicationJsonSchemaDataActionsArchiveOwnAssetDisabledReasonsItems": { "enum": [ "ARCHIVED", "AT_DEEL_WAREHOUSE", "BEING_REPAIRED", "CONSUMABLE", "CONTROLLED_BY_DEEL", "COUNTRY_NOT_SUPPORTED_FOR_HUB", "COUNTRY_NOT_SUPPORTED_FOR_LOCAL", "DEEL_OWNED_ITEM_WITHOUT_RENTAL_CONTRACT", "DESKTOP_STORAGE", "ENDING_CONTRACT", "HUB_IN_SAME_REGION_AS_LOCAL", "INACTIVE", "INVALID_ITEM_LOCATION", "INVALID_ORGANIZATION_STATUS", "INVALID_STATE", "ITEM_CONDITIONS_TO_UNARCHIVE_NOT_MET", "ITEM_NOT_VISIBLE_FOR_ORGANIZATION", "NON_DEVICE", "NOT_AT_WAREHOUSE", "NOT_AVAILABLE_FOR_REUSE", "NOT_A_RENTAL", "NOT_MANAGEABLE_BY_ORGANIZATION", "NOT_WITH_ASSIGNMENT", "NOT_WITH_USER", "NO_ACTIVE_ADDONS", "NO_ACTIVE_STORAGE_CONTRACT", "NO_LOCATION_FOR_STORAGE", "NO_LOGISTICS_FOR_STORAGE", "NO_VALID_ADDONS", "ONGOING_SERVICE", "OWNED_BY_DEEL", "OWNED_BY_ORGANIZATION", "OWNED_BY_PARTNER_ORGANIZATION", "PARTNER_CHILD_CONTRACT", "PENDING_DEVICE_REFRESH", "RENTAL_CONTRACT_AND_USER_REGION_DO_NOT_MATCH", "TEMPORARILY_UNAVAILABLE", "UNKNOWN", "USER_HAS_NO_COUNTRY", "USER_HAS_NO_SEAT", "WAITING_FOR_CLEARANCE", "WITH_LOANER_ASSIGNMENT", "WITH_NON_COLLECTED_ASSIGNMENT", "WITH_NON_DELIVERED_ASSIGNMENT", "WITH_PENDING_ASSIGNMENT", "WRONG_ASSIGNMENT_STATUS", "WRONG_CONTRACT_STATUS", "WRONG_TERMS_AND_CONDITIONS" ], "title": "ItAssetsAssetIdLocationPostResponsesContentApplicationJsonSchemaDataActionsArchiveOwnAssetDisabledReasonsItems", "type": "string" }, "ItAssetsAssetIdLocationPostResponsesContentApplicationJsonSchemaDataActionsArchiveOwnAssetStatus": { "description": "Whether the action is currently available for this asset", "enum": [ "DISABLED", "ENABLED", "NOT_APPLICABLE" ], "title": "ItAssetsAssetIdLocationPostResponsesContentApplicationJsonSchemaDataActionsArchiveOwnAssetStatus", "type": "string" }, "ItAssetsAssetIdLocationPostResponsesContentApplicationJsonSchemaDataActionsAssetCountry": { "description": "Resolved country used for asset actions. Derived from the asset's country,\nits assigned rental contract billing entity country, or the last active\nassignment delivery country. Null when the country cannot be determined\n(e.g. asset was returned to Deel)", "enum": [ "AD", "AE", "AF", "AG", "AI", "AL", "AM", "AN", "AO", "AQ", "AR", "AS", "AT", "AU", "AW", "AX", "AZ", "BA", "BB", "BD", "BE", "BF", "BG", "BH", "BI", "BJ", "BL", "BM", "BN", "BO", "BQ", "BR", "BS", "BT", "BV", "BW", "BY", "BZ", "CA", "CC", "CD", "CF", "CG", "CH", "CI", "CK", "CL", "CM", "CN", "CO", "CR", "CU", "CV", "CW", "CX", "CY", "CZ", "DE", "DJ", "DK", "DM", "DO", "DZ", "EC", "EE", "EG", "EH", "ER", "ES", "ET", "FI", "FJ", "FK", "FM", "FO", "FR", "GA", "GB", "GD", "GE", "GF", "GG", "GH", "GI", "GL", "GM", "GN", "GP", "GQ", "GR", "GS", "GT", "GU", "GW", "GY", "HK", "HM", "HN", "HR", "HT", "HU", "IC", "ID", "IE", "IL", "IM", "IN", "IO", "IQ", "IR", "IS", "IT", "JE", "JM", "JO", "JP", "KE", "KG", "KH", "KI", "KM", "KN", "KP", "KR", "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", "XK", "YE", "YT", "ZA", "ZM", "ZW" ], "title": "ItAssetsAssetIdLocationPostResponsesContentApplicationJsonSchemaDataActionsAssetCountry", "type": "string" }, "ItAssetsAssetIdLocationPostResponsesContentApplicationJsonSchemaDataActionsAssignAddonToOwnAsset": { "description": "Assign an add-on to an organization-owned asset", "properties": { "details": { "description": "Action-specific context needed to perform the action. Populated for enabled and\ndisabled actions (so callers can see what a successful attempt would look like);\nnull when the action is not applicable to this asset.", "oneOf": [ { "$ref": "#/components/schemas/ItAssetsAssetIdLocationPostResponsesContentApplicationJsonSchemaDataActionsAssignAddonToOwnAssetDetails" }, { "type": "null" } ] }, "disabled_reasons": { "description": "Reasons why the action is disabled. Empty when the action is enabled or not applicable", "items": { "$ref": "#/components/schemas/ItAssetsAssetIdLocationPostResponsesContentApplicationJsonSchemaDataActionsAssignAddonToOwnAssetDisabledReasonsItems" }, "type": "array" }, "status": { "$ref": "#/components/schemas/ItAssetsAssetIdLocationPostResponsesContentApplicationJsonSchemaDataActionsAssignAddonToOwnAssetStatus", "description": "Whether the action is currently available for this asset" } }, "required": [ "status", "details", "disabled_reasons" ], "title": "ItAssetsAssetIdLocationPostResponsesContentApplicationJsonSchemaDataActionsAssignAddonToOwnAsset", "type": "object" }, "ItAssetsAssetIdLocationPostResponsesContentApplicationJsonSchemaDataActionsAssignAddonToOwnAssetDetails": { "description": "Action-specific context needed to perform the action. Populated for enabled and\ndisabled actions (so callers can see what a successful attempt would look like);\nnull when the action is not applicable to this asset.", "properties": { "addons": { "description": "Add-ons that can be assigned to the asset, with a fail reason for those that don't qualify", "items": { "$ref": "#/components/schemas/ItAssetsAssetIdLocationPostResponsesContentApplicationJsonSchemaDataActionsAssignAddonToOwnAssetDetailsAddonsItems" }, "type": "array" } }, "required": [ "addons" ], "title": "ItAssetsAssetIdLocationPostResponsesContentApplicationJsonSchemaDataActionsAssignAddonToOwnAssetDetails", "type": "object" }, "ItAssetsAssetIdLocationPostResponsesContentApplicationJsonSchemaDataActionsAssignAddonToOwnAssetDetailsAddonsItems": { "properties": { "addon": { "$ref": "#/components/schemas/ItAssetsAssetIdLocationPostResponsesContentApplicationJsonSchemaDataActionsAssignAddonToOwnAssetDetailsAddonsItemsAddon", "description": "Add-on that can be assigned to the asset" }, "fail_reason": { "description": "Reason the add-on cannot be assigned to the asset. Null when assignment is allowed", "oneOf": [ { "$ref": "#/components/schemas/ItAssetsAssetIdLocationPostResponsesContentApplicationJsonSchemaDataActionsAssignAddonToOwnAssetDetailsAddonsItemsFailReason" }, { "type": "null" } ] } }, "required": [ "addon", "fail_reason" ], "title": "ItAssetsAssetIdLocationPostResponsesContentApplicationJsonSchemaDataActionsAssignAddonToOwnAssetDetailsAddonsItems", "type": "object" }, "ItAssetsAssetIdLocationPostResponsesContentApplicationJsonSchemaDataActionsAssignAddonToOwnAssetDetailsAddonsItemsAddon": { "description": "Add-on that can be assigned to the asset", "properties": { "id": { "description": "ID of the add-on", "format": "uuid", "type": "string" }, "name": { "description": "Public display name of the add-on", "type": "string" } }, "required": [ "id", "name" ], "title": "ItAssetsAssetIdLocationPostResponsesContentApplicationJsonSchemaDataActionsAssignAddonToOwnAssetDetailsAddonsItemsAddon", "type": "object" }, "ItAssetsAssetIdLocationPostResponsesContentApplicationJsonSchemaDataActionsAssignAddonToOwnAssetDetailsAddonsItemsFailReason": { "description": "Reason the add-on cannot be assigned to the asset. Null when assignment is allowed", "enum": [ "ADDON_NOT_AVAILABLE_TO_ORGANIZATION", "ALREADY_ASSIGNED", "HAS_ACTIVE_SERVICE_ADDON", "INVALID_ASSET_AGE", "INVALID_CONTRACT_TYPE", "INVALID_DURATION", "INVALID_PAYMENT_SCHEMA", "INVALID_PLATFORM_TIER", "INVALID_PRODUCT_BRAND", "INVALID_PRODUCT_CATEGORY", "INVALID_PRODUCT_PARENT_CATEGORY", "INVALID_RENTAL_TERM", "NO_MATCHING_ORGANIZATION_CONTRACT", "OTHER" ], "title": "ItAssetsAssetIdLocationPostResponsesContentApplicationJsonSchemaDataActionsAssignAddonToOwnAssetDetailsAddonsItemsFailReason", "type": "string" }, "ItAssetsAssetIdLocationPostResponsesContentApplicationJsonSchemaDataActionsAssignAddonToOwnAssetDisabledReasonsItems": { "enum": [ "ARCHIVED", "AT_DEEL_WAREHOUSE", "BEING_REPAIRED", "CONSUMABLE", "CONTROLLED_BY_DEEL", "COUNTRY_NOT_SUPPORTED_FOR_HUB", "COUNTRY_NOT_SUPPORTED_FOR_LOCAL", "DEEL_OWNED_ITEM_WITHOUT_RENTAL_CONTRACT", "DESKTOP_STORAGE", "ENDING_CONTRACT", "HUB_IN_SAME_REGION_AS_LOCAL", "INACTIVE", "INVALID_ITEM_LOCATION", "INVALID_ORGANIZATION_STATUS", "INVALID_STATE", "ITEM_CONDITIONS_TO_UNARCHIVE_NOT_MET", "ITEM_NOT_VISIBLE_FOR_ORGANIZATION", "NON_DEVICE", "NOT_AT_WAREHOUSE", "NOT_AVAILABLE_FOR_REUSE", "NOT_A_RENTAL", "NOT_MANAGEABLE_BY_ORGANIZATION", "NOT_WITH_ASSIGNMENT", "NOT_WITH_USER", "NO_ACTIVE_ADDONS", "NO_ACTIVE_STORAGE_CONTRACT", "NO_LOCATION_FOR_STORAGE", "NO_LOGISTICS_FOR_STORAGE", "NO_VALID_ADDONS", "ONGOING_SERVICE", "OWNED_BY_DEEL", "OWNED_BY_ORGANIZATION", "OWNED_BY_PARTNER_ORGANIZATION", "PARTNER_CHILD_CONTRACT", "PENDING_DEVICE_REFRESH", "RENTAL_CONTRACT_AND_USER_REGION_DO_NOT_MATCH", "TEMPORARILY_UNAVAILABLE", "UNKNOWN", "USER_HAS_NO_COUNTRY", "USER_HAS_NO_SEAT", "WAITING_FOR_CLEARANCE", "WITH_LOANER_ASSIGNMENT", "WITH_NON_COLLECTED_ASSIGNMENT", "WITH_NON_DELIVERED_ASSIGNMENT", "WITH_PENDING_ASSIGNMENT", "WRONG_ASSIGNMENT_STATUS", "WRONG_CONTRACT_STATUS", "WRONG_TERMS_AND_CONDITIONS" ], "title": "ItAssetsAssetIdLocationPostResponsesContentApplicationJsonSchemaDataActionsAssignAddonToOwnAssetDisabledReasonsItems", "type": "string" }, "ItAssetsAssetIdLocationPostResponsesContentApplicationJsonSchemaDataActionsAssignAddonToOwnAssetStatus": { "description": "Whether the action is currently available for this asset", "enum": [ "DISABLED", "ENABLED", "NOT_APPLICABLE" ], "title": "ItAssetsAssetIdLocationPostResponsesContentApplicationJsonSchemaDataActionsAssignAddonToOwnAssetStatus", "type": "string" }, "ItAssetsAssetIdLocationPostResponsesContentApplicationJsonSchemaDataActionsClearOwnAsset": { "description": "Clear an organization-owned asset from the fleet", "properties": { "disabled_reasons": { "description": "Reasons why the action is disabled. Empty when the action is enabled or not applicable", "items": { "$ref": "#/components/schemas/ItAssetsAssetIdLocationPostResponsesContentApplicationJsonSchemaDataActionsClearOwnAssetDisabledReasonsItems" }, "type": "array" }, "status": { "$ref": "#/components/schemas/ItAssetsAssetIdLocationPostResponsesContentApplicationJsonSchemaDataActionsClearOwnAssetStatus", "description": "Whether the action is currently available for this asset" } }, "required": [ "status", "disabled_reasons" ], "title": "ItAssetsAssetIdLocationPostResponsesContentApplicationJsonSchemaDataActionsClearOwnAsset", "type": "object" }, "ItAssetsAssetIdLocationPostResponsesContentApplicationJsonSchemaDataActionsClearOwnAssetDisabledReasonsItems": { "enum": [ "ARCHIVED", "AT_DEEL_WAREHOUSE", "BEING_REPAIRED", "CONSUMABLE", "CONTROLLED_BY_DEEL", "COUNTRY_NOT_SUPPORTED_FOR_HUB", "COUNTRY_NOT_SUPPORTED_FOR_LOCAL", "DEEL_OWNED_ITEM_WITHOUT_RENTAL_CONTRACT", "DESKTOP_STORAGE", "ENDING_CONTRACT", "HUB_IN_SAME_REGION_AS_LOCAL", "INACTIVE", "INVALID_ITEM_LOCATION", "INVALID_ORGANIZATION_STATUS", "INVALID_STATE", "ITEM_CONDITIONS_TO_UNARCHIVE_NOT_MET", "ITEM_NOT_VISIBLE_FOR_ORGANIZATION", "NON_DEVICE", "NOT_AT_WAREHOUSE", "NOT_AVAILABLE_FOR_REUSE", "NOT_A_RENTAL", "NOT_MANAGEABLE_BY_ORGANIZATION", "NOT_WITH_ASSIGNMENT", "NOT_WITH_USER", "NO_ACTIVE_ADDONS", "NO_ACTIVE_STORAGE_CONTRACT", "NO_LOCATION_FOR_STORAGE", "NO_LOGISTICS_FOR_STORAGE", "NO_VALID_ADDONS", "ONGOING_SERVICE", "OWNED_BY_DEEL", "OWNED_BY_ORGANIZATION", "OWNED_BY_PARTNER_ORGANIZATION", "PARTNER_CHILD_CONTRACT", "PENDING_DEVICE_REFRESH", "RENTAL_CONTRACT_AND_USER_REGION_DO_NOT_MATCH", "TEMPORARILY_UNAVAILABLE", "UNKNOWN", "USER_HAS_NO_COUNTRY", "USER_HAS_NO_SEAT", "WAITING_FOR_CLEARANCE", "WITH_LOANER_ASSIGNMENT", "WITH_NON_COLLECTED_ASSIGNMENT", "WITH_NON_DELIVERED_ASSIGNMENT", "WITH_PENDING_ASSIGNMENT", "WRONG_ASSIGNMENT_STATUS", "WRONG_CONTRACT_STATUS", "WRONG_TERMS_AND_CONDITIONS" ], "title": "ItAssetsAssetIdLocationPostResponsesContentApplicationJsonSchemaDataActionsClearOwnAssetDisabledReasonsItems", "type": "string" }, "ItAssetsAssetIdLocationPostResponsesContentApplicationJsonSchemaDataActionsClearOwnAssetStatus": { "description": "Whether the action is currently available for this asset", "enum": [ "DISABLED", "ENABLED", "NOT_APPLICABLE" ], "title": "ItAssetsAssetIdLocationPostResponsesContentApplicationJsonSchemaDataActionsClearOwnAssetStatus", "type": "string" }, "ItAssetsAssetIdLocationPostResponsesContentApplicationJsonSchemaDataActionsManageEndOfRentalContractActions": { "description": "Manage end-of-rental options for a Deel-owned rental asset", "properties": { "disabled_reasons": { "description": "Reasons why the action is disabled. Empty when the action is enabled or not applicable", "items": { "$ref": "#/components/schemas/ItAssetsAssetIdLocationPostResponsesContentApplicationJsonSchemaDataActionsManageEndOfRentalContractActionsDisabledReasonsItems" }, "type": "array" }, "status": { "$ref": "#/components/schemas/ItAssetsAssetIdLocationPostResponsesContentApplicationJsonSchemaDataActionsManageEndOfRentalContractActionsStatus", "description": "Whether the action is currently available for this asset" } }, "required": [ "status", "disabled_reasons" ], "title": "ItAssetsAssetIdLocationPostResponsesContentApplicationJsonSchemaDataActionsManageEndOfRentalContractActions", "type": "object" }, "ItAssetsAssetIdLocationPostResponsesContentApplicationJsonSchemaDataActionsManageEndOfRentalContractActionsDisabledReasonsItems": { "enum": [ "ARCHIVED", "AT_DEEL_WAREHOUSE", "BEING_REPAIRED", "CONSUMABLE", "CONTROLLED_BY_DEEL", "COUNTRY_NOT_SUPPORTED_FOR_HUB", "COUNTRY_NOT_SUPPORTED_FOR_LOCAL", "DEEL_OWNED_ITEM_WITHOUT_RENTAL_CONTRACT", "DESKTOP_STORAGE", "ENDING_CONTRACT", "HUB_IN_SAME_REGION_AS_LOCAL", "INACTIVE", "INVALID_ITEM_LOCATION", "INVALID_ORGANIZATION_STATUS", "INVALID_STATE", "ITEM_CONDITIONS_TO_UNARCHIVE_NOT_MET", "ITEM_NOT_VISIBLE_FOR_ORGANIZATION", "NON_DEVICE", "NOT_AT_WAREHOUSE", "NOT_AVAILABLE_FOR_REUSE", "NOT_A_RENTAL", "NOT_MANAGEABLE_BY_ORGANIZATION", "NOT_WITH_ASSIGNMENT", "NOT_WITH_USER", "NO_ACTIVE_ADDONS", "NO_ACTIVE_STORAGE_CONTRACT", "NO_LOCATION_FOR_STORAGE", "NO_LOGISTICS_FOR_STORAGE", "NO_VALID_ADDONS", "ONGOING_SERVICE", "OWNED_BY_DEEL", "OWNED_BY_ORGANIZATION", "OWNED_BY_PARTNER_ORGANIZATION", "PARTNER_CHILD_CONTRACT", "PENDING_DEVICE_REFRESH", "RENTAL_CONTRACT_AND_USER_REGION_DO_NOT_MATCH", "TEMPORARILY_UNAVAILABLE", "UNKNOWN", "USER_HAS_NO_COUNTRY", "USER_HAS_NO_SEAT", "WAITING_FOR_CLEARANCE", "WITH_LOANER_ASSIGNMENT", "WITH_NON_COLLECTED_ASSIGNMENT", "WITH_NON_DELIVERED_ASSIGNMENT", "WITH_PENDING_ASSIGNMENT", "WRONG_ASSIGNMENT_STATUS", "WRONG_CONTRACT_STATUS", "WRONG_TERMS_AND_CONDITIONS" ], "title": "ItAssetsAssetIdLocationPostResponsesContentApplicationJsonSchemaDataActionsManageEndOfRentalContractActionsDisabledReasonsItems", "type": "string" }, "ItAssetsAssetIdLocationPostResponsesContentApplicationJsonSchemaDataActionsManageEndOfRentalContractActionsStatus": { "description": "Whether the action is currently available for this asset", "enum": [ "DISABLED", "ENABLED", "NOT_APPLICABLE" ], "title": "ItAssetsAssetIdLocationPostResponsesContentApplicationJsonSchemaDataActionsManageEndOfRentalContractActionsStatus", "type": "string" }, "ItAssetsAssetIdLocationPostResponsesContentApplicationJsonSchemaDataActionsPurchaseRental": { "description": "Purchase a Deel-owned rental asset at end of contract", "properties": { "details": { "description": "Action-specific context needed to perform the action. Populated for enabled and\ndisabled actions (so callers can see what a successful attempt would look like);\nnull when the action is not applicable to this asset.", "oneOf": [ { "$ref": "#/components/schemas/ItAssetsAssetIdLocationPostResponsesContentApplicationJsonSchemaDataActionsPurchaseRentalDetails" }, { "type": "null" } ] }, "disabled_reasons": { "description": "Reasons why the action is disabled. Empty when the action is enabled or not applicable", "items": { "$ref": "#/components/schemas/ItAssetsAssetIdLocationPostResponsesContentApplicationJsonSchemaDataActionsPurchaseRentalDisabledReasonsItems" }, "type": "array" }, "status": { "$ref": "#/components/schemas/ItAssetsAssetIdLocationPostResponsesContentApplicationJsonSchemaDataActionsPurchaseRentalStatus", "description": "Whether the action is currently available for this asset" } }, "required": [ "status", "details", "disabled_reasons" ], "title": "ItAssetsAssetIdLocationPostResponsesContentApplicationJsonSchemaDataActionsPurchaseRental", "type": "object" }, "ItAssetsAssetIdLocationPostResponsesContentApplicationJsonSchemaDataActionsPurchaseRentalDetails": { "description": "Action-specific context needed to perform the action. Populated for enabled and\ndisabled actions (so callers can see what a successful attempt would look like);\nnull when the action is not applicable to this asset.", "properties": { "purchase_price": { "description": "Estimated price to purchase the asset at the end of the rental contract", "oneOf": [ { "$ref": "#/components/schemas/ItAssetsAssetIdLocationPostResponsesContentApplicationJsonSchemaDataActionsPurchaseRentalDetailsPurchasePrice" }, { "type": "null" } ] }, "remaining_contract_value": { "$ref": "#/components/schemas/ItAssetsAssetIdLocationPostResponsesContentApplicationJsonSchemaDataActionsPurchaseRentalDetailsRemainingContractValue", "description": "Estimated remaining value of the rental contract" }, "total_purchase_price": { "description": "Estimated total price of the purchase, including any remaining contract value", "oneOf": [ { "$ref": "#/components/schemas/ItAssetsAssetIdLocationPostResponsesContentApplicationJsonSchemaDataActionsPurchaseRentalDetailsTotalPurchasePrice" }, { "type": "null" } ] } }, "required": [ "purchase_price", "total_purchase_price", "remaining_contract_value" ], "title": "ItAssetsAssetIdLocationPostResponsesContentApplicationJsonSchemaDataActionsPurchaseRentalDetails", "type": "object" }, "ItAssetsAssetIdLocationPostResponsesContentApplicationJsonSchemaDataActionsPurchaseRentalDetailsPurchasePrice": { "description": "Estimated price to purchase the asset at the end of the rental contract", "properties": { "amount": { "description": "Amount", "format": "decimal", "type": "string" }, "currency": { "$ref": "#/components/schemas/ItAssetsAssetIdLocationPostResponsesContentApplicationJsonSchemaDataActionsPurchaseRentalDetailsPurchasePriceCurrency", "description": "Three-letter currency code for the price" } }, "required": [ "amount", "currency" ], "title": "ItAssetsAssetIdLocationPostResponsesContentApplicationJsonSchemaDataActionsPurchaseRentalDetailsPurchasePrice", "type": "object" }, "ItAssetsAssetIdLocationPostResponsesContentApplicationJsonSchemaDataActionsPurchaseRentalDetailsPurchasePriceCurrency": { "description": "Three-letter currency code for the price", "enum": [ "AED", "AFN", "ALL", "AMD", "ANG", "AOA", "ARS", "AUD", "AWG", "AZN", "BAM", "BDT", "BGN", "BHD", "BIF", "BMD", "BOB", "BRL", "BSD", "BTN", "BWP", "BYN", "BZD", "CAD", "CDF", "CHF", "CLP", "CNY", "COP", "CRC", "CUC", "CVE", "CZK", "DJF", "DKK", "DOP", "DZD", "EGP", "ERN", "ETB", "EUR", "FJD", "FKP", "GBP", "GEL", "GHS", "GIP", "GMD", "GNF", "GTQ", "GYD", "HKD", "HNL", "HRK", "HTG", "HUF", "IDR", "ILS", "INR", "IQD", "IRR", "ISK", "JMD", "JOD", "JPY", "KES", "KGS", "KHR", "KMF", "KPW", "KRW", "KWD", "KYD", "KZT", "LAK", "LBP", "LKR", "LRD", "LSL", "LTL", "LYD", "MAD", "MDL", "MGA", "MKD", "MMK", "MNT", "MRU", "MUR", "MVR", "MWK", "MXN", "MYR", "MZN", "NAD", "NGN", "NIO", "NOK", "NPR", "NZD", "OMR", "PAB", "PEN", "PGK", "PHP", "PKR", "PLN", "PYG", "QAR", "RON", "RSD", "RUB", "RWF", "SAR", "SBD", "SCR", "SDG", "SEK", "SGD", "SHP", "SLL", "SOS", "SRD", "SSP", "STD", "SYP", "SZL", "THB", "TJS", "TMT", "TND", "TOP", "TRY", "TTD", "TWD", "TZS", "UAH", "UGX", "USD", "UYU", "UZS", "VEF", "VND", "VUV", "WST", "XAF", "XCD", "XOF", "XPF", "YER", "ZAR", "ZMW", "ZWD" ], "title": "ItAssetsAssetIdLocationPostResponsesContentApplicationJsonSchemaDataActionsPurchaseRentalDetailsPurchasePriceCurrency", "type": "string" }, "ItAssetsAssetIdLocationPostResponsesContentApplicationJsonSchemaDataActionsPurchaseRentalDetailsRemainingContractValue": { "description": "Estimated remaining value of the rental contract", "properties": { "amount": { "description": "Amount", "format": "decimal", "type": "string" }, "currency": { "$ref": "#/components/schemas/ItAssetsAssetIdLocationPostResponsesContentApplicationJsonSchemaDataActionsPurchaseRentalDetailsRemainingContractValueCurrency", "description": "Three-letter currency code for the price" } }, "required": [ "amount", "currency" ], "title": "ItAssetsAssetIdLocationPostResponsesContentApplicationJsonSchemaDataActionsPurchaseRentalDetailsRemainingContractValue", "type": "object" }, "ItAssetsAssetIdLocationPostResponsesContentApplicationJsonSchemaDataActionsPurchaseRentalDetailsRemainingContractValueCurrency": { "description": "Three-letter currency code for the price", "enum": [ "AED", "AFN", "ALL", "AMD", "ANG", "AOA", "ARS", "AUD", "AWG", "AZN", "BAM", "BDT", "BGN", "BHD", "BIF", "BMD", "BOB", "BRL", "BSD", "BTN", "BWP", "BYN", "BZD", "CAD", "CDF", "CHF", "CLP", "CNY", "COP", "CRC", "CUC", "CVE", "CZK", "DJF", "DKK", "DOP", "DZD", "EGP", "ERN", "ETB", "EUR", "FJD", "FKP", "GBP", "GEL", "GHS", "GIP", "GMD", "GNF", "GTQ", "GYD", "HKD", "HNL", "HRK", "HTG", "HUF", "IDR", "ILS", "INR", "IQD", "IRR", "ISK", "JMD", "JOD", "JPY", "KES", "KGS", "KHR", "KMF", "KPW", "KRW", "KWD", "KYD", "KZT", "LAK", "LBP", "LKR", "LRD", "LSL", "LTL", "LYD", "MAD", "MDL", "MGA", "MKD", "MMK", "MNT", "MRU", "MUR", "MVR", "MWK", "MXN", "MYR", "MZN", "NAD", "NGN", "NIO", "NOK", "NPR", "NZD", "OMR", "PAB", "PEN", "PGK", "PHP", "PKR", "PLN", "PYG", "QAR", "RON", "RSD", "RUB", "RWF", "SAR", "SBD", "SCR", "SDG", "SEK", "SGD", "SHP", "SLL", "SOS", "SRD", "SSP", "STD", "SYP", "SZL", "THB", "TJS", "TMT", "TND", "TOP", "TRY", "TTD", "TWD", "TZS", "UAH", "UGX", "USD", "UYU", "UZS", "VEF", "VND", "VUV", "WST", "XAF", "XCD", "XOF", "XPF", "YER", "ZAR", "ZMW", "ZWD" ], "title": "ItAssetsAssetIdLocationPostResponsesContentApplicationJsonSchemaDataActionsPurchaseRentalDetailsRemainingContractValueCurrency", "type": "string" }, "ItAssetsAssetIdLocationPostResponsesContentApplicationJsonSchemaDataActionsPurchaseRentalDetailsTotalPurchasePrice": { "description": "Estimated total price of the purchase, including any remaining contract value", "properties": { "amount": { "description": "Amount", "format": "decimal", "type": "string" }, "currency": { "$ref": "#/components/schemas/ItAssetsAssetIdLocationPostResponsesContentApplicationJsonSchemaDataActionsPurchaseRentalDetailsTotalPurchasePriceCurrency", "description": "Three-letter currency code for the price" } }, "required": [ "amount", "currency" ], "title": "ItAssetsAssetIdLocationPostResponsesContentApplicationJsonSchemaDataActionsPurchaseRentalDetailsTotalPurchasePrice", "type": "object" }, "ItAssetsAssetIdLocationPostResponsesContentApplicationJsonSchemaDataActionsPurchaseRentalDetailsTotalPurchasePriceCurrency": { "description": "Three-letter currency code for the price", "enum": [ "AED", "AFN", "ALL", "AMD", "ANG", "AOA", "ARS", "AUD", "AWG", "AZN", "BAM", "BDT", "BGN", "BHD", "BIF", "BMD", "BOB", "BRL", "BSD", "BTN", "BWP", "BYN", "BZD", "CAD", "CDF", "CHF", "CLP", "CNY", "COP", "CRC", "CUC", "CVE", "CZK", "DJF", "DKK", "DOP", "DZD", "EGP", "ERN", "ETB", "EUR", "FJD", "FKP", "GBP", "GEL", "GHS", "GIP", "GMD", "GNF", "GTQ", "GYD", "HKD", "HNL", "HRK", "HTG", "HUF", "IDR", "ILS", "INR", "IQD", "IRR", "ISK", "JMD", "JOD", "JPY", "KES", "KGS", "KHR", "KMF", "KPW", "KRW", "KWD", "KYD", "KZT", "LAK", "LBP", "LKR", "LRD", "LSL", "LTL", "LYD", "MAD", "MDL", "MGA", "MKD", "MMK", "MNT", "MRU", "MUR", "MVR", "MWK", "MXN", "MYR", "MZN", "NAD", "NGN", "NIO", "NOK", "NPR", "NZD", "OMR", "PAB", "PEN", "PGK", "PHP", "PKR", "PLN", "PYG", "QAR", "RON", "RSD", "RUB", "RWF", "SAR", "SBD", "SCR", "SDG", "SEK", "SGD", "SHP", "SLL", "SOS", "SRD", "SSP", "STD", "SYP", "SZL", "THB", "TJS", "TMT", "TND", "TOP", "TRY", "TTD", "TWD", "TZS", "UAH", "UGX", "USD", "UYU", "UZS", "VEF", "VND", "VUV", "WST", "XAF", "XCD", "XOF", "XPF", "YER", "ZAR", "ZMW", "ZWD" ], "title": "ItAssetsAssetIdLocationPostResponsesContentApplicationJsonSchemaDataActionsPurchaseRentalDetailsTotalPurchasePriceCurrency", "type": "string" }, "ItAssetsAssetIdLocationPostResponsesContentApplicationJsonSchemaDataActionsPurchaseRentalDisabledReasonsItems": { "enum": [ "ARCHIVED", "AT_DEEL_WAREHOUSE", "BEING_REPAIRED", "CONSUMABLE", "CONTROLLED_BY_DEEL", "COUNTRY_NOT_SUPPORTED_FOR_HUB", "COUNTRY_NOT_SUPPORTED_FOR_LOCAL", "DEEL_OWNED_ITEM_WITHOUT_RENTAL_CONTRACT", "DESKTOP_STORAGE", "ENDING_CONTRACT", "HUB_IN_SAME_REGION_AS_LOCAL", "INACTIVE", "INVALID_ITEM_LOCATION", "INVALID_ORGANIZATION_STATUS", "INVALID_STATE", "ITEM_CONDITIONS_TO_UNARCHIVE_NOT_MET", "ITEM_NOT_VISIBLE_FOR_ORGANIZATION", "NON_DEVICE", "NOT_AT_WAREHOUSE", "NOT_AVAILABLE_FOR_REUSE", "NOT_A_RENTAL", "NOT_MANAGEABLE_BY_ORGANIZATION", "NOT_WITH_ASSIGNMENT", "NOT_WITH_USER", "NO_ACTIVE_ADDONS", "NO_ACTIVE_STORAGE_CONTRACT", "NO_LOCATION_FOR_STORAGE", "NO_LOGISTICS_FOR_STORAGE", "NO_VALID_ADDONS", "ONGOING_SERVICE", "OWNED_BY_DEEL", "OWNED_BY_ORGANIZATION", "OWNED_BY_PARTNER_ORGANIZATION", "PARTNER_CHILD_CONTRACT", "PENDING_DEVICE_REFRESH", "RENTAL_CONTRACT_AND_USER_REGION_DO_NOT_MATCH", "TEMPORARILY_UNAVAILABLE", "UNKNOWN", "USER_HAS_NO_COUNTRY", "USER_HAS_NO_SEAT", "WAITING_FOR_CLEARANCE", "WITH_LOANER_ASSIGNMENT", "WITH_NON_COLLECTED_ASSIGNMENT", "WITH_NON_DELIVERED_ASSIGNMENT", "WITH_PENDING_ASSIGNMENT", "WRONG_ASSIGNMENT_STATUS", "WRONG_CONTRACT_STATUS", "WRONG_TERMS_AND_CONDITIONS" ], "title": "ItAssetsAssetIdLocationPostResponsesContentApplicationJsonSchemaDataActionsPurchaseRentalDisabledReasonsItems", "type": "string" }, "ItAssetsAssetIdLocationPostResponsesContentApplicationJsonSchemaDataActionsPurchaseRentalStatus": { "description": "Whether the action is currently available for this asset", "enum": [ "DISABLED", "ENABLED", "NOT_APPLICABLE" ], "title": "ItAssetsAssetIdLocationPostResponsesContentApplicationJsonSchemaDataActionsPurchaseRentalStatus", "type": "string" }, "ItAssetsAssetIdLocationPostResponsesContentApplicationJsonSchemaDataActionsReturnRentalToDeel": { "description": "Return a Deel-owned rental asset back to Deel", "properties": { "details": { "description": "Action-specific context needed to perform the action. Populated for enabled and\ndisabled actions (so callers can see what a successful attempt would look like);\nnull when the action is not applicable to this asset.", "oneOf": [ { "$ref": "#/components/schemas/ItAssetsAssetIdLocationPostResponsesContentApplicationJsonSchemaDataActionsReturnRentalToDeelDetails" }, { "type": "null" } ] }, "disabled_reasons": { "description": "Reasons why the action is disabled. Empty when the action is enabled or not applicable", "items": { "$ref": "#/components/schemas/ItAssetsAssetIdLocationPostResponsesContentApplicationJsonSchemaDataActionsReturnRentalToDeelDisabledReasonsItems" }, "type": "array" }, "status": { "$ref": "#/components/schemas/ItAssetsAssetIdLocationPostResponsesContentApplicationJsonSchemaDataActionsReturnRentalToDeelStatus", "description": "Whether the action is currently available for this asset" } }, "required": [ "status", "details", "disabled_reasons" ], "title": "ItAssetsAssetIdLocationPostResponsesContentApplicationJsonSchemaDataActionsReturnRentalToDeel", "type": "object" }, "ItAssetsAssetIdLocationPostResponsesContentApplicationJsonSchemaDataActionsReturnRentalToDeelDetails": { "description": "Action-specific context needed to perform the action. Populated for enabled and\ndisabled actions (so callers can see what a successful attempt would look like);\nnull when the action is not applicable to this asset.", "properties": { "end_contract_price": { "$ref": "#/components/schemas/ItAssetsAssetIdLocationPostResponsesContentApplicationJsonSchemaDataActionsReturnRentalToDeelDetailsEndContractPrice", "description": "Estimated end-of-contract price charged when returning the asset" } }, "required": [ "end_contract_price" ], "title": "ItAssetsAssetIdLocationPostResponsesContentApplicationJsonSchemaDataActionsReturnRentalToDeelDetails", "type": "object" }, "ItAssetsAssetIdLocationPostResponsesContentApplicationJsonSchemaDataActionsReturnRentalToDeelDetailsEndContractPrice": { "description": "Estimated end-of-contract price charged when returning the asset", "properties": { "amount": { "description": "Amount", "format": "decimal", "type": "string" }, "currency": { "$ref": "#/components/schemas/ItAssetsAssetIdLocationPostResponsesContentApplicationJsonSchemaDataActionsReturnRentalToDeelDetailsEndContractPriceCurrency", "description": "Three-letter currency code for the price" } }, "required": [ "amount", "currency" ], "title": "ItAssetsAssetIdLocationPostResponsesContentApplicationJsonSchemaDataActionsReturnRentalToDeelDetailsEndContractPrice", "type": "object" }, "ItAssetsAssetIdLocationPostResponsesContentApplicationJsonSchemaDataActionsReturnRentalToDeelDetailsEndContractPriceCurrency": { "description": "Three-letter currency code for the price", "enum": [ "AED", "AFN", "ALL", "AMD", "ANG", "AOA", "ARS", "AUD", "AWG", "AZN", "BAM", "BDT", "BGN", "BHD", "BIF", "BMD", "BOB", "BRL", "BSD", "BTN", "BWP", "BYN", "BZD", "CAD", "CDF", "CHF", "CLP", "CNY", "COP", "CRC", "CUC", "CVE", "CZK", "DJF", "DKK", "DOP", "DZD", "EGP", "ERN", "ETB", "EUR", "FJD", "FKP", "GBP", "GEL", "GHS", "GIP", "GMD", "GNF", "GTQ", "GYD", "HKD", "HNL", "HRK", "HTG", "HUF", "IDR", "ILS", "INR", "IQD", "IRR", "ISK", "JMD", "JOD", "JPY", "KES", "KGS", "KHR", "KMF", "KPW", "KRW", "KWD", "KYD", "KZT", "LAK", "LBP", "LKR", "LRD", "LSL", "LTL", "LYD", "MAD", "MDL", "MGA", "MKD", "MMK", "MNT", "MRU", "MUR", "MVR", "MWK", "MXN", "MYR", "MZN", "NAD", "NGN", "NIO", "NOK", "NPR", "NZD", "OMR", "PAB", "PEN", "PGK", "PHP", "PKR", "PLN", "PYG", "QAR", "RON", "RSD", "RUB", "RWF", "SAR", "SBD", "SCR", "SDG", "SEK", "SGD", "SHP", "SLL", "SOS", "SRD", "SSP", "STD", "SYP", "SZL", "THB", "TJS", "TMT", "TND", "TOP", "TRY", "TTD", "TWD", "TZS", "UAH", "UGX", "USD", "UYU", "UZS", "VEF", "VND", "VUV", "WST", "XAF", "XCD", "XOF", "XPF", "YER", "ZAR", "ZMW", "ZWD" ], "title": "ItAssetsAssetIdLocationPostResponsesContentApplicationJsonSchemaDataActionsReturnRentalToDeelDetailsEndContractPriceCurrency", "type": "string" }, "ItAssetsAssetIdLocationPostResponsesContentApplicationJsonSchemaDataActionsReturnRentalToDeelDisabledReasonsItems": { "enum": [ "ARCHIVED", "AT_DEEL_WAREHOUSE", "BEING_REPAIRED", "CONSUMABLE", "CONTROLLED_BY_DEEL", "COUNTRY_NOT_SUPPORTED_FOR_HUB", "COUNTRY_NOT_SUPPORTED_FOR_LOCAL", "DEEL_OWNED_ITEM_WITHOUT_RENTAL_CONTRACT", "DESKTOP_STORAGE", "ENDING_CONTRACT", "HUB_IN_SAME_REGION_AS_LOCAL", "INACTIVE", "INVALID_ITEM_LOCATION", "INVALID_ORGANIZATION_STATUS", "INVALID_STATE", "ITEM_CONDITIONS_TO_UNARCHIVE_NOT_MET", "ITEM_NOT_VISIBLE_FOR_ORGANIZATION", "NON_DEVICE", "NOT_AT_WAREHOUSE", "NOT_AVAILABLE_FOR_REUSE", "NOT_A_RENTAL", "NOT_MANAGEABLE_BY_ORGANIZATION", "NOT_WITH_ASSIGNMENT", "NOT_WITH_USER", "NO_ACTIVE_ADDONS", "NO_ACTIVE_STORAGE_CONTRACT", "NO_LOCATION_FOR_STORAGE", "NO_LOGISTICS_FOR_STORAGE", "NO_VALID_ADDONS", "ONGOING_SERVICE", "OWNED_BY_DEEL", "OWNED_BY_ORGANIZATION", "OWNED_BY_PARTNER_ORGANIZATION", "PARTNER_CHILD_CONTRACT", "PENDING_DEVICE_REFRESH", "RENTAL_CONTRACT_AND_USER_REGION_DO_NOT_MATCH", "TEMPORARILY_UNAVAILABLE", "UNKNOWN", "USER_HAS_NO_COUNTRY", "USER_HAS_NO_SEAT", "WAITING_FOR_CLEARANCE", "WITH_LOANER_ASSIGNMENT", "WITH_NON_COLLECTED_ASSIGNMENT", "WITH_NON_DELIVERED_ASSIGNMENT", "WITH_PENDING_ASSIGNMENT", "WRONG_ASSIGNMENT_STATUS", "WRONG_CONTRACT_STATUS", "WRONG_TERMS_AND_CONDITIONS" ], "title": "ItAssetsAssetIdLocationPostResponsesContentApplicationJsonSchemaDataActionsReturnRentalToDeelDisabledReasonsItems", "type": "string" }, "ItAssetsAssetIdLocationPostResponsesContentApplicationJsonSchemaDataActionsReturnRentalToDeelStatus": { "description": "Whether the action is currently available for this asset", "enum": [ "DISABLED", "ENABLED", "NOT_APPLICABLE" ], "title": "ItAssetsAssetIdLocationPostResponsesContentApplicationJsonSchemaDataActionsReturnRentalToDeelStatus", "type": "string" }, "ItAssetsAssetIdLocationPostResponsesContentApplicationJsonSchemaDataActionsReuseOwnAssetFromDeel": { "description": "Redeploy an organization-owned asset stored at a Deel warehouse", "properties": { "details": { "description": "Action-specific context needed to perform the action. Populated for enabled and\ndisabled actions (so callers can see what a successful attempt would look like);\nnull when the action is not applicable to this asset.", "oneOf": [ { "$ref": "#/components/schemas/ItAssetsAssetIdLocationPostResponsesContentApplicationJsonSchemaDataActionsReuseOwnAssetFromDeelDetails" }, { "type": "null" } ] }, "disabled_reasons": { "description": "Reasons why the action is disabled. Empty when the action is enabled or not applicable", "items": { "$ref": "#/components/schemas/ItAssetsAssetIdLocationPostResponsesContentApplicationJsonSchemaDataActionsReuseOwnAssetFromDeelDisabledReasonsItems" }, "type": "array" }, "status": { "$ref": "#/components/schemas/ItAssetsAssetIdLocationPostResponsesContentApplicationJsonSchemaDataActionsReuseOwnAssetFromDeelStatus", "description": "Whether the action is currently available for this asset" } }, "required": [ "status", "details", "disabled_reasons" ], "title": "ItAssetsAssetIdLocationPostResponsesContentApplicationJsonSchemaDataActionsReuseOwnAssetFromDeel", "type": "object" }, "ItAssetsAssetIdLocationPostResponsesContentApplicationJsonSchemaDataActionsReuseOwnAssetFromDeelDetails": { "description": "Action-specific context needed to perform the action. Populated for enabled and\ndisabled actions (so callers can see what a successful attempt would look like);\nnull when the action is not applicable to this asset.", "properties": { "eligible_countries": { "description": "Countries where the asset can be redeployed from Deel", "items": { "$ref": "#/components/schemas/ItAssetsAssetIdLocationPostResponsesContentApplicationJsonSchemaDataActionsReuseOwnAssetFromDeelDetailsEligibleCountriesItems" }, "type": "array" }, "express_delivery": { "description": "Express delivery availability and per-country fees. Null when express delivery is not supported", "oneOf": [ { "$ref": "#/components/schemas/ItAssetsAssetIdLocationPostResponsesContentApplicationJsonSchemaDataActionsReuseOwnAssetFromDeelDetailsExpressDelivery" }, { "type": "null" } ] } }, "required": [ "express_delivery", "eligible_countries" ], "title": "ItAssetsAssetIdLocationPostResponsesContentApplicationJsonSchemaDataActionsReuseOwnAssetFromDeelDetails", "type": "object" }, "ItAssetsAssetIdLocationPostResponsesContentApplicationJsonSchemaDataActionsReuseOwnAssetFromDeelDetailsEligibleCountriesItems": { "enum": [ "AD", "AE", "AF", "AG", "AI", "AL", "AM", "AN", "AO", "AQ", "AR", "AS", "AT", "AU", "AW", "AX", "AZ", "BA", "BB", "BD", "BE", "BF", "BG", "BH", "BI", "BJ", "BL", "BM", "BN", "BO", "BQ", "BR", "BS", "BT", "BV", "BW", "BY", "BZ", "CA", "CC", "CD", "CF", "CG", "CH", "CI", "CK", "CL", "CM", "CN", "CO", "CR", "CU", "CV", "CW", "CX", "CY", "CZ", "DE", "DJ", "DK", "DM", "DO", "DZ", "EC", "EE", "EG", "EH", "ER", "ES", "ET", "FI", "FJ", "FK", "FM", "FO", "FR", "GA", "GB", "GD", "GE", "GF", "GG", "GH", "GI", "GL", "GM", "GN", "GP", "GQ", "GR", "GS", "GT", "GU", "GW", "GY", "HK", "HM", "HN", "HR", "HT", "HU", "IC", "ID", "IE", "IL", "IM", "IN", "IO", "IQ", "IR", "IS", "IT", "JE", "JM", "JO", "JP", "KE", "KG", "KH", "KI", "KM", "KN", "KP", "KR", "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", "XK", "YE", "YT", "ZA", "ZM", "ZW" ], "title": "ItAssetsAssetIdLocationPostResponsesContentApplicationJsonSchemaDataActionsReuseOwnAssetFromDeelDetailsEligibleCountriesItems", "type": "string" }, "ItAssetsAssetIdLocationPostResponsesContentApplicationJsonSchemaDataActionsReuseOwnAssetFromDeelDetailsExpressDelivery": { "description": "Express delivery availability and per-country fees. Null when express delivery is not supported", "properties": { "country_fees": { "additionalProperties": { "$ref": "#/components/schemas/ItAssetsAssetIdLocationPostResponsesContentApplicationJsonSchemaDataActionsReuseOwnAssetFromDeelDetailsExpressDeliveryCountryFees" }, "description": "Express delivery fees keyed by destination country.", "type": "object" } }, "required": [ "country_fees" ], "title": "ItAssetsAssetIdLocationPostResponsesContentApplicationJsonSchemaDataActionsReuseOwnAssetFromDeelDetailsExpressDelivery", "type": "object" }, "ItAssetsAssetIdLocationPostResponsesContentApplicationJsonSchemaDataActionsReuseOwnAssetFromDeelDetailsExpressDeliveryCountryFees": { "properties": { "amount": { "description": "Amount", "format": "decimal", "type": "string" }, "currency": { "$ref": "#/components/schemas/ItAssetsAssetIdLocationPostResponsesContentApplicationJsonSchemaDataActionsReuseOwnAssetFromDeelDetailsExpressDeliveryCountryFeesCurrency", "description": "Three-letter currency code for the price" } }, "required": [ "amount", "currency" ], "title": "ItAssetsAssetIdLocationPostResponsesContentApplicationJsonSchemaDataActionsReuseOwnAssetFromDeelDetailsExpressDeliveryCountryFees", "type": "object" }, "ItAssetsAssetIdLocationPostResponsesContentApplicationJsonSchemaDataActionsReuseOwnAssetFromDeelDetailsExpressDeliveryCountryFeesCurrency": { "description": "Three-letter currency code for the price", "enum": [ "AED", "AFN", "ALL", "AMD", "ANG", "AOA", "ARS", "AUD", "AWG", "AZN", "BAM", "BDT", "BGN", "BHD", "BIF", "BMD", "BOB", "BRL", "BSD", "BTN", "BWP", "BYN", "BZD", "CAD", "CDF", "CHF", "CLP", "CNY", "COP", "CRC", "CUC", "CVE", "CZK", "DJF", "DKK", "DOP", "DZD", "EGP", "ERN", "ETB", "EUR", "FJD", "FKP", "GBP", "GEL", "GHS", "GIP", "GMD", "GNF", "GTQ", "GYD", "HKD", "HNL", "HRK", "HTG", "HUF", "IDR", "ILS", "INR", "IQD", "IRR", "ISK", "JMD", "JOD", "JPY", "KES", "KGS", "KHR", "KMF", "KPW", "KRW", "KWD", "KYD", "KZT", "LAK", "LBP", "LKR", "LRD", "LSL", "LTL", "LYD", "MAD", "MDL", "MGA", "MKD", "MMK", "MNT", "MRU", "MUR", "MVR", "MWK", "MXN", "MYR", "MZN", "NAD", "NGN", "NIO", "NOK", "NPR", "NZD", "OMR", "PAB", "PEN", "PGK", "PHP", "PKR", "PLN", "PYG", "QAR", "RON", "RSD", "RUB", "RWF", "SAR", "SBD", "SCR", "SDG", "SEK", "SGD", "SHP", "SLL", "SOS", "SRD", "SSP", "STD", "SYP", "SZL", "THB", "TJS", "TMT", "TND", "TOP", "TRY", "TTD", "TWD", "TZS", "UAH", "UGX", "USD", "UYU", "UZS", "VEF", "VND", "VUV", "WST", "XAF", "XCD", "XOF", "XPF", "YER", "ZAR", "ZMW", "ZWD" ], "title": "ItAssetsAssetIdLocationPostResponsesContentApplicationJsonSchemaDataActionsReuseOwnAssetFromDeelDetailsExpressDeliveryCountryFeesCurrency", "type": "string" }, "ItAssetsAssetIdLocationPostResponsesContentApplicationJsonSchemaDataActionsReuseOwnAssetFromDeelDisabledReasonsItems": { "enum": [ "ARCHIVED", "AT_DEEL_WAREHOUSE", "BEING_REPAIRED", "CONSUMABLE", "CONTROLLED_BY_DEEL", "COUNTRY_NOT_SUPPORTED_FOR_HUB", "COUNTRY_NOT_SUPPORTED_FOR_LOCAL", "DEEL_OWNED_ITEM_WITHOUT_RENTAL_CONTRACT", "DESKTOP_STORAGE", "ENDING_CONTRACT", "HUB_IN_SAME_REGION_AS_LOCAL", "INACTIVE", "INVALID_ITEM_LOCATION", "INVALID_ORGANIZATION_STATUS", "INVALID_STATE", "ITEM_CONDITIONS_TO_UNARCHIVE_NOT_MET", "ITEM_NOT_VISIBLE_FOR_ORGANIZATION", "NON_DEVICE", "NOT_AT_WAREHOUSE", "NOT_AVAILABLE_FOR_REUSE", "NOT_A_RENTAL", "NOT_MANAGEABLE_BY_ORGANIZATION", "NOT_WITH_ASSIGNMENT", "NOT_WITH_USER", "NO_ACTIVE_ADDONS", "NO_ACTIVE_STORAGE_CONTRACT", "NO_LOCATION_FOR_STORAGE", "NO_LOGISTICS_FOR_STORAGE", "NO_VALID_ADDONS", "ONGOING_SERVICE", "OWNED_BY_DEEL", "OWNED_BY_ORGANIZATION", "OWNED_BY_PARTNER_ORGANIZATION", "PARTNER_CHILD_CONTRACT", "PENDING_DEVICE_REFRESH", "RENTAL_CONTRACT_AND_USER_REGION_DO_NOT_MATCH", "TEMPORARILY_UNAVAILABLE", "UNKNOWN", "USER_HAS_NO_COUNTRY", "USER_HAS_NO_SEAT", "WAITING_FOR_CLEARANCE", "WITH_LOANER_ASSIGNMENT", "WITH_NON_COLLECTED_ASSIGNMENT", "WITH_NON_DELIVERED_ASSIGNMENT", "WITH_PENDING_ASSIGNMENT", "WRONG_ASSIGNMENT_STATUS", "WRONG_CONTRACT_STATUS", "WRONG_TERMS_AND_CONDITIONS" ], "title": "ItAssetsAssetIdLocationPostResponsesContentApplicationJsonSchemaDataActionsReuseOwnAssetFromDeelDisabledReasonsItems", "type": "string" }, "ItAssetsAssetIdLocationPostResponsesContentApplicationJsonSchemaDataActionsReuseOwnAssetFromDeelStatus": { "description": "Whether the action is currently available for this asset", "enum": [ "DISABLED", "ENABLED", "NOT_APPLICABLE" ], "title": "ItAssetsAssetIdLocationPostResponsesContentApplicationJsonSchemaDataActionsReuseOwnAssetFromDeelStatus", "type": "string" }, "ItAssetsAssetIdLocationPostResponsesContentApplicationJsonSchemaDataActionsReuseOwnAssetFromOwnLocation": { "description": "Redeploy an organization-owned asset from an organization-owned location", "properties": { "details": { "description": "Action-specific context needed to perform the action. Populated for enabled and\ndisabled actions (so callers can see what a successful attempt would look like);\nnull when the action is not applicable to this asset.", "oneOf": [ { "$ref": "#/components/schemas/ItAssetsAssetIdLocationPostResponsesContentApplicationJsonSchemaDataActionsReuseOwnAssetFromOwnLocationDetails" }, { "type": "null" } ] }, "disabled_reasons": { "description": "Reasons why the action is disabled. Empty when the action is enabled or not applicable", "items": { "$ref": "#/components/schemas/ItAssetsAssetIdLocationPostResponsesContentApplicationJsonSchemaDataActionsReuseOwnAssetFromOwnLocationDisabledReasonsItems" }, "type": "array" }, "status": { "$ref": "#/components/schemas/ItAssetsAssetIdLocationPostResponsesContentApplicationJsonSchemaDataActionsReuseOwnAssetFromOwnLocationStatus", "description": "Whether the action is currently available for this asset" } }, "required": [ "status", "details", "disabled_reasons" ], "title": "ItAssetsAssetIdLocationPostResponsesContentApplicationJsonSchemaDataActionsReuseOwnAssetFromOwnLocation", "type": "object" }, "ItAssetsAssetIdLocationPostResponsesContentApplicationJsonSchemaDataActionsReuseOwnAssetFromOwnLocationDetails": { "description": "Action-specific context needed to perform the action. Populated for enabled and\ndisabled actions (so callers can see what a successful attempt would look like);\nnull when the action is not applicable to this asset.", "properties": { "eligible_countries": { "description": "Countries where the asset can be redeployed from an organization-owned location", "items": { "$ref": "#/components/schemas/ItAssetsAssetIdLocationPostResponsesContentApplicationJsonSchemaDataActionsReuseOwnAssetFromOwnLocationDetailsEligibleCountriesItems" }, "type": "array" }, "express_delivery": { "description": "Express delivery availability and per-country fees. Null when express delivery is not supported", "oneOf": [ { "$ref": "#/components/schemas/ItAssetsAssetIdLocationPostResponsesContentApplicationJsonSchemaDataActionsReuseOwnAssetFromOwnLocationDetailsExpressDelivery" }, { "type": "null" } ] }, "service_cost": { "$ref": "#/components/schemas/ItAssetsAssetIdLocationPostResponsesContentApplicationJsonSchemaDataActionsReuseOwnAssetFromOwnLocationDetailsServiceCost", "description": "Cost charged for the transfer service" } }, "required": [ "service_cost", "express_delivery", "eligible_countries" ], "title": "ItAssetsAssetIdLocationPostResponsesContentApplicationJsonSchemaDataActionsReuseOwnAssetFromOwnLocationDetails", "type": "object" }, "ItAssetsAssetIdLocationPostResponsesContentApplicationJsonSchemaDataActionsReuseOwnAssetFromOwnLocationDetailsEligibleCountriesItems": { "enum": [ "AD", "AE", "AF", "AG", "AI", "AL", "AM", "AN", "AO", "AQ", "AR", "AS", "AT", "AU", "AW", "AX", "AZ", "BA", "BB", "BD", "BE", "BF", "BG", "BH", "BI", "BJ", "BL", "BM", "BN", "BO", "BQ", "BR", "BS", "BT", "BV", "BW", "BY", "BZ", "CA", "CC", "CD", "CF", "CG", "CH", "CI", "CK", "CL", "CM", "CN", "CO", "CR", "CU", "CV", "CW", "CX", "CY", "CZ", "DE", "DJ", "DK", "DM", "DO", "DZ", "EC", "EE", "EG", "EH", "ER", "ES", "ET", "FI", "FJ", "FK", "FM", "FO", "FR", "GA", "GB", "GD", "GE", "GF", "GG", "GH", "GI", "GL", "GM", "GN", "GP", "GQ", "GR", "GS", "GT", "GU", "GW", "GY", "HK", "HM", "HN", "HR", "HT", "HU", "IC", "ID", "IE", "IL", "IM", "IN", "IO", "IQ", "IR", "IS", "IT", "JE", "JM", "JO", "JP", "KE", "KG", "KH", "KI", "KM", "KN", "KP", "KR", "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", "XK", "YE", "YT", "ZA", "ZM", "ZW" ], "title": "ItAssetsAssetIdLocationPostResponsesContentApplicationJsonSchemaDataActionsReuseOwnAssetFromOwnLocationDetailsEligibleCountriesItems", "type": "string" }, "ItAssetsAssetIdLocationPostResponsesContentApplicationJsonSchemaDataActionsReuseOwnAssetFromOwnLocationDetailsExpressDelivery": { "description": "Express delivery availability and per-country fees. Null when express delivery is not supported", "properties": { "country_fees": { "additionalProperties": { "$ref": "#/components/schemas/ItAssetsAssetIdLocationPostResponsesContentApplicationJsonSchemaDataActionsReuseOwnAssetFromOwnLocationDetailsExpressDeliveryCountryFees" }, "description": "Express delivery fees keyed by destination country.", "type": "object" } }, "required": [ "country_fees" ], "title": "ItAssetsAssetIdLocationPostResponsesContentApplicationJsonSchemaDataActionsReuseOwnAssetFromOwnLocationDetailsExpressDelivery", "type": "object" }, "ItAssetsAssetIdLocationPostResponsesContentApplicationJsonSchemaDataActionsReuseOwnAssetFromOwnLocationDetailsExpressDeliveryCountryFees": { "properties": { "amount": { "description": "Amount", "format": "decimal", "type": "string" }, "currency": { "$ref": "#/components/schemas/ItAssetsAssetIdLocationPostResponsesContentApplicationJsonSchemaDataActionsReuseOwnAssetFromOwnLocationDetailsExpressDeliveryCountryFeesCurrency", "description": "Three-letter currency code for the price" } }, "required": [ "amount", "currency" ], "title": "ItAssetsAssetIdLocationPostResponsesContentApplicationJsonSchemaDataActionsReuseOwnAssetFromOwnLocationDetailsExpressDeliveryCountryFees", "type": "object" }, "ItAssetsAssetIdLocationPostResponsesContentApplicationJsonSchemaDataActionsReuseOwnAssetFromOwnLocationDetailsExpressDeliveryCountryFeesCurrency": { "description": "Three-letter currency code for the price", "enum": [ "AED", "AFN", "ALL", "AMD", "ANG", "AOA", "ARS", "AUD", "AWG", "AZN", "BAM", "BDT", "BGN", "BHD", "BIF", "BMD", "BOB", "BRL", "BSD", "BTN", "BWP", "BYN", "BZD", "CAD", "CDF", "CHF", "CLP", "CNY", "COP", "CRC", "CUC", "CVE", "CZK", "DJF", "DKK", "DOP", "DZD", "EGP", "ERN", "ETB", "EUR", "FJD", "FKP", "GBP", "GEL", "GHS", "GIP", "GMD", "GNF", "GTQ", "GYD", "HKD", "HNL", "HRK", "HTG", "HUF", "IDR", "ILS", "INR", "IQD", "IRR", "ISK", "JMD", "JOD", "JPY", "KES", "KGS", "KHR", "KMF", "KPW", "KRW", "KWD", "KYD", "KZT", "LAK", "LBP", "LKR", "LRD", "LSL", "LTL", "LYD", "MAD", "MDL", "MGA", "MKD", "MMK", "MNT", "MRU", "MUR", "MVR", "MWK", "MXN", "MYR", "MZN", "NAD", "NGN", "NIO", "NOK", "NPR", "NZD", "OMR", "PAB", "PEN", "PGK", "PHP", "PKR", "PLN", "PYG", "QAR", "RON", "RSD", "RUB", "RWF", "SAR", "SBD", "SCR", "SDG", "SEK", "SGD", "SHP", "SLL", "SOS", "SRD", "SSP", "STD", "SYP", "SZL", "THB", "TJS", "TMT", "TND", "TOP", "TRY", "TTD", "TWD", "TZS", "UAH", "UGX", "USD", "UYU", "UZS", "VEF", "VND", "VUV", "WST", "XAF", "XCD", "XOF", "XPF", "YER", "ZAR", "ZMW", "ZWD" ], "title": "ItAssetsAssetIdLocationPostResponsesContentApplicationJsonSchemaDataActionsReuseOwnAssetFromOwnLocationDetailsExpressDeliveryCountryFeesCurrency", "type": "string" }, "ItAssetsAssetIdLocationPostResponsesContentApplicationJsonSchemaDataActionsReuseOwnAssetFromOwnLocationDetailsServiceCost": { "description": "Cost charged for the transfer service", "properties": { "billing_method": { "$ref": "#/components/schemas/ItAssetsAssetIdLocationPostResponsesContentApplicationJsonSchemaDataActionsReuseOwnAssetFromOwnLocationDetailsServiceCostBillingMethod", "description": "How the action is charged. When \"TOKEN\", the fees are covered by an\nadd-on token pool; when \"CURRENCY\", the fees are billed in the currency\nspecified in the \"fees\" field." }, "fees": { "description": "Price charged for the action. Null when billing method is \"TOKEN\"", "oneOf": [ { "$ref": "#/components/schemas/ItAssetsAssetIdLocationPostResponsesContentApplicationJsonSchemaDataActionsReuseOwnAssetFromOwnLocationDetailsServiceCostFees" }, { "type": "null" } ] }, "token_usage": { "description": "Add-on token consumption details. Null when billing method is \"CURRENCY\"", "oneOf": [ { "$ref": "#/components/schemas/ItAssetsAssetIdLocationPostResponsesContentApplicationJsonSchemaDataActionsReuseOwnAssetFromOwnLocationDetailsServiceCostTokenUsage" }, { "type": "null" } ] } }, "required": [ "fees", "token_usage", "billing_method" ], "title": "ItAssetsAssetIdLocationPostResponsesContentApplicationJsonSchemaDataActionsReuseOwnAssetFromOwnLocationDetailsServiceCost", "type": "object" }, "ItAssetsAssetIdLocationPostResponsesContentApplicationJsonSchemaDataActionsReuseOwnAssetFromOwnLocationDetailsServiceCostBillingMethod": { "description": "How the action is charged. When \"TOKEN\", the fees are covered by an\nadd-on token pool; when \"CURRENCY\", the fees are billed in the currency\nspecified in the \"fees\" field.", "enum": [ "CURRENCY", "TOKEN" ], "title": "ItAssetsAssetIdLocationPostResponsesContentApplicationJsonSchemaDataActionsReuseOwnAssetFromOwnLocationDetailsServiceCostBillingMethod", "type": "string" }, "ItAssetsAssetIdLocationPostResponsesContentApplicationJsonSchemaDataActionsReuseOwnAssetFromOwnLocationDetailsServiceCostFees": { "description": "Price charged for the action. Null when billing method is \"TOKEN\"", "properties": { "amount": { "description": "Amount", "format": "decimal", "type": "string" }, "currency": { "$ref": "#/components/schemas/ItAssetsAssetIdLocationPostResponsesContentApplicationJsonSchemaDataActionsReuseOwnAssetFromOwnLocationDetailsServiceCostFeesCurrency", "description": "Three-letter currency code for the price" } }, "required": [ "amount", "currency" ], "title": "ItAssetsAssetIdLocationPostResponsesContentApplicationJsonSchemaDataActionsReuseOwnAssetFromOwnLocationDetailsServiceCostFees", "type": "object" }, "ItAssetsAssetIdLocationPostResponsesContentApplicationJsonSchemaDataActionsReuseOwnAssetFromOwnLocationDetailsServiceCostFeesCurrency": { "description": "Three-letter currency code for the price", "enum": [ "AED", "AFN", "ALL", "AMD", "ANG", "AOA", "ARS", "AUD", "AWG", "AZN", "BAM", "BDT", "BGN", "BHD", "BIF", "BMD", "BOB", "BRL", "BSD", "BTN", "BWP", "BYN", "BZD", "CAD", "CDF", "CHF", "CLP", "CNY", "COP", "CRC", "CUC", "CVE", "CZK", "DJF", "DKK", "DOP", "DZD", "EGP", "ERN", "ETB", "EUR", "FJD", "FKP", "GBP", "GEL", "GHS", "GIP", "GMD", "GNF", "GTQ", "GYD", "HKD", "HNL", "HRK", "HTG", "HUF", "IDR", "ILS", "INR", "IQD", "IRR", "ISK", "JMD", "JOD", "JPY", "KES", "KGS", "KHR", "KMF", "KPW", "KRW", "KWD", "KYD", "KZT", "LAK", "LBP", "LKR", "LRD", "LSL", "LTL", "LYD", "MAD", "MDL", "MGA", "MKD", "MMK", "MNT", "MRU", "MUR", "MVR", "MWK", "MXN", "MYR", "MZN", "NAD", "NGN", "NIO", "NOK", "NPR", "NZD", "OMR", "PAB", "PEN", "PGK", "PHP", "PKR", "PLN", "PYG", "QAR", "RON", "RSD", "RUB", "RWF", "SAR", "SBD", "SCR", "SDG", "SEK", "SGD", "SHP", "SLL", "SOS", "SRD", "SSP", "STD", "SYP", "SZL", "THB", "TJS", "TMT", "TND", "TOP", "TRY", "TTD", "TWD", "TZS", "UAH", "UGX", "USD", "UYU", "UZS", "VEF", "VND", "VUV", "WST", "XAF", "XCD", "XOF", "XPF", "YER", "ZAR", "ZMW", "ZWD" ], "title": "ItAssetsAssetIdLocationPostResponsesContentApplicationJsonSchemaDataActionsReuseOwnAssetFromOwnLocationDetailsServiceCostFeesCurrency", "type": "string" }, "ItAssetsAssetIdLocationPostResponsesContentApplicationJsonSchemaDataActionsReuseOwnAssetFromOwnLocationDetailsServiceCostTokenUsage": { "description": "Add-on token consumption details. Null when billing method is \"CURRENCY\"", "properties": { "addon": { "$ref": "#/components/schemas/ItAssetsAssetIdLocationPostResponsesContentApplicationJsonSchemaDataActionsReuseOwnAssetFromOwnLocationDetailsServiceCostTokenUsageAddon", "description": "The add-on that provides the tokens" }, "cost": { "description": "Number of tokens consumed by the action. Zero when the add-on covers the\nservice without drawing from a token pool", "format": "decimal", "type": "string" }, "tokens_left": { "description": "Number of tokens left in the pool after the action is performed. Null when\nthe add-on covers the service without a token pool", "format": "decimal", "type": [ "string", "null" ] } }, "required": [ "cost", "addon", "tokens_left" ], "title": "ItAssetsAssetIdLocationPostResponsesContentApplicationJsonSchemaDataActionsReuseOwnAssetFromOwnLocationDetailsServiceCostTokenUsage", "type": "object" }, "ItAssetsAssetIdLocationPostResponsesContentApplicationJsonSchemaDataActionsReuseOwnAssetFromOwnLocationDetailsServiceCostTokenUsageAddon": { "description": "The add-on that provides the tokens", "properties": { "id": { "description": "ID of the add-on", "format": "uuid", "type": "string" }, "name": { "description": "Public display name of the add-on", "type": "string" } }, "required": [ "id", "name" ], "title": "ItAssetsAssetIdLocationPostResponsesContentApplicationJsonSchemaDataActionsReuseOwnAssetFromOwnLocationDetailsServiceCostTokenUsageAddon", "type": "object" }, "ItAssetsAssetIdLocationPostResponsesContentApplicationJsonSchemaDataActionsReuseOwnAssetFromOwnLocationDisabledReasonsItems": { "enum": [ "ARCHIVED", "AT_DEEL_WAREHOUSE", "BEING_REPAIRED", "CONSUMABLE", "CONTROLLED_BY_DEEL", "COUNTRY_NOT_SUPPORTED_FOR_HUB", "COUNTRY_NOT_SUPPORTED_FOR_LOCAL", "DEEL_OWNED_ITEM_WITHOUT_RENTAL_CONTRACT", "DESKTOP_STORAGE", "ENDING_CONTRACT", "HUB_IN_SAME_REGION_AS_LOCAL", "INACTIVE", "INVALID_ITEM_LOCATION", "INVALID_ORGANIZATION_STATUS", "INVALID_STATE", "ITEM_CONDITIONS_TO_UNARCHIVE_NOT_MET", "ITEM_NOT_VISIBLE_FOR_ORGANIZATION", "NON_DEVICE", "NOT_AT_WAREHOUSE", "NOT_AVAILABLE_FOR_REUSE", "NOT_A_RENTAL", "NOT_MANAGEABLE_BY_ORGANIZATION", "NOT_WITH_ASSIGNMENT", "NOT_WITH_USER", "NO_ACTIVE_ADDONS", "NO_ACTIVE_STORAGE_CONTRACT", "NO_LOCATION_FOR_STORAGE", "NO_LOGISTICS_FOR_STORAGE", "NO_VALID_ADDONS", "ONGOING_SERVICE", "OWNED_BY_DEEL", "OWNED_BY_ORGANIZATION", "OWNED_BY_PARTNER_ORGANIZATION", "PARTNER_CHILD_CONTRACT", "PENDING_DEVICE_REFRESH", "RENTAL_CONTRACT_AND_USER_REGION_DO_NOT_MATCH", "TEMPORARILY_UNAVAILABLE", "UNKNOWN", "USER_HAS_NO_COUNTRY", "USER_HAS_NO_SEAT", "WAITING_FOR_CLEARANCE", "WITH_LOANER_ASSIGNMENT", "WITH_NON_COLLECTED_ASSIGNMENT", "WITH_NON_DELIVERED_ASSIGNMENT", "WITH_PENDING_ASSIGNMENT", "WRONG_ASSIGNMENT_STATUS", "WRONG_CONTRACT_STATUS", "WRONG_TERMS_AND_CONDITIONS" ], "title": "ItAssetsAssetIdLocationPostResponsesContentApplicationJsonSchemaDataActionsReuseOwnAssetFromOwnLocationDisabledReasonsItems", "type": "string" }, "ItAssetsAssetIdLocationPostResponsesContentApplicationJsonSchemaDataActionsReuseOwnAssetFromOwnLocationStatus": { "description": "Whether the action is currently available for this asset", "enum": [ "DISABLED", "ENABLED", "NOT_APPLICABLE" ], "title": "ItAssetsAssetIdLocationPostResponsesContentApplicationJsonSchemaDataActionsReuseOwnAssetFromOwnLocationStatus", "type": "string" }, "ItAssetsAssetIdLocationPostResponsesContentApplicationJsonSchemaDataActionsStoreOwnAssetAtDeelForHub": { "description": "Store an organization-owned asset at a Deel hub warehouse", "properties": { "details": { "description": "Action-specific context needed to perform the action. Populated for enabled and\ndisabled actions (so callers can see what a successful attempt would look like);\nnull when the action is not applicable to this asset.", "oneOf": [ { "$ref": "#/components/schemas/ItAssetsAssetIdLocationPostResponsesContentApplicationJsonSchemaDataActionsStoreOwnAssetAtDeelForHubDetails" }, { "type": "null" } ] }, "disabled_reasons": { "description": "Reasons why the action is disabled. Empty when the action is enabled or not applicable", "items": { "$ref": "#/components/schemas/ItAssetsAssetIdLocationPostResponsesContentApplicationJsonSchemaDataActionsStoreOwnAssetAtDeelForHubDisabledReasonsItems" }, "type": "array" }, "status": { "$ref": "#/components/schemas/ItAssetsAssetIdLocationPostResponsesContentApplicationJsonSchemaDataActionsStoreOwnAssetAtDeelForHubStatus", "description": "Whether the action is currently available for this asset" } }, "required": [ "status", "details", "disabled_reasons" ], "title": "ItAssetsAssetIdLocationPostResponsesContentApplicationJsonSchemaDataActionsStoreOwnAssetAtDeelForHub", "type": "object" }, "ItAssetsAssetIdLocationPostResponsesContentApplicationJsonSchemaDataActionsStoreOwnAssetAtDeelForHubDetails": { "description": "Action-specific context needed to perform the action. Populated for enabled and\ndisabled actions (so callers can see what a successful attempt would look like);\nnull when the action is not applicable to this asset.", "properties": { "activation_cost": { "$ref": "#/components/schemas/ItAssetsAssetIdLocationPostResponsesContentApplicationJsonSchemaDataActionsStoreOwnAssetAtDeelForHubDetailsActivationCost", "description": "Cost charged to activate storage" }, "destination_country": { "$ref": "#/components/schemas/ItAssetsAssetIdLocationPostResponsesContentApplicationJsonSchemaDataActionsStoreOwnAssetAtDeelForHubDetailsDestinationCountry", "description": "ISO 3166-1 alpha-2 country of the Deel warehouse the asset will be shipped to" }, "grace_period_in_months": { "description": "Grace period in months during which storage is free before monthly fees apply", "format": "int64", "type": "integer" }, "monthly_fee": { "$ref": "#/components/schemas/ItAssetsAssetIdLocationPostResponsesContentApplicationJsonSchemaDataActionsStoreOwnAssetAtDeelForHubDetailsMonthlyFee", "description": "Monthly storage fee charged after the grace period" } }, "required": [ "monthly_fee", "activation_cost", "destination_country", "grace_period_in_months" ], "title": "ItAssetsAssetIdLocationPostResponsesContentApplicationJsonSchemaDataActionsStoreOwnAssetAtDeelForHubDetails", "type": "object" }, "ItAssetsAssetIdLocationPostResponsesContentApplicationJsonSchemaDataActionsStoreOwnAssetAtDeelForHubDetailsActivationCost": { "description": "Cost charged to activate storage", "properties": { "billing_method": { "$ref": "#/components/schemas/ItAssetsAssetIdLocationPostResponsesContentApplicationJsonSchemaDataActionsStoreOwnAssetAtDeelForHubDetailsActivationCostBillingMethod", "description": "How the action is charged. When \"TOKEN\", the fees are covered by an\nadd-on token pool; when \"CURRENCY\", the fees are billed in the currency\nspecified in the \"fees\" field." }, "fees": { "description": "Price charged for the action. Null when billing method is \"TOKEN\"", "oneOf": [ { "$ref": "#/components/schemas/ItAssetsAssetIdLocationPostResponsesContentApplicationJsonSchemaDataActionsStoreOwnAssetAtDeelForHubDetailsActivationCostFees" }, { "type": "null" } ] }, "token_usage": { "description": "Add-on token consumption details. Null when billing method is \"CURRENCY\"", "oneOf": [ { "$ref": "#/components/schemas/ItAssetsAssetIdLocationPostResponsesContentApplicationJsonSchemaDataActionsStoreOwnAssetAtDeelForHubDetailsActivationCostTokenUsage" }, { "type": "null" } ] } }, "required": [ "fees", "token_usage", "billing_method" ], "title": "ItAssetsAssetIdLocationPostResponsesContentApplicationJsonSchemaDataActionsStoreOwnAssetAtDeelForHubDetailsActivationCost", "type": "object" }, "ItAssetsAssetIdLocationPostResponsesContentApplicationJsonSchemaDataActionsStoreOwnAssetAtDeelForHubDetailsActivationCostBillingMethod": { "description": "How the action is charged. When \"TOKEN\", the fees are covered by an\nadd-on token pool; when \"CURRENCY\", the fees are billed in the currency\nspecified in the \"fees\" field.", "enum": [ "CURRENCY", "TOKEN" ], "title": "ItAssetsAssetIdLocationPostResponsesContentApplicationJsonSchemaDataActionsStoreOwnAssetAtDeelForHubDetailsActivationCostBillingMethod", "type": "string" }, "ItAssetsAssetIdLocationPostResponsesContentApplicationJsonSchemaDataActionsStoreOwnAssetAtDeelForHubDetailsActivationCostFees": { "description": "Price charged for the action. Null when billing method is \"TOKEN\"", "properties": { "amount": { "description": "Amount", "format": "decimal", "type": "string" }, "currency": { "$ref": "#/components/schemas/ItAssetsAssetIdLocationPostResponsesContentApplicationJsonSchemaDataActionsStoreOwnAssetAtDeelForHubDetailsActivationCostFeesCurrency", "description": "Three-letter currency code for the price" } }, "required": [ "amount", "currency" ], "title": "ItAssetsAssetIdLocationPostResponsesContentApplicationJsonSchemaDataActionsStoreOwnAssetAtDeelForHubDetailsActivationCostFees", "type": "object" }, "ItAssetsAssetIdLocationPostResponsesContentApplicationJsonSchemaDataActionsStoreOwnAssetAtDeelForHubDetailsActivationCostFeesCurrency": { "description": "Three-letter currency code for the price", "enum": [ "AED", "AFN", "ALL", "AMD", "ANG", "AOA", "ARS", "AUD", "AWG", "AZN", "BAM", "BDT", "BGN", "BHD", "BIF", "BMD", "BOB", "BRL", "BSD", "BTN", "BWP", "BYN", "BZD", "CAD", "CDF", "CHF", "CLP", "CNY", "COP", "CRC", "CUC", "CVE", "CZK", "DJF", "DKK", "DOP", "DZD", "EGP", "ERN", "ETB", "EUR", "FJD", "FKP", "GBP", "GEL", "GHS", "GIP", "GMD", "GNF", "GTQ", "GYD", "HKD", "HNL", "HRK", "HTG", "HUF", "IDR", "ILS", "INR", "IQD", "IRR", "ISK", "JMD", "JOD", "JPY", "KES", "KGS", "KHR", "KMF", "KPW", "KRW", "KWD", "KYD", "KZT", "LAK", "LBP", "LKR", "LRD", "LSL", "LTL", "LYD", "MAD", "MDL", "MGA", "MKD", "MMK", "MNT", "MRU", "MUR", "MVR", "MWK", "MXN", "MYR", "MZN", "NAD", "NGN", "NIO", "NOK", "NPR", "NZD", "OMR", "PAB", "PEN", "PGK", "PHP", "PKR", "PLN", "PYG", "QAR", "RON", "RSD", "RUB", "RWF", "SAR", "SBD", "SCR", "SDG", "SEK", "SGD", "SHP", "SLL", "SOS", "SRD", "SSP", "STD", "SYP", "SZL", "THB", "TJS", "TMT", "TND", "TOP", "TRY", "TTD", "TWD", "TZS", "UAH", "UGX", "USD", "UYU", "UZS", "VEF", "VND", "VUV", "WST", "XAF", "XCD", "XOF", "XPF", "YER", "ZAR", "ZMW", "ZWD" ], "title": "ItAssetsAssetIdLocationPostResponsesContentApplicationJsonSchemaDataActionsStoreOwnAssetAtDeelForHubDetailsActivationCostFeesCurrency", "type": "string" }, "ItAssetsAssetIdLocationPostResponsesContentApplicationJsonSchemaDataActionsStoreOwnAssetAtDeelForHubDetailsActivationCostTokenUsage": { "description": "Add-on token consumption details. Null when billing method is \"CURRENCY\"", "properties": { "addon": { "$ref": "#/components/schemas/ItAssetsAssetIdLocationPostResponsesContentApplicationJsonSchemaDataActionsStoreOwnAssetAtDeelForHubDetailsActivationCostTokenUsageAddon", "description": "The add-on that provides the tokens" }, "cost": { "description": "Number of tokens consumed by the action. Zero when the add-on covers the\nservice without drawing from a token pool", "format": "decimal", "type": "string" }, "tokens_left": { "description": "Number of tokens left in the pool after the action is performed. Null when\nthe add-on covers the service without a token pool", "format": "decimal", "type": [ "string", "null" ] } }, "required": [ "cost", "addon", "tokens_left" ], "title": "ItAssetsAssetIdLocationPostResponsesContentApplicationJsonSchemaDataActionsStoreOwnAssetAtDeelForHubDetailsActivationCostTokenUsage", "type": "object" }, "ItAssetsAssetIdLocationPostResponsesContentApplicationJsonSchemaDataActionsStoreOwnAssetAtDeelForHubDetailsActivationCostTokenUsageAddon": { "description": "The add-on that provides the tokens", "properties": { "id": { "description": "ID of the add-on", "format": "uuid", "type": "string" }, "name": { "description": "Public display name of the add-on", "type": "string" } }, "required": [ "id", "name" ], "title": "ItAssetsAssetIdLocationPostResponsesContentApplicationJsonSchemaDataActionsStoreOwnAssetAtDeelForHubDetailsActivationCostTokenUsageAddon", "type": "object" }, "ItAssetsAssetIdLocationPostResponsesContentApplicationJsonSchemaDataActionsStoreOwnAssetAtDeelForHubDetailsDestinationCountry": { "description": "ISO 3166-1 alpha-2 country of the Deel warehouse the asset will be shipped to", "enum": [ "AD", "AE", "AF", "AG", "AI", "AL", "AM", "AN", "AO", "AQ", "AR", "AS", "AT", "AU", "AW", "AX", "AZ", "BA", "BB", "BD", "BE", "BF", "BG", "BH", "BI", "BJ", "BL", "BM", "BN", "BO", "BQ", "BR", "BS", "BT", "BV", "BW", "BY", "BZ", "CA", "CC", "CD", "CF", "CG", "CH", "CI", "CK", "CL", "CM", "CN", "CO", "CR", "CU", "CV", "CW", "CX", "CY", "CZ", "DE", "DJ", "DK", "DM", "DO", "DZ", "EC", "EE", "EG", "EH", "ER", "ES", "ET", "FI", "FJ", "FK", "FM", "FO", "FR", "GA", "GB", "GD", "GE", "GF", "GG", "GH", "GI", "GL", "GM", "GN", "GP", "GQ", "GR", "GS", "GT", "GU", "GW", "GY", "HK", "HM", "HN", "HR", "HT", "HU", "IC", "ID", "IE", "IL", "IM", "IN", "IO", "IQ", "IR", "IS", "IT", "JE", "JM", "JO", "JP", "KE", "KG", "KH", "KI", "KM", "KN", "KP", "KR", "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", "XK", "YE", "YT", "ZA", "ZM", "ZW" ], "title": "ItAssetsAssetIdLocationPostResponsesContentApplicationJsonSchemaDataActionsStoreOwnAssetAtDeelForHubDetailsDestinationCountry", "type": "string" }, "ItAssetsAssetIdLocationPostResponsesContentApplicationJsonSchemaDataActionsStoreOwnAssetAtDeelForHubDetailsMonthlyFee": { "description": "Monthly storage fee charged after the grace period", "properties": { "amount": { "description": "Amount", "format": "decimal", "type": "string" }, "currency": { "$ref": "#/components/schemas/ItAssetsAssetIdLocationPostResponsesContentApplicationJsonSchemaDataActionsStoreOwnAssetAtDeelForHubDetailsMonthlyFeeCurrency", "description": "Three-letter currency code for the price" } }, "required": [ "amount", "currency" ], "title": "ItAssetsAssetIdLocationPostResponsesContentApplicationJsonSchemaDataActionsStoreOwnAssetAtDeelForHubDetailsMonthlyFee", "type": "object" }, "ItAssetsAssetIdLocationPostResponsesContentApplicationJsonSchemaDataActionsStoreOwnAssetAtDeelForHubDetailsMonthlyFeeCurrency": { "description": "Three-letter currency code for the price", "enum": [ "AED", "AFN", "ALL", "AMD", "ANG", "AOA", "ARS", "AUD", "AWG", "AZN", "BAM", "BDT", "BGN", "BHD", "BIF", "BMD", "BOB", "BRL", "BSD", "BTN", "BWP", "BYN", "BZD", "CAD", "CDF", "CHF", "CLP", "CNY", "COP", "CRC", "CUC", "CVE", "CZK", "DJF", "DKK", "DOP", "DZD", "EGP", "ERN", "ETB", "EUR", "FJD", "FKP", "GBP", "GEL", "GHS", "GIP", "GMD", "GNF", "GTQ", "GYD", "HKD", "HNL", "HRK", "HTG", "HUF", "IDR", "ILS", "INR", "IQD", "IRR", "ISK", "JMD", "JOD", "JPY", "KES", "KGS", "KHR", "KMF", "KPW", "KRW", "KWD", "KYD", "KZT", "LAK", "LBP", "LKR", "LRD", "LSL", "LTL", "LYD", "MAD", "MDL", "MGA", "MKD", "MMK", "MNT", "MRU", "MUR", "MVR", "MWK", "MXN", "MYR", "MZN", "NAD", "NGN", "NIO", "NOK", "NPR", "NZD", "OMR", "PAB", "PEN", "PGK", "PHP", "PKR", "PLN", "PYG", "QAR", "RON", "RSD", "RUB", "RWF", "SAR", "SBD", "SCR", "SDG", "SEK", "SGD", "SHP", "SLL", "SOS", "SRD", "SSP", "STD", "SYP", "SZL", "THB", "TJS", "TMT", "TND", "TOP", "TRY", "TTD", "TWD", "TZS", "UAH", "UGX", "USD", "UYU", "UZS", "VEF", "VND", "VUV", "WST", "XAF", "XCD", "XOF", "XPF", "YER", "ZAR", "ZMW", "ZWD" ], "title": "ItAssetsAssetIdLocationPostResponsesContentApplicationJsonSchemaDataActionsStoreOwnAssetAtDeelForHubDetailsMonthlyFeeCurrency", "type": "string" }, "ItAssetsAssetIdLocationPostResponsesContentApplicationJsonSchemaDataActionsStoreOwnAssetAtDeelForHubDisabledReasonsItems": { "enum": [ "ARCHIVED", "AT_DEEL_WAREHOUSE", "BEING_REPAIRED", "CONSUMABLE", "CONTROLLED_BY_DEEL", "COUNTRY_NOT_SUPPORTED_FOR_HUB", "COUNTRY_NOT_SUPPORTED_FOR_LOCAL", "DEEL_OWNED_ITEM_WITHOUT_RENTAL_CONTRACT", "DESKTOP_STORAGE", "ENDING_CONTRACT", "HUB_IN_SAME_REGION_AS_LOCAL", "INACTIVE", "INVALID_ITEM_LOCATION", "INVALID_ORGANIZATION_STATUS", "INVALID_STATE", "ITEM_CONDITIONS_TO_UNARCHIVE_NOT_MET", "ITEM_NOT_VISIBLE_FOR_ORGANIZATION", "NON_DEVICE", "NOT_AT_WAREHOUSE", "NOT_AVAILABLE_FOR_REUSE", "NOT_A_RENTAL", "NOT_MANAGEABLE_BY_ORGANIZATION", "NOT_WITH_ASSIGNMENT", "NOT_WITH_USER", "NO_ACTIVE_ADDONS", "NO_ACTIVE_STORAGE_CONTRACT", "NO_LOCATION_FOR_STORAGE", "NO_LOGISTICS_FOR_STORAGE", "NO_VALID_ADDONS", "ONGOING_SERVICE", "OWNED_BY_DEEL", "OWNED_BY_ORGANIZATION", "OWNED_BY_PARTNER_ORGANIZATION", "PARTNER_CHILD_CONTRACT", "PENDING_DEVICE_REFRESH", "RENTAL_CONTRACT_AND_USER_REGION_DO_NOT_MATCH", "TEMPORARILY_UNAVAILABLE", "UNKNOWN", "USER_HAS_NO_COUNTRY", "USER_HAS_NO_SEAT", "WAITING_FOR_CLEARANCE", "WITH_LOANER_ASSIGNMENT", "WITH_NON_COLLECTED_ASSIGNMENT", "WITH_NON_DELIVERED_ASSIGNMENT", "WITH_PENDING_ASSIGNMENT", "WRONG_ASSIGNMENT_STATUS", "WRONG_CONTRACT_STATUS", "WRONG_TERMS_AND_CONDITIONS" ], "title": "ItAssetsAssetIdLocationPostResponsesContentApplicationJsonSchemaDataActionsStoreOwnAssetAtDeelForHubDisabledReasonsItems", "type": "string" }, "ItAssetsAssetIdLocationPostResponsesContentApplicationJsonSchemaDataActionsStoreOwnAssetAtDeelForHubStatus": { "description": "Whether the action is currently available for this asset", "enum": [ "DISABLED", "ENABLED", "NOT_APPLICABLE" ], "title": "ItAssetsAssetIdLocationPostResponsesContentApplicationJsonSchemaDataActionsStoreOwnAssetAtDeelForHubStatus", "type": "string" }, "ItAssetsAssetIdLocationPostResponsesContentApplicationJsonSchemaDataActionsStoreOwnAssetAtDeelForLocal": { "description": "Store an organization-owned asset at a Deel local warehouse", "properties": { "details": { "description": "Action-specific context needed to perform the action. Populated for enabled and\ndisabled actions (so callers can see what a successful attempt would look like);\nnull when the action is not applicable to this asset.", "oneOf": [ { "$ref": "#/components/schemas/ItAssetsAssetIdLocationPostResponsesContentApplicationJsonSchemaDataActionsStoreOwnAssetAtDeelForLocalDetails" }, { "type": "null" } ] }, "disabled_reasons": { "description": "Reasons why the action is disabled. Empty when the action is enabled or not applicable", "items": { "$ref": "#/components/schemas/ItAssetsAssetIdLocationPostResponsesContentApplicationJsonSchemaDataActionsStoreOwnAssetAtDeelForLocalDisabledReasonsItems" }, "type": "array" }, "status": { "$ref": "#/components/schemas/ItAssetsAssetIdLocationPostResponsesContentApplicationJsonSchemaDataActionsStoreOwnAssetAtDeelForLocalStatus", "description": "Whether the action is currently available for this asset" } }, "required": [ "status", "details", "disabled_reasons" ], "title": "ItAssetsAssetIdLocationPostResponsesContentApplicationJsonSchemaDataActionsStoreOwnAssetAtDeelForLocal", "type": "object" }, "ItAssetsAssetIdLocationPostResponsesContentApplicationJsonSchemaDataActionsStoreOwnAssetAtDeelForLocalDetails": { "description": "Action-specific context needed to perform the action. Populated for enabled and\ndisabled actions (so callers can see what a successful attempt would look like);\nnull when the action is not applicable to this asset.", "properties": { "activation_cost": { "$ref": "#/components/schemas/ItAssetsAssetIdLocationPostResponsesContentApplicationJsonSchemaDataActionsStoreOwnAssetAtDeelForLocalDetailsActivationCost", "description": "Cost charged to activate storage" }, "destination_country": { "$ref": "#/components/schemas/ItAssetsAssetIdLocationPostResponsesContentApplicationJsonSchemaDataActionsStoreOwnAssetAtDeelForLocalDetailsDestinationCountry", "description": "ISO 3166-1 alpha-2 country of the Deel warehouse the asset will be shipped to" }, "grace_period_in_months": { "description": "Grace period in months during which storage is free before monthly fees apply", "format": "int64", "type": "integer" }, "monthly_fee": { "$ref": "#/components/schemas/ItAssetsAssetIdLocationPostResponsesContentApplicationJsonSchemaDataActionsStoreOwnAssetAtDeelForLocalDetailsMonthlyFee", "description": "Monthly storage fee charged after the grace period" } }, "required": [ "monthly_fee", "activation_cost", "destination_country", "grace_period_in_months" ], "title": "ItAssetsAssetIdLocationPostResponsesContentApplicationJsonSchemaDataActionsStoreOwnAssetAtDeelForLocalDetails", "type": "object" }, "ItAssetsAssetIdLocationPostResponsesContentApplicationJsonSchemaDataActionsStoreOwnAssetAtDeelForLocalDetailsActivationCost": { "description": "Cost charged to activate storage", "properties": { "billing_method": { "$ref": "#/components/schemas/ItAssetsAssetIdLocationPostResponsesContentApplicationJsonSchemaDataActionsStoreOwnAssetAtDeelForLocalDetailsActivationCostBillingMethod", "description": "How the action is charged. When \"TOKEN\", the fees are covered by an\nadd-on token pool; when \"CURRENCY\", the fees are billed in the currency\nspecified in the \"fees\" field." }, "fees": { "description": "Price charged for the action. Null when billing method is \"TOKEN\"", "oneOf": [ { "$ref": "#/components/schemas/ItAssetsAssetIdLocationPostResponsesContentApplicationJsonSchemaDataActionsStoreOwnAssetAtDeelForLocalDetailsActivationCostFees" }, { "type": "null" } ] }, "token_usage": { "description": "Add-on token consumption details. Null when billing method is \"CURRENCY\"", "oneOf": [ { "$ref": "#/components/schemas/ItAssetsAssetIdLocationPostResponsesContentApplicationJsonSchemaDataActionsStoreOwnAssetAtDeelForLocalDetailsActivationCostTokenUsage" }, { "type": "null" } ] } }, "required": [ "fees", "token_usage", "billing_method" ], "title": "ItAssetsAssetIdLocationPostResponsesContentApplicationJsonSchemaDataActionsStoreOwnAssetAtDeelForLocalDetailsActivationCost", "type": "object" }, "ItAssetsAssetIdLocationPostResponsesContentApplicationJsonSchemaDataActionsStoreOwnAssetAtDeelForLocalDetailsActivationCostBillingMethod": { "description": "How the action is charged. When \"TOKEN\", the fees are covered by an\nadd-on token pool; when \"CURRENCY\", the fees are billed in the currency\nspecified in the \"fees\" field.", "enum": [ "CURRENCY", "TOKEN" ], "title": "ItAssetsAssetIdLocationPostResponsesContentApplicationJsonSchemaDataActionsStoreOwnAssetAtDeelForLocalDetailsActivationCostBillingMethod", "type": "string" }, "ItAssetsAssetIdLocationPostResponsesContentApplicationJsonSchemaDataActionsStoreOwnAssetAtDeelForLocalDetailsActivationCostFees": { "description": "Price charged for the action. Null when billing method is \"TOKEN\"", "properties": { "amount": { "description": "Amount", "format": "decimal", "type": "string" }, "currency": { "$ref": "#/components/schemas/ItAssetsAssetIdLocationPostResponsesContentApplicationJsonSchemaDataActionsStoreOwnAssetAtDeelForLocalDetailsActivationCostFeesCurrency", "description": "Three-letter currency code for the price" } }, "required": [ "amount", "currency" ], "title": "ItAssetsAssetIdLocationPostResponsesContentApplicationJsonSchemaDataActionsStoreOwnAssetAtDeelForLocalDetailsActivationCostFees", "type": "object" }, "ItAssetsAssetIdLocationPostResponsesContentApplicationJsonSchemaDataActionsStoreOwnAssetAtDeelForLocalDetailsActivationCostFeesCurrency": { "description": "Three-letter currency code for the price", "enum": [ "AED", "AFN", "ALL", "AMD", "ANG", "AOA", "ARS", "AUD", "AWG", "AZN", "BAM", "BDT", "BGN", "BHD", "BIF", "BMD", "BOB", "BRL", "BSD", "BTN", "BWP", "BYN", "BZD", "CAD", "CDF", "CHF", "CLP", "CNY", "COP", "CRC", "CUC", "CVE", "CZK", "DJF", "DKK", "DOP", "DZD", "EGP", "ERN", "ETB", "EUR", "FJD", "FKP", "GBP", "GEL", "GHS", "GIP", "GMD", "GNF", "GTQ", "GYD", "HKD", "HNL", "HRK", "HTG", "HUF", "IDR", "ILS", "INR", "IQD", "IRR", "ISK", "JMD", "JOD", "JPY", "KES", "KGS", "KHR", "KMF", "KPW", "KRW", "KWD", "KYD", "KZT", "LAK", "LBP", "LKR", "LRD", "LSL", "LTL", "LYD", "MAD", "MDL", "MGA", "MKD", "MMK", "MNT", "MRU", "MUR", "MVR", "MWK", "MXN", "MYR", "MZN", "NAD", "NGN", "NIO", "NOK", "NPR", "NZD", "OMR", "PAB", "PEN", "PGK", "PHP", "PKR", "PLN", "PYG", "QAR", "RON", "RSD", "RUB", "RWF", "SAR", "SBD", "SCR", "SDG", "SEK", "SGD", "SHP", "SLL", "SOS", "SRD", "SSP", "STD", "SYP", "SZL", "THB", "TJS", "TMT", "TND", "TOP", "TRY", "TTD", "TWD", "TZS", "UAH", "UGX", "USD", "UYU", "UZS", "VEF", "VND", "VUV", "WST", "XAF", "XCD", "XOF", "XPF", "YER", "ZAR", "ZMW", "ZWD" ], "title": "ItAssetsAssetIdLocationPostResponsesContentApplicationJsonSchemaDataActionsStoreOwnAssetAtDeelForLocalDetailsActivationCostFeesCurrency", "type": "string" }, "ItAssetsAssetIdLocationPostResponsesContentApplicationJsonSchemaDataActionsStoreOwnAssetAtDeelForLocalDetailsActivationCostTokenUsage": { "description": "Add-on token consumption details. Null when billing method is \"CURRENCY\"", "properties": { "addon": { "$ref": "#/components/schemas/ItAssetsAssetIdLocationPostResponsesContentApplicationJsonSchemaDataActionsStoreOwnAssetAtDeelForLocalDetailsActivationCostTokenUsageAddon", "description": "The add-on that provides the tokens" }, "cost": { "description": "Number of tokens consumed by the action. Zero when the add-on covers the\nservice without drawing from a token pool", "format": "decimal", "type": "string" }, "tokens_left": { "description": "Number of tokens left in the pool after the action is performed. Null when\nthe add-on covers the service without a token pool", "format": "decimal", "type": [ "string", "null" ] } }, "required": [ "cost", "addon", "tokens_left" ], "title": "ItAssetsAssetIdLocationPostResponsesContentApplicationJsonSchemaDataActionsStoreOwnAssetAtDeelForLocalDetailsActivationCostTokenUsage", "type": "object" }, "ItAssetsAssetIdLocationPostResponsesContentApplicationJsonSchemaDataActionsStoreOwnAssetAtDeelForLocalDetailsActivationCostTokenUsageAddon": { "description": "The add-on that provides the tokens", "properties": { "id": { "description": "ID of the add-on", "format": "uuid", "type": "string" }, "name": { "description": "Public display name of the add-on", "type": "string" } }, "required": [ "id", "name" ], "title": "ItAssetsAssetIdLocationPostResponsesContentApplicationJsonSchemaDataActionsStoreOwnAssetAtDeelForLocalDetailsActivationCostTokenUsageAddon", "type": "object" }, "ItAssetsAssetIdLocationPostResponsesContentApplicationJsonSchemaDataActionsStoreOwnAssetAtDeelForLocalDetailsDestinationCountry": { "description": "ISO 3166-1 alpha-2 country of the Deel warehouse the asset will be shipped to", "enum": [ "AD", "AE", "AF", "AG", "AI", "AL", "AM", "AN", "AO", "AQ", "AR", "AS", "AT", "AU", "AW", "AX", "AZ", "BA", "BB", "BD", "BE", "BF", "BG", "BH", "BI", "BJ", "BL", "BM", "BN", "BO", "BQ", "BR", "BS", "BT", "BV", "BW", "BY", "BZ", "CA", "CC", "CD", "CF", "CG", "CH", "CI", "CK", "CL", "CM", "CN", "CO", "CR", "CU", "CV", "CW", "CX", "CY", "CZ", "DE", "DJ", "DK", "DM", "DO", "DZ", "EC", "EE", "EG", "EH", "ER", "ES", "ET", "FI", "FJ", "FK", "FM", "FO", "FR", "GA", "GB", "GD", "GE", "GF", "GG", "GH", "GI", "GL", "GM", "GN", "GP", "GQ", "GR", "GS", "GT", "GU", "GW", "GY", "HK", "HM", "HN", "HR", "HT", "HU", "IC", "ID", "IE", "IL", "IM", "IN", "IO", "IQ", "IR", "IS", "IT", "JE", "JM", "JO", "JP", "KE", "KG", "KH", "KI", "KM", "KN", "KP", "KR", "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", "XK", "YE", "YT", "ZA", "ZM", "ZW" ], "title": "ItAssetsAssetIdLocationPostResponsesContentApplicationJsonSchemaDataActionsStoreOwnAssetAtDeelForLocalDetailsDestinationCountry", "type": "string" }, "ItAssetsAssetIdLocationPostResponsesContentApplicationJsonSchemaDataActionsStoreOwnAssetAtDeelForLocalDetailsMonthlyFee": { "description": "Monthly storage fee charged after the grace period", "properties": { "amount": { "description": "Amount", "format": "decimal", "type": "string" }, "currency": { "$ref": "#/components/schemas/ItAssetsAssetIdLocationPostResponsesContentApplicationJsonSchemaDataActionsStoreOwnAssetAtDeelForLocalDetailsMonthlyFeeCurrency", "description": "Three-letter currency code for the price" } }, "required": [ "amount", "currency" ], "title": "ItAssetsAssetIdLocationPostResponsesContentApplicationJsonSchemaDataActionsStoreOwnAssetAtDeelForLocalDetailsMonthlyFee", "type": "object" }, "ItAssetsAssetIdLocationPostResponsesContentApplicationJsonSchemaDataActionsStoreOwnAssetAtDeelForLocalDetailsMonthlyFeeCurrency": { "description": "Three-letter currency code for the price", "enum": [ "AED", "AFN", "ALL", "AMD", "ANG", "AOA", "ARS", "AUD", "AWG", "AZN", "BAM", "BDT", "BGN", "BHD", "BIF", "BMD", "BOB", "BRL", "BSD", "BTN", "BWP", "BYN", "BZD", "CAD", "CDF", "CHF", "CLP", "CNY", "COP", "CRC", "CUC", "CVE", "CZK", "DJF", "DKK", "DOP", "DZD", "EGP", "ERN", "ETB", "EUR", "FJD", "FKP", "GBP", "GEL", "GHS", "GIP", "GMD", "GNF", "GTQ", "GYD", "HKD", "HNL", "HRK", "HTG", "HUF", "IDR", "ILS", "INR", "IQD", "IRR", "ISK", "JMD", "JOD", "JPY", "KES", "KGS", "KHR", "KMF", "KPW", "KRW", "KWD", "KYD", "KZT", "LAK", "LBP", "LKR", "LRD", "LSL", "LTL", "LYD", "MAD", "MDL", "MGA", "MKD", "MMK", "MNT", "MRU", "MUR", "MVR", "MWK", "MXN", "MYR", "MZN", "NAD", "NGN", "NIO", "NOK", "NPR", "NZD", "OMR", "PAB", "PEN", "PGK", "PHP", "PKR", "PLN", "PYG", "QAR", "RON", "RSD", "RUB", "RWF", "SAR", "SBD", "SCR", "SDG", "SEK", "SGD", "SHP", "SLL", "SOS", "SRD", "SSP", "STD", "SYP", "SZL", "THB", "TJS", "TMT", "TND", "TOP", "TRY", "TTD", "TWD", "TZS", "UAH", "UGX", "USD", "UYU", "UZS", "VEF", "VND", "VUV", "WST", "XAF", "XCD", "XOF", "XPF", "YER", "ZAR", "ZMW", "ZWD" ], "title": "ItAssetsAssetIdLocationPostResponsesContentApplicationJsonSchemaDataActionsStoreOwnAssetAtDeelForLocalDetailsMonthlyFeeCurrency", "type": "string" }, "ItAssetsAssetIdLocationPostResponsesContentApplicationJsonSchemaDataActionsStoreOwnAssetAtDeelForLocalDisabledReasonsItems": { "enum": [ "ARCHIVED", "AT_DEEL_WAREHOUSE", "BEING_REPAIRED", "CONSUMABLE", "CONTROLLED_BY_DEEL", "COUNTRY_NOT_SUPPORTED_FOR_HUB", "COUNTRY_NOT_SUPPORTED_FOR_LOCAL", "DEEL_OWNED_ITEM_WITHOUT_RENTAL_CONTRACT", "DESKTOP_STORAGE", "ENDING_CONTRACT", "HUB_IN_SAME_REGION_AS_LOCAL", "INACTIVE", "INVALID_ITEM_LOCATION", "INVALID_ORGANIZATION_STATUS", "INVALID_STATE", "ITEM_CONDITIONS_TO_UNARCHIVE_NOT_MET", "ITEM_NOT_VISIBLE_FOR_ORGANIZATION", "NON_DEVICE", "NOT_AT_WAREHOUSE", "NOT_AVAILABLE_FOR_REUSE", "NOT_A_RENTAL", "NOT_MANAGEABLE_BY_ORGANIZATION", "NOT_WITH_ASSIGNMENT", "NOT_WITH_USER", "NO_ACTIVE_ADDONS", "NO_ACTIVE_STORAGE_CONTRACT", "NO_LOCATION_FOR_STORAGE", "NO_LOGISTICS_FOR_STORAGE", "NO_VALID_ADDONS", "ONGOING_SERVICE", "OWNED_BY_DEEL", "OWNED_BY_ORGANIZATION", "OWNED_BY_PARTNER_ORGANIZATION", "PARTNER_CHILD_CONTRACT", "PENDING_DEVICE_REFRESH", "RENTAL_CONTRACT_AND_USER_REGION_DO_NOT_MATCH", "TEMPORARILY_UNAVAILABLE", "UNKNOWN", "USER_HAS_NO_COUNTRY", "USER_HAS_NO_SEAT", "WAITING_FOR_CLEARANCE", "WITH_LOANER_ASSIGNMENT", "WITH_NON_COLLECTED_ASSIGNMENT", "WITH_NON_DELIVERED_ASSIGNMENT", "WITH_PENDING_ASSIGNMENT", "WRONG_ASSIGNMENT_STATUS", "WRONG_CONTRACT_STATUS", "WRONG_TERMS_AND_CONDITIONS" ], "title": "ItAssetsAssetIdLocationPostResponsesContentApplicationJsonSchemaDataActionsStoreOwnAssetAtDeelForLocalDisabledReasonsItems", "type": "string" }, "ItAssetsAssetIdLocationPostResponsesContentApplicationJsonSchemaDataActionsStoreOwnAssetAtDeelForLocalStatus": { "description": "Whether the action is currently available for this asset", "enum": [ "DISABLED", "ENABLED", "NOT_APPLICABLE" ], "title": "ItAssetsAssetIdLocationPostResponsesContentApplicationJsonSchemaDataActionsStoreOwnAssetAtDeelForLocalStatus", "type": "string" }, "ItAssetsAssetIdLocationPostResponsesContentApplicationJsonSchemaDataActionsStoreOwnAssetAtOwnLocation": { "description": "Store an organization-owned asset at an organization-owned location", "properties": { "details": { "description": "Action-specific context needed to perform the action. Populated for enabled and\ndisabled actions (so callers can see what a successful attempt would look like);\nnull when the action is not applicable to this asset.", "oneOf": [ { "$ref": "#/components/schemas/ItAssetsAssetIdLocationPostResponsesContentApplicationJsonSchemaDataActionsStoreOwnAssetAtOwnLocationDetails" }, { "type": "null" } ] }, "disabled_reasons": { "description": "Reasons why the action is disabled. Empty when the action is enabled or not applicable", "items": { "$ref": "#/components/schemas/ItAssetsAssetIdLocationPostResponsesContentApplicationJsonSchemaDataActionsStoreOwnAssetAtOwnLocationDisabledReasonsItems" }, "type": "array" }, "status": { "$ref": "#/components/schemas/ItAssetsAssetIdLocationPostResponsesContentApplicationJsonSchemaDataActionsStoreOwnAssetAtOwnLocationStatus", "description": "Whether the action is currently available for this asset" } }, "required": [ "status", "details", "disabled_reasons" ], "title": "ItAssetsAssetIdLocationPostResponsesContentApplicationJsonSchemaDataActionsStoreOwnAssetAtOwnLocation", "type": "object" }, "ItAssetsAssetIdLocationPostResponsesContentApplicationJsonSchemaDataActionsStoreOwnAssetAtOwnLocationDetails": { "description": "Action-specific context needed to perform the action. Populated for enabled and\ndisabled actions (so callers can see what a successful attempt would look like);\nnull when the action is not applicable to this asset.", "properties": { "eligible_countries": { "description": "Countries where the asset can be stored at an organization-owned location", "items": { "$ref": "#/components/schemas/ItAssetsAssetIdLocationPostResponsesContentApplicationJsonSchemaDataActionsStoreOwnAssetAtOwnLocationDetailsEligibleCountriesItems" }, "type": "array" }, "service_cost": { "$ref": "#/components/schemas/ItAssetsAssetIdLocationPostResponsesContentApplicationJsonSchemaDataActionsStoreOwnAssetAtOwnLocationDetailsServiceCost", "description": "Cost charged for the transfer service" } }, "required": [ "service_cost", "eligible_countries" ], "title": "ItAssetsAssetIdLocationPostResponsesContentApplicationJsonSchemaDataActionsStoreOwnAssetAtOwnLocationDetails", "type": "object" }, "ItAssetsAssetIdLocationPostResponsesContentApplicationJsonSchemaDataActionsStoreOwnAssetAtOwnLocationDetailsEligibleCountriesItems": { "enum": [ "AD", "AE", "AF", "AG", "AI", "AL", "AM", "AN", "AO", "AQ", "AR", "AS", "AT", "AU", "AW", "AX", "AZ", "BA", "BB", "BD", "BE", "BF", "BG", "BH", "BI", "BJ", "BL", "BM", "BN", "BO", "BQ", "BR", "BS", "BT", "BV", "BW", "BY", "BZ", "CA", "CC", "CD", "CF", "CG", "CH", "CI", "CK", "CL", "CM", "CN", "CO", "CR", "CU", "CV", "CW", "CX", "CY", "CZ", "DE", "DJ", "DK", "DM", "DO", "DZ", "EC", "EE", "EG", "EH", "ER", "ES", "ET", "FI", "FJ", "FK", "FM", "FO", "FR", "GA", "GB", "GD", "GE", "GF", "GG", "GH", "GI", "GL", "GM", "GN", "GP", "GQ", "GR", "GS", "GT", "GU", "GW", "GY", "HK", "HM", "HN", "HR", "HT", "HU", "IC", "ID", "IE", "IL", "IM", "IN", "IO", "IQ", "IR", "IS", "IT", "JE", "JM", "JO", "JP", "KE", "KG", "KH", "KI", "KM", "KN", "KP", "KR", "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", "XK", "YE", "YT", "ZA", "ZM", "ZW" ], "title": "ItAssetsAssetIdLocationPostResponsesContentApplicationJsonSchemaDataActionsStoreOwnAssetAtOwnLocationDetailsEligibleCountriesItems", "type": "string" }, "ItAssetsAssetIdLocationPostResponsesContentApplicationJsonSchemaDataActionsStoreOwnAssetAtOwnLocationDetailsServiceCost": { "description": "Cost charged for the transfer service", "properties": { "billing_method": { "$ref": "#/components/schemas/ItAssetsAssetIdLocationPostResponsesContentApplicationJsonSchemaDataActionsStoreOwnAssetAtOwnLocationDetailsServiceCostBillingMethod", "description": "How the action is charged. When \"TOKEN\", the fees are covered by an\nadd-on token pool; when \"CURRENCY\", the fees are billed in the currency\nspecified in the \"fees\" field." }, "fees": { "description": "Price charged for the action. Null when billing method is \"TOKEN\"", "oneOf": [ { "$ref": "#/components/schemas/ItAssetsAssetIdLocationPostResponsesContentApplicationJsonSchemaDataActionsStoreOwnAssetAtOwnLocationDetailsServiceCostFees" }, { "type": "null" } ] }, "token_usage": { "description": "Add-on token consumption details. Null when billing method is \"CURRENCY\"", "oneOf": [ { "$ref": "#/components/schemas/ItAssetsAssetIdLocationPostResponsesContentApplicationJsonSchemaDataActionsStoreOwnAssetAtOwnLocationDetailsServiceCostTokenUsage" }, { "type": "null" } ] } }, "required": [ "fees", "token_usage", "billing_method" ], "title": "ItAssetsAssetIdLocationPostResponsesContentApplicationJsonSchemaDataActionsStoreOwnAssetAtOwnLocationDetailsServiceCost", "type": "object" }, "ItAssetsAssetIdLocationPostResponsesContentApplicationJsonSchemaDataActionsStoreOwnAssetAtOwnLocationDetailsServiceCostBillingMethod": { "description": "How the action is charged. When \"TOKEN\", the fees are covered by an\nadd-on token pool; when \"CURRENCY\", the fees are billed in the currency\nspecified in the \"fees\" field.", "enum": [ "CURRENCY", "TOKEN" ], "title": "ItAssetsAssetIdLocationPostResponsesContentApplicationJsonSchemaDataActionsStoreOwnAssetAtOwnLocationDetailsServiceCostBillingMethod", "type": "string" }, "ItAssetsAssetIdLocationPostResponsesContentApplicationJsonSchemaDataActionsStoreOwnAssetAtOwnLocationDetailsServiceCostFees": { "description": "Price charged for the action. Null when billing method is \"TOKEN\"", "properties": { "amount": { "description": "Amount", "format": "decimal", "type": "string" }, "currency": { "$ref": "#/components/schemas/ItAssetsAssetIdLocationPostResponsesContentApplicationJsonSchemaDataActionsStoreOwnAssetAtOwnLocationDetailsServiceCostFeesCurrency", "description": "Three-letter currency code for the price" } }, "required": [ "amount", "currency" ], "title": "ItAssetsAssetIdLocationPostResponsesContentApplicationJsonSchemaDataActionsStoreOwnAssetAtOwnLocationDetailsServiceCostFees", "type": "object" }, "ItAssetsAssetIdLocationPostResponsesContentApplicationJsonSchemaDataActionsStoreOwnAssetAtOwnLocationDetailsServiceCostFeesCurrency": { "description": "Three-letter currency code for the price", "enum": [ "AED", "AFN", "ALL", "AMD", "ANG", "AOA", "ARS", "AUD", "AWG", "AZN", "BAM", "BDT", "BGN", "BHD", "BIF", "BMD", "BOB", "BRL", "BSD", "BTN", "BWP", "BYN", "BZD", "CAD", "CDF", "CHF", "CLP", "CNY", "COP", "CRC", "CUC", "CVE", "CZK", "DJF", "DKK", "DOP", "DZD", "EGP", "ERN", "ETB", "EUR", "FJD", "FKP", "GBP", "GEL", "GHS", "GIP", "GMD", "GNF", "GTQ", "GYD", "HKD", "HNL", "HRK", "HTG", "HUF", "IDR", "ILS", "INR", "IQD", "IRR", "ISK", "JMD", "JOD", "JPY", "KES", "KGS", "KHR", "KMF", "KPW", "KRW", "KWD", "KYD", "KZT", "LAK", "LBP", "LKR", "LRD", "LSL", "LTL", "LYD", "MAD", "MDL", "MGA", "MKD", "MMK", "MNT", "MRU", "MUR", "MVR", "MWK", "MXN", "MYR", "MZN", "NAD", "NGN", "NIO", "NOK", "NPR", "NZD", "OMR", "PAB", "PEN", "PGK", "PHP", "PKR", "PLN", "PYG", "QAR", "RON", "RSD", "RUB", "RWF", "SAR", "SBD", "SCR", "SDG", "SEK", "SGD", "SHP", "SLL", "SOS", "SRD", "SSP", "STD", "SYP", "SZL", "THB", "TJS", "TMT", "TND", "TOP", "TRY", "TTD", "TWD", "TZS", "UAH", "UGX", "USD", "UYU", "UZS", "VEF", "VND", "VUV", "WST", "XAF", "XCD", "XOF", "XPF", "YER", "ZAR", "ZMW", "ZWD" ], "title": "ItAssetsAssetIdLocationPostResponsesContentApplicationJsonSchemaDataActionsStoreOwnAssetAtOwnLocationDetailsServiceCostFeesCurrency", "type": "string" }, "ItAssetsAssetIdLocationPostResponsesContentApplicationJsonSchemaDataActionsStoreOwnAssetAtOwnLocationDetailsServiceCostTokenUsage": { "description": "Add-on token consumption details. Null when billing method is \"CURRENCY\"", "properties": { "addon": { "$ref": "#/components/schemas/ItAssetsAssetIdLocationPostResponsesContentApplicationJsonSchemaDataActionsStoreOwnAssetAtOwnLocationDetailsServiceCostTokenUsageAddon", "description": "The add-on that provides the tokens" }, "cost": { "description": "Number of tokens consumed by the action. Zero when the add-on covers the\nservice without drawing from a token pool", "format": "decimal", "type": "string" }, "tokens_left": { "description": "Number of tokens left in the pool after the action is performed. Null when\nthe add-on covers the service without a token pool", "format": "decimal", "type": [ "string", "null" ] } }, "required": [ "cost", "addon", "tokens_left" ], "title": "ItAssetsAssetIdLocationPostResponsesContentApplicationJsonSchemaDataActionsStoreOwnAssetAtOwnLocationDetailsServiceCostTokenUsage", "type": "object" }, "ItAssetsAssetIdLocationPostResponsesContentApplicationJsonSchemaDataActionsStoreOwnAssetAtOwnLocationDetailsServiceCostTokenUsageAddon": { "description": "The add-on that provides the tokens", "properties": { "id": { "description": "ID of the add-on", "format": "uuid", "type": "string" }, "name": { "description": "Public display name of the add-on", "type": "string" } }, "required": [ "id", "name" ], "title": "ItAssetsAssetIdLocationPostResponsesContentApplicationJsonSchemaDataActionsStoreOwnAssetAtOwnLocationDetailsServiceCostTokenUsageAddon", "type": "object" }, "ItAssetsAssetIdLocationPostResponsesContentApplicationJsonSchemaDataActionsStoreOwnAssetAtOwnLocationDisabledReasonsItems": { "enum": [ "ARCHIVED", "AT_DEEL_WAREHOUSE", "BEING_REPAIRED", "CONSUMABLE", "CONTROLLED_BY_DEEL", "COUNTRY_NOT_SUPPORTED_FOR_HUB", "COUNTRY_NOT_SUPPORTED_FOR_LOCAL", "DEEL_OWNED_ITEM_WITHOUT_RENTAL_CONTRACT", "DESKTOP_STORAGE", "ENDING_CONTRACT", "HUB_IN_SAME_REGION_AS_LOCAL", "INACTIVE", "INVALID_ITEM_LOCATION", "INVALID_ORGANIZATION_STATUS", "INVALID_STATE", "ITEM_CONDITIONS_TO_UNARCHIVE_NOT_MET", "ITEM_NOT_VISIBLE_FOR_ORGANIZATION", "NON_DEVICE", "NOT_AT_WAREHOUSE", "NOT_AVAILABLE_FOR_REUSE", "NOT_A_RENTAL", "NOT_MANAGEABLE_BY_ORGANIZATION", "NOT_WITH_ASSIGNMENT", "NOT_WITH_USER", "NO_ACTIVE_ADDONS", "NO_ACTIVE_STORAGE_CONTRACT", "NO_LOCATION_FOR_STORAGE", "NO_LOGISTICS_FOR_STORAGE", "NO_VALID_ADDONS", "ONGOING_SERVICE", "OWNED_BY_DEEL", "OWNED_BY_ORGANIZATION", "OWNED_BY_PARTNER_ORGANIZATION", "PARTNER_CHILD_CONTRACT", "PENDING_DEVICE_REFRESH", "RENTAL_CONTRACT_AND_USER_REGION_DO_NOT_MATCH", "TEMPORARILY_UNAVAILABLE", "UNKNOWN", "USER_HAS_NO_COUNTRY", "USER_HAS_NO_SEAT", "WAITING_FOR_CLEARANCE", "WITH_LOANER_ASSIGNMENT", "WITH_NON_COLLECTED_ASSIGNMENT", "WITH_NON_DELIVERED_ASSIGNMENT", "WITH_PENDING_ASSIGNMENT", "WRONG_ASSIGNMENT_STATUS", "WRONG_CONTRACT_STATUS", "WRONG_TERMS_AND_CONDITIONS" ], "title": "ItAssetsAssetIdLocationPostResponsesContentApplicationJsonSchemaDataActionsStoreOwnAssetAtOwnLocationDisabledReasonsItems", "type": "string" }, "ItAssetsAssetIdLocationPostResponsesContentApplicationJsonSchemaDataActionsStoreOwnAssetAtOwnLocationStatus": { "description": "Whether the action is currently available for this asset", "enum": [ "DISABLED", "ENABLED", "NOT_APPLICABLE" ], "title": "ItAssetsAssetIdLocationPostResponsesContentApplicationJsonSchemaDataActionsStoreOwnAssetAtOwnLocationStatus", "type": "string" }, "ItAssetsAssetIdLocationPostResponsesContentApplicationJsonSchemaDataActionsStoreRentalAtDeelForLocal": { "description": "Store a Deel-owned rental asset at a Deel local warehouse", "properties": { "details": { "description": "Action-specific context needed to perform the action. Populated for enabled and\ndisabled actions (so callers can see what a successful attempt would look like);\nnull when the action is not applicable to this asset.", "oneOf": [ { "$ref": "#/components/schemas/ItAssetsAssetIdLocationPostResponsesContentApplicationJsonSchemaDataActionsStoreRentalAtDeelForLocalDetails" }, { "type": "null" } ] }, "disabled_reasons": { "description": "Reasons why the action is disabled. Empty when the action is enabled or not applicable", "items": { "$ref": "#/components/schemas/ItAssetsAssetIdLocationPostResponsesContentApplicationJsonSchemaDataActionsStoreRentalAtDeelForLocalDisabledReasonsItems" }, "type": "array" }, "status": { "$ref": "#/components/schemas/ItAssetsAssetIdLocationPostResponsesContentApplicationJsonSchemaDataActionsStoreRentalAtDeelForLocalStatus", "description": "Whether the action is currently available for this asset" } }, "required": [ "status", "details", "disabled_reasons" ], "title": "ItAssetsAssetIdLocationPostResponsesContentApplicationJsonSchemaDataActionsStoreRentalAtDeelForLocal", "type": "object" }, "ItAssetsAssetIdLocationPostResponsesContentApplicationJsonSchemaDataActionsStoreRentalAtDeelForLocalDetails": { "description": "Action-specific context needed to perform the action. Populated for enabled and\ndisabled actions (so callers can see what a successful attempt would look like);\nnull when the action is not applicable to this asset.", "properties": { "activation_cost": { "$ref": "#/components/schemas/ItAssetsAssetIdLocationPostResponsesContentApplicationJsonSchemaDataActionsStoreRentalAtDeelForLocalDetailsActivationCost", "description": "Cost charged to activate local storage" } }, "required": [ "activation_cost" ], "title": "ItAssetsAssetIdLocationPostResponsesContentApplicationJsonSchemaDataActionsStoreRentalAtDeelForLocalDetails", "type": "object" }, "ItAssetsAssetIdLocationPostResponsesContentApplicationJsonSchemaDataActionsStoreRentalAtDeelForLocalDetailsActivationCost": { "description": "Cost charged to activate local storage", "properties": { "billing_method": { "$ref": "#/components/schemas/ItAssetsAssetIdLocationPostResponsesContentApplicationJsonSchemaDataActionsStoreRentalAtDeelForLocalDetailsActivationCostBillingMethod", "description": "How the action is charged. When \"TOKEN\", the fees are covered by an\nadd-on token pool; when \"CURRENCY\", the fees are billed in the currency\nspecified in the \"fees\" field." }, "fees": { "description": "Price charged for the action. Null when billing method is \"TOKEN\"", "oneOf": [ { "$ref": "#/components/schemas/ItAssetsAssetIdLocationPostResponsesContentApplicationJsonSchemaDataActionsStoreRentalAtDeelForLocalDetailsActivationCostFees" }, { "type": "null" } ] }, "token_usage": { "description": "Add-on token consumption details. Null when billing method is \"CURRENCY\"", "oneOf": [ { "$ref": "#/components/schemas/ItAssetsAssetIdLocationPostResponsesContentApplicationJsonSchemaDataActionsStoreRentalAtDeelForLocalDetailsActivationCostTokenUsage" }, { "type": "null" } ] } }, "required": [ "fees", "token_usage", "billing_method" ], "title": "ItAssetsAssetIdLocationPostResponsesContentApplicationJsonSchemaDataActionsStoreRentalAtDeelForLocalDetailsActivationCost", "type": "object" }, "ItAssetsAssetIdLocationPostResponsesContentApplicationJsonSchemaDataActionsStoreRentalAtDeelForLocalDetailsActivationCostBillingMethod": { "description": "How the action is charged. When \"TOKEN\", the fees are covered by an\nadd-on token pool; when \"CURRENCY\", the fees are billed in the currency\nspecified in the \"fees\" field.", "enum": [ "CURRENCY", "TOKEN" ], "title": "ItAssetsAssetIdLocationPostResponsesContentApplicationJsonSchemaDataActionsStoreRentalAtDeelForLocalDetailsActivationCostBillingMethod", "type": "string" }, "ItAssetsAssetIdLocationPostResponsesContentApplicationJsonSchemaDataActionsStoreRentalAtDeelForLocalDetailsActivationCostFees": { "description": "Price charged for the action. Null when billing method is \"TOKEN\"", "properties": { "amount": { "description": "Amount", "format": "decimal", "type": "string" }, "currency": { "$ref": "#/components/schemas/ItAssetsAssetIdLocationPostResponsesContentApplicationJsonSchemaDataActionsStoreRentalAtDeelForLocalDetailsActivationCostFeesCurrency", "description": "Three-letter currency code for the price" } }, "required": [ "amount", "currency" ], "title": "ItAssetsAssetIdLocationPostResponsesContentApplicationJsonSchemaDataActionsStoreRentalAtDeelForLocalDetailsActivationCostFees", "type": "object" }, "ItAssetsAssetIdLocationPostResponsesContentApplicationJsonSchemaDataActionsStoreRentalAtDeelForLocalDetailsActivationCostFeesCurrency": { "description": "Three-letter currency code for the price", "enum": [ "AED", "AFN", "ALL", "AMD", "ANG", "AOA", "ARS", "AUD", "AWG", "AZN", "BAM", "BDT", "BGN", "BHD", "BIF", "BMD", "BOB", "BRL", "BSD", "BTN", "BWP", "BYN", "BZD", "CAD", "CDF", "CHF", "CLP", "CNY", "COP", "CRC", "CUC", "CVE", "CZK", "DJF", "DKK", "DOP", "DZD", "EGP", "ERN", "ETB", "EUR", "FJD", "FKP", "GBP", "GEL", "GHS", "GIP", "GMD", "GNF", "GTQ", "GYD", "HKD", "HNL", "HRK", "HTG", "HUF", "IDR", "ILS", "INR", "IQD", "IRR", "ISK", "JMD", "JOD", "JPY", "KES", "KGS", "KHR", "KMF", "KPW", "KRW", "KWD", "KYD", "KZT", "LAK", "LBP", "LKR", "LRD", "LSL", "LTL", "LYD", "MAD", "MDL", "MGA", "MKD", "MMK", "MNT", "MRU", "MUR", "MVR", "MWK", "MXN", "MYR", "MZN", "NAD", "NGN", "NIO", "NOK", "NPR", "NZD", "OMR", "PAB", "PEN", "PGK", "PHP", "PKR", "PLN", "PYG", "QAR", "RON", "RSD", "RUB", "RWF", "SAR", "SBD", "SCR", "SDG", "SEK", "SGD", "SHP", "SLL", "SOS", "SRD", "SSP", "STD", "SYP", "SZL", "THB", "TJS", "TMT", "TND", "TOP", "TRY", "TTD", "TWD", "TZS", "UAH", "UGX", "USD", "UYU", "UZS", "VEF", "VND", "VUV", "WST", "XAF", "XCD", "XOF", "XPF", "YER", "ZAR", "ZMW", "ZWD" ], "title": "ItAssetsAssetIdLocationPostResponsesContentApplicationJsonSchemaDataActionsStoreRentalAtDeelForLocalDetailsActivationCostFeesCurrency", "type": "string" }, "ItAssetsAssetIdLocationPostResponsesContentApplicationJsonSchemaDataActionsStoreRentalAtDeelForLocalDetailsActivationCostTokenUsage": { "description": "Add-on token consumption details. Null when billing method is \"CURRENCY\"", "properties": { "addon": { "$ref": "#/components/schemas/ItAssetsAssetIdLocationPostResponsesContentApplicationJsonSchemaDataActionsStoreRentalAtDeelForLocalDetailsActivationCostTokenUsageAddon", "description": "The add-on that provides the tokens" }, "cost": { "description": "Number of tokens consumed by the action. Zero when the add-on covers the\nservice without drawing from a token pool", "format": "decimal", "type": "string" }, "tokens_left": { "description": "Number of tokens left in the pool after the action is performed. Null when\nthe add-on covers the service without a token pool", "format": "decimal", "type": [ "string", "null" ] } }, "required": [ "cost", "addon", "tokens_left" ], "title": "ItAssetsAssetIdLocationPostResponsesContentApplicationJsonSchemaDataActionsStoreRentalAtDeelForLocalDetailsActivationCostTokenUsage", "type": "object" }, "ItAssetsAssetIdLocationPostResponsesContentApplicationJsonSchemaDataActionsStoreRentalAtDeelForLocalDetailsActivationCostTokenUsageAddon": { "description": "The add-on that provides the tokens", "properties": { "id": { "description": "ID of the add-on", "format": "uuid", "type": "string" }, "name": { "description": "Public display name of the add-on", "type": "string" } }, "required": [ "id", "name" ], "title": "ItAssetsAssetIdLocationPostResponsesContentApplicationJsonSchemaDataActionsStoreRentalAtDeelForLocalDetailsActivationCostTokenUsageAddon", "type": "object" }, "ItAssetsAssetIdLocationPostResponsesContentApplicationJsonSchemaDataActionsStoreRentalAtDeelForLocalDisabledReasonsItems": { "enum": [ "ARCHIVED", "AT_DEEL_WAREHOUSE", "BEING_REPAIRED", "CONSUMABLE", "CONTROLLED_BY_DEEL", "COUNTRY_NOT_SUPPORTED_FOR_HUB", "COUNTRY_NOT_SUPPORTED_FOR_LOCAL", "DEEL_OWNED_ITEM_WITHOUT_RENTAL_CONTRACT", "DESKTOP_STORAGE", "ENDING_CONTRACT", "HUB_IN_SAME_REGION_AS_LOCAL", "INACTIVE", "INVALID_ITEM_LOCATION", "INVALID_ORGANIZATION_STATUS", "INVALID_STATE", "ITEM_CONDITIONS_TO_UNARCHIVE_NOT_MET", "ITEM_NOT_VISIBLE_FOR_ORGANIZATION", "NON_DEVICE", "NOT_AT_WAREHOUSE", "NOT_AVAILABLE_FOR_REUSE", "NOT_A_RENTAL", "NOT_MANAGEABLE_BY_ORGANIZATION", "NOT_WITH_ASSIGNMENT", "NOT_WITH_USER", "NO_ACTIVE_ADDONS", "NO_ACTIVE_STORAGE_CONTRACT", "NO_LOCATION_FOR_STORAGE", "NO_LOGISTICS_FOR_STORAGE", "NO_VALID_ADDONS", "ONGOING_SERVICE", "OWNED_BY_DEEL", "OWNED_BY_ORGANIZATION", "OWNED_BY_PARTNER_ORGANIZATION", "PARTNER_CHILD_CONTRACT", "PENDING_DEVICE_REFRESH", "RENTAL_CONTRACT_AND_USER_REGION_DO_NOT_MATCH", "TEMPORARILY_UNAVAILABLE", "UNKNOWN", "USER_HAS_NO_COUNTRY", "USER_HAS_NO_SEAT", "WAITING_FOR_CLEARANCE", "WITH_LOANER_ASSIGNMENT", "WITH_NON_COLLECTED_ASSIGNMENT", "WITH_NON_DELIVERED_ASSIGNMENT", "WITH_PENDING_ASSIGNMENT", "WRONG_ASSIGNMENT_STATUS", "WRONG_CONTRACT_STATUS", "WRONG_TERMS_AND_CONDITIONS" ], "title": "ItAssetsAssetIdLocationPostResponsesContentApplicationJsonSchemaDataActionsStoreRentalAtDeelForLocalDisabledReasonsItems", "type": "string" }, "ItAssetsAssetIdLocationPostResponsesContentApplicationJsonSchemaDataActionsStoreRentalAtDeelForLocalStatus": { "description": "Whether the action is currently available for this asset", "enum": [ "DISABLED", "ENABLED", "NOT_APPLICABLE" ], "title": "ItAssetsAssetIdLocationPostResponsesContentApplicationJsonSchemaDataActionsStoreRentalAtDeelForLocalStatus", "type": "string" }, "ItAssetsAssetIdLocationPostResponsesContentApplicationJsonSchemaDataActionsStoreRentalAtDeelForZone1": { "description": "Store a Deel-owned rental asset at a Deel zone-1 warehouse", "properties": { "details": { "description": "Action-specific context needed to perform the action. Populated for enabled and\ndisabled actions (so callers can see what a successful attempt would look like);\nnull when the action is not applicable to this asset.", "oneOf": [ { "$ref": "#/components/schemas/ItAssetsAssetIdLocationPostResponsesContentApplicationJsonSchemaDataActionsStoreRentalAtDeelForZone1Details" }, { "type": "null" } ] }, "disabled_reasons": { "description": "Reasons why the action is disabled. Empty when the action is enabled or not applicable", "items": { "$ref": "#/components/schemas/ItAssetsAssetIdLocationPostResponsesContentApplicationJsonSchemaDataActionsStoreRentalAtDeelForZone1DisabledReasonsItems" }, "type": "array" }, "status": { "$ref": "#/components/schemas/ItAssetsAssetIdLocationPostResponsesContentApplicationJsonSchemaDataActionsStoreRentalAtDeelForZone1Status", "description": "Whether the action is currently available for this asset" } }, "required": [ "status", "details", "disabled_reasons" ], "title": "ItAssetsAssetIdLocationPostResponsesContentApplicationJsonSchemaDataActionsStoreRentalAtDeelForZone1", "type": "object" }, "ItAssetsAssetIdLocationPostResponsesContentApplicationJsonSchemaDataActionsStoreRentalAtDeelForZone1Details": { "description": "Action-specific context needed to perform the action. Populated for enabled and\ndisabled actions (so callers can see what a successful attempt would look like);\nnull when the action is not applicable to this asset.", "properties": { "activation_cost": { "$ref": "#/components/schemas/ItAssetsAssetIdLocationPostResponsesContentApplicationJsonSchemaDataActionsStoreRentalAtDeelForZone1DetailsActivationCost", "description": "Cost charged to activate zone-1 storage" } }, "required": [ "activation_cost" ], "title": "ItAssetsAssetIdLocationPostResponsesContentApplicationJsonSchemaDataActionsStoreRentalAtDeelForZone1Details", "type": "object" }, "ItAssetsAssetIdLocationPostResponsesContentApplicationJsonSchemaDataActionsStoreRentalAtDeelForZone1DetailsActivationCost": { "description": "Cost charged to activate zone-1 storage", "properties": { "billing_method": { "$ref": "#/components/schemas/ItAssetsAssetIdLocationPostResponsesContentApplicationJsonSchemaDataActionsStoreRentalAtDeelForZone1DetailsActivationCostBillingMethod", "description": "How the action is charged. When \"TOKEN\", the fees are covered by an\nadd-on token pool; when \"CURRENCY\", the fees are billed in the currency\nspecified in the \"fees\" field." }, "fees": { "description": "Price charged for the action. Null when billing method is \"TOKEN\"", "oneOf": [ { "$ref": "#/components/schemas/ItAssetsAssetIdLocationPostResponsesContentApplicationJsonSchemaDataActionsStoreRentalAtDeelForZone1DetailsActivationCostFees" }, { "type": "null" } ] }, "token_usage": { "description": "Add-on token consumption details. Null when billing method is \"CURRENCY\"", "oneOf": [ { "$ref": "#/components/schemas/ItAssetsAssetIdLocationPostResponsesContentApplicationJsonSchemaDataActionsStoreRentalAtDeelForZone1DetailsActivationCostTokenUsage" }, { "type": "null" } ] } }, "required": [ "fees", "token_usage", "billing_method" ], "title": "ItAssetsAssetIdLocationPostResponsesContentApplicationJsonSchemaDataActionsStoreRentalAtDeelForZone1DetailsActivationCost", "type": "object" }, "ItAssetsAssetIdLocationPostResponsesContentApplicationJsonSchemaDataActionsStoreRentalAtDeelForZone1DetailsActivationCostBillingMethod": { "description": "How the action is charged. When \"TOKEN\", the fees are covered by an\nadd-on token pool; when \"CURRENCY\", the fees are billed in the currency\nspecified in the \"fees\" field.", "enum": [ "CURRENCY", "TOKEN" ], "title": "ItAssetsAssetIdLocationPostResponsesContentApplicationJsonSchemaDataActionsStoreRentalAtDeelForZone1DetailsActivationCostBillingMethod", "type": "string" }, "ItAssetsAssetIdLocationPostResponsesContentApplicationJsonSchemaDataActionsStoreRentalAtDeelForZone1DetailsActivationCostFees": { "description": "Price charged for the action. Null when billing method is \"TOKEN\"", "properties": { "amount": { "description": "Amount", "format": "decimal", "type": "string" }, "currency": { "$ref": "#/components/schemas/ItAssetsAssetIdLocationPostResponsesContentApplicationJsonSchemaDataActionsStoreRentalAtDeelForZone1DetailsActivationCostFeesCurrency", "description": "Three-letter currency code for the price" } }, "required": [ "amount", "currency" ], "title": "ItAssetsAssetIdLocationPostResponsesContentApplicationJsonSchemaDataActionsStoreRentalAtDeelForZone1DetailsActivationCostFees", "type": "object" }, "ItAssetsAssetIdLocationPostResponsesContentApplicationJsonSchemaDataActionsStoreRentalAtDeelForZone1DetailsActivationCostFeesCurrency": { "description": "Three-letter currency code for the price", "enum": [ "AED", "AFN", "ALL", "AMD", "ANG", "AOA", "ARS", "AUD", "AWG", "AZN", "BAM", "BDT", "BGN", "BHD", "BIF", "BMD", "BOB", "BRL", "BSD", "BTN", "BWP", "BYN", "BZD", "CAD", "CDF", "CHF", "CLP", "CNY", "COP", "CRC", "CUC", "CVE", "CZK", "DJF", "DKK", "DOP", "DZD", "EGP", "ERN", "ETB", "EUR", "FJD", "FKP", "GBP", "GEL", "GHS", "GIP", "GMD", "GNF", "GTQ", "GYD", "HKD", "HNL", "HRK", "HTG", "HUF", "IDR", "ILS", "INR", "IQD", "IRR", "ISK", "JMD", "JOD", "JPY", "KES", "KGS", "KHR", "KMF", "KPW", "KRW", "KWD", "KYD", "KZT", "LAK", "LBP", "LKR", "LRD", "LSL", "LTL", "LYD", "MAD", "MDL", "MGA", "MKD", "MMK", "MNT", "MRU", "MUR", "MVR", "MWK", "MXN", "MYR", "MZN", "NAD", "NGN", "NIO", "NOK", "NPR", "NZD", "OMR", "PAB", "PEN", "PGK", "PHP", "PKR", "PLN", "PYG", "QAR", "RON", "RSD", "RUB", "RWF", "SAR", "SBD", "SCR", "SDG", "SEK", "SGD", "SHP", "SLL", "SOS", "SRD", "SSP", "STD", "SYP", "SZL", "THB", "TJS", "TMT", "TND", "TOP", "TRY", "TTD", "TWD", "TZS", "UAH", "UGX", "USD", "UYU", "UZS", "VEF", "VND", "VUV", "WST", "XAF", "XCD", "XOF", "XPF", "YER", "ZAR", "ZMW", "ZWD" ], "title": "ItAssetsAssetIdLocationPostResponsesContentApplicationJsonSchemaDataActionsStoreRentalAtDeelForZone1DetailsActivationCostFeesCurrency", "type": "string" }, "ItAssetsAssetIdLocationPostResponsesContentApplicationJsonSchemaDataActionsStoreRentalAtDeelForZone1DetailsActivationCostTokenUsage": { "description": "Add-on token consumption details. Null when billing method is \"CURRENCY\"", "properties": { "addon": { "$ref": "#/components/schemas/ItAssetsAssetIdLocationPostResponsesContentApplicationJsonSchemaDataActionsStoreRentalAtDeelForZone1DetailsActivationCostTokenUsageAddon", "description": "The add-on that provides the tokens" }, "cost": { "description": "Number of tokens consumed by the action. Zero when the add-on covers the\nservice without drawing from a token pool", "format": "decimal", "type": "string" }, "tokens_left": { "description": "Number of tokens left in the pool after the action is performed. Null when\nthe add-on covers the service without a token pool", "format": "decimal", "type": [ "string", "null" ] } }, "required": [ "cost", "addon", "tokens_left" ], "title": "ItAssetsAssetIdLocationPostResponsesContentApplicationJsonSchemaDataActionsStoreRentalAtDeelForZone1DetailsActivationCostTokenUsage", "type": "object" }, "ItAssetsAssetIdLocationPostResponsesContentApplicationJsonSchemaDataActionsStoreRentalAtDeelForZone1DetailsActivationCostTokenUsageAddon": { "description": "The add-on that provides the tokens", "properties": { "id": { "description": "ID of the add-on", "format": "uuid", "type": "string" }, "name": { "description": "Public display name of the add-on", "type": "string" } }, "required": [ "id", "name" ], "title": "ItAssetsAssetIdLocationPostResponsesContentApplicationJsonSchemaDataActionsStoreRentalAtDeelForZone1DetailsActivationCostTokenUsageAddon", "type": "object" }, "ItAssetsAssetIdLocationPostResponsesContentApplicationJsonSchemaDataActionsStoreRentalAtDeelForZone1DisabledReasonsItems": { "enum": [ "ARCHIVED", "AT_DEEL_WAREHOUSE", "BEING_REPAIRED", "CONSUMABLE", "CONTROLLED_BY_DEEL", "COUNTRY_NOT_SUPPORTED_FOR_HUB", "COUNTRY_NOT_SUPPORTED_FOR_LOCAL", "DEEL_OWNED_ITEM_WITHOUT_RENTAL_CONTRACT", "DESKTOP_STORAGE", "ENDING_CONTRACT", "HUB_IN_SAME_REGION_AS_LOCAL", "INACTIVE", "INVALID_ITEM_LOCATION", "INVALID_ORGANIZATION_STATUS", "INVALID_STATE", "ITEM_CONDITIONS_TO_UNARCHIVE_NOT_MET", "ITEM_NOT_VISIBLE_FOR_ORGANIZATION", "NON_DEVICE", "NOT_AT_WAREHOUSE", "NOT_AVAILABLE_FOR_REUSE", "NOT_A_RENTAL", "NOT_MANAGEABLE_BY_ORGANIZATION", "NOT_WITH_ASSIGNMENT", "NOT_WITH_USER", "NO_ACTIVE_ADDONS", "NO_ACTIVE_STORAGE_CONTRACT", "NO_LOCATION_FOR_STORAGE", "NO_LOGISTICS_FOR_STORAGE", "NO_VALID_ADDONS", "ONGOING_SERVICE", "OWNED_BY_DEEL", "OWNED_BY_ORGANIZATION", "OWNED_BY_PARTNER_ORGANIZATION", "PARTNER_CHILD_CONTRACT", "PENDING_DEVICE_REFRESH", "RENTAL_CONTRACT_AND_USER_REGION_DO_NOT_MATCH", "TEMPORARILY_UNAVAILABLE", "UNKNOWN", "USER_HAS_NO_COUNTRY", "USER_HAS_NO_SEAT", "WAITING_FOR_CLEARANCE", "WITH_LOANER_ASSIGNMENT", "WITH_NON_COLLECTED_ASSIGNMENT", "WITH_NON_DELIVERED_ASSIGNMENT", "WITH_PENDING_ASSIGNMENT", "WRONG_ASSIGNMENT_STATUS", "WRONG_CONTRACT_STATUS", "WRONG_TERMS_AND_CONDITIONS" ], "title": "ItAssetsAssetIdLocationPostResponsesContentApplicationJsonSchemaDataActionsStoreRentalAtDeelForZone1DisabledReasonsItems", "type": "string" }, "ItAssetsAssetIdLocationPostResponsesContentApplicationJsonSchemaDataActionsStoreRentalAtDeelForZone1Status": { "description": "Whether the action is currently available for this asset", "enum": [ "DISABLED", "ENABLED", "NOT_APPLICABLE" ], "title": "ItAssetsAssetIdLocationPostResponsesContentApplicationJsonSchemaDataActionsStoreRentalAtDeelForZone1Status", "type": "string" }, "ItAssetsAssetIdLocationPostResponsesContentApplicationJsonSchemaDataActionsTransferOwnAsset": { "description": "Transfer an organization-owned asset to another user", "properties": { "details": { "description": "Action-specific context needed to perform the action. Populated for enabled and\ndisabled actions (so callers can see what a successful attempt would look like);\nnull when the action is not applicable to this asset.", "oneOf": [ { "$ref": "#/components/schemas/ItAssetsAssetIdLocationPostResponsesContentApplicationJsonSchemaDataActionsTransferOwnAssetDetails" }, { "type": "null" } ] }, "disabled_reasons": { "description": "Reasons why the action is disabled. Empty when the action is enabled or not applicable", "items": { "$ref": "#/components/schemas/ItAssetsAssetIdLocationPostResponsesContentApplicationJsonSchemaDataActionsTransferOwnAssetDisabledReasonsItems" }, "type": "array" }, "status": { "$ref": "#/components/schemas/ItAssetsAssetIdLocationPostResponsesContentApplicationJsonSchemaDataActionsTransferOwnAssetStatus", "description": "Whether the action is currently available for this asset" } }, "required": [ "status", "details", "disabled_reasons" ], "title": "ItAssetsAssetIdLocationPostResponsesContentApplicationJsonSchemaDataActionsTransferOwnAsset", "type": "object" }, "ItAssetsAssetIdLocationPostResponsesContentApplicationJsonSchemaDataActionsTransferOwnAssetDetails": { "description": "Action-specific context needed to perform the action. Populated for enabled and\ndisabled actions (so callers can see what a successful attempt would look like);\nnull when the action is not applicable to this asset.", "properties": { "eligible_countries": { "description": "Countries the asset can be transferred to", "items": { "$ref": "#/components/schemas/ItAssetsAssetIdLocationPostResponsesContentApplicationJsonSchemaDataActionsTransferOwnAssetDetailsEligibleCountriesItems" }, "type": "array" }, "transfer_cost": { "$ref": "#/components/schemas/ItAssetsAssetIdLocationPostResponsesContentApplicationJsonSchemaDataActionsTransferOwnAssetDetailsTransferCost", "description": "Cost charged for the transfer service" } }, "required": [ "transfer_cost", "eligible_countries" ], "title": "ItAssetsAssetIdLocationPostResponsesContentApplicationJsonSchemaDataActionsTransferOwnAssetDetails", "type": "object" }, "ItAssetsAssetIdLocationPostResponsesContentApplicationJsonSchemaDataActionsTransferOwnAssetDetailsEligibleCountriesItems": { "enum": [ "AD", "AE", "AF", "AG", "AI", "AL", "AM", "AN", "AO", "AQ", "AR", "AS", "AT", "AU", "AW", "AX", "AZ", "BA", "BB", "BD", "BE", "BF", "BG", "BH", "BI", "BJ", "BL", "BM", "BN", "BO", "BQ", "BR", "BS", "BT", "BV", "BW", "BY", "BZ", "CA", "CC", "CD", "CF", "CG", "CH", "CI", "CK", "CL", "CM", "CN", "CO", "CR", "CU", "CV", "CW", "CX", "CY", "CZ", "DE", "DJ", "DK", "DM", "DO", "DZ", "EC", "EE", "EG", "EH", "ER", "ES", "ET", "FI", "FJ", "FK", "FM", "FO", "FR", "GA", "GB", "GD", "GE", "GF", "GG", "GH", "GI", "GL", "GM", "GN", "GP", "GQ", "GR", "GS", "GT", "GU", "GW", "GY", "HK", "HM", "HN", "HR", "HT", "HU", "IC", "ID", "IE", "IL", "IM", "IN", "IO", "IQ", "IR", "IS", "IT", "JE", "JM", "JO", "JP", "KE", "KG", "KH", "KI", "KM", "KN", "KP", "KR", "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", "XK", "YE", "YT", "ZA", "ZM", "ZW" ], "title": "ItAssetsAssetIdLocationPostResponsesContentApplicationJsonSchemaDataActionsTransferOwnAssetDetailsEligibleCountriesItems", "type": "string" }, "ItAssetsAssetIdLocationPostResponsesContentApplicationJsonSchemaDataActionsTransferOwnAssetDetailsTransferCost": { "description": "Cost charged for the transfer service", "properties": { "billing_method": { "$ref": "#/components/schemas/ItAssetsAssetIdLocationPostResponsesContentApplicationJsonSchemaDataActionsTransferOwnAssetDetailsTransferCostBillingMethod", "description": "How the action is charged. When \"TOKEN\", the fees are covered by an\nadd-on token pool; when \"CURRENCY\", the fees are billed in the currency\nspecified in the \"fees\" field." }, "fees": { "description": "Price charged for the action. Null when billing method is \"TOKEN\"", "oneOf": [ { "$ref": "#/components/schemas/ItAssetsAssetIdLocationPostResponsesContentApplicationJsonSchemaDataActionsTransferOwnAssetDetailsTransferCostFees" }, { "type": "null" } ] }, "token_usage": { "description": "Add-on token consumption details. Null when billing method is \"CURRENCY\"", "oneOf": [ { "$ref": "#/components/schemas/ItAssetsAssetIdLocationPostResponsesContentApplicationJsonSchemaDataActionsTransferOwnAssetDetailsTransferCostTokenUsage" }, { "type": "null" } ] } }, "required": [ "fees", "token_usage", "billing_method" ], "title": "ItAssetsAssetIdLocationPostResponsesContentApplicationJsonSchemaDataActionsTransferOwnAssetDetailsTransferCost", "type": "object" }, "ItAssetsAssetIdLocationPostResponsesContentApplicationJsonSchemaDataActionsTransferOwnAssetDetailsTransferCostBillingMethod": { "description": "How the action is charged. When \"TOKEN\", the fees are covered by an\nadd-on token pool; when \"CURRENCY\", the fees are billed in the currency\nspecified in the \"fees\" field.", "enum": [ "CURRENCY", "TOKEN" ], "title": "ItAssetsAssetIdLocationPostResponsesContentApplicationJsonSchemaDataActionsTransferOwnAssetDetailsTransferCostBillingMethod", "type": "string" }, "ItAssetsAssetIdLocationPostResponsesContentApplicationJsonSchemaDataActionsTransferOwnAssetDetailsTransferCostFees": { "description": "Price charged for the action. Null when billing method is \"TOKEN\"", "properties": { "amount": { "description": "Amount", "format": "decimal", "type": "string" }, "currency": { "$ref": "#/components/schemas/ItAssetsAssetIdLocationPostResponsesContentApplicationJsonSchemaDataActionsTransferOwnAssetDetailsTransferCostFeesCurrency", "description": "Three-letter currency code for the price" } }, "required": [ "amount", "currency" ], "title": "ItAssetsAssetIdLocationPostResponsesContentApplicationJsonSchemaDataActionsTransferOwnAssetDetailsTransferCostFees", "type": "object" }, "ItAssetsAssetIdLocationPostResponsesContentApplicationJsonSchemaDataActionsTransferOwnAssetDetailsTransferCostFeesCurrency": { "description": "Three-letter currency code for the price", "enum": [ "AED", "AFN", "ALL", "AMD", "ANG", "AOA", "ARS", "AUD", "AWG", "AZN", "BAM", "BDT", "BGN", "BHD", "BIF", "BMD", "BOB", "BRL", "BSD", "BTN", "BWP", "BYN", "BZD", "CAD", "CDF", "CHF", "CLP", "CNY", "COP", "CRC", "CUC", "CVE", "CZK", "DJF", "DKK", "DOP", "DZD", "EGP", "ERN", "ETB", "EUR", "FJD", "FKP", "GBP", "GEL", "GHS", "GIP", "GMD", "GNF", "GTQ", "GYD", "HKD", "HNL", "HRK", "HTG", "HUF", "IDR", "ILS", "INR", "IQD", "IRR", "ISK", "JMD", "JOD", "JPY", "KES", "KGS", "KHR", "KMF", "KPW", "KRW", "KWD", "KYD", "KZT", "LAK", "LBP", "LKR", "LRD", "LSL", "LTL", "LYD", "MAD", "MDL", "MGA", "MKD", "MMK", "MNT", "MRU", "MUR", "MVR", "MWK", "MXN", "MYR", "MZN", "NAD", "NGN", "NIO", "NOK", "NPR", "NZD", "OMR", "PAB", "PEN", "PGK", "PHP", "PKR", "PLN", "PYG", "QAR", "RON", "RSD", "RUB", "RWF", "SAR", "SBD", "SCR", "SDG", "SEK", "SGD", "SHP", "SLL", "SOS", "SRD", "SSP", "STD", "SYP", "SZL", "THB", "TJS", "TMT", "TND", "TOP", "TRY", "TTD", "TWD", "TZS", "UAH", "UGX", "USD", "UYU", "UZS", "VEF", "VND", "VUV", "WST", "XAF", "XCD", "XOF", "XPF", "YER", "ZAR", "ZMW", "ZWD" ], "title": "ItAssetsAssetIdLocationPostResponsesContentApplicationJsonSchemaDataActionsTransferOwnAssetDetailsTransferCostFeesCurrency", "type": "string" }, "ItAssetsAssetIdLocationPostResponsesContentApplicationJsonSchemaDataActionsTransferOwnAssetDetailsTransferCostTokenUsage": { "description": "Add-on token consumption details. Null when billing method is \"CURRENCY\"", "properties": { "addon": { "$ref": "#/components/schemas/ItAssetsAssetIdLocationPostResponsesContentApplicationJsonSchemaDataActionsTransferOwnAssetDetailsTransferCostTokenUsageAddon", "description": "The add-on that provides the tokens" }, "cost": { "description": "Number of tokens consumed by the action. Zero when the add-on covers the\nservice without drawing from a token pool", "format": "decimal", "type": "string" }, "tokens_left": { "description": "Number of tokens left in the pool after the action is performed. Null when\nthe add-on covers the service without a token pool", "format": "decimal", "type": [ "string", "null" ] } }, "required": [ "cost", "addon", "tokens_left" ], "title": "ItAssetsAssetIdLocationPostResponsesContentApplicationJsonSchemaDataActionsTransferOwnAssetDetailsTransferCostTokenUsage", "type": "object" }, "ItAssetsAssetIdLocationPostResponsesContentApplicationJsonSchemaDataActionsTransferOwnAssetDetailsTransferCostTokenUsageAddon": { "description": "The add-on that provides the tokens", "properties": { "id": { "description": "ID of the add-on", "format": "uuid", "type": "string" }, "name": { "description": "Public display name of the add-on", "type": "string" } }, "required": [ "id", "name" ], "title": "ItAssetsAssetIdLocationPostResponsesContentApplicationJsonSchemaDataActionsTransferOwnAssetDetailsTransferCostTokenUsageAddon", "type": "object" }, "ItAssetsAssetIdLocationPostResponsesContentApplicationJsonSchemaDataActionsTransferOwnAssetDisabledReasonsItems": { "enum": [ "ARCHIVED", "AT_DEEL_WAREHOUSE", "BEING_REPAIRED", "CONSUMABLE", "CONTROLLED_BY_DEEL", "COUNTRY_NOT_SUPPORTED_FOR_HUB", "COUNTRY_NOT_SUPPORTED_FOR_LOCAL", "DEEL_OWNED_ITEM_WITHOUT_RENTAL_CONTRACT", "DESKTOP_STORAGE", "ENDING_CONTRACT", "HUB_IN_SAME_REGION_AS_LOCAL", "INACTIVE", "INVALID_ITEM_LOCATION", "INVALID_ORGANIZATION_STATUS", "INVALID_STATE", "ITEM_CONDITIONS_TO_UNARCHIVE_NOT_MET", "ITEM_NOT_VISIBLE_FOR_ORGANIZATION", "NON_DEVICE", "NOT_AT_WAREHOUSE", "NOT_AVAILABLE_FOR_REUSE", "NOT_A_RENTAL", "NOT_MANAGEABLE_BY_ORGANIZATION", "NOT_WITH_ASSIGNMENT", "NOT_WITH_USER", "NO_ACTIVE_ADDONS", "NO_ACTIVE_STORAGE_CONTRACT", "NO_LOCATION_FOR_STORAGE", "NO_LOGISTICS_FOR_STORAGE", "NO_VALID_ADDONS", "ONGOING_SERVICE", "OWNED_BY_DEEL", "OWNED_BY_ORGANIZATION", "OWNED_BY_PARTNER_ORGANIZATION", "PARTNER_CHILD_CONTRACT", "PENDING_DEVICE_REFRESH", "RENTAL_CONTRACT_AND_USER_REGION_DO_NOT_MATCH", "TEMPORARILY_UNAVAILABLE", "UNKNOWN", "USER_HAS_NO_COUNTRY", "USER_HAS_NO_SEAT", "WAITING_FOR_CLEARANCE", "WITH_LOANER_ASSIGNMENT", "WITH_NON_COLLECTED_ASSIGNMENT", "WITH_NON_DELIVERED_ASSIGNMENT", "WITH_PENDING_ASSIGNMENT", "WRONG_ASSIGNMENT_STATUS", "WRONG_CONTRACT_STATUS", "WRONG_TERMS_AND_CONDITIONS" ], "title": "ItAssetsAssetIdLocationPostResponsesContentApplicationJsonSchemaDataActionsTransferOwnAssetDisabledReasonsItems", "type": "string" }, "ItAssetsAssetIdLocationPostResponsesContentApplicationJsonSchemaDataActionsTransferOwnAssetStatus": { "description": "Whether the action is currently available for this asset", "enum": [ "DISABLED", "ENABLED", "NOT_APPLICABLE" ], "title": "ItAssetsAssetIdLocationPostResponsesContentApplicationJsonSchemaDataActionsTransferOwnAssetStatus", "type": "string" }, "ItAssetsAssetIdLocationPostResponsesContentApplicationJsonSchemaDataActionsTransferRental": { "description": "Transfer a Deel-owned rental asset to another user", "properties": { "details": { "description": "Action-specific context needed to perform the action. Populated for enabled and\ndisabled actions (so callers can see what a successful attempt would look like);\nnull when the action is not applicable to this asset.", "oneOf": [ { "$ref": "#/components/schemas/ItAssetsAssetIdLocationPostResponsesContentApplicationJsonSchemaDataActionsTransferRentalDetails" }, { "type": "null" } ] }, "disabled_reasons": { "description": "Reasons why the action is disabled. Empty when the action is enabled or not applicable", "items": { "$ref": "#/components/schemas/ItAssetsAssetIdLocationPostResponsesContentApplicationJsonSchemaDataActionsTransferRentalDisabledReasonsItems" }, "type": "array" }, "status": { "$ref": "#/components/schemas/ItAssetsAssetIdLocationPostResponsesContentApplicationJsonSchemaDataActionsTransferRentalStatus", "description": "Whether the action is currently available for this asset" } }, "required": [ "status", "details", "disabled_reasons" ], "title": "ItAssetsAssetIdLocationPostResponsesContentApplicationJsonSchemaDataActionsTransferRental", "type": "object" }, "ItAssetsAssetIdLocationPostResponsesContentApplicationJsonSchemaDataActionsTransferRentalDetails": { "description": "Action-specific context needed to perform the action. Populated for enabled and\ndisabled actions (so callers can see what a successful attempt would look like);\nnull when the action is not applicable to this asset.", "properties": { "eligible_countries": { "description": "Countries the asset can be transferred to", "items": { "$ref": "#/components/schemas/ItAssetsAssetIdLocationPostResponsesContentApplicationJsonSchemaDataActionsTransferRentalDetailsEligibleCountriesItems" }, "type": "array" }, "transfer_cost": { "$ref": "#/components/schemas/ItAssetsAssetIdLocationPostResponsesContentApplicationJsonSchemaDataActionsTransferRentalDetailsTransferCost", "description": "Cost charged for the transfer service" } }, "required": [ "transfer_cost", "eligible_countries" ], "title": "ItAssetsAssetIdLocationPostResponsesContentApplicationJsonSchemaDataActionsTransferRentalDetails", "type": "object" }, "ItAssetsAssetIdLocationPostResponsesContentApplicationJsonSchemaDataActionsTransferRentalDetailsEligibleCountriesItems": { "enum": [ "AD", "AE", "AF", "AG", "AI", "AL", "AM", "AN", "AO", "AQ", "AR", "AS", "AT", "AU", "AW", "AX", "AZ", "BA", "BB", "BD", "BE", "BF", "BG", "BH", "BI", "BJ", "BL", "BM", "BN", "BO", "BQ", "BR", "BS", "BT", "BV", "BW", "BY", "BZ", "CA", "CC", "CD", "CF", "CG", "CH", "CI", "CK", "CL", "CM", "CN", "CO", "CR", "CU", "CV", "CW", "CX", "CY", "CZ", "DE", "DJ", "DK", "DM", "DO", "DZ", "EC", "EE", "EG", "EH", "ER", "ES", "ET", "FI", "FJ", "FK", "FM", "FO", "FR", "GA", "GB", "GD", "GE", "GF", "GG", "GH", "GI", "GL", "GM", "GN", "GP", "GQ", "GR", "GS", "GT", "GU", "GW", "GY", "HK", "HM", "HN", "HR", "HT", "HU", "IC", "ID", "IE", "IL", "IM", "IN", "IO", "IQ", "IR", "IS", "IT", "JE", "JM", "JO", "JP", "KE", "KG", "KH", "KI", "KM", "KN", "KP", "KR", "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", "XK", "YE", "YT", "ZA", "ZM", "ZW" ], "title": "ItAssetsAssetIdLocationPostResponsesContentApplicationJsonSchemaDataActionsTransferRentalDetailsEligibleCountriesItems", "type": "string" }, "ItAssetsAssetIdLocationPostResponsesContentApplicationJsonSchemaDataActionsTransferRentalDetailsTransferCost": { "description": "Cost charged for the transfer service", "properties": { "billing_method": { "$ref": "#/components/schemas/ItAssetsAssetIdLocationPostResponsesContentApplicationJsonSchemaDataActionsTransferRentalDetailsTransferCostBillingMethod", "description": "How the action is charged. When \"TOKEN\", the fees are covered by an\nadd-on token pool; when \"CURRENCY\", the fees are billed in the currency\nspecified in the \"fees\" field." }, "fees": { "description": "Price charged for the action. Null when billing method is \"TOKEN\"", "oneOf": [ { "$ref": "#/components/schemas/ItAssetsAssetIdLocationPostResponsesContentApplicationJsonSchemaDataActionsTransferRentalDetailsTransferCostFees" }, { "type": "null" } ] }, "token_usage": { "description": "Add-on token consumption details. Null when billing method is \"CURRENCY\"", "oneOf": [ { "$ref": "#/components/schemas/ItAssetsAssetIdLocationPostResponsesContentApplicationJsonSchemaDataActionsTransferRentalDetailsTransferCostTokenUsage" }, { "type": "null" } ] } }, "required": [ "fees", "token_usage", "billing_method" ], "title": "ItAssetsAssetIdLocationPostResponsesContentApplicationJsonSchemaDataActionsTransferRentalDetailsTransferCost", "type": "object" }, "ItAssetsAssetIdLocationPostResponsesContentApplicationJsonSchemaDataActionsTransferRentalDetailsTransferCostBillingMethod": { "description": "How the action is charged. When \"TOKEN\", the fees are covered by an\nadd-on token pool; when \"CURRENCY\", the fees are billed in the currency\nspecified in the \"fees\" field.", "enum": [ "CURRENCY", "TOKEN" ], "title": "ItAssetsAssetIdLocationPostResponsesContentApplicationJsonSchemaDataActionsTransferRentalDetailsTransferCostBillingMethod", "type": "string" }, "ItAssetsAssetIdLocationPostResponsesContentApplicationJsonSchemaDataActionsTransferRentalDetailsTransferCostFees": { "description": "Price charged for the action. Null when billing method is \"TOKEN\"", "properties": { "amount": { "description": "Amount", "format": "decimal", "type": "string" }, "currency": { "$ref": "#/components/schemas/ItAssetsAssetIdLocationPostResponsesContentApplicationJsonSchemaDataActionsTransferRentalDetailsTransferCostFeesCurrency", "description": "Three-letter currency code for the price" } }, "required": [ "amount", "currency" ], "title": "ItAssetsAssetIdLocationPostResponsesContentApplicationJsonSchemaDataActionsTransferRentalDetailsTransferCostFees", "type": "object" }, "ItAssetsAssetIdLocationPostResponsesContentApplicationJsonSchemaDataActionsTransferRentalDetailsTransferCostFeesCurrency": { "description": "Three-letter currency code for the price", "enum": [ "AED", "AFN", "ALL", "AMD", "ANG", "AOA", "ARS", "AUD", "AWG", "AZN", "BAM", "BDT", "BGN", "BHD", "BIF", "BMD", "BOB", "BRL", "BSD", "BTN", "BWP", "BYN", "BZD", "CAD", "CDF", "CHF", "CLP", "CNY", "COP", "CRC", "CUC", "CVE", "CZK", "DJF", "DKK", "DOP", "DZD", "EGP", "ERN", "ETB", "EUR", "FJD", "FKP", "GBP", "GEL", "GHS", "GIP", "GMD", "GNF", "GTQ", "GYD", "HKD", "HNL", "HRK", "HTG", "HUF", "IDR", "ILS", "INR", "IQD", "IRR", "ISK", "JMD", "JOD", "JPY", "KES", "KGS", "KHR", "KMF", "KPW", "KRW", "KWD", "KYD", "KZT", "LAK", "LBP", "LKR", "LRD", "LSL", "LTL", "LYD", "MAD", "MDL", "MGA", "MKD", "MMK", "MNT", "MRU", "MUR", "MVR", "MWK", "MXN", "MYR", "MZN", "NAD", "NGN", "NIO", "NOK", "NPR", "NZD", "OMR", "PAB", "PEN", "PGK", "PHP", "PKR", "PLN", "PYG", "QAR", "RON", "RSD", "RUB", "RWF", "SAR", "SBD", "SCR", "SDG", "SEK", "SGD", "SHP", "SLL", "SOS", "SRD", "SSP", "STD", "SYP", "SZL", "THB", "TJS", "TMT", "TND", "TOP", "TRY", "TTD", "TWD", "TZS", "UAH", "UGX", "USD", "UYU", "UZS", "VEF", "VND", "VUV", "WST", "XAF", "XCD", "XOF", "XPF", "YER", "ZAR", "ZMW", "ZWD" ], "title": "ItAssetsAssetIdLocationPostResponsesContentApplicationJsonSchemaDataActionsTransferRentalDetailsTransferCostFeesCurrency", "type": "string" }, "ItAssetsAssetIdLocationPostResponsesContentApplicationJsonSchemaDataActionsTransferRentalDetailsTransferCostTokenUsage": { "description": "Add-on token consumption details. Null when billing method is \"CURRENCY\"", "properties": { "addon": { "$ref": "#/components/schemas/ItAssetsAssetIdLocationPostResponsesContentApplicationJsonSchemaDataActionsTransferRentalDetailsTransferCostTokenUsageAddon", "description": "The add-on that provides the tokens" }, "cost": { "description": "Number of tokens consumed by the action. Zero when the add-on covers the\nservice without drawing from a token pool", "format": "decimal", "type": "string" }, "tokens_left": { "description": "Number of tokens left in the pool after the action is performed. Null when\nthe add-on covers the service without a token pool", "format": "decimal", "type": [ "string", "null" ] } }, "required": [ "cost", "addon", "tokens_left" ], "title": "ItAssetsAssetIdLocationPostResponsesContentApplicationJsonSchemaDataActionsTransferRentalDetailsTransferCostTokenUsage", "type": "object" }, "ItAssetsAssetIdLocationPostResponsesContentApplicationJsonSchemaDataActionsTransferRentalDetailsTransferCostTokenUsageAddon": { "description": "The add-on that provides the tokens", "properties": { "id": { "description": "ID of the add-on", "format": "uuid", "type": "string" }, "name": { "description": "Public display name of the add-on", "type": "string" } }, "required": [ "id", "name" ], "title": "ItAssetsAssetIdLocationPostResponsesContentApplicationJsonSchemaDataActionsTransferRentalDetailsTransferCostTokenUsageAddon", "type": "object" }, "ItAssetsAssetIdLocationPostResponsesContentApplicationJsonSchemaDataActionsTransferRentalDisabledReasonsItems": { "enum": [ "ARCHIVED", "AT_DEEL_WAREHOUSE", "BEING_REPAIRED", "CONSUMABLE", "CONTROLLED_BY_DEEL", "COUNTRY_NOT_SUPPORTED_FOR_HUB", "COUNTRY_NOT_SUPPORTED_FOR_LOCAL", "DEEL_OWNED_ITEM_WITHOUT_RENTAL_CONTRACT", "DESKTOP_STORAGE", "ENDING_CONTRACT", "HUB_IN_SAME_REGION_AS_LOCAL", "INACTIVE", "INVALID_ITEM_LOCATION", "INVALID_ORGANIZATION_STATUS", "INVALID_STATE", "ITEM_CONDITIONS_TO_UNARCHIVE_NOT_MET", "ITEM_NOT_VISIBLE_FOR_ORGANIZATION", "NON_DEVICE", "NOT_AT_WAREHOUSE", "NOT_AVAILABLE_FOR_REUSE", "NOT_A_RENTAL", "NOT_MANAGEABLE_BY_ORGANIZATION", "NOT_WITH_ASSIGNMENT", "NOT_WITH_USER", "NO_ACTIVE_ADDONS", "NO_ACTIVE_STORAGE_CONTRACT", "NO_LOCATION_FOR_STORAGE", "NO_LOGISTICS_FOR_STORAGE", "NO_VALID_ADDONS", "ONGOING_SERVICE", "OWNED_BY_DEEL", "OWNED_BY_ORGANIZATION", "OWNED_BY_PARTNER_ORGANIZATION", "PARTNER_CHILD_CONTRACT", "PENDING_DEVICE_REFRESH", "RENTAL_CONTRACT_AND_USER_REGION_DO_NOT_MATCH", "TEMPORARILY_UNAVAILABLE", "UNKNOWN", "USER_HAS_NO_COUNTRY", "USER_HAS_NO_SEAT", "WAITING_FOR_CLEARANCE", "WITH_LOANER_ASSIGNMENT", "WITH_NON_COLLECTED_ASSIGNMENT", "WITH_NON_DELIVERED_ASSIGNMENT", "WITH_PENDING_ASSIGNMENT", "WRONG_ASSIGNMENT_STATUS", "WRONG_CONTRACT_STATUS", "WRONG_TERMS_AND_CONDITIONS" ], "title": "ItAssetsAssetIdLocationPostResponsesContentApplicationJsonSchemaDataActionsTransferRentalDisabledReasonsItems", "type": "string" }, "ItAssetsAssetIdLocationPostResponsesContentApplicationJsonSchemaDataActionsTransferRentalStatus": { "description": "Whether the action is currently available for this asset", "enum": [ "DISABLED", "ENABLED", "NOT_APPLICABLE" ], "title": "ItAssetsAssetIdLocationPostResponsesContentApplicationJsonSchemaDataActionsTransferRentalStatus", "type": "string" }, "ItAssetsAssetIdLocationPostResponsesContentApplicationJsonSchemaDataActionsUnarchiveOwnAsset": { "description": "Unarchive a previously archived organization-owned asset", "properties": { "disabled_reasons": { "description": "Reasons why the action is disabled. Empty when the action is enabled or not applicable", "items": { "$ref": "#/components/schemas/ItAssetsAssetIdLocationPostResponsesContentApplicationJsonSchemaDataActionsUnarchiveOwnAssetDisabledReasonsItems" }, "type": "array" }, "status": { "$ref": "#/components/schemas/ItAssetsAssetIdLocationPostResponsesContentApplicationJsonSchemaDataActionsUnarchiveOwnAssetStatus", "description": "Whether the action is currently available for this asset" } }, "required": [ "status", "disabled_reasons" ], "title": "ItAssetsAssetIdLocationPostResponsesContentApplicationJsonSchemaDataActionsUnarchiveOwnAsset", "type": "object" }, "ItAssetsAssetIdLocationPostResponsesContentApplicationJsonSchemaDataActionsUnarchiveOwnAssetDisabledReasonsItems": { "enum": [ "ARCHIVED", "AT_DEEL_WAREHOUSE", "BEING_REPAIRED", "CONSUMABLE", "CONTROLLED_BY_DEEL", "COUNTRY_NOT_SUPPORTED_FOR_HUB", "COUNTRY_NOT_SUPPORTED_FOR_LOCAL", "DEEL_OWNED_ITEM_WITHOUT_RENTAL_CONTRACT", "DESKTOP_STORAGE", "ENDING_CONTRACT", "HUB_IN_SAME_REGION_AS_LOCAL", "INACTIVE", "INVALID_ITEM_LOCATION", "INVALID_ORGANIZATION_STATUS", "INVALID_STATE", "ITEM_CONDITIONS_TO_UNARCHIVE_NOT_MET", "ITEM_NOT_VISIBLE_FOR_ORGANIZATION", "NON_DEVICE", "NOT_AT_WAREHOUSE", "NOT_AVAILABLE_FOR_REUSE", "NOT_A_RENTAL", "NOT_MANAGEABLE_BY_ORGANIZATION", "NOT_WITH_ASSIGNMENT", "NOT_WITH_USER", "NO_ACTIVE_ADDONS", "NO_ACTIVE_STORAGE_CONTRACT", "NO_LOCATION_FOR_STORAGE", "NO_LOGISTICS_FOR_STORAGE", "NO_VALID_ADDONS", "ONGOING_SERVICE", "OWNED_BY_DEEL", "OWNED_BY_ORGANIZATION", "OWNED_BY_PARTNER_ORGANIZATION", "PARTNER_CHILD_CONTRACT", "PENDING_DEVICE_REFRESH", "RENTAL_CONTRACT_AND_USER_REGION_DO_NOT_MATCH", "TEMPORARILY_UNAVAILABLE", "UNKNOWN", "USER_HAS_NO_COUNTRY", "USER_HAS_NO_SEAT", "WAITING_FOR_CLEARANCE", "WITH_LOANER_ASSIGNMENT", "WITH_NON_COLLECTED_ASSIGNMENT", "WITH_NON_DELIVERED_ASSIGNMENT", "WITH_PENDING_ASSIGNMENT", "WRONG_ASSIGNMENT_STATUS", "WRONG_CONTRACT_STATUS", "WRONG_TERMS_AND_CONDITIONS" ], "title": "ItAssetsAssetIdLocationPostResponsesContentApplicationJsonSchemaDataActionsUnarchiveOwnAssetDisabledReasonsItems", "type": "string" }, "ItAssetsAssetIdLocationPostResponsesContentApplicationJsonSchemaDataActionsUnarchiveOwnAssetStatus": { "description": "Whether the action is currently available for this asset", "enum": [ "DISABLED", "ENABLED", "NOT_APPLICABLE" ], "title": "ItAssetsAssetIdLocationPostResponsesContentApplicationJsonSchemaDataActionsUnarchiveOwnAssetStatus", "type": "string" }, "ItAssetsAssetIdLocationPostResponsesContentApplicationJsonSchemaDataActionsUpdateLocationLocationToUser": { "description": "Update the location of an asset from a warehouse to a user", "properties": { "disabled_reasons": { "description": "Reasons why the action is disabled. Empty when the action is enabled or not applicable", "items": { "$ref": "#/components/schemas/ItAssetsAssetIdLocationPostResponsesContentApplicationJsonSchemaDataActionsUpdateLocationLocationToUserDisabledReasonsItems" }, "type": "array" }, "status": { "$ref": "#/components/schemas/ItAssetsAssetIdLocationPostResponsesContentApplicationJsonSchemaDataActionsUpdateLocationLocationToUserStatus", "description": "Whether the action is currently available for this asset" } }, "required": [ "status", "disabled_reasons" ], "title": "ItAssetsAssetIdLocationPostResponsesContentApplicationJsonSchemaDataActionsUpdateLocationLocationToUser", "type": "object" }, "ItAssetsAssetIdLocationPostResponsesContentApplicationJsonSchemaDataActionsUpdateLocationLocationToUserDisabledReasonsItems": { "enum": [ "ARCHIVED", "AT_DEEL_WAREHOUSE", "BEING_REPAIRED", "CONSUMABLE", "CONTROLLED_BY_DEEL", "COUNTRY_NOT_SUPPORTED_FOR_HUB", "COUNTRY_NOT_SUPPORTED_FOR_LOCAL", "DEEL_OWNED_ITEM_WITHOUT_RENTAL_CONTRACT", "DESKTOP_STORAGE", "ENDING_CONTRACT", "HUB_IN_SAME_REGION_AS_LOCAL", "INACTIVE", "INVALID_ITEM_LOCATION", "INVALID_ORGANIZATION_STATUS", "INVALID_STATE", "ITEM_CONDITIONS_TO_UNARCHIVE_NOT_MET", "ITEM_NOT_VISIBLE_FOR_ORGANIZATION", "NON_DEVICE", "NOT_AT_WAREHOUSE", "NOT_AVAILABLE_FOR_REUSE", "NOT_A_RENTAL", "NOT_MANAGEABLE_BY_ORGANIZATION", "NOT_WITH_ASSIGNMENT", "NOT_WITH_USER", "NO_ACTIVE_ADDONS", "NO_ACTIVE_STORAGE_CONTRACT", "NO_LOCATION_FOR_STORAGE", "NO_LOGISTICS_FOR_STORAGE", "NO_VALID_ADDONS", "ONGOING_SERVICE", "OWNED_BY_DEEL", "OWNED_BY_ORGANIZATION", "OWNED_BY_PARTNER_ORGANIZATION", "PARTNER_CHILD_CONTRACT", "PENDING_DEVICE_REFRESH", "RENTAL_CONTRACT_AND_USER_REGION_DO_NOT_MATCH", "TEMPORARILY_UNAVAILABLE", "UNKNOWN", "USER_HAS_NO_COUNTRY", "USER_HAS_NO_SEAT", "WAITING_FOR_CLEARANCE", "WITH_LOANER_ASSIGNMENT", "WITH_NON_COLLECTED_ASSIGNMENT", "WITH_NON_DELIVERED_ASSIGNMENT", "WITH_PENDING_ASSIGNMENT", "WRONG_ASSIGNMENT_STATUS", "WRONG_CONTRACT_STATUS", "WRONG_TERMS_AND_CONDITIONS" ], "title": "ItAssetsAssetIdLocationPostResponsesContentApplicationJsonSchemaDataActionsUpdateLocationLocationToUserDisabledReasonsItems", "type": "string" }, "ItAssetsAssetIdLocationPostResponsesContentApplicationJsonSchemaDataActionsUpdateLocationLocationToUserStatus": { "description": "Whether the action is currently available for this asset", "enum": [ "DISABLED", "ENABLED", "NOT_APPLICABLE" ], "title": "ItAssetsAssetIdLocationPostResponsesContentApplicationJsonSchemaDataActionsUpdateLocationLocationToUserStatus", "type": "string" }, "ItAssetsAssetIdLocationPostResponsesContentApplicationJsonSchemaDataActionsUpdateLocationUserToLocation": { "description": "Update the location of an asset from a user to a warehouse", "properties": { "disabled_reasons": { "description": "Reasons why the action is disabled. Empty when the action is enabled or not applicable", "items": { "$ref": "#/components/schemas/ItAssetsAssetIdLocationPostResponsesContentApplicationJsonSchemaDataActionsUpdateLocationUserToLocationDisabledReasonsItems" }, "type": "array" }, "status": { "$ref": "#/components/schemas/ItAssetsAssetIdLocationPostResponsesContentApplicationJsonSchemaDataActionsUpdateLocationUserToLocationStatus", "description": "Whether the action is currently available for this asset" } }, "required": [ "status", "disabled_reasons" ], "title": "ItAssetsAssetIdLocationPostResponsesContentApplicationJsonSchemaDataActionsUpdateLocationUserToLocation", "type": "object" }, "ItAssetsAssetIdLocationPostResponsesContentApplicationJsonSchemaDataActionsUpdateLocationUserToLocationDisabledReasonsItems": { "enum": [ "ARCHIVED", "AT_DEEL_WAREHOUSE", "BEING_REPAIRED", "CONSUMABLE", "CONTROLLED_BY_DEEL", "COUNTRY_NOT_SUPPORTED_FOR_HUB", "COUNTRY_NOT_SUPPORTED_FOR_LOCAL", "DEEL_OWNED_ITEM_WITHOUT_RENTAL_CONTRACT", "DESKTOP_STORAGE", "ENDING_CONTRACT", "HUB_IN_SAME_REGION_AS_LOCAL", "INACTIVE", "INVALID_ITEM_LOCATION", "INVALID_ORGANIZATION_STATUS", "INVALID_STATE", "ITEM_CONDITIONS_TO_UNARCHIVE_NOT_MET", "ITEM_NOT_VISIBLE_FOR_ORGANIZATION", "NON_DEVICE", "NOT_AT_WAREHOUSE", "NOT_AVAILABLE_FOR_REUSE", "NOT_A_RENTAL", "NOT_MANAGEABLE_BY_ORGANIZATION", "NOT_WITH_ASSIGNMENT", "NOT_WITH_USER", "NO_ACTIVE_ADDONS", "NO_ACTIVE_STORAGE_CONTRACT", "NO_LOCATION_FOR_STORAGE", "NO_LOGISTICS_FOR_STORAGE", "NO_VALID_ADDONS", "ONGOING_SERVICE", "OWNED_BY_DEEL", "OWNED_BY_ORGANIZATION", "OWNED_BY_PARTNER_ORGANIZATION", "PARTNER_CHILD_CONTRACT", "PENDING_DEVICE_REFRESH", "RENTAL_CONTRACT_AND_USER_REGION_DO_NOT_MATCH", "TEMPORARILY_UNAVAILABLE", "UNKNOWN", "USER_HAS_NO_COUNTRY", "USER_HAS_NO_SEAT", "WAITING_FOR_CLEARANCE", "WITH_LOANER_ASSIGNMENT", "WITH_NON_COLLECTED_ASSIGNMENT", "WITH_NON_DELIVERED_ASSIGNMENT", "WITH_PENDING_ASSIGNMENT", "WRONG_ASSIGNMENT_STATUS", "WRONG_CONTRACT_STATUS", "WRONG_TERMS_AND_CONDITIONS" ], "title": "ItAssetsAssetIdLocationPostResponsesContentApplicationJsonSchemaDataActionsUpdateLocationUserToLocationDisabledReasonsItems", "type": "string" }, "ItAssetsAssetIdLocationPostResponsesContentApplicationJsonSchemaDataActionsUpdateLocationUserToLocationStatus": { "description": "Whether the action is currently available for this asset", "enum": [ "DISABLED", "ENABLED", "NOT_APPLICABLE" ], "title": "ItAssetsAssetIdLocationPostResponsesContentApplicationJsonSchemaDataActionsUpdateLocationUserToLocationStatus", "type": "string" }, "ItAssetsAssetIdLocationPostResponsesContentApplicationJsonSchemaDataActionsUpdateLocationUserToUser": { "description": "Update the assigned user of an asset that is currently with a user", "properties": { "disabled_reasons": { "description": "Reasons why the action is disabled. Empty when the action is enabled or not applicable", "items": { "$ref": "#/components/schemas/ItAssetsAssetIdLocationPostResponsesContentApplicationJsonSchemaDataActionsUpdateLocationUserToUserDisabledReasonsItems" }, "type": "array" }, "status": { "$ref": "#/components/schemas/ItAssetsAssetIdLocationPostResponsesContentApplicationJsonSchemaDataActionsUpdateLocationUserToUserStatus", "description": "Whether the action is currently available for this asset" } }, "required": [ "status", "disabled_reasons" ], "title": "ItAssetsAssetIdLocationPostResponsesContentApplicationJsonSchemaDataActionsUpdateLocationUserToUser", "type": "object" }, "ItAssetsAssetIdLocationPostResponsesContentApplicationJsonSchemaDataActionsUpdateLocationUserToUserDisabledReasonsItems": { "enum": [ "ARCHIVED", "AT_DEEL_WAREHOUSE", "BEING_REPAIRED", "CONSUMABLE", "CONTROLLED_BY_DEEL", "COUNTRY_NOT_SUPPORTED_FOR_HUB", "COUNTRY_NOT_SUPPORTED_FOR_LOCAL", "DEEL_OWNED_ITEM_WITHOUT_RENTAL_CONTRACT", "DESKTOP_STORAGE", "ENDING_CONTRACT", "HUB_IN_SAME_REGION_AS_LOCAL", "INACTIVE", "INVALID_ITEM_LOCATION", "INVALID_ORGANIZATION_STATUS", "INVALID_STATE", "ITEM_CONDITIONS_TO_UNARCHIVE_NOT_MET", "ITEM_NOT_VISIBLE_FOR_ORGANIZATION", "NON_DEVICE", "NOT_AT_WAREHOUSE", "NOT_AVAILABLE_FOR_REUSE", "NOT_A_RENTAL", "NOT_MANAGEABLE_BY_ORGANIZATION", "NOT_WITH_ASSIGNMENT", "NOT_WITH_USER", "NO_ACTIVE_ADDONS", "NO_ACTIVE_STORAGE_CONTRACT", "NO_LOCATION_FOR_STORAGE", "NO_LOGISTICS_FOR_STORAGE", "NO_VALID_ADDONS", "ONGOING_SERVICE", "OWNED_BY_DEEL", "OWNED_BY_ORGANIZATION", "OWNED_BY_PARTNER_ORGANIZATION", "PARTNER_CHILD_CONTRACT", "PENDING_DEVICE_REFRESH", "RENTAL_CONTRACT_AND_USER_REGION_DO_NOT_MATCH", "TEMPORARILY_UNAVAILABLE", "UNKNOWN", "USER_HAS_NO_COUNTRY", "USER_HAS_NO_SEAT", "WAITING_FOR_CLEARANCE", "WITH_LOANER_ASSIGNMENT", "WITH_NON_COLLECTED_ASSIGNMENT", "WITH_NON_DELIVERED_ASSIGNMENT", "WITH_PENDING_ASSIGNMENT", "WRONG_ASSIGNMENT_STATUS", "WRONG_CONTRACT_STATUS", "WRONG_TERMS_AND_CONDITIONS" ], "title": "ItAssetsAssetIdLocationPostResponsesContentApplicationJsonSchemaDataActionsUpdateLocationUserToUserDisabledReasonsItems", "type": "string" }, "ItAssetsAssetIdLocationPostResponsesContentApplicationJsonSchemaDataActionsUpdateLocationUserToUserStatus": { "description": "Whether the action is currently available for this asset", "enum": [ "DISABLED", "ENABLED", "NOT_APPLICABLE" ], "title": "ItAssetsAssetIdLocationPostResponsesContentApplicationJsonSchemaDataActionsUpdateLocationUserToUserStatus", "type": "string" }, "ItAssetsAssetIdLocationPostResponsesContentApplicationJsonSchemaDataActionsUpdateOwnAssetDetails": { "description": "Update editable details of an organization-owned asset", "properties": { "disabled_reasons": { "description": "Reasons why the action is disabled. Empty when the action is enabled or not applicable", "items": { "$ref": "#/components/schemas/ItAssetsAssetIdLocationPostResponsesContentApplicationJsonSchemaDataActionsUpdateOwnAssetDetailsDisabledReasonsItems" }, "type": "array" }, "status": { "$ref": "#/components/schemas/ItAssetsAssetIdLocationPostResponsesContentApplicationJsonSchemaDataActionsUpdateOwnAssetDetailsStatus", "description": "Whether the action is currently available for this asset" } }, "required": [ "status", "disabled_reasons" ], "title": "ItAssetsAssetIdLocationPostResponsesContentApplicationJsonSchemaDataActionsUpdateOwnAssetDetails", "type": "object" }, "ItAssetsAssetIdLocationPostResponsesContentApplicationJsonSchemaDataActionsUpdateOwnAssetDetailsDisabledReasonsItems": { "enum": [ "ARCHIVED", "AT_DEEL_WAREHOUSE", "BEING_REPAIRED", "CONSUMABLE", "CONTROLLED_BY_DEEL", "COUNTRY_NOT_SUPPORTED_FOR_HUB", "COUNTRY_NOT_SUPPORTED_FOR_LOCAL", "DEEL_OWNED_ITEM_WITHOUT_RENTAL_CONTRACT", "DESKTOP_STORAGE", "ENDING_CONTRACT", "HUB_IN_SAME_REGION_AS_LOCAL", "INACTIVE", "INVALID_ITEM_LOCATION", "INVALID_ORGANIZATION_STATUS", "INVALID_STATE", "ITEM_CONDITIONS_TO_UNARCHIVE_NOT_MET", "ITEM_NOT_VISIBLE_FOR_ORGANIZATION", "NON_DEVICE", "NOT_AT_WAREHOUSE", "NOT_AVAILABLE_FOR_REUSE", "NOT_A_RENTAL", "NOT_MANAGEABLE_BY_ORGANIZATION", "NOT_WITH_ASSIGNMENT", "NOT_WITH_USER", "NO_ACTIVE_ADDONS", "NO_ACTIVE_STORAGE_CONTRACT", "NO_LOCATION_FOR_STORAGE", "NO_LOGISTICS_FOR_STORAGE", "NO_VALID_ADDONS", "ONGOING_SERVICE", "OWNED_BY_DEEL", "OWNED_BY_ORGANIZATION", "OWNED_BY_PARTNER_ORGANIZATION", "PARTNER_CHILD_CONTRACT", "PENDING_DEVICE_REFRESH", "RENTAL_CONTRACT_AND_USER_REGION_DO_NOT_MATCH", "TEMPORARILY_UNAVAILABLE", "UNKNOWN", "USER_HAS_NO_COUNTRY", "USER_HAS_NO_SEAT", "WAITING_FOR_CLEARANCE", "WITH_LOANER_ASSIGNMENT", "WITH_NON_COLLECTED_ASSIGNMENT", "WITH_NON_DELIVERED_ASSIGNMENT", "WITH_PENDING_ASSIGNMENT", "WRONG_ASSIGNMENT_STATUS", "WRONG_CONTRACT_STATUS", "WRONG_TERMS_AND_CONDITIONS" ], "title": "ItAssetsAssetIdLocationPostResponsesContentApplicationJsonSchemaDataActionsUpdateOwnAssetDetailsDisabledReasonsItems", "type": "string" }, "ItAssetsAssetIdLocationPostResponsesContentApplicationJsonSchemaDataActionsUpdateOwnAssetDetailsStatus": { "description": "Whether the action is currently available for this asset", "enum": [ "DISABLED", "ENABLED", "NOT_APPLICABLE" ], "title": "ItAssetsAssetIdLocationPostResponsesContentApplicationJsonSchemaDataActionsUpdateOwnAssetDetailsStatus", "type": "string" }, "ItAssetsAssetIdLocationPostResponsesContentApplicationJsonSchemaDataAssignedUser": { "description": "Details of the user with asset possession", "properties": { "emails": { "description": "Array of user email addresses", "items": { "format": "email", "type": "string" }, "type": "array" }, "first_name": { "description": "First name of the user", "type": "string" }, "hris_profile_id": { "description": "The unique identifier of the HRIS profile of the assigned user", "format": "uuid", "type": "string" }, "last_name": { "description": "Last name of the user", "type": "string" } }, "required": [ "emails", "last_name", "first_name", "hris_profile_id" ], "title": "ItAssetsAssetIdLocationPostResponsesContentApplicationJsonSchemaDataAssignedUser", "type": "object" }, "ItAssetsAssetIdLocationPostResponsesContentApplicationJsonSchemaDataAssignedWarehouse": { "description": "Details of the warehouse with asset possession", "properties": { "address": { "$ref": "#/components/schemas/ItAssetsAssetIdLocationPostResponsesContentApplicationJsonSchemaDataAssignedWarehouseAddress", "description": "Warehouse address details" }, "id": { "description": "Unique identifier of the warehouse", "format": "uuid", "type": "string" }, "name": { "description": "Warehouse or storage location name", "type": "string" }, "ownership": { "$ref": "#/components/schemas/ItAssetsAssetIdLocationPostResponsesContentApplicationJsonSchemaDataAssignedWarehouseOwnership", "description": "Warehouse ownership type" }, "public_id": { "description": "Public identifier of the warehouse", "type": "string" }, "warehouse_type": { "$ref": "#/components/schemas/ItAssetsAssetIdLocationPostResponsesContentApplicationJsonSchemaDataAssignedWarehouseWarehouseType", "description": "Warehouse type" } }, "required": [ "id", "name", "address", "ownership", "public_id", "warehouse_type" ], "title": "ItAssetsAssetIdLocationPostResponsesContentApplicationJsonSchemaDataAssignedWarehouse", "type": "object" }, "ItAssetsAssetIdLocationPostResponsesContentApplicationJsonSchemaDataAssignedWarehouseAddress": { "description": "Warehouse address details", "properties": { "city": { "description": "City name", "type": [ "string", "null" ] }, "country": { "$ref": "#/components/schemas/ItAssetsAssetIdLocationPostResponsesContentApplicationJsonSchemaDataAssignedWarehouseAddressCountry", "description": "Country code" }, "date_of_birth": { "description": "Date of birth (applicable for some address types)", "format": "date", "type": [ "string", "null" ] }, "delivery_instructions": { "description": "Special instructions for deliveries", "type": [ "string", "null" ] }, "id": { "description": "Unique identifier of the address", "format": "uuid", "type": "string" }, "is_valid": { "description": "Whether the address passes validation", "type": "boolean" }, "line1": { "description": "Address line 1", "type": [ "string", "null" ] }, "line2": { "description": "Address line 2", "type": [ "string", "null" ] }, "passport_number": { "description": "Passport number (applicable for some address types)", "type": [ "string", "null" ] }, "phone_number": { "description": "Phone number", "type": [ "string", "null" ] }, "post_code": { "description": "Post code", "type": [ "string", "null" ] }, "state": { "description": "State code or name", "type": [ "string", "null" ] }, "tax_id_number": { "description": "Tax ID number (applicable for some address types)", "type": [ "string", "null" ] }, "type": { "$ref": "#/components/schemas/ItAssetsAssetIdLocationPostResponsesContentApplicationJsonSchemaDataAssignedWarehouseAddressType", "description": "Type of the address" } }, "required": [ "id", "city", "type", "line1", "line2", "state", "country", "is_valid", "post_code", "phone_number", "date_of_birth", "tax_id_number", "passport_number", "delivery_instructions" ], "title": "ItAssetsAssetIdLocationPostResponsesContentApplicationJsonSchemaDataAssignedWarehouseAddress", "type": "object" }, "ItAssetsAssetIdLocationPostResponsesContentApplicationJsonSchemaDataAssignedWarehouseAddressCountry": { "description": "Country code", "enum": [ "AD", "AE", "AF", "AG", "AI", "AL", "AM", "AN", "AO", "AQ", "AR", "AS", "AT", "AU", "AW", "AX", "AZ", "BA", "BB", "BD", "BE", "BF", "BG", "BH", "BI", "BJ", "BL", "BM", "BN", "BO", "BQ", "BR", "BS", "BT", "BV", "BW", "BY", "BZ", "CA", "CC", "CD", "CF", "CG", "CH", "CI", "CK", "CL", "CM", "CN", "CO", "CR", "CU", "CV", "CW", "CX", "CY", "CZ", "DE", "DJ", "DK", "DM", "DO", "DZ", "EC", "EE", "EG", "EH", "ER", "ES", "ET", "FI", "FJ", "FK", "FM", "FO", "FR", "GA", "GB", "GD", "GE", "GF", "GG", "GH", "GI", "GL", "GM", "GN", "GP", "GQ", "GR", "GS", "GT", "GU", "GW", "GY", "HK", "HM", "HN", "HR", "HT", "HU", "IC", "ID", "IE", "IL", "IM", "IN", "IO", "IQ", "IR", "IS", "IT", "JE", "JM", "JO", "JP", "KE", "KG", "KH", "KI", "KM", "KN", "KP", "KR", "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", "XK", "YE", "YT", "ZA", "ZM", "ZW" ], "title": "ItAssetsAssetIdLocationPostResponsesContentApplicationJsonSchemaDataAssignedWarehouseAddressCountry", "type": "string" }, "ItAssetsAssetIdLocationPostResponsesContentApplicationJsonSchemaDataAssignedWarehouseAddressType": { "description": "Type of the address", "enum": [ "BILLING", "COLLECTION", "DELIVERY", "ENTITY", "PARTIAL", "PII", "SUPPLIER" ], "title": "ItAssetsAssetIdLocationPostResponsesContentApplicationJsonSchemaDataAssignedWarehouseAddressType", "type": "string" }, "ItAssetsAssetIdLocationPostResponsesContentApplicationJsonSchemaDataAssignedWarehouseOwnership": { "description": "Warehouse ownership type", "enum": [ "DEEL", "ORGANIZATION" ], "title": "ItAssetsAssetIdLocationPostResponsesContentApplicationJsonSchemaDataAssignedWarehouseOwnership", "type": "string" }, "ItAssetsAssetIdLocationPostResponsesContentApplicationJsonSchemaDataAssignedWarehouseWarehouseType": { "description": "Warehouse type", "enum": [ "CLEARANCE", "DEEL", "ORGANIZATION" ], "title": "ItAssetsAssetIdLocationPostResponsesContentApplicationJsonSchemaDataAssignedWarehouseWarehouseType", "type": "string" }, "ItAssetsAssetIdLocationPostResponsesContentApplicationJsonSchemaDataGrade": { "description": "The condition grade of the asset", "enum": [ "A", "B", "C", "D", "F", "NEW" ], "title": "ItAssetsAssetIdLocationPostResponsesContentApplicationJsonSchemaDataGrade", "type": "string" }, "ItAssetsAssetIdLocationPostResponsesContentApplicationJsonSchemaDataLocation": { "description": "Current location type of the asset", "enum": [ "AT_WAREHOUSE", "CLEARANCE_WAREHOUSE", "DEEL_WAREHOUSE", "ORGANIZATION_WAREHOUSE", "SUPPLIER", "WITH_COURIER", "WITH_USER", "WRITE_OFF" ], "title": "ItAssetsAssetIdLocationPostResponsesContentApplicationJsonSchemaDataLocation", "type": "string" }, "ItAssetsAssetIdLocationPostResponsesContentApplicationJsonSchemaDataOwnership": { "description": "Asset owner", "properties": { "name": { "description": "Asset owner name", "type": "string" }, "type": { "$ref": "#/components/schemas/ItAssetsAssetIdLocationPostResponsesContentApplicationJsonSchemaDataOwnershipType", "description": "Asset owner type" } }, "required": [ "name", "type" ], "title": "ItAssetsAssetIdLocationPostResponsesContentApplicationJsonSchemaDataOwnership", "type": "object" }, "ItAssetsAssetIdLocationPostResponsesContentApplicationJsonSchemaDataOwnershipType": { "description": "Asset owner type", "enum": [ "DEEL", "ORGANIZATION" ], "title": "ItAssetsAssetIdLocationPostResponsesContentApplicationJsonSchemaDataOwnershipType", "type": "string" }, "ItAssetsAssetIdLocationPostResponsesContentApplicationJsonSchemaDataProduct": { "description": "Product details", "properties": { "brand": { "description": "Product brand", "type": "string" }, "category": { "$ref": "#/components/schemas/ItAssetsAssetIdLocationPostResponsesContentApplicationJsonSchemaDataProductCategory", "description": "Product category" }, "id": { "description": "Unique identifier of the product", "format": "uuid", "type": "string" }, "name": { "description": "Product name", "type": "string" }, "specifications": { "description": "Specifications of the product", "items": { "$ref": "#/components/schemas/ItAssetsAssetIdLocationPostResponsesContentApplicationJsonSchemaDataProductSpecificationsItems" }, "type": "array" } }, "required": [ "id", "name", "brand", "category", "specifications" ], "title": "ItAssetsAssetIdLocationPostResponsesContentApplicationJsonSchemaDataProduct", "type": "object" }, "ItAssetsAssetIdLocationPostResponsesContentApplicationJsonSchemaDataProductCategory": { "description": "Product category", "enum": [ "ADAPTER", "CABLE", "CHAIR", "CHARGER", "COMPACT_DESKTOP", "DESK", "DESKTOP", "DESK_RISER", "DESK_TIDY", "DOCKING_STATION", "DONGLE", "FOOTREST", "HEADSET", "KEYBOARD", "LAPTOP", "LAPTOP_STAND", "MICE_TRACKPAD", "MOBILE_DEVICE", "MONITOR", "MONITOR_ARM", "OTHER", "PRINTER", "SHREDDER", "STANDING_MAT", "TABLET", "TASK_LIGHT", "WEBCAM", "WELCOME_PACK", "WIFI_RANGE_EXTENDER" ], "title": "ItAssetsAssetIdLocationPostResponsesContentApplicationJsonSchemaDataProductCategory", "type": "string" }, "ItAssetsAssetIdLocationPostResponsesContentApplicationJsonSchemaDataProductSpecificationsItems": { "properties": { "name": { "description": "Specification name", "type": "string" }, "value": { "description": "Specification value", "type": "string" } }, "required": [ "name", "value" ], "title": "ItAssetsAssetIdLocationPostResponsesContentApplicationJsonSchemaDataProductSpecificationsItems", "type": "object" }, "ItAssetsAssetIdLocationPostResponsesContentApplicationJsonSchemaDataPurchaseValue": { "description": "Purchase value of the asset", "properties": { "amount": { "description": "Amount", "format": "decimal", "type": "string" }, "currency": { "$ref": "#/components/schemas/ItAssetsAssetIdLocationPostResponsesContentApplicationJsonSchemaDataPurchaseValueCurrency", "description": "Three-letter currency code for the price" } }, "required": [ "amount", "currency" ], "title": "ItAssetsAssetIdLocationPostResponsesContentApplicationJsonSchemaDataPurchaseValue", "type": "object" }, "ItAssetsAssetIdLocationPostResponsesContentApplicationJsonSchemaDataPurchaseValueCurrency": { "description": "Three-letter currency code for the price", "enum": [ "AED", "AFN", "ALL", "AMD", "ANG", "AOA", "ARS", "AUD", "AWG", "AZN", "BAM", "BDT", "BGN", "BHD", "BIF", "BMD", "BOB", "BRL", "BSD", "BTN", "BWP", "BYN", "BZD", "CAD", "CDF", "CHF", "CLP", "CNY", "COP", "CRC", "CUC", "CVE", "CZK", "DJF", "DKK", "DOP", "DZD", "EGP", "ERN", "ETB", "EUR", "FJD", "FKP", "GBP", "GEL", "GHS", "GIP", "GMD", "GNF", "GTQ", "GYD", "HKD", "HNL", "HRK", "HTG", "HUF", "IDR", "ILS", "INR", "IQD", "IRR", "ISK", "JMD", "JOD", "JPY", "KES", "KGS", "KHR", "KMF", "KPW", "KRW", "KWD", "KYD", "KZT", "LAK", "LBP", "LKR", "LRD", "LSL", "LTL", "LYD", "MAD", "MDL", "MGA", "MKD", "MMK", "MNT", "MRU", "MUR", "MVR", "MWK", "MXN", "MYR", "MZN", "NAD", "NGN", "NIO", "NOK", "NPR", "NZD", "OMR", "PAB", "PEN", "PGK", "PHP", "PKR", "PLN", "PYG", "QAR", "RON", "RSD", "RUB", "RWF", "SAR", "SBD", "SCR", "SDG", "SEK", "SGD", "SHP", "SLL", "SOS", "SRD", "SSP", "STD", "SYP", "SZL", "THB", "TJS", "TMT", "TND", "TOP", "TRY", "TTD", "TWD", "TZS", "UAH", "UGX", "USD", "UYU", "UZS", "VEF", "VND", "VUV", "WST", "XAF", "XCD", "XOF", "XPF", "YER", "ZAR", "ZMW", "ZWD" ], "title": "ItAssetsAssetIdLocationPostResponsesContentApplicationJsonSchemaDataPurchaseValueCurrency", "type": "string" }, "ItAssetsAssetIdLocationPostResponsesContentApplicationJsonSchemaDataStatus": { "description": "Current state of the asset", "enum": [ "ACTIVE", "ADDED_BY_MISTAKE", "BEING_REPAIRED", "BINNED", "BROKEN_AT_WAREHOUSE", "BROKEN_BY_USER", "BROKEN_IN_TRANSIT", "CLEARED", "DAMAGED_AT_WAREHOUSE", "DAMAGED_BY_USER", "DAMAGED_IN_TRANSIT", "LEFT_WITH_USER", "LOST_IN_TRANSIT", "RETURNED_TO_DEEL", "SHRINKAGE", "STOLEN", "SUPPLIER_RETURN", "WAITING_FOR_CLEARANCE" ], "title": "ItAssetsAssetIdLocationPostResponsesContentApplicationJsonSchemaDataStatus", "type": "string" }, "ItAssetsAssetIdLocationPostResponsesContentApplicationJsonSchemaErrorsItems": { "properties": { "code": { "description": "Error code of the handler which produced the returned error", "type": "string" }, "field": { "description": "The field name where input validation failed", "type": [ "string", "null" ] }, "message": { "description": "Description of the returned error", "type": "string" } }, "required": [ "code", "field", "message" ], "title": "ItAssetsAssetIdLocationPostResponsesContentApplicationJsonSchemaErrorsItems", "type": "object" }, "ItAssetsAssetIdPatchParametersXBeta": { "default": "true", "enum": [ "true" ], "title": "ItAssetsAssetIdPatchParametersXBeta", "type": "string" }, "ItAssetsAssetIdPatchRequestBodyContentApplicationJsonSchemaData": { "properties": { "end_of_life_on": { "description": "End-of-life date for the asset", "format": "date", "type": "string" }, "grade": { "$ref": "#/components/schemas/ItAssetsAssetIdPatchRequestBodyContentApplicationJsonSchemaDataGrade", "description": "Condition grade of the asset" }, "purchase_date": { "description": "Date the asset was purchased. Cannot be in the future.", "format": "date", "type": "string" }, "purchase_value": { "$ref": "#/components/schemas/ItAssetsAssetIdPatchRequestBodyContentApplicationJsonSchemaDataPurchaseValue", "description": "Price paid for the asset" }, "serial_number": { "description": "Asset serial number. Cannot be blanked on device categories.", "type": "string" } }, "title": "ItAssetsAssetIdPatchRequestBodyContentApplicationJsonSchemaData", "type": "object" }, "ItAssetsAssetIdPatchRequestBodyContentApplicationJsonSchemaDataGrade": { "description": "Condition grade of the asset", "enum": [ "A", "B", "C", "D", "F", "NEW" ], "title": "ItAssetsAssetIdPatchRequestBodyContentApplicationJsonSchemaDataGrade", "type": "string" }, "ItAssetsAssetIdPatchRequestBodyContentApplicationJsonSchemaDataPurchaseValue": { "description": "Price paid for the asset", "properties": { "amount": { "description": "Amount", "format": "decimal", "type": "string" }, "currency": { "$ref": "#/components/schemas/ItAssetsAssetIdPatchRequestBodyContentApplicationJsonSchemaDataPurchaseValueCurrency", "description": "Three-letter currency code for the price" } }, "required": [ "amount", "currency" ], "title": "ItAssetsAssetIdPatchRequestBodyContentApplicationJsonSchemaDataPurchaseValue", "type": "object" }, "ItAssetsAssetIdPatchRequestBodyContentApplicationJsonSchemaDataPurchaseValueCurrency": { "description": "Three-letter currency code for the price", "enum": [ "AED", "AFN", "ALL", "AMD", "ANG", "AOA", "ARS", "AUD", "AWG", "AZN", "BAM", "BDT", "BGN", "BHD", "BIF", "BMD", "BOB", "BRL", "BSD", "BTN", "BWP", "BYN", "BZD", "CAD", "CDF", "CHF", "CLP", "CNY", "COP", "CRC", "CUC", "CVE", "CZK", "DJF", "DKK", "DOP", "DZD", "EGP", "ERN", "ETB", "EUR", "FJD", "FKP", "GBP", "GEL", "GHS", "GIP", "GMD", "GNF", "GTQ", "GYD", "HKD", "HNL", "HRK", "HTG", "HUF", "IDR", "ILS", "INR", "IQD", "IRR", "ISK", "JMD", "JOD", "JPY", "KES", "KGS", "KHR", "KMF", "KPW", "KRW", "KWD", "KYD", "KZT", "LAK", "LBP", "LKR", "LRD", "LSL", "LTL", "LYD", "MAD", "MDL", "MGA", "MKD", "MMK", "MNT", "MRU", "MUR", "MVR", "MWK", "MXN", "MYR", "MZN", "NAD", "NGN", "NIO", "NOK", "NPR", "NZD", "OMR", "PAB", "PEN", "PGK", "PHP", "PKR", "PLN", "PYG", "QAR", "RON", "RSD", "RUB", "RWF", "SAR", "SBD", "SCR", "SDG", "SEK", "SGD", "SHP", "SLL", "SOS", "SRD", "SSP", "STD", "SYP", "SZL", "THB", "TJS", "TMT", "TND", "TOP", "TRY", "TTD", "TWD", "TZS", "UAH", "UGX", "USD", "UYU", "UZS", "VEF", "VND", "VUV", "WST", "XAF", "XCD", "XOF", "XPF", "YER", "ZAR", "ZMW", "ZWD" ], "title": "ItAssetsAssetIdPatchRequestBodyContentApplicationJsonSchemaDataPurchaseValueCurrency", "type": "string" }, "ItAssetsAssetIdPatchResponsesContentApplicationJsonSchemaData": { "properties": { "actions": { "$ref": "#/components/schemas/ItAssetsAssetIdPatchResponsesContentApplicationJsonSchemaDataActions", "description": "Actions the caller can execute on this asset, with availability status per action" }, "assigned_user": { "description": "Details of the user with asset possession", "oneOf": [ { "$ref": "#/components/schemas/ItAssetsAssetIdPatchResponsesContentApplicationJsonSchemaDataAssignedUser" }, { "type": "null" } ] }, "assigned_warehouse": { "description": "Details of the warehouse with asset possession", "oneOf": [ { "$ref": "#/components/schemas/ItAssetsAssetIdPatchResponsesContentApplicationJsonSchemaDataAssignedWarehouse" }, { "type": "null" } ] }, "created_at": { "description": "Creation timestamp of the asset", "format": "date-time", "type": "string" }, "grade": { "$ref": "#/components/schemas/ItAssetsAssetIdPatchResponsesContentApplicationJsonSchemaDataGrade", "description": "The condition grade of the asset" }, "id": { "description": "Unique identifier of the item", "format": "uuid", "type": "string" }, "location": { "$ref": "#/components/schemas/ItAssetsAssetIdPatchResponsesContentApplicationJsonSchemaDataLocation", "description": "Current location type of the asset" }, "ownership": { "$ref": "#/components/schemas/ItAssetsAssetIdPatchResponsesContentApplicationJsonSchemaDataOwnership", "description": "Asset owner" }, "product": { "$ref": "#/components/schemas/ItAssetsAssetIdPatchResponsesContentApplicationJsonSchemaDataProduct", "description": "Product details" }, "public_id": { "description": "Public identifier of the item", "type": "string" }, "purchase_date": { "description": "Purchase date of the asset", "format": "date", "type": [ "string", "null" ] }, "purchase_value": { "description": "Purchase value of the asset", "oneOf": [ { "$ref": "#/components/schemas/ItAssetsAssetIdPatchResponsesContentApplicationJsonSchemaDataPurchaseValue" }, { "type": "null" } ] }, "serial_number": { "description": "Asset serial number", "type": [ "string", "null" ] }, "status": { "$ref": "#/components/schemas/ItAssetsAssetIdPatchResponsesContentApplicationJsonSchemaDataStatus", "description": "Current state of the asset" }, "updated_at": { "description": "Last update timestamp of the asset", "format": "date-time", "type": "string" } }, "required": [ "id", "grade", "status", "actions", "product", "location", "ownership", "public_id", "created_at", "updated_at", "assigned_user", "purchase_date", "serial_number", "purchase_value", "assigned_warehouse" ], "title": "ItAssetsAssetIdPatchResponsesContentApplicationJsonSchemaData", "type": "object" }, "ItAssetsAssetIdPatchResponsesContentApplicationJsonSchemaDataActions": { "description": "Actions the caller can execute on this asset, with availability status per action", "properties": { "archive_own_asset": { "$ref": "#/components/schemas/ItAssetsAssetIdPatchResponsesContentApplicationJsonSchemaDataActionsArchiveOwnAsset", "description": "Archive an organization-owned asset" }, "asset_country": { "description": "Resolved country used for asset actions. Derived from the asset's country,\nits assigned rental contract billing entity country, or the last active\nassignment delivery country. Null when the country cannot be determined\n(e.g. asset was returned to Deel)", "oneOf": [ { "$ref": "#/components/schemas/ItAssetsAssetIdPatchResponsesContentApplicationJsonSchemaDataActionsAssetCountry" }, { "type": "null" } ] }, "assign_addon_to_own_asset": { "$ref": "#/components/schemas/ItAssetsAssetIdPatchResponsesContentApplicationJsonSchemaDataActionsAssignAddonToOwnAsset", "description": "Assign an add-on to an organization-owned asset" }, "clear_own_asset": { "$ref": "#/components/schemas/ItAssetsAssetIdPatchResponsesContentApplicationJsonSchemaDataActionsClearOwnAsset", "description": "Clear an organization-owned asset from the fleet" }, "manage_end_of_rental_contract_actions": { "$ref": "#/components/schemas/ItAssetsAssetIdPatchResponsesContentApplicationJsonSchemaDataActionsManageEndOfRentalContractActions", "description": "Manage end-of-rental options for a Deel-owned rental asset" }, "purchase_rental": { "$ref": "#/components/schemas/ItAssetsAssetIdPatchResponsesContentApplicationJsonSchemaDataActionsPurchaseRental", "description": "Purchase a Deel-owned rental asset at end of contract" }, "return_rental_to_deel": { "$ref": "#/components/schemas/ItAssetsAssetIdPatchResponsesContentApplicationJsonSchemaDataActionsReturnRentalToDeel", "description": "Return a Deel-owned rental asset back to Deel" }, "reuse_own_asset_from_deel": { "$ref": "#/components/schemas/ItAssetsAssetIdPatchResponsesContentApplicationJsonSchemaDataActionsReuseOwnAssetFromDeel", "description": "Redeploy an organization-owned asset stored at a Deel warehouse" }, "reuse_own_asset_from_own_location": { "$ref": "#/components/schemas/ItAssetsAssetIdPatchResponsesContentApplicationJsonSchemaDataActionsReuseOwnAssetFromOwnLocation", "description": "Redeploy an organization-owned asset from an organization-owned location" }, "store_own_asset_at_deel_for_hub": { "$ref": "#/components/schemas/ItAssetsAssetIdPatchResponsesContentApplicationJsonSchemaDataActionsStoreOwnAssetAtDeelForHub", "description": "Store an organization-owned asset at a Deel hub warehouse" }, "store_own_asset_at_deel_for_local": { "$ref": "#/components/schemas/ItAssetsAssetIdPatchResponsesContentApplicationJsonSchemaDataActionsStoreOwnAssetAtDeelForLocal", "description": "Store an organization-owned asset at a Deel local warehouse" }, "store_own_asset_at_own_location": { "$ref": "#/components/schemas/ItAssetsAssetIdPatchResponsesContentApplicationJsonSchemaDataActionsStoreOwnAssetAtOwnLocation", "description": "Store an organization-owned asset at an organization-owned location" }, "store_rental_at_deel_for_local": { "$ref": "#/components/schemas/ItAssetsAssetIdPatchResponsesContentApplicationJsonSchemaDataActionsStoreRentalAtDeelForLocal", "description": "Store a Deel-owned rental asset at a Deel local warehouse" }, "store_rental_at_deel_for_zone1": { "$ref": "#/components/schemas/ItAssetsAssetIdPatchResponsesContentApplicationJsonSchemaDataActionsStoreRentalAtDeelForZone1", "description": "Store a Deel-owned rental asset at a Deel zone-1 warehouse" }, "transfer_own_asset": { "$ref": "#/components/schemas/ItAssetsAssetIdPatchResponsesContentApplicationJsonSchemaDataActionsTransferOwnAsset", "description": "Transfer an organization-owned asset to another user" }, "transfer_rental": { "$ref": "#/components/schemas/ItAssetsAssetIdPatchResponsesContentApplicationJsonSchemaDataActionsTransferRental", "description": "Transfer a Deel-owned rental asset to another user" }, "unarchive_own_asset": { "$ref": "#/components/schemas/ItAssetsAssetIdPatchResponsesContentApplicationJsonSchemaDataActionsUnarchiveOwnAsset", "description": "Unarchive a previously archived organization-owned asset" }, "update_location_location_to_user": { "$ref": "#/components/schemas/ItAssetsAssetIdPatchResponsesContentApplicationJsonSchemaDataActionsUpdateLocationLocationToUser", "description": "Update the location of an asset from a warehouse to a user" }, "update_location_user_to_location": { "$ref": "#/components/schemas/ItAssetsAssetIdPatchResponsesContentApplicationJsonSchemaDataActionsUpdateLocationUserToLocation", "description": "Update the location of an asset from a user to a warehouse" }, "update_location_user_to_user": { "$ref": "#/components/schemas/ItAssetsAssetIdPatchResponsesContentApplicationJsonSchemaDataActionsUpdateLocationUserToUser", "description": "Update the assigned user of an asset that is currently with a user" }, "update_own_asset_details": { "$ref": "#/components/schemas/ItAssetsAssetIdPatchResponsesContentApplicationJsonSchemaDataActionsUpdateOwnAssetDetails", "description": "Update editable details of an organization-owned asset" } }, "required": [ "asset_country", "clear_own_asset", "purchase_rental", "transfer_rental", "archive_own_asset", "transfer_own_asset", "unarchive_own_asset", "return_rental_to_deel", "update_own_asset_details", "assign_addon_to_own_asset", "reuse_own_asset_from_deel", "update_location_user_to_user", "store_rental_at_deel_for_local", "store_rental_at_deel_for_zone1", "store_own_asset_at_deel_for_hub", "store_own_asset_at_own_location", "update_location_location_to_user", "update_location_user_to_location", "reuse_own_asset_from_own_location", "store_own_asset_at_deel_for_local", "manage_end_of_rental_contract_actions" ], "title": "ItAssetsAssetIdPatchResponsesContentApplicationJsonSchemaDataActions", "type": "object" }, "ItAssetsAssetIdPatchResponsesContentApplicationJsonSchemaDataActionsArchiveOwnAsset": { "description": "Archive an organization-owned asset", "properties": { "details": { "description": "Action-specific context needed to perform the action. Populated for enabled and\ndisabled actions (so callers can see what a successful attempt would look like);\nnull when the action is not applicable to this asset.", "oneOf": [ { "$ref": "#/components/schemas/ItAssetsAssetIdPatchResponsesContentApplicationJsonSchemaDataActionsArchiveOwnAssetDetails" }, { "type": "null" } ] }, "disabled_reasons": { "description": "Reasons why the action is disabled. Empty when the action is enabled or not applicable", "items": { "$ref": "#/components/schemas/ItAssetsAssetIdPatchResponsesContentApplicationJsonSchemaDataActionsArchiveOwnAssetDisabledReasonsItems" }, "type": "array" }, "status": { "$ref": "#/components/schemas/ItAssetsAssetIdPatchResponsesContentApplicationJsonSchemaDataActionsArchiveOwnAssetStatus", "description": "Whether the action is currently available for this asset" } }, "required": [ "status", "details", "disabled_reasons" ], "title": "ItAssetsAssetIdPatchResponsesContentApplicationJsonSchemaDataActionsArchiveOwnAsset", "type": "object" }, "ItAssetsAssetIdPatchResponsesContentApplicationJsonSchemaDataActionsArchiveOwnAssetDetails": { "description": "Action-specific context needed to perform the action. Populated for enabled and\ndisabled actions (so callers can see what a successful attempt would look like);\nnull when the action is not applicable to this asset.", "properties": { "allowed_statuses": { "description": "Statuses that can be passed as the archive reason when archiving the asset", "items": { "$ref": "#/components/schemas/ItAssetsAssetIdPatchResponsesContentApplicationJsonSchemaDataActionsArchiveOwnAssetDetailsAllowedStatusesItems" }, "type": "array" } }, "required": [ "allowed_statuses" ], "title": "ItAssetsAssetIdPatchResponsesContentApplicationJsonSchemaDataActionsArchiveOwnAssetDetails", "type": "object" }, "ItAssetsAssetIdPatchResponsesContentApplicationJsonSchemaDataActionsArchiveOwnAssetDetailsAllowedStatusesItems": { "enum": [ "ADDED_BY_MISTAKE", "BINNED", "BROKEN_AT_WAREHOUSE", "BROKEN_BY_USER", "BROKEN_IN_TRANSIT", "DAMAGED_AT_WAREHOUSE", "DAMAGED_BY_USER", "DAMAGED_IN_TRANSIT", "LEFT_WITH_USER", "LOST_IN_TRANSIT", "RETURNED_TO_DEEL", "SHRINKAGE", "STOLEN", "SUPPLIER_RETURN" ], "title": "ItAssetsAssetIdPatchResponsesContentApplicationJsonSchemaDataActionsArchiveOwnAssetDetailsAllowedStatusesItems", "type": "string" }, "ItAssetsAssetIdPatchResponsesContentApplicationJsonSchemaDataActionsArchiveOwnAssetDisabledReasonsItems": { "enum": [ "ARCHIVED", "AT_DEEL_WAREHOUSE", "BEING_REPAIRED", "CONSUMABLE", "CONTROLLED_BY_DEEL", "COUNTRY_NOT_SUPPORTED_FOR_HUB", "COUNTRY_NOT_SUPPORTED_FOR_LOCAL", "DEEL_OWNED_ITEM_WITHOUT_RENTAL_CONTRACT", "DESKTOP_STORAGE", "ENDING_CONTRACT", "HUB_IN_SAME_REGION_AS_LOCAL", "INACTIVE", "INVALID_ITEM_LOCATION", "INVALID_ORGANIZATION_STATUS", "INVALID_STATE", "ITEM_CONDITIONS_TO_UNARCHIVE_NOT_MET", "ITEM_NOT_VISIBLE_FOR_ORGANIZATION", "NON_DEVICE", "NOT_AT_WAREHOUSE", "NOT_AVAILABLE_FOR_REUSE", "NOT_A_RENTAL", "NOT_MANAGEABLE_BY_ORGANIZATION", "NOT_WITH_ASSIGNMENT", "NOT_WITH_USER", "NO_ACTIVE_ADDONS", "NO_ACTIVE_STORAGE_CONTRACT", "NO_LOCATION_FOR_STORAGE", "NO_LOGISTICS_FOR_STORAGE", "NO_VALID_ADDONS", "ONGOING_SERVICE", "OWNED_BY_DEEL", "OWNED_BY_ORGANIZATION", "OWNED_BY_PARTNER_ORGANIZATION", "PARTNER_CHILD_CONTRACT", "PENDING_DEVICE_REFRESH", "RENTAL_CONTRACT_AND_USER_REGION_DO_NOT_MATCH", "TEMPORARILY_UNAVAILABLE", "UNKNOWN", "USER_HAS_NO_COUNTRY", "USER_HAS_NO_SEAT", "WAITING_FOR_CLEARANCE", "WITH_LOANER_ASSIGNMENT", "WITH_NON_COLLECTED_ASSIGNMENT", "WITH_NON_DELIVERED_ASSIGNMENT", "WITH_PENDING_ASSIGNMENT", "WRONG_ASSIGNMENT_STATUS", "WRONG_CONTRACT_STATUS", "WRONG_TERMS_AND_CONDITIONS" ], "title": "ItAssetsAssetIdPatchResponsesContentApplicationJsonSchemaDataActionsArchiveOwnAssetDisabledReasonsItems", "type": "string" }, "ItAssetsAssetIdPatchResponsesContentApplicationJsonSchemaDataActionsArchiveOwnAssetStatus": { "description": "Whether the action is currently available for this asset", "enum": [ "DISABLED", "ENABLED", "NOT_APPLICABLE" ], "title": "ItAssetsAssetIdPatchResponsesContentApplicationJsonSchemaDataActionsArchiveOwnAssetStatus", "type": "string" }, "ItAssetsAssetIdPatchResponsesContentApplicationJsonSchemaDataActionsAssetCountry": { "description": "Resolved country used for asset actions. Derived from the asset's country,\nits assigned rental contract billing entity country, or the last active\nassignment delivery country. Null when the country cannot be determined\n(e.g. asset was returned to Deel)", "enum": [ "AD", "AE", "AF", "AG", "AI", "AL", "AM", "AN", "AO", "AQ", "AR", "AS", "AT", "AU", "AW", "AX", "AZ", "BA", "BB", "BD", "BE", "BF", "BG", "BH", "BI", "BJ", "BL", "BM", "BN", "BO", "BQ", "BR", "BS", "BT", "BV", "BW", "BY", "BZ", "CA", "CC", "CD", "CF", "CG", "CH", "CI", "CK", "CL", "CM", "CN", "CO", "CR", "CU", "CV", "CW", "CX", "CY", "CZ", "DE", "DJ", "DK", "DM", "DO", "DZ", "EC", "EE", "EG", "EH", "ER", "ES", "ET", "FI", "FJ", "FK", "FM", "FO", "FR", "GA", "GB", "GD", "GE", "GF", "GG", "GH", "GI", "GL", "GM", "GN", "GP", "GQ", "GR", "GS", "GT", "GU", "GW", "GY", "HK", "HM", "HN", "HR", "HT", "HU", "IC", "ID", "IE", "IL", "IM", "IN", "IO", "IQ", "IR", "IS", "IT", "JE", "JM", "JO", "JP", "KE", "KG", "KH", "KI", "KM", "KN", "KP", "KR", "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", "XK", "YE", "YT", "ZA", "ZM", "ZW" ], "title": "ItAssetsAssetIdPatchResponsesContentApplicationJsonSchemaDataActionsAssetCountry", "type": "string" }, "ItAssetsAssetIdPatchResponsesContentApplicationJsonSchemaDataActionsAssignAddonToOwnAsset": { "description": "Assign an add-on to an organization-owned asset", "properties": { "details": { "description": "Action-specific context needed to perform the action. Populated for enabled and\ndisabled actions (so callers can see what a successful attempt would look like);\nnull when the action is not applicable to this asset.", "oneOf": [ { "$ref": "#/components/schemas/ItAssetsAssetIdPatchResponsesContentApplicationJsonSchemaDataActionsAssignAddonToOwnAssetDetails" }, { "type": "null" } ] }, "disabled_reasons": { "description": "Reasons why the action is disabled. Empty when the action is enabled or not applicable", "items": { "$ref": "#/components/schemas/ItAssetsAssetIdPatchResponsesContentApplicationJsonSchemaDataActionsAssignAddonToOwnAssetDisabledReasonsItems" }, "type": "array" }, "status": { "$ref": "#/components/schemas/ItAssetsAssetIdPatchResponsesContentApplicationJsonSchemaDataActionsAssignAddonToOwnAssetStatus", "description": "Whether the action is currently available for this asset" } }, "required": [ "status", "details", "disabled_reasons" ], "title": "ItAssetsAssetIdPatchResponsesContentApplicationJsonSchemaDataActionsAssignAddonToOwnAsset", "type": "object" }, "ItAssetsAssetIdPatchResponsesContentApplicationJsonSchemaDataActionsAssignAddonToOwnAssetDetails": { "description": "Action-specific context needed to perform the action. Populated for enabled and\ndisabled actions (so callers can see what a successful attempt would look like);\nnull when the action is not applicable to this asset.", "properties": { "addons": { "description": "Add-ons that can be assigned to the asset, with a fail reason for those that don't qualify", "items": { "$ref": "#/components/schemas/ItAssetsAssetIdPatchResponsesContentApplicationJsonSchemaDataActionsAssignAddonToOwnAssetDetailsAddonsItems" }, "type": "array" } }, "required": [ "addons" ], "title": "ItAssetsAssetIdPatchResponsesContentApplicationJsonSchemaDataActionsAssignAddonToOwnAssetDetails", "type": "object" }, "ItAssetsAssetIdPatchResponsesContentApplicationJsonSchemaDataActionsAssignAddonToOwnAssetDetailsAddonsItems": { "properties": { "addon": { "$ref": "#/components/schemas/ItAssetsAssetIdPatchResponsesContentApplicationJsonSchemaDataActionsAssignAddonToOwnAssetDetailsAddonsItemsAddon", "description": "Add-on that can be assigned to the asset" }, "fail_reason": { "description": "Reason the add-on cannot be assigned to the asset. Null when assignment is allowed", "oneOf": [ { "$ref": "#/components/schemas/ItAssetsAssetIdPatchResponsesContentApplicationJsonSchemaDataActionsAssignAddonToOwnAssetDetailsAddonsItemsFailReason" }, { "type": "null" } ] } }, "required": [ "addon", "fail_reason" ], "title": "ItAssetsAssetIdPatchResponsesContentApplicationJsonSchemaDataActionsAssignAddonToOwnAssetDetailsAddonsItems", "type": "object" }, "ItAssetsAssetIdPatchResponsesContentApplicationJsonSchemaDataActionsAssignAddonToOwnAssetDetailsAddonsItemsAddon": { "description": "Add-on that can be assigned to the asset", "properties": { "id": { "description": "ID of the add-on", "format": "uuid", "type": "string" }, "name": { "description": "Public display name of the add-on", "type": "string" } }, "required": [ "id", "name" ], "title": "ItAssetsAssetIdPatchResponsesContentApplicationJsonSchemaDataActionsAssignAddonToOwnAssetDetailsAddonsItemsAddon", "type": "object" }, "ItAssetsAssetIdPatchResponsesContentApplicationJsonSchemaDataActionsAssignAddonToOwnAssetDetailsAddonsItemsFailReason": { "description": "Reason the add-on cannot be assigned to the asset. Null when assignment is allowed", "enum": [ "ADDON_NOT_AVAILABLE_TO_ORGANIZATION", "ALREADY_ASSIGNED", "HAS_ACTIVE_SERVICE_ADDON", "INVALID_ASSET_AGE", "INVALID_CONTRACT_TYPE", "INVALID_DURATION", "INVALID_PAYMENT_SCHEMA", "INVALID_PLATFORM_TIER", "INVALID_PRODUCT_BRAND", "INVALID_PRODUCT_CATEGORY", "INVALID_PRODUCT_PARENT_CATEGORY", "INVALID_RENTAL_TERM", "NO_MATCHING_ORGANIZATION_CONTRACT", "OTHER" ], "title": "ItAssetsAssetIdPatchResponsesContentApplicationJsonSchemaDataActionsAssignAddonToOwnAssetDetailsAddonsItemsFailReason", "type": "string" }, "ItAssetsAssetIdPatchResponsesContentApplicationJsonSchemaDataActionsAssignAddonToOwnAssetDisabledReasonsItems": { "enum": [ "ARCHIVED", "AT_DEEL_WAREHOUSE", "BEING_REPAIRED", "CONSUMABLE", "CONTROLLED_BY_DEEL", "COUNTRY_NOT_SUPPORTED_FOR_HUB", "COUNTRY_NOT_SUPPORTED_FOR_LOCAL", "DEEL_OWNED_ITEM_WITHOUT_RENTAL_CONTRACT", "DESKTOP_STORAGE", "ENDING_CONTRACT", "HUB_IN_SAME_REGION_AS_LOCAL", "INACTIVE", "INVALID_ITEM_LOCATION", "INVALID_ORGANIZATION_STATUS", "INVALID_STATE", "ITEM_CONDITIONS_TO_UNARCHIVE_NOT_MET", "ITEM_NOT_VISIBLE_FOR_ORGANIZATION", "NON_DEVICE", "NOT_AT_WAREHOUSE", "NOT_AVAILABLE_FOR_REUSE", "NOT_A_RENTAL", "NOT_MANAGEABLE_BY_ORGANIZATION", "NOT_WITH_ASSIGNMENT", "NOT_WITH_USER", "NO_ACTIVE_ADDONS", "NO_ACTIVE_STORAGE_CONTRACT", "NO_LOCATION_FOR_STORAGE", "NO_LOGISTICS_FOR_STORAGE", "NO_VALID_ADDONS", "ONGOING_SERVICE", "OWNED_BY_DEEL", "OWNED_BY_ORGANIZATION", "OWNED_BY_PARTNER_ORGANIZATION", "PARTNER_CHILD_CONTRACT", "PENDING_DEVICE_REFRESH", "RENTAL_CONTRACT_AND_USER_REGION_DO_NOT_MATCH", "TEMPORARILY_UNAVAILABLE", "UNKNOWN", "USER_HAS_NO_COUNTRY", "USER_HAS_NO_SEAT", "WAITING_FOR_CLEARANCE", "WITH_LOANER_ASSIGNMENT", "WITH_NON_COLLECTED_ASSIGNMENT", "WITH_NON_DELIVERED_ASSIGNMENT", "WITH_PENDING_ASSIGNMENT", "WRONG_ASSIGNMENT_STATUS", "WRONG_CONTRACT_STATUS", "WRONG_TERMS_AND_CONDITIONS" ], "title": "ItAssetsAssetIdPatchResponsesContentApplicationJsonSchemaDataActionsAssignAddonToOwnAssetDisabledReasonsItems", "type": "string" }, "ItAssetsAssetIdPatchResponsesContentApplicationJsonSchemaDataActionsAssignAddonToOwnAssetStatus": { "description": "Whether the action is currently available for this asset", "enum": [ "DISABLED", "ENABLED", "NOT_APPLICABLE" ], "title": "ItAssetsAssetIdPatchResponsesContentApplicationJsonSchemaDataActionsAssignAddonToOwnAssetStatus", "type": "string" }, "ItAssetsAssetIdPatchResponsesContentApplicationJsonSchemaDataActionsClearOwnAsset": { "description": "Clear an organization-owned asset from the fleet", "properties": { "disabled_reasons": { "description": "Reasons why the action is disabled. Empty when the action is enabled or not applicable", "items": { "$ref": "#/components/schemas/ItAssetsAssetIdPatchResponsesContentApplicationJsonSchemaDataActionsClearOwnAssetDisabledReasonsItems" }, "type": "array" }, "status": { "$ref": "#/components/schemas/ItAssetsAssetIdPatchResponsesContentApplicationJsonSchemaDataActionsClearOwnAssetStatus", "description": "Whether the action is currently available for this asset" } }, "required": [ "status", "disabled_reasons" ], "title": "ItAssetsAssetIdPatchResponsesContentApplicationJsonSchemaDataActionsClearOwnAsset", "type": "object" }, "ItAssetsAssetIdPatchResponsesContentApplicationJsonSchemaDataActionsClearOwnAssetDisabledReasonsItems": { "enum": [ "ARCHIVED", "AT_DEEL_WAREHOUSE", "BEING_REPAIRED", "CONSUMABLE", "CONTROLLED_BY_DEEL", "COUNTRY_NOT_SUPPORTED_FOR_HUB", "COUNTRY_NOT_SUPPORTED_FOR_LOCAL", "DEEL_OWNED_ITEM_WITHOUT_RENTAL_CONTRACT", "DESKTOP_STORAGE", "ENDING_CONTRACT", "HUB_IN_SAME_REGION_AS_LOCAL", "INACTIVE", "INVALID_ITEM_LOCATION", "INVALID_ORGANIZATION_STATUS", "INVALID_STATE", "ITEM_CONDITIONS_TO_UNARCHIVE_NOT_MET", "ITEM_NOT_VISIBLE_FOR_ORGANIZATION", "NON_DEVICE", "NOT_AT_WAREHOUSE", "NOT_AVAILABLE_FOR_REUSE", "NOT_A_RENTAL", "NOT_MANAGEABLE_BY_ORGANIZATION", "NOT_WITH_ASSIGNMENT", "NOT_WITH_USER", "NO_ACTIVE_ADDONS", "NO_ACTIVE_STORAGE_CONTRACT", "NO_LOCATION_FOR_STORAGE", "NO_LOGISTICS_FOR_STORAGE", "NO_VALID_ADDONS", "ONGOING_SERVICE", "OWNED_BY_DEEL", "OWNED_BY_ORGANIZATION", "OWNED_BY_PARTNER_ORGANIZATION", "PARTNER_CHILD_CONTRACT", "PENDING_DEVICE_REFRESH", "RENTAL_CONTRACT_AND_USER_REGION_DO_NOT_MATCH", "TEMPORARILY_UNAVAILABLE", "UNKNOWN", "USER_HAS_NO_COUNTRY", "USER_HAS_NO_SEAT", "WAITING_FOR_CLEARANCE", "WITH_LOANER_ASSIGNMENT", "WITH_NON_COLLECTED_ASSIGNMENT", "WITH_NON_DELIVERED_ASSIGNMENT", "WITH_PENDING_ASSIGNMENT", "WRONG_ASSIGNMENT_STATUS", "WRONG_CONTRACT_STATUS", "WRONG_TERMS_AND_CONDITIONS" ], "title": "ItAssetsAssetIdPatchResponsesContentApplicationJsonSchemaDataActionsClearOwnAssetDisabledReasonsItems", "type": "string" }, "ItAssetsAssetIdPatchResponsesContentApplicationJsonSchemaDataActionsClearOwnAssetStatus": { "description": "Whether the action is currently available for this asset", "enum": [ "DISABLED", "ENABLED", "NOT_APPLICABLE" ], "title": "ItAssetsAssetIdPatchResponsesContentApplicationJsonSchemaDataActionsClearOwnAssetStatus", "type": "string" }, "ItAssetsAssetIdPatchResponsesContentApplicationJsonSchemaDataActionsManageEndOfRentalContractActions": { "description": "Manage end-of-rental options for a Deel-owned rental asset", "properties": { "disabled_reasons": { "description": "Reasons why the action is disabled. Empty when the action is enabled or not applicable", "items": { "$ref": "#/components/schemas/ItAssetsAssetIdPatchResponsesContentApplicationJsonSchemaDataActionsManageEndOfRentalContractActionsDisabledReasonsItems" }, "type": "array" }, "status": { "$ref": "#/components/schemas/ItAssetsAssetIdPatchResponsesContentApplicationJsonSchemaDataActionsManageEndOfRentalContractActionsStatus", "description": "Whether the action is currently available for this asset" } }, "required": [ "status", "disabled_reasons" ], "title": "ItAssetsAssetIdPatchResponsesContentApplicationJsonSchemaDataActionsManageEndOfRentalContractActions", "type": "object" }, "ItAssetsAssetIdPatchResponsesContentApplicationJsonSchemaDataActionsManageEndOfRentalContractActionsDisabledReasonsItems": { "enum": [ "ARCHIVED", "AT_DEEL_WAREHOUSE", "BEING_REPAIRED", "CONSUMABLE", "CONTROLLED_BY_DEEL", "COUNTRY_NOT_SUPPORTED_FOR_HUB", "COUNTRY_NOT_SUPPORTED_FOR_LOCAL", "DEEL_OWNED_ITEM_WITHOUT_RENTAL_CONTRACT", "DESKTOP_STORAGE", "ENDING_CONTRACT", "HUB_IN_SAME_REGION_AS_LOCAL", "INACTIVE", "INVALID_ITEM_LOCATION", "INVALID_ORGANIZATION_STATUS", "INVALID_STATE", "ITEM_CONDITIONS_TO_UNARCHIVE_NOT_MET", "ITEM_NOT_VISIBLE_FOR_ORGANIZATION", "NON_DEVICE", "NOT_AT_WAREHOUSE", "NOT_AVAILABLE_FOR_REUSE", "NOT_A_RENTAL", "NOT_MANAGEABLE_BY_ORGANIZATION", "NOT_WITH_ASSIGNMENT", "NOT_WITH_USER", "NO_ACTIVE_ADDONS", "NO_ACTIVE_STORAGE_CONTRACT", "NO_LOCATION_FOR_STORAGE", "NO_LOGISTICS_FOR_STORAGE", "NO_VALID_ADDONS", "ONGOING_SERVICE", "OWNED_BY_DEEL", "OWNED_BY_ORGANIZATION", "OWNED_BY_PARTNER_ORGANIZATION", "PARTNER_CHILD_CONTRACT", "PENDING_DEVICE_REFRESH", "RENTAL_CONTRACT_AND_USER_REGION_DO_NOT_MATCH", "TEMPORARILY_UNAVAILABLE", "UNKNOWN", "USER_HAS_NO_COUNTRY", "USER_HAS_NO_SEAT", "WAITING_FOR_CLEARANCE", "WITH_LOANER_ASSIGNMENT", "WITH_NON_COLLECTED_ASSIGNMENT", "WITH_NON_DELIVERED_ASSIGNMENT", "WITH_PENDING_ASSIGNMENT", "WRONG_ASSIGNMENT_STATUS", "WRONG_CONTRACT_STATUS", "WRONG_TERMS_AND_CONDITIONS" ], "title": "ItAssetsAssetIdPatchResponsesContentApplicationJsonSchemaDataActionsManageEndOfRentalContractActionsDisabledReasonsItems", "type": "string" }, "ItAssetsAssetIdPatchResponsesContentApplicationJsonSchemaDataActionsManageEndOfRentalContractActionsStatus": { "description": "Whether the action is currently available for this asset", "enum": [ "DISABLED", "ENABLED", "NOT_APPLICABLE" ], "title": "ItAssetsAssetIdPatchResponsesContentApplicationJsonSchemaDataActionsManageEndOfRentalContractActionsStatus", "type": "string" }, "ItAssetsAssetIdPatchResponsesContentApplicationJsonSchemaDataActionsPurchaseRental": { "description": "Purchase a Deel-owned rental asset at end of contract", "properties": { "details": { "description": "Action-specific context needed to perform the action. Populated for enabled and\ndisabled actions (so callers can see what a successful attempt would look like);\nnull when the action is not applicable to this asset.", "oneOf": [ { "$ref": "#/components/schemas/ItAssetsAssetIdPatchResponsesContentApplicationJsonSchemaDataActionsPurchaseRentalDetails" }, { "type": "null" } ] }, "disabled_reasons": { "description": "Reasons why the action is disabled. Empty when the action is enabled or not applicable", "items": { "$ref": "#/components/schemas/ItAssetsAssetIdPatchResponsesContentApplicationJsonSchemaDataActionsPurchaseRentalDisabledReasonsItems" }, "type": "array" }, "status": { "$ref": "#/components/schemas/ItAssetsAssetIdPatchResponsesContentApplicationJsonSchemaDataActionsPurchaseRentalStatus", "description": "Whether the action is currently available for this asset" } }, "required": [ "status", "details", "disabled_reasons" ], "title": "ItAssetsAssetIdPatchResponsesContentApplicationJsonSchemaDataActionsPurchaseRental", "type": "object" }, "ItAssetsAssetIdPatchResponsesContentApplicationJsonSchemaDataActionsPurchaseRentalDetails": { "description": "Action-specific context needed to perform the action. Populated for enabled and\ndisabled actions (so callers can see what a successful attempt would look like);\nnull when the action is not applicable to this asset.", "properties": { "purchase_price": { "description": "Estimated price to purchase the asset at the end of the rental contract", "oneOf": [ { "$ref": "#/components/schemas/ItAssetsAssetIdPatchResponsesContentApplicationJsonSchemaDataActionsPurchaseRentalDetailsPurchasePrice" }, { "type": "null" } ] }, "remaining_contract_value": { "$ref": "#/components/schemas/ItAssetsAssetIdPatchResponsesContentApplicationJsonSchemaDataActionsPurchaseRentalDetailsRemainingContractValue", "description": "Estimated remaining value of the rental contract" }, "total_purchase_price": { "description": "Estimated total price of the purchase, including any remaining contract value", "oneOf": [ { "$ref": "#/components/schemas/ItAssetsAssetIdPatchResponsesContentApplicationJsonSchemaDataActionsPurchaseRentalDetailsTotalPurchasePrice" }, { "type": "null" } ] } }, "required": [ "purchase_price", "total_purchase_price", "remaining_contract_value" ], "title": "ItAssetsAssetIdPatchResponsesContentApplicationJsonSchemaDataActionsPurchaseRentalDetails", "type": "object" }, "ItAssetsAssetIdPatchResponsesContentApplicationJsonSchemaDataActionsPurchaseRentalDetailsPurchasePrice": { "description": "Estimated price to purchase the asset at the end of the rental contract", "properties": { "amount": { "description": "Amount", "format": "decimal", "type": "string" }, "currency": { "$ref": "#/components/schemas/ItAssetsAssetIdPatchResponsesContentApplicationJsonSchemaDataActionsPurchaseRentalDetailsPurchasePriceCurrency", "description": "Three-letter currency code for the price" } }, "required": [ "amount", "currency" ], "title": "ItAssetsAssetIdPatchResponsesContentApplicationJsonSchemaDataActionsPurchaseRentalDetailsPurchasePrice", "type": "object" }, "ItAssetsAssetIdPatchResponsesContentApplicationJsonSchemaDataActionsPurchaseRentalDetailsPurchasePriceCurrency": { "description": "Three-letter currency code for the price", "enum": [ "AED", "AFN", "ALL", "AMD", "ANG", "AOA", "ARS", "AUD", "AWG", "AZN", "BAM", "BDT", "BGN", "BHD", "BIF", "BMD", "BOB", "BRL", "BSD", "BTN", "BWP", "BYN", "BZD", "CAD", "CDF", "CHF", "CLP", "CNY", "COP", "CRC", "CUC", "CVE", "CZK", "DJF", "DKK", "DOP", "DZD", "EGP", "ERN", "ETB", "EUR", "FJD", "FKP", "GBP", "GEL", "GHS", "GIP", "GMD", "GNF", "GTQ", "GYD", "HKD", "HNL", "HRK", "HTG", "HUF", "IDR", "ILS", "INR", "IQD", "IRR", "ISK", "JMD", "JOD", "JPY", "KES", "KGS", "KHR", "KMF", "KPW", "KRW", "KWD", "KYD", "KZT", "LAK", "LBP", "LKR", "LRD", "LSL", "LTL", "LYD", "MAD", "MDL", "MGA", "MKD", "MMK", "MNT", "MRU", "MUR", "MVR", "MWK", "MXN", "MYR", "MZN", "NAD", "NGN", "NIO", "NOK", "NPR", "NZD", "OMR", "PAB", "PEN", "PGK", "PHP", "PKR", "PLN", "PYG", "QAR", "RON", "RSD", "RUB", "RWF", "SAR", "SBD", "SCR", "SDG", "SEK", "SGD", "SHP", "SLL", "SOS", "SRD", "SSP", "STD", "SYP", "SZL", "THB", "TJS", "TMT", "TND", "TOP", "TRY", "TTD", "TWD", "TZS", "UAH", "UGX", "USD", "UYU", "UZS", "VEF", "VND", "VUV", "WST", "XAF", "XCD", "XOF", "XPF", "YER", "ZAR", "ZMW", "ZWD" ], "title": "ItAssetsAssetIdPatchResponsesContentApplicationJsonSchemaDataActionsPurchaseRentalDetailsPurchasePriceCurrency", "type": "string" }, "ItAssetsAssetIdPatchResponsesContentApplicationJsonSchemaDataActionsPurchaseRentalDetailsRemainingContractValue": { "description": "Estimated remaining value of the rental contract", "properties": { "amount": { "description": "Amount", "format": "decimal", "type": "string" }, "currency": { "$ref": "#/components/schemas/ItAssetsAssetIdPatchResponsesContentApplicationJsonSchemaDataActionsPurchaseRentalDetailsRemainingContractValueCurrency", "description": "Three-letter currency code for the price" } }, "required": [ "amount", "currency" ], "title": "ItAssetsAssetIdPatchResponsesContentApplicationJsonSchemaDataActionsPurchaseRentalDetailsRemainingContractValue", "type": "object" }, "ItAssetsAssetIdPatchResponsesContentApplicationJsonSchemaDataActionsPurchaseRentalDetailsRemainingContractValueCurrency": { "description": "Three-letter currency code for the price", "enum": [ "AED", "AFN", "ALL", "AMD", "ANG", "AOA", "ARS", "AUD", "AWG", "AZN", "BAM", "BDT", "BGN", "BHD", "BIF", "BMD", "BOB", "BRL", "BSD", "BTN", "BWP", "BYN", "BZD", "CAD", "CDF", "CHF", "CLP", "CNY", "COP", "CRC", "CUC", "CVE", "CZK", "DJF", "DKK", "DOP", "DZD", "EGP", "ERN", "ETB", "EUR", "FJD", "FKP", "GBP", "GEL", "GHS", "GIP", "GMD", "GNF", "GTQ", "GYD", "HKD", "HNL", "HRK", "HTG", "HUF", "IDR", "ILS", "INR", "IQD", "IRR", "ISK", "JMD", "JOD", "JPY", "KES", "KGS", "KHR", "KMF", "KPW", "KRW", "KWD", "KYD", "KZT", "LAK", "LBP", "LKR", "LRD", "LSL", "LTL", "LYD", "MAD", "MDL", "MGA", "MKD", "MMK", "MNT", "MRU", "MUR", "MVR", "MWK", "MXN", "MYR", "MZN", "NAD", "NGN", "NIO", "NOK", "NPR", "NZD", "OMR", "PAB", "PEN", "PGK", "PHP", "PKR", "PLN", "PYG", "QAR", "RON", "RSD", "RUB", "RWF", "SAR", "SBD", "SCR", "SDG", "SEK", "SGD", "SHP", "SLL", "SOS", "SRD", "SSP", "STD", "SYP", "SZL", "THB", "TJS", "TMT", "TND", "TOP", "TRY", "TTD", "TWD", "TZS", "UAH", "UGX", "USD", "UYU", "UZS", "VEF", "VND", "VUV", "WST", "XAF", "XCD", "XOF", "XPF", "YER", "ZAR", "ZMW", "ZWD" ], "title": "ItAssetsAssetIdPatchResponsesContentApplicationJsonSchemaDataActionsPurchaseRentalDetailsRemainingContractValueCurrency", "type": "string" }, "ItAssetsAssetIdPatchResponsesContentApplicationJsonSchemaDataActionsPurchaseRentalDetailsTotalPurchasePrice": { "description": "Estimated total price of the purchase, including any remaining contract value", "properties": { "amount": { "description": "Amount", "format": "decimal", "type": "string" }, "currency": { "$ref": "#/components/schemas/ItAssetsAssetIdPatchResponsesContentApplicationJsonSchemaDataActionsPurchaseRentalDetailsTotalPurchasePriceCurrency", "description": "Three-letter currency code for the price" } }, "required": [ "amount", "currency" ], "title": "ItAssetsAssetIdPatchResponsesContentApplicationJsonSchemaDataActionsPurchaseRentalDetailsTotalPurchasePrice", "type": "object" }, "ItAssetsAssetIdPatchResponsesContentApplicationJsonSchemaDataActionsPurchaseRentalDetailsTotalPurchasePriceCurrency": { "description": "Three-letter currency code for the price", "enum": [ "AED", "AFN", "ALL", "AMD", "ANG", "AOA", "ARS", "AUD", "AWG", "AZN", "BAM", "BDT", "BGN", "BHD", "BIF", "BMD", "BOB", "BRL", "BSD", "BTN", "BWP", "BYN", "BZD", "CAD", "CDF", "CHF", "CLP", "CNY", "COP", "CRC", "CUC", "CVE", "CZK", "DJF", "DKK", "DOP", "DZD", "EGP", "ERN", "ETB", "EUR", "FJD", "FKP", "GBP", "GEL", "GHS", "GIP", "GMD", "GNF", "GTQ", "GYD", "HKD", "HNL", "HRK", "HTG", "HUF", "IDR", "ILS", "INR", "IQD", "IRR", "ISK", "JMD", "JOD", "JPY", "KES", "KGS", "KHR", "KMF", "KPW", "KRW", "KWD", "KYD", "KZT", "LAK", "LBP", "LKR", "LRD", "LSL", "LTL", "LYD", "MAD", "MDL", "MGA", "MKD", "MMK", "MNT", "MRU", "MUR", "MVR", "MWK", "MXN", "MYR", "MZN", "NAD", "NGN", "NIO", "NOK", "NPR", "NZD", "OMR", "PAB", "PEN", "PGK", "PHP", "PKR", "PLN", "PYG", "QAR", "RON", "RSD", "RUB", "RWF", "SAR", "SBD", "SCR", "SDG", "SEK", "SGD", "SHP", "SLL", "SOS", "SRD", "SSP", "STD", "SYP", "SZL", "THB", "TJS", "TMT", "TND", "TOP", "TRY", "TTD", "TWD", "TZS", "UAH", "UGX", "USD", "UYU", "UZS", "VEF", "VND", "VUV", "WST", "XAF", "XCD", "XOF", "XPF", "YER", "ZAR", "ZMW", "ZWD" ], "title": "ItAssetsAssetIdPatchResponsesContentApplicationJsonSchemaDataActionsPurchaseRentalDetailsTotalPurchasePriceCurrency", "type": "string" }, "ItAssetsAssetIdPatchResponsesContentApplicationJsonSchemaDataActionsPurchaseRentalDisabledReasonsItems": { "enum": [ "ARCHIVED", "AT_DEEL_WAREHOUSE", "BEING_REPAIRED", "CONSUMABLE", "CONTROLLED_BY_DEEL", "COUNTRY_NOT_SUPPORTED_FOR_HUB", "COUNTRY_NOT_SUPPORTED_FOR_LOCAL", "DEEL_OWNED_ITEM_WITHOUT_RENTAL_CONTRACT", "DESKTOP_STORAGE", "ENDING_CONTRACT", "HUB_IN_SAME_REGION_AS_LOCAL", "INACTIVE", "INVALID_ITEM_LOCATION", "INVALID_ORGANIZATION_STATUS", "INVALID_STATE", "ITEM_CONDITIONS_TO_UNARCHIVE_NOT_MET", "ITEM_NOT_VISIBLE_FOR_ORGANIZATION", "NON_DEVICE", "NOT_AT_WAREHOUSE", "NOT_AVAILABLE_FOR_REUSE", "NOT_A_RENTAL", "NOT_MANAGEABLE_BY_ORGANIZATION", "NOT_WITH_ASSIGNMENT", "NOT_WITH_USER", "NO_ACTIVE_ADDONS", "NO_ACTIVE_STORAGE_CONTRACT", "NO_LOCATION_FOR_STORAGE", "NO_LOGISTICS_FOR_STORAGE", "NO_VALID_ADDONS", "ONGOING_SERVICE", "OWNED_BY_DEEL", "OWNED_BY_ORGANIZATION", "OWNED_BY_PARTNER_ORGANIZATION", "PARTNER_CHILD_CONTRACT", "PENDING_DEVICE_REFRESH", "RENTAL_CONTRACT_AND_USER_REGION_DO_NOT_MATCH", "TEMPORARILY_UNAVAILABLE", "UNKNOWN", "USER_HAS_NO_COUNTRY", "USER_HAS_NO_SEAT", "WAITING_FOR_CLEARANCE", "WITH_LOANER_ASSIGNMENT", "WITH_NON_COLLECTED_ASSIGNMENT", "WITH_NON_DELIVERED_ASSIGNMENT", "WITH_PENDING_ASSIGNMENT", "WRONG_ASSIGNMENT_STATUS", "WRONG_CONTRACT_STATUS", "WRONG_TERMS_AND_CONDITIONS" ], "title": "ItAssetsAssetIdPatchResponsesContentApplicationJsonSchemaDataActionsPurchaseRentalDisabledReasonsItems", "type": "string" }, "ItAssetsAssetIdPatchResponsesContentApplicationJsonSchemaDataActionsPurchaseRentalStatus": { "description": "Whether the action is currently available for this asset", "enum": [ "DISABLED", "ENABLED", "NOT_APPLICABLE" ], "title": "ItAssetsAssetIdPatchResponsesContentApplicationJsonSchemaDataActionsPurchaseRentalStatus", "type": "string" }, "ItAssetsAssetIdPatchResponsesContentApplicationJsonSchemaDataActionsReturnRentalToDeel": { "description": "Return a Deel-owned rental asset back to Deel", "properties": { "details": { "description": "Action-specific context needed to perform the action. Populated for enabled and\ndisabled actions (so callers can see what a successful attempt would look like);\nnull when the action is not applicable to this asset.", "oneOf": [ { "$ref": "#/components/schemas/ItAssetsAssetIdPatchResponsesContentApplicationJsonSchemaDataActionsReturnRentalToDeelDetails" }, { "type": "null" } ] }, "disabled_reasons": { "description": "Reasons why the action is disabled. Empty when the action is enabled or not applicable", "items": { "$ref": "#/components/schemas/ItAssetsAssetIdPatchResponsesContentApplicationJsonSchemaDataActionsReturnRentalToDeelDisabledReasonsItems" }, "type": "array" }, "status": { "$ref": "#/components/schemas/ItAssetsAssetIdPatchResponsesContentApplicationJsonSchemaDataActionsReturnRentalToDeelStatus", "description": "Whether the action is currently available for this asset" } }, "required": [ "status", "details", "disabled_reasons" ], "title": "ItAssetsAssetIdPatchResponsesContentApplicationJsonSchemaDataActionsReturnRentalToDeel", "type": "object" }, "ItAssetsAssetIdPatchResponsesContentApplicationJsonSchemaDataActionsReturnRentalToDeelDetails": { "description": "Action-specific context needed to perform the action. Populated for enabled and\ndisabled actions (so callers can see what a successful attempt would look like);\nnull when the action is not applicable to this asset.", "properties": { "end_contract_price": { "$ref": "#/components/schemas/ItAssetsAssetIdPatchResponsesContentApplicationJsonSchemaDataActionsReturnRentalToDeelDetailsEndContractPrice", "description": "Estimated end-of-contract price charged when returning the asset" } }, "required": [ "end_contract_price" ], "title": "ItAssetsAssetIdPatchResponsesContentApplicationJsonSchemaDataActionsReturnRentalToDeelDetails", "type": "object" }, "ItAssetsAssetIdPatchResponsesContentApplicationJsonSchemaDataActionsReturnRentalToDeelDetailsEndContractPrice": { "description": "Estimated end-of-contract price charged when returning the asset", "properties": { "amount": { "description": "Amount", "format": "decimal", "type": "string" }, "currency": { "$ref": "#/components/schemas/ItAssetsAssetIdPatchResponsesContentApplicationJsonSchemaDataActionsReturnRentalToDeelDetailsEndContractPriceCurrency", "description": "Three-letter currency code for the price" } }, "required": [ "amount", "currency" ], "title": "ItAssetsAssetIdPatchResponsesContentApplicationJsonSchemaDataActionsReturnRentalToDeelDetailsEndContractPrice", "type": "object" }, "ItAssetsAssetIdPatchResponsesContentApplicationJsonSchemaDataActionsReturnRentalToDeelDetailsEndContractPriceCurrency": { "description": "Three-letter currency code for the price", "enum": [ "AED", "AFN", "ALL", "AMD", "ANG", "AOA", "ARS", "AUD", "AWG", "AZN", "BAM", "BDT", "BGN", "BHD", "BIF", "BMD", "BOB", "BRL", "BSD", "BTN", "BWP", "BYN", "BZD", "CAD", "CDF", "CHF", "CLP", "CNY", "COP", "CRC", "CUC", "CVE", "CZK", "DJF", "DKK", "DOP", "DZD", "EGP", "ERN", "ETB", "EUR", "FJD", "FKP", "GBP", "GEL", "GHS", "GIP", "GMD", "GNF", "GTQ", "GYD", "HKD", "HNL", "HRK", "HTG", "HUF", "IDR", "ILS", "INR", "IQD", "IRR", "ISK", "JMD", "JOD", "JPY", "KES", "KGS", "KHR", "KMF", "KPW", "KRW", "KWD", "KYD", "KZT", "LAK", "LBP", "LKR", "LRD", "LSL", "LTL", "LYD", "MAD", "MDL", "MGA", "MKD", "MMK", "MNT", "MRU", "MUR", "MVR", "MWK", "MXN", "MYR", "MZN", "NAD", "NGN", "NIO", "NOK", "NPR", "NZD", "OMR", "PAB", "PEN", "PGK", "PHP", "PKR", "PLN", "PYG", "QAR", "RON", "RSD", "RUB", "RWF", "SAR", "SBD", "SCR", "SDG", "SEK", "SGD", "SHP", "SLL", "SOS", "SRD", "SSP", "STD", "SYP", "SZL", "THB", "TJS", "TMT", "TND", "TOP", "TRY", "TTD", "TWD", "TZS", "UAH", "UGX", "USD", "UYU", "UZS", "VEF", "VND", "VUV", "WST", "XAF", "XCD", "XOF", "XPF", "YER", "ZAR", "ZMW", "ZWD" ], "title": "ItAssetsAssetIdPatchResponsesContentApplicationJsonSchemaDataActionsReturnRentalToDeelDetailsEndContractPriceCurrency", "type": "string" }, "ItAssetsAssetIdPatchResponsesContentApplicationJsonSchemaDataActionsReturnRentalToDeelDisabledReasonsItems": { "enum": [ "ARCHIVED", "AT_DEEL_WAREHOUSE", "BEING_REPAIRED", "CONSUMABLE", "CONTROLLED_BY_DEEL", "COUNTRY_NOT_SUPPORTED_FOR_HUB", "COUNTRY_NOT_SUPPORTED_FOR_LOCAL", "DEEL_OWNED_ITEM_WITHOUT_RENTAL_CONTRACT", "DESKTOP_STORAGE", "ENDING_CONTRACT", "HUB_IN_SAME_REGION_AS_LOCAL", "INACTIVE", "INVALID_ITEM_LOCATION", "INVALID_ORGANIZATION_STATUS", "INVALID_STATE", "ITEM_CONDITIONS_TO_UNARCHIVE_NOT_MET", "ITEM_NOT_VISIBLE_FOR_ORGANIZATION", "NON_DEVICE", "NOT_AT_WAREHOUSE", "NOT_AVAILABLE_FOR_REUSE", "NOT_A_RENTAL", "NOT_MANAGEABLE_BY_ORGANIZATION", "NOT_WITH_ASSIGNMENT", "NOT_WITH_USER", "NO_ACTIVE_ADDONS", "NO_ACTIVE_STORAGE_CONTRACT", "NO_LOCATION_FOR_STORAGE", "NO_LOGISTICS_FOR_STORAGE", "NO_VALID_ADDONS", "ONGOING_SERVICE", "OWNED_BY_DEEL", "OWNED_BY_ORGANIZATION", "OWNED_BY_PARTNER_ORGANIZATION", "PARTNER_CHILD_CONTRACT", "PENDING_DEVICE_REFRESH", "RENTAL_CONTRACT_AND_USER_REGION_DO_NOT_MATCH", "TEMPORARILY_UNAVAILABLE", "UNKNOWN", "USER_HAS_NO_COUNTRY", "USER_HAS_NO_SEAT", "WAITING_FOR_CLEARANCE", "WITH_LOANER_ASSIGNMENT", "WITH_NON_COLLECTED_ASSIGNMENT", "WITH_NON_DELIVERED_ASSIGNMENT", "WITH_PENDING_ASSIGNMENT", "WRONG_ASSIGNMENT_STATUS", "WRONG_CONTRACT_STATUS", "WRONG_TERMS_AND_CONDITIONS" ], "title": "ItAssetsAssetIdPatchResponsesContentApplicationJsonSchemaDataActionsReturnRentalToDeelDisabledReasonsItems", "type": "string" }, "ItAssetsAssetIdPatchResponsesContentApplicationJsonSchemaDataActionsReturnRentalToDeelStatus": { "description": "Whether the action is currently available for this asset", "enum": [ "DISABLED", "ENABLED", "NOT_APPLICABLE" ], "title": "ItAssetsAssetIdPatchResponsesContentApplicationJsonSchemaDataActionsReturnRentalToDeelStatus", "type": "string" }, "ItAssetsAssetIdPatchResponsesContentApplicationJsonSchemaDataActionsReuseOwnAssetFromDeel": { "description": "Redeploy an organization-owned asset stored at a Deel warehouse", "properties": { "details": { "description": "Action-specific context needed to perform the action. Populated for enabled and\ndisabled actions (so callers can see what a successful attempt would look like);\nnull when the action is not applicable to this asset.", "oneOf": [ { "$ref": "#/components/schemas/ItAssetsAssetIdPatchResponsesContentApplicationJsonSchemaDataActionsReuseOwnAssetFromDeelDetails" }, { "type": "null" } ] }, "disabled_reasons": { "description": "Reasons why the action is disabled. Empty when the action is enabled or not applicable", "items": { "$ref": "#/components/schemas/ItAssetsAssetIdPatchResponsesContentApplicationJsonSchemaDataActionsReuseOwnAssetFromDeelDisabledReasonsItems" }, "type": "array" }, "status": { "$ref": "#/components/schemas/ItAssetsAssetIdPatchResponsesContentApplicationJsonSchemaDataActionsReuseOwnAssetFromDeelStatus", "description": "Whether the action is currently available for this asset" } }, "required": [ "status", "details", "disabled_reasons" ], "title": "ItAssetsAssetIdPatchResponsesContentApplicationJsonSchemaDataActionsReuseOwnAssetFromDeel", "type": "object" }, "ItAssetsAssetIdPatchResponsesContentApplicationJsonSchemaDataActionsReuseOwnAssetFromDeelDetails": { "description": "Action-specific context needed to perform the action. Populated for enabled and\ndisabled actions (so callers can see what a successful attempt would look like);\nnull when the action is not applicable to this asset.", "properties": { "eligible_countries": { "description": "Countries where the asset can be redeployed from Deel", "items": { "$ref": "#/components/schemas/ItAssetsAssetIdPatchResponsesContentApplicationJsonSchemaDataActionsReuseOwnAssetFromDeelDetailsEligibleCountriesItems" }, "type": "array" }, "express_delivery": { "description": "Express delivery availability and per-country fees. Null when express delivery is not supported", "oneOf": [ { "$ref": "#/components/schemas/ItAssetsAssetIdPatchResponsesContentApplicationJsonSchemaDataActionsReuseOwnAssetFromDeelDetailsExpressDelivery" }, { "type": "null" } ] } }, "required": [ "express_delivery", "eligible_countries" ], "title": "ItAssetsAssetIdPatchResponsesContentApplicationJsonSchemaDataActionsReuseOwnAssetFromDeelDetails", "type": "object" }, "ItAssetsAssetIdPatchResponsesContentApplicationJsonSchemaDataActionsReuseOwnAssetFromDeelDetailsEligibleCountriesItems": { "enum": [ "AD", "AE", "AF", "AG", "AI", "AL", "AM", "AN", "AO", "AQ", "AR", "AS", "AT", "AU", "AW", "AX", "AZ", "BA", "BB", "BD", "BE", "BF", "BG", "BH", "BI", "BJ", "BL", "BM", "BN", "BO", "BQ", "BR", "BS", "BT", "BV", "BW", "BY", "BZ", "CA", "CC", "CD", "CF", "CG", "CH", "CI", "CK", "CL", "CM", "CN", "CO", "CR", "CU", "CV", "CW", "CX", "CY", "CZ", "DE", "DJ", "DK", "DM", "DO", "DZ", "EC", "EE", "EG", "EH", "ER", "ES", "ET", "FI", "FJ", "FK", "FM", "FO", "FR", "GA", "GB", "GD", "GE", "GF", "GG", "GH", "GI", "GL", "GM", "GN", "GP", "GQ", "GR", "GS", "GT", "GU", "GW", "GY", "HK", "HM", "HN", "HR", "HT", "HU", "IC", "ID", "IE", "IL", "IM", "IN", "IO", "IQ", "IR", "IS", "IT", "JE", "JM", "JO", "JP", "KE", "KG", "KH", "KI", "KM", "KN", "KP", "KR", "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", "XK", "YE", "YT", "ZA", "ZM", "ZW" ], "title": "ItAssetsAssetIdPatchResponsesContentApplicationJsonSchemaDataActionsReuseOwnAssetFromDeelDetailsEligibleCountriesItems", "type": "string" }, "ItAssetsAssetIdPatchResponsesContentApplicationJsonSchemaDataActionsReuseOwnAssetFromDeelDetailsExpressDelivery": { "description": "Express delivery availability and per-country fees. Null when express delivery is not supported", "properties": { "country_fees": { "additionalProperties": { "$ref": "#/components/schemas/ItAssetsAssetIdPatchResponsesContentApplicationJsonSchemaDataActionsReuseOwnAssetFromDeelDetailsExpressDeliveryCountryFees" }, "description": "Express delivery fees keyed by destination country.", "type": "object" } }, "required": [ "country_fees" ], "title": "ItAssetsAssetIdPatchResponsesContentApplicationJsonSchemaDataActionsReuseOwnAssetFromDeelDetailsExpressDelivery", "type": "object" }, "ItAssetsAssetIdPatchResponsesContentApplicationJsonSchemaDataActionsReuseOwnAssetFromDeelDetailsExpressDeliveryCountryFees": { "properties": { "amount": { "description": "Amount", "format": "decimal", "type": "string" }, "currency": { "$ref": "#/components/schemas/ItAssetsAssetIdPatchResponsesContentApplicationJsonSchemaDataActionsReuseOwnAssetFromDeelDetailsExpressDeliveryCountryFeesCurrency", "description": "Three-letter currency code for the price" } }, "required": [ "amount", "currency" ], "title": "ItAssetsAssetIdPatchResponsesContentApplicationJsonSchemaDataActionsReuseOwnAssetFromDeelDetailsExpressDeliveryCountryFees", "type": "object" }, "ItAssetsAssetIdPatchResponsesContentApplicationJsonSchemaDataActionsReuseOwnAssetFromDeelDetailsExpressDeliveryCountryFeesCurrency": { "description": "Three-letter currency code for the price", "enum": [ "AED", "AFN", "ALL", "AMD", "ANG", "AOA", "ARS", "AUD", "AWG", "AZN", "BAM", "BDT", "BGN", "BHD", "BIF", "BMD", "BOB", "BRL", "BSD", "BTN", "BWP", "BYN", "BZD", "CAD", "CDF", "CHF", "CLP", "CNY", "COP", "CRC", "CUC", "CVE", "CZK", "DJF", "DKK", "DOP", "DZD", "EGP", "ERN", "ETB", "EUR", "FJD", "FKP", "GBP", "GEL", "GHS", "GIP", "GMD", "GNF", "GTQ", "GYD", "HKD", "HNL", "HRK", "HTG", "HUF", "IDR", "ILS", "INR", "IQD", "IRR", "ISK", "JMD", "JOD", "JPY", "KES", "KGS", "KHR", "KMF", "KPW", "KRW", "KWD", "KYD", "KZT", "LAK", "LBP", "LKR", "LRD", "LSL", "LTL", "LYD", "MAD", "MDL", "MGA", "MKD", "MMK", "MNT", "MRU", "MUR", "MVR", "MWK", "MXN", "MYR", "MZN", "NAD", "NGN", "NIO", "NOK", "NPR", "NZD", "OMR", "PAB", "PEN", "PGK", "PHP", "PKR", "PLN", "PYG", "QAR", "RON", "RSD", "RUB", "RWF", "SAR", "SBD", "SCR", "SDG", "SEK", "SGD", "SHP", "SLL", "SOS", "SRD", "SSP", "STD", "SYP", "SZL", "THB", "TJS", "TMT", "TND", "TOP", "TRY", "TTD", "TWD", "TZS", "UAH", "UGX", "USD", "UYU", "UZS", "VEF", "VND", "VUV", "WST", "XAF", "XCD", "XOF", "XPF", "YER", "ZAR", "ZMW", "ZWD" ], "title": "ItAssetsAssetIdPatchResponsesContentApplicationJsonSchemaDataActionsReuseOwnAssetFromDeelDetailsExpressDeliveryCountryFeesCurrency", "type": "string" }, "ItAssetsAssetIdPatchResponsesContentApplicationJsonSchemaDataActionsReuseOwnAssetFromDeelDisabledReasonsItems": { "enum": [ "ARCHIVED", "AT_DEEL_WAREHOUSE", "BEING_REPAIRED", "CONSUMABLE", "CONTROLLED_BY_DEEL", "COUNTRY_NOT_SUPPORTED_FOR_HUB", "COUNTRY_NOT_SUPPORTED_FOR_LOCAL", "DEEL_OWNED_ITEM_WITHOUT_RENTAL_CONTRACT", "DESKTOP_STORAGE", "ENDING_CONTRACT", "HUB_IN_SAME_REGION_AS_LOCAL", "INACTIVE", "INVALID_ITEM_LOCATION", "INVALID_ORGANIZATION_STATUS", "INVALID_STATE", "ITEM_CONDITIONS_TO_UNARCHIVE_NOT_MET", "ITEM_NOT_VISIBLE_FOR_ORGANIZATION", "NON_DEVICE", "NOT_AT_WAREHOUSE", "NOT_AVAILABLE_FOR_REUSE", "NOT_A_RENTAL", "NOT_MANAGEABLE_BY_ORGANIZATION", "NOT_WITH_ASSIGNMENT", "NOT_WITH_USER", "NO_ACTIVE_ADDONS", "NO_ACTIVE_STORAGE_CONTRACT", "NO_LOCATION_FOR_STORAGE", "NO_LOGISTICS_FOR_STORAGE", "NO_VALID_ADDONS", "ONGOING_SERVICE", "OWNED_BY_DEEL", "OWNED_BY_ORGANIZATION", "OWNED_BY_PARTNER_ORGANIZATION", "PARTNER_CHILD_CONTRACT", "PENDING_DEVICE_REFRESH", "RENTAL_CONTRACT_AND_USER_REGION_DO_NOT_MATCH", "TEMPORARILY_UNAVAILABLE", "UNKNOWN", "USER_HAS_NO_COUNTRY", "USER_HAS_NO_SEAT", "WAITING_FOR_CLEARANCE", "WITH_LOANER_ASSIGNMENT", "WITH_NON_COLLECTED_ASSIGNMENT", "WITH_NON_DELIVERED_ASSIGNMENT", "WITH_PENDING_ASSIGNMENT", "WRONG_ASSIGNMENT_STATUS", "WRONG_CONTRACT_STATUS", "WRONG_TERMS_AND_CONDITIONS" ], "title": "ItAssetsAssetIdPatchResponsesContentApplicationJsonSchemaDataActionsReuseOwnAssetFromDeelDisabledReasonsItems", "type": "string" }, "ItAssetsAssetIdPatchResponsesContentApplicationJsonSchemaDataActionsReuseOwnAssetFromDeelStatus": { "description": "Whether the action is currently available for this asset", "enum": [ "DISABLED", "ENABLED", "NOT_APPLICABLE" ], "title": "ItAssetsAssetIdPatchResponsesContentApplicationJsonSchemaDataActionsReuseOwnAssetFromDeelStatus", "type": "string" }, "ItAssetsAssetIdPatchResponsesContentApplicationJsonSchemaDataActionsReuseOwnAssetFromOwnLocation": { "description": "Redeploy an organization-owned asset from an organization-owned location", "properties": { "details": { "description": "Action-specific context needed to perform the action. Populated for enabled and\ndisabled actions (so callers can see what a successful attempt would look like);\nnull when the action is not applicable to this asset.", "oneOf": [ { "$ref": "#/components/schemas/ItAssetsAssetIdPatchResponsesContentApplicationJsonSchemaDataActionsReuseOwnAssetFromOwnLocationDetails" }, { "type": "null" } ] }, "disabled_reasons": { "description": "Reasons why the action is disabled. Empty when the action is enabled or not applicable", "items": { "$ref": "#/components/schemas/ItAssetsAssetIdPatchResponsesContentApplicationJsonSchemaDataActionsReuseOwnAssetFromOwnLocationDisabledReasonsItems" }, "type": "array" }, "status": { "$ref": "#/components/schemas/ItAssetsAssetIdPatchResponsesContentApplicationJsonSchemaDataActionsReuseOwnAssetFromOwnLocationStatus", "description": "Whether the action is currently available for this asset" } }, "required": [ "status", "details", "disabled_reasons" ], "title": "ItAssetsAssetIdPatchResponsesContentApplicationJsonSchemaDataActionsReuseOwnAssetFromOwnLocation", "type": "object" }, "ItAssetsAssetIdPatchResponsesContentApplicationJsonSchemaDataActionsReuseOwnAssetFromOwnLocationDetails": { "description": "Action-specific context needed to perform the action. Populated for enabled and\ndisabled actions (so callers can see what a successful attempt would look like);\nnull when the action is not applicable to this asset.", "properties": { "eligible_countries": { "description": "Countries where the asset can be redeployed from an organization-owned location", "items": { "$ref": "#/components/schemas/ItAssetsAssetIdPatchResponsesContentApplicationJsonSchemaDataActionsReuseOwnAssetFromOwnLocationDetailsEligibleCountriesItems" }, "type": "array" }, "express_delivery": { "description": "Express delivery availability and per-country fees. Null when express delivery is not supported", "oneOf": [ { "$ref": "#/components/schemas/ItAssetsAssetIdPatchResponsesContentApplicationJsonSchemaDataActionsReuseOwnAssetFromOwnLocationDetailsExpressDelivery" }, { "type": "null" } ] }, "service_cost": { "$ref": "#/components/schemas/ItAssetsAssetIdPatchResponsesContentApplicationJsonSchemaDataActionsReuseOwnAssetFromOwnLocationDetailsServiceCost", "description": "Cost charged for the transfer service" } }, "required": [ "service_cost", "express_delivery", "eligible_countries" ], "title": "ItAssetsAssetIdPatchResponsesContentApplicationJsonSchemaDataActionsReuseOwnAssetFromOwnLocationDetails", "type": "object" }, "ItAssetsAssetIdPatchResponsesContentApplicationJsonSchemaDataActionsReuseOwnAssetFromOwnLocationDetailsEligibleCountriesItems": { "enum": [ "AD", "AE", "AF", "AG", "AI", "AL", "AM", "AN", "AO", "AQ", "AR", "AS", "AT", "AU", "AW", "AX", "AZ", "BA", "BB", "BD", "BE", "BF", "BG", "BH", "BI", "BJ", "BL", "BM", "BN", "BO", "BQ", "BR", "BS", "BT", "BV", "BW", "BY", "BZ", "CA", "CC", "CD", "CF", "CG", "CH", "CI", "CK", "CL", "CM", "CN", "CO", "CR", "CU", "CV", "CW", "CX", "CY", "CZ", "DE", "DJ", "DK", "DM", "DO", "DZ", "EC", "EE", "EG", "EH", "ER", "ES", "ET", "FI", "FJ", "FK", "FM", "FO", "FR", "GA", "GB", "GD", "GE", "GF", "GG", "GH", "GI", "GL", "GM", "GN", "GP", "GQ", "GR", "GS", "GT", "GU", "GW", "GY", "HK", "HM", "HN", "HR", "HT", "HU", "IC", "ID", "IE", "IL", "IM", "IN", "IO", "IQ", "IR", "IS", "IT", "JE", "JM", "JO", "JP", "KE", "KG", "KH", "KI", "KM", "KN", "KP", "KR", "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", "XK", "YE", "YT", "ZA", "ZM", "ZW" ], "title": "ItAssetsAssetIdPatchResponsesContentApplicationJsonSchemaDataActionsReuseOwnAssetFromOwnLocationDetailsEligibleCountriesItems", "type": "string" }, "ItAssetsAssetIdPatchResponsesContentApplicationJsonSchemaDataActionsReuseOwnAssetFromOwnLocationDetailsExpressDelivery": { "description": "Express delivery availability and per-country fees. Null when express delivery is not supported", "properties": { "country_fees": { "additionalProperties": { "$ref": "#/components/schemas/ItAssetsAssetIdPatchResponsesContentApplicationJsonSchemaDataActionsReuseOwnAssetFromOwnLocationDetailsExpressDeliveryCountryFees" }, "description": "Express delivery fees keyed by destination country.", "type": "object" } }, "required": [ "country_fees" ], "title": "ItAssetsAssetIdPatchResponsesContentApplicationJsonSchemaDataActionsReuseOwnAssetFromOwnLocationDetailsExpressDelivery", "type": "object" }, "ItAssetsAssetIdPatchResponsesContentApplicationJsonSchemaDataActionsReuseOwnAssetFromOwnLocationDetailsExpressDeliveryCountryFees": { "properties": { "amount": { "description": "Amount", "format": "decimal", "type": "string" }, "currency": { "$ref": "#/components/schemas/ItAssetsAssetIdPatchResponsesContentApplicationJsonSchemaDataActionsReuseOwnAssetFromOwnLocationDetailsExpressDeliveryCountryFeesCurrency", "description": "Three-letter currency code for the price" } }, "required": [ "amount", "currency" ], "title": "ItAssetsAssetIdPatchResponsesContentApplicationJsonSchemaDataActionsReuseOwnAssetFromOwnLocationDetailsExpressDeliveryCountryFees", "type": "object" }, "ItAssetsAssetIdPatchResponsesContentApplicationJsonSchemaDataActionsReuseOwnAssetFromOwnLocationDetailsExpressDeliveryCountryFeesCurrency": { "description": "Three-letter currency code for the price", "enum": [ "AED", "AFN", "ALL", "AMD", "ANG", "AOA", "ARS", "AUD", "AWG", "AZN", "BAM", "BDT", "BGN", "BHD", "BIF", "BMD", "BOB", "BRL", "BSD", "BTN", "BWP", "BYN", "BZD", "CAD", "CDF", "CHF", "CLP", "CNY", "COP", "CRC", "CUC", "CVE", "CZK", "DJF", "DKK", "DOP", "DZD", "EGP", "ERN", "ETB", "EUR", "FJD", "FKP", "GBP", "GEL", "GHS", "GIP", "GMD", "GNF", "GTQ", "GYD", "HKD", "HNL", "HRK", "HTG", "HUF", "IDR", "ILS", "INR", "IQD", "IRR", "ISK", "JMD", "JOD", "JPY", "KES", "KGS", "KHR", "KMF", "KPW", "KRW", "KWD", "KYD", "KZT", "LAK", "LBP", "LKR", "LRD", "LSL", "LTL", "LYD", "MAD", "MDL", "MGA", "MKD", "MMK", "MNT", "MRU", "MUR", "MVR", "MWK", "MXN", "MYR", "MZN", "NAD", "NGN", "NIO", "NOK", "NPR", "NZD", "OMR", "PAB", "PEN", "PGK", "PHP", "PKR", "PLN", "PYG", "QAR", "RON", "RSD", "RUB", "RWF", "SAR", "SBD", "SCR", "SDG", "SEK", "SGD", "SHP", "SLL", "SOS", "SRD", "SSP", "STD", "SYP", "SZL", "THB", "TJS", "TMT", "TND", "TOP", "TRY", "TTD", "TWD", "TZS", "UAH", "UGX", "USD", "UYU", "UZS", "VEF", "VND", "VUV", "WST", "XAF", "XCD", "XOF", "XPF", "YER", "ZAR", "ZMW", "ZWD" ], "title": "ItAssetsAssetIdPatchResponsesContentApplicationJsonSchemaDataActionsReuseOwnAssetFromOwnLocationDetailsExpressDeliveryCountryFeesCurrency", "type": "string" }, "ItAssetsAssetIdPatchResponsesContentApplicationJsonSchemaDataActionsReuseOwnAssetFromOwnLocationDetailsServiceCost": { "description": "Cost charged for the transfer service", "properties": { "billing_method": { "$ref": "#/components/schemas/ItAssetsAssetIdPatchResponsesContentApplicationJsonSchemaDataActionsReuseOwnAssetFromOwnLocationDetailsServiceCostBillingMethod", "description": "How the action is charged. When \"TOKEN\", the fees are covered by an\nadd-on token pool; when \"CURRENCY\", the fees are billed in the currency\nspecified in the \"fees\" field." }, "fees": { "description": "Price charged for the action. Null when billing method is \"TOKEN\"", "oneOf": [ { "$ref": "#/components/schemas/ItAssetsAssetIdPatchResponsesContentApplicationJsonSchemaDataActionsReuseOwnAssetFromOwnLocationDetailsServiceCostFees" }, { "type": "null" } ] }, "token_usage": { "description": "Add-on token consumption details. Null when billing method is \"CURRENCY\"", "oneOf": [ { "$ref": "#/components/schemas/ItAssetsAssetIdPatchResponsesContentApplicationJsonSchemaDataActionsReuseOwnAssetFromOwnLocationDetailsServiceCostTokenUsage" }, { "type": "null" } ] } }, "required": [ "fees", "token_usage", "billing_method" ], "title": "ItAssetsAssetIdPatchResponsesContentApplicationJsonSchemaDataActionsReuseOwnAssetFromOwnLocationDetailsServiceCost", "type": "object" }, "ItAssetsAssetIdPatchResponsesContentApplicationJsonSchemaDataActionsReuseOwnAssetFromOwnLocationDetailsServiceCostBillingMethod": { "description": "How the action is charged. When \"TOKEN\", the fees are covered by an\nadd-on token pool; when \"CURRENCY\", the fees are billed in the currency\nspecified in the \"fees\" field.", "enum": [ "CURRENCY", "TOKEN" ], "title": "ItAssetsAssetIdPatchResponsesContentApplicationJsonSchemaDataActionsReuseOwnAssetFromOwnLocationDetailsServiceCostBillingMethod", "type": "string" }, "ItAssetsAssetIdPatchResponsesContentApplicationJsonSchemaDataActionsReuseOwnAssetFromOwnLocationDetailsServiceCostFees": { "description": "Price charged for the action. Null when billing method is \"TOKEN\"", "properties": { "amount": { "description": "Amount", "format": "decimal", "type": "string" }, "currency": { "$ref": "#/components/schemas/ItAssetsAssetIdPatchResponsesContentApplicationJsonSchemaDataActionsReuseOwnAssetFromOwnLocationDetailsServiceCostFeesCurrency", "description": "Three-letter currency code for the price" } }, "required": [ "amount", "currency" ], "title": "ItAssetsAssetIdPatchResponsesContentApplicationJsonSchemaDataActionsReuseOwnAssetFromOwnLocationDetailsServiceCostFees", "type": "object" }, "ItAssetsAssetIdPatchResponsesContentApplicationJsonSchemaDataActionsReuseOwnAssetFromOwnLocationDetailsServiceCostFeesCurrency": { "description": "Three-letter currency code for the price", "enum": [ "AED", "AFN", "ALL", "AMD", "ANG", "AOA", "ARS", "AUD", "AWG", "AZN", "BAM", "BDT", "BGN", "BHD", "BIF", "BMD", "BOB", "BRL", "BSD", "BTN", "BWP", "BYN", "BZD", "CAD", "CDF", "CHF", "CLP", "CNY", "COP", "CRC", "CUC", "CVE", "CZK", "DJF", "DKK", "DOP", "DZD", "EGP", "ERN", "ETB", "EUR", "FJD", "FKP", "GBP", "GEL", "GHS", "GIP", "GMD", "GNF", "GTQ", "GYD", "HKD", "HNL", "HRK", "HTG", "HUF", "IDR", "ILS", "INR", "IQD", "IRR", "ISK", "JMD", "JOD", "JPY", "KES", "KGS", "KHR", "KMF", "KPW", "KRW", "KWD", "KYD", "KZT", "LAK", "LBP", "LKR", "LRD", "LSL", "LTL", "LYD", "MAD", "MDL", "MGA", "MKD", "MMK", "MNT", "MRU", "MUR", "MVR", "MWK", "MXN", "MYR", "MZN", "NAD", "NGN", "NIO", "NOK", "NPR", "NZD", "OMR", "PAB", "PEN", "PGK", "PHP", "PKR", "PLN", "PYG", "QAR", "RON", "RSD", "RUB", "RWF", "SAR", "SBD", "SCR", "SDG", "SEK", "SGD", "SHP", "SLL", "SOS", "SRD", "SSP", "STD", "SYP", "SZL", "THB", "TJS", "TMT", "TND", "TOP", "TRY", "TTD", "TWD", "TZS", "UAH", "UGX", "USD", "UYU", "UZS", "VEF", "VND", "VUV", "WST", "XAF", "XCD", "XOF", "XPF", "YER", "ZAR", "ZMW", "ZWD" ], "title": "ItAssetsAssetIdPatchResponsesContentApplicationJsonSchemaDataActionsReuseOwnAssetFromOwnLocationDetailsServiceCostFeesCurrency", "type": "string" }, "ItAssetsAssetIdPatchResponsesContentApplicationJsonSchemaDataActionsReuseOwnAssetFromOwnLocationDetailsServiceCostTokenUsage": { "description": "Add-on token consumption details. Null when billing method is \"CURRENCY\"", "properties": { "addon": { "$ref": "#/components/schemas/ItAssetsAssetIdPatchResponsesContentApplicationJsonSchemaDataActionsReuseOwnAssetFromOwnLocationDetailsServiceCostTokenUsageAddon", "description": "The add-on that provides the tokens" }, "cost": { "description": "Number of tokens consumed by the action. Zero when the add-on covers the\nservice without drawing from a token pool", "format": "decimal", "type": "string" }, "tokens_left": { "description": "Number of tokens left in the pool after the action is performed. Null when\nthe add-on covers the service without a token pool", "format": "decimal", "type": [ "string", "null" ] } }, "required": [ "cost", "addon", "tokens_left" ], "title": "ItAssetsAssetIdPatchResponsesContentApplicationJsonSchemaDataActionsReuseOwnAssetFromOwnLocationDetailsServiceCostTokenUsage", "type": "object" }, "ItAssetsAssetIdPatchResponsesContentApplicationJsonSchemaDataActionsReuseOwnAssetFromOwnLocationDetailsServiceCostTokenUsageAddon": { "description": "The add-on that provides the tokens", "properties": { "id": { "description": "ID of the add-on", "format": "uuid", "type": "string" }, "name": { "description": "Public display name of the add-on", "type": "string" } }, "required": [ "id", "name" ], "title": "ItAssetsAssetIdPatchResponsesContentApplicationJsonSchemaDataActionsReuseOwnAssetFromOwnLocationDetailsServiceCostTokenUsageAddon", "type": "object" }, "ItAssetsAssetIdPatchResponsesContentApplicationJsonSchemaDataActionsReuseOwnAssetFromOwnLocationDisabledReasonsItems": { "enum": [ "ARCHIVED", "AT_DEEL_WAREHOUSE", "BEING_REPAIRED", "CONSUMABLE", "CONTROLLED_BY_DEEL", "COUNTRY_NOT_SUPPORTED_FOR_HUB", "COUNTRY_NOT_SUPPORTED_FOR_LOCAL", "DEEL_OWNED_ITEM_WITHOUT_RENTAL_CONTRACT", "DESKTOP_STORAGE", "ENDING_CONTRACT", "HUB_IN_SAME_REGION_AS_LOCAL", "INACTIVE", "INVALID_ITEM_LOCATION", "INVALID_ORGANIZATION_STATUS", "INVALID_STATE", "ITEM_CONDITIONS_TO_UNARCHIVE_NOT_MET", "ITEM_NOT_VISIBLE_FOR_ORGANIZATION", "NON_DEVICE", "NOT_AT_WAREHOUSE", "NOT_AVAILABLE_FOR_REUSE", "NOT_A_RENTAL", "NOT_MANAGEABLE_BY_ORGANIZATION", "NOT_WITH_ASSIGNMENT", "NOT_WITH_USER", "NO_ACTIVE_ADDONS", "NO_ACTIVE_STORAGE_CONTRACT", "NO_LOCATION_FOR_STORAGE", "NO_LOGISTICS_FOR_STORAGE", "NO_VALID_ADDONS", "ONGOING_SERVICE", "OWNED_BY_DEEL", "OWNED_BY_ORGANIZATION", "OWNED_BY_PARTNER_ORGANIZATION", "PARTNER_CHILD_CONTRACT", "PENDING_DEVICE_REFRESH", "RENTAL_CONTRACT_AND_USER_REGION_DO_NOT_MATCH", "TEMPORARILY_UNAVAILABLE", "UNKNOWN", "USER_HAS_NO_COUNTRY", "USER_HAS_NO_SEAT", "WAITING_FOR_CLEARANCE", "WITH_LOANER_ASSIGNMENT", "WITH_NON_COLLECTED_ASSIGNMENT", "WITH_NON_DELIVERED_ASSIGNMENT", "WITH_PENDING_ASSIGNMENT", "WRONG_ASSIGNMENT_STATUS", "WRONG_CONTRACT_STATUS", "WRONG_TERMS_AND_CONDITIONS" ], "title": "ItAssetsAssetIdPatchResponsesContentApplicationJsonSchemaDataActionsReuseOwnAssetFromOwnLocationDisabledReasonsItems", "type": "string" }, "ItAssetsAssetIdPatchResponsesContentApplicationJsonSchemaDataActionsReuseOwnAssetFromOwnLocationStatus": { "description": "Whether the action is currently available for this asset", "enum": [ "DISABLED", "ENABLED", "NOT_APPLICABLE" ], "title": "ItAssetsAssetIdPatchResponsesContentApplicationJsonSchemaDataActionsReuseOwnAssetFromOwnLocationStatus", "type": "string" }, "ItAssetsAssetIdPatchResponsesContentApplicationJsonSchemaDataActionsStoreOwnAssetAtDeelForHub": { "description": "Store an organization-owned asset at a Deel hub warehouse", "properties": { "details": { "description": "Action-specific context needed to perform the action. Populated for enabled and\ndisabled actions (so callers can see what a successful attempt would look like);\nnull when the action is not applicable to this asset.", "oneOf": [ { "$ref": "#/components/schemas/ItAssetsAssetIdPatchResponsesContentApplicationJsonSchemaDataActionsStoreOwnAssetAtDeelForHubDetails" }, { "type": "null" } ] }, "disabled_reasons": { "description": "Reasons why the action is disabled. Empty when the action is enabled or not applicable", "items": { "$ref": "#/components/schemas/ItAssetsAssetIdPatchResponsesContentApplicationJsonSchemaDataActionsStoreOwnAssetAtDeelForHubDisabledReasonsItems" }, "type": "array" }, "status": { "$ref": "#/components/schemas/ItAssetsAssetIdPatchResponsesContentApplicationJsonSchemaDataActionsStoreOwnAssetAtDeelForHubStatus", "description": "Whether the action is currently available for this asset" } }, "required": [ "status", "details", "disabled_reasons" ], "title": "ItAssetsAssetIdPatchResponsesContentApplicationJsonSchemaDataActionsStoreOwnAssetAtDeelForHub", "type": "object" }, "ItAssetsAssetIdPatchResponsesContentApplicationJsonSchemaDataActionsStoreOwnAssetAtDeelForHubDetails": { "description": "Action-specific context needed to perform the action. Populated for enabled and\ndisabled actions (so callers can see what a successful attempt would look like);\nnull when the action is not applicable to this asset.", "properties": { "activation_cost": { "$ref": "#/components/schemas/ItAssetsAssetIdPatchResponsesContentApplicationJsonSchemaDataActionsStoreOwnAssetAtDeelForHubDetailsActivationCost", "description": "Cost charged to activate storage" }, "destination_country": { "$ref": "#/components/schemas/ItAssetsAssetIdPatchResponsesContentApplicationJsonSchemaDataActionsStoreOwnAssetAtDeelForHubDetailsDestinationCountry", "description": "ISO 3166-1 alpha-2 country of the Deel warehouse the asset will be shipped to" }, "grace_period_in_months": { "description": "Grace period in months during which storage is free before monthly fees apply", "format": "int64", "type": "integer" }, "monthly_fee": { "$ref": "#/components/schemas/ItAssetsAssetIdPatchResponsesContentApplicationJsonSchemaDataActionsStoreOwnAssetAtDeelForHubDetailsMonthlyFee", "description": "Monthly storage fee charged after the grace period" } }, "required": [ "monthly_fee", "activation_cost", "destination_country", "grace_period_in_months" ], "title": "ItAssetsAssetIdPatchResponsesContentApplicationJsonSchemaDataActionsStoreOwnAssetAtDeelForHubDetails", "type": "object" }, "ItAssetsAssetIdPatchResponsesContentApplicationJsonSchemaDataActionsStoreOwnAssetAtDeelForHubDetailsActivationCost": { "description": "Cost charged to activate storage", "properties": { "billing_method": { "$ref": "#/components/schemas/ItAssetsAssetIdPatchResponsesContentApplicationJsonSchemaDataActionsStoreOwnAssetAtDeelForHubDetailsActivationCostBillingMethod", "description": "How the action is charged. When \"TOKEN\", the fees are covered by an\nadd-on token pool; when \"CURRENCY\", the fees are billed in the currency\nspecified in the \"fees\" field." }, "fees": { "description": "Price charged for the action. Null when billing method is \"TOKEN\"", "oneOf": [ { "$ref": "#/components/schemas/ItAssetsAssetIdPatchResponsesContentApplicationJsonSchemaDataActionsStoreOwnAssetAtDeelForHubDetailsActivationCostFees" }, { "type": "null" } ] }, "token_usage": { "description": "Add-on token consumption details. Null when billing method is \"CURRENCY\"", "oneOf": [ { "$ref": "#/components/schemas/ItAssetsAssetIdPatchResponsesContentApplicationJsonSchemaDataActionsStoreOwnAssetAtDeelForHubDetailsActivationCostTokenUsage" }, { "type": "null" } ] } }, "required": [ "fees", "token_usage", "billing_method" ], "title": "ItAssetsAssetIdPatchResponsesContentApplicationJsonSchemaDataActionsStoreOwnAssetAtDeelForHubDetailsActivationCost", "type": "object" }, "ItAssetsAssetIdPatchResponsesContentApplicationJsonSchemaDataActionsStoreOwnAssetAtDeelForHubDetailsActivationCostBillingMethod": { "description": "How the action is charged. When \"TOKEN\", the fees are covered by an\nadd-on token pool; when \"CURRENCY\", the fees are billed in the currency\nspecified in the \"fees\" field.", "enum": [ "CURRENCY", "TOKEN" ], "title": "ItAssetsAssetIdPatchResponsesContentApplicationJsonSchemaDataActionsStoreOwnAssetAtDeelForHubDetailsActivationCostBillingMethod", "type": "string" }, "ItAssetsAssetIdPatchResponsesContentApplicationJsonSchemaDataActionsStoreOwnAssetAtDeelForHubDetailsActivationCostFees": { "description": "Price charged for the action. Null when billing method is \"TOKEN\"", "properties": { "amount": { "description": "Amount", "format": "decimal", "type": "string" }, "currency": { "$ref": "#/components/schemas/ItAssetsAssetIdPatchResponsesContentApplicationJsonSchemaDataActionsStoreOwnAssetAtDeelForHubDetailsActivationCostFeesCurrency", "description": "Three-letter currency code for the price" } }, "required": [ "amount", "currency" ], "title": "ItAssetsAssetIdPatchResponsesContentApplicationJsonSchemaDataActionsStoreOwnAssetAtDeelForHubDetailsActivationCostFees", "type": "object" }, "ItAssetsAssetIdPatchResponsesContentApplicationJsonSchemaDataActionsStoreOwnAssetAtDeelForHubDetailsActivationCostFeesCurrency": { "description": "Three-letter currency code for the price", "enum": [ "AED", "AFN", "ALL", "AMD", "ANG", "AOA", "ARS", "AUD", "AWG", "AZN", "BAM", "BDT", "BGN", "BHD", "BIF", "BMD", "BOB", "BRL", "BSD", "BTN", "BWP", "BYN", "BZD", "CAD", "CDF", "CHF", "CLP", "CNY", "COP", "CRC", "CUC", "CVE", "CZK", "DJF", "DKK", "DOP", "DZD", "EGP", "ERN", "ETB", "EUR", "FJD", "FKP", "GBP", "GEL", "GHS", "GIP", "GMD", "GNF", "GTQ", "GYD", "HKD", "HNL", "HRK", "HTG", "HUF", "IDR", "ILS", "INR", "IQD", "IRR", "ISK", "JMD", "JOD", "JPY", "KES", "KGS", "KHR", "KMF", "KPW", "KRW", "KWD", "KYD", "KZT", "LAK", "LBP", "LKR", "LRD", "LSL", "LTL", "LYD", "MAD", "MDL", "MGA", "MKD", "MMK", "MNT", "MRU", "MUR", "MVR", "MWK", "MXN", "MYR", "MZN", "NAD", "NGN", "NIO", "NOK", "NPR", "NZD", "OMR", "PAB", "PEN", "PGK", "PHP", "PKR", "PLN", "PYG", "QAR", "RON", "RSD", "RUB", "RWF", "SAR", "SBD", "SCR", "SDG", "SEK", "SGD", "SHP", "SLL", "SOS", "SRD", "SSP", "STD", "SYP", "SZL", "THB", "TJS", "TMT", "TND", "TOP", "TRY", "TTD", "TWD", "TZS", "UAH", "UGX", "USD", "UYU", "UZS", "VEF", "VND", "VUV", "WST", "XAF", "XCD", "XOF", "XPF", "YER", "ZAR", "ZMW", "ZWD" ], "title": "ItAssetsAssetIdPatchResponsesContentApplicationJsonSchemaDataActionsStoreOwnAssetAtDeelForHubDetailsActivationCostFeesCurrency", "type": "string" }, "ItAssetsAssetIdPatchResponsesContentApplicationJsonSchemaDataActionsStoreOwnAssetAtDeelForHubDetailsActivationCostTokenUsage": { "description": "Add-on token consumption details. Null when billing method is \"CURRENCY\"", "properties": { "addon": { "$ref": "#/components/schemas/ItAssetsAssetIdPatchResponsesContentApplicationJsonSchemaDataActionsStoreOwnAssetAtDeelForHubDetailsActivationCostTokenUsageAddon", "description": "The add-on that provides the tokens" }, "cost": { "description": "Number of tokens consumed by the action. Zero when the add-on covers the\nservice without drawing from a token pool", "format": "decimal", "type": "string" }, "tokens_left": { "description": "Number of tokens left in the pool after the action is performed. Null when\nthe add-on covers the service without a token pool", "format": "decimal", "type": [ "string", "null" ] } }, "required": [ "cost", "addon", "tokens_left" ], "title": "ItAssetsAssetIdPatchResponsesContentApplicationJsonSchemaDataActionsStoreOwnAssetAtDeelForHubDetailsActivationCostTokenUsage", "type": "object" }, "ItAssetsAssetIdPatchResponsesContentApplicationJsonSchemaDataActionsStoreOwnAssetAtDeelForHubDetailsActivationCostTokenUsageAddon": { "description": "The add-on that provides the tokens", "properties": { "id": { "description": "ID of the add-on", "format": "uuid", "type": "string" }, "name": { "description": "Public display name of the add-on", "type": "string" } }, "required": [ "id", "name" ], "title": "ItAssetsAssetIdPatchResponsesContentApplicationJsonSchemaDataActionsStoreOwnAssetAtDeelForHubDetailsActivationCostTokenUsageAddon", "type": "object" }, "ItAssetsAssetIdPatchResponsesContentApplicationJsonSchemaDataActionsStoreOwnAssetAtDeelForHubDetailsDestinationCountry": { "description": "ISO 3166-1 alpha-2 country of the Deel warehouse the asset will be shipped to", "enum": [ "AD", "AE", "AF", "AG", "AI", "AL", "AM", "AN", "AO", "AQ", "AR", "AS", "AT", "AU", "AW", "AX", "AZ", "BA", "BB", "BD", "BE", "BF", "BG", "BH", "BI", "BJ", "BL", "BM", "BN", "BO", "BQ", "BR", "BS", "BT", "BV", "BW", "BY", "BZ", "CA", "CC", "CD", "CF", "CG", "CH", "CI", "CK", "CL", "CM", "CN", "CO", "CR", "CU", "CV", "CW", "CX", "CY", "CZ", "DE", "DJ", "DK", "DM", "DO", "DZ", "EC", "EE", "EG", "EH", "ER", "ES", "ET", "FI", "FJ", "FK", "FM", "FO", "FR", "GA", "GB", "GD", "GE", "GF", "GG", "GH", "GI", "GL", "GM", "GN", "GP", "GQ", "GR", "GS", "GT", "GU", "GW", "GY", "HK", "HM", "HN", "HR", "HT", "HU", "IC", "ID", "IE", "IL", "IM", "IN", "IO", "IQ", "IR", "IS", "IT", "JE", "JM", "JO", "JP", "KE", "KG", "KH", "KI", "KM", "KN", "KP", "KR", "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", "XK", "YE", "YT", "ZA", "ZM", "ZW" ], "title": "ItAssetsAssetIdPatchResponsesContentApplicationJsonSchemaDataActionsStoreOwnAssetAtDeelForHubDetailsDestinationCountry", "type": "string" }, "ItAssetsAssetIdPatchResponsesContentApplicationJsonSchemaDataActionsStoreOwnAssetAtDeelForHubDetailsMonthlyFee": { "description": "Monthly storage fee charged after the grace period", "properties": { "amount": { "description": "Amount", "format": "decimal", "type": "string" }, "currency": { "$ref": "#/components/schemas/ItAssetsAssetIdPatchResponsesContentApplicationJsonSchemaDataActionsStoreOwnAssetAtDeelForHubDetailsMonthlyFeeCurrency", "description": "Three-letter currency code for the price" } }, "required": [ "amount", "currency" ], "title": "ItAssetsAssetIdPatchResponsesContentApplicationJsonSchemaDataActionsStoreOwnAssetAtDeelForHubDetailsMonthlyFee", "type": "object" }, "ItAssetsAssetIdPatchResponsesContentApplicationJsonSchemaDataActionsStoreOwnAssetAtDeelForHubDetailsMonthlyFeeCurrency": { "description": "Three-letter currency code for the price", "enum": [ "AED", "AFN", "ALL", "AMD", "ANG", "AOA", "ARS", "AUD", "AWG", "AZN", "BAM", "BDT", "BGN", "BHD", "BIF", "BMD", "BOB", "BRL", "BSD", "BTN", "BWP", "BYN", "BZD", "CAD", "CDF", "CHF", "CLP", "CNY", "COP", "CRC", "CUC", "CVE", "CZK", "DJF", "DKK", "DOP", "DZD", "EGP", "ERN", "ETB", "EUR", "FJD", "FKP", "GBP", "GEL", "GHS", "GIP", "GMD", "GNF", "GTQ", "GYD", "HKD", "HNL", "HRK", "HTG", "HUF", "IDR", "ILS", "INR", "IQD", "IRR", "ISK", "JMD", "JOD", "JPY", "KES", "KGS", "KHR", "KMF", "KPW", "KRW", "KWD", "KYD", "KZT", "LAK", "LBP", "LKR", "LRD", "LSL", "LTL", "LYD", "MAD", "MDL", "MGA", "MKD", "MMK", "MNT", "MRU", "MUR", "MVR", "MWK", "MXN", "MYR", "MZN", "NAD", "NGN", "NIO", "NOK", "NPR", "NZD", "OMR", "PAB", "PEN", "PGK", "PHP", "PKR", "PLN", "PYG", "QAR", "RON", "RSD", "RUB", "RWF", "SAR", "SBD", "SCR", "SDG", "SEK", "SGD", "SHP", "SLL", "SOS", "SRD", "SSP", "STD", "SYP", "SZL", "THB", "TJS", "TMT", "TND", "TOP", "TRY", "TTD", "TWD", "TZS", "UAH", "UGX", "USD", "UYU", "UZS", "VEF", "VND", "VUV", "WST", "XAF", "XCD", "XOF", "XPF", "YER", "ZAR", "ZMW", "ZWD" ], "title": "ItAssetsAssetIdPatchResponsesContentApplicationJsonSchemaDataActionsStoreOwnAssetAtDeelForHubDetailsMonthlyFeeCurrency", "type": "string" }, "ItAssetsAssetIdPatchResponsesContentApplicationJsonSchemaDataActionsStoreOwnAssetAtDeelForHubDisabledReasonsItems": { "enum": [ "ARCHIVED", "AT_DEEL_WAREHOUSE", "BEING_REPAIRED", "CONSUMABLE", "CONTROLLED_BY_DEEL", "COUNTRY_NOT_SUPPORTED_FOR_HUB", "COUNTRY_NOT_SUPPORTED_FOR_LOCAL", "DEEL_OWNED_ITEM_WITHOUT_RENTAL_CONTRACT", "DESKTOP_STORAGE", "ENDING_CONTRACT", "HUB_IN_SAME_REGION_AS_LOCAL", "INACTIVE", "INVALID_ITEM_LOCATION", "INVALID_ORGANIZATION_STATUS", "INVALID_STATE", "ITEM_CONDITIONS_TO_UNARCHIVE_NOT_MET", "ITEM_NOT_VISIBLE_FOR_ORGANIZATION", "NON_DEVICE", "NOT_AT_WAREHOUSE", "NOT_AVAILABLE_FOR_REUSE", "NOT_A_RENTAL", "NOT_MANAGEABLE_BY_ORGANIZATION", "NOT_WITH_ASSIGNMENT", "NOT_WITH_USER", "NO_ACTIVE_ADDONS", "NO_ACTIVE_STORAGE_CONTRACT", "NO_LOCATION_FOR_STORAGE", "NO_LOGISTICS_FOR_STORAGE", "NO_VALID_ADDONS", "ONGOING_SERVICE", "OWNED_BY_DEEL", "OWNED_BY_ORGANIZATION", "OWNED_BY_PARTNER_ORGANIZATION", "PARTNER_CHILD_CONTRACT", "PENDING_DEVICE_REFRESH", "RENTAL_CONTRACT_AND_USER_REGION_DO_NOT_MATCH", "TEMPORARILY_UNAVAILABLE", "UNKNOWN", "USER_HAS_NO_COUNTRY", "USER_HAS_NO_SEAT", "WAITING_FOR_CLEARANCE", "WITH_LOANER_ASSIGNMENT", "WITH_NON_COLLECTED_ASSIGNMENT", "WITH_NON_DELIVERED_ASSIGNMENT", "WITH_PENDING_ASSIGNMENT", "WRONG_ASSIGNMENT_STATUS", "WRONG_CONTRACT_STATUS", "WRONG_TERMS_AND_CONDITIONS" ], "title": "ItAssetsAssetIdPatchResponsesContentApplicationJsonSchemaDataActionsStoreOwnAssetAtDeelForHubDisabledReasonsItems", "type": "string" }, "ItAssetsAssetIdPatchResponsesContentApplicationJsonSchemaDataActionsStoreOwnAssetAtDeelForHubStatus": { "description": "Whether the action is currently available for this asset", "enum": [ "DISABLED", "ENABLED", "NOT_APPLICABLE" ], "title": "ItAssetsAssetIdPatchResponsesContentApplicationJsonSchemaDataActionsStoreOwnAssetAtDeelForHubStatus", "type": "string" }, "ItAssetsAssetIdPatchResponsesContentApplicationJsonSchemaDataActionsStoreOwnAssetAtDeelForLocal": { "description": "Store an organization-owned asset at a Deel local warehouse", "properties": { "details": { "description": "Action-specific context needed to perform the action. Populated for enabled and\ndisabled actions (so callers can see what a successful attempt would look like);\nnull when the action is not applicable to this asset.", "oneOf": [ { "$ref": "#/components/schemas/ItAssetsAssetIdPatchResponsesContentApplicationJsonSchemaDataActionsStoreOwnAssetAtDeelForLocalDetails" }, { "type": "null" } ] }, "disabled_reasons": { "description": "Reasons why the action is disabled. Empty when the action is enabled or not applicable", "items": { "$ref": "#/components/schemas/ItAssetsAssetIdPatchResponsesContentApplicationJsonSchemaDataActionsStoreOwnAssetAtDeelForLocalDisabledReasonsItems" }, "type": "array" }, "status": { "$ref": "#/components/schemas/ItAssetsAssetIdPatchResponsesContentApplicationJsonSchemaDataActionsStoreOwnAssetAtDeelForLocalStatus", "description": "Whether the action is currently available for this asset" } }, "required": [ "status", "details", "disabled_reasons" ], "title": "ItAssetsAssetIdPatchResponsesContentApplicationJsonSchemaDataActionsStoreOwnAssetAtDeelForLocal", "type": "object" }, "ItAssetsAssetIdPatchResponsesContentApplicationJsonSchemaDataActionsStoreOwnAssetAtDeelForLocalDetails": { "description": "Action-specific context needed to perform the action. Populated for enabled and\ndisabled actions (so callers can see what a successful attempt would look like);\nnull when the action is not applicable to this asset.", "properties": { "activation_cost": { "$ref": "#/components/schemas/ItAssetsAssetIdPatchResponsesContentApplicationJsonSchemaDataActionsStoreOwnAssetAtDeelForLocalDetailsActivationCost", "description": "Cost charged to activate storage" }, "destination_country": { "$ref": "#/components/schemas/ItAssetsAssetIdPatchResponsesContentApplicationJsonSchemaDataActionsStoreOwnAssetAtDeelForLocalDetailsDestinationCountry", "description": "ISO 3166-1 alpha-2 country of the Deel warehouse the asset will be shipped to" }, "grace_period_in_months": { "description": "Grace period in months during which storage is free before monthly fees apply", "format": "int64", "type": "integer" }, "monthly_fee": { "$ref": "#/components/schemas/ItAssetsAssetIdPatchResponsesContentApplicationJsonSchemaDataActionsStoreOwnAssetAtDeelForLocalDetailsMonthlyFee", "description": "Monthly storage fee charged after the grace period" } }, "required": [ "monthly_fee", "activation_cost", "destination_country", "grace_period_in_months" ], "title": "ItAssetsAssetIdPatchResponsesContentApplicationJsonSchemaDataActionsStoreOwnAssetAtDeelForLocalDetails", "type": "object" }, "ItAssetsAssetIdPatchResponsesContentApplicationJsonSchemaDataActionsStoreOwnAssetAtDeelForLocalDetailsActivationCost": { "description": "Cost charged to activate storage", "properties": { "billing_method": { "$ref": "#/components/schemas/ItAssetsAssetIdPatchResponsesContentApplicationJsonSchemaDataActionsStoreOwnAssetAtDeelForLocalDetailsActivationCostBillingMethod", "description": "How the action is charged. When \"TOKEN\", the fees are covered by an\nadd-on token pool; when \"CURRENCY\", the fees are billed in the currency\nspecified in the \"fees\" field." }, "fees": { "description": "Price charged for the action. Null when billing method is \"TOKEN\"", "oneOf": [ { "$ref": "#/components/schemas/ItAssetsAssetIdPatchResponsesContentApplicationJsonSchemaDataActionsStoreOwnAssetAtDeelForLocalDetailsActivationCostFees" }, { "type": "null" } ] }, "token_usage": { "description": "Add-on token consumption details. Null when billing method is \"CURRENCY\"", "oneOf": [ { "$ref": "#/components/schemas/ItAssetsAssetIdPatchResponsesContentApplicationJsonSchemaDataActionsStoreOwnAssetAtDeelForLocalDetailsActivationCostTokenUsage" }, { "type": "null" } ] } }, "required": [ "fees", "token_usage", "billing_method" ], "title": "ItAssetsAssetIdPatchResponsesContentApplicationJsonSchemaDataActionsStoreOwnAssetAtDeelForLocalDetailsActivationCost", "type": "object" }, "ItAssetsAssetIdPatchResponsesContentApplicationJsonSchemaDataActionsStoreOwnAssetAtDeelForLocalDetailsActivationCostBillingMethod": { "description": "How the action is charged. When \"TOKEN\", the fees are covered by an\nadd-on token pool; when \"CURRENCY\", the fees are billed in the currency\nspecified in the \"fees\" field.", "enum": [ "CURRENCY", "TOKEN" ], "title": "ItAssetsAssetIdPatchResponsesContentApplicationJsonSchemaDataActionsStoreOwnAssetAtDeelForLocalDetailsActivationCostBillingMethod", "type": "string" }, "ItAssetsAssetIdPatchResponsesContentApplicationJsonSchemaDataActionsStoreOwnAssetAtDeelForLocalDetailsActivationCostFees": { "description": "Price charged for the action. Null when billing method is \"TOKEN\"", "properties": { "amount": { "description": "Amount", "format": "decimal", "type": "string" }, "currency": { "$ref": "#/components/schemas/ItAssetsAssetIdPatchResponsesContentApplicationJsonSchemaDataActionsStoreOwnAssetAtDeelForLocalDetailsActivationCostFeesCurrency", "description": "Three-letter currency code for the price" } }, "required": [ "amount", "currency" ], "title": "ItAssetsAssetIdPatchResponsesContentApplicationJsonSchemaDataActionsStoreOwnAssetAtDeelForLocalDetailsActivationCostFees", "type": "object" }, "ItAssetsAssetIdPatchResponsesContentApplicationJsonSchemaDataActionsStoreOwnAssetAtDeelForLocalDetailsActivationCostFeesCurrency": { "description": "Three-letter currency code for the price", "enum": [ "AED", "AFN", "ALL", "AMD", "ANG", "AOA", "ARS", "AUD", "AWG", "AZN", "BAM", "BDT", "BGN", "BHD", "BIF", "BMD", "BOB", "BRL", "BSD", "BTN", "BWP", "BYN", "BZD", "CAD", "CDF", "CHF", "CLP", "CNY", "COP", "CRC", "CUC", "CVE", "CZK", "DJF", "DKK", "DOP", "DZD", "EGP", "ERN", "ETB", "EUR", "FJD", "FKP", "GBP", "GEL", "GHS", "GIP", "GMD", "GNF", "GTQ", "GYD", "HKD", "HNL", "HRK", "HTG", "HUF", "IDR", "ILS", "INR", "IQD", "IRR", "ISK", "JMD", "JOD", "JPY", "KES", "KGS", "KHR", "KMF", "KPW", "KRW", "KWD", "KYD", "KZT", "LAK", "LBP", "LKR", "LRD", "LSL", "LTL", "LYD", "MAD", "MDL", "MGA", "MKD", "MMK", "MNT", "MRU", "MUR", "MVR", "MWK", "MXN", "MYR", "MZN", "NAD", "NGN", "NIO", "NOK", "NPR", "NZD", "OMR", "PAB", "PEN", "PGK", "PHP", "PKR", "PLN", "PYG", "QAR", "RON", "RSD", "RUB", "RWF", "SAR", "SBD", "SCR", "SDG", "SEK", "SGD", "SHP", "SLL", "SOS", "SRD", "SSP", "STD", "SYP", "SZL", "THB", "TJS", "TMT", "TND", "TOP", "TRY", "TTD", "TWD", "TZS", "UAH", "UGX", "USD", "UYU", "UZS", "VEF", "VND", "VUV", "WST", "XAF", "XCD", "XOF", "XPF", "YER", "ZAR", "ZMW", "ZWD" ], "title": "ItAssetsAssetIdPatchResponsesContentApplicationJsonSchemaDataActionsStoreOwnAssetAtDeelForLocalDetailsActivationCostFeesCurrency", "type": "string" }, "ItAssetsAssetIdPatchResponsesContentApplicationJsonSchemaDataActionsStoreOwnAssetAtDeelForLocalDetailsActivationCostTokenUsage": { "description": "Add-on token consumption details. Null when billing method is \"CURRENCY\"", "properties": { "addon": { "$ref": "#/components/schemas/ItAssetsAssetIdPatchResponsesContentApplicationJsonSchemaDataActionsStoreOwnAssetAtDeelForLocalDetailsActivationCostTokenUsageAddon", "description": "The add-on that provides the tokens" }, "cost": { "description": "Number of tokens consumed by the action. Zero when the add-on covers the\nservice without drawing from a token pool", "format": "decimal", "type": "string" }, "tokens_left": { "description": "Number of tokens left in the pool after the action is performed. Null when\nthe add-on covers the service without a token pool", "format": "decimal", "type": [ "string", "null" ] } }, "required": [ "cost", "addon", "tokens_left" ], "title": "ItAssetsAssetIdPatchResponsesContentApplicationJsonSchemaDataActionsStoreOwnAssetAtDeelForLocalDetailsActivationCostTokenUsage", "type": "object" }, "ItAssetsAssetIdPatchResponsesContentApplicationJsonSchemaDataActionsStoreOwnAssetAtDeelForLocalDetailsActivationCostTokenUsageAddon": { "description": "The add-on that provides the tokens", "properties": { "id": { "description": "ID of the add-on", "format": "uuid", "type": "string" }, "name": { "description": "Public display name of the add-on", "type": "string" } }, "required": [ "id", "name" ], "title": "ItAssetsAssetIdPatchResponsesContentApplicationJsonSchemaDataActionsStoreOwnAssetAtDeelForLocalDetailsActivationCostTokenUsageAddon", "type": "object" }, "ItAssetsAssetIdPatchResponsesContentApplicationJsonSchemaDataActionsStoreOwnAssetAtDeelForLocalDetailsDestinationCountry": { "description": "ISO 3166-1 alpha-2 country of the Deel warehouse the asset will be shipped to", "enum": [ "AD", "AE", "AF", "AG", "AI", "AL", "AM", "AN", "AO", "AQ", "AR", "AS", "AT", "AU", "AW", "AX", "AZ", "BA", "BB", "BD", "BE", "BF", "BG", "BH", "BI", "BJ", "BL", "BM", "BN", "BO", "BQ", "BR", "BS", "BT", "BV", "BW", "BY", "BZ", "CA", "CC", "CD", "CF", "CG", "CH", "CI", "CK", "CL", "CM", "CN", "CO", "CR", "CU", "CV", "CW", "CX", "CY", "CZ", "DE", "DJ", "DK", "DM", "DO", "DZ", "EC", "EE", "EG", "EH", "ER", "ES", "ET", "FI", "FJ", "FK", "FM", "FO", "FR", "GA", "GB", "GD", "GE", "GF", "GG", "GH", "GI", "GL", "GM", "GN", "GP", "GQ", "GR", "GS", "GT", "GU", "GW", "GY", "HK", "HM", "HN", "HR", "HT", "HU", "IC", "ID", "IE", "IL", "IM", "IN", "IO", "IQ", "IR", "IS", "IT", "JE", "JM", "JO", "JP", "KE", "KG", "KH", "KI", "KM", "KN", "KP", "KR", "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", "XK", "YE", "YT", "ZA", "ZM", "ZW" ], "title": "ItAssetsAssetIdPatchResponsesContentApplicationJsonSchemaDataActionsStoreOwnAssetAtDeelForLocalDetailsDestinationCountry", "type": "string" }, "ItAssetsAssetIdPatchResponsesContentApplicationJsonSchemaDataActionsStoreOwnAssetAtDeelForLocalDetailsMonthlyFee": { "description": "Monthly storage fee charged after the grace period", "properties": { "amount": { "description": "Amount", "format": "decimal", "type": "string" }, "currency": { "$ref": "#/components/schemas/ItAssetsAssetIdPatchResponsesContentApplicationJsonSchemaDataActionsStoreOwnAssetAtDeelForLocalDetailsMonthlyFeeCurrency", "description": "Three-letter currency code for the price" } }, "required": [ "amount", "currency" ], "title": "ItAssetsAssetIdPatchResponsesContentApplicationJsonSchemaDataActionsStoreOwnAssetAtDeelForLocalDetailsMonthlyFee", "type": "object" }, "ItAssetsAssetIdPatchResponsesContentApplicationJsonSchemaDataActionsStoreOwnAssetAtDeelForLocalDetailsMonthlyFeeCurrency": { "description": "Three-letter currency code for the price", "enum": [ "AED", "AFN", "ALL", "AMD", "ANG", "AOA", "ARS", "AUD", "AWG", "AZN", "BAM", "BDT", "BGN", "BHD", "BIF", "BMD", "BOB", "BRL", "BSD", "BTN", "BWP", "BYN", "BZD", "CAD", "CDF", "CHF", "CLP", "CNY", "COP", "CRC", "CUC", "CVE", "CZK", "DJF", "DKK", "DOP", "DZD", "EGP", "ERN", "ETB", "EUR", "FJD", "FKP", "GBP", "GEL", "GHS", "GIP", "GMD", "GNF", "GTQ", "GYD", "HKD", "HNL", "HRK", "HTG", "HUF", "IDR", "ILS", "INR", "IQD", "IRR", "ISK", "JMD", "JOD", "JPY", "KES", "KGS", "KHR", "KMF", "KPW", "KRW", "KWD", "KYD", "KZT", "LAK", "LBP", "LKR", "LRD", "LSL", "LTL", "LYD", "MAD", "MDL", "MGA", "MKD", "MMK", "MNT", "MRU", "MUR", "MVR", "MWK", "MXN", "MYR", "MZN", "NAD", "NGN", "NIO", "NOK", "NPR", "NZD", "OMR", "PAB", "PEN", "PGK", "PHP", "PKR", "PLN", "PYG", "QAR", "RON", "RSD", "RUB", "RWF", "SAR", "SBD", "SCR", "SDG", "SEK", "SGD", "SHP", "SLL", "SOS", "SRD", "SSP", "STD", "SYP", "SZL", "THB", "TJS", "TMT", "TND", "TOP", "TRY", "TTD", "TWD", "TZS", "UAH", "UGX", "USD", "UYU", "UZS", "VEF", "VND", "VUV", "WST", "XAF", "XCD", "XOF", "XPF", "YER", "ZAR", "ZMW", "ZWD" ], "title": "ItAssetsAssetIdPatchResponsesContentApplicationJsonSchemaDataActionsStoreOwnAssetAtDeelForLocalDetailsMonthlyFeeCurrency", "type": "string" }, "ItAssetsAssetIdPatchResponsesContentApplicationJsonSchemaDataActionsStoreOwnAssetAtDeelForLocalDisabledReasonsItems": { "enum": [ "ARCHIVED", "AT_DEEL_WAREHOUSE", "BEING_REPAIRED", "CONSUMABLE", "CONTROLLED_BY_DEEL", "COUNTRY_NOT_SUPPORTED_FOR_HUB", "COUNTRY_NOT_SUPPORTED_FOR_LOCAL", "DEEL_OWNED_ITEM_WITHOUT_RENTAL_CONTRACT", "DESKTOP_STORAGE", "ENDING_CONTRACT", "HUB_IN_SAME_REGION_AS_LOCAL", "INACTIVE", "INVALID_ITEM_LOCATION", "INVALID_ORGANIZATION_STATUS", "INVALID_STATE", "ITEM_CONDITIONS_TO_UNARCHIVE_NOT_MET", "ITEM_NOT_VISIBLE_FOR_ORGANIZATION", "NON_DEVICE", "NOT_AT_WAREHOUSE", "NOT_AVAILABLE_FOR_REUSE", "NOT_A_RENTAL", "NOT_MANAGEABLE_BY_ORGANIZATION", "NOT_WITH_ASSIGNMENT", "NOT_WITH_USER", "NO_ACTIVE_ADDONS", "NO_ACTIVE_STORAGE_CONTRACT", "NO_LOCATION_FOR_STORAGE", "NO_LOGISTICS_FOR_STORAGE", "NO_VALID_ADDONS", "ONGOING_SERVICE", "OWNED_BY_DEEL", "OWNED_BY_ORGANIZATION", "OWNED_BY_PARTNER_ORGANIZATION", "PARTNER_CHILD_CONTRACT", "PENDING_DEVICE_REFRESH", "RENTAL_CONTRACT_AND_USER_REGION_DO_NOT_MATCH", "TEMPORARILY_UNAVAILABLE", "UNKNOWN", "USER_HAS_NO_COUNTRY", "USER_HAS_NO_SEAT", "WAITING_FOR_CLEARANCE", "WITH_LOANER_ASSIGNMENT", "WITH_NON_COLLECTED_ASSIGNMENT", "WITH_NON_DELIVERED_ASSIGNMENT", "WITH_PENDING_ASSIGNMENT", "WRONG_ASSIGNMENT_STATUS", "WRONG_CONTRACT_STATUS", "WRONG_TERMS_AND_CONDITIONS" ], "title": "ItAssetsAssetIdPatchResponsesContentApplicationJsonSchemaDataActionsStoreOwnAssetAtDeelForLocalDisabledReasonsItems", "type": "string" }, "ItAssetsAssetIdPatchResponsesContentApplicationJsonSchemaDataActionsStoreOwnAssetAtDeelForLocalStatus": { "description": "Whether the action is currently available for this asset", "enum": [ "DISABLED", "ENABLED", "NOT_APPLICABLE" ], "title": "ItAssetsAssetIdPatchResponsesContentApplicationJsonSchemaDataActionsStoreOwnAssetAtDeelForLocalStatus", "type": "string" }, "ItAssetsAssetIdPatchResponsesContentApplicationJsonSchemaDataActionsStoreOwnAssetAtOwnLocation": { "description": "Store an organization-owned asset at an organization-owned location", "properties": { "details": { "description": "Action-specific context needed to perform the action. Populated for enabled and\ndisabled actions (so callers can see what a successful attempt would look like);\nnull when the action is not applicable to this asset.", "oneOf": [ { "$ref": "#/components/schemas/ItAssetsAssetIdPatchResponsesContentApplicationJsonSchemaDataActionsStoreOwnAssetAtOwnLocationDetails" }, { "type": "null" } ] }, "disabled_reasons": { "description": "Reasons why the action is disabled. Empty when the action is enabled or not applicable", "items": { "$ref": "#/components/schemas/ItAssetsAssetIdPatchResponsesContentApplicationJsonSchemaDataActionsStoreOwnAssetAtOwnLocationDisabledReasonsItems" }, "type": "array" }, "status": { "$ref": "#/components/schemas/ItAssetsAssetIdPatchResponsesContentApplicationJsonSchemaDataActionsStoreOwnAssetAtOwnLocationStatus", "description": "Whether the action is currently available for this asset" } }, "required": [ "status", "details", "disabled_reasons" ], "title": "ItAssetsAssetIdPatchResponsesContentApplicationJsonSchemaDataActionsStoreOwnAssetAtOwnLocation", "type": "object" }, "ItAssetsAssetIdPatchResponsesContentApplicationJsonSchemaDataActionsStoreOwnAssetAtOwnLocationDetails": { "description": "Action-specific context needed to perform the action. Populated for enabled and\ndisabled actions (so callers can see what a successful attempt would look like);\nnull when the action is not applicable to this asset.", "properties": { "eligible_countries": { "description": "Countries where the asset can be stored at an organization-owned location", "items": { "$ref": "#/components/schemas/ItAssetsAssetIdPatchResponsesContentApplicationJsonSchemaDataActionsStoreOwnAssetAtOwnLocationDetailsEligibleCountriesItems" }, "type": "array" }, "service_cost": { "$ref": "#/components/schemas/ItAssetsAssetIdPatchResponsesContentApplicationJsonSchemaDataActionsStoreOwnAssetAtOwnLocationDetailsServiceCost", "description": "Cost charged for the transfer service" } }, "required": [ "service_cost", "eligible_countries" ], "title": "ItAssetsAssetIdPatchResponsesContentApplicationJsonSchemaDataActionsStoreOwnAssetAtOwnLocationDetails", "type": "object" }, "ItAssetsAssetIdPatchResponsesContentApplicationJsonSchemaDataActionsStoreOwnAssetAtOwnLocationDetailsEligibleCountriesItems": { "enum": [ "AD", "AE", "AF", "AG", "AI", "AL", "AM", "AN", "AO", "AQ", "AR", "AS", "AT", "AU", "AW", "AX", "AZ", "BA", "BB", "BD", "BE", "BF", "BG", "BH", "BI", "BJ", "BL", "BM", "BN", "BO", "BQ", "BR", "BS", "BT", "BV", "BW", "BY", "BZ", "CA", "CC", "CD", "CF", "CG", "CH", "CI", "CK", "CL", "CM", "CN", "CO", "CR", "CU", "CV", "CW", "CX", "CY", "CZ", "DE", "DJ", "DK", "DM", "DO", "DZ", "EC", "EE", "EG", "EH", "ER", "ES", "ET", "FI", "FJ", "FK", "FM", "FO", "FR", "GA", "GB", "GD", "GE", "GF", "GG", "GH", "GI", "GL", "GM", "GN", "GP", "GQ", "GR", "GS", "GT", "GU", "GW", "GY", "HK", "HM", "HN", "HR", "HT", "HU", "IC", "ID", "IE", "IL", "IM", "IN", "IO", "IQ", "IR", "IS", "IT", "JE", "JM", "JO", "JP", "KE", "KG", "KH", "KI", "KM", "KN", "KP", "KR", "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", "XK", "YE", "YT", "ZA", "ZM", "ZW" ], "title": "ItAssetsAssetIdPatchResponsesContentApplicationJsonSchemaDataActionsStoreOwnAssetAtOwnLocationDetailsEligibleCountriesItems", "type": "string" }, "ItAssetsAssetIdPatchResponsesContentApplicationJsonSchemaDataActionsStoreOwnAssetAtOwnLocationDetailsServiceCost": { "description": "Cost charged for the transfer service", "properties": { "billing_method": { "$ref": "#/components/schemas/ItAssetsAssetIdPatchResponsesContentApplicationJsonSchemaDataActionsStoreOwnAssetAtOwnLocationDetailsServiceCostBillingMethod", "description": "How the action is charged. When \"TOKEN\", the fees are covered by an\nadd-on token pool; when \"CURRENCY\", the fees are billed in the currency\nspecified in the \"fees\" field." }, "fees": { "description": "Price charged for the action. Null when billing method is \"TOKEN\"", "oneOf": [ { "$ref": "#/components/schemas/ItAssetsAssetIdPatchResponsesContentApplicationJsonSchemaDataActionsStoreOwnAssetAtOwnLocationDetailsServiceCostFees" }, { "type": "null" } ] }, "token_usage": { "description": "Add-on token consumption details. Null when billing method is \"CURRENCY\"", "oneOf": [ { "$ref": "#/components/schemas/ItAssetsAssetIdPatchResponsesContentApplicationJsonSchemaDataActionsStoreOwnAssetAtOwnLocationDetailsServiceCostTokenUsage" }, { "type": "null" } ] } }, "required": [ "fees", "token_usage", "billing_method" ], "title": "ItAssetsAssetIdPatchResponsesContentApplicationJsonSchemaDataActionsStoreOwnAssetAtOwnLocationDetailsServiceCost", "type": "object" }, "ItAssetsAssetIdPatchResponsesContentApplicationJsonSchemaDataActionsStoreOwnAssetAtOwnLocationDetailsServiceCostBillingMethod": { "description": "How the action is charged. When \"TOKEN\", the fees are covered by an\nadd-on token pool; when \"CURRENCY\", the fees are billed in the currency\nspecified in the \"fees\" field.", "enum": [ "CURRENCY", "TOKEN" ], "title": "ItAssetsAssetIdPatchResponsesContentApplicationJsonSchemaDataActionsStoreOwnAssetAtOwnLocationDetailsServiceCostBillingMethod", "type": "string" }, "ItAssetsAssetIdPatchResponsesContentApplicationJsonSchemaDataActionsStoreOwnAssetAtOwnLocationDetailsServiceCostFees": { "description": "Price charged for the action. Null when billing method is \"TOKEN\"", "properties": { "amount": { "description": "Amount", "format": "decimal", "type": "string" }, "currency": { "$ref": "#/components/schemas/ItAssetsAssetIdPatchResponsesContentApplicationJsonSchemaDataActionsStoreOwnAssetAtOwnLocationDetailsServiceCostFeesCurrency", "description": "Three-letter currency code for the price" } }, "required": [ "amount", "currency" ], "title": "ItAssetsAssetIdPatchResponsesContentApplicationJsonSchemaDataActionsStoreOwnAssetAtOwnLocationDetailsServiceCostFees", "type": "object" }, "ItAssetsAssetIdPatchResponsesContentApplicationJsonSchemaDataActionsStoreOwnAssetAtOwnLocationDetailsServiceCostFeesCurrency": { "description": "Three-letter currency code for the price", "enum": [ "AED", "AFN", "ALL", "AMD", "ANG", "AOA", "ARS", "AUD", "AWG", "AZN", "BAM", "BDT", "BGN", "BHD", "BIF", "BMD", "BOB", "BRL", "BSD", "BTN", "BWP", "BYN", "BZD", "CAD", "CDF", "CHF", "CLP", "CNY", "COP", "CRC", "CUC", "CVE", "CZK", "DJF", "DKK", "DOP", "DZD", "EGP", "ERN", "ETB", "EUR", "FJD", "FKP", "GBP", "GEL", "GHS", "GIP", "GMD", "GNF", "GTQ", "GYD", "HKD", "HNL", "HRK", "HTG", "HUF", "IDR", "ILS", "INR", "IQD", "IRR", "ISK", "JMD", "JOD", "JPY", "KES", "KGS", "KHR", "KMF", "KPW", "KRW", "KWD", "KYD", "KZT", "LAK", "LBP", "LKR", "LRD", "LSL", "LTL", "LYD", "MAD", "MDL", "MGA", "MKD", "MMK", "MNT", "MRU", "MUR", "MVR", "MWK", "MXN", "MYR", "MZN", "NAD", "NGN", "NIO", "NOK", "NPR", "NZD", "OMR", "PAB", "PEN", "PGK", "PHP", "PKR", "PLN", "PYG", "QAR", "RON", "RSD", "RUB", "RWF", "SAR", "SBD", "SCR", "SDG", "SEK", "SGD", "SHP", "SLL", "SOS", "SRD", "SSP", "STD", "SYP", "SZL", "THB", "TJS", "TMT", "TND", "TOP", "TRY", "TTD", "TWD", "TZS", "UAH", "UGX", "USD", "UYU", "UZS", "VEF", "VND", "VUV", "WST", "XAF", "XCD", "XOF", "XPF", "YER", "ZAR", "ZMW", "ZWD" ], "title": "ItAssetsAssetIdPatchResponsesContentApplicationJsonSchemaDataActionsStoreOwnAssetAtOwnLocationDetailsServiceCostFeesCurrency", "type": "string" }, "ItAssetsAssetIdPatchResponsesContentApplicationJsonSchemaDataActionsStoreOwnAssetAtOwnLocationDetailsServiceCostTokenUsage": { "description": "Add-on token consumption details. Null when billing method is \"CURRENCY\"", "properties": { "addon": { "$ref": "#/components/schemas/ItAssetsAssetIdPatchResponsesContentApplicationJsonSchemaDataActionsStoreOwnAssetAtOwnLocationDetailsServiceCostTokenUsageAddon", "description": "The add-on that provides the tokens" }, "cost": { "description": "Number of tokens consumed by the action. Zero when the add-on covers the\nservice without drawing from a token pool", "format": "decimal", "type": "string" }, "tokens_left": { "description": "Number of tokens left in the pool after the action is performed. Null when\nthe add-on covers the service without a token pool", "format": "decimal", "type": [ "string", "null" ] } }, "required": [ "cost", "addon", "tokens_left" ], "title": "ItAssetsAssetIdPatchResponsesContentApplicationJsonSchemaDataActionsStoreOwnAssetAtOwnLocationDetailsServiceCostTokenUsage", "type": "object" }, "ItAssetsAssetIdPatchResponsesContentApplicationJsonSchemaDataActionsStoreOwnAssetAtOwnLocationDetailsServiceCostTokenUsageAddon": { "description": "The add-on that provides the tokens", "properties": { "id": { "description": "ID of the add-on", "format": "uuid", "type": "string" }, "name": { "description": "Public display name of the add-on", "type": "string" } }, "required": [ "id", "name" ], "title": "ItAssetsAssetIdPatchResponsesContentApplicationJsonSchemaDataActionsStoreOwnAssetAtOwnLocationDetailsServiceCostTokenUsageAddon", "type": "object" }, "ItAssetsAssetIdPatchResponsesContentApplicationJsonSchemaDataActionsStoreOwnAssetAtOwnLocationDisabledReasonsItems": { "enum": [ "ARCHIVED", "AT_DEEL_WAREHOUSE", "BEING_REPAIRED", "CONSUMABLE", "CONTROLLED_BY_DEEL", "COUNTRY_NOT_SUPPORTED_FOR_HUB", "COUNTRY_NOT_SUPPORTED_FOR_LOCAL", "DEEL_OWNED_ITEM_WITHOUT_RENTAL_CONTRACT", "DESKTOP_STORAGE", "ENDING_CONTRACT", "HUB_IN_SAME_REGION_AS_LOCAL", "INACTIVE", "INVALID_ITEM_LOCATION", "INVALID_ORGANIZATION_STATUS", "INVALID_STATE", "ITEM_CONDITIONS_TO_UNARCHIVE_NOT_MET", "ITEM_NOT_VISIBLE_FOR_ORGANIZATION", "NON_DEVICE", "NOT_AT_WAREHOUSE", "NOT_AVAILABLE_FOR_REUSE", "NOT_A_RENTAL", "NOT_MANAGEABLE_BY_ORGANIZATION", "NOT_WITH_ASSIGNMENT", "NOT_WITH_USER", "NO_ACTIVE_ADDONS", "NO_ACTIVE_STORAGE_CONTRACT", "NO_LOCATION_FOR_STORAGE", "NO_LOGISTICS_FOR_STORAGE", "NO_VALID_ADDONS", "ONGOING_SERVICE", "OWNED_BY_DEEL", "OWNED_BY_ORGANIZATION", "OWNED_BY_PARTNER_ORGANIZATION", "PARTNER_CHILD_CONTRACT", "PENDING_DEVICE_REFRESH", "RENTAL_CONTRACT_AND_USER_REGION_DO_NOT_MATCH", "TEMPORARILY_UNAVAILABLE", "UNKNOWN", "USER_HAS_NO_COUNTRY", "USER_HAS_NO_SEAT", "WAITING_FOR_CLEARANCE", "WITH_LOANER_ASSIGNMENT", "WITH_NON_COLLECTED_ASSIGNMENT", "WITH_NON_DELIVERED_ASSIGNMENT", "WITH_PENDING_ASSIGNMENT", "WRONG_ASSIGNMENT_STATUS", "WRONG_CONTRACT_STATUS", "WRONG_TERMS_AND_CONDITIONS" ], "title": "ItAssetsAssetIdPatchResponsesContentApplicationJsonSchemaDataActionsStoreOwnAssetAtOwnLocationDisabledReasonsItems", "type": "string" }, "ItAssetsAssetIdPatchResponsesContentApplicationJsonSchemaDataActionsStoreOwnAssetAtOwnLocationStatus": { "description": "Whether the action is currently available for this asset", "enum": [ "DISABLED", "ENABLED", "NOT_APPLICABLE" ], "title": "ItAssetsAssetIdPatchResponsesContentApplicationJsonSchemaDataActionsStoreOwnAssetAtOwnLocationStatus", "type": "string" }, "ItAssetsAssetIdPatchResponsesContentApplicationJsonSchemaDataActionsStoreRentalAtDeelForLocal": { "description": "Store a Deel-owned rental asset at a Deel local warehouse", "properties": { "details": { "description": "Action-specific context needed to perform the action. Populated for enabled and\ndisabled actions (so callers can see what a successful attempt would look like);\nnull when the action is not applicable to this asset.", "oneOf": [ { "$ref": "#/components/schemas/ItAssetsAssetIdPatchResponsesContentApplicationJsonSchemaDataActionsStoreRentalAtDeelForLocalDetails" }, { "type": "null" } ] }, "disabled_reasons": { "description": "Reasons why the action is disabled. Empty when the action is enabled or not applicable", "items": { "$ref": "#/components/schemas/ItAssetsAssetIdPatchResponsesContentApplicationJsonSchemaDataActionsStoreRentalAtDeelForLocalDisabledReasonsItems" }, "type": "array" }, "status": { "$ref": "#/components/schemas/ItAssetsAssetIdPatchResponsesContentApplicationJsonSchemaDataActionsStoreRentalAtDeelForLocalStatus", "description": "Whether the action is currently available for this asset" } }, "required": [ "status", "details", "disabled_reasons" ], "title": "ItAssetsAssetIdPatchResponsesContentApplicationJsonSchemaDataActionsStoreRentalAtDeelForLocal", "type": "object" }, "ItAssetsAssetIdPatchResponsesContentApplicationJsonSchemaDataActionsStoreRentalAtDeelForLocalDetails": { "description": "Action-specific context needed to perform the action. Populated for enabled and\ndisabled actions (so callers can see what a successful attempt would look like);\nnull when the action is not applicable to this asset.", "properties": { "activation_cost": { "$ref": "#/components/schemas/ItAssetsAssetIdPatchResponsesContentApplicationJsonSchemaDataActionsStoreRentalAtDeelForLocalDetailsActivationCost", "description": "Cost charged to activate local storage" } }, "required": [ "activation_cost" ], "title": "ItAssetsAssetIdPatchResponsesContentApplicationJsonSchemaDataActionsStoreRentalAtDeelForLocalDetails", "type": "object" }, "ItAssetsAssetIdPatchResponsesContentApplicationJsonSchemaDataActionsStoreRentalAtDeelForLocalDetailsActivationCost": { "description": "Cost charged to activate local storage", "properties": { "billing_method": { "$ref": "#/components/schemas/ItAssetsAssetIdPatchResponsesContentApplicationJsonSchemaDataActionsStoreRentalAtDeelForLocalDetailsActivationCostBillingMethod", "description": "How the action is charged. When \"TOKEN\", the fees are covered by an\nadd-on token pool; when \"CURRENCY\", the fees are billed in the currency\nspecified in the \"fees\" field." }, "fees": { "description": "Price charged for the action. Null when billing method is \"TOKEN\"", "oneOf": [ { "$ref": "#/components/schemas/ItAssetsAssetIdPatchResponsesContentApplicationJsonSchemaDataActionsStoreRentalAtDeelForLocalDetailsActivationCostFees" }, { "type": "null" } ] }, "token_usage": { "description": "Add-on token consumption details. Null when billing method is \"CURRENCY\"", "oneOf": [ { "$ref": "#/components/schemas/ItAssetsAssetIdPatchResponsesContentApplicationJsonSchemaDataActionsStoreRentalAtDeelForLocalDetailsActivationCostTokenUsage" }, { "type": "null" } ] } }, "required": [ "fees", "token_usage", "billing_method" ], "title": "ItAssetsAssetIdPatchResponsesContentApplicationJsonSchemaDataActionsStoreRentalAtDeelForLocalDetailsActivationCost", "type": "object" }, "ItAssetsAssetIdPatchResponsesContentApplicationJsonSchemaDataActionsStoreRentalAtDeelForLocalDetailsActivationCostBillingMethod": { "description": "How the action is charged. When \"TOKEN\", the fees are covered by an\nadd-on token pool; when \"CURRENCY\", the fees are billed in the currency\nspecified in the \"fees\" field.", "enum": [ "CURRENCY", "TOKEN" ], "title": "ItAssetsAssetIdPatchResponsesContentApplicationJsonSchemaDataActionsStoreRentalAtDeelForLocalDetailsActivationCostBillingMethod", "type": "string" }, "ItAssetsAssetIdPatchResponsesContentApplicationJsonSchemaDataActionsStoreRentalAtDeelForLocalDetailsActivationCostFees": { "description": "Price charged for the action. Null when billing method is \"TOKEN\"", "properties": { "amount": { "description": "Amount", "format": "decimal", "type": "string" }, "currency": { "$ref": "#/components/schemas/ItAssetsAssetIdPatchResponsesContentApplicationJsonSchemaDataActionsStoreRentalAtDeelForLocalDetailsActivationCostFeesCurrency", "description": "Three-letter currency code for the price" } }, "required": [ "amount", "currency" ], "title": "ItAssetsAssetIdPatchResponsesContentApplicationJsonSchemaDataActionsStoreRentalAtDeelForLocalDetailsActivationCostFees", "type": "object" }, "ItAssetsAssetIdPatchResponsesContentApplicationJsonSchemaDataActionsStoreRentalAtDeelForLocalDetailsActivationCostFeesCurrency": { "description": "Three-letter currency code for the price", "enum": [ "AED", "AFN", "ALL", "AMD", "ANG", "AOA", "ARS", "AUD", "AWG", "AZN", "BAM", "BDT", "BGN", "BHD", "BIF", "BMD", "BOB", "BRL", "BSD", "BTN", "BWP", "BYN", "BZD", "CAD", "CDF", "CHF", "CLP", "CNY", "COP", "CRC", "CUC", "CVE", "CZK", "DJF", "DKK", "DOP", "DZD", "EGP", "ERN", "ETB", "EUR", "FJD", "FKP", "GBP", "GEL", "GHS", "GIP", "GMD", "GNF", "GTQ", "GYD", "HKD", "HNL", "HRK", "HTG", "HUF", "IDR", "ILS", "INR", "IQD", "IRR", "ISK", "JMD", "JOD", "JPY", "KES", "KGS", "KHR", "KMF", "KPW", "KRW", "KWD", "KYD", "KZT", "LAK", "LBP", "LKR", "LRD", "LSL", "LTL", "LYD", "MAD", "MDL", "MGA", "MKD", "MMK", "MNT", "MRU", "MUR", "MVR", "MWK", "MXN", "MYR", "MZN", "NAD", "NGN", "NIO", "NOK", "NPR", "NZD", "OMR", "PAB", "PEN", "PGK", "PHP", "PKR", "PLN", "PYG", "QAR", "RON", "RSD", "RUB", "RWF", "SAR", "SBD", "SCR", "SDG", "SEK", "SGD", "SHP", "SLL", "SOS", "SRD", "SSP", "STD", "SYP", "SZL", "THB", "TJS", "TMT", "TND", "TOP", "TRY", "TTD", "TWD", "TZS", "UAH", "UGX", "USD", "UYU", "UZS", "VEF", "VND", "VUV", "WST", "XAF", "XCD", "XOF", "XPF", "YER", "ZAR", "ZMW", "ZWD" ], "title": "ItAssetsAssetIdPatchResponsesContentApplicationJsonSchemaDataActionsStoreRentalAtDeelForLocalDetailsActivationCostFeesCurrency", "type": "string" }, "ItAssetsAssetIdPatchResponsesContentApplicationJsonSchemaDataActionsStoreRentalAtDeelForLocalDetailsActivationCostTokenUsage": { "description": "Add-on token consumption details. Null when billing method is \"CURRENCY\"", "properties": { "addon": { "$ref": "#/components/schemas/ItAssetsAssetIdPatchResponsesContentApplicationJsonSchemaDataActionsStoreRentalAtDeelForLocalDetailsActivationCostTokenUsageAddon", "description": "The add-on that provides the tokens" }, "cost": { "description": "Number of tokens consumed by the action. Zero when the add-on covers the\nservice without drawing from a token pool", "format": "decimal", "type": "string" }, "tokens_left": { "description": "Number of tokens left in the pool after the action is performed. Null when\nthe add-on covers the service without a token pool", "format": "decimal", "type": [ "string", "null" ] } }, "required": [ "cost", "addon", "tokens_left" ], "title": "ItAssetsAssetIdPatchResponsesContentApplicationJsonSchemaDataActionsStoreRentalAtDeelForLocalDetailsActivationCostTokenUsage", "type": "object" }, "ItAssetsAssetIdPatchResponsesContentApplicationJsonSchemaDataActionsStoreRentalAtDeelForLocalDetailsActivationCostTokenUsageAddon": { "description": "The add-on that provides the tokens", "properties": { "id": { "description": "ID of the add-on", "format": "uuid", "type": "string" }, "name": { "description": "Public display name of the add-on", "type": "string" } }, "required": [ "id", "name" ], "title": "ItAssetsAssetIdPatchResponsesContentApplicationJsonSchemaDataActionsStoreRentalAtDeelForLocalDetailsActivationCostTokenUsageAddon", "type": "object" }, "ItAssetsAssetIdPatchResponsesContentApplicationJsonSchemaDataActionsStoreRentalAtDeelForLocalDisabledReasonsItems": { "enum": [ "ARCHIVED", "AT_DEEL_WAREHOUSE", "BEING_REPAIRED", "CONSUMABLE", "CONTROLLED_BY_DEEL", "COUNTRY_NOT_SUPPORTED_FOR_HUB", "COUNTRY_NOT_SUPPORTED_FOR_LOCAL", "DEEL_OWNED_ITEM_WITHOUT_RENTAL_CONTRACT", "DESKTOP_STORAGE", "ENDING_CONTRACT", "HUB_IN_SAME_REGION_AS_LOCAL", "INACTIVE", "INVALID_ITEM_LOCATION", "INVALID_ORGANIZATION_STATUS", "INVALID_STATE", "ITEM_CONDITIONS_TO_UNARCHIVE_NOT_MET", "ITEM_NOT_VISIBLE_FOR_ORGANIZATION", "NON_DEVICE", "NOT_AT_WAREHOUSE", "NOT_AVAILABLE_FOR_REUSE", "NOT_A_RENTAL", "NOT_MANAGEABLE_BY_ORGANIZATION", "NOT_WITH_ASSIGNMENT", "NOT_WITH_USER", "NO_ACTIVE_ADDONS", "NO_ACTIVE_STORAGE_CONTRACT", "NO_LOCATION_FOR_STORAGE", "NO_LOGISTICS_FOR_STORAGE", "NO_VALID_ADDONS", "ONGOING_SERVICE", "OWNED_BY_DEEL", "OWNED_BY_ORGANIZATION", "OWNED_BY_PARTNER_ORGANIZATION", "PARTNER_CHILD_CONTRACT", "PENDING_DEVICE_REFRESH", "RENTAL_CONTRACT_AND_USER_REGION_DO_NOT_MATCH", "TEMPORARILY_UNAVAILABLE", "UNKNOWN", "USER_HAS_NO_COUNTRY", "USER_HAS_NO_SEAT", "WAITING_FOR_CLEARANCE", "WITH_LOANER_ASSIGNMENT", "WITH_NON_COLLECTED_ASSIGNMENT", "WITH_NON_DELIVERED_ASSIGNMENT", "WITH_PENDING_ASSIGNMENT", "WRONG_ASSIGNMENT_STATUS", "WRONG_CONTRACT_STATUS", "WRONG_TERMS_AND_CONDITIONS" ], "title": "ItAssetsAssetIdPatchResponsesContentApplicationJsonSchemaDataActionsStoreRentalAtDeelForLocalDisabledReasonsItems", "type": "string" }, "ItAssetsAssetIdPatchResponsesContentApplicationJsonSchemaDataActionsStoreRentalAtDeelForLocalStatus": { "description": "Whether the action is currently available for this asset", "enum": [ "DISABLED", "ENABLED", "NOT_APPLICABLE" ], "title": "ItAssetsAssetIdPatchResponsesContentApplicationJsonSchemaDataActionsStoreRentalAtDeelForLocalStatus", "type": "string" }, "ItAssetsAssetIdPatchResponsesContentApplicationJsonSchemaDataActionsStoreRentalAtDeelForZone1": { "description": "Store a Deel-owned rental asset at a Deel zone-1 warehouse", "properties": { "details": { "description": "Action-specific context needed to perform the action. Populated for enabled and\ndisabled actions (so callers can see what a successful attempt would look like);\nnull when the action is not applicable to this asset.", "oneOf": [ { "$ref": "#/components/schemas/ItAssetsAssetIdPatchResponsesContentApplicationJsonSchemaDataActionsStoreRentalAtDeelForZone1Details" }, { "type": "null" } ] }, "disabled_reasons": { "description": "Reasons why the action is disabled. Empty when the action is enabled or not applicable", "items": { "$ref": "#/components/schemas/ItAssetsAssetIdPatchResponsesContentApplicationJsonSchemaDataActionsStoreRentalAtDeelForZone1DisabledReasonsItems" }, "type": "array" }, "status": { "$ref": "#/components/schemas/ItAssetsAssetIdPatchResponsesContentApplicationJsonSchemaDataActionsStoreRentalAtDeelForZone1Status", "description": "Whether the action is currently available for this asset" } }, "required": [ "status", "details", "disabled_reasons" ], "title": "ItAssetsAssetIdPatchResponsesContentApplicationJsonSchemaDataActionsStoreRentalAtDeelForZone1", "type": "object" }, "ItAssetsAssetIdPatchResponsesContentApplicationJsonSchemaDataActionsStoreRentalAtDeelForZone1Details": { "description": "Action-specific context needed to perform the action. Populated for enabled and\ndisabled actions (so callers can see what a successful attempt would look like);\nnull when the action is not applicable to this asset.", "properties": { "activation_cost": { "$ref": "#/components/schemas/ItAssetsAssetIdPatchResponsesContentApplicationJsonSchemaDataActionsStoreRentalAtDeelForZone1DetailsActivationCost", "description": "Cost charged to activate zone-1 storage" } }, "required": [ "activation_cost" ], "title": "ItAssetsAssetIdPatchResponsesContentApplicationJsonSchemaDataActionsStoreRentalAtDeelForZone1Details", "type": "object" }, "ItAssetsAssetIdPatchResponsesContentApplicationJsonSchemaDataActionsStoreRentalAtDeelForZone1DetailsActivationCost": { "description": "Cost charged to activate zone-1 storage", "properties": { "billing_method": { "$ref": "#/components/schemas/ItAssetsAssetIdPatchResponsesContentApplicationJsonSchemaDataActionsStoreRentalAtDeelForZone1DetailsActivationCostBillingMethod", "description": "How the action is charged. When \"TOKEN\", the fees are covered by an\nadd-on token pool; when \"CURRENCY\", the fees are billed in the currency\nspecified in the \"fees\" field." }, "fees": { "description": "Price charged for the action. Null when billing method is \"TOKEN\"", "oneOf": [ { "$ref": "#/components/schemas/ItAssetsAssetIdPatchResponsesContentApplicationJsonSchemaDataActionsStoreRentalAtDeelForZone1DetailsActivationCostFees" }, { "type": "null" } ] }, "token_usage": { "description": "Add-on token consumption details. Null when billing method is \"CURRENCY\"", "oneOf": [ { "$ref": "#/components/schemas/ItAssetsAssetIdPatchResponsesContentApplicationJsonSchemaDataActionsStoreRentalAtDeelForZone1DetailsActivationCostTokenUsage" }, { "type": "null" } ] } }, "required": [ "fees", "token_usage", "billing_method" ], "title": "ItAssetsAssetIdPatchResponsesContentApplicationJsonSchemaDataActionsStoreRentalAtDeelForZone1DetailsActivationCost", "type": "object" }, "ItAssetsAssetIdPatchResponsesContentApplicationJsonSchemaDataActionsStoreRentalAtDeelForZone1DetailsActivationCostBillingMethod": { "description": "How the action is charged. When \"TOKEN\", the fees are covered by an\nadd-on token pool; when \"CURRENCY\", the fees are billed in the currency\nspecified in the \"fees\" field.", "enum": [ "CURRENCY", "TOKEN" ], "title": "ItAssetsAssetIdPatchResponsesContentApplicationJsonSchemaDataActionsStoreRentalAtDeelForZone1DetailsActivationCostBillingMethod", "type": "string" }, "ItAssetsAssetIdPatchResponsesContentApplicationJsonSchemaDataActionsStoreRentalAtDeelForZone1DetailsActivationCostFees": { "description": "Price charged for the action. Null when billing method is \"TOKEN\"", "properties": { "amount": { "description": "Amount", "format": "decimal", "type": "string" }, "currency": { "$ref": "#/components/schemas/ItAssetsAssetIdPatchResponsesContentApplicationJsonSchemaDataActionsStoreRentalAtDeelForZone1DetailsActivationCostFeesCurrency", "description": "Three-letter currency code for the price" } }, "required": [ "amount", "currency" ], "title": "ItAssetsAssetIdPatchResponsesContentApplicationJsonSchemaDataActionsStoreRentalAtDeelForZone1DetailsActivationCostFees", "type": "object" }, "ItAssetsAssetIdPatchResponsesContentApplicationJsonSchemaDataActionsStoreRentalAtDeelForZone1DetailsActivationCostFeesCurrency": { "description": "Three-letter currency code for the price", "enum": [ "AED", "AFN", "ALL", "AMD", "ANG", "AOA", "ARS", "AUD", "AWG", "AZN", "BAM", "BDT", "BGN", "BHD", "BIF", "BMD", "BOB", "BRL", "BSD", "BTN", "BWP", "BYN", "BZD", "CAD", "CDF", "CHF", "CLP", "CNY", "COP", "CRC", "CUC", "CVE", "CZK", "DJF", "DKK", "DOP", "DZD", "EGP", "ERN", "ETB", "EUR", "FJD", "FKP", "GBP", "GEL", "GHS", "GIP", "GMD", "GNF", "GTQ", "GYD", "HKD", "HNL", "HRK", "HTG", "HUF", "IDR", "ILS", "INR", "IQD", "IRR", "ISK", "JMD", "JOD", "JPY", "KES", "KGS", "KHR", "KMF", "KPW", "KRW", "KWD", "KYD", "KZT", "LAK", "LBP", "LKR", "LRD", "LSL", "LTL", "LYD", "MAD", "MDL", "MGA", "MKD", "MMK", "MNT", "MRU", "MUR", "MVR", "MWK", "MXN", "MYR", "MZN", "NAD", "NGN", "NIO", "NOK", "NPR", "NZD", "OMR", "PAB", "PEN", "PGK", "PHP", "PKR", "PLN", "PYG", "QAR", "RON", "RSD", "RUB", "RWF", "SAR", "SBD", "SCR", "SDG", "SEK", "SGD", "SHP", "SLL", "SOS", "SRD", "SSP", "STD", "SYP", "SZL", "THB", "TJS", "TMT", "TND", "TOP", "TRY", "TTD", "TWD", "TZS", "UAH", "UGX", "USD", "UYU", "UZS", "VEF", "VND", "VUV", "WST", "XAF", "XCD", "XOF", "XPF", "YER", "ZAR", "ZMW", "ZWD" ], "title": "ItAssetsAssetIdPatchResponsesContentApplicationJsonSchemaDataActionsStoreRentalAtDeelForZone1DetailsActivationCostFeesCurrency", "type": "string" }, "ItAssetsAssetIdPatchResponsesContentApplicationJsonSchemaDataActionsStoreRentalAtDeelForZone1DetailsActivationCostTokenUsage": { "description": "Add-on token consumption details. Null when billing method is \"CURRENCY\"", "properties": { "addon": { "$ref": "#/components/schemas/ItAssetsAssetIdPatchResponsesContentApplicationJsonSchemaDataActionsStoreRentalAtDeelForZone1DetailsActivationCostTokenUsageAddon", "description": "The add-on that provides the tokens" }, "cost": { "description": "Number of tokens consumed by the action. Zero when the add-on covers the\nservice without drawing from a token pool", "format": "decimal", "type": "string" }, "tokens_left": { "description": "Number of tokens left in the pool after the action is performed. Null when\nthe add-on covers the service without a token pool", "format": "decimal", "type": [ "string", "null" ] } }, "required": [ "cost", "addon", "tokens_left" ], "title": "ItAssetsAssetIdPatchResponsesContentApplicationJsonSchemaDataActionsStoreRentalAtDeelForZone1DetailsActivationCostTokenUsage", "type": "object" }, "ItAssetsAssetIdPatchResponsesContentApplicationJsonSchemaDataActionsStoreRentalAtDeelForZone1DetailsActivationCostTokenUsageAddon": { "description": "The add-on that provides the tokens", "properties": { "id": { "description": "ID of the add-on", "format": "uuid", "type": "string" }, "name": { "description": "Public display name of the add-on", "type": "string" } }, "required": [ "id", "name" ], "title": "ItAssetsAssetIdPatchResponsesContentApplicationJsonSchemaDataActionsStoreRentalAtDeelForZone1DetailsActivationCostTokenUsageAddon", "type": "object" }, "ItAssetsAssetIdPatchResponsesContentApplicationJsonSchemaDataActionsStoreRentalAtDeelForZone1DisabledReasonsItems": { "enum": [ "ARCHIVED", "AT_DEEL_WAREHOUSE", "BEING_REPAIRED", "CONSUMABLE", "CONTROLLED_BY_DEEL", "COUNTRY_NOT_SUPPORTED_FOR_HUB", "COUNTRY_NOT_SUPPORTED_FOR_LOCAL", "DEEL_OWNED_ITEM_WITHOUT_RENTAL_CONTRACT", "DESKTOP_STORAGE", "ENDING_CONTRACT", "HUB_IN_SAME_REGION_AS_LOCAL", "INACTIVE", "INVALID_ITEM_LOCATION", "INVALID_ORGANIZATION_STATUS", "INVALID_STATE", "ITEM_CONDITIONS_TO_UNARCHIVE_NOT_MET", "ITEM_NOT_VISIBLE_FOR_ORGANIZATION", "NON_DEVICE", "NOT_AT_WAREHOUSE", "NOT_AVAILABLE_FOR_REUSE", "NOT_A_RENTAL", "NOT_MANAGEABLE_BY_ORGANIZATION", "NOT_WITH_ASSIGNMENT", "NOT_WITH_USER", "NO_ACTIVE_ADDONS", "NO_ACTIVE_STORAGE_CONTRACT", "NO_LOCATION_FOR_STORAGE", "NO_LOGISTICS_FOR_STORAGE", "NO_VALID_ADDONS", "ONGOING_SERVICE", "OWNED_BY_DEEL", "OWNED_BY_ORGANIZATION", "OWNED_BY_PARTNER_ORGANIZATION", "PARTNER_CHILD_CONTRACT", "PENDING_DEVICE_REFRESH", "RENTAL_CONTRACT_AND_USER_REGION_DO_NOT_MATCH", "TEMPORARILY_UNAVAILABLE", "UNKNOWN", "USER_HAS_NO_COUNTRY", "USER_HAS_NO_SEAT", "WAITING_FOR_CLEARANCE", "WITH_LOANER_ASSIGNMENT", "WITH_NON_COLLECTED_ASSIGNMENT", "WITH_NON_DELIVERED_ASSIGNMENT", "WITH_PENDING_ASSIGNMENT", "WRONG_ASSIGNMENT_STATUS", "WRONG_CONTRACT_STATUS", "WRONG_TERMS_AND_CONDITIONS" ], "title": "ItAssetsAssetIdPatchResponsesContentApplicationJsonSchemaDataActionsStoreRentalAtDeelForZone1DisabledReasonsItems", "type": "string" }, "ItAssetsAssetIdPatchResponsesContentApplicationJsonSchemaDataActionsStoreRentalAtDeelForZone1Status": { "description": "Whether the action is currently available for this asset", "enum": [ "DISABLED", "ENABLED", "NOT_APPLICABLE" ], "title": "ItAssetsAssetIdPatchResponsesContentApplicationJsonSchemaDataActionsStoreRentalAtDeelForZone1Status", "type": "string" }, "ItAssetsAssetIdPatchResponsesContentApplicationJsonSchemaDataActionsTransferOwnAsset": { "description": "Transfer an organization-owned asset to another user", "properties": { "details": { "description": "Action-specific context needed to perform the action. Populated for enabled and\ndisabled actions (so callers can see what a successful attempt would look like);\nnull when the action is not applicable to this asset.", "oneOf": [ { "$ref": "#/components/schemas/ItAssetsAssetIdPatchResponsesContentApplicationJsonSchemaDataActionsTransferOwnAssetDetails" }, { "type": "null" } ] }, "disabled_reasons": { "description": "Reasons why the action is disabled. Empty when the action is enabled or not applicable", "items": { "$ref": "#/components/schemas/ItAssetsAssetIdPatchResponsesContentApplicationJsonSchemaDataActionsTransferOwnAssetDisabledReasonsItems" }, "type": "array" }, "status": { "$ref": "#/components/schemas/ItAssetsAssetIdPatchResponsesContentApplicationJsonSchemaDataActionsTransferOwnAssetStatus", "description": "Whether the action is currently available for this asset" } }, "required": [ "status", "details", "disabled_reasons" ], "title": "ItAssetsAssetIdPatchResponsesContentApplicationJsonSchemaDataActionsTransferOwnAsset", "type": "object" }, "ItAssetsAssetIdPatchResponsesContentApplicationJsonSchemaDataActionsTransferOwnAssetDetails": { "description": "Action-specific context needed to perform the action. Populated for enabled and\ndisabled actions (so callers can see what a successful attempt would look like);\nnull when the action is not applicable to this asset.", "properties": { "eligible_countries": { "description": "Countries the asset can be transferred to", "items": { "$ref": "#/components/schemas/ItAssetsAssetIdPatchResponsesContentApplicationJsonSchemaDataActionsTransferOwnAssetDetailsEligibleCountriesItems" }, "type": "array" }, "transfer_cost": { "$ref": "#/components/schemas/ItAssetsAssetIdPatchResponsesContentApplicationJsonSchemaDataActionsTransferOwnAssetDetailsTransferCost", "description": "Cost charged for the transfer service" } }, "required": [ "transfer_cost", "eligible_countries" ], "title": "ItAssetsAssetIdPatchResponsesContentApplicationJsonSchemaDataActionsTransferOwnAssetDetails", "type": "object" }, "ItAssetsAssetIdPatchResponsesContentApplicationJsonSchemaDataActionsTransferOwnAssetDetailsEligibleCountriesItems": { "enum": [ "AD", "AE", "AF", "AG", "AI", "AL", "AM", "AN", "AO", "AQ", "AR", "AS", "AT", "AU", "AW", "AX", "AZ", "BA", "BB", "BD", "BE", "BF", "BG", "BH", "BI", "BJ", "BL", "BM", "BN", "BO", "BQ", "BR", "BS", "BT", "BV", "BW", "BY", "BZ", "CA", "CC", "CD", "CF", "CG", "CH", "CI", "CK", "CL", "CM", "CN", "CO", "CR", "CU", "CV", "CW", "CX", "CY", "CZ", "DE", "DJ", "DK", "DM", "DO", "DZ", "EC", "EE", "EG", "EH", "ER", "ES", "ET", "FI", "FJ", "FK", "FM", "FO", "FR", "GA", "GB", "GD", "GE", "GF", "GG", "GH", "GI", "GL", "GM", "GN", "GP", "GQ", "GR", "GS", "GT", "GU", "GW", "GY", "HK", "HM", "HN", "HR", "HT", "HU", "IC", "ID", "IE", "IL", "IM", "IN", "IO", "IQ", "IR", "IS", "IT", "JE", "JM", "JO", "JP", "KE", "KG", "KH", "KI", "KM", "KN", "KP", "KR", "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", "XK", "YE", "YT", "ZA", "ZM", "ZW" ], "title": "ItAssetsAssetIdPatchResponsesContentApplicationJsonSchemaDataActionsTransferOwnAssetDetailsEligibleCountriesItems", "type": "string" }, "ItAssetsAssetIdPatchResponsesContentApplicationJsonSchemaDataActionsTransferOwnAssetDetailsTransferCost": { "description": "Cost charged for the transfer service", "properties": { "billing_method": { "$ref": "#/components/schemas/ItAssetsAssetIdPatchResponsesContentApplicationJsonSchemaDataActionsTransferOwnAssetDetailsTransferCostBillingMethod", "description": "How the action is charged. When \"TOKEN\", the fees are covered by an\nadd-on token pool; when \"CURRENCY\", the fees are billed in the currency\nspecified in the \"fees\" field." }, "fees": { "description": "Price charged for the action. Null when billing method is \"TOKEN\"", "oneOf": [ { "$ref": "#/components/schemas/ItAssetsAssetIdPatchResponsesContentApplicationJsonSchemaDataActionsTransferOwnAssetDetailsTransferCostFees" }, { "type": "null" } ] }, "token_usage": { "description": "Add-on token consumption details. Null when billing method is \"CURRENCY\"", "oneOf": [ { "$ref": "#/components/schemas/ItAssetsAssetIdPatchResponsesContentApplicationJsonSchemaDataActionsTransferOwnAssetDetailsTransferCostTokenUsage" }, { "type": "null" } ] } }, "required": [ "fees", "token_usage", "billing_method" ], "title": "ItAssetsAssetIdPatchResponsesContentApplicationJsonSchemaDataActionsTransferOwnAssetDetailsTransferCost", "type": "object" }, "ItAssetsAssetIdPatchResponsesContentApplicationJsonSchemaDataActionsTransferOwnAssetDetailsTransferCostBillingMethod": { "description": "How the action is charged. When \"TOKEN\", the fees are covered by an\nadd-on token pool; when \"CURRENCY\", the fees are billed in the currency\nspecified in the \"fees\" field.", "enum": [ "CURRENCY", "TOKEN" ], "title": "ItAssetsAssetIdPatchResponsesContentApplicationJsonSchemaDataActionsTransferOwnAssetDetailsTransferCostBillingMethod", "type": "string" }, "ItAssetsAssetIdPatchResponsesContentApplicationJsonSchemaDataActionsTransferOwnAssetDetailsTransferCostFees": { "description": "Price charged for the action. Null when billing method is \"TOKEN\"", "properties": { "amount": { "description": "Amount", "format": "decimal", "type": "string" }, "currency": { "$ref": "#/components/schemas/ItAssetsAssetIdPatchResponsesContentApplicationJsonSchemaDataActionsTransferOwnAssetDetailsTransferCostFeesCurrency", "description": "Three-letter currency code for the price" } }, "required": [ "amount", "currency" ], "title": "ItAssetsAssetIdPatchResponsesContentApplicationJsonSchemaDataActionsTransferOwnAssetDetailsTransferCostFees", "type": "object" }, "ItAssetsAssetIdPatchResponsesContentApplicationJsonSchemaDataActionsTransferOwnAssetDetailsTransferCostFeesCurrency": { "description": "Three-letter currency code for the price", "enum": [ "AED", "AFN", "ALL", "AMD", "ANG", "AOA", "ARS", "AUD", "AWG", "AZN", "BAM", "BDT", "BGN", "BHD", "BIF", "BMD", "BOB", "BRL", "BSD", "BTN", "BWP", "BYN", "BZD", "CAD", "CDF", "CHF", "CLP", "CNY", "COP", "CRC", "CUC", "CVE", "CZK", "DJF", "DKK", "DOP", "DZD", "EGP", "ERN", "ETB", "EUR", "FJD", "FKP", "GBP", "GEL", "GHS", "GIP", "GMD", "GNF", "GTQ", "GYD", "HKD", "HNL", "HRK", "HTG", "HUF", "IDR", "ILS", "INR", "IQD", "IRR", "ISK", "JMD", "JOD", "JPY", "KES", "KGS", "KHR", "KMF", "KPW", "KRW", "KWD", "KYD", "KZT", "LAK", "LBP", "LKR", "LRD", "LSL", "LTL", "LYD", "MAD", "MDL", "MGA", "MKD", "MMK", "MNT", "MRU", "MUR", "MVR", "MWK", "MXN", "MYR", "MZN", "NAD", "NGN", "NIO", "NOK", "NPR", "NZD", "OMR", "PAB", "PEN", "PGK", "PHP", "PKR", "PLN", "PYG", "QAR", "RON", "RSD", "RUB", "RWF", "SAR", "SBD", "SCR", "SDG", "SEK", "SGD", "SHP", "SLL", "SOS", "SRD", "SSP", "STD", "SYP", "SZL", "THB", "TJS", "TMT", "TND", "TOP", "TRY", "TTD", "TWD", "TZS", "UAH", "UGX", "USD", "UYU", "UZS", "VEF", "VND", "VUV", "WST", "XAF", "XCD", "XOF", "XPF", "YER", "ZAR", "ZMW", "ZWD" ], "title": "ItAssetsAssetIdPatchResponsesContentApplicationJsonSchemaDataActionsTransferOwnAssetDetailsTransferCostFeesCurrency", "type": "string" }, "ItAssetsAssetIdPatchResponsesContentApplicationJsonSchemaDataActionsTransferOwnAssetDetailsTransferCostTokenUsage": { "description": "Add-on token consumption details. Null when billing method is \"CURRENCY\"", "properties": { "addon": { "$ref": "#/components/schemas/ItAssetsAssetIdPatchResponsesContentApplicationJsonSchemaDataActionsTransferOwnAssetDetailsTransferCostTokenUsageAddon", "description": "The add-on that provides the tokens" }, "cost": { "description": "Number of tokens consumed by the action. Zero when the add-on covers the\nservice without drawing from a token pool", "format": "decimal", "type": "string" }, "tokens_left": { "description": "Number of tokens left in the pool after the action is performed. Null when\nthe add-on covers the service without a token pool", "format": "decimal", "type": [ "string", "null" ] } }, "required": [ "cost", "addon", "tokens_left" ], "title": "ItAssetsAssetIdPatchResponsesContentApplicationJsonSchemaDataActionsTransferOwnAssetDetailsTransferCostTokenUsage", "type": "object" }, "ItAssetsAssetIdPatchResponsesContentApplicationJsonSchemaDataActionsTransferOwnAssetDetailsTransferCostTokenUsageAddon": { "description": "The add-on that provides the tokens", "properties": { "id": { "description": "ID of the add-on", "format": "uuid", "type": "string" }, "name": { "description": "Public display name of the add-on", "type": "string" } }, "required": [ "id", "name" ], "title": "ItAssetsAssetIdPatchResponsesContentApplicationJsonSchemaDataActionsTransferOwnAssetDetailsTransferCostTokenUsageAddon", "type": "object" }, "ItAssetsAssetIdPatchResponsesContentApplicationJsonSchemaDataActionsTransferOwnAssetDisabledReasonsItems": { "enum": [ "ARCHIVED", "AT_DEEL_WAREHOUSE", "BEING_REPAIRED", "CONSUMABLE", "CONTROLLED_BY_DEEL", "COUNTRY_NOT_SUPPORTED_FOR_HUB", "COUNTRY_NOT_SUPPORTED_FOR_LOCAL", "DEEL_OWNED_ITEM_WITHOUT_RENTAL_CONTRACT", "DESKTOP_STORAGE", "ENDING_CONTRACT", "HUB_IN_SAME_REGION_AS_LOCAL", "INACTIVE", "INVALID_ITEM_LOCATION", "INVALID_ORGANIZATION_STATUS", "INVALID_STATE", "ITEM_CONDITIONS_TO_UNARCHIVE_NOT_MET", "ITEM_NOT_VISIBLE_FOR_ORGANIZATION", "NON_DEVICE", "NOT_AT_WAREHOUSE", "NOT_AVAILABLE_FOR_REUSE", "NOT_A_RENTAL", "NOT_MANAGEABLE_BY_ORGANIZATION", "NOT_WITH_ASSIGNMENT", "NOT_WITH_USER", "NO_ACTIVE_ADDONS", "NO_ACTIVE_STORAGE_CONTRACT", "NO_LOCATION_FOR_STORAGE", "NO_LOGISTICS_FOR_STORAGE", "NO_VALID_ADDONS", "ONGOING_SERVICE", "OWNED_BY_DEEL", "OWNED_BY_ORGANIZATION", "OWNED_BY_PARTNER_ORGANIZATION", "PARTNER_CHILD_CONTRACT", "PENDING_DEVICE_REFRESH", "RENTAL_CONTRACT_AND_USER_REGION_DO_NOT_MATCH", "TEMPORARILY_UNAVAILABLE", "UNKNOWN", "USER_HAS_NO_COUNTRY", "USER_HAS_NO_SEAT", "WAITING_FOR_CLEARANCE", "WITH_LOANER_ASSIGNMENT", "WITH_NON_COLLECTED_ASSIGNMENT", "WITH_NON_DELIVERED_ASSIGNMENT", "WITH_PENDING_ASSIGNMENT", "WRONG_ASSIGNMENT_STATUS", "WRONG_CONTRACT_STATUS", "WRONG_TERMS_AND_CONDITIONS" ], "title": "ItAssetsAssetIdPatchResponsesContentApplicationJsonSchemaDataActionsTransferOwnAssetDisabledReasonsItems", "type": "string" }, "ItAssetsAssetIdPatchResponsesContentApplicationJsonSchemaDataActionsTransferOwnAssetStatus": { "description": "Whether the action is currently available for this asset", "enum": [ "DISABLED", "ENABLED", "NOT_APPLICABLE" ], "title": "ItAssetsAssetIdPatchResponsesContentApplicationJsonSchemaDataActionsTransferOwnAssetStatus", "type": "string" }, "ItAssetsAssetIdPatchResponsesContentApplicationJsonSchemaDataActionsTransferRental": { "description": "Transfer a Deel-owned rental asset to another user", "properties": { "details": { "description": "Action-specific context needed to perform the action. Populated for enabled and\ndisabled actions (so callers can see what a successful attempt would look like);\nnull when the action is not applicable to this asset.", "oneOf": [ { "$ref": "#/components/schemas/ItAssetsAssetIdPatchResponsesContentApplicationJsonSchemaDataActionsTransferRentalDetails" }, { "type": "null" } ] }, "disabled_reasons": { "description": "Reasons why the action is disabled. Empty when the action is enabled or not applicable", "items": { "$ref": "#/components/schemas/ItAssetsAssetIdPatchResponsesContentApplicationJsonSchemaDataActionsTransferRentalDisabledReasonsItems" }, "type": "array" }, "status": { "$ref": "#/components/schemas/ItAssetsAssetIdPatchResponsesContentApplicationJsonSchemaDataActionsTransferRentalStatus", "description": "Whether the action is currently available for this asset" } }, "required": [ "status", "details", "disabled_reasons" ], "title": "ItAssetsAssetIdPatchResponsesContentApplicationJsonSchemaDataActionsTransferRental", "type": "object" }, "ItAssetsAssetIdPatchResponsesContentApplicationJsonSchemaDataActionsTransferRentalDetails": { "description": "Action-specific context needed to perform the action. Populated for enabled and\ndisabled actions (so callers can see what a successful attempt would look like);\nnull when the action is not applicable to this asset.", "properties": { "eligible_countries": { "description": "Countries the asset can be transferred to", "items": { "$ref": "#/components/schemas/ItAssetsAssetIdPatchResponsesContentApplicationJsonSchemaDataActionsTransferRentalDetailsEligibleCountriesItems" }, "type": "array" }, "transfer_cost": { "$ref": "#/components/schemas/ItAssetsAssetIdPatchResponsesContentApplicationJsonSchemaDataActionsTransferRentalDetailsTransferCost", "description": "Cost charged for the transfer service" } }, "required": [ "transfer_cost", "eligible_countries" ], "title": "ItAssetsAssetIdPatchResponsesContentApplicationJsonSchemaDataActionsTransferRentalDetails", "type": "object" }, "ItAssetsAssetIdPatchResponsesContentApplicationJsonSchemaDataActionsTransferRentalDetailsEligibleCountriesItems": { "enum": [ "AD", "AE", "AF", "AG", "AI", "AL", "AM", "AN", "AO", "AQ", "AR", "AS", "AT", "AU", "AW", "AX", "AZ", "BA", "BB", "BD", "BE", "BF", "BG", "BH", "BI", "BJ", "BL", "BM", "BN", "BO", "BQ", "BR", "BS", "BT", "BV", "BW", "BY", "BZ", "CA", "CC", "CD", "CF", "CG", "CH", "CI", "CK", "CL", "CM", "CN", "CO", "CR", "CU", "CV", "CW", "CX", "CY", "CZ", "DE", "DJ", "DK", "DM", "DO", "DZ", "EC", "EE", "EG", "EH", "ER", "ES", "ET", "FI", "FJ", "FK", "FM", "FO", "FR", "GA", "GB", "GD", "GE", "GF", "GG", "GH", "GI", "GL", "GM", "GN", "GP", "GQ", "GR", "GS", "GT", "GU", "GW", "GY", "HK", "HM", "HN", "HR", "HT", "HU", "IC", "ID", "IE", "IL", "IM", "IN", "IO", "IQ", "IR", "IS", "IT", "JE", "JM", "JO", "JP", "KE", "KG", "KH", "KI", "KM", "KN", "KP", "KR", "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", "XK", "YE", "YT", "ZA", "ZM", "ZW" ], "title": "ItAssetsAssetIdPatchResponsesContentApplicationJsonSchemaDataActionsTransferRentalDetailsEligibleCountriesItems", "type": "string" }, "ItAssetsAssetIdPatchResponsesContentApplicationJsonSchemaDataActionsTransferRentalDetailsTransferCost": { "description": "Cost charged for the transfer service", "properties": { "billing_method": { "$ref": "#/components/schemas/ItAssetsAssetIdPatchResponsesContentApplicationJsonSchemaDataActionsTransferRentalDetailsTransferCostBillingMethod", "description": "How the action is charged. When \"TOKEN\", the fees are covered by an\nadd-on token pool; when \"CURRENCY\", the fees are billed in the currency\nspecified in the \"fees\" field." }, "fees": { "description": "Price charged for the action. Null when billing method is \"TOKEN\"", "oneOf": [ { "$ref": "#/components/schemas/ItAssetsAssetIdPatchResponsesContentApplicationJsonSchemaDataActionsTransferRentalDetailsTransferCostFees" }, { "type": "null" } ] }, "token_usage": { "description": "Add-on token consumption details. Null when billing method is \"CURRENCY\"", "oneOf": [ { "$ref": "#/components/schemas/ItAssetsAssetIdPatchResponsesContentApplicationJsonSchemaDataActionsTransferRentalDetailsTransferCostTokenUsage" }, { "type": "null" } ] } }, "required": [ "fees", "token_usage", "billing_method" ], "title": "ItAssetsAssetIdPatchResponsesContentApplicationJsonSchemaDataActionsTransferRentalDetailsTransferCost", "type": "object" }, "ItAssetsAssetIdPatchResponsesContentApplicationJsonSchemaDataActionsTransferRentalDetailsTransferCostBillingMethod": { "description": "How the action is charged. When \"TOKEN\", the fees are covered by an\nadd-on token pool; when \"CURRENCY\", the fees are billed in the currency\nspecified in the \"fees\" field.", "enum": [ "CURRENCY", "TOKEN" ], "title": "ItAssetsAssetIdPatchResponsesContentApplicationJsonSchemaDataActionsTransferRentalDetailsTransferCostBillingMethod", "type": "string" }, "ItAssetsAssetIdPatchResponsesContentApplicationJsonSchemaDataActionsTransferRentalDetailsTransferCostFees": { "description": "Price charged for the action. Null when billing method is \"TOKEN\"", "properties": { "amount": { "description": "Amount", "format": "decimal", "type": "string" }, "currency": { "$ref": "#/components/schemas/ItAssetsAssetIdPatchResponsesContentApplicationJsonSchemaDataActionsTransferRentalDetailsTransferCostFeesCurrency", "description": "Three-letter currency code for the price" } }, "required": [ "amount", "currency" ], "title": "ItAssetsAssetIdPatchResponsesContentApplicationJsonSchemaDataActionsTransferRentalDetailsTransferCostFees", "type": "object" }, "ItAssetsAssetIdPatchResponsesContentApplicationJsonSchemaDataActionsTransferRentalDetailsTransferCostFeesCurrency": { "description": "Three-letter currency code for the price", "enum": [ "AED", "AFN", "ALL", "AMD", "ANG", "AOA", "ARS", "AUD", "AWG", "AZN", "BAM", "BDT", "BGN", "BHD", "BIF", "BMD", "BOB", "BRL", "BSD", "BTN", "BWP", "BYN", "BZD", "CAD", "CDF", "CHF", "CLP", "CNY", "COP", "CRC", "CUC", "CVE", "CZK", "DJF", "DKK", "DOP", "DZD", "EGP", "ERN", "ETB", "EUR", "FJD", "FKP", "GBP", "GEL", "GHS", "GIP", "GMD", "GNF", "GTQ", "GYD", "HKD", "HNL", "HRK", "HTG", "HUF", "IDR", "ILS", "INR", "IQD", "IRR", "ISK", "JMD", "JOD", "JPY", "KES", "KGS", "KHR", "KMF", "KPW", "KRW", "KWD", "KYD", "KZT", "LAK", "LBP", "LKR", "LRD", "LSL", "LTL", "LYD", "MAD", "MDL", "MGA", "MKD", "MMK", "MNT", "MRU", "MUR", "MVR", "MWK", "MXN", "MYR", "MZN", "NAD", "NGN", "NIO", "NOK", "NPR", "NZD", "OMR", "PAB", "PEN", "PGK", "PHP", "PKR", "PLN", "PYG", "QAR", "RON", "RSD", "RUB", "RWF", "SAR", "SBD", "SCR", "SDG", "SEK", "SGD", "SHP", "SLL", "SOS", "SRD", "SSP", "STD", "SYP", "SZL", "THB", "TJS", "TMT", "TND", "TOP", "TRY", "TTD", "TWD", "TZS", "UAH", "UGX", "USD", "UYU", "UZS", "VEF", "VND", "VUV", "WST", "XAF", "XCD", "XOF", "XPF", "YER", "ZAR", "ZMW", "ZWD" ], "title": "ItAssetsAssetIdPatchResponsesContentApplicationJsonSchemaDataActionsTransferRentalDetailsTransferCostFeesCurrency", "type": "string" }, "ItAssetsAssetIdPatchResponsesContentApplicationJsonSchemaDataActionsTransferRentalDetailsTransferCostTokenUsage": { "description": "Add-on token consumption details. Null when billing method is \"CURRENCY\"", "properties": { "addon": { "$ref": "#/components/schemas/ItAssetsAssetIdPatchResponsesContentApplicationJsonSchemaDataActionsTransferRentalDetailsTransferCostTokenUsageAddon", "description": "The add-on that provides the tokens" }, "cost": { "description": "Number of tokens consumed by the action. Zero when the add-on covers the\nservice without drawing from a token pool", "format": "decimal", "type": "string" }, "tokens_left": { "description": "Number of tokens left in the pool after the action is performed. Null when\nthe add-on covers the service without a token pool", "format": "decimal", "type": [ "string", "null" ] } }, "required": [ "cost", "addon", "tokens_left" ], "title": "ItAssetsAssetIdPatchResponsesContentApplicationJsonSchemaDataActionsTransferRentalDetailsTransferCostTokenUsage", "type": "object" }, "ItAssetsAssetIdPatchResponsesContentApplicationJsonSchemaDataActionsTransferRentalDetailsTransferCostTokenUsageAddon": { "description": "The add-on that provides the tokens", "properties": { "id": { "description": "ID of the add-on", "format": "uuid", "type": "string" }, "name": { "description": "Public display name of the add-on", "type": "string" } }, "required": [ "id", "name" ], "title": "ItAssetsAssetIdPatchResponsesContentApplicationJsonSchemaDataActionsTransferRentalDetailsTransferCostTokenUsageAddon", "type": "object" }, "ItAssetsAssetIdPatchResponsesContentApplicationJsonSchemaDataActionsTransferRentalDisabledReasonsItems": { "enum": [ "ARCHIVED", "AT_DEEL_WAREHOUSE", "BEING_REPAIRED", "CONSUMABLE", "CONTROLLED_BY_DEEL", "COUNTRY_NOT_SUPPORTED_FOR_HUB", "COUNTRY_NOT_SUPPORTED_FOR_LOCAL", "DEEL_OWNED_ITEM_WITHOUT_RENTAL_CONTRACT", "DESKTOP_STORAGE", "ENDING_CONTRACT", "HUB_IN_SAME_REGION_AS_LOCAL", "INACTIVE", "INVALID_ITEM_LOCATION", "INVALID_ORGANIZATION_STATUS", "INVALID_STATE", "ITEM_CONDITIONS_TO_UNARCHIVE_NOT_MET", "ITEM_NOT_VISIBLE_FOR_ORGANIZATION", "NON_DEVICE", "NOT_AT_WAREHOUSE", "NOT_AVAILABLE_FOR_REUSE", "NOT_A_RENTAL", "NOT_MANAGEABLE_BY_ORGANIZATION", "NOT_WITH_ASSIGNMENT", "NOT_WITH_USER", "NO_ACTIVE_ADDONS", "NO_ACTIVE_STORAGE_CONTRACT", "NO_LOCATION_FOR_STORAGE", "NO_LOGISTICS_FOR_STORAGE", "NO_VALID_ADDONS", "ONGOING_SERVICE", "OWNED_BY_DEEL", "OWNED_BY_ORGANIZATION", "OWNED_BY_PARTNER_ORGANIZATION", "PARTNER_CHILD_CONTRACT", "PENDING_DEVICE_REFRESH", "RENTAL_CONTRACT_AND_USER_REGION_DO_NOT_MATCH", "TEMPORARILY_UNAVAILABLE", "UNKNOWN", "USER_HAS_NO_COUNTRY", "USER_HAS_NO_SEAT", "WAITING_FOR_CLEARANCE", "WITH_LOANER_ASSIGNMENT", "WITH_NON_COLLECTED_ASSIGNMENT", "WITH_NON_DELIVERED_ASSIGNMENT", "WITH_PENDING_ASSIGNMENT", "WRONG_ASSIGNMENT_STATUS", "WRONG_CONTRACT_STATUS", "WRONG_TERMS_AND_CONDITIONS" ], "title": "ItAssetsAssetIdPatchResponsesContentApplicationJsonSchemaDataActionsTransferRentalDisabledReasonsItems", "type": "string" }, "ItAssetsAssetIdPatchResponsesContentApplicationJsonSchemaDataActionsTransferRentalStatus": { "description": "Whether the action is currently available for this asset", "enum": [ "DISABLED", "ENABLED", "NOT_APPLICABLE" ], "title": "ItAssetsAssetIdPatchResponsesContentApplicationJsonSchemaDataActionsTransferRentalStatus", "type": "string" }, "ItAssetsAssetIdPatchResponsesContentApplicationJsonSchemaDataActionsUnarchiveOwnAsset": { "description": "Unarchive a previously archived organization-owned asset", "properties": { "disabled_reasons": { "description": "Reasons why the action is disabled. Empty when the action is enabled or not applicable", "items": { "$ref": "#/components/schemas/ItAssetsAssetIdPatchResponsesContentApplicationJsonSchemaDataActionsUnarchiveOwnAssetDisabledReasonsItems" }, "type": "array" }, "status": { "$ref": "#/components/schemas/ItAssetsAssetIdPatchResponsesContentApplicationJsonSchemaDataActionsUnarchiveOwnAssetStatus", "description": "Whether the action is currently available for this asset" } }, "required": [ "status", "disabled_reasons" ], "title": "ItAssetsAssetIdPatchResponsesContentApplicationJsonSchemaDataActionsUnarchiveOwnAsset", "type": "object" }, "ItAssetsAssetIdPatchResponsesContentApplicationJsonSchemaDataActionsUnarchiveOwnAssetDisabledReasonsItems": { "enum": [ "ARCHIVED", "AT_DEEL_WAREHOUSE", "BEING_REPAIRED", "CONSUMABLE", "CONTROLLED_BY_DEEL", "COUNTRY_NOT_SUPPORTED_FOR_HUB", "COUNTRY_NOT_SUPPORTED_FOR_LOCAL", "DEEL_OWNED_ITEM_WITHOUT_RENTAL_CONTRACT", "DESKTOP_STORAGE", "ENDING_CONTRACT", "HUB_IN_SAME_REGION_AS_LOCAL", "INACTIVE", "INVALID_ITEM_LOCATION", "INVALID_ORGANIZATION_STATUS", "INVALID_STATE", "ITEM_CONDITIONS_TO_UNARCHIVE_NOT_MET", "ITEM_NOT_VISIBLE_FOR_ORGANIZATION", "NON_DEVICE", "NOT_AT_WAREHOUSE", "NOT_AVAILABLE_FOR_REUSE", "NOT_A_RENTAL", "NOT_MANAGEABLE_BY_ORGANIZATION", "NOT_WITH_ASSIGNMENT", "NOT_WITH_USER", "NO_ACTIVE_ADDONS", "NO_ACTIVE_STORAGE_CONTRACT", "NO_LOCATION_FOR_STORAGE", "NO_LOGISTICS_FOR_STORAGE", "NO_VALID_ADDONS", "ONGOING_SERVICE", "OWNED_BY_DEEL", "OWNED_BY_ORGANIZATION", "OWNED_BY_PARTNER_ORGANIZATION", "PARTNER_CHILD_CONTRACT", "PENDING_DEVICE_REFRESH", "RENTAL_CONTRACT_AND_USER_REGION_DO_NOT_MATCH", "TEMPORARILY_UNAVAILABLE", "UNKNOWN", "USER_HAS_NO_COUNTRY", "USER_HAS_NO_SEAT", "WAITING_FOR_CLEARANCE", "WITH_LOANER_ASSIGNMENT", "WITH_NON_COLLECTED_ASSIGNMENT", "WITH_NON_DELIVERED_ASSIGNMENT", "WITH_PENDING_ASSIGNMENT", "WRONG_ASSIGNMENT_STATUS", "WRONG_CONTRACT_STATUS", "WRONG_TERMS_AND_CONDITIONS" ], "title": "ItAssetsAssetIdPatchResponsesContentApplicationJsonSchemaDataActionsUnarchiveOwnAssetDisabledReasonsItems", "type": "string" }, "ItAssetsAssetIdPatchResponsesContentApplicationJsonSchemaDataActionsUnarchiveOwnAssetStatus": { "description": "Whether the action is currently available for this asset", "enum": [ "DISABLED", "ENABLED", "NOT_APPLICABLE" ], "title": "ItAssetsAssetIdPatchResponsesContentApplicationJsonSchemaDataActionsUnarchiveOwnAssetStatus", "type": "string" }, "ItAssetsAssetIdPatchResponsesContentApplicationJsonSchemaDataActionsUpdateLocationLocationToUser": { "description": "Update the location of an asset from a warehouse to a user", "properties": { "disabled_reasons": { "description": "Reasons why the action is disabled. Empty when the action is enabled or not applicable", "items": { "$ref": "#/components/schemas/ItAssetsAssetIdPatchResponsesContentApplicationJsonSchemaDataActionsUpdateLocationLocationToUserDisabledReasonsItems" }, "type": "array" }, "status": { "$ref": "#/components/schemas/ItAssetsAssetIdPatchResponsesContentApplicationJsonSchemaDataActionsUpdateLocationLocationToUserStatus", "description": "Whether the action is currently available for this asset" } }, "required": [ "status", "disabled_reasons" ], "title": "ItAssetsAssetIdPatchResponsesContentApplicationJsonSchemaDataActionsUpdateLocationLocationToUser", "type": "object" }, "ItAssetsAssetIdPatchResponsesContentApplicationJsonSchemaDataActionsUpdateLocationLocationToUserDisabledReasonsItems": { "enum": [ "ARCHIVED", "AT_DEEL_WAREHOUSE", "BEING_REPAIRED", "CONSUMABLE", "CONTROLLED_BY_DEEL", "COUNTRY_NOT_SUPPORTED_FOR_HUB", "COUNTRY_NOT_SUPPORTED_FOR_LOCAL", "DEEL_OWNED_ITEM_WITHOUT_RENTAL_CONTRACT", "DESKTOP_STORAGE", "ENDING_CONTRACT", "HUB_IN_SAME_REGION_AS_LOCAL", "INACTIVE", "INVALID_ITEM_LOCATION", "INVALID_ORGANIZATION_STATUS", "INVALID_STATE", "ITEM_CONDITIONS_TO_UNARCHIVE_NOT_MET", "ITEM_NOT_VISIBLE_FOR_ORGANIZATION", "NON_DEVICE", "NOT_AT_WAREHOUSE", "NOT_AVAILABLE_FOR_REUSE", "NOT_A_RENTAL", "NOT_MANAGEABLE_BY_ORGANIZATION", "NOT_WITH_ASSIGNMENT", "NOT_WITH_USER", "NO_ACTIVE_ADDONS", "NO_ACTIVE_STORAGE_CONTRACT", "NO_LOCATION_FOR_STORAGE", "NO_LOGISTICS_FOR_STORAGE", "NO_VALID_ADDONS", "ONGOING_SERVICE", "OWNED_BY_DEEL", "OWNED_BY_ORGANIZATION", "OWNED_BY_PARTNER_ORGANIZATION", "PARTNER_CHILD_CONTRACT", "PENDING_DEVICE_REFRESH", "RENTAL_CONTRACT_AND_USER_REGION_DO_NOT_MATCH", "TEMPORARILY_UNAVAILABLE", "UNKNOWN", "USER_HAS_NO_COUNTRY", "USER_HAS_NO_SEAT", "WAITING_FOR_CLEARANCE", "WITH_LOANER_ASSIGNMENT", "WITH_NON_COLLECTED_ASSIGNMENT", "WITH_NON_DELIVERED_ASSIGNMENT", "WITH_PENDING_ASSIGNMENT", "WRONG_ASSIGNMENT_STATUS", "WRONG_CONTRACT_STATUS", "WRONG_TERMS_AND_CONDITIONS" ], "title": "ItAssetsAssetIdPatchResponsesContentApplicationJsonSchemaDataActionsUpdateLocationLocationToUserDisabledReasonsItems", "type": "string" }, "ItAssetsAssetIdPatchResponsesContentApplicationJsonSchemaDataActionsUpdateLocationLocationToUserStatus": { "description": "Whether the action is currently available for this asset", "enum": [ "DISABLED", "ENABLED", "NOT_APPLICABLE" ], "title": "ItAssetsAssetIdPatchResponsesContentApplicationJsonSchemaDataActionsUpdateLocationLocationToUserStatus", "type": "string" }, "ItAssetsAssetIdPatchResponsesContentApplicationJsonSchemaDataActionsUpdateLocationUserToLocation": { "description": "Update the location of an asset from a user to a warehouse", "properties": { "disabled_reasons": { "description": "Reasons why the action is disabled. Empty when the action is enabled or not applicable", "items": { "$ref": "#/components/schemas/ItAssetsAssetIdPatchResponsesContentApplicationJsonSchemaDataActionsUpdateLocationUserToLocationDisabledReasonsItems" }, "type": "array" }, "status": { "$ref": "#/components/schemas/ItAssetsAssetIdPatchResponsesContentApplicationJsonSchemaDataActionsUpdateLocationUserToLocationStatus", "description": "Whether the action is currently available for this asset" } }, "required": [ "status", "disabled_reasons" ], "title": "ItAssetsAssetIdPatchResponsesContentApplicationJsonSchemaDataActionsUpdateLocationUserToLocation", "type": "object" }, "ItAssetsAssetIdPatchResponsesContentApplicationJsonSchemaDataActionsUpdateLocationUserToLocationDisabledReasonsItems": { "enum": [ "ARCHIVED", "AT_DEEL_WAREHOUSE", "BEING_REPAIRED", "CONSUMABLE", "CONTROLLED_BY_DEEL", "COUNTRY_NOT_SUPPORTED_FOR_HUB", "COUNTRY_NOT_SUPPORTED_FOR_LOCAL", "DEEL_OWNED_ITEM_WITHOUT_RENTAL_CONTRACT", "DESKTOP_STORAGE", "ENDING_CONTRACT", "HUB_IN_SAME_REGION_AS_LOCAL", "INACTIVE", "INVALID_ITEM_LOCATION", "INVALID_ORGANIZATION_STATUS", "INVALID_STATE", "ITEM_CONDITIONS_TO_UNARCHIVE_NOT_MET", "ITEM_NOT_VISIBLE_FOR_ORGANIZATION", "NON_DEVICE", "NOT_AT_WAREHOUSE", "NOT_AVAILABLE_FOR_REUSE", "NOT_A_RENTAL", "NOT_MANAGEABLE_BY_ORGANIZATION", "NOT_WITH_ASSIGNMENT", "NOT_WITH_USER", "NO_ACTIVE_ADDONS", "NO_ACTIVE_STORAGE_CONTRACT", "NO_LOCATION_FOR_STORAGE", "NO_LOGISTICS_FOR_STORAGE", "NO_VALID_ADDONS", "ONGOING_SERVICE", "OWNED_BY_DEEL", "OWNED_BY_ORGANIZATION", "OWNED_BY_PARTNER_ORGANIZATION", "PARTNER_CHILD_CONTRACT", "PENDING_DEVICE_REFRESH", "RENTAL_CONTRACT_AND_USER_REGION_DO_NOT_MATCH", "TEMPORARILY_UNAVAILABLE", "UNKNOWN", "USER_HAS_NO_COUNTRY", "USER_HAS_NO_SEAT", "WAITING_FOR_CLEARANCE", "WITH_LOANER_ASSIGNMENT", "WITH_NON_COLLECTED_ASSIGNMENT", "WITH_NON_DELIVERED_ASSIGNMENT", "WITH_PENDING_ASSIGNMENT", "WRONG_ASSIGNMENT_STATUS", "WRONG_CONTRACT_STATUS", "WRONG_TERMS_AND_CONDITIONS" ], "title": "ItAssetsAssetIdPatchResponsesContentApplicationJsonSchemaDataActionsUpdateLocationUserToLocationDisabledReasonsItems", "type": "string" }, "ItAssetsAssetIdPatchResponsesContentApplicationJsonSchemaDataActionsUpdateLocationUserToLocationStatus": { "description": "Whether the action is currently available for this asset", "enum": [ "DISABLED", "ENABLED", "NOT_APPLICABLE" ], "title": "ItAssetsAssetIdPatchResponsesContentApplicationJsonSchemaDataActionsUpdateLocationUserToLocationStatus", "type": "string" }, "ItAssetsAssetIdPatchResponsesContentApplicationJsonSchemaDataActionsUpdateLocationUserToUser": { "description": "Update the assigned user of an asset that is currently with a user", "properties": { "disabled_reasons": { "description": "Reasons why the action is disabled. Empty when the action is enabled or not applicable", "items": { "$ref": "#/components/schemas/ItAssetsAssetIdPatchResponsesContentApplicationJsonSchemaDataActionsUpdateLocationUserToUserDisabledReasonsItems" }, "type": "array" }, "status": { "$ref": "#/components/schemas/ItAssetsAssetIdPatchResponsesContentApplicationJsonSchemaDataActionsUpdateLocationUserToUserStatus", "description": "Whether the action is currently available for this asset" } }, "required": [ "status", "disabled_reasons" ], "title": "ItAssetsAssetIdPatchResponsesContentApplicationJsonSchemaDataActionsUpdateLocationUserToUser", "type": "object" }, "ItAssetsAssetIdPatchResponsesContentApplicationJsonSchemaDataActionsUpdateLocationUserToUserDisabledReasonsItems": { "enum": [ "ARCHIVED", "AT_DEEL_WAREHOUSE", "BEING_REPAIRED", "CONSUMABLE", "CONTROLLED_BY_DEEL", "COUNTRY_NOT_SUPPORTED_FOR_HUB", "COUNTRY_NOT_SUPPORTED_FOR_LOCAL", "DEEL_OWNED_ITEM_WITHOUT_RENTAL_CONTRACT", "DESKTOP_STORAGE", "ENDING_CONTRACT", "HUB_IN_SAME_REGION_AS_LOCAL", "INACTIVE", "INVALID_ITEM_LOCATION", "INVALID_ORGANIZATION_STATUS", "INVALID_STATE", "ITEM_CONDITIONS_TO_UNARCHIVE_NOT_MET", "ITEM_NOT_VISIBLE_FOR_ORGANIZATION", "NON_DEVICE", "NOT_AT_WAREHOUSE", "NOT_AVAILABLE_FOR_REUSE", "NOT_A_RENTAL", "NOT_MANAGEABLE_BY_ORGANIZATION", "NOT_WITH_ASSIGNMENT", "NOT_WITH_USER", "NO_ACTIVE_ADDONS", "NO_ACTIVE_STORAGE_CONTRACT", "NO_LOCATION_FOR_STORAGE", "NO_LOGISTICS_FOR_STORAGE", "NO_VALID_ADDONS", "ONGOING_SERVICE", "OWNED_BY_DEEL", "OWNED_BY_ORGANIZATION", "OWNED_BY_PARTNER_ORGANIZATION", "PARTNER_CHILD_CONTRACT", "PENDING_DEVICE_REFRESH", "RENTAL_CONTRACT_AND_USER_REGION_DO_NOT_MATCH", "TEMPORARILY_UNAVAILABLE", "UNKNOWN", "USER_HAS_NO_COUNTRY", "USER_HAS_NO_SEAT", "WAITING_FOR_CLEARANCE", "WITH_LOANER_ASSIGNMENT", "WITH_NON_COLLECTED_ASSIGNMENT", "WITH_NON_DELIVERED_ASSIGNMENT", "WITH_PENDING_ASSIGNMENT", "WRONG_ASSIGNMENT_STATUS", "WRONG_CONTRACT_STATUS", "WRONG_TERMS_AND_CONDITIONS" ], "title": "ItAssetsAssetIdPatchResponsesContentApplicationJsonSchemaDataActionsUpdateLocationUserToUserDisabledReasonsItems", "type": "string" }, "ItAssetsAssetIdPatchResponsesContentApplicationJsonSchemaDataActionsUpdateLocationUserToUserStatus": { "description": "Whether the action is currently available for this asset", "enum": [ "DISABLED", "ENABLED", "NOT_APPLICABLE" ], "title": "ItAssetsAssetIdPatchResponsesContentApplicationJsonSchemaDataActionsUpdateLocationUserToUserStatus", "type": "string" }, "ItAssetsAssetIdPatchResponsesContentApplicationJsonSchemaDataActionsUpdateOwnAssetDetails": { "description": "Update editable details of an organization-owned asset", "properties": { "disabled_reasons": { "description": "Reasons why the action is disabled. Empty when the action is enabled or not applicable", "items": { "$ref": "#/components/schemas/ItAssetsAssetIdPatchResponsesContentApplicationJsonSchemaDataActionsUpdateOwnAssetDetailsDisabledReasonsItems" }, "type": "array" }, "status": { "$ref": "#/components/schemas/ItAssetsAssetIdPatchResponsesContentApplicationJsonSchemaDataActionsUpdateOwnAssetDetailsStatus", "description": "Whether the action is currently available for this asset" } }, "required": [ "status", "disabled_reasons" ], "title": "ItAssetsAssetIdPatchResponsesContentApplicationJsonSchemaDataActionsUpdateOwnAssetDetails", "type": "object" }, "ItAssetsAssetIdPatchResponsesContentApplicationJsonSchemaDataActionsUpdateOwnAssetDetailsDisabledReasonsItems": { "enum": [ "ARCHIVED", "AT_DEEL_WAREHOUSE", "BEING_REPAIRED", "CONSUMABLE", "CONTROLLED_BY_DEEL", "COUNTRY_NOT_SUPPORTED_FOR_HUB", "COUNTRY_NOT_SUPPORTED_FOR_LOCAL", "DEEL_OWNED_ITEM_WITHOUT_RENTAL_CONTRACT", "DESKTOP_STORAGE", "ENDING_CONTRACT", "HUB_IN_SAME_REGION_AS_LOCAL", "INACTIVE", "INVALID_ITEM_LOCATION", "INVALID_ORGANIZATION_STATUS", "INVALID_STATE", "ITEM_CONDITIONS_TO_UNARCHIVE_NOT_MET", "ITEM_NOT_VISIBLE_FOR_ORGANIZATION", "NON_DEVICE", "NOT_AT_WAREHOUSE", "NOT_AVAILABLE_FOR_REUSE", "NOT_A_RENTAL", "NOT_MANAGEABLE_BY_ORGANIZATION", "NOT_WITH_ASSIGNMENT", "NOT_WITH_USER", "NO_ACTIVE_ADDONS", "NO_ACTIVE_STORAGE_CONTRACT", "NO_LOCATION_FOR_STORAGE", "NO_LOGISTICS_FOR_STORAGE", "NO_VALID_ADDONS", "ONGOING_SERVICE", "OWNED_BY_DEEL", "OWNED_BY_ORGANIZATION", "OWNED_BY_PARTNER_ORGANIZATION", "PARTNER_CHILD_CONTRACT", "PENDING_DEVICE_REFRESH", "RENTAL_CONTRACT_AND_USER_REGION_DO_NOT_MATCH", "TEMPORARILY_UNAVAILABLE", "UNKNOWN", "USER_HAS_NO_COUNTRY", "USER_HAS_NO_SEAT", "WAITING_FOR_CLEARANCE", "WITH_LOANER_ASSIGNMENT", "WITH_NON_COLLECTED_ASSIGNMENT", "WITH_NON_DELIVERED_ASSIGNMENT", "WITH_PENDING_ASSIGNMENT", "WRONG_ASSIGNMENT_STATUS", "WRONG_CONTRACT_STATUS", "WRONG_TERMS_AND_CONDITIONS" ], "title": "ItAssetsAssetIdPatchResponsesContentApplicationJsonSchemaDataActionsUpdateOwnAssetDetailsDisabledReasonsItems", "type": "string" }, "ItAssetsAssetIdPatchResponsesContentApplicationJsonSchemaDataActionsUpdateOwnAssetDetailsStatus": { "description": "Whether the action is currently available for this asset", "enum": [ "DISABLED", "ENABLED", "NOT_APPLICABLE" ], "title": "ItAssetsAssetIdPatchResponsesContentApplicationJsonSchemaDataActionsUpdateOwnAssetDetailsStatus", "type": "string" }, "ItAssetsAssetIdPatchResponsesContentApplicationJsonSchemaDataAssignedUser": { "description": "Details of the user with asset possession", "properties": { "emails": { "description": "Array of user email addresses", "items": { "format": "email", "type": "string" }, "type": "array" }, "first_name": { "description": "First name of the user", "type": "string" }, "hris_profile_id": { "description": "The unique identifier of the HRIS profile of the assigned user", "format": "uuid", "type": "string" }, "last_name": { "description": "Last name of the user", "type": "string" } }, "required": [ "emails", "last_name", "first_name", "hris_profile_id" ], "title": "ItAssetsAssetIdPatchResponsesContentApplicationJsonSchemaDataAssignedUser", "type": "object" }, "ItAssetsAssetIdPatchResponsesContentApplicationJsonSchemaDataAssignedWarehouse": { "description": "Details of the warehouse with asset possession", "properties": { "address": { "$ref": "#/components/schemas/ItAssetsAssetIdPatchResponsesContentApplicationJsonSchemaDataAssignedWarehouseAddress", "description": "Warehouse address details" }, "id": { "description": "Unique identifier of the warehouse", "format": "uuid", "type": "string" }, "name": { "description": "Warehouse or storage location name", "type": "string" }, "ownership": { "$ref": "#/components/schemas/ItAssetsAssetIdPatchResponsesContentApplicationJsonSchemaDataAssignedWarehouseOwnership", "description": "Warehouse ownership type" }, "public_id": { "description": "Public identifier of the warehouse", "type": "string" }, "warehouse_type": { "$ref": "#/components/schemas/ItAssetsAssetIdPatchResponsesContentApplicationJsonSchemaDataAssignedWarehouseWarehouseType", "description": "Warehouse type" } }, "required": [ "id", "name", "address", "ownership", "public_id", "warehouse_type" ], "title": "ItAssetsAssetIdPatchResponsesContentApplicationJsonSchemaDataAssignedWarehouse", "type": "object" }, "ItAssetsAssetIdPatchResponsesContentApplicationJsonSchemaDataAssignedWarehouseAddress": { "description": "Warehouse address details", "properties": { "city": { "description": "City name", "type": [ "string", "null" ] }, "country": { "$ref": "#/components/schemas/ItAssetsAssetIdPatchResponsesContentApplicationJsonSchemaDataAssignedWarehouseAddressCountry", "description": "Country code" }, "date_of_birth": { "description": "Date of birth (applicable for some address types)", "format": "date", "type": [ "string", "null" ] }, "delivery_instructions": { "description": "Special instructions for deliveries", "type": [ "string", "null" ] }, "id": { "description": "Unique identifier of the address", "format": "uuid", "type": "string" }, "is_valid": { "description": "Whether the address passes validation", "type": "boolean" }, "line1": { "description": "Address line 1", "type": [ "string", "null" ] }, "line2": { "description": "Address line 2", "type": [ "string", "null" ] }, "passport_number": { "description": "Passport number (applicable for some address types)", "type": [ "string", "null" ] }, "phone_number": { "description": "Phone number", "type": [ "string", "null" ] }, "post_code": { "description": "Post code", "type": [ "string", "null" ] }, "state": { "description": "State code or name", "type": [ "string", "null" ] }, "tax_id_number": { "description": "Tax ID number (applicable for some address types)", "type": [ "string", "null" ] }, "type": { "$ref": "#/components/schemas/ItAssetsAssetIdPatchResponsesContentApplicationJsonSchemaDataAssignedWarehouseAddressType", "description": "Type of the address" } }, "required": [ "id", "city", "type", "line1", "line2", "state", "country", "is_valid", "post_code", "phone_number", "date_of_birth", "tax_id_number", "passport_number", "delivery_instructions" ], "title": "ItAssetsAssetIdPatchResponsesContentApplicationJsonSchemaDataAssignedWarehouseAddress", "type": "object" }, "ItAssetsAssetIdPatchResponsesContentApplicationJsonSchemaDataAssignedWarehouseAddressCountry": { "description": "Country code", "enum": [ "AD", "AE", "AF", "AG", "AI", "AL", "AM", "AN", "AO", "AQ", "AR", "AS", "AT", "AU", "AW", "AX", "AZ", "BA", "BB", "BD", "BE", "BF", "BG", "BH", "BI", "BJ", "BL", "BM", "BN", "BO", "BQ", "BR", "BS", "BT", "BV", "BW", "BY", "BZ", "CA", "CC", "CD", "CF", "CG", "CH", "CI", "CK", "CL", "CM", "CN", "CO", "CR", "CU", "CV", "CW", "CX", "CY", "CZ", "DE", "DJ", "DK", "DM", "DO", "DZ", "EC", "EE", "EG", "EH", "ER", "ES", "ET", "FI", "FJ", "FK", "FM", "FO", "FR", "GA", "GB", "GD", "GE", "GF", "GG", "GH", "GI", "GL", "GM", "GN", "GP", "GQ", "GR", "GS", "GT", "GU", "GW", "GY", "HK", "HM", "HN", "HR", "HT", "HU", "IC", "ID", "IE", "IL", "IM", "IN", "IO", "IQ", "IR", "IS", "IT", "JE", "JM", "JO", "JP", "KE", "KG", "KH", "KI", "KM", "KN", "KP", "KR", "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", "XK", "YE", "YT", "ZA", "ZM", "ZW" ], "title": "ItAssetsAssetIdPatchResponsesContentApplicationJsonSchemaDataAssignedWarehouseAddressCountry", "type": "string" }, "ItAssetsAssetIdPatchResponsesContentApplicationJsonSchemaDataAssignedWarehouseAddressType": { "description": "Type of the address", "enum": [ "BILLING", "COLLECTION", "DELIVERY", "ENTITY", "PARTIAL", "PII", "SUPPLIER" ], "title": "ItAssetsAssetIdPatchResponsesContentApplicationJsonSchemaDataAssignedWarehouseAddressType", "type": "string" }, "ItAssetsAssetIdPatchResponsesContentApplicationJsonSchemaDataAssignedWarehouseOwnership": { "description": "Warehouse ownership type", "enum": [ "DEEL", "ORGANIZATION" ], "title": "ItAssetsAssetIdPatchResponsesContentApplicationJsonSchemaDataAssignedWarehouseOwnership", "type": "string" }, "ItAssetsAssetIdPatchResponsesContentApplicationJsonSchemaDataAssignedWarehouseWarehouseType": { "description": "Warehouse type", "enum": [ "CLEARANCE", "DEEL", "ORGANIZATION" ], "title": "ItAssetsAssetIdPatchResponsesContentApplicationJsonSchemaDataAssignedWarehouseWarehouseType", "type": "string" }, "ItAssetsAssetIdPatchResponsesContentApplicationJsonSchemaDataGrade": { "description": "The condition grade of the asset", "enum": [ "A", "B", "C", "D", "F", "NEW" ], "title": "ItAssetsAssetIdPatchResponsesContentApplicationJsonSchemaDataGrade", "type": "string" }, "ItAssetsAssetIdPatchResponsesContentApplicationJsonSchemaDataLocation": { "description": "Current location type of the asset", "enum": [ "AT_WAREHOUSE", "CLEARANCE_WAREHOUSE", "DEEL_WAREHOUSE", "ORGANIZATION_WAREHOUSE", "SUPPLIER", "WITH_COURIER", "WITH_USER", "WRITE_OFF" ], "title": "ItAssetsAssetIdPatchResponsesContentApplicationJsonSchemaDataLocation", "type": "string" }, "ItAssetsAssetIdPatchResponsesContentApplicationJsonSchemaDataOwnership": { "description": "Asset owner", "properties": { "name": { "description": "Asset owner name", "type": "string" }, "type": { "$ref": "#/components/schemas/ItAssetsAssetIdPatchResponsesContentApplicationJsonSchemaDataOwnershipType", "description": "Asset owner type" } }, "required": [ "name", "type" ], "title": "ItAssetsAssetIdPatchResponsesContentApplicationJsonSchemaDataOwnership", "type": "object" }, "ItAssetsAssetIdPatchResponsesContentApplicationJsonSchemaDataOwnershipType": { "description": "Asset owner type", "enum": [ "DEEL", "ORGANIZATION" ], "title": "ItAssetsAssetIdPatchResponsesContentApplicationJsonSchemaDataOwnershipType", "type": "string" }, "ItAssetsAssetIdPatchResponsesContentApplicationJsonSchemaDataProduct": { "description": "Product details", "properties": { "brand": { "description": "Product brand", "type": "string" }, "category": { "$ref": "#/components/schemas/ItAssetsAssetIdPatchResponsesContentApplicationJsonSchemaDataProductCategory", "description": "Product category" }, "id": { "description": "Unique identifier of the product", "format": "uuid", "type": "string" }, "name": { "description": "Product name", "type": "string" }, "specifications": { "description": "Specifications of the product", "items": { "$ref": "#/components/schemas/ItAssetsAssetIdPatchResponsesContentApplicationJsonSchemaDataProductSpecificationsItems" }, "type": "array" } }, "required": [ "id", "name", "brand", "category", "specifications" ], "title": "ItAssetsAssetIdPatchResponsesContentApplicationJsonSchemaDataProduct", "type": "object" }, "ItAssetsAssetIdPatchResponsesContentApplicationJsonSchemaDataProductCategory": { "description": "Product category", "enum": [ "ADAPTER", "CABLE", "CHAIR", "CHARGER", "COMPACT_DESKTOP", "DESK", "DESKTOP", "DESK_RISER", "DESK_TIDY", "DOCKING_STATION", "DONGLE", "FOOTREST", "HEADSET", "KEYBOARD", "LAPTOP", "LAPTOP_STAND", "MICE_TRACKPAD", "MOBILE_DEVICE", "MONITOR", "MONITOR_ARM", "OTHER", "PRINTER", "SHREDDER", "STANDING_MAT", "TABLET", "TASK_LIGHT", "WEBCAM", "WELCOME_PACK", "WIFI_RANGE_EXTENDER" ], "title": "ItAssetsAssetIdPatchResponsesContentApplicationJsonSchemaDataProductCategory", "type": "string" }, "ItAssetsAssetIdPatchResponsesContentApplicationJsonSchemaDataProductSpecificationsItems": { "properties": { "name": { "description": "Specification name", "type": "string" }, "value": { "description": "Specification value", "type": "string" } }, "required": [ "name", "value" ], "title": "ItAssetsAssetIdPatchResponsesContentApplicationJsonSchemaDataProductSpecificationsItems", "type": "object" }, "ItAssetsAssetIdPatchResponsesContentApplicationJsonSchemaDataPurchaseValue": { "description": "Purchase value of the asset", "properties": { "amount": { "description": "Amount", "format": "decimal", "type": "string" }, "currency": { "$ref": "#/components/schemas/ItAssetsAssetIdPatchResponsesContentApplicationJsonSchemaDataPurchaseValueCurrency", "description": "Three-letter currency code for the price" } }, "required": [ "amount", "currency" ], "title": "ItAssetsAssetIdPatchResponsesContentApplicationJsonSchemaDataPurchaseValue", "type": "object" }, "ItAssetsAssetIdPatchResponsesContentApplicationJsonSchemaDataPurchaseValueCurrency": { "description": "Three-letter currency code for the price", "enum": [ "AED", "AFN", "ALL", "AMD", "ANG", "AOA", "ARS", "AUD", "AWG", "AZN", "BAM", "BDT", "BGN", "BHD", "BIF", "BMD", "BOB", "BRL", "BSD", "BTN", "BWP", "BYN", "BZD", "CAD", "CDF", "CHF", "CLP", "CNY", "COP", "CRC", "CUC", "CVE", "CZK", "DJF", "DKK", "DOP", "DZD", "EGP", "ERN", "ETB", "EUR", "FJD", "FKP", "GBP", "GEL", "GHS", "GIP", "GMD", "GNF", "GTQ", "GYD", "HKD", "HNL", "HRK", "HTG", "HUF", "IDR", "ILS", "INR", "IQD", "IRR", "ISK", "JMD", "JOD", "JPY", "KES", "KGS", "KHR", "KMF", "KPW", "KRW", "KWD", "KYD", "KZT", "LAK", "LBP", "LKR", "LRD", "LSL", "LTL", "LYD", "MAD", "MDL", "MGA", "MKD", "MMK", "MNT", "MRU", "MUR", "MVR", "MWK", "MXN", "MYR", "MZN", "NAD", "NGN", "NIO", "NOK", "NPR", "NZD", "OMR", "PAB", "PEN", "PGK", "PHP", "PKR", "PLN", "PYG", "QAR", "RON", "RSD", "RUB", "RWF", "SAR", "SBD", "SCR", "SDG", "SEK", "SGD", "SHP", "SLL", "SOS", "SRD", "SSP", "STD", "SYP", "SZL", "THB", "TJS", "TMT", "TND", "TOP", "TRY", "TTD", "TWD", "TZS", "UAH", "UGX", "USD", "UYU", "UZS", "VEF", "VND", "VUV", "WST", "XAF", "XCD", "XOF", "XPF", "YER", "ZAR", "ZMW", "ZWD" ], "title": "ItAssetsAssetIdPatchResponsesContentApplicationJsonSchemaDataPurchaseValueCurrency", "type": "string" }, "ItAssetsAssetIdPatchResponsesContentApplicationJsonSchemaDataStatus": { "description": "Current state of the asset", "enum": [ "ACTIVE", "ADDED_BY_MISTAKE", "BEING_REPAIRED", "BINNED", "BROKEN_AT_WAREHOUSE", "BROKEN_BY_USER", "BROKEN_IN_TRANSIT", "CLEARED", "DAMAGED_AT_WAREHOUSE", "DAMAGED_BY_USER", "DAMAGED_IN_TRANSIT", "LEFT_WITH_USER", "LOST_IN_TRANSIT", "RETURNED_TO_DEEL", "SHRINKAGE", "STOLEN", "SUPPLIER_RETURN", "WAITING_FOR_CLEARANCE" ], "title": "ItAssetsAssetIdPatchResponsesContentApplicationJsonSchemaDataStatus", "type": "string" }, "ItAssetsAssetIdPatchResponsesContentApplicationJsonSchemaErrorsItems": { "properties": { "code": { "description": "Error code of the handler which produced the returned error", "type": "string" }, "field": { "description": "The field name where input validation failed", "type": [ "string", "null" ] }, "message": { "description": "Description of the returned error", "type": "string" } }, "required": [ "code", "field", "message" ], "title": "ItAssetsAssetIdPatchResponsesContentApplicationJsonSchemaErrorsItems", "type": "object" }, "ItAssetsAssetIdTransferPostParametersXBeta": { "default": "true", "enum": [ "true" ], "title": "ItAssetsAssetIdTransferPostParametersXBeta", "type": "string" }, "ItAssetsAssetIdTransferPostRequestBodyContentApplicationJsonSchemaData": { "properties": { "collection_address": { "$ref": "#/components/schemas/ItAssetsAssetIdTransferPostRequestBodyContentApplicationJsonSchemaDataCollectionAddress", "description": "Location the asset is being collected from before being shipped to the new holder." }, "delivery_address": { "$ref": "#/components/schemas/ItAssetsAssetIdTransferPostRequestBodyContentApplicationJsonSchemaDataDeliveryAddress", "description": "Delivery address for the target holder. Optional when the target HRIS profile already has a valid delivery address on file." }, "hris_profile_id": { "description": "HRIS profile identifier of the new holder.", "format": "uuid", "type": "string" }, "not_before": { "description": "Earliest date Deel logistics may execute the pickup.", "format": "date", "type": "string" }, "shipment_insurance": { "$ref": "#/components/schemas/ItAssetsAssetIdTransferPostRequestBodyContentApplicationJsonSchemaDataShipmentInsurance", "description": "Insurance-consent flag and optional purchase details Deel records against the asset. May be omitted (or sent with `is_waived: false` and no `purchase_details`) if the asset already has a purchase price and date on record." } }, "required": [ "hris_profile_id", "collection_address" ], "title": "ItAssetsAssetIdTransferPostRequestBodyContentApplicationJsonSchemaData", "type": "object" }, "ItAssetsAssetIdTransferPostRequestBodyContentApplicationJsonSchemaDataCollectionAddress": { "description": "Location the asset is being collected from before being shipped to the new holder.", "properties": { "country": { "$ref": "#/components/schemas/ItAssetsAssetIdTransferPostRequestBodyContentApplicationJsonSchemaDataCollectionAddressCountry", "description": "Country the asset is being picked up from. Overrides the country the asset-action validator derives from asset state." } }, "title": "ItAssetsAssetIdTransferPostRequestBodyContentApplicationJsonSchemaDataCollectionAddress", "type": "object" }, "ItAssetsAssetIdTransferPostRequestBodyContentApplicationJsonSchemaDataCollectionAddressCountry": { "description": "Country the asset is being picked up from. Overrides the country the asset-action validator derives from asset state.", "enum": [ "AD", "AE", "AF", "AG", "AI", "AL", "AM", "AN", "AO", "AQ", "AR", "AS", "AT", "AU", "AW", "AX", "AZ", "BA", "BB", "BD", "BE", "BF", "BG", "BH", "BI", "BJ", "BL", "BM", "BN", "BO", "BQ", "BR", "BS", "BT", "BV", "BW", "BY", "BZ", "CA", "CC", "CD", "CF", "CG", "CH", "CI", "CK", "CL", "CM", "CN", "CO", "CR", "CU", "CV", "CW", "CX", "CY", "CZ", "DE", "DJ", "DK", "DM", "DO", "DZ", "EC", "EE", "EG", "EH", "ER", "ES", "ET", "FI", "FJ", "FK", "FM", "FO", "FR", "GA", "GB", "GD", "GE", "GF", "GG", "GH", "GI", "GL", "GM", "GN", "GP", "GQ", "GR", "GS", "GT", "GU", "GW", "GY", "HK", "HM", "HN", "HR", "HT", "HU", "IC", "ID", "IE", "IL", "IM", "IN", "IO", "IQ", "IR", "IS", "IT", "JE", "JM", "JO", "JP", "KE", "KG", "KH", "KI", "KM", "KN", "KP", "KR", "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", "XK", "YE", "YT", "ZA", "ZM", "ZW" ], "title": "ItAssetsAssetIdTransferPostRequestBodyContentApplicationJsonSchemaDataCollectionAddressCountry", "type": "string" }, "ItAssetsAssetIdTransferPostRequestBodyContentApplicationJsonSchemaDataDeliveryAddress": { "description": "Delivery address for the target holder. Optional when the target HRIS profile already has a valid delivery address on file.", "properties": { "city": { "description": "City name", "type": "string" }, "country": { "$ref": "#/components/schemas/ItAssetsAssetIdTransferPostRequestBodyContentApplicationJsonSchemaDataDeliveryAddressCountry", "description": "Country code (ISO 3166 alpha-2)" }, "date_of_birth": { "description": "Date of birth", "format": "date", "type": "string" }, "delivery_instructions": { "description": "Delivery instructions for the courier", "type": "string" }, "line1": { "description": "Address line 1", "type": "string" }, "line2": { "description": "Address line 2", "type": "string" }, "passport_number": { "description": "Passport number", "type": "string" }, "phone_number": { "description": "Phone number in E.164 format", "type": "string" }, "post_code": { "description": "Post code", "type": "string" }, "state": { "description": "State or region name", "type": "string" }, "tax_id_number": { "description": "Tax ID number", "type": "string" } }, "required": [ "country" ], "title": "ItAssetsAssetIdTransferPostRequestBodyContentApplicationJsonSchemaDataDeliveryAddress", "type": "object" }, "ItAssetsAssetIdTransferPostRequestBodyContentApplicationJsonSchemaDataDeliveryAddressCountry": { "description": "Country code (ISO 3166 alpha-2)", "enum": [ "AD", "AE", "AF", "AG", "AI", "AL", "AM", "AN", "AO", "AQ", "AR", "AS", "AT", "AU", "AW", "AX", "AZ", "BA", "BB", "BD", "BE", "BF", "BG", "BH", "BI", "BJ", "BL", "BM", "BN", "BO", "BQ", "BR", "BS", "BT", "BV", "BW", "BY", "BZ", "CA", "CC", "CD", "CF", "CG", "CH", "CI", "CK", "CL", "CM", "CN", "CO", "CR", "CU", "CV", "CW", "CX", "CY", "CZ", "DE", "DJ", "DK", "DM", "DO", "DZ", "EC", "EE", "EG", "EH", "ER", "ES", "ET", "FI", "FJ", "FK", "FM", "FO", "FR", "GA", "GB", "GD", "GE", "GF", "GG", "GH", "GI", "GL", "GM", "GN", "GP", "GQ", "GR", "GS", "GT", "GU", "GW", "GY", "HK", "HM", "HN", "HR", "HT", "HU", "IC", "ID", "IE", "IL", "IM", "IN", "IO", "IQ", "IR", "IS", "IT", "JE", "JM", "JO", "JP", "KE", "KG", "KH", "KI", "KM", "KN", "KP", "KR", "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", "XK", "YE", "YT", "ZA", "ZM", "ZW" ], "title": "ItAssetsAssetIdTransferPostRequestBodyContentApplicationJsonSchemaDataDeliveryAddressCountry", "type": "string" }, "ItAssetsAssetIdTransferPostRequestBodyContentApplicationJsonSchemaDataShipmentInsurance": { "description": "Insurance-consent flag and optional purchase details Deel records against the asset. May be omitted (or sent with `is_waived: false` and no `purchase_details`) if the asset already has a purchase price and date on record.", "properties": { "is_waived": { "description": "Consent to ship without insurance. When true, `purchase_details` must be omitted and Deel will not record a purchase price against the asset.", "type": "boolean" }, "purchase_details": { "$ref": "#/components/schemas/ItAssetsAssetIdTransferPostRequestBodyContentApplicationJsonSchemaDataShipmentInsurancePurchaseDetails", "description": "Purchase details Deel records against the asset. Omit to fall back to purchase details already stored on the asset, if any. Must be omitted when `is_waived` is true." } }, "required": [ "is_waived" ], "title": "ItAssetsAssetIdTransferPostRequestBodyContentApplicationJsonSchemaDataShipmentInsurance", "type": "object" }, "ItAssetsAssetIdTransferPostRequestBodyContentApplicationJsonSchemaDataShipmentInsurancePurchaseDetails": { "description": "Purchase details Deel records against the asset. Omit to fall back to purchase details already stored on the asset, if any. Must be omitted when `is_waived` is true.", "properties": { "date": { "description": "Date the asset was purchased.", "format": "date", "type": "string" }, "price": { "$ref": "#/components/schemas/ItAssetsAssetIdTransferPostRequestBodyContentApplicationJsonSchemaDataShipmentInsurancePurchaseDetailsPrice", "description": "Purchase price paid for the asset." } }, "required": [ "date", "price" ], "title": "ItAssetsAssetIdTransferPostRequestBodyContentApplicationJsonSchemaDataShipmentInsurancePurchaseDetails", "type": "object" }, "ItAssetsAssetIdTransferPostRequestBodyContentApplicationJsonSchemaDataShipmentInsurancePurchaseDetailsPrice": { "description": "Purchase price paid for the asset.", "properties": { "amount": { "description": "Amount", "format": "decimal", "type": "string" }, "currency": { "$ref": "#/components/schemas/ItAssetsAssetIdTransferPostRequestBodyContentApplicationJsonSchemaDataShipmentInsurancePurchaseDetailsPriceCurrency", "description": "Three-letter currency code for the price" } }, "required": [ "amount", "currency" ], "title": "ItAssetsAssetIdTransferPostRequestBodyContentApplicationJsonSchemaDataShipmentInsurancePurchaseDetailsPrice", "type": "object" }, "ItAssetsAssetIdTransferPostRequestBodyContentApplicationJsonSchemaDataShipmentInsurancePurchaseDetailsPriceCurrency": { "description": "Three-letter currency code for the price", "enum": [ "AED", "AFN", "ALL", "AMD", "ANG", "AOA", "ARS", "AUD", "AWG", "AZN", "BAM", "BDT", "BGN", "BHD", "BIF", "BMD", "BOB", "BRL", "BSD", "BTN", "BWP", "BYN", "BZD", "CAD", "CDF", "CHF", "CLP", "CNY", "COP", "CRC", "CUC", "CVE", "CZK", "DJF", "DKK", "DOP", "DZD", "EGP", "ERN", "ETB", "EUR", "FJD", "FKP", "GBP", "GEL", "GHS", "GIP", "GMD", "GNF", "GTQ", "GYD", "HKD", "HNL", "HRK", "HTG", "HUF", "IDR", "ILS", "INR", "IQD", "IRR", "ISK", "JMD", "JOD", "JPY", "KES", "KGS", "KHR", "KMF", "KPW", "KRW", "KWD", "KYD", "KZT", "LAK", "LBP", "LKR", "LRD", "LSL", "LTL", "LYD", "MAD", "MDL", "MGA", "MKD", "MMK", "MNT", "MRU", "MUR", "MVR", "MWK", "MXN", "MYR", "MZN", "NAD", "NGN", "NIO", "NOK", "NPR", "NZD", "OMR", "PAB", "PEN", "PGK", "PHP", "PKR", "PLN", "PYG", "QAR", "RON", "RSD", "RUB", "RWF", "SAR", "SBD", "SCR", "SDG", "SEK", "SGD", "SHP", "SLL", "SOS", "SRD", "SSP", "STD", "SYP", "SZL", "THB", "TJS", "TMT", "TND", "TOP", "TRY", "TTD", "TWD", "TZS", "UAH", "UGX", "USD", "UYU", "UZS", "VEF", "VND", "VUV", "WST", "XAF", "XCD", "XOF", "XPF", "YER", "ZAR", "ZMW", "ZWD" ], "title": "ItAssetsAssetIdTransferPostRequestBodyContentApplicationJsonSchemaDataShipmentInsurancePurchaseDetailsPriceCurrency", "type": "string" }, "ItAssetsAssetIdTransferPostResponsesContentApplicationJsonSchemaData": { "properties": { "actions": { "$ref": "#/components/schemas/ItAssetsAssetIdTransferPostResponsesContentApplicationJsonSchemaDataActions", "description": "Actions the caller can execute on this asset, with availability status per action" }, "assigned_user": { "description": "Details of the user with asset possession", "oneOf": [ { "$ref": "#/components/schemas/ItAssetsAssetIdTransferPostResponsesContentApplicationJsonSchemaDataAssignedUser" }, { "type": "null" } ] }, "assigned_warehouse": { "description": "Details of the warehouse with asset possession", "oneOf": [ { "$ref": "#/components/schemas/ItAssetsAssetIdTransferPostResponsesContentApplicationJsonSchemaDataAssignedWarehouse" }, { "type": "null" } ] }, "created_at": { "description": "Creation timestamp of the asset", "format": "date-time", "type": "string" }, "grade": { "$ref": "#/components/schemas/ItAssetsAssetIdTransferPostResponsesContentApplicationJsonSchemaDataGrade", "description": "The condition grade of the asset" }, "id": { "description": "Unique identifier of the item", "format": "uuid", "type": "string" }, "location": { "$ref": "#/components/schemas/ItAssetsAssetIdTransferPostResponsesContentApplicationJsonSchemaDataLocation", "description": "Current location type of the asset" }, "ownership": { "$ref": "#/components/schemas/ItAssetsAssetIdTransferPostResponsesContentApplicationJsonSchemaDataOwnership", "description": "Asset owner" }, "product": { "$ref": "#/components/schemas/ItAssetsAssetIdTransferPostResponsesContentApplicationJsonSchemaDataProduct", "description": "Product details" }, "public_id": { "description": "Public identifier of the item", "type": "string" }, "purchase_date": { "description": "Purchase date of the asset", "format": "date", "type": [ "string", "null" ] }, "purchase_value": { "description": "Purchase value of the asset", "oneOf": [ { "$ref": "#/components/schemas/ItAssetsAssetIdTransferPostResponsesContentApplicationJsonSchemaDataPurchaseValue" }, { "type": "null" } ] }, "serial_number": { "description": "Asset serial number", "type": [ "string", "null" ] }, "status": { "$ref": "#/components/schemas/ItAssetsAssetIdTransferPostResponsesContentApplicationJsonSchemaDataStatus", "description": "Current state of the asset" }, "updated_at": { "description": "Last update timestamp of the asset", "format": "date-time", "type": "string" } }, "required": [ "id", "grade", "status", "actions", "product", "location", "ownership", "public_id", "created_at", "updated_at", "assigned_user", "purchase_date", "serial_number", "purchase_value", "assigned_warehouse" ], "title": "ItAssetsAssetIdTransferPostResponsesContentApplicationJsonSchemaData", "type": "object" }, "ItAssetsAssetIdTransferPostResponsesContentApplicationJsonSchemaDataActions": { "description": "Actions the caller can execute on this asset, with availability status per action", "properties": { "archive_own_asset": { "$ref": "#/components/schemas/ItAssetsAssetIdTransferPostResponsesContentApplicationJsonSchemaDataActionsArchiveOwnAsset", "description": "Archive an organization-owned asset" }, "asset_country": { "description": "Resolved country used for asset actions. Derived from the asset's country,\nits assigned rental contract billing entity country, or the last active\nassignment delivery country. Null when the country cannot be determined\n(e.g. asset was returned to Deel)", "oneOf": [ { "$ref": "#/components/schemas/ItAssetsAssetIdTransferPostResponsesContentApplicationJsonSchemaDataActionsAssetCountry" }, { "type": "null" } ] }, "assign_addon_to_own_asset": { "$ref": "#/components/schemas/ItAssetsAssetIdTransferPostResponsesContentApplicationJsonSchemaDataActionsAssignAddonToOwnAsset", "description": "Assign an add-on to an organization-owned asset" }, "clear_own_asset": { "$ref": "#/components/schemas/ItAssetsAssetIdTransferPostResponsesContentApplicationJsonSchemaDataActionsClearOwnAsset", "description": "Clear an organization-owned asset from the fleet" }, "manage_end_of_rental_contract_actions": { "$ref": "#/components/schemas/ItAssetsAssetIdTransferPostResponsesContentApplicationJsonSchemaDataActionsManageEndOfRentalContractActions", "description": "Manage end-of-rental options for a Deel-owned rental asset" }, "purchase_rental": { "$ref": "#/components/schemas/ItAssetsAssetIdTransferPostResponsesContentApplicationJsonSchemaDataActionsPurchaseRental", "description": "Purchase a Deel-owned rental asset at end of contract" }, "return_rental_to_deel": { "$ref": "#/components/schemas/ItAssetsAssetIdTransferPostResponsesContentApplicationJsonSchemaDataActionsReturnRentalToDeel", "description": "Return a Deel-owned rental asset back to Deel" }, "reuse_own_asset_from_deel": { "$ref": "#/components/schemas/ItAssetsAssetIdTransferPostResponsesContentApplicationJsonSchemaDataActionsReuseOwnAssetFromDeel", "description": "Redeploy an organization-owned asset stored at a Deel warehouse" }, "reuse_own_asset_from_own_location": { "$ref": "#/components/schemas/ItAssetsAssetIdTransferPostResponsesContentApplicationJsonSchemaDataActionsReuseOwnAssetFromOwnLocation", "description": "Redeploy an organization-owned asset from an organization-owned location" }, "store_own_asset_at_deel_for_hub": { "$ref": "#/components/schemas/ItAssetsAssetIdTransferPostResponsesContentApplicationJsonSchemaDataActionsStoreOwnAssetAtDeelForHub", "description": "Store an organization-owned asset at a Deel hub warehouse" }, "store_own_asset_at_deel_for_local": { "$ref": "#/components/schemas/ItAssetsAssetIdTransferPostResponsesContentApplicationJsonSchemaDataActionsStoreOwnAssetAtDeelForLocal", "description": "Store an organization-owned asset at a Deel local warehouse" }, "store_own_asset_at_own_location": { "$ref": "#/components/schemas/ItAssetsAssetIdTransferPostResponsesContentApplicationJsonSchemaDataActionsStoreOwnAssetAtOwnLocation", "description": "Store an organization-owned asset at an organization-owned location" }, "store_rental_at_deel_for_local": { "$ref": "#/components/schemas/ItAssetsAssetIdTransferPostResponsesContentApplicationJsonSchemaDataActionsStoreRentalAtDeelForLocal", "description": "Store a Deel-owned rental asset at a Deel local warehouse" }, "store_rental_at_deel_for_zone1": { "$ref": "#/components/schemas/ItAssetsAssetIdTransferPostResponsesContentApplicationJsonSchemaDataActionsStoreRentalAtDeelForZone1", "description": "Store a Deel-owned rental asset at a Deel zone-1 warehouse" }, "transfer_own_asset": { "$ref": "#/components/schemas/ItAssetsAssetIdTransferPostResponsesContentApplicationJsonSchemaDataActionsTransferOwnAsset", "description": "Transfer an organization-owned asset to another user" }, "transfer_rental": { "$ref": "#/components/schemas/ItAssetsAssetIdTransferPostResponsesContentApplicationJsonSchemaDataActionsTransferRental", "description": "Transfer a Deel-owned rental asset to another user" }, "unarchive_own_asset": { "$ref": "#/components/schemas/ItAssetsAssetIdTransferPostResponsesContentApplicationJsonSchemaDataActionsUnarchiveOwnAsset", "description": "Unarchive a previously archived organization-owned asset" }, "update_location_location_to_user": { "$ref": "#/components/schemas/ItAssetsAssetIdTransferPostResponsesContentApplicationJsonSchemaDataActionsUpdateLocationLocationToUser", "description": "Update the location of an asset from a warehouse to a user" }, "update_location_user_to_location": { "$ref": "#/components/schemas/ItAssetsAssetIdTransferPostResponsesContentApplicationJsonSchemaDataActionsUpdateLocationUserToLocation", "description": "Update the location of an asset from a user to a warehouse" }, "update_location_user_to_user": { "$ref": "#/components/schemas/ItAssetsAssetIdTransferPostResponsesContentApplicationJsonSchemaDataActionsUpdateLocationUserToUser", "description": "Update the assigned user of an asset that is currently with a user" }, "update_own_asset_details": { "$ref": "#/components/schemas/ItAssetsAssetIdTransferPostResponsesContentApplicationJsonSchemaDataActionsUpdateOwnAssetDetails", "description": "Update editable details of an organization-owned asset" } }, "required": [ "asset_country", "clear_own_asset", "purchase_rental", "transfer_rental", "archive_own_asset", "transfer_own_asset", "unarchive_own_asset", "return_rental_to_deel", "update_own_asset_details", "assign_addon_to_own_asset", "reuse_own_asset_from_deel", "update_location_user_to_user", "store_rental_at_deel_for_local", "store_rental_at_deel_for_zone1", "store_own_asset_at_deel_for_hub", "store_own_asset_at_own_location", "update_location_location_to_user", "update_location_user_to_location", "reuse_own_asset_from_own_location", "store_own_asset_at_deel_for_local", "manage_end_of_rental_contract_actions" ], "title": "ItAssetsAssetIdTransferPostResponsesContentApplicationJsonSchemaDataActions", "type": "object" }, "ItAssetsAssetIdTransferPostResponsesContentApplicationJsonSchemaDataActionsArchiveOwnAsset": { "description": "Archive an organization-owned asset", "properties": { "details": { "description": "Action-specific context needed to perform the action. Populated for enabled and\ndisabled actions (so callers can see what a successful attempt would look like);\nnull when the action is not applicable to this asset.", "oneOf": [ { "$ref": "#/components/schemas/ItAssetsAssetIdTransferPostResponsesContentApplicationJsonSchemaDataActionsArchiveOwnAssetDetails" }, { "type": "null" } ] }, "disabled_reasons": { "description": "Reasons why the action is disabled. Empty when the action is enabled or not applicable", "items": { "$ref": "#/components/schemas/ItAssetsAssetIdTransferPostResponsesContentApplicationJsonSchemaDataActionsArchiveOwnAssetDisabledReasonsItems" }, "type": "array" }, "status": { "$ref": "#/components/schemas/ItAssetsAssetIdTransferPostResponsesContentApplicationJsonSchemaDataActionsArchiveOwnAssetStatus", "description": "Whether the action is currently available for this asset" } }, "required": [ "status", "details", "disabled_reasons" ], "title": "ItAssetsAssetIdTransferPostResponsesContentApplicationJsonSchemaDataActionsArchiveOwnAsset", "type": "object" }, "ItAssetsAssetIdTransferPostResponsesContentApplicationJsonSchemaDataActionsArchiveOwnAssetDetails": { "description": "Action-specific context needed to perform the action. Populated for enabled and\ndisabled actions (so callers can see what a successful attempt would look like);\nnull when the action is not applicable to this asset.", "properties": { "allowed_statuses": { "description": "Statuses that can be passed as the archive reason when archiving the asset", "items": { "$ref": "#/components/schemas/ItAssetsAssetIdTransferPostResponsesContentApplicationJsonSchemaDataActionsArchiveOwnAssetDetailsAllowedStatusesItems" }, "type": "array" } }, "required": [ "allowed_statuses" ], "title": "ItAssetsAssetIdTransferPostResponsesContentApplicationJsonSchemaDataActionsArchiveOwnAssetDetails", "type": "object" }, "ItAssetsAssetIdTransferPostResponsesContentApplicationJsonSchemaDataActionsArchiveOwnAssetDetailsAllowedStatusesItems": { "enum": [ "ADDED_BY_MISTAKE", "BINNED", "BROKEN_AT_WAREHOUSE", "BROKEN_BY_USER", "BROKEN_IN_TRANSIT", "DAMAGED_AT_WAREHOUSE", "DAMAGED_BY_USER", "DAMAGED_IN_TRANSIT", "LEFT_WITH_USER", "LOST_IN_TRANSIT", "RETURNED_TO_DEEL", "SHRINKAGE", "STOLEN", "SUPPLIER_RETURN" ], "title": "ItAssetsAssetIdTransferPostResponsesContentApplicationJsonSchemaDataActionsArchiveOwnAssetDetailsAllowedStatusesItems", "type": "string" }, "ItAssetsAssetIdTransferPostResponsesContentApplicationJsonSchemaDataActionsArchiveOwnAssetDisabledReasonsItems": { "enum": [ "ARCHIVED", "AT_DEEL_WAREHOUSE", "BEING_REPAIRED", "CONSUMABLE", "CONTROLLED_BY_DEEL", "COUNTRY_NOT_SUPPORTED_FOR_HUB", "COUNTRY_NOT_SUPPORTED_FOR_LOCAL", "DEEL_OWNED_ITEM_WITHOUT_RENTAL_CONTRACT", "DESKTOP_STORAGE", "ENDING_CONTRACT", "HUB_IN_SAME_REGION_AS_LOCAL", "INACTIVE", "INVALID_ITEM_LOCATION", "INVALID_ORGANIZATION_STATUS", "INVALID_STATE", "ITEM_CONDITIONS_TO_UNARCHIVE_NOT_MET", "ITEM_NOT_VISIBLE_FOR_ORGANIZATION", "NON_DEVICE", "NOT_AT_WAREHOUSE", "NOT_AVAILABLE_FOR_REUSE", "NOT_A_RENTAL", "NOT_MANAGEABLE_BY_ORGANIZATION", "NOT_WITH_ASSIGNMENT", "NOT_WITH_USER", "NO_ACTIVE_ADDONS", "NO_ACTIVE_STORAGE_CONTRACT", "NO_LOCATION_FOR_STORAGE", "NO_LOGISTICS_FOR_STORAGE", "NO_VALID_ADDONS", "ONGOING_SERVICE", "OWNED_BY_DEEL", "OWNED_BY_ORGANIZATION", "OWNED_BY_PARTNER_ORGANIZATION", "PARTNER_CHILD_CONTRACT", "PENDING_DEVICE_REFRESH", "RENTAL_CONTRACT_AND_USER_REGION_DO_NOT_MATCH", "TEMPORARILY_UNAVAILABLE", "UNKNOWN", "USER_HAS_NO_COUNTRY", "USER_HAS_NO_SEAT", "WAITING_FOR_CLEARANCE", "WITH_LOANER_ASSIGNMENT", "WITH_NON_COLLECTED_ASSIGNMENT", "WITH_NON_DELIVERED_ASSIGNMENT", "WITH_PENDING_ASSIGNMENT", "WRONG_ASSIGNMENT_STATUS", "WRONG_CONTRACT_STATUS", "WRONG_TERMS_AND_CONDITIONS" ], "title": "ItAssetsAssetIdTransferPostResponsesContentApplicationJsonSchemaDataActionsArchiveOwnAssetDisabledReasonsItems", "type": "string" }, "ItAssetsAssetIdTransferPostResponsesContentApplicationJsonSchemaDataActionsArchiveOwnAssetStatus": { "description": "Whether the action is currently available for this asset", "enum": [ "DISABLED", "ENABLED", "NOT_APPLICABLE" ], "title": "ItAssetsAssetIdTransferPostResponsesContentApplicationJsonSchemaDataActionsArchiveOwnAssetStatus", "type": "string" }, "ItAssetsAssetIdTransferPostResponsesContentApplicationJsonSchemaDataActionsAssetCountry": { "description": "Resolved country used for asset actions. Derived from the asset's country,\nits assigned rental contract billing entity country, or the last active\nassignment delivery country. Null when the country cannot be determined\n(e.g. asset was returned to Deel)", "enum": [ "AD", "AE", "AF", "AG", "AI", "AL", "AM", "AN", "AO", "AQ", "AR", "AS", "AT", "AU", "AW", "AX", "AZ", "BA", "BB", "BD", "BE", "BF", "BG", "BH", "BI", "BJ", "BL", "BM", "BN", "BO", "BQ", "BR", "BS", "BT", "BV", "BW", "BY", "BZ", "CA", "CC", "CD", "CF", "CG", "CH", "CI", "CK", "CL", "CM", "CN", "CO", "CR", "CU", "CV", "CW", "CX", "CY", "CZ", "DE", "DJ", "DK", "DM", "DO", "DZ", "EC", "EE", "EG", "EH", "ER", "ES", "ET", "FI", "FJ", "FK", "FM", "FO", "FR", "GA", "GB", "GD", "GE", "GF", "GG", "GH", "GI", "GL", "GM", "GN", "GP", "GQ", "GR", "GS", "GT", "GU", "GW", "GY", "HK", "HM", "HN", "HR", "HT", "HU", "IC", "ID", "IE", "IL", "IM", "IN", "IO", "IQ", "IR", "IS", "IT", "JE", "JM", "JO", "JP", "KE", "KG", "KH", "KI", "KM", "KN", "KP", "KR", "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", "XK", "YE", "YT", "ZA", "ZM", "ZW" ], "title": "ItAssetsAssetIdTransferPostResponsesContentApplicationJsonSchemaDataActionsAssetCountry", "type": "string" }, "ItAssetsAssetIdTransferPostResponsesContentApplicationJsonSchemaDataActionsAssignAddonToOwnAsset": { "description": "Assign an add-on to an organization-owned asset", "properties": { "details": { "description": "Action-specific context needed to perform the action. Populated for enabled and\ndisabled actions (so callers can see what a successful attempt would look like);\nnull when the action is not applicable to this asset.", "oneOf": [ { "$ref": "#/components/schemas/ItAssetsAssetIdTransferPostResponsesContentApplicationJsonSchemaDataActionsAssignAddonToOwnAssetDetails" }, { "type": "null" } ] }, "disabled_reasons": { "description": "Reasons why the action is disabled. Empty when the action is enabled or not applicable", "items": { "$ref": "#/components/schemas/ItAssetsAssetIdTransferPostResponsesContentApplicationJsonSchemaDataActionsAssignAddonToOwnAssetDisabledReasonsItems" }, "type": "array" }, "status": { "$ref": "#/components/schemas/ItAssetsAssetIdTransferPostResponsesContentApplicationJsonSchemaDataActionsAssignAddonToOwnAssetStatus", "description": "Whether the action is currently available for this asset" } }, "required": [ "status", "details", "disabled_reasons" ], "title": "ItAssetsAssetIdTransferPostResponsesContentApplicationJsonSchemaDataActionsAssignAddonToOwnAsset", "type": "object" }, "ItAssetsAssetIdTransferPostResponsesContentApplicationJsonSchemaDataActionsAssignAddonToOwnAssetDetails": { "description": "Action-specific context needed to perform the action. Populated for enabled and\ndisabled actions (so callers can see what a successful attempt would look like);\nnull when the action is not applicable to this asset.", "properties": { "addons": { "description": "Add-ons that can be assigned to the asset, with a fail reason for those that don't qualify", "items": { "$ref": "#/components/schemas/ItAssetsAssetIdTransferPostResponsesContentApplicationJsonSchemaDataActionsAssignAddonToOwnAssetDetailsAddonsItems" }, "type": "array" } }, "required": [ "addons" ], "title": "ItAssetsAssetIdTransferPostResponsesContentApplicationJsonSchemaDataActionsAssignAddonToOwnAssetDetails", "type": "object" }, "ItAssetsAssetIdTransferPostResponsesContentApplicationJsonSchemaDataActionsAssignAddonToOwnAssetDetailsAddonsItems": { "properties": { "addon": { "$ref": "#/components/schemas/ItAssetsAssetIdTransferPostResponsesContentApplicationJsonSchemaDataActionsAssignAddonToOwnAssetDetailsAddonsItemsAddon", "description": "Add-on that can be assigned to the asset" }, "fail_reason": { "description": "Reason the add-on cannot be assigned to the asset. Null when assignment is allowed", "oneOf": [ { "$ref": "#/components/schemas/ItAssetsAssetIdTransferPostResponsesContentApplicationJsonSchemaDataActionsAssignAddonToOwnAssetDetailsAddonsItemsFailReason" }, { "type": "null" } ] } }, "required": [ "addon", "fail_reason" ], "title": "ItAssetsAssetIdTransferPostResponsesContentApplicationJsonSchemaDataActionsAssignAddonToOwnAssetDetailsAddonsItems", "type": "object" }, "ItAssetsAssetIdTransferPostResponsesContentApplicationJsonSchemaDataActionsAssignAddonToOwnAssetDetailsAddonsItemsAddon": { "description": "Add-on that can be assigned to the asset", "properties": { "id": { "description": "ID of the add-on", "format": "uuid", "type": "string" }, "name": { "description": "Public display name of the add-on", "type": "string" } }, "required": [ "id", "name" ], "title": "ItAssetsAssetIdTransferPostResponsesContentApplicationJsonSchemaDataActionsAssignAddonToOwnAssetDetailsAddonsItemsAddon", "type": "object" }, "ItAssetsAssetIdTransferPostResponsesContentApplicationJsonSchemaDataActionsAssignAddonToOwnAssetDetailsAddonsItemsFailReason": { "description": "Reason the add-on cannot be assigned to the asset. Null when assignment is allowed", "enum": [ "ADDON_NOT_AVAILABLE_TO_ORGANIZATION", "ALREADY_ASSIGNED", "HAS_ACTIVE_SERVICE_ADDON", "INVALID_ASSET_AGE", "INVALID_CONTRACT_TYPE", "INVALID_DURATION", "INVALID_PAYMENT_SCHEMA", "INVALID_PLATFORM_TIER", "INVALID_PRODUCT_BRAND", "INVALID_PRODUCT_CATEGORY", "INVALID_PRODUCT_PARENT_CATEGORY", "INVALID_RENTAL_TERM", "NO_MATCHING_ORGANIZATION_CONTRACT", "OTHER" ], "title": "ItAssetsAssetIdTransferPostResponsesContentApplicationJsonSchemaDataActionsAssignAddonToOwnAssetDetailsAddonsItemsFailReason", "type": "string" }, "ItAssetsAssetIdTransferPostResponsesContentApplicationJsonSchemaDataActionsAssignAddonToOwnAssetDisabledReasonsItems": { "enum": [ "ARCHIVED", "AT_DEEL_WAREHOUSE", "BEING_REPAIRED", "CONSUMABLE", "CONTROLLED_BY_DEEL", "COUNTRY_NOT_SUPPORTED_FOR_HUB", "COUNTRY_NOT_SUPPORTED_FOR_LOCAL", "DEEL_OWNED_ITEM_WITHOUT_RENTAL_CONTRACT", "DESKTOP_STORAGE", "ENDING_CONTRACT", "HUB_IN_SAME_REGION_AS_LOCAL", "INACTIVE", "INVALID_ITEM_LOCATION", "INVALID_ORGANIZATION_STATUS", "INVALID_STATE", "ITEM_CONDITIONS_TO_UNARCHIVE_NOT_MET", "ITEM_NOT_VISIBLE_FOR_ORGANIZATION", "NON_DEVICE", "NOT_AT_WAREHOUSE", "NOT_AVAILABLE_FOR_REUSE", "NOT_A_RENTAL", "NOT_MANAGEABLE_BY_ORGANIZATION", "NOT_WITH_ASSIGNMENT", "NOT_WITH_USER", "NO_ACTIVE_ADDONS", "NO_ACTIVE_STORAGE_CONTRACT", "NO_LOCATION_FOR_STORAGE", "NO_LOGISTICS_FOR_STORAGE", "NO_VALID_ADDONS", "ONGOING_SERVICE", "OWNED_BY_DEEL", "OWNED_BY_ORGANIZATION", "OWNED_BY_PARTNER_ORGANIZATION", "PARTNER_CHILD_CONTRACT", "PENDING_DEVICE_REFRESH", "RENTAL_CONTRACT_AND_USER_REGION_DO_NOT_MATCH", "TEMPORARILY_UNAVAILABLE", "UNKNOWN", "USER_HAS_NO_COUNTRY", "USER_HAS_NO_SEAT", "WAITING_FOR_CLEARANCE", "WITH_LOANER_ASSIGNMENT", "WITH_NON_COLLECTED_ASSIGNMENT", "WITH_NON_DELIVERED_ASSIGNMENT", "WITH_PENDING_ASSIGNMENT", "WRONG_ASSIGNMENT_STATUS", "WRONG_CONTRACT_STATUS", "WRONG_TERMS_AND_CONDITIONS" ], "title": "ItAssetsAssetIdTransferPostResponsesContentApplicationJsonSchemaDataActionsAssignAddonToOwnAssetDisabledReasonsItems", "type": "string" }, "ItAssetsAssetIdTransferPostResponsesContentApplicationJsonSchemaDataActionsAssignAddonToOwnAssetStatus": { "description": "Whether the action is currently available for this asset", "enum": [ "DISABLED", "ENABLED", "NOT_APPLICABLE" ], "title": "ItAssetsAssetIdTransferPostResponsesContentApplicationJsonSchemaDataActionsAssignAddonToOwnAssetStatus", "type": "string" }, "ItAssetsAssetIdTransferPostResponsesContentApplicationJsonSchemaDataActionsClearOwnAsset": { "description": "Clear an organization-owned asset from the fleet", "properties": { "disabled_reasons": { "description": "Reasons why the action is disabled. Empty when the action is enabled or not applicable", "items": { "$ref": "#/components/schemas/ItAssetsAssetIdTransferPostResponsesContentApplicationJsonSchemaDataActionsClearOwnAssetDisabledReasonsItems" }, "type": "array" }, "status": { "$ref": "#/components/schemas/ItAssetsAssetIdTransferPostResponsesContentApplicationJsonSchemaDataActionsClearOwnAssetStatus", "description": "Whether the action is currently available for this asset" } }, "required": [ "status", "disabled_reasons" ], "title": "ItAssetsAssetIdTransferPostResponsesContentApplicationJsonSchemaDataActionsClearOwnAsset", "type": "object" }, "ItAssetsAssetIdTransferPostResponsesContentApplicationJsonSchemaDataActionsClearOwnAssetDisabledReasonsItems": { "enum": [ "ARCHIVED", "AT_DEEL_WAREHOUSE", "BEING_REPAIRED", "CONSUMABLE", "CONTROLLED_BY_DEEL", "COUNTRY_NOT_SUPPORTED_FOR_HUB", "COUNTRY_NOT_SUPPORTED_FOR_LOCAL", "DEEL_OWNED_ITEM_WITHOUT_RENTAL_CONTRACT", "DESKTOP_STORAGE", "ENDING_CONTRACT", "HUB_IN_SAME_REGION_AS_LOCAL", "INACTIVE", "INVALID_ITEM_LOCATION", "INVALID_ORGANIZATION_STATUS", "INVALID_STATE", "ITEM_CONDITIONS_TO_UNARCHIVE_NOT_MET", "ITEM_NOT_VISIBLE_FOR_ORGANIZATION", "NON_DEVICE", "NOT_AT_WAREHOUSE", "NOT_AVAILABLE_FOR_REUSE", "NOT_A_RENTAL", "NOT_MANAGEABLE_BY_ORGANIZATION", "NOT_WITH_ASSIGNMENT", "NOT_WITH_USER", "NO_ACTIVE_ADDONS", "NO_ACTIVE_STORAGE_CONTRACT", "NO_LOCATION_FOR_STORAGE", "NO_LOGISTICS_FOR_STORAGE", "NO_VALID_ADDONS", "ONGOING_SERVICE", "OWNED_BY_DEEL", "OWNED_BY_ORGANIZATION", "OWNED_BY_PARTNER_ORGANIZATION", "PARTNER_CHILD_CONTRACT", "PENDING_DEVICE_REFRESH", "RENTAL_CONTRACT_AND_USER_REGION_DO_NOT_MATCH", "TEMPORARILY_UNAVAILABLE", "UNKNOWN", "USER_HAS_NO_COUNTRY", "USER_HAS_NO_SEAT", "WAITING_FOR_CLEARANCE", "WITH_LOANER_ASSIGNMENT", "WITH_NON_COLLECTED_ASSIGNMENT", "WITH_NON_DELIVERED_ASSIGNMENT", "WITH_PENDING_ASSIGNMENT", "WRONG_ASSIGNMENT_STATUS", "WRONG_CONTRACT_STATUS", "WRONG_TERMS_AND_CONDITIONS" ], "title": "ItAssetsAssetIdTransferPostResponsesContentApplicationJsonSchemaDataActionsClearOwnAssetDisabledReasonsItems", "type": "string" }, "ItAssetsAssetIdTransferPostResponsesContentApplicationJsonSchemaDataActionsClearOwnAssetStatus": { "description": "Whether the action is currently available for this asset", "enum": [ "DISABLED", "ENABLED", "NOT_APPLICABLE" ], "title": "ItAssetsAssetIdTransferPostResponsesContentApplicationJsonSchemaDataActionsClearOwnAssetStatus", "type": "string" }, "ItAssetsAssetIdTransferPostResponsesContentApplicationJsonSchemaDataActionsManageEndOfRentalContractActions": { "description": "Manage end-of-rental options for a Deel-owned rental asset", "properties": { "disabled_reasons": { "description": "Reasons why the action is disabled. Empty when the action is enabled or not applicable", "items": { "$ref": "#/components/schemas/ItAssetsAssetIdTransferPostResponsesContentApplicationJsonSchemaDataActionsManageEndOfRentalContractActionsDisabledReasonsItems" }, "type": "array" }, "status": { "$ref": "#/components/schemas/ItAssetsAssetIdTransferPostResponsesContentApplicationJsonSchemaDataActionsManageEndOfRentalContractActionsStatus", "description": "Whether the action is currently available for this asset" } }, "required": [ "status", "disabled_reasons" ], "title": "ItAssetsAssetIdTransferPostResponsesContentApplicationJsonSchemaDataActionsManageEndOfRentalContractActions", "type": "object" }, "ItAssetsAssetIdTransferPostResponsesContentApplicationJsonSchemaDataActionsManageEndOfRentalContractActionsDisabledReasonsItems": { "enum": [ "ARCHIVED", "AT_DEEL_WAREHOUSE", "BEING_REPAIRED", "CONSUMABLE", "CONTROLLED_BY_DEEL", "COUNTRY_NOT_SUPPORTED_FOR_HUB", "COUNTRY_NOT_SUPPORTED_FOR_LOCAL", "DEEL_OWNED_ITEM_WITHOUT_RENTAL_CONTRACT", "DESKTOP_STORAGE", "ENDING_CONTRACT", "HUB_IN_SAME_REGION_AS_LOCAL", "INACTIVE", "INVALID_ITEM_LOCATION", "INVALID_ORGANIZATION_STATUS", "INVALID_STATE", "ITEM_CONDITIONS_TO_UNARCHIVE_NOT_MET", "ITEM_NOT_VISIBLE_FOR_ORGANIZATION", "NON_DEVICE", "NOT_AT_WAREHOUSE", "NOT_AVAILABLE_FOR_REUSE", "NOT_A_RENTAL", "NOT_MANAGEABLE_BY_ORGANIZATION", "NOT_WITH_ASSIGNMENT", "NOT_WITH_USER", "NO_ACTIVE_ADDONS", "NO_ACTIVE_STORAGE_CONTRACT", "NO_LOCATION_FOR_STORAGE", "NO_LOGISTICS_FOR_STORAGE", "NO_VALID_ADDONS", "ONGOING_SERVICE", "OWNED_BY_DEEL", "OWNED_BY_ORGANIZATION", "OWNED_BY_PARTNER_ORGANIZATION", "PARTNER_CHILD_CONTRACT", "PENDING_DEVICE_REFRESH", "RENTAL_CONTRACT_AND_USER_REGION_DO_NOT_MATCH", "TEMPORARILY_UNAVAILABLE", "UNKNOWN", "USER_HAS_NO_COUNTRY", "USER_HAS_NO_SEAT", "WAITING_FOR_CLEARANCE", "WITH_LOANER_ASSIGNMENT", "WITH_NON_COLLECTED_ASSIGNMENT", "WITH_NON_DELIVERED_ASSIGNMENT", "WITH_PENDING_ASSIGNMENT", "WRONG_ASSIGNMENT_STATUS", "WRONG_CONTRACT_STATUS", "WRONG_TERMS_AND_CONDITIONS" ], "title": "ItAssetsAssetIdTransferPostResponsesContentApplicationJsonSchemaDataActionsManageEndOfRentalContractActionsDisabledReasonsItems", "type": "string" }, "ItAssetsAssetIdTransferPostResponsesContentApplicationJsonSchemaDataActionsManageEndOfRentalContractActionsStatus": { "description": "Whether the action is currently available for this asset", "enum": [ "DISABLED", "ENABLED", "NOT_APPLICABLE" ], "title": "ItAssetsAssetIdTransferPostResponsesContentApplicationJsonSchemaDataActionsManageEndOfRentalContractActionsStatus", "type": "string" }, "ItAssetsAssetIdTransferPostResponsesContentApplicationJsonSchemaDataActionsPurchaseRental": { "description": "Purchase a Deel-owned rental asset at end of contract", "properties": { "details": { "description": "Action-specific context needed to perform the action. Populated for enabled and\ndisabled actions (so callers can see what a successful attempt would look like);\nnull when the action is not applicable to this asset.", "oneOf": [ { "$ref": "#/components/schemas/ItAssetsAssetIdTransferPostResponsesContentApplicationJsonSchemaDataActionsPurchaseRentalDetails" }, { "type": "null" } ] }, "disabled_reasons": { "description": "Reasons why the action is disabled. Empty when the action is enabled or not applicable", "items": { "$ref": "#/components/schemas/ItAssetsAssetIdTransferPostResponsesContentApplicationJsonSchemaDataActionsPurchaseRentalDisabledReasonsItems" }, "type": "array" }, "status": { "$ref": "#/components/schemas/ItAssetsAssetIdTransferPostResponsesContentApplicationJsonSchemaDataActionsPurchaseRentalStatus", "description": "Whether the action is currently available for this asset" } }, "required": [ "status", "details", "disabled_reasons" ], "title": "ItAssetsAssetIdTransferPostResponsesContentApplicationJsonSchemaDataActionsPurchaseRental", "type": "object" }, "ItAssetsAssetIdTransferPostResponsesContentApplicationJsonSchemaDataActionsPurchaseRentalDetails": { "description": "Action-specific context needed to perform the action. Populated for enabled and\ndisabled actions (so callers can see what a successful attempt would look like);\nnull when the action is not applicable to this asset.", "properties": { "purchase_price": { "description": "Estimated price to purchase the asset at the end of the rental contract", "oneOf": [ { "$ref": "#/components/schemas/ItAssetsAssetIdTransferPostResponsesContentApplicationJsonSchemaDataActionsPurchaseRentalDetailsPurchasePrice" }, { "type": "null" } ] }, "remaining_contract_value": { "$ref": "#/components/schemas/ItAssetsAssetIdTransferPostResponsesContentApplicationJsonSchemaDataActionsPurchaseRentalDetailsRemainingContractValue", "description": "Estimated remaining value of the rental contract" }, "total_purchase_price": { "description": "Estimated total price of the purchase, including any remaining contract value", "oneOf": [ { "$ref": "#/components/schemas/ItAssetsAssetIdTransferPostResponsesContentApplicationJsonSchemaDataActionsPurchaseRentalDetailsTotalPurchasePrice" }, { "type": "null" } ] } }, "required": [ "purchase_price", "total_purchase_price", "remaining_contract_value" ], "title": "ItAssetsAssetIdTransferPostResponsesContentApplicationJsonSchemaDataActionsPurchaseRentalDetails", "type": "object" }, "ItAssetsAssetIdTransferPostResponsesContentApplicationJsonSchemaDataActionsPurchaseRentalDetailsPurchasePrice": { "description": "Estimated price to purchase the asset at the end of the rental contract", "properties": { "amount": { "description": "Amount", "format": "decimal", "type": "string" }, "currency": { "$ref": "#/components/schemas/ItAssetsAssetIdTransferPostResponsesContentApplicationJsonSchemaDataActionsPurchaseRentalDetailsPurchasePriceCurrency", "description": "Three-letter currency code for the price" } }, "required": [ "amount", "currency" ], "title": "ItAssetsAssetIdTransferPostResponsesContentApplicationJsonSchemaDataActionsPurchaseRentalDetailsPurchasePrice", "type": "object" }, "ItAssetsAssetIdTransferPostResponsesContentApplicationJsonSchemaDataActionsPurchaseRentalDetailsPurchasePriceCurrency": { "description": "Three-letter currency code for the price", "enum": [ "AED", "AFN", "ALL", "AMD", "ANG", "AOA", "ARS", "AUD", "AWG", "AZN", "BAM", "BDT", "BGN", "BHD", "BIF", "BMD", "BOB", "BRL", "BSD", "BTN", "BWP", "BYN", "BZD", "CAD", "CDF", "CHF", "CLP", "CNY", "COP", "CRC", "CUC", "CVE", "CZK", "DJF", "DKK", "DOP", "DZD", "EGP", "ERN", "ETB", "EUR", "FJD", "FKP", "GBP", "GEL", "GHS", "GIP", "GMD", "GNF", "GTQ", "GYD", "HKD", "HNL", "HRK", "HTG", "HUF", "IDR", "ILS", "INR", "IQD", "IRR", "ISK", "JMD", "JOD", "JPY", "KES", "KGS", "KHR", "KMF", "KPW", "KRW", "KWD", "KYD", "KZT", "LAK", "LBP", "LKR", "LRD", "LSL", "LTL", "LYD", "MAD", "MDL", "MGA", "MKD", "MMK", "MNT", "MRU", "MUR", "MVR", "MWK", "MXN", "MYR", "MZN", "NAD", "NGN", "NIO", "NOK", "NPR", "NZD", "OMR", "PAB", "PEN", "PGK", "PHP", "PKR", "PLN", "PYG", "QAR", "RON", "RSD", "RUB", "RWF", "SAR", "SBD", "SCR", "SDG", "SEK", "SGD", "SHP", "SLL", "SOS", "SRD", "SSP", "STD", "SYP", "SZL", "THB", "TJS", "TMT", "TND", "TOP", "TRY", "TTD", "TWD", "TZS", "UAH", "UGX", "USD", "UYU", "UZS", "VEF", "VND", "VUV", "WST", "XAF", "XCD", "XOF", "XPF", "YER", "ZAR", "ZMW", "ZWD" ], "title": "ItAssetsAssetIdTransferPostResponsesContentApplicationJsonSchemaDataActionsPurchaseRentalDetailsPurchasePriceCurrency", "type": "string" }, "ItAssetsAssetIdTransferPostResponsesContentApplicationJsonSchemaDataActionsPurchaseRentalDetailsRemainingContractValue": { "description": "Estimated remaining value of the rental contract", "properties": { "amount": { "description": "Amount", "format": "decimal", "type": "string" }, "currency": { "$ref": "#/components/schemas/ItAssetsAssetIdTransferPostResponsesContentApplicationJsonSchemaDataActionsPurchaseRentalDetailsRemainingContractValueCurrency", "description": "Three-letter currency code for the price" } }, "required": [ "amount", "currency" ], "title": "ItAssetsAssetIdTransferPostResponsesContentApplicationJsonSchemaDataActionsPurchaseRentalDetailsRemainingContractValue", "type": "object" }, "ItAssetsAssetIdTransferPostResponsesContentApplicationJsonSchemaDataActionsPurchaseRentalDetailsRemainingContractValueCurrency": { "description": "Three-letter currency code for the price", "enum": [ "AED", "AFN", "ALL", "AMD", "ANG", "AOA", "ARS", "AUD", "AWG", "AZN", "BAM", "BDT", "BGN", "BHD", "BIF", "BMD", "BOB", "BRL", "BSD", "BTN", "BWP", "BYN", "BZD", "CAD", "CDF", "CHF", "CLP", "CNY", "COP", "CRC", "CUC", "CVE", "CZK", "DJF", "DKK", "DOP", "DZD", "EGP", "ERN", "ETB", "EUR", "FJD", "FKP", "GBP", "GEL", "GHS", "GIP", "GMD", "GNF", "GTQ", "GYD", "HKD", "HNL", "HRK", "HTG", "HUF", "IDR", "ILS", "INR", "IQD", "IRR", "ISK", "JMD", "JOD", "JPY", "KES", "KGS", "KHR", "KMF", "KPW", "KRW", "KWD", "KYD", "KZT", "LAK", "LBP", "LKR", "LRD", "LSL", "LTL", "LYD", "MAD", "MDL", "MGA", "MKD", "MMK", "MNT", "MRU", "MUR", "MVR", "MWK", "MXN", "MYR", "MZN", "NAD", "NGN", "NIO", "NOK", "NPR", "NZD", "OMR", "PAB", "PEN", "PGK", "PHP", "PKR", "PLN", "PYG", "QAR", "RON", "RSD", "RUB", "RWF", "SAR", "SBD", "SCR", "SDG", "SEK", "SGD", "SHP", "SLL", "SOS", "SRD", "SSP", "STD", "SYP", "SZL", "THB", "TJS", "TMT", "TND", "TOP", "TRY", "TTD", "TWD", "TZS", "UAH", "UGX", "USD", "UYU", "UZS", "VEF", "VND", "VUV", "WST", "XAF", "XCD", "XOF", "XPF", "YER", "ZAR", "ZMW", "ZWD" ], "title": "ItAssetsAssetIdTransferPostResponsesContentApplicationJsonSchemaDataActionsPurchaseRentalDetailsRemainingContractValueCurrency", "type": "string" }, "ItAssetsAssetIdTransferPostResponsesContentApplicationJsonSchemaDataActionsPurchaseRentalDetailsTotalPurchasePrice": { "description": "Estimated total price of the purchase, including any remaining contract value", "properties": { "amount": { "description": "Amount", "format": "decimal", "type": "string" }, "currency": { "$ref": "#/components/schemas/ItAssetsAssetIdTransferPostResponsesContentApplicationJsonSchemaDataActionsPurchaseRentalDetailsTotalPurchasePriceCurrency", "description": "Three-letter currency code for the price" } }, "required": [ "amount", "currency" ], "title": "ItAssetsAssetIdTransferPostResponsesContentApplicationJsonSchemaDataActionsPurchaseRentalDetailsTotalPurchasePrice", "type": "object" }, "ItAssetsAssetIdTransferPostResponsesContentApplicationJsonSchemaDataActionsPurchaseRentalDetailsTotalPurchasePriceCurrency": { "description": "Three-letter currency code for the price", "enum": [ "AED", "AFN", "ALL", "AMD", "ANG", "AOA", "ARS", "AUD", "AWG", "AZN", "BAM", "BDT", "BGN", "BHD", "BIF", "BMD", "BOB", "BRL", "BSD", "BTN", "BWP", "BYN", "BZD", "CAD", "CDF", "CHF", "CLP", "CNY", "COP", "CRC", "CUC", "CVE", "CZK", "DJF", "DKK", "DOP", "DZD", "EGP", "ERN", "ETB", "EUR", "FJD", "FKP", "GBP", "GEL", "GHS", "GIP", "GMD", "GNF", "GTQ", "GYD", "HKD", "HNL", "HRK", "HTG", "HUF", "IDR", "ILS", "INR", "IQD", "IRR", "ISK", "JMD", "JOD", "JPY", "KES", "KGS", "KHR", "KMF", "KPW", "KRW", "KWD", "KYD", "KZT", "LAK", "LBP", "LKR", "LRD", "LSL", "LTL", "LYD", "MAD", "MDL", "MGA", "MKD", "MMK", "MNT", "MRU", "MUR", "MVR", "MWK", "MXN", "MYR", "MZN", "NAD", "NGN", "NIO", "NOK", "NPR", "NZD", "OMR", "PAB", "PEN", "PGK", "PHP", "PKR", "PLN", "PYG", "QAR", "RON", "RSD", "RUB", "RWF", "SAR", "SBD", "SCR", "SDG", "SEK", "SGD", "SHP", "SLL", "SOS", "SRD", "SSP", "STD", "SYP", "SZL", "THB", "TJS", "TMT", "TND", "TOP", "TRY", "TTD", "TWD", "TZS", "UAH", "UGX", "USD", "UYU", "UZS", "VEF", "VND", "VUV", "WST", "XAF", "XCD", "XOF", "XPF", "YER", "ZAR", "ZMW", "ZWD" ], "title": "ItAssetsAssetIdTransferPostResponsesContentApplicationJsonSchemaDataActionsPurchaseRentalDetailsTotalPurchasePriceCurrency", "type": "string" }, "ItAssetsAssetIdTransferPostResponsesContentApplicationJsonSchemaDataActionsPurchaseRentalDisabledReasonsItems": { "enum": [ "ARCHIVED", "AT_DEEL_WAREHOUSE", "BEING_REPAIRED", "CONSUMABLE", "CONTROLLED_BY_DEEL", "COUNTRY_NOT_SUPPORTED_FOR_HUB", "COUNTRY_NOT_SUPPORTED_FOR_LOCAL", "DEEL_OWNED_ITEM_WITHOUT_RENTAL_CONTRACT", "DESKTOP_STORAGE", "ENDING_CONTRACT", "HUB_IN_SAME_REGION_AS_LOCAL", "INACTIVE", "INVALID_ITEM_LOCATION", "INVALID_ORGANIZATION_STATUS", "INVALID_STATE", "ITEM_CONDITIONS_TO_UNARCHIVE_NOT_MET", "ITEM_NOT_VISIBLE_FOR_ORGANIZATION", "NON_DEVICE", "NOT_AT_WAREHOUSE", "NOT_AVAILABLE_FOR_REUSE", "NOT_A_RENTAL", "NOT_MANAGEABLE_BY_ORGANIZATION", "NOT_WITH_ASSIGNMENT", "NOT_WITH_USER", "NO_ACTIVE_ADDONS", "NO_ACTIVE_STORAGE_CONTRACT", "NO_LOCATION_FOR_STORAGE", "NO_LOGISTICS_FOR_STORAGE", "NO_VALID_ADDONS", "ONGOING_SERVICE", "OWNED_BY_DEEL", "OWNED_BY_ORGANIZATION", "OWNED_BY_PARTNER_ORGANIZATION", "PARTNER_CHILD_CONTRACT", "PENDING_DEVICE_REFRESH", "RENTAL_CONTRACT_AND_USER_REGION_DO_NOT_MATCH", "TEMPORARILY_UNAVAILABLE", "UNKNOWN", "USER_HAS_NO_COUNTRY", "USER_HAS_NO_SEAT", "WAITING_FOR_CLEARANCE", "WITH_LOANER_ASSIGNMENT", "WITH_NON_COLLECTED_ASSIGNMENT", "WITH_NON_DELIVERED_ASSIGNMENT", "WITH_PENDING_ASSIGNMENT", "WRONG_ASSIGNMENT_STATUS", "WRONG_CONTRACT_STATUS", "WRONG_TERMS_AND_CONDITIONS" ], "title": "ItAssetsAssetIdTransferPostResponsesContentApplicationJsonSchemaDataActionsPurchaseRentalDisabledReasonsItems", "type": "string" }, "ItAssetsAssetIdTransferPostResponsesContentApplicationJsonSchemaDataActionsPurchaseRentalStatus": { "description": "Whether the action is currently available for this asset", "enum": [ "DISABLED", "ENABLED", "NOT_APPLICABLE" ], "title": "ItAssetsAssetIdTransferPostResponsesContentApplicationJsonSchemaDataActionsPurchaseRentalStatus", "type": "string" }, "ItAssetsAssetIdTransferPostResponsesContentApplicationJsonSchemaDataActionsReturnRentalToDeel": { "description": "Return a Deel-owned rental asset back to Deel", "properties": { "details": { "description": "Action-specific context needed to perform the action. Populated for enabled and\ndisabled actions (so callers can see what a successful attempt would look like);\nnull when the action is not applicable to this asset.", "oneOf": [ { "$ref": "#/components/schemas/ItAssetsAssetIdTransferPostResponsesContentApplicationJsonSchemaDataActionsReturnRentalToDeelDetails" }, { "type": "null" } ] }, "disabled_reasons": { "description": "Reasons why the action is disabled. Empty when the action is enabled or not applicable", "items": { "$ref": "#/components/schemas/ItAssetsAssetIdTransferPostResponsesContentApplicationJsonSchemaDataActionsReturnRentalToDeelDisabledReasonsItems" }, "type": "array" }, "status": { "$ref": "#/components/schemas/ItAssetsAssetIdTransferPostResponsesContentApplicationJsonSchemaDataActionsReturnRentalToDeelStatus", "description": "Whether the action is currently available for this asset" } }, "required": [ "status", "details", "disabled_reasons" ], "title": "ItAssetsAssetIdTransferPostResponsesContentApplicationJsonSchemaDataActionsReturnRentalToDeel", "type": "object" }, "ItAssetsAssetIdTransferPostResponsesContentApplicationJsonSchemaDataActionsReturnRentalToDeelDetails": { "description": "Action-specific context needed to perform the action. Populated for enabled and\ndisabled actions (so callers can see what a successful attempt would look like);\nnull when the action is not applicable to this asset.", "properties": { "end_contract_price": { "$ref": "#/components/schemas/ItAssetsAssetIdTransferPostResponsesContentApplicationJsonSchemaDataActionsReturnRentalToDeelDetailsEndContractPrice", "description": "Estimated end-of-contract price charged when returning the asset" } }, "required": [ "end_contract_price" ], "title": "ItAssetsAssetIdTransferPostResponsesContentApplicationJsonSchemaDataActionsReturnRentalToDeelDetails", "type": "object" }, "ItAssetsAssetIdTransferPostResponsesContentApplicationJsonSchemaDataActionsReturnRentalToDeelDetailsEndContractPrice": { "description": "Estimated end-of-contract price charged when returning the asset", "properties": { "amount": { "description": "Amount", "format": "decimal", "type": "string" }, "currency": { "$ref": "#/components/schemas/ItAssetsAssetIdTransferPostResponsesContentApplicationJsonSchemaDataActionsReturnRentalToDeelDetailsEndContractPriceCurrency", "description": "Three-letter currency code for the price" } }, "required": [ "amount", "currency" ], "title": "ItAssetsAssetIdTransferPostResponsesContentApplicationJsonSchemaDataActionsReturnRentalToDeelDetailsEndContractPrice", "type": "object" }, "ItAssetsAssetIdTransferPostResponsesContentApplicationJsonSchemaDataActionsReturnRentalToDeelDetailsEndContractPriceCurrency": { "description": "Three-letter currency code for the price", "enum": [ "AED", "AFN", "ALL", "AMD", "ANG", "AOA", "ARS", "AUD", "AWG", "AZN", "BAM", "BDT", "BGN", "BHD", "BIF", "BMD", "BOB", "BRL", "BSD", "BTN", "BWP", "BYN", "BZD", "CAD", "CDF", "CHF", "CLP", "CNY", "COP", "CRC", "CUC", "CVE", "CZK", "DJF", "DKK", "DOP", "DZD", "EGP", "ERN", "ETB", "EUR", "FJD", "FKP", "GBP", "GEL", "GHS", "GIP", "GMD", "GNF", "GTQ", "GYD", "HKD", "HNL", "HRK", "HTG", "HUF", "IDR", "ILS", "INR", "IQD", "IRR", "ISK", "JMD", "JOD", "JPY", "KES", "KGS", "KHR", "KMF", "KPW", "KRW", "KWD", "KYD", "KZT", "LAK", "LBP", "LKR", "LRD", "LSL", "LTL", "LYD", "MAD", "MDL", "MGA", "MKD", "MMK", "MNT", "MRU", "MUR", "MVR", "MWK", "MXN", "MYR", "MZN", "NAD", "NGN", "NIO", "NOK", "NPR", "NZD", "OMR", "PAB", "PEN", "PGK", "PHP", "PKR", "PLN", "PYG", "QAR", "RON", "RSD", "RUB", "RWF", "SAR", "SBD", "SCR", "SDG", "SEK", "SGD", "SHP", "SLL", "SOS", "SRD", "SSP", "STD", "SYP", "SZL", "THB", "TJS", "TMT", "TND", "TOP", "TRY", "TTD", "TWD", "TZS", "UAH", "UGX", "USD", "UYU", "UZS", "VEF", "VND", "VUV", "WST", "XAF", "XCD", "XOF", "XPF", "YER", "ZAR", "ZMW", "ZWD" ], "title": "ItAssetsAssetIdTransferPostResponsesContentApplicationJsonSchemaDataActionsReturnRentalToDeelDetailsEndContractPriceCurrency", "type": "string" }, "ItAssetsAssetIdTransferPostResponsesContentApplicationJsonSchemaDataActionsReturnRentalToDeelDisabledReasonsItems": { "enum": [ "ARCHIVED", "AT_DEEL_WAREHOUSE", "BEING_REPAIRED", "CONSUMABLE", "CONTROLLED_BY_DEEL", "COUNTRY_NOT_SUPPORTED_FOR_HUB", "COUNTRY_NOT_SUPPORTED_FOR_LOCAL", "DEEL_OWNED_ITEM_WITHOUT_RENTAL_CONTRACT", "DESKTOP_STORAGE", "ENDING_CONTRACT", "HUB_IN_SAME_REGION_AS_LOCAL", "INACTIVE", "INVALID_ITEM_LOCATION", "INVALID_ORGANIZATION_STATUS", "INVALID_STATE", "ITEM_CONDITIONS_TO_UNARCHIVE_NOT_MET", "ITEM_NOT_VISIBLE_FOR_ORGANIZATION", "NON_DEVICE", "NOT_AT_WAREHOUSE", "NOT_AVAILABLE_FOR_REUSE", "NOT_A_RENTAL", "NOT_MANAGEABLE_BY_ORGANIZATION", "NOT_WITH_ASSIGNMENT", "NOT_WITH_USER", "NO_ACTIVE_ADDONS", "NO_ACTIVE_STORAGE_CONTRACT", "NO_LOCATION_FOR_STORAGE", "NO_LOGISTICS_FOR_STORAGE", "NO_VALID_ADDONS", "ONGOING_SERVICE", "OWNED_BY_DEEL", "OWNED_BY_ORGANIZATION", "OWNED_BY_PARTNER_ORGANIZATION", "PARTNER_CHILD_CONTRACT", "PENDING_DEVICE_REFRESH", "RENTAL_CONTRACT_AND_USER_REGION_DO_NOT_MATCH", "TEMPORARILY_UNAVAILABLE", "UNKNOWN", "USER_HAS_NO_COUNTRY", "USER_HAS_NO_SEAT", "WAITING_FOR_CLEARANCE", "WITH_LOANER_ASSIGNMENT", "WITH_NON_COLLECTED_ASSIGNMENT", "WITH_NON_DELIVERED_ASSIGNMENT", "WITH_PENDING_ASSIGNMENT", "WRONG_ASSIGNMENT_STATUS", "WRONG_CONTRACT_STATUS", "WRONG_TERMS_AND_CONDITIONS" ], "title": "ItAssetsAssetIdTransferPostResponsesContentApplicationJsonSchemaDataActionsReturnRentalToDeelDisabledReasonsItems", "type": "string" }, "ItAssetsAssetIdTransferPostResponsesContentApplicationJsonSchemaDataActionsReturnRentalToDeelStatus": { "description": "Whether the action is currently available for this asset", "enum": [ "DISABLED", "ENABLED", "NOT_APPLICABLE" ], "title": "ItAssetsAssetIdTransferPostResponsesContentApplicationJsonSchemaDataActionsReturnRentalToDeelStatus", "type": "string" }, "ItAssetsAssetIdTransferPostResponsesContentApplicationJsonSchemaDataActionsReuseOwnAssetFromDeel": { "description": "Redeploy an organization-owned asset stored at a Deel warehouse", "properties": { "details": { "description": "Action-specific context needed to perform the action. Populated for enabled and\ndisabled actions (so callers can see what a successful attempt would look like);\nnull when the action is not applicable to this asset.", "oneOf": [ { "$ref": "#/components/schemas/ItAssetsAssetIdTransferPostResponsesContentApplicationJsonSchemaDataActionsReuseOwnAssetFromDeelDetails" }, { "type": "null" } ] }, "disabled_reasons": { "description": "Reasons why the action is disabled. Empty when the action is enabled or not applicable", "items": { "$ref": "#/components/schemas/ItAssetsAssetIdTransferPostResponsesContentApplicationJsonSchemaDataActionsReuseOwnAssetFromDeelDisabledReasonsItems" }, "type": "array" }, "status": { "$ref": "#/components/schemas/ItAssetsAssetIdTransferPostResponsesContentApplicationJsonSchemaDataActionsReuseOwnAssetFromDeelStatus", "description": "Whether the action is currently available for this asset" } }, "required": [ "status", "details", "disabled_reasons" ], "title": "ItAssetsAssetIdTransferPostResponsesContentApplicationJsonSchemaDataActionsReuseOwnAssetFromDeel", "type": "object" }, "ItAssetsAssetIdTransferPostResponsesContentApplicationJsonSchemaDataActionsReuseOwnAssetFromDeelDetails": { "description": "Action-specific context needed to perform the action. Populated for enabled and\ndisabled actions (so callers can see what a successful attempt would look like);\nnull when the action is not applicable to this asset.", "properties": { "eligible_countries": { "description": "Countries where the asset can be redeployed from Deel", "items": { "$ref": "#/components/schemas/ItAssetsAssetIdTransferPostResponsesContentApplicationJsonSchemaDataActionsReuseOwnAssetFromDeelDetailsEligibleCountriesItems" }, "type": "array" }, "express_delivery": { "description": "Express delivery availability and per-country fees. Null when express delivery is not supported", "oneOf": [ { "$ref": "#/components/schemas/ItAssetsAssetIdTransferPostResponsesContentApplicationJsonSchemaDataActionsReuseOwnAssetFromDeelDetailsExpressDelivery" }, { "type": "null" } ] } }, "required": [ "express_delivery", "eligible_countries" ], "title": "ItAssetsAssetIdTransferPostResponsesContentApplicationJsonSchemaDataActionsReuseOwnAssetFromDeelDetails", "type": "object" }, "ItAssetsAssetIdTransferPostResponsesContentApplicationJsonSchemaDataActionsReuseOwnAssetFromDeelDetailsEligibleCountriesItems": { "enum": [ "AD", "AE", "AF", "AG", "AI", "AL", "AM", "AN", "AO", "AQ", "AR", "AS", "AT", "AU", "AW", "AX", "AZ", "BA", "BB", "BD", "BE", "BF", "BG", "BH", "BI", "BJ", "BL", "BM", "BN", "BO", "BQ", "BR", "BS", "BT", "BV", "BW", "BY", "BZ", "CA", "CC", "CD", "CF", "CG", "CH", "CI", "CK", "CL", "CM", "CN", "CO", "CR", "CU", "CV", "CW", "CX", "CY", "CZ", "DE", "DJ", "DK", "DM", "DO", "DZ", "EC", "EE", "EG", "EH", "ER", "ES", "ET", "FI", "FJ", "FK", "FM", "FO", "FR", "GA", "GB", "GD", "GE", "GF", "GG", "GH", "GI", "GL", "GM", "GN", "GP", "GQ", "GR", "GS", "GT", "GU", "GW", "GY", "HK", "HM", "HN", "HR", "HT", "HU", "IC", "ID", "IE", "IL", "IM", "IN", "IO", "IQ", "IR", "IS", "IT", "JE", "JM", "JO", "JP", "KE", "KG", "KH", "KI", "KM", "KN", "KP", "KR", "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", "XK", "YE", "YT", "ZA", "ZM", "ZW" ], "title": "ItAssetsAssetIdTransferPostResponsesContentApplicationJsonSchemaDataActionsReuseOwnAssetFromDeelDetailsEligibleCountriesItems", "type": "string" }, "ItAssetsAssetIdTransferPostResponsesContentApplicationJsonSchemaDataActionsReuseOwnAssetFromDeelDetailsExpressDelivery": { "description": "Express delivery availability and per-country fees. Null when express delivery is not supported", "properties": { "country_fees": { "additionalProperties": { "$ref": "#/components/schemas/ItAssetsAssetIdTransferPostResponsesContentApplicationJsonSchemaDataActionsReuseOwnAssetFromDeelDetailsExpressDeliveryCountryFees" }, "description": "Express delivery fees keyed by destination country.", "type": "object" } }, "required": [ "country_fees" ], "title": "ItAssetsAssetIdTransferPostResponsesContentApplicationJsonSchemaDataActionsReuseOwnAssetFromDeelDetailsExpressDelivery", "type": "object" }, "ItAssetsAssetIdTransferPostResponsesContentApplicationJsonSchemaDataActionsReuseOwnAssetFromDeelDetailsExpressDeliveryCountryFees": { "properties": { "amount": { "description": "Amount", "format": "decimal", "type": "string" }, "currency": { "$ref": "#/components/schemas/ItAssetsAssetIdTransferPostResponsesContentApplicationJsonSchemaDataActionsReuseOwnAssetFromDeelDetailsExpressDeliveryCountryFeesCurrency", "description": "Three-letter currency code for the price" } }, "required": [ "amount", "currency" ], "title": "ItAssetsAssetIdTransferPostResponsesContentApplicationJsonSchemaDataActionsReuseOwnAssetFromDeelDetailsExpressDeliveryCountryFees", "type": "object" }, "ItAssetsAssetIdTransferPostResponsesContentApplicationJsonSchemaDataActionsReuseOwnAssetFromDeelDetailsExpressDeliveryCountryFeesCurrency": { "description": "Three-letter currency code for the price", "enum": [ "AED", "AFN", "ALL", "AMD", "ANG", "AOA", "ARS", "AUD", "AWG", "AZN", "BAM", "BDT", "BGN", "BHD", "BIF", "BMD", "BOB", "BRL", "BSD", "BTN", "BWP", "BYN", "BZD", "CAD", "CDF", "CHF", "CLP", "CNY", "COP", "CRC", "CUC", "CVE", "CZK", "DJF", "DKK", "DOP", "DZD", "EGP", "ERN", "ETB", "EUR", "FJD", "FKP", "GBP", "GEL", "GHS", "GIP", "GMD", "GNF", "GTQ", "GYD", "HKD", "HNL", "HRK", "HTG", "HUF", "IDR", "ILS", "INR", "IQD", "IRR", "ISK", "JMD", "JOD", "JPY", "KES", "KGS", "KHR", "KMF", "KPW", "KRW", "KWD", "KYD", "KZT", "LAK", "LBP", "LKR", "LRD", "LSL", "LTL", "LYD", "MAD", "MDL", "MGA", "MKD", "MMK", "MNT", "MRU", "MUR", "MVR", "MWK", "MXN", "MYR", "MZN", "NAD", "NGN", "NIO", "NOK", "NPR", "NZD", "OMR", "PAB", "PEN", "PGK", "PHP", "PKR", "PLN", "PYG", "QAR", "RON", "RSD", "RUB", "RWF", "SAR", "SBD", "SCR", "SDG", "SEK", "SGD", "SHP", "SLL", "SOS", "SRD", "SSP", "STD", "SYP", "SZL", "THB", "TJS", "TMT", "TND", "TOP", "TRY", "TTD", "TWD", "TZS", "UAH", "UGX", "USD", "UYU", "UZS", "VEF", "VND", "VUV", "WST", "XAF", "XCD", "XOF", "XPF", "YER", "ZAR", "ZMW", "ZWD" ], "title": "ItAssetsAssetIdTransferPostResponsesContentApplicationJsonSchemaDataActionsReuseOwnAssetFromDeelDetailsExpressDeliveryCountryFeesCurrency", "type": "string" }, "ItAssetsAssetIdTransferPostResponsesContentApplicationJsonSchemaDataActionsReuseOwnAssetFromDeelDisabledReasonsItems": { "enum": [ "ARCHIVED", "AT_DEEL_WAREHOUSE", "BEING_REPAIRED", "CONSUMABLE", "CONTROLLED_BY_DEEL", "COUNTRY_NOT_SUPPORTED_FOR_HUB", "COUNTRY_NOT_SUPPORTED_FOR_LOCAL", "DEEL_OWNED_ITEM_WITHOUT_RENTAL_CONTRACT", "DESKTOP_STORAGE", "ENDING_CONTRACT", "HUB_IN_SAME_REGION_AS_LOCAL", "INACTIVE", "INVALID_ITEM_LOCATION", "INVALID_ORGANIZATION_STATUS", "INVALID_STATE", "ITEM_CONDITIONS_TO_UNARCHIVE_NOT_MET", "ITEM_NOT_VISIBLE_FOR_ORGANIZATION", "NON_DEVICE", "NOT_AT_WAREHOUSE", "NOT_AVAILABLE_FOR_REUSE", "NOT_A_RENTAL", "NOT_MANAGEABLE_BY_ORGANIZATION", "NOT_WITH_ASSIGNMENT", "NOT_WITH_USER", "NO_ACTIVE_ADDONS", "NO_ACTIVE_STORAGE_CONTRACT", "NO_LOCATION_FOR_STORAGE", "NO_LOGISTICS_FOR_STORAGE", "NO_VALID_ADDONS", "ONGOING_SERVICE", "OWNED_BY_DEEL", "OWNED_BY_ORGANIZATION", "OWNED_BY_PARTNER_ORGANIZATION", "PARTNER_CHILD_CONTRACT", "PENDING_DEVICE_REFRESH", "RENTAL_CONTRACT_AND_USER_REGION_DO_NOT_MATCH", "TEMPORARILY_UNAVAILABLE", "UNKNOWN", "USER_HAS_NO_COUNTRY", "USER_HAS_NO_SEAT", "WAITING_FOR_CLEARANCE", "WITH_LOANER_ASSIGNMENT", "WITH_NON_COLLECTED_ASSIGNMENT", "WITH_NON_DELIVERED_ASSIGNMENT", "WITH_PENDING_ASSIGNMENT", "WRONG_ASSIGNMENT_STATUS", "WRONG_CONTRACT_STATUS", "WRONG_TERMS_AND_CONDITIONS" ], "title": "ItAssetsAssetIdTransferPostResponsesContentApplicationJsonSchemaDataActionsReuseOwnAssetFromDeelDisabledReasonsItems", "type": "string" }, "ItAssetsAssetIdTransferPostResponsesContentApplicationJsonSchemaDataActionsReuseOwnAssetFromDeelStatus": { "description": "Whether the action is currently available for this asset", "enum": [ "DISABLED", "ENABLED", "NOT_APPLICABLE" ], "title": "ItAssetsAssetIdTransferPostResponsesContentApplicationJsonSchemaDataActionsReuseOwnAssetFromDeelStatus", "type": "string" }, "ItAssetsAssetIdTransferPostResponsesContentApplicationJsonSchemaDataActionsReuseOwnAssetFromOwnLocation": { "description": "Redeploy an organization-owned asset from an organization-owned location", "properties": { "details": { "description": "Action-specific context needed to perform the action. Populated for enabled and\ndisabled actions (so callers can see what a successful attempt would look like);\nnull when the action is not applicable to this asset.", "oneOf": [ { "$ref": "#/components/schemas/ItAssetsAssetIdTransferPostResponsesContentApplicationJsonSchemaDataActionsReuseOwnAssetFromOwnLocationDetails" }, { "type": "null" } ] }, "disabled_reasons": { "description": "Reasons why the action is disabled. Empty when the action is enabled or not applicable", "items": { "$ref": "#/components/schemas/ItAssetsAssetIdTransferPostResponsesContentApplicationJsonSchemaDataActionsReuseOwnAssetFromOwnLocationDisabledReasonsItems" }, "type": "array" }, "status": { "$ref": "#/components/schemas/ItAssetsAssetIdTransferPostResponsesContentApplicationJsonSchemaDataActionsReuseOwnAssetFromOwnLocationStatus", "description": "Whether the action is currently available for this asset" } }, "required": [ "status", "details", "disabled_reasons" ], "title": "ItAssetsAssetIdTransferPostResponsesContentApplicationJsonSchemaDataActionsReuseOwnAssetFromOwnLocation", "type": "object" }, "ItAssetsAssetIdTransferPostResponsesContentApplicationJsonSchemaDataActionsReuseOwnAssetFromOwnLocationDetails": { "description": "Action-specific context needed to perform the action. Populated for enabled and\ndisabled actions (so callers can see what a successful attempt would look like);\nnull when the action is not applicable to this asset.", "properties": { "eligible_countries": { "description": "Countries where the asset can be redeployed from an organization-owned location", "items": { "$ref": "#/components/schemas/ItAssetsAssetIdTransferPostResponsesContentApplicationJsonSchemaDataActionsReuseOwnAssetFromOwnLocationDetailsEligibleCountriesItems" }, "type": "array" }, "express_delivery": { "description": "Express delivery availability and per-country fees. Null when express delivery is not supported", "oneOf": [ { "$ref": "#/components/schemas/ItAssetsAssetIdTransferPostResponsesContentApplicationJsonSchemaDataActionsReuseOwnAssetFromOwnLocationDetailsExpressDelivery" }, { "type": "null" } ] }, "service_cost": { "$ref": "#/components/schemas/ItAssetsAssetIdTransferPostResponsesContentApplicationJsonSchemaDataActionsReuseOwnAssetFromOwnLocationDetailsServiceCost", "description": "Cost charged for the transfer service" } }, "required": [ "service_cost", "express_delivery", "eligible_countries" ], "title": "ItAssetsAssetIdTransferPostResponsesContentApplicationJsonSchemaDataActionsReuseOwnAssetFromOwnLocationDetails", "type": "object" }, "ItAssetsAssetIdTransferPostResponsesContentApplicationJsonSchemaDataActionsReuseOwnAssetFromOwnLocationDetailsEligibleCountriesItems": { "enum": [ "AD", "AE", "AF", "AG", "AI", "AL", "AM", "AN", "AO", "AQ", "AR", "AS", "AT", "AU", "AW", "AX", "AZ", "BA", "BB", "BD", "BE", "BF", "BG", "BH", "BI", "BJ", "BL", "BM", "BN", "BO", "BQ", "BR", "BS", "BT", "BV", "BW", "BY", "BZ", "CA", "CC", "CD", "CF", "CG", "CH", "CI", "CK", "CL", "CM", "CN", "CO", "CR", "CU", "CV", "CW", "CX", "CY", "CZ", "DE", "DJ", "DK", "DM", "DO", "DZ", "EC", "EE", "EG", "EH", "ER", "ES", "ET", "FI", "FJ", "FK", "FM", "FO", "FR", "GA", "GB", "GD", "GE", "GF", "GG", "GH", "GI", "GL", "GM", "GN", "GP", "GQ", "GR", "GS", "GT", "GU", "GW", "GY", "HK", "HM", "HN", "HR", "HT", "HU", "IC", "ID", "IE", "IL", "IM", "IN", "IO", "IQ", "IR", "IS", "IT", "JE", "JM", "JO", "JP", "KE", "KG", "KH", "KI", "KM", "KN", "KP", "KR", "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", "XK", "YE", "YT", "ZA", "ZM", "ZW" ], "title": "ItAssetsAssetIdTransferPostResponsesContentApplicationJsonSchemaDataActionsReuseOwnAssetFromOwnLocationDetailsEligibleCountriesItems", "type": "string" }, "ItAssetsAssetIdTransferPostResponsesContentApplicationJsonSchemaDataActionsReuseOwnAssetFromOwnLocationDetailsExpressDelivery": { "description": "Express delivery availability and per-country fees. Null when express delivery is not supported", "properties": { "country_fees": { "additionalProperties": { "$ref": "#/components/schemas/ItAssetsAssetIdTransferPostResponsesContentApplicationJsonSchemaDataActionsReuseOwnAssetFromOwnLocationDetailsExpressDeliveryCountryFees" }, "description": "Express delivery fees keyed by destination country.", "type": "object" } }, "required": [ "country_fees" ], "title": "ItAssetsAssetIdTransferPostResponsesContentApplicationJsonSchemaDataActionsReuseOwnAssetFromOwnLocationDetailsExpressDelivery", "type": "object" }, "ItAssetsAssetIdTransferPostResponsesContentApplicationJsonSchemaDataActionsReuseOwnAssetFromOwnLocationDetailsExpressDeliveryCountryFees": { "properties": { "amount": { "description": "Amount", "format": "decimal", "type": "string" }, "currency": { "$ref": "#/components/schemas/ItAssetsAssetIdTransferPostResponsesContentApplicationJsonSchemaDataActionsReuseOwnAssetFromOwnLocationDetailsExpressDeliveryCountryFeesCurrency", "description": "Three-letter currency code for the price" } }, "required": [ "amount", "currency" ], "title": "ItAssetsAssetIdTransferPostResponsesContentApplicationJsonSchemaDataActionsReuseOwnAssetFromOwnLocationDetailsExpressDeliveryCountryFees", "type": "object" }, "ItAssetsAssetIdTransferPostResponsesContentApplicationJsonSchemaDataActionsReuseOwnAssetFromOwnLocationDetailsExpressDeliveryCountryFeesCurrency": { "description": "Three-letter currency code for the price", "enum": [ "AED", "AFN", "ALL", "AMD", "ANG", "AOA", "ARS", "AUD", "AWG", "AZN", "BAM", "BDT", "BGN", "BHD", "BIF", "BMD", "BOB", "BRL", "BSD", "BTN", "BWP", "BYN", "BZD", "CAD", "CDF", "CHF", "CLP", "CNY", "COP", "CRC", "CUC", "CVE", "CZK", "DJF", "DKK", "DOP", "DZD", "EGP", "ERN", "ETB", "EUR", "FJD", "FKP", "GBP", "GEL", "GHS", "GIP", "GMD", "GNF", "GTQ", "GYD", "HKD", "HNL", "HRK", "HTG", "HUF", "IDR", "ILS", "INR", "IQD", "IRR", "ISK", "JMD", "JOD", "JPY", "KES", "KGS", "KHR", "KMF", "KPW", "KRW", "KWD", "KYD", "KZT", "LAK", "LBP", "LKR", "LRD", "LSL", "LTL", "LYD", "MAD", "MDL", "MGA", "MKD", "MMK", "MNT", "MRU", "MUR", "MVR", "MWK", "MXN", "MYR", "MZN", "NAD", "NGN", "NIO", "NOK", "NPR", "NZD", "OMR", "PAB", "PEN", "PGK", "PHP", "PKR", "PLN", "PYG", "QAR", "RON", "RSD", "RUB", "RWF", "SAR", "SBD", "SCR", "SDG", "SEK", "SGD", "SHP", "SLL", "SOS", "SRD", "SSP", "STD", "SYP", "SZL", "THB", "TJS", "TMT", "TND", "TOP", "TRY", "TTD", "TWD", "TZS", "UAH", "UGX", "USD", "UYU", "UZS", "VEF", "VND", "VUV", "WST", "XAF", "XCD", "XOF", "XPF", "YER", "ZAR", "ZMW", "ZWD" ], "title": "ItAssetsAssetIdTransferPostResponsesContentApplicationJsonSchemaDataActionsReuseOwnAssetFromOwnLocationDetailsExpressDeliveryCountryFeesCurrency", "type": "string" }, "ItAssetsAssetIdTransferPostResponsesContentApplicationJsonSchemaDataActionsReuseOwnAssetFromOwnLocationDetailsServiceCost": { "description": "Cost charged for the transfer service", "properties": { "billing_method": { "$ref": "#/components/schemas/ItAssetsAssetIdTransferPostResponsesContentApplicationJsonSchemaDataActionsReuseOwnAssetFromOwnLocationDetailsServiceCostBillingMethod", "description": "How the action is charged. When \"TOKEN\", the fees are covered by an\nadd-on token pool; when \"CURRENCY\", the fees are billed in the currency\nspecified in the \"fees\" field." }, "fees": { "description": "Price charged for the action. Null when billing method is \"TOKEN\"", "oneOf": [ { "$ref": "#/components/schemas/ItAssetsAssetIdTransferPostResponsesContentApplicationJsonSchemaDataActionsReuseOwnAssetFromOwnLocationDetailsServiceCostFees" }, { "type": "null" } ] }, "token_usage": { "description": "Add-on token consumption details. Null when billing method is \"CURRENCY\"", "oneOf": [ { "$ref": "#/components/schemas/ItAssetsAssetIdTransferPostResponsesContentApplicationJsonSchemaDataActionsReuseOwnAssetFromOwnLocationDetailsServiceCostTokenUsage" }, { "type": "null" } ] } }, "required": [ "fees", "token_usage", "billing_method" ], "title": "ItAssetsAssetIdTransferPostResponsesContentApplicationJsonSchemaDataActionsReuseOwnAssetFromOwnLocationDetailsServiceCost", "type": "object" }, "ItAssetsAssetIdTransferPostResponsesContentApplicationJsonSchemaDataActionsReuseOwnAssetFromOwnLocationDetailsServiceCostBillingMethod": { "description": "How the action is charged. When \"TOKEN\", the fees are covered by an\nadd-on token pool; when \"CURRENCY\", the fees are billed in the currency\nspecified in the \"fees\" field.", "enum": [ "CURRENCY", "TOKEN" ], "title": "ItAssetsAssetIdTransferPostResponsesContentApplicationJsonSchemaDataActionsReuseOwnAssetFromOwnLocationDetailsServiceCostBillingMethod", "type": "string" }, "ItAssetsAssetIdTransferPostResponsesContentApplicationJsonSchemaDataActionsReuseOwnAssetFromOwnLocationDetailsServiceCostFees": { "description": "Price charged for the action. Null when billing method is \"TOKEN\"", "properties": { "amount": { "description": "Amount", "format": "decimal", "type": "string" }, "currency": { "$ref": "#/components/schemas/ItAssetsAssetIdTransferPostResponsesContentApplicationJsonSchemaDataActionsReuseOwnAssetFromOwnLocationDetailsServiceCostFeesCurrency", "description": "Three-letter currency code for the price" } }, "required": [ "amount", "currency" ], "title": "ItAssetsAssetIdTransferPostResponsesContentApplicationJsonSchemaDataActionsReuseOwnAssetFromOwnLocationDetailsServiceCostFees", "type": "object" }, "ItAssetsAssetIdTransferPostResponsesContentApplicationJsonSchemaDataActionsReuseOwnAssetFromOwnLocationDetailsServiceCostFeesCurrency": { "description": "Three-letter currency code for the price", "enum": [ "AED", "AFN", "ALL", "AMD", "ANG", "AOA", "ARS", "AUD", "AWG", "AZN", "BAM", "BDT", "BGN", "BHD", "BIF", "BMD", "BOB", "BRL", "BSD", "BTN", "BWP", "BYN", "BZD", "CAD", "CDF", "CHF", "CLP", "CNY", "COP", "CRC", "CUC", "CVE", "CZK", "DJF", "DKK", "DOP", "DZD", "EGP", "ERN", "ETB", "EUR", "FJD", "FKP", "GBP", "GEL", "GHS", "GIP", "GMD", "GNF", "GTQ", "GYD", "HKD", "HNL", "HRK", "HTG", "HUF", "IDR", "ILS", "INR", "IQD", "IRR", "ISK", "JMD", "JOD", "JPY", "KES", "KGS", "KHR", "KMF", "KPW", "KRW", "KWD", "KYD", "KZT", "LAK", "LBP", "LKR", "LRD", "LSL", "LTL", "LYD", "MAD", "MDL", "MGA", "MKD", "MMK", "MNT", "MRU", "MUR", "MVR", "MWK", "MXN", "MYR", "MZN", "NAD", "NGN", "NIO", "NOK", "NPR", "NZD", "OMR", "PAB", "PEN", "PGK", "PHP", "PKR", "PLN", "PYG", "QAR", "RON", "RSD", "RUB", "RWF", "SAR", "SBD", "SCR", "SDG", "SEK", "SGD", "SHP", "SLL", "SOS", "SRD", "SSP", "STD", "SYP", "SZL", "THB", "TJS", "TMT", "TND", "TOP", "TRY", "TTD", "TWD", "TZS", "UAH", "UGX", "USD", "UYU", "UZS", "VEF", "VND", "VUV", "WST", "XAF", "XCD", "XOF", "XPF", "YER", "ZAR", "ZMW", "ZWD" ], "title": "ItAssetsAssetIdTransferPostResponsesContentApplicationJsonSchemaDataActionsReuseOwnAssetFromOwnLocationDetailsServiceCostFeesCurrency", "type": "string" }, "ItAssetsAssetIdTransferPostResponsesContentApplicationJsonSchemaDataActionsReuseOwnAssetFromOwnLocationDetailsServiceCostTokenUsage": { "description": "Add-on token consumption details. Null when billing method is \"CURRENCY\"", "properties": { "addon": { "$ref": "#/components/schemas/ItAssetsAssetIdTransferPostResponsesContentApplicationJsonSchemaDataActionsReuseOwnAssetFromOwnLocationDetailsServiceCostTokenUsageAddon", "description": "The add-on that provides the tokens" }, "cost": { "description": "Number of tokens consumed by the action. Zero when the add-on covers the\nservice without drawing from a token pool", "format": "decimal", "type": "string" }, "tokens_left": { "description": "Number of tokens left in the pool after the action is performed. Null when\nthe add-on covers the service without a token pool", "format": "decimal", "type": [ "string", "null" ] } }, "required": [ "cost", "addon", "tokens_left" ], "title": "ItAssetsAssetIdTransferPostResponsesContentApplicationJsonSchemaDataActionsReuseOwnAssetFromOwnLocationDetailsServiceCostTokenUsage", "type": "object" }, "ItAssetsAssetIdTransferPostResponsesContentApplicationJsonSchemaDataActionsReuseOwnAssetFromOwnLocationDetailsServiceCostTokenUsageAddon": { "description": "The add-on that provides the tokens", "properties": { "id": { "description": "ID of the add-on", "format": "uuid", "type": "string" }, "name": { "description": "Public display name of the add-on", "type": "string" } }, "required": [ "id", "name" ], "title": "ItAssetsAssetIdTransferPostResponsesContentApplicationJsonSchemaDataActionsReuseOwnAssetFromOwnLocationDetailsServiceCostTokenUsageAddon", "type": "object" }, "ItAssetsAssetIdTransferPostResponsesContentApplicationJsonSchemaDataActionsReuseOwnAssetFromOwnLocationDisabledReasonsItems": { "enum": [ "ARCHIVED", "AT_DEEL_WAREHOUSE", "BEING_REPAIRED", "CONSUMABLE", "CONTROLLED_BY_DEEL", "COUNTRY_NOT_SUPPORTED_FOR_HUB", "COUNTRY_NOT_SUPPORTED_FOR_LOCAL", "DEEL_OWNED_ITEM_WITHOUT_RENTAL_CONTRACT", "DESKTOP_STORAGE", "ENDING_CONTRACT", "HUB_IN_SAME_REGION_AS_LOCAL", "INACTIVE", "INVALID_ITEM_LOCATION", "INVALID_ORGANIZATION_STATUS", "INVALID_STATE", "ITEM_CONDITIONS_TO_UNARCHIVE_NOT_MET", "ITEM_NOT_VISIBLE_FOR_ORGANIZATION", "NON_DEVICE", "NOT_AT_WAREHOUSE", "NOT_AVAILABLE_FOR_REUSE", "NOT_A_RENTAL", "NOT_MANAGEABLE_BY_ORGANIZATION", "NOT_WITH_ASSIGNMENT", "NOT_WITH_USER", "NO_ACTIVE_ADDONS", "NO_ACTIVE_STORAGE_CONTRACT", "NO_LOCATION_FOR_STORAGE", "NO_LOGISTICS_FOR_STORAGE", "NO_VALID_ADDONS", "ONGOING_SERVICE", "OWNED_BY_DEEL", "OWNED_BY_ORGANIZATION", "OWNED_BY_PARTNER_ORGANIZATION", "PARTNER_CHILD_CONTRACT", "PENDING_DEVICE_REFRESH", "RENTAL_CONTRACT_AND_USER_REGION_DO_NOT_MATCH", "TEMPORARILY_UNAVAILABLE", "UNKNOWN", "USER_HAS_NO_COUNTRY", "USER_HAS_NO_SEAT", "WAITING_FOR_CLEARANCE", "WITH_LOANER_ASSIGNMENT", "WITH_NON_COLLECTED_ASSIGNMENT", "WITH_NON_DELIVERED_ASSIGNMENT", "WITH_PENDING_ASSIGNMENT", "WRONG_ASSIGNMENT_STATUS", "WRONG_CONTRACT_STATUS", "WRONG_TERMS_AND_CONDITIONS" ], "title": "ItAssetsAssetIdTransferPostResponsesContentApplicationJsonSchemaDataActionsReuseOwnAssetFromOwnLocationDisabledReasonsItems", "type": "string" }, "ItAssetsAssetIdTransferPostResponsesContentApplicationJsonSchemaDataActionsReuseOwnAssetFromOwnLocationStatus": { "description": "Whether the action is currently available for this asset", "enum": [ "DISABLED", "ENABLED", "NOT_APPLICABLE" ], "title": "ItAssetsAssetIdTransferPostResponsesContentApplicationJsonSchemaDataActionsReuseOwnAssetFromOwnLocationStatus", "type": "string" }, "ItAssetsAssetIdTransferPostResponsesContentApplicationJsonSchemaDataActionsStoreOwnAssetAtDeelForHub": { "description": "Store an organization-owned asset at a Deel hub warehouse", "properties": { "details": { "description": "Action-specific context needed to perform the action. Populated for enabled and\ndisabled actions (so callers can see what a successful attempt would look like);\nnull when the action is not applicable to this asset.", "oneOf": [ { "$ref": "#/components/schemas/ItAssetsAssetIdTransferPostResponsesContentApplicationJsonSchemaDataActionsStoreOwnAssetAtDeelForHubDetails" }, { "type": "null" } ] }, "disabled_reasons": { "description": "Reasons why the action is disabled. Empty when the action is enabled or not applicable", "items": { "$ref": "#/components/schemas/ItAssetsAssetIdTransferPostResponsesContentApplicationJsonSchemaDataActionsStoreOwnAssetAtDeelForHubDisabledReasonsItems" }, "type": "array" }, "status": { "$ref": "#/components/schemas/ItAssetsAssetIdTransferPostResponsesContentApplicationJsonSchemaDataActionsStoreOwnAssetAtDeelForHubStatus", "description": "Whether the action is currently available for this asset" } }, "required": [ "status", "details", "disabled_reasons" ], "title": "ItAssetsAssetIdTransferPostResponsesContentApplicationJsonSchemaDataActionsStoreOwnAssetAtDeelForHub", "type": "object" }, "ItAssetsAssetIdTransferPostResponsesContentApplicationJsonSchemaDataActionsStoreOwnAssetAtDeelForHubDetails": { "description": "Action-specific context needed to perform the action. Populated for enabled and\ndisabled actions (so callers can see what a successful attempt would look like);\nnull when the action is not applicable to this asset.", "properties": { "activation_cost": { "$ref": "#/components/schemas/ItAssetsAssetIdTransferPostResponsesContentApplicationJsonSchemaDataActionsStoreOwnAssetAtDeelForHubDetailsActivationCost", "description": "Cost charged to activate storage" }, "destination_country": { "$ref": "#/components/schemas/ItAssetsAssetIdTransferPostResponsesContentApplicationJsonSchemaDataActionsStoreOwnAssetAtDeelForHubDetailsDestinationCountry", "description": "ISO 3166-1 alpha-2 country of the Deel warehouse the asset will be shipped to" }, "grace_period_in_months": { "description": "Grace period in months during which storage is free before monthly fees apply", "format": "int64", "type": "integer" }, "monthly_fee": { "$ref": "#/components/schemas/ItAssetsAssetIdTransferPostResponsesContentApplicationJsonSchemaDataActionsStoreOwnAssetAtDeelForHubDetailsMonthlyFee", "description": "Monthly storage fee charged after the grace period" } }, "required": [ "monthly_fee", "activation_cost", "destination_country", "grace_period_in_months" ], "title": "ItAssetsAssetIdTransferPostResponsesContentApplicationJsonSchemaDataActionsStoreOwnAssetAtDeelForHubDetails", "type": "object" }, "ItAssetsAssetIdTransferPostResponsesContentApplicationJsonSchemaDataActionsStoreOwnAssetAtDeelForHubDetailsActivationCost": { "description": "Cost charged to activate storage", "properties": { "billing_method": { "$ref": "#/components/schemas/ItAssetsAssetIdTransferPostResponsesContentApplicationJsonSchemaDataActionsStoreOwnAssetAtDeelForHubDetailsActivationCostBillingMethod", "description": "How the action is charged. When \"TOKEN\", the fees are covered by an\nadd-on token pool; when \"CURRENCY\", the fees are billed in the currency\nspecified in the \"fees\" field." }, "fees": { "description": "Price charged for the action. Null when billing method is \"TOKEN\"", "oneOf": [ { "$ref": "#/components/schemas/ItAssetsAssetIdTransferPostResponsesContentApplicationJsonSchemaDataActionsStoreOwnAssetAtDeelForHubDetailsActivationCostFees" }, { "type": "null" } ] }, "token_usage": { "description": "Add-on token consumption details. Null when billing method is \"CURRENCY\"", "oneOf": [ { "$ref": "#/components/schemas/ItAssetsAssetIdTransferPostResponsesContentApplicationJsonSchemaDataActionsStoreOwnAssetAtDeelForHubDetailsActivationCostTokenUsage" }, { "type": "null" } ] } }, "required": [ "fees", "token_usage", "billing_method" ], "title": "ItAssetsAssetIdTransferPostResponsesContentApplicationJsonSchemaDataActionsStoreOwnAssetAtDeelForHubDetailsActivationCost", "type": "object" }, "ItAssetsAssetIdTransferPostResponsesContentApplicationJsonSchemaDataActionsStoreOwnAssetAtDeelForHubDetailsActivationCostBillingMethod": { "description": "How the action is charged. When \"TOKEN\", the fees are covered by an\nadd-on token pool; when \"CURRENCY\", the fees are billed in the currency\nspecified in the \"fees\" field.", "enum": [ "CURRENCY", "TOKEN" ], "title": "ItAssetsAssetIdTransferPostResponsesContentApplicationJsonSchemaDataActionsStoreOwnAssetAtDeelForHubDetailsActivationCostBillingMethod", "type": "string" }, "ItAssetsAssetIdTransferPostResponsesContentApplicationJsonSchemaDataActionsStoreOwnAssetAtDeelForHubDetailsActivationCostFees": { "description": "Price charged for the action. Null when billing method is \"TOKEN\"", "properties": { "amount": { "description": "Amount", "format": "decimal", "type": "string" }, "currency": { "$ref": "#/components/schemas/ItAssetsAssetIdTransferPostResponsesContentApplicationJsonSchemaDataActionsStoreOwnAssetAtDeelForHubDetailsActivationCostFeesCurrency", "description": "Three-letter currency code for the price" } }, "required": [ "amount", "currency" ], "title": "ItAssetsAssetIdTransferPostResponsesContentApplicationJsonSchemaDataActionsStoreOwnAssetAtDeelForHubDetailsActivationCostFees", "type": "object" }, "ItAssetsAssetIdTransferPostResponsesContentApplicationJsonSchemaDataActionsStoreOwnAssetAtDeelForHubDetailsActivationCostFeesCurrency": { "description": "Three-letter currency code for the price", "enum": [ "AED", "AFN", "ALL", "AMD", "ANG", "AOA", "ARS", "AUD", "AWG", "AZN", "BAM", "BDT", "BGN", "BHD", "BIF", "BMD", "BOB", "BRL", "BSD", "BTN", "BWP", "BYN", "BZD", "CAD", "CDF", "CHF", "CLP", "CNY", "COP", "CRC", "CUC", "CVE", "CZK", "DJF", "DKK", "DOP", "DZD", "EGP", "ERN", "ETB", "EUR", "FJD", "FKP", "GBP", "GEL", "GHS", "GIP", "GMD", "GNF", "GTQ", "GYD", "HKD", "HNL", "HRK", "HTG", "HUF", "IDR", "ILS", "INR", "IQD", "IRR", "ISK", "JMD", "JOD", "JPY", "KES", "KGS", "KHR", "KMF", "KPW", "KRW", "KWD", "KYD", "KZT", "LAK", "LBP", "LKR", "LRD", "LSL", "LTL", "LYD", "MAD", "MDL", "MGA", "MKD", "MMK", "MNT", "MRU", "MUR", "MVR", "MWK", "MXN", "MYR", "MZN", "NAD", "NGN", "NIO", "NOK", "NPR", "NZD", "OMR", "PAB", "PEN", "PGK", "PHP", "PKR", "PLN", "PYG", "QAR", "RON", "RSD", "RUB", "RWF", "SAR", "SBD", "SCR", "SDG", "SEK", "SGD", "SHP", "SLL", "SOS", "SRD", "SSP", "STD", "SYP", "SZL", "THB", "TJS", "TMT", "TND", "TOP", "TRY", "TTD", "TWD", "TZS", "UAH", "UGX", "USD", "UYU", "UZS", "VEF", "VND", "VUV", "WST", "XAF", "XCD", "XOF", "XPF", "YER", "ZAR", "ZMW", "ZWD" ], "title": "ItAssetsAssetIdTransferPostResponsesContentApplicationJsonSchemaDataActionsStoreOwnAssetAtDeelForHubDetailsActivationCostFeesCurrency", "type": "string" }, "ItAssetsAssetIdTransferPostResponsesContentApplicationJsonSchemaDataActionsStoreOwnAssetAtDeelForHubDetailsActivationCostTokenUsage": { "description": "Add-on token consumption details. Null when billing method is \"CURRENCY\"", "properties": { "addon": { "$ref": "#/components/schemas/ItAssetsAssetIdTransferPostResponsesContentApplicationJsonSchemaDataActionsStoreOwnAssetAtDeelForHubDetailsActivationCostTokenUsageAddon", "description": "The add-on that provides the tokens" }, "cost": { "description": "Number of tokens consumed by the action. Zero when the add-on covers the\nservice without drawing from a token pool", "format": "decimal", "type": "string" }, "tokens_left": { "description": "Number of tokens left in the pool after the action is performed. Null when\nthe add-on covers the service without a token pool", "format": "decimal", "type": [ "string", "null" ] } }, "required": [ "cost", "addon", "tokens_left" ], "title": "ItAssetsAssetIdTransferPostResponsesContentApplicationJsonSchemaDataActionsStoreOwnAssetAtDeelForHubDetailsActivationCostTokenUsage", "type": "object" }, "ItAssetsAssetIdTransferPostResponsesContentApplicationJsonSchemaDataActionsStoreOwnAssetAtDeelForHubDetailsActivationCostTokenUsageAddon": { "description": "The add-on that provides the tokens", "properties": { "id": { "description": "ID of the add-on", "format": "uuid", "type": "string" }, "name": { "description": "Public display name of the add-on", "type": "string" } }, "required": [ "id", "name" ], "title": "ItAssetsAssetIdTransferPostResponsesContentApplicationJsonSchemaDataActionsStoreOwnAssetAtDeelForHubDetailsActivationCostTokenUsageAddon", "type": "object" }, "ItAssetsAssetIdTransferPostResponsesContentApplicationJsonSchemaDataActionsStoreOwnAssetAtDeelForHubDetailsDestinationCountry": { "description": "ISO 3166-1 alpha-2 country of the Deel warehouse the asset will be shipped to", "enum": [ "AD", "AE", "AF", "AG", "AI", "AL", "AM", "AN", "AO", "AQ", "AR", "AS", "AT", "AU", "AW", "AX", "AZ", "BA", "BB", "BD", "BE", "BF", "BG", "BH", "BI", "BJ", "BL", "BM", "BN", "BO", "BQ", "BR", "BS", "BT", "BV", "BW", "BY", "BZ", "CA", "CC", "CD", "CF", "CG", "CH", "CI", "CK", "CL", "CM", "CN", "CO", "CR", "CU", "CV", "CW", "CX", "CY", "CZ", "DE", "DJ", "DK", "DM", "DO", "DZ", "EC", "EE", "EG", "EH", "ER", "ES", "ET", "FI", "FJ", "FK", "FM", "FO", "FR", "GA", "GB", "GD", "GE", "GF", "GG", "GH", "GI", "GL", "GM", "GN", "GP", "GQ", "GR", "GS", "GT", "GU", "GW", "GY", "HK", "HM", "HN", "HR", "HT", "HU", "IC", "ID", "IE", "IL", "IM", "IN", "IO", "IQ", "IR", "IS", "IT", "JE", "JM", "JO", "JP", "KE", "KG", "KH", "KI", "KM", "KN", "KP", "KR", "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", "XK", "YE", "YT", "ZA", "ZM", "ZW" ], "title": "ItAssetsAssetIdTransferPostResponsesContentApplicationJsonSchemaDataActionsStoreOwnAssetAtDeelForHubDetailsDestinationCountry", "type": "string" }, "ItAssetsAssetIdTransferPostResponsesContentApplicationJsonSchemaDataActionsStoreOwnAssetAtDeelForHubDetailsMonthlyFee": { "description": "Monthly storage fee charged after the grace period", "properties": { "amount": { "description": "Amount", "format": "decimal", "type": "string" }, "currency": { "$ref": "#/components/schemas/ItAssetsAssetIdTransferPostResponsesContentApplicationJsonSchemaDataActionsStoreOwnAssetAtDeelForHubDetailsMonthlyFeeCurrency", "description": "Three-letter currency code for the price" } }, "required": [ "amount", "currency" ], "title": "ItAssetsAssetIdTransferPostResponsesContentApplicationJsonSchemaDataActionsStoreOwnAssetAtDeelForHubDetailsMonthlyFee", "type": "object" }, "ItAssetsAssetIdTransferPostResponsesContentApplicationJsonSchemaDataActionsStoreOwnAssetAtDeelForHubDetailsMonthlyFeeCurrency": { "description": "Three-letter currency code for the price", "enum": [ "AED", "AFN", "ALL", "AMD", "ANG", "AOA", "ARS", "AUD", "AWG", "AZN", "BAM", "BDT", "BGN", "BHD", "BIF", "BMD", "BOB", "BRL", "BSD", "BTN", "BWP", "BYN", "BZD", "CAD", "CDF", "CHF", "CLP", "CNY", "COP", "CRC", "CUC", "CVE", "CZK", "DJF", "DKK", "DOP", "DZD", "EGP", "ERN", "ETB", "EUR", "FJD", "FKP", "GBP", "GEL", "GHS", "GIP", "GMD", "GNF", "GTQ", "GYD", "HKD", "HNL", "HRK", "HTG", "HUF", "IDR", "ILS", "INR", "IQD", "IRR", "ISK", "JMD", "JOD", "JPY", "KES", "KGS", "KHR", "KMF", "KPW", "KRW", "KWD", "KYD", "KZT", "LAK", "LBP", "LKR", "LRD", "LSL", "LTL", "LYD", "MAD", "MDL", "MGA", "MKD", "MMK", "MNT", "MRU", "MUR", "MVR", "MWK", "MXN", "MYR", "MZN", "NAD", "NGN", "NIO", "NOK", "NPR", "NZD", "OMR", "PAB", "PEN", "PGK", "PHP", "PKR", "PLN", "PYG", "QAR", "RON", "RSD", "RUB", "RWF", "SAR", "SBD", "SCR", "SDG", "SEK", "SGD", "SHP", "SLL", "SOS", "SRD", "SSP", "STD", "SYP", "SZL", "THB", "TJS", "TMT", "TND", "TOP", "TRY", "TTD", "TWD", "TZS", "UAH", "UGX", "USD", "UYU", "UZS", "VEF", "VND", "VUV", "WST", "XAF", "XCD", "XOF", "XPF", "YER", "ZAR", "ZMW", "ZWD" ], "title": "ItAssetsAssetIdTransferPostResponsesContentApplicationJsonSchemaDataActionsStoreOwnAssetAtDeelForHubDetailsMonthlyFeeCurrency", "type": "string" }, "ItAssetsAssetIdTransferPostResponsesContentApplicationJsonSchemaDataActionsStoreOwnAssetAtDeelForHubDisabledReasonsItems": { "enum": [ "ARCHIVED", "AT_DEEL_WAREHOUSE", "BEING_REPAIRED", "CONSUMABLE", "CONTROLLED_BY_DEEL", "COUNTRY_NOT_SUPPORTED_FOR_HUB", "COUNTRY_NOT_SUPPORTED_FOR_LOCAL", "DEEL_OWNED_ITEM_WITHOUT_RENTAL_CONTRACT", "DESKTOP_STORAGE", "ENDING_CONTRACT", "HUB_IN_SAME_REGION_AS_LOCAL", "INACTIVE", "INVALID_ITEM_LOCATION", "INVALID_ORGANIZATION_STATUS", "INVALID_STATE", "ITEM_CONDITIONS_TO_UNARCHIVE_NOT_MET", "ITEM_NOT_VISIBLE_FOR_ORGANIZATION", "NON_DEVICE", "NOT_AT_WAREHOUSE", "NOT_AVAILABLE_FOR_REUSE", "NOT_A_RENTAL", "NOT_MANAGEABLE_BY_ORGANIZATION", "NOT_WITH_ASSIGNMENT", "NOT_WITH_USER", "NO_ACTIVE_ADDONS", "NO_ACTIVE_STORAGE_CONTRACT", "NO_LOCATION_FOR_STORAGE", "NO_LOGISTICS_FOR_STORAGE", "NO_VALID_ADDONS", "ONGOING_SERVICE", "OWNED_BY_DEEL", "OWNED_BY_ORGANIZATION", "OWNED_BY_PARTNER_ORGANIZATION", "PARTNER_CHILD_CONTRACT", "PENDING_DEVICE_REFRESH", "RENTAL_CONTRACT_AND_USER_REGION_DO_NOT_MATCH", "TEMPORARILY_UNAVAILABLE", "UNKNOWN", "USER_HAS_NO_COUNTRY", "USER_HAS_NO_SEAT", "WAITING_FOR_CLEARANCE", "WITH_LOANER_ASSIGNMENT", "WITH_NON_COLLECTED_ASSIGNMENT", "WITH_NON_DELIVERED_ASSIGNMENT", "WITH_PENDING_ASSIGNMENT", "WRONG_ASSIGNMENT_STATUS", "WRONG_CONTRACT_STATUS", "WRONG_TERMS_AND_CONDITIONS" ], "title": "ItAssetsAssetIdTransferPostResponsesContentApplicationJsonSchemaDataActionsStoreOwnAssetAtDeelForHubDisabledReasonsItems", "type": "string" }, "ItAssetsAssetIdTransferPostResponsesContentApplicationJsonSchemaDataActionsStoreOwnAssetAtDeelForHubStatus": { "description": "Whether the action is currently available for this asset", "enum": [ "DISABLED", "ENABLED", "NOT_APPLICABLE" ], "title": "ItAssetsAssetIdTransferPostResponsesContentApplicationJsonSchemaDataActionsStoreOwnAssetAtDeelForHubStatus", "type": "string" }, "ItAssetsAssetIdTransferPostResponsesContentApplicationJsonSchemaDataActionsStoreOwnAssetAtDeelForLocal": { "description": "Store an organization-owned asset at a Deel local warehouse", "properties": { "details": { "description": "Action-specific context needed to perform the action. Populated for enabled and\ndisabled actions (so callers can see what a successful attempt would look like);\nnull when the action is not applicable to this asset.", "oneOf": [ { "$ref": "#/components/schemas/ItAssetsAssetIdTransferPostResponsesContentApplicationJsonSchemaDataActionsStoreOwnAssetAtDeelForLocalDetails" }, { "type": "null" } ] }, "disabled_reasons": { "description": "Reasons why the action is disabled. Empty when the action is enabled or not applicable", "items": { "$ref": "#/components/schemas/ItAssetsAssetIdTransferPostResponsesContentApplicationJsonSchemaDataActionsStoreOwnAssetAtDeelForLocalDisabledReasonsItems" }, "type": "array" }, "status": { "$ref": "#/components/schemas/ItAssetsAssetIdTransferPostResponsesContentApplicationJsonSchemaDataActionsStoreOwnAssetAtDeelForLocalStatus", "description": "Whether the action is currently available for this asset" } }, "required": [ "status", "details", "disabled_reasons" ], "title": "ItAssetsAssetIdTransferPostResponsesContentApplicationJsonSchemaDataActionsStoreOwnAssetAtDeelForLocal", "type": "object" }, "ItAssetsAssetIdTransferPostResponsesContentApplicationJsonSchemaDataActionsStoreOwnAssetAtDeelForLocalDetails": { "description": "Action-specific context needed to perform the action. Populated for enabled and\ndisabled actions (so callers can see what a successful attempt would look like);\nnull when the action is not applicable to this asset.", "properties": { "activation_cost": { "$ref": "#/components/schemas/ItAssetsAssetIdTransferPostResponsesContentApplicationJsonSchemaDataActionsStoreOwnAssetAtDeelForLocalDetailsActivationCost", "description": "Cost charged to activate storage" }, "destination_country": { "$ref": "#/components/schemas/ItAssetsAssetIdTransferPostResponsesContentApplicationJsonSchemaDataActionsStoreOwnAssetAtDeelForLocalDetailsDestinationCountry", "description": "ISO 3166-1 alpha-2 country of the Deel warehouse the asset will be shipped to" }, "grace_period_in_months": { "description": "Grace period in months during which storage is free before monthly fees apply", "format": "int64", "type": "integer" }, "monthly_fee": { "$ref": "#/components/schemas/ItAssetsAssetIdTransferPostResponsesContentApplicationJsonSchemaDataActionsStoreOwnAssetAtDeelForLocalDetailsMonthlyFee", "description": "Monthly storage fee charged after the grace period" } }, "required": [ "monthly_fee", "activation_cost", "destination_country", "grace_period_in_months" ], "title": "ItAssetsAssetIdTransferPostResponsesContentApplicationJsonSchemaDataActionsStoreOwnAssetAtDeelForLocalDetails", "type": "object" }, "ItAssetsAssetIdTransferPostResponsesContentApplicationJsonSchemaDataActionsStoreOwnAssetAtDeelForLocalDetailsActivationCost": { "description": "Cost charged to activate storage", "properties": { "billing_method": { "$ref": "#/components/schemas/ItAssetsAssetIdTransferPostResponsesContentApplicationJsonSchemaDataActionsStoreOwnAssetAtDeelForLocalDetailsActivationCostBillingMethod", "description": "How the action is charged. When \"TOKEN\", the fees are covered by an\nadd-on token pool; when \"CURRENCY\", the fees are billed in the currency\nspecified in the \"fees\" field." }, "fees": { "description": "Price charged for the action. Null when billing method is \"TOKEN\"", "oneOf": [ { "$ref": "#/components/schemas/ItAssetsAssetIdTransferPostResponsesContentApplicationJsonSchemaDataActionsStoreOwnAssetAtDeelForLocalDetailsActivationCostFees" }, { "type": "null" } ] }, "token_usage": { "description": "Add-on token consumption details. Null when billing method is \"CURRENCY\"", "oneOf": [ { "$ref": "#/components/schemas/ItAssetsAssetIdTransferPostResponsesContentApplicationJsonSchemaDataActionsStoreOwnAssetAtDeelForLocalDetailsActivationCostTokenUsage" }, { "type": "null" } ] } }, "required": [ "fees", "token_usage", "billing_method" ], "title": "ItAssetsAssetIdTransferPostResponsesContentApplicationJsonSchemaDataActionsStoreOwnAssetAtDeelForLocalDetailsActivationCost", "type": "object" }, "ItAssetsAssetIdTransferPostResponsesContentApplicationJsonSchemaDataActionsStoreOwnAssetAtDeelForLocalDetailsActivationCostBillingMethod": { "description": "How the action is charged. When \"TOKEN\", the fees are covered by an\nadd-on token pool; when \"CURRENCY\", the fees are billed in the currency\nspecified in the \"fees\" field.", "enum": [ "CURRENCY", "TOKEN" ], "title": "ItAssetsAssetIdTransferPostResponsesContentApplicationJsonSchemaDataActionsStoreOwnAssetAtDeelForLocalDetailsActivationCostBillingMethod", "type": "string" }, "ItAssetsAssetIdTransferPostResponsesContentApplicationJsonSchemaDataActionsStoreOwnAssetAtDeelForLocalDetailsActivationCostFees": { "description": "Price charged for the action. Null when billing method is \"TOKEN\"", "properties": { "amount": { "description": "Amount", "format": "decimal", "type": "string" }, "currency": { "$ref": "#/components/schemas/ItAssetsAssetIdTransferPostResponsesContentApplicationJsonSchemaDataActionsStoreOwnAssetAtDeelForLocalDetailsActivationCostFeesCurrency", "description": "Three-letter currency code for the price" } }, "required": [ "amount", "currency" ], "title": "ItAssetsAssetIdTransferPostResponsesContentApplicationJsonSchemaDataActionsStoreOwnAssetAtDeelForLocalDetailsActivationCostFees", "type": "object" }, "ItAssetsAssetIdTransferPostResponsesContentApplicationJsonSchemaDataActionsStoreOwnAssetAtDeelForLocalDetailsActivationCostFeesCurrency": { "description": "Three-letter currency code for the price", "enum": [ "AED", "AFN", "ALL", "AMD", "ANG", "AOA", "ARS", "AUD", "AWG", "AZN", "BAM", "BDT", "BGN", "BHD", "BIF", "BMD", "BOB", "BRL", "BSD", "BTN", "BWP", "BYN", "BZD", "CAD", "CDF", "CHF", "CLP", "CNY", "COP", "CRC", "CUC", "CVE", "CZK", "DJF", "DKK", "DOP", "DZD", "EGP", "ERN", "ETB", "EUR", "FJD", "FKP", "GBP", "GEL", "GHS", "GIP", "GMD", "GNF", "GTQ", "GYD", "HKD", "HNL", "HRK", "HTG", "HUF", "IDR", "ILS", "INR", "IQD", "IRR", "ISK", "JMD", "JOD", "JPY", "KES", "KGS", "KHR", "KMF", "KPW", "KRW", "KWD", "KYD", "KZT", "LAK", "LBP", "LKR", "LRD", "LSL", "LTL", "LYD", "MAD", "MDL", "MGA", "MKD", "MMK", "MNT", "MRU", "MUR", "MVR", "MWK", "MXN", "MYR", "MZN", "NAD", "NGN", "NIO", "NOK", "NPR", "NZD", "OMR", "PAB", "PEN", "PGK", "PHP", "PKR", "PLN", "PYG", "QAR", "RON", "RSD", "RUB", "RWF", "SAR", "SBD", "SCR", "SDG", "SEK", "SGD", "SHP", "SLL", "SOS", "SRD", "SSP", "STD", "SYP", "SZL", "THB", "TJS", "TMT", "TND", "TOP", "TRY", "TTD", "TWD", "TZS", "UAH", "UGX", "USD", "UYU", "UZS", "VEF", "VND", "VUV", "WST", "XAF", "XCD", "XOF", "XPF", "YER", "ZAR", "ZMW", "ZWD" ], "title": "ItAssetsAssetIdTransferPostResponsesContentApplicationJsonSchemaDataActionsStoreOwnAssetAtDeelForLocalDetailsActivationCostFeesCurrency", "type": "string" }, "ItAssetsAssetIdTransferPostResponsesContentApplicationJsonSchemaDataActionsStoreOwnAssetAtDeelForLocalDetailsActivationCostTokenUsage": { "description": "Add-on token consumption details. Null when billing method is \"CURRENCY\"", "properties": { "addon": { "$ref": "#/components/schemas/ItAssetsAssetIdTransferPostResponsesContentApplicationJsonSchemaDataActionsStoreOwnAssetAtDeelForLocalDetailsActivationCostTokenUsageAddon", "description": "The add-on that provides the tokens" }, "cost": { "description": "Number of tokens consumed by the action. Zero when the add-on covers the\nservice without drawing from a token pool", "format": "decimal", "type": "string" }, "tokens_left": { "description": "Number of tokens left in the pool after the action is performed. Null when\nthe add-on covers the service without a token pool", "format": "decimal", "type": [ "string", "null" ] } }, "required": [ "cost", "addon", "tokens_left" ], "title": "ItAssetsAssetIdTransferPostResponsesContentApplicationJsonSchemaDataActionsStoreOwnAssetAtDeelForLocalDetailsActivationCostTokenUsage", "type": "object" }, "ItAssetsAssetIdTransferPostResponsesContentApplicationJsonSchemaDataActionsStoreOwnAssetAtDeelForLocalDetailsActivationCostTokenUsageAddon": { "description": "The add-on that provides the tokens", "properties": { "id": { "description": "ID of the add-on", "format": "uuid", "type": "string" }, "name": { "description": "Public display name of the add-on", "type": "string" } }, "required": [ "id", "name" ], "title": "ItAssetsAssetIdTransferPostResponsesContentApplicationJsonSchemaDataActionsStoreOwnAssetAtDeelForLocalDetailsActivationCostTokenUsageAddon", "type": "object" }, "ItAssetsAssetIdTransferPostResponsesContentApplicationJsonSchemaDataActionsStoreOwnAssetAtDeelForLocalDetailsDestinationCountry": { "description": "ISO 3166-1 alpha-2 country of the Deel warehouse the asset will be shipped to", "enum": [ "AD", "AE", "AF", "AG", "AI", "AL", "AM", "AN", "AO", "AQ", "AR", "AS", "AT", "AU", "AW", "AX", "AZ", "BA", "BB", "BD", "BE", "BF", "BG", "BH", "BI", "BJ", "BL", "BM", "BN", "BO", "BQ", "BR", "BS", "BT", "BV", "BW", "BY", "BZ", "CA", "CC", "CD", "CF", "CG", "CH", "CI", "CK", "CL", "CM", "CN", "CO", "CR", "CU", "CV", "CW", "CX", "CY", "CZ", "DE", "DJ", "DK", "DM", "DO", "DZ", "EC", "EE", "EG", "EH", "ER", "ES", "ET", "FI", "FJ", "FK", "FM", "FO", "FR", "GA", "GB", "GD", "GE", "GF", "GG", "GH", "GI", "GL", "GM", "GN", "GP", "GQ", "GR", "GS", "GT", "GU", "GW", "GY", "HK", "HM", "HN", "HR", "HT", "HU", "IC", "ID", "IE", "IL", "IM", "IN", "IO", "IQ", "IR", "IS", "IT", "JE", "JM", "JO", "JP", "KE", "KG", "KH", "KI", "KM", "KN", "KP", "KR", "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", "XK", "YE", "YT", "ZA", "ZM", "ZW" ], "title": "ItAssetsAssetIdTransferPostResponsesContentApplicationJsonSchemaDataActionsStoreOwnAssetAtDeelForLocalDetailsDestinationCountry", "type": "string" }, "ItAssetsAssetIdTransferPostResponsesContentApplicationJsonSchemaDataActionsStoreOwnAssetAtDeelForLocalDetailsMonthlyFee": { "description": "Monthly storage fee charged after the grace period", "properties": { "amount": { "description": "Amount", "format": "decimal", "type": "string" }, "currency": { "$ref": "#/components/schemas/ItAssetsAssetIdTransferPostResponsesContentApplicationJsonSchemaDataActionsStoreOwnAssetAtDeelForLocalDetailsMonthlyFeeCurrency", "description": "Three-letter currency code for the price" } }, "required": [ "amount", "currency" ], "title": "ItAssetsAssetIdTransferPostResponsesContentApplicationJsonSchemaDataActionsStoreOwnAssetAtDeelForLocalDetailsMonthlyFee", "type": "object" }, "ItAssetsAssetIdTransferPostResponsesContentApplicationJsonSchemaDataActionsStoreOwnAssetAtDeelForLocalDetailsMonthlyFeeCurrency": { "description": "Three-letter currency code for the price", "enum": [ "AED", "AFN", "ALL", "AMD", "ANG", "AOA", "ARS", "AUD", "AWG", "AZN", "BAM", "BDT", "BGN", "BHD", "BIF", "BMD", "BOB", "BRL", "BSD", "BTN", "BWP", "BYN", "BZD", "CAD", "CDF", "CHF", "CLP", "CNY", "COP", "CRC", "CUC", "CVE", "CZK", "DJF", "DKK", "DOP", "DZD", "EGP", "ERN", "ETB", "EUR", "FJD", "FKP", "GBP", "GEL", "GHS", "GIP", "GMD", "GNF", "GTQ", "GYD", "HKD", "HNL", "HRK", "HTG", "HUF", "IDR", "ILS", "INR", "IQD", "IRR", "ISK", "JMD", "JOD", "JPY", "KES", "KGS", "KHR", "KMF", "KPW", "KRW", "KWD", "KYD", "KZT", "LAK", "LBP", "LKR", "LRD", "LSL", "LTL", "LYD", "MAD", "MDL", "MGA", "MKD", "MMK", "MNT", "MRU", "MUR", "MVR", "MWK", "MXN", "MYR", "MZN", "NAD", "NGN", "NIO", "NOK", "NPR", "NZD", "OMR", "PAB", "PEN", "PGK", "PHP", "PKR", "PLN", "PYG", "QAR", "RON", "RSD", "RUB", "RWF", "SAR", "SBD", "SCR", "SDG", "SEK", "SGD", "SHP", "SLL", "SOS", "SRD", "SSP", "STD", "SYP", "SZL", "THB", "TJS", "TMT", "TND", "TOP", "TRY", "TTD", "TWD", "TZS", "UAH", "UGX", "USD", "UYU", "UZS", "VEF", "VND", "VUV", "WST", "XAF", "XCD", "XOF", "XPF", "YER", "ZAR", "ZMW", "ZWD" ], "title": "ItAssetsAssetIdTransferPostResponsesContentApplicationJsonSchemaDataActionsStoreOwnAssetAtDeelForLocalDetailsMonthlyFeeCurrency", "type": "string" }, "ItAssetsAssetIdTransferPostResponsesContentApplicationJsonSchemaDataActionsStoreOwnAssetAtDeelForLocalDisabledReasonsItems": { "enum": [ "ARCHIVED", "AT_DEEL_WAREHOUSE", "BEING_REPAIRED", "CONSUMABLE", "CONTROLLED_BY_DEEL", "COUNTRY_NOT_SUPPORTED_FOR_HUB", "COUNTRY_NOT_SUPPORTED_FOR_LOCAL", "DEEL_OWNED_ITEM_WITHOUT_RENTAL_CONTRACT", "DESKTOP_STORAGE", "ENDING_CONTRACT", "HUB_IN_SAME_REGION_AS_LOCAL", "INACTIVE", "INVALID_ITEM_LOCATION", "INVALID_ORGANIZATION_STATUS", "INVALID_STATE", "ITEM_CONDITIONS_TO_UNARCHIVE_NOT_MET", "ITEM_NOT_VISIBLE_FOR_ORGANIZATION", "NON_DEVICE", "NOT_AT_WAREHOUSE", "NOT_AVAILABLE_FOR_REUSE", "NOT_A_RENTAL", "NOT_MANAGEABLE_BY_ORGANIZATION", "NOT_WITH_ASSIGNMENT", "NOT_WITH_USER", "NO_ACTIVE_ADDONS", "NO_ACTIVE_STORAGE_CONTRACT", "NO_LOCATION_FOR_STORAGE", "NO_LOGISTICS_FOR_STORAGE", "NO_VALID_ADDONS", "ONGOING_SERVICE", "OWNED_BY_DEEL", "OWNED_BY_ORGANIZATION", "OWNED_BY_PARTNER_ORGANIZATION", "PARTNER_CHILD_CONTRACT", "PENDING_DEVICE_REFRESH", "RENTAL_CONTRACT_AND_USER_REGION_DO_NOT_MATCH", "TEMPORARILY_UNAVAILABLE", "UNKNOWN", "USER_HAS_NO_COUNTRY", "USER_HAS_NO_SEAT", "WAITING_FOR_CLEARANCE", "WITH_LOANER_ASSIGNMENT", "WITH_NON_COLLECTED_ASSIGNMENT", "WITH_NON_DELIVERED_ASSIGNMENT", "WITH_PENDING_ASSIGNMENT", "WRONG_ASSIGNMENT_STATUS", "WRONG_CONTRACT_STATUS", "WRONG_TERMS_AND_CONDITIONS" ], "title": "ItAssetsAssetIdTransferPostResponsesContentApplicationJsonSchemaDataActionsStoreOwnAssetAtDeelForLocalDisabledReasonsItems", "type": "string" }, "ItAssetsAssetIdTransferPostResponsesContentApplicationJsonSchemaDataActionsStoreOwnAssetAtDeelForLocalStatus": { "description": "Whether the action is currently available for this asset", "enum": [ "DISABLED", "ENABLED", "NOT_APPLICABLE" ], "title": "ItAssetsAssetIdTransferPostResponsesContentApplicationJsonSchemaDataActionsStoreOwnAssetAtDeelForLocalStatus", "type": "string" }, "ItAssetsAssetIdTransferPostResponsesContentApplicationJsonSchemaDataActionsStoreOwnAssetAtOwnLocation": { "description": "Store an organization-owned asset at an organization-owned location", "properties": { "details": { "description": "Action-specific context needed to perform the action. Populated for enabled and\ndisabled actions (so callers can see what a successful attempt would look like);\nnull when the action is not applicable to this asset.", "oneOf": [ { "$ref": "#/components/schemas/ItAssetsAssetIdTransferPostResponsesContentApplicationJsonSchemaDataActionsStoreOwnAssetAtOwnLocationDetails" }, { "type": "null" } ] }, "disabled_reasons": { "description": "Reasons why the action is disabled. Empty when the action is enabled or not applicable", "items": { "$ref": "#/components/schemas/ItAssetsAssetIdTransferPostResponsesContentApplicationJsonSchemaDataActionsStoreOwnAssetAtOwnLocationDisabledReasonsItems" }, "type": "array" }, "status": { "$ref": "#/components/schemas/ItAssetsAssetIdTransferPostResponsesContentApplicationJsonSchemaDataActionsStoreOwnAssetAtOwnLocationStatus", "description": "Whether the action is currently available for this asset" } }, "required": [ "status", "details", "disabled_reasons" ], "title": "ItAssetsAssetIdTransferPostResponsesContentApplicationJsonSchemaDataActionsStoreOwnAssetAtOwnLocation", "type": "object" }, "ItAssetsAssetIdTransferPostResponsesContentApplicationJsonSchemaDataActionsStoreOwnAssetAtOwnLocationDetails": { "description": "Action-specific context needed to perform the action. Populated for enabled and\ndisabled actions (so callers can see what a successful attempt would look like);\nnull when the action is not applicable to this asset.", "properties": { "eligible_countries": { "description": "Countries where the asset can be stored at an organization-owned location", "items": { "$ref": "#/components/schemas/ItAssetsAssetIdTransferPostResponsesContentApplicationJsonSchemaDataActionsStoreOwnAssetAtOwnLocationDetailsEligibleCountriesItems" }, "type": "array" }, "service_cost": { "$ref": "#/components/schemas/ItAssetsAssetIdTransferPostResponsesContentApplicationJsonSchemaDataActionsStoreOwnAssetAtOwnLocationDetailsServiceCost", "description": "Cost charged for the transfer service" } }, "required": [ "service_cost", "eligible_countries" ], "title": "ItAssetsAssetIdTransferPostResponsesContentApplicationJsonSchemaDataActionsStoreOwnAssetAtOwnLocationDetails", "type": "object" }, "ItAssetsAssetIdTransferPostResponsesContentApplicationJsonSchemaDataActionsStoreOwnAssetAtOwnLocationDetailsEligibleCountriesItems": { "enum": [ "AD", "AE", "AF", "AG", "AI", "AL", "AM", "AN", "AO", "AQ", "AR", "AS", "AT", "AU", "AW", "AX", "AZ", "BA", "BB", "BD", "BE", "BF", "BG", "BH", "BI", "BJ", "BL", "BM", "BN", "BO", "BQ", "BR", "BS", "BT", "BV", "BW", "BY", "BZ", "CA", "CC", "CD", "CF", "CG", "CH", "CI", "CK", "CL", "CM", "CN", "CO", "CR", "CU", "CV", "CW", "CX", "CY", "CZ", "DE", "DJ", "DK", "DM", "DO", "DZ", "EC", "EE", "EG", "EH", "ER", "ES", "ET", "FI", "FJ", "FK", "FM", "FO", "FR", "GA", "GB", "GD", "GE", "GF", "GG", "GH", "GI", "GL", "GM", "GN", "GP", "GQ", "GR", "GS", "GT", "GU", "GW", "GY", "HK", "HM", "HN", "HR", "HT", "HU", "IC", "ID", "IE", "IL", "IM", "IN", "IO", "IQ", "IR", "IS", "IT", "JE", "JM", "JO", "JP", "KE", "KG", "KH", "KI", "KM", "KN", "KP", "KR", "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", "XK", "YE", "YT", "ZA", "ZM", "ZW" ], "title": "ItAssetsAssetIdTransferPostResponsesContentApplicationJsonSchemaDataActionsStoreOwnAssetAtOwnLocationDetailsEligibleCountriesItems", "type": "string" }, "ItAssetsAssetIdTransferPostResponsesContentApplicationJsonSchemaDataActionsStoreOwnAssetAtOwnLocationDetailsServiceCost": { "description": "Cost charged for the transfer service", "properties": { "billing_method": { "$ref": "#/components/schemas/ItAssetsAssetIdTransferPostResponsesContentApplicationJsonSchemaDataActionsStoreOwnAssetAtOwnLocationDetailsServiceCostBillingMethod", "description": "How the action is charged. When \"TOKEN\", the fees are covered by an\nadd-on token pool; when \"CURRENCY\", the fees are billed in the currency\nspecified in the \"fees\" field." }, "fees": { "description": "Price charged for the action. Null when billing method is \"TOKEN\"", "oneOf": [ { "$ref": "#/components/schemas/ItAssetsAssetIdTransferPostResponsesContentApplicationJsonSchemaDataActionsStoreOwnAssetAtOwnLocationDetailsServiceCostFees" }, { "type": "null" } ] }, "token_usage": { "description": "Add-on token consumption details. Null when billing method is \"CURRENCY\"", "oneOf": [ { "$ref": "#/components/schemas/ItAssetsAssetIdTransferPostResponsesContentApplicationJsonSchemaDataActionsStoreOwnAssetAtOwnLocationDetailsServiceCostTokenUsage" }, { "type": "null" } ] } }, "required": [ "fees", "token_usage", "billing_method" ], "title": "ItAssetsAssetIdTransferPostResponsesContentApplicationJsonSchemaDataActionsStoreOwnAssetAtOwnLocationDetailsServiceCost", "type": "object" }, "ItAssetsAssetIdTransferPostResponsesContentApplicationJsonSchemaDataActionsStoreOwnAssetAtOwnLocationDetailsServiceCostBillingMethod": { "description": "How the action is charged. When \"TOKEN\", the fees are covered by an\nadd-on token pool; when \"CURRENCY\", the fees are billed in the currency\nspecified in the \"fees\" field.", "enum": [ "CURRENCY", "TOKEN" ], "title": "ItAssetsAssetIdTransferPostResponsesContentApplicationJsonSchemaDataActionsStoreOwnAssetAtOwnLocationDetailsServiceCostBillingMethod", "type": "string" }, "ItAssetsAssetIdTransferPostResponsesContentApplicationJsonSchemaDataActionsStoreOwnAssetAtOwnLocationDetailsServiceCostFees": { "description": "Price charged for the action. Null when billing method is \"TOKEN\"", "properties": { "amount": { "description": "Amount", "format": "decimal", "type": "string" }, "currency": { "$ref": "#/components/schemas/ItAssetsAssetIdTransferPostResponsesContentApplicationJsonSchemaDataActionsStoreOwnAssetAtOwnLocationDetailsServiceCostFeesCurrency", "description": "Three-letter currency code for the price" } }, "required": [ "amount", "currency" ], "title": "ItAssetsAssetIdTransferPostResponsesContentApplicationJsonSchemaDataActionsStoreOwnAssetAtOwnLocationDetailsServiceCostFees", "type": "object" }, "ItAssetsAssetIdTransferPostResponsesContentApplicationJsonSchemaDataActionsStoreOwnAssetAtOwnLocationDetailsServiceCostFeesCurrency": { "description": "Three-letter currency code for the price", "enum": [ "AED", "AFN", "ALL", "AMD", "ANG", "AOA", "ARS", "AUD", "AWG", "AZN", "BAM", "BDT", "BGN", "BHD", "BIF", "BMD", "BOB", "BRL", "BSD", "BTN", "BWP", "BYN", "BZD", "CAD", "CDF", "CHF", "CLP", "CNY", "COP", "CRC", "CUC", "CVE", "CZK", "DJF", "DKK", "DOP", "DZD", "EGP", "ERN", "ETB", "EUR", "FJD", "FKP", "GBP", "GEL", "GHS", "GIP", "GMD", "GNF", "GTQ", "GYD", "HKD", "HNL", "HRK", "HTG", "HUF", "IDR", "ILS", "INR", "IQD", "IRR", "ISK", "JMD", "JOD", "JPY", "KES", "KGS", "KHR", "KMF", "KPW", "KRW", "KWD", "KYD", "KZT", "LAK", "LBP", "LKR", "LRD", "LSL", "LTL", "LYD", "MAD", "MDL", "MGA", "MKD", "MMK", "MNT", "MRU", "MUR", "MVR", "MWK", "MXN", "MYR", "MZN", "NAD", "NGN", "NIO", "NOK", "NPR", "NZD", "OMR", "PAB", "PEN", "PGK", "PHP", "PKR", "PLN", "PYG", "QAR", "RON", "RSD", "RUB", "RWF", "SAR", "SBD", "SCR", "SDG", "SEK", "SGD", "SHP", "SLL", "SOS", "SRD", "SSP", "STD", "SYP", "SZL", "THB", "TJS", "TMT", "TND", "TOP", "TRY", "TTD", "TWD", "TZS", "UAH", "UGX", "USD", "UYU", "UZS", "VEF", "VND", "VUV", "WST", "XAF", "XCD", "XOF", "XPF", "YER", "ZAR", "ZMW", "ZWD" ], "title": "ItAssetsAssetIdTransferPostResponsesContentApplicationJsonSchemaDataActionsStoreOwnAssetAtOwnLocationDetailsServiceCostFeesCurrency", "type": "string" }, "ItAssetsAssetIdTransferPostResponsesContentApplicationJsonSchemaDataActionsStoreOwnAssetAtOwnLocationDetailsServiceCostTokenUsage": { "description": "Add-on token consumption details. Null when billing method is \"CURRENCY\"", "properties": { "addon": { "$ref": "#/components/schemas/ItAssetsAssetIdTransferPostResponsesContentApplicationJsonSchemaDataActionsStoreOwnAssetAtOwnLocationDetailsServiceCostTokenUsageAddon", "description": "The add-on that provides the tokens" }, "cost": { "description": "Number of tokens consumed by the action. Zero when the add-on covers the\nservice without drawing from a token pool", "format": "decimal", "type": "string" }, "tokens_left": { "description": "Number of tokens left in the pool after the action is performed. Null when\nthe add-on covers the service without a token pool", "format": "decimal", "type": [ "string", "null" ] } }, "required": [ "cost", "addon", "tokens_left" ], "title": "ItAssetsAssetIdTransferPostResponsesContentApplicationJsonSchemaDataActionsStoreOwnAssetAtOwnLocationDetailsServiceCostTokenUsage", "type": "object" }, "ItAssetsAssetIdTransferPostResponsesContentApplicationJsonSchemaDataActionsStoreOwnAssetAtOwnLocationDetailsServiceCostTokenUsageAddon": { "description": "The add-on that provides the tokens", "properties": { "id": { "description": "ID of the add-on", "format": "uuid", "type": "string" }, "name": { "description": "Public display name of the add-on", "type": "string" } }, "required": [ "id", "name" ], "title": "ItAssetsAssetIdTransferPostResponsesContentApplicationJsonSchemaDataActionsStoreOwnAssetAtOwnLocationDetailsServiceCostTokenUsageAddon", "type": "object" }, "ItAssetsAssetIdTransferPostResponsesContentApplicationJsonSchemaDataActionsStoreOwnAssetAtOwnLocationDisabledReasonsItems": { "enum": [ "ARCHIVED", "AT_DEEL_WAREHOUSE", "BEING_REPAIRED", "CONSUMABLE", "CONTROLLED_BY_DEEL", "COUNTRY_NOT_SUPPORTED_FOR_HUB", "COUNTRY_NOT_SUPPORTED_FOR_LOCAL", "DEEL_OWNED_ITEM_WITHOUT_RENTAL_CONTRACT", "DESKTOP_STORAGE", "ENDING_CONTRACT", "HUB_IN_SAME_REGION_AS_LOCAL", "INACTIVE", "INVALID_ITEM_LOCATION", "INVALID_ORGANIZATION_STATUS", "INVALID_STATE", "ITEM_CONDITIONS_TO_UNARCHIVE_NOT_MET", "ITEM_NOT_VISIBLE_FOR_ORGANIZATION", "NON_DEVICE", "NOT_AT_WAREHOUSE", "NOT_AVAILABLE_FOR_REUSE", "NOT_A_RENTAL", "NOT_MANAGEABLE_BY_ORGANIZATION", "NOT_WITH_ASSIGNMENT", "NOT_WITH_USER", "NO_ACTIVE_ADDONS", "NO_ACTIVE_STORAGE_CONTRACT", "NO_LOCATION_FOR_STORAGE", "NO_LOGISTICS_FOR_STORAGE", "NO_VALID_ADDONS", "ONGOING_SERVICE", "OWNED_BY_DEEL", "OWNED_BY_ORGANIZATION", "OWNED_BY_PARTNER_ORGANIZATION", "PARTNER_CHILD_CONTRACT", "PENDING_DEVICE_REFRESH", "RENTAL_CONTRACT_AND_USER_REGION_DO_NOT_MATCH", "TEMPORARILY_UNAVAILABLE", "UNKNOWN", "USER_HAS_NO_COUNTRY", "USER_HAS_NO_SEAT", "WAITING_FOR_CLEARANCE", "WITH_LOANER_ASSIGNMENT", "WITH_NON_COLLECTED_ASSIGNMENT", "WITH_NON_DELIVERED_ASSIGNMENT", "WITH_PENDING_ASSIGNMENT", "WRONG_ASSIGNMENT_STATUS", "WRONG_CONTRACT_STATUS", "WRONG_TERMS_AND_CONDITIONS" ], "title": "ItAssetsAssetIdTransferPostResponsesContentApplicationJsonSchemaDataActionsStoreOwnAssetAtOwnLocationDisabledReasonsItems", "type": "string" }, "ItAssetsAssetIdTransferPostResponsesContentApplicationJsonSchemaDataActionsStoreOwnAssetAtOwnLocationStatus": { "description": "Whether the action is currently available for this asset", "enum": [ "DISABLED", "ENABLED", "NOT_APPLICABLE" ], "title": "ItAssetsAssetIdTransferPostResponsesContentApplicationJsonSchemaDataActionsStoreOwnAssetAtOwnLocationStatus", "type": "string" }, "ItAssetsAssetIdTransferPostResponsesContentApplicationJsonSchemaDataActionsStoreRentalAtDeelForLocal": { "description": "Store a Deel-owned rental asset at a Deel local warehouse", "properties": { "details": { "description": "Action-specific context needed to perform the action. Populated for enabled and\ndisabled actions (so callers can see what a successful attempt would look like);\nnull when the action is not applicable to this asset.", "oneOf": [ { "$ref": "#/components/schemas/ItAssetsAssetIdTransferPostResponsesContentApplicationJsonSchemaDataActionsStoreRentalAtDeelForLocalDetails" }, { "type": "null" } ] }, "disabled_reasons": { "description": "Reasons why the action is disabled. Empty when the action is enabled or not applicable", "items": { "$ref": "#/components/schemas/ItAssetsAssetIdTransferPostResponsesContentApplicationJsonSchemaDataActionsStoreRentalAtDeelForLocalDisabledReasonsItems" }, "type": "array" }, "status": { "$ref": "#/components/schemas/ItAssetsAssetIdTransferPostResponsesContentApplicationJsonSchemaDataActionsStoreRentalAtDeelForLocalStatus", "description": "Whether the action is currently available for this asset" } }, "required": [ "status", "details", "disabled_reasons" ], "title": "ItAssetsAssetIdTransferPostResponsesContentApplicationJsonSchemaDataActionsStoreRentalAtDeelForLocal", "type": "object" }, "ItAssetsAssetIdTransferPostResponsesContentApplicationJsonSchemaDataActionsStoreRentalAtDeelForLocalDetails": { "description": "Action-specific context needed to perform the action. Populated for enabled and\ndisabled actions (so callers can see what a successful attempt would look like);\nnull when the action is not applicable to this asset.", "properties": { "activation_cost": { "$ref": "#/components/schemas/ItAssetsAssetIdTransferPostResponsesContentApplicationJsonSchemaDataActionsStoreRentalAtDeelForLocalDetailsActivationCost", "description": "Cost charged to activate local storage" } }, "required": [ "activation_cost" ], "title": "ItAssetsAssetIdTransferPostResponsesContentApplicationJsonSchemaDataActionsStoreRentalAtDeelForLocalDetails", "type": "object" }, "ItAssetsAssetIdTransferPostResponsesContentApplicationJsonSchemaDataActionsStoreRentalAtDeelForLocalDetailsActivationCost": { "description": "Cost charged to activate local storage", "properties": { "billing_method": { "$ref": "#/components/schemas/ItAssetsAssetIdTransferPostResponsesContentApplicationJsonSchemaDataActionsStoreRentalAtDeelForLocalDetailsActivationCostBillingMethod", "description": "How the action is charged. When \"TOKEN\", the fees are covered by an\nadd-on token pool; when \"CURRENCY\", the fees are billed in the currency\nspecified in the \"fees\" field." }, "fees": { "description": "Price charged for the action. Null when billing method is \"TOKEN\"", "oneOf": [ { "$ref": "#/components/schemas/ItAssetsAssetIdTransferPostResponsesContentApplicationJsonSchemaDataActionsStoreRentalAtDeelForLocalDetailsActivationCostFees" }, { "type": "null" } ] }, "token_usage": { "description": "Add-on token consumption details. Null when billing method is \"CURRENCY\"", "oneOf": [ { "$ref": "#/components/schemas/ItAssetsAssetIdTransferPostResponsesContentApplicationJsonSchemaDataActionsStoreRentalAtDeelForLocalDetailsActivationCostTokenUsage" }, { "type": "null" } ] } }, "required": [ "fees", "token_usage", "billing_method" ], "title": "ItAssetsAssetIdTransferPostResponsesContentApplicationJsonSchemaDataActionsStoreRentalAtDeelForLocalDetailsActivationCost", "type": "object" }, "ItAssetsAssetIdTransferPostResponsesContentApplicationJsonSchemaDataActionsStoreRentalAtDeelForLocalDetailsActivationCostBillingMethod": { "description": "How the action is charged. When \"TOKEN\", the fees are covered by an\nadd-on token pool; when \"CURRENCY\", the fees are billed in the currency\nspecified in the \"fees\" field.", "enum": [ "CURRENCY", "TOKEN" ], "title": "ItAssetsAssetIdTransferPostResponsesContentApplicationJsonSchemaDataActionsStoreRentalAtDeelForLocalDetailsActivationCostBillingMethod", "type": "string" }, "ItAssetsAssetIdTransferPostResponsesContentApplicationJsonSchemaDataActionsStoreRentalAtDeelForLocalDetailsActivationCostFees": { "description": "Price charged for the action. Null when billing method is \"TOKEN\"", "properties": { "amount": { "description": "Amount", "format": "decimal", "type": "string" }, "currency": { "$ref": "#/components/schemas/ItAssetsAssetIdTransferPostResponsesContentApplicationJsonSchemaDataActionsStoreRentalAtDeelForLocalDetailsActivationCostFeesCurrency", "description": "Three-letter currency code for the price" } }, "required": [ "amount", "currency" ], "title": "ItAssetsAssetIdTransferPostResponsesContentApplicationJsonSchemaDataActionsStoreRentalAtDeelForLocalDetailsActivationCostFees", "type": "object" }, "ItAssetsAssetIdTransferPostResponsesContentApplicationJsonSchemaDataActionsStoreRentalAtDeelForLocalDetailsActivationCostFeesCurrency": { "description": "Three-letter currency code for the price", "enum": [ "AED", "AFN", "ALL", "AMD", "ANG", "AOA", "ARS", "AUD", "AWG", "AZN", "BAM", "BDT", "BGN", "BHD", "BIF", "BMD", "BOB", "BRL", "BSD", "BTN", "BWP", "BYN", "BZD", "CAD", "CDF", "CHF", "CLP", "CNY", "COP", "CRC", "CUC", "CVE", "CZK", "DJF", "DKK", "DOP", "DZD", "EGP", "ERN", "ETB", "EUR", "FJD", "FKP", "GBP", "GEL", "GHS", "GIP", "GMD", "GNF", "GTQ", "GYD", "HKD", "HNL", "HRK", "HTG", "HUF", "IDR", "ILS", "INR", "IQD", "IRR", "ISK", "JMD", "JOD", "JPY", "KES", "KGS", "KHR", "KMF", "KPW", "KRW", "KWD", "KYD", "KZT", "LAK", "LBP", "LKR", "LRD", "LSL", "LTL", "LYD", "MAD", "MDL", "MGA", "MKD", "MMK", "MNT", "MRU", "MUR", "MVR", "MWK", "MXN", "MYR", "MZN", "NAD", "NGN", "NIO", "NOK", "NPR", "NZD", "OMR", "PAB", "PEN", "PGK", "PHP", "PKR", "PLN", "PYG", "QAR", "RON", "RSD", "RUB", "RWF", "SAR", "SBD", "SCR", "SDG", "SEK", "SGD", "SHP", "SLL", "SOS", "SRD", "SSP", "STD", "SYP", "SZL", "THB", "TJS", "TMT", "TND", "TOP", "TRY", "TTD", "TWD", "TZS", "UAH", "UGX", "USD", "UYU", "UZS", "VEF", "VND", "VUV", "WST", "XAF", "XCD", "XOF", "XPF", "YER", "ZAR", "ZMW", "ZWD" ], "title": "ItAssetsAssetIdTransferPostResponsesContentApplicationJsonSchemaDataActionsStoreRentalAtDeelForLocalDetailsActivationCostFeesCurrency", "type": "string" }, "ItAssetsAssetIdTransferPostResponsesContentApplicationJsonSchemaDataActionsStoreRentalAtDeelForLocalDetailsActivationCostTokenUsage": { "description": "Add-on token consumption details. Null when billing method is \"CURRENCY\"", "properties": { "addon": { "$ref": "#/components/schemas/ItAssetsAssetIdTransferPostResponsesContentApplicationJsonSchemaDataActionsStoreRentalAtDeelForLocalDetailsActivationCostTokenUsageAddon", "description": "The add-on that provides the tokens" }, "cost": { "description": "Number of tokens consumed by the action. Zero when the add-on covers the\nservice without drawing from a token pool", "format": "decimal", "type": "string" }, "tokens_left": { "description": "Number of tokens left in the pool after the action is performed. Null when\nthe add-on covers the service without a token pool", "format": "decimal", "type": [ "string", "null" ] } }, "required": [ "cost", "addon", "tokens_left" ], "title": "ItAssetsAssetIdTransferPostResponsesContentApplicationJsonSchemaDataActionsStoreRentalAtDeelForLocalDetailsActivationCostTokenUsage", "type": "object" }, "ItAssetsAssetIdTransferPostResponsesContentApplicationJsonSchemaDataActionsStoreRentalAtDeelForLocalDetailsActivationCostTokenUsageAddon": { "description": "The add-on that provides the tokens", "properties": { "id": { "description": "ID of the add-on", "format": "uuid", "type": "string" }, "name": { "description": "Public display name of the add-on", "type": "string" } }, "required": [ "id", "name" ], "title": "ItAssetsAssetIdTransferPostResponsesContentApplicationJsonSchemaDataActionsStoreRentalAtDeelForLocalDetailsActivationCostTokenUsageAddon", "type": "object" }, "ItAssetsAssetIdTransferPostResponsesContentApplicationJsonSchemaDataActionsStoreRentalAtDeelForLocalDisabledReasonsItems": { "enum": [ "ARCHIVED", "AT_DEEL_WAREHOUSE", "BEING_REPAIRED", "CONSUMABLE", "CONTROLLED_BY_DEEL", "COUNTRY_NOT_SUPPORTED_FOR_HUB", "COUNTRY_NOT_SUPPORTED_FOR_LOCAL", "DEEL_OWNED_ITEM_WITHOUT_RENTAL_CONTRACT", "DESKTOP_STORAGE", "ENDING_CONTRACT", "HUB_IN_SAME_REGION_AS_LOCAL", "INACTIVE", "INVALID_ITEM_LOCATION", "INVALID_ORGANIZATION_STATUS", "INVALID_STATE", "ITEM_CONDITIONS_TO_UNARCHIVE_NOT_MET", "ITEM_NOT_VISIBLE_FOR_ORGANIZATION", "NON_DEVICE", "NOT_AT_WAREHOUSE", "NOT_AVAILABLE_FOR_REUSE", "NOT_A_RENTAL", "NOT_MANAGEABLE_BY_ORGANIZATION", "NOT_WITH_ASSIGNMENT", "NOT_WITH_USER", "NO_ACTIVE_ADDONS", "NO_ACTIVE_STORAGE_CONTRACT", "NO_LOCATION_FOR_STORAGE", "NO_LOGISTICS_FOR_STORAGE", "NO_VALID_ADDONS", "ONGOING_SERVICE", "OWNED_BY_DEEL", "OWNED_BY_ORGANIZATION", "OWNED_BY_PARTNER_ORGANIZATION", "PARTNER_CHILD_CONTRACT", "PENDING_DEVICE_REFRESH", "RENTAL_CONTRACT_AND_USER_REGION_DO_NOT_MATCH", "TEMPORARILY_UNAVAILABLE", "UNKNOWN", "USER_HAS_NO_COUNTRY", "USER_HAS_NO_SEAT", "WAITING_FOR_CLEARANCE", "WITH_LOANER_ASSIGNMENT", "WITH_NON_COLLECTED_ASSIGNMENT", "WITH_NON_DELIVERED_ASSIGNMENT", "WITH_PENDING_ASSIGNMENT", "WRONG_ASSIGNMENT_STATUS", "WRONG_CONTRACT_STATUS", "WRONG_TERMS_AND_CONDITIONS" ], "title": "ItAssetsAssetIdTransferPostResponsesContentApplicationJsonSchemaDataActionsStoreRentalAtDeelForLocalDisabledReasonsItems", "type": "string" }, "ItAssetsAssetIdTransferPostResponsesContentApplicationJsonSchemaDataActionsStoreRentalAtDeelForLocalStatus": { "description": "Whether the action is currently available for this asset", "enum": [ "DISABLED", "ENABLED", "NOT_APPLICABLE" ], "title": "ItAssetsAssetIdTransferPostResponsesContentApplicationJsonSchemaDataActionsStoreRentalAtDeelForLocalStatus", "type": "string" }, "ItAssetsAssetIdTransferPostResponsesContentApplicationJsonSchemaDataActionsStoreRentalAtDeelForZone1": { "description": "Store a Deel-owned rental asset at a Deel zone-1 warehouse", "properties": { "details": { "description": "Action-specific context needed to perform the action. Populated for enabled and\ndisabled actions (so callers can see what a successful attempt would look like);\nnull when the action is not applicable to this asset.", "oneOf": [ { "$ref": "#/components/schemas/ItAssetsAssetIdTransferPostResponsesContentApplicationJsonSchemaDataActionsStoreRentalAtDeelForZone1Details" }, { "type": "null" } ] }, "disabled_reasons": { "description": "Reasons why the action is disabled. Empty when the action is enabled or not applicable", "items": { "$ref": "#/components/schemas/ItAssetsAssetIdTransferPostResponsesContentApplicationJsonSchemaDataActionsStoreRentalAtDeelForZone1DisabledReasonsItems" }, "type": "array" }, "status": { "$ref": "#/components/schemas/ItAssetsAssetIdTransferPostResponsesContentApplicationJsonSchemaDataActionsStoreRentalAtDeelForZone1Status", "description": "Whether the action is currently available for this asset" } }, "required": [ "status", "details", "disabled_reasons" ], "title": "ItAssetsAssetIdTransferPostResponsesContentApplicationJsonSchemaDataActionsStoreRentalAtDeelForZone1", "type": "object" }, "ItAssetsAssetIdTransferPostResponsesContentApplicationJsonSchemaDataActionsStoreRentalAtDeelForZone1Details": { "description": "Action-specific context needed to perform the action. Populated for enabled and\ndisabled actions (so callers can see what a successful attempt would look like);\nnull when the action is not applicable to this asset.", "properties": { "activation_cost": { "$ref": "#/components/schemas/ItAssetsAssetIdTransferPostResponsesContentApplicationJsonSchemaDataActionsStoreRentalAtDeelForZone1DetailsActivationCost", "description": "Cost charged to activate zone-1 storage" } }, "required": [ "activation_cost" ], "title": "ItAssetsAssetIdTransferPostResponsesContentApplicationJsonSchemaDataActionsStoreRentalAtDeelForZone1Details", "type": "object" }, "ItAssetsAssetIdTransferPostResponsesContentApplicationJsonSchemaDataActionsStoreRentalAtDeelForZone1DetailsActivationCost": { "description": "Cost charged to activate zone-1 storage", "properties": { "billing_method": { "$ref": "#/components/schemas/ItAssetsAssetIdTransferPostResponsesContentApplicationJsonSchemaDataActionsStoreRentalAtDeelForZone1DetailsActivationCostBillingMethod", "description": "How the action is charged. When \"TOKEN\", the fees are covered by an\nadd-on token pool; when \"CURRENCY\", the fees are billed in the currency\nspecified in the \"fees\" field." }, "fees": { "description": "Price charged for the action. Null when billing method is \"TOKEN\"", "oneOf": [ { "$ref": "#/components/schemas/ItAssetsAssetIdTransferPostResponsesContentApplicationJsonSchemaDataActionsStoreRentalAtDeelForZone1DetailsActivationCostFees" }, { "type": "null" } ] }, "token_usage": { "description": "Add-on token consumption details. Null when billing method is \"CURRENCY\"", "oneOf": [ { "$ref": "#/components/schemas/ItAssetsAssetIdTransferPostResponsesContentApplicationJsonSchemaDataActionsStoreRentalAtDeelForZone1DetailsActivationCostTokenUsage" }, { "type": "null" } ] } }, "required": [ "fees", "token_usage", "billing_method" ], "title": "ItAssetsAssetIdTransferPostResponsesContentApplicationJsonSchemaDataActionsStoreRentalAtDeelForZone1DetailsActivationCost", "type": "object" }, "ItAssetsAssetIdTransferPostResponsesContentApplicationJsonSchemaDataActionsStoreRentalAtDeelForZone1DetailsActivationCostBillingMethod": { "description": "How the action is charged. When \"TOKEN\", the fees are covered by an\nadd-on token pool; when \"CURRENCY\", the fees are billed in the currency\nspecified in the \"fees\" field.", "enum": [ "CURRENCY", "TOKEN" ], "title": "ItAssetsAssetIdTransferPostResponsesContentApplicationJsonSchemaDataActionsStoreRentalAtDeelForZone1DetailsActivationCostBillingMethod", "type": "string" }, "ItAssetsAssetIdTransferPostResponsesContentApplicationJsonSchemaDataActionsStoreRentalAtDeelForZone1DetailsActivationCostFees": { "description": "Price charged for the action. Null when billing method is \"TOKEN\"", "properties": { "amount": { "description": "Amount", "format": "decimal", "type": "string" }, "currency": { "$ref": "#/components/schemas/ItAssetsAssetIdTransferPostResponsesContentApplicationJsonSchemaDataActionsStoreRentalAtDeelForZone1DetailsActivationCostFeesCurrency", "description": "Three-letter currency code for the price" } }, "required": [ "amount", "currency" ], "title": "ItAssetsAssetIdTransferPostResponsesContentApplicationJsonSchemaDataActionsStoreRentalAtDeelForZone1DetailsActivationCostFees", "type": "object" }, "ItAssetsAssetIdTransferPostResponsesContentApplicationJsonSchemaDataActionsStoreRentalAtDeelForZone1DetailsActivationCostFeesCurrency": { "description": "Three-letter currency code for the price", "enum": [ "AED", "AFN", "ALL", "AMD", "ANG", "AOA", "ARS", "AUD", "AWG", "AZN", "BAM", "BDT", "BGN", "BHD", "BIF", "BMD", "BOB", "BRL", "BSD", "BTN", "BWP", "BYN", "BZD", "CAD", "CDF", "CHF", "CLP", "CNY", "COP", "CRC", "CUC", "CVE", "CZK", "DJF", "DKK", "DOP", "DZD", "EGP", "ERN", "ETB", "EUR", "FJD", "FKP", "GBP", "GEL", "GHS", "GIP", "GMD", "GNF", "GTQ", "GYD", "HKD", "HNL", "HRK", "HTG", "HUF", "IDR", "ILS", "INR", "IQD", "IRR", "ISK", "JMD", "JOD", "JPY", "KES", "KGS", "KHR", "KMF", "KPW", "KRW", "KWD", "KYD", "KZT", "LAK", "LBP", "LKR", "LRD", "LSL", "LTL", "LYD", "MAD", "MDL", "MGA", "MKD", "MMK", "MNT", "MRU", "MUR", "MVR", "MWK", "MXN", "MYR", "MZN", "NAD", "NGN", "NIO", "NOK", "NPR", "NZD", "OMR", "PAB", "PEN", "PGK", "PHP", "PKR", "PLN", "PYG", "QAR", "RON", "RSD", "RUB", "RWF", "SAR", "SBD", "SCR", "SDG", "SEK", "SGD", "SHP", "SLL", "SOS", "SRD", "SSP", "STD", "SYP", "SZL", "THB", "TJS", "TMT", "TND", "TOP", "TRY", "TTD", "TWD", "TZS", "UAH", "UGX", "USD", "UYU", "UZS", "VEF", "VND", "VUV", "WST", "XAF", "XCD", "XOF", "XPF", "YER", "ZAR", "ZMW", "ZWD" ], "title": "ItAssetsAssetIdTransferPostResponsesContentApplicationJsonSchemaDataActionsStoreRentalAtDeelForZone1DetailsActivationCostFeesCurrency", "type": "string" }, "ItAssetsAssetIdTransferPostResponsesContentApplicationJsonSchemaDataActionsStoreRentalAtDeelForZone1DetailsActivationCostTokenUsage": { "description": "Add-on token consumption details. Null when billing method is \"CURRENCY\"", "properties": { "addon": { "$ref": "#/components/schemas/ItAssetsAssetIdTransferPostResponsesContentApplicationJsonSchemaDataActionsStoreRentalAtDeelForZone1DetailsActivationCostTokenUsageAddon", "description": "The add-on that provides the tokens" }, "cost": { "description": "Number of tokens consumed by the action. Zero when the add-on covers the\nservice without drawing from a token pool", "format": "decimal", "type": "string" }, "tokens_left": { "description": "Number of tokens left in the pool after the action is performed. Null when\nthe add-on covers the service without a token pool", "format": "decimal", "type": [ "string", "null" ] } }, "required": [ "cost", "addon", "tokens_left" ], "title": "ItAssetsAssetIdTransferPostResponsesContentApplicationJsonSchemaDataActionsStoreRentalAtDeelForZone1DetailsActivationCostTokenUsage", "type": "object" }, "ItAssetsAssetIdTransferPostResponsesContentApplicationJsonSchemaDataActionsStoreRentalAtDeelForZone1DetailsActivationCostTokenUsageAddon": { "description": "The add-on that provides the tokens", "properties": { "id": { "description": "ID of the add-on", "format": "uuid", "type": "string" }, "name": { "description": "Public display name of the add-on", "type": "string" } }, "required": [ "id", "name" ], "title": "ItAssetsAssetIdTransferPostResponsesContentApplicationJsonSchemaDataActionsStoreRentalAtDeelForZone1DetailsActivationCostTokenUsageAddon", "type": "object" }, "ItAssetsAssetIdTransferPostResponsesContentApplicationJsonSchemaDataActionsStoreRentalAtDeelForZone1DisabledReasonsItems": { "enum": [ "ARCHIVED", "AT_DEEL_WAREHOUSE", "BEING_REPAIRED", "CONSUMABLE", "CONTROLLED_BY_DEEL", "COUNTRY_NOT_SUPPORTED_FOR_HUB", "COUNTRY_NOT_SUPPORTED_FOR_LOCAL", "DEEL_OWNED_ITEM_WITHOUT_RENTAL_CONTRACT", "DESKTOP_STORAGE", "ENDING_CONTRACT", "HUB_IN_SAME_REGION_AS_LOCAL", "INACTIVE", "INVALID_ITEM_LOCATION", "INVALID_ORGANIZATION_STATUS", "INVALID_STATE", "ITEM_CONDITIONS_TO_UNARCHIVE_NOT_MET", "ITEM_NOT_VISIBLE_FOR_ORGANIZATION", "NON_DEVICE", "NOT_AT_WAREHOUSE", "NOT_AVAILABLE_FOR_REUSE", "NOT_A_RENTAL", "NOT_MANAGEABLE_BY_ORGANIZATION", "NOT_WITH_ASSIGNMENT", "NOT_WITH_USER", "NO_ACTIVE_ADDONS", "NO_ACTIVE_STORAGE_CONTRACT", "NO_LOCATION_FOR_STORAGE", "NO_LOGISTICS_FOR_STORAGE", "NO_VALID_ADDONS", "ONGOING_SERVICE", "OWNED_BY_DEEL", "OWNED_BY_ORGANIZATION", "OWNED_BY_PARTNER_ORGANIZATION", "PARTNER_CHILD_CONTRACT", "PENDING_DEVICE_REFRESH", "RENTAL_CONTRACT_AND_USER_REGION_DO_NOT_MATCH", "TEMPORARILY_UNAVAILABLE", "UNKNOWN", "USER_HAS_NO_COUNTRY", "USER_HAS_NO_SEAT", "WAITING_FOR_CLEARANCE", "WITH_LOANER_ASSIGNMENT", "WITH_NON_COLLECTED_ASSIGNMENT", "WITH_NON_DELIVERED_ASSIGNMENT", "WITH_PENDING_ASSIGNMENT", "WRONG_ASSIGNMENT_STATUS", "WRONG_CONTRACT_STATUS", "WRONG_TERMS_AND_CONDITIONS" ], "title": "ItAssetsAssetIdTransferPostResponsesContentApplicationJsonSchemaDataActionsStoreRentalAtDeelForZone1DisabledReasonsItems", "type": "string" }, "ItAssetsAssetIdTransferPostResponsesContentApplicationJsonSchemaDataActionsStoreRentalAtDeelForZone1Status": { "description": "Whether the action is currently available for this asset", "enum": [ "DISABLED", "ENABLED", "NOT_APPLICABLE" ], "title": "ItAssetsAssetIdTransferPostResponsesContentApplicationJsonSchemaDataActionsStoreRentalAtDeelForZone1Status", "type": "string" }, "ItAssetsAssetIdTransferPostResponsesContentApplicationJsonSchemaDataActionsTransferOwnAsset": { "description": "Transfer an organization-owned asset to another user", "properties": { "details": { "description": "Action-specific context needed to perform the action. Populated for enabled and\ndisabled actions (so callers can see what a successful attempt would look like);\nnull when the action is not applicable to this asset.", "oneOf": [ { "$ref": "#/components/schemas/ItAssetsAssetIdTransferPostResponsesContentApplicationJsonSchemaDataActionsTransferOwnAssetDetails" }, { "type": "null" } ] }, "disabled_reasons": { "description": "Reasons why the action is disabled. Empty when the action is enabled or not applicable", "items": { "$ref": "#/components/schemas/ItAssetsAssetIdTransferPostResponsesContentApplicationJsonSchemaDataActionsTransferOwnAssetDisabledReasonsItems" }, "type": "array" }, "status": { "$ref": "#/components/schemas/ItAssetsAssetIdTransferPostResponsesContentApplicationJsonSchemaDataActionsTransferOwnAssetStatus", "description": "Whether the action is currently available for this asset" } }, "required": [ "status", "details", "disabled_reasons" ], "title": "ItAssetsAssetIdTransferPostResponsesContentApplicationJsonSchemaDataActionsTransferOwnAsset", "type": "object" }, "ItAssetsAssetIdTransferPostResponsesContentApplicationJsonSchemaDataActionsTransferOwnAssetDetails": { "description": "Action-specific context needed to perform the action. Populated for enabled and\ndisabled actions (so callers can see what a successful attempt would look like);\nnull when the action is not applicable to this asset.", "properties": { "eligible_countries": { "description": "Countries the asset can be transferred to", "items": { "$ref": "#/components/schemas/ItAssetsAssetIdTransferPostResponsesContentApplicationJsonSchemaDataActionsTransferOwnAssetDetailsEligibleCountriesItems" }, "type": "array" }, "transfer_cost": { "$ref": "#/components/schemas/ItAssetsAssetIdTransferPostResponsesContentApplicationJsonSchemaDataActionsTransferOwnAssetDetailsTransferCost", "description": "Cost charged for the transfer service" } }, "required": [ "transfer_cost", "eligible_countries" ], "title": "ItAssetsAssetIdTransferPostResponsesContentApplicationJsonSchemaDataActionsTransferOwnAssetDetails", "type": "object" }, "ItAssetsAssetIdTransferPostResponsesContentApplicationJsonSchemaDataActionsTransferOwnAssetDetailsEligibleCountriesItems": { "enum": [ "AD", "AE", "AF", "AG", "AI", "AL", "AM", "AN", "AO", "AQ", "AR", "AS", "AT", "AU", "AW", "AX", "AZ", "BA", "BB", "BD", "BE", "BF", "BG", "BH", "BI", "BJ", "BL", "BM", "BN", "BO", "BQ", "BR", "BS", "BT", "BV", "BW", "BY", "BZ", "CA", "CC", "CD", "CF", "CG", "CH", "CI", "CK", "CL", "CM", "CN", "CO", "CR", "CU", "CV", "CW", "CX", "CY", "CZ", "DE", "DJ", "DK", "DM", "DO", "DZ", "EC", "EE", "EG", "EH", "ER", "ES", "ET", "FI", "FJ", "FK", "FM", "FO", "FR", "GA", "GB", "GD", "GE", "GF", "GG", "GH", "GI", "GL", "GM", "GN", "GP", "GQ", "GR", "GS", "GT", "GU", "GW", "GY", "HK", "HM", "HN", "HR", "HT", "HU", "IC", "ID", "IE", "IL", "IM", "IN", "IO", "IQ", "IR", "IS", "IT", "JE", "JM", "JO", "JP", "KE", "KG", "KH", "KI", "KM", "KN", "KP", "KR", "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", "XK", "YE", "YT", "ZA", "ZM", "ZW" ], "title": "ItAssetsAssetIdTransferPostResponsesContentApplicationJsonSchemaDataActionsTransferOwnAssetDetailsEligibleCountriesItems", "type": "string" }, "ItAssetsAssetIdTransferPostResponsesContentApplicationJsonSchemaDataActionsTransferOwnAssetDetailsTransferCost": { "description": "Cost charged for the transfer service", "properties": { "billing_method": { "$ref": "#/components/schemas/ItAssetsAssetIdTransferPostResponsesContentApplicationJsonSchemaDataActionsTransferOwnAssetDetailsTransferCostBillingMethod", "description": "How the action is charged. When \"TOKEN\", the fees are covered by an\nadd-on token pool; when \"CURRENCY\", the fees are billed in the currency\nspecified in the \"fees\" field." }, "fees": { "description": "Price charged for the action. Null when billing method is \"TOKEN\"", "oneOf": [ { "$ref": "#/components/schemas/ItAssetsAssetIdTransferPostResponsesContentApplicationJsonSchemaDataActionsTransferOwnAssetDetailsTransferCostFees" }, { "type": "null" } ] }, "token_usage": { "description": "Add-on token consumption details. Null when billing method is \"CURRENCY\"", "oneOf": [ { "$ref": "#/components/schemas/ItAssetsAssetIdTransferPostResponsesContentApplicationJsonSchemaDataActionsTransferOwnAssetDetailsTransferCostTokenUsage" }, { "type": "null" } ] } }, "required": [ "fees", "token_usage", "billing_method" ], "title": "ItAssetsAssetIdTransferPostResponsesContentApplicationJsonSchemaDataActionsTransferOwnAssetDetailsTransferCost", "type": "object" }, "ItAssetsAssetIdTransferPostResponsesContentApplicationJsonSchemaDataActionsTransferOwnAssetDetailsTransferCostBillingMethod": { "description": "How the action is charged. When \"TOKEN\", the fees are covered by an\nadd-on token pool; when \"CURRENCY\", the fees are billed in the currency\nspecified in the \"fees\" field.", "enum": [ "CURRENCY", "TOKEN" ], "title": "ItAssetsAssetIdTransferPostResponsesContentApplicationJsonSchemaDataActionsTransferOwnAssetDetailsTransferCostBillingMethod", "type": "string" }, "ItAssetsAssetIdTransferPostResponsesContentApplicationJsonSchemaDataActionsTransferOwnAssetDetailsTransferCostFees": { "description": "Price charged for the action. Null when billing method is \"TOKEN\"", "properties": { "amount": { "description": "Amount", "format": "decimal", "type": "string" }, "currency": { "$ref": "#/components/schemas/ItAssetsAssetIdTransferPostResponsesContentApplicationJsonSchemaDataActionsTransferOwnAssetDetailsTransferCostFeesCurrency", "description": "Three-letter currency code for the price" } }, "required": [ "amount", "currency" ], "title": "ItAssetsAssetIdTransferPostResponsesContentApplicationJsonSchemaDataActionsTransferOwnAssetDetailsTransferCostFees", "type": "object" }, "ItAssetsAssetIdTransferPostResponsesContentApplicationJsonSchemaDataActionsTransferOwnAssetDetailsTransferCostFeesCurrency": { "description": "Three-letter currency code for the price", "enum": [ "AED", "AFN", "ALL", "AMD", "ANG", "AOA", "ARS", "AUD", "AWG", "AZN", "BAM", "BDT", "BGN", "BHD", "BIF", "BMD", "BOB", "BRL", "BSD", "BTN", "BWP", "BYN", "BZD", "CAD", "CDF", "CHF", "CLP", "CNY", "COP", "CRC", "CUC", "CVE", "CZK", "DJF", "DKK", "DOP", "DZD", "EGP", "ERN", "ETB", "EUR", "FJD", "FKP", "GBP", "GEL", "GHS", "GIP", "GMD", "GNF", "GTQ", "GYD", "HKD", "HNL", "HRK", "HTG", "HUF", "IDR", "ILS", "INR", "IQD", "IRR", "ISK", "JMD", "JOD", "JPY", "KES", "KGS", "KHR", "KMF", "KPW", "KRW", "KWD", "KYD", "KZT", "LAK", "LBP", "LKR", "LRD", "LSL", "LTL", "LYD", "MAD", "MDL", "MGA", "MKD", "MMK", "MNT", "MRU", "MUR", "MVR", "MWK", "MXN", "MYR", "MZN", "NAD", "NGN", "NIO", "NOK", "NPR", "NZD", "OMR", "PAB", "PEN", "PGK", "PHP", "PKR", "PLN", "PYG", "QAR", "RON", "RSD", "RUB", "RWF", "SAR", "SBD", "SCR", "SDG", "SEK", "SGD", "SHP", "SLL", "SOS", "SRD", "SSP", "STD", "SYP", "SZL", "THB", "TJS", "TMT", "TND", "TOP", "TRY", "TTD", "TWD", "TZS", "UAH", "UGX", "USD", "UYU", "UZS", "VEF", "VND", "VUV", "WST", "XAF", "XCD", "XOF", "XPF", "YER", "ZAR", "ZMW", "ZWD" ], "title": "ItAssetsAssetIdTransferPostResponsesContentApplicationJsonSchemaDataActionsTransferOwnAssetDetailsTransferCostFeesCurrency", "type": "string" }, "ItAssetsAssetIdTransferPostResponsesContentApplicationJsonSchemaDataActionsTransferOwnAssetDetailsTransferCostTokenUsage": { "description": "Add-on token consumption details. Null when billing method is \"CURRENCY\"", "properties": { "addon": { "$ref": "#/components/schemas/ItAssetsAssetIdTransferPostResponsesContentApplicationJsonSchemaDataActionsTransferOwnAssetDetailsTransferCostTokenUsageAddon", "description": "The add-on that provides the tokens" }, "cost": { "description": "Number of tokens consumed by the action. Zero when the add-on covers the\nservice without drawing from a token pool", "format": "decimal", "type": "string" }, "tokens_left": { "description": "Number of tokens left in the pool after the action is performed. Null when\nthe add-on covers the service without a token pool", "format": "decimal", "type": [ "string", "null" ] } }, "required": [ "cost", "addon", "tokens_left" ], "title": "ItAssetsAssetIdTransferPostResponsesContentApplicationJsonSchemaDataActionsTransferOwnAssetDetailsTransferCostTokenUsage", "type": "object" }, "ItAssetsAssetIdTransferPostResponsesContentApplicationJsonSchemaDataActionsTransferOwnAssetDetailsTransferCostTokenUsageAddon": { "description": "The add-on that provides the tokens", "properties": { "id": { "description": "ID of the add-on", "format": "uuid", "type": "string" }, "name": { "description": "Public display name of the add-on", "type": "string" } }, "required": [ "id", "name" ], "title": "ItAssetsAssetIdTransferPostResponsesContentApplicationJsonSchemaDataActionsTransferOwnAssetDetailsTransferCostTokenUsageAddon", "type": "object" }, "ItAssetsAssetIdTransferPostResponsesContentApplicationJsonSchemaDataActionsTransferOwnAssetDisabledReasonsItems": { "enum": [ "ARCHIVED", "AT_DEEL_WAREHOUSE", "BEING_REPAIRED", "CONSUMABLE", "CONTROLLED_BY_DEEL", "COUNTRY_NOT_SUPPORTED_FOR_HUB", "COUNTRY_NOT_SUPPORTED_FOR_LOCAL", "DEEL_OWNED_ITEM_WITHOUT_RENTAL_CONTRACT", "DESKTOP_STORAGE", "ENDING_CONTRACT", "HUB_IN_SAME_REGION_AS_LOCAL", "INACTIVE", "INVALID_ITEM_LOCATION", "INVALID_ORGANIZATION_STATUS", "INVALID_STATE", "ITEM_CONDITIONS_TO_UNARCHIVE_NOT_MET", "ITEM_NOT_VISIBLE_FOR_ORGANIZATION", "NON_DEVICE", "NOT_AT_WAREHOUSE", "NOT_AVAILABLE_FOR_REUSE", "NOT_A_RENTAL", "NOT_MANAGEABLE_BY_ORGANIZATION", "NOT_WITH_ASSIGNMENT", "NOT_WITH_USER", "NO_ACTIVE_ADDONS", "NO_ACTIVE_STORAGE_CONTRACT", "NO_LOCATION_FOR_STORAGE", "NO_LOGISTICS_FOR_STORAGE", "NO_VALID_ADDONS", "ONGOING_SERVICE", "OWNED_BY_DEEL", "OWNED_BY_ORGANIZATION", "OWNED_BY_PARTNER_ORGANIZATION", "PARTNER_CHILD_CONTRACT", "PENDING_DEVICE_REFRESH", "RENTAL_CONTRACT_AND_USER_REGION_DO_NOT_MATCH", "TEMPORARILY_UNAVAILABLE", "UNKNOWN", "USER_HAS_NO_COUNTRY", "USER_HAS_NO_SEAT", "WAITING_FOR_CLEARANCE", "WITH_LOANER_ASSIGNMENT", "WITH_NON_COLLECTED_ASSIGNMENT", "WITH_NON_DELIVERED_ASSIGNMENT", "WITH_PENDING_ASSIGNMENT", "WRONG_ASSIGNMENT_STATUS", "WRONG_CONTRACT_STATUS", "WRONG_TERMS_AND_CONDITIONS" ], "title": "ItAssetsAssetIdTransferPostResponsesContentApplicationJsonSchemaDataActionsTransferOwnAssetDisabledReasonsItems", "type": "string" }, "ItAssetsAssetIdTransferPostResponsesContentApplicationJsonSchemaDataActionsTransferOwnAssetStatus": { "description": "Whether the action is currently available for this asset", "enum": [ "DISABLED", "ENABLED", "NOT_APPLICABLE" ], "title": "ItAssetsAssetIdTransferPostResponsesContentApplicationJsonSchemaDataActionsTransferOwnAssetStatus", "type": "string" }, "ItAssetsAssetIdTransferPostResponsesContentApplicationJsonSchemaDataActionsTransferRental": { "description": "Transfer a Deel-owned rental asset to another user", "properties": { "details": { "description": "Action-specific context needed to perform the action. Populated for enabled and\ndisabled actions (so callers can see what a successful attempt would look like);\nnull when the action is not applicable to this asset.", "oneOf": [ { "$ref": "#/components/schemas/ItAssetsAssetIdTransferPostResponsesContentApplicationJsonSchemaDataActionsTransferRentalDetails" }, { "type": "null" } ] }, "disabled_reasons": { "description": "Reasons why the action is disabled. Empty when the action is enabled or not applicable", "items": { "$ref": "#/components/schemas/ItAssetsAssetIdTransferPostResponsesContentApplicationJsonSchemaDataActionsTransferRentalDisabledReasonsItems" }, "type": "array" }, "status": { "$ref": "#/components/schemas/ItAssetsAssetIdTransferPostResponsesContentApplicationJsonSchemaDataActionsTransferRentalStatus", "description": "Whether the action is currently available for this asset" } }, "required": [ "status", "details", "disabled_reasons" ], "title": "ItAssetsAssetIdTransferPostResponsesContentApplicationJsonSchemaDataActionsTransferRental", "type": "object" }, "ItAssetsAssetIdTransferPostResponsesContentApplicationJsonSchemaDataActionsTransferRentalDetails": { "description": "Action-specific context needed to perform the action. Populated for enabled and\ndisabled actions (so callers can see what a successful attempt would look like);\nnull when the action is not applicable to this asset.", "properties": { "eligible_countries": { "description": "Countries the asset can be transferred to", "items": { "$ref": "#/components/schemas/ItAssetsAssetIdTransferPostResponsesContentApplicationJsonSchemaDataActionsTransferRentalDetailsEligibleCountriesItems" }, "type": "array" }, "transfer_cost": { "$ref": "#/components/schemas/ItAssetsAssetIdTransferPostResponsesContentApplicationJsonSchemaDataActionsTransferRentalDetailsTransferCost", "description": "Cost charged for the transfer service" } }, "required": [ "transfer_cost", "eligible_countries" ], "title": "ItAssetsAssetIdTransferPostResponsesContentApplicationJsonSchemaDataActionsTransferRentalDetails", "type": "object" }, "ItAssetsAssetIdTransferPostResponsesContentApplicationJsonSchemaDataActionsTransferRentalDetailsEligibleCountriesItems": { "enum": [ "AD", "AE", "AF", "AG", "AI", "AL", "AM", "AN", "AO", "AQ", "AR", "AS", "AT", "AU", "AW", "AX", "AZ", "BA", "BB", "BD", "BE", "BF", "BG", "BH", "BI", "BJ", "BL", "BM", "BN", "BO", "BQ", "BR", "BS", "BT", "BV", "BW", "BY", "BZ", "CA", "CC", "CD", "CF", "CG", "CH", "CI", "CK", "CL", "CM", "CN", "CO", "CR", "CU", "CV", "CW", "CX", "CY", "CZ", "DE", "DJ", "DK", "DM", "DO", "DZ", "EC", "EE", "EG", "EH", "ER", "ES", "ET", "FI", "FJ", "FK", "FM", "FO", "FR", "GA", "GB", "GD", "GE", "GF", "GG", "GH", "GI", "GL", "GM", "GN", "GP", "GQ", "GR", "GS", "GT", "GU", "GW", "GY", "HK", "HM", "HN", "HR", "HT", "HU", "IC", "ID", "IE", "IL", "IM", "IN", "IO", "IQ", "IR", "IS", "IT", "JE", "JM", "JO", "JP", "KE", "KG", "KH", "KI", "KM", "KN", "KP", "KR", "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", "XK", "YE", "YT", "ZA", "ZM", "ZW" ], "title": "ItAssetsAssetIdTransferPostResponsesContentApplicationJsonSchemaDataActionsTransferRentalDetailsEligibleCountriesItems", "type": "string" }, "ItAssetsAssetIdTransferPostResponsesContentApplicationJsonSchemaDataActionsTransferRentalDetailsTransferCost": { "description": "Cost charged for the transfer service", "properties": { "billing_method": { "$ref": "#/components/schemas/ItAssetsAssetIdTransferPostResponsesContentApplicationJsonSchemaDataActionsTransferRentalDetailsTransferCostBillingMethod", "description": "How the action is charged. When \"TOKEN\", the fees are covered by an\nadd-on token pool; when \"CURRENCY\", the fees are billed in the currency\nspecified in the \"fees\" field." }, "fees": { "description": "Price charged for the action. Null when billing method is \"TOKEN\"", "oneOf": [ { "$ref": "#/components/schemas/ItAssetsAssetIdTransferPostResponsesContentApplicationJsonSchemaDataActionsTransferRentalDetailsTransferCostFees" }, { "type": "null" } ] }, "token_usage": { "description": "Add-on token consumption details. Null when billing method is \"CURRENCY\"", "oneOf": [ { "$ref": "#/components/schemas/ItAssetsAssetIdTransferPostResponsesContentApplicationJsonSchemaDataActionsTransferRentalDetailsTransferCostTokenUsage" }, { "type": "null" } ] } }, "required": [ "fees", "token_usage", "billing_method" ], "title": "ItAssetsAssetIdTransferPostResponsesContentApplicationJsonSchemaDataActionsTransferRentalDetailsTransferCost", "type": "object" }, "ItAssetsAssetIdTransferPostResponsesContentApplicationJsonSchemaDataActionsTransferRentalDetailsTransferCostBillingMethod": { "description": "How the action is charged. When \"TOKEN\", the fees are covered by an\nadd-on token pool; when \"CURRENCY\", the fees are billed in the currency\nspecified in the \"fees\" field.", "enum": [ "CURRENCY", "TOKEN" ], "title": "ItAssetsAssetIdTransferPostResponsesContentApplicationJsonSchemaDataActionsTransferRentalDetailsTransferCostBillingMethod", "type": "string" }, "ItAssetsAssetIdTransferPostResponsesContentApplicationJsonSchemaDataActionsTransferRentalDetailsTransferCostFees": { "description": "Price charged for the action. Null when billing method is \"TOKEN\"", "properties": { "amount": { "description": "Amount", "format": "decimal", "type": "string" }, "currency": { "$ref": "#/components/schemas/ItAssetsAssetIdTransferPostResponsesContentApplicationJsonSchemaDataActionsTransferRentalDetailsTransferCostFeesCurrency", "description": "Three-letter currency code for the price" } }, "required": [ "amount", "currency" ], "title": "ItAssetsAssetIdTransferPostResponsesContentApplicationJsonSchemaDataActionsTransferRentalDetailsTransferCostFees", "type": "object" }, "ItAssetsAssetIdTransferPostResponsesContentApplicationJsonSchemaDataActionsTransferRentalDetailsTransferCostFeesCurrency": { "description": "Three-letter currency code for the price", "enum": [ "AED", "AFN", "ALL", "AMD", "ANG", "AOA", "ARS", "AUD", "AWG", "AZN", "BAM", "BDT", "BGN", "BHD", "BIF", "BMD", "BOB", "BRL", "BSD", "BTN", "BWP", "BYN", "BZD", "CAD", "CDF", "CHF", "CLP", "CNY", "COP", "CRC", "CUC", "CVE", "CZK", "DJF", "DKK", "DOP", "DZD", "EGP", "ERN", "ETB", "EUR", "FJD", "FKP", "GBP", "GEL", "GHS", "GIP", "GMD", "GNF", "GTQ", "GYD", "HKD", "HNL", "HRK", "HTG", "HUF", "IDR", "ILS", "INR", "IQD", "IRR", "ISK", "JMD", "JOD", "JPY", "KES", "KGS", "KHR", "KMF", "KPW", "KRW", "KWD", "KYD", "KZT", "LAK", "LBP", "LKR", "LRD", "LSL", "LTL", "LYD", "MAD", "MDL", "MGA", "MKD", "MMK", "MNT", "MRU", "MUR", "MVR", "MWK", "MXN", "MYR", "MZN", "NAD", "NGN", "NIO", "NOK", "NPR", "NZD", "OMR", "PAB", "PEN", "PGK", "PHP", "PKR", "PLN", "PYG", "QAR", "RON", "RSD", "RUB", "RWF", "SAR", "SBD", "SCR", "SDG", "SEK", "SGD", "SHP", "SLL", "SOS", "SRD", "SSP", "STD", "SYP", "SZL", "THB", "TJS", "TMT", "TND", "TOP", "TRY", "TTD", "TWD", "TZS", "UAH", "UGX", "USD", "UYU", "UZS", "VEF", "VND", "VUV", "WST", "XAF", "XCD", "XOF", "XPF", "YER", "ZAR", "ZMW", "ZWD" ], "title": "ItAssetsAssetIdTransferPostResponsesContentApplicationJsonSchemaDataActionsTransferRentalDetailsTransferCostFeesCurrency", "type": "string" }, "ItAssetsAssetIdTransferPostResponsesContentApplicationJsonSchemaDataActionsTransferRentalDetailsTransferCostTokenUsage": { "description": "Add-on token consumption details. Null when billing method is \"CURRENCY\"", "properties": { "addon": { "$ref": "#/components/schemas/ItAssetsAssetIdTransferPostResponsesContentApplicationJsonSchemaDataActionsTransferRentalDetailsTransferCostTokenUsageAddon", "description": "The add-on that provides the tokens" }, "cost": { "description": "Number of tokens consumed by the action. Zero when the add-on covers the\nservice without drawing from a token pool", "format": "decimal", "type": "string" }, "tokens_left": { "description": "Number of tokens left in the pool after the action is performed. Null when\nthe add-on covers the service without a token pool", "format": "decimal", "type": [ "string", "null" ] } }, "required": [ "cost", "addon", "tokens_left" ], "title": "ItAssetsAssetIdTransferPostResponsesContentApplicationJsonSchemaDataActionsTransferRentalDetailsTransferCostTokenUsage", "type": "object" }, "ItAssetsAssetIdTransferPostResponsesContentApplicationJsonSchemaDataActionsTransferRentalDetailsTransferCostTokenUsageAddon": { "description": "The add-on that provides the tokens", "properties": { "id": { "description": "ID of the add-on", "format": "uuid", "type": "string" }, "name": { "description": "Public display name of the add-on", "type": "string" } }, "required": [ "id", "name" ], "title": "ItAssetsAssetIdTransferPostResponsesContentApplicationJsonSchemaDataActionsTransferRentalDetailsTransferCostTokenUsageAddon", "type": "object" }, "ItAssetsAssetIdTransferPostResponsesContentApplicationJsonSchemaDataActionsTransferRentalDisabledReasonsItems": { "enum": [ "ARCHIVED", "AT_DEEL_WAREHOUSE", "BEING_REPAIRED", "CONSUMABLE", "CONTROLLED_BY_DEEL", "COUNTRY_NOT_SUPPORTED_FOR_HUB", "COUNTRY_NOT_SUPPORTED_FOR_LOCAL", "DEEL_OWNED_ITEM_WITHOUT_RENTAL_CONTRACT", "DESKTOP_STORAGE", "ENDING_CONTRACT", "HUB_IN_SAME_REGION_AS_LOCAL", "INACTIVE", "INVALID_ITEM_LOCATION", "INVALID_ORGANIZATION_STATUS", "INVALID_STATE", "ITEM_CONDITIONS_TO_UNARCHIVE_NOT_MET", "ITEM_NOT_VISIBLE_FOR_ORGANIZATION", "NON_DEVICE", "NOT_AT_WAREHOUSE", "NOT_AVAILABLE_FOR_REUSE", "NOT_A_RENTAL", "NOT_MANAGEABLE_BY_ORGANIZATION", "NOT_WITH_ASSIGNMENT", "NOT_WITH_USER", "NO_ACTIVE_ADDONS", "NO_ACTIVE_STORAGE_CONTRACT", "NO_LOCATION_FOR_STORAGE", "NO_LOGISTICS_FOR_STORAGE", "NO_VALID_ADDONS", "ONGOING_SERVICE", "OWNED_BY_DEEL", "OWNED_BY_ORGANIZATION", "OWNED_BY_PARTNER_ORGANIZATION", "PARTNER_CHILD_CONTRACT", "PENDING_DEVICE_REFRESH", "RENTAL_CONTRACT_AND_USER_REGION_DO_NOT_MATCH", "TEMPORARILY_UNAVAILABLE", "UNKNOWN", "USER_HAS_NO_COUNTRY", "USER_HAS_NO_SEAT", "WAITING_FOR_CLEARANCE", "WITH_LOANER_ASSIGNMENT", "WITH_NON_COLLECTED_ASSIGNMENT", "WITH_NON_DELIVERED_ASSIGNMENT", "WITH_PENDING_ASSIGNMENT", "WRONG_ASSIGNMENT_STATUS", "WRONG_CONTRACT_STATUS", "WRONG_TERMS_AND_CONDITIONS" ], "title": "ItAssetsAssetIdTransferPostResponsesContentApplicationJsonSchemaDataActionsTransferRentalDisabledReasonsItems", "type": "string" }, "ItAssetsAssetIdTransferPostResponsesContentApplicationJsonSchemaDataActionsTransferRentalStatus": { "description": "Whether the action is currently available for this asset", "enum": [ "DISABLED", "ENABLED", "NOT_APPLICABLE" ], "title": "ItAssetsAssetIdTransferPostResponsesContentApplicationJsonSchemaDataActionsTransferRentalStatus", "type": "string" }, "ItAssetsAssetIdTransferPostResponsesContentApplicationJsonSchemaDataActionsUnarchiveOwnAsset": { "description": "Unarchive a previously archived organization-owned asset", "properties": { "disabled_reasons": { "description": "Reasons why the action is disabled. Empty when the action is enabled or not applicable", "items": { "$ref": "#/components/schemas/ItAssetsAssetIdTransferPostResponsesContentApplicationJsonSchemaDataActionsUnarchiveOwnAssetDisabledReasonsItems" }, "type": "array" }, "status": { "$ref": "#/components/schemas/ItAssetsAssetIdTransferPostResponsesContentApplicationJsonSchemaDataActionsUnarchiveOwnAssetStatus", "description": "Whether the action is currently available for this asset" } }, "required": [ "status", "disabled_reasons" ], "title": "ItAssetsAssetIdTransferPostResponsesContentApplicationJsonSchemaDataActionsUnarchiveOwnAsset", "type": "object" }, "ItAssetsAssetIdTransferPostResponsesContentApplicationJsonSchemaDataActionsUnarchiveOwnAssetDisabledReasonsItems": { "enum": [ "ARCHIVED", "AT_DEEL_WAREHOUSE", "BEING_REPAIRED", "CONSUMABLE", "CONTROLLED_BY_DEEL", "COUNTRY_NOT_SUPPORTED_FOR_HUB", "COUNTRY_NOT_SUPPORTED_FOR_LOCAL", "DEEL_OWNED_ITEM_WITHOUT_RENTAL_CONTRACT", "DESKTOP_STORAGE", "ENDING_CONTRACT", "HUB_IN_SAME_REGION_AS_LOCAL", "INACTIVE", "INVALID_ITEM_LOCATION", "INVALID_ORGANIZATION_STATUS", "INVALID_STATE", "ITEM_CONDITIONS_TO_UNARCHIVE_NOT_MET", "ITEM_NOT_VISIBLE_FOR_ORGANIZATION", "NON_DEVICE", "NOT_AT_WAREHOUSE", "NOT_AVAILABLE_FOR_REUSE", "NOT_A_RENTAL", "NOT_MANAGEABLE_BY_ORGANIZATION", "NOT_WITH_ASSIGNMENT", "NOT_WITH_USER", "NO_ACTIVE_ADDONS", "NO_ACTIVE_STORAGE_CONTRACT", "NO_LOCATION_FOR_STORAGE", "NO_LOGISTICS_FOR_STORAGE", "NO_VALID_ADDONS", "ONGOING_SERVICE", "OWNED_BY_DEEL", "OWNED_BY_ORGANIZATION", "OWNED_BY_PARTNER_ORGANIZATION", "PARTNER_CHILD_CONTRACT", "PENDING_DEVICE_REFRESH", "RENTAL_CONTRACT_AND_USER_REGION_DO_NOT_MATCH", "TEMPORARILY_UNAVAILABLE", "UNKNOWN", "USER_HAS_NO_COUNTRY", "USER_HAS_NO_SEAT", "WAITING_FOR_CLEARANCE", "WITH_LOANER_ASSIGNMENT", "WITH_NON_COLLECTED_ASSIGNMENT", "WITH_NON_DELIVERED_ASSIGNMENT", "WITH_PENDING_ASSIGNMENT", "WRONG_ASSIGNMENT_STATUS", "WRONG_CONTRACT_STATUS", "WRONG_TERMS_AND_CONDITIONS" ], "title": "ItAssetsAssetIdTransferPostResponsesContentApplicationJsonSchemaDataActionsUnarchiveOwnAssetDisabledReasonsItems", "type": "string" }, "ItAssetsAssetIdTransferPostResponsesContentApplicationJsonSchemaDataActionsUnarchiveOwnAssetStatus": { "description": "Whether the action is currently available for this asset", "enum": [ "DISABLED", "ENABLED", "NOT_APPLICABLE" ], "title": "ItAssetsAssetIdTransferPostResponsesContentApplicationJsonSchemaDataActionsUnarchiveOwnAssetStatus", "type": "string" }, "ItAssetsAssetIdTransferPostResponsesContentApplicationJsonSchemaDataActionsUpdateLocationLocationToUser": { "description": "Update the location of an asset from a warehouse to a user", "properties": { "disabled_reasons": { "description": "Reasons why the action is disabled. Empty when the action is enabled or not applicable", "items": { "$ref": "#/components/schemas/ItAssetsAssetIdTransferPostResponsesContentApplicationJsonSchemaDataActionsUpdateLocationLocationToUserDisabledReasonsItems" }, "type": "array" }, "status": { "$ref": "#/components/schemas/ItAssetsAssetIdTransferPostResponsesContentApplicationJsonSchemaDataActionsUpdateLocationLocationToUserStatus", "description": "Whether the action is currently available for this asset" } }, "required": [ "status", "disabled_reasons" ], "title": "ItAssetsAssetIdTransferPostResponsesContentApplicationJsonSchemaDataActionsUpdateLocationLocationToUser", "type": "object" }, "ItAssetsAssetIdTransferPostResponsesContentApplicationJsonSchemaDataActionsUpdateLocationLocationToUserDisabledReasonsItems": { "enum": [ "ARCHIVED", "AT_DEEL_WAREHOUSE", "BEING_REPAIRED", "CONSUMABLE", "CONTROLLED_BY_DEEL", "COUNTRY_NOT_SUPPORTED_FOR_HUB", "COUNTRY_NOT_SUPPORTED_FOR_LOCAL", "DEEL_OWNED_ITEM_WITHOUT_RENTAL_CONTRACT", "DESKTOP_STORAGE", "ENDING_CONTRACT", "HUB_IN_SAME_REGION_AS_LOCAL", "INACTIVE", "INVALID_ITEM_LOCATION", "INVALID_ORGANIZATION_STATUS", "INVALID_STATE", "ITEM_CONDITIONS_TO_UNARCHIVE_NOT_MET", "ITEM_NOT_VISIBLE_FOR_ORGANIZATION", "NON_DEVICE", "NOT_AT_WAREHOUSE", "NOT_AVAILABLE_FOR_REUSE", "NOT_A_RENTAL", "NOT_MANAGEABLE_BY_ORGANIZATION", "NOT_WITH_ASSIGNMENT", "NOT_WITH_USER", "NO_ACTIVE_ADDONS", "NO_ACTIVE_STORAGE_CONTRACT", "NO_LOCATION_FOR_STORAGE", "NO_LOGISTICS_FOR_STORAGE", "NO_VALID_ADDONS", "ONGOING_SERVICE", "OWNED_BY_DEEL", "OWNED_BY_ORGANIZATION", "OWNED_BY_PARTNER_ORGANIZATION", "PARTNER_CHILD_CONTRACT", "PENDING_DEVICE_REFRESH", "RENTAL_CONTRACT_AND_USER_REGION_DO_NOT_MATCH", "TEMPORARILY_UNAVAILABLE", "UNKNOWN", "USER_HAS_NO_COUNTRY", "USER_HAS_NO_SEAT", "WAITING_FOR_CLEARANCE", "WITH_LOANER_ASSIGNMENT", "WITH_NON_COLLECTED_ASSIGNMENT", "WITH_NON_DELIVERED_ASSIGNMENT", "WITH_PENDING_ASSIGNMENT", "WRONG_ASSIGNMENT_STATUS", "WRONG_CONTRACT_STATUS", "WRONG_TERMS_AND_CONDITIONS" ], "title": "ItAssetsAssetIdTransferPostResponsesContentApplicationJsonSchemaDataActionsUpdateLocationLocationToUserDisabledReasonsItems", "type": "string" }, "ItAssetsAssetIdTransferPostResponsesContentApplicationJsonSchemaDataActionsUpdateLocationLocationToUserStatus": { "description": "Whether the action is currently available for this asset", "enum": [ "DISABLED", "ENABLED", "NOT_APPLICABLE" ], "title": "ItAssetsAssetIdTransferPostResponsesContentApplicationJsonSchemaDataActionsUpdateLocationLocationToUserStatus", "type": "string" }, "ItAssetsAssetIdTransferPostResponsesContentApplicationJsonSchemaDataActionsUpdateLocationUserToLocation": { "description": "Update the location of an asset from a user to a warehouse", "properties": { "disabled_reasons": { "description": "Reasons why the action is disabled. Empty when the action is enabled or not applicable", "items": { "$ref": "#/components/schemas/ItAssetsAssetIdTransferPostResponsesContentApplicationJsonSchemaDataActionsUpdateLocationUserToLocationDisabledReasonsItems" }, "type": "array" }, "status": { "$ref": "#/components/schemas/ItAssetsAssetIdTransferPostResponsesContentApplicationJsonSchemaDataActionsUpdateLocationUserToLocationStatus", "description": "Whether the action is currently available for this asset" } }, "required": [ "status", "disabled_reasons" ], "title": "ItAssetsAssetIdTransferPostResponsesContentApplicationJsonSchemaDataActionsUpdateLocationUserToLocation", "type": "object" }, "ItAssetsAssetIdTransferPostResponsesContentApplicationJsonSchemaDataActionsUpdateLocationUserToLocationDisabledReasonsItems": { "enum": [ "ARCHIVED", "AT_DEEL_WAREHOUSE", "BEING_REPAIRED", "CONSUMABLE", "CONTROLLED_BY_DEEL", "COUNTRY_NOT_SUPPORTED_FOR_HUB", "COUNTRY_NOT_SUPPORTED_FOR_LOCAL", "DEEL_OWNED_ITEM_WITHOUT_RENTAL_CONTRACT", "DESKTOP_STORAGE", "ENDING_CONTRACT", "HUB_IN_SAME_REGION_AS_LOCAL", "INACTIVE", "INVALID_ITEM_LOCATION", "INVALID_ORGANIZATION_STATUS", "INVALID_STATE", "ITEM_CONDITIONS_TO_UNARCHIVE_NOT_MET", "ITEM_NOT_VISIBLE_FOR_ORGANIZATION", "NON_DEVICE", "NOT_AT_WAREHOUSE", "NOT_AVAILABLE_FOR_REUSE", "NOT_A_RENTAL", "NOT_MANAGEABLE_BY_ORGANIZATION", "NOT_WITH_ASSIGNMENT", "NOT_WITH_USER", "NO_ACTIVE_ADDONS", "NO_ACTIVE_STORAGE_CONTRACT", "NO_LOCATION_FOR_STORAGE", "NO_LOGISTICS_FOR_STORAGE", "NO_VALID_ADDONS", "ONGOING_SERVICE", "OWNED_BY_DEEL", "OWNED_BY_ORGANIZATION", "OWNED_BY_PARTNER_ORGANIZATION", "PARTNER_CHILD_CONTRACT", "PENDING_DEVICE_REFRESH", "RENTAL_CONTRACT_AND_USER_REGION_DO_NOT_MATCH", "TEMPORARILY_UNAVAILABLE", "UNKNOWN", "USER_HAS_NO_COUNTRY", "USER_HAS_NO_SEAT", "WAITING_FOR_CLEARANCE", "WITH_LOANER_ASSIGNMENT", "WITH_NON_COLLECTED_ASSIGNMENT", "WITH_NON_DELIVERED_ASSIGNMENT", "WITH_PENDING_ASSIGNMENT", "WRONG_ASSIGNMENT_STATUS", "WRONG_CONTRACT_STATUS", "WRONG_TERMS_AND_CONDITIONS" ], "title": "ItAssetsAssetIdTransferPostResponsesContentApplicationJsonSchemaDataActionsUpdateLocationUserToLocationDisabledReasonsItems", "type": "string" }, "ItAssetsAssetIdTransferPostResponsesContentApplicationJsonSchemaDataActionsUpdateLocationUserToLocationStatus": { "description": "Whether the action is currently available for this asset", "enum": [ "DISABLED", "ENABLED", "NOT_APPLICABLE" ], "title": "ItAssetsAssetIdTransferPostResponsesContentApplicationJsonSchemaDataActionsUpdateLocationUserToLocationStatus", "type": "string" }, "ItAssetsAssetIdTransferPostResponsesContentApplicationJsonSchemaDataActionsUpdateLocationUserToUser": { "description": "Update the assigned user of an asset that is currently with a user", "properties": { "disabled_reasons": { "description": "Reasons why the action is disabled. Empty when the action is enabled or not applicable", "items": { "$ref": "#/components/schemas/ItAssetsAssetIdTransferPostResponsesContentApplicationJsonSchemaDataActionsUpdateLocationUserToUserDisabledReasonsItems" }, "type": "array" }, "status": { "$ref": "#/components/schemas/ItAssetsAssetIdTransferPostResponsesContentApplicationJsonSchemaDataActionsUpdateLocationUserToUserStatus", "description": "Whether the action is currently available for this asset" } }, "required": [ "status", "disabled_reasons" ], "title": "ItAssetsAssetIdTransferPostResponsesContentApplicationJsonSchemaDataActionsUpdateLocationUserToUser", "type": "object" }, "ItAssetsAssetIdTransferPostResponsesContentApplicationJsonSchemaDataActionsUpdateLocationUserToUserDisabledReasonsItems": { "enum": [ "ARCHIVED", "AT_DEEL_WAREHOUSE", "BEING_REPAIRED", "CONSUMABLE", "CONTROLLED_BY_DEEL", "COUNTRY_NOT_SUPPORTED_FOR_HUB", "COUNTRY_NOT_SUPPORTED_FOR_LOCAL", "DEEL_OWNED_ITEM_WITHOUT_RENTAL_CONTRACT", "DESKTOP_STORAGE", "ENDING_CONTRACT", "HUB_IN_SAME_REGION_AS_LOCAL", "INACTIVE", "INVALID_ITEM_LOCATION", "INVALID_ORGANIZATION_STATUS", "INVALID_STATE", "ITEM_CONDITIONS_TO_UNARCHIVE_NOT_MET", "ITEM_NOT_VISIBLE_FOR_ORGANIZATION", "NON_DEVICE", "NOT_AT_WAREHOUSE", "NOT_AVAILABLE_FOR_REUSE", "NOT_A_RENTAL", "NOT_MANAGEABLE_BY_ORGANIZATION", "NOT_WITH_ASSIGNMENT", "NOT_WITH_USER", "NO_ACTIVE_ADDONS", "NO_ACTIVE_STORAGE_CONTRACT", "NO_LOCATION_FOR_STORAGE", "NO_LOGISTICS_FOR_STORAGE", "NO_VALID_ADDONS", "ONGOING_SERVICE", "OWNED_BY_DEEL", "OWNED_BY_ORGANIZATION", "OWNED_BY_PARTNER_ORGANIZATION", "PARTNER_CHILD_CONTRACT", "PENDING_DEVICE_REFRESH", "RENTAL_CONTRACT_AND_USER_REGION_DO_NOT_MATCH", "TEMPORARILY_UNAVAILABLE", "UNKNOWN", "USER_HAS_NO_COUNTRY", "USER_HAS_NO_SEAT", "WAITING_FOR_CLEARANCE", "WITH_LOANER_ASSIGNMENT", "WITH_NON_COLLECTED_ASSIGNMENT", "WITH_NON_DELIVERED_ASSIGNMENT", "WITH_PENDING_ASSIGNMENT", "WRONG_ASSIGNMENT_STATUS", "WRONG_CONTRACT_STATUS", "WRONG_TERMS_AND_CONDITIONS" ], "title": "ItAssetsAssetIdTransferPostResponsesContentApplicationJsonSchemaDataActionsUpdateLocationUserToUserDisabledReasonsItems", "type": "string" }, "ItAssetsAssetIdTransferPostResponsesContentApplicationJsonSchemaDataActionsUpdateLocationUserToUserStatus": { "description": "Whether the action is currently available for this asset", "enum": [ "DISABLED", "ENABLED", "NOT_APPLICABLE" ], "title": "ItAssetsAssetIdTransferPostResponsesContentApplicationJsonSchemaDataActionsUpdateLocationUserToUserStatus", "type": "string" }, "ItAssetsAssetIdTransferPostResponsesContentApplicationJsonSchemaDataActionsUpdateOwnAssetDetails": { "description": "Update editable details of an organization-owned asset", "properties": { "disabled_reasons": { "description": "Reasons why the action is disabled. Empty when the action is enabled or not applicable", "items": { "$ref": "#/components/schemas/ItAssetsAssetIdTransferPostResponsesContentApplicationJsonSchemaDataActionsUpdateOwnAssetDetailsDisabledReasonsItems" }, "type": "array" }, "status": { "$ref": "#/components/schemas/ItAssetsAssetIdTransferPostResponsesContentApplicationJsonSchemaDataActionsUpdateOwnAssetDetailsStatus", "description": "Whether the action is currently available for this asset" } }, "required": [ "status", "disabled_reasons" ], "title": "ItAssetsAssetIdTransferPostResponsesContentApplicationJsonSchemaDataActionsUpdateOwnAssetDetails", "type": "object" }, "ItAssetsAssetIdTransferPostResponsesContentApplicationJsonSchemaDataActionsUpdateOwnAssetDetailsDisabledReasonsItems": { "enum": [ "ARCHIVED", "AT_DEEL_WAREHOUSE", "BEING_REPAIRED", "CONSUMABLE", "CONTROLLED_BY_DEEL", "COUNTRY_NOT_SUPPORTED_FOR_HUB", "COUNTRY_NOT_SUPPORTED_FOR_LOCAL", "DEEL_OWNED_ITEM_WITHOUT_RENTAL_CONTRACT", "DESKTOP_STORAGE", "ENDING_CONTRACT", "HUB_IN_SAME_REGION_AS_LOCAL", "INACTIVE", "INVALID_ITEM_LOCATION", "INVALID_ORGANIZATION_STATUS", "INVALID_STATE", "ITEM_CONDITIONS_TO_UNARCHIVE_NOT_MET", "ITEM_NOT_VISIBLE_FOR_ORGANIZATION", "NON_DEVICE", "NOT_AT_WAREHOUSE", "NOT_AVAILABLE_FOR_REUSE", "NOT_A_RENTAL", "NOT_MANAGEABLE_BY_ORGANIZATION", "NOT_WITH_ASSIGNMENT", "NOT_WITH_USER", "NO_ACTIVE_ADDONS", "NO_ACTIVE_STORAGE_CONTRACT", "NO_LOCATION_FOR_STORAGE", "NO_LOGISTICS_FOR_STORAGE", "NO_VALID_ADDONS", "ONGOING_SERVICE", "OWNED_BY_DEEL", "OWNED_BY_ORGANIZATION", "OWNED_BY_PARTNER_ORGANIZATION", "PARTNER_CHILD_CONTRACT", "PENDING_DEVICE_REFRESH", "RENTAL_CONTRACT_AND_USER_REGION_DO_NOT_MATCH", "TEMPORARILY_UNAVAILABLE", "UNKNOWN", "USER_HAS_NO_COUNTRY", "USER_HAS_NO_SEAT", "WAITING_FOR_CLEARANCE", "WITH_LOANER_ASSIGNMENT", "WITH_NON_COLLECTED_ASSIGNMENT", "WITH_NON_DELIVERED_ASSIGNMENT", "WITH_PENDING_ASSIGNMENT", "WRONG_ASSIGNMENT_STATUS", "WRONG_CONTRACT_STATUS", "WRONG_TERMS_AND_CONDITIONS" ], "title": "ItAssetsAssetIdTransferPostResponsesContentApplicationJsonSchemaDataActionsUpdateOwnAssetDetailsDisabledReasonsItems", "type": "string" }, "ItAssetsAssetIdTransferPostResponsesContentApplicationJsonSchemaDataActionsUpdateOwnAssetDetailsStatus": { "description": "Whether the action is currently available for this asset", "enum": [ "DISABLED", "ENABLED", "NOT_APPLICABLE" ], "title": "ItAssetsAssetIdTransferPostResponsesContentApplicationJsonSchemaDataActionsUpdateOwnAssetDetailsStatus", "type": "string" }, "ItAssetsAssetIdTransferPostResponsesContentApplicationJsonSchemaDataAssignedUser": { "description": "Details of the user with asset possession", "properties": { "emails": { "description": "Array of user email addresses", "items": { "format": "email", "type": "string" }, "type": "array" }, "first_name": { "description": "First name of the user", "type": "string" }, "hris_profile_id": { "description": "The unique identifier of the HRIS profile of the assigned user", "format": "uuid", "type": "string" }, "last_name": { "description": "Last name of the user", "type": "string" } }, "required": [ "emails", "last_name", "first_name", "hris_profile_id" ], "title": "ItAssetsAssetIdTransferPostResponsesContentApplicationJsonSchemaDataAssignedUser", "type": "object" }, "ItAssetsAssetIdTransferPostResponsesContentApplicationJsonSchemaDataAssignedWarehouse": { "description": "Details of the warehouse with asset possession", "properties": { "address": { "$ref": "#/components/schemas/ItAssetsAssetIdTransferPostResponsesContentApplicationJsonSchemaDataAssignedWarehouseAddress", "description": "Warehouse address details" }, "id": { "description": "Unique identifier of the warehouse", "format": "uuid", "type": "string" }, "name": { "description": "Warehouse or storage location name", "type": "string" }, "ownership": { "$ref": "#/components/schemas/ItAssetsAssetIdTransferPostResponsesContentApplicationJsonSchemaDataAssignedWarehouseOwnership", "description": "Warehouse ownership type" }, "public_id": { "description": "Public identifier of the warehouse", "type": "string" }, "warehouse_type": { "$ref": "#/components/schemas/ItAssetsAssetIdTransferPostResponsesContentApplicationJsonSchemaDataAssignedWarehouseWarehouseType", "description": "Warehouse type" } }, "required": [ "id", "name", "address", "ownership", "public_id", "warehouse_type" ], "title": "ItAssetsAssetIdTransferPostResponsesContentApplicationJsonSchemaDataAssignedWarehouse", "type": "object" }, "ItAssetsAssetIdTransferPostResponsesContentApplicationJsonSchemaDataAssignedWarehouseAddress": { "description": "Warehouse address details", "properties": { "city": { "description": "City name", "type": [ "string", "null" ] }, "country": { "$ref": "#/components/schemas/ItAssetsAssetIdTransferPostResponsesContentApplicationJsonSchemaDataAssignedWarehouseAddressCountry", "description": "Country code" }, "date_of_birth": { "description": "Date of birth (applicable for some address types)", "format": "date", "type": [ "string", "null" ] }, "delivery_instructions": { "description": "Special instructions for deliveries", "type": [ "string", "null" ] }, "id": { "description": "Unique identifier of the address", "format": "uuid", "type": "string" }, "is_valid": { "description": "Whether the address passes validation", "type": "boolean" }, "line1": { "description": "Address line 1", "type": [ "string", "null" ] }, "line2": { "description": "Address line 2", "type": [ "string", "null" ] }, "passport_number": { "description": "Passport number (applicable for some address types)", "type": [ "string", "null" ] }, "phone_number": { "description": "Phone number", "type": [ "string", "null" ] }, "post_code": { "description": "Post code", "type": [ "string", "null" ] }, "state": { "description": "State code or name", "type": [ "string", "null" ] }, "tax_id_number": { "description": "Tax ID number (applicable for some address types)", "type": [ "string", "null" ] }, "type": { "$ref": "#/components/schemas/ItAssetsAssetIdTransferPostResponsesContentApplicationJsonSchemaDataAssignedWarehouseAddressType", "description": "Type of the address" } }, "required": [ "id", "city", "type", "line1", "line2", "state", "country", "is_valid", "post_code", "phone_number", "date_of_birth", "tax_id_number", "passport_number", "delivery_instructions" ], "title": "ItAssetsAssetIdTransferPostResponsesContentApplicationJsonSchemaDataAssignedWarehouseAddress", "type": "object" }, "ItAssetsAssetIdTransferPostResponsesContentApplicationJsonSchemaDataAssignedWarehouseAddressCountry": { "description": "Country code", "enum": [ "AD", "AE", "AF", "AG", "AI", "AL", "AM", "AN", "AO", "AQ", "AR", "AS", "AT", "AU", "AW", "AX", "AZ", "BA", "BB", "BD", "BE", "BF", "BG", "BH", "BI", "BJ", "BL", "BM", "BN", "BO", "BQ", "BR", "BS", "BT", "BV", "BW", "BY", "BZ", "CA", "CC", "CD", "CF", "CG", "CH", "CI", "CK", "CL", "CM", "CN", "CO", "CR", "CU", "CV", "CW", "CX", "CY", "CZ", "DE", "DJ", "DK", "DM", "DO", "DZ", "EC", "EE", "EG", "EH", "ER", "ES", "ET", "FI", "FJ", "FK", "FM", "FO", "FR", "GA", "GB", "GD", "GE", "GF", "GG", "GH", "GI", "GL", "GM", "GN", "GP", "GQ", "GR", "GS", "GT", "GU", "GW", "GY", "HK", "HM", "HN", "HR", "HT", "HU", "IC", "ID", "IE", "IL", "IM", "IN", "IO", "IQ", "IR", "IS", "IT", "JE", "JM", "JO", "JP", "KE", "KG", "KH", "KI", "KM", "KN", "KP", "KR", "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", "XK", "YE", "YT", "ZA", "ZM", "ZW" ], "title": "ItAssetsAssetIdTransferPostResponsesContentApplicationJsonSchemaDataAssignedWarehouseAddressCountry", "type": "string" }, "ItAssetsAssetIdTransferPostResponsesContentApplicationJsonSchemaDataAssignedWarehouseAddressType": { "description": "Type of the address", "enum": [ "BILLING", "COLLECTION", "DELIVERY", "ENTITY", "PARTIAL", "PII", "SUPPLIER" ], "title": "ItAssetsAssetIdTransferPostResponsesContentApplicationJsonSchemaDataAssignedWarehouseAddressType", "type": "string" }, "ItAssetsAssetIdTransferPostResponsesContentApplicationJsonSchemaDataAssignedWarehouseOwnership": { "description": "Warehouse ownership type", "enum": [ "DEEL", "ORGANIZATION" ], "title": "ItAssetsAssetIdTransferPostResponsesContentApplicationJsonSchemaDataAssignedWarehouseOwnership", "type": "string" }, "ItAssetsAssetIdTransferPostResponsesContentApplicationJsonSchemaDataAssignedWarehouseWarehouseType": { "description": "Warehouse type", "enum": [ "CLEARANCE", "DEEL", "ORGANIZATION" ], "title": "ItAssetsAssetIdTransferPostResponsesContentApplicationJsonSchemaDataAssignedWarehouseWarehouseType", "type": "string" }, "ItAssetsAssetIdTransferPostResponsesContentApplicationJsonSchemaDataGrade": { "description": "The condition grade of the asset", "enum": [ "A", "B", "C", "D", "F", "NEW" ], "title": "ItAssetsAssetIdTransferPostResponsesContentApplicationJsonSchemaDataGrade", "type": "string" }, "ItAssetsAssetIdTransferPostResponsesContentApplicationJsonSchemaDataLocation": { "description": "Current location type of the asset", "enum": [ "AT_WAREHOUSE", "CLEARANCE_WAREHOUSE", "DEEL_WAREHOUSE", "ORGANIZATION_WAREHOUSE", "SUPPLIER", "WITH_COURIER", "WITH_USER", "WRITE_OFF" ], "title": "ItAssetsAssetIdTransferPostResponsesContentApplicationJsonSchemaDataLocation", "type": "string" }, "ItAssetsAssetIdTransferPostResponsesContentApplicationJsonSchemaDataOwnership": { "description": "Asset owner", "properties": { "name": { "description": "Asset owner name", "type": "string" }, "type": { "$ref": "#/components/schemas/ItAssetsAssetIdTransferPostResponsesContentApplicationJsonSchemaDataOwnershipType", "description": "Asset owner type" } }, "required": [ "name", "type" ], "title": "ItAssetsAssetIdTransferPostResponsesContentApplicationJsonSchemaDataOwnership", "type": "object" }, "ItAssetsAssetIdTransferPostResponsesContentApplicationJsonSchemaDataOwnershipType": { "description": "Asset owner type", "enum": [ "DEEL", "ORGANIZATION" ], "title": "ItAssetsAssetIdTransferPostResponsesContentApplicationJsonSchemaDataOwnershipType", "type": "string" }, "ItAssetsAssetIdTransferPostResponsesContentApplicationJsonSchemaDataProduct": { "description": "Product details", "properties": { "brand": { "description": "Product brand", "type": "string" }, "category": { "$ref": "#/components/schemas/ItAssetsAssetIdTransferPostResponsesContentApplicationJsonSchemaDataProductCategory", "description": "Product category" }, "id": { "description": "Unique identifier of the product", "format": "uuid", "type": "string" }, "name": { "description": "Product name", "type": "string" }, "specifications": { "description": "Specifications of the product", "items": { "$ref": "#/components/schemas/ItAssetsAssetIdTransferPostResponsesContentApplicationJsonSchemaDataProductSpecificationsItems" }, "type": "array" } }, "required": [ "id", "name", "brand", "category", "specifications" ], "title": "ItAssetsAssetIdTransferPostResponsesContentApplicationJsonSchemaDataProduct", "type": "object" }, "ItAssetsAssetIdTransferPostResponsesContentApplicationJsonSchemaDataProductCategory": { "description": "Product category", "enum": [ "ADAPTER", "CABLE", "CHAIR", "CHARGER", "COMPACT_DESKTOP", "DESK", "DESKTOP", "DESK_RISER", "DESK_TIDY", "DOCKING_STATION", "DONGLE", "FOOTREST", "HEADSET", "KEYBOARD", "LAPTOP", "LAPTOP_STAND", "MICE_TRACKPAD", "MOBILE_DEVICE", "MONITOR", "MONITOR_ARM", "OTHER", "PRINTER", "SHREDDER", "STANDING_MAT", "TABLET", "TASK_LIGHT", "WEBCAM", "WELCOME_PACK", "WIFI_RANGE_EXTENDER" ], "title": "ItAssetsAssetIdTransferPostResponsesContentApplicationJsonSchemaDataProductCategory", "type": "string" }, "ItAssetsAssetIdTransferPostResponsesContentApplicationJsonSchemaDataProductSpecificationsItems": { "properties": { "name": { "description": "Specification name", "type": "string" }, "value": { "description": "Specification value", "type": "string" } }, "required": [ "name", "value" ], "title": "ItAssetsAssetIdTransferPostResponsesContentApplicationJsonSchemaDataProductSpecificationsItems", "type": "object" }, "ItAssetsAssetIdTransferPostResponsesContentApplicationJsonSchemaDataPurchaseValue": { "description": "Purchase value of the asset", "properties": { "amount": { "description": "Amount", "format": "decimal", "type": "string" }, "currency": { "$ref": "#/components/schemas/ItAssetsAssetIdTransferPostResponsesContentApplicationJsonSchemaDataPurchaseValueCurrency", "description": "Three-letter currency code for the price" } }, "required": [ "amount", "currency" ], "title": "ItAssetsAssetIdTransferPostResponsesContentApplicationJsonSchemaDataPurchaseValue", "type": "object" }, "ItAssetsAssetIdTransferPostResponsesContentApplicationJsonSchemaDataPurchaseValueCurrency": { "description": "Three-letter currency code for the price", "enum": [ "AED", "AFN", "ALL", "AMD", "ANG", "AOA", "ARS", "AUD", "AWG", "AZN", "BAM", "BDT", "BGN", "BHD", "BIF", "BMD", "BOB", "BRL", "BSD", "BTN", "BWP", "BYN", "BZD", "CAD", "CDF", "CHF", "CLP", "CNY", "COP", "CRC", "CUC", "CVE", "CZK", "DJF", "DKK", "DOP", "DZD", "EGP", "ERN", "ETB", "EUR", "FJD", "FKP", "GBP", "GEL", "GHS", "GIP", "GMD", "GNF", "GTQ", "GYD", "HKD", "HNL", "HRK", "HTG", "HUF", "IDR", "ILS", "INR", "IQD", "IRR", "ISK", "JMD", "JOD", "JPY", "KES", "KGS", "KHR", "KMF", "KPW", "KRW", "KWD", "KYD", "KZT", "LAK", "LBP", "LKR", "LRD", "LSL", "LTL", "LYD", "MAD", "MDL", "MGA", "MKD", "MMK", "MNT", "MRU", "MUR", "MVR", "MWK", "MXN", "MYR", "MZN", "NAD", "NGN", "NIO", "NOK", "NPR", "NZD", "OMR", "PAB", "PEN", "PGK", "PHP", "PKR", "PLN", "PYG", "QAR", "RON", "RSD", "RUB", "RWF", "SAR", "SBD", "SCR", "SDG", "SEK", "SGD", "SHP", "SLL", "SOS", "SRD", "SSP", "STD", "SYP", "SZL", "THB", "TJS", "TMT", "TND", "TOP", "TRY", "TTD", "TWD", "TZS", "UAH", "UGX", "USD", "UYU", "UZS", "VEF", "VND", "VUV", "WST", "XAF", "XCD", "XOF", "XPF", "YER", "ZAR", "ZMW", "ZWD" ], "title": "ItAssetsAssetIdTransferPostResponsesContentApplicationJsonSchemaDataPurchaseValueCurrency", "type": "string" }, "ItAssetsAssetIdTransferPostResponsesContentApplicationJsonSchemaDataStatus": { "description": "Current state of the asset", "enum": [ "ACTIVE", "ADDED_BY_MISTAKE", "BEING_REPAIRED", "BINNED", "BROKEN_AT_WAREHOUSE", "BROKEN_BY_USER", "BROKEN_IN_TRANSIT", "CLEARED", "DAMAGED_AT_WAREHOUSE", "DAMAGED_BY_USER", "DAMAGED_IN_TRANSIT", "LEFT_WITH_USER", "LOST_IN_TRANSIT", "RETURNED_TO_DEEL", "SHRINKAGE", "STOLEN", "SUPPLIER_RETURN", "WAITING_FOR_CLEARANCE" ], "title": "ItAssetsAssetIdTransferPostResponsesContentApplicationJsonSchemaDataStatus", "type": "string" }, "ItAssetsAssetIdTransferPostResponsesContentApplicationJsonSchemaErrorsItems": { "properties": { "code": { "description": "Error code of the handler which produced the returned error", "type": "string" }, "field": { "description": "The field name where input validation failed", "type": [ "string", "null" ] }, "message": { "description": "Description of the returned error", "type": "string" } }, "required": [ "code", "field", "message" ], "title": "ItAssetsAssetIdTransferPostResponsesContentApplicationJsonSchemaErrorsItems", "type": "object" }, "ItAssetsAssetIdUnarchivePostParametersXBeta": { "default": "true", "enum": [ "true" ], "title": "ItAssetsAssetIdUnarchivePostParametersXBeta", "type": "string" }, "ItAssetsAssetIdUnarchivePostResponsesContentApplicationJsonSchemaData": { "properties": { "actions": { "$ref": "#/components/schemas/ItAssetsAssetIdUnarchivePostResponsesContentApplicationJsonSchemaDataActions", "description": "Actions the caller can execute on this asset, with availability status per action" }, "assigned_user": { "description": "Details of the user with asset possession", "oneOf": [ { "$ref": "#/components/schemas/ItAssetsAssetIdUnarchivePostResponsesContentApplicationJsonSchemaDataAssignedUser" }, { "type": "null" } ] }, "assigned_warehouse": { "description": "Details of the warehouse with asset possession", "oneOf": [ { "$ref": "#/components/schemas/ItAssetsAssetIdUnarchivePostResponsesContentApplicationJsonSchemaDataAssignedWarehouse" }, { "type": "null" } ] }, "created_at": { "description": "Creation timestamp of the asset", "format": "date-time", "type": "string" }, "grade": { "$ref": "#/components/schemas/ItAssetsAssetIdUnarchivePostResponsesContentApplicationJsonSchemaDataGrade", "description": "The condition grade of the asset" }, "id": { "description": "Unique identifier of the item", "format": "uuid", "type": "string" }, "location": { "$ref": "#/components/schemas/ItAssetsAssetIdUnarchivePostResponsesContentApplicationJsonSchemaDataLocation", "description": "Current location type of the asset" }, "ownership": { "$ref": "#/components/schemas/ItAssetsAssetIdUnarchivePostResponsesContentApplicationJsonSchemaDataOwnership", "description": "Asset owner" }, "product": { "$ref": "#/components/schemas/ItAssetsAssetIdUnarchivePostResponsesContentApplicationJsonSchemaDataProduct", "description": "Product details" }, "public_id": { "description": "Public identifier of the item", "type": "string" }, "purchase_date": { "description": "Purchase date of the asset", "format": "date", "type": [ "string", "null" ] }, "purchase_value": { "description": "Purchase value of the asset", "oneOf": [ { "$ref": "#/components/schemas/ItAssetsAssetIdUnarchivePostResponsesContentApplicationJsonSchemaDataPurchaseValue" }, { "type": "null" } ] }, "serial_number": { "description": "Asset serial number", "type": [ "string", "null" ] }, "status": { "$ref": "#/components/schemas/ItAssetsAssetIdUnarchivePostResponsesContentApplicationJsonSchemaDataStatus", "description": "Current state of the asset" }, "updated_at": { "description": "Last update timestamp of the asset", "format": "date-time", "type": "string" } }, "required": [ "id", "grade", "status", "actions", "product", "location", "ownership", "public_id", "created_at", "updated_at", "assigned_user", "purchase_date", "serial_number", "purchase_value", "assigned_warehouse" ], "title": "ItAssetsAssetIdUnarchivePostResponsesContentApplicationJsonSchemaData", "type": "object" }, "ItAssetsAssetIdUnarchivePostResponsesContentApplicationJsonSchemaDataActions": { "description": "Actions the caller can execute on this asset, with availability status per action", "properties": { "archive_own_asset": { "$ref": "#/components/schemas/ItAssetsAssetIdUnarchivePostResponsesContentApplicationJsonSchemaDataActionsArchiveOwnAsset", "description": "Archive an organization-owned asset" }, "asset_country": { "description": "Resolved country used for asset actions. Derived from the asset's country,\nits assigned rental contract billing entity country, or the last active\nassignment delivery country. Null when the country cannot be determined\n(e.g. asset was returned to Deel)", "oneOf": [ { "$ref": "#/components/schemas/ItAssetsAssetIdUnarchivePostResponsesContentApplicationJsonSchemaDataActionsAssetCountry" }, { "type": "null" } ] }, "assign_addon_to_own_asset": { "$ref": "#/components/schemas/ItAssetsAssetIdUnarchivePostResponsesContentApplicationJsonSchemaDataActionsAssignAddonToOwnAsset", "description": "Assign an add-on to an organization-owned asset" }, "clear_own_asset": { "$ref": "#/components/schemas/ItAssetsAssetIdUnarchivePostResponsesContentApplicationJsonSchemaDataActionsClearOwnAsset", "description": "Clear an organization-owned asset from the fleet" }, "manage_end_of_rental_contract_actions": { "$ref": "#/components/schemas/ItAssetsAssetIdUnarchivePostResponsesContentApplicationJsonSchemaDataActionsManageEndOfRentalContractActions", "description": "Manage end-of-rental options for a Deel-owned rental asset" }, "purchase_rental": { "$ref": "#/components/schemas/ItAssetsAssetIdUnarchivePostResponsesContentApplicationJsonSchemaDataActionsPurchaseRental", "description": "Purchase a Deel-owned rental asset at end of contract" }, "return_rental_to_deel": { "$ref": "#/components/schemas/ItAssetsAssetIdUnarchivePostResponsesContentApplicationJsonSchemaDataActionsReturnRentalToDeel", "description": "Return a Deel-owned rental asset back to Deel" }, "reuse_own_asset_from_deel": { "$ref": "#/components/schemas/ItAssetsAssetIdUnarchivePostResponsesContentApplicationJsonSchemaDataActionsReuseOwnAssetFromDeel", "description": "Redeploy an organization-owned asset stored at a Deel warehouse" }, "reuse_own_asset_from_own_location": { "$ref": "#/components/schemas/ItAssetsAssetIdUnarchivePostResponsesContentApplicationJsonSchemaDataActionsReuseOwnAssetFromOwnLocation", "description": "Redeploy an organization-owned asset from an organization-owned location" }, "store_own_asset_at_deel_for_hub": { "$ref": "#/components/schemas/ItAssetsAssetIdUnarchivePostResponsesContentApplicationJsonSchemaDataActionsStoreOwnAssetAtDeelForHub", "description": "Store an organization-owned asset at a Deel hub warehouse" }, "store_own_asset_at_deel_for_local": { "$ref": "#/components/schemas/ItAssetsAssetIdUnarchivePostResponsesContentApplicationJsonSchemaDataActionsStoreOwnAssetAtDeelForLocal", "description": "Store an organization-owned asset at a Deel local warehouse" }, "store_own_asset_at_own_location": { "$ref": "#/components/schemas/ItAssetsAssetIdUnarchivePostResponsesContentApplicationJsonSchemaDataActionsStoreOwnAssetAtOwnLocation", "description": "Store an organization-owned asset at an organization-owned location" }, "store_rental_at_deel_for_local": { "$ref": "#/components/schemas/ItAssetsAssetIdUnarchivePostResponsesContentApplicationJsonSchemaDataActionsStoreRentalAtDeelForLocal", "description": "Store a Deel-owned rental asset at a Deel local warehouse" }, "store_rental_at_deel_for_zone1": { "$ref": "#/components/schemas/ItAssetsAssetIdUnarchivePostResponsesContentApplicationJsonSchemaDataActionsStoreRentalAtDeelForZone1", "description": "Store a Deel-owned rental asset at a Deel zone-1 warehouse" }, "transfer_own_asset": { "$ref": "#/components/schemas/ItAssetsAssetIdUnarchivePostResponsesContentApplicationJsonSchemaDataActionsTransferOwnAsset", "description": "Transfer an organization-owned asset to another user" }, "transfer_rental": { "$ref": "#/components/schemas/ItAssetsAssetIdUnarchivePostResponsesContentApplicationJsonSchemaDataActionsTransferRental", "description": "Transfer a Deel-owned rental asset to another user" }, "unarchive_own_asset": { "$ref": "#/components/schemas/ItAssetsAssetIdUnarchivePostResponsesContentApplicationJsonSchemaDataActionsUnarchiveOwnAsset", "description": "Unarchive a previously archived organization-owned asset" }, "update_location_location_to_user": { "$ref": "#/components/schemas/ItAssetsAssetIdUnarchivePostResponsesContentApplicationJsonSchemaDataActionsUpdateLocationLocationToUser", "description": "Update the location of an asset from a warehouse to a user" }, "update_location_user_to_location": { "$ref": "#/components/schemas/ItAssetsAssetIdUnarchivePostResponsesContentApplicationJsonSchemaDataActionsUpdateLocationUserToLocation", "description": "Update the location of an asset from a user to a warehouse" }, "update_location_user_to_user": { "$ref": "#/components/schemas/ItAssetsAssetIdUnarchivePostResponsesContentApplicationJsonSchemaDataActionsUpdateLocationUserToUser", "description": "Update the assigned user of an asset that is currently with a user" }, "update_own_asset_details": { "$ref": "#/components/schemas/ItAssetsAssetIdUnarchivePostResponsesContentApplicationJsonSchemaDataActionsUpdateOwnAssetDetails", "description": "Update editable details of an organization-owned asset" } }, "required": [ "asset_country", "clear_own_asset", "purchase_rental", "transfer_rental", "archive_own_asset", "transfer_own_asset", "unarchive_own_asset", "return_rental_to_deel", "update_own_asset_details", "assign_addon_to_own_asset", "reuse_own_asset_from_deel", "update_location_user_to_user", "store_rental_at_deel_for_local", "store_rental_at_deel_for_zone1", "store_own_asset_at_deel_for_hub", "store_own_asset_at_own_location", "update_location_location_to_user", "update_location_user_to_location", "reuse_own_asset_from_own_location", "store_own_asset_at_deel_for_local", "manage_end_of_rental_contract_actions" ], "title": "ItAssetsAssetIdUnarchivePostResponsesContentApplicationJsonSchemaDataActions", "type": "object" }, "ItAssetsAssetIdUnarchivePostResponsesContentApplicationJsonSchemaDataActionsArchiveOwnAsset": { "description": "Archive an organization-owned asset", "properties": { "details": { "description": "Action-specific context needed to perform the action. Populated for enabled and\ndisabled actions (so callers can see what a successful attempt would look like);\nnull when the action is not applicable to this asset.", "oneOf": [ { "$ref": "#/components/schemas/ItAssetsAssetIdUnarchivePostResponsesContentApplicationJsonSchemaDataActionsArchiveOwnAssetDetails" }, { "type": "null" } ] }, "disabled_reasons": { "description": "Reasons why the action is disabled. Empty when the action is enabled or not applicable", "items": { "$ref": "#/components/schemas/ItAssetsAssetIdUnarchivePostResponsesContentApplicationJsonSchemaDataActionsArchiveOwnAssetDisabledReasonsItems" }, "type": "array" }, "status": { "$ref": "#/components/schemas/ItAssetsAssetIdUnarchivePostResponsesContentApplicationJsonSchemaDataActionsArchiveOwnAssetStatus", "description": "Whether the action is currently available for this asset" } }, "required": [ "status", "details", "disabled_reasons" ], "title": "ItAssetsAssetIdUnarchivePostResponsesContentApplicationJsonSchemaDataActionsArchiveOwnAsset", "type": "object" }, "ItAssetsAssetIdUnarchivePostResponsesContentApplicationJsonSchemaDataActionsArchiveOwnAssetDetails": { "description": "Action-specific context needed to perform the action. Populated for enabled and\ndisabled actions (so callers can see what a successful attempt would look like);\nnull when the action is not applicable to this asset.", "properties": { "allowed_statuses": { "description": "Statuses that can be passed as the archive reason when archiving the asset", "items": { "$ref": "#/components/schemas/ItAssetsAssetIdUnarchivePostResponsesContentApplicationJsonSchemaDataActionsArchiveOwnAssetDetailsAllowedStatusesItems" }, "type": "array" } }, "required": [ "allowed_statuses" ], "title": "ItAssetsAssetIdUnarchivePostResponsesContentApplicationJsonSchemaDataActionsArchiveOwnAssetDetails", "type": "object" }, "ItAssetsAssetIdUnarchivePostResponsesContentApplicationJsonSchemaDataActionsArchiveOwnAssetDetailsAllowedStatusesItems": { "enum": [ "ADDED_BY_MISTAKE", "BINNED", "BROKEN_AT_WAREHOUSE", "BROKEN_BY_USER", "BROKEN_IN_TRANSIT", "DAMAGED_AT_WAREHOUSE", "DAMAGED_BY_USER", "DAMAGED_IN_TRANSIT", "LEFT_WITH_USER", "LOST_IN_TRANSIT", "RETURNED_TO_DEEL", "SHRINKAGE", "STOLEN", "SUPPLIER_RETURN" ], "title": "ItAssetsAssetIdUnarchivePostResponsesContentApplicationJsonSchemaDataActionsArchiveOwnAssetDetailsAllowedStatusesItems", "type": "string" }, "ItAssetsAssetIdUnarchivePostResponsesContentApplicationJsonSchemaDataActionsArchiveOwnAssetDisabledReasonsItems": { "enum": [ "ARCHIVED", "AT_DEEL_WAREHOUSE", "BEING_REPAIRED", "CONSUMABLE", "CONTROLLED_BY_DEEL", "COUNTRY_NOT_SUPPORTED_FOR_HUB", "COUNTRY_NOT_SUPPORTED_FOR_LOCAL", "DEEL_OWNED_ITEM_WITHOUT_RENTAL_CONTRACT", "DESKTOP_STORAGE", "ENDING_CONTRACT", "HUB_IN_SAME_REGION_AS_LOCAL", "INACTIVE", "INVALID_ITEM_LOCATION", "INVALID_ORGANIZATION_STATUS", "INVALID_STATE", "ITEM_CONDITIONS_TO_UNARCHIVE_NOT_MET", "ITEM_NOT_VISIBLE_FOR_ORGANIZATION", "NON_DEVICE", "NOT_AT_WAREHOUSE", "NOT_AVAILABLE_FOR_REUSE", "NOT_A_RENTAL", "NOT_MANAGEABLE_BY_ORGANIZATION", "NOT_WITH_ASSIGNMENT", "NOT_WITH_USER", "NO_ACTIVE_ADDONS", "NO_ACTIVE_STORAGE_CONTRACT", "NO_LOCATION_FOR_STORAGE", "NO_LOGISTICS_FOR_STORAGE", "NO_VALID_ADDONS", "ONGOING_SERVICE", "OWNED_BY_DEEL", "OWNED_BY_ORGANIZATION", "OWNED_BY_PARTNER_ORGANIZATION", "PARTNER_CHILD_CONTRACT", "PENDING_DEVICE_REFRESH", "RENTAL_CONTRACT_AND_USER_REGION_DO_NOT_MATCH", "TEMPORARILY_UNAVAILABLE", "UNKNOWN", "USER_HAS_NO_COUNTRY", "USER_HAS_NO_SEAT", "WAITING_FOR_CLEARANCE", "WITH_LOANER_ASSIGNMENT", "WITH_NON_COLLECTED_ASSIGNMENT", "WITH_NON_DELIVERED_ASSIGNMENT", "WITH_PENDING_ASSIGNMENT", "WRONG_ASSIGNMENT_STATUS", "WRONG_CONTRACT_STATUS", "WRONG_TERMS_AND_CONDITIONS" ], "title": "ItAssetsAssetIdUnarchivePostResponsesContentApplicationJsonSchemaDataActionsArchiveOwnAssetDisabledReasonsItems", "type": "string" }, "ItAssetsAssetIdUnarchivePostResponsesContentApplicationJsonSchemaDataActionsArchiveOwnAssetStatus": { "description": "Whether the action is currently available for this asset", "enum": [ "DISABLED", "ENABLED", "NOT_APPLICABLE" ], "title": "ItAssetsAssetIdUnarchivePostResponsesContentApplicationJsonSchemaDataActionsArchiveOwnAssetStatus", "type": "string" }, "ItAssetsAssetIdUnarchivePostResponsesContentApplicationJsonSchemaDataActionsAssetCountry": { "description": "Resolved country used for asset actions. Derived from the asset's country,\nits assigned rental contract billing entity country, or the last active\nassignment delivery country. Null when the country cannot be determined\n(e.g. asset was returned to Deel)", "enum": [ "AD", "AE", "AF", "AG", "AI", "AL", "AM", "AN", "AO", "AQ", "AR", "AS", "AT", "AU", "AW", "AX", "AZ", "BA", "BB", "BD", "BE", "BF", "BG", "BH", "BI", "BJ", "BL", "BM", "BN", "BO", "BQ", "BR", "BS", "BT", "BV", "BW", "BY", "BZ", "CA", "CC", "CD", "CF", "CG", "CH", "CI", "CK", "CL", "CM", "CN", "CO", "CR", "CU", "CV", "CW", "CX", "CY", "CZ", "DE", "DJ", "DK", "DM", "DO", "DZ", "EC", "EE", "EG", "EH", "ER", "ES", "ET", "FI", "FJ", "FK", "FM", "FO", "FR", "GA", "GB", "GD", "GE", "GF", "GG", "GH", "GI", "GL", "GM", "GN", "GP", "GQ", "GR", "GS", "GT", "GU", "GW", "GY", "HK", "HM", "HN", "HR", "HT", "HU", "IC", "ID", "IE", "IL", "IM", "IN", "IO", "IQ", "IR", "IS", "IT", "JE", "JM", "JO", "JP", "KE", "KG", "KH", "KI", "KM", "KN", "KP", "KR", "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", "XK", "YE", "YT", "ZA", "ZM", "ZW" ], "title": "ItAssetsAssetIdUnarchivePostResponsesContentApplicationJsonSchemaDataActionsAssetCountry", "type": "string" }, "ItAssetsAssetIdUnarchivePostResponsesContentApplicationJsonSchemaDataActionsAssignAddonToOwnAsset": { "description": "Assign an add-on to an organization-owned asset", "properties": { "details": { "description": "Action-specific context needed to perform the action. Populated for enabled and\ndisabled actions (so callers can see what a successful attempt would look like);\nnull when the action is not applicable to this asset.", "oneOf": [ { "$ref": "#/components/schemas/ItAssetsAssetIdUnarchivePostResponsesContentApplicationJsonSchemaDataActionsAssignAddonToOwnAssetDetails" }, { "type": "null" } ] }, "disabled_reasons": { "description": "Reasons why the action is disabled. Empty when the action is enabled or not applicable", "items": { "$ref": "#/components/schemas/ItAssetsAssetIdUnarchivePostResponsesContentApplicationJsonSchemaDataActionsAssignAddonToOwnAssetDisabledReasonsItems" }, "type": "array" }, "status": { "$ref": "#/components/schemas/ItAssetsAssetIdUnarchivePostResponsesContentApplicationJsonSchemaDataActionsAssignAddonToOwnAssetStatus", "description": "Whether the action is currently available for this asset" } }, "required": [ "status", "details", "disabled_reasons" ], "title": "ItAssetsAssetIdUnarchivePostResponsesContentApplicationJsonSchemaDataActionsAssignAddonToOwnAsset", "type": "object" }, "ItAssetsAssetIdUnarchivePostResponsesContentApplicationJsonSchemaDataActionsAssignAddonToOwnAssetDetails": { "description": "Action-specific context needed to perform the action. Populated for enabled and\ndisabled actions (so callers can see what a successful attempt would look like);\nnull when the action is not applicable to this asset.", "properties": { "addons": { "description": "Add-ons that can be assigned to the asset, with a fail reason for those that don't qualify", "items": { "$ref": "#/components/schemas/ItAssetsAssetIdUnarchivePostResponsesContentApplicationJsonSchemaDataActionsAssignAddonToOwnAssetDetailsAddonsItems" }, "type": "array" } }, "required": [ "addons" ], "title": "ItAssetsAssetIdUnarchivePostResponsesContentApplicationJsonSchemaDataActionsAssignAddonToOwnAssetDetails", "type": "object" }, "ItAssetsAssetIdUnarchivePostResponsesContentApplicationJsonSchemaDataActionsAssignAddonToOwnAssetDetailsAddonsItems": { "properties": { "addon": { "$ref": "#/components/schemas/ItAssetsAssetIdUnarchivePostResponsesContentApplicationJsonSchemaDataActionsAssignAddonToOwnAssetDetailsAddonsItemsAddon", "description": "Add-on that can be assigned to the asset" }, "fail_reason": { "description": "Reason the add-on cannot be assigned to the asset. Null when assignment is allowed", "oneOf": [ { "$ref": "#/components/schemas/ItAssetsAssetIdUnarchivePostResponsesContentApplicationJsonSchemaDataActionsAssignAddonToOwnAssetDetailsAddonsItemsFailReason" }, { "type": "null" } ] } }, "required": [ "addon", "fail_reason" ], "title": "ItAssetsAssetIdUnarchivePostResponsesContentApplicationJsonSchemaDataActionsAssignAddonToOwnAssetDetailsAddonsItems", "type": "object" }, "ItAssetsAssetIdUnarchivePostResponsesContentApplicationJsonSchemaDataActionsAssignAddonToOwnAssetDetailsAddonsItemsAddon": { "description": "Add-on that can be assigned to the asset", "properties": { "id": { "description": "ID of the add-on", "format": "uuid", "type": "string" }, "name": { "description": "Public display name of the add-on", "type": "string" } }, "required": [ "id", "name" ], "title": "ItAssetsAssetIdUnarchivePostResponsesContentApplicationJsonSchemaDataActionsAssignAddonToOwnAssetDetailsAddonsItemsAddon", "type": "object" }, "ItAssetsAssetIdUnarchivePostResponsesContentApplicationJsonSchemaDataActionsAssignAddonToOwnAssetDetailsAddonsItemsFailReason": { "description": "Reason the add-on cannot be assigned to the asset. Null when assignment is allowed", "enum": [ "ADDON_NOT_AVAILABLE_TO_ORGANIZATION", "ALREADY_ASSIGNED", "HAS_ACTIVE_SERVICE_ADDON", "INVALID_ASSET_AGE", "INVALID_CONTRACT_TYPE", "INVALID_DURATION", "INVALID_PAYMENT_SCHEMA", "INVALID_PLATFORM_TIER", "INVALID_PRODUCT_BRAND", "INVALID_PRODUCT_CATEGORY", "INVALID_PRODUCT_PARENT_CATEGORY", "INVALID_RENTAL_TERM", "NO_MATCHING_ORGANIZATION_CONTRACT", "OTHER" ], "title": "ItAssetsAssetIdUnarchivePostResponsesContentApplicationJsonSchemaDataActionsAssignAddonToOwnAssetDetailsAddonsItemsFailReason", "type": "string" }, "ItAssetsAssetIdUnarchivePostResponsesContentApplicationJsonSchemaDataActionsAssignAddonToOwnAssetDisabledReasonsItems": { "enum": [ "ARCHIVED", "AT_DEEL_WAREHOUSE", "BEING_REPAIRED", "CONSUMABLE", "CONTROLLED_BY_DEEL", "COUNTRY_NOT_SUPPORTED_FOR_HUB", "COUNTRY_NOT_SUPPORTED_FOR_LOCAL", "DEEL_OWNED_ITEM_WITHOUT_RENTAL_CONTRACT", "DESKTOP_STORAGE", "ENDING_CONTRACT", "HUB_IN_SAME_REGION_AS_LOCAL", "INACTIVE", "INVALID_ITEM_LOCATION", "INVALID_ORGANIZATION_STATUS", "INVALID_STATE", "ITEM_CONDITIONS_TO_UNARCHIVE_NOT_MET", "ITEM_NOT_VISIBLE_FOR_ORGANIZATION", "NON_DEVICE", "NOT_AT_WAREHOUSE", "NOT_AVAILABLE_FOR_REUSE", "NOT_A_RENTAL", "NOT_MANAGEABLE_BY_ORGANIZATION", "NOT_WITH_ASSIGNMENT", "NOT_WITH_USER", "NO_ACTIVE_ADDONS", "NO_ACTIVE_STORAGE_CONTRACT", "NO_LOCATION_FOR_STORAGE", "NO_LOGISTICS_FOR_STORAGE", "NO_VALID_ADDONS", "ONGOING_SERVICE", "OWNED_BY_DEEL", "OWNED_BY_ORGANIZATION", "OWNED_BY_PARTNER_ORGANIZATION", "PARTNER_CHILD_CONTRACT", "PENDING_DEVICE_REFRESH", "RENTAL_CONTRACT_AND_USER_REGION_DO_NOT_MATCH", "TEMPORARILY_UNAVAILABLE", "UNKNOWN", "USER_HAS_NO_COUNTRY", "USER_HAS_NO_SEAT", "WAITING_FOR_CLEARANCE", "WITH_LOANER_ASSIGNMENT", "WITH_NON_COLLECTED_ASSIGNMENT", "WITH_NON_DELIVERED_ASSIGNMENT", "WITH_PENDING_ASSIGNMENT", "WRONG_ASSIGNMENT_STATUS", "WRONG_CONTRACT_STATUS", "WRONG_TERMS_AND_CONDITIONS" ], "title": "ItAssetsAssetIdUnarchivePostResponsesContentApplicationJsonSchemaDataActionsAssignAddonToOwnAssetDisabledReasonsItems", "type": "string" }, "ItAssetsAssetIdUnarchivePostResponsesContentApplicationJsonSchemaDataActionsAssignAddonToOwnAssetStatus": { "description": "Whether the action is currently available for this asset", "enum": [ "DISABLED", "ENABLED", "NOT_APPLICABLE" ], "title": "ItAssetsAssetIdUnarchivePostResponsesContentApplicationJsonSchemaDataActionsAssignAddonToOwnAssetStatus", "type": "string" }, "ItAssetsAssetIdUnarchivePostResponsesContentApplicationJsonSchemaDataActionsClearOwnAsset": { "description": "Clear an organization-owned asset from the fleet", "properties": { "disabled_reasons": { "description": "Reasons why the action is disabled. Empty when the action is enabled or not applicable", "items": { "$ref": "#/components/schemas/ItAssetsAssetIdUnarchivePostResponsesContentApplicationJsonSchemaDataActionsClearOwnAssetDisabledReasonsItems" }, "type": "array" }, "status": { "$ref": "#/components/schemas/ItAssetsAssetIdUnarchivePostResponsesContentApplicationJsonSchemaDataActionsClearOwnAssetStatus", "description": "Whether the action is currently available for this asset" } }, "required": [ "status", "disabled_reasons" ], "title": "ItAssetsAssetIdUnarchivePostResponsesContentApplicationJsonSchemaDataActionsClearOwnAsset", "type": "object" }, "ItAssetsAssetIdUnarchivePostResponsesContentApplicationJsonSchemaDataActionsClearOwnAssetDisabledReasonsItems": { "enum": [ "ARCHIVED", "AT_DEEL_WAREHOUSE", "BEING_REPAIRED", "CONSUMABLE", "CONTROLLED_BY_DEEL", "COUNTRY_NOT_SUPPORTED_FOR_HUB", "COUNTRY_NOT_SUPPORTED_FOR_LOCAL", "DEEL_OWNED_ITEM_WITHOUT_RENTAL_CONTRACT", "DESKTOP_STORAGE", "ENDING_CONTRACT", "HUB_IN_SAME_REGION_AS_LOCAL", "INACTIVE", "INVALID_ITEM_LOCATION", "INVALID_ORGANIZATION_STATUS", "INVALID_STATE", "ITEM_CONDITIONS_TO_UNARCHIVE_NOT_MET", "ITEM_NOT_VISIBLE_FOR_ORGANIZATION", "NON_DEVICE", "NOT_AT_WAREHOUSE", "NOT_AVAILABLE_FOR_REUSE", "NOT_A_RENTAL", "NOT_MANAGEABLE_BY_ORGANIZATION", "NOT_WITH_ASSIGNMENT", "NOT_WITH_USER", "NO_ACTIVE_ADDONS", "NO_ACTIVE_STORAGE_CONTRACT", "NO_LOCATION_FOR_STORAGE", "NO_LOGISTICS_FOR_STORAGE", "NO_VALID_ADDONS", "ONGOING_SERVICE", "OWNED_BY_DEEL", "OWNED_BY_ORGANIZATION", "OWNED_BY_PARTNER_ORGANIZATION", "PARTNER_CHILD_CONTRACT", "PENDING_DEVICE_REFRESH", "RENTAL_CONTRACT_AND_USER_REGION_DO_NOT_MATCH", "TEMPORARILY_UNAVAILABLE", "UNKNOWN", "USER_HAS_NO_COUNTRY", "USER_HAS_NO_SEAT", "WAITING_FOR_CLEARANCE", "WITH_LOANER_ASSIGNMENT", "WITH_NON_COLLECTED_ASSIGNMENT", "WITH_NON_DELIVERED_ASSIGNMENT", "WITH_PENDING_ASSIGNMENT", "WRONG_ASSIGNMENT_STATUS", "WRONG_CONTRACT_STATUS", "WRONG_TERMS_AND_CONDITIONS" ], "title": "ItAssetsAssetIdUnarchivePostResponsesContentApplicationJsonSchemaDataActionsClearOwnAssetDisabledReasonsItems", "type": "string" }, "ItAssetsAssetIdUnarchivePostResponsesContentApplicationJsonSchemaDataActionsClearOwnAssetStatus": { "description": "Whether the action is currently available for this asset", "enum": [ "DISABLED", "ENABLED", "NOT_APPLICABLE" ], "title": "ItAssetsAssetIdUnarchivePostResponsesContentApplicationJsonSchemaDataActionsClearOwnAssetStatus", "type": "string" }, "ItAssetsAssetIdUnarchivePostResponsesContentApplicationJsonSchemaDataActionsManageEndOfRentalContractActions": { "description": "Manage end-of-rental options for a Deel-owned rental asset", "properties": { "disabled_reasons": { "description": "Reasons why the action is disabled. Empty when the action is enabled or not applicable", "items": { "$ref": "#/components/schemas/ItAssetsAssetIdUnarchivePostResponsesContentApplicationJsonSchemaDataActionsManageEndOfRentalContractActionsDisabledReasonsItems" }, "type": "array" }, "status": { "$ref": "#/components/schemas/ItAssetsAssetIdUnarchivePostResponsesContentApplicationJsonSchemaDataActionsManageEndOfRentalContractActionsStatus", "description": "Whether the action is currently available for this asset" } }, "required": [ "status", "disabled_reasons" ], "title": "ItAssetsAssetIdUnarchivePostResponsesContentApplicationJsonSchemaDataActionsManageEndOfRentalContractActions", "type": "object" }, "ItAssetsAssetIdUnarchivePostResponsesContentApplicationJsonSchemaDataActionsManageEndOfRentalContractActionsDisabledReasonsItems": { "enum": [ "ARCHIVED", "AT_DEEL_WAREHOUSE", "BEING_REPAIRED", "CONSUMABLE", "CONTROLLED_BY_DEEL", "COUNTRY_NOT_SUPPORTED_FOR_HUB", "COUNTRY_NOT_SUPPORTED_FOR_LOCAL", "DEEL_OWNED_ITEM_WITHOUT_RENTAL_CONTRACT", "DESKTOP_STORAGE", "ENDING_CONTRACT", "HUB_IN_SAME_REGION_AS_LOCAL", "INACTIVE", "INVALID_ITEM_LOCATION", "INVALID_ORGANIZATION_STATUS", "INVALID_STATE", "ITEM_CONDITIONS_TO_UNARCHIVE_NOT_MET", "ITEM_NOT_VISIBLE_FOR_ORGANIZATION", "NON_DEVICE", "NOT_AT_WAREHOUSE", "NOT_AVAILABLE_FOR_REUSE", "NOT_A_RENTAL", "NOT_MANAGEABLE_BY_ORGANIZATION", "NOT_WITH_ASSIGNMENT", "NOT_WITH_USER", "NO_ACTIVE_ADDONS", "NO_ACTIVE_STORAGE_CONTRACT", "NO_LOCATION_FOR_STORAGE", "NO_LOGISTICS_FOR_STORAGE", "NO_VALID_ADDONS", "ONGOING_SERVICE", "OWNED_BY_DEEL", "OWNED_BY_ORGANIZATION", "OWNED_BY_PARTNER_ORGANIZATION", "PARTNER_CHILD_CONTRACT", "PENDING_DEVICE_REFRESH", "RENTAL_CONTRACT_AND_USER_REGION_DO_NOT_MATCH", "TEMPORARILY_UNAVAILABLE", "UNKNOWN", "USER_HAS_NO_COUNTRY", "USER_HAS_NO_SEAT", "WAITING_FOR_CLEARANCE", "WITH_LOANER_ASSIGNMENT", "WITH_NON_COLLECTED_ASSIGNMENT", "WITH_NON_DELIVERED_ASSIGNMENT", "WITH_PENDING_ASSIGNMENT", "WRONG_ASSIGNMENT_STATUS", "WRONG_CONTRACT_STATUS", "WRONG_TERMS_AND_CONDITIONS" ], "title": "ItAssetsAssetIdUnarchivePostResponsesContentApplicationJsonSchemaDataActionsManageEndOfRentalContractActionsDisabledReasonsItems", "type": "string" }, "ItAssetsAssetIdUnarchivePostResponsesContentApplicationJsonSchemaDataActionsManageEndOfRentalContractActionsStatus": { "description": "Whether the action is currently available for this asset", "enum": [ "DISABLED", "ENABLED", "NOT_APPLICABLE" ], "title": "ItAssetsAssetIdUnarchivePostResponsesContentApplicationJsonSchemaDataActionsManageEndOfRentalContractActionsStatus", "type": "string" }, "ItAssetsAssetIdUnarchivePostResponsesContentApplicationJsonSchemaDataActionsPurchaseRental": { "description": "Purchase a Deel-owned rental asset at end of contract", "properties": { "details": { "description": "Action-specific context needed to perform the action. Populated for enabled and\ndisabled actions (so callers can see what a successful attempt would look like);\nnull when the action is not applicable to this asset.", "oneOf": [ { "$ref": "#/components/schemas/ItAssetsAssetIdUnarchivePostResponsesContentApplicationJsonSchemaDataActionsPurchaseRentalDetails" }, { "type": "null" } ] }, "disabled_reasons": { "description": "Reasons why the action is disabled. Empty when the action is enabled or not applicable", "items": { "$ref": "#/components/schemas/ItAssetsAssetIdUnarchivePostResponsesContentApplicationJsonSchemaDataActionsPurchaseRentalDisabledReasonsItems" }, "type": "array" }, "status": { "$ref": "#/components/schemas/ItAssetsAssetIdUnarchivePostResponsesContentApplicationJsonSchemaDataActionsPurchaseRentalStatus", "description": "Whether the action is currently available for this asset" } }, "required": [ "status", "details", "disabled_reasons" ], "title": "ItAssetsAssetIdUnarchivePostResponsesContentApplicationJsonSchemaDataActionsPurchaseRental", "type": "object" }, "ItAssetsAssetIdUnarchivePostResponsesContentApplicationJsonSchemaDataActionsPurchaseRentalDetails": { "description": "Action-specific context needed to perform the action. Populated for enabled and\ndisabled actions (so callers can see what a successful attempt would look like);\nnull when the action is not applicable to this asset.", "properties": { "purchase_price": { "description": "Estimated price to purchase the asset at the end of the rental contract", "oneOf": [ { "$ref": "#/components/schemas/ItAssetsAssetIdUnarchivePostResponsesContentApplicationJsonSchemaDataActionsPurchaseRentalDetailsPurchasePrice" }, { "type": "null" } ] }, "remaining_contract_value": { "$ref": "#/components/schemas/ItAssetsAssetIdUnarchivePostResponsesContentApplicationJsonSchemaDataActionsPurchaseRentalDetailsRemainingContractValue", "description": "Estimated remaining value of the rental contract" }, "total_purchase_price": { "description": "Estimated total price of the purchase, including any remaining contract value", "oneOf": [ { "$ref": "#/components/schemas/ItAssetsAssetIdUnarchivePostResponsesContentApplicationJsonSchemaDataActionsPurchaseRentalDetailsTotalPurchasePrice" }, { "type": "null" } ] } }, "required": [ "purchase_price", "total_purchase_price", "remaining_contract_value" ], "title": "ItAssetsAssetIdUnarchivePostResponsesContentApplicationJsonSchemaDataActionsPurchaseRentalDetails", "type": "object" }, "ItAssetsAssetIdUnarchivePostResponsesContentApplicationJsonSchemaDataActionsPurchaseRentalDetailsPurchasePrice": { "description": "Estimated price to purchase the asset at the end of the rental contract", "properties": { "amount": { "description": "Amount", "format": "decimal", "type": "string" }, "currency": { "$ref": "#/components/schemas/ItAssetsAssetIdUnarchivePostResponsesContentApplicationJsonSchemaDataActionsPurchaseRentalDetailsPurchasePriceCurrency", "description": "Three-letter currency code for the price" } }, "required": [ "amount", "currency" ], "title": "ItAssetsAssetIdUnarchivePostResponsesContentApplicationJsonSchemaDataActionsPurchaseRentalDetailsPurchasePrice", "type": "object" }, "ItAssetsAssetIdUnarchivePostResponsesContentApplicationJsonSchemaDataActionsPurchaseRentalDetailsPurchasePriceCurrency": { "description": "Three-letter currency code for the price", "enum": [ "AED", "AFN", "ALL", "AMD", "ANG", "AOA", "ARS", "AUD", "AWG", "AZN", "BAM", "BDT", "BGN", "BHD", "BIF", "BMD", "BOB", "BRL", "BSD", "BTN", "BWP", "BYN", "BZD", "CAD", "CDF", "CHF", "CLP", "CNY", "COP", "CRC", "CUC", "CVE", "CZK", "DJF", "DKK", "DOP", "DZD", "EGP", "ERN", "ETB", "EUR", "FJD", "FKP", "GBP", "GEL", "GHS", "GIP", "GMD", "GNF", "GTQ", "GYD", "HKD", "HNL", "HRK", "HTG", "HUF", "IDR", "ILS", "INR", "IQD", "IRR", "ISK", "JMD", "JOD", "JPY", "KES", "KGS", "KHR", "KMF", "KPW", "KRW", "KWD", "KYD", "KZT", "LAK", "LBP", "LKR", "LRD", "LSL", "LTL", "LYD", "MAD", "MDL", "MGA", "MKD", "MMK", "MNT", "MRU", "MUR", "MVR", "MWK", "MXN", "MYR", "MZN", "NAD", "NGN", "NIO", "NOK", "NPR", "NZD", "OMR", "PAB", "PEN", "PGK", "PHP", "PKR", "PLN", "PYG", "QAR", "RON", "RSD", "RUB", "RWF", "SAR", "SBD", "SCR", "SDG", "SEK", "SGD", "SHP", "SLL", "SOS", "SRD", "SSP", "STD", "SYP", "SZL", "THB", "TJS", "TMT", "TND", "TOP", "TRY", "TTD", "TWD", "TZS", "UAH", "UGX", "USD", "UYU", "UZS", "VEF", "VND", "VUV", "WST", "XAF", "XCD", "XOF", "XPF", "YER", "ZAR", "ZMW", "ZWD" ], "title": "ItAssetsAssetIdUnarchivePostResponsesContentApplicationJsonSchemaDataActionsPurchaseRentalDetailsPurchasePriceCurrency", "type": "string" }, "ItAssetsAssetIdUnarchivePostResponsesContentApplicationJsonSchemaDataActionsPurchaseRentalDetailsRemainingContractValue": { "description": "Estimated remaining value of the rental contract", "properties": { "amount": { "description": "Amount", "format": "decimal", "type": "string" }, "currency": { "$ref": "#/components/schemas/ItAssetsAssetIdUnarchivePostResponsesContentApplicationJsonSchemaDataActionsPurchaseRentalDetailsRemainingContractValueCurrency", "description": "Three-letter currency code for the price" } }, "required": [ "amount", "currency" ], "title": "ItAssetsAssetIdUnarchivePostResponsesContentApplicationJsonSchemaDataActionsPurchaseRentalDetailsRemainingContractValue", "type": "object" }, "ItAssetsAssetIdUnarchivePostResponsesContentApplicationJsonSchemaDataActionsPurchaseRentalDetailsRemainingContractValueCurrency": { "description": "Three-letter currency code for the price", "enum": [ "AED", "AFN", "ALL", "AMD", "ANG", "AOA", "ARS", "AUD", "AWG", "AZN", "BAM", "BDT", "BGN", "BHD", "BIF", "BMD", "BOB", "BRL", "BSD", "BTN", "BWP", "BYN", "BZD", "CAD", "CDF", "CHF", "CLP", "CNY", "COP", "CRC", "CUC", "CVE", "CZK", "DJF", "DKK", "DOP", "DZD", "EGP", "ERN", "ETB", "EUR", "FJD", "FKP", "GBP", "GEL", "GHS", "GIP", "GMD", "GNF", "GTQ", "GYD", "HKD", "HNL", "HRK", "HTG", "HUF", "IDR", "ILS", "INR", "IQD", "IRR", "ISK", "JMD", "JOD", "JPY", "KES", "KGS", "KHR", "KMF", "KPW", "KRW", "KWD", "KYD", "KZT", "LAK", "LBP", "LKR", "LRD", "LSL", "LTL", "LYD", "MAD", "MDL", "MGA", "MKD", "MMK", "MNT", "MRU", "MUR", "MVR", "MWK", "MXN", "MYR", "MZN", "NAD", "NGN", "NIO", "NOK", "NPR", "NZD", "OMR", "PAB", "PEN", "PGK", "PHP", "PKR", "PLN", "PYG", "QAR", "RON", "RSD", "RUB", "RWF", "SAR", "SBD", "SCR", "SDG", "SEK", "SGD", "SHP", "SLL", "SOS", "SRD", "SSP", "STD", "SYP", "SZL", "THB", "TJS", "TMT", "TND", "TOP", "TRY", "TTD", "TWD", "TZS", "UAH", "UGX", "USD", "UYU", "UZS", "VEF", "VND", "VUV", "WST", "XAF", "XCD", "XOF", "XPF", "YER", "ZAR", "ZMW", "ZWD" ], "title": "ItAssetsAssetIdUnarchivePostResponsesContentApplicationJsonSchemaDataActionsPurchaseRentalDetailsRemainingContractValueCurrency", "type": "string" }, "ItAssetsAssetIdUnarchivePostResponsesContentApplicationJsonSchemaDataActionsPurchaseRentalDetailsTotalPurchasePrice": { "description": "Estimated total price of the purchase, including any remaining contract value", "properties": { "amount": { "description": "Amount", "format": "decimal", "type": "string" }, "currency": { "$ref": "#/components/schemas/ItAssetsAssetIdUnarchivePostResponsesContentApplicationJsonSchemaDataActionsPurchaseRentalDetailsTotalPurchasePriceCurrency", "description": "Three-letter currency code for the price" } }, "required": [ "amount", "currency" ], "title": "ItAssetsAssetIdUnarchivePostResponsesContentApplicationJsonSchemaDataActionsPurchaseRentalDetailsTotalPurchasePrice", "type": "object" }, "ItAssetsAssetIdUnarchivePostResponsesContentApplicationJsonSchemaDataActionsPurchaseRentalDetailsTotalPurchasePriceCurrency": { "description": "Three-letter currency code for the price", "enum": [ "AED", "AFN", "ALL", "AMD", "ANG", "AOA", "ARS", "AUD", "AWG", "AZN", "BAM", "BDT", "BGN", "BHD", "BIF", "BMD", "BOB", "BRL", "BSD", "BTN", "BWP", "BYN", "BZD", "CAD", "CDF", "CHF", "CLP", "CNY", "COP", "CRC", "CUC", "CVE", "CZK", "DJF", "DKK", "DOP", "DZD", "EGP", "ERN", "ETB", "EUR", "FJD", "FKP", "GBP", "GEL", "GHS", "GIP", "GMD", "GNF", "GTQ", "GYD", "HKD", "HNL", "HRK", "HTG", "HUF", "IDR", "ILS", "INR", "IQD", "IRR", "ISK", "JMD", "JOD", "JPY", "KES", "KGS", "KHR", "KMF", "KPW", "KRW", "KWD", "KYD", "KZT", "LAK", "LBP", "LKR", "LRD", "LSL", "LTL", "LYD", "MAD", "MDL", "MGA", "MKD", "MMK", "MNT", "MRU", "MUR", "MVR", "MWK", "MXN", "MYR", "MZN", "NAD", "NGN", "NIO", "NOK", "NPR", "NZD", "OMR", "PAB", "PEN", "PGK", "PHP", "PKR", "PLN", "PYG", "QAR", "RON", "RSD", "RUB", "RWF", "SAR", "SBD", "SCR", "SDG", "SEK", "SGD", "SHP", "SLL", "SOS", "SRD", "SSP", "STD", "SYP", "SZL", "THB", "TJS", "TMT", "TND", "TOP", "TRY", "TTD", "TWD", "TZS", "UAH", "UGX", "USD", "UYU", "UZS", "VEF", "VND", "VUV", "WST", "XAF", "XCD", "XOF", "XPF", "YER", "ZAR", "ZMW", "ZWD" ], "title": "ItAssetsAssetIdUnarchivePostResponsesContentApplicationJsonSchemaDataActionsPurchaseRentalDetailsTotalPurchasePriceCurrency", "type": "string" }, "ItAssetsAssetIdUnarchivePostResponsesContentApplicationJsonSchemaDataActionsPurchaseRentalDisabledReasonsItems": { "enum": [ "ARCHIVED", "AT_DEEL_WAREHOUSE", "BEING_REPAIRED", "CONSUMABLE", "CONTROLLED_BY_DEEL", "COUNTRY_NOT_SUPPORTED_FOR_HUB", "COUNTRY_NOT_SUPPORTED_FOR_LOCAL", "DEEL_OWNED_ITEM_WITHOUT_RENTAL_CONTRACT", "DESKTOP_STORAGE", "ENDING_CONTRACT", "HUB_IN_SAME_REGION_AS_LOCAL", "INACTIVE", "INVALID_ITEM_LOCATION", "INVALID_ORGANIZATION_STATUS", "INVALID_STATE", "ITEM_CONDITIONS_TO_UNARCHIVE_NOT_MET", "ITEM_NOT_VISIBLE_FOR_ORGANIZATION", "NON_DEVICE", "NOT_AT_WAREHOUSE", "NOT_AVAILABLE_FOR_REUSE", "NOT_A_RENTAL", "NOT_MANAGEABLE_BY_ORGANIZATION", "NOT_WITH_ASSIGNMENT", "NOT_WITH_USER", "NO_ACTIVE_ADDONS", "NO_ACTIVE_STORAGE_CONTRACT", "NO_LOCATION_FOR_STORAGE", "NO_LOGISTICS_FOR_STORAGE", "NO_VALID_ADDONS", "ONGOING_SERVICE", "OWNED_BY_DEEL", "OWNED_BY_ORGANIZATION", "OWNED_BY_PARTNER_ORGANIZATION", "PARTNER_CHILD_CONTRACT", "PENDING_DEVICE_REFRESH", "RENTAL_CONTRACT_AND_USER_REGION_DO_NOT_MATCH", "TEMPORARILY_UNAVAILABLE", "UNKNOWN", "USER_HAS_NO_COUNTRY", "USER_HAS_NO_SEAT", "WAITING_FOR_CLEARANCE", "WITH_LOANER_ASSIGNMENT", "WITH_NON_COLLECTED_ASSIGNMENT", "WITH_NON_DELIVERED_ASSIGNMENT", "WITH_PENDING_ASSIGNMENT", "WRONG_ASSIGNMENT_STATUS", "WRONG_CONTRACT_STATUS", "WRONG_TERMS_AND_CONDITIONS" ], "title": "ItAssetsAssetIdUnarchivePostResponsesContentApplicationJsonSchemaDataActionsPurchaseRentalDisabledReasonsItems", "type": "string" }, "ItAssetsAssetIdUnarchivePostResponsesContentApplicationJsonSchemaDataActionsPurchaseRentalStatus": { "description": "Whether the action is currently available for this asset", "enum": [ "DISABLED", "ENABLED", "NOT_APPLICABLE" ], "title": "ItAssetsAssetIdUnarchivePostResponsesContentApplicationJsonSchemaDataActionsPurchaseRentalStatus", "type": "string" }, "ItAssetsAssetIdUnarchivePostResponsesContentApplicationJsonSchemaDataActionsReturnRentalToDeel": { "description": "Return a Deel-owned rental asset back to Deel", "properties": { "details": { "description": "Action-specific context needed to perform the action. Populated for enabled and\ndisabled actions (so callers can see what a successful attempt would look like);\nnull when the action is not applicable to this asset.", "oneOf": [ { "$ref": "#/components/schemas/ItAssetsAssetIdUnarchivePostResponsesContentApplicationJsonSchemaDataActionsReturnRentalToDeelDetails" }, { "type": "null" } ] }, "disabled_reasons": { "description": "Reasons why the action is disabled. Empty when the action is enabled or not applicable", "items": { "$ref": "#/components/schemas/ItAssetsAssetIdUnarchivePostResponsesContentApplicationJsonSchemaDataActionsReturnRentalToDeelDisabledReasonsItems" }, "type": "array" }, "status": { "$ref": "#/components/schemas/ItAssetsAssetIdUnarchivePostResponsesContentApplicationJsonSchemaDataActionsReturnRentalToDeelStatus", "description": "Whether the action is currently available for this asset" } }, "required": [ "status", "details", "disabled_reasons" ], "title": "ItAssetsAssetIdUnarchivePostResponsesContentApplicationJsonSchemaDataActionsReturnRentalToDeel", "type": "object" }, "ItAssetsAssetIdUnarchivePostResponsesContentApplicationJsonSchemaDataActionsReturnRentalToDeelDetails": { "description": "Action-specific context needed to perform the action. Populated for enabled and\ndisabled actions (so callers can see what a successful attempt would look like);\nnull when the action is not applicable to this asset.", "properties": { "end_contract_price": { "$ref": "#/components/schemas/ItAssetsAssetIdUnarchivePostResponsesContentApplicationJsonSchemaDataActionsReturnRentalToDeelDetailsEndContractPrice", "description": "Estimated end-of-contract price charged when returning the asset" } }, "required": [ "end_contract_price" ], "title": "ItAssetsAssetIdUnarchivePostResponsesContentApplicationJsonSchemaDataActionsReturnRentalToDeelDetails", "type": "object" }, "ItAssetsAssetIdUnarchivePostResponsesContentApplicationJsonSchemaDataActionsReturnRentalToDeelDetailsEndContractPrice": { "description": "Estimated end-of-contract price charged when returning the asset", "properties": { "amount": { "description": "Amount", "format": "decimal", "type": "string" }, "currency": { "$ref": "#/components/schemas/ItAssetsAssetIdUnarchivePostResponsesContentApplicationJsonSchemaDataActionsReturnRentalToDeelDetailsEndContractPriceCurrency", "description": "Three-letter currency code for the price" } }, "required": [ "amount", "currency" ], "title": "ItAssetsAssetIdUnarchivePostResponsesContentApplicationJsonSchemaDataActionsReturnRentalToDeelDetailsEndContractPrice", "type": "object" }, "ItAssetsAssetIdUnarchivePostResponsesContentApplicationJsonSchemaDataActionsReturnRentalToDeelDetailsEndContractPriceCurrency": { "description": "Three-letter currency code for the price", "enum": [ "AED", "AFN", "ALL", "AMD", "ANG", "AOA", "ARS", "AUD", "AWG", "AZN", "BAM", "BDT", "BGN", "BHD", "BIF", "BMD", "BOB", "BRL", "BSD", "BTN", "BWP", "BYN", "BZD", "CAD", "CDF", "CHF", "CLP", "CNY", "COP", "CRC", "CUC", "CVE", "CZK", "DJF", "DKK", "DOP", "DZD", "EGP", "ERN", "ETB", "EUR", "FJD", "FKP", "GBP", "GEL", "GHS", "GIP", "GMD", "GNF", "GTQ", "GYD", "HKD", "HNL", "HRK", "HTG", "HUF", "IDR", "ILS", "INR", "IQD", "IRR", "ISK", "JMD", "JOD", "JPY", "KES", "KGS", "KHR", "KMF", "KPW", "KRW", "KWD", "KYD", "KZT", "LAK", "LBP", "LKR", "LRD", "LSL", "LTL", "LYD", "MAD", "MDL", "MGA", "MKD", "MMK", "MNT", "MRU", "MUR", "MVR", "MWK", "MXN", "MYR", "MZN", "NAD", "NGN", "NIO", "NOK", "NPR", "NZD", "OMR", "PAB", "PEN", "PGK", "PHP", "PKR", "PLN", "PYG", "QAR", "RON", "RSD", "RUB", "RWF", "SAR", "SBD", "SCR", "SDG", "SEK", "SGD", "SHP", "SLL", "SOS", "SRD", "SSP", "STD", "SYP", "SZL", "THB", "TJS", "TMT", "TND", "TOP", "TRY", "TTD", "TWD", "TZS", "UAH", "UGX", "USD", "UYU", "UZS", "VEF", "VND", "VUV", "WST", "XAF", "XCD", "XOF", "XPF", "YER", "ZAR", "ZMW", "ZWD" ], "title": "ItAssetsAssetIdUnarchivePostResponsesContentApplicationJsonSchemaDataActionsReturnRentalToDeelDetailsEndContractPriceCurrency", "type": "string" }, "ItAssetsAssetIdUnarchivePostResponsesContentApplicationJsonSchemaDataActionsReturnRentalToDeelDisabledReasonsItems": { "enum": [ "ARCHIVED", "AT_DEEL_WAREHOUSE", "BEING_REPAIRED", "CONSUMABLE", "CONTROLLED_BY_DEEL", "COUNTRY_NOT_SUPPORTED_FOR_HUB", "COUNTRY_NOT_SUPPORTED_FOR_LOCAL", "DEEL_OWNED_ITEM_WITHOUT_RENTAL_CONTRACT", "DESKTOP_STORAGE", "ENDING_CONTRACT", "HUB_IN_SAME_REGION_AS_LOCAL", "INACTIVE", "INVALID_ITEM_LOCATION", "INVALID_ORGANIZATION_STATUS", "INVALID_STATE", "ITEM_CONDITIONS_TO_UNARCHIVE_NOT_MET", "ITEM_NOT_VISIBLE_FOR_ORGANIZATION", "NON_DEVICE", "NOT_AT_WAREHOUSE", "NOT_AVAILABLE_FOR_REUSE", "NOT_A_RENTAL", "NOT_MANAGEABLE_BY_ORGANIZATION", "NOT_WITH_ASSIGNMENT", "NOT_WITH_USER", "NO_ACTIVE_ADDONS", "NO_ACTIVE_STORAGE_CONTRACT", "NO_LOCATION_FOR_STORAGE", "NO_LOGISTICS_FOR_STORAGE", "NO_VALID_ADDONS", "ONGOING_SERVICE", "OWNED_BY_DEEL", "OWNED_BY_ORGANIZATION", "OWNED_BY_PARTNER_ORGANIZATION", "PARTNER_CHILD_CONTRACT", "PENDING_DEVICE_REFRESH", "RENTAL_CONTRACT_AND_USER_REGION_DO_NOT_MATCH", "TEMPORARILY_UNAVAILABLE", "UNKNOWN", "USER_HAS_NO_COUNTRY", "USER_HAS_NO_SEAT", "WAITING_FOR_CLEARANCE", "WITH_LOANER_ASSIGNMENT", "WITH_NON_COLLECTED_ASSIGNMENT", "WITH_NON_DELIVERED_ASSIGNMENT", "WITH_PENDING_ASSIGNMENT", "WRONG_ASSIGNMENT_STATUS", "WRONG_CONTRACT_STATUS", "WRONG_TERMS_AND_CONDITIONS" ], "title": "ItAssetsAssetIdUnarchivePostResponsesContentApplicationJsonSchemaDataActionsReturnRentalToDeelDisabledReasonsItems", "type": "string" }, "ItAssetsAssetIdUnarchivePostResponsesContentApplicationJsonSchemaDataActionsReturnRentalToDeelStatus": { "description": "Whether the action is currently available for this asset", "enum": [ "DISABLED", "ENABLED", "NOT_APPLICABLE" ], "title": "ItAssetsAssetIdUnarchivePostResponsesContentApplicationJsonSchemaDataActionsReturnRentalToDeelStatus", "type": "string" }, "ItAssetsAssetIdUnarchivePostResponsesContentApplicationJsonSchemaDataActionsReuseOwnAssetFromDeel": { "description": "Redeploy an organization-owned asset stored at a Deel warehouse", "properties": { "details": { "description": "Action-specific context needed to perform the action. Populated for enabled and\ndisabled actions (so callers can see what a successful attempt would look like);\nnull when the action is not applicable to this asset.", "oneOf": [ { "$ref": "#/components/schemas/ItAssetsAssetIdUnarchivePostResponsesContentApplicationJsonSchemaDataActionsReuseOwnAssetFromDeelDetails" }, { "type": "null" } ] }, "disabled_reasons": { "description": "Reasons why the action is disabled. Empty when the action is enabled or not applicable", "items": { "$ref": "#/components/schemas/ItAssetsAssetIdUnarchivePostResponsesContentApplicationJsonSchemaDataActionsReuseOwnAssetFromDeelDisabledReasonsItems" }, "type": "array" }, "status": { "$ref": "#/components/schemas/ItAssetsAssetIdUnarchivePostResponsesContentApplicationJsonSchemaDataActionsReuseOwnAssetFromDeelStatus", "description": "Whether the action is currently available for this asset" } }, "required": [ "status", "details", "disabled_reasons" ], "title": "ItAssetsAssetIdUnarchivePostResponsesContentApplicationJsonSchemaDataActionsReuseOwnAssetFromDeel", "type": "object" }, "ItAssetsAssetIdUnarchivePostResponsesContentApplicationJsonSchemaDataActionsReuseOwnAssetFromDeelDetails": { "description": "Action-specific context needed to perform the action. Populated for enabled and\ndisabled actions (so callers can see what a successful attempt would look like);\nnull when the action is not applicable to this asset.", "properties": { "eligible_countries": { "description": "Countries where the asset can be redeployed from Deel", "items": { "$ref": "#/components/schemas/ItAssetsAssetIdUnarchivePostResponsesContentApplicationJsonSchemaDataActionsReuseOwnAssetFromDeelDetailsEligibleCountriesItems" }, "type": "array" }, "express_delivery": { "description": "Express delivery availability and per-country fees. Null when express delivery is not supported", "oneOf": [ { "$ref": "#/components/schemas/ItAssetsAssetIdUnarchivePostResponsesContentApplicationJsonSchemaDataActionsReuseOwnAssetFromDeelDetailsExpressDelivery" }, { "type": "null" } ] } }, "required": [ "express_delivery", "eligible_countries" ], "title": "ItAssetsAssetIdUnarchivePostResponsesContentApplicationJsonSchemaDataActionsReuseOwnAssetFromDeelDetails", "type": "object" }, "ItAssetsAssetIdUnarchivePostResponsesContentApplicationJsonSchemaDataActionsReuseOwnAssetFromDeelDetailsEligibleCountriesItems": { "enum": [ "AD", "AE", "AF", "AG", "AI", "AL", "AM", "AN", "AO", "AQ", "AR", "AS", "AT", "AU", "AW", "AX", "AZ", "BA", "BB", "BD", "BE", "BF", "BG", "BH", "BI", "BJ", "BL", "BM", "BN", "BO", "BQ", "BR", "BS", "BT", "BV", "BW", "BY", "BZ", "CA", "CC", "CD", "CF", "CG", "CH", "CI", "CK", "CL", "CM", "CN", "CO", "CR", "CU", "CV", "CW", "CX", "CY", "CZ", "DE", "DJ", "DK", "DM", "DO", "DZ", "EC", "EE", "EG", "EH", "ER", "ES", "ET", "FI", "FJ", "FK", "FM", "FO", "FR", "GA", "GB", "GD", "GE", "GF", "GG", "GH", "GI", "GL", "GM", "GN", "GP", "GQ", "GR", "GS", "GT", "GU", "GW", "GY", "HK", "HM", "HN", "HR", "HT", "HU", "IC", "ID", "IE", "IL", "IM", "IN", "IO", "IQ", "IR", "IS", "IT", "JE", "JM", "JO", "JP", "KE", "KG", "KH", "KI", "KM", "KN", "KP", "KR", "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", "XK", "YE", "YT", "ZA", "ZM", "ZW" ], "title": "ItAssetsAssetIdUnarchivePostResponsesContentApplicationJsonSchemaDataActionsReuseOwnAssetFromDeelDetailsEligibleCountriesItems", "type": "string" }, "ItAssetsAssetIdUnarchivePostResponsesContentApplicationJsonSchemaDataActionsReuseOwnAssetFromDeelDetailsExpressDelivery": { "description": "Express delivery availability and per-country fees. Null when express delivery is not supported", "properties": { "country_fees": { "additionalProperties": { "$ref": "#/components/schemas/ItAssetsAssetIdUnarchivePostResponsesContentApplicationJsonSchemaDataActionsReuseOwnAssetFromDeelDetailsExpressDeliveryCountryFees" }, "description": "Express delivery fees keyed by destination country.", "type": "object" } }, "required": [ "country_fees" ], "title": "ItAssetsAssetIdUnarchivePostResponsesContentApplicationJsonSchemaDataActionsReuseOwnAssetFromDeelDetailsExpressDelivery", "type": "object" }, "ItAssetsAssetIdUnarchivePostResponsesContentApplicationJsonSchemaDataActionsReuseOwnAssetFromDeelDetailsExpressDeliveryCountryFees": { "properties": { "amount": { "description": "Amount", "format": "decimal", "type": "string" }, "currency": { "$ref": "#/components/schemas/ItAssetsAssetIdUnarchivePostResponsesContentApplicationJsonSchemaDataActionsReuseOwnAssetFromDeelDetailsExpressDeliveryCountryFeesCurrency", "description": "Three-letter currency code for the price" } }, "required": [ "amount", "currency" ], "title": "ItAssetsAssetIdUnarchivePostResponsesContentApplicationJsonSchemaDataActionsReuseOwnAssetFromDeelDetailsExpressDeliveryCountryFees", "type": "object" }, "ItAssetsAssetIdUnarchivePostResponsesContentApplicationJsonSchemaDataActionsReuseOwnAssetFromDeelDetailsExpressDeliveryCountryFeesCurrency": { "description": "Three-letter currency code for the price", "enum": [ "AED", "AFN", "ALL", "AMD", "ANG", "AOA", "ARS", "AUD", "AWG", "AZN", "BAM", "BDT", "BGN", "BHD", "BIF", "BMD", "BOB", "BRL", "BSD", "BTN", "BWP", "BYN", "BZD", "CAD", "CDF", "CHF", "CLP", "CNY", "COP", "CRC", "CUC", "CVE", "CZK", "DJF", "DKK", "DOP", "DZD", "EGP", "ERN", "ETB", "EUR", "FJD", "FKP", "GBP", "GEL", "GHS", "GIP", "GMD", "GNF", "GTQ", "GYD", "HKD", "HNL", "HRK", "HTG", "HUF", "IDR", "ILS", "INR", "IQD", "IRR", "ISK", "JMD", "JOD", "JPY", "KES", "KGS", "KHR", "KMF", "KPW", "KRW", "KWD", "KYD", "KZT", "LAK", "LBP", "LKR", "LRD", "LSL", "LTL", "LYD", "MAD", "MDL", "MGA", "MKD", "MMK", "MNT", "MRU", "MUR", "MVR", "MWK", "MXN", "MYR", "MZN", "NAD", "NGN", "NIO", "NOK", "NPR", "NZD", "OMR", "PAB", "PEN", "PGK", "PHP", "PKR", "PLN", "PYG", "QAR", "RON", "RSD", "RUB", "RWF", "SAR", "SBD", "SCR", "SDG", "SEK", "SGD", "SHP", "SLL", "SOS", "SRD", "SSP", "STD", "SYP", "SZL", "THB", "TJS", "TMT", "TND", "TOP", "TRY", "TTD", "TWD", "TZS", "UAH", "UGX", "USD", "UYU", "UZS", "VEF", "VND", "VUV", "WST", "XAF", "XCD", "XOF", "XPF", "YER", "ZAR", "ZMW", "ZWD" ], "title": "ItAssetsAssetIdUnarchivePostResponsesContentApplicationJsonSchemaDataActionsReuseOwnAssetFromDeelDetailsExpressDeliveryCountryFeesCurrency", "type": "string" }, "ItAssetsAssetIdUnarchivePostResponsesContentApplicationJsonSchemaDataActionsReuseOwnAssetFromDeelDisabledReasonsItems": { "enum": [ "ARCHIVED", "AT_DEEL_WAREHOUSE", "BEING_REPAIRED", "CONSUMABLE", "CONTROLLED_BY_DEEL", "COUNTRY_NOT_SUPPORTED_FOR_HUB", "COUNTRY_NOT_SUPPORTED_FOR_LOCAL", "DEEL_OWNED_ITEM_WITHOUT_RENTAL_CONTRACT", "DESKTOP_STORAGE", "ENDING_CONTRACT", "HUB_IN_SAME_REGION_AS_LOCAL", "INACTIVE", "INVALID_ITEM_LOCATION", "INVALID_ORGANIZATION_STATUS", "INVALID_STATE", "ITEM_CONDITIONS_TO_UNARCHIVE_NOT_MET", "ITEM_NOT_VISIBLE_FOR_ORGANIZATION", "NON_DEVICE", "NOT_AT_WAREHOUSE", "NOT_AVAILABLE_FOR_REUSE", "NOT_A_RENTAL", "NOT_MANAGEABLE_BY_ORGANIZATION", "NOT_WITH_ASSIGNMENT", "NOT_WITH_USER", "NO_ACTIVE_ADDONS", "NO_ACTIVE_STORAGE_CONTRACT", "NO_LOCATION_FOR_STORAGE", "NO_LOGISTICS_FOR_STORAGE", "NO_VALID_ADDONS", "ONGOING_SERVICE", "OWNED_BY_DEEL", "OWNED_BY_ORGANIZATION", "OWNED_BY_PARTNER_ORGANIZATION", "PARTNER_CHILD_CONTRACT", "PENDING_DEVICE_REFRESH", "RENTAL_CONTRACT_AND_USER_REGION_DO_NOT_MATCH", "TEMPORARILY_UNAVAILABLE", "UNKNOWN", "USER_HAS_NO_COUNTRY", "USER_HAS_NO_SEAT", "WAITING_FOR_CLEARANCE", "WITH_LOANER_ASSIGNMENT", "WITH_NON_COLLECTED_ASSIGNMENT", "WITH_NON_DELIVERED_ASSIGNMENT", "WITH_PENDING_ASSIGNMENT", "WRONG_ASSIGNMENT_STATUS", "WRONG_CONTRACT_STATUS", "WRONG_TERMS_AND_CONDITIONS" ], "title": "ItAssetsAssetIdUnarchivePostResponsesContentApplicationJsonSchemaDataActionsReuseOwnAssetFromDeelDisabledReasonsItems", "type": "string" }, "ItAssetsAssetIdUnarchivePostResponsesContentApplicationJsonSchemaDataActionsReuseOwnAssetFromDeelStatus": { "description": "Whether the action is currently available for this asset", "enum": [ "DISABLED", "ENABLED", "NOT_APPLICABLE" ], "title": "ItAssetsAssetIdUnarchivePostResponsesContentApplicationJsonSchemaDataActionsReuseOwnAssetFromDeelStatus", "type": "string" }, "ItAssetsAssetIdUnarchivePostResponsesContentApplicationJsonSchemaDataActionsReuseOwnAssetFromOwnLocation": { "description": "Redeploy an organization-owned asset from an organization-owned location", "properties": { "details": { "description": "Action-specific context needed to perform the action. Populated for enabled and\ndisabled actions (so callers can see what a successful attempt would look like);\nnull when the action is not applicable to this asset.", "oneOf": [ { "$ref": "#/components/schemas/ItAssetsAssetIdUnarchivePostResponsesContentApplicationJsonSchemaDataActionsReuseOwnAssetFromOwnLocationDetails" }, { "type": "null" } ] }, "disabled_reasons": { "description": "Reasons why the action is disabled. Empty when the action is enabled or not applicable", "items": { "$ref": "#/components/schemas/ItAssetsAssetIdUnarchivePostResponsesContentApplicationJsonSchemaDataActionsReuseOwnAssetFromOwnLocationDisabledReasonsItems" }, "type": "array" }, "status": { "$ref": "#/components/schemas/ItAssetsAssetIdUnarchivePostResponsesContentApplicationJsonSchemaDataActionsReuseOwnAssetFromOwnLocationStatus", "description": "Whether the action is currently available for this asset" } }, "required": [ "status", "details", "disabled_reasons" ], "title": "ItAssetsAssetIdUnarchivePostResponsesContentApplicationJsonSchemaDataActionsReuseOwnAssetFromOwnLocation", "type": "object" }, "ItAssetsAssetIdUnarchivePostResponsesContentApplicationJsonSchemaDataActionsReuseOwnAssetFromOwnLocationDetails": { "description": "Action-specific context needed to perform the action. Populated for enabled and\ndisabled actions (so callers can see what a successful attempt would look like);\nnull when the action is not applicable to this asset.", "properties": { "eligible_countries": { "description": "Countries where the asset can be redeployed from an organization-owned location", "items": { "$ref": "#/components/schemas/ItAssetsAssetIdUnarchivePostResponsesContentApplicationJsonSchemaDataActionsReuseOwnAssetFromOwnLocationDetailsEligibleCountriesItems" }, "type": "array" }, "express_delivery": { "description": "Express delivery availability and per-country fees. Null when express delivery is not supported", "oneOf": [ { "$ref": "#/components/schemas/ItAssetsAssetIdUnarchivePostResponsesContentApplicationJsonSchemaDataActionsReuseOwnAssetFromOwnLocationDetailsExpressDelivery" }, { "type": "null" } ] }, "service_cost": { "$ref": "#/components/schemas/ItAssetsAssetIdUnarchivePostResponsesContentApplicationJsonSchemaDataActionsReuseOwnAssetFromOwnLocationDetailsServiceCost", "description": "Cost charged for the transfer service" } }, "required": [ "service_cost", "express_delivery", "eligible_countries" ], "title": "ItAssetsAssetIdUnarchivePostResponsesContentApplicationJsonSchemaDataActionsReuseOwnAssetFromOwnLocationDetails", "type": "object" }, "ItAssetsAssetIdUnarchivePostResponsesContentApplicationJsonSchemaDataActionsReuseOwnAssetFromOwnLocationDetailsEligibleCountriesItems": { "enum": [ "AD", "AE", "AF", "AG", "AI", "AL", "AM", "AN", "AO", "AQ", "AR", "AS", "AT", "AU", "AW", "AX", "AZ", "BA", "BB", "BD", "BE", "BF", "BG", "BH", "BI", "BJ", "BL", "BM", "BN", "BO", "BQ", "BR", "BS", "BT", "BV", "BW", "BY", "BZ", "CA", "CC", "CD", "CF", "CG", "CH", "CI", "CK", "CL", "CM", "CN", "CO", "CR", "CU", "CV", "CW", "CX", "CY", "CZ", "DE", "DJ", "DK", "DM", "DO", "DZ", "EC", "EE", "EG", "EH", "ER", "ES", "ET", "FI", "FJ", "FK", "FM", "FO", "FR", "GA", "GB", "GD", "GE", "GF", "GG", "GH", "GI", "GL", "GM", "GN", "GP", "GQ", "GR", "GS", "GT", "GU", "GW", "GY", "HK", "HM", "HN", "HR", "HT", "HU", "IC", "ID", "IE", "IL", "IM", "IN", "IO", "IQ", "IR", "IS", "IT", "JE", "JM", "JO", "JP", "KE", "KG", "KH", "KI", "KM", "KN", "KP", "KR", "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", "XK", "YE", "YT", "ZA", "ZM", "ZW" ], "title": "ItAssetsAssetIdUnarchivePostResponsesContentApplicationJsonSchemaDataActionsReuseOwnAssetFromOwnLocationDetailsEligibleCountriesItems", "type": "string" }, "ItAssetsAssetIdUnarchivePostResponsesContentApplicationJsonSchemaDataActionsReuseOwnAssetFromOwnLocationDetailsExpressDelivery": { "description": "Express delivery availability and per-country fees. Null when express delivery is not supported", "properties": { "country_fees": { "additionalProperties": { "$ref": "#/components/schemas/ItAssetsAssetIdUnarchivePostResponsesContentApplicationJsonSchemaDataActionsReuseOwnAssetFromOwnLocationDetailsExpressDeliveryCountryFees" }, "description": "Express delivery fees keyed by destination country.", "type": "object" } }, "required": [ "country_fees" ], "title": "ItAssetsAssetIdUnarchivePostResponsesContentApplicationJsonSchemaDataActionsReuseOwnAssetFromOwnLocationDetailsExpressDelivery", "type": "object" }, "ItAssetsAssetIdUnarchivePostResponsesContentApplicationJsonSchemaDataActionsReuseOwnAssetFromOwnLocationDetailsExpressDeliveryCountryFees": { "properties": { "amount": { "description": "Amount", "format": "decimal", "type": "string" }, "currency": { "$ref": "#/components/schemas/ItAssetsAssetIdUnarchivePostResponsesContentApplicationJsonSchemaDataActionsReuseOwnAssetFromOwnLocationDetailsExpressDeliveryCountryFeesCurrency", "description": "Three-letter currency code for the price" } }, "required": [ "amount", "currency" ], "title": "ItAssetsAssetIdUnarchivePostResponsesContentApplicationJsonSchemaDataActionsReuseOwnAssetFromOwnLocationDetailsExpressDeliveryCountryFees", "type": "object" }, "ItAssetsAssetIdUnarchivePostResponsesContentApplicationJsonSchemaDataActionsReuseOwnAssetFromOwnLocationDetailsExpressDeliveryCountryFeesCurrency": { "description": "Three-letter currency code for the price", "enum": [ "AED", "AFN", "ALL", "AMD", "ANG", "AOA", "ARS", "AUD", "AWG", "AZN", "BAM", "BDT", "BGN", "BHD", "BIF", "BMD", "BOB", "BRL", "BSD", "BTN", "BWP", "BYN", "BZD", "CAD", "CDF", "CHF", "CLP", "CNY", "COP", "CRC", "CUC", "CVE", "CZK", "DJF", "DKK", "DOP", "DZD", "EGP", "ERN", "ETB", "EUR", "FJD", "FKP", "GBP", "GEL", "GHS", "GIP", "GMD", "GNF", "GTQ", "GYD", "HKD", "HNL", "HRK", "HTG", "HUF", "IDR", "ILS", "INR", "IQD", "IRR", "ISK", "JMD", "JOD", "JPY", "KES", "KGS", "KHR", "KMF", "KPW", "KRW", "KWD", "KYD", "KZT", "LAK", "LBP", "LKR", "LRD", "LSL", "LTL", "LYD", "MAD", "MDL", "MGA", "MKD", "MMK", "MNT", "MRU", "MUR", "MVR", "MWK", "MXN", "MYR", "MZN", "NAD", "NGN", "NIO", "NOK", "NPR", "NZD", "OMR", "PAB", "PEN", "PGK", "PHP", "PKR", "PLN", "PYG", "QAR", "RON", "RSD", "RUB", "RWF", "SAR", "SBD", "SCR", "SDG", "SEK", "SGD", "SHP", "SLL", "SOS", "SRD", "SSP", "STD", "SYP", "SZL", "THB", "TJS", "TMT", "TND", "TOP", "TRY", "TTD", "TWD", "TZS", "UAH", "UGX", "USD", "UYU", "UZS", "VEF", "VND", "VUV", "WST", "XAF", "XCD", "XOF", "XPF", "YER", "ZAR", "ZMW", "ZWD" ], "title": "ItAssetsAssetIdUnarchivePostResponsesContentApplicationJsonSchemaDataActionsReuseOwnAssetFromOwnLocationDetailsExpressDeliveryCountryFeesCurrency", "type": "string" }, "ItAssetsAssetIdUnarchivePostResponsesContentApplicationJsonSchemaDataActionsReuseOwnAssetFromOwnLocationDetailsServiceCost": { "description": "Cost charged for the transfer service", "properties": { "billing_method": { "$ref": "#/components/schemas/ItAssetsAssetIdUnarchivePostResponsesContentApplicationJsonSchemaDataActionsReuseOwnAssetFromOwnLocationDetailsServiceCostBillingMethod", "description": "How the action is charged. When \"TOKEN\", the fees are covered by an\nadd-on token pool; when \"CURRENCY\", the fees are billed in the currency\nspecified in the \"fees\" field." }, "fees": { "description": "Price charged for the action. Null when billing method is \"TOKEN\"", "oneOf": [ { "$ref": "#/components/schemas/ItAssetsAssetIdUnarchivePostResponsesContentApplicationJsonSchemaDataActionsReuseOwnAssetFromOwnLocationDetailsServiceCostFees" }, { "type": "null" } ] }, "token_usage": { "description": "Add-on token consumption details. Null when billing method is \"CURRENCY\"", "oneOf": [ { "$ref": "#/components/schemas/ItAssetsAssetIdUnarchivePostResponsesContentApplicationJsonSchemaDataActionsReuseOwnAssetFromOwnLocationDetailsServiceCostTokenUsage" }, { "type": "null" } ] } }, "required": [ "fees", "token_usage", "billing_method" ], "title": "ItAssetsAssetIdUnarchivePostResponsesContentApplicationJsonSchemaDataActionsReuseOwnAssetFromOwnLocationDetailsServiceCost", "type": "object" }, "ItAssetsAssetIdUnarchivePostResponsesContentApplicationJsonSchemaDataActionsReuseOwnAssetFromOwnLocationDetailsServiceCostBillingMethod": { "description": "How the action is charged. When \"TOKEN\", the fees are covered by an\nadd-on token pool; when \"CURRENCY\", the fees are billed in the currency\nspecified in the \"fees\" field.", "enum": [ "CURRENCY", "TOKEN" ], "title": "ItAssetsAssetIdUnarchivePostResponsesContentApplicationJsonSchemaDataActionsReuseOwnAssetFromOwnLocationDetailsServiceCostBillingMethod", "type": "string" }, "ItAssetsAssetIdUnarchivePostResponsesContentApplicationJsonSchemaDataActionsReuseOwnAssetFromOwnLocationDetailsServiceCostFees": { "description": "Price charged for the action. Null when billing method is \"TOKEN\"", "properties": { "amount": { "description": "Amount", "format": "decimal", "type": "string" }, "currency": { "$ref": "#/components/schemas/ItAssetsAssetIdUnarchivePostResponsesContentApplicationJsonSchemaDataActionsReuseOwnAssetFromOwnLocationDetailsServiceCostFeesCurrency", "description": "Three-letter currency code for the price" } }, "required": [ "amount", "currency" ], "title": "ItAssetsAssetIdUnarchivePostResponsesContentApplicationJsonSchemaDataActionsReuseOwnAssetFromOwnLocationDetailsServiceCostFees", "type": "object" }, "ItAssetsAssetIdUnarchivePostResponsesContentApplicationJsonSchemaDataActionsReuseOwnAssetFromOwnLocationDetailsServiceCostFeesCurrency": { "description": "Three-letter currency code for the price", "enum": [ "AED", "AFN", "ALL", "AMD", "ANG", "AOA", "ARS", "AUD", "AWG", "AZN", "BAM", "BDT", "BGN", "BHD", "BIF", "BMD", "BOB", "BRL", "BSD", "BTN", "BWP", "BYN", "BZD", "CAD", "CDF", "CHF", "CLP", "CNY", "COP", "CRC", "CUC", "CVE", "CZK", "DJF", "DKK", "DOP", "DZD", "EGP", "ERN", "ETB", "EUR", "FJD", "FKP", "GBP", "GEL", "GHS", "GIP", "GMD", "GNF", "GTQ", "GYD", "HKD", "HNL", "HRK", "HTG", "HUF", "IDR", "ILS", "INR", "IQD", "IRR", "ISK", "JMD", "JOD", "JPY", "KES", "KGS", "KHR", "KMF", "KPW", "KRW", "KWD", "KYD", "KZT", "LAK", "LBP", "LKR", "LRD", "LSL", "LTL", "LYD", "MAD", "MDL", "MGA", "MKD", "MMK", "MNT", "MRU", "MUR", "MVR", "MWK", "MXN", "MYR", "MZN", "NAD", "NGN", "NIO", "NOK", "NPR", "NZD", "OMR", "PAB", "PEN", "PGK", "PHP", "PKR", "PLN", "PYG", "QAR", "RON", "RSD", "RUB", "RWF", "SAR", "SBD", "SCR", "SDG", "SEK", "SGD", "SHP", "SLL", "SOS", "SRD", "SSP", "STD", "SYP", "SZL", "THB", "TJS", "TMT", "TND", "TOP", "TRY", "TTD", "TWD", "TZS", "UAH", "UGX", "USD", "UYU", "UZS", "VEF", "VND", "VUV", "WST", "XAF", "XCD", "XOF", "XPF", "YER", "ZAR", "ZMW", "ZWD" ], "title": "ItAssetsAssetIdUnarchivePostResponsesContentApplicationJsonSchemaDataActionsReuseOwnAssetFromOwnLocationDetailsServiceCostFeesCurrency", "type": "string" }, "ItAssetsAssetIdUnarchivePostResponsesContentApplicationJsonSchemaDataActionsReuseOwnAssetFromOwnLocationDetailsServiceCostTokenUsage": { "description": "Add-on token consumption details. Null when billing method is \"CURRENCY\"", "properties": { "addon": { "$ref": "#/components/schemas/ItAssetsAssetIdUnarchivePostResponsesContentApplicationJsonSchemaDataActionsReuseOwnAssetFromOwnLocationDetailsServiceCostTokenUsageAddon", "description": "The add-on that provides the tokens" }, "cost": { "description": "Number of tokens consumed by the action. Zero when the add-on covers the\nservice without drawing from a token pool", "format": "decimal", "type": "string" }, "tokens_left": { "description": "Number of tokens left in the pool after the action is performed. Null when\nthe add-on covers the service without a token pool", "format": "decimal", "type": [ "string", "null" ] } }, "required": [ "cost", "addon", "tokens_left" ], "title": "ItAssetsAssetIdUnarchivePostResponsesContentApplicationJsonSchemaDataActionsReuseOwnAssetFromOwnLocationDetailsServiceCostTokenUsage", "type": "object" }, "ItAssetsAssetIdUnarchivePostResponsesContentApplicationJsonSchemaDataActionsReuseOwnAssetFromOwnLocationDetailsServiceCostTokenUsageAddon": { "description": "The add-on that provides the tokens", "properties": { "id": { "description": "ID of the add-on", "format": "uuid", "type": "string" }, "name": { "description": "Public display name of the add-on", "type": "string" } }, "required": [ "id", "name" ], "title": "ItAssetsAssetIdUnarchivePostResponsesContentApplicationJsonSchemaDataActionsReuseOwnAssetFromOwnLocationDetailsServiceCostTokenUsageAddon", "type": "object" }, "ItAssetsAssetIdUnarchivePostResponsesContentApplicationJsonSchemaDataActionsReuseOwnAssetFromOwnLocationDisabledReasonsItems": { "enum": [ "ARCHIVED", "AT_DEEL_WAREHOUSE", "BEING_REPAIRED", "CONSUMABLE", "CONTROLLED_BY_DEEL", "COUNTRY_NOT_SUPPORTED_FOR_HUB", "COUNTRY_NOT_SUPPORTED_FOR_LOCAL", "DEEL_OWNED_ITEM_WITHOUT_RENTAL_CONTRACT", "DESKTOP_STORAGE", "ENDING_CONTRACT", "HUB_IN_SAME_REGION_AS_LOCAL", "INACTIVE", "INVALID_ITEM_LOCATION", "INVALID_ORGANIZATION_STATUS", "INVALID_STATE", "ITEM_CONDITIONS_TO_UNARCHIVE_NOT_MET", "ITEM_NOT_VISIBLE_FOR_ORGANIZATION", "NON_DEVICE", "NOT_AT_WAREHOUSE", "NOT_AVAILABLE_FOR_REUSE", "NOT_A_RENTAL", "NOT_MANAGEABLE_BY_ORGANIZATION", "NOT_WITH_ASSIGNMENT", "NOT_WITH_USER", "NO_ACTIVE_ADDONS", "NO_ACTIVE_STORAGE_CONTRACT", "NO_LOCATION_FOR_STORAGE", "NO_LOGISTICS_FOR_STORAGE", "NO_VALID_ADDONS", "ONGOING_SERVICE", "OWNED_BY_DEEL", "OWNED_BY_ORGANIZATION", "OWNED_BY_PARTNER_ORGANIZATION", "PARTNER_CHILD_CONTRACT", "PENDING_DEVICE_REFRESH", "RENTAL_CONTRACT_AND_USER_REGION_DO_NOT_MATCH", "TEMPORARILY_UNAVAILABLE", "UNKNOWN", "USER_HAS_NO_COUNTRY", "USER_HAS_NO_SEAT", "WAITING_FOR_CLEARANCE", "WITH_LOANER_ASSIGNMENT", "WITH_NON_COLLECTED_ASSIGNMENT", "WITH_NON_DELIVERED_ASSIGNMENT", "WITH_PENDING_ASSIGNMENT", "WRONG_ASSIGNMENT_STATUS", "WRONG_CONTRACT_STATUS", "WRONG_TERMS_AND_CONDITIONS" ], "title": "ItAssetsAssetIdUnarchivePostResponsesContentApplicationJsonSchemaDataActionsReuseOwnAssetFromOwnLocationDisabledReasonsItems", "type": "string" }, "ItAssetsAssetIdUnarchivePostResponsesContentApplicationJsonSchemaDataActionsReuseOwnAssetFromOwnLocationStatus": { "description": "Whether the action is currently available for this asset", "enum": [ "DISABLED", "ENABLED", "NOT_APPLICABLE" ], "title": "ItAssetsAssetIdUnarchivePostResponsesContentApplicationJsonSchemaDataActionsReuseOwnAssetFromOwnLocationStatus", "type": "string" }, "ItAssetsAssetIdUnarchivePostResponsesContentApplicationJsonSchemaDataActionsStoreOwnAssetAtDeelForHub": { "description": "Store an organization-owned asset at a Deel hub warehouse", "properties": { "details": { "description": "Action-specific context needed to perform the action. Populated for enabled and\ndisabled actions (so callers can see what a successful attempt would look like);\nnull when the action is not applicable to this asset.", "oneOf": [ { "$ref": "#/components/schemas/ItAssetsAssetIdUnarchivePostResponsesContentApplicationJsonSchemaDataActionsStoreOwnAssetAtDeelForHubDetails" }, { "type": "null" } ] }, "disabled_reasons": { "description": "Reasons why the action is disabled. Empty when the action is enabled or not applicable", "items": { "$ref": "#/components/schemas/ItAssetsAssetIdUnarchivePostResponsesContentApplicationJsonSchemaDataActionsStoreOwnAssetAtDeelForHubDisabledReasonsItems" }, "type": "array" }, "status": { "$ref": "#/components/schemas/ItAssetsAssetIdUnarchivePostResponsesContentApplicationJsonSchemaDataActionsStoreOwnAssetAtDeelForHubStatus", "description": "Whether the action is currently available for this asset" } }, "required": [ "status", "details", "disabled_reasons" ], "title": "ItAssetsAssetIdUnarchivePostResponsesContentApplicationJsonSchemaDataActionsStoreOwnAssetAtDeelForHub", "type": "object" }, "ItAssetsAssetIdUnarchivePostResponsesContentApplicationJsonSchemaDataActionsStoreOwnAssetAtDeelForHubDetails": { "description": "Action-specific context needed to perform the action. Populated for enabled and\ndisabled actions (so callers can see what a successful attempt would look like);\nnull when the action is not applicable to this asset.", "properties": { "activation_cost": { "$ref": "#/components/schemas/ItAssetsAssetIdUnarchivePostResponsesContentApplicationJsonSchemaDataActionsStoreOwnAssetAtDeelForHubDetailsActivationCost", "description": "Cost charged to activate storage" }, "destination_country": { "$ref": "#/components/schemas/ItAssetsAssetIdUnarchivePostResponsesContentApplicationJsonSchemaDataActionsStoreOwnAssetAtDeelForHubDetailsDestinationCountry", "description": "ISO 3166-1 alpha-2 country of the Deel warehouse the asset will be shipped to" }, "grace_period_in_months": { "description": "Grace period in months during which storage is free before monthly fees apply", "format": "int64", "type": "integer" }, "monthly_fee": { "$ref": "#/components/schemas/ItAssetsAssetIdUnarchivePostResponsesContentApplicationJsonSchemaDataActionsStoreOwnAssetAtDeelForHubDetailsMonthlyFee", "description": "Monthly storage fee charged after the grace period" } }, "required": [ "monthly_fee", "activation_cost", "destination_country", "grace_period_in_months" ], "title": "ItAssetsAssetIdUnarchivePostResponsesContentApplicationJsonSchemaDataActionsStoreOwnAssetAtDeelForHubDetails", "type": "object" }, "ItAssetsAssetIdUnarchivePostResponsesContentApplicationJsonSchemaDataActionsStoreOwnAssetAtDeelForHubDetailsActivationCost": { "description": "Cost charged to activate storage", "properties": { "billing_method": { "$ref": "#/components/schemas/ItAssetsAssetIdUnarchivePostResponsesContentApplicationJsonSchemaDataActionsStoreOwnAssetAtDeelForHubDetailsActivationCostBillingMethod", "description": "How the action is charged. When \"TOKEN\", the fees are covered by an\nadd-on token pool; when \"CURRENCY\", the fees are billed in the currency\nspecified in the \"fees\" field." }, "fees": { "description": "Price charged for the action. Null when billing method is \"TOKEN\"", "oneOf": [ { "$ref": "#/components/schemas/ItAssetsAssetIdUnarchivePostResponsesContentApplicationJsonSchemaDataActionsStoreOwnAssetAtDeelForHubDetailsActivationCostFees" }, { "type": "null" } ] }, "token_usage": { "description": "Add-on token consumption details. Null when billing method is \"CURRENCY\"", "oneOf": [ { "$ref": "#/components/schemas/ItAssetsAssetIdUnarchivePostResponsesContentApplicationJsonSchemaDataActionsStoreOwnAssetAtDeelForHubDetailsActivationCostTokenUsage" }, { "type": "null" } ] } }, "required": [ "fees", "token_usage", "billing_method" ], "title": "ItAssetsAssetIdUnarchivePostResponsesContentApplicationJsonSchemaDataActionsStoreOwnAssetAtDeelForHubDetailsActivationCost", "type": "object" }, "ItAssetsAssetIdUnarchivePostResponsesContentApplicationJsonSchemaDataActionsStoreOwnAssetAtDeelForHubDetailsActivationCostBillingMethod": { "description": "How the action is charged. When \"TOKEN\", the fees are covered by an\nadd-on token pool; when \"CURRENCY\", the fees are billed in the currency\nspecified in the \"fees\" field.", "enum": [ "CURRENCY", "TOKEN" ], "title": "ItAssetsAssetIdUnarchivePostResponsesContentApplicationJsonSchemaDataActionsStoreOwnAssetAtDeelForHubDetailsActivationCostBillingMethod", "type": "string" }, "ItAssetsAssetIdUnarchivePostResponsesContentApplicationJsonSchemaDataActionsStoreOwnAssetAtDeelForHubDetailsActivationCostFees": { "description": "Price charged for the action. Null when billing method is \"TOKEN\"", "properties": { "amount": { "description": "Amount", "format": "decimal", "type": "string" }, "currency": { "$ref": "#/components/schemas/ItAssetsAssetIdUnarchivePostResponsesContentApplicationJsonSchemaDataActionsStoreOwnAssetAtDeelForHubDetailsActivationCostFeesCurrency", "description": "Three-letter currency code for the price" } }, "required": [ "amount", "currency" ], "title": "ItAssetsAssetIdUnarchivePostResponsesContentApplicationJsonSchemaDataActionsStoreOwnAssetAtDeelForHubDetailsActivationCostFees", "type": "object" }, "ItAssetsAssetIdUnarchivePostResponsesContentApplicationJsonSchemaDataActionsStoreOwnAssetAtDeelForHubDetailsActivationCostFeesCurrency": { "description": "Three-letter currency code for the price", "enum": [ "AED", "AFN", "ALL", "AMD", "ANG", "AOA", "ARS", "AUD", "AWG", "AZN", "BAM", "BDT", "BGN", "BHD", "BIF", "BMD", "BOB", "BRL", "BSD", "BTN", "BWP", "BYN", "BZD", "CAD", "CDF", "CHF", "CLP", "CNY", "COP", "CRC", "CUC", "CVE", "CZK", "DJF", "DKK", "DOP", "DZD", "EGP", "ERN", "ETB", "EUR", "FJD", "FKP", "GBP", "GEL", "GHS", "GIP", "GMD", "GNF", "GTQ", "GYD", "HKD", "HNL", "HRK", "HTG", "HUF", "IDR", "ILS", "INR", "IQD", "IRR", "ISK", "JMD", "JOD", "JPY", "KES", "KGS", "KHR", "KMF", "KPW", "KRW", "KWD", "KYD", "KZT", "LAK", "LBP", "LKR", "LRD", "LSL", "LTL", "LYD", "MAD", "MDL", "MGA", "MKD", "MMK", "MNT", "MRU", "MUR", "MVR", "MWK", "MXN", "MYR", "MZN", "NAD", "NGN", "NIO", "NOK", "NPR", "NZD", "OMR", "PAB", "PEN", "PGK", "PHP", "PKR", "PLN", "PYG", "QAR", "RON", "RSD", "RUB", "RWF", "SAR", "SBD", "SCR", "SDG", "SEK", "SGD", "SHP", "SLL", "SOS", "SRD", "SSP", "STD", "SYP", "SZL", "THB", "TJS", "TMT", "TND", "TOP", "TRY", "TTD", "TWD", "TZS", "UAH", "UGX", "USD", "UYU", "UZS", "VEF", "VND", "VUV", "WST", "XAF", "XCD", "XOF", "XPF", "YER", "ZAR", "ZMW", "ZWD" ], "title": "ItAssetsAssetIdUnarchivePostResponsesContentApplicationJsonSchemaDataActionsStoreOwnAssetAtDeelForHubDetailsActivationCostFeesCurrency", "type": "string" }, "ItAssetsAssetIdUnarchivePostResponsesContentApplicationJsonSchemaDataActionsStoreOwnAssetAtDeelForHubDetailsActivationCostTokenUsage": { "description": "Add-on token consumption details. Null when billing method is \"CURRENCY\"", "properties": { "addon": { "$ref": "#/components/schemas/ItAssetsAssetIdUnarchivePostResponsesContentApplicationJsonSchemaDataActionsStoreOwnAssetAtDeelForHubDetailsActivationCostTokenUsageAddon", "description": "The add-on that provides the tokens" }, "cost": { "description": "Number of tokens consumed by the action. Zero when the add-on covers the\nservice without drawing from a token pool", "format": "decimal", "type": "string" }, "tokens_left": { "description": "Number of tokens left in the pool after the action is performed. Null when\nthe add-on covers the service without a token pool", "format": "decimal", "type": [ "string", "null" ] } }, "required": [ "cost", "addon", "tokens_left" ], "title": "ItAssetsAssetIdUnarchivePostResponsesContentApplicationJsonSchemaDataActionsStoreOwnAssetAtDeelForHubDetailsActivationCostTokenUsage", "type": "object" }, "ItAssetsAssetIdUnarchivePostResponsesContentApplicationJsonSchemaDataActionsStoreOwnAssetAtDeelForHubDetailsActivationCostTokenUsageAddon": { "description": "The add-on that provides the tokens", "properties": { "id": { "description": "ID of the add-on", "format": "uuid", "type": "string" }, "name": { "description": "Public display name of the add-on", "type": "string" } }, "required": [ "id", "name" ], "title": "ItAssetsAssetIdUnarchivePostResponsesContentApplicationJsonSchemaDataActionsStoreOwnAssetAtDeelForHubDetailsActivationCostTokenUsageAddon", "type": "object" }, "ItAssetsAssetIdUnarchivePostResponsesContentApplicationJsonSchemaDataActionsStoreOwnAssetAtDeelForHubDetailsDestinationCountry": { "description": "ISO 3166-1 alpha-2 country of the Deel warehouse the asset will be shipped to", "enum": [ "AD", "AE", "AF", "AG", "AI", "AL", "AM", "AN", "AO", "AQ", "AR", "AS", "AT", "AU", "AW", "AX", "AZ", "BA", "BB", "BD", "BE", "BF", "BG", "BH", "BI", "BJ", "BL", "BM", "BN", "BO", "BQ", "BR", "BS", "BT", "BV", "BW", "BY", "BZ", "CA", "CC", "CD", "CF", "CG", "CH", "CI", "CK", "CL", "CM", "CN", "CO", "CR", "CU", "CV", "CW", "CX", "CY", "CZ", "DE", "DJ", "DK", "DM", "DO", "DZ", "EC", "EE", "EG", "EH", "ER", "ES", "ET", "FI", "FJ", "FK", "FM", "FO", "FR", "GA", "GB", "GD", "GE", "GF", "GG", "GH", "GI", "GL", "GM", "GN", "GP", "GQ", "GR", "GS", "GT", "GU", "GW", "GY", "HK", "HM", "HN", "HR", "HT", "HU", "IC", "ID", "IE", "IL", "IM", "IN", "IO", "IQ", "IR", "IS", "IT", "JE", "JM", "JO", "JP", "KE", "KG", "KH", "KI", "KM", "KN", "KP", "KR", "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", "XK", "YE", "YT", "ZA", "ZM", "ZW" ], "title": "ItAssetsAssetIdUnarchivePostResponsesContentApplicationJsonSchemaDataActionsStoreOwnAssetAtDeelForHubDetailsDestinationCountry", "type": "string" }, "ItAssetsAssetIdUnarchivePostResponsesContentApplicationJsonSchemaDataActionsStoreOwnAssetAtDeelForHubDetailsMonthlyFee": { "description": "Monthly storage fee charged after the grace period", "properties": { "amount": { "description": "Amount", "format": "decimal", "type": "string" }, "currency": { "$ref": "#/components/schemas/ItAssetsAssetIdUnarchivePostResponsesContentApplicationJsonSchemaDataActionsStoreOwnAssetAtDeelForHubDetailsMonthlyFeeCurrency", "description": "Three-letter currency code for the price" } }, "required": [ "amount", "currency" ], "title": "ItAssetsAssetIdUnarchivePostResponsesContentApplicationJsonSchemaDataActionsStoreOwnAssetAtDeelForHubDetailsMonthlyFee", "type": "object" }, "ItAssetsAssetIdUnarchivePostResponsesContentApplicationJsonSchemaDataActionsStoreOwnAssetAtDeelForHubDetailsMonthlyFeeCurrency": { "description": "Three-letter currency code for the price", "enum": [ "AED", "AFN", "ALL", "AMD", "ANG", "AOA", "ARS", "AUD", "AWG", "AZN", "BAM", "BDT", "BGN", "BHD", "BIF", "BMD", "BOB", "BRL", "BSD", "BTN", "BWP", "BYN", "BZD", "CAD", "CDF", "CHF", "CLP", "CNY", "COP", "CRC", "CUC", "CVE", "CZK", "DJF", "DKK", "DOP", "DZD", "EGP", "ERN", "ETB", "EUR", "FJD", "FKP", "GBP", "GEL", "GHS", "GIP", "GMD", "GNF", "GTQ", "GYD", "HKD", "HNL", "HRK", "HTG", "HUF", "IDR", "ILS", "INR", "IQD", "IRR", "ISK", "JMD", "JOD", "JPY", "KES", "KGS", "KHR", "KMF", "KPW", "KRW", "KWD", "KYD", "KZT", "LAK", "LBP", "LKR", "LRD", "LSL", "LTL", "LYD", "MAD", "MDL", "MGA", "MKD", "MMK", "MNT", "MRU", "MUR", "MVR", "MWK", "MXN", "MYR", "MZN", "NAD", "NGN", "NIO", "NOK", "NPR", "NZD", "OMR", "PAB", "PEN", "PGK", "PHP", "PKR", "PLN", "PYG", "QAR", "RON", "RSD", "RUB", "RWF", "SAR", "SBD", "SCR", "SDG", "SEK", "SGD", "SHP", "SLL", "SOS", "SRD", "SSP", "STD", "SYP", "SZL", "THB", "TJS", "TMT", "TND", "TOP", "TRY", "TTD", "TWD", "TZS", "UAH", "UGX", "USD", "UYU", "UZS", "VEF", "VND", "VUV", "WST", "XAF", "XCD", "XOF", "XPF", "YER", "ZAR", "ZMW", "ZWD" ], "title": "ItAssetsAssetIdUnarchivePostResponsesContentApplicationJsonSchemaDataActionsStoreOwnAssetAtDeelForHubDetailsMonthlyFeeCurrency", "type": "string" }, "ItAssetsAssetIdUnarchivePostResponsesContentApplicationJsonSchemaDataActionsStoreOwnAssetAtDeelForHubDisabledReasonsItems": { "enum": [ "ARCHIVED", "AT_DEEL_WAREHOUSE", "BEING_REPAIRED", "CONSUMABLE", "CONTROLLED_BY_DEEL", "COUNTRY_NOT_SUPPORTED_FOR_HUB", "COUNTRY_NOT_SUPPORTED_FOR_LOCAL", "DEEL_OWNED_ITEM_WITHOUT_RENTAL_CONTRACT", "DESKTOP_STORAGE", "ENDING_CONTRACT", "HUB_IN_SAME_REGION_AS_LOCAL", "INACTIVE", "INVALID_ITEM_LOCATION", "INVALID_ORGANIZATION_STATUS", "INVALID_STATE", "ITEM_CONDITIONS_TO_UNARCHIVE_NOT_MET", "ITEM_NOT_VISIBLE_FOR_ORGANIZATION", "NON_DEVICE", "NOT_AT_WAREHOUSE", "NOT_AVAILABLE_FOR_REUSE", "NOT_A_RENTAL", "NOT_MANAGEABLE_BY_ORGANIZATION", "NOT_WITH_ASSIGNMENT", "NOT_WITH_USER", "NO_ACTIVE_ADDONS", "NO_ACTIVE_STORAGE_CONTRACT", "NO_LOCATION_FOR_STORAGE", "NO_LOGISTICS_FOR_STORAGE", "NO_VALID_ADDONS", "ONGOING_SERVICE", "OWNED_BY_DEEL", "OWNED_BY_ORGANIZATION", "OWNED_BY_PARTNER_ORGANIZATION", "PARTNER_CHILD_CONTRACT", "PENDING_DEVICE_REFRESH", "RENTAL_CONTRACT_AND_USER_REGION_DO_NOT_MATCH", "TEMPORARILY_UNAVAILABLE", "UNKNOWN", "USER_HAS_NO_COUNTRY", "USER_HAS_NO_SEAT", "WAITING_FOR_CLEARANCE", "WITH_LOANER_ASSIGNMENT", "WITH_NON_COLLECTED_ASSIGNMENT", "WITH_NON_DELIVERED_ASSIGNMENT", "WITH_PENDING_ASSIGNMENT", "WRONG_ASSIGNMENT_STATUS", "WRONG_CONTRACT_STATUS", "WRONG_TERMS_AND_CONDITIONS" ], "title": "ItAssetsAssetIdUnarchivePostResponsesContentApplicationJsonSchemaDataActionsStoreOwnAssetAtDeelForHubDisabledReasonsItems", "type": "string" }, "ItAssetsAssetIdUnarchivePostResponsesContentApplicationJsonSchemaDataActionsStoreOwnAssetAtDeelForHubStatus": { "description": "Whether the action is currently available for this asset", "enum": [ "DISABLED", "ENABLED", "NOT_APPLICABLE" ], "title": "ItAssetsAssetIdUnarchivePostResponsesContentApplicationJsonSchemaDataActionsStoreOwnAssetAtDeelForHubStatus", "type": "string" }, "ItAssetsAssetIdUnarchivePostResponsesContentApplicationJsonSchemaDataActionsStoreOwnAssetAtDeelForLocal": { "description": "Store an organization-owned asset at a Deel local warehouse", "properties": { "details": { "description": "Action-specific context needed to perform the action. Populated for enabled and\ndisabled actions (so callers can see what a successful attempt would look like);\nnull when the action is not applicable to this asset.", "oneOf": [ { "$ref": "#/components/schemas/ItAssetsAssetIdUnarchivePostResponsesContentApplicationJsonSchemaDataActionsStoreOwnAssetAtDeelForLocalDetails" }, { "type": "null" } ] }, "disabled_reasons": { "description": "Reasons why the action is disabled. Empty when the action is enabled or not applicable", "items": { "$ref": "#/components/schemas/ItAssetsAssetIdUnarchivePostResponsesContentApplicationJsonSchemaDataActionsStoreOwnAssetAtDeelForLocalDisabledReasonsItems" }, "type": "array" }, "status": { "$ref": "#/components/schemas/ItAssetsAssetIdUnarchivePostResponsesContentApplicationJsonSchemaDataActionsStoreOwnAssetAtDeelForLocalStatus", "description": "Whether the action is currently available for this asset" } }, "required": [ "status", "details", "disabled_reasons" ], "title": "ItAssetsAssetIdUnarchivePostResponsesContentApplicationJsonSchemaDataActionsStoreOwnAssetAtDeelForLocal", "type": "object" }, "ItAssetsAssetIdUnarchivePostResponsesContentApplicationJsonSchemaDataActionsStoreOwnAssetAtDeelForLocalDetails": { "description": "Action-specific context needed to perform the action. Populated for enabled and\ndisabled actions (so callers can see what a successful attempt would look like);\nnull when the action is not applicable to this asset.", "properties": { "activation_cost": { "$ref": "#/components/schemas/ItAssetsAssetIdUnarchivePostResponsesContentApplicationJsonSchemaDataActionsStoreOwnAssetAtDeelForLocalDetailsActivationCost", "description": "Cost charged to activate storage" }, "destination_country": { "$ref": "#/components/schemas/ItAssetsAssetIdUnarchivePostResponsesContentApplicationJsonSchemaDataActionsStoreOwnAssetAtDeelForLocalDetailsDestinationCountry", "description": "ISO 3166-1 alpha-2 country of the Deel warehouse the asset will be shipped to" }, "grace_period_in_months": { "description": "Grace period in months during which storage is free before monthly fees apply", "format": "int64", "type": "integer" }, "monthly_fee": { "$ref": "#/components/schemas/ItAssetsAssetIdUnarchivePostResponsesContentApplicationJsonSchemaDataActionsStoreOwnAssetAtDeelForLocalDetailsMonthlyFee", "description": "Monthly storage fee charged after the grace period" } }, "required": [ "monthly_fee", "activation_cost", "destination_country", "grace_period_in_months" ], "title": "ItAssetsAssetIdUnarchivePostResponsesContentApplicationJsonSchemaDataActionsStoreOwnAssetAtDeelForLocalDetails", "type": "object" }, "ItAssetsAssetIdUnarchivePostResponsesContentApplicationJsonSchemaDataActionsStoreOwnAssetAtDeelForLocalDetailsActivationCost": { "description": "Cost charged to activate storage", "properties": { "billing_method": { "$ref": "#/components/schemas/ItAssetsAssetIdUnarchivePostResponsesContentApplicationJsonSchemaDataActionsStoreOwnAssetAtDeelForLocalDetailsActivationCostBillingMethod", "description": "How the action is charged. When \"TOKEN\", the fees are covered by an\nadd-on token pool; when \"CURRENCY\", the fees are billed in the currency\nspecified in the \"fees\" field." }, "fees": { "description": "Price charged for the action. Null when billing method is \"TOKEN\"", "oneOf": [ { "$ref": "#/components/schemas/ItAssetsAssetIdUnarchivePostResponsesContentApplicationJsonSchemaDataActionsStoreOwnAssetAtDeelForLocalDetailsActivationCostFees" }, { "type": "null" } ] }, "token_usage": { "description": "Add-on token consumption details. Null when billing method is \"CURRENCY\"", "oneOf": [ { "$ref": "#/components/schemas/ItAssetsAssetIdUnarchivePostResponsesContentApplicationJsonSchemaDataActionsStoreOwnAssetAtDeelForLocalDetailsActivationCostTokenUsage" }, { "type": "null" } ] } }, "required": [ "fees", "token_usage", "billing_method" ], "title": "ItAssetsAssetIdUnarchivePostResponsesContentApplicationJsonSchemaDataActionsStoreOwnAssetAtDeelForLocalDetailsActivationCost", "type": "object" }, "ItAssetsAssetIdUnarchivePostResponsesContentApplicationJsonSchemaDataActionsStoreOwnAssetAtDeelForLocalDetailsActivationCostBillingMethod": { "description": "How the action is charged. When \"TOKEN\", the fees are covered by an\nadd-on token pool; when \"CURRENCY\", the fees are billed in the currency\nspecified in the \"fees\" field.", "enum": [ "CURRENCY", "TOKEN" ], "title": "ItAssetsAssetIdUnarchivePostResponsesContentApplicationJsonSchemaDataActionsStoreOwnAssetAtDeelForLocalDetailsActivationCostBillingMethod", "type": "string" }, "ItAssetsAssetIdUnarchivePostResponsesContentApplicationJsonSchemaDataActionsStoreOwnAssetAtDeelForLocalDetailsActivationCostFees": { "description": "Price charged for the action. Null when billing method is \"TOKEN\"", "properties": { "amount": { "description": "Amount", "format": "decimal", "type": "string" }, "currency": { "$ref": "#/components/schemas/ItAssetsAssetIdUnarchivePostResponsesContentApplicationJsonSchemaDataActionsStoreOwnAssetAtDeelForLocalDetailsActivationCostFeesCurrency", "description": "Three-letter currency code for the price" } }, "required": [ "amount", "currency" ], "title": "ItAssetsAssetIdUnarchivePostResponsesContentApplicationJsonSchemaDataActionsStoreOwnAssetAtDeelForLocalDetailsActivationCostFees", "type": "object" }, "ItAssetsAssetIdUnarchivePostResponsesContentApplicationJsonSchemaDataActionsStoreOwnAssetAtDeelForLocalDetailsActivationCostFeesCurrency": { "description": "Three-letter currency code for the price", "enum": [ "AED", "AFN", "ALL", "AMD", "ANG", "AOA", "ARS", "AUD", "AWG", "AZN", "BAM", "BDT", "BGN", "BHD", "BIF", "BMD", "BOB", "BRL", "BSD", "BTN", "BWP", "BYN", "BZD", "CAD", "CDF", "CHF", "CLP", "CNY", "COP", "CRC", "CUC", "CVE", "CZK", "DJF", "DKK", "DOP", "DZD", "EGP", "ERN", "ETB", "EUR", "FJD", "FKP", "GBP", "GEL", "GHS", "GIP", "GMD", "GNF", "GTQ", "GYD", "HKD", "HNL", "HRK", "HTG", "HUF", "IDR", "ILS", "INR", "IQD", "IRR", "ISK", "JMD", "JOD", "JPY", "KES", "KGS", "KHR", "KMF", "KPW", "KRW", "KWD", "KYD", "KZT", "LAK", "LBP", "LKR", "LRD", "LSL", "LTL", "LYD", "MAD", "MDL", "MGA", "MKD", "MMK", "MNT", "MRU", "MUR", "MVR", "MWK", "MXN", "MYR", "MZN", "NAD", "NGN", "NIO", "NOK", "NPR", "NZD", "OMR", "PAB", "PEN", "PGK", "PHP", "PKR", "PLN", "PYG", "QAR", "RON", "RSD", "RUB", "RWF", "SAR", "SBD", "SCR", "SDG", "SEK", "SGD", "SHP", "SLL", "SOS", "SRD", "SSP", "STD", "SYP", "SZL", "THB", "TJS", "TMT", "TND", "TOP", "TRY", "TTD", "TWD", "TZS", "UAH", "UGX", "USD", "UYU", "UZS", "VEF", "VND", "VUV", "WST", "XAF", "XCD", "XOF", "XPF", "YER", "ZAR", "ZMW", "ZWD" ], "title": "ItAssetsAssetIdUnarchivePostResponsesContentApplicationJsonSchemaDataActionsStoreOwnAssetAtDeelForLocalDetailsActivationCostFeesCurrency", "type": "string" }, "ItAssetsAssetIdUnarchivePostResponsesContentApplicationJsonSchemaDataActionsStoreOwnAssetAtDeelForLocalDetailsActivationCostTokenUsage": { "description": "Add-on token consumption details. Null when billing method is \"CURRENCY\"", "properties": { "addon": { "$ref": "#/components/schemas/ItAssetsAssetIdUnarchivePostResponsesContentApplicationJsonSchemaDataActionsStoreOwnAssetAtDeelForLocalDetailsActivationCostTokenUsageAddon", "description": "The add-on that provides the tokens" }, "cost": { "description": "Number of tokens consumed by the action. Zero when the add-on covers the\nservice without drawing from a token pool", "format": "decimal", "type": "string" }, "tokens_left": { "description": "Number of tokens left in the pool after the action is performed. Null when\nthe add-on covers the service without a token pool", "format": "decimal", "type": [ "string", "null" ] } }, "required": [ "cost", "addon", "tokens_left" ], "title": "ItAssetsAssetIdUnarchivePostResponsesContentApplicationJsonSchemaDataActionsStoreOwnAssetAtDeelForLocalDetailsActivationCostTokenUsage", "type": "object" }, "ItAssetsAssetIdUnarchivePostResponsesContentApplicationJsonSchemaDataActionsStoreOwnAssetAtDeelForLocalDetailsActivationCostTokenUsageAddon": { "description": "The add-on that provides the tokens", "properties": { "id": { "description": "ID of the add-on", "format": "uuid", "type": "string" }, "name": { "description": "Public display name of the add-on", "type": "string" } }, "required": [ "id", "name" ], "title": "ItAssetsAssetIdUnarchivePostResponsesContentApplicationJsonSchemaDataActionsStoreOwnAssetAtDeelForLocalDetailsActivationCostTokenUsageAddon", "type": "object" }, "ItAssetsAssetIdUnarchivePostResponsesContentApplicationJsonSchemaDataActionsStoreOwnAssetAtDeelForLocalDetailsDestinationCountry": { "description": "ISO 3166-1 alpha-2 country of the Deel warehouse the asset will be shipped to", "enum": [ "AD", "AE", "AF", "AG", "AI", "AL", "AM", "AN", "AO", "AQ", "AR", "AS", "AT", "AU", "AW", "AX", "AZ", "BA", "BB", "BD", "BE", "BF", "BG", "BH", "BI", "BJ", "BL", "BM", "BN", "BO", "BQ", "BR", "BS", "BT", "BV", "BW", "BY", "BZ", "CA", "CC", "CD", "CF", "CG", "CH", "CI", "CK", "CL", "CM", "CN", "CO", "CR", "CU", "CV", "CW", "CX", "CY", "CZ", "DE", "DJ", "DK", "DM", "DO", "DZ", "EC", "EE", "EG", "EH", "ER", "ES", "ET", "FI", "FJ", "FK", "FM", "FO", "FR", "GA", "GB", "GD", "GE", "GF", "GG", "GH", "GI", "GL", "GM", "GN", "GP", "GQ", "GR", "GS", "GT", "GU", "GW", "GY", "HK", "HM", "HN", "HR", "HT", "HU", "IC", "ID", "IE", "IL", "IM", "IN", "IO", "IQ", "IR", "IS", "IT", "JE", "JM", "JO", "JP", "KE", "KG", "KH", "KI", "KM", "KN", "KP", "KR", "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", "XK", "YE", "YT", "ZA", "ZM", "ZW" ], "title": "ItAssetsAssetIdUnarchivePostResponsesContentApplicationJsonSchemaDataActionsStoreOwnAssetAtDeelForLocalDetailsDestinationCountry", "type": "string" }, "ItAssetsAssetIdUnarchivePostResponsesContentApplicationJsonSchemaDataActionsStoreOwnAssetAtDeelForLocalDetailsMonthlyFee": { "description": "Monthly storage fee charged after the grace period", "properties": { "amount": { "description": "Amount", "format": "decimal", "type": "string" }, "currency": { "$ref": "#/components/schemas/ItAssetsAssetIdUnarchivePostResponsesContentApplicationJsonSchemaDataActionsStoreOwnAssetAtDeelForLocalDetailsMonthlyFeeCurrency", "description": "Three-letter currency code for the price" } }, "required": [ "amount", "currency" ], "title": "ItAssetsAssetIdUnarchivePostResponsesContentApplicationJsonSchemaDataActionsStoreOwnAssetAtDeelForLocalDetailsMonthlyFee", "type": "object" }, "ItAssetsAssetIdUnarchivePostResponsesContentApplicationJsonSchemaDataActionsStoreOwnAssetAtDeelForLocalDetailsMonthlyFeeCurrency": { "description": "Three-letter currency code for the price", "enum": [ "AED", "AFN", "ALL", "AMD", "ANG", "AOA", "ARS", "AUD", "AWG", "AZN", "BAM", "BDT", "BGN", "BHD", "BIF", "BMD", "BOB", "BRL", "BSD", "BTN", "BWP", "BYN", "BZD", "CAD", "CDF", "CHF", "CLP", "CNY", "COP", "CRC", "CUC", "CVE", "CZK", "DJF", "DKK", "DOP", "DZD", "EGP", "ERN", "ETB", "EUR", "FJD", "FKP", "GBP", "GEL", "GHS", "GIP", "GMD", "GNF", "GTQ", "GYD", "HKD", "HNL", "HRK", "HTG", "HUF", "IDR", "ILS", "INR", "IQD", "IRR", "ISK", "JMD", "JOD", "JPY", "KES", "KGS", "KHR", "KMF", "KPW", "KRW", "KWD", "KYD", "KZT", "LAK", "LBP", "LKR", "LRD", "LSL", "LTL", "LYD", "MAD", "MDL", "MGA", "MKD", "MMK", "MNT", "MRU", "MUR", "MVR", "MWK", "MXN", "MYR", "MZN", "NAD", "NGN", "NIO", "NOK", "NPR", "NZD", "OMR", "PAB", "PEN", "PGK", "PHP", "PKR", "PLN", "PYG", "QAR", "RON", "RSD", "RUB", "RWF", "SAR", "SBD", "SCR", "SDG", "SEK", "SGD", "SHP", "SLL", "SOS", "SRD", "SSP", "STD", "SYP", "SZL", "THB", "TJS", "TMT", "TND", "TOP", "TRY", "TTD", "TWD", "TZS", "UAH", "UGX", "USD", "UYU", "UZS", "VEF", "VND", "VUV", "WST", "XAF", "XCD", "XOF", "XPF", "YER", "ZAR", "ZMW", "ZWD" ], "title": "ItAssetsAssetIdUnarchivePostResponsesContentApplicationJsonSchemaDataActionsStoreOwnAssetAtDeelForLocalDetailsMonthlyFeeCurrency", "type": "string" }, "ItAssetsAssetIdUnarchivePostResponsesContentApplicationJsonSchemaDataActionsStoreOwnAssetAtDeelForLocalDisabledReasonsItems": { "enum": [ "ARCHIVED", "AT_DEEL_WAREHOUSE", "BEING_REPAIRED", "CONSUMABLE", "CONTROLLED_BY_DEEL", "COUNTRY_NOT_SUPPORTED_FOR_HUB", "COUNTRY_NOT_SUPPORTED_FOR_LOCAL", "DEEL_OWNED_ITEM_WITHOUT_RENTAL_CONTRACT", "DESKTOP_STORAGE", "ENDING_CONTRACT", "HUB_IN_SAME_REGION_AS_LOCAL", "INACTIVE", "INVALID_ITEM_LOCATION", "INVALID_ORGANIZATION_STATUS", "INVALID_STATE", "ITEM_CONDITIONS_TO_UNARCHIVE_NOT_MET", "ITEM_NOT_VISIBLE_FOR_ORGANIZATION", "NON_DEVICE", "NOT_AT_WAREHOUSE", "NOT_AVAILABLE_FOR_REUSE", "NOT_A_RENTAL", "NOT_MANAGEABLE_BY_ORGANIZATION", "NOT_WITH_ASSIGNMENT", "NOT_WITH_USER", "NO_ACTIVE_ADDONS", "NO_ACTIVE_STORAGE_CONTRACT", "NO_LOCATION_FOR_STORAGE", "NO_LOGISTICS_FOR_STORAGE", "NO_VALID_ADDONS", "ONGOING_SERVICE", "OWNED_BY_DEEL", "OWNED_BY_ORGANIZATION", "OWNED_BY_PARTNER_ORGANIZATION", "PARTNER_CHILD_CONTRACT", "PENDING_DEVICE_REFRESH", "RENTAL_CONTRACT_AND_USER_REGION_DO_NOT_MATCH", "TEMPORARILY_UNAVAILABLE", "UNKNOWN", "USER_HAS_NO_COUNTRY", "USER_HAS_NO_SEAT", "WAITING_FOR_CLEARANCE", "WITH_LOANER_ASSIGNMENT", "WITH_NON_COLLECTED_ASSIGNMENT", "WITH_NON_DELIVERED_ASSIGNMENT", "WITH_PENDING_ASSIGNMENT", "WRONG_ASSIGNMENT_STATUS", "WRONG_CONTRACT_STATUS", "WRONG_TERMS_AND_CONDITIONS" ], "title": "ItAssetsAssetIdUnarchivePostResponsesContentApplicationJsonSchemaDataActionsStoreOwnAssetAtDeelForLocalDisabledReasonsItems", "type": "string" }, "ItAssetsAssetIdUnarchivePostResponsesContentApplicationJsonSchemaDataActionsStoreOwnAssetAtDeelForLocalStatus": { "description": "Whether the action is currently available for this asset", "enum": [ "DISABLED", "ENABLED", "NOT_APPLICABLE" ], "title": "ItAssetsAssetIdUnarchivePostResponsesContentApplicationJsonSchemaDataActionsStoreOwnAssetAtDeelForLocalStatus", "type": "string" }, "ItAssetsAssetIdUnarchivePostResponsesContentApplicationJsonSchemaDataActionsStoreOwnAssetAtOwnLocation": { "description": "Store an organization-owned asset at an organization-owned location", "properties": { "details": { "description": "Action-specific context needed to perform the action. Populated for enabled and\ndisabled actions (so callers can see what a successful attempt would look like);\nnull when the action is not applicable to this asset.", "oneOf": [ { "$ref": "#/components/schemas/ItAssetsAssetIdUnarchivePostResponsesContentApplicationJsonSchemaDataActionsStoreOwnAssetAtOwnLocationDetails" }, { "type": "null" } ] }, "disabled_reasons": { "description": "Reasons why the action is disabled. Empty when the action is enabled or not applicable", "items": { "$ref": "#/components/schemas/ItAssetsAssetIdUnarchivePostResponsesContentApplicationJsonSchemaDataActionsStoreOwnAssetAtOwnLocationDisabledReasonsItems" }, "type": "array" }, "status": { "$ref": "#/components/schemas/ItAssetsAssetIdUnarchivePostResponsesContentApplicationJsonSchemaDataActionsStoreOwnAssetAtOwnLocationStatus", "description": "Whether the action is currently available for this asset" } }, "required": [ "status", "details", "disabled_reasons" ], "title": "ItAssetsAssetIdUnarchivePostResponsesContentApplicationJsonSchemaDataActionsStoreOwnAssetAtOwnLocation", "type": "object" }, "ItAssetsAssetIdUnarchivePostResponsesContentApplicationJsonSchemaDataActionsStoreOwnAssetAtOwnLocationDetails": { "description": "Action-specific context needed to perform the action. Populated for enabled and\ndisabled actions (so callers can see what a successful attempt would look like);\nnull when the action is not applicable to this asset.", "properties": { "eligible_countries": { "description": "Countries where the asset can be stored at an organization-owned location", "items": { "$ref": "#/components/schemas/ItAssetsAssetIdUnarchivePostResponsesContentApplicationJsonSchemaDataActionsStoreOwnAssetAtOwnLocationDetailsEligibleCountriesItems" }, "type": "array" }, "service_cost": { "$ref": "#/components/schemas/ItAssetsAssetIdUnarchivePostResponsesContentApplicationJsonSchemaDataActionsStoreOwnAssetAtOwnLocationDetailsServiceCost", "description": "Cost charged for the transfer service" } }, "required": [ "service_cost", "eligible_countries" ], "title": "ItAssetsAssetIdUnarchivePostResponsesContentApplicationJsonSchemaDataActionsStoreOwnAssetAtOwnLocationDetails", "type": "object" }, "ItAssetsAssetIdUnarchivePostResponsesContentApplicationJsonSchemaDataActionsStoreOwnAssetAtOwnLocationDetailsEligibleCountriesItems": { "enum": [ "AD", "AE", "AF", "AG", "AI", "AL", "AM", "AN", "AO", "AQ", "AR", "AS", "AT", "AU", "AW", "AX", "AZ", "BA", "BB", "BD", "BE", "BF", "BG", "BH", "BI", "BJ", "BL", "BM", "BN", "BO", "BQ", "BR", "BS", "BT", "BV", "BW", "BY", "BZ", "CA", "CC", "CD", "CF", "CG", "CH", "CI", "CK", "CL", "CM", "CN", "CO", "CR", "CU", "CV", "CW", "CX", "CY", "CZ", "DE", "DJ", "DK", "DM", "DO", "DZ", "EC", "EE", "EG", "EH", "ER", "ES", "ET", "FI", "FJ", "FK", "FM", "FO", "FR", "GA", "GB", "GD", "GE", "GF", "GG", "GH", "GI", "GL", "GM", "GN", "GP", "GQ", "GR", "GS", "GT", "GU", "GW", "GY", "HK", "HM", "HN", "HR", "HT", "HU", "IC", "ID", "IE", "IL", "IM", "IN", "IO", "IQ", "IR", "IS", "IT", "JE", "JM", "JO", "JP", "KE", "KG", "KH", "KI", "KM", "KN", "KP", "KR", "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", "XK", "YE", "YT", "ZA", "ZM", "ZW" ], "title": "ItAssetsAssetIdUnarchivePostResponsesContentApplicationJsonSchemaDataActionsStoreOwnAssetAtOwnLocationDetailsEligibleCountriesItems", "type": "string" }, "ItAssetsAssetIdUnarchivePostResponsesContentApplicationJsonSchemaDataActionsStoreOwnAssetAtOwnLocationDetailsServiceCost": { "description": "Cost charged for the transfer service", "properties": { "billing_method": { "$ref": "#/components/schemas/ItAssetsAssetIdUnarchivePostResponsesContentApplicationJsonSchemaDataActionsStoreOwnAssetAtOwnLocationDetailsServiceCostBillingMethod", "description": "How the action is charged. When \"TOKEN\", the fees are covered by an\nadd-on token pool; when \"CURRENCY\", the fees are billed in the currency\nspecified in the \"fees\" field." }, "fees": { "description": "Price charged for the action. Null when billing method is \"TOKEN\"", "oneOf": [ { "$ref": "#/components/schemas/ItAssetsAssetIdUnarchivePostResponsesContentApplicationJsonSchemaDataActionsStoreOwnAssetAtOwnLocationDetailsServiceCostFees" }, { "type": "null" } ] }, "token_usage": { "description": "Add-on token consumption details. Null when billing method is \"CURRENCY\"", "oneOf": [ { "$ref": "#/components/schemas/ItAssetsAssetIdUnarchivePostResponsesContentApplicationJsonSchemaDataActionsStoreOwnAssetAtOwnLocationDetailsServiceCostTokenUsage" }, { "type": "null" } ] } }, "required": [ "fees", "token_usage", "billing_method" ], "title": "ItAssetsAssetIdUnarchivePostResponsesContentApplicationJsonSchemaDataActionsStoreOwnAssetAtOwnLocationDetailsServiceCost", "type": "object" }, "ItAssetsAssetIdUnarchivePostResponsesContentApplicationJsonSchemaDataActionsStoreOwnAssetAtOwnLocationDetailsServiceCostBillingMethod": { "description": "How the action is charged. When \"TOKEN\", the fees are covered by an\nadd-on token pool; when \"CURRENCY\", the fees are billed in the currency\nspecified in the \"fees\" field.", "enum": [ "CURRENCY", "TOKEN" ], "title": "ItAssetsAssetIdUnarchivePostResponsesContentApplicationJsonSchemaDataActionsStoreOwnAssetAtOwnLocationDetailsServiceCostBillingMethod", "type": "string" }, "ItAssetsAssetIdUnarchivePostResponsesContentApplicationJsonSchemaDataActionsStoreOwnAssetAtOwnLocationDetailsServiceCostFees": { "description": "Price charged for the action. Null when billing method is \"TOKEN\"", "properties": { "amount": { "description": "Amount", "format": "decimal", "type": "string" }, "currency": { "$ref": "#/components/schemas/ItAssetsAssetIdUnarchivePostResponsesContentApplicationJsonSchemaDataActionsStoreOwnAssetAtOwnLocationDetailsServiceCostFeesCurrency", "description": "Three-letter currency code for the price" } }, "required": [ "amount", "currency" ], "title": "ItAssetsAssetIdUnarchivePostResponsesContentApplicationJsonSchemaDataActionsStoreOwnAssetAtOwnLocationDetailsServiceCostFees", "type": "object" }, "ItAssetsAssetIdUnarchivePostResponsesContentApplicationJsonSchemaDataActionsStoreOwnAssetAtOwnLocationDetailsServiceCostFeesCurrency": { "description": "Three-letter currency code for the price", "enum": [ "AED", "AFN", "ALL", "AMD", "ANG", "AOA", "ARS", "AUD", "AWG", "AZN", "BAM", "BDT", "BGN", "BHD", "BIF", "BMD", "BOB", "BRL", "BSD", "BTN", "BWP", "BYN", "BZD", "CAD", "CDF", "CHF", "CLP", "CNY", "COP", "CRC", "CUC", "CVE", "CZK", "DJF", "DKK", "DOP", "DZD", "EGP", "ERN", "ETB", "EUR", "FJD", "FKP", "GBP", "GEL", "GHS", "GIP", "GMD", "GNF", "GTQ", "GYD", "HKD", "HNL", "HRK", "HTG", "HUF", "IDR", "ILS", "INR", "IQD", "IRR", "ISK", "JMD", "JOD", "JPY", "KES", "KGS", "KHR", "KMF", "KPW", "KRW", "KWD", "KYD", "KZT", "LAK", "LBP", "LKR", "LRD", "LSL", "LTL", "LYD", "MAD", "MDL", "MGA", "MKD", "MMK", "MNT", "MRU", "MUR", "MVR", "MWK", "MXN", "MYR", "MZN", "NAD", "NGN", "NIO", "NOK", "NPR", "NZD", "OMR", "PAB", "PEN", "PGK", "PHP", "PKR", "PLN", "PYG", "QAR", "RON", "RSD", "RUB", "RWF", "SAR", "SBD", "SCR", "SDG", "SEK", "SGD", "SHP", "SLL", "SOS", "SRD", "SSP", "STD", "SYP", "SZL", "THB", "TJS", "TMT", "TND", "TOP", "TRY", "TTD", "TWD", "TZS", "UAH", "UGX", "USD", "UYU", "UZS", "VEF", "VND", "VUV", "WST", "XAF", "XCD", "XOF", "XPF", "YER", "ZAR", "ZMW", "ZWD" ], "title": "ItAssetsAssetIdUnarchivePostResponsesContentApplicationJsonSchemaDataActionsStoreOwnAssetAtOwnLocationDetailsServiceCostFeesCurrency", "type": "string" }, "ItAssetsAssetIdUnarchivePostResponsesContentApplicationJsonSchemaDataActionsStoreOwnAssetAtOwnLocationDetailsServiceCostTokenUsage": { "description": "Add-on token consumption details. Null when billing method is \"CURRENCY\"", "properties": { "addon": { "$ref": "#/components/schemas/ItAssetsAssetIdUnarchivePostResponsesContentApplicationJsonSchemaDataActionsStoreOwnAssetAtOwnLocationDetailsServiceCostTokenUsageAddon", "description": "The add-on that provides the tokens" }, "cost": { "description": "Number of tokens consumed by the action. Zero when the add-on covers the\nservice without drawing from a token pool", "format": "decimal", "type": "string" }, "tokens_left": { "description": "Number of tokens left in the pool after the action is performed. Null when\nthe add-on covers the service without a token pool", "format": "decimal", "type": [ "string", "null" ] } }, "required": [ "cost", "addon", "tokens_left" ], "title": "ItAssetsAssetIdUnarchivePostResponsesContentApplicationJsonSchemaDataActionsStoreOwnAssetAtOwnLocationDetailsServiceCostTokenUsage", "type": "object" }, "ItAssetsAssetIdUnarchivePostResponsesContentApplicationJsonSchemaDataActionsStoreOwnAssetAtOwnLocationDetailsServiceCostTokenUsageAddon": { "description": "The add-on that provides the tokens", "properties": { "id": { "description": "ID of the add-on", "format": "uuid", "type": "string" }, "name": { "description": "Public display name of the add-on", "type": "string" } }, "required": [ "id", "name" ], "title": "ItAssetsAssetIdUnarchivePostResponsesContentApplicationJsonSchemaDataActionsStoreOwnAssetAtOwnLocationDetailsServiceCostTokenUsageAddon", "type": "object" }, "ItAssetsAssetIdUnarchivePostResponsesContentApplicationJsonSchemaDataActionsStoreOwnAssetAtOwnLocationDisabledReasonsItems": { "enum": [ "ARCHIVED", "AT_DEEL_WAREHOUSE", "BEING_REPAIRED", "CONSUMABLE", "CONTROLLED_BY_DEEL", "COUNTRY_NOT_SUPPORTED_FOR_HUB", "COUNTRY_NOT_SUPPORTED_FOR_LOCAL", "DEEL_OWNED_ITEM_WITHOUT_RENTAL_CONTRACT", "DESKTOP_STORAGE", "ENDING_CONTRACT", "HUB_IN_SAME_REGION_AS_LOCAL", "INACTIVE", "INVALID_ITEM_LOCATION", "INVALID_ORGANIZATION_STATUS", "INVALID_STATE", "ITEM_CONDITIONS_TO_UNARCHIVE_NOT_MET", "ITEM_NOT_VISIBLE_FOR_ORGANIZATION", "NON_DEVICE", "NOT_AT_WAREHOUSE", "NOT_AVAILABLE_FOR_REUSE", "NOT_A_RENTAL", "NOT_MANAGEABLE_BY_ORGANIZATION", "NOT_WITH_ASSIGNMENT", "NOT_WITH_USER", "NO_ACTIVE_ADDONS", "NO_ACTIVE_STORAGE_CONTRACT", "NO_LOCATION_FOR_STORAGE", "NO_LOGISTICS_FOR_STORAGE", "NO_VALID_ADDONS", "ONGOING_SERVICE", "OWNED_BY_DEEL", "OWNED_BY_ORGANIZATION", "OWNED_BY_PARTNER_ORGANIZATION", "PARTNER_CHILD_CONTRACT", "PENDING_DEVICE_REFRESH", "RENTAL_CONTRACT_AND_USER_REGION_DO_NOT_MATCH", "TEMPORARILY_UNAVAILABLE", "UNKNOWN", "USER_HAS_NO_COUNTRY", "USER_HAS_NO_SEAT", "WAITING_FOR_CLEARANCE", "WITH_LOANER_ASSIGNMENT", "WITH_NON_COLLECTED_ASSIGNMENT", "WITH_NON_DELIVERED_ASSIGNMENT", "WITH_PENDING_ASSIGNMENT", "WRONG_ASSIGNMENT_STATUS", "WRONG_CONTRACT_STATUS", "WRONG_TERMS_AND_CONDITIONS" ], "title": "ItAssetsAssetIdUnarchivePostResponsesContentApplicationJsonSchemaDataActionsStoreOwnAssetAtOwnLocationDisabledReasonsItems", "type": "string" }, "ItAssetsAssetIdUnarchivePostResponsesContentApplicationJsonSchemaDataActionsStoreOwnAssetAtOwnLocationStatus": { "description": "Whether the action is currently available for this asset", "enum": [ "DISABLED", "ENABLED", "NOT_APPLICABLE" ], "title": "ItAssetsAssetIdUnarchivePostResponsesContentApplicationJsonSchemaDataActionsStoreOwnAssetAtOwnLocationStatus", "type": "string" }, "ItAssetsAssetIdUnarchivePostResponsesContentApplicationJsonSchemaDataActionsStoreRentalAtDeelForLocal": { "description": "Store a Deel-owned rental asset at a Deel local warehouse", "properties": { "details": { "description": "Action-specific context needed to perform the action. Populated for enabled and\ndisabled actions (so callers can see what a successful attempt would look like);\nnull when the action is not applicable to this asset.", "oneOf": [ { "$ref": "#/components/schemas/ItAssetsAssetIdUnarchivePostResponsesContentApplicationJsonSchemaDataActionsStoreRentalAtDeelForLocalDetails" }, { "type": "null" } ] }, "disabled_reasons": { "description": "Reasons why the action is disabled. Empty when the action is enabled or not applicable", "items": { "$ref": "#/components/schemas/ItAssetsAssetIdUnarchivePostResponsesContentApplicationJsonSchemaDataActionsStoreRentalAtDeelForLocalDisabledReasonsItems" }, "type": "array" }, "status": { "$ref": "#/components/schemas/ItAssetsAssetIdUnarchivePostResponsesContentApplicationJsonSchemaDataActionsStoreRentalAtDeelForLocalStatus", "description": "Whether the action is currently available for this asset" } }, "required": [ "status", "details", "disabled_reasons" ], "title": "ItAssetsAssetIdUnarchivePostResponsesContentApplicationJsonSchemaDataActionsStoreRentalAtDeelForLocal", "type": "object" }, "ItAssetsAssetIdUnarchivePostResponsesContentApplicationJsonSchemaDataActionsStoreRentalAtDeelForLocalDetails": { "description": "Action-specific context needed to perform the action. Populated for enabled and\ndisabled actions (so callers can see what a successful attempt would look like);\nnull when the action is not applicable to this asset.", "properties": { "activation_cost": { "$ref": "#/components/schemas/ItAssetsAssetIdUnarchivePostResponsesContentApplicationJsonSchemaDataActionsStoreRentalAtDeelForLocalDetailsActivationCost", "description": "Cost charged to activate local storage" } }, "required": [ "activation_cost" ], "title": "ItAssetsAssetIdUnarchivePostResponsesContentApplicationJsonSchemaDataActionsStoreRentalAtDeelForLocalDetails", "type": "object" }, "ItAssetsAssetIdUnarchivePostResponsesContentApplicationJsonSchemaDataActionsStoreRentalAtDeelForLocalDetailsActivationCost": { "description": "Cost charged to activate local storage", "properties": { "billing_method": { "$ref": "#/components/schemas/ItAssetsAssetIdUnarchivePostResponsesContentApplicationJsonSchemaDataActionsStoreRentalAtDeelForLocalDetailsActivationCostBillingMethod", "description": "How the action is charged. When \"TOKEN\", the fees are covered by an\nadd-on token pool; when \"CURRENCY\", the fees are billed in the currency\nspecified in the \"fees\" field." }, "fees": { "description": "Price charged for the action. Null when billing method is \"TOKEN\"", "oneOf": [ { "$ref": "#/components/schemas/ItAssetsAssetIdUnarchivePostResponsesContentApplicationJsonSchemaDataActionsStoreRentalAtDeelForLocalDetailsActivationCostFees" }, { "type": "null" } ] }, "token_usage": { "description": "Add-on token consumption details. Null when billing method is \"CURRENCY\"", "oneOf": [ { "$ref": "#/components/schemas/ItAssetsAssetIdUnarchivePostResponsesContentApplicationJsonSchemaDataActionsStoreRentalAtDeelForLocalDetailsActivationCostTokenUsage" }, { "type": "null" } ] } }, "required": [ "fees", "token_usage", "billing_method" ], "title": "ItAssetsAssetIdUnarchivePostResponsesContentApplicationJsonSchemaDataActionsStoreRentalAtDeelForLocalDetailsActivationCost", "type": "object" }, "ItAssetsAssetIdUnarchivePostResponsesContentApplicationJsonSchemaDataActionsStoreRentalAtDeelForLocalDetailsActivationCostBillingMethod": { "description": "How the action is charged. When \"TOKEN\", the fees are covered by an\nadd-on token pool; when \"CURRENCY\", the fees are billed in the currency\nspecified in the \"fees\" field.", "enum": [ "CURRENCY", "TOKEN" ], "title": "ItAssetsAssetIdUnarchivePostResponsesContentApplicationJsonSchemaDataActionsStoreRentalAtDeelForLocalDetailsActivationCostBillingMethod", "type": "string" }, "ItAssetsAssetIdUnarchivePostResponsesContentApplicationJsonSchemaDataActionsStoreRentalAtDeelForLocalDetailsActivationCostFees": { "description": "Price charged for the action. Null when billing method is \"TOKEN\"", "properties": { "amount": { "description": "Amount", "format": "decimal", "type": "string" }, "currency": { "$ref": "#/components/schemas/ItAssetsAssetIdUnarchivePostResponsesContentApplicationJsonSchemaDataActionsStoreRentalAtDeelForLocalDetailsActivationCostFeesCurrency", "description": "Three-letter currency code for the price" } }, "required": [ "amount", "currency" ], "title": "ItAssetsAssetIdUnarchivePostResponsesContentApplicationJsonSchemaDataActionsStoreRentalAtDeelForLocalDetailsActivationCostFees", "type": "object" }, "ItAssetsAssetIdUnarchivePostResponsesContentApplicationJsonSchemaDataActionsStoreRentalAtDeelForLocalDetailsActivationCostFeesCurrency": { "description": "Three-letter currency code for the price", "enum": [ "AED", "AFN", "ALL", "AMD", "ANG", "AOA", "ARS", "AUD", "AWG", "AZN", "BAM", "BDT", "BGN", "BHD", "BIF", "BMD", "BOB", "BRL", "BSD", "BTN", "BWP", "BYN", "BZD", "CAD", "CDF", "CHF", "CLP", "CNY", "COP", "CRC", "CUC", "CVE", "CZK", "DJF", "DKK", "DOP", "DZD", "EGP", "ERN", "ETB", "EUR", "FJD", "FKP", "GBP", "GEL", "GHS", "GIP", "GMD", "GNF", "GTQ", "GYD", "HKD", "HNL", "HRK", "HTG", "HUF", "IDR", "ILS", "INR", "IQD", "IRR", "ISK", "JMD", "JOD", "JPY", "KES", "KGS", "KHR", "KMF", "KPW", "KRW", "KWD", "KYD", "KZT", "LAK", "LBP", "LKR", "LRD", "LSL", "LTL", "LYD", "MAD", "MDL", "MGA", "MKD", "MMK", "MNT", "MRU", "MUR", "MVR", "MWK", "MXN", "MYR", "MZN", "NAD", "NGN", "NIO", "NOK", "NPR", "NZD", "OMR", "PAB", "PEN", "PGK", "PHP", "PKR", "PLN", "PYG", "QAR", "RON", "RSD", "RUB", "RWF", "SAR", "SBD", "SCR", "SDG", "SEK", "SGD", "SHP", "SLL", "SOS", "SRD", "SSP", "STD", "SYP", "SZL", "THB", "TJS", "TMT", "TND", "TOP", "TRY", "TTD", "TWD", "TZS", "UAH", "UGX", "USD", "UYU", "UZS", "VEF", "VND", "VUV", "WST", "XAF", "XCD", "XOF", "XPF", "YER", "ZAR", "ZMW", "ZWD" ], "title": "ItAssetsAssetIdUnarchivePostResponsesContentApplicationJsonSchemaDataActionsStoreRentalAtDeelForLocalDetailsActivationCostFeesCurrency", "type": "string" }, "ItAssetsAssetIdUnarchivePostResponsesContentApplicationJsonSchemaDataActionsStoreRentalAtDeelForLocalDetailsActivationCostTokenUsage": { "description": "Add-on token consumption details. Null when billing method is \"CURRENCY\"", "properties": { "addon": { "$ref": "#/components/schemas/ItAssetsAssetIdUnarchivePostResponsesContentApplicationJsonSchemaDataActionsStoreRentalAtDeelForLocalDetailsActivationCostTokenUsageAddon", "description": "The add-on that provides the tokens" }, "cost": { "description": "Number of tokens consumed by the action. Zero when the add-on covers the\nservice without drawing from a token pool", "format": "decimal", "type": "string" }, "tokens_left": { "description": "Number of tokens left in the pool after the action is performed. Null when\nthe add-on covers the service without a token pool", "format": "decimal", "type": [ "string", "null" ] } }, "required": [ "cost", "addon", "tokens_left" ], "title": "ItAssetsAssetIdUnarchivePostResponsesContentApplicationJsonSchemaDataActionsStoreRentalAtDeelForLocalDetailsActivationCostTokenUsage", "type": "object" }, "ItAssetsAssetIdUnarchivePostResponsesContentApplicationJsonSchemaDataActionsStoreRentalAtDeelForLocalDetailsActivationCostTokenUsageAddon": { "description": "The add-on that provides the tokens", "properties": { "id": { "description": "ID of the add-on", "format": "uuid", "type": "string" }, "name": { "description": "Public display name of the add-on", "type": "string" } }, "required": [ "id", "name" ], "title": "ItAssetsAssetIdUnarchivePostResponsesContentApplicationJsonSchemaDataActionsStoreRentalAtDeelForLocalDetailsActivationCostTokenUsageAddon", "type": "object" }, "ItAssetsAssetIdUnarchivePostResponsesContentApplicationJsonSchemaDataActionsStoreRentalAtDeelForLocalDisabledReasonsItems": { "enum": [ "ARCHIVED", "AT_DEEL_WAREHOUSE", "BEING_REPAIRED", "CONSUMABLE", "CONTROLLED_BY_DEEL", "COUNTRY_NOT_SUPPORTED_FOR_HUB", "COUNTRY_NOT_SUPPORTED_FOR_LOCAL", "DEEL_OWNED_ITEM_WITHOUT_RENTAL_CONTRACT", "DESKTOP_STORAGE", "ENDING_CONTRACT", "HUB_IN_SAME_REGION_AS_LOCAL", "INACTIVE", "INVALID_ITEM_LOCATION", "INVALID_ORGANIZATION_STATUS", "INVALID_STATE", "ITEM_CONDITIONS_TO_UNARCHIVE_NOT_MET", "ITEM_NOT_VISIBLE_FOR_ORGANIZATION", "NON_DEVICE", "NOT_AT_WAREHOUSE", "NOT_AVAILABLE_FOR_REUSE", "NOT_A_RENTAL", "NOT_MANAGEABLE_BY_ORGANIZATION", "NOT_WITH_ASSIGNMENT", "NOT_WITH_USER", "NO_ACTIVE_ADDONS", "NO_ACTIVE_STORAGE_CONTRACT", "NO_LOCATION_FOR_STORAGE", "NO_LOGISTICS_FOR_STORAGE", "NO_VALID_ADDONS", "ONGOING_SERVICE", "OWNED_BY_DEEL", "OWNED_BY_ORGANIZATION", "OWNED_BY_PARTNER_ORGANIZATION", "PARTNER_CHILD_CONTRACT", "PENDING_DEVICE_REFRESH", "RENTAL_CONTRACT_AND_USER_REGION_DO_NOT_MATCH", "TEMPORARILY_UNAVAILABLE", "UNKNOWN", "USER_HAS_NO_COUNTRY", "USER_HAS_NO_SEAT", "WAITING_FOR_CLEARANCE", "WITH_LOANER_ASSIGNMENT", "WITH_NON_COLLECTED_ASSIGNMENT", "WITH_NON_DELIVERED_ASSIGNMENT", "WITH_PENDING_ASSIGNMENT", "WRONG_ASSIGNMENT_STATUS", "WRONG_CONTRACT_STATUS", "WRONG_TERMS_AND_CONDITIONS" ], "title": "ItAssetsAssetIdUnarchivePostResponsesContentApplicationJsonSchemaDataActionsStoreRentalAtDeelForLocalDisabledReasonsItems", "type": "string" }, "ItAssetsAssetIdUnarchivePostResponsesContentApplicationJsonSchemaDataActionsStoreRentalAtDeelForLocalStatus": { "description": "Whether the action is currently available for this asset", "enum": [ "DISABLED", "ENABLED", "NOT_APPLICABLE" ], "title": "ItAssetsAssetIdUnarchivePostResponsesContentApplicationJsonSchemaDataActionsStoreRentalAtDeelForLocalStatus", "type": "string" }, "ItAssetsAssetIdUnarchivePostResponsesContentApplicationJsonSchemaDataActionsStoreRentalAtDeelForZone1": { "description": "Store a Deel-owned rental asset at a Deel zone-1 warehouse", "properties": { "details": { "description": "Action-specific context needed to perform the action. Populated for enabled and\ndisabled actions (so callers can see what a successful attempt would look like);\nnull when the action is not applicable to this asset.", "oneOf": [ { "$ref": "#/components/schemas/ItAssetsAssetIdUnarchivePostResponsesContentApplicationJsonSchemaDataActionsStoreRentalAtDeelForZone1Details" }, { "type": "null" } ] }, "disabled_reasons": { "description": "Reasons why the action is disabled. Empty when the action is enabled or not applicable", "items": { "$ref": "#/components/schemas/ItAssetsAssetIdUnarchivePostResponsesContentApplicationJsonSchemaDataActionsStoreRentalAtDeelForZone1DisabledReasonsItems" }, "type": "array" }, "status": { "$ref": "#/components/schemas/ItAssetsAssetIdUnarchivePostResponsesContentApplicationJsonSchemaDataActionsStoreRentalAtDeelForZone1Status", "description": "Whether the action is currently available for this asset" } }, "required": [ "status", "details", "disabled_reasons" ], "title": "ItAssetsAssetIdUnarchivePostResponsesContentApplicationJsonSchemaDataActionsStoreRentalAtDeelForZone1", "type": "object" }, "ItAssetsAssetIdUnarchivePostResponsesContentApplicationJsonSchemaDataActionsStoreRentalAtDeelForZone1Details": { "description": "Action-specific context needed to perform the action. Populated for enabled and\ndisabled actions (so callers can see what a successful attempt would look like);\nnull when the action is not applicable to this asset.", "properties": { "activation_cost": { "$ref": "#/components/schemas/ItAssetsAssetIdUnarchivePostResponsesContentApplicationJsonSchemaDataActionsStoreRentalAtDeelForZone1DetailsActivationCost", "description": "Cost charged to activate zone-1 storage" } }, "required": [ "activation_cost" ], "title": "ItAssetsAssetIdUnarchivePostResponsesContentApplicationJsonSchemaDataActionsStoreRentalAtDeelForZone1Details", "type": "object" }, "ItAssetsAssetIdUnarchivePostResponsesContentApplicationJsonSchemaDataActionsStoreRentalAtDeelForZone1DetailsActivationCost": { "description": "Cost charged to activate zone-1 storage", "properties": { "billing_method": { "$ref": "#/components/schemas/ItAssetsAssetIdUnarchivePostResponsesContentApplicationJsonSchemaDataActionsStoreRentalAtDeelForZone1DetailsActivationCostBillingMethod", "description": "How the action is charged. When \"TOKEN\", the fees are covered by an\nadd-on token pool; when \"CURRENCY\", the fees are billed in the currency\nspecified in the \"fees\" field." }, "fees": { "description": "Price charged for the action. Null when billing method is \"TOKEN\"", "oneOf": [ { "$ref": "#/components/schemas/ItAssetsAssetIdUnarchivePostResponsesContentApplicationJsonSchemaDataActionsStoreRentalAtDeelForZone1DetailsActivationCostFees" }, { "type": "null" } ] }, "token_usage": { "description": "Add-on token consumption details. Null when billing method is \"CURRENCY\"", "oneOf": [ { "$ref": "#/components/schemas/ItAssetsAssetIdUnarchivePostResponsesContentApplicationJsonSchemaDataActionsStoreRentalAtDeelForZone1DetailsActivationCostTokenUsage" }, { "type": "null" } ] } }, "required": [ "fees", "token_usage", "billing_method" ], "title": "ItAssetsAssetIdUnarchivePostResponsesContentApplicationJsonSchemaDataActionsStoreRentalAtDeelForZone1DetailsActivationCost", "type": "object" }, "ItAssetsAssetIdUnarchivePostResponsesContentApplicationJsonSchemaDataActionsStoreRentalAtDeelForZone1DetailsActivationCostBillingMethod": { "description": "How the action is charged. When \"TOKEN\", the fees are covered by an\nadd-on token pool; when \"CURRENCY\", the fees are billed in the currency\nspecified in the \"fees\" field.", "enum": [ "CURRENCY", "TOKEN" ], "title": "ItAssetsAssetIdUnarchivePostResponsesContentApplicationJsonSchemaDataActionsStoreRentalAtDeelForZone1DetailsActivationCostBillingMethod", "type": "string" }, "ItAssetsAssetIdUnarchivePostResponsesContentApplicationJsonSchemaDataActionsStoreRentalAtDeelForZone1DetailsActivationCostFees": { "description": "Price charged for the action. Null when billing method is \"TOKEN\"", "properties": { "amount": { "description": "Amount", "format": "decimal", "type": "string" }, "currency": { "$ref": "#/components/schemas/ItAssetsAssetIdUnarchivePostResponsesContentApplicationJsonSchemaDataActionsStoreRentalAtDeelForZone1DetailsActivationCostFeesCurrency", "description": "Three-letter currency code for the price" } }, "required": [ "amount", "currency" ], "title": "ItAssetsAssetIdUnarchivePostResponsesContentApplicationJsonSchemaDataActionsStoreRentalAtDeelForZone1DetailsActivationCostFees", "type": "object" }, "ItAssetsAssetIdUnarchivePostResponsesContentApplicationJsonSchemaDataActionsStoreRentalAtDeelForZone1DetailsActivationCostFeesCurrency": { "description": "Three-letter currency code for the price", "enum": [ "AED", "AFN", "ALL", "AMD", "ANG", "AOA", "ARS", "AUD", "AWG", "AZN", "BAM", "BDT", "BGN", "BHD", "BIF", "BMD", "BOB", "BRL", "BSD", "BTN", "BWP", "BYN", "BZD", "CAD", "CDF", "CHF", "CLP", "CNY", "COP", "CRC", "CUC", "CVE", "CZK", "DJF", "DKK", "DOP", "DZD", "EGP", "ERN", "ETB", "EUR", "FJD", "FKP", "GBP", "GEL", "GHS", "GIP", "GMD", "GNF", "GTQ", "GYD", "HKD", "HNL", "HRK", "HTG", "HUF", "IDR", "ILS", "INR", "IQD", "IRR", "ISK", "JMD", "JOD", "JPY", "KES", "KGS", "KHR", "KMF", "KPW", "KRW", "KWD", "KYD", "KZT", "LAK", "LBP", "LKR", "LRD", "LSL", "LTL", "LYD", "MAD", "MDL", "MGA", "MKD", "MMK", "MNT", "MRU", "MUR", "MVR", "MWK", "MXN", "MYR", "MZN", "NAD", "NGN", "NIO", "NOK", "NPR", "NZD", "OMR", "PAB", "PEN", "PGK", "PHP", "PKR", "PLN", "PYG", "QAR", "RON", "RSD", "RUB", "RWF", "SAR", "SBD", "SCR", "SDG", "SEK", "SGD", "SHP", "SLL", "SOS", "SRD", "SSP", "STD", "SYP", "SZL", "THB", "TJS", "TMT", "TND", "TOP", "TRY", "TTD", "TWD", "TZS", "UAH", "UGX", "USD", "UYU", "UZS", "VEF", "VND", "VUV", "WST", "XAF", "XCD", "XOF", "XPF", "YER", "ZAR", "ZMW", "ZWD" ], "title": "ItAssetsAssetIdUnarchivePostResponsesContentApplicationJsonSchemaDataActionsStoreRentalAtDeelForZone1DetailsActivationCostFeesCurrency", "type": "string" }, "ItAssetsAssetIdUnarchivePostResponsesContentApplicationJsonSchemaDataActionsStoreRentalAtDeelForZone1DetailsActivationCostTokenUsage": { "description": "Add-on token consumption details. Null when billing method is \"CURRENCY\"", "properties": { "addon": { "$ref": "#/components/schemas/ItAssetsAssetIdUnarchivePostResponsesContentApplicationJsonSchemaDataActionsStoreRentalAtDeelForZone1DetailsActivationCostTokenUsageAddon", "description": "The add-on that provides the tokens" }, "cost": { "description": "Number of tokens consumed by the action. Zero when the add-on covers the\nservice without drawing from a token pool", "format": "decimal", "type": "string" }, "tokens_left": { "description": "Number of tokens left in the pool after the action is performed. Null when\nthe add-on covers the service without a token pool", "format": "decimal", "type": [ "string", "null" ] } }, "required": [ "cost", "addon", "tokens_left" ], "title": "ItAssetsAssetIdUnarchivePostResponsesContentApplicationJsonSchemaDataActionsStoreRentalAtDeelForZone1DetailsActivationCostTokenUsage", "type": "object" }, "ItAssetsAssetIdUnarchivePostResponsesContentApplicationJsonSchemaDataActionsStoreRentalAtDeelForZone1DetailsActivationCostTokenUsageAddon": { "description": "The add-on that provides the tokens", "properties": { "id": { "description": "ID of the add-on", "format": "uuid", "type": "string" }, "name": { "description": "Public display name of the add-on", "type": "string" } }, "required": [ "id", "name" ], "title": "ItAssetsAssetIdUnarchivePostResponsesContentApplicationJsonSchemaDataActionsStoreRentalAtDeelForZone1DetailsActivationCostTokenUsageAddon", "type": "object" }, "ItAssetsAssetIdUnarchivePostResponsesContentApplicationJsonSchemaDataActionsStoreRentalAtDeelForZone1DisabledReasonsItems": { "enum": [ "ARCHIVED", "AT_DEEL_WAREHOUSE", "BEING_REPAIRED", "CONSUMABLE", "CONTROLLED_BY_DEEL", "COUNTRY_NOT_SUPPORTED_FOR_HUB", "COUNTRY_NOT_SUPPORTED_FOR_LOCAL", "DEEL_OWNED_ITEM_WITHOUT_RENTAL_CONTRACT", "DESKTOP_STORAGE", "ENDING_CONTRACT", "HUB_IN_SAME_REGION_AS_LOCAL", "INACTIVE", "INVALID_ITEM_LOCATION", "INVALID_ORGANIZATION_STATUS", "INVALID_STATE", "ITEM_CONDITIONS_TO_UNARCHIVE_NOT_MET", "ITEM_NOT_VISIBLE_FOR_ORGANIZATION", "NON_DEVICE", "NOT_AT_WAREHOUSE", "NOT_AVAILABLE_FOR_REUSE", "NOT_A_RENTAL", "NOT_MANAGEABLE_BY_ORGANIZATION", "NOT_WITH_ASSIGNMENT", "NOT_WITH_USER", "NO_ACTIVE_ADDONS", "NO_ACTIVE_STORAGE_CONTRACT", "NO_LOCATION_FOR_STORAGE", "NO_LOGISTICS_FOR_STORAGE", "NO_VALID_ADDONS", "ONGOING_SERVICE", "OWNED_BY_DEEL", "OWNED_BY_ORGANIZATION", "OWNED_BY_PARTNER_ORGANIZATION", "PARTNER_CHILD_CONTRACT", "PENDING_DEVICE_REFRESH", "RENTAL_CONTRACT_AND_USER_REGION_DO_NOT_MATCH", "TEMPORARILY_UNAVAILABLE", "UNKNOWN", "USER_HAS_NO_COUNTRY", "USER_HAS_NO_SEAT", "WAITING_FOR_CLEARANCE", "WITH_LOANER_ASSIGNMENT", "WITH_NON_COLLECTED_ASSIGNMENT", "WITH_NON_DELIVERED_ASSIGNMENT", "WITH_PENDING_ASSIGNMENT", "WRONG_ASSIGNMENT_STATUS", "WRONG_CONTRACT_STATUS", "WRONG_TERMS_AND_CONDITIONS" ], "title": "ItAssetsAssetIdUnarchivePostResponsesContentApplicationJsonSchemaDataActionsStoreRentalAtDeelForZone1DisabledReasonsItems", "type": "string" }, "ItAssetsAssetIdUnarchivePostResponsesContentApplicationJsonSchemaDataActionsStoreRentalAtDeelForZone1Status": { "description": "Whether the action is currently available for this asset", "enum": [ "DISABLED", "ENABLED", "NOT_APPLICABLE" ], "title": "ItAssetsAssetIdUnarchivePostResponsesContentApplicationJsonSchemaDataActionsStoreRentalAtDeelForZone1Status", "type": "string" }, "ItAssetsAssetIdUnarchivePostResponsesContentApplicationJsonSchemaDataActionsTransferOwnAsset": { "description": "Transfer an organization-owned asset to another user", "properties": { "details": { "description": "Action-specific context needed to perform the action. Populated for enabled and\ndisabled actions (so callers can see what a successful attempt would look like);\nnull when the action is not applicable to this asset.", "oneOf": [ { "$ref": "#/components/schemas/ItAssetsAssetIdUnarchivePostResponsesContentApplicationJsonSchemaDataActionsTransferOwnAssetDetails" }, { "type": "null" } ] }, "disabled_reasons": { "description": "Reasons why the action is disabled. Empty when the action is enabled or not applicable", "items": { "$ref": "#/components/schemas/ItAssetsAssetIdUnarchivePostResponsesContentApplicationJsonSchemaDataActionsTransferOwnAssetDisabledReasonsItems" }, "type": "array" }, "status": { "$ref": "#/components/schemas/ItAssetsAssetIdUnarchivePostResponsesContentApplicationJsonSchemaDataActionsTransferOwnAssetStatus", "description": "Whether the action is currently available for this asset" } }, "required": [ "status", "details", "disabled_reasons" ], "title": "ItAssetsAssetIdUnarchivePostResponsesContentApplicationJsonSchemaDataActionsTransferOwnAsset", "type": "object" }, "ItAssetsAssetIdUnarchivePostResponsesContentApplicationJsonSchemaDataActionsTransferOwnAssetDetails": { "description": "Action-specific context needed to perform the action. Populated for enabled and\ndisabled actions (so callers can see what a successful attempt would look like);\nnull when the action is not applicable to this asset.", "properties": { "eligible_countries": { "description": "Countries the asset can be transferred to", "items": { "$ref": "#/components/schemas/ItAssetsAssetIdUnarchivePostResponsesContentApplicationJsonSchemaDataActionsTransferOwnAssetDetailsEligibleCountriesItems" }, "type": "array" }, "transfer_cost": { "$ref": "#/components/schemas/ItAssetsAssetIdUnarchivePostResponsesContentApplicationJsonSchemaDataActionsTransferOwnAssetDetailsTransferCost", "description": "Cost charged for the transfer service" } }, "required": [ "transfer_cost", "eligible_countries" ], "title": "ItAssetsAssetIdUnarchivePostResponsesContentApplicationJsonSchemaDataActionsTransferOwnAssetDetails", "type": "object" }, "ItAssetsAssetIdUnarchivePostResponsesContentApplicationJsonSchemaDataActionsTransferOwnAssetDetailsEligibleCountriesItems": { "enum": [ "AD", "AE", "AF", "AG", "AI", "AL", "AM", "AN", "AO", "AQ", "AR", "AS", "AT", "AU", "AW", "AX", "AZ", "BA", "BB", "BD", "BE", "BF", "BG", "BH", "BI", "BJ", "BL", "BM", "BN", "BO", "BQ", "BR", "BS", "BT", "BV", "BW", "BY", "BZ", "CA", "CC", "CD", "CF", "CG", "CH", "CI", "CK", "CL", "CM", "CN", "CO", "CR", "CU", "CV", "CW", "CX", "CY", "CZ", "DE", "DJ", "DK", "DM", "DO", "DZ", "EC", "EE", "EG", "EH", "ER", "ES", "ET", "FI", "FJ", "FK", "FM", "FO", "FR", "GA", "GB", "GD", "GE", "GF", "GG", "GH", "GI", "GL", "GM", "GN", "GP", "GQ", "GR", "GS", "GT", "GU", "GW", "GY", "HK", "HM", "HN", "HR", "HT", "HU", "IC", "ID", "IE", "IL", "IM", "IN", "IO", "IQ", "IR", "IS", "IT", "JE", "JM", "JO", "JP", "KE", "KG", "KH", "KI", "KM", "KN", "KP", "KR", "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", "XK", "YE", "YT", "ZA", "ZM", "ZW" ], "title": "ItAssetsAssetIdUnarchivePostResponsesContentApplicationJsonSchemaDataActionsTransferOwnAssetDetailsEligibleCountriesItems", "type": "string" }, "ItAssetsAssetIdUnarchivePostResponsesContentApplicationJsonSchemaDataActionsTransferOwnAssetDetailsTransferCost": { "description": "Cost charged for the transfer service", "properties": { "billing_method": { "$ref": "#/components/schemas/ItAssetsAssetIdUnarchivePostResponsesContentApplicationJsonSchemaDataActionsTransferOwnAssetDetailsTransferCostBillingMethod", "description": "How the action is charged. When \"TOKEN\", the fees are covered by an\nadd-on token pool; when \"CURRENCY\", the fees are billed in the currency\nspecified in the \"fees\" field." }, "fees": { "description": "Price charged for the action. Null when billing method is \"TOKEN\"", "oneOf": [ { "$ref": "#/components/schemas/ItAssetsAssetIdUnarchivePostResponsesContentApplicationJsonSchemaDataActionsTransferOwnAssetDetailsTransferCostFees" }, { "type": "null" } ] }, "token_usage": { "description": "Add-on token consumption details. Null when billing method is \"CURRENCY\"", "oneOf": [ { "$ref": "#/components/schemas/ItAssetsAssetIdUnarchivePostResponsesContentApplicationJsonSchemaDataActionsTransferOwnAssetDetailsTransferCostTokenUsage" }, { "type": "null" } ] } }, "required": [ "fees", "token_usage", "billing_method" ], "title": "ItAssetsAssetIdUnarchivePostResponsesContentApplicationJsonSchemaDataActionsTransferOwnAssetDetailsTransferCost", "type": "object" }, "ItAssetsAssetIdUnarchivePostResponsesContentApplicationJsonSchemaDataActionsTransferOwnAssetDetailsTransferCostBillingMethod": { "description": "How the action is charged. When \"TOKEN\", the fees are covered by an\nadd-on token pool; when \"CURRENCY\", the fees are billed in the currency\nspecified in the \"fees\" field.", "enum": [ "CURRENCY", "TOKEN" ], "title": "ItAssetsAssetIdUnarchivePostResponsesContentApplicationJsonSchemaDataActionsTransferOwnAssetDetailsTransferCostBillingMethod", "type": "string" }, "ItAssetsAssetIdUnarchivePostResponsesContentApplicationJsonSchemaDataActionsTransferOwnAssetDetailsTransferCostFees": { "description": "Price charged for the action. Null when billing method is \"TOKEN\"", "properties": { "amount": { "description": "Amount", "format": "decimal", "type": "string" }, "currency": { "$ref": "#/components/schemas/ItAssetsAssetIdUnarchivePostResponsesContentApplicationJsonSchemaDataActionsTransferOwnAssetDetailsTransferCostFeesCurrency", "description": "Three-letter currency code for the price" } }, "required": [ "amount", "currency" ], "title": "ItAssetsAssetIdUnarchivePostResponsesContentApplicationJsonSchemaDataActionsTransferOwnAssetDetailsTransferCostFees", "type": "object" }, "ItAssetsAssetIdUnarchivePostResponsesContentApplicationJsonSchemaDataActionsTransferOwnAssetDetailsTransferCostFeesCurrency": { "description": "Three-letter currency code for the price", "enum": [ "AED", "AFN", "ALL", "AMD", "ANG", "AOA", "ARS", "AUD", "AWG", "AZN", "BAM", "BDT", "BGN", "BHD", "BIF", "BMD", "BOB", "BRL", "BSD", "BTN", "BWP", "BYN", "BZD", "CAD", "CDF", "CHF", "CLP", "CNY", "COP", "CRC", "CUC", "CVE", "CZK", "DJF", "DKK", "DOP", "DZD", "EGP", "ERN", "ETB", "EUR", "FJD", "FKP", "GBP", "GEL", "GHS", "GIP", "GMD", "GNF", "GTQ", "GYD", "HKD", "HNL", "HRK", "HTG", "HUF", "IDR", "ILS", "INR", "IQD", "IRR", "ISK", "JMD", "JOD", "JPY", "KES", "KGS", "KHR", "KMF", "KPW", "KRW", "KWD", "KYD", "KZT", "LAK", "LBP", "LKR", "LRD", "LSL", "LTL", "LYD", "MAD", "MDL", "MGA", "MKD", "MMK", "MNT", "MRU", "MUR", "MVR", "MWK", "MXN", "MYR", "MZN", "NAD", "NGN", "NIO", "NOK", "NPR", "NZD", "OMR", "PAB", "PEN", "PGK", "PHP", "PKR", "PLN", "PYG", "QAR", "RON", "RSD", "RUB", "RWF", "SAR", "SBD", "SCR", "SDG", "SEK", "SGD", "SHP", "SLL", "SOS", "SRD", "SSP", "STD", "SYP", "SZL", "THB", "TJS", "TMT", "TND", "TOP", "TRY", "TTD", "TWD", "TZS", "UAH", "UGX", "USD", "UYU", "UZS", "VEF", "VND", "VUV", "WST", "XAF", "XCD", "XOF", "XPF", "YER", "ZAR", "ZMW", "ZWD" ], "title": "ItAssetsAssetIdUnarchivePostResponsesContentApplicationJsonSchemaDataActionsTransferOwnAssetDetailsTransferCostFeesCurrency", "type": "string" }, "ItAssetsAssetIdUnarchivePostResponsesContentApplicationJsonSchemaDataActionsTransferOwnAssetDetailsTransferCostTokenUsage": { "description": "Add-on token consumption details. Null when billing method is \"CURRENCY\"", "properties": { "addon": { "$ref": "#/components/schemas/ItAssetsAssetIdUnarchivePostResponsesContentApplicationJsonSchemaDataActionsTransferOwnAssetDetailsTransferCostTokenUsageAddon", "description": "The add-on that provides the tokens" }, "cost": { "description": "Number of tokens consumed by the action. Zero when the add-on covers the\nservice without drawing from a token pool", "format": "decimal", "type": "string" }, "tokens_left": { "description": "Number of tokens left in the pool after the action is performed. Null when\nthe add-on covers the service without a token pool", "format": "decimal", "type": [ "string", "null" ] } }, "required": [ "cost", "addon", "tokens_left" ], "title": "ItAssetsAssetIdUnarchivePostResponsesContentApplicationJsonSchemaDataActionsTransferOwnAssetDetailsTransferCostTokenUsage", "type": "object" }, "ItAssetsAssetIdUnarchivePostResponsesContentApplicationJsonSchemaDataActionsTransferOwnAssetDetailsTransferCostTokenUsageAddon": { "description": "The add-on that provides the tokens", "properties": { "id": { "description": "ID of the add-on", "format": "uuid", "type": "string" }, "name": { "description": "Public display name of the add-on", "type": "string" } }, "required": [ "id", "name" ], "title": "ItAssetsAssetIdUnarchivePostResponsesContentApplicationJsonSchemaDataActionsTransferOwnAssetDetailsTransferCostTokenUsageAddon", "type": "object" }, "ItAssetsAssetIdUnarchivePostResponsesContentApplicationJsonSchemaDataActionsTransferOwnAssetDisabledReasonsItems": { "enum": [ "ARCHIVED", "AT_DEEL_WAREHOUSE", "BEING_REPAIRED", "CONSUMABLE", "CONTROLLED_BY_DEEL", "COUNTRY_NOT_SUPPORTED_FOR_HUB", "COUNTRY_NOT_SUPPORTED_FOR_LOCAL", "DEEL_OWNED_ITEM_WITHOUT_RENTAL_CONTRACT", "DESKTOP_STORAGE", "ENDING_CONTRACT", "HUB_IN_SAME_REGION_AS_LOCAL", "INACTIVE", "INVALID_ITEM_LOCATION", "INVALID_ORGANIZATION_STATUS", "INVALID_STATE", "ITEM_CONDITIONS_TO_UNARCHIVE_NOT_MET", "ITEM_NOT_VISIBLE_FOR_ORGANIZATION", "NON_DEVICE", "NOT_AT_WAREHOUSE", "NOT_AVAILABLE_FOR_REUSE", "NOT_A_RENTAL", "NOT_MANAGEABLE_BY_ORGANIZATION", "NOT_WITH_ASSIGNMENT", "NOT_WITH_USER", "NO_ACTIVE_ADDONS", "NO_ACTIVE_STORAGE_CONTRACT", "NO_LOCATION_FOR_STORAGE", "NO_LOGISTICS_FOR_STORAGE", "NO_VALID_ADDONS", "ONGOING_SERVICE", "OWNED_BY_DEEL", "OWNED_BY_ORGANIZATION", "OWNED_BY_PARTNER_ORGANIZATION", "PARTNER_CHILD_CONTRACT", "PENDING_DEVICE_REFRESH", "RENTAL_CONTRACT_AND_USER_REGION_DO_NOT_MATCH", "TEMPORARILY_UNAVAILABLE", "UNKNOWN", "USER_HAS_NO_COUNTRY", "USER_HAS_NO_SEAT", "WAITING_FOR_CLEARANCE", "WITH_LOANER_ASSIGNMENT", "WITH_NON_COLLECTED_ASSIGNMENT", "WITH_NON_DELIVERED_ASSIGNMENT", "WITH_PENDING_ASSIGNMENT", "WRONG_ASSIGNMENT_STATUS", "WRONG_CONTRACT_STATUS", "WRONG_TERMS_AND_CONDITIONS" ], "title": "ItAssetsAssetIdUnarchivePostResponsesContentApplicationJsonSchemaDataActionsTransferOwnAssetDisabledReasonsItems", "type": "string" }, "ItAssetsAssetIdUnarchivePostResponsesContentApplicationJsonSchemaDataActionsTransferOwnAssetStatus": { "description": "Whether the action is currently available for this asset", "enum": [ "DISABLED", "ENABLED", "NOT_APPLICABLE" ], "title": "ItAssetsAssetIdUnarchivePostResponsesContentApplicationJsonSchemaDataActionsTransferOwnAssetStatus", "type": "string" }, "ItAssetsAssetIdUnarchivePostResponsesContentApplicationJsonSchemaDataActionsTransferRental": { "description": "Transfer a Deel-owned rental asset to another user", "properties": { "details": { "description": "Action-specific context needed to perform the action. Populated for enabled and\ndisabled actions (so callers can see what a successful attempt would look like);\nnull when the action is not applicable to this asset.", "oneOf": [ { "$ref": "#/components/schemas/ItAssetsAssetIdUnarchivePostResponsesContentApplicationJsonSchemaDataActionsTransferRentalDetails" }, { "type": "null" } ] }, "disabled_reasons": { "description": "Reasons why the action is disabled. Empty when the action is enabled or not applicable", "items": { "$ref": "#/components/schemas/ItAssetsAssetIdUnarchivePostResponsesContentApplicationJsonSchemaDataActionsTransferRentalDisabledReasonsItems" }, "type": "array" }, "status": { "$ref": "#/components/schemas/ItAssetsAssetIdUnarchivePostResponsesContentApplicationJsonSchemaDataActionsTransferRentalStatus", "description": "Whether the action is currently available for this asset" } }, "required": [ "status", "details", "disabled_reasons" ], "title": "ItAssetsAssetIdUnarchivePostResponsesContentApplicationJsonSchemaDataActionsTransferRental", "type": "object" }, "ItAssetsAssetIdUnarchivePostResponsesContentApplicationJsonSchemaDataActionsTransferRentalDetails": { "description": "Action-specific context needed to perform the action. Populated for enabled and\ndisabled actions (so callers can see what a successful attempt would look like);\nnull when the action is not applicable to this asset.", "properties": { "eligible_countries": { "description": "Countries the asset can be transferred to", "items": { "$ref": "#/components/schemas/ItAssetsAssetIdUnarchivePostResponsesContentApplicationJsonSchemaDataActionsTransferRentalDetailsEligibleCountriesItems" }, "type": "array" }, "transfer_cost": { "$ref": "#/components/schemas/ItAssetsAssetIdUnarchivePostResponsesContentApplicationJsonSchemaDataActionsTransferRentalDetailsTransferCost", "description": "Cost charged for the transfer service" } }, "required": [ "transfer_cost", "eligible_countries" ], "title": "ItAssetsAssetIdUnarchivePostResponsesContentApplicationJsonSchemaDataActionsTransferRentalDetails", "type": "object" }, "ItAssetsAssetIdUnarchivePostResponsesContentApplicationJsonSchemaDataActionsTransferRentalDetailsEligibleCountriesItems": { "enum": [ "AD", "AE", "AF", "AG", "AI", "AL", "AM", "AN", "AO", "AQ", "AR", "AS", "AT", "AU", "AW", "AX", "AZ", "BA", "BB", "BD", "BE", "BF", "BG", "BH", "BI", "BJ", "BL", "BM", "BN", "BO", "BQ", "BR", "BS", "BT", "BV", "BW", "BY", "BZ", "CA", "CC", "CD", "CF", "CG", "CH", "CI", "CK", "CL", "CM", "CN", "CO", "CR", "CU", "CV", "CW", "CX", "CY", "CZ", "DE", "DJ", "DK", "DM", "DO", "DZ", "EC", "EE", "EG", "EH", "ER", "ES", "ET", "FI", "FJ", "FK", "FM", "FO", "FR", "GA", "GB", "GD", "GE", "GF", "GG", "GH", "GI", "GL", "GM", "GN", "GP", "GQ", "GR", "GS", "GT", "GU", "GW", "GY", "HK", "HM", "HN", "HR", "HT", "HU", "IC", "ID", "IE", "IL", "IM", "IN", "IO", "IQ", "IR", "IS", "IT", "JE", "JM", "JO", "JP", "KE", "KG", "KH", "KI", "KM", "KN", "KP", "KR", "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", "XK", "YE", "YT", "ZA", "ZM", "ZW" ], "title": "ItAssetsAssetIdUnarchivePostResponsesContentApplicationJsonSchemaDataActionsTransferRentalDetailsEligibleCountriesItems", "type": "string" }, "ItAssetsAssetIdUnarchivePostResponsesContentApplicationJsonSchemaDataActionsTransferRentalDetailsTransferCost": { "description": "Cost charged for the transfer service", "properties": { "billing_method": { "$ref": "#/components/schemas/ItAssetsAssetIdUnarchivePostResponsesContentApplicationJsonSchemaDataActionsTransferRentalDetailsTransferCostBillingMethod", "description": "How the action is charged. When \"TOKEN\", the fees are covered by an\nadd-on token pool; when \"CURRENCY\", the fees are billed in the currency\nspecified in the \"fees\" field." }, "fees": { "description": "Price charged for the action. Null when billing method is \"TOKEN\"", "oneOf": [ { "$ref": "#/components/schemas/ItAssetsAssetIdUnarchivePostResponsesContentApplicationJsonSchemaDataActionsTransferRentalDetailsTransferCostFees" }, { "type": "null" } ] }, "token_usage": { "description": "Add-on token consumption details. Null when billing method is \"CURRENCY\"", "oneOf": [ { "$ref": "#/components/schemas/ItAssetsAssetIdUnarchivePostResponsesContentApplicationJsonSchemaDataActionsTransferRentalDetailsTransferCostTokenUsage" }, { "type": "null" } ] } }, "required": [ "fees", "token_usage", "billing_method" ], "title": "ItAssetsAssetIdUnarchivePostResponsesContentApplicationJsonSchemaDataActionsTransferRentalDetailsTransferCost", "type": "object" }, "ItAssetsAssetIdUnarchivePostResponsesContentApplicationJsonSchemaDataActionsTransferRentalDetailsTransferCostBillingMethod": { "description": "How the action is charged. When \"TOKEN\", the fees are covered by an\nadd-on token pool; when \"CURRENCY\", the fees are billed in the currency\nspecified in the \"fees\" field.", "enum": [ "CURRENCY", "TOKEN" ], "title": "ItAssetsAssetIdUnarchivePostResponsesContentApplicationJsonSchemaDataActionsTransferRentalDetailsTransferCostBillingMethod", "type": "string" }, "ItAssetsAssetIdUnarchivePostResponsesContentApplicationJsonSchemaDataActionsTransferRentalDetailsTransferCostFees": { "description": "Price charged for the action. Null when billing method is \"TOKEN\"", "properties": { "amount": { "description": "Amount", "format": "decimal", "type": "string" }, "currency": { "$ref": "#/components/schemas/ItAssetsAssetIdUnarchivePostResponsesContentApplicationJsonSchemaDataActionsTransferRentalDetailsTransferCostFeesCurrency", "description": "Three-letter currency code for the price" } }, "required": [ "amount", "currency" ], "title": "ItAssetsAssetIdUnarchivePostResponsesContentApplicationJsonSchemaDataActionsTransferRentalDetailsTransferCostFees", "type": "object" }, "ItAssetsAssetIdUnarchivePostResponsesContentApplicationJsonSchemaDataActionsTransferRentalDetailsTransferCostFeesCurrency": { "description": "Three-letter currency code for the price", "enum": [ "AED", "AFN", "ALL", "AMD", "ANG", "AOA", "ARS", "AUD", "AWG", "AZN", "BAM", "BDT", "BGN", "BHD", "BIF", "BMD", "BOB", "BRL", "BSD", "BTN", "BWP", "BYN", "BZD", "CAD", "CDF", "CHF", "CLP", "CNY", "COP", "CRC", "CUC", "CVE", "CZK", "DJF", "DKK", "DOP", "DZD", "EGP", "ERN", "ETB", "EUR", "FJD", "FKP", "GBP", "GEL", "GHS", "GIP", "GMD", "GNF", "GTQ", "GYD", "HKD", "HNL", "HRK", "HTG", "HUF", "IDR", "ILS", "INR", "IQD", "IRR", "ISK", "JMD", "JOD", "JPY", "KES", "KGS", "KHR", "KMF", "KPW", "KRW", "KWD", "KYD", "KZT", "LAK", "LBP", "LKR", "LRD", "LSL", "LTL", "LYD", "MAD", "MDL", "MGA", "MKD", "MMK", "MNT", "MRU", "MUR", "MVR", "MWK", "MXN", "MYR", "MZN", "NAD", "NGN", "NIO", "NOK", "NPR", "NZD", "OMR", "PAB", "PEN", "PGK", "PHP", "PKR", "PLN", "PYG", "QAR", "RON", "RSD", "RUB", "RWF", "SAR", "SBD", "SCR", "SDG", "SEK", "SGD", "SHP", "SLL", "SOS", "SRD", "SSP", "STD", "SYP", "SZL", "THB", "TJS", "TMT", "TND", "TOP", "TRY", "TTD", "TWD", "TZS", "UAH", "UGX", "USD", "UYU", "UZS", "VEF", "VND", "VUV", "WST", "XAF", "XCD", "XOF", "XPF", "YER", "ZAR", "ZMW", "ZWD" ], "title": "ItAssetsAssetIdUnarchivePostResponsesContentApplicationJsonSchemaDataActionsTransferRentalDetailsTransferCostFeesCurrency", "type": "string" }, "ItAssetsAssetIdUnarchivePostResponsesContentApplicationJsonSchemaDataActionsTransferRentalDetailsTransferCostTokenUsage": { "description": "Add-on token consumption details. Null when billing method is \"CURRENCY\"", "properties": { "addon": { "$ref": "#/components/schemas/ItAssetsAssetIdUnarchivePostResponsesContentApplicationJsonSchemaDataActionsTransferRentalDetailsTransferCostTokenUsageAddon", "description": "The add-on that provides the tokens" }, "cost": { "description": "Number of tokens consumed by the action. Zero when the add-on covers the\nservice without drawing from a token pool", "format": "decimal", "type": "string" }, "tokens_left": { "description": "Number of tokens left in the pool after the action is performed. Null when\nthe add-on covers the service without a token pool", "format": "decimal", "type": [ "string", "null" ] } }, "required": [ "cost", "addon", "tokens_left" ], "title": "ItAssetsAssetIdUnarchivePostResponsesContentApplicationJsonSchemaDataActionsTransferRentalDetailsTransferCostTokenUsage", "type": "object" }, "ItAssetsAssetIdUnarchivePostResponsesContentApplicationJsonSchemaDataActionsTransferRentalDetailsTransferCostTokenUsageAddon": { "description": "The add-on that provides the tokens", "properties": { "id": { "description": "ID of the add-on", "format": "uuid", "type": "string" }, "name": { "description": "Public display name of the add-on", "type": "string" } }, "required": [ "id", "name" ], "title": "ItAssetsAssetIdUnarchivePostResponsesContentApplicationJsonSchemaDataActionsTransferRentalDetailsTransferCostTokenUsageAddon", "type": "object" }, "ItAssetsAssetIdUnarchivePostResponsesContentApplicationJsonSchemaDataActionsTransferRentalDisabledReasonsItems": { "enum": [ "ARCHIVED", "AT_DEEL_WAREHOUSE", "BEING_REPAIRED", "CONSUMABLE", "CONTROLLED_BY_DEEL", "COUNTRY_NOT_SUPPORTED_FOR_HUB", "COUNTRY_NOT_SUPPORTED_FOR_LOCAL", "DEEL_OWNED_ITEM_WITHOUT_RENTAL_CONTRACT", "DESKTOP_STORAGE", "ENDING_CONTRACT", "HUB_IN_SAME_REGION_AS_LOCAL", "INACTIVE", "INVALID_ITEM_LOCATION", "INVALID_ORGANIZATION_STATUS", "INVALID_STATE", "ITEM_CONDITIONS_TO_UNARCHIVE_NOT_MET", "ITEM_NOT_VISIBLE_FOR_ORGANIZATION", "NON_DEVICE", "NOT_AT_WAREHOUSE", "NOT_AVAILABLE_FOR_REUSE", "NOT_A_RENTAL", "NOT_MANAGEABLE_BY_ORGANIZATION", "NOT_WITH_ASSIGNMENT", "NOT_WITH_USER", "NO_ACTIVE_ADDONS", "NO_ACTIVE_STORAGE_CONTRACT", "NO_LOCATION_FOR_STORAGE", "NO_LOGISTICS_FOR_STORAGE", "NO_VALID_ADDONS", "ONGOING_SERVICE", "OWNED_BY_DEEL", "OWNED_BY_ORGANIZATION", "OWNED_BY_PARTNER_ORGANIZATION", "PARTNER_CHILD_CONTRACT", "PENDING_DEVICE_REFRESH", "RENTAL_CONTRACT_AND_USER_REGION_DO_NOT_MATCH", "TEMPORARILY_UNAVAILABLE", "UNKNOWN", "USER_HAS_NO_COUNTRY", "USER_HAS_NO_SEAT", "WAITING_FOR_CLEARANCE", "WITH_LOANER_ASSIGNMENT", "WITH_NON_COLLECTED_ASSIGNMENT", "WITH_NON_DELIVERED_ASSIGNMENT", "WITH_PENDING_ASSIGNMENT", "WRONG_ASSIGNMENT_STATUS", "WRONG_CONTRACT_STATUS", "WRONG_TERMS_AND_CONDITIONS" ], "title": "ItAssetsAssetIdUnarchivePostResponsesContentApplicationJsonSchemaDataActionsTransferRentalDisabledReasonsItems", "type": "string" }, "ItAssetsAssetIdUnarchivePostResponsesContentApplicationJsonSchemaDataActionsTransferRentalStatus": { "description": "Whether the action is currently available for this asset", "enum": [ "DISABLED", "ENABLED", "NOT_APPLICABLE" ], "title": "ItAssetsAssetIdUnarchivePostResponsesContentApplicationJsonSchemaDataActionsTransferRentalStatus", "type": "string" }, "ItAssetsAssetIdUnarchivePostResponsesContentApplicationJsonSchemaDataActionsUnarchiveOwnAsset": { "description": "Unarchive a previously archived organization-owned asset", "properties": { "disabled_reasons": { "description": "Reasons why the action is disabled. Empty when the action is enabled or not applicable", "items": { "$ref": "#/components/schemas/ItAssetsAssetIdUnarchivePostResponsesContentApplicationJsonSchemaDataActionsUnarchiveOwnAssetDisabledReasonsItems" }, "type": "array" }, "status": { "$ref": "#/components/schemas/ItAssetsAssetIdUnarchivePostResponsesContentApplicationJsonSchemaDataActionsUnarchiveOwnAssetStatus", "description": "Whether the action is currently available for this asset" } }, "required": [ "status", "disabled_reasons" ], "title": "ItAssetsAssetIdUnarchivePostResponsesContentApplicationJsonSchemaDataActionsUnarchiveOwnAsset", "type": "object" }, "ItAssetsAssetIdUnarchivePostResponsesContentApplicationJsonSchemaDataActionsUnarchiveOwnAssetDisabledReasonsItems": { "enum": [ "ARCHIVED", "AT_DEEL_WAREHOUSE", "BEING_REPAIRED", "CONSUMABLE", "CONTROLLED_BY_DEEL", "COUNTRY_NOT_SUPPORTED_FOR_HUB", "COUNTRY_NOT_SUPPORTED_FOR_LOCAL", "DEEL_OWNED_ITEM_WITHOUT_RENTAL_CONTRACT", "DESKTOP_STORAGE", "ENDING_CONTRACT", "HUB_IN_SAME_REGION_AS_LOCAL", "INACTIVE", "INVALID_ITEM_LOCATION", "INVALID_ORGANIZATION_STATUS", "INVALID_STATE", "ITEM_CONDITIONS_TO_UNARCHIVE_NOT_MET", "ITEM_NOT_VISIBLE_FOR_ORGANIZATION", "NON_DEVICE", "NOT_AT_WAREHOUSE", "NOT_AVAILABLE_FOR_REUSE", "NOT_A_RENTAL", "NOT_MANAGEABLE_BY_ORGANIZATION", "NOT_WITH_ASSIGNMENT", "NOT_WITH_USER", "NO_ACTIVE_ADDONS", "NO_ACTIVE_STORAGE_CONTRACT", "NO_LOCATION_FOR_STORAGE", "NO_LOGISTICS_FOR_STORAGE", "NO_VALID_ADDONS", "ONGOING_SERVICE", "OWNED_BY_DEEL", "OWNED_BY_ORGANIZATION", "OWNED_BY_PARTNER_ORGANIZATION", "PARTNER_CHILD_CONTRACT", "PENDING_DEVICE_REFRESH", "RENTAL_CONTRACT_AND_USER_REGION_DO_NOT_MATCH", "TEMPORARILY_UNAVAILABLE", "UNKNOWN", "USER_HAS_NO_COUNTRY", "USER_HAS_NO_SEAT", "WAITING_FOR_CLEARANCE", "WITH_LOANER_ASSIGNMENT", "WITH_NON_COLLECTED_ASSIGNMENT", "WITH_NON_DELIVERED_ASSIGNMENT", "WITH_PENDING_ASSIGNMENT", "WRONG_ASSIGNMENT_STATUS", "WRONG_CONTRACT_STATUS", "WRONG_TERMS_AND_CONDITIONS" ], "title": "ItAssetsAssetIdUnarchivePostResponsesContentApplicationJsonSchemaDataActionsUnarchiveOwnAssetDisabledReasonsItems", "type": "string" }, "ItAssetsAssetIdUnarchivePostResponsesContentApplicationJsonSchemaDataActionsUnarchiveOwnAssetStatus": { "description": "Whether the action is currently available for this asset", "enum": [ "DISABLED", "ENABLED", "NOT_APPLICABLE" ], "title": "ItAssetsAssetIdUnarchivePostResponsesContentApplicationJsonSchemaDataActionsUnarchiveOwnAssetStatus", "type": "string" }, "ItAssetsAssetIdUnarchivePostResponsesContentApplicationJsonSchemaDataActionsUpdateLocationLocationToUser": { "description": "Update the location of an asset from a warehouse to a user", "properties": { "disabled_reasons": { "description": "Reasons why the action is disabled. Empty when the action is enabled or not applicable", "items": { "$ref": "#/components/schemas/ItAssetsAssetIdUnarchivePostResponsesContentApplicationJsonSchemaDataActionsUpdateLocationLocationToUserDisabledReasonsItems" }, "type": "array" }, "status": { "$ref": "#/components/schemas/ItAssetsAssetIdUnarchivePostResponsesContentApplicationJsonSchemaDataActionsUpdateLocationLocationToUserStatus", "description": "Whether the action is currently available for this asset" } }, "required": [ "status", "disabled_reasons" ], "title": "ItAssetsAssetIdUnarchivePostResponsesContentApplicationJsonSchemaDataActionsUpdateLocationLocationToUser", "type": "object" }, "ItAssetsAssetIdUnarchivePostResponsesContentApplicationJsonSchemaDataActionsUpdateLocationLocationToUserDisabledReasonsItems": { "enum": [ "ARCHIVED", "AT_DEEL_WAREHOUSE", "BEING_REPAIRED", "CONSUMABLE", "CONTROLLED_BY_DEEL", "COUNTRY_NOT_SUPPORTED_FOR_HUB", "COUNTRY_NOT_SUPPORTED_FOR_LOCAL", "DEEL_OWNED_ITEM_WITHOUT_RENTAL_CONTRACT", "DESKTOP_STORAGE", "ENDING_CONTRACT", "HUB_IN_SAME_REGION_AS_LOCAL", "INACTIVE", "INVALID_ITEM_LOCATION", "INVALID_ORGANIZATION_STATUS", "INVALID_STATE", "ITEM_CONDITIONS_TO_UNARCHIVE_NOT_MET", "ITEM_NOT_VISIBLE_FOR_ORGANIZATION", "NON_DEVICE", "NOT_AT_WAREHOUSE", "NOT_AVAILABLE_FOR_REUSE", "NOT_A_RENTAL", "NOT_MANAGEABLE_BY_ORGANIZATION", "NOT_WITH_ASSIGNMENT", "NOT_WITH_USER", "NO_ACTIVE_ADDONS", "NO_ACTIVE_STORAGE_CONTRACT", "NO_LOCATION_FOR_STORAGE", "NO_LOGISTICS_FOR_STORAGE", "NO_VALID_ADDONS", "ONGOING_SERVICE", "OWNED_BY_DEEL", "OWNED_BY_ORGANIZATION", "OWNED_BY_PARTNER_ORGANIZATION", "PARTNER_CHILD_CONTRACT", "PENDING_DEVICE_REFRESH", "RENTAL_CONTRACT_AND_USER_REGION_DO_NOT_MATCH", "TEMPORARILY_UNAVAILABLE", "UNKNOWN", "USER_HAS_NO_COUNTRY", "USER_HAS_NO_SEAT", "WAITING_FOR_CLEARANCE", "WITH_LOANER_ASSIGNMENT", "WITH_NON_COLLECTED_ASSIGNMENT", "WITH_NON_DELIVERED_ASSIGNMENT", "WITH_PENDING_ASSIGNMENT", "WRONG_ASSIGNMENT_STATUS", "WRONG_CONTRACT_STATUS", "WRONG_TERMS_AND_CONDITIONS" ], "title": "ItAssetsAssetIdUnarchivePostResponsesContentApplicationJsonSchemaDataActionsUpdateLocationLocationToUserDisabledReasonsItems", "type": "string" }, "ItAssetsAssetIdUnarchivePostResponsesContentApplicationJsonSchemaDataActionsUpdateLocationLocationToUserStatus": { "description": "Whether the action is currently available for this asset", "enum": [ "DISABLED", "ENABLED", "NOT_APPLICABLE" ], "title": "ItAssetsAssetIdUnarchivePostResponsesContentApplicationJsonSchemaDataActionsUpdateLocationLocationToUserStatus", "type": "string" }, "ItAssetsAssetIdUnarchivePostResponsesContentApplicationJsonSchemaDataActionsUpdateLocationUserToLocation": { "description": "Update the location of an asset from a user to a warehouse", "properties": { "disabled_reasons": { "description": "Reasons why the action is disabled. Empty when the action is enabled or not applicable", "items": { "$ref": "#/components/schemas/ItAssetsAssetIdUnarchivePostResponsesContentApplicationJsonSchemaDataActionsUpdateLocationUserToLocationDisabledReasonsItems" }, "type": "array" }, "status": { "$ref": "#/components/schemas/ItAssetsAssetIdUnarchivePostResponsesContentApplicationJsonSchemaDataActionsUpdateLocationUserToLocationStatus", "description": "Whether the action is currently available for this asset" } }, "required": [ "status", "disabled_reasons" ], "title": "ItAssetsAssetIdUnarchivePostResponsesContentApplicationJsonSchemaDataActionsUpdateLocationUserToLocation", "type": "object" }, "ItAssetsAssetIdUnarchivePostResponsesContentApplicationJsonSchemaDataActionsUpdateLocationUserToLocationDisabledReasonsItems": { "enum": [ "ARCHIVED", "AT_DEEL_WAREHOUSE", "BEING_REPAIRED", "CONSUMABLE", "CONTROLLED_BY_DEEL", "COUNTRY_NOT_SUPPORTED_FOR_HUB", "COUNTRY_NOT_SUPPORTED_FOR_LOCAL", "DEEL_OWNED_ITEM_WITHOUT_RENTAL_CONTRACT", "DESKTOP_STORAGE", "ENDING_CONTRACT", "HUB_IN_SAME_REGION_AS_LOCAL", "INACTIVE", "INVALID_ITEM_LOCATION", "INVALID_ORGANIZATION_STATUS", "INVALID_STATE", "ITEM_CONDITIONS_TO_UNARCHIVE_NOT_MET", "ITEM_NOT_VISIBLE_FOR_ORGANIZATION", "NON_DEVICE", "NOT_AT_WAREHOUSE", "NOT_AVAILABLE_FOR_REUSE", "NOT_A_RENTAL", "NOT_MANAGEABLE_BY_ORGANIZATION", "NOT_WITH_ASSIGNMENT", "NOT_WITH_USER", "NO_ACTIVE_ADDONS", "NO_ACTIVE_STORAGE_CONTRACT", "NO_LOCATION_FOR_STORAGE", "NO_LOGISTICS_FOR_STORAGE", "NO_VALID_ADDONS", "ONGOING_SERVICE", "OWNED_BY_DEEL", "OWNED_BY_ORGANIZATION", "OWNED_BY_PARTNER_ORGANIZATION", "PARTNER_CHILD_CONTRACT", "PENDING_DEVICE_REFRESH", "RENTAL_CONTRACT_AND_USER_REGION_DO_NOT_MATCH", "TEMPORARILY_UNAVAILABLE", "UNKNOWN", "USER_HAS_NO_COUNTRY", "USER_HAS_NO_SEAT", "WAITING_FOR_CLEARANCE", "WITH_LOANER_ASSIGNMENT", "WITH_NON_COLLECTED_ASSIGNMENT", "WITH_NON_DELIVERED_ASSIGNMENT", "WITH_PENDING_ASSIGNMENT", "WRONG_ASSIGNMENT_STATUS", "WRONG_CONTRACT_STATUS", "WRONG_TERMS_AND_CONDITIONS" ], "title": "ItAssetsAssetIdUnarchivePostResponsesContentApplicationJsonSchemaDataActionsUpdateLocationUserToLocationDisabledReasonsItems", "type": "string" }, "ItAssetsAssetIdUnarchivePostResponsesContentApplicationJsonSchemaDataActionsUpdateLocationUserToLocationStatus": { "description": "Whether the action is currently available for this asset", "enum": [ "DISABLED", "ENABLED", "NOT_APPLICABLE" ], "title": "ItAssetsAssetIdUnarchivePostResponsesContentApplicationJsonSchemaDataActionsUpdateLocationUserToLocationStatus", "type": "string" }, "ItAssetsAssetIdUnarchivePostResponsesContentApplicationJsonSchemaDataActionsUpdateLocationUserToUser": { "description": "Update the assigned user of an asset that is currently with a user", "properties": { "disabled_reasons": { "description": "Reasons why the action is disabled. Empty when the action is enabled or not applicable", "items": { "$ref": "#/components/schemas/ItAssetsAssetIdUnarchivePostResponsesContentApplicationJsonSchemaDataActionsUpdateLocationUserToUserDisabledReasonsItems" }, "type": "array" }, "status": { "$ref": "#/components/schemas/ItAssetsAssetIdUnarchivePostResponsesContentApplicationJsonSchemaDataActionsUpdateLocationUserToUserStatus", "description": "Whether the action is currently available for this asset" } }, "required": [ "status", "disabled_reasons" ], "title": "ItAssetsAssetIdUnarchivePostResponsesContentApplicationJsonSchemaDataActionsUpdateLocationUserToUser", "type": "object" }, "ItAssetsAssetIdUnarchivePostResponsesContentApplicationJsonSchemaDataActionsUpdateLocationUserToUserDisabledReasonsItems": { "enum": [ "ARCHIVED", "AT_DEEL_WAREHOUSE", "BEING_REPAIRED", "CONSUMABLE", "CONTROLLED_BY_DEEL", "COUNTRY_NOT_SUPPORTED_FOR_HUB", "COUNTRY_NOT_SUPPORTED_FOR_LOCAL", "DEEL_OWNED_ITEM_WITHOUT_RENTAL_CONTRACT", "DESKTOP_STORAGE", "ENDING_CONTRACT", "HUB_IN_SAME_REGION_AS_LOCAL", "INACTIVE", "INVALID_ITEM_LOCATION", "INVALID_ORGANIZATION_STATUS", "INVALID_STATE", "ITEM_CONDITIONS_TO_UNARCHIVE_NOT_MET", "ITEM_NOT_VISIBLE_FOR_ORGANIZATION", "NON_DEVICE", "NOT_AT_WAREHOUSE", "NOT_AVAILABLE_FOR_REUSE", "NOT_A_RENTAL", "NOT_MANAGEABLE_BY_ORGANIZATION", "NOT_WITH_ASSIGNMENT", "NOT_WITH_USER", "NO_ACTIVE_ADDONS", "NO_ACTIVE_STORAGE_CONTRACT", "NO_LOCATION_FOR_STORAGE", "NO_LOGISTICS_FOR_STORAGE", "NO_VALID_ADDONS", "ONGOING_SERVICE", "OWNED_BY_DEEL", "OWNED_BY_ORGANIZATION", "OWNED_BY_PARTNER_ORGANIZATION", "PARTNER_CHILD_CONTRACT", "PENDING_DEVICE_REFRESH", "RENTAL_CONTRACT_AND_USER_REGION_DO_NOT_MATCH", "TEMPORARILY_UNAVAILABLE", "UNKNOWN", "USER_HAS_NO_COUNTRY", "USER_HAS_NO_SEAT", "WAITING_FOR_CLEARANCE", "WITH_LOANER_ASSIGNMENT", "WITH_NON_COLLECTED_ASSIGNMENT", "WITH_NON_DELIVERED_ASSIGNMENT", "WITH_PENDING_ASSIGNMENT", "WRONG_ASSIGNMENT_STATUS", "WRONG_CONTRACT_STATUS", "WRONG_TERMS_AND_CONDITIONS" ], "title": "ItAssetsAssetIdUnarchivePostResponsesContentApplicationJsonSchemaDataActionsUpdateLocationUserToUserDisabledReasonsItems", "type": "string" }, "ItAssetsAssetIdUnarchivePostResponsesContentApplicationJsonSchemaDataActionsUpdateLocationUserToUserStatus": { "description": "Whether the action is currently available for this asset", "enum": [ "DISABLED", "ENABLED", "NOT_APPLICABLE" ], "title": "ItAssetsAssetIdUnarchivePostResponsesContentApplicationJsonSchemaDataActionsUpdateLocationUserToUserStatus", "type": "string" }, "ItAssetsAssetIdUnarchivePostResponsesContentApplicationJsonSchemaDataActionsUpdateOwnAssetDetails": { "description": "Update editable details of an organization-owned asset", "properties": { "disabled_reasons": { "description": "Reasons why the action is disabled. Empty when the action is enabled or not applicable", "items": { "$ref": "#/components/schemas/ItAssetsAssetIdUnarchivePostResponsesContentApplicationJsonSchemaDataActionsUpdateOwnAssetDetailsDisabledReasonsItems" }, "type": "array" }, "status": { "$ref": "#/components/schemas/ItAssetsAssetIdUnarchivePostResponsesContentApplicationJsonSchemaDataActionsUpdateOwnAssetDetailsStatus", "description": "Whether the action is currently available for this asset" } }, "required": [ "status", "disabled_reasons" ], "title": "ItAssetsAssetIdUnarchivePostResponsesContentApplicationJsonSchemaDataActionsUpdateOwnAssetDetails", "type": "object" }, "ItAssetsAssetIdUnarchivePostResponsesContentApplicationJsonSchemaDataActionsUpdateOwnAssetDetailsDisabledReasonsItems": { "enum": [ "ARCHIVED", "AT_DEEL_WAREHOUSE", "BEING_REPAIRED", "CONSUMABLE", "CONTROLLED_BY_DEEL", "COUNTRY_NOT_SUPPORTED_FOR_HUB", "COUNTRY_NOT_SUPPORTED_FOR_LOCAL", "DEEL_OWNED_ITEM_WITHOUT_RENTAL_CONTRACT", "DESKTOP_STORAGE", "ENDING_CONTRACT", "HUB_IN_SAME_REGION_AS_LOCAL", "INACTIVE", "INVALID_ITEM_LOCATION", "INVALID_ORGANIZATION_STATUS", "INVALID_STATE", "ITEM_CONDITIONS_TO_UNARCHIVE_NOT_MET", "ITEM_NOT_VISIBLE_FOR_ORGANIZATION", "NON_DEVICE", "NOT_AT_WAREHOUSE", "NOT_AVAILABLE_FOR_REUSE", "NOT_A_RENTAL", "NOT_MANAGEABLE_BY_ORGANIZATION", "NOT_WITH_ASSIGNMENT", "NOT_WITH_USER", "NO_ACTIVE_ADDONS", "NO_ACTIVE_STORAGE_CONTRACT", "NO_LOCATION_FOR_STORAGE", "NO_LOGISTICS_FOR_STORAGE", "NO_VALID_ADDONS", "ONGOING_SERVICE", "OWNED_BY_DEEL", "OWNED_BY_ORGANIZATION", "OWNED_BY_PARTNER_ORGANIZATION", "PARTNER_CHILD_CONTRACT", "PENDING_DEVICE_REFRESH", "RENTAL_CONTRACT_AND_USER_REGION_DO_NOT_MATCH", "TEMPORARILY_UNAVAILABLE", "UNKNOWN", "USER_HAS_NO_COUNTRY", "USER_HAS_NO_SEAT", "WAITING_FOR_CLEARANCE", "WITH_LOANER_ASSIGNMENT", "WITH_NON_COLLECTED_ASSIGNMENT", "WITH_NON_DELIVERED_ASSIGNMENT", "WITH_PENDING_ASSIGNMENT", "WRONG_ASSIGNMENT_STATUS", "WRONG_CONTRACT_STATUS", "WRONG_TERMS_AND_CONDITIONS" ], "title": "ItAssetsAssetIdUnarchivePostResponsesContentApplicationJsonSchemaDataActionsUpdateOwnAssetDetailsDisabledReasonsItems", "type": "string" }, "ItAssetsAssetIdUnarchivePostResponsesContentApplicationJsonSchemaDataActionsUpdateOwnAssetDetailsStatus": { "description": "Whether the action is currently available for this asset", "enum": [ "DISABLED", "ENABLED", "NOT_APPLICABLE" ], "title": "ItAssetsAssetIdUnarchivePostResponsesContentApplicationJsonSchemaDataActionsUpdateOwnAssetDetailsStatus", "type": "string" }, "ItAssetsAssetIdUnarchivePostResponsesContentApplicationJsonSchemaDataAssignedUser": { "description": "Details of the user with asset possession", "properties": { "emails": { "description": "Array of user email addresses", "items": { "format": "email", "type": "string" }, "type": "array" }, "first_name": { "description": "First name of the user", "type": "string" }, "hris_profile_id": { "description": "The unique identifier of the HRIS profile of the assigned user", "format": "uuid", "type": "string" }, "last_name": { "description": "Last name of the user", "type": "string" } }, "required": [ "emails", "last_name", "first_name", "hris_profile_id" ], "title": "ItAssetsAssetIdUnarchivePostResponsesContentApplicationJsonSchemaDataAssignedUser", "type": "object" }, "ItAssetsAssetIdUnarchivePostResponsesContentApplicationJsonSchemaDataAssignedWarehouse": { "description": "Details of the warehouse with asset possession", "properties": { "address": { "$ref": "#/components/schemas/ItAssetsAssetIdUnarchivePostResponsesContentApplicationJsonSchemaDataAssignedWarehouseAddress", "description": "Warehouse address details" }, "id": { "description": "Unique identifier of the warehouse", "format": "uuid", "type": "string" }, "name": { "description": "Warehouse or storage location name", "type": "string" }, "ownership": { "$ref": "#/components/schemas/ItAssetsAssetIdUnarchivePostResponsesContentApplicationJsonSchemaDataAssignedWarehouseOwnership", "description": "Warehouse ownership type" }, "public_id": { "description": "Public identifier of the warehouse", "type": "string" }, "warehouse_type": { "$ref": "#/components/schemas/ItAssetsAssetIdUnarchivePostResponsesContentApplicationJsonSchemaDataAssignedWarehouseWarehouseType", "description": "Warehouse type" } }, "required": [ "id", "name", "address", "ownership", "public_id", "warehouse_type" ], "title": "ItAssetsAssetIdUnarchivePostResponsesContentApplicationJsonSchemaDataAssignedWarehouse", "type": "object" }, "ItAssetsAssetIdUnarchivePostResponsesContentApplicationJsonSchemaDataAssignedWarehouseAddress": { "description": "Warehouse address details", "properties": { "city": { "description": "City name", "type": [ "string", "null" ] }, "country": { "$ref": "#/components/schemas/ItAssetsAssetIdUnarchivePostResponsesContentApplicationJsonSchemaDataAssignedWarehouseAddressCountry", "description": "Country code" }, "date_of_birth": { "description": "Date of birth (applicable for some address types)", "format": "date", "type": [ "string", "null" ] }, "delivery_instructions": { "description": "Special instructions for deliveries", "type": [ "string", "null" ] }, "id": { "description": "Unique identifier of the address", "format": "uuid", "type": "string" }, "is_valid": { "description": "Whether the address passes validation", "type": "boolean" }, "line1": { "description": "Address line 1", "type": [ "string", "null" ] }, "line2": { "description": "Address line 2", "type": [ "string", "null" ] }, "passport_number": { "description": "Passport number (applicable for some address types)", "type": [ "string", "null" ] }, "phone_number": { "description": "Phone number", "type": [ "string", "null" ] }, "post_code": { "description": "Post code", "type": [ "string", "null" ] }, "state": { "description": "State code or name", "type": [ "string", "null" ] }, "tax_id_number": { "description": "Tax ID number (applicable for some address types)", "type": [ "string", "null" ] }, "type": { "$ref": "#/components/schemas/ItAssetsAssetIdUnarchivePostResponsesContentApplicationJsonSchemaDataAssignedWarehouseAddressType", "description": "Type of the address" } }, "required": [ "id", "city", "type", "line1", "line2", "state", "country", "is_valid", "post_code", "phone_number", "date_of_birth", "tax_id_number", "passport_number", "delivery_instructions" ], "title": "ItAssetsAssetIdUnarchivePostResponsesContentApplicationJsonSchemaDataAssignedWarehouseAddress", "type": "object" }, "ItAssetsAssetIdUnarchivePostResponsesContentApplicationJsonSchemaDataAssignedWarehouseAddressCountry": { "description": "Country code", "enum": [ "AD", "AE", "AF", "AG", "AI", "AL", "AM", "AN", "AO", "AQ", "AR", "AS", "AT", "AU", "AW", "AX", "AZ", "BA", "BB", "BD", "BE", "BF", "BG", "BH", "BI", "BJ", "BL", "BM", "BN", "BO", "BQ", "BR", "BS", "BT", "BV", "BW", "BY", "BZ", "CA", "CC", "CD", "CF", "CG", "CH", "CI", "CK", "CL", "CM", "CN", "CO", "CR", "CU", "CV", "CW", "CX", "CY", "CZ", "DE", "DJ", "DK", "DM", "DO", "DZ", "EC", "EE", "EG", "EH", "ER", "ES", "ET", "FI", "FJ", "FK", "FM", "FO", "FR", "GA", "GB", "GD", "GE", "GF", "GG", "GH", "GI", "GL", "GM", "GN", "GP", "GQ", "GR", "GS", "GT", "GU", "GW", "GY", "HK", "HM", "HN", "HR", "HT", "HU", "IC", "ID", "IE", "IL", "IM", "IN", "IO", "IQ", "IR", "IS", "IT", "JE", "JM", "JO", "JP", "KE", "KG", "KH", "KI", "KM", "KN", "KP", "KR", "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", "XK", "YE", "YT", "ZA", "ZM", "ZW" ], "title": "ItAssetsAssetIdUnarchivePostResponsesContentApplicationJsonSchemaDataAssignedWarehouseAddressCountry", "type": "string" }, "ItAssetsAssetIdUnarchivePostResponsesContentApplicationJsonSchemaDataAssignedWarehouseAddressType": { "description": "Type of the address", "enum": [ "BILLING", "COLLECTION", "DELIVERY", "ENTITY", "PARTIAL", "PII", "SUPPLIER" ], "title": "ItAssetsAssetIdUnarchivePostResponsesContentApplicationJsonSchemaDataAssignedWarehouseAddressType", "type": "string" }, "ItAssetsAssetIdUnarchivePostResponsesContentApplicationJsonSchemaDataAssignedWarehouseOwnership": { "description": "Warehouse ownership type", "enum": [ "DEEL", "ORGANIZATION" ], "title": "ItAssetsAssetIdUnarchivePostResponsesContentApplicationJsonSchemaDataAssignedWarehouseOwnership", "type": "string" }, "ItAssetsAssetIdUnarchivePostResponsesContentApplicationJsonSchemaDataAssignedWarehouseWarehouseType": { "description": "Warehouse type", "enum": [ "CLEARANCE", "DEEL", "ORGANIZATION" ], "title": "ItAssetsAssetIdUnarchivePostResponsesContentApplicationJsonSchemaDataAssignedWarehouseWarehouseType", "type": "string" }, "ItAssetsAssetIdUnarchivePostResponsesContentApplicationJsonSchemaDataGrade": { "description": "The condition grade of the asset", "enum": [ "A", "B", "C", "D", "F", "NEW" ], "title": "ItAssetsAssetIdUnarchivePostResponsesContentApplicationJsonSchemaDataGrade", "type": "string" }, "ItAssetsAssetIdUnarchivePostResponsesContentApplicationJsonSchemaDataLocation": { "description": "Current location type of the asset", "enum": [ "AT_WAREHOUSE", "CLEARANCE_WAREHOUSE", "DEEL_WAREHOUSE", "ORGANIZATION_WAREHOUSE", "SUPPLIER", "WITH_COURIER", "WITH_USER", "WRITE_OFF" ], "title": "ItAssetsAssetIdUnarchivePostResponsesContentApplicationJsonSchemaDataLocation", "type": "string" }, "ItAssetsAssetIdUnarchivePostResponsesContentApplicationJsonSchemaDataOwnership": { "description": "Asset owner", "properties": { "name": { "description": "Asset owner name", "type": "string" }, "type": { "$ref": "#/components/schemas/ItAssetsAssetIdUnarchivePostResponsesContentApplicationJsonSchemaDataOwnershipType", "description": "Asset owner type" } }, "required": [ "name", "type" ], "title": "ItAssetsAssetIdUnarchivePostResponsesContentApplicationJsonSchemaDataOwnership", "type": "object" }, "ItAssetsAssetIdUnarchivePostResponsesContentApplicationJsonSchemaDataOwnershipType": { "description": "Asset owner type", "enum": [ "DEEL", "ORGANIZATION" ], "title": "ItAssetsAssetIdUnarchivePostResponsesContentApplicationJsonSchemaDataOwnershipType", "type": "string" }, "ItAssetsAssetIdUnarchivePostResponsesContentApplicationJsonSchemaDataProduct": { "description": "Product details", "properties": { "brand": { "description": "Product brand", "type": "string" }, "category": { "$ref": "#/components/schemas/ItAssetsAssetIdUnarchivePostResponsesContentApplicationJsonSchemaDataProductCategory", "description": "Product category" }, "id": { "description": "Unique identifier of the product", "format": "uuid", "type": "string" }, "name": { "description": "Product name", "type": "string" }, "specifications": { "description": "Specifications of the product", "items": { "$ref": "#/components/schemas/ItAssetsAssetIdUnarchivePostResponsesContentApplicationJsonSchemaDataProductSpecificationsItems" }, "type": "array" } }, "required": [ "id", "name", "brand", "category", "specifications" ], "title": "ItAssetsAssetIdUnarchivePostResponsesContentApplicationJsonSchemaDataProduct", "type": "object" }, "ItAssetsAssetIdUnarchivePostResponsesContentApplicationJsonSchemaDataProductCategory": { "description": "Product category", "enum": [ "ADAPTER", "CABLE", "CHAIR", "CHARGER", "COMPACT_DESKTOP", "DESK", "DESKTOP", "DESK_RISER", "DESK_TIDY", "DOCKING_STATION", "DONGLE", "FOOTREST", "HEADSET", "KEYBOARD", "LAPTOP", "LAPTOP_STAND", "MICE_TRACKPAD", "MOBILE_DEVICE", "MONITOR", "MONITOR_ARM", "OTHER", "PRINTER", "SHREDDER", "STANDING_MAT", "TABLET", "TASK_LIGHT", "WEBCAM", "WELCOME_PACK", "WIFI_RANGE_EXTENDER" ], "title": "ItAssetsAssetIdUnarchivePostResponsesContentApplicationJsonSchemaDataProductCategory", "type": "string" }, "ItAssetsAssetIdUnarchivePostResponsesContentApplicationJsonSchemaDataProductSpecificationsItems": { "properties": { "name": { "description": "Specification name", "type": "string" }, "value": { "description": "Specification value", "type": "string" } }, "required": [ "name", "value" ], "title": "ItAssetsAssetIdUnarchivePostResponsesContentApplicationJsonSchemaDataProductSpecificationsItems", "type": "object" }, "ItAssetsAssetIdUnarchivePostResponsesContentApplicationJsonSchemaDataPurchaseValue": { "description": "Purchase value of the asset", "properties": { "amount": { "description": "Amount", "format": "decimal", "type": "string" }, "currency": { "$ref": "#/components/schemas/ItAssetsAssetIdUnarchivePostResponsesContentApplicationJsonSchemaDataPurchaseValueCurrency", "description": "Three-letter currency code for the price" } }, "required": [ "amount", "currency" ], "title": "ItAssetsAssetIdUnarchivePostResponsesContentApplicationJsonSchemaDataPurchaseValue", "type": "object" }, "ItAssetsAssetIdUnarchivePostResponsesContentApplicationJsonSchemaDataPurchaseValueCurrency": { "description": "Three-letter currency code for the price", "enum": [ "AED", "AFN", "ALL", "AMD", "ANG", "AOA", "ARS", "AUD", "AWG", "AZN", "BAM", "BDT", "BGN", "BHD", "BIF", "BMD", "BOB", "BRL", "BSD", "BTN", "BWP", "BYN", "BZD", "CAD", "CDF", "CHF", "CLP", "CNY", "COP", "CRC", "CUC", "CVE", "CZK", "DJF", "DKK", "DOP", "DZD", "EGP", "ERN", "ETB", "EUR", "FJD", "FKP", "GBP", "GEL", "GHS", "GIP", "GMD", "GNF", "GTQ", "GYD", "HKD", "HNL", "HRK", "HTG", "HUF", "IDR", "ILS", "INR", "IQD", "IRR", "ISK", "JMD", "JOD", "JPY", "KES", "KGS", "KHR", "KMF", "KPW", "KRW", "KWD", "KYD", "KZT", "LAK", "LBP", "LKR", "LRD", "LSL", "LTL", "LYD", "MAD", "MDL", "MGA", "MKD", "MMK", "MNT", "MRU", "MUR", "MVR", "MWK", "MXN", "MYR", "MZN", "NAD", "NGN", "NIO", "NOK", "NPR", "NZD", "OMR", "PAB", "PEN", "PGK", "PHP", "PKR", "PLN", "PYG", "QAR", "RON", "RSD", "RUB", "RWF", "SAR", "SBD", "SCR", "SDG", "SEK", "SGD", "SHP", "SLL", "SOS", "SRD", "SSP", "STD", "SYP", "SZL", "THB", "TJS", "TMT", "TND", "TOP", "TRY", "TTD", "TWD", "TZS", "UAH", "UGX", "USD", "UYU", "UZS", "VEF", "VND", "VUV", "WST", "XAF", "XCD", "XOF", "XPF", "YER", "ZAR", "ZMW", "ZWD" ], "title": "ItAssetsAssetIdUnarchivePostResponsesContentApplicationJsonSchemaDataPurchaseValueCurrency", "type": "string" }, "ItAssetsAssetIdUnarchivePostResponsesContentApplicationJsonSchemaDataStatus": { "description": "Current state of the asset", "enum": [ "ACTIVE", "ADDED_BY_MISTAKE", "BEING_REPAIRED", "BINNED", "BROKEN_AT_WAREHOUSE", "BROKEN_BY_USER", "BROKEN_IN_TRANSIT", "CLEARED", "DAMAGED_AT_WAREHOUSE", "DAMAGED_BY_USER", "DAMAGED_IN_TRANSIT", "LEFT_WITH_USER", "LOST_IN_TRANSIT", "RETURNED_TO_DEEL", "SHRINKAGE", "STOLEN", "SUPPLIER_RETURN", "WAITING_FOR_CLEARANCE" ], "title": "ItAssetsAssetIdUnarchivePostResponsesContentApplicationJsonSchemaDataStatus", "type": "string" }, "ItAssetsAssetIdUnarchivePostResponsesContentApplicationJsonSchemaErrorsItems": { "properties": { "code": { "description": "Error code of the handler which produced the returned error", "type": "string" }, "field": { "description": "The field name where input validation failed", "type": [ "string", "null" ] }, "message": { "description": "Description of the returned error", "type": "string" } }, "required": [ "code", "field", "message" ], "title": "ItAssetsAssetIdUnarchivePostResponsesContentApplicationJsonSchemaErrorsItems", "type": "object" }, "ItAssetsGetParametersCategory": { "enum": [ "ADAPTER", "CABLE", "CHAIR", "CHARGER", "COMPACT_DESKTOP", "DESK", "DESKTOP", "DESK_RISER", "DESK_TIDY", "DOCKING_STATION", "DONGLE", "FOOTREST", "HEADSET", "KEYBOARD", "LAPTOP", "LAPTOP_STAND", "MICE_TRACKPAD", "MOBILE_DEVICE", "MONITOR", "MONITOR_ARM", "OTHER", "PRINTER", "SHREDDER", "STANDING_MAT", "TABLET", "TASK_LIGHT", "WEBCAM", "WELCOME_PACK", "WIFI_RANGE_EXTENDER" ], "title": "ItAssetsGetParametersCategory", "type": "string" }, "ItAssetsGetParametersLocation": { "enum": [ "AT_WAREHOUSE", "CLEARANCE_WAREHOUSE", "DEEL_WAREHOUSE", "ORGANIZATION_WAREHOUSE", "SUPPLIER", "WITH_COURIER", "WITH_USER", "WRITE_OFF" ], "title": "ItAssetsGetParametersLocation", "type": "string" }, "ItAssetsGetParametersStatus": { "enum": [ "ACTIVE", "ARCHIVED" ], "title": "ItAssetsGetParametersStatus", "type": "string" }, "ItAssetsGetResponsesContentApplicationJsonSchemaDataItems": { "properties": { "assigned_user": { "description": "Details of the user with asset possession", "oneOf": [ { "$ref": "#/components/schemas/ItAssetsGetResponsesContentApplicationJsonSchemaDataItemsAssignedUser" }, { "type": "null" } ] }, "assigned_warehouse": { "description": "Details of the warehouse with asset possession", "oneOf": [ { "$ref": "#/components/schemas/ItAssetsGetResponsesContentApplicationJsonSchemaDataItemsAssignedWarehouse" }, { "type": "null" } ] }, "created_at": { "description": "Creation timestamp of the asset", "format": "date-time", "type": "string" }, "grade": { "$ref": "#/components/schemas/ItAssetsGetResponsesContentApplicationJsonSchemaDataItemsGrade", "description": "The condition grade of the asset" }, "id": { "description": "Unique identifier of the item", "format": "uuid", "type": "string" }, "location": { "$ref": "#/components/schemas/ItAssetsGetResponsesContentApplicationJsonSchemaDataItemsLocation", "description": "Current location type of the asset" }, "ownership": { "$ref": "#/components/schemas/ItAssetsGetResponsesContentApplicationJsonSchemaDataItemsOwnership", "description": "Asset owner" }, "product": { "$ref": "#/components/schemas/ItAssetsGetResponsesContentApplicationJsonSchemaDataItemsProduct", "description": "Product details" }, "public_id": { "description": "Public identifier of the item", "type": "string" }, "purchase_date": { "description": "Purchase date of the asset", "format": "date", "type": [ "string", "null" ] }, "purchase_value": { "description": "Purchase value of the asset", "oneOf": [ { "$ref": "#/components/schemas/ItAssetsGetResponsesContentApplicationJsonSchemaDataItemsPurchaseValue" }, { "type": "null" } ] }, "serial_number": { "description": "Asset serial number", "type": [ "string", "null" ] }, "status": { "$ref": "#/components/schemas/ItAssetsGetResponsesContentApplicationJsonSchemaDataItemsStatus", "description": "Current state of the asset" }, "updated_at": { "description": "Last update timestamp of the asset", "format": "date-time", "type": "string" } }, "required": [ "id", "grade", "status", "product", "location", "ownership", "public_id", "created_at", "updated_at", "assigned_user", "purchase_date", "serial_number", "purchase_value", "assigned_warehouse" ], "title": "ItAssetsGetResponsesContentApplicationJsonSchemaDataItems", "type": "object" }, "ItAssetsGetResponsesContentApplicationJsonSchemaDataItemsAssignedUser": { "description": "Details of the user with asset possession", "properties": { "address": { "$ref": "#/components/schemas/ItAssetsGetResponsesContentApplicationJsonSchemaDataItemsAssignedUserAddress", "description": "User address details" }, "emails": { "description": "Array of user email addresses", "items": { "format": "email", "type": "string" }, "type": "array" }, "first_name": { "description": "First name of the user", "type": "string" }, "hris_profile_id": { "description": "The unique identifier of the HRIS profile of the assigned user", "format": "uuid", "type": "string" }, "last_name": { "description": "Last name of the user", "type": "string" } }, "required": [ "emails", "address", "last_name", "first_name", "hris_profile_id" ], "title": "ItAssetsGetResponsesContentApplicationJsonSchemaDataItemsAssignedUser", "type": "object" }, "ItAssetsGetResponsesContentApplicationJsonSchemaDataItemsAssignedUserAddress": { "description": "User address details", "properties": { "city": { "description": "City name", "type": [ "string", "null" ] }, "country": { "$ref": "#/components/schemas/ItAssetsGetResponsesContentApplicationJsonSchemaDataItemsAssignedUserAddressCountry", "description": "Country code" }, "date_of_birth": { "description": "Date of birth (applicable for some address types)", "format": "date", "type": [ "string", "null" ] }, "delivery_instructions": { "description": "Special instructions for deliveries", "type": [ "string", "null" ] }, "id": { "description": "Unique identifier of the address", "format": "uuid", "type": "string" }, "is_valid": { "description": "Whether the address passes validation", "type": "boolean" }, "line1": { "description": "Address line 1", "type": [ "string", "null" ] }, "line2": { "description": "Address line 2", "type": [ "string", "null" ] }, "passport_number": { "description": "Passport number (applicable for some address types)", "type": [ "string", "null" ] }, "phone_number": { "description": "Phone number", "type": [ "string", "null" ] }, "post_code": { "description": "Post code", "type": [ "string", "null" ] }, "state": { "description": "State code or name", "type": [ "string", "null" ] }, "tax_id_number": { "description": "Tax ID number (applicable for some address types)", "type": [ "string", "null" ] }, "type": { "$ref": "#/components/schemas/ItAssetsGetResponsesContentApplicationJsonSchemaDataItemsAssignedUserAddressType", "description": "Type of the address" } }, "required": [ "id", "city", "type", "line1", "line2", "state", "country", "is_valid", "post_code", "phone_number", "date_of_birth", "tax_id_number", "passport_number", "delivery_instructions" ], "title": "ItAssetsGetResponsesContentApplicationJsonSchemaDataItemsAssignedUserAddress", "type": "object" }, "ItAssetsGetResponsesContentApplicationJsonSchemaDataItemsAssignedUserAddressCountry": { "description": "Country code", "enum": [ "AD", "AE", "AF", "AG", "AI", "AL", "AM", "AN", "AO", "AQ", "AR", "AS", "AT", "AU", "AW", "AX", "AZ", "BA", "BB", "BD", "BE", "BF", "BG", "BH", "BI", "BJ", "BL", "BM", "BN", "BO", "BQ", "BR", "BS", "BT", "BV", "BW", "BY", "BZ", "CA", "CC", "CD", "CF", "CG", "CH", "CI", "CK", "CL", "CM", "CN", "CO", "CR", "CU", "CV", "CW", "CX", "CY", "CZ", "DE", "DJ", "DK", "DM", "DO", "DZ", "EC", "EE", "EG", "EH", "ER", "ES", "ET", "FI", "FJ", "FK", "FM", "FO", "FR", "GA", "GB", "GD", "GE", "GF", "GG", "GH", "GI", "GL", "GM", "GN", "GP", "GQ", "GR", "GS", "GT", "GU", "GW", "GY", "HK", "HM", "HN", "HR", "HT", "HU", "IC", "ID", "IE", "IL", "IM", "IN", "IO", "IQ", "IR", "IS", "IT", "JE", "JM", "JO", "JP", "KE", "KG", "KH", "KI", "KM", "KN", "KP", "KR", "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", "XK", "YE", "YT", "ZA", "ZM", "ZW" ], "title": "ItAssetsGetResponsesContentApplicationJsonSchemaDataItemsAssignedUserAddressCountry", "type": "string" }, "ItAssetsGetResponsesContentApplicationJsonSchemaDataItemsAssignedUserAddressType": { "description": "Type of the address", "enum": [ "BILLING", "COLLECTION", "DELIVERY", "ENTITY", "PARTIAL", "PII", "SUPPLIER" ], "title": "ItAssetsGetResponsesContentApplicationJsonSchemaDataItemsAssignedUserAddressType", "type": "string" }, "ItAssetsGetResponsesContentApplicationJsonSchemaDataItemsAssignedWarehouse": { "description": "Details of the warehouse with asset possession", "properties": { "address": { "$ref": "#/components/schemas/ItAssetsGetResponsesContentApplicationJsonSchemaDataItemsAssignedWarehouseAddress", "description": "Warehouse address details" }, "id": { "description": "Unique identifier of the warehouse", "format": "uuid", "type": "string" }, "name": { "description": "Warehouse or storage location name", "type": "string" }, "ownership": { "$ref": "#/components/schemas/ItAssetsGetResponsesContentApplicationJsonSchemaDataItemsAssignedWarehouseOwnership", "description": "Warehouse ownership type" }, "public_id": { "description": "Public identifier of the warehouse", "type": "string" }, "warehouse_type": { "$ref": "#/components/schemas/ItAssetsGetResponsesContentApplicationJsonSchemaDataItemsAssignedWarehouseWarehouseType", "description": "Warehouse type" } }, "required": [ "id", "name", "address", "ownership", "public_id", "warehouse_type" ], "title": "ItAssetsGetResponsesContentApplicationJsonSchemaDataItemsAssignedWarehouse", "type": "object" }, "ItAssetsGetResponsesContentApplicationJsonSchemaDataItemsAssignedWarehouseAddress": { "description": "Warehouse address details", "properties": { "city": { "description": "City name", "type": [ "string", "null" ] }, "country": { "$ref": "#/components/schemas/ItAssetsGetResponsesContentApplicationJsonSchemaDataItemsAssignedWarehouseAddressCountry", "description": "Country code" }, "date_of_birth": { "description": "Date of birth (applicable for some address types)", "format": "date", "type": [ "string", "null" ] }, "delivery_instructions": { "description": "Special instructions for deliveries", "type": [ "string", "null" ] }, "id": { "description": "Unique identifier of the address", "format": "uuid", "type": "string" }, "is_valid": { "description": "Whether the address passes validation", "type": "boolean" }, "line1": { "description": "Address line 1", "type": [ "string", "null" ] }, "line2": { "description": "Address line 2", "type": [ "string", "null" ] }, "passport_number": { "description": "Passport number (applicable for some address types)", "type": [ "string", "null" ] }, "phone_number": { "description": "Phone number", "type": [ "string", "null" ] }, "post_code": { "description": "Post code", "type": [ "string", "null" ] }, "state": { "description": "State code or name", "type": [ "string", "null" ] }, "tax_id_number": { "description": "Tax ID number (applicable for some address types)", "type": [ "string", "null" ] }, "type": { "$ref": "#/components/schemas/ItAssetsGetResponsesContentApplicationJsonSchemaDataItemsAssignedWarehouseAddressType", "description": "Type of the address" } }, "required": [ "id", "city", "type", "line1", "line2", "state", "country", "is_valid", "post_code", "phone_number", "date_of_birth", "tax_id_number", "passport_number", "delivery_instructions" ], "title": "ItAssetsGetResponsesContentApplicationJsonSchemaDataItemsAssignedWarehouseAddress", "type": "object" }, "ItAssetsGetResponsesContentApplicationJsonSchemaDataItemsAssignedWarehouseAddressCountry": { "description": "Country code", "enum": [ "AD", "AE", "AF", "AG", "AI", "AL", "AM", "AN", "AO", "AQ", "AR", "AS", "AT", "AU", "AW", "AX", "AZ", "BA", "BB", "BD", "BE", "BF", "BG", "BH", "BI", "BJ", "BL", "BM", "BN", "BO", "BQ", "BR", "BS", "BT", "BV", "BW", "BY", "BZ", "CA", "CC", "CD", "CF", "CG", "CH", "CI", "CK", "CL", "CM", "CN", "CO", "CR", "CU", "CV", "CW", "CX", "CY", "CZ", "DE", "DJ", "DK", "DM", "DO", "DZ", "EC", "EE", "EG", "EH", "ER", "ES", "ET", "FI", "FJ", "FK", "FM", "FO", "FR", "GA", "GB", "GD", "GE", "GF", "GG", "GH", "GI", "GL", "GM", "GN", "GP", "GQ", "GR", "GS", "GT", "GU", "GW", "GY", "HK", "HM", "HN", "HR", "HT", "HU", "IC", "ID", "IE", "IL", "IM", "IN", "IO", "IQ", "IR", "IS", "IT", "JE", "JM", "JO", "JP", "KE", "KG", "KH", "KI", "KM", "KN", "KP", "KR", "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", "XK", "YE", "YT", "ZA", "ZM", "ZW" ], "title": "ItAssetsGetResponsesContentApplicationJsonSchemaDataItemsAssignedWarehouseAddressCountry", "type": "string" }, "ItAssetsGetResponsesContentApplicationJsonSchemaDataItemsAssignedWarehouseAddressType": { "description": "Type of the address", "enum": [ "BILLING", "COLLECTION", "DELIVERY", "ENTITY", "PARTIAL", "PII", "SUPPLIER" ], "title": "ItAssetsGetResponsesContentApplicationJsonSchemaDataItemsAssignedWarehouseAddressType", "type": "string" }, "ItAssetsGetResponsesContentApplicationJsonSchemaDataItemsAssignedWarehouseOwnership": { "description": "Warehouse ownership type", "enum": [ "DEEL", "ORGANIZATION" ], "title": "ItAssetsGetResponsesContentApplicationJsonSchemaDataItemsAssignedWarehouseOwnership", "type": "string" }, "ItAssetsGetResponsesContentApplicationJsonSchemaDataItemsAssignedWarehouseWarehouseType": { "description": "Warehouse type", "enum": [ "CLEARANCE", "DEEL", "ORGANIZATION" ], "title": "ItAssetsGetResponsesContentApplicationJsonSchemaDataItemsAssignedWarehouseWarehouseType", "type": "string" }, "ItAssetsGetResponsesContentApplicationJsonSchemaDataItemsGrade": { "description": "The condition grade of the asset", "enum": [ "A", "B", "C", "D", "F", "NEW" ], "title": "ItAssetsGetResponsesContentApplicationJsonSchemaDataItemsGrade", "type": "string" }, "ItAssetsGetResponsesContentApplicationJsonSchemaDataItemsLocation": { "description": "Current location type of the asset", "enum": [ "AT_WAREHOUSE", "CLEARANCE_WAREHOUSE", "DEEL_WAREHOUSE", "ORGANIZATION_WAREHOUSE", "SUPPLIER", "WITH_COURIER", "WITH_USER", "WRITE_OFF" ], "title": "ItAssetsGetResponsesContentApplicationJsonSchemaDataItemsLocation", "type": "string" }, "ItAssetsGetResponsesContentApplicationJsonSchemaDataItemsOwnership": { "description": "Asset owner", "properties": { "name": { "description": "Asset owner name", "type": "string" }, "type": { "$ref": "#/components/schemas/ItAssetsGetResponsesContentApplicationJsonSchemaDataItemsOwnershipType", "description": "Asset owner type" } }, "required": [ "name", "type" ], "title": "ItAssetsGetResponsesContentApplicationJsonSchemaDataItemsOwnership", "type": "object" }, "ItAssetsGetResponsesContentApplicationJsonSchemaDataItemsOwnershipType": { "description": "Asset owner type", "enum": [ "DEEL", "ORGANIZATION" ], "title": "ItAssetsGetResponsesContentApplicationJsonSchemaDataItemsOwnershipType", "type": "string" }, "ItAssetsGetResponsesContentApplicationJsonSchemaDataItemsProduct": { "description": "Product details", "properties": { "brand": { "description": "Product brand", "type": "string" }, "category": { "$ref": "#/components/schemas/ItAssetsGetResponsesContentApplicationJsonSchemaDataItemsProductCategory", "description": "Product category" }, "id": { "description": "Unique identifier of the product", "format": "uuid", "type": "string" }, "name": { "description": "Product name", "type": "string" } }, "required": [ "id", "name", "brand", "category" ], "title": "ItAssetsGetResponsesContentApplicationJsonSchemaDataItemsProduct", "type": "object" }, "ItAssetsGetResponsesContentApplicationJsonSchemaDataItemsProductCategory": { "description": "Product category", "enum": [ "ADAPTER", "CABLE", "CHAIR", "CHARGER", "COMPACT_DESKTOP", "DESK", "DESKTOP", "DESK_RISER", "DESK_TIDY", "DOCKING_STATION", "DONGLE", "FOOTREST", "HEADSET", "KEYBOARD", "LAPTOP", "LAPTOP_STAND", "MICE_TRACKPAD", "MOBILE_DEVICE", "MONITOR", "MONITOR_ARM", "OTHER", "PRINTER", "SHREDDER", "STANDING_MAT", "TABLET", "TASK_LIGHT", "WEBCAM", "WELCOME_PACK", "WIFI_RANGE_EXTENDER" ], "title": "ItAssetsGetResponsesContentApplicationJsonSchemaDataItemsProductCategory", "type": "string" }, "ItAssetsGetResponsesContentApplicationJsonSchemaDataItemsPurchaseValue": { "description": "Purchase value of the asset", "properties": { "amount": { "description": "Amount", "format": "decimal", "type": "string" }, "currency": { "$ref": "#/components/schemas/ItAssetsGetResponsesContentApplicationJsonSchemaDataItemsPurchaseValueCurrency", "description": "Three-letter currency code for the price" } }, "required": [ "amount", "currency" ], "title": "ItAssetsGetResponsesContentApplicationJsonSchemaDataItemsPurchaseValue", "type": "object" }, "ItAssetsGetResponsesContentApplicationJsonSchemaDataItemsPurchaseValueCurrency": { "description": "Three-letter currency code for the price", "enum": [ "AED", "AFN", "ALL", "AMD", "ANG", "AOA", "ARS", "AUD", "AWG", "AZN", "BAM", "BDT", "BGN", "BHD", "BIF", "BMD", "BOB", "BRL", "BSD", "BTN", "BWP", "BYN", "BZD", "CAD", "CDF", "CHF", "CLP", "CNY", "COP", "CRC", "CUC", "CVE", "CZK", "DJF", "DKK", "DOP", "DZD", "EGP", "ERN", "ETB", "EUR", "FJD", "FKP", "GBP", "GEL", "GHS", "GIP", "GMD", "GNF", "GTQ", "GYD", "HKD", "HNL", "HRK", "HTG", "HUF", "IDR", "ILS", "INR", "IQD", "IRR", "ISK", "JMD", "JOD", "JPY", "KES", "KGS", "KHR", "KMF", "KPW", "KRW", "KWD", "KYD", "KZT", "LAK", "LBP", "LKR", "LRD", "LSL", "LTL", "LYD", "MAD", "MDL", "MGA", "MKD", "MMK", "MNT", "MRU", "MUR", "MVR", "MWK", "MXN", "MYR", "MZN", "NAD", "NGN", "NIO", "NOK", "NPR", "NZD", "OMR", "PAB", "PEN", "PGK", "PHP", "PKR", "PLN", "PYG", "QAR", "RON", "RSD", "RUB", "RWF", "SAR", "SBD", "SCR", "SDG", "SEK", "SGD", "SHP", "SLL", "SOS", "SRD", "SSP", "STD", "SYP", "SZL", "THB", "TJS", "TMT", "TND", "TOP", "TRY", "TTD", "TWD", "TZS", "UAH", "UGX", "USD", "UYU", "UZS", "VEF", "VND", "VUV", "WST", "XAF", "XCD", "XOF", "XPF", "YER", "ZAR", "ZMW", "ZWD" ], "title": "ItAssetsGetResponsesContentApplicationJsonSchemaDataItemsPurchaseValueCurrency", "type": "string" }, "ItAssetsGetResponsesContentApplicationJsonSchemaDataItemsStatus": { "description": "Current state of the asset", "enum": [ "ACTIVE", "ADDED_BY_MISTAKE", "BEING_REPAIRED", "BINNED", "BROKEN_AT_WAREHOUSE", "BROKEN_BY_USER", "BROKEN_IN_TRANSIT", "CLEARED", "DAMAGED_AT_WAREHOUSE", "DAMAGED_BY_USER", "DAMAGED_IN_TRANSIT", "LEFT_WITH_USER", "LOST_IN_TRANSIT", "RETURNED_TO_DEEL", "SHRINKAGE", "STOLEN", "SUPPLIER_RETURN", "WAITING_FOR_CLEARANCE" ], "title": "ItAssetsGetResponsesContentApplicationJsonSchemaDataItemsStatus", "type": "string" }, "ItAssetsGetResponsesContentApplicationJsonSchemaErrorsItems": { "properties": { "code": { "description": "Error code of the handler which produced the returned error", "type": "string" }, "field": { "description": "The field name where input validation failed", "type": [ "string", "null" ] }, "message": { "description": "Description of the returned error", "type": "string" } }, "required": [ "code", "field", "message" ], "title": "ItAssetsGetResponsesContentApplicationJsonSchemaErrorsItems", "type": "object" }, "ItAssetsPostParametersXBeta": { "default": "true", "enum": [ "true" ], "title": "ItAssetsPostParametersXBeta", "type": "string" }, "ItAssetsPostRequestBodyContentApplicationJsonSchemaData": { "properties": { "brand": { "description": "Product brand. Free-form; well-known values (\"Apple\", \"Microsoft\", \"Dell\",\n\"Lenovo\", \"HP\") are normalized when passed with common aliases.", "type": "string" }, "category": { "$ref": "#/components/schemas/ItAssetsPostRequestBodyContentApplicationJsonSchemaDataCategory", "description": "Product category" }, "end_of_life_on": { "description": "End-of-life date for the asset", "format": "date", "type": "string" }, "grade": { "$ref": "#/components/schemas/ItAssetsPostRequestBodyContentApplicationJsonSchemaDataGrade", "description": "Condition grade of the asset. Currently ignored when location is AT_WAREHOUSE." }, "hris_profile_id": { "description": "HRIS profile ID of the user the asset is assigned to.\nRequired when location is WITH_USER.", "format": "uuid", "type": "string" }, "keyboard_layout": { "$ref": "#/components/schemas/ItAssetsPostRequestBodyContentApplicationJsonSchemaDataKeyboardLayout", "description": "Keyboard layout of the asset. Required for laptops." }, "location": { "$ref": "#/components/schemas/ItAssetsPostRequestBodyContentApplicationJsonSchemaDataLocation", "description": "Where the asset is located when created. Must be WITH_USER or AT_WAREHOUSE." }, "name": { "description": "Product name displayed for the asset", "type": "string" }, "operating_system": { "$ref": "#/components/schemas/ItAssetsPostRequestBodyContentApplicationJsonSchemaDataOperatingSystem", "description": "Operating system running on the asset. Required for device categories that\nsupport an operating system." }, "purchase_date": { "description": "Date the asset was purchased", "format": "date", "type": "string" }, "purchase_value": { "$ref": "#/components/schemas/ItAssetsPostRequestBodyContentApplicationJsonSchemaDataPurchaseValue", "description": "Price paid for the asset" }, "serial_number": { "description": "Asset serial number. Required for device categories.", "type": "string" }, "specifications": { "description": "Product specifications", "items": { "$ref": "#/components/schemas/ItAssetsPostRequestBodyContentApplicationJsonSchemaDataSpecificationsItems" }, "type": "array" }, "storage_location_id": { "description": "ID of the organization storage location the asset is stored at.\nRequired when location is AT_WAREHOUSE.", "format": "uuid", "type": "string" } }, "required": [ "name", "brand", "category", "location", "specifications" ], "title": "ItAssetsPostRequestBodyContentApplicationJsonSchemaData", "type": "object" }, "ItAssetsPostRequestBodyContentApplicationJsonSchemaDataCategory": { "description": "Product category", "enum": [ "ADAPTER", "CABLE", "CHAIR", "CHARGER", "COMPACT_DESKTOP", "DESK", "DESKTOP", "DESK_RISER", "DESK_TIDY", "DOCKING_STATION", "DONGLE", "FOOTREST", "HEADSET", "KEYBOARD", "LAPTOP", "LAPTOP_STAND", "MICE_TRACKPAD", "MOBILE_DEVICE", "MONITOR", "MONITOR_ARM", "OTHER", "PRINTER", "SHREDDER", "STANDING_MAT", "TABLET", "TASK_LIGHT", "WEBCAM", "WELCOME_PACK", "WIFI_RANGE_EXTENDER" ], "title": "ItAssetsPostRequestBodyContentApplicationJsonSchemaDataCategory", "type": "string" }, "ItAssetsPostRequestBodyContentApplicationJsonSchemaDataGrade": { "description": "Condition grade of the asset. Currently ignored when location is AT_WAREHOUSE.", "enum": [ "A", "B", "C", "D", "F", "NEW" ], "title": "ItAssetsPostRequestBodyContentApplicationJsonSchemaDataGrade", "type": "string" }, "ItAssetsPostRequestBodyContentApplicationJsonSchemaDataKeyboardLayout": { "description": "Keyboard layout of the asset. Required for laptops.", "enum": [ "BELGIAN_AZERTY", "CANADIAN_MULTILINGUAL_STANDARD_QWERTY", "CZECH_QWERTY", "DANISH_QWERTY", "DUTCH_QWERTY", "EGYPTIAN_LOCAL", "ENGLISH_RUSSIAN_QWERTY", "EU_STANDARD_QWERTY", "FRENCH_AZERTY", "GERMAN_QWERTZ", "INDIAN_QWERTY", "INTERNATIONAL_ENGLISH_QWERTY", "ITALIAN_QWERTY", "JAPANESE_QWERTY", "KOREAN_QWERTY", "LATAM_QWERTY", "NORWEGIAN_QWERTY", "PORTUGUESE_QWERTY", "SPANISH_QWERTY", "SWEDISH_QWERTY", "SWISS_FRENCH_QWERTZ", "SWISS_GERMAN_QWERTZ", "TURKISH_QWERTY", "UK_ENGLISH_QWERTY", "UNKNOWN", "US_ENGLISH_QWERTY" ], "title": "ItAssetsPostRequestBodyContentApplicationJsonSchemaDataKeyboardLayout", "type": "string" }, "ItAssetsPostRequestBodyContentApplicationJsonSchemaDataLocation": { "description": "Where the asset is located when created. Must be WITH_USER or AT_WAREHOUSE.", "enum": [ "AT_WAREHOUSE", "WITH_USER" ], "title": "ItAssetsPostRequestBodyContentApplicationJsonSchemaDataLocation", "type": "string" }, "ItAssetsPostRequestBodyContentApplicationJsonSchemaDataOperatingSystem": { "description": "Operating system running on the asset. Required for device categories that\nsupport an operating system.", "enum": [ "ANDROID_PHONE", "ANDROID_TABLET", "CHROME_OS", "IOS_PHONE", "IOS_TABLET", "LINUX", "MACOS", "WINDOWS" ], "title": "ItAssetsPostRequestBodyContentApplicationJsonSchemaDataOperatingSystem", "type": "string" }, "ItAssetsPostRequestBodyContentApplicationJsonSchemaDataPurchaseValue": { "description": "Price paid for the asset", "properties": { "amount": { "description": "Amount", "format": "decimal", "type": "string" }, "currency": { "$ref": "#/components/schemas/ItAssetsPostRequestBodyContentApplicationJsonSchemaDataPurchaseValueCurrency", "description": "Three-letter currency code for the price" } }, "required": [ "amount", "currency" ], "title": "ItAssetsPostRequestBodyContentApplicationJsonSchemaDataPurchaseValue", "type": "object" }, "ItAssetsPostRequestBodyContentApplicationJsonSchemaDataPurchaseValueCurrency": { "description": "Three-letter currency code for the price", "enum": [ "AED", "AFN", "ALL", "AMD", "ANG", "AOA", "ARS", "AUD", "AWG", "AZN", "BAM", "BDT", "BGN", "BHD", "BIF", "BMD", "BOB", "BRL", "BSD", "BTN", "BWP", "BYN", "BZD", "CAD", "CDF", "CHF", "CLP", "CNY", "COP", "CRC", "CUC", "CVE", "CZK", "DJF", "DKK", "DOP", "DZD", "EGP", "ERN", "ETB", "EUR", "FJD", "FKP", "GBP", "GEL", "GHS", "GIP", "GMD", "GNF", "GTQ", "GYD", "HKD", "HNL", "HRK", "HTG", "HUF", "IDR", "ILS", "INR", "IQD", "IRR", "ISK", "JMD", "JOD", "JPY", "KES", "KGS", "KHR", "KMF", "KPW", "KRW", "KWD", "KYD", "KZT", "LAK", "LBP", "LKR", "LRD", "LSL", "LTL", "LYD", "MAD", "MDL", "MGA", "MKD", "MMK", "MNT", "MRU", "MUR", "MVR", "MWK", "MXN", "MYR", "MZN", "NAD", "NGN", "NIO", "NOK", "NPR", "NZD", "OMR", "PAB", "PEN", "PGK", "PHP", "PKR", "PLN", "PYG", "QAR", "RON", "RSD", "RUB", "RWF", "SAR", "SBD", "SCR", "SDG", "SEK", "SGD", "SHP", "SLL", "SOS", "SRD", "SSP", "STD", "SYP", "SZL", "THB", "TJS", "TMT", "TND", "TOP", "TRY", "TTD", "TWD", "TZS", "UAH", "UGX", "USD", "UYU", "UZS", "VEF", "VND", "VUV", "WST", "XAF", "XCD", "XOF", "XPF", "YER", "ZAR", "ZMW", "ZWD" ], "title": "ItAssetsPostRequestBodyContentApplicationJsonSchemaDataPurchaseValueCurrency", "type": "string" }, "ItAssetsPostRequestBodyContentApplicationJsonSchemaDataSpecificationsItems": { "properties": { "name": { "$ref": "#/components/schemas/ItAssetsPostRequestBodyContentApplicationJsonSchemaDataSpecificationsItemsName", "description": "Specification key" }, "value": { "description": "Specification value", "type": "string" } }, "required": [ "name", "value" ], "title": "ItAssetsPostRequestBodyContentApplicationJsonSchemaDataSpecificationsItems", "type": "object" }, "ItAssetsPostRequestBodyContentApplicationJsonSchemaDataSpecificationsItemsName": { "description": "Specification key", "enum": [ "COLOR", "DISPLAY", "MEMORY", "PROCESSOR", "STORAGE" ], "title": "ItAssetsPostRequestBodyContentApplicationJsonSchemaDataSpecificationsItemsName", "type": "string" }, "ItAssetsPostResponsesContentApplicationJsonSchemaData": { "properties": { "actions": { "$ref": "#/components/schemas/ItAssetsPostResponsesContentApplicationJsonSchemaDataActions", "description": "Actions the caller can execute on this asset, with availability status per action" }, "assigned_user": { "description": "Details of the user with asset possession", "oneOf": [ { "$ref": "#/components/schemas/ItAssetsPostResponsesContentApplicationJsonSchemaDataAssignedUser" }, { "type": "null" } ] }, "assigned_warehouse": { "description": "Details of the warehouse with asset possession", "oneOf": [ { "$ref": "#/components/schemas/ItAssetsPostResponsesContentApplicationJsonSchemaDataAssignedWarehouse" }, { "type": "null" } ] }, "created_at": { "description": "Creation timestamp of the asset", "format": "date-time", "type": "string" }, "grade": { "$ref": "#/components/schemas/ItAssetsPostResponsesContentApplicationJsonSchemaDataGrade", "description": "The condition grade of the asset" }, "id": { "description": "Unique identifier of the item", "format": "uuid", "type": "string" }, "location": { "$ref": "#/components/schemas/ItAssetsPostResponsesContentApplicationJsonSchemaDataLocation", "description": "Current location type of the asset" }, "ownership": { "$ref": "#/components/schemas/ItAssetsPostResponsesContentApplicationJsonSchemaDataOwnership", "description": "Asset owner" }, "product": { "$ref": "#/components/schemas/ItAssetsPostResponsesContentApplicationJsonSchemaDataProduct", "description": "Product details" }, "public_id": { "description": "Public identifier of the item", "type": "string" }, "purchase_date": { "description": "Purchase date of the asset", "format": "date", "type": [ "string", "null" ] }, "purchase_value": { "description": "Purchase value of the asset", "oneOf": [ { "$ref": "#/components/schemas/ItAssetsPostResponsesContentApplicationJsonSchemaDataPurchaseValue" }, { "type": "null" } ] }, "serial_number": { "description": "Asset serial number", "type": [ "string", "null" ] }, "status": { "$ref": "#/components/schemas/ItAssetsPostResponsesContentApplicationJsonSchemaDataStatus", "description": "Current state of the asset" }, "updated_at": { "description": "Last update timestamp of the asset", "format": "date-time", "type": "string" } }, "required": [ "id", "grade", "status", "actions", "product", "location", "ownership", "public_id", "created_at", "updated_at", "assigned_user", "purchase_date", "serial_number", "purchase_value", "assigned_warehouse" ], "title": "ItAssetsPostResponsesContentApplicationJsonSchemaData", "type": "object" }, "ItAssetsPostResponsesContentApplicationJsonSchemaDataActions": { "description": "Actions the caller can execute on this asset, with availability status per action", "properties": { "archive_own_asset": { "$ref": "#/components/schemas/ItAssetsPostResponsesContentApplicationJsonSchemaDataActionsArchiveOwnAsset", "description": "Archive an organization-owned asset" }, "asset_country": { "description": "Resolved country used for asset actions. Derived from the asset's country,\nits assigned rental contract billing entity country, or the last active\nassignment delivery country. Null when the country cannot be determined\n(e.g. asset was returned to Deel)", "oneOf": [ { "$ref": "#/components/schemas/ItAssetsPostResponsesContentApplicationJsonSchemaDataActionsAssetCountry" }, { "type": "null" } ] }, "assign_addon_to_own_asset": { "$ref": "#/components/schemas/ItAssetsPostResponsesContentApplicationJsonSchemaDataActionsAssignAddonToOwnAsset", "description": "Assign an add-on to an organization-owned asset" }, "clear_own_asset": { "$ref": "#/components/schemas/ItAssetsPostResponsesContentApplicationJsonSchemaDataActionsClearOwnAsset", "description": "Clear an organization-owned asset from the fleet" }, "manage_end_of_rental_contract_actions": { "$ref": "#/components/schemas/ItAssetsPostResponsesContentApplicationJsonSchemaDataActionsManageEndOfRentalContractActions", "description": "Manage end-of-rental options for a Deel-owned rental asset" }, "purchase_rental": { "$ref": "#/components/schemas/ItAssetsPostResponsesContentApplicationJsonSchemaDataActionsPurchaseRental", "description": "Purchase a Deel-owned rental asset at end of contract" }, "return_rental_to_deel": { "$ref": "#/components/schemas/ItAssetsPostResponsesContentApplicationJsonSchemaDataActionsReturnRentalToDeel", "description": "Return a Deel-owned rental asset back to Deel" }, "reuse_own_asset_from_deel": { "$ref": "#/components/schemas/ItAssetsPostResponsesContentApplicationJsonSchemaDataActionsReuseOwnAssetFromDeel", "description": "Redeploy an organization-owned asset stored at a Deel warehouse" }, "reuse_own_asset_from_own_location": { "$ref": "#/components/schemas/ItAssetsPostResponsesContentApplicationJsonSchemaDataActionsReuseOwnAssetFromOwnLocation", "description": "Redeploy an organization-owned asset from an organization-owned location" }, "store_own_asset_at_deel_for_hub": { "$ref": "#/components/schemas/ItAssetsPostResponsesContentApplicationJsonSchemaDataActionsStoreOwnAssetAtDeelForHub", "description": "Store an organization-owned asset at a Deel hub warehouse" }, "store_own_asset_at_deel_for_local": { "$ref": "#/components/schemas/ItAssetsPostResponsesContentApplicationJsonSchemaDataActionsStoreOwnAssetAtDeelForLocal", "description": "Store an organization-owned asset at a Deel local warehouse" }, "store_own_asset_at_own_location": { "$ref": "#/components/schemas/ItAssetsPostResponsesContentApplicationJsonSchemaDataActionsStoreOwnAssetAtOwnLocation", "description": "Store an organization-owned asset at an organization-owned location" }, "store_rental_at_deel_for_local": { "$ref": "#/components/schemas/ItAssetsPostResponsesContentApplicationJsonSchemaDataActionsStoreRentalAtDeelForLocal", "description": "Store a Deel-owned rental asset at a Deel local warehouse" }, "store_rental_at_deel_for_zone1": { "$ref": "#/components/schemas/ItAssetsPostResponsesContentApplicationJsonSchemaDataActionsStoreRentalAtDeelForZone1", "description": "Store a Deel-owned rental asset at a Deel zone-1 warehouse" }, "transfer_own_asset": { "$ref": "#/components/schemas/ItAssetsPostResponsesContentApplicationJsonSchemaDataActionsTransferOwnAsset", "description": "Transfer an organization-owned asset to another user" }, "transfer_rental": { "$ref": "#/components/schemas/ItAssetsPostResponsesContentApplicationJsonSchemaDataActionsTransferRental", "description": "Transfer a Deel-owned rental asset to another user" }, "unarchive_own_asset": { "$ref": "#/components/schemas/ItAssetsPostResponsesContentApplicationJsonSchemaDataActionsUnarchiveOwnAsset", "description": "Unarchive a previously archived organization-owned asset" }, "update_location_location_to_user": { "$ref": "#/components/schemas/ItAssetsPostResponsesContentApplicationJsonSchemaDataActionsUpdateLocationLocationToUser", "description": "Update the location of an asset from a warehouse to a user" }, "update_location_user_to_location": { "$ref": "#/components/schemas/ItAssetsPostResponsesContentApplicationJsonSchemaDataActionsUpdateLocationUserToLocation", "description": "Update the location of an asset from a user to a warehouse" }, "update_location_user_to_user": { "$ref": "#/components/schemas/ItAssetsPostResponsesContentApplicationJsonSchemaDataActionsUpdateLocationUserToUser", "description": "Update the assigned user of an asset that is currently with a user" }, "update_own_asset_details": { "$ref": "#/components/schemas/ItAssetsPostResponsesContentApplicationJsonSchemaDataActionsUpdateOwnAssetDetails", "description": "Update editable details of an organization-owned asset" } }, "required": [ "asset_country", "clear_own_asset", "purchase_rental", "transfer_rental", "archive_own_asset", "transfer_own_asset", "unarchive_own_asset", "return_rental_to_deel", "update_own_asset_details", "assign_addon_to_own_asset", "reuse_own_asset_from_deel", "update_location_user_to_user", "store_rental_at_deel_for_local", "store_rental_at_deel_for_zone1", "store_own_asset_at_deel_for_hub", "store_own_asset_at_own_location", "update_location_location_to_user", "update_location_user_to_location", "reuse_own_asset_from_own_location", "store_own_asset_at_deel_for_local", "manage_end_of_rental_contract_actions" ], "title": "ItAssetsPostResponsesContentApplicationJsonSchemaDataActions", "type": "object" }, "ItAssetsPostResponsesContentApplicationJsonSchemaDataActionsArchiveOwnAsset": { "description": "Archive an organization-owned asset", "properties": { "details": { "description": "Action-specific context needed to perform the action. Populated for enabled and\ndisabled actions (so callers can see what a successful attempt would look like);\nnull when the action is not applicable to this asset.", "oneOf": [ { "$ref": "#/components/schemas/ItAssetsPostResponsesContentApplicationJsonSchemaDataActionsArchiveOwnAssetDetails" }, { "type": "null" } ] }, "disabled_reasons": { "description": "Reasons why the action is disabled. Empty when the action is enabled or not applicable", "items": { "$ref": "#/components/schemas/ItAssetsPostResponsesContentApplicationJsonSchemaDataActionsArchiveOwnAssetDisabledReasonsItems" }, "type": "array" }, "status": { "$ref": "#/components/schemas/ItAssetsPostResponsesContentApplicationJsonSchemaDataActionsArchiveOwnAssetStatus", "description": "Whether the action is currently available for this asset" } }, "required": [ "status", "details", "disabled_reasons" ], "title": "ItAssetsPostResponsesContentApplicationJsonSchemaDataActionsArchiveOwnAsset", "type": "object" }, "ItAssetsPostResponsesContentApplicationJsonSchemaDataActionsArchiveOwnAssetDetails": { "description": "Action-specific context needed to perform the action. Populated for enabled and\ndisabled actions (so callers can see what a successful attempt would look like);\nnull when the action is not applicable to this asset.", "properties": { "allowed_statuses": { "description": "Statuses that can be passed as the archive reason when archiving the asset", "items": { "$ref": "#/components/schemas/ItAssetsPostResponsesContentApplicationJsonSchemaDataActionsArchiveOwnAssetDetailsAllowedStatusesItems" }, "type": "array" } }, "required": [ "allowed_statuses" ], "title": "ItAssetsPostResponsesContentApplicationJsonSchemaDataActionsArchiveOwnAssetDetails", "type": "object" }, "ItAssetsPostResponsesContentApplicationJsonSchemaDataActionsArchiveOwnAssetDetailsAllowedStatusesItems": { "enum": [ "ADDED_BY_MISTAKE", "BINNED", "BROKEN_AT_WAREHOUSE", "BROKEN_BY_USER", "BROKEN_IN_TRANSIT", "DAMAGED_AT_WAREHOUSE", "DAMAGED_BY_USER", "DAMAGED_IN_TRANSIT", "LEFT_WITH_USER", "LOST_IN_TRANSIT", "RETURNED_TO_DEEL", "SHRINKAGE", "STOLEN", "SUPPLIER_RETURN" ], "title": "ItAssetsPostResponsesContentApplicationJsonSchemaDataActionsArchiveOwnAssetDetailsAllowedStatusesItems", "type": "string" }, "ItAssetsPostResponsesContentApplicationJsonSchemaDataActionsArchiveOwnAssetDisabledReasonsItems": { "enum": [ "ARCHIVED", "AT_DEEL_WAREHOUSE", "BEING_REPAIRED", "CONSUMABLE", "CONTROLLED_BY_DEEL", "COUNTRY_NOT_SUPPORTED_FOR_HUB", "COUNTRY_NOT_SUPPORTED_FOR_LOCAL", "DEEL_OWNED_ITEM_WITHOUT_RENTAL_CONTRACT", "DESKTOP_STORAGE", "ENDING_CONTRACT", "HUB_IN_SAME_REGION_AS_LOCAL", "INACTIVE", "INVALID_ITEM_LOCATION", "INVALID_ORGANIZATION_STATUS", "INVALID_STATE", "ITEM_CONDITIONS_TO_UNARCHIVE_NOT_MET", "ITEM_NOT_VISIBLE_FOR_ORGANIZATION", "NON_DEVICE", "NOT_AT_WAREHOUSE", "NOT_AVAILABLE_FOR_REUSE", "NOT_A_RENTAL", "NOT_MANAGEABLE_BY_ORGANIZATION", "NOT_WITH_ASSIGNMENT", "NOT_WITH_USER", "NO_ACTIVE_ADDONS", "NO_ACTIVE_STORAGE_CONTRACT", "NO_LOCATION_FOR_STORAGE", "NO_LOGISTICS_FOR_STORAGE", "NO_VALID_ADDONS", "ONGOING_SERVICE", "OWNED_BY_DEEL", "OWNED_BY_ORGANIZATION", "OWNED_BY_PARTNER_ORGANIZATION", "PARTNER_CHILD_CONTRACT", "PENDING_DEVICE_REFRESH", "RENTAL_CONTRACT_AND_USER_REGION_DO_NOT_MATCH", "TEMPORARILY_UNAVAILABLE", "UNKNOWN", "USER_HAS_NO_COUNTRY", "USER_HAS_NO_SEAT", "WAITING_FOR_CLEARANCE", "WITH_LOANER_ASSIGNMENT", "WITH_NON_COLLECTED_ASSIGNMENT", "WITH_NON_DELIVERED_ASSIGNMENT", "WITH_PENDING_ASSIGNMENT", "WRONG_ASSIGNMENT_STATUS", "WRONG_CONTRACT_STATUS", "WRONG_TERMS_AND_CONDITIONS" ], "title": "ItAssetsPostResponsesContentApplicationJsonSchemaDataActionsArchiveOwnAssetDisabledReasonsItems", "type": "string" }, "ItAssetsPostResponsesContentApplicationJsonSchemaDataActionsArchiveOwnAssetStatus": { "description": "Whether the action is currently available for this asset", "enum": [ "DISABLED", "ENABLED", "NOT_APPLICABLE" ], "title": "ItAssetsPostResponsesContentApplicationJsonSchemaDataActionsArchiveOwnAssetStatus", "type": "string" }, "ItAssetsPostResponsesContentApplicationJsonSchemaDataActionsAssetCountry": { "description": "Resolved country used for asset actions. Derived from the asset's country,\nits assigned rental contract billing entity country, or the last active\nassignment delivery country. Null when the country cannot be determined\n(e.g. asset was returned to Deel)", "enum": [ "AD", "AE", "AF", "AG", "AI", "AL", "AM", "AN", "AO", "AQ", "AR", "AS", "AT", "AU", "AW", "AX", "AZ", "BA", "BB", "BD", "BE", "BF", "BG", "BH", "BI", "BJ", "BL", "BM", "BN", "BO", "BQ", "BR", "BS", "BT", "BV", "BW", "BY", "BZ", "CA", "CC", "CD", "CF", "CG", "CH", "CI", "CK", "CL", "CM", "CN", "CO", "CR", "CU", "CV", "CW", "CX", "CY", "CZ", "DE", "DJ", "DK", "DM", "DO", "DZ", "EC", "EE", "EG", "EH", "ER", "ES", "ET", "FI", "FJ", "FK", "FM", "FO", "FR", "GA", "GB", "GD", "GE", "GF", "GG", "GH", "GI", "GL", "GM", "GN", "GP", "GQ", "GR", "GS", "GT", "GU", "GW", "GY", "HK", "HM", "HN", "HR", "HT", "HU", "IC", "ID", "IE", "IL", "IM", "IN", "IO", "IQ", "IR", "IS", "IT", "JE", "JM", "JO", "JP", "KE", "KG", "KH", "KI", "KM", "KN", "KP", "KR", "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", "XK", "YE", "YT", "ZA", "ZM", "ZW" ], "title": "ItAssetsPostResponsesContentApplicationJsonSchemaDataActionsAssetCountry", "type": "string" }, "ItAssetsPostResponsesContentApplicationJsonSchemaDataActionsAssignAddonToOwnAsset": { "description": "Assign an add-on to an organization-owned asset", "properties": { "details": { "description": "Action-specific context needed to perform the action. Populated for enabled and\ndisabled actions (so callers can see what a successful attempt would look like);\nnull when the action is not applicable to this asset.", "oneOf": [ { "$ref": "#/components/schemas/ItAssetsPostResponsesContentApplicationJsonSchemaDataActionsAssignAddonToOwnAssetDetails" }, { "type": "null" } ] }, "disabled_reasons": { "description": "Reasons why the action is disabled. Empty when the action is enabled or not applicable", "items": { "$ref": "#/components/schemas/ItAssetsPostResponsesContentApplicationJsonSchemaDataActionsAssignAddonToOwnAssetDisabledReasonsItems" }, "type": "array" }, "status": { "$ref": "#/components/schemas/ItAssetsPostResponsesContentApplicationJsonSchemaDataActionsAssignAddonToOwnAssetStatus", "description": "Whether the action is currently available for this asset" } }, "required": [ "status", "details", "disabled_reasons" ], "title": "ItAssetsPostResponsesContentApplicationJsonSchemaDataActionsAssignAddonToOwnAsset", "type": "object" }, "ItAssetsPostResponsesContentApplicationJsonSchemaDataActionsAssignAddonToOwnAssetDetails": { "description": "Action-specific context needed to perform the action. Populated for enabled and\ndisabled actions (so callers can see what a successful attempt would look like);\nnull when the action is not applicable to this asset.", "properties": { "addons": { "description": "Add-ons that can be assigned to the asset, with a fail reason for those that don't qualify", "items": { "$ref": "#/components/schemas/ItAssetsPostResponsesContentApplicationJsonSchemaDataActionsAssignAddonToOwnAssetDetailsAddonsItems" }, "type": "array" } }, "required": [ "addons" ], "title": "ItAssetsPostResponsesContentApplicationJsonSchemaDataActionsAssignAddonToOwnAssetDetails", "type": "object" }, "ItAssetsPostResponsesContentApplicationJsonSchemaDataActionsAssignAddonToOwnAssetDetailsAddonsItems": { "properties": { "addon": { "$ref": "#/components/schemas/ItAssetsPostResponsesContentApplicationJsonSchemaDataActionsAssignAddonToOwnAssetDetailsAddonsItemsAddon", "description": "Add-on that can be assigned to the asset" }, "fail_reason": { "description": "Reason the add-on cannot be assigned to the asset. Null when assignment is allowed", "oneOf": [ { "$ref": "#/components/schemas/ItAssetsPostResponsesContentApplicationJsonSchemaDataActionsAssignAddonToOwnAssetDetailsAddonsItemsFailReason" }, { "type": "null" } ] } }, "required": [ "addon", "fail_reason" ], "title": "ItAssetsPostResponsesContentApplicationJsonSchemaDataActionsAssignAddonToOwnAssetDetailsAddonsItems", "type": "object" }, "ItAssetsPostResponsesContentApplicationJsonSchemaDataActionsAssignAddonToOwnAssetDetailsAddonsItemsAddon": { "description": "Add-on that can be assigned to the asset", "properties": { "id": { "description": "ID of the add-on", "format": "uuid", "type": "string" }, "name": { "description": "Public display name of the add-on", "type": "string" } }, "required": [ "id", "name" ], "title": "ItAssetsPostResponsesContentApplicationJsonSchemaDataActionsAssignAddonToOwnAssetDetailsAddonsItemsAddon", "type": "object" }, "ItAssetsPostResponsesContentApplicationJsonSchemaDataActionsAssignAddonToOwnAssetDetailsAddonsItemsFailReason": { "description": "Reason the add-on cannot be assigned to the asset. Null when assignment is allowed", "enum": [ "ADDON_NOT_AVAILABLE_TO_ORGANIZATION", "ALREADY_ASSIGNED", "HAS_ACTIVE_SERVICE_ADDON", "INVALID_ASSET_AGE", "INVALID_CONTRACT_TYPE", "INVALID_DURATION", "INVALID_PAYMENT_SCHEMA", "INVALID_PLATFORM_TIER", "INVALID_PRODUCT_BRAND", "INVALID_PRODUCT_CATEGORY", "INVALID_PRODUCT_PARENT_CATEGORY", "INVALID_RENTAL_TERM", "NO_MATCHING_ORGANIZATION_CONTRACT", "OTHER" ], "title": "ItAssetsPostResponsesContentApplicationJsonSchemaDataActionsAssignAddonToOwnAssetDetailsAddonsItemsFailReason", "type": "string" }, "ItAssetsPostResponsesContentApplicationJsonSchemaDataActionsAssignAddonToOwnAssetDisabledReasonsItems": { "enum": [ "ARCHIVED", "AT_DEEL_WAREHOUSE", "BEING_REPAIRED", "CONSUMABLE", "CONTROLLED_BY_DEEL", "COUNTRY_NOT_SUPPORTED_FOR_HUB", "COUNTRY_NOT_SUPPORTED_FOR_LOCAL", "DEEL_OWNED_ITEM_WITHOUT_RENTAL_CONTRACT", "DESKTOP_STORAGE", "ENDING_CONTRACT", "HUB_IN_SAME_REGION_AS_LOCAL", "INACTIVE", "INVALID_ITEM_LOCATION", "INVALID_ORGANIZATION_STATUS", "INVALID_STATE", "ITEM_CONDITIONS_TO_UNARCHIVE_NOT_MET", "ITEM_NOT_VISIBLE_FOR_ORGANIZATION", "NON_DEVICE", "NOT_AT_WAREHOUSE", "NOT_AVAILABLE_FOR_REUSE", "NOT_A_RENTAL", "NOT_MANAGEABLE_BY_ORGANIZATION", "NOT_WITH_ASSIGNMENT", "NOT_WITH_USER", "NO_ACTIVE_ADDONS", "NO_ACTIVE_STORAGE_CONTRACT", "NO_LOCATION_FOR_STORAGE", "NO_LOGISTICS_FOR_STORAGE", "NO_VALID_ADDONS", "ONGOING_SERVICE", "OWNED_BY_DEEL", "OWNED_BY_ORGANIZATION", "OWNED_BY_PARTNER_ORGANIZATION", "PARTNER_CHILD_CONTRACT", "PENDING_DEVICE_REFRESH", "RENTAL_CONTRACT_AND_USER_REGION_DO_NOT_MATCH", "TEMPORARILY_UNAVAILABLE", "UNKNOWN", "USER_HAS_NO_COUNTRY", "USER_HAS_NO_SEAT", "WAITING_FOR_CLEARANCE", "WITH_LOANER_ASSIGNMENT", "WITH_NON_COLLECTED_ASSIGNMENT", "WITH_NON_DELIVERED_ASSIGNMENT", "WITH_PENDING_ASSIGNMENT", "WRONG_ASSIGNMENT_STATUS", "WRONG_CONTRACT_STATUS", "WRONG_TERMS_AND_CONDITIONS" ], "title": "ItAssetsPostResponsesContentApplicationJsonSchemaDataActionsAssignAddonToOwnAssetDisabledReasonsItems", "type": "string" }, "ItAssetsPostResponsesContentApplicationJsonSchemaDataActionsAssignAddonToOwnAssetStatus": { "description": "Whether the action is currently available for this asset", "enum": [ "DISABLED", "ENABLED", "NOT_APPLICABLE" ], "title": "ItAssetsPostResponsesContentApplicationJsonSchemaDataActionsAssignAddonToOwnAssetStatus", "type": "string" }, "ItAssetsPostResponsesContentApplicationJsonSchemaDataActionsClearOwnAsset": { "description": "Clear an organization-owned asset from the fleet", "properties": { "disabled_reasons": { "description": "Reasons why the action is disabled. Empty when the action is enabled or not applicable", "items": { "$ref": "#/components/schemas/ItAssetsPostResponsesContentApplicationJsonSchemaDataActionsClearOwnAssetDisabledReasonsItems" }, "type": "array" }, "status": { "$ref": "#/components/schemas/ItAssetsPostResponsesContentApplicationJsonSchemaDataActionsClearOwnAssetStatus", "description": "Whether the action is currently available for this asset" } }, "required": [ "status", "disabled_reasons" ], "title": "ItAssetsPostResponsesContentApplicationJsonSchemaDataActionsClearOwnAsset", "type": "object" }, "ItAssetsPostResponsesContentApplicationJsonSchemaDataActionsClearOwnAssetDisabledReasonsItems": { "enum": [ "ARCHIVED", "AT_DEEL_WAREHOUSE", "BEING_REPAIRED", "CONSUMABLE", "CONTROLLED_BY_DEEL", "COUNTRY_NOT_SUPPORTED_FOR_HUB", "COUNTRY_NOT_SUPPORTED_FOR_LOCAL", "DEEL_OWNED_ITEM_WITHOUT_RENTAL_CONTRACT", "DESKTOP_STORAGE", "ENDING_CONTRACT", "HUB_IN_SAME_REGION_AS_LOCAL", "INACTIVE", "INVALID_ITEM_LOCATION", "INVALID_ORGANIZATION_STATUS", "INVALID_STATE", "ITEM_CONDITIONS_TO_UNARCHIVE_NOT_MET", "ITEM_NOT_VISIBLE_FOR_ORGANIZATION", "NON_DEVICE", "NOT_AT_WAREHOUSE", "NOT_AVAILABLE_FOR_REUSE", "NOT_A_RENTAL", "NOT_MANAGEABLE_BY_ORGANIZATION", "NOT_WITH_ASSIGNMENT", "NOT_WITH_USER", "NO_ACTIVE_ADDONS", "NO_ACTIVE_STORAGE_CONTRACT", "NO_LOCATION_FOR_STORAGE", "NO_LOGISTICS_FOR_STORAGE", "NO_VALID_ADDONS", "ONGOING_SERVICE", "OWNED_BY_DEEL", "OWNED_BY_ORGANIZATION", "OWNED_BY_PARTNER_ORGANIZATION", "PARTNER_CHILD_CONTRACT", "PENDING_DEVICE_REFRESH", "RENTAL_CONTRACT_AND_USER_REGION_DO_NOT_MATCH", "TEMPORARILY_UNAVAILABLE", "UNKNOWN", "USER_HAS_NO_COUNTRY", "USER_HAS_NO_SEAT", "WAITING_FOR_CLEARANCE", "WITH_LOANER_ASSIGNMENT", "WITH_NON_COLLECTED_ASSIGNMENT", "WITH_NON_DELIVERED_ASSIGNMENT", "WITH_PENDING_ASSIGNMENT", "WRONG_ASSIGNMENT_STATUS", "WRONG_CONTRACT_STATUS", "WRONG_TERMS_AND_CONDITIONS" ], "title": "ItAssetsPostResponsesContentApplicationJsonSchemaDataActionsClearOwnAssetDisabledReasonsItems", "type": "string" }, "ItAssetsPostResponsesContentApplicationJsonSchemaDataActionsClearOwnAssetStatus": { "description": "Whether the action is currently available for this asset", "enum": [ "DISABLED", "ENABLED", "NOT_APPLICABLE" ], "title": "ItAssetsPostResponsesContentApplicationJsonSchemaDataActionsClearOwnAssetStatus", "type": "string" }, "ItAssetsPostResponsesContentApplicationJsonSchemaDataActionsManageEndOfRentalContractActions": { "description": "Manage end-of-rental options for a Deel-owned rental asset", "properties": { "disabled_reasons": { "description": "Reasons why the action is disabled. Empty when the action is enabled or not applicable", "items": { "$ref": "#/components/schemas/ItAssetsPostResponsesContentApplicationJsonSchemaDataActionsManageEndOfRentalContractActionsDisabledReasonsItems" }, "type": "array" }, "status": { "$ref": "#/components/schemas/ItAssetsPostResponsesContentApplicationJsonSchemaDataActionsManageEndOfRentalContractActionsStatus", "description": "Whether the action is currently available for this asset" } }, "required": [ "status", "disabled_reasons" ], "title": "ItAssetsPostResponsesContentApplicationJsonSchemaDataActionsManageEndOfRentalContractActions", "type": "object" }, "ItAssetsPostResponsesContentApplicationJsonSchemaDataActionsManageEndOfRentalContractActionsDisabledReasonsItems": { "enum": [ "ARCHIVED", "AT_DEEL_WAREHOUSE", "BEING_REPAIRED", "CONSUMABLE", "CONTROLLED_BY_DEEL", "COUNTRY_NOT_SUPPORTED_FOR_HUB", "COUNTRY_NOT_SUPPORTED_FOR_LOCAL", "DEEL_OWNED_ITEM_WITHOUT_RENTAL_CONTRACT", "DESKTOP_STORAGE", "ENDING_CONTRACT", "HUB_IN_SAME_REGION_AS_LOCAL", "INACTIVE", "INVALID_ITEM_LOCATION", "INVALID_ORGANIZATION_STATUS", "INVALID_STATE", "ITEM_CONDITIONS_TO_UNARCHIVE_NOT_MET", "ITEM_NOT_VISIBLE_FOR_ORGANIZATION", "NON_DEVICE", "NOT_AT_WAREHOUSE", "NOT_AVAILABLE_FOR_REUSE", "NOT_A_RENTAL", "NOT_MANAGEABLE_BY_ORGANIZATION", "NOT_WITH_ASSIGNMENT", "NOT_WITH_USER", "NO_ACTIVE_ADDONS", "NO_ACTIVE_STORAGE_CONTRACT", "NO_LOCATION_FOR_STORAGE", "NO_LOGISTICS_FOR_STORAGE", "NO_VALID_ADDONS", "ONGOING_SERVICE", "OWNED_BY_DEEL", "OWNED_BY_ORGANIZATION", "OWNED_BY_PARTNER_ORGANIZATION", "PARTNER_CHILD_CONTRACT", "PENDING_DEVICE_REFRESH", "RENTAL_CONTRACT_AND_USER_REGION_DO_NOT_MATCH", "TEMPORARILY_UNAVAILABLE", "UNKNOWN", "USER_HAS_NO_COUNTRY", "USER_HAS_NO_SEAT", "WAITING_FOR_CLEARANCE", "WITH_LOANER_ASSIGNMENT", "WITH_NON_COLLECTED_ASSIGNMENT", "WITH_NON_DELIVERED_ASSIGNMENT", "WITH_PENDING_ASSIGNMENT", "WRONG_ASSIGNMENT_STATUS", "WRONG_CONTRACT_STATUS", "WRONG_TERMS_AND_CONDITIONS" ], "title": "ItAssetsPostResponsesContentApplicationJsonSchemaDataActionsManageEndOfRentalContractActionsDisabledReasonsItems", "type": "string" }, "ItAssetsPostResponsesContentApplicationJsonSchemaDataActionsManageEndOfRentalContractActionsStatus": { "description": "Whether the action is currently available for this asset", "enum": [ "DISABLED", "ENABLED", "NOT_APPLICABLE" ], "title": "ItAssetsPostResponsesContentApplicationJsonSchemaDataActionsManageEndOfRentalContractActionsStatus", "type": "string" }, "ItAssetsPostResponsesContentApplicationJsonSchemaDataActionsPurchaseRental": { "description": "Purchase a Deel-owned rental asset at end of contract", "properties": { "details": { "description": "Action-specific context needed to perform the action. Populated for enabled and\ndisabled actions (so callers can see what a successful attempt would look like);\nnull when the action is not applicable to this asset.", "oneOf": [ { "$ref": "#/components/schemas/ItAssetsPostResponsesContentApplicationJsonSchemaDataActionsPurchaseRentalDetails" }, { "type": "null" } ] }, "disabled_reasons": { "description": "Reasons why the action is disabled. Empty when the action is enabled or not applicable", "items": { "$ref": "#/components/schemas/ItAssetsPostResponsesContentApplicationJsonSchemaDataActionsPurchaseRentalDisabledReasonsItems" }, "type": "array" }, "status": { "$ref": "#/components/schemas/ItAssetsPostResponsesContentApplicationJsonSchemaDataActionsPurchaseRentalStatus", "description": "Whether the action is currently available for this asset" } }, "required": [ "status", "details", "disabled_reasons" ], "title": "ItAssetsPostResponsesContentApplicationJsonSchemaDataActionsPurchaseRental", "type": "object" }, "ItAssetsPostResponsesContentApplicationJsonSchemaDataActionsPurchaseRentalDetails": { "description": "Action-specific context needed to perform the action. Populated for enabled and\ndisabled actions (so callers can see what a successful attempt would look like);\nnull when the action is not applicable to this asset.", "properties": { "purchase_price": { "description": "Estimated price to purchase the asset at the end of the rental contract", "oneOf": [ { "$ref": "#/components/schemas/ItAssetsPostResponsesContentApplicationJsonSchemaDataActionsPurchaseRentalDetailsPurchasePrice" }, { "type": "null" } ] }, "remaining_contract_value": { "$ref": "#/components/schemas/ItAssetsPostResponsesContentApplicationJsonSchemaDataActionsPurchaseRentalDetailsRemainingContractValue", "description": "Estimated remaining value of the rental contract" }, "total_purchase_price": { "description": "Estimated total price of the purchase, including any remaining contract value", "oneOf": [ { "$ref": "#/components/schemas/ItAssetsPostResponsesContentApplicationJsonSchemaDataActionsPurchaseRentalDetailsTotalPurchasePrice" }, { "type": "null" } ] } }, "required": [ "purchase_price", "total_purchase_price", "remaining_contract_value" ], "title": "ItAssetsPostResponsesContentApplicationJsonSchemaDataActionsPurchaseRentalDetails", "type": "object" }, "ItAssetsPostResponsesContentApplicationJsonSchemaDataActionsPurchaseRentalDetailsPurchasePrice": { "description": "Estimated price to purchase the asset at the end of the rental contract", "properties": { "amount": { "description": "Amount", "format": "decimal", "type": "string" }, "currency": { "$ref": "#/components/schemas/ItAssetsPostResponsesContentApplicationJsonSchemaDataActionsPurchaseRentalDetailsPurchasePriceCurrency", "description": "Three-letter currency code for the price" } }, "required": [ "amount", "currency" ], "title": "ItAssetsPostResponsesContentApplicationJsonSchemaDataActionsPurchaseRentalDetailsPurchasePrice", "type": "object" }, "ItAssetsPostResponsesContentApplicationJsonSchemaDataActionsPurchaseRentalDetailsPurchasePriceCurrency": { "description": "Three-letter currency code for the price", "enum": [ "AED", "AFN", "ALL", "AMD", "ANG", "AOA", "ARS", "AUD", "AWG", "AZN", "BAM", "BDT", "BGN", "BHD", "BIF", "BMD", "BOB", "BRL", "BSD", "BTN", "BWP", "BYN", "BZD", "CAD", "CDF", "CHF", "CLP", "CNY", "COP", "CRC", "CUC", "CVE", "CZK", "DJF", "DKK", "DOP", "DZD", "EGP", "ERN", "ETB", "EUR", "FJD", "FKP", "GBP", "GEL", "GHS", "GIP", "GMD", "GNF", "GTQ", "GYD", "HKD", "HNL", "HRK", "HTG", "HUF", "IDR", "ILS", "INR", "IQD", "IRR", "ISK", "JMD", "JOD", "JPY", "KES", "KGS", "KHR", "KMF", "KPW", "KRW", "KWD", "KYD", "KZT", "LAK", "LBP", "LKR", "LRD", "LSL", "LTL", "LYD", "MAD", "MDL", "MGA", "MKD", "MMK", "MNT", "MRU", "MUR", "MVR", "MWK", "MXN", "MYR", "MZN", "NAD", "NGN", "NIO", "NOK", "NPR", "NZD", "OMR", "PAB", "PEN", "PGK", "PHP", "PKR", "PLN", "PYG", "QAR", "RON", "RSD", "RUB", "RWF", "SAR", "SBD", "SCR", "SDG", "SEK", "SGD", "SHP", "SLL", "SOS", "SRD", "SSP", "STD", "SYP", "SZL", "THB", "TJS", "TMT", "TND", "TOP", "TRY", "TTD", "TWD", "TZS", "UAH", "UGX", "USD", "UYU", "UZS", "VEF", "VND", "VUV", "WST", "XAF", "XCD", "XOF", "XPF", "YER", "ZAR", "ZMW", "ZWD" ], "title": "ItAssetsPostResponsesContentApplicationJsonSchemaDataActionsPurchaseRentalDetailsPurchasePriceCurrency", "type": "string" }, "ItAssetsPostResponsesContentApplicationJsonSchemaDataActionsPurchaseRentalDetailsRemainingContractValue": { "description": "Estimated remaining value of the rental contract", "properties": { "amount": { "description": "Amount", "format": "decimal", "type": "string" }, "currency": { "$ref": "#/components/schemas/ItAssetsPostResponsesContentApplicationJsonSchemaDataActionsPurchaseRentalDetailsRemainingContractValueCurrency", "description": "Three-letter currency code for the price" } }, "required": [ "amount", "currency" ], "title": "ItAssetsPostResponsesContentApplicationJsonSchemaDataActionsPurchaseRentalDetailsRemainingContractValue", "type": "object" }, "ItAssetsPostResponsesContentApplicationJsonSchemaDataActionsPurchaseRentalDetailsRemainingContractValueCurrency": { "description": "Three-letter currency code for the price", "enum": [ "AED", "AFN", "ALL", "AMD", "ANG", "AOA", "ARS", "AUD", "AWG", "AZN", "BAM", "BDT", "BGN", "BHD", "BIF", "BMD", "BOB", "BRL", "BSD", "BTN", "BWP", "BYN", "BZD", "CAD", "CDF", "CHF", "CLP", "CNY", "COP", "CRC", "CUC", "CVE", "CZK", "DJF", "DKK", "DOP", "DZD", "EGP", "ERN", "ETB", "EUR", "FJD", "FKP", "GBP", "GEL", "GHS", "GIP", "GMD", "GNF", "GTQ", "GYD", "HKD", "HNL", "HRK", "HTG", "HUF", "IDR", "ILS", "INR", "IQD", "IRR", "ISK", "JMD", "JOD", "JPY", "KES", "KGS", "KHR", "KMF", "KPW", "KRW", "KWD", "KYD", "KZT", "LAK", "LBP", "LKR", "LRD", "LSL", "LTL", "LYD", "MAD", "MDL", "MGA", "MKD", "MMK", "MNT", "MRU", "MUR", "MVR", "MWK", "MXN", "MYR", "MZN", "NAD", "NGN", "NIO", "NOK", "NPR", "NZD", "OMR", "PAB", "PEN", "PGK", "PHP", "PKR", "PLN", "PYG", "QAR", "RON", "RSD", "RUB", "RWF", "SAR", "SBD", "SCR", "SDG", "SEK", "SGD", "SHP", "SLL", "SOS", "SRD", "SSP", "STD", "SYP", "SZL", "THB", "TJS", "TMT", "TND", "TOP", "TRY", "TTD", "TWD", "TZS", "UAH", "UGX", "USD", "UYU", "UZS", "VEF", "VND", "VUV", "WST", "XAF", "XCD", "XOF", "XPF", "YER", "ZAR", "ZMW", "ZWD" ], "title": "ItAssetsPostResponsesContentApplicationJsonSchemaDataActionsPurchaseRentalDetailsRemainingContractValueCurrency", "type": "string" }, "ItAssetsPostResponsesContentApplicationJsonSchemaDataActionsPurchaseRentalDetailsTotalPurchasePrice": { "description": "Estimated total price of the purchase, including any remaining contract value", "properties": { "amount": { "description": "Amount", "format": "decimal", "type": "string" }, "currency": { "$ref": "#/components/schemas/ItAssetsPostResponsesContentApplicationJsonSchemaDataActionsPurchaseRentalDetailsTotalPurchasePriceCurrency", "description": "Three-letter currency code for the price" } }, "required": [ "amount", "currency" ], "title": "ItAssetsPostResponsesContentApplicationJsonSchemaDataActionsPurchaseRentalDetailsTotalPurchasePrice", "type": "object" }, "ItAssetsPostResponsesContentApplicationJsonSchemaDataActionsPurchaseRentalDetailsTotalPurchasePriceCurrency": { "description": "Three-letter currency code for the price", "enum": [ "AED", "AFN", "ALL", "AMD", "ANG", "AOA", "ARS", "AUD", "AWG", "AZN", "BAM", "BDT", "BGN", "BHD", "BIF", "BMD", "BOB", "BRL", "BSD", "BTN", "BWP", "BYN", "BZD", "CAD", "CDF", "CHF", "CLP", "CNY", "COP", "CRC", "CUC", "CVE", "CZK", "DJF", "DKK", "DOP", "DZD", "EGP", "ERN", "ETB", "EUR", "FJD", "FKP", "GBP", "GEL", "GHS", "GIP", "GMD", "GNF", "GTQ", "GYD", "HKD", "HNL", "HRK", "HTG", "HUF", "IDR", "ILS", "INR", "IQD", "IRR", "ISK", "JMD", "JOD", "JPY", "KES", "KGS", "KHR", "KMF", "KPW", "KRW", "KWD", "KYD", "KZT", "LAK", "LBP", "LKR", "LRD", "LSL", "LTL", "LYD", "MAD", "MDL", "MGA", "MKD", "MMK", "MNT", "MRU", "MUR", "MVR", "MWK", "MXN", "MYR", "MZN", "NAD", "NGN", "NIO", "NOK", "NPR", "NZD", "OMR", "PAB", "PEN", "PGK", "PHP", "PKR", "PLN", "PYG", "QAR", "RON", "RSD", "RUB", "RWF", "SAR", "SBD", "SCR", "SDG", "SEK", "SGD", "SHP", "SLL", "SOS", "SRD", "SSP", "STD", "SYP", "SZL", "THB", "TJS", "TMT", "TND", "TOP", "TRY", "TTD", "TWD", "TZS", "UAH", "UGX", "USD", "UYU", "UZS", "VEF", "VND", "VUV", "WST", "XAF", "XCD", "XOF", "XPF", "YER", "ZAR", "ZMW", "ZWD" ], "title": "ItAssetsPostResponsesContentApplicationJsonSchemaDataActionsPurchaseRentalDetailsTotalPurchasePriceCurrency", "type": "string" }, "ItAssetsPostResponsesContentApplicationJsonSchemaDataActionsPurchaseRentalDisabledReasonsItems": { "enum": [ "ARCHIVED", "AT_DEEL_WAREHOUSE", "BEING_REPAIRED", "CONSUMABLE", "CONTROLLED_BY_DEEL", "COUNTRY_NOT_SUPPORTED_FOR_HUB", "COUNTRY_NOT_SUPPORTED_FOR_LOCAL", "DEEL_OWNED_ITEM_WITHOUT_RENTAL_CONTRACT", "DESKTOP_STORAGE", "ENDING_CONTRACT", "HUB_IN_SAME_REGION_AS_LOCAL", "INACTIVE", "INVALID_ITEM_LOCATION", "INVALID_ORGANIZATION_STATUS", "INVALID_STATE", "ITEM_CONDITIONS_TO_UNARCHIVE_NOT_MET", "ITEM_NOT_VISIBLE_FOR_ORGANIZATION", "NON_DEVICE", "NOT_AT_WAREHOUSE", "NOT_AVAILABLE_FOR_REUSE", "NOT_A_RENTAL", "NOT_MANAGEABLE_BY_ORGANIZATION", "NOT_WITH_ASSIGNMENT", "NOT_WITH_USER", "NO_ACTIVE_ADDONS", "NO_ACTIVE_STORAGE_CONTRACT", "NO_LOCATION_FOR_STORAGE", "NO_LOGISTICS_FOR_STORAGE", "NO_VALID_ADDONS", "ONGOING_SERVICE", "OWNED_BY_DEEL", "OWNED_BY_ORGANIZATION", "OWNED_BY_PARTNER_ORGANIZATION", "PARTNER_CHILD_CONTRACT", "PENDING_DEVICE_REFRESH", "RENTAL_CONTRACT_AND_USER_REGION_DO_NOT_MATCH", "TEMPORARILY_UNAVAILABLE", "UNKNOWN", "USER_HAS_NO_COUNTRY", "USER_HAS_NO_SEAT", "WAITING_FOR_CLEARANCE", "WITH_LOANER_ASSIGNMENT", "WITH_NON_COLLECTED_ASSIGNMENT", "WITH_NON_DELIVERED_ASSIGNMENT", "WITH_PENDING_ASSIGNMENT", "WRONG_ASSIGNMENT_STATUS", "WRONG_CONTRACT_STATUS", "WRONG_TERMS_AND_CONDITIONS" ], "title": "ItAssetsPostResponsesContentApplicationJsonSchemaDataActionsPurchaseRentalDisabledReasonsItems", "type": "string" }, "ItAssetsPostResponsesContentApplicationJsonSchemaDataActionsPurchaseRentalStatus": { "description": "Whether the action is currently available for this asset", "enum": [ "DISABLED", "ENABLED", "NOT_APPLICABLE" ], "title": "ItAssetsPostResponsesContentApplicationJsonSchemaDataActionsPurchaseRentalStatus", "type": "string" }, "ItAssetsPostResponsesContentApplicationJsonSchemaDataActionsReturnRentalToDeel": { "description": "Return a Deel-owned rental asset back to Deel", "properties": { "details": { "description": "Action-specific context needed to perform the action. Populated for enabled and\ndisabled actions (so callers can see what a successful attempt would look like);\nnull when the action is not applicable to this asset.", "oneOf": [ { "$ref": "#/components/schemas/ItAssetsPostResponsesContentApplicationJsonSchemaDataActionsReturnRentalToDeelDetails" }, { "type": "null" } ] }, "disabled_reasons": { "description": "Reasons why the action is disabled. Empty when the action is enabled or not applicable", "items": { "$ref": "#/components/schemas/ItAssetsPostResponsesContentApplicationJsonSchemaDataActionsReturnRentalToDeelDisabledReasonsItems" }, "type": "array" }, "status": { "$ref": "#/components/schemas/ItAssetsPostResponsesContentApplicationJsonSchemaDataActionsReturnRentalToDeelStatus", "description": "Whether the action is currently available for this asset" } }, "required": [ "status", "details", "disabled_reasons" ], "title": "ItAssetsPostResponsesContentApplicationJsonSchemaDataActionsReturnRentalToDeel", "type": "object" }, "ItAssetsPostResponsesContentApplicationJsonSchemaDataActionsReturnRentalToDeelDetails": { "description": "Action-specific context needed to perform the action. Populated for enabled and\ndisabled actions (so callers can see what a successful attempt would look like);\nnull when the action is not applicable to this asset.", "properties": { "end_contract_price": { "$ref": "#/components/schemas/ItAssetsPostResponsesContentApplicationJsonSchemaDataActionsReturnRentalToDeelDetailsEndContractPrice", "description": "Estimated end-of-contract price charged when returning the asset" } }, "required": [ "end_contract_price" ], "title": "ItAssetsPostResponsesContentApplicationJsonSchemaDataActionsReturnRentalToDeelDetails", "type": "object" }, "ItAssetsPostResponsesContentApplicationJsonSchemaDataActionsReturnRentalToDeelDetailsEndContractPrice": { "description": "Estimated end-of-contract price charged when returning the asset", "properties": { "amount": { "description": "Amount", "format": "decimal", "type": "string" }, "currency": { "$ref": "#/components/schemas/ItAssetsPostResponsesContentApplicationJsonSchemaDataActionsReturnRentalToDeelDetailsEndContractPriceCurrency", "description": "Three-letter currency code for the price" } }, "required": [ "amount", "currency" ], "title": "ItAssetsPostResponsesContentApplicationJsonSchemaDataActionsReturnRentalToDeelDetailsEndContractPrice", "type": "object" }, "ItAssetsPostResponsesContentApplicationJsonSchemaDataActionsReturnRentalToDeelDetailsEndContractPriceCurrency": { "description": "Three-letter currency code for the price", "enum": [ "AED", "AFN", "ALL", "AMD", "ANG", "AOA", "ARS", "AUD", "AWG", "AZN", "BAM", "BDT", "BGN", "BHD", "BIF", "BMD", "BOB", "BRL", "BSD", "BTN", "BWP", "BYN", "BZD", "CAD", "CDF", "CHF", "CLP", "CNY", "COP", "CRC", "CUC", "CVE", "CZK", "DJF", "DKK", "DOP", "DZD", "EGP", "ERN", "ETB", "EUR", "FJD", "FKP", "GBP", "GEL", "GHS", "GIP", "GMD", "GNF", "GTQ", "GYD", "HKD", "HNL", "HRK", "HTG", "HUF", "IDR", "ILS", "INR", "IQD", "IRR", "ISK", "JMD", "JOD", "JPY", "KES", "KGS", "KHR", "KMF", "KPW", "KRW", "KWD", "KYD", "KZT", "LAK", "LBP", "LKR", "LRD", "LSL", "LTL", "LYD", "MAD", "MDL", "MGA", "MKD", "MMK", "MNT", "MRU", "MUR", "MVR", "MWK", "MXN", "MYR", "MZN", "NAD", "NGN", "NIO", "NOK", "NPR", "NZD", "OMR", "PAB", "PEN", "PGK", "PHP", "PKR", "PLN", "PYG", "QAR", "RON", "RSD", "RUB", "RWF", "SAR", "SBD", "SCR", "SDG", "SEK", "SGD", "SHP", "SLL", "SOS", "SRD", "SSP", "STD", "SYP", "SZL", "THB", "TJS", "TMT", "TND", "TOP", "TRY", "TTD", "TWD", "TZS", "UAH", "UGX", "USD", "UYU", "UZS", "VEF", "VND", "VUV", "WST", "XAF", "XCD", "XOF", "XPF", "YER", "ZAR", "ZMW", "ZWD" ], "title": "ItAssetsPostResponsesContentApplicationJsonSchemaDataActionsReturnRentalToDeelDetailsEndContractPriceCurrency", "type": "string" }, "ItAssetsPostResponsesContentApplicationJsonSchemaDataActionsReturnRentalToDeelDisabledReasonsItems": { "enum": [ "ARCHIVED", "AT_DEEL_WAREHOUSE", "BEING_REPAIRED", "CONSUMABLE", "CONTROLLED_BY_DEEL", "COUNTRY_NOT_SUPPORTED_FOR_HUB", "COUNTRY_NOT_SUPPORTED_FOR_LOCAL", "DEEL_OWNED_ITEM_WITHOUT_RENTAL_CONTRACT", "DESKTOP_STORAGE", "ENDING_CONTRACT", "HUB_IN_SAME_REGION_AS_LOCAL", "INACTIVE", "INVALID_ITEM_LOCATION", "INVALID_ORGANIZATION_STATUS", "INVALID_STATE", "ITEM_CONDITIONS_TO_UNARCHIVE_NOT_MET", "ITEM_NOT_VISIBLE_FOR_ORGANIZATION", "NON_DEVICE", "NOT_AT_WAREHOUSE", "NOT_AVAILABLE_FOR_REUSE", "NOT_A_RENTAL", "NOT_MANAGEABLE_BY_ORGANIZATION", "NOT_WITH_ASSIGNMENT", "NOT_WITH_USER", "NO_ACTIVE_ADDONS", "NO_ACTIVE_STORAGE_CONTRACT", "NO_LOCATION_FOR_STORAGE", "NO_LOGISTICS_FOR_STORAGE", "NO_VALID_ADDONS", "ONGOING_SERVICE", "OWNED_BY_DEEL", "OWNED_BY_ORGANIZATION", "OWNED_BY_PARTNER_ORGANIZATION", "PARTNER_CHILD_CONTRACT", "PENDING_DEVICE_REFRESH", "RENTAL_CONTRACT_AND_USER_REGION_DO_NOT_MATCH", "TEMPORARILY_UNAVAILABLE", "UNKNOWN", "USER_HAS_NO_COUNTRY", "USER_HAS_NO_SEAT", "WAITING_FOR_CLEARANCE", "WITH_LOANER_ASSIGNMENT", "WITH_NON_COLLECTED_ASSIGNMENT", "WITH_NON_DELIVERED_ASSIGNMENT", "WITH_PENDING_ASSIGNMENT", "WRONG_ASSIGNMENT_STATUS", "WRONG_CONTRACT_STATUS", "WRONG_TERMS_AND_CONDITIONS" ], "title": "ItAssetsPostResponsesContentApplicationJsonSchemaDataActionsReturnRentalToDeelDisabledReasonsItems", "type": "string" }, "ItAssetsPostResponsesContentApplicationJsonSchemaDataActionsReturnRentalToDeelStatus": { "description": "Whether the action is currently available for this asset", "enum": [ "DISABLED", "ENABLED", "NOT_APPLICABLE" ], "title": "ItAssetsPostResponsesContentApplicationJsonSchemaDataActionsReturnRentalToDeelStatus", "type": "string" }, "ItAssetsPostResponsesContentApplicationJsonSchemaDataActionsReuseOwnAssetFromDeel": { "description": "Redeploy an organization-owned asset stored at a Deel warehouse", "properties": { "details": { "description": "Action-specific context needed to perform the action. Populated for enabled and\ndisabled actions (so callers can see what a successful attempt would look like);\nnull when the action is not applicable to this asset.", "oneOf": [ { "$ref": "#/components/schemas/ItAssetsPostResponsesContentApplicationJsonSchemaDataActionsReuseOwnAssetFromDeelDetails" }, { "type": "null" } ] }, "disabled_reasons": { "description": "Reasons why the action is disabled. Empty when the action is enabled or not applicable", "items": { "$ref": "#/components/schemas/ItAssetsPostResponsesContentApplicationJsonSchemaDataActionsReuseOwnAssetFromDeelDisabledReasonsItems" }, "type": "array" }, "status": { "$ref": "#/components/schemas/ItAssetsPostResponsesContentApplicationJsonSchemaDataActionsReuseOwnAssetFromDeelStatus", "description": "Whether the action is currently available for this asset" } }, "required": [ "status", "details", "disabled_reasons" ], "title": "ItAssetsPostResponsesContentApplicationJsonSchemaDataActionsReuseOwnAssetFromDeel", "type": "object" }, "ItAssetsPostResponsesContentApplicationJsonSchemaDataActionsReuseOwnAssetFromDeelDetails": { "description": "Action-specific context needed to perform the action. Populated for enabled and\ndisabled actions (so callers can see what a successful attempt would look like);\nnull when the action is not applicable to this asset.", "properties": { "eligible_countries": { "description": "Countries where the asset can be redeployed from Deel", "items": { "$ref": "#/components/schemas/ItAssetsPostResponsesContentApplicationJsonSchemaDataActionsReuseOwnAssetFromDeelDetailsEligibleCountriesItems" }, "type": "array" }, "express_delivery": { "description": "Express delivery availability and per-country fees. Null when express delivery is not supported", "oneOf": [ { "$ref": "#/components/schemas/ItAssetsPostResponsesContentApplicationJsonSchemaDataActionsReuseOwnAssetFromDeelDetailsExpressDelivery" }, { "type": "null" } ] } }, "required": [ "express_delivery", "eligible_countries" ], "title": "ItAssetsPostResponsesContentApplicationJsonSchemaDataActionsReuseOwnAssetFromDeelDetails", "type": "object" }, "ItAssetsPostResponsesContentApplicationJsonSchemaDataActionsReuseOwnAssetFromDeelDetailsEligibleCountriesItems": { "enum": [ "AD", "AE", "AF", "AG", "AI", "AL", "AM", "AN", "AO", "AQ", "AR", "AS", "AT", "AU", "AW", "AX", "AZ", "BA", "BB", "BD", "BE", "BF", "BG", "BH", "BI", "BJ", "BL", "BM", "BN", "BO", "BQ", "BR", "BS", "BT", "BV", "BW", "BY", "BZ", "CA", "CC", "CD", "CF", "CG", "CH", "CI", "CK", "CL", "CM", "CN", "CO", "CR", "CU", "CV", "CW", "CX", "CY", "CZ", "DE", "DJ", "DK", "DM", "DO", "DZ", "EC", "EE", "EG", "EH", "ER", "ES", "ET", "FI", "FJ", "FK", "FM", "FO", "FR", "GA", "GB", "GD", "GE", "GF", "GG", "GH", "GI", "GL", "GM", "GN", "GP", "GQ", "GR", "GS", "GT", "GU", "GW", "GY", "HK", "HM", "HN", "HR", "HT", "HU", "IC", "ID", "IE", "IL", "IM", "IN", "IO", "IQ", "IR", "IS", "IT", "JE", "JM", "JO", "JP", "KE", "KG", "KH", "KI", "KM", "KN", "KP", "KR", "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", "XK", "YE", "YT", "ZA", "ZM", "ZW" ], "title": "ItAssetsPostResponsesContentApplicationJsonSchemaDataActionsReuseOwnAssetFromDeelDetailsEligibleCountriesItems", "type": "string" }, "ItAssetsPostResponsesContentApplicationJsonSchemaDataActionsReuseOwnAssetFromDeelDetailsExpressDelivery": { "description": "Express delivery availability and per-country fees. Null when express delivery is not supported", "properties": { "country_fees": { "additionalProperties": { "$ref": "#/components/schemas/ItAssetsPostResponsesContentApplicationJsonSchemaDataActionsReuseOwnAssetFromDeelDetailsExpressDeliveryCountryFees" }, "description": "Express delivery fees keyed by destination country.", "type": "object" } }, "required": [ "country_fees" ], "title": "ItAssetsPostResponsesContentApplicationJsonSchemaDataActionsReuseOwnAssetFromDeelDetailsExpressDelivery", "type": "object" }, "ItAssetsPostResponsesContentApplicationJsonSchemaDataActionsReuseOwnAssetFromDeelDetailsExpressDeliveryCountryFees": { "properties": { "amount": { "description": "Amount", "format": "decimal", "type": "string" }, "currency": { "$ref": "#/components/schemas/ItAssetsPostResponsesContentApplicationJsonSchemaDataActionsReuseOwnAssetFromDeelDetailsExpressDeliveryCountryFeesCurrency", "description": "Three-letter currency code for the price" } }, "required": [ "amount", "currency" ], "title": "ItAssetsPostResponsesContentApplicationJsonSchemaDataActionsReuseOwnAssetFromDeelDetailsExpressDeliveryCountryFees", "type": "object" }, "ItAssetsPostResponsesContentApplicationJsonSchemaDataActionsReuseOwnAssetFromDeelDetailsExpressDeliveryCountryFeesCurrency": { "description": "Three-letter currency code for the price", "enum": [ "AED", "AFN", "ALL", "AMD", "ANG", "AOA", "ARS", "AUD", "AWG", "AZN", "BAM", "BDT", "BGN", "BHD", "BIF", "BMD", "BOB", "BRL", "BSD", "BTN", "BWP", "BYN", "BZD", "CAD", "CDF", "CHF", "CLP", "CNY", "COP", "CRC", "CUC", "CVE", "CZK", "DJF", "DKK", "DOP", "DZD", "EGP", "ERN", "ETB", "EUR", "FJD", "FKP", "GBP", "GEL", "GHS", "GIP", "GMD", "GNF", "GTQ", "GYD", "HKD", "HNL", "HRK", "HTG", "HUF", "IDR", "ILS", "INR", "IQD", "IRR", "ISK", "JMD", "JOD", "JPY", "KES", "KGS", "KHR", "KMF", "KPW", "KRW", "KWD", "KYD", "KZT", "LAK", "LBP", "LKR", "LRD", "LSL", "LTL", "LYD", "MAD", "MDL", "MGA", "MKD", "MMK", "MNT", "MRU", "MUR", "MVR", "MWK", "MXN", "MYR", "MZN", "NAD", "NGN", "NIO", "NOK", "NPR", "NZD", "OMR", "PAB", "PEN", "PGK", "PHP", "PKR", "PLN", "PYG", "QAR", "RON", "RSD", "RUB", "RWF", "SAR", "SBD", "SCR", "SDG", "SEK", "SGD", "SHP", "SLL", "SOS", "SRD", "SSP", "STD", "SYP", "SZL", "THB", "TJS", "TMT", "TND", "TOP", "TRY", "TTD", "TWD", "TZS", "UAH", "UGX", "USD", "UYU", "UZS", "VEF", "VND", "VUV", "WST", "XAF", "XCD", "XOF", "XPF", "YER", "ZAR", "ZMW", "ZWD" ], "title": "ItAssetsPostResponsesContentApplicationJsonSchemaDataActionsReuseOwnAssetFromDeelDetailsExpressDeliveryCountryFeesCurrency", "type": "string" }, "ItAssetsPostResponsesContentApplicationJsonSchemaDataActionsReuseOwnAssetFromDeelDisabledReasonsItems": { "enum": [ "ARCHIVED", "AT_DEEL_WAREHOUSE", "BEING_REPAIRED", "CONSUMABLE", "CONTROLLED_BY_DEEL", "COUNTRY_NOT_SUPPORTED_FOR_HUB", "COUNTRY_NOT_SUPPORTED_FOR_LOCAL", "DEEL_OWNED_ITEM_WITHOUT_RENTAL_CONTRACT", "DESKTOP_STORAGE", "ENDING_CONTRACT", "HUB_IN_SAME_REGION_AS_LOCAL", "INACTIVE", "INVALID_ITEM_LOCATION", "INVALID_ORGANIZATION_STATUS", "INVALID_STATE", "ITEM_CONDITIONS_TO_UNARCHIVE_NOT_MET", "ITEM_NOT_VISIBLE_FOR_ORGANIZATION", "NON_DEVICE", "NOT_AT_WAREHOUSE", "NOT_AVAILABLE_FOR_REUSE", "NOT_A_RENTAL", "NOT_MANAGEABLE_BY_ORGANIZATION", "NOT_WITH_ASSIGNMENT", "NOT_WITH_USER", "NO_ACTIVE_ADDONS", "NO_ACTIVE_STORAGE_CONTRACT", "NO_LOCATION_FOR_STORAGE", "NO_LOGISTICS_FOR_STORAGE", "NO_VALID_ADDONS", "ONGOING_SERVICE", "OWNED_BY_DEEL", "OWNED_BY_ORGANIZATION", "OWNED_BY_PARTNER_ORGANIZATION", "PARTNER_CHILD_CONTRACT", "PENDING_DEVICE_REFRESH", "RENTAL_CONTRACT_AND_USER_REGION_DO_NOT_MATCH", "TEMPORARILY_UNAVAILABLE", "UNKNOWN", "USER_HAS_NO_COUNTRY", "USER_HAS_NO_SEAT", "WAITING_FOR_CLEARANCE", "WITH_LOANER_ASSIGNMENT", "WITH_NON_COLLECTED_ASSIGNMENT", "WITH_NON_DELIVERED_ASSIGNMENT", "WITH_PENDING_ASSIGNMENT", "WRONG_ASSIGNMENT_STATUS", "WRONG_CONTRACT_STATUS", "WRONG_TERMS_AND_CONDITIONS" ], "title": "ItAssetsPostResponsesContentApplicationJsonSchemaDataActionsReuseOwnAssetFromDeelDisabledReasonsItems", "type": "string" }, "ItAssetsPostResponsesContentApplicationJsonSchemaDataActionsReuseOwnAssetFromDeelStatus": { "description": "Whether the action is currently available for this asset", "enum": [ "DISABLED", "ENABLED", "NOT_APPLICABLE" ], "title": "ItAssetsPostResponsesContentApplicationJsonSchemaDataActionsReuseOwnAssetFromDeelStatus", "type": "string" }, "ItAssetsPostResponsesContentApplicationJsonSchemaDataActionsReuseOwnAssetFromOwnLocation": { "description": "Redeploy an organization-owned asset from an organization-owned location", "properties": { "details": { "description": "Action-specific context needed to perform the action. Populated for enabled and\ndisabled actions (so callers can see what a successful attempt would look like);\nnull when the action is not applicable to this asset.", "oneOf": [ { "$ref": "#/components/schemas/ItAssetsPostResponsesContentApplicationJsonSchemaDataActionsReuseOwnAssetFromOwnLocationDetails" }, { "type": "null" } ] }, "disabled_reasons": { "description": "Reasons why the action is disabled. Empty when the action is enabled or not applicable", "items": { "$ref": "#/components/schemas/ItAssetsPostResponsesContentApplicationJsonSchemaDataActionsReuseOwnAssetFromOwnLocationDisabledReasonsItems" }, "type": "array" }, "status": { "$ref": "#/components/schemas/ItAssetsPostResponsesContentApplicationJsonSchemaDataActionsReuseOwnAssetFromOwnLocationStatus", "description": "Whether the action is currently available for this asset" } }, "required": [ "status", "details", "disabled_reasons" ], "title": "ItAssetsPostResponsesContentApplicationJsonSchemaDataActionsReuseOwnAssetFromOwnLocation", "type": "object" }, "ItAssetsPostResponsesContentApplicationJsonSchemaDataActionsReuseOwnAssetFromOwnLocationDetails": { "description": "Action-specific context needed to perform the action. Populated for enabled and\ndisabled actions (so callers can see what a successful attempt would look like);\nnull when the action is not applicable to this asset.", "properties": { "eligible_countries": { "description": "Countries where the asset can be redeployed from an organization-owned location", "items": { "$ref": "#/components/schemas/ItAssetsPostResponsesContentApplicationJsonSchemaDataActionsReuseOwnAssetFromOwnLocationDetailsEligibleCountriesItems" }, "type": "array" }, "express_delivery": { "description": "Express delivery availability and per-country fees. Null when express delivery is not supported", "oneOf": [ { "$ref": "#/components/schemas/ItAssetsPostResponsesContentApplicationJsonSchemaDataActionsReuseOwnAssetFromOwnLocationDetailsExpressDelivery" }, { "type": "null" } ] }, "service_cost": { "$ref": "#/components/schemas/ItAssetsPostResponsesContentApplicationJsonSchemaDataActionsReuseOwnAssetFromOwnLocationDetailsServiceCost", "description": "Cost charged for the transfer service" } }, "required": [ "service_cost", "express_delivery", "eligible_countries" ], "title": "ItAssetsPostResponsesContentApplicationJsonSchemaDataActionsReuseOwnAssetFromOwnLocationDetails", "type": "object" }, "ItAssetsPostResponsesContentApplicationJsonSchemaDataActionsReuseOwnAssetFromOwnLocationDetailsEligibleCountriesItems": { "enum": [ "AD", "AE", "AF", "AG", "AI", "AL", "AM", "AN", "AO", "AQ", "AR", "AS", "AT", "AU", "AW", "AX", "AZ", "BA", "BB", "BD", "BE", "BF", "BG", "BH", "BI", "BJ", "BL", "BM", "BN", "BO", "BQ", "BR", "BS", "BT", "BV", "BW", "BY", "BZ", "CA", "CC", "CD", "CF", "CG", "CH", "CI", "CK", "CL", "CM", "CN", "CO", "CR", "CU", "CV", "CW", "CX", "CY", "CZ", "DE", "DJ", "DK", "DM", "DO", "DZ", "EC", "EE", "EG", "EH", "ER", "ES", "ET", "FI", "FJ", "FK", "FM", "FO", "FR", "GA", "GB", "GD", "GE", "GF", "GG", "GH", "GI", "GL", "GM", "GN", "GP", "GQ", "GR", "GS", "GT", "GU", "GW", "GY", "HK", "HM", "HN", "HR", "HT", "HU", "IC", "ID", "IE", "IL", "IM", "IN", "IO", "IQ", "IR", "IS", "IT", "JE", "JM", "JO", "JP", "KE", "KG", "KH", "KI", "KM", "KN", "KP", "KR", "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", "XK", "YE", "YT", "ZA", "ZM", "ZW" ], "title": "ItAssetsPostResponsesContentApplicationJsonSchemaDataActionsReuseOwnAssetFromOwnLocationDetailsEligibleCountriesItems", "type": "string" }, "ItAssetsPostResponsesContentApplicationJsonSchemaDataActionsReuseOwnAssetFromOwnLocationDetailsExpressDelivery": { "description": "Express delivery availability and per-country fees. Null when express delivery is not supported", "properties": { "country_fees": { "additionalProperties": { "$ref": "#/components/schemas/ItAssetsPostResponsesContentApplicationJsonSchemaDataActionsReuseOwnAssetFromOwnLocationDetailsExpressDeliveryCountryFees" }, "description": "Express delivery fees keyed by destination country.", "type": "object" } }, "required": [ "country_fees" ], "title": "ItAssetsPostResponsesContentApplicationJsonSchemaDataActionsReuseOwnAssetFromOwnLocationDetailsExpressDelivery", "type": "object" }, "ItAssetsPostResponsesContentApplicationJsonSchemaDataActionsReuseOwnAssetFromOwnLocationDetailsExpressDeliveryCountryFees": { "properties": { "amount": { "description": "Amount", "format": "decimal", "type": "string" }, "currency": { "$ref": "#/components/schemas/ItAssetsPostResponsesContentApplicationJsonSchemaDataActionsReuseOwnAssetFromOwnLocationDetailsExpressDeliveryCountryFeesCurrency", "description": "Three-letter currency code for the price" } }, "required": [ "amount", "currency" ], "title": "ItAssetsPostResponsesContentApplicationJsonSchemaDataActionsReuseOwnAssetFromOwnLocationDetailsExpressDeliveryCountryFees", "type": "object" }, "ItAssetsPostResponsesContentApplicationJsonSchemaDataActionsReuseOwnAssetFromOwnLocationDetailsExpressDeliveryCountryFeesCurrency": { "description": "Three-letter currency code for the price", "enum": [ "AED", "AFN", "ALL", "AMD", "ANG", "AOA", "ARS", "AUD", "AWG", "AZN", "BAM", "BDT", "BGN", "BHD", "BIF", "BMD", "BOB", "BRL", "BSD", "BTN", "BWP", "BYN", "BZD", "CAD", "CDF", "CHF", "CLP", "CNY", "COP", "CRC", "CUC", "CVE", "CZK", "DJF", "DKK", "DOP", "DZD", "EGP", "ERN", "ETB", "EUR", "FJD", "FKP", "GBP", "GEL", "GHS", "GIP", "GMD", "GNF", "GTQ", "GYD", "HKD", "HNL", "HRK", "HTG", "HUF", "IDR", "ILS", "INR", "IQD", "IRR", "ISK", "JMD", "JOD", "JPY", "KES", "KGS", "KHR", "KMF", "KPW", "KRW", "KWD", "KYD", "KZT", "LAK", "LBP", "LKR", "LRD", "LSL", "LTL", "LYD", "MAD", "MDL", "MGA", "MKD", "MMK", "MNT", "MRU", "MUR", "MVR", "MWK", "MXN", "MYR", "MZN", "NAD", "NGN", "NIO", "NOK", "NPR", "NZD", "OMR", "PAB", "PEN", "PGK", "PHP", "PKR", "PLN", "PYG", "QAR", "RON", "RSD", "RUB", "RWF", "SAR", "SBD", "SCR", "SDG", "SEK", "SGD", "SHP", "SLL", "SOS", "SRD", "SSP", "STD", "SYP", "SZL", "THB", "TJS", "TMT", "TND", "TOP", "TRY", "TTD", "TWD", "TZS", "UAH", "UGX", "USD", "UYU", "UZS", "VEF", "VND", "VUV", "WST", "XAF", "XCD", "XOF", "XPF", "YER", "ZAR", "ZMW", "ZWD" ], "title": "ItAssetsPostResponsesContentApplicationJsonSchemaDataActionsReuseOwnAssetFromOwnLocationDetailsExpressDeliveryCountryFeesCurrency", "type": "string" }, "ItAssetsPostResponsesContentApplicationJsonSchemaDataActionsReuseOwnAssetFromOwnLocationDetailsServiceCost": { "description": "Cost charged for the transfer service", "properties": { "billing_method": { "$ref": "#/components/schemas/ItAssetsPostResponsesContentApplicationJsonSchemaDataActionsReuseOwnAssetFromOwnLocationDetailsServiceCostBillingMethod", "description": "How the action is charged. When \"TOKEN\", the fees are covered by an\nadd-on token pool; when \"CURRENCY\", the fees are billed in the currency\nspecified in the \"fees\" field." }, "fees": { "description": "Price charged for the action. Null when billing method is \"TOKEN\"", "oneOf": [ { "$ref": "#/components/schemas/ItAssetsPostResponsesContentApplicationJsonSchemaDataActionsReuseOwnAssetFromOwnLocationDetailsServiceCostFees" }, { "type": "null" } ] }, "token_usage": { "description": "Add-on token consumption details. Null when billing method is \"CURRENCY\"", "oneOf": [ { "$ref": "#/components/schemas/ItAssetsPostResponsesContentApplicationJsonSchemaDataActionsReuseOwnAssetFromOwnLocationDetailsServiceCostTokenUsage" }, { "type": "null" } ] } }, "required": [ "fees", "token_usage", "billing_method" ], "title": "ItAssetsPostResponsesContentApplicationJsonSchemaDataActionsReuseOwnAssetFromOwnLocationDetailsServiceCost", "type": "object" }, "ItAssetsPostResponsesContentApplicationJsonSchemaDataActionsReuseOwnAssetFromOwnLocationDetailsServiceCostBillingMethod": { "description": "How the action is charged. When \"TOKEN\", the fees are covered by an\nadd-on token pool; when \"CURRENCY\", the fees are billed in the currency\nspecified in the \"fees\" field.", "enum": [ "CURRENCY", "TOKEN" ], "title": "ItAssetsPostResponsesContentApplicationJsonSchemaDataActionsReuseOwnAssetFromOwnLocationDetailsServiceCostBillingMethod", "type": "string" }, "ItAssetsPostResponsesContentApplicationJsonSchemaDataActionsReuseOwnAssetFromOwnLocationDetailsServiceCostFees": { "description": "Price charged for the action. Null when billing method is \"TOKEN\"", "properties": { "amount": { "description": "Amount", "format": "decimal", "type": "string" }, "currency": { "$ref": "#/components/schemas/ItAssetsPostResponsesContentApplicationJsonSchemaDataActionsReuseOwnAssetFromOwnLocationDetailsServiceCostFeesCurrency", "description": "Three-letter currency code for the price" } }, "required": [ "amount", "currency" ], "title": "ItAssetsPostResponsesContentApplicationJsonSchemaDataActionsReuseOwnAssetFromOwnLocationDetailsServiceCostFees", "type": "object" }, "ItAssetsPostResponsesContentApplicationJsonSchemaDataActionsReuseOwnAssetFromOwnLocationDetailsServiceCostFeesCurrency": { "description": "Three-letter currency code for the price", "enum": [ "AED", "AFN", "ALL", "AMD", "ANG", "AOA", "ARS", "AUD", "AWG", "AZN", "BAM", "BDT", "BGN", "BHD", "BIF", "BMD", "BOB", "BRL", "BSD", "BTN", "BWP", "BYN", "BZD", "CAD", "CDF", "CHF", "CLP", "CNY", "COP", "CRC", "CUC", "CVE", "CZK", "DJF", "DKK", "DOP", "DZD", "EGP", "ERN", "ETB", "EUR", "FJD", "FKP", "GBP", "GEL", "GHS", "GIP", "GMD", "GNF", "GTQ", "GYD", "HKD", "HNL", "HRK", "HTG", "HUF", "IDR", "ILS", "INR", "IQD", "IRR", "ISK", "JMD", "JOD", "JPY", "KES", "KGS", "KHR", "KMF", "KPW", "KRW", "KWD", "KYD", "KZT", "LAK", "LBP", "LKR", "LRD", "LSL", "LTL", "LYD", "MAD", "MDL", "MGA", "MKD", "MMK", "MNT", "MRU", "MUR", "MVR", "MWK", "MXN", "MYR", "MZN", "NAD", "NGN", "NIO", "NOK", "NPR", "NZD", "OMR", "PAB", "PEN", "PGK", "PHP", "PKR", "PLN", "PYG", "QAR", "RON", "RSD", "RUB", "RWF", "SAR", "SBD", "SCR", "SDG", "SEK", "SGD", "SHP", "SLL", "SOS", "SRD", "SSP", "STD", "SYP", "SZL", "THB", "TJS", "TMT", "TND", "TOP", "TRY", "TTD", "TWD", "TZS", "UAH", "UGX", "USD", "UYU", "UZS", "VEF", "VND", "VUV", "WST", "XAF", "XCD", "XOF", "XPF", "YER", "ZAR", "ZMW", "ZWD" ], "title": "ItAssetsPostResponsesContentApplicationJsonSchemaDataActionsReuseOwnAssetFromOwnLocationDetailsServiceCostFeesCurrency", "type": "string" }, "ItAssetsPostResponsesContentApplicationJsonSchemaDataActionsReuseOwnAssetFromOwnLocationDetailsServiceCostTokenUsage": { "description": "Add-on token consumption details. Null when billing method is \"CURRENCY\"", "properties": { "addon": { "$ref": "#/components/schemas/ItAssetsPostResponsesContentApplicationJsonSchemaDataActionsReuseOwnAssetFromOwnLocationDetailsServiceCostTokenUsageAddon", "description": "The add-on that provides the tokens" }, "cost": { "description": "Number of tokens consumed by the action. Zero when the add-on covers the\nservice without drawing from a token pool", "format": "decimal", "type": "string" }, "tokens_left": { "description": "Number of tokens left in the pool after the action is performed. Null when\nthe add-on covers the service without a token pool", "format": "decimal", "type": [ "string", "null" ] } }, "required": [ "cost", "addon", "tokens_left" ], "title": "ItAssetsPostResponsesContentApplicationJsonSchemaDataActionsReuseOwnAssetFromOwnLocationDetailsServiceCostTokenUsage", "type": "object" }, "ItAssetsPostResponsesContentApplicationJsonSchemaDataActionsReuseOwnAssetFromOwnLocationDetailsServiceCostTokenUsageAddon": { "description": "The add-on that provides the tokens", "properties": { "id": { "description": "ID of the add-on", "format": "uuid", "type": "string" }, "name": { "description": "Public display name of the add-on", "type": "string" } }, "required": [ "id", "name" ], "title": "ItAssetsPostResponsesContentApplicationJsonSchemaDataActionsReuseOwnAssetFromOwnLocationDetailsServiceCostTokenUsageAddon", "type": "object" }, "ItAssetsPostResponsesContentApplicationJsonSchemaDataActionsReuseOwnAssetFromOwnLocationDisabledReasonsItems": { "enum": [ "ARCHIVED", "AT_DEEL_WAREHOUSE", "BEING_REPAIRED", "CONSUMABLE", "CONTROLLED_BY_DEEL", "COUNTRY_NOT_SUPPORTED_FOR_HUB", "COUNTRY_NOT_SUPPORTED_FOR_LOCAL", "DEEL_OWNED_ITEM_WITHOUT_RENTAL_CONTRACT", "DESKTOP_STORAGE", "ENDING_CONTRACT", "HUB_IN_SAME_REGION_AS_LOCAL", "INACTIVE", "INVALID_ITEM_LOCATION", "INVALID_ORGANIZATION_STATUS", "INVALID_STATE", "ITEM_CONDITIONS_TO_UNARCHIVE_NOT_MET", "ITEM_NOT_VISIBLE_FOR_ORGANIZATION", "NON_DEVICE", "NOT_AT_WAREHOUSE", "NOT_AVAILABLE_FOR_REUSE", "NOT_A_RENTAL", "NOT_MANAGEABLE_BY_ORGANIZATION", "NOT_WITH_ASSIGNMENT", "NOT_WITH_USER", "NO_ACTIVE_ADDONS", "NO_ACTIVE_STORAGE_CONTRACT", "NO_LOCATION_FOR_STORAGE", "NO_LOGISTICS_FOR_STORAGE", "NO_VALID_ADDONS", "ONGOING_SERVICE", "OWNED_BY_DEEL", "OWNED_BY_ORGANIZATION", "OWNED_BY_PARTNER_ORGANIZATION", "PARTNER_CHILD_CONTRACT", "PENDING_DEVICE_REFRESH", "RENTAL_CONTRACT_AND_USER_REGION_DO_NOT_MATCH", "TEMPORARILY_UNAVAILABLE", "UNKNOWN", "USER_HAS_NO_COUNTRY", "USER_HAS_NO_SEAT", "WAITING_FOR_CLEARANCE", "WITH_LOANER_ASSIGNMENT", "WITH_NON_COLLECTED_ASSIGNMENT", "WITH_NON_DELIVERED_ASSIGNMENT", "WITH_PENDING_ASSIGNMENT", "WRONG_ASSIGNMENT_STATUS", "WRONG_CONTRACT_STATUS", "WRONG_TERMS_AND_CONDITIONS" ], "title": "ItAssetsPostResponsesContentApplicationJsonSchemaDataActionsReuseOwnAssetFromOwnLocationDisabledReasonsItems", "type": "string" }, "ItAssetsPostResponsesContentApplicationJsonSchemaDataActionsReuseOwnAssetFromOwnLocationStatus": { "description": "Whether the action is currently available for this asset", "enum": [ "DISABLED", "ENABLED", "NOT_APPLICABLE" ], "title": "ItAssetsPostResponsesContentApplicationJsonSchemaDataActionsReuseOwnAssetFromOwnLocationStatus", "type": "string" }, "ItAssetsPostResponsesContentApplicationJsonSchemaDataActionsStoreOwnAssetAtDeelForHub": { "description": "Store an organization-owned asset at a Deel hub warehouse", "properties": { "details": { "description": "Action-specific context needed to perform the action. Populated for enabled and\ndisabled actions (so callers can see what a successful attempt would look like);\nnull when the action is not applicable to this asset.", "oneOf": [ { "$ref": "#/components/schemas/ItAssetsPostResponsesContentApplicationJsonSchemaDataActionsStoreOwnAssetAtDeelForHubDetails" }, { "type": "null" } ] }, "disabled_reasons": { "description": "Reasons why the action is disabled. Empty when the action is enabled or not applicable", "items": { "$ref": "#/components/schemas/ItAssetsPostResponsesContentApplicationJsonSchemaDataActionsStoreOwnAssetAtDeelForHubDisabledReasonsItems" }, "type": "array" }, "status": { "$ref": "#/components/schemas/ItAssetsPostResponsesContentApplicationJsonSchemaDataActionsStoreOwnAssetAtDeelForHubStatus", "description": "Whether the action is currently available for this asset" } }, "required": [ "status", "details", "disabled_reasons" ], "title": "ItAssetsPostResponsesContentApplicationJsonSchemaDataActionsStoreOwnAssetAtDeelForHub", "type": "object" }, "ItAssetsPostResponsesContentApplicationJsonSchemaDataActionsStoreOwnAssetAtDeelForHubDetails": { "description": "Action-specific context needed to perform the action. Populated for enabled and\ndisabled actions (so callers can see what a successful attempt would look like);\nnull when the action is not applicable to this asset.", "properties": { "activation_cost": { "$ref": "#/components/schemas/ItAssetsPostResponsesContentApplicationJsonSchemaDataActionsStoreOwnAssetAtDeelForHubDetailsActivationCost", "description": "Cost charged to activate storage" }, "destination_country": { "$ref": "#/components/schemas/ItAssetsPostResponsesContentApplicationJsonSchemaDataActionsStoreOwnAssetAtDeelForHubDetailsDestinationCountry", "description": "ISO 3166-1 alpha-2 country of the Deel warehouse the asset will be shipped to" }, "grace_period_in_months": { "description": "Grace period in months during which storage is free before monthly fees apply", "format": "int64", "type": "integer" }, "monthly_fee": { "$ref": "#/components/schemas/ItAssetsPostResponsesContentApplicationJsonSchemaDataActionsStoreOwnAssetAtDeelForHubDetailsMonthlyFee", "description": "Monthly storage fee charged after the grace period" } }, "required": [ "monthly_fee", "activation_cost", "destination_country", "grace_period_in_months" ], "title": "ItAssetsPostResponsesContentApplicationJsonSchemaDataActionsStoreOwnAssetAtDeelForHubDetails", "type": "object" }, "ItAssetsPostResponsesContentApplicationJsonSchemaDataActionsStoreOwnAssetAtDeelForHubDetailsActivationCost": { "description": "Cost charged to activate storage", "properties": { "billing_method": { "$ref": "#/components/schemas/ItAssetsPostResponsesContentApplicationJsonSchemaDataActionsStoreOwnAssetAtDeelForHubDetailsActivationCostBillingMethod", "description": "How the action is charged. When \"TOKEN\", the fees are covered by an\nadd-on token pool; when \"CURRENCY\", the fees are billed in the currency\nspecified in the \"fees\" field." }, "fees": { "description": "Price charged for the action. Null when billing method is \"TOKEN\"", "oneOf": [ { "$ref": "#/components/schemas/ItAssetsPostResponsesContentApplicationJsonSchemaDataActionsStoreOwnAssetAtDeelForHubDetailsActivationCostFees" }, { "type": "null" } ] }, "token_usage": { "description": "Add-on token consumption details. Null when billing method is \"CURRENCY\"", "oneOf": [ { "$ref": "#/components/schemas/ItAssetsPostResponsesContentApplicationJsonSchemaDataActionsStoreOwnAssetAtDeelForHubDetailsActivationCostTokenUsage" }, { "type": "null" } ] } }, "required": [ "fees", "token_usage", "billing_method" ], "title": "ItAssetsPostResponsesContentApplicationJsonSchemaDataActionsStoreOwnAssetAtDeelForHubDetailsActivationCost", "type": "object" }, "ItAssetsPostResponsesContentApplicationJsonSchemaDataActionsStoreOwnAssetAtDeelForHubDetailsActivationCostBillingMethod": { "description": "How the action is charged. When \"TOKEN\", the fees are covered by an\nadd-on token pool; when \"CURRENCY\", the fees are billed in the currency\nspecified in the \"fees\" field.", "enum": [ "CURRENCY", "TOKEN" ], "title": "ItAssetsPostResponsesContentApplicationJsonSchemaDataActionsStoreOwnAssetAtDeelForHubDetailsActivationCostBillingMethod", "type": "string" }, "ItAssetsPostResponsesContentApplicationJsonSchemaDataActionsStoreOwnAssetAtDeelForHubDetailsActivationCostFees": { "description": "Price charged for the action. Null when billing method is \"TOKEN\"", "properties": { "amount": { "description": "Amount", "format": "decimal", "type": "string" }, "currency": { "$ref": "#/components/schemas/ItAssetsPostResponsesContentApplicationJsonSchemaDataActionsStoreOwnAssetAtDeelForHubDetailsActivationCostFeesCurrency", "description": "Three-letter currency code for the price" } }, "required": [ "amount", "currency" ], "title": "ItAssetsPostResponsesContentApplicationJsonSchemaDataActionsStoreOwnAssetAtDeelForHubDetailsActivationCostFees", "type": "object" }, "ItAssetsPostResponsesContentApplicationJsonSchemaDataActionsStoreOwnAssetAtDeelForHubDetailsActivationCostFeesCurrency": { "description": "Three-letter currency code for the price", "enum": [ "AED", "AFN", "ALL", "AMD", "ANG", "AOA", "ARS", "AUD", "AWG", "AZN", "BAM", "BDT", "BGN", "BHD", "BIF", "BMD", "BOB", "BRL", "BSD", "BTN", "BWP", "BYN", "BZD", "CAD", "CDF", "CHF", "CLP", "CNY", "COP", "CRC", "CUC", "CVE", "CZK", "DJF", "DKK", "DOP", "DZD", "EGP", "ERN", "ETB", "EUR", "FJD", "FKP", "GBP", "GEL", "GHS", "GIP", "GMD", "GNF", "GTQ", "GYD", "HKD", "HNL", "HRK", "HTG", "HUF", "IDR", "ILS", "INR", "IQD", "IRR", "ISK", "JMD", "JOD", "JPY", "KES", "KGS", "KHR", "KMF", "KPW", "KRW", "KWD", "KYD", "KZT", "LAK", "LBP", "LKR", "LRD", "LSL", "LTL", "LYD", "MAD", "MDL", "MGA", "MKD", "MMK", "MNT", "MRU", "MUR", "MVR", "MWK", "MXN", "MYR", "MZN", "NAD", "NGN", "NIO", "NOK", "NPR", "NZD", "OMR", "PAB", "PEN", "PGK", "PHP", "PKR", "PLN", "PYG", "QAR", "RON", "RSD", "RUB", "RWF", "SAR", "SBD", "SCR", "SDG", "SEK", "SGD", "SHP", "SLL", "SOS", "SRD", "SSP", "STD", "SYP", "SZL", "THB", "TJS", "TMT", "TND", "TOP", "TRY", "TTD", "TWD", "TZS", "UAH", "UGX", "USD", "UYU", "UZS", "VEF", "VND", "VUV", "WST", "XAF", "XCD", "XOF", "XPF", "YER", "ZAR", "ZMW", "ZWD" ], "title": "ItAssetsPostResponsesContentApplicationJsonSchemaDataActionsStoreOwnAssetAtDeelForHubDetailsActivationCostFeesCurrency", "type": "string" }, "ItAssetsPostResponsesContentApplicationJsonSchemaDataActionsStoreOwnAssetAtDeelForHubDetailsActivationCostTokenUsage": { "description": "Add-on token consumption details. Null when billing method is \"CURRENCY\"", "properties": { "addon": { "$ref": "#/components/schemas/ItAssetsPostResponsesContentApplicationJsonSchemaDataActionsStoreOwnAssetAtDeelForHubDetailsActivationCostTokenUsageAddon", "description": "The add-on that provides the tokens" }, "cost": { "description": "Number of tokens consumed by the action. Zero when the add-on covers the\nservice without drawing from a token pool", "format": "decimal", "type": "string" }, "tokens_left": { "description": "Number of tokens left in the pool after the action is performed. Null when\nthe add-on covers the service without a token pool", "format": "decimal", "type": [ "string", "null" ] } }, "required": [ "cost", "addon", "tokens_left" ], "title": "ItAssetsPostResponsesContentApplicationJsonSchemaDataActionsStoreOwnAssetAtDeelForHubDetailsActivationCostTokenUsage", "type": "object" }, "ItAssetsPostResponsesContentApplicationJsonSchemaDataActionsStoreOwnAssetAtDeelForHubDetailsActivationCostTokenUsageAddon": { "description": "The add-on that provides the tokens", "properties": { "id": { "description": "ID of the add-on", "format": "uuid", "type": "string" }, "name": { "description": "Public display name of the add-on", "type": "string" } }, "required": [ "id", "name" ], "title": "ItAssetsPostResponsesContentApplicationJsonSchemaDataActionsStoreOwnAssetAtDeelForHubDetailsActivationCostTokenUsageAddon", "type": "object" }, "ItAssetsPostResponsesContentApplicationJsonSchemaDataActionsStoreOwnAssetAtDeelForHubDetailsDestinationCountry": { "description": "ISO 3166-1 alpha-2 country of the Deel warehouse the asset will be shipped to", "enum": [ "AD", "AE", "AF", "AG", "AI", "AL", "AM", "AN", "AO", "AQ", "AR", "AS", "AT", "AU", "AW", "AX", "AZ", "BA", "BB", "BD", "BE", "BF", "BG", "BH", "BI", "BJ", "BL", "BM", "BN", "BO", "BQ", "BR", "BS", "BT", "BV", "BW", "BY", "BZ", "CA", "CC", "CD", "CF", "CG", "CH", "CI", "CK", "CL", "CM", "CN", "CO", "CR", "CU", "CV", "CW", "CX", "CY", "CZ", "DE", "DJ", "DK", "DM", "DO", "DZ", "EC", "EE", "EG", "EH", "ER", "ES", "ET", "FI", "FJ", "FK", "FM", "FO", "FR", "GA", "GB", "GD", "GE", "GF", "GG", "GH", "GI", "GL", "GM", "GN", "GP", "GQ", "GR", "GS", "GT", "GU", "GW", "GY", "HK", "HM", "HN", "HR", "HT", "HU", "IC", "ID", "IE", "IL", "IM", "IN", "IO", "IQ", "IR", "IS", "IT", "JE", "JM", "JO", "JP", "KE", "KG", "KH", "KI", "KM", "KN", "KP", "KR", "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", "XK", "YE", "YT", "ZA", "ZM", "ZW" ], "title": "ItAssetsPostResponsesContentApplicationJsonSchemaDataActionsStoreOwnAssetAtDeelForHubDetailsDestinationCountry", "type": "string" }, "ItAssetsPostResponsesContentApplicationJsonSchemaDataActionsStoreOwnAssetAtDeelForHubDetailsMonthlyFee": { "description": "Monthly storage fee charged after the grace period", "properties": { "amount": { "description": "Amount", "format": "decimal", "type": "string" }, "currency": { "$ref": "#/components/schemas/ItAssetsPostResponsesContentApplicationJsonSchemaDataActionsStoreOwnAssetAtDeelForHubDetailsMonthlyFeeCurrency", "description": "Three-letter currency code for the price" } }, "required": [ "amount", "currency" ], "title": "ItAssetsPostResponsesContentApplicationJsonSchemaDataActionsStoreOwnAssetAtDeelForHubDetailsMonthlyFee", "type": "object" }, "ItAssetsPostResponsesContentApplicationJsonSchemaDataActionsStoreOwnAssetAtDeelForHubDetailsMonthlyFeeCurrency": { "description": "Three-letter currency code for the price", "enum": [ "AED", "AFN", "ALL", "AMD", "ANG", "AOA", "ARS", "AUD", "AWG", "AZN", "BAM", "BDT", "BGN", "BHD", "BIF", "BMD", "BOB", "BRL", "BSD", "BTN", "BWP", "BYN", "BZD", "CAD", "CDF", "CHF", "CLP", "CNY", "COP", "CRC", "CUC", "CVE", "CZK", "DJF", "DKK", "DOP", "DZD", "EGP", "ERN", "ETB", "EUR", "FJD", "FKP", "GBP", "GEL", "GHS", "GIP", "GMD", "GNF", "GTQ", "GYD", "HKD", "HNL", "HRK", "HTG", "HUF", "IDR", "ILS", "INR", "IQD", "IRR", "ISK", "JMD", "JOD", "JPY", "KES", "KGS", "KHR", "KMF", "KPW", "KRW", "KWD", "KYD", "KZT", "LAK", "LBP", "LKR", "LRD", "LSL", "LTL", "LYD", "MAD", "MDL", "MGA", "MKD", "MMK", "MNT", "MRU", "MUR", "MVR", "MWK", "MXN", "MYR", "MZN", "NAD", "NGN", "NIO", "NOK", "NPR", "NZD", "OMR", "PAB", "PEN", "PGK", "PHP", "PKR", "PLN", "PYG", "QAR", "RON", "RSD", "RUB", "RWF", "SAR", "SBD", "SCR", "SDG", "SEK", "SGD", "SHP", "SLL", "SOS", "SRD", "SSP", "STD", "SYP", "SZL", "THB", "TJS", "TMT", "TND", "TOP", "TRY", "TTD", "TWD", "TZS", "UAH", "UGX", "USD", "UYU", "UZS", "VEF", "VND", "VUV", "WST", "XAF", "XCD", "XOF", "XPF", "YER", "ZAR", "ZMW", "ZWD" ], "title": "ItAssetsPostResponsesContentApplicationJsonSchemaDataActionsStoreOwnAssetAtDeelForHubDetailsMonthlyFeeCurrency", "type": "string" }, "ItAssetsPostResponsesContentApplicationJsonSchemaDataActionsStoreOwnAssetAtDeelForHubDisabledReasonsItems": { "enum": [ "ARCHIVED", "AT_DEEL_WAREHOUSE", "BEING_REPAIRED", "CONSUMABLE", "CONTROLLED_BY_DEEL", "COUNTRY_NOT_SUPPORTED_FOR_HUB", "COUNTRY_NOT_SUPPORTED_FOR_LOCAL", "DEEL_OWNED_ITEM_WITHOUT_RENTAL_CONTRACT", "DESKTOP_STORAGE", "ENDING_CONTRACT", "HUB_IN_SAME_REGION_AS_LOCAL", "INACTIVE", "INVALID_ITEM_LOCATION", "INVALID_ORGANIZATION_STATUS", "INVALID_STATE", "ITEM_CONDITIONS_TO_UNARCHIVE_NOT_MET", "ITEM_NOT_VISIBLE_FOR_ORGANIZATION", "NON_DEVICE", "NOT_AT_WAREHOUSE", "NOT_AVAILABLE_FOR_REUSE", "NOT_A_RENTAL", "NOT_MANAGEABLE_BY_ORGANIZATION", "NOT_WITH_ASSIGNMENT", "NOT_WITH_USER", "NO_ACTIVE_ADDONS", "NO_ACTIVE_STORAGE_CONTRACT", "NO_LOCATION_FOR_STORAGE", "NO_LOGISTICS_FOR_STORAGE", "NO_VALID_ADDONS", "ONGOING_SERVICE", "OWNED_BY_DEEL", "OWNED_BY_ORGANIZATION", "OWNED_BY_PARTNER_ORGANIZATION", "PARTNER_CHILD_CONTRACT", "PENDING_DEVICE_REFRESH", "RENTAL_CONTRACT_AND_USER_REGION_DO_NOT_MATCH", "TEMPORARILY_UNAVAILABLE", "UNKNOWN", "USER_HAS_NO_COUNTRY", "USER_HAS_NO_SEAT", "WAITING_FOR_CLEARANCE", "WITH_LOANER_ASSIGNMENT", "WITH_NON_COLLECTED_ASSIGNMENT", "WITH_NON_DELIVERED_ASSIGNMENT", "WITH_PENDING_ASSIGNMENT", "WRONG_ASSIGNMENT_STATUS", "WRONG_CONTRACT_STATUS", "WRONG_TERMS_AND_CONDITIONS" ], "title": "ItAssetsPostResponsesContentApplicationJsonSchemaDataActionsStoreOwnAssetAtDeelForHubDisabledReasonsItems", "type": "string" }, "ItAssetsPostResponsesContentApplicationJsonSchemaDataActionsStoreOwnAssetAtDeelForHubStatus": { "description": "Whether the action is currently available for this asset", "enum": [ "DISABLED", "ENABLED", "NOT_APPLICABLE" ], "title": "ItAssetsPostResponsesContentApplicationJsonSchemaDataActionsStoreOwnAssetAtDeelForHubStatus", "type": "string" }, "ItAssetsPostResponsesContentApplicationJsonSchemaDataActionsStoreOwnAssetAtDeelForLocal": { "description": "Store an organization-owned asset at a Deel local warehouse", "properties": { "details": { "description": "Action-specific context needed to perform the action. Populated for enabled and\ndisabled actions (so callers can see what a successful attempt would look like);\nnull when the action is not applicable to this asset.", "oneOf": [ { "$ref": "#/components/schemas/ItAssetsPostResponsesContentApplicationJsonSchemaDataActionsStoreOwnAssetAtDeelForLocalDetails" }, { "type": "null" } ] }, "disabled_reasons": { "description": "Reasons why the action is disabled. Empty when the action is enabled or not applicable", "items": { "$ref": "#/components/schemas/ItAssetsPostResponsesContentApplicationJsonSchemaDataActionsStoreOwnAssetAtDeelForLocalDisabledReasonsItems" }, "type": "array" }, "status": { "$ref": "#/components/schemas/ItAssetsPostResponsesContentApplicationJsonSchemaDataActionsStoreOwnAssetAtDeelForLocalStatus", "description": "Whether the action is currently available for this asset" } }, "required": [ "status", "details", "disabled_reasons" ], "title": "ItAssetsPostResponsesContentApplicationJsonSchemaDataActionsStoreOwnAssetAtDeelForLocal", "type": "object" }, "ItAssetsPostResponsesContentApplicationJsonSchemaDataActionsStoreOwnAssetAtDeelForLocalDetails": { "description": "Action-specific context needed to perform the action. Populated for enabled and\ndisabled actions (so callers can see what a successful attempt would look like);\nnull when the action is not applicable to this asset.", "properties": { "activation_cost": { "$ref": "#/components/schemas/ItAssetsPostResponsesContentApplicationJsonSchemaDataActionsStoreOwnAssetAtDeelForLocalDetailsActivationCost", "description": "Cost charged to activate storage" }, "destination_country": { "$ref": "#/components/schemas/ItAssetsPostResponsesContentApplicationJsonSchemaDataActionsStoreOwnAssetAtDeelForLocalDetailsDestinationCountry", "description": "ISO 3166-1 alpha-2 country of the Deel warehouse the asset will be shipped to" }, "grace_period_in_months": { "description": "Grace period in months during which storage is free before monthly fees apply", "format": "int64", "type": "integer" }, "monthly_fee": { "$ref": "#/components/schemas/ItAssetsPostResponsesContentApplicationJsonSchemaDataActionsStoreOwnAssetAtDeelForLocalDetailsMonthlyFee", "description": "Monthly storage fee charged after the grace period" } }, "required": [ "monthly_fee", "activation_cost", "destination_country", "grace_period_in_months" ], "title": "ItAssetsPostResponsesContentApplicationJsonSchemaDataActionsStoreOwnAssetAtDeelForLocalDetails", "type": "object" }, "ItAssetsPostResponsesContentApplicationJsonSchemaDataActionsStoreOwnAssetAtDeelForLocalDetailsActivationCost": { "description": "Cost charged to activate storage", "properties": { "billing_method": { "$ref": "#/components/schemas/ItAssetsPostResponsesContentApplicationJsonSchemaDataActionsStoreOwnAssetAtDeelForLocalDetailsActivationCostBillingMethod", "description": "How the action is charged. When \"TOKEN\", the fees are covered by an\nadd-on token pool; when \"CURRENCY\", the fees are billed in the currency\nspecified in the \"fees\" field." }, "fees": { "description": "Price charged for the action. Null when billing method is \"TOKEN\"", "oneOf": [ { "$ref": "#/components/schemas/ItAssetsPostResponsesContentApplicationJsonSchemaDataActionsStoreOwnAssetAtDeelForLocalDetailsActivationCostFees" }, { "type": "null" } ] }, "token_usage": { "description": "Add-on token consumption details. Null when billing method is \"CURRENCY\"", "oneOf": [ { "$ref": "#/components/schemas/ItAssetsPostResponsesContentApplicationJsonSchemaDataActionsStoreOwnAssetAtDeelForLocalDetailsActivationCostTokenUsage" }, { "type": "null" } ] } }, "required": [ "fees", "token_usage", "billing_method" ], "title": "ItAssetsPostResponsesContentApplicationJsonSchemaDataActionsStoreOwnAssetAtDeelForLocalDetailsActivationCost", "type": "object" }, "ItAssetsPostResponsesContentApplicationJsonSchemaDataActionsStoreOwnAssetAtDeelForLocalDetailsActivationCostBillingMethod": { "description": "How the action is charged. When \"TOKEN\", the fees are covered by an\nadd-on token pool; when \"CURRENCY\", the fees are billed in the currency\nspecified in the \"fees\" field.", "enum": [ "CURRENCY", "TOKEN" ], "title": "ItAssetsPostResponsesContentApplicationJsonSchemaDataActionsStoreOwnAssetAtDeelForLocalDetailsActivationCostBillingMethod", "type": "string" }, "ItAssetsPostResponsesContentApplicationJsonSchemaDataActionsStoreOwnAssetAtDeelForLocalDetailsActivationCostFees": { "description": "Price charged for the action. Null when billing method is \"TOKEN\"", "properties": { "amount": { "description": "Amount", "format": "decimal", "type": "string" }, "currency": { "$ref": "#/components/schemas/ItAssetsPostResponsesContentApplicationJsonSchemaDataActionsStoreOwnAssetAtDeelForLocalDetailsActivationCostFeesCurrency", "description": "Three-letter currency code for the price" } }, "required": [ "amount", "currency" ], "title": "ItAssetsPostResponsesContentApplicationJsonSchemaDataActionsStoreOwnAssetAtDeelForLocalDetailsActivationCostFees", "type": "object" }, "ItAssetsPostResponsesContentApplicationJsonSchemaDataActionsStoreOwnAssetAtDeelForLocalDetailsActivationCostFeesCurrency": { "description": "Three-letter currency code for the price", "enum": [ "AED", "AFN", "ALL", "AMD", "ANG", "AOA", "ARS", "AUD", "AWG", "AZN", "BAM", "BDT", "BGN", "BHD", "BIF", "BMD", "BOB", "BRL", "BSD", "BTN", "BWP", "BYN", "BZD", "CAD", "CDF", "CHF", "CLP", "CNY", "COP", "CRC", "CUC", "CVE", "CZK", "DJF", "DKK", "DOP", "DZD", "EGP", "ERN", "ETB", "EUR", "FJD", "FKP", "GBP", "GEL", "GHS", "GIP", "GMD", "GNF", "GTQ", "GYD", "HKD", "HNL", "HRK", "HTG", "HUF", "IDR", "ILS", "INR", "IQD", "IRR", "ISK", "JMD", "JOD", "JPY", "KES", "KGS", "KHR", "KMF", "KPW", "KRW", "KWD", "KYD", "KZT", "LAK", "LBP", "LKR", "LRD", "LSL", "LTL", "LYD", "MAD", "MDL", "MGA", "MKD", "MMK", "MNT", "MRU", "MUR", "MVR", "MWK", "MXN", "MYR", "MZN", "NAD", "NGN", "NIO", "NOK", "NPR", "NZD", "OMR", "PAB", "PEN", "PGK", "PHP", "PKR", "PLN", "PYG", "QAR", "RON", "RSD", "RUB", "RWF", "SAR", "SBD", "SCR", "SDG", "SEK", "SGD", "SHP", "SLL", "SOS", "SRD", "SSP", "STD", "SYP", "SZL", "THB", "TJS", "TMT", "TND", "TOP", "TRY", "TTD", "TWD", "TZS", "UAH", "UGX", "USD", "UYU", "UZS", "VEF", "VND", "VUV", "WST", "XAF", "XCD", "XOF", "XPF", "YER", "ZAR", "ZMW", "ZWD" ], "title": "ItAssetsPostResponsesContentApplicationJsonSchemaDataActionsStoreOwnAssetAtDeelForLocalDetailsActivationCostFeesCurrency", "type": "string" }, "ItAssetsPostResponsesContentApplicationJsonSchemaDataActionsStoreOwnAssetAtDeelForLocalDetailsActivationCostTokenUsage": { "description": "Add-on token consumption details. Null when billing method is \"CURRENCY\"", "properties": { "addon": { "$ref": "#/components/schemas/ItAssetsPostResponsesContentApplicationJsonSchemaDataActionsStoreOwnAssetAtDeelForLocalDetailsActivationCostTokenUsageAddon", "description": "The add-on that provides the tokens" }, "cost": { "description": "Number of tokens consumed by the action. Zero when the add-on covers the\nservice without drawing from a token pool", "format": "decimal", "type": "string" }, "tokens_left": { "description": "Number of tokens left in the pool after the action is performed. Null when\nthe add-on covers the service without a token pool", "format": "decimal", "type": [ "string", "null" ] } }, "required": [ "cost", "addon", "tokens_left" ], "title": "ItAssetsPostResponsesContentApplicationJsonSchemaDataActionsStoreOwnAssetAtDeelForLocalDetailsActivationCostTokenUsage", "type": "object" }, "ItAssetsPostResponsesContentApplicationJsonSchemaDataActionsStoreOwnAssetAtDeelForLocalDetailsActivationCostTokenUsageAddon": { "description": "The add-on that provides the tokens", "properties": { "id": { "description": "ID of the add-on", "format": "uuid", "type": "string" }, "name": { "description": "Public display name of the add-on", "type": "string" } }, "required": [ "id", "name" ], "title": "ItAssetsPostResponsesContentApplicationJsonSchemaDataActionsStoreOwnAssetAtDeelForLocalDetailsActivationCostTokenUsageAddon", "type": "object" }, "ItAssetsPostResponsesContentApplicationJsonSchemaDataActionsStoreOwnAssetAtDeelForLocalDetailsDestinationCountry": { "description": "ISO 3166-1 alpha-2 country of the Deel warehouse the asset will be shipped to", "enum": [ "AD", "AE", "AF", "AG", "AI", "AL", "AM", "AN", "AO", "AQ", "AR", "AS", "AT", "AU", "AW", "AX", "AZ", "BA", "BB", "BD", "BE", "BF", "BG", "BH", "BI", "BJ", "BL", "BM", "BN", "BO", "BQ", "BR", "BS", "BT", "BV", "BW", "BY", "BZ", "CA", "CC", "CD", "CF", "CG", "CH", "CI", "CK", "CL", "CM", "CN", "CO", "CR", "CU", "CV", "CW", "CX", "CY", "CZ", "DE", "DJ", "DK", "DM", "DO", "DZ", "EC", "EE", "EG", "EH", "ER", "ES", "ET", "FI", "FJ", "FK", "FM", "FO", "FR", "GA", "GB", "GD", "GE", "GF", "GG", "GH", "GI", "GL", "GM", "GN", "GP", "GQ", "GR", "GS", "GT", "GU", "GW", "GY", "HK", "HM", "HN", "HR", "HT", "HU", "IC", "ID", "IE", "IL", "IM", "IN", "IO", "IQ", "IR", "IS", "IT", "JE", "JM", "JO", "JP", "KE", "KG", "KH", "KI", "KM", "KN", "KP", "KR", "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", "XK", "YE", "YT", "ZA", "ZM", "ZW" ], "title": "ItAssetsPostResponsesContentApplicationJsonSchemaDataActionsStoreOwnAssetAtDeelForLocalDetailsDestinationCountry", "type": "string" }, "ItAssetsPostResponsesContentApplicationJsonSchemaDataActionsStoreOwnAssetAtDeelForLocalDetailsMonthlyFee": { "description": "Monthly storage fee charged after the grace period", "properties": { "amount": { "description": "Amount", "format": "decimal", "type": "string" }, "currency": { "$ref": "#/components/schemas/ItAssetsPostResponsesContentApplicationJsonSchemaDataActionsStoreOwnAssetAtDeelForLocalDetailsMonthlyFeeCurrency", "description": "Three-letter currency code for the price" } }, "required": [ "amount", "currency" ], "title": "ItAssetsPostResponsesContentApplicationJsonSchemaDataActionsStoreOwnAssetAtDeelForLocalDetailsMonthlyFee", "type": "object" }, "ItAssetsPostResponsesContentApplicationJsonSchemaDataActionsStoreOwnAssetAtDeelForLocalDetailsMonthlyFeeCurrency": { "description": "Three-letter currency code for the price", "enum": [ "AED", "AFN", "ALL", "AMD", "ANG", "AOA", "ARS", "AUD", "AWG", "AZN", "BAM", "BDT", "BGN", "BHD", "BIF", "BMD", "BOB", "BRL", "BSD", "BTN", "BWP", "BYN", "BZD", "CAD", "CDF", "CHF", "CLP", "CNY", "COP", "CRC", "CUC", "CVE", "CZK", "DJF", "DKK", "DOP", "DZD", "EGP", "ERN", "ETB", "EUR", "FJD", "FKP", "GBP", "GEL", "GHS", "GIP", "GMD", "GNF", "GTQ", "GYD", "HKD", "HNL", "HRK", "HTG", "HUF", "IDR", "ILS", "INR", "IQD", "IRR", "ISK", "JMD", "JOD", "JPY", "KES", "KGS", "KHR", "KMF", "KPW", "KRW", "KWD", "KYD", "KZT", "LAK", "LBP", "LKR", "LRD", "LSL", "LTL", "LYD", "MAD", "MDL", "MGA", "MKD", "MMK", "MNT", "MRU", "MUR", "MVR", "MWK", "MXN", "MYR", "MZN", "NAD", "NGN", "NIO", "NOK", "NPR", "NZD", "OMR", "PAB", "PEN", "PGK", "PHP", "PKR", "PLN", "PYG", "QAR", "RON", "RSD", "RUB", "RWF", "SAR", "SBD", "SCR", "SDG", "SEK", "SGD", "SHP", "SLL", "SOS", "SRD", "SSP", "STD", "SYP", "SZL", "THB", "TJS", "TMT", "TND", "TOP", "TRY", "TTD", "TWD", "TZS", "UAH", "UGX", "USD", "UYU", "UZS", "VEF", "VND", "VUV", "WST", "XAF", "XCD", "XOF", "XPF", "YER", "ZAR", "ZMW", "ZWD" ], "title": "ItAssetsPostResponsesContentApplicationJsonSchemaDataActionsStoreOwnAssetAtDeelForLocalDetailsMonthlyFeeCurrency", "type": "string" }, "ItAssetsPostResponsesContentApplicationJsonSchemaDataActionsStoreOwnAssetAtDeelForLocalDisabledReasonsItems": { "enum": [ "ARCHIVED", "AT_DEEL_WAREHOUSE", "BEING_REPAIRED", "CONSUMABLE", "CONTROLLED_BY_DEEL", "COUNTRY_NOT_SUPPORTED_FOR_HUB", "COUNTRY_NOT_SUPPORTED_FOR_LOCAL", "DEEL_OWNED_ITEM_WITHOUT_RENTAL_CONTRACT", "DESKTOP_STORAGE", "ENDING_CONTRACT", "HUB_IN_SAME_REGION_AS_LOCAL", "INACTIVE", "INVALID_ITEM_LOCATION", "INVALID_ORGANIZATION_STATUS", "INVALID_STATE", "ITEM_CONDITIONS_TO_UNARCHIVE_NOT_MET", "ITEM_NOT_VISIBLE_FOR_ORGANIZATION", "NON_DEVICE", "NOT_AT_WAREHOUSE", "NOT_AVAILABLE_FOR_REUSE", "NOT_A_RENTAL", "NOT_MANAGEABLE_BY_ORGANIZATION", "NOT_WITH_ASSIGNMENT", "NOT_WITH_USER", "NO_ACTIVE_ADDONS", "NO_ACTIVE_STORAGE_CONTRACT", "NO_LOCATION_FOR_STORAGE", "NO_LOGISTICS_FOR_STORAGE", "NO_VALID_ADDONS", "ONGOING_SERVICE", "OWNED_BY_DEEL", "OWNED_BY_ORGANIZATION", "OWNED_BY_PARTNER_ORGANIZATION", "PARTNER_CHILD_CONTRACT", "PENDING_DEVICE_REFRESH", "RENTAL_CONTRACT_AND_USER_REGION_DO_NOT_MATCH", "TEMPORARILY_UNAVAILABLE", "UNKNOWN", "USER_HAS_NO_COUNTRY", "USER_HAS_NO_SEAT", "WAITING_FOR_CLEARANCE", "WITH_LOANER_ASSIGNMENT", "WITH_NON_COLLECTED_ASSIGNMENT", "WITH_NON_DELIVERED_ASSIGNMENT", "WITH_PENDING_ASSIGNMENT", "WRONG_ASSIGNMENT_STATUS", "WRONG_CONTRACT_STATUS", "WRONG_TERMS_AND_CONDITIONS" ], "title": "ItAssetsPostResponsesContentApplicationJsonSchemaDataActionsStoreOwnAssetAtDeelForLocalDisabledReasonsItems", "type": "string" }, "ItAssetsPostResponsesContentApplicationJsonSchemaDataActionsStoreOwnAssetAtDeelForLocalStatus": { "description": "Whether the action is currently available for this asset", "enum": [ "DISABLED", "ENABLED", "NOT_APPLICABLE" ], "title": "ItAssetsPostResponsesContentApplicationJsonSchemaDataActionsStoreOwnAssetAtDeelForLocalStatus", "type": "string" }, "ItAssetsPostResponsesContentApplicationJsonSchemaDataActionsStoreOwnAssetAtOwnLocation": { "description": "Store an organization-owned asset at an organization-owned location", "properties": { "details": { "description": "Action-specific context needed to perform the action. Populated for enabled and\ndisabled actions (so callers can see what a successful attempt would look like);\nnull when the action is not applicable to this asset.", "oneOf": [ { "$ref": "#/components/schemas/ItAssetsPostResponsesContentApplicationJsonSchemaDataActionsStoreOwnAssetAtOwnLocationDetails" }, { "type": "null" } ] }, "disabled_reasons": { "description": "Reasons why the action is disabled. Empty when the action is enabled or not applicable", "items": { "$ref": "#/components/schemas/ItAssetsPostResponsesContentApplicationJsonSchemaDataActionsStoreOwnAssetAtOwnLocationDisabledReasonsItems" }, "type": "array" }, "status": { "$ref": "#/components/schemas/ItAssetsPostResponsesContentApplicationJsonSchemaDataActionsStoreOwnAssetAtOwnLocationStatus", "description": "Whether the action is currently available for this asset" } }, "required": [ "status", "details", "disabled_reasons" ], "title": "ItAssetsPostResponsesContentApplicationJsonSchemaDataActionsStoreOwnAssetAtOwnLocation", "type": "object" }, "ItAssetsPostResponsesContentApplicationJsonSchemaDataActionsStoreOwnAssetAtOwnLocationDetails": { "description": "Action-specific context needed to perform the action. Populated for enabled and\ndisabled actions (so callers can see what a successful attempt would look like);\nnull when the action is not applicable to this asset.", "properties": { "eligible_countries": { "description": "Countries where the asset can be stored at an organization-owned location", "items": { "$ref": "#/components/schemas/ItAssetsPostResponsesContentApplicationJsonSchemaDataActionsStoreOwnAssetAtOwnLocationDetailsEligibleCountriesItems" }, "type": "array" }, "service_cost": { "$ref": "#/components/schemas/ItAssetsPostResponsesContentApplicationJsonSchemaDataActionsStoreOwnAssetAtOwnLocationDetailsServiceCost", "description": "Cost charged for the transfer service" } }, "required": [ "service_cost", "eligible_countries" ], "title": "ItAssetsPostResponsesContentApplicationJsonSchemaDataActionsStoreOwnAssetAtOwnLocationDetails", "type": "object" }, "ItAssetsPostResponsesContentApplicationJsonSchemaDataActionsStoreOwnAssetAtOwnLocationDetailsEligibleCountriesItems": { "enum": [ "AD", "AE", "AF", "AG", "AI", "AL", "AM", "AN", "AO", "AQ", "AR", "AS", "AT", "AU", "AW", "AX", "AZ", "BA", "BB", "BD", "BE", "BF", "BG", "BH", "BI", "BJ", "BL", "BM", "BN", "BO", "BQ", "BR", "BS", "BT", "BV", "BW", "BY", "BZ", "CA", "CC", "CD", "CF", "CG", "CH", "CI", "CK", "CL", "CM", "CN", "CO", "CR", "CU", "CV", "CW", "CX", "CY", "CZ", "DE", "DJ", "DK", "DM", "DO", "DZ", "EC", "EE", "EG", "EH", "ER", "ES", "ET", "FI", "FJ", "FK", "FM", "FO", "FR", "GA", "GB", "GD", "GE", "GF", "GG", "GH", "GI", "GL", "GM", "GN", "GP", "GQ", "GR", "GS", "GT", "GU", "GW", "GY", "HK", "HM", "HN", "HR", "HT", "HU", "IC", "ID", "IE", "IL", "IM", "IN", "IO", "IQ", "IR", "IS", "IT", "JE", "JM", "JO", "JP", "KE", "KG", "KH", "KI", "KM", "KN", "KP", "KR", "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", "XK", "YE", "YT", "ZA", "ZM", "ZW" ], "title": "ItAssetsPostResponsesContentApplicationJsonSchemaDataActionsStoreOwnAssetAtOwnLocationDetailsEligibleCountriesItems", "type": "string" }, "ItAssetsPostResponsesContentApplicationJsonSchemaDataActionsStoreOwnAssetAtOwnLocationDetailsServiceCost": { "description": "Cost charged for the transfer service", "properties": { "billing_method": { "$ref": "#/components/schemas/ItAssetsPostResponsesContentApplicationJsonSchemaDataActionsStoreOwnAssetAtOwnLocationDetailsServiceCostBillingMethod", "description": "How the action is charged. When \"TOKEN\", the fees are covered by an\nadd-on token pool; when \"CURRENCY\", the fees are billed in the currency\nspecified in the \"fees\" field." }, "fees": { "description": "Price charged for the action. Null when billing method is \"TOKEN\"", "oneOf": [ { "$ref": "#/components/schemas/ItAssetsPostResponsesContentApplicationJsonSchemaDataActionsStoreOwnAssetAtOwnLocationDetailsServiceCostFees" }, { "type": "null" } ] }, "token_usage": { "description": "Add-on token consumption details. Null when billing method is \"CURRENCY\"", "oneOf": [ { "$ref": "#/components/schemas/ItAssetsPostResponsesContentApplicationJsonSchemaDataActionsStoreOwnAssetAtOwnLocationDetailsServiceCostTokenUsage" }, { "type": "null" } ] } }, "required": [ "fees", "token_usage", "billing_method" ], "title": "ItAssetsPostResponsesContentApplicationJsonSchemaDataActionsStoreOwnAssetAtOwnLocationDetailsServiceCost", "type": "object" }, "ItAssetsPostResponsesContentApplicationJsonSchemaDataActionsStoreOwnAssetAtOwnLocationDetailsServiceCostBillingMethod": { "description": "How the action is charged. When \"TOKEN\", the fees are covered by an\nadd-on token pool; when \"CURRENCY\", the fees are billed in the currency\nspecified in the \"fees\" field.", "enum": [ "CURRENCY", "TOKEN" ], "title": "ItAssetsPostResponsesContentApplicationJsonSchemaDataActionsStoreOwnAssetAtOwnLocationDetailsServiceCostBillingMethod", "type": "string" }, "ItAssetsPostResponsesContentApplicationJsonSchemaDataActionsStoreOwnAssetAtOwnLocationDetailsServiceCostFees": { "description": "Price charged for the action. Null when billing method is \"TOKEN\"", "properties": { "amount": { "description": "Amount", "format": "decimal", "type": "string" }, "currency": { "$ref": "#/components/schemas/ItAssetsPostResponsesContentApplicationJsonSchemaDataActionsStoreOwnAssetAtOwnLocationDetailsServiceCostFeesCurrency", "description": "Three-letter currency code for the price" } }, "required": [ "amount", "currency" ], "title": "ItAssetsPostResponsesContentApplicationJsonSchemaDataActionsStoreOwnAssetAtOwnLocationDetailsServiceCostFees", "type": "object" }, "ItAssetsPostResponsesContentApplicationJsonSchemaDataActionsStoreOwnAssetAtOwnLocationDetailsServiceCostFeesCurrency": { "description": "Three-letter currency code for the price", "enum": [ "AED", "AFN", "ALL", "AMD", "ANG", "AOA", "ARS", "AUD", "AWG", "AZN", "BAM", "BDT", "BGN", "BHD", "BIF", "BMD", "BOB", "BRL", "BSD", "BTN", "BWP", "BYN", "BZD", "CAD", "CDF", "CHF", "CLP", "CNY", "COP", "CRC", "CUC", "CVE", "CZK", "DJF", "DKK", "DOP", "DZD", "EGP", "ERN", "ETB", "EUR", "FJD", "FKP", "GBP", "GEL", "GHS", "GIP", "GMD", "GNF", "GTQ", "GYD", "HKD", "HNL", "HRK", "HTG", "HUF", "IDR", "ILS", "INR", "IQD", "IRR", "ISK", "JMD", "JOD", "JPY", "KES", "KGS", "KHR", "KMF", "KPW", "KRW", "KWD", "KYD", "KZT", "LAK", "LBP", "LKR", "LRD", "LSL", "LTL", "LYD", "MAD", "MDL", "MGA", "MKD", "MMK", "MNT", "MRU", "MUR", "MVR", "MWK", "MXN", "MYR", "MZN", "NAD", "NGN", "NIO", "NOK", "NPR", "NZD", "OMR", "PAB", "PEN", "PGK", "PHP", "PKR", "PLN", "PYG", "QAR", "RON", "RSD", "RUB", "RWF", "SAR", "SBD", "SCR", "SDG", "SEK", "SGD", "SHP", "SLL", "SOS", "SRD", "SSP", "STD", "SYP", "SZL", "THB", "TJS", "TMT", "TND", "TOP", "TRY", "TTD", "TWD", "TZS", "UAH", "UGX", "USD", "UYU", "UZS", "VEF", "VND", "VUV", "WST", "XAF", "XCD", "XOF", "XPF", "YER", "ZAR", "ZMW", "ZWD" ], "title": "ItAssetsPostResponsesContentApplicationJsonSchemaDataActionsStoreOwnAssetAtOwnLocationDetailsServiceCostFeesCurrency", "type": "string" }, "ItAssetsPostResponsesContentApplicationJsonSchemaDataActionsStoreOwnAssetAtOwnLocationDetailsServiceCostTokenUsage": { "description": "Add-on token consumption details. Null when billing method is \"CURRENCY\"", "properties": { "addon": { "$ref": "#/components/schemas/ItAssetsPostResponsesContentApplicationJsonSchemaDataActionsStoreOwnAssetAtOwnLocationDetailsServiceCostTokenUsageAddon", "description": "The add-on that provides the tokens" }, "cost": { "description": "Number of tokens consumed by the action. Zero when the add-on covers the\nservice without drawing from a token pool", "format": "decimal", "type": "string" }, "tokens_left": { "description": "Number of tokens left in the pool after the action is performed. Null when\nthe add-on covers the service without a token pool", "format": "decimal", "type": [ "string", "null" ] } }, "required": [ "cost", "addon", "tokens_left" ], "title": "ItAssetsPostResponsesContentApplicationJsonSchemaDataActionsStoreOwnAssetAtOwnLocationDetailsServiceCostTokenUsage", "type": "object" }, "ItAssetsPostResponsesContentApplicationJsonSchemaDataActionsStoreOwnAssetAtOwnLocationDetailsServiceCostTokenUsageAddon": { "description": "The add-on that provides the tokens", "properties": { "id": { "description": "ID of the add-on", "format": "uuid", "type": "string" }, "name": { "description": "Public display name of the add-on", "type": "string" } }, "required": [ "id", "name" ], "title": "ItAssetsPostResponsesContentApplicationJsonSchemaDataActionsStoreOwnAssetAtOwnLocationDetailsServiceCostTokenUsageAddon", "type": "object" }, "ItAssetsPostResponsesContentApplicationJsonSchemaDataActionsStoreOwnAssetAtOwnLocationDisabledReasonsItems": { "enum": [ "ARCHIVED", "AT_DEEL_WAREHOUSE", "BEING_REPAIRED", "CONSUMABLE", "CONTROLLED_BY_DEEL", "COUNTRY_NOT_SUPPORTED_FOR_HUB", "COUNTRY_NOT_SUPPORTED_FOR_LOCAL", "DEEL_OWNED_ITEM_WITHOUT_RENTAL_CONTRACT", "DESKTOP_STORAGE", "ENDING_CONTRACT", "HUB_IN_SAME_REGION_AS_LOCAL", "INACTIVE", "INVALID_ITEM_LOCATION", "INVALID_ORGANIZATION_STATUS", "INVALID_STATE", "ITEM_CONDITIONS_TO_UNARCHIVE_NOT_MET", "ITEM_NOT_VISIBLE_FOR_ORGANIZATION", "NON_DEVICE", "NOT_AT_WAREHOUSE", "NOT_AVAILABLE_FOR_REUSE", "NOT_A_RENTAL", "NOT_MANAGEABLE_BY_ORGANIZATION", "NOT_WITH_ASSIGNMENT", "NOT_WITH_USER", "NO_ACTIVE_ADDONS", "NO_ACTIVE_STORAGE_CONTRACT", "NO_LOCATION_FOR_STORAGE", "NO_LOGISTICS_FOR_STORAGE", "NO_VALID_ADDONS", "ONGOING_SERVICE", "OWNED_BY_DEEL", "OWNED_BY_ORGANIZATION", "OWNED_BY_PARTNER_ORGANIZATION", "PARTNER_CHILD_CONTRACT", "PENDING_DEVICE_REFRESH", "RENTAL_CONTRACT_AND_USER_REGION_DO_NOT_MATCH", "TEMPORARILY_UNAVAILABLE", "UNKNOWN", "USER_HAS_NO_COUNTRY", "USER_HAS_NO_SEAT", "WAITING_FOR_CLEARANCE", "WITH_LOANER_ASSIGNMENT", "WITH_NON_COLLECTED_ASSIGNMENT", "WITH_NON_DELIVERED_ASSIGNMENT", "WITH_PENDING_ASSIGNMENT", "WRONG_ASSIGNMENT_STATUS", "WRONG_CONTRACT_STATUS", "WRONG_TERMS_AND_CONDITIONS" ], "title": "ItAssetsPostResponsesContentApplicationJsonSchemaDataActionsStoreOwnAssetAtOwnLocationDisabledReasonsItems", "type": "string" }, "ItAssetsPostResponsesContentApplicationJsonSchemaDataActionsStoreOwnAssetAtOwnLocationStatus": { "description": "Whether the action is currently available for this asset", "enum": [ "DISABLED", "ENABLED", "NOT_APPLICABLE" ], "title": "ItAssetsPostResponsesContentApplicationJsonSchemaDataActionsStoreOwnAssetAtOwnLocationStatus", "type": "string" }, "ItAssetsPostResponsesContentApplicationJsonSchemaDataActionsStoreRentalAtDeelForLocal": { "description": "Store a Deel-owned rental asset at a Deel local warehouse", "properties": { "details": { "description": "Action-specific context needed to perform the action. Populated for enabled and\ndisabled actions (so callers can see what a successful attempt would look like);\nnull when the action is not applicable to this asset.", "oneOf": [ { "$ref": "#/components/schemas/ItAssetsPostResponsesContentApplicationJsonSchemaDataActionsStoreRentalAtDeelForLocalDetails" }, { "type": "null" } ] }, "disabled_reasons": { "description": "Reasons why the action is disabled. Empty when the action is enabled or not applicable", "items": { "$ref": "#/components/schemas/ItAssetsPostResponsesContentApplicationJsonSchemaDataActionsStoreRentalAtDeelForLocalDisabledReasonsItems" }, "type": "array" }, "status": { "$ref": "#/components/schemas/ItAssetsPostResponsesContentApplicationJsonSchemaDataActionsStoreRentalAtDeelForLocalStatus", "description": "Whether the action is currently available for this asset" } }, "required": [ "status", "details", "disabled_reasons" ], "title": "ItAssetsPostResponsesContentApplicationJsonSchemaDataActionsStoreRentalAtDeelForLocal", "type": "object" }, "ItAssetsPostResponsesContentApplicationJsonSchemaDataActionsStoreRentalAtDeelForLocalDetails": { "description": "Action-specific context needed to perform the action. Populated for enabled and\ndisabled actions (so callers can see what a successful attempt would look like);\nnull when the action is not applicable to this asset.", "properties": { "activation_cost": { "$ref": "#/components/schemas/ItAssetsPostResponsesContentApplicationJsonSchemaDataActionsStoreRentalAtDeelForLocalDetailsActivationCost", "description": "Cost charged to activate local storage" } }, "required": [ "activation_cost" ], "title": "ItAssetsPostResponsesContentApplicationJsonSchemaDataActionsStoreRentalAtDeelForLocalDetails", "type": "object" }, "ItAssetsPostResponsesContentApplicationJsonSchemaDataActionsStoreRentalAtDeelForLocalDetailsActivationCost": { "description": "Cost charged to activate local storage", "properties": { "billing_method": { "$ref": "#/components/schemas/ItAssetsPostResponsesContentApplicationJsonSchemaDataActionsStoreRentalAtDeelForLocalDetailsActivationCostBillingMethod", "description": "How the action is charged. When \"TOKEN\", the fees are covered by an\nadd-on token pool; when \"CURRENCY\", the fees are billed in the currency\nspecified in the \"fees\" field." }, "fees": { "description": "Price charged for the action. Null when billing method is \"TOKEN\"", "oneOf": [ { "$ref": "#/components/schemas/ItAssetsPostResponsesContentApplicationJsonSchemaDataActionsStoreRentalAtDeelForLocalDetailsActivationCostFees" }, { "type": "null" } ] }, "token_usage": { "description": "Add-on token consumption details. Null when billing method is \"CURRENCY\"", "oneOf": [ { "$ref": "#/components/schemas/ItAssetsPostResponsesContentApplicationJsonSchemaDataActionsStoreRentalAtDeelForLocalDetailsActivationCostTokenUsage" }, { "type": "null" } ] } }, "required": [ "fees", "token_usage", "billing_method" ], "title": "ItAssetsPostResponsesContentApplicationJsonSchemaDataActionsStoreRentalAtDeelForLocalDetailsActivationCost", "type": "object" }, "ItAssetsPostResponsesContentApplicationJsonSchemaDataActionsStoreRentalAtDeelForLocalDetailsActivationCostBillingMethod": { "description": "How the action is charged. When \"TOKEN\", the fees are covered by an\nadd-on token pool; when \"CURRENCY\", the fees are billed in the currency\nspecified in the \"fees\" field.", "enum": [ "CURRENCY", "TOKEN" ], "title": "ItAssetsPostResponsesContentApplicationJsonSchemaDataActionsStoreRentalAtDeelForLocalDetailsActivationCostBillingMethod", "type": "string" }, "ItAssetsPostResponsesContentApplicationJsonSchemaDataActionsStoreRentalAtDeelForLocalDetailsActivationCostFees": { "description": "Price charged for the action. Null when billing method is \"TOKEN\"", "properties": { "amount": { "description": "Amount", "format": "decimal", "type": "string" }, "currency": { "$ref": "#/components/schemas/ItAssetsPostResponsesContentApplicationJsonSchemaDataActionsStoreRentalAtDeelForLocalDetailsActivationCostFeesCurrency", "description": "Three-letter currency code for the price" } }, "required": [ "amount", "currency" ], "title": "ItAssetsPostResponsesContentApplicationJsonSchemaDataActionsStoreRentalAtDeelForLocalDetailsActivationCostFees", "type": "object" }, "ItAssetsPostResponsesContentApplicationJsonSchemaDataActionsStoreRentalAtDeelForLocalDetailsActivationCostFeesCurrency": { "description": "Three-letter currency code for the price", "enum": [ "AED", "AFN", "ALL", "AMD", "ANG", "AOA", "ARS", "AUD", "AWG", "AZN", "BAM", "BDT", "BGN", "BHD", "BIF", "BMD", "BOB", "BRL", "BSD", "BTN", "BWP", "BYN", "BZD", "CAD", "CDF", "CHF", "CLP", "CNY", "COP", "CRC", "CUC", "CVE", "CZK", "DJF", "DKK", "DOP", "DZD", "EGP", "ERN", "ETB", "EUR", "FJD", "FKP", "GBP", "GEL", "GHS", "GIP", "GMD", "GNF", "GTQ", "GYD", "HKD", "HNL", "HRK", "HTG", "HUF", "IDR", "ILS", "INR", "IQD", "IRR", "ISK", "JMD", "JOD", "JPY", "KES", "KGS", "KHR", "KMF", "KPW", "KRW", "KWD", "KYD", "KZT", "LAK", "LBP", "LKR", "LRD", "LSL", "LTL", "LYD", "MAD", "MDL", "MGA", "MKD", "MMK", "MNT", "MRU", "MUR", "MVR", "MWK", "MXN", "MYR", "MZN", "NAD", "NGN", "NIO", "NOK", "NPR", "NZD", "OMR", "PAB", "PEN", "PGK", "PHP", "PKR", "PLN", "PYG", "QAR", "RON", "RSD", "RUB", "RWF", "SAR", "SBD", "SCR", "SDG", "SEK", "SGD", "SHP", "SLL", "SOS", "SRD", "SSP", "STD", "SYP", "SZL", "THB", "TJS", "TMT", "TND", "TOP", "TRY", "TTD", "TWD", "TZS", "UAH", "UGX", "USD", "UYU", "UZS", "VEF", "VND", "VUV", "WST", "XAF", "XCD", "XOF", "XPF", "YER", "ZAR", "ZMW", "ZWD" ], "title": "ItAssetsPostResponsesContentApplicationJsonSchemaDataActionsStoreRentalAtDeelForLocalDetailsActivationCostFeesCurrency", "type": "string" }, "ItAssetsPostResponsesContentApplicationJsonSchemaDataActionsStoreRentalAtDeelForLocalDetailsActivationCostTokenUsage": { "description": "Add-on token consumption details. Null when billing method is \"CURRENCY\"", "properties": { "addon": { "$ref": "#/components/schemas/ItAssetsPostResponsesContentApplicationJsonSchemaDataActionsStoreRentalAtDeelForLocalDetailsActivationCostTokenUsageAddon", "description": "The add-on that provides the tokens" }, "cost": { "description": "Number of tokens consumed by the action. Zero when the add-on covers the\nservice without drawing from a token pool", "format": "decimal", "type": "string" }, "tokens_left": { "description": "Number of tokens left in the pool after the action is performed. Null when\nthe add-on covers the service without a token pool", "format": "decimal", "type": [ "string", "null" ] } }, "required": [ "cost", "addon", "tokens_left" ], "title": "ItAssetsPostResponsesContentApplicationJsonSchemaDataActionsStoreRentalAtDeelForLocalDetailsActivationCostTokenUsage", "type": "object" }, "ItAssetsPostResponsesContentApplicationJsonSchemaDataActionsStoreRentalAtDeelForLocalDetailsActivationCostTokenUsageAddon": { "description": "The add-on that provides the tokens", "properties": { "id": { "description": "ID of the add-on", "format": "uuid", "type": "string" }, "name": { "description": "Public display name of the add-on", "type": "string" } }, "required": [ "id", "name" ], "title": "ItAssetsPostResponsesContentApplicationJsonSchemaDataActionsStoreRentalAtDeelForLocalDetailsActivationCostTokenUsageAddon", "type": "object" }, "ItAssetsPostResponsesContentApplicationJsonSchemaDataActionsStoreRentalAtDeelForLocalDisabledReasonsItems": { "enum": [ "ARCHIVED", "AT_DEEL_WAREHOUSE", "BEING_REPAIRED", "CONSUMABLE", "CONTROLLED_BY_DEEL", "COUNTRY_NOT_SUPPORTED_FOR_HUB", "COUNTRY_NOT_SUPPORTED_FOR_LOCAL", "DEEL_OWNED_ITEM_WITHOUT_RENTAL_CONTRACT", "DESKTOP_STORAGE", "ENDING_CONTRACT", "HUB_IN_SAME_REGION_AS_LOCAL", "INACTIVE", "INVALID_ITEM_LOCATION", "INVALID_ORGANIZATION_STATUS", "INVALID_STATE", "ITEM_CONDITIONS_TO_UNARCHIVE_NOT_MET", "ITEM_NOT_VISIBLE_FOR_ORGANIZATION", "NON_DEVICE", "NOT_AT_WAREHOUSE", "NOT_AVAILABLE_FOR_REUSE", "NOT_A_RENTAL", "NOT_MANAGEABLE_BY_ORGANIZATION", "NOT_WITH_ASSIGNMENT", "NOT_WITH_USER", "NO_ACTIVE_ADDONS", "NO_ACTIVE_STORAGE_CONTRACT", "NO_LOCATION_FOR_STORAGE", "NO_LOGISTICS_FOR_STORAGE", "NO_VALID_ADDONS", "ONGOING_SERVICE", "OWNED_BY_DEEL", "OWNED_BY_ORGANIZATION", "OWNED_BY_PARTNER_ORGANIZATION", "PARTNER_CHILD_CONTRACT", "PENDING_DEVICE_REFRESH", "RENTAL_CONTRACT_AND_USER_REGION_DO_NOT_MATCH", "TEMPORARILY_UNAVAILABLE", "UNKNOWN", "USER_HAS_NO_COUNTRY", "USER_HAS_NO_SEAT", "WAITING_FOR_CLEARANCE", "WITH_LOANER_ASSIGNMENT", "WITH_NON_COLLECTED_ASSIGNMENT", "WITH_NON_DELIVERED_ASSIGNMENT", "WITH_PENDING_ASSIGNMENT", "WRONG_ASSIGNMENT_STATUS", "WRONG_CONTRACT_STATUS", "WRONG_TERMS_AND_CONDITIONS" ], "title": "ItAssetsPostResponsesContentApplicationJsonSchemaDataActionsStoreRentalAtDeelForLocalDisabledReasonsItems", "type": "string" }, "ItAssetsPostResponsesContentApplicationJsonSchemaDataActionsStoreRentalAtDeelForLocalStatus": { "description": "Whether the action is currently available for this asset", "enum": [ "DISABLED", "ENABLED", "NOT_APPLICABLE" ], "title": "ItAssetsPostResponsesContentApplicationJsonSchemaDataActionsStoreRentalAtDeelForLocalStatus", "type": "string" }, "ItAssetsPostResponsesContentApplicationJsonSchemaDataActionsStoreRentalAtDeelForZone1": { "description": "Store a Deel-owned rental asset at a Deel zone-1 warehouse", "properties": { "details": { "description": "Action-specific context needed to perform the action. Populated for enabled and\ndisabled actions (so callers can see what a successful attempt would look like);\nnull when the action is not applicable to this asset.", "oneOf": [ { "$ref": "#/components/schemas/ItAssetsPostResponsesContentApplicationJsonSchemaDataActionsStoreRentalAtDeelForZone1Details" }, { "type": "null" } ] }, "disabled_reasons": { "description": "Reasons why the action is disabled. Empty when the action is enabled or not applicable", "items": { "$ref": "#/components/schemas/ItAssetsPostResponsesContentApplicationJsonSchemaDataActionsStoreRentalAtDeelForZone1DisabledReasonsItems" }, "type": "array" }, "status": { "$ref": "#/components/schemas/ItAssetsPostResponsesContentApplicationJsonSchemaDataActionsStoreRentalAtDeelForZone1Status", "description": "Whether the action is currently available for this asset" } }, "required": [ "status", "details", "disabled_reasons" ], "title": "ItAssetsPostResponsesContentApplicationJsonSchemaDataActionsStoreRentalAtDeelForZone1", "type": "object" }, "ItAssetsPostResponsesContentApplicationJsonSchemaDataActionsStoreRentalAtDeelForZone1Details": { "description": "Action-specific context needed to perform the action. Populated for enabled and\ndisabled actions (so callers can see what a successful attempt would look like);\nnull when the action is not applicable to this asset.", "properties": { "activation_cost": { "$ref": "#/components/schemas/ItAssetsPostResponsesContentApplicationJsonSchemaDataActionsStoreRentalAtDeelForZone1DetailsActivationCost", "description": "Cost charged to activate zone-1 storage" } }, "required": [ "activation_cost" ], "title": "ItAssetsPostResponsesContentApplicationJsonSchemaDataActionsStoreRentalAtDeelForZone1Details", "type": "object" }, "ItAssetsPostResponsesContentApplicationJsonSchemaDataActionsStoreRentalAtDeelForZone1DetailsActivationCost": { "description": "Cost charged to activate zone-1 storage", "properties": { "billing_method": { "$ref": "#/components/schemas/ItAssetsPostResponsesContentApplicationJsonSchemaDataActionsStoreRentalAtDeelForZone1DetailsActivationCostBillingMethod", "description": "How the action is charged. When \"TOKEN\", the fees are covered by an\nadd-on token pool; when \"CURRENCY\", the fees are billed in the currency\nspecified in the \"fees\" field." }, "fees": { "description": "Price charged for the action. Null when billing method is \"TOKEN\"", "oneOf": [ { "$ref": "#/components/schemas/ItAssetsPostResponsesContentApplicationJsonSchemaDataActionsStoreRentalAtDeelForZone1DetailsActivationCostFees" }, { "type": "null" } ] }, "token_usage": { "description": "Add-on token consumption details. Null when billing method is \"CURRENCY\"", "oneOf": [ { "$ref": "#/components/schemas/ItAssetsPostResponsesContentApplicationJsonSchemaDataActionsStoreRentalAtDeelForZone1DetailsActivationCostTokenUsage" }, { "type": "null" } ] } }, "required": [ "fees", "token_usage", "billing_method" ], "title": "ItAssetsPostResponsesContentApplicationJsonSchemaDataActionsStoreRentalAtDeelForZone1DetailsActivationCost", "type": "object" }, "ItAssetsPostResponsesContentApplicationJsonSchemaDataActionsStoreRentalAtDeelForZone1DetailsActivationCostBillingMethod": { "description": "How the action is charged. When \"TOKEN\", the fees are covered by an\nadd-on token pool; when \"CURRENCY\", the fees are billed in the currency\nspecified in the \"fees\" field.", "enum": [ "CURRENCY", "TOKEN" ], "title": "ItAssetsPostResponsesContentApplicationJsonSchemaDataActionsStoreRentalAtDeelForZone1DetailsActivationCostBillingMethod", "type": "string" }, "ItAssetsPostResponsesContentApplicationJsonSchemaDataActionsStoreRentalAtDeelForZone1DetailsActivationCostFees": { "description": "Price charged for the action. Null when billing method is \"TOKEN\"", "properties": { "amount": { "description": "Amount", "format": "decimal", "type": "string" }, "currency": { "$ref": "#/components/schemas/ItAssetsPostResponsesContentApplicationJsonSchemaDataActionsStoreRentalAtDeelForZone1DetailsActivationCostFeesCurrency", "description": "Three-letter currency code for the price" } }, "required": [ "amount", "currency" ], "title": "ItAssetsPostResponsesContentApplicationJsonSchemaDataActionsStoreRentalAtDeelForZone1DetailsActivationCostFees", "type": "object" }, "ItAssetsPostResponsesContentApplicationJsonSchemaDataActionsStoreRentalAtDeelForZone1DetailsActivationCostFeesCurrency": { "description": "Three-letter currency code for the price", "enum": [ "AED", "AFN", "ALL", "AMD", "ANG", "AOA", "ARS", "AUD", "AWG", "AZN", "BAM", "BDT", "BGN", "BHD", "BIF", "BMD", "BOB", "BRL", "BSD", "BTN", "BWP", "BYN", "BZD", "CAD", "CDF", "CHF", "CLP", "CNY", "COP", "CRC", "CUC", "CVE", "CZK", "DJF", "DKK", "DOP", "DZD", "EGP", "ERN", "ETB", "EUR", "FJD", "FKP", "GBP", "GEL", "GHS", "GIP", "GMD", "GNF", "GTQ", "GYD", "HKD", "HNL", "HRK", "HTG", "HUF", "IDR", "ILS", "INR", "IQD", "IRR", "ISK", "JMD", "JOD", "JPY", "KES", "KGS", "KHR", "KMF", "KPW", "KRW", "KWD", "KYD", "KZT", "LAK", "LBP", "LKR", "LRD", "LSL", "LTL", "LYD", "MAD", "MDL", "MGA", "MKD", "MMK", "MNT", "MRU", "MUR", "MVR", "MWK", "MXN", "MYR", "MZN", "NAD", "NGN", "NIO", "NOK", "NPR", "NZD", "OMR", "PAB", "PEN", "PGK", "PHP", "PKR", "PLN", "PYG", "QAR", "RON", "RSD", "RUB", "RWF", "SAR", "SBD", "SCR", "SDG", "SEK", "SGD", "SHP", "SLL", "SOS", "SRD", "SSP", "STD", "SYP", "SZL", "THB", "TJS", "TMT", "TND", "TOP", "TRY", "TTD", "TWD", "TZS", "UAH", "UGX", "USD", "UYU", "UZS", "VEF", "VND", "VUV", "WST", "XAF", "XCD", "XOF", "XPF", "YER", "ZAR", "ZMW", "ZWD" ], "title": "ItAssetsPostResponsesContentApplicationJsonSchemaDataActionsStoreRentalAtDeelForZone1DetailsActivationCostFeesCurrency", "type": "string" }, "ItAssetsPostResponsesContentApplicationJsonSchemaDataActionsStoreRentalAtDeelForZone1DetailsActivationCostTokenUsage": { "description": "Add-on token consumption details. Null when billing method is \"CURRENCY\"", "properties": { "addon": { "$ref": "#/components/schemas/ItAssetsPostResponsesContentApplicationJsonSchemaDataActionsStoreRentalAtDeelForZone1DetailsActivationCostTokenUsageAddon", "description": "The add-on that provides the tokens" }, "cost": { "description": "Number of tokens consumed by the action. Zero when the add-on covers the\nservice without drawing from a token pool", "format": "decimal", "type": "string" }, "tokens_left": { "description": "Number of tokens left in the pool after the action is performed. Null when\nthe add-on covers the service without a token pool", "format": "decimal", "type": [ "string", "null" ] } }, "required": [ "cost", "addon", "tokens_left" ], "title": "ItAssetsPostResponsesContentApplicationJsonSchemaDataActionsStoreRentalAtDeelForZone1DetailsActivationCostTokenUsage", "type": "object" }, "ItAssetsPostResponsesContentApplicationJsonSchemaDataActionsStoreRentalAtDeelForZone1DetailsActivationCostTokenUsageAddon": { "description": "The add-on that provides the tokens", "properties": { "id": { "description": "ID of the add-on", "format": "uuid", "type": "string" }, "name": { "description": "Public display name of the add-on", "type": "string" } }, "required": [ "id", "name" ], "title": "ItAssetsPostResponsesContentApplicationJsonSchemaDataActionsStoreRentalAtDeelForZone1DetailsActivationCostTokenUsageAddon", "type": "object" }, "ItAssetsPostResponsesContentApplicationJsonSchemaDataActionsStoreRentalAtDeelForZone1DisabledReasonsItems": { "enum": [ "ARCHIVED", "AT_DEEL_WAREHOUSE", "BEING_REPAIRED", "CONSUMABLE", "CONTROLLED_BY_DEEL", "COUNTRY_NOT_SUPPORTED_FOR_HUB", "COUNTRY_NOT_SUPPORTED_FOR_LOCAL", "DEEL_OWNED_ITEM_WITHOUT_RENTAL_CONTRACT", "DESKTOP_STORAGE", "ENDING_CONTRACT", "HUB_IN_SAME_REGION_AS_LOCAL", "INACTIVE", "INVALID_ITEM_LOCATION", "INVALID_ORGANIZATION_STATUS", "INVALID_STATE", "ITEM_CONDITIONS_TO_UNARCHIVE_NOT_MET", "ITEM_NOT_VISIBLE_FOR_ORGANIZATION", "NON_DEVICE", "NOT_AT_WAREHOUSE", "NOT_AVAILABLE_FOR_REUSE", "NOT_A_RENTAL", "NOT_MANAGEABLE_BY_ORGANIZATION", "NOT_WITH_ASSIGNMENT", "NOT_WITH_USER", "NO_ACTIVE_ADDONS", "NO_ACTIVE_STORAGE_CONTRACT", "NO_LOCATION_FOR_STORAGE", "NO_LOGISTICS_FOR_STORAGE", "NO_VALID_ADDONS", "ONGOING_SERVICE", "OWNED_BY_DEEL", "OWNED_BY_ORGANIZATION", "OWNED_BY_PARTNER_ORGANIZATION", "PARTNER_CHILD_CONTRACT", "PENDING_DEVICE_REFRESH", "RENTAL_CONTRACT_AND_USER_REGION_DO_NOT_MATCH", "TEMPORARILY_UNAVAILABLE", "UNKNOWN", "USER_HAS_NO_COUNTRY", "USER_HAS_NO_SEAT", "WAITING_FOR_CLEARANCE", "WITH_LOANER_ASSIGNMENT", "WITH_NON_COLLECTED_ASSIGNMENT", "WITH_NON_DELIVERED_ASSIGNMENT", "WITH_PENDING_ASSIGNMENT", "WRONG_ASSIGNMENT_STATUS", "WRONG_CONTRACT_STATUS", "WRONG_TERMS_AND_CONDITIONS" ], "title": "ItAssetsPostResponsesContentApplicationJsonSchemaDataActionsStoreRentalAtDeelForZone1DisabledReasonsItems", "type": "string" }, "ItAssetsPostResponsesContentApplicationJsonSchemaDataActionsStoreRentalAtDeelForZone1Status": { "description": "Whether the action is currently available for this asset", "enum": [ "DISABLED", "ENABLED", "NOT_APPLICABLE" ], "title": "ItAssetsPostResponsesContentApplicationJsonSchemaDataActionsStoreRentalAtDeelForZone1Status", "type": "string" }, "ItAssetsPostResponsesContentApplicationJsonSchemaDataActionsTransferOwnAsset": { "description": "Transfer an organization-owned asset to another user", "properties": { "details": { "description": "Action-specific context needed to perform the action. Populated for enabled and\ndisabled actions (so callers can see what a successful attempt would look like);\nnull when the action is not applicable to this asset.", "oneOf": [ { "$ref": "#/components/schemas/ItAssetsPostResponsesContentApplicationJsonSchemaDataActionsTransferOwnAssetDetails" }, { "type": "null" } ] }, "disabled_reasons": { "description": "Reasons why the action is disabled. Empty when the action is enabled or not applicable", "items": { "$ref": "#/components/schemas/ItAssetsPostResponsesContentApplicationJsonSchemaDataActionsTransferOwnAssetDisabledReasonsItems" }, "type": "array" }, "status": { "$ref": "#/components/schemas/ItAssetsPostResponsesContentApplicationJsonSchemaDataActionsTransferOwnAssetStatus", "description": "Whether the action is currently available for this asset" } }, "required": [ "status", "details", "disabled_reasons" ], "title": "ItAssetsPostResponsesContentApplicationJsonSchemaDataActionsTransferOwnAsset", "type": "object" }, "ItAssetsPostResponsesContentApplicationJsonSchemaDataActionsTransferOwnAssetDetails": { "description": "Action-specific context needed to perform the action. Populated for enabled and\ndisabled actions (so callers can see what a successful attempt would look like);\nnull when the action is not applicable to this asset.", "properties": { "eligible_countries": { "description": "Countries the asset can be transferred to", "items": { "$ref": "#/components/schemas/ItAssetsPostResponsesContentApplicationJsonSchemaDataActionsTransferOwnAssetDetailsEligibleCountriesItems" }, "type": "array" }, "transfer_cost": { "$ref": "#/components/schemas/ItAssetsPostResponsesContentApplicationJsonSchemaDataActionsTransferOwnAssetDetailsTransferCost", "description": "Cost charged for the transfer service" } }, "required": [ "transfer_cost", "eligible_countries" ], "title": "ItAssetsPostResponsesContentApplicationJsonSchemaDataActionsTransferOwnAssetDetails", "type": "object" }, "ItAssetsPostResponsesContentApplicationJsonSchemaDataActionsTransferOwnAssetDetailsEligibleCountriesItems": { "enum": [ "AD", "AE", "AF", "AG", "AI", "AL", "AM", "AN", "AO", "AQ", "AR", "AS", "AT", "AU", "AW", "AX", "AZ", "BA", "BB", "BD", "BE", "BF", "BG", "BH", "BI", "BJ", "BL", "BM", "BN", "BO", "BQ", "BR", "BS", "BT", "BV", "BW", "BY", "BZ", "CA", "CC", "CD", "CF", "CG", "CH", "CI", "CK", "CL", "CM", "CN", "CO", "CR", "CU", "CV", "CW", "CX", "CY", "CZ", "DE", "DJ", "DK", "DM", "DO", "DZ", "EC", "EE", "EG", "EH", "ER", "ES", "ET", "FI", "FJ", "FK", "FM", "FO", "FR", "GA", "GB", "GD", "GE", "GF", "GG", "GH", "GI", "GL", "GM", "GN", "GP", "GQ", "GR", "GS", "GT", "GU", "GW", "GY", "HK", "HM", "HN", "HR", "HT", "HU", "IC", "ID", "IE", "IL", "IM", "IN", "IO", "IQ", "IR", "IS", "IT", "JE", "JM", "JO", "JP", "KE", "KG", "KH", "KI", "KM", "KN", "KP", "KR", "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", "XK", "YE", "YT", "ZA", "ZM", "ZW" ], "title": "ItAssetsPostResponsesContentApplicationJsonSchemaDataActionsTransferOwnAssetDetailsEligibleCountriesItems", "type": "string" }, "ItAssetsPostResponsesContentApplicationJsonSchemaDataActionsTransferOwnAssetDetailsTransferCost": { "description": "Cost charged for the transfer service", "properties": { "billing_method": { "$ref": "#/components/schemas/ItAssetsPostResponsesContentApplicationJsonSchemaDataActionsTransferOwnAssetDetailsTransferCostBillingMethod", "description": "How the action is charged. When \"TOKEN\", the fees are covered by an\nadd-on token pool; when \"CURRENCY\", the fees are billed in the currency\nspecified in the \"fees\" field." }, "fees": { "description": "Price charged for the action. Null when billing method is \"TOKEN\"", "oneOf": [ { "$ref": "#/components/schemas/ItAssetsPostResponsesContentApplicationJsonSchemaDataActionsTransferOwnAssetDetailsTransferCostFees" }, { "type": "null" } ] }, "token_usage": { "description": "Add-on token consumption details. Null when billing method is \"CURRENCY\"", "oneOf": [ { "$ref": "#/components/schemas/ItAssetsPostResponsesContentApplicationJsonSchemaDataActionsTransferOwnAssetDetailsTransferCostTokenUsage" }, { "type": "null" } ] } }, "required": [ "fees", "token_usage", "billing_method" ], "title": "ItAssetsPostResponsesContentApplicationJsonSchemaDataActionsTransferOwnAssetDetailsTransferCost", "type": "object" }, "ItAssetsPostResponsesContentApplicationJsonSchemaDataActionsTransferOwnAssetDetailsTransferCostBillingMethod": { "description": "How the action is charged. When \"TOKEN\", the fees are covered by an\nadd-on token pool; when \"CURRENCY\", the fees are billed in the currency\nspecified in the \"fees\" field.", "enum": [ "CURRENCY", "TOKEN" ], "title": "ItAssetsPostResponsesContentApplicationJsonSchemaDataActionsTransferOwnAssetDetailsTransferCostBillingMethod", "type": "string" }, "ItAssetsPostResponsesContentApplicationJsonSchemaDataActionsTransferOwnAssetDetailsTransferCostFees": { "description": "Price charged for the action. Null when billing method is \"TOKEN\"", "properties": { "amount": { "description": "Amount", "format": "decimal", "type": "string" }, "currency": { "$ref": "#/components/schemas/ItAssetsPostResponsesContentApplicationJsonSchemaDataActionsTransferOwnAssetDetailsTransferCostFeesCurrency", "description": "Three-letter currency code for the price" } }, "required": [ "amount", "currency" ], "title": "ItAssetsPostResponsesContentApplicationJsonSchemaDataActionsTransferOwnAssetDetailsTransferCostFees", "type": "object" }, "ItAssetsPostResponsesContentApplicationJsonSchemaDataActionsTransferOwnAssetDetailsTransferCostFeesCurrency": { "description": "Three-letter currency code for the price", "enum": [ "AED", "AFN", "ALL", "AMD", "ANG", "AOA", "ARS", "AUD", "AWG", "AZN", "BAM", "BDT", "BGN", "BHD", "BIF", "BMD", "BOB", "BRL", "BSD", "BTN", "BWP", "BYN", "BZD", "CAD", "CDF", "CHF", "CLP", "CNY", "COP", "CRC", "CUC", "CVE", "CZK", "DJF", "DKK", "DOP", "DZD", "EGP", "ERN", "ETB", "EUR", "FJD", "FKP", "GBP", "GEL", "GHS", "GIP", "GMD", "GNF", "GTQ", "GYD", "HKD", "HNL", "HRK", "HTG", "HUF", "IDR", "ILS", "INR", "IQD", "IRR", "ISK", "JMD", "JOD", "JPY", "KES", "KGS", "KHR", "KMF", "KPW", "KRW", "KWD", "KYD", "KZT", "LAK", "LBP", "LKR", "LRD", "LSL", "LTL", "LYD", "MAD", "MDL", "MGA", "MKD", "MMK", "MNT", "MRU", "MUR", "MVR", "MWK", "MXN", "MYR", "MZN", "NAD", "NGN", "NIO", "NOK", "NPR", "NZD", "OMR", "PAB", "PEN", "PGK", "PHP", "PKR", "PLN", "PYG", "QAR", "RON", "RSD", "RUB", "RWF", "SAR", "SBD", "SCR", "SDG", "SEK", "SGD", "SHP", "SLL", "SOS", "SRD", "SSP", "STD", "SYP", "SZL", "THB", "TJS", "TMT", "TND", "TOP", "TRY", "TTD", "TWD", "TZS", "UAH", "UGX", "USD", "UYU", "UZS", "VEF", "VND", "VUV", "WST", "XAF", "XCD", "XOF", "XPF", "YER", "ZAR", "ZMW", "ZWD" ], "title": "ItAssetsPostResponsesContentApplicationJsonSchemaDataActionsTransferOwnAssetDetailsTransferCostFeesCurrency", "type": "string" }, "ItAssetsPostResponsesContentApplicationJsonSchemaDataActionsTransferOwnAssetDetailsTransferCostTokenUsage": { "description": "Add-on token consumption details. Null when billing method is \"CURRENCY\"", "properties": { "addon": { "$ref": "#/components/schemas/ItAssetsPostResponsesContentApplicationJsonSchemaDataActionsTransferOwnAssetDetailsTransferCostTokenUsageAddon", "description": "The add-on that provides the tokens" }, "cost": { "description": "Number of tokens consumed by the action. Zero when the add-on covers the\nservice without drawing from a token pool", "format": "decimal", "type": "string" }, "tokens_left": { "description": "Number of tokens left in the pool after the action is performed. Null when\nthe add-on covers the service without a token pool", "format": "decimal", "type": [ "string", "null" ] } }, "required": [ "cost", "addon", "tokens_left" ], "title": "ItAssetsPostResponsesContentApplicationJsonSchemaDataActionsTransferOwnAssetDetailsTransferCostTokenUsage", "type": "object" }, "ItAssetsPostResponsesContentApplicationJsonSchemaDataActionsTransferOwnAssetDetailsTransferCostTokenUsageAddon": { "description": "The add-on that provides the tokens", "properties": { "id": { "description": "ID of the add-on", "format": "uuid", "type": "string" }, "name": { "description": "Public display name of the add-on", "type": "string" } }, "required": [ "id", "name" ], "title": "ItAssetsPostResponsesContentApplicationJsonSchemaDataActionsTransferOwnAssetDetailsTransferCostTokenUsageAddon", "type": "object" }, "ItAssetsPostResponsesContentApplicationJsonSchemaDataActionsTransferOwnAssetDisabledReasonsItems": { "enum": [ "ARCHIVED", "AT_DEEL_WAREHOUSE", "BEING_REPAIRED", "CONSUMABLE", "CONTROLLED_BY_DEEL", "COUNTRY_NOT_SUPPORTED_FOR_HUB", "COUNTRY_NOT_SUPPORTED_FOR_LOCAL", "DEEL_OWNED_ITEM_WITHOUT_RENTAL_CONTRACT", "DESKTOP_STORAGE", "ENDING_CONTRACT", "HUB_IN_SAME_REGION_AS_LOCAL", "INACTIVE", "INVALID_ITEM_LOCATION", "INVALID_ORGANIZATION_STATUS", "INVALID_STATE", "ITEM_CONDITIONS_TO_UNARCHIVE_NOT_MET", "ITEM_NOT_VISIBLE_FOR_ORGANIZATION", "NON_DEVICE", "NOT_AT_WAREHOUSE", "NOT_AVAILABLE_FOR_REUSE", "NOT_A_RENTAL", "NOT_MANAGEABLE_BY_ORGANIZATION", "NOT_WITH_ASSIGNMENT", "NOT_WITH_USER", "NO_ACTIVE_ADDONS", "NO_ACTIVE_STORAGE_CONTRACT", "NO_LOCATION_FOR_STORAGE", "NO_LOGISTICS_FOR_STORAGE", "NO_VALID_ADDONS", "ONGOING_SERVICE", "OWNED_BY_DEEL", "OWNED_BY_ORGANIZATION", "OWNED_BY_PARTNER_ORGANIZATION", "PARTNER_CHILD_CONTRACT", "PENDING_DEVICE_REFRESH", "RENTAL_CONTRACT_AND_USER_REGION_DO_NOT_MATCH", "TEMPORARILY_UNAVAILABLE", "UNKNOWN", "USER_HAS_NO_COUNTRY", "USER_HAS_NO_SEAT", "WAITING_FOR_CLEARANCE", "WITH_LOANER_ASSIGNMENT", "WITH_NON_COLLECTED_ASSIGNMENT", "WITH_NON_DELIVERED_ASSIGNMENT", "WITH_PENDING_ASSIGNMENT", "WRONG_ASSIGNMENT_STATUS", "WRONG_CONTRACT_STATUS", "WRONG_TERMS_AND_CONDITIONS" ], "title": "ItAssetsPostResponsesContentApplicationJsonSchemaDataActionsTransferOwnAssetDisabledReasonsItems", "type": "string" }, "ItAssetsPostResponsesContentApplicationJsonSchemaDataActionsTransferOwnAssetStatus": { "description": "Whether the action is currently available for this asset", "enum": [ "DISABLED", "ENABLED", "NOT_APPLICABLE" ], "title": "ItAssetsPostResponsesContentApplicationJsonSchemaDataActionsTransferOwnAssetStatus", "type": "string" }, "ItAssetsPostResponsesContentApplicationJsonSchemaDataActionsTransferRental": { "description": "Transfer a Deel-owned rental asset to another user", "properties": { "details": { "description": "Action-specific context needed to perform the action. Populated for enabled and\ndisabled actions (so callers can see what a successful attempt would look like);\nnull when the action is not applicable to this asset.", "oneOf": [ { "$ref": "#/components/schemas/ItAssetsPostResponsesContentApplicationJsonSchemaDataActionsTransferRentalDetails" }, { "type": "null" } ] }, "disabled_reasons": { "description": "Reasons why the action is disabled. Empty when the action is enabled or not applicable", "items": { "$ref": "#/components/schemas/ItAssetsPostResponsesContentApplicationJsonSchemaDataActionsTransferRentalDisabledReasonsItems" }, "type": "array" }, "status": { "$ref": "#/components/schemas/ItAssetsPostResponsesContentApplicationJsonSchemaDataActionsTransferRentalStatus", "description": "Whether the action is currently available for this asset" } }, "required": [ "status", "details", "disabled_reasons" ], "title": "ItAssetsPostResponsesContentApplicationJsonSchemaDataActionsTransferRental", "type": "object" }, "ItAssetsPostResponsesContentApplicationJsonSchemaDataActionsTransferRentalDetails": { "description": "Action-specific context needed to perform the action. Populated for enabled and\ndisabled actions (so callers can see what a successful attempt would look like);\nnull when the action is not applicable to this asset.", "properties": { "eligible_countries": { "description": "Countries the asset can be transferred to", "items": { "$ref": "#/components/schemas/ItAssetsPostResponsesContentApplicationJsonSchemaDataActionsTransferRentalDetailsEligibleCountriesItems" }, "type": "array" }, "transfer_cost": { "$ref": "#/components/schemas/ItAssetsPostResponsesContentApplicationJsonSchemaDataActionsTransferRentalDetailsTransferCost", "description": "Cost charged for the transfer service" } }, "required": [ "transfer_cost", "eligible_countries" ], "title": "ItAssetsPostResponsesContentApplicationJsonSchemaDataActionsTransferRentalDetails", "type": "object" }, "ItAssetsPostResponsesContentApplicationJsonSchemaDataActionsTransferRentalDetailsEligibleCountriesItems": { "enum": [ "AD", "AE", "AF", "AG", "AI", "AL", "AM", "AN", "AO", "AQ", "AR", "AS", "AT", "AU", "AW", "AX", "AZ", "BA", "BB", "BD", "BE", "BF", "BG", "BH", "BI", "BJ", "BL", "BM", "BN", "BO", "BQ", "BR", "BS", "BT", "BV", "BW", "BY", "BZ", "CA", "CC", "CD", "CF", "CG", "CH", "CI", "CK", "CL", "CM", "CN", "CO", "CR", "CU", "CV", "CW", "CX", "CY", "CZ", "DE", "DJ", "DK", "DM", "DO", "DZ", "EC", "EE", "EG", "EH", "ER", "ES", "ET", "FI", "FJ", "FK", "FM", "FO", "FR", "GA", "GB", "GD", "GE", "GF", "GG", "GH", "GI", "GL", "GM", "GN", "GP", "GQ", "GR", "GS", "GT", "GU", "GW", "GY", "HK", "HM", "HN", "HR", "HT", "HU", "IC", "ID", "IE", "IL", "IM", "IN", "IO", "IQ", "IR", "IS", "IT", "JE", "JM", "JO", "JP", "KE", "KG", "KH", "KI", "KM", "KN", "KP", "KR", "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", "XK", "YE", "YT", "ZA", "ZM", "ZW" ], "title": "ItAssetsPostResponsesContentApplicationJsonSchemaDataActionsTransferRentalDetailsEligibleCountriesItems", "type": "string" }, "ItAssetsPostResponsesContentApplicationJsonSchemaDataActionsTransferRentalDetailsTransferCost": { "description": "Cost charged for the transfer service", "properties": { "billing_method": { "$ref": "#/components/schemas/ItAssetsPostResponsesContentApplicationJsonSchemaDataActionsTransferRentalDetailsTransferCostBillingMethod", "description": "How the action is charged. When \"TOKEN\", the fees are covered by an\nadd-on token pool; when \"CURRENCY\", the fees are billed in the currency\nspecified in the \"fees\" field." }, "fees": { "description": "Price charged for the action. Null when billing method is \"TOKEN\"", "oneOf": [ { "$ref": "#/components/schemas/ItAssetsPostResponsesContentApplicationJsonSchemaDataActionsTransferRentalDetailsTransferCostFees" }, { "type": "null" } ] }, "token_usage": { "description": "Add-on token consumption details. Null when billing method is \"CURRENCY\"", "oneOf": [ { "$ref": "#/components/schemas/ItAssetsPostResponsesContentApplicationJsonSchemaDataActionsTransferRentalDetailsTransferCostTokenUsage" }, { "type": "null" } ] } }, "required": [ "fees", "token_usage", "billing_method" ], "title": "ItAssetsPostResponsesContentApplicationJsonSchemaDataActionsTransferRentalDetailsTransferCost", "type": "object" }, "ItAssetsPostResponsesContentApplicationJsonSchemaDataActionsTransferRentalDetailsTransferCostBillingMethod": { "description": "How the action is charged. When \"TOKEN\", the fees are covered by an\nadd-on token pool; when \"CURRENCY\", the fees are billed in the currency\nspecified in the \"fees\" field.", "enum": [ "CURRENCY", "TOKEN" ], "title": "ItAssetsPostResponsesContentApplicationJsonSchemaDataActionsTransferRentalDetailsTransferCostBillingMethod", "type": "string" }, "ItAssetsPostResponsesContentApplicationJsonSchemaDataActionsTransferRentalDetailsTransferCostFees": { "description": "Price charged for the action. Null when billing method is \"TOKEN\"", "properties": { "amount": { "description": "Amount", "format": "decimal", "type": "string" }, "currency": { "$ref": "#/components/schemas/ItAssetsPostResponsesContentApplicationJsonSchemaDataActionsTransferRentalDetailsTransferCostFeesCurrency", "description": "Three-letter currency code for the price" } }, "required": [ "amount", "currency" ], "title": "ItAssetsPostResponsesContentApplicationJsonSchemaDataActionsTransferRentalDetailsTransferCostFees", "type": "object" }, "ItAssetsPostResponsesContentApplicationJsonSchemaDataActionsTransferRentalDetailsTransferCostFeesCurrency": { "description": "Three-letter currency code for the price", "enum": [ "AED", "AFN", "ALL", "AMD", "ANG", "AOA", "ARS", "AUD", "AWG", "AZN", "BAM", "BDT", "BGN", "BHD", "BIF", "BMD", "BOB", "BRL", "BSD", "BTN", "BWP", "BYN", "BZD", "CAD", "CDF", "CHF", "CLP", "CNY", "COP", "CRC", "CUC", "CVE", "CZK", "DJF", "DKK", "DOP", "DZD", "EGP", "ERN", "ETB", "EUR", "FJD", "FKP", "GBP", "GEL", "GHS", "GIP", "GMD", "GNF", "GTQ", "GYD", "HKD", "HNL", "HRK", "HTG", "HUF", "IDR", "ILS", "INR", "IQD", "IRR", "ISK", "JMD", "JOD", "JPY", "KES", "KGS", "KHR", "KMF", "KPW", "KRW", "KWD", "KYD", "KZT", "LAK", "LBP", "LKR", "LRD", "LSL", "LTL", "LYD", "MAD", "MDL", "MGA", "MKD", "MMK", "MNT", "MRU", "MUR", "MVR", "MWK", "MXN", "MYR", "MZN", "NAD", "NGN", "NIO", "NOK", "NPR", "NZD", "OMR", "PAB", "PEN", "PGK", "PHP", "PKR", "PLN", "PYG", "QAR", "RON", "RSD", "RUB", "RWF", "SAR", "SBD", "SCR", "SDG", "SEK", "SGD", "SHP", "SLL", "SOS", "SRD", "SSP", "STD", "SYP", "SZL", "THB", "TJS", "TMT", "TND", "TOP", "TRY", "TTD", "TWD", "TZS", "UAH", "UGX", "USD", "UYU", "UZS", "VEF", "VND", "VUV", "WST", "XAF", "XCD", "XOF", "XPF", "YER", "ZAR", "ZMW", "ZWD" ], "title": "ItAssetsPostResponsesContentApplicationJsonSchemaDataActionsTransferRentalDetailsTransferCostFeesCurrency", "type": "string" }, "ItAssetsPostResponsesContentApplicationJsonSchemaDataActionsTransferRentalDetailsTransferCostTokenUsage": { "description": "Add-on token consumption details. Null when billing method is \"CURRENCY\"", "properties": { "addon": { "$ref": "#/components/schemas/ItAssetsPostResponsesContentApplicationJsonSchemaDataActionsTransferRentalDetailsTransferCostTokenUsageAddon", "description": "The add-on that provides the tokens" }, "cost": { "description": "Number of tokens consumed by the action. Zero when the add-on covers the\nservice without drawing from a token pool", "format": "decimal", "type": "string" }, "tokens_left": { "description": "Number of tokens left in the pool after the action is performed. Null when\nthe add-on covers the service without a token pool", "format": "decimal", "type": [ "string", "null" ] } }, "required": [ "cost", "addon", "tokens_left" ], "title": "ItAssetsPostResponsesContentApplicationJsonSchemaDataActionsTransferRentalDetailsTransferCostTokenUsage", "type": "object" }, "ItAssetsPostResponsesContentApplicationJsonSchemaDataActionsTransferRentalDetailsTransferCostTokenUsageAddon": { "description": "The add-on that provides the tokens", "properties": { "id": { "description": "ID of the add-on", "format": "uuid", "type": "string" }, "name": { "description": "Public display name of the add-on", "type": "string" } }, "required": [ "id", "name" ], "title": "ItAssetsPostResponsesContentApplicationJsonSchemaDataActionsTransferRentalDetailsTransferCostTokenUsageAddon", "type": "object" }, "ItAssetsPostResponsesContentApplicationJsonSchemaDataActionsTransferRentalDisabledReasonsItems": { "enum": [ "ARCHIVED", "AT_DEEL_WAREHOUSE", "BEING_REPAIRED", "CONSUMABLE", "CONTROLLED_BY_DEEL", "COUNTRY_NOT_SUPPORTED_FOR_HUB", "COUNTRY_NOT_SUPPORTED_FOR_LOCAL", "DEEL_OWNED_ITEM_WITHOUT_RENTAL_CONTRACT", "DESKTOP_STORAGE", "ENDING_CONTRACT", "HUB_IN_SAME_REGION_AS_LOCAL", "INACTIVE", "INVALID_ITEM_LOCATION", "INVALID_ORGANIZATION_STATUS", "INVALID_STATE", "ITEM_CONDITIONS_TO_UNARCHIVE_NOT_MET", "ITEM_NOT_VISIBLE_FOR_ORGANIZATION", "NON_DEVICE", "NOT_AT_WAREHOUSE", "NOT_AVAILABLE_FOR_REUSE", "NOT_A_RENTAL", "NOT_MANAGEABLE_BY_ORGANIZATION", "NOT_WITH_ASSIGNMENT", "NOT_WITH_USER", "NO_ACTIVE_ADDONS", "NO_ACTIVE_STORAGE_CONTRACT", "NO_LOCATION_FOR_STORAGE", "NO_LOGISTICS_FOR_STORAGE", "NO_VALID_ADDONS", "ONGOING_SERVICE", "OWNED_BY_DEEL", "OWNED_BY_ORGANIZATION", "OWNED_BY_PARTNER_ORGANIZATION", "PARTNER_CHILD_CONTRACT", "PENDING_DEVICE_REFRESH", "RENTAL_CONTRACT_AND_USER_REGION_DO_NOT_MATCH", "TEMPORARILY_UNAVAILABLE", "UNKNOWN", "USER_HAS_NO_COUNTRY", "USER_HAS_NO_SEAT", "WAITING_FOR_CLEARANCE", "WITH_LOANER_ASSIGNMENT", "WITH_NON_COLLECTED_ASSIGNMENT", "WITH_NON_DELIVERED_ASSIGNMENT", "WITH_PENDING_ASSIGNMENT", "WRONG_ASSIGNMENT_STATUS", "WRONG_CONTRACT_STATUS", "WRONG_TERMS_AND_CONDITIONS" ], "title": "ItAssetsPostResponsesContentApplicationJsonSchemaDataActionsTransferRentalDisabledReasonsItems", "type": "string" }, "ItAssetsPostResponsesContentApplicationJsonSchemaDataActionsTransferRentalStatus": { "description": "Whether the action is currently available for this asset", "enum": [ "DISABLED", "ENABLED", "NOT_APPLICABLE" ], "title": "ItAssetsPostResponsesContentApplicationJsonSchemaDataActionsTransferRentalStatus", "type": "string" }, "ItAssetsPostResponsesContentApplicationJsonSchemaDataActionsUnarchiveOwnAsset": { "description": "Unarchive a previously archived organization-owned asset", "properties": { "disabled_reasons": { "description": "Reasons why the action is disabled. Empty when the action is enabled or not applicable", "items": { "$ref": "#/components/schemas/ItAssetsPostResponsesContentApplicationJsonSchemaDataActionsUnarchiveOwnAssetDisabledReasonsItems" }, "type": "array" }, "status": { "$ref": "#/components/schemas/ItAssetsPostResponsesContentApplicationJsonSchemaDataActionsUnarchiveOwnAssetStatus", "description": "Whether the action is currently available for this asset" } }, "required": [ "status", "disabled_reasons" ], "title": "ItAssetsPostResponsesContentApplicationJsonSchemaDataActionsUnarchiveOwnAsset", "type": "object" }, "ItAssetsPostResponsesContentApplicationJsonSchemaDataActionsUnarchiveOwnAssetDisabledReasonsItems": { "enum": [ "ARCHIVED", "AT_DEEL_WAREHOUSE", "BEING_REPAIRED", "CONSUMABLE", "CONTROLLED_BY_DEEL", "COUNTRY_NOT_SUPPORTED_FOR_HUB", "COUNTRY_NOT_SUPPORTED_FOR_LOCAL", "DEEL_OWNED_ITEM_WITHOUT_RENTAL_CONTRACT", "DESKTOP_STORAGE", "ENDING_CONTRACT", "HUB_IN_SAME_REGION_AS_LOCAL", "INACTIVE", "INVALID_ITEM_LOCATION", "INVALID_ORGANIZATION_STATUS", "INVALID_STATE", "ITEM_CONDITIONS_TO_UNARCHIVE_NOT_MET", "ITEM_NOT_VISIBLE_FOR_ORGANIZATION", "NON_DEVICE", "NOT_AT_WAREHOUSE", "NOT_AVAILABLE_FOR_REUSE", "NOT_A_RENTAL", "NOT_MANAGEABLE_BY_ORGANIZATION", "NOT_WITH_ASSIGNMENT", "NOT_WITH_USER", "NO_ACTIVE_ADDONS", "NO_ACTIVE_STORAGE_CONTRACT", "NO_LOCATION_FOR_STORAGE", "NO_LOGISTICS_FOR_STORAGE", "NO_VALID_ADDONS", "ONGOING_SERVICE", "OWNED_BY_DEEL", "OWNED_BY_ORGANIZATION", "OWNED_BY_PARTNER_ORGANIZATION", "PARTNER_CHILD_CONTRACT", "PENDING_DEVICE_REFRESH", "RENTAL_CONTRACT_AND_USER_REGION_DO_NOT_MATCH", "TEMPORARILY_UNAVAILABLE", "UNKNOWN", "USER_HAS_NO_COUNTRY", "USER_HAS_NO_SEAT", "WAITING_FOR_CLEARANCE", "WITH_LOANER_ASSIGNMENT", "WITH_NON_COLLECTED_ASSIGNMENT", "WITH_NON_DELIVERED_ASSIGNMENT", "WITH_PENDING_ASSIGNMENT", "WRONG_ASSIGNMENT_STATUS", "WRONG_CONTRACT_STATUS", "WRONG_TERMS_AND_CONDITIONS" ], "title": "ItAssetsPostResponsesContentApplicationJsonSchemaDataActionsUnarchiveOwnAssetDisabledReasonsItems", "type": "string" }, "ItAssetsPostResponsesContentApplicationJsonSchemaDataActionsUnarchiveOwnAssetStatus": { "description": "Whether the action is currently available for this asset", "enum": [ "DISABLED", "ENABLED", "NOT_APPLICABLE" ], "title": "ItAssetsPostResponsesContentApplicationJsonSchemaDataActionsUnarchiveOwnAssetStatus", "type": "string" }, "ItAssetsPostResponsesContentApplicationJsonSchemaDataActionsUpdateLocationLocationToUser": { "description": "Update the location of an asset from a warehouse to a user", "properties": { "disabled_reasons": { "description": "Reasons why the action is disabled. Empty when the action is enabled or not applicable", "items": { "$ref": "#/components/schemas/ItAssetsPostResponsesContentApplicationJsonSchemaDataActionsUpdateLocationLocationToUserDisabledReasonsItems" }, "type": "array" }, "status": { "$ref": "#/components/schemas/ItAssetsPostResponsesContentApplicationJsonSchemaDataActionsUpdateLocationLocationToUserStatus", "description": "Whether the action is currently available for this asset" } }, "required": [ "status", "disabled_reasons" ], "title": "ItAssetsPostResponsesContentApplicationJsonSchemaDataActionsUpdateLocationLocationToUser", "type": "object" }, "ItAssetsPostResponsesContentApplicationJsonSchemaDataActionsUpdateLocationLocationToUserDisabledReasonsItems": { "enum": [ "ARCHIVED", "AT_DEEL_WAREHOUSE", "BEING_REPAIRED", "CONSUMABLE", "CONTROLLED_BY_DEEL", "COUNTRY_NOT_SUPPORTED_FOR_HUB", "COUNTRY_NOT_SUPPORTED_FOR_LOCAL", "DEEL_OWNED_ITEM_WITHOUT_RENTAL_CONTRACT", "DESKTOP_STORAGE", "ENDING_CONTRACT", "HUB_IN_SAME_REGION_AS_LOCAL", "INACTIVE", "INVALID_ITEM_LOCATION", "INVALID_ORGANIZATION_STATUS", "INVALID_STATE", "ITEM_CONDITIONS_TO_UNARCHIVE_NOT_MET", "ITEM_NOT_VISIBLE_FOR_ORGANIZATION", "NON_DEVICE", "NOT_AT_WAREHOUSE", "NOT_AVAILABLE_FOR_REUSE", "NOT_A_RENTAL", "NOT_MANAGEABLE_BY_ORGANIZATION", "NOT_WITH_ASSIGNMENT", "NOT_WITH_USER", "NO_ACTIVE_ADDONS", "NO_ACTIVE_STORAGE_CONTRACT", "NO_LOCATION_FOR_STORAGE", "NO_LOGISTICS_FOR_STORAGE", "NO_VALID_ADDONS", "ONGOING_SERVICE", "OWNED_BY_DEEL", "OWNED_BY_ORGANIZATION", "OWNED_BY_PARTNER_ORGANIZATION", "PARTNER_CHILD_CONTRACT", "PENDING_DEVICE_REFRESH", "RENTAL_CONTRACT_AND_USER_REGION_DO_NOT_MATCH", "TEMPORARILY_UNAVAILABLE", "UNKNOWN", "USER_HAS_NO_COUNTRY", "USER_HAS_NO_SEAT", "WAITING_FOR_CLEARANCE", "WITH_LOANER_ASSIGNMENT", "WITH_NON_COLLECTED_ASSIGNMENT", "WITH_NON_DELIVERED_ASSIGNMENT", "WITH_PENDING_ASSIGNMENT", "WRONG_ASSIGNMENT_STATUS", "WRONG_CONTRACT_STATUS", "WRONG_TERMS_AND_CONDITIONS" ], "title": "ItAssetsPostResponsesContentApplicationJsonSchemaDataActionsUpdateLocationLocationToUserDisabledReasonsItems", "type": "string" }, "ItAssetsPostResponsesContentApplicationJsonSchemaDataActionsUpdateLocationLocationToUserStatus": { "description": "Whether the action is currently available for this asset", "enum": [ "DISABLED", "ENABLED", "NOT_APPLICABLE" ], "title": "ItAssetsPostResponsesContentApplicationJsonSchemaDataActionsUpdateLocationLocationToUserStatus", "type": "string" }, "ItAssetsPostResponsesContentApplicationJsonSchemaDataActionsUpdateLocationUserToLocation": { "description": "Update the location of an asset from a user to a warehouse", "properties": { "disabled_reasons": { "description": "Reasons why the action is disabled. Empty when the action is enabled or not applicable", "items": { "$ref": "#/components/schemas/ItAssetsPostResponsesContentApplicationJsonSchemaDataActionsUpdateLocationUserToLocationDisabledReasonsItems" }, "type": "array" }, "status": { "$ref": "#/components/schemas/ItAssetsPostResponsesContentApplicationJsonSchemaDataActionsUpdateLocationUserToLocationStatus", "description": "Whether the action is currently available for this asset" } }, "required": [ "status", "disabled_reasons" ], "title": "ItAssetsPostResponsesContentApplicationJsonSchemaDataActionsUpdateLocationUserToLocation", "type": "object" }, "ItAssetsPostResponsesContentApplicationJsonSchemaDataActionsUpdateLocationUserToLocationDisabledReasonsItems": { "enum": [ "ARCHIVED", "AT_DEEL_WAREHOUSE", "BEING_REPAIRED", "CONSUMABLE", "CONTROLLED_BY_DEEL", "COUNTRY_NOT_SUPPORTED_FOR_HUB", "COUNTRY_NOT_SUPPORTED_FOR_LOCAL", "DEEL_OWNED_ITEM_WITHOUT_RENTAL_CONTRACT", "DESKTOP_STORAGE", "ENDING_CONTRACT", "HUB_IN_SAME_REGION_AS_LOCAL", "INACTIVE", "INVALID_ITEM_LOCATION", "INVALID_ORGANIZATION_STATUS", "INVALID_STATE", "ITEM_CONDITIONS_TO_UNARCHIVE_NOT_MET", "ITEM_NOT_VISIBLE_FOR_ORGANIZATION", "NON_DEVICE", "NOT_AT_WAREHOUSE", "NOT_AVAILABLE_FOR_REUSE", "NOT_A_RENTAL", "NOT_MANAGEABLE_BY_ORGANIZATION", "NOT_WITH_ASSIGNMENT", "NOT_WITH_USER", "NO_ACTIVE_ADDONS", "NO_ACTIVE_STORAGE_CONTRACT", "NO_LOCATION_FOR_STORAGE", "NO_LOGISTICS_FOR_STORAGE", "NO_VALID_ADDONS", "ONGOING_SERVICE", "OWNED_BY_DEEL", "OWNED_BY_ORGANIZATION", "OWNED_BY_PARTNER_ORGANIZATION", "PARTNER_CHILD_CONTRACT", "PENDING_DEVICE_REFRESH", "RENTAL_CONTRACT_AND_USER_REGION_DO_NOT_MATCH", "TEMPORARILY_UNAVAILABLE", "UNKNOWN", "USER_HAS_NO_COUNTRY", "USER_HAS_NO_SEAT", "WAITING_FOR_CLEARANCE", "WITH_LOANER_ASSIGNMENT", "WITH_NON_COLLECTED_ASSIGNMENT", "WITH_NON_DELIVERED_ASSIGNMENT", "WITH_PENDING_ASSIGNMENT", "WRONG_ASSIGNMENT_STATUS", "WRONG_CONTRACT_STATUS", "WRONG_TERMS_AND_CONDITIONS" ], "title": "ItAssetsPostResponsesContentApplicationJsonSchemaDataActionsUpdateLocationUserToLocationDisabledReasonsItems", "type": "string" }, "ItAssetsPostResponsesContentApplicationJsonSchemaDataActionsUpdateLocationUserToLocationStatus": { "description": "Whether the action is currently available for this asset", "enum": [ "DISABLED", "ENABLED", "NOT_APPLICABLE" ], "title": "ItAssetsPostResponsesContentApplicationJsonSchemaDataActionsUpdateLocationUserToLocationStatus", "type": "string" }, "ItAssetsPostResponsesContentApplicationJsonSchemaDataActionsUpdateLocationUserToUser": { "description": "Update the assigned user of an asset that is currently with a user", "properties": { "disabled_reasons": { "description": "Reasons why the action is disabled. Empty when the action is enabled or not applicable", "items": { "$ref": "#/components/schemas/ItAssetsPostResponsesContentApplicationJsonSchemaDataActionsUpdateLocationUserToUserDisabledReasonsItems" }, "type": "array" }, "status": { "$ref": "#/components/schemas/ItAssetsPostResponsesContentApplicationJsonSchemaDataActionsUpdateLocationUserToUserStatus", "description": "Whether the action is currently available for this asset" } }, "required": [ "status", "disabled_reasons" ], "title": "ItAssetsPostResponsesContentApplicationJsonSchemaDataActionsUpdateLocationUserToUser", "type": "object" }, "ItAssetsPostResponsesContentApplicationJsonSchemaDataActionsUpdateLocationUserToUserDisabledReasonsItems": { "enum": [ "ARCHIVED", "AT_DEEL_WAREHOUSE", "BEING_REPAIRED", "CONSUMABLE", "CONTROLLED_BY_DEEL", "COUNTRY_NOT_SUPPORTED_FOR_HUB", "COUNTRY_NOT_SUPPORTED_FOR_LOCAL", "DEEL_OWNED_ITEM_WITHOUT_RENTAL_CONTRACT", "DESKTOP_STORAGE", "ENDING_CONTRACT", "HUB_IN_SAME_REGION_AS_LOCAL", "INACTIVE", "INVALID_ITEM_LOCATION", "INVALID_ORGANIZATION_STATUS", "INVALID_STATE", "ITEM_CONDITIONS_TO_UNARCHIVE_NOT_MET", "ITEM_NOT_VISIBLE_FOR_ORGANIZATION", "NON_DEVICE", "NOT_AT_WAREHOUSE", "NOT_AVAILABLE_FOR_REUSE", "NOT_A_RENTAL", "NOT_MANAGEABLE_BY_ORGANIZATION", "NOT_WITH_ASSIGNMENT", "NOT_WITH_USER", "NO_ACTIVE_ADDONS", "NO_ACTIVE_STORAGE_CONTRACT", "NO_LOCATION_FOR_STORAGE", "NO_LOGISTICS_FOR_STORAGE", "NO_VALID_ADDONS", "ONGOING_SERVICE", "OWNED_BY_DEEL", "OWNED_BY_ORGANIZATION", "OWNED_BY_PARTNER_ORGANIZATION", "PARTNER_CHILD_CONTRACT", "PENDING_DEVICE_REFRESH", "RENTAL_CONTRACT_AND_USER_REGION_DO_NOT_MATCH", "TEMPORARILY_UNAVAILABLE", "UNKNOWN", "USER_HAS_NO_COUNTRY", "USER_HAS_NO_SEAT", "WAITING_FOR_CLEARANCE", "WITH_LOANER_ASSIGNMENT", "WITH_NON_COLLECTED_ASSIGNMENT", "WITH_NON_DELIVERED_ASSIGNMENT", "WITH_PENDING_ASSIGNMENT", "WRONG_ASSIGNMENT_STATUS", "WRONG_CONTRACT_STATUS", "WRONG_TERMS_AND_CONDITIONS" ], "title": "ItAssetsPostResponsesContentApplicationJsonSchemaDataActionsUpdateLocationUserToUserDisabledReasonsItems", "type": "string" }, "ItAssetsPostResponsesContentApplicationJsonSchemaDataActionsUpdateLocationUserToUserStatus": { "description": "Whether the action is currently available for this asset", "enum": [ "DISABLED", "ENABLED", "NOT_APPLICABLE" ], "title": "ItAssetsPostResponsesContentApplicationJsonSchemaDataActionsUpdateLocationUserToUserStatus", "type": "string" }, "ItAssetsPostResponsesContentApplicationJsonSchemaDataActionsUpdateOwnAssetDetails": { "description": "Update editable details of an organization-owned asset", "properties": { "disabled_reasons": { "description": "Reasons why the action is disabled. Empty when the action is enabled or not applicable", "items": { "$ref": "#/components/schemas/ItAssetsPostResponsesContentApplicationJsonSchemaDataActionsUpdateOwnAssetDetailsDisabledReasonsItems" }, "type": "array" }, "status": { "$ref": "#/components/schemas/ItAssetsPostResponsesContentApplicationJsonSchemaDataActionsUpdateOwnAssetDetailsStatus", "description": "Whether the action is currently available for this asset" } }, "required": [ "status", "disabled_reasons" ], "title": "ItAssetsPostResponsesContentApplicationJsonSchemaDataActionsUpdateOwnAssetDetails", "type": "object" }, "ItAssetsPostResponsesContentApplicationJsonSchemaDataActionsUpdateOwnAssetDetailsDisabledReasonsItems": { "enum": [ "ARCHIVED", "AT_DEEL_WAREHOUSE", "BEING_REPAIRED", "CONSUMABLE", "CONTROLLED_BY_DEEL", "COUNTRY_NOT_SUPPORTED_FOR_HUB", "COUNTRY_NOT_SUPPORTED_FOR_LOCAL", "DEEL_OWNED_ITEM_WITHOUT_RENTAL_CONTRACT", "DESKTOP_STORAGE", "ENDING_CONTRACT", "HUB_IN_SAME_REGION_AS_LOCAL", "INACTIVE", "INVALID_ITEM_LOCATION", "INVALID_ORGANIZATION_STATUS", "INVALID_STATE", "ITEM_CONDITIONS_TO_UNARCHIVE_NOT_MET", "ITEM_NOT_VISIBLE_FOR_ORGANIZATION", "NON_DEVICE", "NOT_AT_WAREHOUSE", "NOT_AVAILABLE_FOR_REUSE", "NOT_A_RENTAL", "NOT_MANAGEABLE_BY_ORGANIZATION", "NOT_WITH_ASSIGNMENT", "NOT_WITH_USER", "NO_ACTIVE_ADDONS", "NO_ACTIVE_STORAGE_CONTRACT", "NO_LOCATION_FOR_STORAGE", "NO_LOGISTICS_FOR_STORAGE", "NO_VALID_ADDONS", "ONGOING_SERVICE", "OWNED_BY_DEEL", "OWNED_BY_ORGANIZATION", "OWNED_BY_PARTNER_ORGANIZATION", "PARTNER_CHILD_CONTRACT", "PENDING_DEVICE_REFRESH", "RENTAL_CONTRACT_AND_USER_REGION_DO_NOT_MATCH", "TEMPORARILY_UNAVAILABLE", "UNKNOWN", "USER_HAS_NO_COUNTRY", "USER_HAS_NO_SEAT", "WAITING_FOR_CLEARANCE", "WITH_LOANER_ASSIGNMENT", "WITH_NON_COLLECTED_ASSIGNMENT", "WITH_NON_DELIVERED_ASSIGNMENT", "WITH_PENDING_ASSIGNMENT", "WRONG_ASSIGNMENT_STATUS", "WRONG_CONTRACT_STATUS", "WRONG_TERMS_AND_CONDITIONS" ], "title": "ItAssetsPostResponsesContentApplicationJsonSchemaDataActionsUpdateOwnAssetDetailsDisabledReasonsItems", "type": "string" }, "ItAssetsPostResponsesContentApplicationJsonSchemaDataActionsUpdateOwnAssetDetailsStatus": { "description": "Whether the action is currently available for this asset", "enum": [ "DISABLED", "ENABLED", "NOT_APPLICABLE" ], "title": "ItAssetsPostResponsesContentApplicationJsonSchemaDataActionsUpdateOwnAssetDetailsStatus", "type": "string" }, "ItAssetsPostResponsesContentApplicationJsonSchemaDataAssignedUser": { "description": "Details of the user with asset possession", "properties": { "emails": { "description": "Array of user email addresses", "items": { "format": "email", "type": "string" }, "type": "array" }, "first_name": { "description": "First name of the user", "type": "string" }, "hris_profile_id": { "description": "The unique identifier of the HRIS profile of the assigned user", "format": "uuid", "type": "string" }, "last_name": { "description": "Last name of the user", "type": "string" } }, "required": [ "emails", "last_name", "first_name", "hris_profile_id" ], "title": "ItAssetsPostResponsesContentApplicationJsonSchemaDataAssignedUser", "type": "object" }, "ItAssetsPostResponsesContentApplicationJsonSchemaDataAssignedWarehouse": { "description": "Details of the warehouse with asset possession", "properties": { "address": { "$ref": "#/components/schemas/ItAssetsPostResponsesContentApplicationJsonSchemaDataAssignedWarehouseAddress", "description": "Warehouse address details" }, "id": { "description": "Unique identifier of the warehouse", "format": "uuid", "type": "string" }, "name": { "description": "Warehouse or storage location name", "type": "string" }, "ownership": { "$ref": "#/components/schemas/ItAssetsPostResponsesContentApplicationJsonSchemaDataAssignedWarehouseOwnership", "description": "Warehouse ownership type" }, "public_id": { "description": "Public identifier of the warehouse", "type": "string" }, "warehouse_type": { "$ref": "#/components/schemas/ItAssetsPostResponsesContentApplicationJsonSchemaDataAssignedWarehouseWarehouseType", "description": "Warehouse type" } }, "required": [ "id", "name", "address", "ownership", "public_id", "warehouse_type" ], "title": "ItAssetsPostResponsesContentApplicationJsonSchemaDataAssignedWarehouse", "type": "object" }, "ItAssetsPostResponsesContentApplicationJsonSchemaDataAssignedWarehouseAddress": { "description": "Warehouse address details", "properties": { "city": { "description": "City name", "type": [ "string", "null" ] }, "country": { "$ref": "#/components/schemas/ItAssetsPostResponsesContentApplicationJsonSchemaDataAssignedWarehouseAddressCountry", "description": "Country code" }, "date_of_birth": { "description": "Date of birth (applicable for some address types)", "format": "date", "type": [ "string", "null" ] }, "delivery_instructions": { "description": "Special instructions for deliveries", "type": [ "string", "null" ] }, "id": { "description": "Unique identifier of the address", "format": "uuid", "type": "string" }, "is_valid": { "description": "Whether the address passes validation", "type": "boolean" }, "line1": { "description": "Address line 1", "type": [ "string", "null" ] }, "line2": { "description": "Address line 2", "type": [ "string", "null" ] }, "passport_number": { "description": "Passport number (applicable for some address types)", "type": [ "string", "null" ] }, "phone_number": { "description": "Phone number", "type": [ "string", "null" ] }, "post_code": { "description": "Post code", "type": [ "string", "null" ] }, "state": { "description": "State code or name", "type": [ "string", "null" ] }, "tax_id_number": { "description": "Tax ID number (applicable for some address types)", "type": [ "string", "null" ] }, "type": { "$ref": "#/components/schemas/ItAssetsPostResponsesContentApplicationJsonSchemaDataAssignedWarehouseAddressType", "description": "Type of the address" } }, "required": [ "id", "city", "type", "line1", "line2", "state", "country", "is_valid", "post_code", "phone_number", "date_of_birth", "tax_id_number", "passport_number", "delivery_instructions" ], "title": "ItAssetsPostResponsesContentApplicationJsonSchemaDataAssignedWarehouseAddress", "type": "object" }, "ItAssetsPostResponsesContentApplicationJsonSchemaDataAssignedWarehouseAddressCountry": { "description": "Country code", "enum": [ "AD", "AE", "AF", "AG", "AI", "AL", "AM", "AN", "AO", "AQ", "AR", "AS", "AT", "AU", "AW", "AX", "AZ", "BA", "BB", "BD", "BE", "BF", "BG", "BH", "BI", "BJ", "BL", "BM", "BN", "BO", "BQ", "BR", "BS", "BT", "BV", "BW", "BY", "BZ", "CA", "CC", "CD", "CF", "CG", "CH", "CI", "CK", "CL", "CM", "CN", "CO", "CR", "CU", "CV", "CW", "CX", "CY", "CZ", "DE", "DJ", "DK", "DM", "DO", "DZ", "EC", "EE", "EG", "EH", "ER", "ES", "ET", "FI", "FJ", "FK", "FM", "FO", "FR", "GA", "GB", "GD", "GE", "GF", "GG", "GH", "GI", "GL", "GM", "GN", "GP", "GQ", "GR", "GS", "GT", "GU", "GW", "GY", "HK", "HM", "HN", "HR", "HT", "HU", "IC", "ID", "IE", "IL", "IM", "IN", "IO", "IQ", "IR", "IS", "IT", "JE", "JM", "JO", "JP", "KE", "KG", "KH", "KI", "KM", "KN", "KP", "KR", "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", "XK", "YE", "YT", "ZA", "ZM", "ZW" ], "title": "ItAssetsPostResponsesContentApplicationJsonSchemaDataAssignedWarehouseAddressCountry", "type": "string" }, "ItAssetsPostResponsesContentApplicationJsonSchemaDataAssignedWarehouseAddressType": { "description": "Type of the address", "enum": [ "BILLING", "COLLECTION", "DELIVERY", "ENTITY", "PARTIAL", "PII", "SUPPLIER" ], "title": "ItAssetsPostResponsesContentApplicationJsonSchemaDataAssignedWarehouseAddressType", "type": "string" }, "ItAssetsPostResponsesContentApplicationJsonSchemaDataAssignedWarehouseOwnership": { "description": "Warehouse ownership type", "enum": [ "DEEL", "ORGANIZATION" ], "title": "ItAssetsPostResponsesContentApplicationJsonSchemaDataAssignedWarehouseOwnership", "type": "string" }, "ItAssetsPostResponsesContentApplicationJsonSchemaDataAssignedWarehouseWarehouseType": { "description": "Warehouse type", "enum": [ "CLEARANCE", "DEEL", "ORGANIZATION" ], "title": "ItAssetsPostResponsesContentApplicationJsonSchemaDataAssignedWarehouseWarehouseType", "type": "string" }, "ItAssetsPostResponsesContentApplicationJsonSchemaDataGrade": { "description": "The condition grade of the asset", "enum": [ "A", "B", "C", "D", "F", "NEW" ], "title": "ItAssetsPostResponsesContentApplicationJsonSchemaDataGrade", "type": "string" }, "ItAssetsPostResponsesContentApplicationJsonSchemaDataLocation": { "description": "Current location type of the asset", "enum": [ "AT_WAREHOUSE", "CLEARANCE_WAREHOUSE", "DEEL_WAREHOUSE", "ORGANIZATION_WAREHOUSE", "SUPPLIER", "WITH_COURIER", "WITH_USER", "WRITE_OFF" ], "title": "ItAssetsPostResponsesContentApplicationJsonSchemaDataLocation", "type": "string" }, "ItAssetsPostResponsesContentApplicationJsonSchemaDataOwnership": { "description": "Asset owner", "properties": { "name": { "description": "Asset owner name", "type": "string" }, "type": { "$ref": "#/components/schemas/ItAssetsPostResponsesContentApplicationJsonSchemaDataOwnershipType", "description": "Asset owner type" } }, "required": [ "name", "type" ], "title": "ItAssetsPostResponsesContentApplicationJsonSchemaDataOwnership", "type": "object" }, "ItAssetsPostResponsesContentApplicationJsonSchemaDataOwnershipType": { "description": "Asset owner type", "enum": [ "DEEL", "ORGANIZATION" ], "title": "ItAssetsPostResponsesContentApplicationJsonSchemaDataOwnershipType", "type": "string" }, "ItAssetsPostResponsesContentApplicationJsonSchemaDataProduct": { "description": "Product details", "properties": { "brand": { "description": "Product brand", "type": "string" }, "category": { "$ref": "#/components/schemas/ItAssetsPostResponsesContentApplicationJsonSchemaDataProductCategory", "description": "Product category" }, "id": { "description": "Unique identifier of the product", "format": "uuid", "type": "string" }, "name": { "description": "Product name", "type": "string" }, "specifications": { "description": "Specifications of the product", "items": { "$ref": "#/components/schemas/ItAssetsPostResponsesContentApplicationJsonSchemaDataProductSpecificationsItems" }, "type": "array" } }, "required": [ "id", "name", "brand", "category", "specifications" ], "title": "ItAssetsPostResponsesContentApplicationJsonSchemaDataProduct", "type": "object" }, "ItAssetsPostResponsesContentApplicationJsonSchemaDataProductCategory": { "description": "Product category", "enum": [ "ADAPTER", "CABLE", "CHAIR", "CHARGER", "COMPACT_DESKTOP", "DESK", "DESKTOP", "DESK_RISER", "DESK_TIDY", "DOCKING_STATION", "DONGLE", "FOOTREST", "HEADSET", "KEYBOARD", "LAPTOP", "LAPTOP_STAND", "MICE_TRACKPAD", "MOBILE_DEVICE", "MONITOR", "MONITOR_ARM", "OTHER", "PRINTER", "SHREDDER", "STANDING_MAT", "TABLET", "TASK_LIGHT", "WEBCAM", "WELCOME_PACK", "WIFI_RANGE_EXTENDER" ], "title": "ItAssetsPostResponsesContentApplicationJsonSchemaDataProductCategory", "type": "string" }, "ItAssetsPostResponsesContentApplicationJsonSchemaDataProductSpecificationsItems": { "properties": { "name": { "description": "Specification name", "type": "string" }, "value": { "description": "Specification value", "type": "string" } }, "required": [ "name", "value" ], "title": "ItAssetsPostResponsesContentApplicationJsonSchemaDataProductSpecificationsItems", "type": "object" }, "ItAssetsPostResponsesContentApplicationJsonSchemaDataPurchaseValue": { "description": "Purchase value of the asset", "properties": { "amount": { "description": "Amount", "format": "decimal", "type": "string" }, "currency": { "$ref": "#/components/schemas/ItAssetsPostResponsesContentApplicationJsonSchemaDataPurchaseValueCurrency", "description": "Three-letter currency code for the price" } }, "required": [ "amount", "currency" ], "title": "ItAssetsPostResponsesContentApplicationJsonSchemaDataPurchaseValue", "type": "object" }, "ItAssetsPostResponsesContentApplicationJsonSchemaDataPurchaseValueCurrency": { "description": "Three-letter currency code for the price", "enum": [ "AED", "AFN", "ALL", "AMD", "ANG", "AOA", "ARS", "AUD", "AWG", "AZN", "BAM", "BDT", "BGN", "BHD", "BIF", "BMD", "BOB", "BRL", "BSD", "BTN", "BWP", "BYN", "BZD", "CAD", "CDF", "CHF", "CLP", "CNY", "COP", "CRC", "CUC", "CVE", "CZK", "DJF", "DKK", "DOP", "DZD", "EGP", "ERN", "ETB", "EUR", "FJD", "FKP", "GBP", "GEL", "GHS", "GIP", "GMD", "GNF", "GTQ", "GYD", "HKD", "HNL", "HRK", "HTG", "HUF", "IDR", "ILS", "INR", "IQD", "IRR", "ISK", "JMD", "JOD", "JPY", "KES", "KGS", "KHR", "KMF", "KPW", "KRW", "KWD", "KYD", "KZT", "LAK", "LBP", "LKR", "LRD", "LSL", "LTL", "LYD", "MAD", "MDL", "MGA", "MKD", "MMK", "MNT", "MRU", "MUR", "MVR", "MWK", "MXN", "MYR", "MZN", "NAD", "NGN", "NIO", "NOK", "NPR", "NZD", "OMR", "PAB", "PEN", "PGK", "PHP", "PKR", "PLN", "PYG", "QAR", "RON", "RSD", "RUB", "RWF", "SAR", "SBD", "SCR", "SDG", "SEK", "SGD", "SHP", "SLL", "SOS", "SRD", "SSP", "STD", "SYP", "SZL", "THB", "TJS", "TMT", "TND", "TOP", "TRY", "TTD", "TWD", "TZS", "UAH", "UGX", "USD", "UYU", "UZS", "VEF", "VND", "VUV", "WST", "XAF", "XCD", "XOF", "XPF", "YER", "ZAR", "ZMW", "ZWD" ], "title": "ItAssetsPostResponsesContentApplicationJsonSchemaDataPurchaseValueCurrency", "type": "string" }, "ItAssetsPostResponsesContentApplicationJsonSchemaDataStatus": { "description": "Current state of the asset", "enum": [ "ACTIVE", "ADDED_BY_MISTAKE", "BEING_REPAIRED", "BINNED", "BROKEN_AT_WAREHOUSE", "BROKEN_BY_USER", "BROKEN_IN_TRANSIT", "CLEARED", "DAMAGED_AT_WAREHOUSE", "DAMAGED_BY_USER", "DAMAGED_IN_TRANSIT", "LEFT_WITH_USER", "LOST_IN_TRANSIT", "RETURNED_TO_DEEL", "SHRINKAGE", "STOLEN", "SUPPLIER_RETURN", "WAITING_FOR_CLEARANCE" ], "title": "ItAssetsPostResponsesContentApplicationJsonSchemaDataStatus", "type": "string" }, "ItAssetsPostResponsesContentApplicationJsonSchemaErrorsItems": { "properties": { "code": { "description": "Error code of the handler which produced the returned error", "type": "string" }, "field": { "description": "The field name where input validation failed", "type": [ "string", "null" ] }, "message": { "description": "Description of the returned error", "type": "string" } }, "required": [ "code", "field", "message" ], "title": "ItAssetsPostResponsesContentApplicationJsonSchemaErrorsItems", "type": "object" }, "ItClearanceRequestsClearanceRequestIdCancelPostParametersXBeta": { "default": "true", "enum": [ "true" ], "title": "ItClearanceRequestsClearanceRequestIdCancelPostParametersXBeta", "type": "string" }, "ItClearanceRequestsClearanceRequestIdCancelPostResponsesContentApplicationJsonSchemaData": { "properties": { "cancelled_reason": { "description": "Reason the clearance request was cancelled, absent unless the status is CANCELLED", "oneOf": [ { "$ref": "#/components/schemas/ItClearanceRequestsClearanceRequestIdCancelPostResponsesContentApplicationJsonSchemaDataCancelledReason" }, { "type": "null" } ] }, "created_at": { "description": "Creation timestamp of the clearance request", "format": "date-time", "type": "string" }, "expires_at": { "description": "Timestamp indicating when the request expires and the manager can no longer take action, absent when no deadline applies", "format": "date-time", "type": [ "string", "null" ] }, "id": { "description": "Unique identifier of the clearance request", "format": "uuid", "type": "string" }, "public_id": { "description": "Public identifier of the clearance request", "type": "string" }, "request_items": { "description": "Items included in this clearance request, one per asset being cleared", "items": { "$ref": "#/components/schemas/ItClearanceRequestsClearanceRequestIdCancelPostResponsesContentApplicationJsonSchemaDataRequestItemsItems" }, "type": "array" }, "status": { "$ref": "#/components/schemas/ItClearanceRequestsClearanceRequestIdCancelPostResponsesContentApplicationJsonSchemaDataStatus", "description": "Current state of the clearance request" } }, "required": [ "id", "status", "public_id", "created_at", "expires_at", "request_items", "cancelled_reason" ], "title": "ItClearanceRequestsClearanceRequestIdCancelPostResponsesContentApplicationJsonSchemaData", "type": "object" }, "ItClearanceRequestsClearanceRequestIdCancelPostResponsesContentApplicationJsonSchemaDataCancelledReason": { "description": "Reason the clearance request was cancelled, absent unless the status is CANCELLED", "enum": [ "DEADLINE_EXCEEDED", "REQUESTED_BY_CUSTOMER" ], "title": "ItClearanceRequestsClearanceRequestIdCancelPostResponsesContentApplicationJsonSchemaDataCancelledReason", "type": "string" }, "ItClearanceRequestsClearanceRequestIdCancelPostResponsesContentApplicationJsonSchemaDataRequestItemsItems": { "properties": { "asset": { "$ref": "#/components/schemas/ItClearanceRequestsClearanceRequestIdCancelPostResponsesContentApplicationJsonSchemaDataRequestItemsItemsAsset", "description": "Asset being cleared as part of this clearance request item" }, "id": { "description": "Unique identifier of the clearance request item", "format": "uuid", "type": "string" }, "quote_price": { "description": "Quote price offered by the clearance partner for the asset, absent until a quote is received", "oneOf": [ { "$ref": "#/components/schemas/ItClearanceRequestsClearanceRequestIdCancelPostResponsesContentApplicationJsonSchemaDataRequestItemsItemsQuotePrice" }, { "type": "null" } ] }, "status": { "$ref": "#/components/schemas/ItClearanceRequestsClearanceRequestIdCancelPostResponsesContentApplicationJsonSchemaDataRequestItemsItemsStatus", "description": "Current state of the item within the clearance request lifecycle" } }, "required": [ "id", "asset", "status", "quote_price" ], "title": "ItClearanceRequestsClearanceRequestIdCancelPostResponsesContentApplicationJsonSchemaDataRequestItemsItems", "type": "object" }, "ItClearanceRequestsClearanceRequestIdCancelPostResponsesContentApplicationJsonSchemaDataRequestItemsItemsAsset": { "description": "Asset being cleared as part of this clearance request item", "properties": { "id": { "description": "Unique identifier of the asset", "format": "uuid", "type": "string" }, "product": { "$ref": "#/components/schemas/ItClearanceRequestsClearanceRequestIdCancelPostResponsesContentApplicationJsonSchemaDataRequestItemsItemsAssetProduct", "description": "Product details of the asset" }, "public_id": { "description": "Public identifier of the asset", "type": "string" }, "serial_number": { "description": "Asset serial number, absent when the manufacturer did not assign one", "type": [ "string", "null" ] } }, "required": [ "id", "product", "public_id", "serial_number" ], "title": "ItClearanceRequestsClearanceRequestIdCancelPostResponsesContentApplicationJsonSchemaDataRequestItemsItemsAsset", "type": "object" }, "ItClearanceRequestsClearanceRequestIdCancelPostResponsesContentApplicationJsonSchemaDataRequestItemsItemsAssetProduct": { "description": "Product details of the asset", "properties": { "brand": { "description": "Product brand", "type": "string" }, "category": { "$ref": "#/components/schemas/ItClearanceRequestsClearanceRequestIdCancelPostResponsesContentApplicationJsonSchemaDataRequestItemsItemsAssetProductCategory", "description": "Product category" }, "id": { "description": "Unique identifier of the product", "format": "uuid", "type": "string" }, "name": { "description": "Product name", "type": "string" } }, "required": [ "id", "name", "brand", "category" ], "title": "ItClearanceRequestsClearanceRequestIdCancelPostResponsesContentApplicationJsonSchemaDataRequestItemsItemsAssetProduct", "type": "object" }, "ItClearanceRequestsClearanceRequestIdCancelPostResponsesContentApplicationJsonSchemaDataRequestItemsItemsAssetProductCategory": { "description": "Product category", "enum": [ "ADAPTER", "CABLE", "CHAIR", "CHARGER", "COMPACT_DESKTOP", "DESK", "DESKTOP", "DESK_RISER", "DESK_TIDY", "DOCKING_STATION", "DONGLE", "FOOTREST", "HEADSET", "KEYBOARD", "LAPTOP", "LAPTOP_STAND", "MICE_TRACKPAD", "MOBILE_DEVICE", "MONITOR", "MONITOR_ARM", "OTHER", "PRINTER", "SHREDDER", "STANDING_MAT", "TABLET", "TASK_LIGHT", "WEBCAM", "WELCOME_PACK", "WIFI_RANGE_EXTENDER" ], "title": "ItClearanceRequestsClearanceRequestIdCancelPostResponsesContentApplicationJsonSchemaDataRequestItemsItemsAssetProductCategory", "type": "string" }, "ItClearanceRequestsClearanceRequestIdCancelPostResponsesContentApplicationJsonSchemaDataRequestItemsItemsQuotePrice": { "description": "Quote price offered by the clearance partner for the asset, absent until a quote is received", "properties": { "amount": { "description": "Amount", "format": "decimal", "type": "string" }, "currency": { "$ref": "#/components/schemas/ItClearanceRequestsClearanceRequestIdCancelPostResponsesContentApplicationJsonSchemaDataRequestItemsItemsQuotePriceCurrency", "description": "Three-letter currency code for the price" } }, "required": [ "amount", "currency" ], "title": "ItClearanceRequestsClearanceRequestIdCancelPostResponsesContentApplicationJsonSchemaDataRequestItemsItemsQuotePrice", "type": "object" }, "ItClearanceRequestsClearanceRequestIdCancelPostResponsesContentApplicationJsonSchemaDataRequestItemsItemsQuotePriceCurrency": { "description": "Three-letter currency code for the price", "enum": [ "AED", "AFN", "ALL", "AMD", "ANG", "AOA", "ARS", "AUD", "AWG", "AZN", "BAM", "BDT", "BGN", "BHD", "BIF", "BMD", "BOB", "BRL", "BSD", "BTN", "BWP", "BYN", "BZD", "CAD", "CDF", "CHF", "CLP", "CNY", "COP", "CRC", "CUC", "CVE", "CZK", "DJF", "DKK", "DOP", "DZD", "EGP", "ERN", "ETB", "EUR", "FJD", "FKP", "GBP", "GEL", "GHS", "GIP", "GMD", "GNF", "GTQ", "GYD", "HKD", "HNL", "HRK", "HTG", "HUF", "IDR", "ILS", "INR", "IQD", "IRR", "ISK", "JMD", "JOD", "JPY", "KES", "KGS", "KHR", "KMF", "KPW", "KRW", "KWD", "KYD", "KZT", "LAK", "LBP", "LKR", "LRD", "LSL", "LTL", "LYD", "MAD", "MDL", "MGA", "MKD", "MMK", "MNT", "MRU", "MUR", "MVR", "MWK", "MXN", "MYR", "MZN", "NAD", "NGN", "NIO", "NOK", "NPR", "NZD", "OMR", "PAB", "PEN", "PGK", "PHP", "PKR", "PLN", "PYG", "QAR", "RON", "RSD", "RUB", "RWF", "SAR", "SBD", "SCR", "SDG", "SEK", "SGD", "SHP", "SLL", "SOS", "SRD", "SSP", "STD", "SYP", "SZL", "THB", "TJS", "TMT", "TND", "TOP", "TRY", "TTD", "TWD", "TZS", "UAH", "UGX", "USD", "UYU", "UZS", "VEF", "VND", "VUV", "WST", "XAF", "XCD", "XOF", "XPF", "YER", "ZAR", "ZMW", "ZWD" ], "title": "ItClearanceRequestsClearanceRequestIdCancelPostResponsesContentApplicationJsonSchemaDataRequestItemsItemsQuotePriceCurrency", "type": "string" }, "ItClearanceRequestsClearanceRequestIdCancelPostResponsesContentApplicationJsonSchemaDataRequestItemsItemsStatus": { "description": "Current state of the item within the clearance request lifecycle", "enum": [ "CANCELLED", "CUSTOMER_ACCEPTED_QUOTE", "CUSTOMER_REJECTED_QUOTE", "PENDING_CUSTOMER_DECISION", "PENDING_QUOTE", "SKIPPED_QUOTE" ], "title": "ItClearanceRequestsClearanceRequestIdCancelPostResponsesContentApplicationJsonSchemaDataRequestItemsItemsStatus", "type": "string" }, "ItClearanceRequestsClearanceRequestIdCancelPostResponsesContentApplicationJsonSchemaDataStatus": { "description": "Current state of the clearance request", "enum": [ "CANCELLED", "COMPLETED", "DECIDED", "PENDING_DECISION", "PENDING_QUOTE", "PENDING_RETURN" ], "title": "ItClearanceRequestsClearanceRequestIdCancelPostResponsesContentApplicationJsonSchemaDataStatus", "type": "string" }, "ItClearanceRequestsClearanceRequestIdCancelPostResponsesContentApplicationJsonSchemaErrorsItems": { "properties": { "code": { "description": "Error code of the handler which produced the returned error", "type": "string" }, "field": { "description": "The field name where input validation failed", "type": [ "string", "null" ] }, "message": { "description": "Description of the returned error", "type": "string" } }, "required": [ "code", "field", "message" ], "title": "ItClearanceRequestsClearanceRequestIdCancelPostResponsesContentApplicationJsonSchemaErrorsItems", "type": "object" }, "ItClearanceRequestsClearanceRequestIdDecidePostParametersXBeta": { "default": "true", "enum": [ "true" ], "title": "ItClearanceRequestsClearanceRequestIdDecidePostParametersXBeta", "type": "string" }, "ItClearanceRequestsClearanceRequestIdDecidePostRequestBodyContentApplicationJsonSchemaData": { "properties": { "items": { "description": "Decisions on each request item in the clearance request. Every request item in the clearance request must be included; otherwise the endpoint returns a `clearance_request_items_undecided` error.", "items": { "$ref": "#/components/schemas/ItClearanceRequestsClearanceRequestIdDecidePostRequestBodyContentApplicationJsonSchemaDataItemsItems" }, "type": "array" } }, "required": [ "items" ], "title": "ItClearanceRequestsClearanceRequestIdDecidePostRequestBodyContentApplicationJsonSchemaData", "type": "object" }, "ItClearanceRequestsClearanceRequestIdDecidePostRequestBodyContentApplicationJsonSchemaDataItemsItems": { "properties": { "is_accepted": { "description": "Whether the quote for this request item is accepted (`true`) or rejected (`false`). When every item is rejected the clearance request is cancelled.", "type": "boolean" }, "request_item_id": { "description": "Unique identifier of the clearance request item the decision applies to", "format": "uuid", "type": "string" } }, "required": [ "is_accepted", "request_item_id" ], "title": "ItClearanceRequestsClearanceRequestIdDecidePostRequestBodyContentApplicationJsonSchemaDataItemsItems", "type": "object" }, "ItClearanceRequestsClearanceRequestIdDecidePostResponsesContentApplicationJsonSchemaData": { "properties": { "cancelled_reason": { "description": "Reason the clearance request was cancelled, absent unless the status is CANCELLED", "oneOf": [ { "$ref": "#/components/schemas/ItClearanceRequestsClearanceRequestIdDecidePostResponsesContentApplicationJsonSchemaDataCancelledReason" }, { "type": "null" } ] }, "created_at": { "description": "Creation timestamp of the clearance request", "format": "date-time", "type": "string" }, "expires_at": { "description": "Timestamp indicating when the request expires and the manager can no longer take action, absent when no deadline applies", "format": "date-time", "type": [ "string", "null" ] }, "id": { "description": "Unique identifier of the clearance request", "format": "uuid", "type": "string" }, "public_id": { "description": "Public identifier of the clearance request", "type": "string" }, "request_items": { "description": "Items included in this clearance request, one per asset being cleared", "items": { "$ref": "#/components/schemas/ItClearanceRequestsClearanceRequestIdDecidePostResponsesContentApplicationJsonSchemaDataRequestItemsItems" }, "type": "array" }, "status": { "$ref": "#/components/schemas/ItClearanceRequestsClearanceRequestIdDecidePostResponsesContentApplicationJsonSchemaDataStatus", "description": "Current state of the clearance request" } }, "required": [ "id", "status", "public_id", "created_at", "expires_at", "request_items", "cancelled_reason" ], "title": "ItClearanceRequestsClearanceRequestIdDecidePostResponsesContentApplicationJsonSchemaData", "type": "object" }, "ItClearanceRequestsClearanceRequestIdDecidePostResponsesContentApplicationJsonSchemaDataCancelledReason": { "description": "Reason the clearance request was cancelled, absent unless the status is CANCELLED", "enum": [ "DEADLINE_EXCEEDED", "REQUESTED_BY_CUSTOMER" ], "title": "ItClearanceRequestsClearanceRequestIdDecidePostResponsesContentApplicationJsonSchemaDataCancelledReason", "type": "string" }, "ItClearanceRequestsClearanceRequestIdDecidePostResponsesContentApplicationJsonSchemaDataRequestItemsItems": { "properties": { "asset": { "$ref": "#/components/schemas/ItClearanceRequestsClearanceRequestIdDecidePostResponsesContentApplicationJsonSchemaDataRequestItemsItemsAsset", "description": "Asset being cleared as part of this clearance request item" }, "id": { "description": "Unique identifier of the clearance request item", "format": "uuid", "type": "string" }, "quote_price": { "description": "Quote price offered by the clearance partner for the asset, absent until a quote is received", "oneOf": [ { "$ref": "#/components/schemas/ItClearanceRequestsClearanceRequestIdDecidePostResponsesContentApplicationJsonSchemaDataRequestItemsItemsQuotePrice" }, { "type": "null" } ] }, "status": { "$ref": "#/components/schemas/ItClearanceRequestsClearanceRequestIdDecidePostResponsesContentApplicationJsonSchemaDataRequestItemsItemsStatus", "description": "Current state of the item within the clearance request lifecycle" } }, "required": [ "id", "asset", "status", "quote_price" ], "title": "ItClearanceRequestsClearanceRequestIdDecidePostResponsesContentApplicationJsonSchemaDataRequestItemsItems", "type": "object" }, "ItClearanceRequestsClearanceRequestIdDecidePostResponsesContentApplicationJsonSchemaDataRequestItemsItemsAsset": { "description": "Asset being cleared as part of this clearance request item", "properties": { "id": { "description": "Unique identifier of the asset", "format": "uuid", "type": "string" }, "product": { "$ref": "#/components/schemas/ItClearanceRequestsClearanceRequestIdDecidePostResponsesContentApplicationJsonSchemaDataRequestItemsItemsAssetProduct", "description": "Product details of the asset" }, "public_id": { "description": "Public identifier of the asset", "type": "string" }, "serial_number": { "description": "Asset serial number, absent when the manufacturer did not assign one", "type": [ "string", "null" ] } }, "required": [ "id", "product", "public_id", "serial_number" ], "title": "ItClearanceRequestsClearanceRequestIdDecidePostResponsesContentApplicationJsonSchemaDataRequestItemsItemsAsset", "type": "object" }, "ItClearanceRequestsClearanceRequestIdDecidePostResponsesContentApplicationJsonSchemaDataRequestItemsItemsAssetProduct": { "description": "Product details of the asset", "properties": { "brand": { "description": "Product brand", "type": "string" }, "category": { "$ref": "#/components/schemas/ItClearanceRequestsClearanceRequestIdDecidePostResponsesContentApplicationJsonSchemaDataRequestItemsItemsAssetProductCategory", "description": "Product category" }, "id": { "description": "Unique identifier of the product", "format": "uuid", "type": "string" }, "name": { "description": "Product name", "type": "string" } }, "required": [ "id", "name", "brand", "category" ], "title": "ItClearanceRequestsClearanceRequestIdDecidePostResponsesContentApplicationJsonSchemaDataRequestItemsItemsAssetProduct", "type": "object" }, "ItClearanceRequestsClearanceRequestIdDecidePostResponsesContentApplicationJsonSchemaDataRequestItemsItemsAssetProductCategory": { "description": "Product category", "enum": [ "ADAPTER", "CABLE", "CHAIR", "CHARGER", "COMPACT_DESKTOP", "DESK", "DESKTOP", "DESK_RISER", "DESK_TIDY", "DOCKING_STATION", "DONGLE", "FOOTREST", "HEADSET", "KEYBOARD", "LAPTOP", "LAPTOP_STAND", "MICE_TRACKPAD", "MOBILE_DEVICE", "MONITOR", "MONITOR_ARM", "OTHER", "PRINTER", "SHREDDER", "STANDING_MAT", "TABLET", "TASK_LIGHT", "WEBCAM", "WELCOME_PACK", "WIFI_RANGE_EXTENDER" ], "title": "ItClearanceRequestsClearanceRequestIdDecidePostResponsesContentApplicationJsonSchemaDataRequestItemsItemsAssetProductCategory", "type": "string" }, "ItClearanceRequestsClearanceRequestIdDecidePostResponsesContentApplicationJsonSchemaDataRequestItemsItemsQuotePrice": { "description": "Quote price offered by the clearance partner for the asset, absent until a quote is received", "properties": { "amount": { "description": "Amount", "format": "decimal", "type": "string" }, "currency": { "$ref": "#/components/schemas/ItClearanceRequestsClearanceRequestIdDecidePostResponsesContentApplicationJsonSchemaDataRequestItemsItemsQuotePriceCurrency", "description": "Three-letter currency code for the price" } }, "required": [ "amount", "currency" ], "title": "ItClearanceRequestsClearanceRequestIdDecidePostResponsesContentApplicationJsonSchemaDataRequestItemsItemsQuotePrice", "type": "object" }, "ItClearanceRequestsClearanceRequestIdDecidePostResponsesContentApplicationJsonSchemaDataRequestItemsItemsQuotePriceCurrency": { "description": "Three-letter currency code for the price", "enum": [ "AED", "AFN", "ALL", "AMD", "ANG", "AOA", "ARS", "AUD", "AWG", "AZN", "BAM", "BDT", "BGN", "BHD", "BIF", "BMD", "BOB", "BRL", "BSD", "BTN", "BWP", "BYN", "BZD", "CAD", "CDF", "CHF", "CLP", "CNY", "COP", "CRC", "CUC", "CVE", "CZK", "DJF", "DKK", "DOP", "DZD", "EGP", "ERN", "ETB", "EUR", "FJD", "FKP", "GBP", "GEL", "GHS", "GIP", "GMD", "GNF", "GTQ", "GYD", "HKD", "HNL", "HRK", "HTG", "HUF", "IDR", "ILS", "INR", "IQD", "IRR", "ISK", "JMD", "JOD", "JPY", "KES", "KGS", "KHR", "KMF", "KPW", "KRW", "KWD", "KYD", "KZT", "LAK", "LBP", "LKR", "LRD", "LSL", "LTL", "LYD", "MAD", "MDL", "MGA", "MKD", "MMK", "MNT", "MRU", "MUR", "MVR", "MWK", "MXN", "MYR", "MZN", "NAD", "NGN", "NIO", "NOK", "NPR", "NZD", "OMR", "PAB", "PEN", "PGK", "PHP", "PKR", "PLN", "PYG", "QAR", "RON", "RSD", "RUB", "RWF", "SAR", "SBD", "SCR", "SDG", "SEK", "SGD", "SHP", "SLL", "SOS", "SRD", "SSP", "STD", "SYP", "SZL", "THB", "TJS", "TMT", "TND", "TOP", "TRY", "TTD", "TWD", "TZS", "UAH", "UGX", "USD", "UYU", "UZS", "VEF", "VND", "VUV", "WST", "XAF", "XCD", "XOF", "XPF", "YER", "ZAR", "ZMW", "ZWD" ], "title": "ItClearanceRequestsClearanceRequestIdDecidePostResponsesContentApplicationJsonSchemaDataRequestItemsItemsQuotePriceCurrency", "type": "string" }, "ItClearanceRequestsClearanceRequestIdDecidePostResponsesContentApplicationJsonSchemaDataRequestItemsItemsStatus": { "description": "Current state of the item within the clearance request lifecycle", "enum": [ "CANCELLED", "CUSTOMER_ACCEPTED_QUOTE", "CUSTOMER_REJECTED_QUOTE", "PENDING_CUSTOMER_DECISION", "PENDING_QUOTE", "SKIPPED_QUOTE" ], "title": "ItClearanceRequestsClearanceRequestIdDecidePostResponsesContentApplicationJsonSchemaDataRequestItemsItemsStatus", "type": "string" }, "ItClearanceRequestsClearanceRequestIdDecidePostResponsesContentApplicationJsonSchemaDataStatus": { "description": "Current state of the clearance request", "enum": [ "CANCELLED", "COMPLETED", "DECIDED", "PENDING_DECISION", "PENDING_QUOTE", "PENDING_RETURN" ], "title": "ItClearanceRequestsClearanceRequestIdDecidePostResponsesContentApplicationJsonSchemaDataStatus", "type": "string" }, "ItClearanceRequestsClearanceRequestIdDecidePostResponsesContentApplicationJsonSchemaErrorsItems": { "properties": { "code": { "description": "Error code of the handler which produced the returned error", "type": "string" }, "field": { "description": "The field name where input validation failed", "type": [ "string", "null" ] }, "message": { "description": "Description of the returned error", "type": "string" } }, "required": [ "code", "field", "message" ], "title": "ItClearanceRequestsClearanceRequestIdDecidePostResponsesContentApplicationJsonSchemaErrorsItems", "type": "object" }, "ItClearanceRequestsClearanceRequestIdGetParametersXBeta": { "default": "true", "enum": [ "true" ], "title": "ItClearanceRequestsClearanceRequestIdGetParametersXBeta", "type": "string" }, "ItClearanceRequestsClearanceRequestIdGetResponsesContentApplicationJsonSchemaData": { "properties": { "cancelled_reason": { "description": "Reason the clearance request was cancelled, absent unless the status is CANCELLED", "oneOf": [ { "$ref": "#/components/schemas/ItClearanceRequestsClearanceRequestIdGetResponsesContentApplicationJsonSchemaDataCancelledReason" }, { "type": "null" } ] }, "created_at": { "description": "Creation timestamp of the clearance request", "format": "date-time", "type": "string" }, "expires_at": { "description": "Timestamp indicating when the request expires and the manager can no longer take action, absent when no deadline applies", "format": "date-time", "type": [ "string", "null" ] }, "id": { "description": "Unique identifier of the clearance request", "format": "uuid", "type": "string" }, "public_id": { "description": "Public identifier of the clearance request", "type": "string" }, "request_items": { "description": "Items included in this clearance request, one per asset being cleared", "items": { "$ref": "#/components/schemas/ItClearanceRequestsClearanceRequestIdGetResponsesContentApplicationJsonSchemaDataRequestItemsItems" }, "type": "array" }, "status": { "$ref": "#/components/schemas/ItClearanceRequestsClearanceRequestIdGetResponsesContentApplicationJsonSchemaDataStatus", "description": "Current state of the clearance request" } }, "required": [ "id", "status", "public_id", "created_at", "expires_at", "request_items", "cancelled_reason" ], "title": "ItClearanceRequestsClearanceRequestIdGetResponsesContentApplicationJsonSchemaData", "type": "object" }, "ItClearanceRequestsClearanceRequestIdGetResponsesContentApplicationJsonSchemaDataCancelledReason": { "description": "Reason the clearance request was cancelled, absent unless the status is CANCELLED", "enum": [ "DEADLINE_EXCEEDED", "REQUESTED_BY_CUSTOMER" ], "title": "ItClearanceRequestsClearanceRequestIdGetResponsesContentApplicationJsonSchemaDataCancelledReason", "type": "string" }, "ItClearanceRequestsClearanceRequestIdGetResponsesContentApplicationJsonSchemaDataRequestItemsItems": { "properties": { "asset": { "$ref": "#/components/schemas/ItClearanceRequestsClearanceRequestIdGetResponsesContentApplicationJsonSchemaDataRequestItemsItemsAsset", "description": "Asset being cleared as part of this clearance request item" }, "id": { "description": "Unique identifier of the clearance request item", "format": "uuid", "type": "string" }, "quote_price": { "description": "Quote price offered by the clearance partner for the asset, absent until a quote is received", "oneOf": [ { "$ref": "#/components/schemas/ItClearanceRequestsClearanceRequestIdGetResponsesContentApplicationJsonSchemaDataRequestItemsItemsQuotePrice" }, { "type": "null" } ] }, "status": { "$ref": "#/components/schemas/ItClearanceRequestsClearanceRequestIdGetResponsesContentApplicationJsonSchemaDataRequestItemsItemsStatus", "description": "Current state of the item within the clearance request lifecycle" } }, "required": [ "id", "asset", "status", "quote_price" ], "title": "ItClearanceRequestsClearanceRequestIdGetResponsesContentApplicationJsonSchemaDataRequestItemsItems", "type": "object" }, "ItClearanceRequestsClearanceRequestIdGetResponsesContentApplicationJsonSchemaDataRequestItemsItemsAsset": { "description": "Asset being cleared as part of this clearance request item", "properties": { "id": { "description": "Unique identifier of the asset", "format": "uuid", "type": "string" }, "product": { "$ref": "#/components/schemas/ItClearanceRequestsClearanceRequestIdGetResponsesContentApplicationJsonSchemaDataRequestItemsItemsAssetProduct", "description": "Product details of the asset" }, "public_id": { "description": "Public identifier of the asset", "type": "string" }, "serial_number": { "description": "Asset serial number, absent when the manufacturer did not assign one", "type": [ "string", "null" ] } }, "required": [ "id", "product", "public_id", "serial_number" ], "title": "ItClearanceRequestsClearanceRequestIdGetResponsesContentApplicationJsonSchemaDataRequestItemsItemsAsset", "type": "object" }, "ItClearanceRequestsClearanceRequestIdGetResponsesContentApplicationJsonSchemaDataRequestItemsItemsAssetProduct": { "description": "Product details of the asset", "properties": { "brand": { "description": "Product brand", "type": "string" }, "category": { "$ref": "#/components/schemas/ItClearanceRequestsClearanceRequestIdGetResponsesContentApplicationJsonSchemaDataRequestItemsItemsAssetProductCategory", "description": "Product category" }, "id": { "description": "Unique identifier of the product", "format": "uuid", "type": "string" }, "name": { "description": "Product name", "type": "string" } }, "required": [ "id", "name", "brand", "category" ], "title": "ItClearanceRequestsClearanceRequestIdGetResponsesContentApplicationJsonSchemaDataRequestItemsItemsAssetProduct", "type": "object" }, "ItClearanceRequestsClearanceRequestIdGetResponsesContentApplicationJsonSchemaDataRequestItemsItemsAssetProductCategory": { "description": "Product category", "enum": [ "ADAPTER", "CABLE", "CHAIR", "CHARGER", "COMPACT_DESKTOP", "DESK", "DESKTOP", "DESK_RISER", "DESK_TIDY", "DOCKING_STATION", "DONGLE", "FOOTREST", "HEADSET", "KEYBOARD", "LAPTOP", "LAPTOP_STAND", "MICE_TRACKPAD", "MOBILE_DEVICE", "MONITOR", "MONITOR_ARM", "OTHER", "PRINTER", "SHREDDER", "STANDING_MAT", "TABLET", "TASK_LIGHT", "WEBCAM", "WELCOME_PACK", "WIFI_RANGE_EXTENDER" ], "title": "ItClearanceRequestsClearanceRequestIdGetResponsesContentApplicationJsonSchemaDataRequestItemsItemsAssetProductCategory", "type": "string" }, "ItClearanceRequestsClearanceRequestIdGetResponsesContentApplicationJsonSchemaDataRequestItemsItemsQuotePrice": { "description": "Quote price offered by the clearance partner for the asset, absent until a quote is received", "properties": { "amount": { "description": "Amount", "format": "decimal", "type": "string" }, "currency": { "$ref": "#/components/schemas/ItClearanceRequestsClearanceRequestIdGetResponsesContentApplicationJsonSchemaDataRequestItemsItemsQuotePriceCurrency", "description": "Three-letter currency code for the price" } }, "required": [ "amount", "currency" ], "title": "ItClearanceRequestsClearanceRequestIdGetResponsesContentApplicationJsonSchemaDataRequestItemsItemsQuotePrice", "type": "object" }, "ItClearanceRequestsClearanceRequestIdGetResponsesContentApplicationJsonSchemaDataRequestItemsItemsQuotePriceCurrency": { "description": "Three-letter currency code for the price", "enum": [ "AED", "AFN", "ALL", "AMD", "ANG", "AOA", "ARS", "AUD", "AWG", "AZN", "BAM", "BDT", "BGN", "BHD", "BIF", "BMD", "BOB", "BRL", "BSD", "BTN", "BWP", "BYN", "BZD", "CAD", "CDF", "CHF", "CLP", "CNY", "COP", "CRC", "CUC", "CVE", "CZK", "DJF", "DKK", "DOP", "DZD", "EGP", "ERN", "ETB", "EUR", "FJD", "FKP", "GBP", "GEL", "GHS", "GIP", "GMD", "GNF", "GTQ", "GYD", "HKD", "HNL", "HRK", "HTG", "HUF", "IDR", "ILS", "INR", "IQD", "IRR", "ISK", "JMD", "JOD", "JPY", "KES", "KGS", "KHR", "KMF", "KPW", "KRW", "KWD", "KYD", "KZT", "LAK", "LBP", "LKR", "LRD", "LSL", "LTL", "LYD", "MAD", "MDL", "MGA", "MKD", "MMK", "MNT", "MRU", "MUR", "MVR", "MWK", "MXN", "MYR", "MZN", "NAD", "NGN", "NIO", "NOK", "NPR", "NZD", "OMR", "PAB", "PEN", "PGK", "PHP", "PKR", "PLN", "PYG", "QAR", "RON", "RSD", "RUB", "RWF", "SAR", "SBD", "SCR", "SDG", "SEK", "SGD", "SHP", "SLL", "SOS", "SRD", "SSP", "STD", "SYP", "SZL", "THB", "TJS", "TMT", "TND", "TOP", "TRY", "TTD", "TWD", "TZS", "UAH", "UGX", "USD", "UYU", "UZS", "VEF", "VND", "VUV", "WST", "XAF", "XCD", "XOF", "XPF", "YER", "ZAR", "ZMW", "ZWD" ], "title": "ItClearanceRequestsClearanceRequestIdGetResponsesContentApplicationJsonSchemaDataRequestItemsItemsQuotePriceCurrency", "type": "string" }, "ItClearanceRequestsClearanceRequestIdGetResponsesContentApplicationJsonSchemaDataRequestItemsItemsStatus": { "description": "Current state of the item within the clearance request lifecycle", "enum": [ "CANCELLED", "CUSTOMER_ACCEPTED_QUOTE", "CUSTOMER_REJECTED_QUOTE", "PENDING_CUSTOMER_DECISION", "PENDING_QUOTE", "SKIPPED_QUOTE" ], "title": "ItClearanceRequestsClearanceRequestIdGetResponsesContentApplicationJsonSchemaDataRequestItemsItemsStatus", "type": "string" }, "ItClearanceRequestsClearanceRequestIdGetResponsesContentApplicationJsonSchemaDataStatus": { "description": "Current state of the clearance request", "enum": [ "CANCELLED", "COMPLETED", "DECIDED", "PENDING_DECISION", "PENDING_QUOTE", "PENDING_RETURN" ], "title": "ItClearanceRequestsClearanceRequestIdGetResponsesContentApplicationJsonSchemaDataStatus", "type": "string" }, "ItClearanceRequestsClearanceRequestIdGetResponsesContentApplicationJsonSchemaErrorsItems": { "properties": { "code": { "description": "Error code of the handler which produced the returned error", "type": "string" }, "field": { "description": "The field name where input validation failed", "type": [ "string", "null" ] }, "message": { "description": "Description of the returned error", "type": "string" } }, "required": [ "code", "field", "message" ], "title": "ItClearanceRequestsClearanceRequestIdGetResponsesContentApplicationJsonSchemaErrorsItems", "type": "object" }, "ItClearanceRequestsGetParametersStatus": { "enum": [ "CANCELLED", "COMPLETED", "DECIDED", "PENDING_DECISION", "PENDING_QUOTE", "PENDING_RETURN" ], "title": "ItClearanceRequestsGetParametersStatus", "type": "string" }, "ItClearanceRequestsGetParametersXBeta": { "default": "true", "enum": [ "true" ], "title": "ItClearanceRequestsGetParametersXBeta", "type": "string" }, "ItClearanceRequestsGetResponsesContentApplicationJsonSchemaDataItems": { "properties": { "cancelled_reason": { "description": "Reason the clearance request was cancelled, absent unless the status is CANCELLED", "oneOf": [ { "$ref": "#/components/schemas/ItClearanceRequestsGetResponsesContentApplicationJsonSchemaDataItemsCancelledReason" }, { "type": "null" } ] }, "created_at": { "description": "Creation timestamp of the clearance request", "format": "date-time", "type": "string" }, "expires_at": { "description": "Timestamp indicating when the request expires and the manager can no longer take action, absent when no deadline applies", "format": "date-time", "type": [ "string", "null" ] }, "id": { "description": "Unique identifier of the clearance request", "format": "uuid", "type": "string" }, "public_id": { "description": "Public identifier of the clearance request", "type": "string" }, "status": { "$ref": "#/components/schemas/ItClearanceRequestsGetResponsesContentApplicationJsonSchemaDataItemsStatus", "description": "Current state of the clearance request" } }, "required": [ "id", "status", "public_id", "created_at", "expires_at", "cancelled_reason" ], "title": "ItClearanceRequestsGetResponsesContentApplicationJsonSchemaDataItems", "type": "object" }, "ItClearanceRequestsGetResponsesContentApplicationJsonSchemaDataItemsCancelledReason": { "description": "Reason the clearance request was cancelled, absent unless the status is CANCELLED", "enum": [ "DEADLINE_EXCEEDED", "REQUESTED_BY_CUSTOMER" ], "title": "ItClearanceRequestsGetResponsesContentApplicationJsonSchemaDataItemsCancelledReason", "type": "string" }, "ItClearanceRequestsGetResponsesContentApplicationJsonSchemaDataItemsStatus": { "description": "Current state of the clearance request", "enum": [ "CANCELLED", "COMPLETED", "DECIDED", "PENDING_DECISION", "PENDING_QUOTE", "PENDING_RETURN" ], "title": "ItClearanceRequestsGetResponsesContentApplicationJsonSchemaDataItemsStatus", "type": "string" }, "ItClearanceRequestsGetResponsesContentApplicationJsonSchemaErrorsItems": { "properties": { "code": { "description": "Error code of the handler which produced the returned error", "type": "string" }, "field": { "description": "The field name where input validation failed", "type": [ "string", "null" ] }, "message": { "description": "Description of the returned error", "type": "string" } }, "required": [ "code", "field", "message" ], "title": "ItClearanceRequestsGetResponsesContentApplicationJsonSchemaErrorsItems", "type": "object" }, "ItOrdersGetResponsesContentApplicationJsonSchemaDataItems": { "properties": { "created_at": { "description": "Creation timestamp of the order", "format": "date-time", "type": "string" }, "id": { "description": "Unique identifier of the order", "format": "uuid", "type": "string" }, "order_items": { "description": "Order's items details", "items": { "$ref": "#/components/schemas/ItOrdersGetResponsesContentApplicationJsonSchemaDataItemsOrderItemsItems" }, "type": "array" }, "public_id": { "description": "Public identifier of the order", "type": "string" }, "status": { "$ref": "#/components/schemas/ItOrdersGetResponsesContentApplicationJsonSchemaDataItemsStatus", "description": "Order status" }, "updated_at": { "description": "Last update timestamp of the order", "format": "date-time", "type": "string" }, "user": { "description": "Details of the user with asset possession", "oneOf": [ { "$ref": "#/components/schemas/ItOrdersGetResponsesContentApplicationJsonSchemaDataItemsUser" }, { "type": "null" } ] } }, "required": [ "id", "user", "status", "public_id", "created_at", "updated_at", "order_items" ], "title": "ItOrdersGetResponsesContentApplicationJsonSchemaDataItems", "type": "object" }, "ItOrdersGetResponsesContentApplicationJsonSchemaDataItemsOrderItemsItems": { "properties": { "created_at": { "description": "Creation timestamp of the order item", "format": "date-time", "type": "string" }, "id": { "description": "Unique identifier of the order item", "format": "uuid", "type": "string" }, "is_approved": { "description": "Is the order item approved", "type": "boolean" }, "is_express_delivery_requested": { "description": "Is express delivery requested for the order item", "type": "boolean" }, "pricing_details": { "$ref": "#/components/schemas/ItOrdersGetResponsesContentApplicationJsonSchemaDataItemsOrderItemsItemsPricingDetails", "description": "Order item pricing details" }, "product": { "$ref": "#/components/schemas/ItOrdersGetResponsesContentApplicationJsonSchemaDataItemsOrderItemsItemsProduct", "description": "Product details" }, "status": { "$ref": "#/components/schemas/ItOrdersGetResponsesContentApplicationJsonSchemaDataItemsOrderItemsItemsStatus", "description": "Status of the order item" } }, "required": [ "id", "status", "product", "created_at", "is_approved", "pricing_details", "is_express_delivery_requested" ], "title": "ItOrdersGetResponsesContentApplicationJsonSchemaDataItemsOrderItemsItems", "type": "object" }, "ItOrdersGetResponsesContentApplicationJsonSchemaDataItemsOrderItemsItemsPricingDetails": { "description": "Order item pricing details", "properties": { "acquisition_type": { "$ref": "#/components/schemas/ItOrdersGetResponsesContentApplicationJsonSchemaDataItemsOrderItemsItemsPricingDetailsAcquisitionType", "description": "Acquisition type of the order item" }, "asset_price": { "description": "Price of the order item", "oneOf": [ { "$ref": "#/components/schemas/ItOrdersGetResponsesContentApplicationJsonSchemaDataItemsOrderItemsItemsPricingDetailsAssetPrice" }, { "type": "null" } ] }, "storefront_fee": { "description": "Storefront fee associated with the order item", "oneOf": [ { "$ref": "#/components/schemas/ItOrdersGetResponsesContentApplicationJsonSchemaDataItemsOrderItemsItemsPricingDetailsStorefrontFee" }, { "type": "null" } ] } }, "required": [ "asset_price", "storefront_fee", "acquisition_type" ], "title": "ItOrdersGetResponsesContentApplicationJsonSchemaDataItemsOrderItemsItemsPricingDetails", "type": "object" }, "ItOrdersGetResponsesContentApplicationJsonSchemaDataItemsOrderItemsItemsPricingDetailsAcquisitionType": { "description": "Acquisition type of the order item", "enum": [ "PURCHASE", "RENTAL", "REUSE" ], "title": "ItOrdersGetResponsesContentApplicationJsonSchemaDataItemsOrderItemsItemsPricingDetailsAcquisitionType", "type": "string" }, "ItOrdersGetResponsesContentApplicationJsonSchemaDataItemsOrderItemsItemsPricingDetailsAssetPrice": { "description": "Price of the order item", "properties": { "amount": { "description": "Amount", "format": "decimal", "type": "string" }, "currency": { "$ref": "#/components/schemas/ItOrdersGetResponsesContentApplicationJsonSchemaDataItemsOrderItemsItemsPricingDetailsAssetPriceCurrency", "description": "Three-letter currency code for the price" } }, "required": [ "amount", "currency" ], "title": "ItOrdersGetResponsesContentApplicationJsonSchemaDataItemsOrderItemsItemsPricingDetailsAssetPrice", "type": "object" }, "ItOrdersGetResponsesContentApplicationJsonSchemaDataItemsOrderItemsItemsPricingDetailsAssetPriceCurrency": { "description": "Three-letter currency code for the price", "enum": [ "AED", "AFN", "ALL", "AMD", "ANG", "AOA", "ARS", "AUD", "AWG", "AZN", "BAM", "BDT", "BGN", "BHD", "BIF", "BMD", "BOB", "BRL", "BSD", "BTN", "BWP", "BYN", "BZD", "CAD", "CDF", "CHF", "CLP", "CNY", "COP", "CRC", "CUC", "CVE", "CZK", "DJF", "DKK", "DOP", "DZD", "EGP", "ERN", "ETB", "EUR", "FJD", "FKP", "GBP", "GEL", "GHS", "GIP", "GMD", "GNF", "GTQ", "GYD", "HKD", "HNL", "HRK", "HTG", "HUF", "IDR", "ILS", "INR", "IQD", "IRR", "ISK", "JMD", "JOD", "JPY", "KES", "KGS", "KHR", "KMF", "KPW", "KRW", "KWD", "KYD", "KZT", "LAK", "LBP", "LKR", "LRD", "LSL", "LTL", "LYD", "MAD", "MDL", "MGA", "MKD", "MMK", "MNT", "MRU", "MUR", "MVR", "MWK", "MXN", "MYR", "MZN", "NAD", "NGN", "NIO", "NOK", "NPR", "NZD", "OMR", "PAB", "PEN", "PGK", "PHP", "PKR", "PLN", "PYG", "QAR", "RON", "RSD", "RUB", "RWF", "SAR", "SBD", "SCR", "SDG", "SEK", "SGD", "SHP", "SLL", "SOS", "SRD", "SSP", "STD", "SYP", "SZL", "THB", "TJS", "TMT", "TND", "TOP", "TRY", "TTD", "TWD", "TZS", "UAH", "UGX", "USD", "UYU", "UZS", "VEF", "VND", "VUV", "WST", "XAF", "XCD", "XOF", "XPF", "YER", "ZAR", "ZMW", "ZWD" ], "title": "ItOrdersGetResponsesContentApplicationJsonSchemaDataItemsOrderItemsItemsPricingDetailsAssetPriceCurrency", "type": "string" }, "ItOrdersGetResponsesContentApplicationJsonSchemaDataItemsOrderItemsItemsPricingDetailsStorefrontFee": { "description": "Storefront fee associated with the order item", "properties": { "amount": { "description": "Amount", "format": "decimal", "type": "string" }, "currency": { "$ref": "#/components/schemas/ItOrdersGetResponsesContentApplicationJsonSchemaDataItemsOrderItemsItemsPricingDetailsStorefrontFeeCurrency", "description": "Three-letter currency code for the price" } }, "required": [ "amount", "currency" ], "title": "ItOrdersGetResponsesContentApplicationJsonSchemaDataItemsOrderItemsItemsPricingDetailsStorefrontFee", "type": "object" }, "ItOrdersGetResponsesContentApplicationJsonSchemaDataItemsOrderItemsItemsPricingDetailsStorefrontFeeCurrency": { "description": "Three-letter currency code for the price", "enum": [ "AED", "AFN", "ALL", "AMD", "ANG", "AOA", "ARS", "AUD", "AWG", "AZN", "BAM", "BDT", "BGN", "BHD", "BIF", "BMD", "BOB", "BRL", "BSD", "BTN", "BWP", "BYN", "BZD", "CAD", "CDF", "CHF", "CLP", "CNY", "COP", "CRC", "CUC", "CVE", "CZK", "DJF", "DKK", "DOP", "DZD", "EGP", "ERN", "ETB", "EUR", "FJD", "FKP", "GBP", "GEL", "GHS", "GIP", "GMD", "GNF", "GTQ", "GYD", "HKD", "HNL", "HRK", "HTG", "HUF", "IDR", "ILS", "INR", "IQD", "IRR", "ISK", "JMD", "JOD", "JPY", "KES", "KGS", "KHR", "KMF", "KPW", "KRW", "KWD", "KYD", "KZT", "LAK", "LBP", "LKR", "LRD", "LSL", "LTL", "LYD", "MAD", "MDL", "MGA", "MKD", "MMK", "MNT", "MRU", "MUR", "MVR", "MWK", "MXN", "MYR", "MZN", "NAD", "NGN", "NIO", "NOK", "NPR", "NZD", "OMR", "PAB", "PEN", "PGK", "PHP", "PKR", "PLN", "PYG", "QAR", "RON", "RSD", "RUB", "RWF", "SAR", "SBD", "SCR", "SDG", "SEK", "SGD", "SHP", "SLL", "SOS", "SRD", "SSP", "STD", "SYP", "SZL", "THB", "TJS", "TMT", "TND", "TOP", "TRY", "TTD", "TWD", "TZS", "UAH", "UGX", "USD", "UYU", "UZS", "VEF", "VND", "VUV", "WST", "XAF", "XCD", "XOF", "XPF", "YER", "ZAR", "ZMW", "ZWD" ], "title": "ItOrdersGetResponsesContentApplicationJsonSchemaDataItemsOrderItemsItemsPricingDetailsStorefrontFeeCurrency", "type": "string" }, "ItOrdersGetResponsesContentApplicationJsonSchemaDataItemsOrderItemsItemsProduct": { "description": "Product details", "properties": { "brand": { "description": "Product brand", "type": "string" }, "category": { "$ref": "#/components/schemas/ItOrdersGetResponsesContentApplicationJsonSchemaDataItemsOrderItemsItemsProductCategory", "description": "Product category" }, "id": { "description": "Unique identifier of the product", "format": "uuid", "type": "string" }, "name": { "description": "Product name", "type": "string" } }, "required": [ "id", "name", "brand", "category" ], "title": "ItOrdersGetResponsesContentApplicationJsonSchemaDataItemsOrderItemsItemsProduct", "type": "object" }, "ItOrdersGetResponsesContentApplicationJsonSchemaDataItemsOrderItemsItemsProductCategory": { "description": "Product category", "enum": [ "ADAPTER", "CABLE", "CHAIR", "CHARGER", "COMPACT_DESKTOP", "DESK", "DESKTOP", "DESK_RISER", "DESK_TIDY", "DOCKING_STATION", "DONGLE", "FOOTREST", "HEADSET", "KEYBOARD", "LAPTOP", "LAPTOP_STAND", "MICE_TRACKPAD", "MOBILE_DEVICE", "MONITOR", "MONITOR_ARM", "OTHER", "PRINTER", "SHREDDER", "STANDING_MAT", "TABLET", "TASK_LIGHT", "WEBCAM", "WELCOME_PACK", "WIFI_RANGE_EXTENDER" ], "title": "ItOrdersGetResponsesContentApplicationJsonSchemaDataItemsOrderItemsItemsProductCategory", "type": "string" }, "ItOrdersGetResponsesContentApplicationJsonSchemaDataItemsOrderItemsItemsStatus": { "description": "Status of the order item", "enum": [ "AWAITING_PAYMENT", "CANCELLED", "COMPLETED", "PLACED", "PROCESSING", "READY_TO_SHIP", "SHIPPED" ], "title": "ItOrdersGetResponsesContentApplicationJsonSchemaDataItemsOrderItemsItemsStatus", "type": "string" }, "ItOrdersGetResponsesContentApplicationJsonSchemaDataItemsStatus": { "description": "Order status", "enum": [ "APPROVED", "CANCELLED", "DECLINED", "REQUESTED" ], "title": "ItOrdersGetResponsesContentApplicationJsonSchemaDataItemsStatus", "type": "string" }, "ItOrdersGetResponsesContentApplicationJsonSchemaDataItemsUser": { "description": "Details of the user with asset possession", "properties": { "address": { "$ref": "#/components/schemas/ItOrdersGetResponsesContentApplicationJsonSchemaDataItemsUserAddress", "description": "User address details" }, "emails": { "description": "Array of user email addresses", "items": { "format": "email", "type": "string" }, "type": "array" }, "first_name": { "description": "First name of the user", "type": "string" }, "hris_profile_id": { "description": "The unique identifier of the HRIS profile of the assigned user", "format": "uuid", "type": "string" }, "last_name": { "description": "Last name of the user", "type": "string" } }, "required": [ "emails", "address", "last_name", "first_name", "hris_profile_id" ], "title": "ItOrdersGetResponsesContentApplicationJsonSchemaDataItemsUser", "type": "object" }, "ItOrdersGetResponsesContentApplicationJsonSchemaDataItemsUserAddress": { "description": "User address details", "properties": { "city": { "description": "City name", "type": [ "string", "null" ] }, "country": { "$ref": "#/components/schemas/ItOrdersGetResponsesContentApplicationJsonSchemaDataItemsUserAddressCountry", "description": "Country code" }, "date_of_birth": { "description": "Date of birth (applicable for some address types)", "format": "date", "type": [ "string", "null" ] }, "delivery_instructions": { "description": "Special instructions for deliveries", "type": [ "string", "null" ] }, "id": { "description": "Unique identifier of the address", "format": "uuid", "type": "string" }, "is_valid": { "description": "Whether the address passes validation", "type": "boolean" }, "line1": { "description": "Address line 1", "type": [ "string", "null" ] }, "line2": { "description": "Address line 2", "type": [ "string", "null" ] }, "passport_number": { "description": "Passport number (applicable for some address types)", "type": [ "string", "null" ] }, "phone_number": { "description": "Phone number", "type": [ "string", "null" ] }, "post_code": { "description": "Post code", "type": [ "string", "null" ] }, "state": { "description": "State code or name", "type": [ "string", "null" ] }, "tax_id_number": { "description": "Tax ID number (applicable for some address types)", "type": [ "string", "null" ] }, "type": { "$ref": "#/components/schemas/ItOrdersGetResponsesContentApplicationJsonSchemaDataItemsUserAddressType", "description": "Type of the address" } }, "required": [ "id", "city", "type", "line1", "line2", "state", "country", "is_valid", "post_code", "phone_number", "date_of_birth", "tax_id_number", "passport_number", "delivery_instructions" ], "title": "ItOrdersGetResponsesContentApplicationJsonSchemaDataItemsUserAddress", "type": "object" }, "ItOrdersGetResponsesContentApplicationJsonSchemaDataItemsUserAddressCountry": { "description": "Country code", "enum": [ "AD", "AE", "AF", "AG", "AI", "AL", "AM", "AN", "AO", "AQ", "AR", "AS", "AT", "AU", "AW", "AX", "AZ", "BA", "BB", "BD", "BE", "BF", "BG", "BH", "BI", "BJ", "BL", "BM", "BN", "BO", "BQ", "BR", "BS", "BT", "BV", "BW", "BY", "BZ", "CA", "CC", "CD", "CF", "CG", "CH", "CI", "CK", "CL", "CM", "CN", "CO", "CR", "CU", "CV", "CW", "CX", "CY", "CZ", "DE", "DJ", "DK", "DM", "DO", "DZ", "EC", "EE", "EG", "EH", "ER", "ES", "ET", "FI", "FJ", "FK", "FM", "FO", "FR", "GA", "GB", "GD", "GE", "GF", "GG", "GH", "GI", "GL", "GM", "GN", "GP", "GQ", "GR", "GS", "GT", "GU", "GW", "GY", "HK", "HM", "HN", "HR", "HT", "HU", "IC", "ID", "IE", "IL", "IM", "IN", "IO", "IQ", "IR", "IS", "IT", "JE", "JM", "JO", "JP", "KE", "KG", "KH", "KI", "KM", "KN", "KP", "KR", "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", "XK", "YE", "YT", "ZA", "ZM", "ZW" ], "title": "ItOrdersGetResponsesContentApplicationJsonSchemaDataItemsUserAddressCountry", "type": "string" }, "ItOrdersGetResponsesContentApplicationJsonSchemaDataItemsUserAddressType": { "description": "Type of the address", "enum": [ "BILLING", "COLLECTION", "DELIVERY", "ENTITY", "PARTIAL", "PII", "SUPPLIER" ], "title": "ItOrdersGetResponsesContentApplicationJsonSchemaDataItemsUserAddressType", "type": "string" }, "ItOrdersGetResponsesContentApplicationJsonSchemaErrorsItems": { "properties": { "code": { "description": "Error code of the handler which produced the returned error", "type": "string" }, "field": { "description": "The field name where input validation failed", "type": [ "string", "null" ] }, "message": { "description": "Description of the returned error", "type": "string" } }, "required": [ "code", "field", "message" ], "title": "ItOrdersGetResponsesContentApplicationJsonSchemaErrorsItems", "type": "object" }, "ItOrdersOrderIdApprovePostParametersXBeta": { "default": "true", "enum": [ "true" ], "title": "ItOrdersOrderIdApprovePostParametersXBeta", "type": "string" }, "ItOrdersOrderIdApprovePostResponsesContentApplicationJsonSchemaData": { "properties": { "created_at": { "description": "Creation timestamp of the order", "format": "date-time", "type": "string" }, "delivery_address": { "$ref": "#/components/schemas/ItOrdersOrderIdApprovePostResponsesContentApplicationJsonSchemaDataDeliveryAddress", "description": "Delivery address of the order" }, "id": { "description": "Unique identifier of the order", "format": "uuid", "type": "string" }, "order_items": { "description": "Order's items details", "items": { "$ref": "#/components/schemas/ItOrdersOrderIdApprovePostResponsesContentApplicationJsonSchemaDataOrderItemsItems" }, "type": "array" }, "public_id": { "description": "Public identifier of the order", "type": "string" }, "status": { "$ref": "#/components/schemas/ItOrdersOrderIdApprovePostResponsesContentApplicationJsonSchemaDataStatus", "description": "Order status" }, "updated_at": { "description": "Last update timestamp of the order", "format": "date-time", "type": "string" }, "user": { "description": "Details of the user the order is for", "oneOf": [ { "$ref": "#/components/schemas/ItOrdersOrderIdApprovePostResponsesContentApplicationJsonSchemaDataUser" }, { "type": "null" } ] } }, "required": [ "id", "user", "status", "public_id", "created_at", "updated_at", "order_items", "delivery_address" ], "title": "ItOrdersOrderIdApprovePostResponsesContentApplicationJsonSchemaData", "type": "object" }, "ItOrdersOrderIdApprovePostResponsesContentApplicationJsonSchemaDataDeliveryAddress": { "description": "Delivery address of the order", "properties": { "city": { "description": "City name", "type": [ "string", "null" ] }, "country": { "$ref": "#/components/schemas/ItOrdersOrderIdApprovePostResponsesContentApplicationJsonSchemaDataDeliveryAddressCountry", "description": "Country code" }, "date_of_birth": { "description": "Date of birth (applicable for some address types)", "format": "date", "type": [ "string", "null" ] }, "delivery_instructions": { "description": "Special instructions for deliveries", "type": [ "string", "null" ] }, "id": { "description": "Unique identifier of the address", "format": "uuid", "type": "string" }, "is_valid": { "description": "Whether the address passes validation", "type": "boolean" }, "line1": { "description": "Address line 1", "type": [ "string", "null" ] }, "line2": { "description": "Address line 2", "type": [ "string", "null" ] }, "passport_number": { "description": "Passport number (applicable for some address types)", "type": [ "string", "null" ] }, "phone_number": { "description": "Phone number", "type": [ "string", "null" ] }, "post_code": { "description": "Post code", "type": [ "string", "null" ] }, "state": { "description": "State code or name", "type": [ "string", "null" ] }, "tax_id_number": { "description": "Tax ID number (applicable for some address types)", "type": [ "string", "null" ] }, "type": { "$ref": "#/components/schemas/ItOrdersOrderIdApprovePostResponsesContentApplicationJsonSchemaDataDeliveryAddressType", "description": "Type of the address" } }, "required": [ "id", "city", "type", "line1", "line2", "state", "country", "is_valid", "post_code", "phone_number", "date_of_birth", "tax_id_number", "passport_number", "delivery_instructions" ], "title": "ItOrdersOrderIdApprovePostResponsesContentApplicationJsonSchemaDataDeliveryAddress", "type": "object" }, "ItOrdersOrderIdApprovePostResponsesContentApplicationJsonSchemaDataDeliveryAddressCountry": { "description": "Country code", "enum": [ "AD", "AE", "AF", "AG", "AI", "AL", "AM", "AN", "AO", "AQ", "AR", "AS", "AT", "AU", "AW", "AX", "AZ", "BA", "BB", "BD", "BE", "BF", "BG", "BH", "BI", "BJ", "BL", "BM", "BN", "BO", "BQ", "BR", "BS", "BT", "BV", "BW", "BY", "BZ", "CA", "CC", "CD", "CF", "CG", "CH", "CI", "CK", "CL", "CM", "CN", "CO", "CR", "CU", "CV", "CW", "CX", "CY", "CZ", "DE", "DJ", "DK", "DM", "DO", "DZ", "EC", "EE", "EG", "EH", "ER", "ES", "ET", "FI", "FJ", "FK", "FM", "FO", "FR", "GA", "GB", "GD", "GE", "GF", "GG", "GH", "GI", "GL", "GM", "GN", "GP", "GQ", "GR", "GS", "GT", "GU", "GW", "GY", "HK", "HM", "HN", "HR", "HT", "HU", "IC", "ID", "IE", "IL", "IM", "IN", "IO", "IQ", "IR", "IS", "IT", "JE", "JM", "JO", "JP", "KE", "KG", "KH", "KI", "KM", "KN", "KP", "KR", "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", "XK", "YE", "YT", "ZA", "ZM", "ZW" ], "title": "ItOrdersOrderIdApprovePostResponsesContentApplicationJsonSchemaDataDeliveryAddressCountry", "type": "string" }, "ItOrdersOrderIdApprovePostResponsesContentApplicationJsonSchemaDataDeliveryAddressType": { "description": "Type of the address", "enum": [ "BILLING", "COLLECTION", "DELIVERY", "ENTITY", "PARTIAL", "PII", "SUPPLIER" ], "title": "ItOrdersOrderIdApprovePostResponsesContentApplicationJsonSchemaDataDeliveryAddressType", "type": "string" }, "ItOrdersOrderIdApprovePostResponsesContentApplicationJsonSchemaDataOrderItemsItems": { "properties": { "created_at": { "description": "Creation timestamp of the order item", "format": "date-time", "type": "string" }, "id": { "description": "Unique identifier of the order item", "format": "uuid", "type": "string" }, "is_approved": { "description": "Is the order item approved", "type": "boolean" }, "is_express_delivery_requested": { "description": "Is express delivery requested for the order item", "type": "boolean" }, "pricing_details": { "$ref": "#/components/schemas/ItOrdersOrderIdApprovePostResponsesContentApplicationJsonSchemaDataOrderItemsItemsPricingDetails", "description": "Order item pricing details" }, "product": { "$ref": "#/components/schemas/ItOrdersOrderIdApprovePostResponsesContentApplicationJsonSchemaDataOrderItemsItemsProduct", "description": "Product details" }, "status": { "$ref": "#/components/schemas/ItOrdersOrderIdApprovePostResponsesContentApplicationJsonSchemaDataOrderItemsItemsStatus", "description": "Status of the order item" } }, "required": [ "id", "status", "product", "created_at", "is_approved", "pricing_details", "is_express_delivery_requested" ], "title": "ItOrdersOrderIdApprovePostResponsesContentApplicationJsonSchemaDataOrderItemsItems", "type": "object" }, "ItOrdersOrderIdApprovePostResponsesContentApplicationJsonSchemaDataOrderItemsItemsPricingDetails": { "description": "Order item pricing details", "properties": { "acquisition_type": { "$ref": "#/components/schemas/ItOrdersOrderIdApprovePostResponsesContentApplicationJsonSchemaDataOrderItemsItemsPricingDetailsAcquisitionType", "description": "Acquisition type of the order item" }, "asset_price": { "description": "Price of the order item", "oneOf": [ { "$ref": "#/components/schemas/ItOrdersOrderIdApprovePostResponsesContentApplicationJsonSchemaDataOrderItemsItemsPricingDetailsAssetPrice" }, { "type": "null" } ] }, "storefront_fee": { "description": "Storefront fee associated with the order item", "oneOf": [ { "$ref": "#/components/schemas/ItOrdersOrderIdApprovePostResponsesContentApplicationJsonSchemaDataOrderItemsItemsPricingDetailsStorefrontFee" }, { "type": "null" } ] } }, "required": [ "asset_price", "storefront_fee", "acquisition_type" ], "title": "ItOrdersOrderIdApprovePostResponsesContentApplicationJsonSchemaDataOrderItemsItemsPricingDetails", "type": "object" }, "ItOrdersOrderIdApprovePostResponsesContentApplicationJsonSchemaDataOrderItemsItemsPricingDetailsAcquisitionType": { "description": "Acquisition type of the order item", "enum": [ "PURCHASE", "RENTAL", "REUSE" ], "title": "ItOrdersOrderIdApprovePostResponsesContentApplicationJsonSchemaDataOrderItemsItemsPricingDetailsAcquisitionType", "type": "string" }, "ItOrdersOrderIdApprovePostResponsesContentApplicationJsonSchemaDataOrderItemsItemsPricingDetailsAssetPrice": { "description": "Price of the order item", "properties": { "amount": { "description": "Amount", "format": "decimal", "type": "string" }, "currency": { "$ref": "#/components/schemas/ItOrdersOrderIdApprovePostResponsesContentApplicationJsonSchemaDataOrderItemsItemsPricingDetailsAssetPriceCurrency", "description": "Three-letter currency code for the price" } }, "required": [ "amount", "currency" ], "title": "ItOrdersOrderIdApprovePostResponsesContentApplicationJsonSchemaDataOrderItemsItemsPricingDetailsAssetPrice", "type": "object" }, "ItOrdersOrderIdApprovePostResponsesContentApplicationJsonSchemaDataOrderItemsItemsPricingDetailsAssetPriceCurrency": { "description": "Three-letter currency code for the price", "enum": [ "AED", "AFN", "ALL", "AMD", "ANG", "AOA", "ARS", "AUD", "AWG", "AZN", "BAM", "BDT", "BGN", "BHD", "BIF", "BMD", "BOB", "BRL", "BSD", "BTN", "BWP", "BYN", "BZD", "CAD", "CDF", "CHF", "CLP", "CNY", "COP", "CRC", "CUC", "CVE", "CZK", "DJF", "DKK", "DOP", "DZD", "EGP", "ERN", "ETB", "EUR", "FJD", "FKP", "GBP", "GEL", "GHS", "GIP", "GMD", "GNF", "GTQ", "GYD", "HKD", "HNL", "HRK", "HTG", "HUF", "IDR", "ILS", "INR", "IQD", "IRR", "ISK", "JMD", "JOD", "JPY", "KES", "KGS", "KHR", "KMF", "KPW", "KRW", "KWD", "KYD", "KZT", "LAK", "LBP", "LKR", "LRD", "LSL", "LTL", "LYD", "MAD", "MDL", "MGA", "MKD", "MMK", "MNT", "MRU", "MUR", "MVR", "MWK", "MXN", "MYR", "MZN", "NAD", "NGN", "NIO", "NOK", "NPR", "NZD", "OMR", "PAB", "PEN", "PGK", "PHP", "PKR", "PLN", "PYG", "QAR", "RON", "RSD", "RUB", "RWF", "SAR", "SBD", "SCR", "SDG", "SEK", "SGD", "SHP", "SLL", "SOS", "SRD", "SSP", "STD", "SYP", "SZL", "THB", "TJS", "TMT", "TND", "TOP", "TRY", "TTD", "TWD", "TZS", "UAH", "UGX", "USD", "UYU", "UZS", "VEF", "VND", "VUV", "WST", "XAF", "XCD", "XOF", "XPF", "YER", "ZAR", "ZMW", "ZWD" ], "title": "ItOrdersOrderIdApprovePostResponsesContentApplicationJsonSchemaDataOrderItemsItemsPricingDetailsAssetPriceCurrency", "type": "string" }, "ItOrdersOrderIdApprovePostResponsesContentApplicationJsonSchemaDataOrderItemsItemsPricingDetailsStorefrontFee": { "description": "Storefront fee associated with the order item", "properties": { "amount": { "description": "Amount", "format": "decimal", "type": "string" }, "currency": { "$ref": "#/components/schemas/ItOrdersOrderIdApprovePostResponsesContentApplicationJsonSchemaDataOrderItemsItemsPricingDetailsStorefrontFeeCurrency", "description": "Three-letter currency code for the price" } }, "required": [ "amount", "currency" ], "title": "ItOrdersOrderIdApprovePostResponsesContentApplicationJsonSchemaDataOrderItemsItemsPricingDetailsStorefrontFee", "type": "object" }, "ItOrdersOrderIdApprovePostResponsesContentApplicationJsonSchemaDataOrderItemsItemsPricingDetailsStorefrontFeeCurrency": { "description": "Three-letter currency code for the price", "enum": [ "AED", "AFN", "ALL", "AMD", "ANG", "AOA", "ARS", "AUD", "AWG", "AZN", "BAM", "BDT", "BGN", "BHD", "BIF", "BMD", "BOB", "BRL", "BSD", "BTN", "BWP", "BYN", "BZD", "CAD", "CDF", "CHF", "CLP", "CNY", "COP", "CRC", "CUC", "CVE", "CZK", "DJF", "DKK", "DOP", "DZD", "EGP", "ERN", "ETB", "EUR", "FJD", "FKP", "GBP", "GEL", "GHS", "GIP", "GMD", "GNF", "GTQ", "GYD", "HKD", "HNL", "HRK", "HTG", "HUF", "IDR", "ILS", "INR", "IQD", "IRR", "ISK", "JMD", "JOD", "JPY", "KES", "KGS", "KHR", "KMF", "KPW", "KRW", "KWD", "KYD", "KZT", "LAK", "LBP", "LKR", "LRD", "LSL", "LTL", "LYD", "MAD", "MDL", "MGA", "MKD", "MMK", "MNT", "MRU", "MUR", "MVR", "MWK", "MXN", "MYR", "MZN", "NAD", "NGN", "NIO", "NOK", "NPR", "NZD", "OMR", "PAB", "PEN", "PGK", "PHP", "PKR", "PLN", "PYG", "QAR", "RON", "RSD", "RUB", "RWF", "SAR", "SBD", "SCR", "SDG", "SEK", "SGD", "SHP", "SLL", "SOS", "SRD", "SSP", "STD", "SYP", "SZL", "THB", "TJS", "TMT", "TND", "TOP", "TRY", "TTD", "TWD", "TZS", "UAH", "UGX", "USD", "UYU", "UZS", "VEF", "VND", "VUV", "WST", "XAF", "XCD", "XOF", "XPF", "YER", "ZAR", "ZMW", "ZWD" ], "title": "ItOrdersOrderIdApprovePostResponsesContentApplicationJsonSchemaDataOrderItemsItemsPricingDetailsStorefrontFeeCurrency", "type": "string" }, "ItOrdersOrderIdApprovePostResponsesContentApplicationJsonSchemaDataOrderItemsItemsProduct": { "description": "Product details", "properties": { "brand": { "description": "Product brand", "type": "string" }, "category": { "$ref": "#/components/schemas/ItOrdersOrderIdApprovePostResponsesContentApplicationJsonSchemaDataOrderItemsItemsProductCategory", "description": "Product category" }, "id": { "description": "Unique identifier of the product", "format": "uuid", "type": "string" }, "name": { "description": "Product name", "type": "string" } }, "required": [ "id", "name", "brand", "category" ], "title": "ItOrdersOrderIdApprovePostResponsesContentApplicationJsonSchemaDataOrderItemsItemsProduct", "type": "object" }, "ItOrdersOrderIdApprovePostResponsesContentApplicationJsonSchemaDataOrderItemsItemsProductCategory": { "description": "Product category", "enum": [ "ADAPTER", "CABLE", "CHAIR", "CHARGER", "COMPACT_DESKTOP", "DESK", "DESKTOP", "DESK_RISER", "DESK_TIDY", "DOCKING_STATION", "DONGLE", "FOOTREST", "HEADSET", "KEYBOARD", "LAPTOP", "LAPTOP_STAND", "MICE_TRACKPAD", "MOBILE_DEVICE", "MONITOR", "MONITOR_ARM", "OTHER", "PRINTER", "SHREDDER", "STANDING_MAT", "TABLET", "TASK_LIGHT", "WEBCAM", "WELCOME_PACK", "WIFI_RANGE_EXTENDER" ], "title": "ItOrdersOrderIdApprovePostResponsesContentApplicationJsonSchemaDataOrderItemsItemsProductCategory", "type": "string" }, "ItOrdersOrderIdApprovePostResponsesContentApplicationJsonSchemaDataOrderItemsItemsStatus": { "description": "Status of the order item", "enum": [ "AWAITING_PAYMENT", "CANCELLED", "COMPLETED", "PLACED", "PROCESSING", "READY_TO_SHIP", "SHIPPED" ], "title": "ItOrdersOrderIdApprovePostResponsesContentApplicationJsonSchemaDataOrderItemsItemsStatus", "type": "string" }, "ItOrdersOrderIdApprovePostResponsesContentApplicationJsonSchemaDataStatus": { "description": "Order status", "enum": [ "APPROVED", "CANCELLED", "DECLINED", "REQUESTED" ], "title": "ItOrdersOrderIdApprovePostResponsesContentApplicationJsonSchemaDataStatus", "type": "string" }, "ItOrdersOrderIdApprovePostResponsesContentApplicationJsonSchemaDataUser": { "description": "Details of the user the order is for", "properties": { "emails": { "description": "Array of user email addresses", "items": { "format": "email", "type": "string" }, "type": "array" }, "first_name": { "description": "First name of the user", "type": "string" }, "hris_profile_id": { "description": "The unique identifier of the HRIS profile of the assigned user", "format": "uuid", "type": "string" }, "last_name": { "description": "Last name of the user", "type": "string" } }, "required": [ "emails", "last_name", "first_name", "hris_profile_id" ], "title": "ItOrdersOrderIdApprovePostResponsesContentApplicationJsonSchemaDataUser", "type": "object" }, "ItOrdersOrderIdApprovePostResponsesContentApplicationJsonSchemaErrorsItems": { "properties": { "code": { "description": "Error code of the handler which produced the returned error", "type": "string" }, "field": { "description": "The field name where input validation failed", "type": [ "string", "null" ] }, "message": { "description": "Description of the returned error", "type": "string" } }, "required": [ "code", "field", "message" ], "title": "ItOrdersOrderIdApprovePostResponsesContentApplicationJsonSchemaErrorsItems", "type": "object" }, "ItOrdersOrderIdCancelPostParametersXBeta": { "default": "true", "enum": [ "true" ], "title": "ItOrdersOrderIdCancelPostParametersXBeta", "type": "string" }, "ItOrdersOrderIdCancelPostRequestBodyContentApplicationJsonSchemaData": { "properties": { "cancelled_reason": { "$ref": "#/components/schemas/ItOrdersOrderIdCancelPostRequestBodyContentApplicationJsonSchemaDataCancelledReason", "description": "Reason the order was cancelled" }, "cancelled_reason_description": { "description": "Free-text description explaining the cancellation. Required when cancelled_reason is OTHER; max 500 characters.", "maxLength": 500, "type": "string" } }, "required": [ "cancelled_reason" ], "title": "ItOrdersOrderIdCancelPostRequestBodyContentApplicationJsonSchemaData", "type": "object" }, "ItOrdersOrderIdCancelPostRequestBodyContentApplicationJsonSchemaDataCancelledReason": { "description": "Reason the order was cancelled", "enum": [ "ADDRESS_ISSUE", "DELAY_WANTED", "DUPLICATE", "ITEM_CHANGE", "NOT_NEEDED", "OTHER", "PRICE", "WRONG_WORKER" ], "title": "ItOrdersOrderIdCancelPostRequestBodyContentApplicationJsonSchemaDataCancelledReason", "type": "string" }, "ItOrdersOrderIdCancelPostResponsesContentApplicationJsonSchemaData": { "properties": { "created_at": { "description": "Creation timestamp of the order", "format": "date-time", "type": "string" }, "delivery_address": { "$ref": "#/components/schemas/ItOrdersOrderIdCancelPostResponsesContentApplicationJsonSchemaDataDeliveryAddress", "description": "Delivery address of the order" }, "id": { "description": "Unique identifier of the order", "format": "uuid", "type": "string" }, "order_items": { "description": "Order's items details", "items": { "$ref": "#/components/schemas/ItOrdersOrderIdCancelPostResponsesContentApplicationJsonSchemaDataOrderItemsItems" }, "type": "array" }, "public_id": { "description": "Public identifier of the order", "type": "string" }, "status": { "$ref": "#/components/schemas/ItOrdersOrderIdCancelPostResponsesContentApplicationJsonSchemaDataStatus", "description": "Order status" }, "updated_at": { "description": "Last update timestamp of the order", "format": "date-time", "type": "string" }, "user": { "description": "Details of the user the order is for", "oneOf": [ { "$ref": "#/components/schemas/ItOrdersOrderIdCancelPostResponsesContentApplicationJsonSchemaDataUser" }, { "type": "null" } ] } }, "required": [ "id", "user", "status", "public_id", "created_at", "updated_at", "order_items", "delivery_address" ], "title": "ItOrdersOrderIdCancelPostResponsesContentApplicationJsonSchemaData", "type": "object" }, "ItOrdersOrderIdCancelPostResponsesContentApplicationJsonSchemaDataDeliveryAddress": { "description": "Delivery address of the order", "properties": { "city": { "description": "City name", "type": [ "string", "null" ] }, "country": { "$ref": "#/components/schemas/ItOrdersOrderIdCancelPostResponsesContentApplicationJsonSchemaDataDeliveryAddressCountry", "description": "Country code" }, "date_of_birth": { "description": "Date of birth (applicable for some address types)", "format": "date", "type": [ "string", "null" ] }, "delivery_instructions": { "description": "Special instructions for deliveries", "type": [ "string", "null" ] }, "id": { "description": "Unique identifier of the address", "format": "uuid", "type": "string" }, "is_valid": { "description": "Whether the address passes validation", "type": "boolean" }, "line1": { "description": "Address line 1", "type": [ "string", "null" ] }, "line2": { "description": "Address line 2", "type": [ "string", "null" ] }, "passport_number": { "description": "Passport number (applicable for some address types)", "type": [ "string", "null" ] }, "phone_number": { "description": "Phone number", "type": [ "string", "null" ] }, "post_code": { "description": "Post code", "type": [ "string", "null" ] }, "state": { "description": "State code or name", "type": [ "string", "null" ] }, "tax_id_number": { "description": "Tax ID number (applicable for some address types)", "type": [ "string", "null" ] }, "type": { "$ref": "#/components/schemas/ItOrdersOrderIdCancelPostResponsesContentApplicationJsonSchemaDataDeliveryAddressType", "description": "Type of the address" } }, "required": [ "id", "city", "type", "line1", "line2", "state", "country", "is_valid", "post_code", "phone_number", "date_of_birth", "tax_id_number", "passport_number", "delivery_instructions" ], "title": "ItOrdersOrderIdCancelPostResponsesContentApplicationJsonSchemaDataDeliveryAddress", "type": "object" }, "ItOrdersOrderIdCancelPostResponsesContentApplicationJsonSchemaDataDeliveryAddressCountry": { "description": "Country code", "enum": [ "AD", "AE", "AF", "AG", "AI", "AL", "AM", "AN", "AO", "AQ", "AR", "AS", "AT", "AU", "AW", "AX", "AZ", "BA", "BB", "BD", "BE", "BF", "BG", "BH", "BI", "BJ", "BL", "BM", "BN", "BO", "BQ", "BR", "BS", "BT", "BV", "BW", "BY", "BZ", "CA", "CC", "CD", "CF", "CG", "CH", "CI", "CK", "CL", "CM", "CN", "CO", "CR", "CU", "CV", "CW", "CX", "CY", "CZ", "DE", "DJ", "DK", "DM", "DO", "DZ", "EC", "EE", "EG", "EH", "ER", "ES", "ET", "FI", "FJ", "FK", "FM", "FO", "FR", "GA", "GB", "GD", "GE", "GF", "GG", "GH", "GI", "GL", "GM", "GN", "GP", "GQ", "GR", "GS", "GT", "GU", "GW", "GY", "HK", "HM", "HN", "HR", "HT", "HU", "IC", "ID", "IE", "IL", "IM", "IN", "IO", "IQ", "IR", "IS", "IT", "JE", "JM", "JO", "JP", "KE", "KG", "KH", "KI", "KM", "KN", "KP", "KR", "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", "XK", "YE", "YT", "ZA", "ZM", "ZW" ], "title": "ItOrdersOrderIdCancelPostResponsesContentApplicationJsonSchemaDataDeliveryAddressCountry", "type": "string" }, "ItOrdersOrderIdCancelPostResponsesContentApplicationJsonSchemaDataDeliveryAddressType": { "description": "Type of the address", "enum": [ "BILLING", "COLLECTION", "DELIVERY", "ENTITY", "PARTIAL", "PII", "SUPPLIER" ], "title": "ItOrdersOrderIdCancelPostResponsesContentApplicationJsonSchemaDataDeliveryAddressType", "type": "string" }, "ItOrdersOrderIdCancelPostResponsesContentApplicationJsonSchemaDataOrderItemsItems": { "properties": { "created_at": { "description": "Creation timestamp of the order item", "format": "date-time", "type": "string" }, "id": { "description": "Unique identifier of the order item", "format": "uuid", "type": "string" }, "is_approved": { "description": "Is the order item approved", "type": "boolean" }, "is_express_delivery_requested": { "description": "Is express delivery requested for the order item", "type": "boolean" }, "pricing_details": { "$ref": "#/components/schemas/ItOrdersOrderIdCancelPostResponsesContentApplicationJsonSchemaDataOrderItemsItemsPricingDetails", "description": "Order item pricing details" }, "product": { "$ref": "#/components/schemas/ItOrdersOrderIdCancelPostResponsesContentApplicationJsonSchemaDataOrderItemsItemsProduct", "description": "Product details" }, "status": { "$ref": "#/components/schemas/ItOrdersOrderIdCancelPostResponsesContentApplicationJsonSchemaDataOrderItemsItemsStatus", "description": "Status of the order item" } }, "required": [ "id", "status", "product", "created_at", "is_approved", "pricing_details", "is_express_delivery_requested" ], "title": "ItOrdersOrderIdCancelPostResponsesContentApplicationJsonSchemaDataOrderItemsItems", "type": "object" }, "ItOrdersOrderIdCancelPostResponsesContentApplicationJsonSchemaDataOrderItemsItemsPricingDetails": { "description": "Order item pricing details", "properties": { "acquisition_type": { "$ref": "#/components/schemas/ItOrdersOrderIdCancelPostResponsesContentApplicationJsonSchemaDataOrderItemsItemsPricingDetailsAcquisitionType", "description": "Acquisition type of the order item" }, "asset_price": { "description": "Price of the order item", "oneOf": [ { "$ref": "#/components/schemas/ItOrdersOrderIdCancelPostResponsesContentApplicationJsonSchemaDataOrderItemsItemsPricingDetailsAssetPrice" }, { "type": "null" } ] }, "storefront_fee": { "description": "Storefront fee associated with the order item", "oneOf": [ { "$ref": "#/components/schemas/ItOrdersOrderIdCancelPostResponsesContentApplicationJsonSchemaDataOrderItemsItemsPricingDetailsStorefrontFee" }, { "type": "null" } ] } }, "required": [ "asset_price", "storefront_fee", "acquisition_type" ], "title": "ItOrdersOrderIdCancelPostResponsesContentApplicationJsonSchemaDataOrderItemsItemsPricingDetails", "type": "object" }, "ItOrdersOrderIdCancelPostResponsesContentApplicationJsonSchemaDataOrderItemsItemsPricingDetailsAcquisitionType": { "description": "Acquisition type of the order item", "enum": [ "PURCHASE", "RENTAL", "REUSE" ], "title": "ItOrdersOrderIdCancelPostResponsesContentApplicationJsonSchemaDataOrderItemsItemsPricingDetailsAcquisitionType", "type": "string" }, "ItOrdersOrderIdCancelPostResponsesContentApplicationJsonSchemaDataOrderItemsItemsPricingDetailsAssetPrice": { "description": "Price of the order item", "properties": { "amount": { "description": "Amount", "format": "decimal", "type": "string" }, "currency": { "$ref": "#/components/schemas/ItOrdersOrderIdCancelPostResponsesContentApplicationJsonSchemaDataOrderItemsItemsPricingDetailsAssetPriceCurrency", "description": "Three-letter currency code for the price" } }, "required": [ "amount", "currency" ], "title": "ItOrdersOrderIdCancelPostResponsesContentApplicationJsonSchemaDataOrderItemsItemsPricingDetailsAssetPrice", "type": "object" }, "ItOrdersOrderIdCancelPostResponsesContentApplicationJsonSchemaDataOrderItemsItemsPricingDetailsAssetPriceCurrency": { "description": "Three-letter currency code for the price", "enum": [ "AED", "AFN", "ALL", "AMD", "ANG", "AOA", "ARS", "AUD", "AWG", "AZN", "BAM", "BDT", "BGN", "BHD", "BIF", "BMD", "BOB", "BRL", "BSD", "BTN", "BWP", "BYN", "BZD", "CAD", "CDF", "CHF", "CLP", "CNY", "COP", "CRC", "CUC", "CVE", "CZK", "DJF", "DKK", "DOP", "DZD", "EGP", "ERN", "ETB", "EUR", "FJD", "FKP", "GBP", "GEL", "GHS", "GIP", "GMD", "GNF", "GTQ", "GYD", "HKD", "HNL", "HRK", "HTG", "HUF", "IDR", "ILS", "INR", "IQD", "IRR", "ISK", "JMD", "JOD", "JPY", "KES", "KGS", "KHR", "KMF", "KPW", "KRW", "KWD", "KYD", "KZT", "LAK", "LBP", "LKR", "LRD", "LSL", "LTL", "LYD", "MAD", "MDL", "MGA", "MKD", "MMK", "MNT", "MRU", "MUR", "MVR", "MWK", "MXN", "MYR", "MZN", "NAD", "NGN", "NIO", "NOK", "NPR", "NZD", "OMR", "PAB", "PEN", "PGK", "PHP", "PKR", "PLN", "PYG", "QAR", "RON", "RSD", "RUB", "RWF", "SAR", "SBD", "SCR", "SDG", "SEK", "SGD", "SHP", "SLL", "SOS", "SRD", "SSP", "STD", "SYP", "SZL", "THB", "TJS", "TMT", "TND", "TOP", "TRY", "TTD", "TWD", "TZS", "UAH", "UGX", "USD", "UYU", "UZS", "VEF", "VND", "VUV", "WST", "XAF", "XCD", "XOF", "XPF", "YER", "ZAR", "ZMW", "ZWD" ], "title": "ItOrdersOrderIdCancelPostResponsesContentApplicationJsonSchemaDataOrderItemsItemsPricingDetailsAssetPriceCurrency", "type": "string" }, "ItOrdersOrderIdCancelPostResponsesContentApplicationJsonSchemaDataOrderItemsItemsPricingDetailsStorefrontFee": { "description": "Storefront fee associated with the order item", "properties": { "amount": { "description": "Amount", "format": "decimal", "type": "string" }, "currency": { "$ref": "#/components/schemas/ItOrdersOrderIdCancelPostResponsesContentApplicationJsonSchemaDataOrderItemsItemsPricingDetailsStorefrontFeeCurrency", "description": "Three-letter currency code for the price" } }, "required": [ "amount", "currency" ], "title": "ItOrdersOrderIdCancelPostResponsesContentApplicationJsonSchemaDataOrderItemsItemsPricingDetailsStorefrontFee", "type": "object" }, "ItOrdersOrderIdCancelPostResponsesContentApplicationJsonSchemaDataOrderItemsItemsPricingDetailsStorefrontFeeCurrency": { "description": "Three-letter currency code for the price", "enum": [ "AED", "AFN", "ALL", "AMD", "ANG", "AOA", "ARS", "AUD", "AWG", "AZN", "BAM", "BDT", "BGN", "BHD", "BIF", "BMD", "BOB", "BRL", "BSD", "BTN", "BWP", "BYN", "BZD", "CAD", "CDF", "CHF", "CLP", "CNY", "COP", "CRC", "CUC", "CVE", "CZK", "DJF", "DKK", "DOP", "DZD", "EGP", "ERN", "ETB", "EUR", "FJD", "FKP", "GBP", "GEL", "GHS", "GIP", "GMD", "GNF", "GTQ", "GYD", "HKD", "HNL", "HRK", "HTG", "HUF", "IDR", "ILS", "INR", "IQD", "IRR", "ISK", "JMD", "JOD", "JPY", "KES", "KGS", "KHR", "KMF", "KPW", "KRW", "KWD", "KYD", "KZT", "LAK", "LBP", "LKR", "LRD", "LSL", "LTL", "LYD", "MAD", "MDL", "MGA", "MKD", "MMK", "MNT", "MRU", "MUR", "MVR", "MWK", "MXN", "MYR", "MZN", "NAD", "NGN", "NIO", "NOK", "NPR", "NZD", "OMR", "PAB", "PEN", "PGK", "PHP", "PKR", "PLN", "PYG", "QAR", "RON", "RSD", "RUB", "RWF", "SAR", "SBD", "SCR", "SDG", "SEK", "SGD", "SHP", "SLL", "SOS", "SRD", "SSP", "STD", "SYP", "SZL", "THB", "TJS", "TMT", "TND", "TOP", "TRY", "TTD", "TWD", "TZS", "UAH", "UGX", "USD", "UYU", "UZS", "VEF", "VND", "VUV", "WST", "XAF", "XCD", "XOF", "XPF", "YER", "ZAR", "ZMW", "ZWD" ], "title": "ItOrdersOrderIdCancelPostResponsesContentApplicationJsonSchemaDataOrderItemsItemsPricingDetailsStorefrontFeeCurrency", "type": "string" }, "ItOrdersOrderIdCancelPostResponsesContentApplicationJsonSchemaDataOrderItemsItemsProduct": { "description": "Product details", "properties": { "brand": { "description": "Product brand", "type": "string" }, "category": { "$ref": "#/components/schemas/ItOrdersOrderIdCancelPostResponsesContentApplicationJsonSchemaDataOrderItemsItemsProductCategory", "description": "Product category" }, "id": { "description": "Unique identifier of the product", "format": "uuid", "type": "string" }, "name": { "description": "Product name", "type": "string" } }, "required": [ "id", "name", "brand", "category" ], "title": "ItOrdersOrderIdCancelPostResponsesContentApplicationJsonSchemaDataOrderItemsItemsProduct", "type": "object" }, "ItOrdersOrderIdCancelPostResponsesContentApplicationJsonSchemaDataOrderItemsItemsProductCategory": { "description": "Product category", "enum": [ "ADAPTER", "CABLE", "CHAIR", "CHARGER", "COMPACT_DESKTOP", "DESK", "DESKTOP", "DESK_RISER", "DESK_TIDY", "DOCKING_STATION", "DONGLE", "FOOTREST", "HEADSET", "KEYBOARD", "LAPTOP", "LAPTOP_STAND", "MICE_TRACKPAD", "MOBILE_DEVICE", "MONITOR", "MONITOR_ARM", "OTHER", "PRINTER", "SHREDDER", "STANDING_MAT", "TABLET", "TASK_LIGHT", "WEBCAM", "WELCOME_PACK", "WIFI_RANGE_EXTENDER" ], "title": "ItOrdersOrderIdCancelPostResponsesContentApplicationJsonSchemaDataOrderItemsItemsProductCategory", "type": "string" }, "ItOrdersOrderIdCancelPostResponsesContentApplicationJsonSchemaDataOrderItemsItemsStatus": { "description": "Status of the order item", "enum": [ "AWAITING_PAYMENT", "CANCELLED", "COMPLETED", "PLACED", "PROCESSING", "READY_TO_SHIP", "SHIPPED" ], "title": "ItOrdersOrderIdCancelPostResponsesContentApplicationJsonSchemaDataOrderItemsItemsStatus", "type": "string" }, "ItOrdersOrderIdCancelPostResponsesContentApplicationJsonSchemaDataStatus": { "description": "Order status", "enum": [ "APPROVED", "CANCELLED", "DECLINED", "REQUESTED" ], "title": "ItOrdersOrderIdCancelPostResponsesContentApplicationJsonSchemaDataStatus", "type": "string" }, "ItOrdersOrderIdCancelPostResponsesContentApplicationJsonSchemaDataUser": { "description": "Details of the user the order is for", "properties": { "emails": { "description": "Array of user email addresses", "items": { "format": "email", "type": "string" }, "type": "array" }, "first_name": { "description": "First name of the user", "type": "string" }, "hris_profile_id": { "description": "The unique identifier of the HRIS profile of the assigned user", "format": "uuid", "type": "string" }, "last_name": { "description": "Last name of the user", "type": "string" } }, "required": [ "emails", "last_name", "first_name", "hris_profile_id" ], "title": "ItOrdersOrderIdCancelPostResponsesContentApplicationJsonSchemaDataUser", "type": "object" }, "ItOrdersOrderIdCancelPostResponsesContentApplicationJsonSchemaErrorsItems": { "properties": { "code": { "description": "Error code of the handler which produced the returned error", "type": "string" }, "field": { "description": "The field name where input validation failed", "type": [ "string", "null" ] }, "message": { "description": "Description of the returned error", "type": "string" } }, "required": [ "code", "field", "message" ], "title": "ItOrdersOrderIdCancelPostResponsesContentApplicationJsonSchemaErrorsItems", "type": "object" }, "ItOrdersOrderIdDeclinePostParametersXBeta": { "default": "true", "enum": [ "true" ], "title": "ItOrdersOrderIdDeclinePostParametersXBeta", "type": "string" }, "ItOrdersOrderIdDeclinePostResponsesContentApplicationJsonSchemaData": { "properties": { "created_at": { "description": "Creation timestamp of the order", "format": "date-time", "type": "string" }, "delivery_address": { "$ref": "#/components/schemas/ItOrdersOrderIdDeclinePostResponsesContentApplicationJsonSchemaDataDeliveryAddress", "description": "Delivery address of the order" }, "id": { "description": "Unique identifier of the order", "format": "uuid", "type": "string" }, "order_items": { "description": "Order's items details", "items": { "$ref": "#/components/schemas/ItOrdersOrderIdDeclinePostResponsesContentApplicationJsonSchemaDataOrderItemsItems" }, "type": "array" }, "public_id": { "description": "Public identifier of the order", "type": "string" }, "status": { "$ref": "#/components/schemas/ItOrdersOrderIdDeclinePostResponsesContentApplicationJsonSchemaDataStatus", "description": "Order status" }, "updated_at": { "description": "Last update timestamp of the order", "format": "date-time", "type": "string" }, "user": { "description": "Details of the user the order is for", "oneOf": [ { "$ref": "#/components/schemas/ItOrdersOrderIdDeclinePostResponsesContentApplicationJsonSchemaDataUser" }, { "type": "null" } ] } }, "required": [ "id", "user", "status", "public_id", "created_at", "updated_at", "order_items", "delivery_address" ], "title": "ItOrdersOrderIdDeclinePostResponsesContentApplicationJsonSchemaData", "type": "object" }, "ItOrdersOrderIdDeclinePostResponsesContentApplicationJsonSchemaDataDeliveryAddress": { "description": "Delivery address of the order", "properties": { "city": { "description": "City name", "type": [ "string", "null" ] }, "country": { "$ref": "#/components/schemas/ItOrdersOrderIdDeclinePostResponsesContentApplicationJsonSchemaDataDeliveryAddressCountry", "description": "Country code" }, "date_of_birth": { "description": "Date of birth (applicable for some address types)", "format": "date", "type": [ "string", "null" ] }, "delivery_instructions": { "description": "Special instructions for deliveries", "type": [ "string", "null" ] }, "id": { "description": "Unique identifier of the address", "format": "uuid", "type": "string" }, "is_valid": { "description": "Whether the address passes validation", "type": "boolean" }, "line1": { "description": "Address line 1", "type": [ "string", "null" ] }, "line2": { "description": "Address line 2", "type": [ "string", "null" ] }, "passport_number": { "description": "Passport number (applicable for some address types)", "type": [ "string", "null" ] }, "phone_number": { "description": "Phone number", "type": [ "string", "null" ] }, "post_code": { "description": "Post code", "type": [ "string", "null" ] }, "state": { "description": "State code or name", "type": [ "string", "null" ] }, "tax_id_number": { "description": "Tax ID number (applicable for some address types)", "type": [ "string", "null" ] }, "type": { "$ref": "#/components/schemas/ItOrdersOrderIdDeclinePostResponsesContentApplicationJsonSchemaDataDeliveryAddressType", "description": "Type of the address" } }, "required": [ "id", "city", "type", "line1", "line2", "state", "country", "is_valid", "post_code", "phone_number", "date_of_birth", "tax_id_number", "passport_number", "delivery_instructions" ], "title": "ItOrdersOrderIdDeclinePostResponsesContentApplicationJsonSchemaDataDeliveryAddress", "type": "object" }, "ItOrdersOrderIdDeclinePostResponsesContentApplicationJsonSchemaDataDeliveryAddressCountry": { "description": "Country code", "enum": [ "AD", "AE", "AF", "AG", "AI", "AL", "AM", "AN", "AO", "AQ", "AR", "AS", "AT", "AU", "AW", "AX", "AZ", "BA", "BB", "BD", "BE", "BF", "BG", "BH", "BI", "BJ", "BL", "BM", "BN", "BO", "BQ", "BR", "BS", "BT", "BV", "BW", "BY", "BZ", "CA", "CC", "CD", "CF", "CG", "CH", "CI", "CK", "CL", "CM", "CN", "CO", "CR", "CU", "CV", "CW", "CX", "CY", "CZ", "DE", "DJ", "DK", "DM", "DO", "DZ", "EC", "EE", "EG", "EH", "ER", "ES", "ET", "FI", "FJ", "FK", "FM", "FO", "FR", "GA", "GB", "GD", "GE", "GF", "GG", "GH", "GI", "GL", "GM", "GN", "GP", "GQ", "GR", "GS", "GT", "GU", "GW", "GY", "HK", "HM", "HN", "HR", "HT", "HU", "IC", "ID", "IE", "IL", "IM", "IN", "IO", "IQ", "IR", "IS", "IT", "JE", "JM", "JO", "JP", "KE", "KG", "KH", "KI", "KM", "KN", "KP", "KR", "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", "XK", "YE", "YT", "ZA", "ZM", "ZW" ], "title": "ItOrdersOrderIdDeclinePostResponsesContentApplicationJsonSchemaDataDeliveryAddressCountry", "type": "string" }, "ItOrdersOrderIdDeclinePostResponsesContentApplicationJsonSchemaDataDeliveryAddressType": { "description": "Type of the address", "enum": [ "BILLING", "COLLECTION", "DELIVERY", "ENTITY", "PARTIAL", "PII", "SUPPLIER" ], "title": "ItOrdersOrderIdDeclinePostResponsesContentApplicationJsonSchemaDataDeliveryAddressType", "type": "string" }, "ItOrdersOrderIdDeclinePostResponsesContentApplicationJsonSchemaDataOrderItemsItems": { "properties": { "created_at": { "description": "Creation timestamp of the order item", "format": "date-time", "type": "string" }, "id": { "description": "Unique identifier of the order item", "format": "uuid", "type": "string" }, "is_approved": { "description": "Is the order item approved", "type": "boolean" }, "is_express_delivery_requested": { "description": "Is express delivery requested for the order item", "type": "boolean" }, "pricing_details": { "$ref": "#/components/schemas/ItOrdersOrderIdDeclinePostResponsesContentApplicationJsonSchemaDataOrderItemsItemsPricingDetails", "description": "Order item pricing details" }, "product": { "$ref": "#/components/schemas/ItOrdersOrderIdDeclinePostResponsesContentApplicationJsonSchemaDataOrderItemsItemsProduct", "description": "Product details" }, "status": { "$ref": "#/components/schemas/ItOrdersOrderIdDeclinePostResponsesContentApplicationJsonSchemaDataOrderItemsItemsStatus", "description": "Status of the order item" } }, "required": [ "id", "status", "product", "created_at", "is_approved", "pricing_details", "is_express_delivery_requested" ], "title": "ItOrdersOrderIdDeclinePostResponsesContentApplicationJsonSchemaDataOrderItemsItems", "type": "object" }, "ItOrdersOrderIdDeclinePostResponsesContentApplicationJsonSchemaDataOrderItemsItemsPricingDetails": { "description": "Order item pricing details", "properties": { "acquisition_type": { "$ref": "#/components/schemas/ItOrdersOrderIdDeclinePostResponsesContentApplicationJsonSchemaDataOrderItemsItemsPricingDetailsAcquisitionType", "description": "Acquisition type of the order item" }, "asset_price": { "description": "Price of the order item", "oneOf": [ { "$ref": "#/components/schemas/ItOrdersOrderIdDeclinePostResponsesContentApplicationJsonSchemaDataOrderItemsItemsPricingDetailsAssetPrice" }, { "type": "null" } ] }, "storefront_fee": { "description": "Storefront fee associated with the order item", "oneOf": [ { "$ref": "#/components/schemas/ItOrdersOrderIdDeclinePostResponsesContentApplicationJsonSchemaDataOrderItemsItemsPricingDetailsStorefrontFee" }, { "type": "null" } ] } }, "required": [ "asset_price", "storefront_fee", "acquisition_type" ], "title": "ItOrdersOrderIdDeclinePostResponsesContentApplicationJsonSchemaDataOrderItemsItemsPricingDetails", "type": "object" }, "ItOrdersOrderIdDeclinePostResponsesContentApplicationJsonSchemaDataOrderItemsItemsPricingDetailsAcquisitionType": { "description": "Acquisition type of the order item", "enum": [ "PURCHASE", "RENTAL", "REUSE" ], "title": "ItOrdersOrderIdDeclinePostResponsesContentApplicationJsonSchemaDataOrderItemsItemsPricingDetailsAcquisitionType", "type": "string" }, "ItOrdersOrderIdDeclinePostResponsesContentApplicationJsonSchemaDataOrderItemsItemsPricingDetailsAssetPrice": { "description": "Price of the order item", "properties": { "amount": { "description": "Amount", "format": "decimal", "type": "string" }, "currency": { "$ref": "#/components/schemas/ItOrdersOrderIdDeclinePostResponsesContentApplicationJsonSchemaDataOrderItemsItemsPricingDetailsAssetPriceCurrency", "description": "Three-letter currency code for the price" } }, "required": [ "amount", "currency" ], "title": "ItOrdersOrderIdDeclinePostResponsesContentApplicationJsonSchemaDataOrderItemsItemsPricingDetailsAssetPrice", "type": "object" }, "ItOrdersOrderIdDeclinePostResponsesContentApplicationJsonSchemaDataOrderItemsItemsPricingDetailsAssetPriceCurrency": { "description": "Three-letter currency code for the price", "enum": [ "AED", "AFN", "ALL", "AMD", "ANG", "AOA", "ARS", "AUD", "AWG", "AZN", "BAM", "BDT", "BGN", "BHD", "BIF", "BMD", "BOB", "BRL", "BSD", "BTN", "BWP", "BYN", "BZD", "CAD", "CDF", "CHF", "CLP", "CNY", "COP", "CRC", "CUC", "CVE", "CZK", "DJF", "DKK", "DOP", "DZD", "EGP", "ERN", "ETB", "EUR", "FJD", "FKP", "GBP", "GEL", "GHS", "GIP", "GMD", "GNF", "GTQ", "GYD", "HKD", "HNL", "HRK", "HTG", "HUF", "IDR", "ILS", "INR", "IQD", "IRR", "ISK", "JMD", "JOD", "JPY", "KES", "KGS", "KHR", "KMF", "KPW", "KRW", "KWD", "KYD", "KZT", "LAK", "LBP", "LKR", "LRD", "LSL", "LTL", "LYD", "MAD", "MDL", "MGA", "MKD", "MMK", "MNT", "MRU", "MUR", "MVR", "MWK", "MXN", "MYR", "MZN", "NAD", "NGN", "NIO", "NOK", "NPR", "NZD", "OMR", "PAB", "PEN", "PGK", "PHP", "PKR", "PLN", "PYG", "QAR", "RON", "RSD", "RUB", "RWF", "SAR", "SBD", "SCR", "SDG", "SEK", "SGD", "SHP", "SLL", "SOS", "SRD", "SSP", "STD", "SYP", "SZL", "THB", "TJS", "TMT", "TND", "TOP", "TRY", "TTD", "TWD", "TZS", "UAH", "UGX", "USD", "UYU", "UZS", "VEF", "VND", "VUV", "WST", "XAF", "XCD", "XOF", "XPF", "YER", "ZAR", "ZMW", "ZWD" ], "title": "ItOrdersOrderIdDeclinePostResponsesContentApplicationJsonSchemaDataOrderItemsItemsPricingDetailsAssetPriceCurrency", "type": "string" }, "ItOrdersOrderIdDeclinePostResponsesContentApplicationJsonSchemaDataOrderItemsItemsPricingDetailsStorefrontFee": { "description": "Storefront fee associated with the order item", "properties": { "amount": { "description": "Amount", "format": "decimal", "type": "string" }, "currency": { "$ref": "#/components/schemas/ItOrdersOrderIdDeclinePostResponsesContentApplicationJsonSchemaDataOrderItemsItemsPricingDetailsStorefrontFeeCurrency", "description": "Three-letter currency code for the price" } }, "required": [ "amount", "currency" ], "title": "ItOrdersOrderIdDeclinePostResponsesContentApplicationJsonSchemaDataOrderItemsItemsPricingDetailsStorefrontFee", "type": "object" }, "ItOrdersOrderIdDeclinePostResponsesContentApplicationJsonSchemaDataOrderItemsItemsPricingDetailsStorefrontFeeCurrency": { "description": "Three-letter currency code for the price", "enum": [ "AED", "AFN", "ALL", "AMD", "ANG", "AOA", "ARS", "AUD", "AWG", "AZN", "BAM", "BDT", "BGN", "BHD", "BIF", "BMD", "BOB", "BRL", "BSD", "BTN", "BWP", "BYN", "BZD", "CAD", "CDF", "CHF", "CLP", "CNY", "COP", "CRC", "CUC", "CVE", "CZK", "DJF", "DKK", "DOP", "DZD", "EGP", "ERN", "ETB", "EUR", "FJD", "FKP", "GBP", "GEL", "GHS", "GIP", "GMD", "GNF", "GTQ", "GYD", "HKD", "HNL", "HRK", "HTG", "HUF", "IDR", "ILS", "INR", "IQD", "IRR", "ISK", "JMD", "JOD", "JPY", "KES", "KGS", "KHR", "KMF", "KPW", "KRW", "KWD", "KYD", "KZT", "LAK", "LBP", "LKR", "LRD", "LSL", "LTL", "LYD", "MAD", "MDL", "MGA", "MKD", "MMK", "MNT", "MRU", "MUR", "MVR", "MWK", "MXN", "MYR", "MZN", "NAD", "NGN", "NIO", "NOK", "NPR", "NZD", "OMR", "PAB", "PEN", "PGK", "PHP", "PKR", "PLN", "PYG", "QAR", "RON", "RSD", "RUB", "RWF", "SAR", "SBD", "SCR", "SDG", "SEK", "SGD", "SHP", "SLL", "SOS", "SRD", "SSP", "STD", "SYP", "SZL", "THB", "TJS", "TMT", "TND", "TOP", "TRY", "TTD", "TWD", "TZS", "UAH", "UGX", "USD", "UYU", "UZS", "VEF", "VND", "VUV", "WST", "XAF", "XCD", "XOF", "XPF", "YER", "ZAR", "ZMW", "ZWD" ], "title": "ItOrdersOrderIdDeclinePostResponsesContentApplicationJsonSchemaDataOrderItemsItemsPricingDetailsStorefrontFeeCurrency", "type": "string" }, "ItOrdersOrderIdDeclinePostResponsesContentApplicationJsonSchemaDataOrderItemsItemsProduct": { "description": "Product details", "properties": { "brand": { "description": "Product brand", "type": "string" }, "category": { "$ref": "#/components/schemas/ItOrdersOrderIdDeclinePostResponsesContentApplicationJsonSchemaDataOrderItemsItemsProductCategory", "description": "Product category" }, "id": { "description": "Unique identifier of the product", "format": "uuid", "type": "string" }, "name": { "description": "Product name", "type": "string" } }, "required": [ "id", "name", "brand", "category" ], "title": "ItOrdersOrderIdDeclinePostResponsesContentApplicationJsonSchemaDataOrderItemsItemsProduct", "type": "object" }, "ItOrdersOrderIdDeclinePostResponsesContentApplicationJsonSchemaDataOrderItemsItemsProductCategory": { "description": "Product category", "enum": [ "ADAPTER", "CABLE", "CHAIR", "CHARGER", "COMPACT_DESKTOP", "DESK", "DESKTOP", "DESK_RISER", "DESK_TIDY", "DOCKING_STATION", "DONGLE", "FOOTREST", "HEADSET", "KEYBOARD", "LAPTOP", "LAPTOP_STAND", "MICE_TRACKPAD", "MOBILE_DEVICE", "MONITOR", "MONITOR_ARM", "OTHER", "PRINTER", "SHREDDER", "STANDING_MAT", "TABLET", "TASK_LIGHT", "WEBCAM", "WELCOME_PACK", "WIFI_RANGE_EXTENDER" ], "title": "ItOrdersOrderIdDeclinePostResponsesContentApplicationJsonSchemaDataOrderItemsItemsProductCategory", "type": "string" }, "ItOrdersOrderIdDeclinePostResponsesContentApplicationJsonSchemaDataOrderItemsItemsStatus": { "description": "Status of the order item", "enum": [ "AWAITING_PAYMENT", "CANCELLED", "COMPLETED", "PLACED", "PROCESSING", "READY_TO_SHIP", "SHIPPED" ], "title": "ItOrdersOrderIdDeclinePostResponsesContentApplicationJsonSchemaDataOrderItemsItemsStatus", "type": "string" }, "ItOrdersOrderIdDeclinePostResponsesContentApplicationJsonSchemaDataStatus": { "description": "Order status", "enum": [ "APPROVED", "CANCELLED", "DECLINED", "REQUESTED" ], "title": "ItOrdersOrderIdDeclinePostResponsesContentApplicationJsonSchemaDataStatus", "type": "string" }, "ItOrdersOrderIdDeclinePostResponsesContentApplicationJsonSchemaDataUser": { "description": "Details of the user the order is for", "properties": { "emails": { "description": "Array of user email addresses", "items": { "format": "email", "type": "string" }, "type": "array" }, "first_name": { "description": "First name of the user", "type": "string" }, "hris_profile_id": { "description": "The unique identifier of the HRIS profile of the assigned user", "format": "uuid", "type": "string" }, "last_name": { "description": "Last name of the user", "type": "string" } }, "required": [ "emails", "last_name", "first_name", "hris_profile_id" ], "title": "ItOrdersOrderIdDeclinePostResponsesContentApplicationJsonSchemaDataUser", "type": "object" }, "ItOrdersOrderIdDeclinePostResponsesContentApplicationJsonSchemaErrorsItems": { "properties": { "code": { "description": "Error code of the handler which produced the returned error", "type": "string" }, "field": { "description": "The field name where input validation failed", "type": [ "string", "null" ] }, "message": { "description": "Description of the returned error", "type": "string" } }, "required": [ "code", "field", "message" ], "title": "ItOrdersOrderIdDeclinePostResponsesContentApplicationJsonSchemaErrorsItems", "type": "object" }, "ItOrdersOrderIdGetResponsesContentApplicationJsonSchemaData": { "properties": { "created_at": { "description": "Creation timestamp of the order", "format": "date-time", "type": "string" }, "delivery_address": { "$ref": "#/components/schemas/ItOrdersOrderIdGetResponsesContentApplicationJsonSchemaDataDeliveryAddress", "description": "Order delivery address details" }, "id": { "description": "Unique identifier of the order", "format": "uuid", "type": "string" }, "order_items": { "description": "Order's items details", "items": { "$ref": "#/components/schemas/ItOrdersOrderIdGetResponsesContentApplicationJsonSchemaDataOrderItemsItems" }, "type": "array" }, "public_id": { "description": "Public identifier of the order", "type": "string" }, "status": { "$ref": "#/components/schemas/ItOrdersOrderIdGetResponsesContentApplicationJsonSchemaDataStatus", "description": "Order status" }, "updated_at": { "description": "Last update timestamp of the order", "format": "date-time", "type": "string" }, "user": { "description": "Details of the user with asset possession", "oneOf": [ { "$ref": "#/components/schemas/ItOrdersOrderIdGetResponsesContentApplicationJsonSchemaDataUser" }, { "type": "null" } ] } }, "required": [ "id", "user", "status", "public_id", "created_at", "updated_at", "order_items", "delivery_address" ], "title": "ItOrdersOrderIdGetResponsesContentApplicationJsonSchemaData", "type": "object" }, "ItOrdersOrderIdGetResponsesContentApplicationJsonSchemaDataDeliveryAddress": { "description": "Order delivery address details", "properties": { "city": { "description": "City name", "type": [ "string", "null" ] }, "country": { "$ref": "#/components/schemas/ItOrdersOrderIdGetResponsesContentApplicationJsonSchemaDataDeliveryAddressCountry", "description": "Country code" }, "date_of_birth": { "description": "Date of birth (applicable for some address types)", "format": "date", "type": [ "string", "null" ] }, "delivery_instructions": { "description": "Special instructions for deliveries", "type": [ "string", "null" ] }, "id": { "description": "Unique identifier of the address", "format": "uuid", "type": "string" }, "is_valid": { "description": "Whether the address passes validation", "type": "boolean" }, "line1": { "description": "Address line 1", "type": [ "string", "null" ] }, "line2": { "description": "Address line 2", "type": [ "string", "null" ] }, "passport_number": { "description": "Passport number (applicable for some address types)", "type": [ "string", "null" ] }, "phone_number": { "description": "Phone number", "type": [ "string", "null" ] }, "post_code": { "description": "Post code", "type": [ "string", "null" ] }, "state": { "description": "State code or name", "type": [ "string", "null" ] }, "tax_id_number": { "description": "Tax ID number (applicable for some address types)", "type": [ "string", "null" ] }, "type": { "$ref": "#/components/schemas/ItOrdersOrderIdGetResponsesContentApplicationJsonSchemaDataDeliveryAddressType", "description": "Type of the address" } }, "required": [ "id", "city", "type", "line1", "line2", "state", "country", "is_valid", "post_code", "phone_number", "date_of_birth", "tax_id_number", "passport_number", "delivery_instructions" ], "title": "ItOrdersOrderIdGetResponsesContentApplicationJsonSchemaDataDeliveryAddress", "type": "object" }, "ItOrdersOrderIdGetResponsesContentApplicationJsonSchemaDataDeliveryAddressCountry": { "description": "Country code", "enum": [ "AD", "AE", "AF", "AG", "AI", "AL", "AM", "AN", "AO", "AQ", "AR", "AS", "AT", "AU", "AW", "AX", "AZ", "BA", "BB", "BD", "BE", "BF", "BG", "BH", "BI", "BJ", "BL", "BM", "BN", "BO", "BQ", "BR", "BS", "BT", "BV", "BW", "BY", "BZ", "CA", "CC", "CD", "CF", "CG", "CH", "CI", "CK", "CL", "CM", "CN", "CO", "CR", "CU", "CV", "CW", "CX", "CY", "CZ", "DE", "DJ", "DK", "DM", "DO", "DZ", "EC", "EE", "EG", "EH", "ER", "ES", "ET", "FI", "FJ", "FK", "FM", "FO", "FR", "GA", "GB", "GD", "GE", "GF", "GG", "GH", "GI", "GL", "GM", "GN", "GP", "GQ", "GR", "GS", "GT", "GU", "GW", "GY", "HK", "HM", "HN", "HR", "HT", "HU", "IC", "ID", "IE", "IL", "IM", "IN", "IO", "IQ", "IR", "IS", "IT", "JE", "JM", "JO", "JP", "KE", "KG", "KH", "KI", "KM", "KN", "KP", "KR", "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", "XK", "YE", "YT", "ZA", "ZM", "ZW" ], "title": "ItOrdersOrderIdGetResponsesContentApplicationJsonSchemaDataDeliveryAddressCountry", "type": "string" }, "ItOrdersOrderIdGetResponsesContentApplicationJsonSchemaDataDeliveryAddressType": { "description": "Type of the address", "enum": [ "BILLING", "COLLECTION", "DELIVERY", "ENTITY", "PARTIAL", "PII", "SUPPLIER" ], "title": "ItOrdersOrderIdGetResponsesContentApplicationJsonSchemaDataDeliveryAddressType", "type": "string" }, "ItOrdersOrderIdGetResponsesContentApplicationJsonSchemaDataOrderItemsItems": { "properties": { "created_at": { "description": "Creation timestamp of the order item", "format": "date-time", "type": "string" }, "id": { "description": "Unique identifier of the order item", "format": "uuid", "type": "string" }, "is_approved": { "description": "Is the order item approved", "type": "boolean" }, "is_express_delivery_requested": { "description": "Is express delivery requested for the order item", "type": "boolean" }, "pricing_details": { "$ref": "#/components/schemas/ItOrdersOrderIdGetResponsesContentApplicationJsonSchemaDataOrderItemsItemsPricingDetails", "description": "Order item pricing details" }, "product": { "$ref": "#/components/schemas/ItOrdersOrderIdGetResponsesContentApplicationJsonSchemaDataOrderItemsItemsProduct", "description": "Product details" }, "status": { "$ref": "#/components/schemas/ItOrdersOrderIdGetResponsesContentApplicationJsonSchemaDataOrderItemsItemsStatus", "description": "Status of the order item" } }, "required": [ "id", "status", "product", "created_at", "is_approved", "pricing_details", "is_express_delivery_requested" ], "title": "ItOrdersOrderIdGetResponsesContentApplicationJsonSchemaDataOrderItemsItems", "type": "object" }, "ItOrdersOrderIdGetResponsesContentApplicationJsonSchemaDataOrderItemsItemsPricingDetails": { "description": "Order item pricing details", "properties": { "acquisition_type": { "$ref": "#/components/schemas/ItOrdersOrderIdGetResponsesContentApplicationJsonSchemaDataOrderItemsItemsPricingDetailsAcquisitionType", "description": "Acquisition type of the order item" }, "asset_price": { "description": "Price of the order item", "oneOf": [ { "$ref": "#/components/schemas/ItOrdersOrderIdGetResponsesContentApplicationJsonSchemaDataOrderItemsItemsPricingDetailsAssetPrice" }, { "type": "null" } ] }, "storefront_fee": { "description": "Storefront fee associated with the order item", "oneOf": [ { "$ref": "#/components/schemas/ItOrdersOrderIdGetResponsesContentApplicationJsonSchemaDataOrderItemsItemsPricingDetailsStorefrontFee" }, { "type": "null" } ] } }, "required": [ "asset_price", "storefront_fee", "acquisition_type" ], "title": "ItOrdersOrderIdGetResponsesContentApplicationJsonSchemaDataOrderItemsItemsPricingDetails", "type": "object" }, "ItOrdersOrderIdGetResponsesContentApplicationJsonSchemaDataOrderItemsItemsPricingDetailsAcquisitionType": { "description": "Acquisition type of the order item", "enum": [ "PURCHASE", "RENTAL", "REUSE" ], "title": "ItOrdersOrderIdGetResponsesContentApplicationJsonSchemaDataOrderItemsItemsPricingDetailsAcquisitionType", "type": "string" }, "ItOrdersOrderIdGetResponsesContentApplicationJsonSchemaDataOrderItemsItemsPricingDetailsAssetPrice": { "description": "Price of the order item", "properties": { "amount": { "description": "Amount", "format": "decimal", "type": "string" }, "currency": { "$ref": "#/components/schemas/ItOrdersOrderIdGetResponsesContentApplicationJsonSchemaDataOrderItemsItemsPricingDetailsAssetPriceCurrency", "description": "Three-letter currency code for the price" } }, "required": [ "amount", "currency" ], "title": "ItOrdersOrderIdGetResponsesContentApplicationJsonSchemaDataOrderItemsItemsPricingDetailsAssetPrice", "type": "object" }, "ItOrdersOrderIdGetResponsesContentApplicationJsonSchemaDataOrderItemsItemsPricingDetailsAssetPriceCurrency": { "description": "Three-letter currency code for the price", "enum": [ "AED", "AFN", "ALL", "AMD", "ANG", "AOA", "ARS", "AUD", "AWG", "AZN", "BAM", "BDT", "BGN", "BHD", "BIF", "BMD", "BOB", "BRL", "BSD", "BTN", "BWP", "BYN", "BZD", "CAD", "CDF", "CHF", "CLP", "CNY", "COP", "CRC", "CUC", "CVE", "CZK", "DJF", "DKK", "DOP", "DZD", "EGP", "ERN", "ETB", "EUR", "FJD", "FKP", "GBP", "GEL", "GHS", "GIP", "GMD", "GNF", "GTQ", "GYD", "HKD", "HNL", "HRK", "HTG", "HUF", "IDR", "ILS", "INR", "IQD", "IRR", "ISK", "JMD", "JOD", "JPY", "KES", "KGS", "KHR", "KMF", "KPW", "KRW", "KWD", "KYD", "KZT", "LAK", "LBP", "LKR", "LRD", "LSL", "LTL", "LYD", "MAD", "MDL", "MGA", "MKD", "MMK", "MNT", "MRU", "MUR", "MVR", "MWK", "MXN", "MYR", "MZN", "NAD", "NGN", "NIO", "NOK", "NPR", "NZD", "OMR", "PAB", "PEN", "PGK", "PHP", "PKR", "PLN", "PYG", "QAR", "RON", "RSD", "RUB", "RWF", "SAR", "SBD", "SCR", "SDG", "SEK", "SGD", "SHP", "SLL", "SOS", "SRD", "SSP", "STD", "SYP", "SZL", "THB", "TJS", "TMT", "TND", "TOP", "TRY", "TTD", "TWD", "TZS", "UAH", "UGX", "USD", "UYU", "UZS", "VEF", "VND", "VUV", "WST", "XAF", "XCD", "XOF", "XPF", "YER", "ZAR", "ZMW", "ZWD" ], "title": "ItOrdersOrderIdGetResponsesContentApplicationJsonSchemaDataOrderItemsItemsPricingDetailsAssetPriceCurrency", "type": "string" }, "ItOrdersOrderIdGetResponsesContentApplicationJsonSchemaDataOrderItemsItemsPricingDetailsStorefrontFee": { "description": "Storefront fee associated with the order item", "properties": { "amount": { "description": "Amount", "format": "decimal", "type": "string" }, "currency": { "$ref": "#/components/schemas/ItOrdersOrderIdGetResponsesContentApplicationJsonSchemaDataOrderItemsItemsPricingDetailsStorefrontFeeCurrency", "description": "Three-letter currency code for the price" } }, "required": [ "amount", "currency" ], "title": "ItOrdersOrderIdGetResponsesContentApplicationJsonSchemaDataOrderItemsItemsPricingDetailsStorefrontFee", "type": "object" }, "ItOrdersOrderIdGetResponsesContentApplicationJsonSchemaDataOrderItemsItemsPricingDetailsStorefrontFeeCurrency": { "description": "Three-letter currency code for the price", "enum": [ "AED", "AFN", "ALL", "AMD", "ANG", "AOA", "ARS", "AUD", "AWG", "AZN", "BAM", "BDT", "BGN", "BHD", "BIF", "BMD", "BOB", "BRL", "BSD", "BTN", "BWP", "BYN", "BZD", "CAD", "CDF", "CHF", "CLP", "CNY", "COP", "CRC", "CUC", "CVE", "CZK", "DJF", "DKK", "DOP", "DZD", "EGP", "ERN", "ETB", "EUR", "FJD", "FKP", "GBP", "GEL", "GHS", "GIP", "GMD", "GNF", "GTQ", "GYD", "HKD", "HNL", "HRK", "HTG", "HUF", "IDR", "ILS", "INR", "IQD", "IRR", "ISK", "JMD", "JOD", "JPY", "KES", "KGS", "KHR", "KMF", "KPW", "KRW", "KWD", "KYD", "KZT", "LAK", "LBP", "LKR", "LRD", "LSL", "LTL", "LYD", "MAD", "MDL", "MGA", "MKD", "MMK", "MNT", "MRU", "MUR", "MVR", "MWK", "MXN", "MYR", "MZN", "NAD", "NGN", "NIO", "NOK", "NPR", "NZD", "OMR", "PAB", "PEN", "PGK", "PHP", "PKR", "PLN", "PYG", "QAR", "RON", "RSD", "RUB", "RWF", "SAR", "SBD", "SCR", "SDG", "SEK", "SGD", "SHP", "SLL", "SOS", "SRD", "SSP", "STD", "SYP", "SZL", "THB", "TJS", "TMT", "TND", "TOP", "TRY", "TTD", "TWD", "TZS", "UAH", "UGX", "USD", "UYU", "UZS", "VEF", "VND", "VUV", "WST", "XAF", "XCD", "XOF", "XPF", "YER", "ZAR", "ZMW", "ZWD" ], "title": "ItOrdersOrderIdGetResponsesContentApplicationJsonSchemaDataOrderItemsItemsPricingDetailsStorefrontFeeCurrency", "type": "string" }, "ItOrdersOrderIdGetResponsesContentApplicationJsonSchemaDataOrderItemsItemsProduct": { "description": "Product details", "properties": { "brand": { "description": "Product brand", "type": "string" }, "category": { "$ref": "#/components/schemas/ItOrdersOrderIdGetResponsesContentApplicationJsonSchemaDataOrderItemsItemsProductCategory", "description": "Product category" }, "id": { "description": "Unique identifier of the product", "format": "uuid", "type": "string" }, "name": { "description": "Product name", "type": "string" } }, "required": [ "id", "name", "brand", "category" ], "title": "ItOrdersOrderIdGetResponsesContentApplicationJsonSchemaDataOrderItemsItemsProduct", "type": "object" }, "ItOrdersOrderIdGetResponsesContentApplicationJsonSchemaDataOrderItemsItemsProductCategory": { "description": "Product category", "enum": [ "ADAPTER", "CABLE", "CHAIR", "CHARGER", "COMPACT_DESKTOP", "DESK", "DESKTOP", "DESK_RISER", "DESK_TIDY", "DOCKING_STATION", "DONGLE", "FOOTREST", "HEADSET", "KEYBOARD", "LAPTOP", "LAPTOP_STAND", "MICE_TRACKPAD", "MOBILE_DEVICE", "MONITOR", "MONITOR_ARM", "OTHER", "PRINTER", "SHREDDER", "STANDING_MAT", "TABLET", "TASK_LIGHT", "WEBCAM", "WELCOME_PACK", "WIFI_RANGE_EXTENDER" ], "title": "ItOrdersOrderIdGetResponsesContentApplicationJsonSchemaDataOrderItemsItemsProductCategory", "type": "string" }, "ItOrdersOrderIdGetResponsesContentApplicationJsonSchemaDataOrderItemsItemsStatus": { "description": "Status of the order item", "enum": [ "AWAITING_PAYMENT", "CANCELLED", "COMPLETED", "PLACED", "PROCESSING", "READY_TO_SHIP", "SHIPPED" ], "title": "ItOrdersOrderIdGetResponsesContentApplicationJsonSchemaDataOrderItemsItemsStatus", "type": "string" }, "ItOrdersOrderIdGetResponsesContentApplicationJsonSchemaDataStatus": { "description": "Order status", "enum": [ "APPROVED", "CANCELLED", "DECLINED", "REQUESTED" ], "title": "ItOrdersOrderIdGetResponsesContentApplicationJsonSchemaDataStatus", "type": "string" }, "ItOrdersOrderIdGetResponsesContentApplicationJsonSchemaDataUser": { "description": "Details of the user with asset possession", "properties": { "address": { "$ref": "#/components/schemas/ItOrdersOrderIdGetResponsesContentApplicationJsonSchemaDataUserAddress", "description": "User address details" }, "emails": { "description": "Array of user email addresses", "items": { "format": "email", "type": "string" }, "type": "array" }, "first_name": { "description": "First name of the user", "type": "string" }, "hris_profile_id": { "description": "The unique identifier of the HRIS profile of the assigned user", "format": "uuid", "type": "string" }, "last_name": { "description": "Last name of the user", "type": "string" } }, "required": [ "emails", "address", "last_name", "first_name", "hris_profile_id" ], "title": "ItOrdersOrderIdGetResponsesContentApplicationJsonSchemaDataUser", "type": "object" }, "ItOrdersOrderIdGetResponsesContentApplicationJsonSchemaDataUserAddress": { "description": "User address details", "properties": { "city": { "description": "City name", "type": [ "string", "null" ] }, "country": { "$ref": "#/components/schemas/ItOrdersOrderIdGetResponsesContentApplicationJsonSchemaDataUserAddressCountry", "description": "Country code" }, "date_of_birth": { "description": "Date of birth (applicable for some address types)", "format": "date", "type": [ "string", "null" ] }, "delivery_instructions": { "description": "Special instructions for deliveries", "type": [ "string", "null" ] }, "id": { "description": "Unique identifier of the address", "format": "uuid", "type": "string" }, "is_valid": { "description": "Whether the address passes validation", "type": "boolean" }, "line1": { "description": "Address line 1", "type": [ "string", "null" ] }, "line2": { "description": "Address line 2", "type": [ "string", "null" ] }, "passport_number": { "description": "Passport number (applicable for some address types)", "type": [ "string", "null" ] }, "phone_number": { "description": "Phone number", "type": [ "string", "null" ] }, "post_code": { "description": "Post code", "type": [ "string", "null" ] }, "state": { "description": "State code or name", "type": [ "string", "null" ] }, "tax_id_number": { "description": "Tax ID number (applicable for some address types)", "type": [ "string", "null" ] }, "type": { "$ref": "#/components/schemas/ItOrdersOrderIdGetResponsesContentApplicationJsonSchemaDataUserAddressType", "description": "Type of the address" } }, "required": [ "id", "city", "type", "line1", "line2", "state", "country", "is_valid", "post_code", "phone_number", "date_of_birth", "tax_id_number", "passport_number", "delivery_instructions" ], "title": "ItOrdersOrderIdGetResponsesContentApplicationJsonSchemaDataUserAddress", "type": "object" }, "ItOrdersOrderIdGetResponsesContentApplicationJsonSchemaDataUserAddressCountry": { "description": "Country code", "enum": [ "AD", "AE", "AF", "AG", "AI", "AL", "AM", "AN", "AO", "AQ", "AR", "AS", "AT", "AU", "AW", "AX", "AZ", "BA", "BB", "BD", "BE", "BF", "BG", "BH", "BI", "BJ", "BL", "BM", "BN", "BO", "BQ", "BR", "BS", "BT", "BV", "BW", "BY", "BZ", "CA", "CC", "CD", "CF", "CG", "CH", "CI", "CK", "CL", "CM", "CN", "CO", "CR", "CU", "CV", "CW", "CX", "CY", "CZ", "DE", "DJ", "DK", "DM", "DO", "DZ", "EC", "EE", "EG", "EH", "ER", "ES", "ET", "FI", "FJ", "FK", "FM", "FO", "FR", "GA", "GB", "GD", "GE", "GF", "GG", "GH", "GI", "GL", "GM", "GN", "GP", "GQ", "GR", "GS", "GT", "GU", "GW", "GY", "HK", "HM", "HN", "HR", "HT", "HU", "IC", "ID", "IE", "IL", "IM", "IN", "IO", "IQ", "IR", "IS", "IT", "JE", "JM", "JO", "JP", "KE", "KG", "KH", "KI", "KM", "KN", "KP", "KR", "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", "XK", "YE", "YT", "ZA", "ZM", "ZW" ], "title": "ItOrdersOrderIdGetResponsesContentApplicationJsonSchemaDataUserAddressCountry", "type": "string" }, "ItOrdersOrderIdGetResponsesContentApplicationJsonSchemaDataUserAddressType": { "description": "Type of the address", "enum": [ "BILLING", "COLLECTION", "DELIVERY", "ENTITY", "PARTIAL", "PII", "SUPPLIER" ], "title": "ItOrdersOrderIdGetResponsesContentApplicationJsonSchemaDataUserAddressType", "type": "string" }, "ItOrdersOrderIdGetResponsesContentApplicationJsonSchemaErrorsItems": { "properties": { "code": { "description": "Error code of the handler which produced the returned error", "type": "string" }, "field": { "description": "The field name where input validation failed", "type": [ "string", "null" ] }, "message": { "description": "Description of the returned error", "type": "string" } }, "required": [ "code", "field", "message" ], "title": "ItOrdersOrderIdGetResponsesContentApplicationJsonSchemaErrorsItems", "type": "object" }, "ItOrdersPostParametersXBeta": { "default": "true", "enum": [ "true" ], "title": "ItOrdersPostParametersXBeta", "type": "string" }, "ItOrdersPostRequestBodyContentApplicationJsonSchemaData": { "properties": { "destination": { "$ref": "#/components/schemas/ItOrdersPostRequestBodyContentApplicationJsonSchemaDataDestination", "description": "Where the order goes" }, "is_express_delivery_requested": { "description": "Whether express delivery was requested for this order", "type": "boolean" }, "variants": { "description": "One entry per item to order", "items": { "$ref": "#/components/schemas/ItOrdersPostRequestBodyContentApplicationJsonSchemaDataVariantsItems" }, "type": "array" } }, "required": [ "variants", "destination", "is_express_delivery_requested" ], "title": "ItOrdersPostRequestBodyContentApplicationJsonSchemaData", "type": "object" }, "ItOrdersPostRequestBodyContentApplicationJsonSchemaDataDestination": { "description": "Where the order goes", "properties": { "assign_to": { "$ref": "#/components/schemas/ItOrdersPostRequestBodyContentApplicationJsonSchemaDataDestinationAssignTo", "description": "Who the ordered items are assigned to" }, "delivery_address": { "$ref": "#/components/schemas/ItOrdersPostRequestBodyContentApplicationJsonSchemaDataDestinationDeliveryAddress", "description": "Delivery address for the order" }, "hris_profile_id": { "description": "HRIS profile that will receive the order", "format": "uuid", "type": "string" } }, "required": [ "assign_to", "hris_profile_id", "delivery_address" ], "title": "ItOrdersPostRequestBodyContentApplicationJsonSchemaDataDestination", "type": "object" }, "ItOrdersPostRequestBodyContentApplicationJsonSchemaDataDestinationAssignTo": { "description": "Who the ordered items are assigned to", "enum": [ "USER" ], "title": "ItOrdersPostRequestBodyContentApplicationJsonSchemaDataDestinationAssignTo", "type": "string" }, "ItOrdersPostRequestBodyContentApplicationJsonSchemaDataDestinationDeliveryAddress": { "description": "Delivery address for the order", "properties": { "city": { "description": "City name", "type": "string" }, "country": { "$ref": "#/components/schemas/ItOrdersPostRequestBodyContentApplicationJsonSchemaDataDestinationDeliveryAddressCountry", "description": "Country code (ISO 3166 alpha-2)" }, "date_of_birth": { "description": "Date of birth", "format": "date", "type": "string" }, "delivery_instructions": { "description": "Delivery instructions for the courier", "type": "string" }, "line1": { "description": "Address line 1", "type": "string" }, "line2": { "description": "Address line 2", "type": "string" }, "passport_number": { "description": "Passport number", "type": "string" }, "phone_number": { "description": "Phone number in E.164 format", "type": "string" }, "post_code": { "description": "Post code", "type": "string" }, "state": { "description": "State or region name", "type": "string" }, "tax_id_number": { "description": "Tax ID number", "type": "string" } }, "required": [ "country" ], "title": "ItOrdersPostRequestBodyContentApplicationJsonSchemaDataDestinationDeliveryAddress", "type": "object" }, "ItOrdersPostRequestBodyContentApplicationJsonSchemaDataDestinationDeliveryAddressCountry": { "description": "Country code (ISO 3166 alpha-2)", "enum": [ "AD", "AE", "AF", "AG", "AI", "AL", "AM", "AN", "AO", "AQ", "AR", "AS", "AT", "AU", "AW", "AX", "AZ", "BA", "BB", "BD", "BE", "BF", "BG", "BH", "BI", "BJ", "BL", "BM", "BN", "BO", "BQ", "BR", "BS", "BT", "BV", "BW", "BY", "BZ", "CA", "CC", "CD", "CF", "CG", "CH", "CI", "CK", "CL", "CM", "CN", "CO", "CR", "CU", "CV", "CW", "CX", "CY", "CZ", "DE", "DJ", "DK", "DM", "DO", "DZ", "EC", "EE", "EG", "EH", "ER", "ES", "ET", "FI", "FJ", "FK", "FM", "FO", "FR", "GA", "GB", "GD", "GE", "GF", "GG", "GH", "GI", "GL", "GM", "GN", "GP", "GQ", "GR", "GS", "GT", "GU", "GW", "GY", "HK", "HM", "HN", "HR", "HT", "HU", "IC", "ID", "IE", "IL", "IM", "IN", "IO", "IQ", "IR", "IS", "IT", "JE", "JM", "JO", "JP", "KE", "KG", "KH", "KI", "KM", "KN", "KP", "KR", "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", "XK", "YE", "YT", "ZA", "ZM", "ZW" ], "title": "ItOrdersPostRequestBodyContentApplicationJsonSchemaDataDestinationDeliveryAddressCountry", "type": "string" }, "ItOrdersPostRequestBodyContentApplicationJsonSchemaDataVariantsItems": { "properties": { "contract_setting": { "$ref": "#/components/schemas/ItOrdersPostRequestBodyContentApplicationJsonSchemaDataVariantsItemsContractSetting", "description": "Contract terms — acquisition type, rental term, payment schema, and addons" }, "is_preconfig_requested": { "description": "Whether preconfiguration was requested for the delivered device", "type": "boolean" }, "variant_id": { "description": "Variant of the product to order", "format": "uuid", "type": "string" } }, "required": [ "variant_id", "contract_setting" ], "title": "ItOrdersPostRequestBodyContentApplicationJsonSchemaDataVariantsItems", "type": "object" }, "ItOrdersPostRequestBodyContentApplicationJsonSchemaDataVariantsItemsContractSetting": { "description": "Contract terms — acquisition type, rental term, payment schema, and addons", "properties": { "acquisition_type": { "$ref": "#/components/schemas/ItOrdersPostRequestBodyContentApplicationJsonSchemaDataVariantsItemsContractSettingAcquisitionType", "description": "How the equipment is acquired" }, "addons": { "description": "Addon bundles attached to this contract. At most two entries — one service + one warranty. Server derives the type from each `addon_id`.", "items": { "$ref": "#/components/schemas/ItOrdersPostRequestBodyContentApplicationJsonSchemaDataVariantsItemsContractSettingAddonsItems" }, "type": "array" }, "payment_schema": { "$ref": "#/components/schemas/ItOrdersPostRequestBodyContentApplicationJsonSchemaDataVariantsItemsContractSettingPaymentSchema", "description": "How the equipment is billed. Required for rentals, ignored for purchases (always upfront)." }, "rental_term": { "$ref": "#/components/schemas/ItOrdersPostRequestBodyContentApplicationJsonSchemaDataVariantsItemsContractSettingRentalTerm", "description": "Rental term length. Required for rentals, ignored otherwise." } }, "required": [ "addons", "acquisition_type" ], "title": "ItOrdersPostRequestBodyContentApplicationJsonSchemaDataVariantsItemsContractSetting", "type": "object" }, "ItOrdersPostRequestBodyContentApplicationJsonSchemaDataVariantsItemsContractSettingAcquisitionType": { "description": "How the equipment is acquired", "enum": [ "PURCHASE", "RENTAL", "REUSE" ], "title": "ItOrdersPostRequestBodyContentApplicationJsonSchemaDataVariantsItemsContractSettingAcquisitionType", "type": "string" }, "ItOrdersPostRequestBodyContentApplicationJsonSchemaDataVariantsItemsContractSettingAddonsItems": { "properties": { "addon_id": { "description": "Unique identifier of the addon bundle. Callers pick these from\n`available_addons[]` on `GET /products/{id}`.", "format": "uuid", "type": "string" }, "duration_months": { "description": "Bundle duration in months. Service bundles only; nil for warranties and one-off addons.", "format": "int64", "type": "integer" }, "payment_schema": { "$ref": "#/components/schemas/ItOrdersPostRequestBodyContentApplicationJsonSchemaDataVariantsItemsContractSettingAddonsItemsPaymentSchema", "description": "How the addon is billed. Omit to accept the default schema for the bundle." } }, "required": [ "addon_id" ], "title": "ItOrdersPostRequestBodyContentApplicationJsonSchemaDataVariantsItemsContractSettingAddonsItems", "type": "object" }, "ItOrdersPostRequestBodyContentApplicationJsonSchemaDataVariantsItemsContractSettingAddonsItemsPaymentSchema": { "description": "How the addon is billed. Omit to accept the default schema for the bundle.", "enum": [ "MONTHLY", "UPFRONT" ], "title": "ItOrdersPostRequestBodyContentApplicationJsonSchemaDataVariantsItemsContractSettingAddonsItemsPaymentSchema", "type": "string" }, "ItOrdersPostRequestBodyContentApplicationJsonSchemaDataVariantsItemsContractSettingPaymentSchema": { "description": "How the equipment is billed. Required for rentals, ignored for purchases (always upfront).", "enum": [ "MONTHLY", "UPFRONT" ], "title": "ItOrdersPostRequestBodyContentApplicationJsonSchemaDataVariantsItemsContractSettingPaymentSchema", "type": "string" }, "ItOrdersPostRequestBodyContentApplicationJsonSchemaDataVariantsItemsContractSettingRentalTerm": { "description": "Rental term length. Required for rentals, ignored otherwise.", "enum": [ "MONTH_12", "MONTH_24" ], "title": "ItOrdersPostRequestBodyContentApplicationJsonSchemaDataVariantsItemsContractSettingRentalTerm", "type": "string" }, "ItOrdersPostResponsesContentApplicationJsonSchemaData": { "properties": { "created_at": { "description": "Creation timestamp of the order", "format": "date-time", "type": "string" }, "delivery_address": { "$ref": "#/components/schemas/ItOrdersPostResponsesContentApplicationJsonSchemaDataDeliveryAddress", "description": "Delivery address of the order" }, "id": { "description": "Unique identifier of the order", "format": "uuid", "type": "string" }, "order_items": { "description": "Order's items details", "items": { "$ref": "#/components/schemas/ItOrdersPostResponsesContentApplicationJsonSchemaDataOrderItemsItems" }, "type": "array" }, "public_id": { "description": "Public identifier of the order", "type": "string" }, "status": { "$ref": "#/components/schemas/ItOrdersPostResponsesContentApplicationJsonSchemaDataStatus", "description": "Order status" }, "updated_at": { "description": "Last update timestamp of the order", "format": "date-time", "type": "string" }, "user": { "description": "Details of the user the order is for", "oneOf": [ { "$ref": "#/components/schemas/ItOrdersPostResponsesContentApplicationJsonSchemaDataUser" }, { "type": "null" } ] } }, "required": [ "id", "user", "status", "public_id", "created_at", "updated_at", "order_items", "delivery_address" ], "title": "ItOrdersPostResponsesContentApplicationJsonSchemaData", "type": "object" }, "ItOrdersPostResponsesContentApplicationJsonSchemaDataDeliveryAddress": { "description": "Delivery address of the order", "properties": { "city": { "description": "City name", "type": [ "string", "null" ] }, "country": { "$ref": "#/components/schemas/ItOrdersPostResponsesContentApplicationJsonSchemaDataDeliveryAddressCountry", "description": "Country code" }, "date_of_birth": { "description": "Date of birth (applicable for some address types)", "format": "date", "type": [ "string", "null" ] }, "delivery_instructions": { "description": "Special instructions for deliveries", "type": [ "string", "null" ] }, "id": { "description": "Unique identifier of the address", "format": "uuid", "type": "string" }, "is_valid": { "description": "Whether the address passes validation", "type": "boolean" }, "line1": { "description": "Address line 1", "type": [ "string", "null" ] }, "line2": { "description": "Address line 2", "type": [ "string", "null" ] }, "passport_number": { "description": "Passport number (applicable for some address types)", "type": [ "string", "null" ] }, "phone_number": { "description": "Phone number", "type": [ "string", "null" ] }, "post_code": { "description": "Post code", "type": [ "string", "null" ] }, "state": { "description": "State code or name", "type": [ "string", "null" ] }, "tax_id_number": { "description": "Tax ID number (applicable for some address types)", "type": [ "string", "null" ] }, "type": { "$ref": "#/components/schemas/ItOrdersPostResponsesContentApplicationJsonSchemaDataDeliveryAddressType", "description": "Type of the address" } }, "required": [ "id", "city", "type", "line1", "line2", "state", "country", "is_valid", "post_code", "phone_number", "date_of_birth", "tax_id_number", "passport_number", "delivery_instructions" ], "title": "ItOrdersPostResponsesContentApplicationJsonSchemaDataDeliveryAddress", "type": "object" }, "ItOrdersPostResponsesContentApplicationJsonSchemaDataDeliveryAddressCountry": { "description": "Country code", "enum": [ "AD", "AE", "AF", "AG", "AI", "AL", "AM", "AN", "AO", "AQ", "AR", "AS", "AT", "AU", "AW", "AX", "AZ", "BA", "BB", "BD", "BE", "BF", "BG", "BH", "BI", "BJ", "BL", "BM", "BN", "BO", "BQ", "BR", "BS", "BT", "BV", "BW", "BY", "BZ", "CA", "CC", "CD", "CF", "CG", "CH", "CI", "CK", "CL", "CM", "CN", "CO", "CR", "CU", "CV", "CW", "CX", "CY", "CZ", "DE", "DJ", "DK", "DM", "DO", "DZ", "EC", "EE", "EG", "EH", "ER", "ES", "ET", "FI", "FJ", "FK", "FM", "FO", "FR", "GA", "GB", "GD", "GE", "GF", "GG", "GH", "GI", "GL", "GM", "GN", "GP", "GQ", "GR", "GS", "GT", "GU", "GW", "GY", "HK", "HM", "HN", "HR", "HT", "HU", "IC", "ID", "IE", "IL", "IM", "IN", "IO", "IQ", "IR", "IS", "IT", "JE", "JM", "JO", "JP", "KE", "KG", "KH", "KI", "KM", "KN", "KP", "KR", "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", "XK", "YE", "YT", "ZA", "ZM", "ZW" ], "title": "ItOrdersPostResponsesContentApplicationJsonSchemaDataDeliveryAddressCountry", "type": "string" }, "ItOrdersPostResponsesContentApplicationJsonSchemaDataDeliveryAddressType": { "description": "Type of the address", "enum": [ "BILLING", "COLLECTION", "DELIVERY", "ENTITY", "PARTIAL", "PII", "SUPPLIER" ], "title": "ItOrdersPostResponsesContentApplicationJsonSchemaDataDeliveryAddressType", "type": "string" }, "ItOrdersPostResponsesContentApplicationJsonSchemaDataOrderItemsItems": { "properties": { "created_at": { "description": "Creation timestamp of the order item", "format": "date-time", "type": "string" }, "id": { "description": "Unique identifier of the order item", "format": "uuid", "type": "string" }, "is_approved": { "description": "Is the order item approved", "type": "boolean" }, "is_express_delivery_requested": { "description": "Is express delivery requested for the order item", "type": "boolean" }, "pricing_details": { "$ref": "#/components/schemas/ItOrdersPostResponsesContentApplicationJsonSchemaDataOrderItemsItemsPricingDetails", "description": "Order item pricing details" }, "product": { "$ref": "#/components/schemas/ItOrdersPostResponsesContentApplicationJsonSchemaDataOrderItemsItemsProduct", "description": "Product details" }, "status": { "$ref": "#/components/schemas/ItOrdersPostResponsesContentApplicationJsonSchemaDataOrderItemsItemsStatus", "description": "Status of the order item" } }, "required": [ "id", "status", "product", "created_at", "is_approved", "pricing_details", "is_express_delivery_requested" ], "title": "ItOrdersPostResponsesContentApplicationJsonSchemaDataOrderItemsItems", "type": "object" }, "ItOrdersPostResponsesContentApplicationJsonSchemaDataOrderItemsItemsPricingDetails": { "description": "Order item pricing details", "properties": { "acquisition_type": { "$ref": "#/components/schemas/ItOrdersPostResponsesContentApplicationJsonSchemaDataOrderItemsItemsPricingDetailsAcquisitionType", "description": "Acquisition type of the order item" }, "asset_price": { "description": "Price of the order item", "oneOf": [ { "$ref": "#/components/schemas/ItOrdersPostResponsesContentApplicationJsonSchemaDataOrderItemsItemsPricingDetailsAssetPrice" }, { "type": "null" } ] }, "storefront_fee": { "description": "Storefront fee associated with the order item", "oneOf": [ { "$ref": "#/components/schemas/ItOrdersPostResponsesContentApplicationJsonSchemaDataOrderItemsItemsPricingDetailsStorefrontFee" }, { "type": "null" } ] } }, "required": [ "asset_price", "storefront_fee", "acquisition_type" ], "title": "ItOrdersPostResponsesContentApplicationJsonSchemaDataOrderItemsItemsPricingDetails", "type": "object" }, "ItOrdersPostResponsesContentApplicationJsonSchemaDataOrderItemsItemsPricingDetailsAcquisitionType": { "description": "Acquisition type of the order item", "enum": [ "PURCHASE", "RENTAL", "REUSE" ], "title": "ItOrdersPostResponsesContentApplicationJsonSchemaDataOrderItemsItemsPricingDetailsAcquisitionType", "type": "string" }, "ItOrdersPostResponsesContentApplicationJsonSchemaDataOrderItemsItemsPricingDetailsAssetPrice": { "description": "Price of the order item", "properties": { "amount": { "description": "Amount", "format": "decimal", "type": "string" }, "currency": { "$ref": "#/components/schemas/ItOrdersPostResponsesContentApplicationJsonSchemaDataOrderItemsItemsPricingDetailsAssetPriceCurrency", "description": "Three-letter currency code for the price" } }, "required": [ "amount", "currency" ], "title": "ItOrdersPostResponsesContentApplicationJsonSchemaDataOrderItemsItemsPricingDetailsAssetPrice", "type": "object" }, "ItOrdersPostResponsesContentApplicationJsonSchemaDataOrderItemsItemsPricingDetailsAssetPriceCurrency": { "description": "Three-letter currency code for the price", "enum": [ "AED", "AFN", "ALL", "AMD", "ANG", "AOA", "ARS", "AUD", "AWG", "AZN", "BAM", "BDT", "BGN", "BHD", "BIF", "BMD", "BOB", "BRL", "BSD", "BTN", "BWP", "BYN", "BZD", "CAD", "CDF", "CHF", "CLP", "CNY", "COP", "CRC", "CUC", "CVE", "CZK", "DJF", "DKK", "DOP", "DZD", "EGP", "ERN", "ETB", "EUR", "FJD", "FKP", "GBP", "GEL", "GHS", "GIP", "GMD", "GNF", "GTQ", "GYD", "HKD", "HNL", "HRK", "HTG", "HUF", "IDR", "ILS", "INR", "IQD", "IRR", "ISK", "JMD", "JOD", "JPY", "KES", "KGS", "KHR", "KMF", "KPW", "KRW", "KWD", "KYD", "KZT", "LAK", "LBP", "LKR", "LRD", "LSL", "LTL", "LYD", "MAD", "MDL", "MGA", "MKD", "MMK", "MNT", "MRU", "MUR", "MVR", "MWK", "MXN", "MYR", "MZN", "NAD", "NGN", "NIO", "NOK", "NPR", "NZD", "OMR", "PAB", "PEN", "PGK", "PHP", "PKR", "PLN", "PYG", "QAR", "RON", "RSD", "RUB", "RWF", "SAR", "SBD", "SCR", "SDG", "SEK", "SGD", "SHP", "SLL", "SOS", "SRD", "SSP", "STD", "SYP", "SZL", "THB", "TJS", "TMT", "TND", "TOP", "TRY", "TTD", "TWD", "TZS", "UAH", "UGX", "USD", "UYU", "UZS", "VEF", "VND", "VUV", "WST", "XAF", "XCD", "XOF", "XPF", "YER", "ZAR", "ZMW", "ZWD" ], "title": "ItOrdersPostResponsesContentApplicationJsonSchemaDataOrderItemsItemsPricingDetailsAssetPriceCurrency", "type": "string" }, "ItOrdersPostResponsesContentApplicationJsonSchemaDataOrderItemsItemsPricingDetailsStorefrontFee": { "description": "Storefront fee associated with the order item", "properties": { "amount": { "description": "Amount", "format": "decimal", "type": "string" }, "currency": { "$ref": "#/components/schemas/ItOrdersPostResponsesContentApplicationJsonSchemaDataOrderItemsItemsPricingDetailsStorefrontFeeCurrency", "description": "Three-letter currency code for the price" } }, "required": [ "amount", "currency" ], "title": "ItOrdersPostResponsesContentApplicationJsonSchemaDataOrderItemsItemsPricingDetailsStorefrontFee", "type": "object" }, "ItOrdersPostResponsesContentApplicationJsonSchemaDataOrderItemsItemsPricingDetailsStorefrontFeeCurrency": { "description": "Three-letter currency code for the price", "enum": [ "AED", "AFN", "ALL", "AMD", "ANG", "AOA", "ARS", "AUD", "AWG", "AZN", "BAM", "BDT", "BGN", "BHD", "BIF", "BMD", "BOB", "BRL", "BSD", "BTN", "BWP", "BYN", "BZD", "CAD", "CDF", "CHF", "CLP", "CNY", "COP", "CRC", "CUC", "CVE", "CZK", "DJF", "DKK", "DOP", "DZD", "EGP", "ERN", "ETB", "EUR", "FJD", "FKP", "GBP", "GEL", "GHS", "GIP", "GMD", "GNF", "GTQ", "GYD", "HKD", "HNL", "HRK", "HTG", "HUF", "IDR", "ILS", "INR", "IQD", "IRR", "ISK", "JMD", "JOD", "JPY", "KES", "KGS", "KHR", "KMF", "KPW", "KRW", "KWD", "KYD", "KZT", "LAK", "LBP", "LKR", "LRD", "LSL", "LTL", "LYD", "MAD", "MDL", "MGA", "MKD", "MMK", "MNT", "MRU", "MUR", "MVR", "MWK", "MXN", "MYR", "MZN", "NAD", "NGN", "NIO", "NOK", "NPR", "NZD", "OMR", "PAB", "PEN", "PGK", "PHP", "PKR", "PLN", "PYG", "QAR", "RON", "RSD", "RUB", "RWF", "SAR", "SBD", "SCR", "SDG", "SEK", "SGD", "SHP", "SLL", "SOS", "SRD", "SSP", "STD", "SYP", "SZL", "THB", "TJS", "TMT", "TND", "TOP", "TRY", "TTD", "TWD", "TZS", "UAH", "UGX", "USD", "UYU", "UZS", "VEF", "VND", "VUV", "WST", "XAF", "XCD", "XOF", "XPF", "YER", "ZAR", "ZMW", "ZWD" ], "title": "ItOrdersPostResponsesContentApplicationJsonSchemaDataOrderItemsItemsPricingDetailsStorefrontFeeCurrency", "type": "string" }, "ItOrdersPostResponsesContentApplicationJsonSchemaDataOrderItemsItemsProduct": { "description": "Product details", "properties": { "brand": { "description": "Product brand", "type": "string" }, "category": { "$ref": "#/components/schemas/ItOrdersPostResponsesContentApplicationJsonSchemaDataOrderItemsItemsProductCategory", "description": "Product category" }, "id": { "description": "Unique identifier of the product", "format": "uuid", "type": "string" }, "name": { "description": "Product name", "type": "string" } }, "required": [ "id", "name", "brand", "category" ], "title": "ItOrdersPostResponsesContentApplicationJsonSchemaDataOrderItemsItemsProduct", "type": "object" }, "ItOrdersPostResponsesContentApplicationJsonSchemaDataOrderItemsItemsProductCategory": { "description": "Product category", "enum": [ "ADAPTER", "CABLE", "CHAIR", "CHARGER", "COMPACT_DESKTOP", "DESK", "DESKTOP", "DESK_RISER", "DESK_TIDY", "DOCKING_STATION", "DONGLE", "FOOTREST", "HEADSET", "KEYBOARD", "LAPTOP", "LAPTOP_STAND", "MICE_TRACKPAD", "MOBILE_DEVICE", "MONITOR", "MONITOR_ARM", "OTHER", "PRINTER", "SHREDDER", "STANDING_MAT", "TABLET", "TASK_LIGHT", "WEBCAM", "WELCOME_PACK", "WIFI_RANGE_EXTENDER" ], "title": "ItOrdersPostResponsesContentApplicationJsonSchemaDataOrderItemsItemsProductCategory", "type": "string" }, "ItOrdersPostResponsesContentApplicationJsonSchemaDataOrderItemsItemsStatus": { "description": "Status of the order item", "enum": [ "AWAITING_PAYMENT", "CANCELLED", "COMPLETED", "PLACED", "PROCESSING", "READY_TO_SHIP", "SHIPPED" ], "title": "ItOrdersPostResponsesContentApplicationJsonSchemaDataOrderItemsItemsStatus", "type": "string" }, "ItOrdersPostResponsesContentApplicationJsonSchemaDataStatus": { "description": "Order status", "enum": [ "APPROVED", "CANCELLED", "DECLINED", "REQUESTED" ], "title": "ItOrdersPostResponsesContentApplicationJsonSchemaDataStatus", "type": "string" }, "ItOrdersPostResponsesContentApplicationJsonSchemaDataUser": { "description": "Details of the user the order is for", "properties": { "emails": { "description": "Array of user email addresses", "items": { "format": "email", "type": "string" }, "type": "array" }, "first_name": { "description": "First name of the user", "type": "string" }, "hris_profile_id": { "description": "The unique identifier of the HRIS profile of the assigned user", "format": "uuid", "type": "string" }, "last_name": { "description": "Last name of the user", "type": "string" } }, "required": [ "emails", "last_name", "first_name", "hris_profile_id" ], "title": "ItOrdersPostResponsesContentApplicationJsonSchemaDataUser", "type": "object" }, "ItOrdersPostResponsesContentApplicationJsonSchemaErrorsItems": { "properties": { "code": { "description": "Error code of the handler which produced the returned error", "type": "string" }, "field": { "description": "The field name where input validation failed", "type": [ "string", "null" ] }, "message": { "description": "Description of the returned error", "type": "string" } }, "required": [ "code", "field", "message" ], "title": "ItOrdersPostResponsesContentApplicationJsonSchemaErrorsItems", "type": "object" }, "ItPoliciesGetResponsesContentApplicationJsonSchemaDataItems": { "properties": { "id": { "description": "Unique identifier for the policy", "format": "uuid", "type": "string" }, "is_default": { "description": "Whether this is the organization's default policy, applied to workers not explicitly assigned to another one", "type": "boolean" }, "name": { "description": "Policy name", "type": "string" } }, "required": [ "id", "name", "is_default" ], "title": "ItPoliciesGetResponsesContentApplicationJsonSchemaDataItems", "type": "object" }, "ItPoliciesGetResponsesContentApplicationJsonSchemaErrorsItems": { "properties": { "code": { "description": "Error code of the handler which produced the returned error", "type": "string" }, "field": { "description": "The field name where input validation failed", "type": [ "string", "null" ] }, "message": { "description": "Description of the returned error", "type": "string" } }, "required": [ "code", "field", "message" ], "title": "ItPoliciesGetResponsesContentApplicationJsonSchemaErrorsItems", "type": "object" }, "ItPoliciesItPolicyIdAssignPostParametersXBeta": { "default": "true", "enum": [ "true" ], "title": "ItPoliciesItPolicyIdAssignPostParametersXBeta", "type": "string" }, "ItPoliciesItPolicyIdAssignPostRequestBodyContentApplicationJsonSchemaData": { "description": "Workers to assign to the IT policy.", "properties": { "hris_profile_ids": { "description": "HRIS profile identifiers of the workers to assign. Between 1 and 100 unique ids per request; the whole request is rejected when any id is not found in your organization.", "items": { "format": "uuid", "type": "string" }, "type": "array" } }, "required": [ "hris_profile_ids" ], "title": "ItPoliciesItPolicyIdAssignPostRequestBodyContentApplicationJsonSchemaData", "type": "object" }, "ItPoliciesItPolicyIdAssignPostResponsesContentApplicationJsonSchemaErrorsItems": { "properties": { "code": { "description": "Error code of the handler which produced the returned error", "type": "string" }, "field": { "description": "The field name where input validation failed", "type": [ "string", "null" ] }, "message": { "description": "Description of the returned error", "type": "string" } }, "required": [ "code", "field", "message" ], "title": "ItPoliciesItPolicyIdAssignPostResponsesContentApplicationJsonSchemaErrorsItems", "type": "object" }, "ItPoliciesPolicyIdSeatsGetParametersXBeta": { "default": "true", "enum": [ "true" ], "title": "ItPoliciesPolicyIdSeatsGetParametersXBeta", "type": "string" }, "ItPoliciesPolicyIdSeatsGetResponsesContentApplicationJsonSchemaDataItems": { "properties": { "emails": { "description": "Array of user email addresses", "items": { "format": "email", "type": "string" }, "type": "array" }, "first_name": { "description": "First name of the user", "type": "string" }, "hris_profile_id": { "description": "The unique identifier of the HRIS profile of the assigned user", "format": "uuid", "type": "string" }, "last_name": { "description": "Last name of the user", "type": "string" } }, "required": [ "emails", "last_name", "first_name", "hris_profile_id" ], "title": "ItPoliciesPolicyIdSeatsGetResponsesContentApplicationJsonSchemaDataItems", "type": "object" }, "ItPoliciesPolicyIdSeatsGetResponsesContentApplicationJsonSchemaErrorsItems": { "properties": { "code": { "description": "Error code of the handler which produced the returned error", "type": "string" }, "field": { "description": "The field name where input validation failed", "type": [ "string", "null" ] }, "message": { "description": "Description of the returned error", "type": "string" } }, "required": [ "code", "field", "message" ], "title": "ItPoliciesPolicyIdSeatsGetResponsesContentApplicationJsonSchemaErrorsItems", "type": "object" }, "ItPoliciesPolicyIdUsersGetParametersXBeta": { "default": "true", "enum": [ "true" ], "title": "ItPoliciesPolicyIdUsersGetParametersXBeta", "type": "string" }, "ItPoliciesPolicyIdUsersGetResponsesContentApplicationJsonSchemaDataItems": { "properties": { "address": { "$ref": "#/components/schemas/ItPoliciesPolicyIdUsersGetResponsesContentApplicationJsonSchemaDataItemsAddress", "description": "User address details" }, "emails": { "description": "Array of user email addresses", "items": { "format": "email", "type": "string" }, "type": "array" }, "first_name": { "description": "First name of the user", "type": "string" }, "hris_profile_id": { "description": "The unique identifier of the HRIS profile of the assigned user", "format": "uuid", "type": "string" }, "last_name": { "description": "Last name of the user", "type": "string" } }, "required": [ "emails", "address", "last_name", "first_name", "hris_profile_id" ], "title": "ItPoliciesPolicyIdUsersGetResponsesContentApplicationJsonSchemaDataItems", "type": "object" }, "ItPoliciesPolicyIdUsersGetResponsesContentApplicationJsonSchemaDataItemsAddress": { "description": "User address details", "properties": { "city": { "description": "City name", "type": [ "string", "null" ] }, "country": { "$ref": "#/components/schemas/ItPoliciesPolicyIdUsersGetResponsesContentApplicationJsonSchemaDataItemsAddressCountry", "description": "Country code" }, "date_of_birth": { "description": "Date of birth (applicable for some address types)", "format": "date", "type": [ "string", "null" ] }, "delivery_instructions": { "description": "Special instructions for deliveries", "type": [ "string", "null" ] }, "id": { "description": "Unique identifier of the address", "format": "uuid", "type": "string" }, "is_valid": { "description": "Whether the address passes validation", "type": "boolean" }, "line1": { "description": "Address line 1", "type": [ "string", "null" ] }, "line2": { "description": "Address line 2", "type": [ "string", "null" ] }, "passport_number": { "description": "Passport number (applicable for some address types)", "type": [ "string", "null" ] }, "phone_number": { "description": "Phone number", "type": [ "string", "null" ] }, "post_code": { "description": "Post code", "type": [ "string", "null" ] }, "state": { "description": "State code or name", "type": [ "string", "null" ] }, "tax_id_number": { "description": "Tax ID number (applicable for some address types)", "type": [ "string", "null" ] }, "type": { "$ref": "#/components/schemas/ItPoliciesPolicyIdUsersGetResponsesContentApplicationJsonSchemaDataItemsAddressType", "description": "Type of the address" } }, "required": [ "id", "city", "type", "line1", "line2", "state", "country", "is_valid", "post_code", "phone_number", "date_of_birth", "tax_id_number", "passport_number", "delivery_instructions" ], "title": "ItPoliciesPolicyIdUsersGetResponsesContentApplicationJsonSchemaDataItemsAddress", "type": "object" }, "ItPoliciesPolicyIdUsersGetResponsesContentApplicationJsonSchemaDataItemsAddressCountry": { "description": "Country code", "enum": [ "AD", "AE", "AF", "AG", "AI", "AL", "AM", "AN", "AO", "AQ", "AR", "AS", "AT", "AU", "AW", "AX", "AZ", "BA", "BB", "BD", "BE", "BF", "BG", "BH", "BI", "BJ", "BL", "BM", "BN", "BO", "BQ", "BR", "BS", "BT", "BV", "BW", "BY", "BZ", "CA", "CC", "CD", "CF", "CG", "CH", "CI", "CK", "CL", "CM", "CN", "CO", "CR", "CU", "CV", "CW", "CX", "CY", "CZ", "DE", "DJ", "DK", "DM", "DO", "DZ", "EC", "EE", "EG", "EH", "ER", "ES", "ET", "FI", "FJ", "FK", "FM", "FO", "FR", "GA", "GB", "GD", "GE", "GF", "GG", "GH", "GI", "GL", "GM", "GN", "GP", "GQ", "GR", "GS", "GT", "GU", "GW", "GY", "HK", "HM", "HN", "HR", "HT", "HU", "IC", "ID", "IE", "IL", "IM", "IN", "IO", "IQ", "IR", "IS", "IT", "JE", "JM", "JO", "JP", "KE", "KG", "KH", "KI", "KM", "KN", "KP", "KR", "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", "XK", "YE", "YT", "ZA", "ZM", "ZW" ], "title": "ItPoliciesPolicyIdUsersGetResponsesContentApplicationJsonSchemaDataItemsAddressCountry", "type": "string" }, "ItPoliciesPolicyIdUsersGetResponsesContentApplicationJsonSchemaDataItemsAddressType": { "description": "Type of the address", "enum": [ "BILLING", "COLLECTION", "DELIVERY", "ENTITY", "PARTIAL", "PII", "SUPPLIER" ], "title": "ItPoliciesPolicyIdUsersGetResponsesContentApplicationJsonSchemaDataItemsAddressType", "type": "string" }, "ItPoliciesPolicyIdUsersGetResponsesContentApplicationJsonSchemaErrorsItems": { "properties": { "code": { "description": "Error code of the handler which produced the returned error", "type": "string" }, "field": { "description": "The field name where input validation failed", "type": [ "string", "null" ] }, "message": { "description": "Description of the returned error", "type": "string" } }, "required": [ "code", "field", "message" ], "title": "ItPoliciesPolicyIdUsersGetResponsesContentApplicationJsonSchemaErrorsItems", "type": "object" }, "ItProductsGetParametersAcquisitionTypesSchemaItems": { "enum": [ "PURCHASE", "RENTAL", "REUSE" ], "title": "ItProductsGetParametersAcquisitionTypesSchemaItems", "type": "string" }, "ItProductsGetParametersCategory": { "enum": [ "ADAPTER", "CABLE", "CHAIR", "CHARGER", "COMPACT_DESKTOP", "DESK", "DESKTOP", "DESK_RISER", "DESK_TIDY", "DOCKING_STATION", "DONGLE", "FOOTREST", "HEADSET", "KEYBOARD", "LAPTOP", "LAPTOP_STAND", "MICE_TRACKPAD", "MOBILE_DEVICE", "MONITOR", "MONITOR_ARM", "OTHER", "PRINTER", "SHREDDER", "STANDING_MAT", "TABLET", "TASK_LIGHT", "WEBCAM", "WELCOME_PACK", "WIFI_RANGE_EXTENDER" ], "title": "ItProductsGetParametersCategory", "type": "string" }, "ItProductsGetParametersKeyboardLayoutsSchemaItems": { "enum": [ "BELGIAN_AZERTY", "CANADIAN_MULTILINGUAL_STANDARD_QWERTY", "CZECH_QWERTY", "DANISH_QWERTY", "DUTCH_QWERTY", "EGYPTIAN_LOCAL", "ENGLISH_RUSSIAN_QWERTY", "EU_STANDARD_QWERTY", "FRENCH_AZERTY", "GERMAN_QWERTZ", "INDIAN_QWERTY", "INTERNATIONAL_ENGLISH_QWERTY", "ITALIAN_QWERTY", "JAPANESE_QWERTY", "KOREAN_QWERTY", "LATAM_QWERTY", "NORWEGIAN_QWERTY", "PORTUGUESE_QWERTY", "SPANISH_QWERTY", "SWEDISH_QWERTY", "SWISS_FRENCH_QWERTZ", "SWISS_GERMAN_QWERTZ", "TURKISH_QWERTY", "UK_ENGLISH_QWERTY", "UNKNOWN", "US_ENGLISH_QWERTY" ], "title": "ItProductsGetParametersKeyboardLayoutsSchemaItems", "type": "string" }, "ItProductsGetParametersOperatingSystemsSchemaItems": { "enum": [ "ANDROID_PHONE", "ANDROID_TABLET", "CHROME_OS", "IOS_PHONE", "IOS_TABLET", "LINUX", "MACOS", "WINDOWS" ], "title": "ItProductsGetParametersOperatingSystemsSchemaItems", "type": "string" }, "ItProductsGetParametersStockCondition": { "enum": [ "NEW", "REFURBISHED" ], "title": "ItProductsGetParametersStockCondition", "type": "string" }, "ItProductsGetParametersXBeta": { "default": "true", "enum": [ "true" ], "title": "ItProductsGetParametersXBeta", "type": "string" }, "ItProductsGetResponsesContentApplicationJsonSchemaDataItems": { "properties": { "brand": { "description": "Company that produced the product", "type": "string" }, "category": { "$ref": "#/components/schemas/ItProductsGetResponsesContentApplicationJsonSchemaDataItemsCategory", "description": "Product category" }, "id": { "description": "Unique identifier of the product", "format": "uuid", "type": "string" }, "images": { "description": "Ordered list of product images. The first element is the cover image.", "items": { "$ref": "#/components/schemas/ItProductsGetResponsesContentApplicationJsonSchemaDataItemsImagesItems" }, "type": "array" }, "name": { "description": "Product name", "type": "string" } }, "required": [ "id", "name", "brand", "images", "category" ], "title": "ItProductsGetResponsesContentApplicationJsonSchemaDataItems", "type": "object" }, "ItProductsGetResponsesContentApplicationJsonSchemaDataItemsCategory": { "description": "Product category", "enum": [ "ADAPTER", "CABLE", "CHAIR", "CHARGER", "COMPACT_DESKTOP", "DESK", "DESKTOP", "DESK_RISER", "DESK_TIDY", "DOCKING_STATION", "DONGLE", "FOOTREST", "HEADSET", "KEYBOARD", "LAPTOP", "LAPTOP_STAND", "MICE_TRACKPAD", "MOBILE_DEVICE", "MONITOR", "MONITOR_ARM", "OTHER", "PRINTER", "SHREDDER", "STANDING_MAT", "TABLET", "TASK_LIGHT", "WEBCAM", "WELCOME_PACK", "WIFI_RANGE_EXTENDER" ], "title": "ItProductsGetResponsesContentApplicationJsonSchemaDataItemsCategory", "type": "string" }, "ItProductsGetResponsesContentApplicationJsonSchemaDataItemsImagesItems": { "properties": { "id": { "description": "Unique identifier of the image", "format": "uuid", "type": "string" }, "url": { "description": "Public URL of the image", "type": "string" } }, "required": [ "id", "url" ], "title": "ItProductsGetResponsesContentApplicationJsonSchemaDataItemsImagesItems", "type": "object" }, "ItProductsGetResponsesContentApplicationJsonSchemaErrorsItems": { "properties": { "code": { "description": "Error code of the handler which produced the returned error", "type": "string" }, "field": { "description": "The field name where input validation failed", "type": [ "string", "null" ] }, "message": { "description": "Description of the returned error", "type": "string" } }, "required": [ "code", "field", "message" ], "title": "ItProductsGetResponsesContentApplicationJsonSchemaErrorsItems", "type": "object" }, "ItProductsProductIdGetParametersXBeta": { "default": "true", "enum": [ "true" ], "title": "ItProductsProductIdGetParametersXBeta", "type": "string" }, "ItProductsProductIdGetResponsesContentApplicationJsonSchemaData": { "properties": { "available_addons": { "description": "Menu of addons the organization has available to attach on POST /orders. Callers submit an addon by `id` on the order's contract_setting.addons[]. Pricing is not returned in Bundle 2 — the invoice reveals amounts once the order lands.", "items": { "$ref": "#/components/schemas/ItProductsProductIdGetResponsesContentApplicationJsonSchemaDataAvailableAddonsItems" }, "type": "array" }, "brand": { "description": "Company that produced the product", "type": "string" }, "category": { "$ref": "#/components/schemas/ItProductsProductIdGetResponsesContentApplicationJsonSchemaDataCategory", "description": "Product category" }, "description": { "description": "Free-text product description", "type": "string" }, "id": { "description": "Unique identifier of the product", "format": "uuid", "type": "string" }, "images": { "description": "Ordered list of product images. The first element is the cover image.", "items": { "$ref": "#/components/schemas/ItProductsProductIdGetResponsesContentApplicationJsonSchemaDataImagesItems" }, "type": "array" }, "name": { "description": "Product name", "type": "string" }, "product_hardware_spec": { "description": "Structured hardware detail — nullable when no hardware spec is recorded (accessories, consumables)", "oneOf": [ { "$ref": "#/components/schemas/ItProductsProductIdGetResponsesContentApplicationJsonSchemaDataProductHardwareSpec" }, { "type": "null" } ] }, "public_id": { "description": "Public identifier of the product", "type": "string" }, "variants": { "description": "Catalog variants for this product — one per SKU", "items": { "$ref": "#/components/schemas/ItProductsProductIdGetResponsesContentApplicationJsonSchemaDataVariantsItems" }, "type": "array" } }, "required": [ "id", "name", "brand", "images", "category", "variants", "public_id", "description", "available_addons", "product_hardware_spec" ], "title": "ItProductsProductIdGetResponsesContentApplicationJsonSchemaData", "type": "object" }, "ItProductsProductIdGetResponsesContentApplicationJsonSchemaDataAvailableAddonsItems": { "properties": { "id": { "description": "Unique identifier of the addon. Submit this on POST /orders under contract_setting.addons[].id.", "format": "uuid", "type": "string" }, "is_premium": { "description": "Whether the addon is a premium (paid) offering. Free/default addons are false.", "type": "boolean" }, "name": { "description": "Public name of the addon", "type": "string" }, "type": { "$ref": "#/components/schemas/ItProductsProductIdGetResponsesContentApplicationJsonSchemaDataAvailableAddonsItemsType", "description": "Kind of addon — SERVICE bundles cover service/support, WARRANTY bundles cover extended cover." } }, "required": [ "id", "name", "type", "is_premium" ], "title": "ItProductsProductIdGetResponsesContentApplicationJsonSchemaDataAvailableAddonsItems", "type": "object" }, "ItProductsProductIdGetResponsesContentApplicationJsonSchemaDataAvailableAddonsItemsType": { "description": "Kind of addon — SERVICE bundles cover service/support, WARRANTY bundles cover extended cover.", "enum": [ "SERVICE", "WARRANTY" ], "title": "ItProductsProductIdGetResponsesContentApplicationJsonSchemaDataAvailableAddonsItemsType", "type": "string" }, "ItProductsProductIdGetResponsesContentApplicationJsonSchemaDataCategory": { "description": "Product category", "enum": [ "ADAPTER", "CABLE", "CHAIR", "CHARGER", "COMPACT_DESKTOP", "DESK", "DESKTOP", "DESK_RISER", "DESK_TIDY", "DOCKING_STATION", "DONGLE", "FOOTREST", "HEADSET", "KEYBOARD", "LAPTOP", "LAPTOP_STAND", "MICE_TRACKPAD", "MOBILE_DEVICE", "MONITOR", "MONITOR_ARM", "OTHER", "PRINTER", "SHREDDER", "STANDING_MAT", "TABLET", "TASK_LIGHT", "WEBCAM", "WELCOME_PACK", "WIFI_RANGE_EXTENDER" ], "title": "ItProductsProductIdGetResponsesContentApplicationJsonSchemaDataCategory", "type": "string" }, "ItProductsProductIdGetResponsesContentApplicationJsonSchemaDataImagesItems": { "properties": { "id": { "description": "Unique identifier of the image", "format": "uuid", "type": "string" }, "url": { "description": "Public URL of the image", "type": "string" } }, "required": [ "id", "url" ], "title": "ItProductsProductIdGetResponsesContentApplicationJsonSchemaDataImagesItems", "type": "object" }, "ItProductsProductIdGetResponsesContentApplicationJsonSchemaDataProductHardwareSpec": { "description": "Structured hardware detail — nullable when no hardware spec is recorded (accessories, consumables)", "properties": { "display_size": { "description": "Diagonal display size in inches (devices with a screen only)", "type": [ "string", "null" ] }, "has_display_port": { "description": "Whether the device has a DisplayPort connection (laptops, monitors)", "type": [ "boolean", "null" ] }, "has_hdmi_port": { "description": "Whether the device has an HDMI port (laptops, monitors)", "type": [ "boolean", "null" ] }, "has_usb_c_video_input": { "description": "Whether the monitor supports USB-C video input (monitors only)", "type": [ "boolean", "null" ] }, "memory_gb": { "description": "Memory (RAM) capacity in gigabytes (laptops, mobile devices, tablets)", "format": "int64", "type": [ "integer", "null" ] }, "processor": { "description": "Processor model (laptops only)", "type": [ "string", "null" ] }, "product_category": { "$ref": "#/components/schemas/ItProductsProductIdGetResponsesContentApplicationJsonSchemaDataProductHardwareSpecProductCategory", "description": "Category of the product this hardware spec belongs to" }, "storage_gb": { "description": "Storage capacity in gigabytes (laptops, mobile devices, tablets)", "format": "int64", "type": [ "integer", "null" ] }, "storage_type": { "description": "Storage medium type (laptops only)", "oneOf": [ { "$ref": "#/components/schemas/ItProductsProductIdGetResponsesContentApplicationJsonSchemaDataProductHardwareSpecStorageType" }, { "type": "null" } ] }, "usb_c_connections": { "description": "Number of USB-C connections (laptops, monitors)", "format": "int64", "type": [ "integer", "null" ] } }, "required": [ "memory_gb", "processor", "storage_gb", "display_size", "storage_type", "has_hdmi_port", "has_display_port", "product_category", "usb_c_connections", "has_usb_c_video_input" ], "title": "ItProductsProductIdGetResponsesContentApplicationJsonSchemaDataProductHardwareSpec", "type": "object" }, "ItProductsProductIdGetResponsesContentApplicationJsonSchemaDataProductHardwareSpecProductCategory": { "description": "Category of the product this hardware spec belongs to", "enum": [ "ADAPTER", "CABLE", "CHAIR", "CHARGER", "COMPACT_DESKTOP", "DESK", "DESKTOP", "DESK_RISER", "DESK_TIDY", "DOCKING_STATION", "DONGLE", "FOOTREST", "HEADSET", "KEYBOARD", "LAPTOP", "LAPTOP_STAND", "MICE_TRACKPAD", "MOBILE_DEVICE", "MONITOR", "MONITOR_ARM", "OTHER", "PRINTER", "SHREDDER", "STANDING_MAT", "TABLET", "TASK_LIGHT", "WEBCAM", "WELCOME_PACK", "WIFI_RANGE_EXTENDER" ], "title": "ItProductsProductIdGetResponsesContentApplicationJsonSchemaDataProductHardwareSpecProductCategory", "type": "string" }, "ItProductsProductIdGetResponsesContentApplicationJsonSchemaDataProductHardwareSpecStorageType": { "description": "Storage medium type (laptops only)", "enum": [ "HDD", "SSD" ], "title": "ItProductsProductIdGetResponsesContentApplicationJsonSchemaDataProductHardwareSpecStorageType", "type": "string" }, "ItProductsProductIdGetResponsesContentApplicationJsonSchemaDataVariantsItems": { "properties": { "allowed_acquisition_types": { "description": "Acquisition types allowed for this variant", "items": { "$ref": "#/components/schemas/ItProductsProductIdGetResponsesContentApplicationJsonSchemaDataVariantsItemsAllowedAcquisitionTypesItems" }, "type": "array" }, "allowed_rental_terms": { "description": "Rental terms permitted for this variant. Empty for non-rental variants.", "items": { "$ref": "#/components/schemas/ItProductsProductIdGetResponsesContentApplicationJsonSchemaDataVariantsItemsAllowedRentalTermsItems" }, "type": "array" }, "available_countries": { "description": "ISO 3166 alpha-2 country codes where this variant can be ordered", "items": { "$ref": "#/components/schemas/ItProductsProductIdGetResponsesContentApplicationJsonSchemaDataVariantsItemsAvailableCountriesItems" }, "type": "array" }, "id": { "description": "Unique identifier of the variant", "format": "uuid", "type": "string" }, "image": { "description": "Image of this variant, null when the variant has no image", "oneOf": [ { "$ref": "#/components/schemas/ItProductsProductIdGetResponsesContentApplicationJsonSchemaDataVariantsItemsImage" }, { "type": "null" } ] }, "keyboard_layout": { "description": "Physical keyboard layout (laptops only)", "oneOf": [ { "$ref": "#/components/schemas/ItProductsProductIdGetResponsesContentApplicationJsonSchemaDataVariantsItemsKeyboardLayout" }, { "type": "null" } ] }, "operating_system": { "description": "Operating system installed on this variant (devices only)", "oneOf": [ { "$ref": "#/components/schemas/ItProductsProductIdGetResponsesContentApplicationJsonSchemaDataVariantsItemsOperatingSystem" }, { "type": "null" } ] }, "public_id": { "description": "Public identifier of the variant", "type": "string" }, "size": { "description": "Physical size or dimension label — style + size together uniquely identify a variant within a product", "type": [ "string", "null" ] }, "sku": { "description": "SKU of the variant", "type": [ "string", "null" ] }, "style": { "description": "Marketing style (colour, tier, etc.) — style + size together uniquely identify a variant within a product", "type": [ "string", "null" ] } }, "required": [ "id", "sku", "size", "image", "style", "public_id", "keyboard_layout", "operating_system", "available_countries", "allowed_rental_terms", "allowed_acquisition_types" ], "title": "ItProductsProductIdGetResponsesContentApplicationJsonSchemaDataVariantsItems", "type": "object" }, "ItProductsProductIdGetResponsesContentApplicationJsonSchemaDataVariantsItemsAllowedAcquisitionTypesItems": { "enum": [ "PURCHASE", "RENTAL", "REUSE" ], "title": "ItProductsProductIdGetResponsesContentApplicationJsonSchemaDataVariantsItemsAllowedAcquisitionTypesItems", "type": "string" }, "ItProductsProductIdGetResponsesContentApplicationJsonSchemaDataVariantsItemsAllowedRentalTermsItems": { "enum": [ "MONTH_12", "MONTH_24" ], "title": "ItProductsProductIdGetResponsesContentApplicationJsonSchemaDataVariantsItemsAllowedRentalTermsItems", "type": "string" }, "ItProductsProductIdGetResponsesContentApplicationJsonSchemaDataVariantsItemsAvailableCountriesItems": { "enum": [ "AD", "AE", "AF", "AG", "AI", "AL", "AM", "AN", "AO", "AQ", "AR", "AS", "AT", "AU", "AW", "AX", "AZ", "BA", "BB", "BD", "BE", "BF", "BG", "BH", "BI", "BJ", "BL", "BM", "BN", "BO", "BQ", "BR", "BS", "BT", "BV", "BW", "BY", "BZ", "CA", "CC", "CD", "CF", "CG", "CH", "CI", "CK", "CL", "CM", "CN", "CO", "CR", "CU", "CV", "CW", "CX", "CY", "CZ", "DE", "DJ", "DK", "DM", "DO", "DZ", "EC", "EE", "EG", "EH", "ER", "ES", "ET", "FI", "FJ", "FK", "FM", "FO", "FR", "GA", "GB", "GD", "GE", "GF", "GG", "GH", "GI", "GL", "GM", "GN", "GP", "GQ", "GR", "GS", "GT", "GU", "GW", "GY", "HK", "HM", "HN", "HR", "HT", "HU", "IC", "ID", "IE", "IL", "IM", "IN", "IO", "IQ", "IR", "IS", "IT", "JE", "JM", "JO", "JP", "KE", "KG", "KH", "KI", "KM", "KN", "KP", "KR", "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", "XK", "YE", "YT", "ZA", "ZM", "ZW" ], "title": "ItProductsProductIdGetResponsesContentApplicationJsonSchemaDataVariantsItemsAvailableCountriesItems", "type": "string" }, "ItProductsProductIdGetResponsesContentApplicationJsonSchemaDataVariantsItemsImage": { "description": "Image of this variant, null when the variant has no image", "properties": { "id": { "description": "Unique identifier of the image", "format": "uuid", "type": "string" }, "url": { "description": "Public URL of the image", "type": "string" } }, "required": [ "id", "url" ], "title": "ItProductsProductIdGetResponsesContentApplicationJsonSchemaDataVariantsItemsImage", "type": "object" }, "ItProductsProductIdGetResponsesContentApplicationJsonSchemaDataVariantsItemsKeyboardLayout": { "description": "Physical keyboard layout (laptops only)", "enum": [ "BELGIAN_AZERTY", "CANADIAN_MULTILINGUAL_STANDARD_QWERTY", "CZECH_QWERTY", "DANISH_QWERTY", "DUTCH_QWERTY", "EGYPTIAN_LOCAL", "ENGLISH_RUSSIAN_QWERTY", "EU_STANDARD_QWERTY", "FRENCH_AZERTY", "GERMAN_QWERTZ", "INDIAN_QWERTY", "INTERNATIONAL_ENGLISH_QWERTY", "ITALIAN_QWERTY", "JAPANESE_QWERTY", "KOREAN_QWERTY", "LATAM_QWERTY", "NORWEGIAN_QWERTY", "PORTUGUESE_QWERTY", "SPANISH_QWERTY", "SWEDISH_QWERTY", "SWISS_FRENCH_QWERTZ", "SWISS_GERMAN_QWERTZ", "TURKISH_QWERTY", "UK_ENGLISH_QWERTY", "UNKNOWN", "US_ENGLISH_QWERTY" ], "title": "ItProductsProductIdGetResponsesContentApplicationJsonSchemaDataVariantsItemsKeyboardLayout", "type": "string" }, "ItProductsProductIdGetResponsesContentApplicationJsonSchemaDataVariantsItemsOperatingSystem": { "description": "Operating system installed on this variant (devices only)", "enum": [ "ANDROID_PHONE", "ANDROID_TABLET", "CHROME_OS", "IOS_PHONE", "IOS_TABLET", "LINUX", "MACOS", "WINDOWS" ], "title": "ItProductsProductIdGetResponsesContentApplicationJsonSchemaDataVariantsItemsOperatingSystem", "type": "string" }, "ItProductsProductIdGetResponsesContentApplicationJsonSchemaErrorsItems": { "properties": { "code": { "description": "Error code of the handler which produced the returned error", "type": "string" }, "field": { "description": "The field name where input validation failed", "type": [ "string", "null" ] }, "message": { "description": "Description of the returned error", "type": "string" } }, "required": [ "code", "field", "message" ], "title": "ItProductsProductIdGetResponsesContentApplicationJsonSchemaErrorsItems", "type": "object" }, "ItSeatsAssignPostParametersXBeta": { "default": "true", "enum": [ "true" ], "title": "ItSeatsAssignPostParametersXBeta", "type": "string" }, "ItSeatsAssignPostRequestBodyContentApplicationJsonSchemaData": { "description": "Workers to give an IT seat.", "properties": { "hris_profile_ids": { "description": "HRIS profile identifiers of the workers to give an IT seat. Between 1 and 100 unique ids per request; the whole request is rejected when any id is not found in your organization.", "items": { "format": "uuid", "type": "string" }, "type": "array" }, "is_accepting_new_seat_subscription": { "description": "Whether missing seats may be purchased. When true and the subscription has fewer free seats than the workers need, the missing seats are added to your organization's IT-seat subscription at its monthly seat price and billed immediately, bypassing the seat purchase approval your organization would go through in the Deel IT UI. When false (the default) the request fails with a conflict instead and nothing is changed.", "type": "boolean" } }, "required": [ "hris_profile_ids", "is_accepting_new_seat_subscription" ], "title": "ItSeatsAssignPostRequestBodyContentApplicationJsonSchemaData", "type": "object" }, "ItSeatsAssignPostResponsesContentApplicationJsonSchemaErrorsItems": { "properties": { "code": { "description": "Error code of the handler which produced the returned error", "type": "string" }, "field": { "description": "The field name where input validation failed", "type": [ "string", "null" ] }, "message": { "description": "Description of the returned error", "type": "string" } }, "required": [ "code", "field", "message" ], "title": "ItSeatsAssignPostResponsesContentApplicationJsonSchemaErrorsItems", "type": "object" }, "ItSeatsGetParametersStatusSchemaItems": { "enum": [ "ACTIVE", "ASSIGNED", "INACTIVE", "PENDING_APPROVAL" ], "title": "ItSeatsGetParametersStatusSchemaItems", "type": "string" }, "ItSeatsGetParametersXBeta": { "default": "true", "enum": [ "true" ], "title": "ItSeatsGetParametersXBeta", "type": "string" }, "ItSeatsGetResponsesContentApplicationJsonSchemaDataItems": { "properties": { "active_on": { "description": "Day the seat's paid features started being used. `null` while the seat is not in use.", "format": "date", "type": [ "string", "null" ] }, "assigned_at": { "description": "When the seat was given to its worker. `null` when the seat has never been assigned.", "format": "date-time", "type": [ "string", "null" ] }, "assigned_hris_profile": { "description": "Worker holding the seat. `null` when the seat is free or its worker has no Deel HRIS profile.", "oneOf": [ { "$ref": "#/components/schemas/ItSeatsGetResponsesContentApplicationJsonSchemaDataItemsAssignedHrisProfile" }, { "type": "null" } ] }, "created_at": { "description": "When the seat was created.", "format": "date-time", "type": "string" }, "deactivated_on": { "description": "Day the seat was released. `null` while the seat is still held.", "format": "date", "type": [ "string", "null" ] }, "declined_at": { "description": "When the worker declined the seat. `null` unless the worker declined it.", "format": "date-time", "type": [ "string", "null" ] }, "id": { "description": "Unique identifier of the seat.", "format": "uuid", "type": "string" }, "status": { "$ref": "#/components/schemas/ItSeatsGetResponsesContentApplicationJsonSchemaDataItemsStatus", "description": "Current status of the seat." } }, "required": [ "id", "status", "active_on", "created_at", "assigned_at", "declined_at", "deactivated_on", "assigned_hris_profile" ], "title": "ItSeatsGetResponsesContentApplicationJsonSchemaDataItems", "type": "object" }, "ItSeatsGetResponsesContentApplicationJsonSchemaDataItemsAssignedHrisProfile": { "description": "Worker holding the seat. `null` when the seat is free or its worker has no Deel HRIS profile.", "properties": { "emails": { "description": "Array of user email addresses", "items": { "format": "email", "type": "string" }, "type": "array" }, "first_name": { "description": "First name of the user", "type": "string" }, "hris_profile_id": { "description": "The unique identifier of the HRIS profile of the assigned user", "format": "uuid", "type": "string" }, "last_name": { "description": "Last name of the user", "type": "string" } }, "required": [ "emails", "last_name", "first_name", "hris_profile_id" ], "title": "ItSeatsGetResponsesContentApplicationJsonSchemaDataItemsAssignedHrisProfile", "type": "object" }, "ItSeatsGetResponsesContentApplicationJsonSchemaDataItemsStatus": { "description": "Current status of the seat.", "enum": [ "ACTIVE", "ASSIGNED", "INACTIVE", "PENDING_APPROVAL" ], "title": "ItSeatsGetResponsesContentApplicationJsonSchemaDataItemsStatus", "type": "string" }, "ItSeatsGetResponsesContentApplicationJsonSchemaErrorsItems": { "properties": { "code": { "description": "Error code of the handler which produced the returned error", "type": "string" }, "field": { "description": "The field name where input validation failed", "type": [ "string", "null" ] }, "message": { "description": "Description of the returned error", "type": "string" } }, "required": [ "code", "field", "message" ], "title": "ItSeatsGetResponsesContentApplicationJsonSchemaErrorsItems", "type": "object" }, "ItSeatsStatusGetParametersXBeta": { "default": "true", "enum": [ "true" ], "title": "ItSeatsStatusGetParametersXBeta", "type": "string" }, "ItSeatsStatusGetResponsesContentApplicationJsonSchemaData": { "properties": { "assigned_seats": { "description": "Number of seats held by a worker, whether or not the seat's paid features are in use yet.", "format": "int64", "type": "integer" }, "available_seats": { "description": "Number of paid seats free to assign right now.", "format": "int64", "type": "integer" }, "created_at": { "description": "When the subscription was created.", "format": "date-time", "type": "string" }, "end_date": { "description": "Last day the subscription is in force.", "format": "date", "type": "string" }, "id": { "description": "Unique identifier of the IT seat subscription.", "format": "uuid", "type": "string" }, "monthly_seat_price": { "$ref": "#/components/schemas/ItSeatsStatusGetResponsesContentApplicationJsonSchemaDataMonthlySeatPrice", "description": "Price of each seat per month." }, "paid_seats": { "description": "Number of seats the organization pays for.", "format": "int64", "type": "integer" }, "pending_approval_seats": { "description": "Number of seats pending purchase approval. These do not consume a paid seat until approved.", "format": "int64", "type": "integer" }, "start_date": { "description": "First day the subscription is in force.", "format": "date", "type": "string" }, "status": { "$ref": "#/components/schemas/ItSeatsStatusGetResponsesContentApplicationJsonSchemaDataStatus", "description": "Current status of the subscription." }, "term": { "$ref": "#/components/schemas/ItSeatsStatusGetResponsesContentApplicationJsonSchemaDataTerm", "description": "Committed length of the subscription." } }, "required": [ "id", "term", "status", "end_date", "created_at", "paid_seats", "start_date", "assigned_seats", "available_seats", "monthly_seat_price", "pending_approval_seats" ], "title": "ItSeatsStatusGetResponsesContentApplicationJsonSchemaData", "type": "object" }, "ItSeatsStatusGetResponsesContentApplicationJsonSchemaDataMonthlySeatPrice": { "description": "Price of each seat per month.", "properties": { "amount": { "description": "Amount", "format": "decimal", "type": "string" }, "currency": { "$ref": "#/components/schemas/ItSeatsStatusGetResponsesContentApplicationJsonSchemaDataMonthlySeatPriceCurrency", "description": "Three-letter currency code for the price" } }, "required": [ "amount", "currency" ], "title": "ItSeatsStatusGetResponsesContentApplicationJsonSchemaDataMonthlySeatPrice", "type": "object" }, "ItSeatsStatusGetResponsesContentApplicationJsonSchemaDataMonthlySeatPriceCurrency": { "description": "Three-letter currency code for the price", "enum": [ "AED", "AFN", "ALL", "AMD", "ANG", "AOA", "ARS", "AUD", "AWG", "AZN", "BAM", "BDT", "BGN", "BHD", "BIF", "BMD", "BOB", "BRL", "BSD", "BTN", "BWP", "BYN", "BZD", "CAD", "CDF", "CHF", "CLP", "CNY", "COP", "CRC", "CUC", "CVE", "CZK", "DJF", "DKK", "DOP", "DZD", "EGP", "ERN", "ETB", "EUR", "FJD", "FKP", "GBP", "GEL", "GHS", "GIP", "GMD", "GNF", "GTQ", "GYD", "HKD", "HNL", "HRK", "HTG", "HUF", "IDR", "ILS", "INR", "IQD", "IRR", "ISK", "JMD", "JOD", "JPY", "KES", "KGS", "KHR", "KMF", "KPW", "KRW", "KWD", "KYD", "KZT", "LAK", "LBP", "LKR", "LRD", "LSL", "LTL", "LYD", "MAD", "MDL", "MGA", "MKD", "MMK", "MNT", "MRU", "MUR", "MVR", "MWK", "MXN", "MYR", "MZN", "NAD", "NGN", "NIO", "NOK", "NPR", "NZD", "OMR", "PAB", "PEN", "PGK", "PHP", "PKR", "PLN", "PYG", "QAR", "RON", "RSD", "RUB", "RWF", "SAR", "SBD", "SCR", "SDG", "SEK", "SGD", "SHP", "SLL", "SOS", "SRD", "SSP", "STD", "SYP", "SZL", "THB", "TJS", "TMT", "TND", "TOP", "TRY", "TTD", "TWD", "TZS", "UAH", "UGX", "USD", "UYU", "UZS", "VEF", "VND", "VUV", "WST", "XAF", "XCD", "XOF", "XPF", "YER", "ZAR", "ZMW", "ZWD" ], "title": "ItSeatsStatusGetResponsesContentApplicationJsonSchemaDataMonthlySeatPriceCurrency", "type": "string" }, "ItSeatsStatusGetResponsesContentApplicationJsonSchemaDataStatus": { "description": "Current status of the subscription.", "enum": [ "ACTIVE", "EXPIRED", "TRIAL" ], "title": "ItSeatsStatusGetResponsesContentApplicationJsonSchemaDataStatus", "type": "string" }, "ItSeatsStatusGetResponsesContentApplicationJsonSchemaDataTerm": { "description": "Committed length of the subscription.", "enum": [ "12_MONTHS", "24_MONTHS", "36_MONTHS", "CUSTOM" ], "title": "ItSeatsStatusGetResponsesContentApplicationJsonSchemaDataTerm", "type": "string" }, "ItSeatsStatusGetResponsesContentApplicationJsonSchemaErrorsItems": { "properties": { "code": { "description": "Error code of the handler which produced the returned error", "type": "string" }, "field": { "description": "The field name where input validation failed", "type": [ "string", "null" ] }, "message": { "description": "Description of the returned error", "type": "string" } }, "required": [ "code", "field", "message" ], "title": "ItSeatsStatusGetResponsesContentApplicationJsonSchemaErrorsItems", "type": "object" }, "ItSeatsUnassignPostParametersXBeta": { "default": "true", "enum": [ "true" ], "title": "ItSeatsUnassignPostParametersXBeta", "type": "string" }, "ItSeatsUnassignPostRequestBodyContentApplicationJsonSchemaData": { "description": "Workers whose IT seat to release.", "properties": { "hris_profile_ids": { "description": "HRIS profile identifiers of the workers whose IT seat to release. Between 1 and 100 unique ids per request; the whole request is rejected when any id is not found in your organization.", "items": { "format": "uuid", "type": "string" }, "type": "array" } }, "required": [ "hris_profile_ids" ], "title": "ItSeatsUnassignPostRequestBodyContentApplicationJsonSchemaData", "type": "object" }, "ItSeatsUnassignPostResponsesContentApplicationJsonSchemaErrorsItems": { "properties": { "code": { "description": "Error code of the handler which produced the returned error", "type": "string" }, "field": { "description": "The field name where input validation failed", "type": [ "string", "null" ] }, "message": { "description": "Description of the returned error", "type": "string" } }, "required": [ "code", "field", "message" ], "title": "ItSeatsUnassignPostResponsesContentApplicationJsonSchemaErrorsItems", "type": "object" }, "ItWarehousesGetParametersType": { "enum": [ "OFFICE", "RESIDENCE", "WAREHOUSE" ], "title": "ItWarehousesGetParametersType", "type": "string" }, "ItWarehousesGetParametersXBeta": { "default": "true", "enum": [ "true" ], "title": "ItWarehousesGetParametersXBeta", "type": "string" }, "ItWarehousesGetResponsesContentApplicationJsonSchemaDataItems": { "properties": { "address": { "description": "Warehouse address", "oneOf": [ { "$ref": "#/components/schemas/ItWarehousesGetResponsesContentApplicationJsonSchemaDataItemsAddress" }, { "type": "null" } ] }, "created_at": { "description": "When the warehouse was created", "format": "date-time", "type": "string" }, "id": { "description": "Unique identifier of the warehouse", "format": "uuid", "type": "string" }, "name": { "description": "Warehouse or storage location name", "type": "string" }, "ownership": { "$ref": "#/components/schemas/ItWarehousesGetResponsesContentApplicationJsonSchemaDataItemsOwnership", "description": "Warehouse ownership. Always ORGANIZATION for this endpoint." }, "public_id": { "description": "Public identifier of the warehouse", "type": "string" }, "type": { "$ref": "#/components/schemas/ItWarehousesGetResponsesContentApplicationJsonSchemaDataItemsType", "description": "Organization warehouse type" }, "updated_at": { "description": "When the warehouse was last updated", "format": "date-time", "type": "string" }, "warehouse_type": { "$ref": "#/components/schemas/ItWarehousesGetResponsesContentApplicationJsonSchemaDataItemsWarehouseType", "description": "Warehouse type. Always ORGANIZATION for this endpoint." } }, "required": [ "id", "name", "type", "address", "ownership", "public_id", "created_at", "updated_at", "warehouse_type" ], "title": "ItWarehousesGetResponsesContentApplicationJsonSchemaDataItems", "type": "object" }, "ItWarehousesGetResponsesContentApplicationJsonSchemaDataItemsAddress": { "description": "Warehouse address", "properties": { "city": { "description": "City name", "type": [ "string", "null" ] }, "country": { "$ref": "#/components/schemas/ItWarehousesGetResponsesContentApplicationJsonSchemaDataItemsAddressCountry", "description": "Country code" }, "date_of_birth": { "description": "Date of birth (applicable for some address types)", "format": "date", "type": [ "string", "null" ] }, "delivery_instructions": { "description": "Special instructions for deliveries", "type": [ "string", "null" ] }, "id": { "description": "Unique identifier of the address", "format": "uuid", "type": "string" }, "is_valid": { "description": "Whether the address passes validation", "type": "boolean" }, "line1": { "description": "Address line 1", "type": [ "string", "null" ] }, "line2": { "description": "Address line 2", "type": [ "string", "null" ] }, "passport_number": { "description": "Passport number (applicable for some address types)", "type": [ "string", "null" ] }, "phone_number": { "description": "Phone number", "type": [ "string", "null" ] }, "post_code": { "description": "Post code", "type": [ "string", "null" ] }, "state": { "description": "State code or name", "type": [ "string", "null" ] }, "tax_id_number": { "description": "Tax ID number (applicable for some address types)", "type": [ "string", "null" ] }, "type": { "$ref": "#/components/schemas/ItWarehousesGetResponsesContentApplicationJsonSchemaDataItemsAddressType", "description": "Type of the address" } }, "required": [ "id", "city", "type", "line1", "line2", "state", "country", "is_valid", "post_code", "phone_number", "date_of_birth", "tax_id_number", "passport_number", "delivery_instructions" ], "title": "ItWarehousesGetResponsesContentApplicationJsonSchemaDataItemsAddress", "type": "object" }, "ItWarehousesGetResponsesContentApplicationJsonSchemaDataItemsAddressCountry": { "description": "Country code", "enum": [ "AD", "AE", "AF", "AG", "AI", "AL", "AM", "AN", "AO", "AQ", "AR", "AS", "AT", "AU", "AW", "AX", "AZ", "BA", "BB", "BD", "BE", "BF", "BG", "BH", "BI", "BJ", "BL", "BM", "BN", "BO", "BQ", "BR", "BS", "BT", "BV", "BW", "BY", "BZ", "CA", "CC", "CD", "CF", "CG", "CH", "CI", "CK", "CL", "CM", "CN", "CO", "CR", "CU", "CV", "CW", "CX", "CY", "CZ", "DE", "DJ", "DK", "DM", "DO", "DZ", "EC", "EE", "EG", "EH", "ER", "ES", "ET", "FI", "FJ", "FK", "FM", "FO", "FR", "GA", "GB", "GD", "GE", "GF", "GG", "GH", "GI", "GL", "GM", "GN", "GP", "GQ", "GR", "GS", "GT", "GU", "GW", "GY", "HK", "HM", "HN", "HR", "HT", "HU", "IC", "ID", "IE", "IL", "IM", "IN", "IO", "IQ", "IR", "IS", "IT", "JE", "JM", "JO", "JP", "KE", "KG", "KH", "KI", "KM", "KN", "KP", "KR", "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", "XK", "YE", "YT", "ZA", "ZM", "ZW" ], "title": "ItWarehousesGetResponsesContentApplicationJsonSchemaDataItemsAddressCountry", "type": "string" }, "ItWarehousesGetResponsesContentApplicationJsonSchemaDataItemsAddressType": { "description": "Type of the address", "enum": [ "BILLING", "COLLECTION", "DELIVERY", "ENTITY", "PARTIAL", "PII", "SUPPLIER" ], "title": "ItWarehousesGetResponsesContentApplicationJsonSchemaDataItemsAddressType", "type": "string" }, "ItWarehousesGetResponsesContentApplicationJsonSchemaDataItemsOwnership": { "description": "Warehouse ownership. Always ORGANIZATION for this endpoint.", "enum": [ "DEEL", "ORGANIZATION" ], "title": "ItWarehousesGetResponsesContentApplicationJsonSchemaDataItemsOwnership", "type": "string" }, "ItWarehousesGetResponsesContentApplicationJsonSchemaDataItemsType": { "description": "Organization warehouse type", "enum": [ "OFFICE", "RESIDENCE", "WAREHOUSE" ], "title": "ItWarehousesGetResponsesContentApplicationJsonSchemaDataItemsType", "type": "string" }, "ItWarehousesGetResponsesContentApplicationJsonSchemaDataItemsWarehouseType": { "description": "Warehouse type. Always ORGANIZATION for this endpoint.", "enum": [ "CLEARANCE", "DEEL", "ORGANIZATION" ], "title": "ItWarehousesGetResponsesContentApplicationJsonSchemaDataItemsWarehouseType", "type": "string" }, "ItWarehousesGetResponsesContentApplicationJsonSchemaErrorsItems": { "properties": { "code": { "description": "Error code of the handler which produced the returned error", "type": "string" }, "field": { "description": "The field name where input validation failed", "type": [ "string", "null" ] }, "message": { "description": "Description of the returned error", "type": "string" } }, "required": [ "code", "field", "message" ], "title": "ItWarehousesGetResponsesContentApplicationJsonSchemaErrorsItems", "type": "object" }, "ItWarehousesWarehouseIdGetParametersXBeta": { "default": "true", "enum": [ "true" ], "title": "ItWarehousesWarehouseIdGetParametersXBeta", "type": "string" }, "ItWarehousesWarehouseIdGetResponsesContentApplicationJsonSchemaData": { "properties": { "address": { "description": "Warehouse address", "oneOf": [ { "$ref": "#/components/schemas/ItWarehousesWarehouseIdGetResponsesContentApplicationJsonSchemaDataAddress" }, { "type": "null" } ] }, "created_at": { "description": "When the warehouse was created", "format": "date-time", "type": "string" }, "id": { "description": "Unique identifier of the warehouse", "format": "uuid", "type": "string" }, "name": { "description": "Warehouse or storage location name", "type": "string" }, "ownership": { "$ref": "#/components/schemas/ItWarehousesWarehouseIdGetResponsesContentApplicationJsonSchemaDataOwnership", "description": "Warehouse ownership. Always ORGANIZATION for this endpoint." }, "public_id": { "description": "Public identifier of the warehouse", "type": "string" }, "type": { "$ref": "#/components/schemas/ItWarehousesWarehouseIdGetResponsesContentApplicationJsonSchemaDataType", "description": "Organization warehouse type" }, "updated_at": { "description": "When the warehouse was last updated", "format": "date-time", "type": "string" }, "warehouse_type": { "$ref": "#/components/schemas/ItWarehousesWarehouseIdGetResponsesContentApplicationJsonSchemaDataWarehouseType", "description": "Warehouse type. Always ORGANIZATION for this endpoint." } }, "required": [ "id", "name", "type", "address", "ownership", "public_id", "created_at", "updated_at", "warehouse_type" ], "title": "ItWarehousesWarehouseIdGetResponsesContentApplicationJsonSchemaData", "type": "object" }, "ItWarehousesWarehouseIdGetResponsesContentApplicationJsonSchemaDataAddress": { "description": "Warehouse address", "properties": { "city": { "description": "City name", "type": [ "string", "null" ] }, "country": { "$ref": "#/components/schemas/ItWarehousesWarehouseIdGetResponsesContentApplicationJsonSchemaDataAddressCountry", "description": "Country code" }, "date_of_birth": { "description": "Date of birth (applicable for some address types)", "format": "date", "type": [ "string", "null" ] }, "delivery_instructions": { "description": "Special instructions for deliveries", "type": [ "string", "null" ] }, "id": { "description": "Unique identifier of the address", "format": "uuid", "type": "string" }, "is_valid": { "description": "Whether the address passes validation", "type": "boolean" }, "line1": { "description": "Address line 1", "type": [ "string", "null" ] }, "line2": { "description": "Address line 2", "type": [ "string", "null" ] }, "passport_number": { "description": "Passport number (applicable for some address types)", "type": [ "string", "null" ] }, "phone_number": { "description": "Phone number", "type": [ "string", "null" ] }, "post_code": { "description": "Post code", "type": [ "string", "null" ] }, "state": { "description": "State code or name", "type": [ "string", "null" ] }, "tax_id_number": { "description": "Tax ID number (applicable for some address types)", "type": [ "string", "null" ] }, "type": { "$ref": "#/components/schemas/ItWarehousesWarehouseIdGetResponsesContentApplicationJsonSchemaDataAddressType", "description": "Type of the address" } }, "required": [ "id", "city", "type", "line1", "line2", "state", "country", "is_valid", "post_code", "phone_number", "date_of_birth", "tax_id_number", "passport_number", "delivery_instructions" ], "title": "ItWarehousesWarehouseIdGetResponsesContentApplicationJsonSchemaDataAddress", "type": "object" }, "ItWarehousesWarehouseIdGetResponsesContentApplicationJsonSchemaDataAddressCountry": { "description": "Country code", "enum": [ "AD", "AE", "AF", "AG", "AI", "AL", "AM", "AN", "AO", "AQ", "AR", "AS", "AT", "AU", "AW", "AX", "AZ", "BA", "BB", "BD", "BE", "BF", "BG", "BH", "BI", "BJ", "BL", "BM", "BN", "BO", "BQ", "BR", "BS", "BT", "BV", "BW", "BY", "BZ", "CA", "CC", "CD", "CF", "CG", "CH", "CI", "CK", "CL", "CM", "CN", "CO", "CR", "CU", "CV", "CW", "CX", "CY", "CZ", "DE", "DJ", "DK", "DM", "DO", "DZ", "EC", "EE", "EG", "EH", "ER", "ES", "ET", "FI", "FJ", "FK", "FM", "FO", "FR", "GA", "GB", "GD", "GE", "GF", "GG", "GH", "GI", "GL", "GM", "GN", "GP", "GQ", "GR", "GS", "GT", "GU", "GW", "GY", "HK", "HM", "HN", "HR", "HT", "HU", "IC", "ID", "IE", "IL", "IM", "IN", "IO", "IQ", "IR", "IS", "IT", "JE", "JM", "JO", "JP", "KE", "KG", "KH", "KI", "KM", "KN", "KP", "KR", "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", "XK", "YE", "YT", "ZA", "ZM", "ZW" ], "title": "ItWarehousesWarehouseIdGetResponsesContentApplicationJsonSchemaDataAddressCountry", "type": "string" }, "ItWarehousesWarehouseIdGetResponsesContentApplicationJsonSchemaDataAddressType": { "description": "Type of the address", "enum": [ "BILLING", "COLLECTION", "DELIVERY", "ENTITY", "PARTIAL", "PII", "SUPPLIER" ], "title": "ItWarehousesWarehouseIdGetResponsesContentApplicationJsonSchemaDataAddressType", "type": "string" }, "ItWarehousesWarehouseIdGetResponsesContentApplicationJsonSchemaDataOwnership": { "description": "Warehouse ownership. Always ORGANIZATION for this endpoint.", "enum": [ "DEEL", "ORGANIZATION" ], "title": "ItWarehousesWarehouseIdGetResponsesContentApplicationJsonSchemaDataOwnership", "type": "string" }, "ItWarehousesWarehouseIdGetResponsesContentApplicationJsonSchemaDataType": { "description": "Organization warehouse type", "enum": [ "OFFICE", "RESIDENCE", "WAREHOUSE" ], "title": "ItWarehousesWarehouseIdGetResponsesContentApplicationJsonSchemaDataType", "type": "string" }, "ItWarehousesWarehouseIdGetResponsesContentApplicationJsonSchemaDataWarehouseType": { "description": "Warehouse type. Always ORGANIZATION for this endpoint.", "enum": [ "CLEARANCE", "DEEL", "ORGANIZATION" ], "title": "ItWarehousesWarehouseIdGetResponsesContentApplicationJsonSchemaDataWarehouseType", "type": "string" }, "ItWarehousesWarehouseIdGetResponsesContentApplicationJsonSchemaErrorsItems": { "properties": { "code": { "description": "Error code of the handler which produced the returned error", "type": "string" }, "field": { "description": "The field name where input validation failed", "type": [ "string", "null" ] }, "message": { "description": "Description of the returned error", "type": "string" } }, "required": [ "code", "field", "message" ], "title": "ItWarehousesWarehouseIdGetResponsesContentApplicationJsonSchemaErrorsItems", "type": "object" }, "KnowledgeHubCountryGuideCountryCodeGetResponsesContentApplicationJsonSchemaDataItems": { "description": "Represents a specific audience such as Contractor, Client, or Employee.", "properties": { "categories": { "description": "List of categories applicable to this audience.", "items": { "$ref": "#/components/schemas/KnowledgeHubCountryGuideCountryCodeGetResponsesContentApplicationJsonSchemaDataItemsCategoriesItems" }, "type": "array" }, "contract_types": { "description": "List of contract types available for this audience.", "items": { "$ref": "#/components/schemas/KnowledgeHubCountryGuideCountryCodeGetResponsesContentApplicationJsonSchemaDataItemsContractTypesItems" }, "type": "array" }, "name": { "description": "Display name of the audience.", "type": "string" }, "value": { "description": "Identifier or key representing the audience in lowercase.", "type": "string" } }, "required": [ "name", "value" ], "title": "KnowledgeHubCountryGuideCountryCodeGetResponsesContentApplicationJsonSchemaDataItems", "type": "object" }, "KnowledgeHubCountryGuideCountryCodeGetResponsesContentApplicationJsonSchemaDataItemsCategoriesItems": { "properties": { "articles": { "description": "An array of articles that are connected to this category", "items": { "$ref": "#/components/schemas/KnowledgeHubCountryGuideCountryCodeGetResponsesContentApplicationJsonSchemaDataItemsCategoriesItemsArticlesItems" }, "type": "array" }, "fields": { "description": "An array of informative fields and it's value that the category contains", "items": { "$ref": "#/components/schemas/KnowledgeHubCountryGuideCountryCodeGetResponsesContentApplicationJsonSchemaDataItemsCategoriesItemsFieldsItems" }, "type": "array" }, "icon": { "description": "Icon aligning with the category", "type": "string" }, "id": { "description": "ID for the category", "type": "string" }, "name": { "description": "Display name of the category", "type": "string" } }, "required": [ "id", "icon", "name", "fields", "articles" ], "title": "KnowledgeHubCountryGuideCountryCodeGetResponsesContentApplicationJsonSchemaDataItemsCategoriesItems", "type": "object" }, "KnowledgeHubCountryGuideCountryCodeGetResponsesContentApplicationJsonSchemaDataItemsCategoriesItemsArticlesItems": { "properties": { "created_at": { "description": "The timestamp when the article was created", "format": "date-time", "type": "string" }, "description": { "description": "An excerpt for the article", "type": "string" }, "effective_date": { "description": "The date when the article will be effective, meaning the content inside it becomes effective in the real world)", "format": "date", "type": [ "string", "null" ] }, "featured_image": { "description": "The featured image for the article", "format": "uri", "type": "string" }, "id": { "description": "ID for the article", "type": "string" }, "tags": { "description": "Array of tags inside an article", "items": { "$ref": "#/components/schemas/KnowledgeHubCountryGuideCountryCodeGetResponsesContentApplicationJsonSchemaDataItemsCategoriesItemsArticlesItemsTagsItems" }, "type": "array" }, "title": { "description": "Title of the article", "type": "string" }, "type": { "$ref": "#/components/schemas/KnowledgeHubCountryGuideCountryCodeGetResponsesContentApplicationJsonSchemaDataItemsCategoriesItemsArticlesItemsType", "description": "The type of the article, can contain knowledge or compliance" }, "updated_at": { "description": "The timestamp when the article was last updated", "format": "date-time", "type": "string" } }, "required": [ "id", "tags", "type", "title", "created_at", "updated_at", "description", "featured_image" ], "title": "KnowledgeHubCountryGuideCountryCodeGetResponsesContentApplicationJsonSchemaDataItemsCategoriesItemsArticlesItems", "type": "object" }, "KnowledgeHubCountryGuideCountryCodeGetResponsesContentApplicationJsonSchemaDataItemsCategoriesItemsArticlesItemsTagsItems": { "properties": { "id": { "description": "ID for the tag", "type": "string" }, "tag": { "description": "Slug for the tag", "type": "string" }, "title": { "description": "Title of the tag", "type": "string" } }, "required": [ "id", "tag", "title" ], "title": "KnowledgeHubCountryGuideCountryCodeGetResponsesContentApplicationJsonSchemaDataItemsCategoriesItemsArticlesItemsTagsItems", "type": "object" }, "KnowledgeHubCountryGuideCountryCodeGetResponsesContentApplicationJsonSchemaDataItemsCategoriesItemsArticlesItemsType": { "description": "The type of the article, can contain knowledge or compliance", "enum": [ "KNOWLEDGE", "COMPLIANCE" ], "title": "KnowledgeHubCountryGuideCountryCodeGetResponsesContentApplicationJsonSchemaDataItemsCategoriesItemsArticlesItemsType", "type": "string" }, "KnowledgeHubCountryGuideCountryCodeGetResponsesContentApplicationJsonSchemaDataItemsCategoriesItemsFieldsItems": { "properties": { "id": { "description": "ID of the field", "type": "string" }, "name": { "description": "Title of the field", "type": "string" }, "type": { "$ref": "#/components/schemas/KnowledgeHubCountryGuideCountryCodeGetResponsesContentApplicationJsonSchemaDataItemsCategoriesItemsFieldsItemsType", "description": "Type of the field, can contain text, link or html" }, "value": { "description": "The value associated for the field", "type": [ "string", "null" ] } }, "required": [ "id", "name", "type" ], "title": "KnowledgeHubCountryGuideCountryCodeGetResponsesContentApplicationJsonSchemaDataItemsCategoriesItemsFieldsItems", "type": "object" }, "KnowledgeHubCountryGuideCountryCodeGetResponsesContentApplicationJsonSchemaDataItemsCategoriesItemsFieldsItemsType": { "description": "Type of the field, can contain text, link or html", "enum": [ "TEXT", "LINK", "HTML" ], "title": "KnowledgeHubCountryGuideCountryCodeGetResponsesContentApplicationJsonSchemaDataItemsCategoriesItemsFieldsItemsType", "type": "string" }, "KnowledgeHubCountryGuideCountryCodeGetResponsesContentApplicationJsonSchemaDataItemsContractTypesItems": { "properties": { "categories": { "description": "List of categories applicable to this audience.", "items": { "$ref": "#/components/schemas/KnowledgeHubCountryGuideCountryCodeGetResponsesContentApplicationJsonSchemaDataItemsContractTypesItemsCategoriesItems" }, "type": "array" }, "name": { "description": "The user friendly name of the contract type", "type": "string" }, "value": { "description": "Identifier or key representing the contract type in lowercase.", "type": "string" } }, "required": [ "name", "value", "categories" ], "title": "KnowledgeHubCountryGuideCountryCodeGetResponsesContentApplicationJsonSchemaDataItemsContractTypesItems", "type": "object" }, "KnowledgeHubCountryGuideCountryCodeGetResponsesContentApplicationJsonSchemaDataItemsContractTypesItemsCategoriesItems": { "properties": { "articles": { "description": "An array of articles that are connected to this category", "items": { "$ref": "#/components/schemas/KnowledgeHubCountryGuideCountryCodeGetResponsesContentApplicationJsonSchemaDataItemsContractTypesItemsCategoriesItemsArticlesItems" }, "type": "array" }, "fields": { "description": "An array of informative fields and it's value that the category contains", "items": { "$ref": "#/components/schemas/KnowledgeHubCountryGuideCountryCodeGetResponsesContentApplicationJsonSchemaDataItemsContractTypesItemsCategoriesItemsFieldsItems" }, "type": "array" }, "icon": { "description": "Icon aligning with the category", "type": "string" }, "id": { "description": "ID for the category", "type": "string" }, "name": { "description": "Display name of the category", "type": "string" } }, "required": [ "id", "icon", "name", "fields", "articles" ], "title": "KnowledgeHubCountryGuideCountryCodeGetResponsesContentApplicationJsonSchemaDataItemsContractTypesItemsCategoriesItems", "type": "object" }, "KnowledgeHubCountryGuideCountryCodeGetResponsesContentApplicationJsonSchemaDataItemsContractTypesItemsCategoriesItemsArticlesItems": { "properties": { "created_at": { "description": "The timestamp when the article was created", "format": "date-time", "type": "string" }, "description": { "description": "An excerpt for the article", "type": "string" }, "effective_date": { "description": "The date when the article will be effective, meaning the content inside it becomes effective in the real world)", "format": "date", "type": [ "string", "null" ] }, "featured_image": { "description": "The featured image for the article", "format": "uri", "type": "string" }, "id": { "description": "ID for the article", "type": "string" }, "tags": { "description": "Array of tags inside an article", "items": { "$ref": "#/components/schemas/KnowledgeHubCountryGuideCountryCodeGetResponsesContentApplicationJsonSchemaDataItemsContractTypesItemsCategoriesItemsArticlesItemsTagsItems" }, "type": "array" }, "title": { "description": "Title of the article", "type": "string" }, "type": { "$ref": "#/components/schemas/KnowledgeHubCountryGuideCountryCodeGetResponsesContentApplicationJsonSchemaDataItemsContractTypesItemsCategoriesItemsArticlesItemsType", "description": "The type of the article, can contain knowledge or compliance" }, "updated_at": { "description": "The timestamp when the article was last updated", "format": "date-time", "type": "string" } }, "required": [ "id", "tags", "type", "title", "created_at", "updated_at", "description", "featured_image" ], "title": "KnowledgeHubCountryGuideCountryCodeGetResponsesContentApplicationJsonSchemaDataItemsContractTypesItemsCategoriesItemsArticlesItems", "type": "object" }, "KnowledgeHubCountryGuideCountryCodeGetResponsesContentApplicationJsonSchemaDataItemsContractTypesItemsCategoriesItemsArticlesItemsTagsItems": { "properties": { "id": { "description": "ID for the tag", "type": "string" }, "tag": { "description": "Slug for the tag", "type": "string" }, "title": { "description": "Title of the tag", "type": "string" } }, "required": [ "id", "tag", "title" ], "title": "KnowledgeHubCountryGuideCountryCodeGetResponsesContentApplicationJsonSchemaDataItemsContractTypesItemsCategoriesItemsArticlesItemsTagsItems", "type": "object" }, "KnowledgeHubCountryGuideCountryCodeGetResponsesContentApplicationJsonSchemaDataItemsContractTypesItemsCategoriesItemsArticlesItemsType": { "description": "The type of the article, can contain knowledge or compliance", "enum": [ "KNOWLEDGE", "COMPLIANCE" ], "title": "KnowledgeHubCountryGuideCountryCodeGetResponsesContentApplicationJsonSchemaDataItemsContractTypesItemsCategoriesItemsArticlesItemsType", "type": "string" }, "KnowledgeHubCountryGuideCountryCodeGetResponsesContentApplicationJsonSchemaDataItemsContractTypesItemsCategoriesItemsFieldsItems": { "properties": { "id": { "description": "ID of the field", "type": "string" }, "name": { "description": "Title of the field", "type": "string" }, "type": { "$ref": "#/components/schemas/KnowledgeHubCountryGuideCountryCodeGetResponsesContentApplicationJsonSchemaDataItemsContractTypesItemsCategoriesItemsFieldsItemsType", "description": "Type of the field, can contain text, link or html" }, "value": { "description": "The value associated for the field", "type": [ "string", "null" ] } }, "required": [ "id", "name", "type" ], "title": "KnowledgeHubCountryGuideCountryCodeGetResponsesContentApplicationJsonSchemaDataItemsContractTypesItemsCategoriesItemsFieldsItems", "type": "object" }, "KnowledgeHubCountryGuideCountryCodeGetResponsesContentApplicationJsonSchemaDataItemsContractTypesItemsCategoriesItemsFieldsItemsType": { "description": "Type of the field, can contain text, link or html", "enum": [ "TEXT", "LINK", "HTML" ], "title": "KnowledgeHubCountryGuideCountryCodeGetResponsesContentApplicationJsonSchemaDataItemsContractTypesItemsCategoriesItemsFieldsItemsType", "type": "string" }, "KnowledgeHubCountryGuideCountryCodeGetResponsesContentApplicationJsonSchemaErrorsItems": { "properties": { "code": { "description": "Machine-readable error code", "type": "string" }, "message": { "description": "Human-readable explanation of the error", "type": "string" } }, "title": "KnowledgeHubCountryGuideCountryCodeGetResponsesContentApplicationJsonSchemaErrorsItems", "type": "object" }, "Knowledge_Hub_getKnowledgeHubCountryGuidesByCountryCode-v2026-01-01_Response_200": { "properties": { "data": { "description": "List of different audiences with associated categories and contract types.", "items": { "$ref": "#/components/schemas/KnowledgeHubCountryGuideCountryCodeGetResponsesContentApplicationJsonSchemaDataItems" }, "type": "array" }, "has_more": { "description": "Indicates if there are more items to fetch.", "type": "boolean" }, "next_cursor": { "description": "Cursor for the next page of results", "type": [ "string", "null" ] }, "total_count": { "description": "Total number of audiences", "format": "double", "type": "number" } }, "title": "Knowledge Hub_getKnowledgeHubCountryGuidesByCountryCode-v2026-01-01_Response_200", "type": "object" }, "Learning_retrieveWorkersActionableJourneys-v2026-01-01_Response_200": { "description": "ActionableJourney is a representation of a JourneyAssignment and JourneyStep. This defines which Worker should be acting on which Step of the Journey. Generally, it would be same as Assignee of the JourneyAssignment, but can be different when RecipientSettings are added to Steps.", "properties": { "data": { "items": { "$ref": "#/components/schemas/EngageLearningActionableJourneysGetResponsesContentApplicationJsonSchemaDataItems" }, "type": "array" }, "next_cursor": { "description": "Cursor to fetch the next page of results. Null if no more pages.", "type": [ "string", "null" ] } }, "required": [ "data", "next_cursor" ], "title": "Learning_retrieveWorkersActionableJourneys-v2026-01-01_Response_200", "type": "object" }, "LegalEntitiesCountryFieldsCountryCodeGetResponsesContentApplicationJsonSchemaData": { "properties": { "country_code": { "description": "ISO 3166-1 alpha-2 country code, uppercased.", "type": "string" }, "fields": { "description": "Empty when the country is recognized but has no configured identifier fields.", "items": { "$ref": "#/components/schemas/LegalEntitiesCountryFieldsCountryCodeGetResponsesContentApplicationJsonSchemaDataFieldsItems" }, "type": "array" } }, "title": "LegalEntitiesCountryFieldsCountryCodeGetResponsesContentApplicationJsonSchemaData", "type": "object" }, "LegalEntitiesCountryFieldsCountryCodeGetResponsesContentApplicationJsonSchemaDataFieldsItems": { "properties": { "kind": { "$ref": "#/components/schemas/LegalEntitiesCountryFieldsCountryCodeGetResponsesContentApplicationJsonSchemaDataFieldsItemsKind", "description": "Whether this field is a registration or tax identifier." }, "name": { "description": "Human-readable name of the identifier field.", "type": "string" }, "requirement": { "$ref": "#/components/schemas/LegalEntitiesCountryFieldsCountryCodeGetResponsesContentApplicationJsonSchemaDataFieldsItemsRequirement", "description": "`mandatory` — must be collected and submitted. `optional` — may be submitted but is not required. `bypass` — not required; clients should omit it unless they have a value, since if provided it may still be validated." }, "validation_regex": { "description": "Regex the submitted value must match. `null` when the field has no format restriction.", "type": [ "string", "null" ] } }, "title": "LegalEntitiesCountryFieldsCountryCodeGetResponsesContentApplicationJsonSchemaDataFieldsItems", "type": "object" }, "LegalEntitiesCountryFieldsCountryCodeGetResponsesContentApplicationJsonSchemaDataFieldsItemsKind": { "description": "Whether this field is a registration or tax identifier.", "enum": [ "registration_id", "tax_id" ], "title": "LegalEntitiesCountryFieldsCountryCodeGetResponsesContentApplicationJsonSchemaDataFieldsItemsKind", "type": "string" }, "LegalEntitiesCountryFieldsCountryCodeGetResponsesContentApplicationJsonSchemaDataFieldsItemsRequirement": { "description": "`mandatory` — must be collected and submitted. `optional` — may be submitted but is not required. `bypass` — not required; clients should omit it unless they have a value, since if provided it may still be validated.", "enum": [ "mandatory", "optional", "bypass" ], "title": "LegalEntitiesCountryFieldsCountryCodeGetResponsesContentApplicationJsonSchemaDataFieldsItemsRequirement", "type": "string" }, "LegalEntitiesCountryFieldsCountryCodeGetResponsesContentApplicationJsonSchemaErrorsItems": { "properties": { "code": { "description": "Error code identifier", "type": "string" }, "details": { "$ref": "#/components/schemas/LegalEntitiesCountryFieldsCountryCodeGetResponsesContentApplicationJsonSchemaErrorsItemsDetails", "description": "Additional error details" }, "field": { "description": "Name of the field that failed validation", "type": "string" }, "message": { "description": "Human-readable explanation of the error.", "type": "string" } }, "title": "LegalEntitiesCountryFieldsCountryCodeGetResponsesContentApplicationJsonSchemaErrorsItems", "type": "object" }, "LegalEntitiesCountryFieldsCountryCodeGetResponsesContentApplicationJsonSchemaErrorsItemsDetails": { "description": "Additional error details", "properties": {}, "title": "LegalEntitiesCountryFieldsCountryCodeGetResponsesContentApplicationJsonSchemaErrorsItemsDetails", "type": "object" }, "LegalEntitiesGetParametersSortOrder": { "default": "ASC", "enum": [ "ASC", "DESC" ], "title": "LegalEntitiesGetParametersSortOrder", "type": "string" }, "LegalEntitiesGetResponsesContentApplicationJsonSchemaDataItems": { "properties": { "address": { "oneOf": [ { "$ref": "#/components/schemas/LegalEntitiesGetResponsesContentApplicationJsonSchemaDataItemsAddress" }, { "type": "null" } ] }, "archived_at": { "description": "Archived date", "format": "date-time", "type": [ "string", "null" ] }, "country": { "description": "Country of the legal entity", "type": [ "string", "null" ] }, "created_at": { "description": "Created date", "format": "date-time", "type": "string" }, "entity_subtype": { "description": "Entity sub type", "type": "string" }, "entity_type": { "description": "Entity type", "oneOf": [ { "$ref": "#/components/schemas/LegalEntitiesGetResponsesContentApplicationJsonSchemaDataItemsEntityType" }, { "type": "null" } ] }, "id": { "description": "Id of the legal entity", "type": "string" }, "industry_name": { "description": "Industry name", "type": [ "string", "null" ] }, "name": { "description": "Name of the legal entity", "type": "string" }, "phone": { "description": "Phone number", "type": [ "string", "null" ] }, "registrationNumber": { "description": "Registration number", "type": [ "string", "null" ] }, "sic_number": { "description": "SIC Company Identifier", "type": [ "string", "null" ] }, "status": { "$ref": "#/components/schemas/LegalEntitiesGetResponsesContentApplicationJsonSchemaDataItemsStatus", "description": "The mapped legal entity lifecycle status, the same value as on the single legal entity endpoint. Returned only when the feature is enabled for the organization." }, "updated_at": { "description": "Updated date", "format": "date-time", "type": "string" }, "vat_id": { "description": "VAT ID", "type": [ "string", "null" ] } }, "title": "LegalEntitiesGetResponsesContentApplicationJsonSchemaDataItems", "type": "object" }, "LegalEntitiesGetResponsesContentApplicationJsonSchemaDataItemsAddress": { "properties": { "city": { "description": "City", "type": [ "string", "null" ] }, "country": { "description": "Country", "type": [ "string", "null" ] }, "state": { "description": "State", "type": [ "string", "null" ] }, "street": { "description": "Street", "type": [ "string", "null" ] }, "zip": { "description": "Zip code", "type": [ "string", "null" ] } }, "title": "LegalEntitiesGetResponsesContentApplicationJsonSchemaDataItemsAddress", "type": "object" }, "LegalEntitiesGetResponsesContentApplicationJsonSchemaDataItemsEntityType": { "description": "Entity type", "enum": [ "individual", "company", "light" ], "title": "LegalEntitiesGetResponsesContentApplicationJsonSchemaDataItemsEntityType", "type": "string" }, "LegalEntitiesGetResponsesContentApplicationJsonSchemaDataItemsStatus": { "description": "The mapped legal entity lifecycle status, the same value as on the single legal entity endpoint. Returned only when the feature is enabled for the organization.", "enum": [ "archived", "active", "draft", "processing", "processing_draft", "pending_verification", "awaiting_review", "unknown" ], "title": "LegalEntitiesGetResponsesContentApplicationJsonSchemaDataItemsStatus", "type": "string" }, "LegalEntitiesGetResponsesContentApplicationJsonSchemaErrorsItems": { "properties": { "code": { "description": "Error code identifier", "type": "string" }, "details": { "$ref": "#/components/schemas/LegalEntitiesGetResponsesContentApplicationJsonSchemaErrorsItemsDetails", "description": "Additional error details" }, "field": { "description": "Name of the field that failed validation", "type": "string" }, "message": { "description": "Human-readable error message", "type": "string" } }, "title": "LegalEntitiesGetResponsesContentApplicationJsonSchemaErrorsItems", "type": "object" }, "LegalEntitiesGetResponsesContentApplicationJsonSchemaErrorsItemsDetails": { "description": "Additional error details", "properties": {}, "title": "LegalEntitiesGetResponsesContentApplicationJsonSchemaErrorsItemsDetails", "type": "object" }, "LegalEntitiesGetResponsesContentApplicationJsonSchemaPage": { "properties": { "cursor": { "description": "Cursor link", "type": [ "string", "null" ] } }, "title": "LegalEntitiesGetResponsesContentApplicationJsonSchemaPage", "type": "object" }, "LegalEntitiesIdPatchRequestBodyContentApplicationJsonSchemaData": { "properties": { "address": { "$ref": "#/components/schemas/LegalEntitiesIdPatchRequestBodyContentApplicationJsonSchemaDataAddress" }, "company_identifiers": { "$ref": "#/components/schemas/LegalEntitiesIdPatchRequestBodyContentApplicationJsonSchemaDataCompanyIdentifiers", "description": "Identifiers associated with the legal entity." }, "deel_industry_subcategory_id": { "description": "Reference to the Deel Industry Code (NAICS).", "type": "string" }, "entity_type": { "description": "The type of the legal entity.", "type": "string" }, "industry_name": { "description": "The industry name of the legal entity.", "type": "string" }, "name": { "description": "The name of the legal entity.", "type": "string" }, "phone": { "description": "The phone number of the legal entity.", "type": "string" }, "sic_number": { "description": "The SIC number of the legal entity.", "type": "string" } }, "title": "LegalEntitiesIdPatchRequestBodyContentApplicationJsonSchemaData", "type": "object" }, "LegalEntitiesIdPatchRequestBodyContentApplicationJsonSchemaDataAddress": { "properties": { "city": { "description": "The city.", "type": "string" }, "country": { "description": "The ISO 2-letter country code.", "pattern": "^[A-Z]{2}$", "type": "string" }, "state": { "description": "The state.", "type": "string" }, "street": { "description": "The street address.", "type": "string" } }, "title": "LegalEntitiesIdPatchRequestBodyContentApplicationJsonSchemaDataAddress", "type": "object" }, "LegalEntitiesIdPatchRequestBodyContentApplicationJsonSchemaDataCompanyIdentifiers": { "description": "Identifiers associated with the legal entity.", "properties": { "registration_number": { "description": "The registration number of the legal entity.", "type": "string" }, "tax_number": { "description": "The tax identification number of the legal entity.", "type": "string" } }, "title": "LegalEntitiesIdPatchRequestBodyContentApplicationJsonSchemaDataCompanyIdentifiers", "type": "object" }, "LegalEntitiesIdPatchResponsesContentApplicationJsonSchemaData": { "properties": { "address": { "$ref": "#/components/schemas/LegalEntitiesIdPatchResponsesContentApplicationJsonSchemaDataAddress" }, "company_identifiers": { "$ref": "#/components/schemas/LegalEntitiesIdPatchResponsesContentApplicationJsonSchemaDataCompanyIdentifiers" }, "entity_type": { "description": "The type of the legal entity.", "type": "string" }, "id": { "description": "The unique identifier of the legal entity.", "type": "string" }, "industry_name": { "description": "The industry name of the legal entity.", "type": "string" }, "name": { "description": "The name of the legal entity.", "type": "string" }, "phone": { "description": "The phone number of the legal entity.", "type": "string" }, "sic_number": { "description": "The SIC number of the legal entity.", "type": "string" } }, "title": "LegalEntitiesIdPatchResponsesContentApplicationJsonSchemaData", "type": "object" }, "LegalEntitiesIdPatchResponsesContentApplicationJsonSchemaDataAddress": { "properties": { "city": { "description": "The city.", "type": "string" }, "country": { "description": "The ISO 2-letter country code.", "type": "string" }, "state": { "description": "The state.", "type": "string" }, "street": { "description": "The street address.", "type": "string" } }, "title": "LegalEntitiesIdPatchResponsesContentApplicationJsonSchemaDataAddress", "type": "object" }, "LegalEntitiesIdPatchResponsesContentApplicationJsonSchemaDataCompanyIdentifiers": { "properties": { "registration_number": { "description": "The registration number of the legal entity.", "type": "string" }, "tax_number": { "description": "The tax identification number of the legal entity.", "type": "string" } }, "title": "LegalEntitiesIdPatchResponsesContentApplicationJsonSchemaDataCompanyIdentifiers", "type": "object" }, "LegalEntitiesLegalEntityIdCostCentersGetResponsesContentApplicationJsonSchemaDataItems": { "properties": { "cost_center_name": { "description": "Cost center name to be displayed", "type": "string" }, "cost_center_number": { "description": "Cost center code", "type": "string" }, "created_at": { "description": "Cost center date of registration on Deel", "format": "date-time", "type": "string" }, "id": { "description": "Cost center Id", "format": "int64", "type": "integer" }, "updated_at": { "description": "Cost center date of most recent update on Deel", "format": "date-time", "type": "string" } }, "title": "LegalEntitiesLegalEntityIdCostCentersGetResponsesContentApplicationJsonSchemaDataItems", "type": "object" }, "LegalEntitiesLegalEntityIdCostCentersGetResponsesContentApplicationJsonSchemaErrorsItems": { "properties": { "code": { "description": "The code of the source handler which produced the returned error", "format": "double", "type": "number" }, "message": { "description": "A description of the returned error", "type": "string" } }, "title": "LegalEntitiesLegalEntityIdCostCentersGetResponsesContentApplicationJsonSchemaErrorsItems", "type": "object" }, "LegalEntitiesLegalEntityIdCostCentersGetResponsesContentApplicationJsonSchemaRequest": { "properties": { "api_req_id": { "description": "The request ID of the failed request", "type": "string" }, "code": { "description": "The code of the source handler which produced the returned error", "format": "double", "type": "number" }, "docs": { "description": "A link to the official documentation for the requested endpoint resource", "type": "string" }, "method": { "description": "The HTTP method of the failed request", "type": "string" }, "source": { "description": "The source handler which produced the returned error", "type": "string" }, "status": { "description": "The status code of the response", "format": "double", "type": "number" }, "url": { "description": "The relative URL of the failed request", "type": "string" } }, "title": "LegalEntitiesLegalEntityIdCostCentersGetResponsesContentApplicationJsonSchemaRequest", "type": "object" }, "LegalEntitiesLegalEntityIdCostCentersSynchronizePostRequestBodyContentApplicationJsonSchemaDataItems": { "properties": { "cost_center_name": { "description": "Cost center name to be displayed", "maxLength": 255, "type": "string" }, "cost_center_number": { "description": "Cost center code", "maxLength": 255, "type": "string" } }, "required": [ "cost_center_name", "cost_center_number" ], "title": "LegalEntitiesLegalEntityIdCostCentersSynchronizePostRequestBodyContentApplicationJsonSchemaDataItems", "type": "object" }, "LegalEntitiesLegalEntityIdCostCentersSynchronizePostResponsesContentApplicationJsonSchemaDataItems": { "properties": { "cost_center_name": { "description": "Cost center name to be displayed", "type": "string" }, "cost_center_number": { "description": "Cost center code", "type": "string" }, "created_at": { "description": "Cost center date of registration on Deel. Long date-time format following ISO-8601", "format": "date-time", "type": "string" }, "id": { "description": "Cost center id", "format": "int64", "type": "integer" }, "updated_at": { "description": "Cost center date of most recent update on Deel. Long date-time format following ISO-8601", "format": "date-time", "type": "string" } }, "title": "LegalEntitiesLegalEntityIdCostCentersSynchronizePostResponsesContentApplicationJsonSchemaDataItems", "type": "object" }, "LegalEntitiesLegalEntityIdCostCentersSynchronizePostResponsesContentApplicationJsonSchemaErrorsItems": { "properties": { "error": { "description": "A description of the returned error", "type": "string" } }, "title": "LegalEntitiesLegalEntityIdCostCentersSynchronizePostResponsesContentApplicationJsonSchemaErrorsItems", "type": "object" }, "LegalEntitiesLegalEntityIdCostCentersSynchronizePostResponsesContentApplicationJsonSchemaRequest": { "properties": { "api_req_id": { "description": "The request ID of the failed request", "type": "string" }, "code": { "description": "The code of the source handler which produced the returned error", "format": "double", "type": "number" }, "docs": { "description": "A link to the official documentation for the requested endpoint resource", "type": "string" }, "method": { "description": "The HTTP method of the failed request", "type": "string" }, "source": { "description": "The source handler which produced the returned error", "type": "string" }, "status": { "description": "The status code of the response", "format": "double", "type": "number" }, "url": { "description": "The relative URL of the failed request", "type": "string" } }, "title": "LegalEntitiesLegalEntityIdCostCentersSynchronizePostResponsesContentApplicationJsonSchemaRequest", "type": "object" }, "LegalEntitiesLegalEntityIdGetResponsesContentApplicationJsonSchemaData": { "properties": { "address": { "oneOf": [ { "$ref": "#/components/schemas/LegalEntitiesLegalEntityIdGetResponsesContentApplicationJsonSchemaDataAddress" }, { "type": "null" } ] }, "archived_at": { "description": "The timestamp when the legal entity was archived, if any.", "format": "date-time", "type": [ "string", "null" ] }, "cdd_status": { "description": "The raw CDD verification status. When verification has not started it is coalesced to a tier-dependent initial value: PENDING when CDD is required, NOT_REQUIRED for Tier-0/SaaS entities.", "oneOf": [ { "$ref": "#/components/schemas/LegalEntitiesLegalEntityIdGetResponsesContentApplicationJsonSchemaDataCddStatus" }, { "type": "null" } ] }, "country": { "description": "The country of the legal entity (ISO 2-letter code).", "type": [ "string", "null" ] }, "created_at": { "description": "The timestamp when the legal entity was created.", "format": "date-time", "type": "string" }, "entity_type": { "description": "The entity subtype.", "type": [ "string", "null" ] }, "id": { "description": "The unique identifier of the legal entity.", "type": "string" }, "incorporation_date": { "description": "The incorporation date of the legal entity.", "format": "date", "type": [ "string", "null" ] }, "industry_name": { "description": "The industry name of the legal entity.", "type": [ "string", "null" ] }, "legal_name": { "description": "The registered legal name of the entity.", "type": [ "string", "null" ] }, "legal_type": { "description": "The legal type of the entity.", "oneOf": [ { "$ref": "#/components/schemas/LegalEntitiesLegalEntityIdGetResponsesContentApplicationJsonSchemaDataLegalType" }, { "type": "null" } ] }, "name": { "description": "The name of the legal entity.", "type": "string" }, "phone": { "description": "The phone number of the legal entity.", "type": [ "string", "null" ] }, "registration_number": { "description": "The registration number of the legal entity.", "type": [ "string", "null" ] }, "status": { "$ref": "#/components/schemas/LegalEntitiesLegalEntityIdGetResponsesContentApplicationJsonSchemaDataStatus", "description": "The mapped legal entity lifecycle status." }, "updated_at": { "description": "The timestamp when the legal entity was last updated.", "format": "date-time", "type": "string" }, "vat_id": { "description": "The VAT identifier of the legal entity.", "type": [ "string", "null" ] } }, "title": "LegalEntitiesLegalEntityIdGetResponsesContentApplicationJsonSchemaData", "type": "object" }, "LegalEntitiesLegalEntityIdGetResponsesContentApplicationJsonSchemaDataAddress": { "properties": { "city": { "description": "The city.", "type": [ "string", "null" ] }, "country": { "description": "The ISO 2-letter country code.", "type": [ "string", "null" ] }, "state": { "description": "The state.", "type": [ "string", "null" ] }, "street": { "description": "The street address.", "type": [ "string", "null" ] }, "zip": { "description": "The zip code.", "type": [ "string", "null" ] } }, "title": "LegalEntitiesLegalEntityIdGetResponsesContentApplicationJsonSchemaDataAddress", "type": "object" }, "LegalEntitiesLegalEntityIdGetResponsesContentApplicationJsonSchemaDataCddStatus": { "description": "The raw CDD verification status. When verification has not started it is coalesced to a tier-dependent initial value: PENDING when CDD is required, NOT_REQUIRED for Tier-0/SaaS entities.", "enum": [ "NOT_REQUIRED", "PENDING", "PENDING_ASYNC_TASKS", "DRAFT", "SUBMITTED", "APPROVED", "REJECTED", "EDD" ], "title": "LegalEntitiesLegalEntityIdGetResponsesContentApplicationJsonSchemaDataCddStatus", "type": "string" }, "LegalEntitiesLegalEntityIdGetResponsesContentApplicationJsonSchemaDataLegalType": { "description": "The legal type of the entity.", "enum": [ "individual", "company", "light" ], "title": "LegalEntitiesLegalEntityIdGetResponsesContentApplicationJsonSchemaDataLegalType", "type": "string" }, "LegalEntitiesLegalEntityIdGetResponsesContentApplicationJsonSchemaDataStatus": { "description": "The mapped legal entity lifecycle status.", "enum": [ "archived", "active", "draft", "processing", "processing_draft", "pending_verification", "awaiting_review", "unknown" ], "title": "LegalEntitiesLegalEntityIdGetResponsesContentApplicationJsonSchemaDataStatus", "type": "string" }, "LegalEntitiesLegalEntityIdKybDocumentsPostParametersXBeta": { "default": "true", "enum": [ "true" ], "title": "LegalEntitiesLegalEntityIdKybDocumentsPostParametersXBeta", "type": "string" }, "LegalEntitiesLegalEntityIdKybDocumentsPostRequestBodyContentMultipartFormDataSchemaData": { "properties": { "document_type": { "$ref": "#/components/schemas/LegalEntitiesLegalEntityIdKybDocumentsPostRequestBodyContentMultipartFormDataSchemaDataDocumentType", "description": "What the file is. Company documents: `ARTICLES_OF_INCORPORATION`, `COMPANY_BANK_STATEMENT`, `CERTIFICATE_OF_GOOD_STANDING`, `ULTIMATE_BENEFICIAL_OWNER_FORM`, `PROOF_OF_AUTHORITY` (a power of attorney, a board resolution or minutes, or another document evidencing authority). Person documents, one per side: `IDENTITY_DOCUMENT_FRONT`, `IDENTITY_DOCUMENT_BACK`, `SELFIE`. A list of directors is not yet accepted by the verification service over the API." }, "file": { "description": "The document. Company documents accept PDF, JPEG and PNG. Identity documents and selfies accept JPEG and PNG only.", "format": "binary", "type": "string" } }, "required": [ "file", "document_type" ], "title": "LegalEntitiesLegalEntityIdKybDocumentsPostRequestBodyContentMultipartFormDataSchemaData", "type": "object" }, "LegalEntitiesLegalEntityIdKybDocumentsPostRequestBodyContentMultipartFormDataSchemaDataDocumentType": { "description": "What the file is. Company documents: `ARTICLES_OF_INCORPORATION`, `COMPANY_BANK_STATEMENT`, `CERTIFICATE_OF_GOOD_STANDING`, `ULTIMATE_BENEFICIAL_OWNER_FORM`, `PROOF_OF_AUTHORITY` (a power of attorney, a board resolution or minutes, or another document evidencing authority). Person documents, one per side: `IDENTITY_DOCUMENT_FRONT`, `IDENTITY_DOCUMENT_BACK`, `SELFIE`. A list of directors is not yet accepted by the verification service over the API.", "enum": [ "ARTICLES_OF_INCORPORATION", "COMPANY_BANK_STATEMENT", "CERTIFICATE_OF_GOOD_STANDING", "ULTIMATE_BENEFICIAL_OWNER_FORM", "PROOF_OF_AUTHORITY", "IDENTITY_DOCUMENT_FRONT", "IDENTITY_DOCUMENT_BACK", "SELFIE" ], "title": "LegalEntitiesLegalEntityIdKybDocumentsPostRequestBodyContentMultipartFormDataSchemaDataDocumentType", "type": "string" }, "LegalEntitiesLegalEntityIdKybDocumentsPostResponsesContentApplicationJsonSchemaData": { "properties": { "content_type": { "description": "MIME type of the stored file.", "type": "string" }, "created_at": { "description": "When the document was uploaded.", "format": "date-time", "type": "string" }, "document_type": { "$ref": "#/components/schemas/LegalEntitiesLegalEntityIdKybDocumentsPostResponsesContentApplicationJsonSchemaDataDocumentType", "description": "The document type the file was uploaded as. The handle can only be used for this type." }, "expires_at": { "description": "When the handle stops being accepted if it has not been used in a submission.", "format": "date-time", "type": "string" }, "file_name": { "description": "Original file name, when the upload carried one.", "type": [ "string", "null" ] }, "id": { "description": "Opaque handle for the uploaded document. Pass it in the matching document field of `POST /rest/legal-entities/{legal_entity_id}/kyb`. Valid only for this legal entity, usable once, and expires if unused.", "format": "uuid", "type": "string" } }, "required": [ "id", "file_name", "created_at", "expires_at", "content_type", "document_type" ], "title": "LegalEntitiesLegalEntityIdKybDocumentsPostResponsesContentApplicationJsonSchemaData", "type": "object" }, "LegalEntitiesLegalEntityIdKybDocumentsPostResponsesContentApplicationJsonSchemaDataDocumentType": { "description": "The document type the file was uploaded as. The handle can only be used for this type.", "enum": [ "ARTICLES_OF_INCORPORATION", "COMPANY_BANK_STATEMENT", "CERTIFICATE_OF_GOOD_STANDING", "ULTIMATE_BENEFICIAL_OWNER_FORM", "PROOF_OF_AUTHORITY", "IDENTITY_DOCUMENT_FRONT", "IDENTITY_DOCUMENT_BACK", "SELFIE" ], "title": "LegalEntitiesLegalEntityIdKybDocumentsPostResponsesContentApplicationJsonSchemaDataDocumentType", "type": "string" }, "LegalEntitiesLegalEntityIdKybDocumentsPostResponsesContentApplicationJsonSchemaErrorsItems": { "properties": { "code": { "$ref": "#/components/schemas/LegalEntitiesLegalEntityIdKybDocumentsPostResponsesContentApplicationJsonSchemaErrorsItemsCode", "description": "Machine-readable error code." }, "details": { "$ref": "#/components/schemas/LegalEntitiesLegalEntityIdKybDocumentsPostResponsesContentApplicationJsonSchemaErrorsItemsDetails", "description": "Which request field the error refers to and, for a content-type or document-type error, the accepted values." }, "message": { "description": "Human-readable explanation of the error.", "type": "string" } }, "required": [ "code", "message" ], "title": "LegalEntitiesLegalEntityIdKybDocumentsPostResponsesContentApplicationJsonSchemaErrorsItems", "type": "object" }, "LegalEntitiesLegalEntityIdKybDocumentsPostResponsesContentApplicationJsonSchemaErrorsItemsCode": { "description": "Machine-readable error code.", "enum": [ "KYB_DOCUMENT_LIMIT_REACHED" ], "title": "LegalEntitiesLegalEntityIdKybDocumentsPostResponsesContentApplicationJsonSchemaErrorsItemsCode", "type": "string" }, "LegalEntitiesLegalEntityIdKybDocumentsPostResponsesContentApplicationJsonSchemaErrorsItemsDetails": { "description": "Which request field the error refers to and, for a content-type or document-type error, the accepted values.", "properties": { "allowed": { "description": "Accepted values for the field.", "items": { "type": "string" }, "type": "array" }, "key": { "description": "The request field the error refers to.", "type": "string" }, "keys": { "description": "Every offending request field, for a multi-field error.", "items": { "type": "string" }, "type": "array" } }, "title": "LegalEntitiesLegalEntityIdKybDocumentsPostResponsesContentApplicationJsonSchemaErrorsItemsDetails", "type": "object" }, "LegalEntitiesLegalEntityIdKybEddDocumentsPostParametersXBeta": { "default": "true", "enum": [ "true" ], "title": "LegalEntitiesLegalEntityIdKybEddDocumentsPostParametersXBeta", "type": "string" }, "LegalEntitiesLegalEntityIdKybEddDocumentsPostRequestBodyContentMultipartFormDataSchemaData": { "properties": { "edd_request_id": { "description": "The `edd.id` from the KYB state.", "format": "uuid", "type": "string" }, "file": { "description": "The document. Accepts application/pdf, image/jpeg, image/png.", "format": "binary", "type": "string" }, "question_key": { "description": "The `key` of the `DOCUMENT_UPLOAD` question being answered.", "type": "string" } }, "required": [ "file", "question_key", "edd_request_id" ], "title": "LegalEntitiesLegalEntityIdKybEddDocumentsPostRequestBodyContentMultipartFormDataSchemaData", "type": "object" }, "LegalEntitiesLegalEntityIdKybEddDocumentsPostResponsesContentApplicationJsonSchemaData": { "properties": { "created_at": { "description": "When the document was uploaded.", "format": "date-time", "type": "string" }, "expires_at": { "description": "When the handle stops being accepted if it has not been used in an answer.", "format": "date-time", "type": "string" }, "id": { "description": "Opaque handle for the uploaded document. Pass it in the matching answer of `POST /rest/legal-entities/{legal_entity_id}/kyb/edd`. Valid only for this legal entity, EDD request and question, usable once, and expires if unused.", "format": "uuid", "type": "string" }, "question_key": { "description": "The EDD question key the file was uploaded for. The handle can only be used for this question.", "type": "string" } }, "required": [ "id", "created_at", "expires_at", "question_key" ], "title": "LegalEntitiesLegalEntityIdKybEddDocumentsPostResponsesContentApplicationJsonSchemaData", "type": "object" }, "LegalEntitiesLegalEntityIdKybEddDocumentsPostResponsesContentApplicationJsonSchemaErrorsItems": { "properties": { "code": { "$ref": "#/components/schemas/LegalEntitiesLegalEntityIdKybEddDocumentsPostResponsesContentApplicationJsonSchemaErrorsItemsCode", "description": "Machine-readable error code." }, "details": { "$ref": "#/components/schemas/LegalEntitiesLegalEntityIdKybEddDocumentsPostResponsesContentApplicationJsonSchemaErrorsItemsDetails", "description": "Which request field the error refers to and, for a content-type or document-type error, the accepted values." }, "message": { "description": "Human-readable explanation of the error.", "type": "string" } }, "required": [ "code", "message" ], "title": "LegalEntitiesLegalEntityIdKybEddDocumentsPostResponsesContentApplicationJsonSchemaErrorsItems", "type": "object" }, "LegalEntitiesLegalEntityIdKybEddDocumentsPostResponsesContentApplicationJsonSchemaErrorsItemsCode": { "description": "Machine-readable error code.", "enum": [ "KYB_VERIFICATION_UNAVAILABLE" ], "title": "LegalEntitiesLegalEntityIdKybEddDocumentsPostResponsesContentApplicationJsonSchemaErrorsItemsCode", "type": "string" }, "LegalEntitiesLegalEntityIdKybEddDocumentsPostResponsesContentApplicationJsonSchemaErrorsItemsDetails": { "description": "Which request field the error refers to and, for a content-type or document-type error, the accepted values.", "properties": { "allowed": { "description": "Accepted values for the field.", "items": { "type": "string" }, "type": "array" }, "key": { "description": "The request field the error refers to.", "type": "string" }, "keys": { "description": "Every offending request field, for a multi-field error.", "items": { "type": "string" }, "type": "array" } }, "title": "LegalEntitiesLegalEntityIdKybEddDocumentsPostResponsesContentApplicationJsonSchemaErrorsItemsDetails", "type": "object" }, "LegalEntitiesLegalEntityIdKybEddPostParametersXBeta": { "default": "true", "enum": [ "true" ], "title": "LegalEntitiesLegalEntityIdKybEddPostParametersXBeta", "type": "string" }, "LegalEntitiesLegalEntityIdKybEddPostRequestBodyContentApplicationJsonSchemaData": { "properties": { "answers": { "description": "One answer per question key. Every required question needs an answer.", "items": { "$ref": "#/components/schemas/LegalEntitiesLegalEntityIdKybEddPostRequestBodyContentApplicationJsonSchemaDataAnswersItems" }, "type": "array" }, "edd_request_id": { "description": "The `edd.id` from the KYB state. A request that is no longer the open one is refused.", "format": "uuid", "type": "string" } }, "required": [ "answers", "edd_request_id" ], "title": "LegalEntitiesLegalEntityIdKybEddPostRequestBodyContentApplicationJsonSchemaData", "type": "object" }, "LegalEntitiesLegalEntityIdKybEddPostRequestBodyContentApplicationJsonSchemaDataAnswersItems": { "properties": { "question_key": { "description": "The `key` of the question being answered.", "maxLength": 16, "type": "string" }, "value": { "$ref": "#/components/schemas/LegalEntitiesLegalEntityIdKybEddPostRequestBodyContentApplicationJsonSchemaDataAnswersItemsValue", "description": "The answer. `TEXT`, `LONG_TEXT`, `EMAIL`, `PHONE_NUMBER`: a string. `NUMBER`: a number. `DATE`: `YYYY-MM-DD`. `DATE_RANGE`: an object with `start_date` and `end_date`. `ADDRESS`: an object with `country` (ISO 3166-1 alpha-2 code), `state`, `city`, `street`, `number` and `zip_code`; all six are required when the question is required. `SINGLE_CHOICE`: one option title. `MULTIPLE_CHOICE`: a list of option titles. `DOCUMENT_UPLOAD`: a list of document handles from `POST /rest/legal-entities/{legal_entity_id}/kyb/edd/documents`. An empty value leaves an optional question unanswered." } }, "required": [ "value", "question_key" ], "title": "LegalEntitiesLegalEntityIdKybEddPostRequestBodyContentApplicationJsonSchemaDataAnswersItems", "type": "object" }, "LegalEntitiesLegalEntityIdKybEddPostRequestBodyContentApplicationJsonSchemaDataAnswersItemsValue": { "description": "The answer. `TEXT`, `LONG_TEXT`, `EMAIL`, `PHONE_NUMBER`: a string. `NUMBER`: a number. `DATE`: `YYYY-MM-DD`. `DATE_RANGE`: an object with `start_date` and `end_date`. `ADDRESS`: an object with `country` (ISO 3166-1 alpha-2 code), `state`, `city`, `street`, `number` and `zip_code`; all six are required when the question is required. `SINGLE_CHOICE`: one option title. `MULTIPLE_CHOICE`: a list of option titles. `DOCUMENT_UPLOAD`: a list of document handles from `POST /rest/legal-entities/{legal_entity_id}/kyb/edd/documents`. An empty value leaves an optional question unanswered.", "oneOf": [ { "maxLength": 10000, "type": "string" }, { "format": "double", "type": "number" }, { "items": { "type": "string" }, "type": "array" }, { "$ref": "#/components/schemas/LegalEntitiesLegalEntityIdKybEddPostRequestBodyContentApplicationJsonSchemaDataAnswersItemsValue3" } ], "title": "LegalEntitiesLegalEntityIdKybEddPostRequestBodyContentApplicationJsonSchemaDataAnswersItemsValue" }, "LegalEntitiesLegalEntityIdKybEddPostRequestBodyContentApplicationJsonSchemaDataAnswersItemsValue3": { "description": "A date range (`DATE_RANGE`: `start_date` and `end_date`) or an address (`ADDRESS`: `country`, `state`, `city`, `street`, `number` and `zip_code`).", "properties": { "city": { "description": "`ADDRESS` only.", "type": [ "string", "null" ] }, "country": { "description": "`ADDRESS` only. ISO 3166-1 alpha-2 code.", "type": [ "string", "null" ] }, "end_date": { "description": "`DATE_RANGE` only. `YYYY-MM-DD`.", "type": [ "string", "null" ] }, "number": { "description": "`ADDRESS` only.", "type": [ "string", "null" ] }, "start_date": { "description": "`DATE_RANGE` only. `YYYY-MM-DD`.", "type": [ "string", "null" ] }, "state": { "description": "`ADDRESS` only.", "type": [ "string", "null" ] }, "street": { "description": "`ADDRESS` only.", "type": [ "string", "null" ] }, "zip_code": { "description": "`ADDRESS` only.", "type": [ "string", "null" ] } }, "title": "LegalEntitiesLegalEntityIdKybEddPostRequestBodyContentApplicationJsonSchemaDataAnswersItemsValue3", "type": "object" }, "LegalEntitiesLegalEntityIdKybEddPostResponsesContentApplicationJsonSchemaData": { "properties": { "approved_at": { "description": "When the entity was approved; null otherwise.", "format": "date-time", "type": [ "string", "null" ] }, "documents": { "description": "Presence of every company-level document type. Null when `is_detail_available` is false.", "items": { "$ref": "#/components/schemas/LegalEntitiesLegalEntityIdKybEddPostResponsesContentApplicationJsonSchemaDataDocumentsItems" }, "type": [ "array", "null" ] }, "edd": { "description": "The open enhanced due diligence (EDD) request while the entity is in EDD: Deel needs further answers from the client before it continues the review. Null otherwise, and null while the entity is in EDD when the questions could not be read (retry later).", "oneOf": [ { "$ref": "#/components/schemas/LegalEntitiesLegalEntityIdKybEddPostResponsesContentApplicationJsonSchemaDataEdd" }, { "type": "null" } ] }, "is_action_required": { "description": "True while the entity is waiting on the client: `PENDING`, `DRAFT`, or `EDD` (enhanced due diligence — Ops needs something further from the client). False while Deel is reviewing or once the entity is approved, rejected or exempt.", "type": "boolean" }, "is_detail_available": { "description": "False when the verification service could not be read. Every detail block (`requirements`, `documents`, `proof_of_authority`, `persons`, `rejection`) is then null. Retry later; the status fields are still authoritative.", "type": "boolean" }, "legal_entity_id": { "description": "Public id of the legal entity.", "format": "uuid", "type": "string" }, "persons": { "description": "Declared persons of significant control: directors, controlling officers, owners and the submitter. Identity documents are reported by presence only. Null when `is_detail_available` is false.", "items": { "$ref": "#/components/schemas/LegalEntitiesLegalEntityIdKybEddPostResponsesContentApplicationJsonSchemaDataPersonsItems" }, "type": [ "array", "null" ] }, "rejected_at": { "description": "When the entity was last rejected; null otherwise.", "format": "date-time", "type": [ "string", "null" ] }, "rejection": { "description": "Present only when the entity was rejected; null otherwise.", "oneOf": [ { "$ref": "#/components/schemas/LegalEntitiesLegalEntityIdKybEddPostResponsesContentApplicationJsonSchemaDataRejection" }, { "type": "null" } ] }, "requirements": { "description": "Everything the verification service currently requires for this entity, with whether each item is already satisfied. Empty when verification is not required. Null when `is_detail_available` is false.", "items": { "$ref": "#/components/schemas/LegalEntitiesLegalEntityIdKybEddPostResponsesContentApplicationJsonSchemaDataRequirementsItems" }, "type": [ "array", "null" ] }, "status": { "$ref": "#/components/schemas/LegalEntitiesLegalEntityIdKybEddPostResponsesContentApplicationJsonSchemaDataStatus", "description": "The mapped lifecycle status of the legal entity, the same vocabulary as `status` on `GET /rest/legal-entities/{legal_entity_id}`." }, "submitted_at": { "description": "When the verification record was created; null before the first submission.", "format": "date-time", "type": [ "string", "null" ] }, "verification_type": { "description": "Depth of verification the entity is subject to, when known.", "oneOf": [ { "$ref": "#/components/schemas/LegalEntitiesLegalEntityIdKybEddPostResponsesContentApplicationJsonSchemaDataVerificationType" }, { "type": "null" } ] } }, "required": [ "edd", "status", "persons", "documents", "rejection", "approved_at", "rejected_at", "requirements", "submitted_at", "legal_entity_id", "verification_type", "is_action_required", "is_detail_available" ], "title": "LegalEntitiesLegalEntityIdKybEddPostResponsesContentApplicationJsonSchemaData", "type": "object" }, "LegalEntitiesLegalEntityIdKybEddPostResponsesContentApplicationJsonSchemaDataDocumentsItems": { "properties": { "is_provided": { "description": "Whether a file for this document has been submitted. File contents and URLs are never returned.", "type": "boolean" }, "is_required": { "description": "Whether the verification service currently requires this document.", "type": "boolean" }, "meta_type": { "description": "Kind of Proof of Authority document, when this entry's type is PROOF_OF_AUTHORITY. Null for every other document type.", "oneOf": [ { "$ref": "#/components/schemas/LegalEntitiesLegalEntityIdKybEddPostResponsesContentApplicationJsonSchemaDataDocumentsItemsMetaType" }, { "type": "null" } ] }, "type": { "$ref": "#/components/schemas/LegalEntitiesLegalEntityIdKybEddPostResponsesContentApplicationJsonSchemaDataDocumentsItemsType", "description": "Company-level document type." } }, "required": [ "type", "meta_type", "is_provided", "is_required" ], "title": "LegalEntitiesLegalEntityIdKybEddPostResponsesContentApplicationJsonSchemaDataDocumentsItems", "type": "object" }, "LegalEntitiesLegalEntityIdKybEddPostResponsesContentApplicationJsonSchemaDataDocumentsItemsMetaType": { "description": "Kind of Proof of Authority document, when this entry's type is PROOF_OF_AUTHORITY. Null for every other document type.", "enum": [ "POWER_OF_ATTORNEY", "RESOLUTION_OR_MINUTES", "OTHER" ], "title": "LegalEntitiesLegalEntityIdKybEddPostResponsesContentApplicationJsonSchemaDataDocumentsItemsMetaType", "type": "string" }, "LegalEntitiesLegalEntityIdKybEddPostResponsesContentApplicationJsonSchemaDataDocumentsItemsType": { "description": "Company-level document type.", "enum": [ "PROOF_OF_AUTHORITY", "ARTICLES_OF_INCORPORATION", "COMPANY_BANK_STATEMENT", "LIST_OF_DIRECTORS", "CERTIFICATE_OF_GOOD_STANDING", "ULTIMATE_BENEFICIAL_OWNER_FORM" ], "title": "LegalEntitiesLegalEntityIdKybEddPostResponsesContentApplicationJsonSchemaDataDocumentsItemsType", "type": "string" }, "LegalEntitiesLegalEntityIdKybEddPostResponsesContentApplicationJsonSchemaDataEdd": { "description": "The open enhanced due diligence (EDD) request while the entity is in EDD: Deel needs further answers from the client before it continues the review. Null otherwise, and null while the entity is in EDD when the questions could not be read (retry later).", "properties": { "id": { "description": "Public id of the EDD request. Send it as `edd_request_id` when answering.", "format": "uuid", "type": "string" }, "is_answerable_over_api": { "description": "False when the form has a required unsupported question. Contact Deel support to clear such a request.", "type": "boolean" }, "questions": { "description": "Every question of the EDD form, in form order.", "items": { "$ref": "#/components/schemas/LegalEntitiesLegalEntityIdKybEddPostResponsesContentApplicationJsonSchemaDataEddQuestionsItems" }, "type": "array" }, "requested_at": { "description": "When Deel requested the EDD.", "format": "date-time", "type": [ "string", "null" ] }, "status": { "$ref": "#/components/schemas/LegalEntitiesLegalEntityIdKybEddPostResponsesContentApplicationJsonSchemaDataEddStatus", "description": "`AWAITING_ANSWERS` until the answers are sent; `ANSWERED` once they are, until the entity is back in review." } }, "required": [ "id", "status", "questions", "requested_at", "is_answerable_over_api" ], "title": "LegalEntitiesLegalEntityIdKybEddPostResponsesContentApplicationJsonSchemaDataEdd", "type": "object" }, "LegalEntitiesLegalEntityIdKybEddPostResponsesContentApplicationJsonSchemaDataEddQuestionsItems": { "properties": { "description": { "description": "Helper text for the question, when any.", "type": [ "string", "null" ] }, "is_required": { "description": "Whether the question must currently be answered.", "type": "boolean" }, "key": { "description": "Key of the question within this EDD request, in form order. Send it as `question_key` when answering.", "type": "string" }, "options": { "description": "For `SINGLE_CHOICE` and `MULTIPLE_CHOICE` questions, the option titles to answer with. Null for every other type.", "items": { "type": "string" }, "type": [ "array", "null" ] }, "repeat_group": { "description": "Set when this question belongs to a repeatable group (e.g. \"add another director\"); null otherwise.", "oneOf": [ { "$ref": "#/components/schemas/LegalEntitiesLegalEntityIdKybEddPostResponsesContentApplicationJsonSchemaDataEddQuestionsItemsRepeatGroup" }, { "type": "null" } ] }, "revealed_when": { "description": "Conditions under which this question applies, met if any one of them does. Null when the question always applies. Only answer it when a condition is met.", "items": { "$ref": "#/components/schemas/LegalEntitiesLegalEntityIdKybEddPostResponsesContentApplicationJsonSchemaDataEddQuestionsItemsRevealedWhenItems" }, "type": [ "array", "null" ] }, "title": { "description": "The question as the reviewer wrote it.", "type": "string" }, "type": { "$ref": "#/components/schemas/LegalEntitiesLegalEntityIdKybEddPostResponsesContentApplicationJsonSchemaDataEddQuestionsItemsType", "description": "What kind of answer the question takes. `COUNTRY` takes an ISO 3166-1 alpha-2 code (e.g. `US`), `CURRENCY` an ISO 4217 code (e.g. `USD`) and `STATE` a state name (e.g. `California`), each as a string, or a list of strings when the form allows several. `DOCUMENT_UPLOAD` questions are answered with a list of document handles from `POST /rest/legal-entities/{legal_entity_id}/kyb/edd/documents`. `UNSUPPORTED` questions cannot be answered over the API; when one of them is required, `is_answerable_over_api` is false." } }, "required": [ "key", "type", "title", "options", "description", "is_required", "repeat_group", "revealed_when" ], "title": "LegalEntitiesLegalEntityIdKybEddPostResponsesContentApplicationJsonSchemaDataEddQuestionsItems", "type": "object" }, "LegalEntitiesLegalEntityIdKybEddPostResponsesContentApplicationJsonSchemaDataEddQuestionsItemsRepeatGroup": { "description": "Set when this question belongs to a repeatable group (e.g. \"add another director\"); null otherwise.", "properties": { "index": { "description": "Zero-based position of this question within its repeat group instance.", "type": "integer" }, "max_repeats": { "description": "Maximum number of instances of this group the form allows.", "type": "integer" }, "name": { "description": "Name of the repeatable group this question belongs to.", "type": "string" } }, "required": [ "name", "index", "max_repeats" ], "title": "LegalEntitiesLegalEntityIdKybEddPostResponsesContentApplicationJsonSchemaDataEddQuestionsItemsRepeatGroup", "type": "object" }, "LegalEntitiesLegalEntityIdKybEddPostResponsesContentApplicationJsonSchemaDataEddQuestionsItemsRevealedWhenItems": { "properties": { "equals": { "description": "Option title `question` must be answered with for this question to apply.", "type": "string" }, "question": { "description": "Key of the question whose answer gates this one.", "type": "string" } }, "required": [ "equals", "question" ], "title": "LegalEntitiesLegalEntityIdKybEddPostResponsesContentApplicationJsonSchemaDataEddQuestionsItemsRevealedWhenItems", "type": "object" }, "LegalEntitiesLegalEntityIdKybEddPostResponsesContentApplicationJsonSchemaDataEddQuestionsItemsType": { "description": "What kind of answer the question takes. `COUNTRY` takes an ISO 3166-1 alpha-2 code (e.g. `US`), `CURRENCY` an ISO 4217 code (e.g. `USD`) and `STATE` a state name (e.g. `California`), each as a string, or a list of strings when the form allows several. `DOCUMENT_UPLOAD` questions are answered with a list of document handles from `POST /rest/legal-entities/{legal_entity_id}/kyb/edd/documents`. `UNSUPPORTED` questions cannot be answered over the API; when one of them is required, `is_answerable_over_api` is false.", "enum": [ "TEXT", "LONG_TEXT", "NUMBER", "EMAIL", "PHONE_NUMBER", "DATE", "DATE_RANGE", "ADDRESS", "SINGLE_CHOICE", "MULTIPLE_CHOICE", "COUNTRY", "STATE", "CURRENCY", "DOCUMENT_UPLOAD", "UNSUPPORTED" ], "title": "LegalEntitiesLegalEntityIdKybEddPostResponsesContentApplicationJsonSchemaDataEddQuestionsItemsType", "type": "string" }, "LegalEntitiesLegalEntityIdKybEddPostResponsesContentApplicationJsonSchemaDataEddStatus": { "description": "`AWAITING_ANSWERS` until the answers are sent; `ANSWERED` once they are, until the entity is back in review.", "enum": [ "AWAITING_ANSWERS", "ANSWERED" ], "title": "LegalEntitiesLegalEntityIdKybEddPostResponsesContentApplicationJsonSchemaDataEddStatus", "type": "string" }, "LegalEntitiesLegalEntityIdKybEddPostResponsesContentApplicationJsonSchemaDataPersonsItems": { "properties": { "first_name": { "description": "First name as declared.", "type": "string" }, "id": { "description": "Public id of the declared person, when the verification service has assigned one.", "format": "uuid", "type": [ "string", "null" ] }, "last_name": { "description": "Last name as declared.", "type": "string" }, "ownership_percentage": { "description": "Declared ownership percentage for owners; null otherwise.", "format": "double", "type": [ "number", "null" ] }, "responsibilities": { "description": "Roles the person holds in the entity.", "items": { "$ref": "#/components/schemas/LegalEntitiesLegalEntityIdKybEddPostResponsesContentApplicationJsonSchemaDataPersonsItemsResponsibilitiesItems" }, "type": "array" } }, "required": [ "id", "last_name", "first_name", "responsibilities", "ownership_percentage" ], "title": "LegalEntitiesLegalEntityIdKybEddPostResponsesContentApplicationJsonSchemaDataPersonsItems", "type": "object" }, "LegalEntitiesLegalEntityIdKybEddPostResponsesContentApplicationJsonSchemaDataPersonsItemsResponsibilitiesItems": { "enum": [ "submitter", "controllingOfficer", "owner", "director" ], "title": "LegalEntitiesLegalEntityIdKybEddPostResponsesContentApplicationJsonSchemaDataPersonsItemsResponsibilitiesItems", "type": "string" }, "LegalEntitiesLegalEntityIdKybEddPostResponsesContentApplicationJsonSchemaDataRejection": { "description": "Present only when the entity was rejected; null otherwise.", "properties": { "rejected_at": { "description": "When the rejection was recorded.", "format": "date-time", "type": [ "string", "null" ] } }, "required": [ "rejected_at" ], "title": "LegalEntitiesLegalEntityIdKybEddPostResponsesContentApplicationJsonSchemaDataRejection", "type": "object" }, "LegalEntitiesLegalEntityIdKybEddPostResponsesContentApplicationJsonSchemaDataRequirementsItems": { "properties": { "category": { "$ref": "#/components/schemas/LegalEntitiesLegalEntityIdKybEddPostResponsesContentApplicationJsonSchemaDataRequirementsItemsCategory", "description": "What kind of input satisfies the requirement: a company field, a company document, or an attribute of a declared person." }, "is_satisfied": { "description": "Whether the current submission already satisfies the requirement.", "type": "boolean" }, "key": { "description": "Requirement key as published by the verification service, e.g. `FORMATION_DATE`, `ARTICLES_OF_INCORPORATION`, `PROOF_OF_AUTHORITY`, `UBO_NAME`, `DIRECTOR_KYC_DOCUMENT`. Person-level keys are prefixed with the role they constrain: `DIRECTOR_`, `CONTROLLING_OFFICER_`, `UBO_` or `SUBMITTER_`.", "type": "string" } }, "required": [ "key", "category", "is_satisfied" ], "title": "LegalEntitiesLegalEntityIdKybEddPostResponsesContentApplicationJsonSchemaDataRequirementsItems", "type": "object" }, "LegalEntitiesLegalEntityIdKybEddPostResponsesContentApplicationJsonSchemaDataRequirementsItemsCategory": { "description": "What kind of input satisfies the requirement: a company field, a company document, or an attribute of a declared person.", "enum": [ "FIELD", "DOCUMENT", "PERSON" ], "title": "LegalEntitiesLegalEntityIdKybEddPostResponsesContentApplicationJsonSchemaDataRequirementsItemsCategory", "type": "string" }, "LegalEntitiesLegalEntityIdKybEddPostResponsesContentApplicationJsonSchemaDataStatus": { "description": "The mapped lifecycle status of the legal entity, the same vocabulary as `status` on `GET /rest/legal-entities/{legal_entity_id}`.", "enum": [ "archived", "active", "draft", "processing", "processing_draft", "pending_verification", "awaiting_review", "unknown" ], "title": "LegalEntitiesLegalEntityIdKybEddPostResponsesContentApplicationJsonSchemaDataStatus", "type": "string" }, "LegalEntitiesLegalEntityIdKybEddPostResponsesContentApplicationJsonSchemaDataVerificationType": { "description": "Depth of verification the entity is subject to, when known.", "enum": [ "NONE", "LIGHT", "FULL" ], "title": "LegalEntitiesLegalEntityIdKybEddPostResponsesContentApplicationJsonSchemaDataVerificationType", "type": "string" }, "LegalEntitiesLegalEntityIdKybEddPostResponsesContentApplicationJsonSchemaErrorsItems": { "properties": { "code": { "$ref": "#/components/schemas/LegalEntitiesLegalEntityIdKybEddPostResponsesContentApplicationJsonSchemaErrorsItemsCode", "description": "Machine-readable error code." }, "details": { "$ref": "#/components/schemas/LegalEntitiesLegalEntityIdKybEddPostResponsesContentApplicationJsonSchemaErrorsItemsDetails", "description": "Which request field the error refers to and, for a content-type or document-type error, the accepted values." }, "message": { "description": "Human-readable explanation of the error.", "type": "string" } }, "required": [ "code", "message" ], "title": "LegalEntitiesLegalEntityIdKybEddPostResponsesContentApplicationJsonSchemaErrorsItems", "type": "object" }, "LegalEntitiesLegalEntityIdKybEddPostResponsesContentApplicationJsonSchemaErrorsItemsCode": { "description": "Machine-readable error code.", "enum": [ "KYB_VERIFICATION_UNAVAILABLE" ], "title": "LegalEntitiesLegalEntityIdKybEddPostResponsesContentApplicationJsonSchemaErrorsItemsCode", "type": "string" }, "LegalEntitiesLegalEntityIdKybEddPostResponsesContentApplicationJsonSchemaErrorsItemsDetails": { "description": "Which request field the error refers to and, for a content-type or document-type error, the accepted values.", "properties": { "allowed": { "description": "Accepted values for the field.", "items": { "type": "string" }, "type": "array" }, "key": { "description": "The request field the error refers to.", "type": "string" }, "keys": { "description": "Every offending request field, for a multi-field error.", "items": { "type": "string" }, "type": "array" } }, "title": "LegalEntitiesLegalEntityIdKybEddPostResponsesContentApplicationJsonSchemaErrorsItemsDetails", "type": "object" }, "LegalEntitiesLegalEntityIdKybGetParametersXBeta": { "default": "true", "enum": [ "true" ], "title": "LegalEntitiesLegalEntityIdKybGetParametersXBeta", "type": "string" }, "LegalEntitiesLegalEntityIdKybGetResponsesContentApplicationJsonSchemaData": { "properties": { "approved_at": { "description": "When the entity was approved; null otherwise.", "format": "date-time", "type": [ "string", "null" ] }, "documents": { "description": "Presence of every company-level document type. Null when `is_detail_available` is false.", "items": { "$ref": "#/components/schemas/LegalEntitiesLegalEntityIdKybGetResponsesContentApplicationJsonSchemaDataDocumentsItems" }, "type": [ "array", "null" ] }, "edd": { "description": "The open enhanced due diligence (EDD) request while the entity is in EDD: Deel needs further answers from the client before it continues the review. Null otherwise, and null while the entity is in EDD when the questions could not be read (retry later).", "oneOf": [ { "$ref": "#/components/schemas/LegalEntitiesLegalEntityIdKybGetResponsesContentApplicationJsonSchemaDataEdd" }, { "type": "null" } ] }, "is_action_required": { "description": "True while the entity is waiting on the client: `PENDING`, `DRAFT`, or `EDD` (enhanced due diligence — Ops needs something further from the client). False while Deel is reviewing or once the entity is approved, rejected or exempt.", "type": "boolean" }, "is_detail_available": { "description": "False when the verification service could not be read. Every detail block (`requirements`, `documents`, `proof_of_authority`, `persons`, `rejection`) is then null. Retry later; the status fields are still authoritative.", "type": "boolean" }, "legal_entity_id": { "description": "Public id of the legal entity.", "format": "uuid", "type": "string" }, "persons": { "description": "Declared persons of significant control: directors, controlling officers, owners and the submitter. Identity documents are reported by presence only. Null when `is_detail_available` is false.", "items": { "$ref": "#/components/schemas/LegalEntitiesLegalEntityIdKybGetResponsesContentApplicationJsonSchemaDataPersonsItems" }, "type": [ "array", "null" ] }, "rejected_at": { "description": "When the entity was last rejected; null otherwise.", "format": "date-time", "type": [ "string", "null" ] }, "rejection": { "description": "Present only when the entity was rejected; null otherwise.", "oneOf": [ { "$ref": "#/components/schemas/LegalEntitiesLegalEntityIdKybGetResponsesContentApplicationJsonSchemaDataRejection" }, { "type": "null" } ] }, "requirements": { "description": "Everything the verification service currently requires for this entity, with whether each item is already satisfied. Empty when verification is not required. Null when `is_detail_available` is false.", "items": { "$ref": "#/components/schemas/LegalEntitiesLegalEntityIdKybGetResponsesContentApplicationJsonSchemaDataRequirementsItems" }, "type": [ "array", "null" ] }, "status": { "$ref": "#/components/schemas/LegalEntitiesLegalEntityIdKybGetResponsesContentApplicationJsonSchemaDataStatus", "description": "The mapped lifecycle status of the legal entity, the same vocabulary as `status` on `GET /rest/legal-entities/{legal_entity_id}`." }, "submitted_at": { "description": "When the verification record was created; null before the first submission.", "format": "date-time", "type": [ "string", "null" ] }, "verification_type": { "description": "Depth of verification the entity is subject to, when known.", "oneOf": [ { "$ref": "#/components/schemas/LegalEntitiesLegalEntityIdKybGetResponsesContentApplicationJsonSchemaDataVerificationType" }, { "type": "null" } ] } }, "required": [ "edd", "status", "persons", "documents", "rejection", "approved_at", "rejected_at", "requirements", "submitted_at", "legal_entity_id", "verification_type", "is_action_required", "is_detail_available" ], "title": "LegalEntitiesLegalEntityIdKybGetResponsesContentApplicationJsonSchemaData", "type": "object" }, "LegalEntitiesLegalEntityIdKybGetResponsesContentApplicationJsonSchemaDataDocumentsItems": { "properties": { "is_provided": { "description": "Whether a file for this document has been submitted. File contents and URLs are never returned.", "type": "boolean" }, "is_required": { "description": "Whether the verification service currently requires this document.", "type": "boolean" }, "meta_type": { "description": "Kind of Proof of Authority document, when this entry's type is PROOF_OF_AUTHORITY. Null for every other document type.", "oneOf": [ { "$ref": "#/components/schemas/LegalEntitiesLegalEntityIdKybGetResponsesContentApplicationJsonSchemaDataDocumentsItemsMetaType" }, { "type": "null" } ] }, "type": { "$ref": "#/components/schemas/LegalEntitiesLegalEntityIdKybGetResponsesContentApplicationJsonSchemaDataDocumentsItemsType", "description": "Company-level document type." } }, "required": [ "type", "meta_type", "is_provided", "is_required" ], "title": "LegalEntitiesLegalEntityIdKybGetResponsesContentApplicationJsonSchemaDataDocumentsItems", "type": "object" }, "LegalEntitiesLegalEntityIdKybGetResponsesContentApplicationJsonSchemaDataDocumentsItemsMetaType": { "description": "Kind of Proof of Authority document, when this entry's type is PROOF_OF_AUTHORITY. Null for every other document type.", "enum": [ "POWER_OF_ATTORNEY", "RESOLUTION_OR_MINUTES", "OTHER" ], "title": "LegalEntitiesLegalEntityIdKybGetResponsesContentApplicationJsonSchemaDataDocumentsItemsMetaType", "type": "string" }, "LegalEntitiesLegalEntityIdKybGetResponsesContentApplicationJsonSchemaDataDocumentsItemsType": { "description": "Company-level document type.", "enum": [ "PROOF_OF_AUTHORITY", "ARTICLES_OF_INCORPORATION", "COMPANY_BANK_STATEMENT", "LIST_OF_DIRECTORS", "CERTIFICATE_OF_GOOD_STANDING", "ULTIMATE_BENEFICIAL_OWNER_FORM" ], "title": "LegalEntitiesLegalEntityIdKybGetResponsesContentApplicationJsonSchemaDataDocumentsItemsType", "type": "string" }, "LegalEntitiesLegalEntityIdKybGetResponsesContentApplicationJsonSchemaDataEdd": { "description": "The open enhanced due diligence (EDD) request while the entity is in EDD: Deel needs further answers from the client before it continues the review. Null otherwise, and null while the entity is in EDD when the questions could not be read (retry later).", "properties": { "id": { "description": "Public id of the EDD request. Send it as `edd_request_id` when answering.", "format": "uuid", "type": "string" }, "is_answerable_over_api": { "description": "False when the form has a required unsupported question. Contact Deel support to clear such a request.", "type": "boolean" }, "questions": { "description": "Every question of the EDD form, in form order.", "items": { "$ref": "#/components/schemas/LegalEntitiesLegalEntityIdKybGetResponsesContentApplicationJsonSchemaDataEddQuestionsItems" }, "type": "array" }, "requested_at": { "description": "When Deel requested the EDD.", "format": "date-time", "type": [ "string", "null" ] }, "status": { "$ref": "#/components/schemas/LegalEntitiesLegalEntityIdKybGetResponsesContentApplicationJsonSchemaDataEddStatus", "description": "`AWAITING_ANSWERS` until the answers are sent; `ANSWERED` once they are, until the entity is back in review." } }, "required": [ "id", "status", "questions", "requested_at", "is_answerable_over_api" ], "title": "LegalEntitiesLegalEntityIdKybGetResponsesContentApplicationJsonSchemaDataEdd", "type": "object" }, "LegalEntitiesLegalEntityIdKybGetResponsesContentApplicationJsonSchemaDataEddQuestionsItems": { "properties": { "description": { "description": "Helper text for the question, when any.", "type": [ "string", "null" ] }, "is_required": { "description": "Whether the question must currently be answered.", "type": "boolean" }, "key": { "description": "Key of the question within this EDD request, in form order. Send it as `question_key` when answering.", "type": "string" }, "options": { "description": "For `SINGLE_CHOICE` and `MULTIPLE_CHOICE` questions, the option titles to answer with. Null for every other type.", "items": { "type": "string" }, "type": [ "array", "null" ] }, "repeat_group": { "description": "Set when this question belongs to a repeatable group (e.g. \"add another director\"); null otherwise.", "oneOf": [ { "$ref": "#/components/schemas/LegalEntitiesLegalEntityIdKybGetResponsesContentApplicationJsonSchemaDataEddQuestionsItemsRepeatGroup" }, { "type": "null" } ] }, "revealed_when": { "description": "Conditions under which this question applies, met if any one of them does. Null when the question always applies. Only answer it when a condition is met.", "items": { "$ref": "#/components/schemas/LegalEntitiesLegalEntityIdKybGetResponsesContentApplicationJsonSchemaDataEddQuestionsItemsRevealedWhenItems" }, "type": [ "array", "null" ] }, "title": { "description": "The question as the reviewer wrote it.", "type": "string" }, "type": { "$ref": "#/components/schemas/LegalEntitiesLegalEntityIdKybGetResponsesContentApplicationJsonSchemaDataEddQuestionsItemsType", "description": "What kind of answer the question takes. `COUNTRY` takes an ISO 3166-1 alpha-2 code (e.g. `US`), `CURRENCY` an ISO 4217 code (e.g. `USD`) and `STATE` a state name (e.g. `California`), each as a string, or a list of strings when the form allows several. `DOCUMENT_UPLOAD` questions are answered with a list of document handles from `POST /rest/legal-entities/{legal_entity_id}/kyb/edd/documents`. `UNSUPPORTED` questions cannot be answered over the API; when one of them is required, `is_answerable_over_api` is false." } }, "required": [ "key", "type", "title", "options", "description", "is_required", "repeat_group", "revealed_when" ], "title": "LegalEntitiesLegalEntityIdKybGetResponsesContentApplicationJsonSchemaDataEddQuestionsItems", "type": "object" }, "LegalEntitiesLegalEntityIdKybGetResponsesContentApplicationJsonSchemaDataEddQuestionsItemsRepeatGroup": { "description": "Set when this question belongs to a repeatable group (e.g. \"add another director\"); null otherwise.", "properties": { "index": { "description": "Zero-based position of this question within its repeat group instance.", "type": "integer" }, "max_repeats": { "description": "Maximum number of instances of this group the form allows.", "type": "integer" }, "name": { "description": "Name of the repeatable group this question belongs to.", "type": "string" } }, "required": [ "name", "index", "max_repeats" ], "title": "LegalEntitiesLegalEntityIdKybGetResponsesContentApplicationJsonSchemaDataEddQuestionsItemsRepeatGroup", "type": "object" }, "LegalEntitiesLegalEntityIdKybGetResponsesContentApplicationJsonSchemaDataEddQuestionsItemsRevealedWhenItems": { "properties": { "equals": { "description": "Option title `question` must be answered with for this question to apply.", "type": "string" }, "question": { "description": "Key of the question whose answer gates this one.", "type": "string" } }, "required": [ "equals", "question" ], "title": "LegalEntitiesLegalEntityIdKybGetResponsesContentApplicationJsonSchemaDataEddQuestionsItemsRevealedWhenItems", "type": "object" }, "LegalEntitiesLegalEntityIdKybGetResponsesContentApplicationJsonSchemaDataEddQuestionsItemsType": { "description": "What kind of answer the question takes. `COUNTRY` takes an ISO 3166-1 alpha-2 code (e.g. `US`), `CURRENCY` an ISO 4217 code (e.g. `USD`) and `STATE` a state name (e.g. `California`), each as a string, or a list of strings when the form allows several. `DOCUMENT_UPLOAD` questions are answered with a list of document handles from `POST /rest/legal-entities/{legal_entity_id}/kyb/edd/documents`. `UNSUPPORTED` questions cannot be answered over the API; when one of them is required, `is_answerable_over_api` is false.", "enum": [ "TEXT", "LONG_TEXT", "NUMBER", "EMAIL", "PHONE_NUMBER", "DATE", "DATE_RANGE", "ADDRESS", "SINGLE_CHOICE", "MULTIPLE_CHOICE", "COUNTRY", "STATE", "CURRENCY", "DOCUMENT_UPLOAD", "UNSUPPORTED" ], "title": "LegalEntitiesLegalEntityIdKybGetResponsesContentApplicationJsonSchemaDataEddQuestionsItemsType", "type": "string" }, "LegalEntitiesLegalEntityIdKybGetResponsesContentApplicationJsonSchemaDataEddStatus": { "description": "`AWAITING_ANSWERS` until the answers are sent; `ANSWERED` once they are, until the entity is back in review.", "enum": [ "AWAITING_ANSWERS", "ANSWERED" ], "title": "LegalEntitiesLegalEntityIdKybGetResponsesContentApplicationJsonSchemaDataEddStatus", "type": "string" }, "LegalEntitiesLegalEntityIdKybGetResponsesContentApplicationJsonSchemaDataPersonsItems": { "properties": { "first_name": { "description": "First name as declared.", "type": "string" }, "id": { "description": "Public id of the declared person, when the verification service has assigned one.", "format": "uuid", "type": [ "string", "null" ] }, "last_name": { "description": "Last name as declared.", "type": "string" }, "ownership_percentage": { "description": "Declared ownership percentage for owners; null otherwise.", "format": "double", "type": [ "number", "null" ] }, "responsibilities": { "description": "Roles the person holds in the entity.", "items": { "$ref": "#/components/schemas/LegalEntitiesLegalEntityIdKybGetResponsesContentApplicationJsonSchemaDataPersonsItemsResponsibilitiesItems" }, "type": "array" } }, "required": [ "id", "last_name", "first_name", "responsibilities", "ownership_percentage" ], "title": "LegalEntitiesLegalEntityIdKybGetResponsesContentApplicationJsonSchemaDataPersonsItems", "type": "object" }, "LegalEntitiesLegalEntityIdKybGetResponsesContentApplicationJsonSchemaDataPersonsItemsResponsibilitiesItems": { "enum": [ "submitter", "controllingOfficer", "owner", "director" ], "title": "LegalEntitiesLegalEntityIdKybGetResponsesContentApplicationJsonSchemaDataPersonsItemsResponsibilitiesItems", "type": "string" }, "LegalEntitiesLegalEntityIdKybGetResponsesContentApplicationJsonSchemaDataRejection": { "description": "Present only when the entity was rejected; null otherwise.", "properties": { "rejected_at": { "description": "When the rejection was recorded.", "format": "date-time", "type": [ "string", "null" ] } }, "required": [ "rejected_at" ], "title": "LegalEntitiesLegalEntityIdKybGetResponsesContentApplicationJsonSchemaDataRejection", "type": "object" }, "LegalEntitiesLegalEntityIdKybGetResponsesContentApplicationJsonSchemaDataRequirementsItems": { "properties": { "category": { "$ref": "#/components/schemas/LegalEntitiesLegalEntityIdKybGetResponsesContentApplicationJsonSchemaDataRequirementsItemsCategory", "description": "What kind of input satisfies the requirement: a company field, a company document, or an attribute of a declared person." }, "is_satisfied": { "description": "Whether the current submission already satisfies the requirement.", "type": "boolean" }, "key": { "description": "Requirement key as published by the verification service, e.g. `FORMATION_DATE`, `ARTICLES_OF_INCORPORATION`, `PROOF_OF_AUTHORITY`, `UBO_NAME`, `DIRECTOR_KYC_DOCUMENT`. Person-level keys are prefixed with the role they constrain: `DIRECTOR_`, `CONTROLLING_OFFICER_`, `UBO_` or `SUBMITTER_`.", "type": "string" } }, "required": [ "key", "category", "is_satisfied" ], "title": "LegalEntitiesLegalEntityIdKybGetResponsesContentApplicationJsonSchemaDataRequirementsItems", "type": "object" }, "LegalEntitiesLegalEntityIdKybGetResponsesContentApplicationJsonSchemaDataRequirementsItemsCategory": { "description": "What kind of input satisfies the requirement: a company field, a company document, or an attribute of a declared person.", "enum": [ "FIELD", "DOCUMENT", "PERSON" ], "title": "LegalEntitiesLegalEntityIdKybGetResponsesContentApplicationJsonSchemaDataRequirementsItemsCategory", "type": "string" }, "LegalEntitiesLegalEntityIdKybGetResponsesContentApplicationJsonSchemaDataStatus": { "description": "The mapped lifecycle status of the legal entity, the same vocabulary as `status` on `GET /rest/legal-entities/{legal_entity_id}`.", "enum": [ "archived", "active", "draft", "processing", "processing_draft", "pending_verification", "awaiting_review", "unknown" ], "title": "LegalEntitiesLegalEntityIdKybGetResponsesContentApplicationJsonSchemaDataStatus", "type": "string" }, "LegalEntitiesLegalEntityIdKybGetResponsesContentApplicationJsonSchemaDataVerificationType": { "description": "Depth of verification the entity is subject to, when known.", "enum": [ "NONE", "LIGHT", "FULL" ], "title": "LegalEntitiesLegalEntityIdKybGetResponsesContentApplicationJsonSchemaDataVerificationType", "type": "string" }, "LegalEntitiesLegalEntityIdKybGetResponsesContentApplicationJsonSchemaErrorsItems": { "properties": { "code": { "description": "Machine-readable error code.", "type": "string" }, "message": { "description": "Human-readable explanation of the error.", "type": "string" } }, "required": [ "code", "message" ], "title": "LegalEntitiesLegalEntityIdKybGetResponsesContentApplicationJsonSchemaErrorsItems", "type": "object" }, "LegalEntitiesLegalEntityIdKybPostParametersXBeta": { "default": "true", "enum": [ "true" ], "title": "LegalEntitiesLegalEntityIdKybPostParametersXBeta", "type": "string" }, "LegalEntitiesLegalEntityIdKybPostRequestBodyContentApplicationJsonSchemaData": { "properties": { "documents": { "$ref": "#/components/schemas/LegalEntitiesLegalEntityIdKybPostRequestBodyContentApplicationJsonSchemaDataDocuments", "description": "Company documents as handles from the upload endpoint. Supply the ones the KYB state lists as required." }, "formation_date": { "description": "Company formation date, `YYYY-MM-DD`.", "format": "date", "type": "string" }, "is_declaration_confirmed": { "description": "Must be true: the client confirms the information is accurate and complete.", "type": "boolean" }, "is_person_with_significant_control": { "description": "Declares that the submitter personally holds significant control of the company (an owner, director or controlling officer) — the declared submitter in `persons[]` should hold one of those responsibilities too. An alternative to `proof_of_authority`: when `true`, the verification service waives the Proof of Authority document requirement. Omit or set `false` if the submitter is acting on the company's behalf without significant control themselves.", "type": "boolean" }, "is_terms_and_conditions_accepted": { "description": "Must be true: the client accepts the verification terms and conditions.", "type": "boolean" }, "persons": { "description": "Persons of significant control: directors, controlling officers, owners and the client-side submitter.", "items": { "$ref": "#/components/schemas/LegalEntitiesLegalEntityIdKybPostRequestBodyContentApplicationJsonSchemaDataPersonsItems" }, "type": "array" }, "proof_of_authority": { "$ref": "#/components/schemas/LegalEntitiesLegalEntityIdKybPostRequestBodyContentApplicationJsonSchemaDataProofOfAuthority", "description": "Proof of Authority for the person acting on behalf of the entity. Required when the KYB state lists `PROOF_OF_AUTHORITY` as outstanding, unless `is_person_with_significant_control` is `true`." }, "transaction_monthly_volume": { "$ref": "#/components/schemas/LegalEntitiesLegalEntityIdKybPostRequestBodyContentApplicationJsonSchemaDataTransactionMonthlyVolume", "description": "Expected monthly transaction volume range." } }, "required": [ "persons", "is_declaration_confirmed", "is_terms_and_conditions_accepted" ], "title": "LegalEntitiesLegalEntityIdKybPostRequestBodyContentApplicationJsonSchemaData", "type": "object" }, "LegalEntitiesLegalEntityIdKybPostRequestBodyContentApplicationJsonSchemaDataDocuments": { "description": "Company documents as handles from the upload endpoint. Supply the ones the KYB state lists as required.", "properties": { "articles_of_incorporation": { "description": "Handle of a document uploaded as `ARTICLES_OF_INCORPORATION`.", "format": "uuid", "type": "string" }, "certificate_of_good_standing": { "description": "Handle of a document uploaded as `CERTIFICATE_OF_GOOD_STANDING`.", "format": "uuid", "type": "string" }, "company_bank_statement": { "description": "Handle of a document uploaded as `COMPANY_BANK_STATEMENT`.", "format": "uuid", "type": "string" }, "ultimate_beneficial_owner_form": { "description": "Handle of a document uploaded as `ULTIMATE_BENEFICIAL_OWNER_FORM`.", "format": "uuid", "type": "string" } }, "title": "LegalEntitiesLegalEntityIdKybPostRequestBodyContentApplicationJsonSchemaDataDocuments", "type": "object" }, "LegalEntitiesLegalEntityIdKybPostRequestBodyContentApplicationJsonSchemaDataPersonsItems": { "properties": { "address": { "$ref": "#/components/schemas/LegalEntitiesLegalEntityIdKybPostRequestBodyContentApplicationJsonSchemaDataPersonsItemsAddress", "description": "Residential address." }, "citizenship": { "description": "Citizenship as an ISO 3166-1 alpha-2 country code.", "type": "string" }, "date_of_birth": { "description": "Date of birth, `YYYY-MM-DD`.", "format": "date", "type": "string" }, "first_name": { "description": "First name.", "maxLength": 255, "type": "string" }, "identification_document_type": { "$ref": "#/components/schemas/LegalEntitiesLegalEntityIdKybPostRequestBodyContentApplicationJsonSchemaDataPersonsItemsIdentificationDocumentType", "description": "Type of the identity document supplied in `identity_documents`." }, "identity_documents": { "$ref": "#/components/schemas/LegalEntitiesLegalEntityIdKybPostRequestBodyContentApplicationJsonSchemaDataPersonsItemsIdentityDocuments", "description": "Identity document sides and selfie for the person, as upload handles." }, "job_title": { "$ref": "#/components/schemas/LegalEntitiesLegalEntityIdKybPostRequestBodyContentApplicationJsonSchemaDataPersonsItemsJobTitle", "description": "Role of the person in the company, from the verification service vocabulary; required for controlling officers when the verification service asks for it." }, "last_name": { "description": "Last name.", "maxLength": 255, "type": "string" }, "middle_name": { "description": "Middle name, when any.", "maxLength": 255, "type": [ "string", "null" ] }, "ownership_percentage": { "description": "Ownership percentage; required for owners when the verification service asks for it.", "format": "double", "maximum": 100, "minimum": 0, "type": "number" }, "responsibilities": { "description": "Roles the person holds in the entity. `submitter` marks the person who authorised the submission on the client side.", "items": { "$ref": "#/components/schemas/LegalEntitiesLegalEntityIdKybPostRequestBodyContentApplicationJsonSchemaDataPersonsItemsResponsibilitiesItems" }, "type": "array" }, "tax_id": { "description": "Personal tax identifier.", "maxLength": 64, "type": "string" } }, "required": [ "last_name", "first_name", "responsibilities" ], "title": "LegalEntitiesLegalEntityIdKybPostRequestBodyContentApplicationJsonSchemaDataPersonsItems", "type": "object" }, "LegalEntitiesLegalEntityIdKybPostRequestBodyContentApplicationJsonSchemaDataPersonsItemsAddress": { "description": "Residential address.", "properties": { "city": { "description": "City.", "maxLength": 255, "type": "string" }, "country": { "description": "ISO 3166-1 alpha-2 country code.", "type": "string" }, "state": { "description": "State or province. Required for US addresses, as a 2-letter ISO 3166-2 code (e.g. `CA`).", "maxLength": 64, "type": [ "string", "null" ] }, "street": { "description": "Street address.", "maxLength": 255, "type": "string" }, "zip": { "description": "Postal code.", "maxLength": 32, "type": "string" } }, "required": [ "zip", "city", "street", "country" ], "title": "LegalEntitiesLegalEntityIdKybPostRequestBodyContentApplicationJsonSchemaDataPersonsItemsAddress", "type": "object" }, "LegalEntitiesLegalEntityIdKybPostRequestBodyContentApplicationJsonSchemaDataPersonsItemsIdentificationDocumentType": { "description": "Type of the identity document supplied in `identity_documents`.", "enum": [ "PASSPORT", "DRIVERS_LICENSE", "ID_DOCUMENT" ], "title": "LegalEntitiesLegalEntityIdKybPostRequestBodyContentApplicationJsonSchemaDataPersonsItemsIdentificationDocumentType", "type": "string" }, "LegalEntitiesLegalEntityIdKybPostRequestBodyContentApplicationJsonSchemaDataPersonsItemsIdentityDocuments": { "description": "Identity document sides and selfie for the person, as upload handles.", "properties": { "back": { "description": "Handle of a document uploaded as `IDENTITY_DOCUMENT_BACK`. Not needed for passports.", "format": "uuid", "type": "string" }, "front": { "description": "Handle of a document uploaded as `IDENTITY_DOCUMENT_FRONT`.", "format": "uuid", "type": "string" }, "selfie": { "description": "Handle of a document uploaded as `SELFIE`.", "format": "uuid", "type": "string" } }, "title": "LegalEntitiesLegalEntityIdKybPostRequestBodyContentApplicationJsonSchemaDataPersonsItemsIdentityDocuments", "type": "object" }, "LegalEntitiesLegalEntityIdKybPostRequestBodyContentApplicationJsonSchemaDataPersonsItemsJobTitle": { "description": "Role of the person in the company, from the verification service vocabulary; required for controlling officers when the verification service asks for it.", "enum": [ "FOUNDER", "MAJOR_SHAREHOLDER", "MINORITY_SHAREHOLDER", "EQUITY_PARTNER", "EXECUTIVE_C_LEVEL", "MANAGING_DIRECTOR", "DIRECTOR", "PRESIDENT", "VICE_PRESIDENT", "SENIOR_MANAGEMENT_OFFICIAL", "AUTHORIZED_SIGNATORY", "OTHER" ], "title": "LegalEntitiesLegalEntityIdKybPostRequestBodyContentApplicationJsonSchemaDataPersonsItemsJobTitle", "type": "string" }, "LegalEntitiesLegalEntityIdKybPostRequestBodyContentApplicationJsonSchemaDataPersonsItemsResponsibilitiesItems": { "enum": [ "submitter", "controllingOfficer", "owner", "director" ], "title": "LegalEntitiesLegalEntityIdKybPostRequestBodyContentApplicationJsonSchemaDataPersonsItemsResponsibilitiesItems", "type": "string" }, "LegalEntitiesLegalEntityIdKybPostRequestBodyContentApplicationJsonSchemaDataProofOfAuthority": { "description": "Proof of Authority for the person acting on behalf of the entity. Required when the KYB state lists `PROOF_OF_AUTHORITY` as outstanding, unless `is_person_with_significant_control` is `true`.", "properties": { "document": { "description": "Handle of a document uploaded as `PROOF_OF_AUTHORITY`.", "format": "uuid", "type": "string" }, "meta_type": { "$ref": "#/components/schemas/LegalEntitiesLegalEntityIdKybPostRequestBodyContentApplicationJsonSchemaDataProofOfAuthorityMetaType", "description": "What kind of document evidences the authority: a power of attorney, a board resolution or minutes, or another document." } }, "required": [ "document", "meta_type" ], "title": "LegalEntitiesLegalEntityIdKybPostRequestBodyContentApplicationJsonSchemaDataProofOfAuthority", "type": "object" }, "LegalEntitiesLegalEntityIdKybPostRequestBodyContentApplicationJsonSchemaDataProofOfAuthorityMetaType": { "description": "What kind of document evidences the authority: a power of attorney, a board resolution or minutes, or another document.", "enum": [ "POWER_OF_ATTORNEY", "RESOLUTION_OR_MINUTES", "OTHER" ], "title": "LegalEntitiesLegalEntityIdKybPostRequestBodyContentApplicationJsonSchemaDataProofOfAuthorityMetaType", "type": "string" }, "LegalEntitiesLegalEntityIdKybPostRequestBodyContentApplicationJsonSchemaDataTransactionMonthlyVolume": { "description": "Expected monthly transaction volume range.", "enum": [ "LESS_THAN_1K", "BETWEEN_1K_AND_10K", "BETWEEN_10K_AND_100K", "BETWEEN_100K_AND_1M", "GREATER_THAN_1M" ], "title": "LegalEntitiesLegalEntityIdKybPostRequestBodyContentApplicationJsonSchemaDataTransactionMonthlyVolume", "type": "string" }, "LegalEntitiesLegalEntityIdKybPostResponsesContentApplicationJsonSchemaData": { "properties": { "approved_at": { "description": "When the entity was approved; null otherwise.", "format": "date-time", "type": [ "string", "null" ] }, "documents": { "description": "Presence of every company-level document type. Null when `is_detail_available` is false.", "items": { "$ref": "#/components/schemas/LegalEntitiesLegalEntityIdKybPostResponsesContentApplicationJsonSchemaDataDocumentsItems" }, "type": [ "array", "null" ] }, "edd": { "description": "The open enhanced due diligence (EDD) request while the entity is in EDD: Deel needs further answers from the client before it continues the review. Null otherwise, and null while the entity is in EDD when the questions could not be read (retry later).", "oneOf": [ { "$ref": "#/components/schemas/LegalEntitiesLegalEntityIdKybPostResponsesContentApplicationJsonSchemaDataEdd" }, { "type": "null" } ] }, "is_action_required": { "description": "True while the entity is waiting on the client: `PENDING`, `DRAFT`, or `EDD` (enhanced due diligence — Ops needs something further from the client). False while Deel is reviewing or once the entity is approved, rejected or exempt.", "type": "boolean" }, "is_detail_available": { "description": "False when the verification service could not be read. Every detail block (`requirements`, `documents`, `proof_of_authority`, `persons`, `rejection`) is then null. Retry later; the status fields are still authoritative.", "type": "boolean" }, "legal_entity_id": { "description": "Public id of the legal entity.", "format": "uuid", "type": "string" }, "persons": { "description": "Declared persons of significant control: directors, controlling officers, owners and the submitter. Identity documents are reported by presence only. Null when `is_detail_available` is false.", "items": { "$ref": "#/components/schemas/LegalEntitiesLegalEntityIdKybPostResponsesContentApplicationJsonSchemaDataPersonsItems" }, "type": [ "array", "null" ] }, "rejected_at": { "description": "When the entity was last rejected; null otherwise.", "format": "date-time", "type": [ "string", "null" ] }, "rejection": { "description": "Present only when the entity was rejected; null otherwise.", "oneOf": [ { "$ref": "#/components/schemas/LegalEntitiesLegalEntityIdKybPostResponsesContentApplicationJsonSchemaDataRejection" }, { "type": "null" } ] }, "requirements": { "description": "Everything the verification service currently requires for this entity, with whether each item is already satisfied. Empty when verification is not required. Null when `is_detail_available` is false.", "items": { "$ref": "#/components/schemas/LegalEntitiesLegalEntityIdKybPostResponsesContentApplicationJsonSchemaDataRequirementsItems" }, "type": [ "array", "null" ] }, "status": { "$ref": "#/components/schemas/LegalEntitiesLegalEntityIdKybPostResponsesContentApplicationJsonSchemaDataStatus", "description": "The mapped lifecycle status of the legal entity, the same vocabulary as `status` on `GET /rest/legal-entities/{legal_entity_id}`." }, "submitted_at": { "description": "When the verification record was created; null before the first submission.", "format": "date-time", "type": [ "string", "null" ] }, "verification_type": { "description": "Depth of verification the entity is subject to, when known.", "oneOf": [ { "$ref": "#/components/schemas/LegalEntitiesLegalEntityIdKybPostResponsesContentApplicationJsonSchemaDataVerificationType" }, { "type": "null" } ] } }, "required": [ "edd", "status", "persons", "documents", "rejection", "approved_at", "rejected_at", "requirements", "submitted_at", "legal_entity_id", "verification_type", "is_action_required", "is_detail_available" ], "title": "LegalEntitiesLegalEntityIdKybPostResponsesContentApplicationJsonSchemaData", "type": "object" }, "LegalEntitiesLegalEntityIdKybPostResponsesContentApplicationJsonSchemaDataDocumentsItems": { "properties": { "is_provided": { "description": "Whether a file for this document has been submitted. File contents and URLs are never returned.", "type": "boolean" }, "is_required": { "description": "Whether the verification service currently requires this document.", "type": "boolean" }, "meta_type": { "description": "Kind of Proof of Authority document, when this entry's type is PROOF_OF_AUTHORITY. Null for every other document type.", "oneOf": [ { "$ref": "#/components/schemas/LegalEntitiesLegalEntityIdKybPostResponsesContentApplicationJsonSchemaDataDocumentsItemsMetaType" }, { "type": "null" } ] }, "type": { "$ref": "#/components/schemas/LegalEntitiesLegalEntityIdKybPostResponsesContentApplicationJsonSchemaDataDocumentsItemsType", "description": "Company-level document type." } }, "required": [ "type", "meta_type", "is_provided", "is_required" ], "title": "LegalEntitiesLegalEntityIdKybPostResponsesContentApplicationJsonSchemaDataDocumentsItems", "type": "object" }, "LegalEntitiesLegalEntityIdKybPostResponsesContentApplicationJsonSchemaDataDocumentsItemsMetaType": { "description": "Kind of Proof of Authority document, when this entry's type is PROOF_OF_AUTHORITY. Null for every other document type.", "enum": [ "POWER_OF_ATTORNEY", "RESOLUTION_OR_MINUTES", "OTHER" ], "title": "LegalEntitiesLegalEntityIdKybPostResponsesContentApplicationJsonSchemaDataDocumentsItemsMetaType", "type": "string" }, "LegalEntitiesLegalEntityIdKybPostResponsesContentApplicationJsonSchemaDataDocumentsItemsType": { "description": "Company-level document type.", "enum": [ "PROOF_OF_AUTHORITY", "ARTICLES_OF_INCORPORATION", "COMPANY_BANK_STATEMENT", "LIST_OF_DIRECTORS", "CERTIFICATE_OF_GOOD_STANDING", "ULTIMATE_BENEFICIAL_OWNER_FORM" ], "title": "LegalEntitiesLegalEntityIdKybPostResponsesContentApplicationJsonSchemaDataDocumentsItemsType", "type": "string" }, "LegalEntitiesLegalEntityIdKybPostResponsesContentApplicationJsonSchemaDataEdd": { "description": "The open enhanced due diligence (EDD) request while the entity is in EDD: Deel needs further answers from the client before it continues the review. Null otherwise, and null while the entity is in EDD when the questions could not be read (retry later).", "properties": { "id": { "description": "Public id of the EDD request. Send it as `edd_request_id` when answering.", "format": "uuid", "type": "string" }, "is_answerable_over_api": { "description": "False when the form has a required unsupported question. Contact Deel support to clear such a request.", "type": "boolean" }, "questions": { "description": "Every question of the EDD form, in form order.", "items": { "$ref": "#/components/schemas/LegalEntitiesLegalEntityIdKybPostResponsesContentApplicationJsonSchemaDataEddQuestionsItems" }, "type": "array" }, "requested_at": { "description": "When Deel requested the EDD.", "format": "date-time", "type": [ "string", "null" ] }, "status": { "$ref": "#/components/schemas/LegalEntitiesLegalEntityIdKybPostResponsesContentApplicationJsonSchemaDataEddStatus", "description": "`AWAITING_ANSWERS` until the answers are sent; `ANSWERED` once they are, until the entity is back in review." } }, "required": [ "id", "status", "questions", "requested_at", "is_answerable_over_api" ], "title": "LegalEntitiesLegalEntityIdKybPostResponsesContentApplicationJsonSchemaDataEdd", "type": "object" }, "LegalEntitiesLegalEntityIdKybPostResponsesContentApplicationJsonSchemaDataEddQuestionsItems": { "properties": { "description": { "description": "Helper text for the question, when any.", "type": [ "string", "null" ] }, "is_required": { "description": "Whether the question must currently be answered.", "type": "boolean" }, "key": { "description": "Key of the question within this EDD request, in form order. Send it as `question_key` when answering.", "type": "string" }, "options": { "description": "For `SINGLE_CHOICE` and `MULTIPLE_CHOICE` questions, the option titles to answer with. Null for every other type.", "items": { "type": "string" }, "type": [ "array", "null" ] }, "repeat_group": { "description": "Set when this question belongs to a repeatable group (e.g. \"add another director\"); null otherwise.", "oneOf": [ { "$ref": "#/components/schemas/LegalEntitiesLegalEntityIdKybPostResponsesContentApplicationJsonSchemaDataEddQuestionsItemsRepeatGroup" }, { "type": "null" } ] }, "revealed_when": { "description": "Conditions under which this question applies, met if any one of them does. Null when the question always applies. Only answer it when a condition is met.", "items": { "$ref": "#/components/schemas/LegalEntitiesLegalEntityIdKybPostResponsesContentApplicationJsonSchemaDataEddQuestionsItemsRevealedWhenItems" }, "type": [ "array", "null" ] }, "title": { "description": "The question as the reviewer wrote it.", "type": "string" }, "type": { "$ref": "#/components/schemas/LegalEntitiesLegalEntityIdKybPostResponsesContentApplicationJsonSchemaDataEddQuestionsItemsType", "description": "What kind of answer the question takes. `COUNTRY` takes an ISO 3166-1 alpha-2 code (e.g. `US`), `CURRENCY` an ISO 4217 code (e.g. `USD`) and `STATE` a state name (e.g. `California`), each as a string, or a list of strings when the form allows several. `DOCUMENT_UPLOAD` questions are answered with a list of document handles from `POST /rest/legal-entities/{legal_entity_id}/kyb/edd/documents`. `UNSUPPORTED` questions cannot be answered over the API; when one of them is required, `is_answerable_over_api` is false." } }, "required": [ "key", "type", "title", "options", "description", "is_required", "repeat_group", "revealed_when" ], "title": "LegalEntitiesLegalEntityIdKybPostResponsesContentApplicationJsonSchemaDataEddQuestionsItems", "type": "object" }, "LegalEntitiesLegalEntityIdKybPostResponsesContentApplicationJsonSchemaDataEddQuestionsItemsRepeatGroup": { "description": "Set when this question belongs to a repeatable group (e.g. \"add another director\"); null otherwise.", "properties": { "index": { "description": "Zero-based position of this question within its repeat group instance.", "type": "integer" }, "max_repeats": { "description": "Maximum number of instances of this group the form allows.", "type": "integer" }, "name": { "description": "Name of the repeatable group this question belongs to.", "type": "string" } }, "required": [ "name", "index", "max_repeats" ], "title": "LegalEntitiesLegalEntityIdKybPostResponsesContentApplicationJsonSchemaDataEddQuestionsItemsRepeatGroup", "type": "object" }, "LegalEntitiesLegalEntityIdKybPostResponsesContentApplicationJsonSchemaDataEddQuestionsItemsRevealedWhenItems": { "properties": { "equals": { "description": "Option title `question` must be answered with for this question to apply.", "type": "string" }, "question": { "description": "Key of the question whose answer gates this one.", "type": "string" } }, "required": [ "equals", "question" ], "title": "LegalEntitiesLegalEntityIdKybPostResponsesContentApplicationJsonSchemaDataEddQuestionsItemsRevealedWhenItems", "type": "object" }, "LegalEntitiesLegalEntityIdKybPostResponsesContentApplicationJsonSchemaDataEddQuestionsItemsType": { "description": "What kind of answer the question takes. `COUNTRY` takes an ISO 3166-1 alpha-2 code (e.g. `US`), `CURRENCY` an ISO 4217 code (e.g. `USD`) and `STATE` a state name (e.g. `California`), each as a string, or a list of strings when the form allows several. `DOCUMENT_UPLOAD` questions are answered with a list of document handles from `POST /rest/legal-entities/{legal_entity_id}/kyb/edd/documents`. `UNSUPPORTED` questions cannot be answered over the API; when one of them is required, `is_answerable_over_api` is false.", "enum": [ "TEXT", "LONG_TEXT", "NUMBER", "EMAIL", "PHONE_NUMBER", "DATE", "DATE_RANGE", "ADDRESS", "SINGLE_CHOICE", "MULTIPLE_CHOICE", "COUNTRY", "STATE", "CURRENCY", "DOCUMENT_UPLOAD", "UNSUPPORTED" ], "title": "LegalEntitiesLegalEntityIdKybPostResponsesContentApplicationJsonSchemaDataEddQuestionsItemsType", "type": "string" }, "LegalEntitiesLegalEntityIdKybPostResponsesContentApplicationJsonSchemaDataEddStatus": { "description": "`AWAITING_ANSWERS` until the answers are sent; `ANSWERED` once they are, until the entity is back in review.", "enum": [ "AWAITING_ANSWERS", "ANSWERED" ], "title": "LegalEntitiesLegalEntityIdKybPostResponsesContentApplicationJsonSchemaDataEddStatus", "type": "string" }, "LegalEntitiesLegalEntityIdKybPostResponsesContentApplicationJsonSchemaDataPersonsItems": { "properties": { "first_name": { "description": "First name as declared.", "type": "string" }, "id": { "description": "Public id of the declared person, when the verification service has assigned one.", "format": "uuid", "type": [ "string", "null" ] }, "last_name": { "description": "Last name as declared.", "type": "string" }, "ownership_percentage": { "description": "Declared ownership percentage for owners; null otherwise.", "format": "double", "type": [ "number", "null" ] }, "responsibilities": { "description": "Roles the person holds in the entity.", "items": { "$ref": "#/components/schemas/LegalEntitiesLegalEntityIdKybPostResponsesContentApplicationJsonSchemaDataPersonsItemsResponsibilitiesItems" }, "type": "array" } }, "required": [ "id", "last_name", "first_name", "responsibilities", "ownership_percentage" ], "title": "LegalEntitiesLegalEntityIdKybPostResponsesContentApplicationJsonSchemaDataPersonsItems", "type": "object" }, "LegalEntitiesLegalEntityIdKybPostResponsesContentApplicationJsonSchemaDataPersonsItemsResponsibilitiesItems": { "enum": [ "submitter", "controllingOfficer", "owner", "director" ], "title": "LegalEntitiesLegalEntityIdKybPostResponsesContentApplicationJsonSchemaDataPersonsItemsResponsibilitiesItems", "type": "string" }, "LegalEntitiesLegalEntityIdKybPostResponsesContentApplicationJsonSchemaDataRejection": { "description": "Present only when the entity was rejected; null otherwise.", "properties": { "rejected_at": { "description": "When the rejection was recorded.", "format": "date-time", "type": [ "string", "null" ] } }, "required": [ "rejected_at" ], "title": "LegalEntitiesLegalEntityIdKybPostResponsesContentApplicationJsonSchemaDataRejection", "type": "object" }, "LegalEntitiesLegalEntityIdKybPostResponsesContentApplicationJsonSchemaDataRequirementsItems": { "properties": { "category": { "$ref": "#/components/schemas/LegalEntitiesLegalEntityIdKybPostResponsesContentApplicationJsonSchemaDataRequirementsItemsCategory", "description": "What kind of input satisfies the requirement: a company field, a company document, or an attribute of a declared person." }, "is_satisfied": { "description": "Whether the current submission already satisfies the requirement.", "type": "boolean" }, "key": { "description": "Requirement key as published by the verification service, e.g. `FORMATION_DATE`, `ARTICLES_OF_INCORPORATION`, `PROOF_OF_AUTHORITY`, `UBO_NAME`, `DIRECTOR_KYC_DOCUMENT`. Person-level keys are prefixed with the role they constrain: `DIRECTOR_`, `CONTROLLING_OFFICER_`, `UBO_` or `SUBMITTER_`.", "type": "string" } }, "required": [ "key", "category", "is_satisfied" ], "title": "LegalEntitiesLegalEntityIdKybPostResponsesContentApplicationJsonSchemaDataRequirementsItems", "type": "object" }, "LegalEntitiesLegalEntityIdKybPostResponsesContentApplicationJsonSchemaDataRequirementsItemsCategory": { "description": "What kind of input satisfies the requirement: a company field, a company document, or an attribute of a declared person.", "enum": [ "FIELD", "DOCUMENT", "PERSON" ], "title": "LegalEntitiesLegalEntityIdKybPostResponsesContentApplicationJsonSchemaDataRequirementsItemsCategory", "type": "string" }, "LegalEntitiesLegalEntityIdKybPostResponsesContentApplicationJsonSchemaDataStatus": { "description": "The mapped lifecycle status of the legal entity, the same vocabulary as `status` on `GET /rest/legal-entities/{legal_entity_id}`.", "enum": [ "archived", "active", "draft", "processing", "processing_draft", "pending_verification", "awaiting_review", "unknown" ], "title": "LegalEntitiesLegalEntityIdKybPostResponsesContentApplicationJsonSchemaDataStatus", "type": "string" }, "LegalEntitiesLegalEntityIdKybPostResponsesContentApplicationJsonSchemaDataVerificationType": { "description": "Depth of verification the entity is subject to, when known.", "enum": [ "NONE", "LIGHT", "FULL" ], "title": "LegalEntitiesLegalEntityIdKybPostResponsesContentApplicationJsonSchemaDataVerificationType", "type": "string" }, "LegalEntitiesLegalEntityIdKybPostResponsesContentApplicationJsonSchemaErrorsItems": { "properties": { "code": { "$ref": "#/components/schemas/LegalEntitiesLegalEntityIdKybPostResponsesContentApplicationJsonSchemaErrorsItemsCode", "description": "Machine-readable error code." }, "details": { "$ref": "#/components/schemas/LegalEntitiesLegalEntityIdKybPostResponsesContentApplicationJsonSchemaErrorsItemsDetails", "description": "Which request field the error refers to and, for a content-type or document-type error, the accepted values." }, "message": { "description": "Human-readable explanation of the error.", "type": "string" } }, "required": [ "code", "message" ], "title": "LegalEntitiesLegalEntityIdKybPostResponsesContentApplicationJsonSchemaErrorsItems", "type": "object" }, "LegalEntitiesLegalEntityIdKybPostResponsesContentApplicationJsonSchemaErrorsItemsCode": { "description": "Machine-readable error code.", "enum": [ "KYB_VERIFICATION_UNAVAILABLE" ], "title": "LegalEntitiesLegalEntityIdKybPostResponsesContentApplicationJsonSchemaErrorsItemsCode", "type": "string" }, "LegalEntitiesLegalEntityIdKybPostResponsesContentApplicationJsonSchemaErrorsItemsDetails": { "description": "Which request field the error refers to and, for a content-type or document-type error, the accepted values.", "properties": { "allowed": { "description": "Accepted values for the field.", "items": { "type": "string" }, "type": "array" }, "key": { "description": "The request field the error refers to.", "type": "string" }, "keys": { "description": "Every offending request field, for a multi-field error.", "items": { "type": "string" }, "type": "array" } }, "title": "LegalEntitiesLegalEntityIdKybPostResponsesContentApplicationJsonSchemaErrorsItemsDetails", "type": "object" }, "LegalEntitiesLegalEntityIdPayrollEventsGetResponsesContentApplicationJsonSchemaDataItems": { "properties": { "date_end": { "description": "The end date of the payroll cycle.", "format": "date-time", "type": "string" }, "date_start": { "description": "The start date of the payroll cycle.", "format": "date-time", "type": "string" }, "has_g2n_report": { "description": "Indicates whether a Gross-to-Net report is available for this payroll cycle. True only when the cycle is in a published state and a report without blocking errors exists.", "type": "boolean" }, "id": { "description": "The unique identifier for the payroll cycle.", "type": "string" }, "legal_entity_id": { "description": "The unique identifier for the associated legal entity.", "type": "string" }, "payroll_group_id": { "description": "The unique identifier for the payroll group.", "type": [ "string", "null" ] }, "type": { "$ref": "#/components/schemas/LegalEntitiesLegalEntityIdPayrollEventsGetResponsesContentApplicationJsonSchemaDataItemsType", "description": "The type of payroll cycle (e.g., OFFCYCLE, REGULAR)." } }, "title": "LegalEntitiesLegalEntityIdPayrollEventsGetResponsesContentApplicationJsonSchemaDataItems", "type": "object" }, "LegalEntitiesLegalEntityIdPayrollEventsGetResponsesContentApplicationJsonSchemaDataItemsType": { "description": "The type of payroll cycle (e.g., OFFCYCLE, REGULAR).", "enum": [ "OFFCYCLE", "REGULAR" ], "title": "LegalEntitiesLegalEntityIdPayrollEventsGetResponsesContentApplicationJsonSchemaDataItemsType", "type": "string" }, "LegalEntitiesLegalEntityIdPayrollEventsGetResponsesContentApplicationJsonSchemaErrorsItems": { "properties": { "code": { "description": "Machine-readable error code", "type": "string" }, "message": { "description": "Human-readable explanation of the error", "type": "string" } }, "title": "LegalEntitiesLegalEntityIdPayrollEventsGetResponsesContentApplicationJsonSchemaErrorsItems", "type": "object" }, "LegalEntitiesLegalEntityIdRegistrationDocumentsDocumentIdDeleteResponsesContentApplicationJsonSchemaErrorsItems": { "properties": { "code": { "description": "Machine-readable error code", "maxLength": 255, "type": "string" }, "field": { "description": "Field that caused the error, if applicable.", "type": [ "string", "null" ] }, "message": { "description": "Human-readable explanation", "type": "string" } }, "required": [ "message" ], "title": "LegalEntitiesLegalEntityIdRegistrationDocumentsDocumentIdDeleteResponsesContentApplicationJsonSchemaErrorsItems", "type": "object" }, "LegalEntitiesLegalEntityIdRegistrationDocumentsDocumentIdFilesDeleteRequestBodyContentApplicationJsonSchemaData": { "properties": { "file_ids": { "description": "Public UUIDs of the files to remove.", "items": { "format": "uuid", "type": "string" }, "type": "array" } }, "required": [ "file_ids" ], "title": "LegalEntitiesLegalEntityIdRegistrationDocumentsDocumentIdFilesDeleteRequestBodyContentApplicationJsonSchemaData", "type": "object" }, "LegalEntitiesLegalEntityIdRegistrationDocumentsDocumentIdFilesDeleteResponsesContentApplicationJsonSchemaErrorsItems": { "properties": { "code": { "description": "Machine-readable error code", "maxLength": 255, "type": "string" }, "field": { "description": "Field that caused the error, if applicable.", "type": [ "string", "null" ] }, "message": { "description": "Human-readable explanation", "type": "string" } }, "required": [ "message" ], "title": "LegalEntitiesLegalEntityIdRegistrationDocumentsDocumentIdFilesDeleteResponsesContentApplicationJsonSchemaErrorsItems", "type": "object" }, "LegalEntitiesLegalEntityIdRegistrationDocumentsDocumentIdFilesFileIdDownloadGetResponsesContentApplicationJsonSchemaData": { "properties": { "url": { "description": "Time-limited download URL. Expires shortly after issue, so fetch it rather than storing it.", "type": "string" } }, "required": [ "url" ], "title": "LegalEntitiesLegalEntityIdRegistrationDocumentsDocumentIdFilesFileIdDownloadGetResponsesContentApplicationJsonSchemaData", "type": "object" }, "LegalEntitiesLegalEntityIdRegistrationDocumentsDocumentIdFilesFileIdDownloadGetResponsesContentApplicationJsonSchemaErrorsItems": { "properties": { "code": { "description": "Machine-readable error code", "maxLength": 255, "type": "string" }, "field": { "description": "Field that caused the error, if applicable.", "type": [ "string", "null" ] }, "message": { "description": "Human-readable explanation", "type": "string" } }, "required": [ "message" ], "title": "LegalEntitiesLegalEntityIdRegistrationDocumentsDocumentIdFilesFileIdDownloadGetResponsesContentApplicationJsonSchemaErrorsItems", "type": "object" }, "LegalEntitiesLegalEntityIdRegistrationDocumentsDocumentIdGetResponsesContentApplicationJsonSchemaData": { "properties": { "archived_at": { "description": "When the submission was archived.", "format": "date-time", "type": [ "string", "null" ] }, "archived_submissions_count": { "description": "How many superseded revisions exist.", "minimum": 0, "type": "integer" }, "children": { "description": "Superseded revisions of this submission, newest first.", "items": { "$ref": "#/components/schemas/LegalEntitiesLegalEntityIdRegistrationDocumentsDocumentIdGetResponsesContentApplicationJsonSchemaDataChildrenItems" }, "type": "array" }, "files": { "description": "Files attached to this submission.", "items": { "$ref": "#/components/schemas/LegalEntitiesLegalEntityIdRegistrationDocumentsDocumentIdGetResponsesContentApplicationJsonSchemaDataFilesItems" }, "type": "array" }, "id": { "description": "Public UUID of the submission. Null when nothing has been submitted for this requirement yet.", "format": "uuid", "type": [ "string", "null" ] }, "legal_entity": { "description": "The legal entity the document belongs to.", "oneOf": [ { "$ref": "#/components/schemas/LegalEntitiesLegalEntityIdRegistrationDocumentsDocumentIdGetResponsesContentApplicationJsonSchemaDataLegalEntity" }, { "type": "null" } ] }, "parent": { "description": "The submission this one replaced, when it is a resubmission.", "oneOf": [ { "$ref": "#/components/schemas/LegalEntitiesLegalEntityIdRegistrationDocumentsDocumentIdGetResponsesContentApplicationJsonSchemaDataParent" }, { "type": "null" } ] }, "rejection_reason": { "description": "Why the submission was rejected, when applicable.", "type": [ "string", "null" ] }, "requirement": { "description": "The document requirement this submission answers.", "oneOf": [ { "$ref": "#/components/schemas/LegalEntitiesLegalEntityIdRegistrationDocumentsDocumentIdGetResponsesContentApplicationJsonSchemaDataRequirement" }, { "type": "null" } ] }, "reviewed_at": { "description": "When the document was reviewed.", "format": "date-time", "type": [ "string", "null" ] }, "status": { "$ref": "#/components/schemas/LegalEntitiesLegalEntityIdRegistrationDocumentsDocumentIdGetResponsesContentApplicationJsonSchemaDataStatus", "description": "Current review status." }, "submission_due_date": { "description": "When the document is due.", "format": "date-time", "type": [ "string", "null" ] }, "submitted_at": { "description": "When the document was submitted.", "format": "date-time", "type": [ "string", "null" ] } }, "required": [ "id", "status" ], "title": "LegalEntitiesLegalEntityIdRegistrationDocumentsDocumentIdGetResponsesContentApplicationJsonSchemaData", "type": "object" }, "LegalEntitiesLegalEntityIdRegistrationDocumentsDocumentIdGetResponsesContentApplicationJsonSchemaDataChildrenItems": { "properties": { "archived_at": { "description": "When the submission was archived.", "format": "date-time", "type": [ "string", "null" ] }, "files": { "description": "Files attached to this submission.", "items": { "$ref": "#/components/schemas/LegalEntitiesLegalEntityIdRegistrationDocumentsDocumentIdGetResponsesContentApplicationJsonSchemaDataChildrenItemsFilesItems" }, "type": "array" }, "id": { "description": "Public UUID of the submission. Null when nothing has been submitted for this requirement yet.", "format": "uuid", "type": [ "string", "null" ] }, "rejection_reason": { "description": "Why the submission was rejected, when applicable.", "type": [ "string", "null" ] }, "reviewed_at": { "description": "When the document was reviewed.", "format": "date-time", "type": [ "string", "null" ] }, "status": { "$ref": "#/components/schemas/LegalEntitiesLegalEntityIdRegistrationDocumentsDocumentIdGetResponsesContentApplicationJsonSchemaDataChildrenItemsStatus", "description": "Current review status." }, "submitted_at": { "description": "When the document was submitted.", "format": "date-time", "type": [ "string", "null" ] } }, "required": [ "id", "status" ], "title": "LegalEntitiesLegalEntityIdRegistrationDocumentsDocumentIdGetResponsesContentApplicationJsonSchemaDataChildrenItems", "type": "object" }, "LegalEntitiesLegalEntityIdRegistrationDocumentsDocumentIdGetResponsesContentApplicationJsonSchemaDataChildrenItemsFilesItems": { "properties": { "content_type": { "description": "MIME type of the file.", "type": [ "string", "null" ] }, "id": { "description": "Public UUID of the file.", "format": "uuid", "type": "string" }, "original_filename": { "description": "Filename as uploaded.", "type": "string" }, "uploaded_at": { "description": "When the file was uploaded.", "format": "date-time", "type": [ "string", "null" ] } }, "required": [ "id", "original_filename" ], "title": "LegalEntitiesLegalEntityIdRegistrationDocumentsDocumentIdGetResponsesContentApplicationJsonSchemaDataChildrenItemsFilesItems", "type": "object" }, "LegalEntitiesLegalEntityIdRegistrationDocumentsDocumentIdGetResponsesContentApplicationJsonSchemaDataChildrenItemsStatus": { "description": "Current review status.", "enum": [ "REQUESTED", "AWAITING_REVIEW", "REJECTED", "APPROVED", "UNSOLICITED", "COMPLETED" ], "title": "LegalEntitiesLegalEntityIdRegistrationDocumentsDocumentIdGetResponsesContentApplicationJsonSchemaDataChildrenItemsStatus", "type": "string" }, "LegalEntitiesLegalEntityIdRegistrationDocumentsDocumentIdGetResponsesContentApplicationJsonSchemaDataFilesItems": { "properties": { "content_type": { "description": "MIME type of the file.", "type": [ "string", "null" ] }, "id": { "description": "Public UUID of the file.", "format": "uuid", "type": "string" }, "original_filename": { "description": "Filename as uploaded.", "type": "string" }, "uploaded_at": { "description": "When the file was uploaded.", "format": "date-time", "type": [ "string", "null" ] } }, "required": [ "id", "original_filename" ], "title": "LegalEntitiesLegalEntityIdRegistrationDocumentsDocumentIdGetResponsesContentApplicationJsonSchemaDataFilesItems", "type": "object" }, "LegalEntitiesLegalEntityIdRegistrationDocumentsDocumentIdGetResponsesContentApplicationJsonSchemaDataLegalEntity": { "description": "The legal entity the document belongs to.", "properties": { "country": { "description": "ISO country code of the entity address.", "type": [ "string", "null" ] }, "id": { "description": "Public UUID of the legal entity.", "format": "uuid", "type": "string" }, "name": { "description": "Legal entity name.", "type": [ "string", "null" ] } }, "title": "LegalEntitiesLegalEntityIdRegistrationDocumentsDocumentIdGetResponsesContentApplicationJsonSchemaDataLegalEntity", "type": "object" }, "LegalEntitiesLegalEntityIdRegistrationDocumentsDocumentIdGetResponsesContentApplicationJsonSchemaDataParent": { "description": "The submission this one replaced, when it is a resubmission.", "properties": { "id": { "description": "Public UUID of the superseded submission.", "format": "uuid", "type": "string" }, "status": { "$ref": "#/components/schemas/LegalEntitiesLegalEntityIdRegistrationDocumentsDocumentIdGetResponsesContentApplicationJsonSchemaDataParentStatus", "description": "Status of the superseded submission." } }, "title": "LegalEntitiesLegalEntityIdRegistrationDocumentsDocumentIdGetResponsesContentApplicationJsonSchemaDataParent", "type": "object" }, "LegalEntitiesLegalEntityIdRegistrationDocumentsDocumentIdGetResponsesContentApplicationJsonSchemaDataParentStatus": { "description": "Status of the superseded submission.", "enum": [ "REQUESTED", "AWAITING_REVIEW", "REJECTED", "APPROVED", "UNSOLICITED", "COMPLETED" ], "title": "LegalEntitiesLegalEntityIdRegistrationDocumentsDocumentIdGetResponsesContentApplicationJsonSchemaDataParentStatus", "type": "string" }, "LegalEntitiesLegalEntityIdRegistrationDocumentsDocumentIdGetResponsesContentApplicationJsonSchemaDataRequirement": { "description": "The document requirement this submission answers.", "properties": { "applicable_at": { "description": "When the document becomes due.", "oneOf": [ { "$ref": "#/components/schemas/LegalEntitiesLegalEntityIdRegistrationDocumentsDocumentIdGetResponsesContentApplicationJsonSchemaDataRequirementApplicableAt" }, { "type": "null" } ] }, "description": { "description": "What the requirement asks for.", "type": [ "string", "null" ] }, "has_template": { "description": "Whether a template is provided. Fetch it from the requirement template endpoint.", "type": "boolean" }, "how_client_obtains_document": { "description": "How to obtain it.", "type": [ "string", "null" ] }, "how_the_document_is_used": { "description": "How the document is used once submitted.", "oneOf": [ { "$ref": "#/components/schemas/LegalEntitiesLegalEntityIdRegistrationDocumentsDocumentIdGetResponsesContentApplicationJsonSchemaDataRequirementHowTheDocumentIsUsed" }, { "type": "null" } ] }, "id": { "description": "Public UUID of the requirement.", "format": "uuid", "type": "string" }, "is_approval_required": { "description": "Whether a submission against this requirement is reviewed. False means a submission is accepted immediately as COMPLETED.", "type": "boolean" }, "is_disabled": { "description": "Whether the requirement is no longer requested.", "type": "boolean" }, "is_submission_required": { "description": "Whether the document is mandatory rather than optional.", "type": "boolean" }, "name": { "description": "Requirement name.", "type": [ "string", "null" ] }, "product_type": { "description": "Product the requirement applies to.", "oneOf": [ { "$ref": "#/components/schemas/LegalEntitiesLegalEntityIdRegistrationDocumentsDocumentIdGetResponsesContentApplicationJsonSchemaDataRequirementProductType" }, { "type": "null" } ] }, "reference_url": { "description": "External reference for the requirement.", "type": [ "string", "null" ] }, "why_the_document_is_needed": { "description": "Why the document is required.", "type": [ "string", "null" ] } }, "required": [ "id" ], "title": "LegalEntitiesLegalEntityIdRegistrationDocumentsDocumentIdGetResponsesContentApplicationJsonSchemaDataRequirement", "type": "object" }, "LegalEntitiesLegalEntityIdRegistrationDocumentsDocumentIdGetResponsesContentApplicationJsonSchemaDataRequirementApplicableAt": { "description": "When the document becomes due.", "enum": [ "BEFORE_FIRST_PAYROLL", "ANYTIME" ], "title": "LegalEntitiesLegalEntityIdRegistrationDocumentsDocumentIdGetResponsesContentApplicationJsonSchemaDataRequirementApplicableAt", "type": "string" }, "LegalEntitiesLegalEntityIdRegistrationDocumentsDocumentIdGetResponsesContentApplicationJsonSchemaDataRequirementHowTheDocumentIsUsed": { "description": "How the document is used once submitted.", "enum": [ "PAYROLL_PURPOSE", "ENTITY_ONBOARDING" ], "title": "LegalEntitiesLegalEntityIdRegistrationDocumentsDocumentIdGetResponsesContentApplicationJsonSchemaDataRequirementHowTheDocumentIsUsed", "type": "string" }, "LegalEntitiesLegalEntityIdRegistrationDocumentsDocumentIdGetResponsesContentApplicationJsonSchemaDataRequirementProductType": { "description": "Product the requirement applies to.", "enum": [ "EMBEDDED_PAYROLL", "GLOBAL_PAYROLL", "PEO" ], "title": "LegalEntitiesLegalEntityIdRegistrationDocumentsDocumentIdGetResponsesContentApplicationJsonSchemaDataRequirementProductType", "type": "string" }, "LegalEntitiesLegalEntityIdRegistrationDocumentsDocumentIdGetResponsesContentApplicationJsonSchemaDataStatus": { "description": "Current review status.", "enum": [ "REQUESTED", "AWAITING_REVIEW", "REJECTED", "APPROVED", "UNSOLICITED", "COMPLETED" ], "title": "LegalEntitiesLegalEntityIdRegistrationDocumentsDocumentIdGetResponsesContentApplicationJsonSchemaDataStatus", "type": "string" }, "LegalEntitiesLegalEntityIdRegistrationDocumentsDocumentIdGetResponsesContentApplicationJsonSchemaErrorsItems": { "properties": { "code": { "description": "Machine-readable error code", "maxLength": 255, "type": "string" }, "field": { "description": "Field that caused the error, if applicable.", "type": [ "string", "null" ] }, "message": { "description": "Human-readable explanation", "type": "string" } }, "required": [ "message" ], "title": "LegalEntitiesLegalEntityIdRegistrationDocumentsDocumentIdGetResponsesContentApplicationJsonSchemaErrorsItems", "type": "object" }, "LegalEntitiesLegalEntityIdRegistrationDocumentsDocumentIdPatchRequestBodyContentApplicationJsonSchemaData": { "properties": { "files": { "description": "Files previously uploaded to the File Service. Allowed types: pdf, jpg, jpeg, png, doc, docx, csv, xls, xlsx, txt, xml, mov, mp4.", "items": { "$ref": "#/components/schemas/LegalEntitiesLegalEntityIdRegistrationDocumentsDocumentIdPatchRequestBodyContentApplicationJsonSchemaDataFilesItems" }, "type": "array" } }, "required": [ "files" ], "title": "LegalEntitiesLegalEntityIdRegistrationDocumentsDocumentIdPatchRequestBodyContentApplicationJsonSchemaData", "type": "object" }, "LegalEntitiesLegalEntityIdRegistrationDocumentsDocumentIdPatchRequestBodyContentApplicationJsonSchemaDataFilesItems": { "properties": { "content_type": { "description": "MIME type.", "maxLength": 255, "type": "string" }, "file_id": { "description": "File Service file id.", "format": "uuid", "type": "string" }, "one_time_secret": { "description": "File Service one-time secret.", "maxLength": 1024, "minLength": 1, "type": "string" }, "original_filename": { "description": "Original filename.", "maxLength": 500, "type": "string" } }, "required": [ "file_id", "content_type", "one_time_secret", "original_filename" ], "title": "LegalEntitiesLegalEntityIdRegistrationDocumentsDocumentIdPatchRequestBodyContentApplicationJsonSchemaDataFilesItems", "type": "object" }, "LegalEntitiesLegalEntityIdRegistrationDocumentsDocumentIdPatchResponsesContentApplicationJsonSchemaData": { "properties": { "archived_at": { "description": "When the submission was archived.", "format": "date-time", "type": [ "string", "null" ] }, "archived_submissions_count": { "description": "How many superseded revisions exist.", "minimum": 0, "type": "integer" }, "children": { "description": "Superseded revisions of this submission, newest first.", "items": { "$ref": "#/components/schemas/LegalEntitiesLegalEntityIdRegistrationDocumentsDocumentIdPatchResponsesContentApplicationJsonSchemaDataChildrenItems" }, "type": "array" }, "files": { "description": "Files attached to this submission.", "items": { "$ref": "#/components/schemas/LegalEntitiesLegalEntityIdRegistrationDocumentsDocumentIdPatchResponsesContentApplicationJsonSchemaDataFilesItems" }, "type": "array" }, "id": { "description": "Public UUID of the submission. Null when nothing has been submitted for this requirement yet.", "format": "uuid", "type": [ "string", "null" ] }, "legal_entity": { "description": "The legal entity the document belongs to.", "oneOf": [ { "$ref": "#/components/schemas/LegalEntitiesLegalEntityIdRegistrationDocumentsDocumentIdPatchResponsesContentApplicationJsonSchemaDataLegalEntity" }, { "type": "null" } ] }, "parent": { "description": "The submission this one replaced, when it is a resubmission.", "oneOf": [ { "$ref": "#/components/schemas/LegalEntitiesLegalEntityIdRegistrationDocumentsDocumentIdPatchResponsesContentApplicationJsonSchemaDataParent" }, { "type": "null" } ] }, "rejection_reason": { "description": "Why the submission was rejected, when applicable.", "type": [ "string", "null" ] }, "requirement": { "description": "The document requirement this submission answers.", "oneOf": [ { "$ref": "#/components/schemas/LegalEntitiesLegalEntityIdRegistrationDocumentsDocumentIdPatchResponsesContentApplicationJsonSchemaDataRequirement" }, { "type": "null" } ] }, "reviewed_at": { "description": "When the document was reviewed.", "format": "date-time", "type": [ "string", "null" ] }, "status": { "$ref": "#/components/schemas/LegalEntitiesLegalEntityIdRegistrationDocumentsDocumentIdPatchResponsesContentApplicationJsonSchemaDataStatus", "description": "Current review status." }, "submission_due_date": { "description": "When the document is due.", "format": "date-time", "type": [ "string", "null" ] }, "submitted_at": { "description": "When the document was submitted.", "format": "date-time", "type": [ "string", "null" ] } }, "required": [ "id", "status" ], "title": "LegalEntitiesLegalEntityIdRegistrationDocumentsDocumentIdPatchResponsesContentApplicationJsonSchemaData", "type": "object" }, "LegalEntitiesLegalEntityIdRegistrationDocumentsDocumentIdPatchResponsesContentApplicationJsonSchemaDataChildrenItems": { "properties": { "archived_at": { "description": "When the submission was archived.", "format": "date-time", "type": [ "string", "null" ] }, "files": { "description": "Files attached to this submission.", "items": { "$ref": "#/components/schemas/LegalEntitiesLegalEntityIdRegistrationDocumentsDocumentIdPatchResponsesContentApplicationJsonSchemaDataChildrenItemsFilesItems" }, "type": "array" }, "id": { "description": "Public UUID of the submission. Null when nothing has been submitted for this requirement yet.", "format": "uuid", "type": [ "string", "null" ] }, "rejection_reason": { "description": "Why the submission was rejected, when applicable.", "type": [ "string", "null" ] }, "reviewed_at": { "description": "When the document was reviewed.", "format": "date-time", "type": [ "string", "null" ] }, "status": { "$ref": "#/components/schemas/LegalEntitiesLegalEntityIdRegistrationDocumentsDocumentIdPatchResponsesContentApplicationJsonSchemaDataChildrenItemsStatus", "description": "Current review status." }, "submitted_at": { "description": "When the document was submitted.", "format": "date-time", "type": [ "string", "null" ] } }, "required": [ "id", "status" ], "title": "LegalEntitiesLegalEntityIdRegistrationDocumentsDocumentIdPatchResponsesContentApplicationJsonSchemaDataChildrenItems", "type": "object" }, "LegalEntitiesLegalEntityIdRegistrationDocumentsDocumentIdPatchResponsesContentApplicationJsonSchemaDataChildrenItemsFilesItems": { "properties": { "content_type": { "description": "MIME type of the file.", "type": [ "string", "null" ] }, "id": { "description": "Public UUID of the file.", "format": "uuid", "type": "string" }, "original_filename": { "description": "Filename as uploaded.", "type": "string" }, "uploaded_at": { "description": "When the file was uploaded.", "format": "date-time", "type": [ "string", "null" ] } }, "required": [ "id", "original_filename" ], "title": "LegalEntitiesLegalEntityIdRegistrationDocumentsDocumentIdPatchResponsesContentApplicationJsonSchemaDataChildrenItemsFilesItems", "type": "object" }, "LegalEntitiesLegalEntityIdRegistrationDocumentsDocumentIdPatchResponsesContentApplicationJsonSchemaDataChildrenItemsStatus": { "description": "Current review status.", "enum": [ "REQUESTED", "AWAITING_REVIEW", "REJECTED", "APPROVED", "UNSOLICITED", "COMPLETED" ], "title": "LegalEntitiesLegalEntityIdRegistrationDocumentsDocumentIdPatchResponsesContentApplicationJsonSchemaDataChildrenItemsStatus", "type": "string" }, "LegalEntitiesLegalEntityIdRegistrationDocumentsDocumentIdPatchResponsesContentApplicationJsonSchemaDataFilesItems": { "properties": { "content_type": { "description": "MIME type of the file.", "type": [ "string", "null" ] }, "id": { "description": "Public UUID of the file.", "format": "uuid", "type": "string" }, "original_filename": { "description": "Filename as uploaded.", "type": "string" }, "uploaded_at": { "description": "When the file was uploaded.", "format": "date-time", "type": [ "string", "null" ] } }, "required": [ "id", "original_filename" ], "title": "LegalEntitiesLegalEntityIdRegistrationDocumentsDocumentIdPatchResponsesContentApplicationJsonSchemaDataFilesItems", "type": "object" }, "LegalEntitiesLegalEntityIdRegistrationDocumentsDocumentIdPatchResponsesContentApplicationJsonSchemaDataLegalEntity": { "description": "The legal entity the document belongs to.", "properties": { "country": { "description": "ISO country code of the entity address.", "type": [ "string", "null" ] }, "id": { "description": "Public UUID of the legal entity.", "format": "uuid", "type": "string" }, "name": { "description": "Legal entity name.", "type": [ "string", "null" ] } }, "title": "LegalEntitiesLegalEntityIdRegistrationDocumentsDocumentIdPatchResponsesContentApplicationJsonSchemaDataLegalEntity", "type": "object" }, "LegalEntitiesLegalEntityIdRegistrationDocumentsDocumentIdPatchResponsesContentApplicationJsonSchemaDataParent": { "description": "The submission this one replaced, when it is a resubmission.", "properties": { "id": { "description": "Public UUID of the superseded submission.", "format": "uuid", "type": "string" }, "status": { "$ref": "#/components/schemas/LegalEntitiesLegalEntityIdRegistrationDocumentsDocumentIdPatchResponsesContentApplicationJsonSchemaDataParentStatus", "description": "Status of the superseded submission." } }, "title": "LegalEntitiesLegalEntityIdRegistrationDocumentsDocumentIdPatchResponsesContentApplicationJsonSchemaDataParent", "type": "object" }, "LegalEntitiesLegalEntityIdRegistrationDocumentsDocumentIdPatchResponsesContentApplicationJsonSchemaDataParentStatus": { "description": "Status of the superseded submission.", "enum": [ "REQUESTED", "AWAITING_REVIEW", "REJECTED", "APPROVED", "UNSOLICITED", "COMPLETED" ], "title": "LegalEntitiesLegalEntityIdRegistrationDocumentsDocumentIdPatchResponsesContentApplicationJsonSchemaDataParentStatus", "type": "string" }, "LegalEntitiesLegalEntityIdRegistrationDocumentsDocumentIdPatchResponsesContentApplicationJsonSchemaDataRequirement": { "description": "The document requirement this submission answers.", "properties": { "applicable_at": { "description": "When the document becomes due.", "oneOf": [ { "$ref": "#/components/schemas/LegalEntitiesLegalEntityIdRegistrationDocumentsDocumentIdPatchResponsesContentApplicationJsonSchemaDataRequirementApplicableAt" }, { "type": "null" } ] }, "description": { "description": "What the requirement asks for.", "type": [ "string", "null" ] }, "has_template": { "description": "Whether a template is provided. Fetch it from the requirement template endpoint.", "type": "boolean" }, "how_client_obtains_document": { "description": "How to obtain it.", "type": [ "string", "null" ] }, "how_the_document_is_used": { "description": "How the document is used once submitted.", "oneOf": [ { "$ref": "#/components/schemas/LegalEntitiesLegalEntityIdRegistrationDocumentsDocumentIdPatchResponsesContentApplicationJsonSchemaDataRequirementHowTheDocumentIsUsed" }, { "type": "null" } ] }, "id": { "description": "Public UUID of the requirement.", "format": "uuid", "type": "string" }, "is_approval_required": { "description": "Whether a submission against this requirement is reviewed. False means a submission is accepted immediately as COMPLETED.", "type": "boolean" }, "is_disabled": { "description": "Whether the requirement is no longer requested.", "type": "boolean" }, "is_submission_required": { "description": "Whether the document is mandatory rather than optional.", "type": "boolean" }, "name": { "description": "Requirement name.", "type": [ "string", "null" ] }, "product_type": { "description": "Product the requirement applies to.", "oneOf": [ { "$ref": "#/components/schemas/LegalEntitiesLegalEntityIdRegistrationDocumentsDocumentIdPatchResponsesContentApplicationJsonSchemaDataRequirementProductType" }, { "type": "null" } ] }, "reference_url": { "description": "External reference for the requirement.", "type": [ "string", "null" ] }, "why_the_document_is_needed": { "description": "Why the document is required.", "type": [ "string", "null" ] } }, "required": [ "id" ], "title": "LegalEntitiesLegalEntityIdRegistrationDocumentsDocumentIdPatchResponsesContentApplicationJsonSchemaDataRequirement", "type": "object" }, "LegalEntitiesLegalEntityIdRegistrationDocumentsDocumentIdPatchResponsesContentApplicationJsonSchemaDataRequirementApplicableAt": { "description": "When the document becomes due.", "enum": [ "BEFORE_FIRST_PAYROLL", "ANYTIME" ], "title": "LegalEntitiesLegalEntityIdRegistrationDocumentsDocumentIdPatchResponsesContentApplicationJsonSchemaDataRequirementApplicableAt", "type": "string" }, "LegalEntitiesLegalEntityIdRegistrationDocumentsDocumentIdPatchResponsesContentApplicationJsonSchemaDataRequirementHowTheDocumentIsUsed": { "description": "How the document is used once submitted.", "enum": [ "PAYROLL_PURPOSE", "ENTITY_ONBOARDING" ], "title": "LegalEntitiesLegalEntityIdRegistrationDocumentsDocumentIdPatchResponsesContentApplicationJsonSchemaDataRequirementHowTheDocumentIsUsed", "type": "string" }, "LegalEntitiesLegalEntityIdRegistrationDocumentsDocumentIdPatchResponsesContentApplicationJsonSchemaDataRequirementProductType": { "description": "Product the requirement applies to.", "enum": [ "EMBEDDED_PAYROLL", "GLOBAL_PAYROLL", "PEO" ], "title": "LegalEntitiesLegalEntityIdRegistrationDocumentsDocumentIdPatchResponsesContentApplicationJsonSchemaDataRequirementProductType", "type": "string" }, "LegalEntitiesLegalEntityIdRegistrationDocumentsDocumentIdPatchResponsesContentApplicationJsonSchemaDataStatus": { "description": "Current review status.", "enum": [ "REQUESTED", "AWAITING_REVIEW", "REJECTED", "APPROVED", "UNSOLICITED", "COMPLETED" ], "title": "LegalEntitiesLegalEntityIdRegistrationDocumentsDocumentIdPatchResponsesContentApplicationJsonSchemaDataStatus", "type": "string" }, "LegalEntitiesLegalEntityIdRegistrationDocumentsDocumentIdPatchResponsesContentApplicationJsonSchemaErrorsItems": { "properties": { "code": { "description": "Machine-readable error code", "maxLength": 255, "type": "string" }, "field": { "description": "Field that caused the error, if applicable.", "type": [ "string", "null" ] }, "message": { "description": "Human-readable explanation", "type": "string" } }, "required": [ "message" ], "title": "LegalEntitiesLegalEntityIdRegistrationDocumentsDocumentIdPatchResponsesContentApplicationJsonSchemaErrorsItems", "type": "object" }, "LegalEntitiesLegalEntityIdRegistrationDocumentsDocumentIdPutRequestBodyContentApplicationJsonSchemaData": { "properties": { "files": { "description": "Files previously uploaded to the File Service. Allowed types: pdf, jpg, jpeg, png, doc, docx, csv, xls, xlsx, txt, xml, mov, mp4.", "items": { "$ref": "#/components/schemas/LegalEntitiesLegalEntityIdRegistrationDocumentsDocumentIdPutRequestBodyContentApplicationJsonSchemaDataFilesItems" }, "type": "array" }, "submission_reason": { "description": "Optional note explaining what changed since the previous submission.", "maxLength": 2000, "type": "string" } }, "required": [ "files" ], "title": "LegalEntitiesLegalEntityIdRegistrationDocumentsDocumentIdPutRequestBodyContentApplicationJsonSchemaData", "type": "object" }, "LegalEntitiesLegalEntityIdRegistrationDocumentsDocumentIdPutRequestBodyContentApplicationJsonSchemaDataFilesItems": { "properties": { "content_type": { "description": "MIME type.", "maxLength": 255, "type": "string" }, "file_id": { "description": "File Service file id.", "format": "uuid", "type": "string" }, "one_time_secret": { "description": "File Service one-time secret.", "maxLength": 1024, "minLength": 1, "type": "string" }, "original_filename": { "description": "Original filename.", "maxLength": 500, "type": "string" } }, "required": [ "file_id", "content_type", "one_time_secret", "original_filename" ], "title": "LegalEntitiesLegalEntityIdRegistrationDocumentsDocumentIdPutRequestBodyContentApplicationJsonSchemaDataFilesItems", "type": "object" }, "LegalEntitiesLegalEntityIdRegistrationDocumentsDocumentIdPutResponsesContentApplicationJsonSchemaData": { "properties": { "archived_at": { "description": "When the submission was archived.", "format": "date-time", "type": [ "string", "null" ] }, "archived_submissions_count": { "description": "How many superseded revisions exist.", "minimum": 0, "type": "integer" }, "children": { "description": "Superseded revisions of this submission, newest first.", "items": { "$ref": "#/components/schemas/LegalEntitiesLegalEntityIdRegistrationDocumentsDocumentIdPutResponsesContentApplicationJsonSchemaDataChildrenItems" }, "type": "array" }, "files": { "description": "Files attached to this submission.", "items": { "$ref": "#/components/schemas/LegalEntitiesLegalEntityIdRegistrationDocumentsDocumentIdPutResponsesContentApplicationJsonSchemaDataFilesItems" }, "type": "array" }, "id": { "description": "Public UUID of the submission. Null when nothing has been submitted for this requirement yet.", "format": "uuid", "type": [ "string", "null" ] }, "legal_entity": { "description": "The legal entity the document belongs to.", "oneOf": [ { "$ref": "#/components/schemas/LegalEntitiesLegalEntityIdRegistrationDocumentsDocumentIdPutResponsesContentApplicationJsonSchemaDataLegalEntity" }, { "type": "null" } ] }, "parent": { "description": "The submission this one replaced, when it is a resubmission.", "oneOf": [ { "$ref": "#/components/schemas/LegalEntitiesLegalEntityIdRegistrationDocumentsDocumentIdPutResponsesContentApplicationJsonSchemaDataParent" }, { "type": "null" } ] }, "rejection_reason": { "description": "Why the submission was rejected, when applicable.", "type": [ "string", "null" ] }, "requirement": { "description": "The document requirement this submission answers.", "oneOf": [ { "$ref": "#/components/schemas/LegalEntitiesLegalEntityIdRegistrationDocumentsDocumentIdPutResponsesContentApplicationJsonSchemaDataRequirement" }, { "type": "null" } ] }, "reviewed_at": { "description": "When the document was reviewed.", "format": "date-time", "type": [ "string", "null" ] }, "status": { "$ref": "#/components/schemas/LegalEntitiesLegalEntityIdRegistrationDocumentsDocumentIdPutResponsesContentApplicationJsonSchemaDataStatus", "description": "Current review status." }, "submission_due_date": { "description": "When the document is due.", "format": "date-time", "type": [ "string", "null" ] }, "submitted_at": { "description": "When the document was submitted.", "format": "date-time", "type": [ "string", "null" ] } }, "required": [ "id", "status" ], "title": "LegalEntitiesLegalEntityIdRegistrationDocumentsDocumentIdPutResponsesContentApplicationJsonSchemaData", "type": "object" }, "LegalEntitiesLegalEntityIdRegistrationDocumentsDocumentIdPutResponsesContentApplicationJsonSchemaDataChildrenItems": { "properties": { "archived_at": { "description": "When the submission was archived.", "format": "date-time", "type": [ "string", "null" ] }, "files": { "description": "Files attached to this submission.", "items": { "$ref": "#/components/schemas/LegalEntitiesLegalEntityIdRegistrationDocumentsDocumentIdPutResponsesContentApplicationJsonSchemaDataChildrenItemsFilesItems" }, "type": "array" }, "id": { "description": "Public UUID of the submission. Null when nothing has been submitted for this requirement yet.", "format": "uuid", "type": [ "string", "null" ] }, "rejection_reason": { "description": "Why the submission was rejected, when applicable.", "type": [ "string", "null" ] }, "reviewed_at": { "description": "When the document was reviewed.", "format": "date-time", "type": [ "string", "null" ] }, "status": { "$ref": "#/components/schemas/LegalEntitiesLegalEntityIdRegistrationDocumentsDocumentIdPutResponsesContentApplicationJsonSchemaDataChildrenItemsStatus", "description": "Current review status." }, "submitted_at": { "description": "When the document was submitted.", "format": "date-time", "type": [ "string", "null" ] } }, "required": [ "id", "status" ], "title": "LegalEntitiesLegalEntityIdRegistrationDocumentsDocumentIdPutResponsesContentApplicationJsonSchemaDataChildrenItems", "type": "object" }, "LegalEntitiesLegalEntityIdRegistrationDocumentsDocumentIdPutResponsesContentApplicationJsonSchemaDataChildrenItemsFilesItems": { "properties": { "content_type": { "description": "MIME type of the file.", "type": [ "string", "null" ] }, "id": { "description": "Public UUID of the file.", "format": "uuid", "type": "string" }, "original_filename": { "description": "Filename as uploaded.", "type": "string" }, "uploaded_at": { "description": "When the file was uploaded.", "format": "date-time", "type": [ "string", "null" ] } }, "required": [ "id", "original_filename" ], "title": "LegalEntitiesLegalEntityIdRegistrationDocumentsDocumentIdPutResponsesContentApplicationJsonSchemaDataChildrenItemsFilesItems", "type": "object" }, "LegalEntitiesLegalEntityIdRegistrationDocumentsDocumentIdPutResponsesContentApplicationJsonSchemaDataChildrenItemsStatus": { "description": "Current review status.", "enum": [ "REQUESTED", "AWAITING_REVIEW", "REJECTED", "APPROVED", "UNSOLICITED", "COMPLETED" ], "title": "LegalEntitiesLegalEntityIdRegistrationDocumentsDocumentIdPutResponsesContentApplicationJsonSchemaDataChildrenItemsStatus", "type": "string" }, "LegalEntitiesLegalEntityIdRegistrationDocumentsDocumentIdPutResponsesContentApplicationJsonSchemaDataFilesItems": { "properties": { "content_type": { "description": "MIME type of the file.", "type": [ "string", "null" ] }, "id": { "description": "Public UUID of the file.", "format": "uuid", "type": "string" }, "original_filename": { "description": "Filename as uploaded.", "type": "string" }, "uploaded_at": { "description": "When the file was uploaded.", "format": "date-time", "type": [ "string", "null" ] } }, "required": [ "id", "original_filename" ], "title": "LegalEntitiesLegalEntityIdRegistrationDocumentsDocumentIdPutResponsesContentApplicationJsonSchemaDataFilesItems", "type": "object" }, "LegalEntitiesLegalEntityIdRegistrationDocumentsDocumentIdPutResponsesContentApplicationJsonSchemaDataLegalEntity": { "description": "The legal entity the document belongs to.", "properties": { "country": { "description": "ISO country code of the entity address.", "type": [ "string", "null" ] }, "id": { "description": "Public UUID of the legal entity.", "format": "uuid", "type": "string" }, "name": { "description": "Legal entity name.", "type": [ "string", "null" ] } }, "title": "LegalEntitiesLegalEntityIdRegistrationDocumentsDocumentIdPutResponsesContentApplicationJsonSchemaDataLegalEntity", "type": "object" }, "LegalEntitiesLegalEntityIdRegistrationDocumentsDocumentIdPutResponsesContentApplicationJsonSchemaDataParent": { "description": "The submission this one replaced, when it is a resubmission.", "properties": { "id": { "description": "Public UUID of the superseded submission.", "format": "uuid", "type": "string" }, "status": { "$ref": "#/components/schemas/LegalEntitiesLegalEntityIdRegistrationDocumentsDocumentIdPutResponsesContentApplicationJsonSchemaDataParentStatus", "description": "Status of the superseded submission." } }, "title": "LegalEntitiesLegalEntityIdRegistrationDocumentsDocumentIdPutResponsesContentApplicationJsonSchemaDataParent", "type": "object" }, "LegalEntitiesLegalEntityIdRegistrationDocumentsDocumentIdPutResponsesContentApplicationJsonSchemaDataParentStatus": { "description": "Status of the superseded submission.", "enum": [ "REQUESTED", "AWAITING_REVIEW", "REJECTED", "APPROVED", "UNSOLICITED", "COMPLETED" ], "title": "LegalEntitiesLegalEntityIdRegistrationDocumentsDocumentIdPutResponsesContentApplicationJsonSchemaDataParentStatus", "type": "string" }, "LegalEntitiesLegalEntityIdRegistrationDocumentsDocumentIdPutResponsesContentApplicationJsonSchemaDataRequirement": { "description": "The document requirement this submission answers.", "properties": { "applicable_at": { "description": "When the document becomes due.", "oneOf": [ { "$ref": "#/components/schemas/LegalEntitiesLegalEntityIdRegistrationDocumentsDocumentIdPutResponsesContentApplicationJsonSchemaDataRequirementApplicableAt" }, { "type": "null" } ] }, "description": { "description": "What the requirement asks for.", "type": [ "string", "null" ] }, "has_template": { "description": "Whether a template is provided. Fetch it from the requirement template endpoint.", "type": "boolean" }, "how_client_obtains_document": { "description": "How to obtain it.", "type": [ "string", "null" ] }, "how_the_document_is_used": { "description": "How the document is used once submitted.", "oneOf": [ { "$ref": "#/components/schemas/LegalEntitiesLegalEntityIdRegistrationDocumentsDocumentIdPutResponsesContentApplicationJsonSchemaDataRequirementHowTheDocumentIsUsed" }, { "type": "null" } ] }, "id": { "description": "Public UUID of the requirement.", "format": "uuid", "type": "string" }, "is_approval_required": { "description": "Whether a submission against this requirement is reviewed. False means a submission is accepted immediately as COMPLETED.", "type": "boolean" }, "is_disabled": { "description": "Whether the requirement is no longer requested.", "type": "boolean" }, "is_submission_required": { "description": "Whether the document is mandatory rather than optional.", "type": "boolean" }, "name": { "description": "Requirement name.", "type": [ "string", "null" ] }, "product_type": { "description": "Product the requirement applies to.", "oneOf": [ { "$ref": "#/components/schemas/LegalEntitiesLegalEntityIdRegistrationDocumentsDocumentIdPutResponsesContentApplicationJsonSchemaDataRequirementProductType" }, { "type": "null" } ] }, "reference_url": { "description": "External reference for the requirement.", "type": [ "string", "null" ] }, "why_the_document_is_needed": { "description": "Why the document is required.", "type": [ "string", "null" ] } }, "required": [ "id" ], "title": "LegalEntitiesLegalEntityIdRegistrationDocumentsDocumentIdPutResponsesContentApplicationJsonSchemaDataRequirement", "type": "object" }, "LegalEntitiesLegalEntityIdRegistrationDocumentsDocumentIdPutResponsesContentApplicationJsonSchemaDataRequirementApplicableAt": { "description": "When the document becomes due.", "enum": [ "BEFORE_FIRST_PAYROLL", "ANYTIME" ], "title": "LegalEntitiesLegalEntityIdRegistrationDocumentsDocumentIdPutResponsesContentApplicationJsonSchemaDataRequirementApplicableAt", "type": "string" }, "LegalEntitiesLegalEntityIdRegistrationDocumentsDocumentIdPutResponsesContentApplicationJsonSchemaDataRequirementHowTheDocumentIsUsed": { "description": "How the document is used once submitted.", "enum": [ "PAYROLL_PURPOSE", "ENTITY_ONBOARDING" ], "title": "LegalEntitiesLegalEntityIdRegistrationDocumentsDocumentIdPutResponsesContentApplicationJsonSchemaDataRequirementHowTheDocumentIsUsed", "type": "string" }, "LegalEntitiesLegalEntityIdRegistrationDocumentsDocumentIdPutResponsesContentApplicationJsonSchemaDataRequirementProductType": { "description": "Product the requirement applies to.", "enum": [ "EMBEDDED_PAYROLL", "GLOBAL_PAYROLL", "PEO" ], "title": "LegalEntitiesLegalEntityIdRegistrationDocumentsDocumentIdPutResponsesContentApplicationJsonSchemaDataRequirementProductType", "type": "string" }, "LegalEntitiesLegalEntityIdRegistrationDocumentsDocumentIdPutResponsesContentApplicationJsonSchemaDataStatus": { "description": "Current review status.", "enum": [ "REQUESTED", "AWAITING_REVIEW", "REJECTED", "APPROVED", "UNSOLICITED", "COMPLETED" ], "title": "LegalEntitiesLegalEntityIdRegistrationDocumentsDocumentIdPutResponsesContentApplicationJsonSchemaDataStatus", "type": "string" }, "LegalEntitiesLegalEntityIdRegistrationDocumentsDocumentIdPutResponsesContentApplicationJsonSchemaErrorsItems": { "properties": { "code": { "description": "Machine-readable error code", "maxLength": 255, "type": "string" }, "field": { "description": "Field that caused the error, if applicable.", "type": [ "string", "null" ] }, "message": { "description": "Human-readable explanation", "type": "string" } }, "required": [ "message" ], "title": "LegalEntitiesLegalEntityIdRegistrationDocumentsDocumentIdPutResponsesContentApplicationJsonSchemaErrorsItems", "type": "object" }, "LegalEntitiesLegalEntityIdRegistrationDocumentsGetParametersProductTypeSchemaItems": { "enum": [ "EMBEDDED_PAYROLL", "GLOBAL_PAYROLL", "PEO" ], "title": "LegalEntitiesLegalEntityIdRegistrationDocumentsGetParametersProductTypeSchemaItems", "type": "string" }, "LegalEntitiesLegalEntityIdRegistrationDocumentsGetParametersStatusSchemaItems": { "enum": [ "REQUESTED", "AWAITING_REVIEW", "REJECTED", "APPROVED", "UNSOLICITED", "COMPLETED" ], "title": "LegalEntitiesLegalEntityIdRegistrationDocumentsGetParametersStatusSchemaItems", "type": "string" }, "LegalEntitiesLegalEntityIdRegistrationDocumentsGetResponsesContentApplicationJsonSchemaDataItems": { "properties": { "archived_at": { "description": "When the submission was archived.", "format": "date-time", "type": [ "string", "null" ] }, "archived_submissions_count": { "description": "How many superseded revisions exist.", "minimum": 0, "type": "integer" }, "children": { "description": "Superseded revisions of this submission, newest first.", "items": { "$ref": "#/components/schemas/LegalEntitiesLegalEntityIdRegistrationDocumentsGetResponsesContentApplicationJsonSchemaDataItemsChildrenItems" }, "type": "array" }, "files": { "description": "Files attached to this submission.", "items": { "$ref": "#/components/schemas/LegalEntitiesLegalEntityIdRegistrationDocumentsGetResponsesContentApplicationJsonSchemaDataItemsFilesItems" }, "type": "array" }, "id": { "description": "Public UUID of the submission. Null when nothing has been submitted for this requirement yet.", "format": "uuid", "type": [ "string", "null" ] }, "legal_entity": { "description": "The legal entity the document belongs to.", "oneOf": [ { "$ref": "#/components/schemas/LegalEntitiesLegalEntityIdRegistrationDocumentsGetResponsesContentApplicationJsonSchemaDataItemsLegalEntity" }, { "type": "null" } ] }, "parent": { "description": "The submission this one replaced, when it is a resubmission.", "oneOf": [ { "$ref": "#/components/schemas/LegalEntitiesLegalEntityIdRegistrationDocumentsGetResponsesContentApplicationJsonSchemaDataItemsParent" }, { "type": "null" } ] }, "rejection_reason": { "description": "Why the submission was rejected, when applicable.", "type": [ "string", "null" ] }, "requirement": { "description": "The document requirement this submission answers.", "oneOf": [ { "$ref": "#/components/schemas/LegalEntitiesLegalEntityIdRegistrationDocumentsGetResponsesContentApplicationJsonSchemaDataItemsRequirement" }, { "type": "null" } ] }, "reviewed_at": { "description": "When the document was reviewed.", "format": "date-time", "type": [ "string", "null" ] }, "status": { "$ref": "#/components/schemas/LegalEntitiesLegalEntityIdRegistrationDocumentsGetResponsesContentApplicationJsonSchemaDataItemsStatus", "description": "Current review status." }, "submission_due_date": { "description": "When the document is due.", "format": "date-time", "type": [ "string", "null" ] }, "submitted_at": { "description": "When the document was submitted.", "format": "date-time", "type": [ "string", "null" ] } }, "required": [ "id", "status" ], "title": "LegalEntitiesLegalEntityIdRegistrationDocumentsGetResponsesContentApplicationJsonSchemaDataItems", "type": "object" }, "LegalEntitiesLegalEntityIdRegistrationDocumentsGetResponsesContentApplicationJsonSchemaDataItemsChildrenItems": { "properties": { "archived_at": { "description": "When the submission was archived.", "format": "date-time", "type": [ "string", "null" ] }, "files": { "description": "Files attached to this submission.", "items": { "$ref": "#/components/schemas/LegalEntitiesLegalEntityIdRegistrationDocumentsGetResponsesContentApplicationJsonSchemaDataItemsChildrenItemsFilesItems" }, "type": "array" }, "id": { "description": "Public UUID of the submission. Null when nothing has been submitted for this requirement yet.", "format": "uuid", "type": [ "string", "null" ] }, "rejection_reason": { "description": "Why the submission was rejected, when applicable.", "type": [ "string", "null" ] }, "reviewed_at": { "description": "When the document was reviewed.", "format": "date-time", "type": [ "string", "null" ] }, "status": { "$ref": "#/components/schemas/LegalEntitiesLegalEntityIdRegistrationDocumentsGetResponsesContentApplicationJsonSchemaDataItemsChildrenItemsStatus", "description": "Current review status." }, "submitted_at": { "description": "When the document was submitted.", "format": "date-time", "type": [ "string", "null" ] } }, "required": [ "id", "status" ], "title": "LegalEntitiesLegalEntityIdRegistrationDocumentsGetResponsesContentApplicationJsonSchemaDataItemsChildrenItems", "type": "object" }, "LegalEntitiesLegalEntityIdRegistrationDocumentsGetResponsesContentApplicationJsonSchemaDataItemsChildrenItemsFilesItems": { "properties": { "content_type": { "description": "MIME type of the file.", "type": [ "string", "null" ] }, "id": { "description": "Public UUID of the file.", "format": "uuid", "type": "string" }, "original_filename": { "description": "Filename as uploaded.", "type": "string" }, "uploaded_at": { "description": "When the file was uploaded.", "format": "date-time", "type": [ "string", "null" ] } }, "required": [ "id", "original_filename" ], "title": "LegalEntitiesLegalEntityIdRegistrationDocumentsGetResponsesContentApplicationJsonSchemaDataItemsChildrenItemsFilesItems", "type": "object" }, "LegalEntitiesLegalEntityIdRegistrationDocumentsGetResponsesContentApplicationJsonSchemaDataItemsChildrenItemsStatus": { "description": "Current review status.", "enum": [ "REQUESTED", "AWAITING_REVIEW", "REJECTED", "APPROVED", "UNSOLICITED", "COMPLETED" ], "title": "LegalEntitiesLegalEntityIdRegistrationDocumentsGetResponsesContentApplicationJsonSchemaDataItemsChildrenItemsStatus", "type": "string" }, "LegalEntitiesLegalEntityIdRegistrationDocumentsGetResponsesContentApplicationJsonSchemaDataItemsFilesItems": { "properties": { "content_type": { "description": "MIME type of the file.", "type": [ "string", "null" ] }, "id": { "description": "Public UUID of the file.", "format": "uuid", "type": "string" }, "original_filename": { "description": "Filename as uploaded.", "type": "string" }, "uploaded_at": { "description": "When the file was uploaded.", "format": "date-time", "type": [ "string", "null" ] } }, "required": [ "id", "original_filename" ], "title": "LegalEntitiesLegalEntityIdRegistrationDocumentsGetResponsesContentApplicationJsonSchemaDataItemsFilesItems", "type": "object" }, "LegalEntitiesLegalEntityIdRegistrationDocumentsGetResponsesContentApplicationJsonSchemaDataItemsLegalEntity": { "description": "The legal entity the document belongs to.", "properties": { "country": { "description": "ISO country code of the entity address.", "type": [ "string", "null" ] }, "id": { "description": "Public UUID of the legal entity.", "format": "uuid", "type": "string" }, "name": { "description": "Legal entity name.", "type": [ "string", "null" ] } }, "title": "LegalEntitiesLegalEntityIdRegistrationDocumentsGetResponsesContentApplicationJsonSchemaDataItemsLegalEntity", "type": "object" }, "LegalEntitiesLegalEntityIdRegistrationDocumentsGetResponsesContentApplicationJsonSchemaDataItemsParent": { "description": "The submission this one replaced, when it is a resubmission.", "properties": { "id": { "description": "Public UUID of the superseded submission.", "format": "uuid", "type": "string" }, "status": { "$ref": "#/components/schemas/LegalEntitiesLegalEntityIdRegistrationDocumentsGetResponsesContentApplicationJsonSchemaDataItemsParentStatus", "description": "Status of the superseded submission." } }, "title": "LegalEntitiesLegalEntityIdRegistrationDocumentsGetResponsesContentApplicationJsonSchemaDataItemsParent", "type": "object" }, "LegalEntitiesLegalEntityIdRegistrationDocumentsGetResponsesContentApplicationJsonSchemaDataItemsParentStatus": { "description": "Status of the superseded submission.", "enum": [ "REQUESTED", "AWAITING_REVIEW", "REJECTED", "APPROVED", "UNSOLICITED", "COMPLETED" ], "title": "LegalEntitiesLegalEntityIdRegistrationDocumentsGetResponsesContentApplicationJsonSchemaDataItemsParentStatus", "type": "string" }, "LegalEntitiesLegalEntityIdRegistrationDocumentsGetResponsesContentApplicationJsonSchemaDataItemsRequirement": { "description": "The document requirement this submission answers.", "properties": { "applicable_at": { "description": "When the document becomes due.", "oneOf": [ { "$ref": "#/components/schemas/LegalEntitiesLegalEntityIdRegistrationDocumentsGetResponsesContentApplicationJsonSchemaDataItemsRequirementApplicableAt" }, { "type": "null" } ] }, "description": { "description": "What the requirement asks for.", "type": [ "string", "null" ] }, "has_template": { "description": "Whether a template is provided. Fetch it from the requirement template endpoint.", "type": "boolean" }, "how_client_obtains_document": { "description": "How to obtain it.", "type": [ "string", "null" ] }, "how_the_document_is_used": { "description": "How the document is used once submitted.", "oneOf": [ { "$ref": "#/components/schemas/LegalEntitiesLegalEntityIdRegistrationDocumentsGetResponsesContentApplicationJsonSchemaDataItemsRequirementHowTheDocumentIsUsed" }, { "type": "null" } ] }, "id": { "description": "Public UUID of the requirement.", "format": "uuid", "type": "string" }, "is_approval_required": { "description": "Whether a submission against this requirement is reviewed. False means a submission is accepted immediately as COMPLETED.", "type": "boolean" }, "is_disabled": { "description": "Whether the requirement is no longer requested.", "type": "boolean" }, "is_submission_required": { "description": "Whether the document is mandatory rather than optional.", "type": "boolean" }, "name": { "description": "Requirement name.", "type": [ "string", "null" ] }, "product_type": { "description": "Product the requirement applies to.", "oneOf": [ { "$ref": "#/components/schemas/LegalEntitiesLegalEntityIdRegistrationDocumentsGetResponsesContentApplicationJsonSchemaDataItemsRequirementProductType" }, { "type": "null" } ] }, "reference_url": { "description": "External reference for the requirement.", "type": [ "string", "null" ] }, "why_the_document_is_needed": { "description": "Why the document is required.", "type": [ "string", "null" ] } }, "required": [ "id" ], "title": "LegalEntitiesLegalEntityIdRegistrationDocumentsGetResponsesContentApplicationJsonSchemaDataItemsRequirement", "type": "object" }, "LegalEntitiesLegalEntityIdRegistrationDocumentsGetResponsesContentApplicationJsonSchemaDataItemsRequirementApplicableAt": { "description": "When the document becomes due.", "enum": [ "BEFORE_FIRST_PAYROLL", "ANYTIME" ], "title": "LegalEntitiesLegalEntityIdRegistrationDocumentsGetResponsesContentApplicationJsonSchemaDataItemsRequirementApplicableAt", "type": "string" }, "LegalEntitiesLegalEntityIdRegistrationDocumentsGetResponsesContentApplicationJsonSchemaDataItemsRequirementHowTheDocumentIsUsed": { "description": "How the document is used once submitted.", "enum": [ "PAYROLL_PURPOSE", "ENTITY_ONBOARDING" ], "title": "LegalEntitiesLegalEntityIdRegistrationDocumentsGetResponsesContentApplicationJsonSchemaDataItemsRequirementHowTheDocumentIsUsed", "type": "string" }, "LegalEntitiesLegalEntityIdRegistrationDocumentsGetResponsesContentApplicationJsonSchemaDataItemsRequirementProductType": { "description": "Product the requirement applies to.", "enum": [ "EMBEDDED_PAYROLL", "GLOBAL_PAYROLL", "PEO" ], "title": "LegalEntitiesLegalEntityIdRegistrationDocumentsGetResponsesContentApplicationJsonSchemaDataItemsRequirementProductType", "type": "string" }, "LegalEntitiesLegalEntityIdRegistrationDocumentsGetResponsesContentApplicationJsonSchemaDataItemsStatus": { "description": "Current review status.", "enum": [ "REQUESTED", "AWAITING_REVIEW", "REJECTED", "APPROVED", "UNSOLICITED", "COMPLETED" ], "title": "LegalEntitiesLegalEntityIdRegistrationDocumentsGetResponsesContentApplicationJsonSchemaDataItemsStatus", "type": "string" }, "LegalEntitiesLegalEntityIdRegistrationDocumentsGetResponsesContentApplicationJsonSchemaErrorsItems": { "properties": { "code": { "description": "Machine-readable error code", "maxLength": 255, "type": "string" }, "field": { "description": "Field that caused the error, if applicable.", "type": [ "string", "null" ] }, "message": { "description": "Human-readable explanation", "type": "string" } }, "required": [ "message" ], "title": "LegalEntitiesLegalEntityIdRegistrationDocumentsGetResponsesContentApplicationJsonSchemaErrorsItems", "type": "object" }, "LegalEntitiesLegalEntityIdRegistrationDocumentsPostRequestBodyContentApplicationJsonSchemaData": { "properties": { "documents": { "description": "One entry per requirement being answered.", "items": { "$ref": "#/components/schemas/LegalEntitiesLegalEntityIdRegistrationDocumentsPostRequestBodyContentApplicationJsonSchemaDataDocumentsItems" }, "type": "array" } }, "required": [ "documents" ], "title": "LegalEntitiesLegalEntityIdRegistrationDocumentsPostRequestBodyContentApplicationJsonSchemaData", "type": "object" }, "LegalEntitiesLegalEntityIdRegistrationDocumentsPostRequestBodyContentApplicationJsonSchemaDataDocumentsItems": { "properties": { "files": { "description": "Files previously uploaded to the File Service. Allowed types: pdf, jpg, jpeg, png, doc, docx, csv, xls, xlsx, txt, xml, mov, mp4.", "items": { "$ref": "#/components/schemas/LegalEntitiesLegalEntityIdRegistrationDocumentsPostRequestBodyContentApplicationJsonSchemaDataDocumentsItemsFilesItems" }, "type": "array" }, "requirement_id": { "description": "Public UUID of the requirement.", "format": "uuid", "type": "string" } }, "required": [ "files", "requirement_id" ], "title": "LegalEntitiesLegalEntityIdRegistrationDocumentsPostRequestBodyContentApplicationJsonSchemaDataDocumentsItems", "type": "object" }, "LegalEntitiesLegalEntityIdRegistrationDocumentsPostRequestBodyContentApplicationJsonSchemaDataDocumentsItemsFilesItems": { "properties": { "content_type": { "description": "MIME type.", "maxLength": 255, "type": "string" }, "file_id": { "description": "File Service file id.", "format": "uuid", "type": "string" }, "one_time_secret": { "description": "File Service one-time secret.", "maxLength": 1024, "minLength": 1, "type": "string" }, "original_filename": { "description": "Original filename.", "maxLength": 500, "type": "string" } }, "required": [ "file_id", "content_type", "one_time_secret", "original_filename" ], "title": "LegalEntitiesLegalEntityIdRegistrationDocumentsPostRequestBodyContentApplicationJsonSchemaDataDocumentsItemsFilesItems", "type": "object" }, "LegalEntitiesLegalEntityIdRegistrationDocumentsPostResponsesContentApplicationJsonSchemaDataItems": { "properties": { "archived_at": { "description": "When the submission was archived.", "format": "date-time", "type": [ "string", "null" ] }, "archived_submissions_count": { "description": "How many superseded revisions exist.", "minimum": 0, "type": "integer" }, "children": { "description": "Superseded revisions of this submission, newest first.", "items": { "$ref": "#/components/schemas/LegalEntitiesLegalEntityIdRegistrationDocumentsPostResponsesContentApplicationJsonSchemaDataItemsChildrenItems" }, "type": "array" }, "files": { "description": "Files attached to this submission.", "items": { "$ref": "#/components/schemas/LegalEntitiesLegalEntityIdRegistrationDocumentsPostResponsesContentApplicationJsonSchemaDataItemsFilesItems" }, "type": "array" }, "id": { "description": "Public UUID of the submission. Null when nothing has been submitted for this requirement yet.", "format": "uuid", "type": [ "string", "null" ] }, "legal_entity": { "description": "The legal entity the document belongs to.", "oneOf": [ { "$ref": "#/components/schemas/LegalEntitiesLegalEntityIdRegistrationDocumentsPostResponsesContentApplicationJsonSchemaDataItemsLegalEntity" }, { "type": "null" } ] }, "parent": { "description": "The submission this one replaced, when it is a resubmission.", "oneOf": [ { "$ref": "#/components/schemas/LegalEntitiesLegalEntityIdRegistrationDocumentsPostResponsesContentApplicationJsonSchemaDataItemsParent" }, { "type": "null" } ] }, "rejection_reason": { "description": "Why the submission was rejected, when applicable.", "type": [ "string", "null" ] }, "requirement": { "description": "The document requirement this submission answers.", "oneOf": [ { "$ref": "#/components/schemas/LegalEntitiesLegalEntityIdRegistrationDocumentsPostResponsesContentApplicationJsonSchemaDataItemsRequirement" }, { "type": "null" } ] }, "reviewed_at": { "description": "When the document was reviewed.", "format": "date-time", "type": [ "string", "null" ] }, "status": { "$ref": "#/components/schemas/LegalEntitiesLegalEntityIdRegistrationDocumentsPostResponsesContentApplicationJsonSchemaDataItemsStatus", "description": "Current review status." }, "submission_due_date": { "description": "When the document is due.", "format": "date-time", "type": [ "string", "null" ] }, "submitted_at": { "description": "When the document was submitted.", "format": "date-time", "type": [ "string", "null" ] } }, "required": [ "id", "status" ], "title": "LegalEntitiesLegalEntityIdRegistrationDocumentsPostResponsesContentApplicationJsonSchemaDataItems", "type": "object" }, "LegalEntitiesLegalEntityIdRegistrationDocumentsPostResponsesContentApplicationJsonSchemaDataItemsChildrenItems": { "properties": { "archived_at": { "description": "When the submission was archived.", "format": "date-time", "type": [ "string", "null" ] }, "files": { "description": "Files attached to this submission.", "items": { "$ref": "#/components/schemas/LegalEntitiesLegalEntityIdRegistrationDocumentsPostResponsesContentApplicationJsonSchemaDataItemsChildrenItemsFilesItems" }, "type": "array" }, "id": { "description": "Public UUID of the submission. Null when nothing has been submitted for this requirement yet.", "format": "uuid", "type": [ "string", "null" ] }, "rejection_reason": { "description": "Why the submission was rejected, when applicable.", "type": [ "string", "null" ] }, "reviewed_at": { "description": "When the document was reviewed.", "format": "date-time", "type": [ "string", "null" ] }, "status": { "$ref": "#/components/schemas/LegalEntitiesLegalEntityIdRegistrationDocumentsPostResponsesContentApplicationJsonSchemaDataItemsChildrenItemsStatus", "description": "Current review status." }, "submitted_at": { "description": "When the document was submitted.", "format": "date-time", "type": [ "string", "null" ] } }, "required": [ "id", "status" ], "title": "LegalEntitiesLegalEntityIdRegistrationDocumentsPostResponsesContentApplicationJsonSchemaDataItemsChildrenItems", "type": "object" }, "LegalEntitiesLegalEntityIdRegistrationDocumentsPostResponsesContentApplicationJsonSchemaDataItemsChildrenItemsFilesItems": { "properties": { "content_type": { "description": "MIME type of the file.", "type": [ "string", "null" ] }, "id": { "description": "Public UUID of the file.", "format": "uuid", "type": "string" }, "original_filename": { "description": "Filename as uploaded.", "type": "string" }, "uploaded_at": { "description": "When the file was uploaded.", "format": "date-time", "type": [ "string", "null" ] } }, "required": [ "id", "original_filename" ], "title": "LegalEntitiesLegalEntityIdRegistrationDocumentsPostResponsesContentApplicationJsonSchemaDataItemsChildrenItemsFilesItems", "type": "object" }, "LegalEntitiesLegalEntityIdRegistrationDocumentsPostResponsesContentApplicationJsonSchemaDataItemsChildrenItemsStatus": { "description": "Current review status.", "enum": [ "REQUESTED", "AWAITING_REVIEW", "REJECTED", "APPROVED", "UNSOLICITED", "COMPLETED" ], "title": "LegalEntitiesLegalEntityIdRegistrationDocumentsPostResponsesContentApplicationJsonSchemaDataItemsChildrenItemsStatus", "type": "string" }, "LegalEntitiesLegalEntityIdRegistrationDocumentsPostResponsesContentApplicationJsonSchemaDataItemsFilesItems": { "properties": { "content_type": { "description": "MIME type of the file.", "type": [ "string", "null" ] }, "id": { "description": "Public UUID of the file.", "format": "uuid", "type": "string" }, "original_filename": { "description": "Filename as uploaded.", "type": "string" }, "uploaded_at": { "description": "When the file was uploaded.", "format": "date-time", "type": [ "string", "null" ] } }, "required": [ "id", "original_filename" ], "title": "LegalEntitiesLegalEntityIdRegistrationDocumentsPostResponsesContentApplicationJsonSchemaDataItemsFilesItems", "type": "object" }, "LegalEntitiesLegalEntityIdRegistrationDocumentsPostResponsesContentApplicationJsonSchemaDataItemsLegalEntity": { "description": "The legal entity the document belongs to.", "properties": { "country": { "description": "ISO country code of the entity address.", "type": [ "string", "null" ] }, "id": { "description": "Public UUID of the legal entity.", "format": "uuid", "type": "string" }, "name": { "description": "Legal entity name.", "type": [ "string", "null" ] } }, "title": "LegalEntitiesLegalEntityIdRegistrationDocumentsPostResponsesContentApplicationJsonSchemaDataItemsLegalEntity", "type": "object" }, "LegalEntitiesLegalEntityIdRegistrationDocumentsPostResponsesContentApplicationJsonSchemaDataItemsParent": { "description": "The submission this one replaced, when it is a resubmission.", "properties": { "id": { "description": "Public UUID of the superseded submission.", "format": "uuid", "type": "string" }, "status": { "$ref": "#/components/schemas/LegalEntitiesLegalEntityIdRegistrationDocumentsPostResponsesContentApplicationJsonSchemaDataItemsParentStatus", "description": "Status of the superseded submission." } }, "title": "LegalEntitiesLegalEntityIdRegistrationDocumentsPostResponsesContentApplicationJsonSchemaDataItemsParent", "type": "object" }, "LegalEntitiesLegalEntityIdRegistrationDocumentsPostResponsesContentApplicationJsonSchemaDataItemsParentStatus": { "description": "Status of the superseded submission.", "enum": [ "REQUESTED", "AWAITING_REVIEW", "REJECTED", "APPROVED", "UNSOLICITED", "COMPLETED" ], "title": "LegalEntitiesLegalEntityIdRegistrationDocumentsPostResponsesContentApplicationJsonSchemaDataItemsParentStatus", "type": "string" }, "LegalEntitiesLegalEntityIdRegistrationDocumentsPostResponsesContentApplicationJsonSchemaDataItemsRequirement": { "description": "The document requirement this submission answers.", "properties": { "applicable_at": { "description": "When the document becomes due.", "oneOf": [ { "$ref": "#/components/schemas/LegalEntitiesLegalEntityIdRegistrationDocumentsPostResponsesContentApplicationJsonSchemaDataItemsRequirementApplicableAt" }, { "type": "null" } ] }, "description": { "description": "What the requirement asks for.", "type": [ "string", "null" ] }, "has_template": { "description": "Whether a template is provided. Fetch it from the requirement template endpoint.", "type": "boolean" }, "how_client_obtains_document": { "description": "How to obtain it.", "type": [ "string", "null" ] }, "how_the_document_is_used": { "description": "How the document is used once submitted.", "oneOf": [ { "$ref": "#/components/schemas/LegalEntitiesLegalEntityIdRegistrationDocumentsPostResponsesContentApplicationJsonSchemaDataItemsRequirementHowTheDocumentIsUsed" }, { "type": "null" } ] }, "id": { "description": "Public UUID of the requirement.", "format": "uuid", "type": "string" }, "is_approval_required": { "description": "Whether a submission against this requirement is reviewed. False means a submission is accepted immediately as COMPLETED.", "type": "boolean" }, "is_disabled": { "description": "Whether the requirement is no longer requested.", "type": "boolean" }, "is_submission_required": { "description": "Whether the document is mandatory rather than optional.", "type": "boolean" }, "name": { "description": "Requirement name.", "type": [ "string", "null" ] }, "product_type": { "description": "Product the requirement applies to.", "oneOf": [ { "$ref": "#/components/schemas/LegalEntitiesLegalEntityIdRegistrationDocumentsPostResponsesContentApplicationJsonSchemaDataItemsRequirementProductType" }, { "type": "null" } ] }, "reference_url": { "description": "External reference for the requirement.", "type": [ "string", "null" ] }, "why_the_document_is_needed": { "description": "Why the document is required.", "type": [ "string", "null" ] } }, "required": [ "id" ], "title": "LegalEntitiesLegalEntityIdRegistrationDocumentsPostResponsesContentApplicationJsonSchemaDataItemsRequirement", "type": "object" }, "LegalEntitiesLegalEntityIdRegistrationDocumentsPostResponsesContentApplicationJsonSchemaDataItemsRequirementApplicableAt": { "description": "When the document becomes due.", "enum": [ "BEFORE_FIRST_PAYROLL", "ANYTIME" ], "title": "LegalEntitiesLegalEntityIdRegistrationDocumentsPostResponsesContentApplicationJsonSchemaDataItemsRequirementApplicableAt", "type": "string" }, "LegalEntitiesLegalEntityIdRegistrationDocumentsPostResponsesContentApplicationJsonSchemaDataItemsRequirementHowTheDocumentIsUsed": { "description": "How the document is used once submitted.", "enum": [ "PAYROLL_PURPOSE", "ENTITY_ONBOARDING" ], "title": "LegalEntitiesLegalEntityIdRegistrationDocumentsPostResponsesContentApplicationJsonSchemaDataItemsRequirementHowTheDocumentIsUsed", "type": "string" }, "LegalEntitiesLegalEntityIdRegistrationDocumentsPostResponsesContentApplicationJsonSchemaDataItemsRequirementProductType": { "description": "Product the requirement applies to.", "enum": [ "EMBEDDED_PAYROLL", "GLOBAL_PAYROLL", "PEO" ], "title": "LegalEntitiesLegalEntityIdRegistrationDocumentsPostResponsesContentApplicationJsonSchemaDataItemsRequirementProductType", "type": "string" }, "LegalEntitiesLegalEntityIdRegistrationDocumentsPostResponsesContentApplicationJsonSchemaDataItemsStatus": { "description": "Current review status.", "enum": [ "REQUESTED", "AWAITING_REVIEW", "REJECTED", "APPROVED", "UNSOLICITED", "COMPLETED" ], "title": "LegalEntitiesLegalEntityIdRegistrationDocumentsPostResponsesContentApplicationJsonSchemaDataItemsStatus", "type": "string" }, "LegalEntitiesLegalEntityIdRegistrationDocumentsPostResponsesContentApplicationJsonSchemaErrorsItems": { "properties": { "code": { "description": "Machine-readable error code", "maxLength": 255, "type": "string" }, "field": { "description": "Field that caused the error, if applicable.", "type": [ "string", "null" ] }, "message": { "description": "Human-readable explanation", "type": "string" } }, "required": [ "message" ], "title": "LegalEntitiesLegalEntityIdRegistrationDocumentsPostResponsesContentApplicationJsonSchemaErrorsItems", "type": "object" }, "LegalEntitiesLegalEntityIdSettingsPostRequestBodyContentApplicationJsonSchemaData": { "properties": { "key": { "$ref": "#/components/schemas/LegalEntitiesLegalEntityIdSettingsPostRequestBodyContentApplicationJsonSchemaDataKey", "description": "The setting key to update. Only ALLOW_GP_EMPLOYEE_APP_ACCESS is supported today." }, "value": { "$ref": "#/components/schemas/LegalEntitiesLegalEntityIdSettingsPostRequestBodyContentApplicationJsonSchemaDataValue", "description": "Set to \"true\" to grant employees access to the Deel app, or \"false\" to revoke it." } }, "required": [ "key", "value" ], "title": "LegalEntitiesLegalEntityIdSettingsPostRequestBodyContentApplicationJsonSchemaData", "type": "object" }, "LegalEntitiesLegalEntityIdSettingsPostRequestBodyContentApplicationJsonSchemaDataKey": { "description": "The setting key to update. Only ALLOW_GP_EMPLOYEE_APP_ACCESS is supported today.", "enum": [ "ALLOW_GP_EMPLOYEE_APP_ACCESS" ], "title": "LegalEntitiesLegalEntityIdSettingsPostRequestBodyContentApplicationJsonSchemaDataKey", "type": "string" }, "LegalEntitiesLegalEntityIdSettingsPostRequestBodyContentApplicationJsonSchemaDataValue": { "description": "Set to \"true\" to grant employees access to the Deel app, or \"false\" to revoke it.", "enum": [ "true", "false" ], "title": "LegalEntitiesLegalEntityIdSettingsPostRequestBodyContentApplicationJsonSchemaDataValue", "type": "string" }, "LegalEntitiesLegalEntityIdSettingsPostResponsesContentApplicationJsonSchemaData": { "properties": { "key": { "description": "The setting key that was updated.", "type": "string" }, "value": { "description": "The setting value that was applied.", "type": "string" } }, "title": "LegalEntitiesLegalEntityIdSettingsPostResponsesContentApplicationJsonSchemaData", "type": "object" }, "LegalEntitiesPostRequestBodyContentApplicationJsonSchemaData": { "properties": { "address": { "$ref": "#/components/schemas/LegalEntitiesPostRequestBodyContentApplicationJsonSchemaDataAddress", "description": "The physical address of the entity." }, "company_identifiers": { "$ref": "#/components/schemas/LegalEntitiesPostRequestBodyContentApplicationJsonSchemaDataCompanyIdentifiers" }, "entity_type": { "description": "Type of the entity.", "type": "string" }, "name": { "description": "The legal name of the entity.", "type": "string" }, "phone": { "description": "Contact phone number for the entity.", "type": "string" }, "sic_number": { "description": "The SIC number for the entity.", "type": "string" } }, "required": [ "name", "phone", "address", "sic_number", "entity_type", "company_identifiers" ], "title": "LegalEntitiesPostRequestBodyContentApplicationJsonSchemaData", "type": "object" }, "LegalEntitiesPostRequestBodyContentApplicationJsonSchemaDataAddress": { "description": "The physical address of the entity.", "properties": { "city": { "description": "City name.", "type": "string" }, "country": { "description": "Country code.", "type": "string" }, "state": { "description": "State ", "type": "string" }, "street": { "description": "Street address.", "type": "string" }, "zip": { "description": "Zip code.", "type": "string" } }, "required": [ "zip", "city", "street", "country" ], "title": "LegalEntitiesPostRequestBodyContentApplicationJsonSchemaDataAddress", "type": "object" }, "LegalEntitiesPostRequestBodyContentApplicationJsonSchemaDataCompanyIdentifiers": { "properties": { "registration_number": { "description": "Registration number of the entity.", "type": "string" }, "tax_number": { "description": "Tax number of the entity.", "type": "string" } }, "required": [ "tax_number", "registration_number" ], "title": "LegalEntitiesPostRequestBodyContentApplicationJsonSchemaDataCompanyIdentifiers", "type": "object" }, "LegalEntitiesPostResponsesContentApplicationJsonSchemaData": { "properties": { "address": { "$ref": "#/components/schemas/LegalEntitiesPostResponsesContentApplicationJsonSchemaDataAddress", "description": "The entity's address." }, "created_at": { "description": "Timestamp when the entity was created.", "format": "date-time", "type": "string" }, "entity_type": { "description": "Type of the entity.", "type": "string" }, "id": { "description": "The unique identifier for the legal entity.", "type": "string" }, "name": { "description": "The name of the entity.", "type": "string" }, "phone": { "description": "The contact number of the entity.", "type": "string" }, "sic_number": { "description": "The SIC number of the entity.", "type": "string" }, "updated_at": { "description": "Timestamp when the entity was last updated.", "format": "date-time", "type": "string" } }, "title": "LegalEntitiesPostResponsesContentApplicationJsonSchemaData", "type": "object" }, "LegalEntitiesPostResponsesContentApplicationJsonSchemaDataAddress": { "description": "The entity's address.", "properties": { "city": { "type": "string" }, "country": { "type": "string" }, "state": { "type": "string" }, "street": { "type": "string" }, "zip": { "type": "string" } }, "title": "LegalEntitiesPostResponsesContentApplicationJsonSchemaDataAddress", "type": "object" }, "LegalEntitiesRegistrationDocumentsGetParametersProductTypeSchemaItems": { "enum": [ "EMBEDDED_PAYROLL", "GLOBAL_PAYROLL", "PEO" ], "title": "LegalEntitiesRegistrationDocumentsGetParametersProductTypeSchemaItems", "type": "string" }, "LegalEntitiesRegistrationDocumentsGetParametersStatusSchemaItems": { "enum": [ "REQUESTED", "AWAITING_REVIEW", "REJECTED", "APPROVED", "UNSOLICITED", "COMPLETED" ], "title": "LegalEntitiesRegistrationDocumentsGetParametersStatusSchemaItems", "type": "string" }, "LegalEntitiesRegistrationDocumentsGetResponsesContentApplicationJsonSchemaDataItems": { "properties": { "archived_at": { "description": "When the submission was archived.", "format": "date-time", "type": [ "string", "null" ] }, "archived_submissions_count": { "description": "How many superseded revisions exist.", "minimum": 0, "type": "integer" }, "children": { "description": "Superseded revisions of this submission, newest first.", "items": { "$ref": "#/components/schemas/LegalEntitiesRegistrationDocumentsGetResponsesContentApplicationJsonSchemaDataItemsChildrenItems" }, "type": "array" }, "files": { "description": "Files attached to this submission.", "items": { "$ref": "#/components/schemas/LegalEntitiesRegistrationDocumentsGetResponsesContentApplicationJsonSchemaDataItemsFilesItems" }, "type": "array" }, "id": { "description": "Public UUID of the submission. Null when nothing has been submitted for this requirement yet.", "format": "uuid", "type": [ "string", "null" ] }, "legal_entity": { "description": "The legal entity the document belongs to.", "oneOf": [ { "$ref": "#/components/schemas/LegalEntitiesRegistrationDocumentsGetResponsesContentApplicationJsonSchemaDataItemsLegalEntity" }, { "type": "null" } ] }, "parent": { "description": "The submission this one replaced, when it is a resubmission.", "oneOf": [ { "$ref": "#/components/schemas/LegalEntitiesRegistrationDocumentsGetResponsesContentApplicationJsonSchemaDataItemsParent" }, { "type": "null" } ] }, "rejection_reason": { "description": "Why the submission was rejected, when applicable.", "type": [ "string", "null" ] }, "requirement": { "description": "The document requirement this submission answers.", "oneOf": [ { "$ref": "#/components/schemas/LegalEntitiesRegistrationDocumentsGetResponsesContentApplicationJsonSchemaDataItemsRequirement" }, { "type": "null" } ] }, "reviewed_at": { "description": "When the document was reviewed.", "format": "date-time", "type": [ "string", "null" ] }, "status": { "$ref": "#/components/schemas/LegalEntitiesRegistrationDocumentsGetResponsesContentApplicationJsonSchemaDataItemsStatus", "description": "Current review status." }, "submission_due_date": { "description": "When the document is due.", "format": "date-time", "type": [ "string", "null" ] }, "submitted_at": { "description": "When the document was submitted.", "format": "date-time", "type": [ "string", "null" ] } }, "required": [ "id", "status" ], "title": "LegalEntitiesRegistrationDocumentsGetResponsesContentApplicationJsonSchemaDataItems", "type": "object" }, "LegalEntitiesRegistrationDocumentsGetResponsesContentApplicationJsonSchemaDataItemsChildrenItems": { "properties": { "archived_at": { "description": "When the submission was archived.", "format": "date-time", "type": [ "string", "null" ] }, "files": { "description": "Files attached to this submission.", "items": { "$ref": "#/components/schemas/LegalEntitiesRegistrationDocumentsGetResponsesContentApplicationJsonSchemaDataItemsChildrenItemsFilesItems" }, "type": "array" }, "id": { "description": "Public UUID of the submission. Null when nothing has been submitted for this requirement yet.", "format": "uuid", "type": [ "string", "null" ] }, "rejection_reason": { "description": "Why the submission was rejected, when applicable.", "type": [ "string", "null" ] }, "reviewed_at": { "description": "When the document was reviewed.", "format": "date-time", "type": [ "string", "null" ] }, "status": { "$ref": "#/components/schemas/LegalEntitiesRegistrationDocumentsGetResponsesContentApplicationJsonSchemaDataItemsChildrenItemsStatus", "description": "Current review status." }, "submitted_at": { "description": "When the document was submitted.", "format": "date-time", "type": [ "string", "null" ] } }, "required": [ "id", "status" ], "title": "LegalEntitiesRegistrationDocumentsGetResponsesContentApplicationJsonSchemaDataItemsChildrenItems", "type": "object" }, "LegalEntitiesRegistrationDocumentsGetResponsesContentApplicationJsonSchemaDataItemsChildrenItemsFilesItems": { "properties": { "content_type": { "description": "MIME type of the file.", "type": [ "string", "null" ] }, "id": { "description": "Public UUID of the file.", "format": "uuid", "type": "string" }, "original_filename": { "description": "Filename as uploaded.", "type": "string" }, "uploaded_at": { "description": "When the file was uploaded.", "format": "date-time", "type": [ "string", "null" ] } }, "required": [ "id", "original_filename" ], "title": "LegalEntitiesRegistrationDocumentsGetResponsesContentApplicationJsonSchemaDataItemsChildrenItemsFilesItems", "type": "object" }, "LegalEntitiesRegistrationDocumentsGetResponsesContentApplicationJsonSchemaDataItemsChildrenItemsStatus": { "description": "Current review status.", "enum": [ "REQUESTED", "AWAITING_REVIEW", "REJECTED", "APPROVED", "UNSOLICITED", "COMPLETED" ], "title": "LegalEntitiesRegistrationDocumentsGetResponsesContentApplicationJsonSchemaDataItemsChildrenItemsStatus", "type": "string" }, "LegalEntitiesRegistrationDocumentsGetResponsesContentApplicationJsonSchemaDataItemsFilesItems": { "properties": { "content_type": { "description": "MIME type of the file.", "type": [ "string", "null" ] }, "id": { "description": "Public UUID of the file.", "format": "uuid", "type": "string" }, "original_filename": { "description": "Filename as uploaded.", "type": "string" }, "uploaded_at": { "description": "When the file was uploaded.", "format": "date-time", "type": [ "string", "null" ] } }, "required": [ "id", "original_filename" ], "title": "LegalEntitiesRegistrationDocumentsGetResponsesContentApplicationJsonSchemaDataItemsFilesItems", "type": "object" }, "LegalEntitiesRegistrationDocumentsGetResponsesContentApplicationJsonSchemaDataItemsLegalEntity": { "description": "The legal entity the document belongs to.", "properties": { "country": { "description": "ISO country code of the entity address.", "type": [ "string", "null" ] }, "id": { "description": "Public UUID of the legal entity.", "format": "uuid", "type": "string" }, "name": { "description": "Legal entity name.", "type": [ "string", "null" ] } }, "title": "LegalEntitiesRegistrationDocumentsGetResponsesContentApplicationJsonSchemaDataItemsLegalEntity", "type": "object" }, "LegalEntitiesRegistrationDocumentsGetResponsesContentApplicationJsonSchemaDataItemsParent": { "description": "The submission this one replaced, when it is a resubmission.", "properties": { "id": { "description": "Public UUID of the superseded submission.", "format": "uuid", "type": "string" }, "status": { "$ref": "#/components/schemas/LegalEntitiesRegistrationDocumentsGetResponsesContentApplicationJsonSchemaDataItemsParentStatus", "description": "Status of the superseded submission." } }, "title": "LegalEntitiesRegistrationDocumentsGetResponsesContentApplicationJsonSchemaDataItemsParent", "type": "object" }, "LegalEntitiesRegistrationDocumentsGetResponsesContentApplicationJsonSchemaDataItemsParentStatus": { "description": "Status of the superseded submission.", "enum": [ "REQUESTED", "AWAITING_REVIEW", "REJECTED", "APPROVED", "UNSOLICITED", "COMPLETED" ], "title": "LegalEntitiesRegistrationDocumentsGetResponsesContentApplicationJsonSchemaDataItemsParentStatus", "type": "string" }, "LegalEntitiesRegistrationDocumentsGetResponsesContentApplicationJsonSchemaDataItemsRequirement": { "description": "The document requirement this submission answers.", "properties": { "applicable_at": { "description": "When the document becomes due.", "oneOf": [ { "$ref": "#/components/schemas/LegalEntitiesRegistrationDocumentsGetResponsesContentApplicationJsonSchemaDataItemsRequirementApplicableAt" }, { "type": "null" } ] }, "description": { "description": "What the requirement asks for.", "type": [ "string", "null" ] }, "has_template": { "description": "Whether a template is provided. Fetch it from the requirement template endpoint.", "type": "boolean" }, "how_client_obtains_document": { "description": "How to obtain it.", "type": [ "string", "null" ] }, "how_the_document_is_used": { "description": "How the document is used once submitted.", "oneOf": [ { "$ref": "#/components/schemas/LegalEntitiesRegistrationDocumentsGetResponsesContentApplicationJsonSchemaDataItemsRequirementHowTheDocumentIsUsed" }, { "type": "null" } ] }, "id": { "description": "Public UUID of the requirement.", "format": "uuid", "type": "string" }, "is_approval_required": { "description": "Whether a submission against this requirement is reviewed. False means a submission is accepted immediately as COMPLETED.", "type": "boolean" }, "is_disabled": { "description": "Whether the requirement is no longer requested.", "type": "boolean" }, "is_submission_required": { "description": "Whether the document is mandatory rather than optional.", "type": "boolean" }, "name": { "description": "Requirement name.", "type": [ "string", "null" ] }, "product_type": { "description": "Product the requirement applies to.", "oneOf": [ { "$ref": "#/components/schemas/LegalEntitiesRegistrationDocumentsGetResponsesContentApplicationJsonSchemaDataItemsRequirementProductType" }, { "type": "null" } ] }, "reference_url": { "description": "External reference for the requirement.", "type": [ "string", "null" ] }, "why_the_document_is_needed": { "description": "Why the document is required.", "type": [ "string", "null" ] } }, "required": [ "id" ], "title": "LegalEntitiesRegistrationDocumentsGetResponsesContentApplicationJsonSchemaDataItemsRequirement", "type": "object" }, "LegalEntitiesRegistrationDocumentsGetResponsesContentApplicationJsonSchemaDataItemsRequirementApplicableAt": { "description": "When the document becomes due.", "enum": [ "BEFORE_FIRST_PAYROLL", "ANYTIME" ], "title": "LegalEntitiesRegistrationDocumentsGetResponsesContentApplicationJsonSchemaDataItemsRequirementApplicableAt", "type": "string" }, "LegalEntitiesRegistrationDocumentsGetResponsesContentApplicationJsonSchemaDataItemsRequirementHowTheDocumentIsUsed": { "description": "How the document is used once submitted.", "enum": [ "PAYROLL_PURPOSE", "ENTITY_ONBOARDING" ], "title": "LegalEntitiesRegistrationDocumentsGetResponsesContentApplicationJsonSchemaDataItemsRequirementHowTheDocumentIsUsed", "type": "string" }, "LegalEntitiesRegistrationDocumentsGetResponsesContentApplicationJsonSchemaDataItemsRequirementProductType": { "description": "Product the requirement applies to.", "enum": [ "EMBEDDED_PAYROLL", "GLOBAL_PAYROLL", "PEO" ], "title": "LegalEntitiesRegistrationDocumentsGetResponsesContentApplicationJsonSchemaDataItemsRequirementProductType", "type": "string" }, "LegalEntitiesRegistrationDocumentsGetResponsesContentApplicationJsonSchemaDataItemsStatus": { "description": "Current review status.", "enum": [ "REQUESTED", "AWAITING_REVIEW", "REJECTED", "APPROVED", "UNSOLICITED", "COMPLETED" ], "title": "LegalEntitiesRegistrationDocumentsGetResponsesContentApplicationJsonSchemaDataItemsStatus", "type": "string" }, "LegalEntitiesRegistrationDocumentsGetResponsesContentApplicationJsonSchemaErrorsItems": { "properties": { "code": { "description": "Machine-readable error code", "maxLength": 255, "type": "string" }, "field": { "description": "Field that caused the error, if applicable.", "type": [ "string", "null" ] }, "message": { "description": "Human-readable explanation", "type": "string" } }, "required": [ "message" ], "title": "LegalEntitiesRegistrationDocumentsGetResponsesContentApplicationJsonSchemaErrorsItems", "type": "object" }, "Legal_Entities_answerLegalEntityKybEdd-v2026-10-16_Response_200": { "properties": { "data": { "$ref": "#/components/schemas/LegalEntitiesLegalEntityIdKybEddPostResponsesContentApplicationJsonSchemaData" } }, "required": [ "data" ], "title": "Legal Entities_answerLegalEntityKybEdd-v2026-10-16_Response_200", "type": "object" }, "Legal_Entities_getCountryFieldsForALegalEntity-v2026-09-11_Response_200": { "properties": { "data": { "$ref": "#/components/schemas/LegalEntitiesCountryFieldsCountryCodeGetResponsesContentApplicationJsonSchemaData" } }, "title": "Legal Entities_getCountryFieldsForALegalEntity-v2026-09-11_Response_200", "type": "object" }, "Legal_Entities_getLegalEntity-v2026-09-09_Response_200": { "properties": { "data": { "$ref": "#/components/schemas/LegalEntitiesLegalEntityIdGetResponsesContentApplicationJsonSchemaData" } }, "title": "Legal Entities_getLegalEntity-v2026-09-09_Response_200", "type": "object" }, "Legal_Entities_getLegalEntityKybState-v2026-10-01_Response_200": { "properties": { "data": { "$ref": "#/components/schemas/LegalEntitiesLegalEntityIdKybGetResponsesContentApplicationJsonSchemaData" } }, "required": [ "data" ], "title": "Legal Entities_getLegalEntityKybState-v2026-10-01_Response_200", "type": "object" }, "Legal_Entities_submitLegalEntityKyb-v2026-10-12_Response_200": { "properties": { "data": { "$ref": "#/components/schemas/LegalEntitiesLegalEntityIdKybPostResponsesContentApplicationJsonSchemaData" } }, "required": [ "data" ], "title": "Legal Entities_submitLegalEntityKyb-v2026-10-12_Response_200", "type": "object" }, "Legal_Entities_updateLegalEntitySetting-v2026-09-02_Response_200": { "properties": { "data": { "$ref": "#/components/schemas/LegalEntitiesLegalEntityIdSettingsPostResponsesContentApplicationJsonSchemaData" } }, "title": "Legal Entities_updateLegalEntitySetting-v2026-09-02_Response_200", "type": "object" }, "Legal_Entities_uploadLegalEntityKybDocument-v2026-10-02_Response_201": { "properties": { "data": { "$ref": "#/components/schemas/LegalEntitiesLegalEntityIdKybDocumentsPostResponsesContentApplicationJsonSchemaData" } }, "required": [ "data" ], "title": "Legal Entities_uploadLegalEntityKybDocument-v2026-10-02_Response_201", "type": "object" }, "Legal_Entities_uploadLegalEntityKybEddDocument-v2026-10-14_Response_201": { "properties": { "data": { "$ref": "#/components/schemas/LegalEntitiesLegalEntityIdKybEddDocumentsPostResponsesContentApplicationJsonSchemaData" } }, "required": [ "data" ], "title": "Legal Entities_uploadLegalEntityKybEddDocument-v2026-10-14_Response_201", "type": "object" }, "ListAllAmendmentsForAnEorContract-v2026-01-01RequestBadRequestError": { "properties": { "errors": { "items": { "$ref": "#/components/schemas/EorContractsContractIdAmendmentsGetResponsesContentApplicationJsonSchemaErrorsItems" }, "type": "array" } }, "required": [ "errors" ], "title": "ListAllAmendmentsForAnEorContract-v2026-01-01RequestBadRequestError", "type": "object" }, "ListAllAmendmentsForAnEorContract-v2026-01-01RequestInternalServerError": { "properties": { "errors": { "items": { "$ref": "#/components/schemas/EorContractsContractIdAmendmentsGetResponsesContentApplicationJsonSchemaErrorsItems" }, "type": "array" } }, "required": [ "errors" ], "title": "ListAllAmendmentsForAnEorContract-v2026-01-01RequestInternalServerError", "type": "object" }, "ListAllAmendmentsForAnEorContract-v2026-01-01RequestNotFoundError": { "properties": { "errors": { "items": { "$ref": "#/components/schemas/EorContractsContractIdAmendmentsGetResponsesContentApplicationJsonSchemaErrorsItems" }, "type": "array" } }, "required": [ "errors" ], "title": "ListAllAmendmentsForAnEorContract-v2026-01-01RequestNotFoundError", "type": "object" }, "ListAllCustomFields-v2026-01-01RequestInternalServerError": { "properties": { "errors": { "items": { "$ref": "#/components/schemas/ContractsCustomFieldsGetResponsesContentApplicationJsonSchemaErrorsItems" }, "type": "array" } }, "title": "ListAllCustomFields-v2026-01-01RequestInternalServerError", "type": "object" }, "ListAllIndustrySubcategories-v2026-01-01RequestBadRequestError": { "properties": { "errors": { "items": { "$ref": "#/components/schemas/IndustriesGetResponsesContentApplicationJsonSchemaErrorsItems" }, "type": "array" }, "request": { "$ref": "#/components/schemas/IndustriesGetResponsesContentApplicationJsonSchemaRequest" } }, "title": "ListAllIndustrySubcategories-v2026-01-01RequestBadRequestError", "type": "object" }, "ListAllPeopleCustomFields-v2026-01-01RequestInternalServerError": { "properties": { "message": { "description": "Error message", "type": "string" } }, "title": "ListAllPeopleCustomFields-v2026-01-01RequestInternalServerError", "type": "object" }, "ListApplicationFeedbacks-v2026-07-02RequestBadRequestError": { "properties": { "errors": { "description": "List of error objects", "items": { "$ref": "#/components/schemas/AtsApplicationsApplicationIdFeedbacksGetResponsesContentApplicationJsonSchemaErrorsItems" }, "type": "array" } }, "required": [ "errors" ], "title": "ListApplicationFeedbacks-v2026-07-02RequestBadRequestError", "type": "object" }, "ListApplicationFeedbacks-v2026-07-02RequestForbiddenError": { "properties": { "errors": { "description": "List of error objects", "items": { "$ref": "#/components/schemas/AtsApplicationsApplicationIdFeedbacksGetResponsesContentApplicationJsonSchemaErrorsItems" }, "type": "array" } }, "required": [ "errors" ], "title": "ListApplicationFeedbacks-v2026-07-02RequestForbiddenError", "type": "object" }, "ListApplicationFeedbacks-v2026-07-02RequestInternalServerError": { "properties": { "errors": { "description": "List of error objects", "items": { "$ref": "#/components/schemas/AtsApplicationsApplicationIdFeedbacksGetResponsesContentApplicationJsonSchemaErrorsItems" }, "type": "array" } }, "required": [ "errors" ], "title": "ListApplicationFeedbacks-v2026-07-02RequestInternalServerError", "type": "object" }, "ListCaseInvoices-v2026-10-14RequestBadRequestError": { "properties": { "errors": { "items": { "$ref": "#/components/schemas/ImmigrationInvoicesGetResponsesContentApplicationJsonSchemaErrorsItems" }, "type": "array" } }, "title": "ListCaseInvoices-v2026-10-14RequestBadRequestError", "type": "object" }, "ListCaseInvoices-v2026-10-14RequestInternalServerError": { "properties": { "errors": { "items": { "$ref": "#/components/schemas/ImmigrationInvoicesGetResponsesContentApplicationJsonSchemaErrorsItems" }, "type": "array" } }, "title": "ListCaseInvoices-v2026-10-14RequestInternalServerError", "type": "object" }, "ListCaseNotes-v2026-08-10RequestBadRequestError": { "properties": { "errors": { "items": { "$ref": "#/components/schemas/ImmigrationNotesGetResponsesContentApplicationJsonSchemaErrorsItems" }, "type": "array" } }, "title": "ListCaseNotes-v2026-08-10RequestBadRequestError", "type": "object" }, "ListCaseNotes-v2026-08-10RequestInternalServerError": { "properties": { "errors": { "items": { "$ref": "#/components/schemas/ImmigrationNotesGetResponsesContentApplicationJsonSchemaErrorsItems" }, "type": "array" } }, "title": "ListCaseNotes-v2026-08-10RequestInternalServerError", "type": "object" }, "ListCaseVisaApplicationQuotes-v2026-10-14RequestBadRequestError": { "properties": { "errors": { "items": { "$ref": "#/components/schemas/ImmigrationVisaApplicationQuotesGetResponsesContentApplicationJsonSchemaErrorsItems" }, "type": "array" } }, "title": "ListCaseVisaApplicationQuotes-v2026-10-14RequestBadRequestError", "type": "object" }, "ListCaseVisaApplicationQuotes-v2026-10-14RequestInternalServerError": { "properties": { "errors": { "items": { "$ref": "#/components/schemas/ImmigrationVisaApplicationQuotesGetResponsesContentApplicationJsonSchemaErrorsItems" }, "type": "array" } }, "title": "ListCaseVisaApplicationQuotes-v2026-10-14RequestInternalServerError", "type": "object" }, "ListClearanceRequests-v2026-09-16RequestBadRequestError": { "properties": { "errors": { "items": { "$ref": "#/components/schemas/ItClearanceRequestsGetResponsesContentApplicationJsonSchemaErrorsItems" }, "type": "array" } }, "required": [ "errors" ], "title": "ListClearanceRequests-v2026-09-16RequestBadRequestError", "type": "object" }, "ListClearanceRequests-v2026-09-16RequestForbiddenError": { "properties": { "errors": { "items": { "$ref": "#/components/schemas/ItClearanceRequestsGetResponsesContentApplicationJsonSchemaErrorsItems" }, "type": "array" } }, "required": [ "errors" ], "title": "ListClearanceRequests-v2026-09-16RequestForbiddenError", "type": "object" }, "ListClearanceRequests-v2026-09-16RequestInternalServerError": { "properties": { "errors": { "items": { "$ref": "#/components/schemas/ItClearanceRequestsGetResponsesContentApplicationJsonSchemaErrorsItems" }, "type": "array" } }, "required": [ "errors" ], "title": "ListClearanceRequests-v2026-09-16RequestInternalServerError", "type": "object" }, "ListClearanceRequests-v2026-09-16RequestUnauthorizedError": { "properties": { "errors": { "items": { "$ref": "#/components/schemas/ItClearanceRequestsGetResponsesContentApplicationJsonSchemaErrorsItems" }, "type": "array" } }, "required": [ "errors" ], "title": "ListClearanceRequests-v2026-09-16RequestUnauthorizedError", "type": "object" }, "ListContractAmendments-v2026-01-01RequestBadRequestError": { "properties": { "errors": { "items": { "$ref": "#/components/schemas/ContractsContractIdAmendmentsGetResponsesContentApplicationJsonSchemaErrorsItems" }, "type": "array" } }, "title": "ListContractAmendments-v2026-01-01RequestBadRequestError", "type": "object" }, "ListContractAmendments-v2026-01-01RequestInternalServerError": { "properties": { "errors": { "items": { "$ref": "#/components/schemas/ContractsContractIdAmendmentsGetResponsesContentApplicationJsonSchemaErrorsItems" }, "type": "array" } }, "title": "ListContractAmendments-v2026-01-01RequestInternalServerError", "type": "object" }, "ListContractTerminationReasons-v2026-01-01RequestBadRequestError": { "properties": { "errors": { "items": { "$ref": "#/components/schemas/ContractsTerminationReasonsGetResponsesContentApplicationJsonSchemaErrorsItems" }, "type": "array" } }, "title": "ListContractTerminationReasons-v2026-01-01RequestBadRequestError", "type": "object" }, "ListContractTerminationReasons-v2026-01-01RequestInternalServerError": { "properties": { "errors": { "items": { "$ref": "#/components/schemas/ContractsTerminationReasonsGetResponsesContentApplicationJsonSchemaErrorsItems" }, "type": "array" } }, "title": "ListContractTerminationReasons-v2026-01-01RequestInternalServerError", "type": "object" }, "ListEquityAmortizations-v2026-09-09RequestBadRequestError": { "properties": { "errors": { "description": "List of errors that occurred while processing the request.", "items": { "$ref": "#/components/schemas/EquityAmortizationsGetResponsesContentApplicationJsonSchemaErrorsItems" }, "type": "array" } }, "required": [ "errors" ], "title": "ListEquityAmortizations-v2026-09-09RequestBadRequestError", "type": "object" }, "ListEquityAmortizations-v2026-09-09RequestForbiddenError": { "properties": { "errors": { "description": "List of errors that occurred while processing the request.", "items": { "$ref": "#/components/schemas/EquityAmortizationsGetResponsesContentApplicationJsonSchemaErrorsItems" }, "type": "array" } }, "required": [ "errors" ], "title": "ListEquityAmortizations-v2026-09-09RequestForbiddenError", "type": "object" }, "ListEquityAmortizations-v2026-09-09RequestInternalServerError": { "properties": { "errors": { "description": "List of errors that occurred while processing the request.", "items": { "$ref": "#/components/schemas/EquityAmortizationsGetResponsesContentApplicationJsonSchemaErrorsItems" }, "type": "array" } }, "required": [ "errors" ], "title": "ListEquityAmortizations-v2026-09-09RequestInternalServerError", "type": "object" }, "ListEquityAmortizations-v2026-09-09RequestNotFoundError": { "properties": { "errors": { "description": "List of errors that occurred while processing the request.", "items": { "$ref": "#/components/schemas/EquityAmortizationsGetResponsesContentApplicationJsonSchemaErrorsItems" }, "type": "array" } }, "required": [ "errors" ], "title": "ListEquityAmortizations-v2026-09-09RequestNotFoundError", "type": "object" }, "ListEquityAmortizations-v2026-09-09RequestUnauthorizedError": { "properties": { "errors": { "description": "List of errors that occurred while processing the request.", "items": { "$ref": "#/components/schemas/EquityAmortizationsGetResponsesContentApplicationJsonSchemaErrorsItems" }, "type": "array" } }, "required": [ "errors" ], "title": "ListEquityAmortizations-v2026-09-09RequestUnauthorizedError", "type": "object" }, "ListEquityAwards-v2026-09-09RequestBadRequestError": { "properties": { "errors": { "description": "List of errors that occurred while processing the request.", "items": { "$ref": "#/components/schemas/EquityAwardsGetResponsesContentApplicationJsonSchemaErrorsItems" }, "type": "array" } }, "required": [ "errors" ], "title": "ListEquityAwards-v2026-09-09RequestBadRequestError", "type": "object" }, "ListEquityAwards-v2026-09-09RequestForbiddenError": { "properties": { "errors": { "description": "List of errors that occurred while processing the request.", "items": { "$ref": "#/components/schemas/EquityAwardsGetResponsesContentApplicationJsonSchemaErrorsItems" }, "type": "array" } }, "required": [ "errors" ], "title": "ListEquityAwards-v2026-09-09RequestForbiddenError", "type": "object" }, "ListEquityAwards-v2026-09-09RequestInternalServerError": { "properties": { "errors": { "description": "List of errors that occurred while processing the request.", "items": { "$ref": "#/components/schemas/EquityAwardsGetResponsesContentApplicationJsonSchemaErrorsItems" }, "type": "array" } }, "required": [ "errors" ], "title": "ListEquityAwards-v2026-09-09RequestInternalServerError", "type": "object" }, "ListEquityAwards-v2026-09-09RequestNotFoundError": { "properties": { "errors": { "description": "List of errors that occurred while processing the request.", "items": { "$ref": "#/components/schemas/EquityAwardsGetResponsesContentApplicationJsonSchemaErrorsItems" }, "type": "array" } }, "required": [ "errors" ], "title": "ListEquityAwards-v2026-09-09RequestNotFoundError", "type": "object" }, "ListEquityAwards-v2026-09-09RequestUnauthorizedError": { "properties": { "errors": { "description": "List of errors that occurred while processing the request.", "items": { "$ref": "#/components/schemas/EquityAwardsGetResponsesContentApplicationJsonSchemaErrorsItems" }, "type": "array" } }, "required": [ "errors" ], "title": "ListEquityAwards-v2026-09-09RequestUnauthorizedError", "type": "object" }, "ListEquityExpenses-v2026-09-09RequestBadRequestError": { "properties": { "errors": { "description": "List of errors that occurred while processing the request.", "items": { "$ref": "#/components/schemas/EquityExpensesGetResponsesContentApplicationJsonSchemaErrorsItems" }, "type": "array" } }, "required": [ "errors" ], "title": "ListEquityExpenses-v2026-09-09RequestBadRequestError", "type": "object" }, "ListEquityExpenses-v2026-09-09RequestForbiddenError": { "properties": { "errors": { "description": "List of errors that occurred while processing the request.", "items": { "$ref": "#/components/schemas/EquityExpensesGetResponsesContentApplicationJsonSchemaErrorsItems" }, "type": "array" } }, "required": [ "errors" ], "title": "ListEquityExpenses-v2026-09-09RequestForbiddenError", "type": "object" }, "ListEquityExpenses-v2026-09-09RequestInternalServerError": { "properties": { "errors": { "description": "List of errors that occurred while processing the request.", "items": { "$ref": "#/components/schemas/EquityExpensesGetResponsesContentApplicationJsonSchemaErrorsItems" }, "type": "array" } }, "required": [ "errors" ], "title": "ListEquityExpenses-v2026-09-09RequestInternalServerError", "type": "object" }, "ListEquityExpenses-v2026-09-09RequestNotFoundError": { "properties": { "errors": { "description": "List of errors that occurred while processing the request.", "items": { "$ref": "#/components/schemas/EquityExpensesGetResponsesContentApplicationJsonSchemaErrorsItems" }, "type": "array" } }, "required": [ "errors" ], "title": "ListEquityExpenses-v2026-09-09RequestNotFoundError", "type": "object" }, "ListEquityExpenses-v2026-09-09RequestUnauthorizedError": { "properties": { "errors": { "description": "List of errors that occurred while processing the request.", "items": { "$ref": "#/components/schemas/EquityExpensesGetResponsesContentApplicationJsonSchemaErrorsItems" }, "type": "array" } }, "required": [ "errors" ], "title": "ListEquityExpenses-v2026-09-09RequestUnauthorizedError", "type": "object" }, "ListEquityGrantsWithTaxEvents-v2026-08-10RequestBadRequestError": { "properties": { "errors": { "items": { "$ref": "#/components/schemas/EquityGrantsGetResponsesContentApplicationJsonSchemaErrorsItems" }, "type": "array" } }, "title": "ListEquityGrantsWithTaxEvents-v2026-08-10RequestBadRequestError", "type": "object" }, "ListEquityGrantsWithTaxEvents-v2026-08-10RequestForbiddenError": { "properties": { "errors": { "items": { "$ref": "#/components/schemas/EquityGrantsGetResponsesContentApplicationJsonSchemaErrorsItems" }, "type": "array" } }, "title": "ListEquityGrantsWithTaxEvents-v2026-08-10RequestForbiddenError", "type": "object" }, "ListEquityOptionLedgerEntries-v2026-09-09RequestBadRequestError": { "properties": { "errors": { "description": "List of errors that occurred while processing the request.", "items": { "$ref": "#/components/schemas/EquityOptionLedgerGetResponsesContentApplicationJsonSchemaErrorsItems" }, "type": "array" } }, "required": [ "errors" ], "title": "ListEquityOptionLedgerEntries-v2026-09-09RequestBadRequestError", "type": "object" }, "ListEquityOptionLedgerEntries-v2026-09-09RequestForbiddenError": { "properties": { "errors": { "description": "List of errors that occurred while processing the request.", "items": { "$ref": "#/components/schemas/EquityOptionLedgerGetResponsesContentApplicationJsonSchemaErrorsItems" }, "type": "array" } }, "required": [ "errors" ], "title": "ListEquityOptionLedgerEntries-v2026-09-09RequestForbiddenError", "type": "object" }, "ListEquityOptionLedgerEntries-v2026-09-09RequestInternalServerError": { "properties": { "errors": { "description": "List of errors that occurred while processing the request.", "items": { "$ref": "#/components/schemas/EquityOptionLedgerGetResponsesContentApplicationJsonSchemaErrorsItems" }, "type": "array" } }, "required": [ "errors" ], "title": "ListEquityOptionLedgerEntries-v2026-09-09RequestInternalServerError", "type": "object" }, "ListEquityOptionLedgerEntries-v2026-09-09RequestNotFoundError": { "properties": { "errors": { "description": "List of errors that occurred while processing the request.", "items": { "$ref": "#/components/schemas/EquityOptionLedgerGetResponsesContentApplicationJsonSchemaErrorsItems" }, "type": "array" } }, "required": [ "errors" ], "title": "ListEquityOptionLedgerEntries-v2026-09-09RequestNotFoundError", "type": "object" }, "ListEquityOptionLedgerEntries-v2026-09-09RequestUnauthorizedError": { "properties": { "errors": { "description": "List of errors that occurred while processing the request.", "items": { "$ref": "#/components/schemas/EquityOptionLedgerGetResponsesContentApplicationJsonSchemaErrorsItems" }, "type": "array" } }, "required": [ "errors" ], "title": "ListEquityOptionLedgerEntries-v2026-09-09RequestUnauthorizedError", "type": "object" }, "ListEquityParticipants-v2026-09-08RequestBadRequestError": { "properties": { "errors": { "description": "List of errors that occurred while processing the request.", "items": { "$ref": "#/components/schemas/EquityParticipantsGetResponsesContentApplicationJsonSchemaErrorsItems" }, "type": "array" } }, "required": [ "errors" ], "title": "ListEquityParticipants-v2026-09-08RequestBadRequestError", "type": "object" }, "ListEquityParticipants-v2026-09-08RequestForbiddenError": { "properties": { "errors": { "description": "List of errors that occurred while processing the request.", "items": { "$ref": "#/components/schemas/EquityParticipantsGetResponsesContentApplicationJsonSchemaErrorsItems" }, "type": "array" } }, "required": [ "errors" ], "title": "ListEquityParticipants-v2026-09-08RequestForbiddenError", "type": "object" }, "ListEquityParticipants-v2026-09-08RequestInternalServerError": { "properties": { "errors": { "description": "List of errors that occurred while processing the request.", "items": { "$ref": "#/components/schemas/EquityParticipantsGetResponsesContentApplicationJsonSchemaErrorsItems" }, "type": "array" } }, "required": [ "errors" ], "title": "ListEquityParticipants-v2026-09-08RequestInternalServerError", "type": "object" }, "ListEquityParticipants-v2026-09-08RequestNotFoundError": { "properties": { "errors": { "description": "List of errors that occurred while processing the request.", "items": { "$ref": "#/components/schemas/EquityParticipantsGetResponsesContentApplicationJsonSchemaErrorsItems" }, "type": "array" } }, "required": [ "errors" ], "title": "ListEquityParticipants-v2026-09-08RequestNotFoundError", "type": "object" }, "ListEquityParticipants-v2026-09-08RequestUnauthorizedError": { "properties": { "errors": { "description": "List of errors that occurred while processing the request.", "items": { "$ref": "#/components/schemas/EquityParticipantsGetResponsesContentApplicationJsonSchemaErrorsItems" }, "type": "array" } }, "required": [ "errors" ], "title": "ListEquityParticipants-v2026-09-08RequestUnauthorizedError", "type": "object" }, "ListEquityShareworksExercises-v2026-09-09RequestBadRequestError": { "properties": { "errors": { "description": "List of errors that occurred while processing the request.", "items": { "$ref": "#/components/schemas/EquityExercisesGetResponsesContentApplicationJsonSchemaErrorsItems" }, "type": "array" } }, "required": [ "errors" ], "title": "ListEquityShareworksExercises-v2026-09-09RequestBadRequestError", "type": "object" }, "ListEquityShareworksExercises-v2026-09-09RequestForbiddenError": { "properties": { "errors": { "description": "List of errors that occurred while processing the request.", "items": { "$ref": "#/components/schemas/EquityExercisesGetResponsesContentApplicationJsonSchemaErrorsItems" }, "type": "array" } }, "required": [ "errors" ], "title": "ListEquityShareworksExercises-v2026-09-09RequestForbiddenError", "type": "object" }, "ListEquityShareworksExercises-v2026-09-09RequestUnauthorizedError": { "properties": { "errors": { "description": "List of errors that occurred while processing the request.", "items": { "$ref": "#/components/schemas/EquityExercisesGetResponsesContentApplicationJsonSchemaErrorsItems" }, "type": "array" } }, "required": [ "errors" ], "title": "ListEquityShareworksExercises-v2026-09-09RequestUnauthorizedError", "type": "object" }, "ListEquityValuations-v2026-09-09RequestBadRequestError": { "properties": { "errors": { "description": "List of errors that occurred while processing the request.", "items": { "$ref": "#/components/schemas/EquityValuationsGetResponsesContentApplicationJsonSchemaErrorsItems" }, "type": "array" } }, "required": [ "errors" ], "title": "ListEquityValuations-v2026-09-09RequestBadRequestError", "type": "object" }, "ListEquityValuations-v2026-09-09RequestForbiddenError": { "properties": { "errors": { "description": "List of errors that occurred while processing the request.", "items": { "$ref": "#/components/schemas/EquityValuationsGetResponsesContentApplicationJsonSchemaErrorsItems" }, "type": "array" } }, "required": [ "errors" ], "title": "ListEquityValuations-v2026-09-09RequestForbiddenError", "type": "object" }, "ListEquityValuations-v2026-09-09RequestInternalServerError": { "properties": { "errors": { "description": "List of errors that occurred while processing the request.", "items": { "$ref": "#/components/schemas/EquityValuationsGetResponsesContentApplicationJsonSchemaErrorsItems" }, "type": "array" } }, "required": [ "errors" ], "title": "ListEquityValuations-v2026-09-09RequestInternalServerError", "type": "object" }, "ListEquityValuations-v2026-09-09RequestNotFoundError": { "properties": { "errors": { "description": "List of errors that occurred while processing the request.", "items": { "$ref": "#/components/schemas/EquityValuationsGetResponsesContentApplicationJsonSchemaErrorsItems" }, "type": "array" } }, "required": [ "errors" ], "title": "ListEquityValuations-v2026-09-09RequestNotFoundError", "type": "object" }, "ListEquityValuations-v2026-09-09RequestUnauthorizedError": { "properties": { "errors": { "description": "List of errors that occurred while processing the request.", "items": { "$ref": "#/components/schemas/EquityValuationsGetResponsesContentApplicationJsonSchemaErrorsItems" }, "type": "array" } }, "required": [ "errors" ], "title": "ListEquityValuations-v2026-09-09RequestUnauthorizedError", "type": "object" }, "ListFeedbacks-v2026-09-18RequestBadRequestError": { "properties": { "errors": { "description": "List of error objects", "items": { "$ref": "#/components/schemas/AtsFeedbacksGetResponsesContentApplicationJsonSchemaErrorsItems" }, "type": "array" } }, "required": [ "errors" ], "title": "ListFeedbacks-v2026-09-18RequestBadRequestError", "type": "object" }, "ListFeedbacks-v2026-09-18RequestForbiddenError": { "properties": { "errors": { "description": "List of error objects", "items": { "$ref": "#/components/schemas/AtsFeedbacksGetResponsesContentApplicationJsonSchemaErrorsItems" }, "type": "array" } }, "required": [ "errors" ], "title": "ListFeedbacks-v2026-09-18RequestForbiddenError", "type": "object" }, "ListFeedbacks-v2026-09-18RequestInternalServerError": { "properties": { "errors": { "description": "List of error objects", "items": { "$ref": "#/components/schemas/AtsFeedbacksGetResponsesContentApplicationJsonSchemaErrorsItems" }, "type": "array" } }, "required": [ "errors" ], "title": "ListFeedbacks-v2026-09-18RequestInternalServerError", "type": "object" }, "ListGrossToNetReport-v2026-01-01RequestBadRequestError": { "properties": { "errors": { "items": { "$ref": "#/components/schemas/GpReportsIdGrossToNetGetResponsesContentApplicationJsonSchemaErrorsItems" }, "type": "array" }, "request": { "$ref": "#/components/schemas/GpReportsIdGrossToNetGetResponsesContentApplicationJsonSchemaRequest" } }, "title": "ListGrossToNetReport-v2026-01-01RequestBadRequestError", "type": "object" }, "ListInterviews-v2026-06-03RequestBadRequestError": { "properties": { "errors": { "description": "List of error objects", "items": { "$ref": "#/components/schemas/AtsInterviewsGetResponsesContentApplicationJsonSchemaErrorsItems" }, "type": "array" } }, "required": [ "errors" ], "title": "ListInterviews-v2026-06-03RequestBadRequestError", "type": "object" }, "ListInterviews-v2026-06-03RequestForbiddenError": { "properties": { "errors": { "description": "List of error objects", "items": { "$ref": "#/components/schemas/AtsInterviewsGetResponsesContentApplicationJsonSchemaErrorsItems" }, "type": "array" } }, "required": [ "errors" ], "title": "ListInterviews-v2026-06-03RequestForbiddenError", "type": "object" }, "ListInterviews-v2026-06-03RequestInternalServerError": { "properties": { "errors": { "description": "List of error objects", "items": { "$ref": "#/components/schemas/AtsInterviewsGetResponsesContentApplicationJsonSchemaErrorsItems" }, "type": "array" } }, "required": [ "errors" ], "title": "ListInterviews-v2026-06-03RequestInternalServerError", "type": "object" }, "ListInvoiceAdjustments-v2026-01-01RequestBadRequestError": { "properties": { "error": { "type": "string" } }, "required": [ "error" ], "title": "ListInvoiceAdjustments-v2026-01-01RequestBadRequestError", "type": "object" }, "ListItAgreements-v2026-09-15RequestBadRequestError": { "properties": { "errors": { "items": { "$ref": "#/components/schemas/ItAgreementsGetResponsesContentApplicationJsonSchemaErrorsItems" }, "type": "array" } }, "required": [ "errors" ], "title": "ListItAgreements-v2026-09-15RequestBadRequestError", "type": "object" }, "ListItAgreements-v2026-09-15RequestInternalServerError": { "properties": { "errors": { "items": { "$ref": "#/components/schemas/ItAgreementsGetResponsesContentApplicationJsonSchemaErrorsItems" }, "type": "array" } }, "required": [ "errors" ], "title": "ListItAgreements-v2026-09-15RequestInternalServerError", "type": "object" }, "ListItAssets-v2026-01-01RequestBadRequestError": { "properties": { "errors": { "items": { "$ref": "#/components/schemas/ItAssetsGetResponsesContentApplicationJsonSchemaErrorsItems" }, "type": "array" } }, "required": [ "errors" ], "title": "ListItAssets-v2026-01-01RequestBadRequestError", "type": "object" }, "ListItAssets-v2026-01-01RequestInternalServerError": { "properties": { "errors": { "items": { "$ref": "#/components/schemas/ItAssetsGetResponsesContentApplicationJsonSchemaErrorsItems" }, "type": "array" } }, "required": [ "errors" ], "title": "ListItAssets-v2026-01-01RequestInternalServerError", "type": "object" }, "ListItHardwarePolicies-v2026-01-01RequestBadRequestError": { "properties": { "errors": { "items": { "$ref": "#/components/schemas/ItPoliciesGetResponsesContentApplicationJsonSchemaErrorsItems" }, "type": "array" } }, "required": [ "errors" ], "title": "ListItHardwarePolicies-v2026-01-01RequestBadRequestError", "type": "object" }, "ListItHardwarePolicies-v2026-01-01RequestInternalServerError": { "properties": { "errors": { "items": { "$ref": "#/components/schemas/ItPoliciesGetResponsesContentApplicationJsonSchemaErrorsItems" }, "type": "array" } }, "required": [ "errors" ], "title": "ListItHardwarePolicies-v2026-01-01RequestInternalServerError", "type": "object" }, "ListItOrders-v2026-01-01RequestBadRequestError": { "properties": { "errors": { "items": { "$ref": "#/components/schemas/ItOrdersGetResponsesContentApplicationJsonSchemaErrorsItems" }, "type": "array" } }, "required": [ "errors" ], "title": "ListItOrders-v2026-01-01RequestBadRequestError", "type": "object" }, "ListItOrders-v2026-01-01RequestInternalServerError": { "properties": { "errors": { "items": { "$ref": "#/components/schemas/ItOrdersGetResponsesContentApplicationJsonSchemaErrorsItems" }, "type": "array" } }, "required": [ "errors" ], "title": "ListItOrders-v2026-01-01RequestInternalServerError", "type": "object" }, "ListItPolicyUsers-v2026-09-17RequestBadRequestError": { "properties": { "errors": { "items": { "$ref": "#/components/schemas/ItPoliciesPolicyIdUsersGetResponsesContentApplicationJsonSchemaErrorsItems" }, "type": "array" } }, "required": [ "errors" ], "title": "ListItPolicyUsers-v2026-09-17RequestBadRequestError", "type": "object" }, "ListItPolicyUsers-v2026-09-17RequestInternalServerError": { "properties": { "errors": { "items": { "$ref": "#/components/schemas/ItPoliciesPolicyIdUsersGetResponsesContentApplicationJsonSchemaErrorsItems" }, "type": "array" } }, "required": [ "errors" ], "title": "ListItPolicyUsers-v2026-09-17RequestInternalServerError", "type": "object" }, "ListItPolicyUsers-v2026-09-17RequestNotFoundError": { "properties": { "errors": { "items": { "$ref": "#/components/schemas/ItPoliciesPolicyIdUsersGetResponsesContentApplicationJsonSchemaErrorsItems" }, "type": "array" } }, "required": [ "errors" ], "title": "ListItPolicyUsers-v2026-09-17RequestNotFoundError", "type": "object" }, "ListItPolicyUsers-v2026-09-25RequestBadRequestError": { "properties": { "errors": { "items": { "$ref": "#/components/schemas/ItPoliciesPolicyIdSeatsGetResponsesContentApplicationJsonSchemaErrorsItems" }, "type": "array" } }, "required": [ "errors" ], "title": "ListItPolicyUsers-v2026-09-25RequestBadRequestError", "type": "object" }, "ListItPolicyUsers-v2026-09-25RequestInternalServerError": { "properties": { "errors": { "items": { "$ref": "#/components/schemas/ItPoliciesPolicyIdSeatsGetResponsesContentApplicationJsonSchemaErrorsItems" }, "type": "array" } }, "required": [ "errors" ], "title": "ListItPolicyUsers-v2026-09-25RequestInternalServerError", "type": "object" }, "ListItPolicyUsers-v2026-09-25RequestNotFoundError": { "properties": { "errors": { "items": { "$ref": "#/components/schemas/ItPoliciesPolicyIdSeatsGetResponsesContentApplicationJsonSchemaErrorsItems" }, "type": "array" } }, "required": [ "errors" ], "title": "ListItPolicyUsers-v2026-09-25RequestNotFoundError", "type": "object" }, "ListItProducts-v2026-09-17RequestBadRequestError": { "properties": { "errors": { "items": { "$ref": "#/components/schemas/ItProductsGetResponsesContentApplicationJsonSchemaErrorsItems" }, "type": "array" } }, "required": [ "errors" ], "title": "ListItProducts-v2026-09-17RequestBadRequestError", "type": "object" }, "ListItProducts-v2026-09-17RequestInternalServerError": { "properties": { "errors": { "items": { "$ref": "#/components/schemas/ItProductsGetResponsesContentApplicationJsonSchemaErrorsItems" }, "type": "array" } }, "required": [ "errors" ], "title": "ListItProducts-v2026-09-17RequestInternalServerError", "type": "object" }, "ListItSeats-v2026-09-25RequestBadRequestError": { "properties": { "errors": { "items": { "$ref": "#/components/schemas/ItSeatsGetResponsesContentApplicationJsonSchemaErrorsItems" }, "type": "array" } }, "required": [ "errors" ], "title": "ListItSeats-v2026-09-25RequestBadRequestError", "type": "object" }, "ListItSeats-v2026-09-25RequestConflictError": { "properties": { "errors": { "items": { "$ref": "#/components/schemas/ItSeatsGetResponsesContentApplicationJsonSchemaErrorsItems" }, "type": "array" } }, "required": [ "errors" ], "title": "ListItSeats-v2026-09-25RequestConflictError", "type": "object" }, "ListItSeats-v2026-09-25RequestForbiddenError": { "properties": { "errors": { "items": { "$ref": "#/components/schemas/ItSeatsGetResponsesContentApplicationJsonSchemaErrorsItems" }, "type": "array" } }, "required": [ "errors" ], "title": "ListItSeats-v2026-09-25RequestForbiddenError", "type": "object" }, "ListItSeats-v2026-09-25RequestInternalServerError": { "properties": { "errors": { "items": { "$ref": "#/components/schemas/ItSeatsGetResponsesContentApplicationJsonSchemaErrorsItems" }, "type": "array" } }, "required": [ "errors" ], "title": "ListItSeats-v2026-09-25RequestInternalServerError", "type": "object" }, "ListItSeats-v2026-09-25RequestNotFoundError": { "properties": { "errors": { "items": { "$ref": "#/components/schemas/ItSeatsGetResponsesContentApplicationJsonSchemaErrorsItems" }, "type": "array" } }, "required": [ "errors" ], "title": "ListItSeats-v2026-09-25RequestNotFoundError", "type": "object" }, "ListItSeats-v2026-09-25RequestUnauthorizedError": { "properties": { "errors": { "items": { "$ref": "#/components/schemas/ItSeatsGetResponsesContentApplicationJsonSchemaErrorsItems" }, "type": "array" } }, "required": [ "errors" ], "title": "ListItSeats-v2026-09-25RequestUnauthorizedError", "type": "object" }, "ListItWarehouses-v2026-09-15RequestBadRequestError": { "properties": { "errors": { "items": { "$ref": "#/components/schemas/ItWarehousesGetResponsesContentApplicationJsonSchemaErrorsItems" }, "type": "array" } }, "required": [ "errors" ], "title": "ListItWarehouses-v2026-09-15RequestBadRequestError", "type": "object" }, "ListItWarehouses-v2026-09-15RequestInternalServerError": { "properties": { "errors": { "items": { "$ref": "#/components/schemas/ItWarehousesGetResponsesContentApplicationJsonSchemaErrorsItems" }, "type": "array" } }, "required": [ "errors" ], "title": "ListItWarehouses-v2026-09-15RequestInternalServerError", "type": "object" }, "ListJobInterviewPlanStages-v2026-09-18RequestBadRequestError": { "properties": { "errors": { "description": "List of error objects", "items": { "$ref": "#/components/schemas/AtsJobsJobIdInterviewPlanStagesGetResponsesContentApplicationJsonSchemaErrorsItems" }, "type": "array" } }, "required": [ "errors" ], "title": "ListJobInterviewPlanStages-v2026-09-18RequestBadRequestError", "type": "object" }, "ListJobInterviewPlanStages-v2026-09-18RequestForbiddenError": { "properties": { "errors": { "description": "List of error objects", "items": { "$ref": "#/components/schemas/AtsJobsJobIdInterviewPlanStagesGetResponsesContentApplicationJsonSchemaErrorsItems" }, "type": "array" } }, "required": [ "errors" ], "title": "ListJobInterviewPlanStages-v2026-09-18RequestForbiddenError", "type": "object" }, "ListJobInterviewPlanStages-v2026-09-18RequestInternalServerError": { "properties": { "errors": { "description": "List of error objects", "items": { "$ref": "#/components/schemas/AtsJobsJobIdInterviewPlanStagesGetResponsesContentApplicationJsonSchemaErrorsItems" }, "type": "array" } }, "required": [ "errors" ], "title": "ListJobInterviewPlanStages-v2026-09-18RequestInternalServerError", "type": "object" }, "ListLegalEntityRegistrationDocuments-v2026-08-17RequestBadRequestError": { "properties": { "errors": { "description": "List of errors that occurred while processing the request.", "items": { "$ref": "#/components/schemas/LegalEntitiesLegalEntityIdRegistrationDocumentsGetResponsesContentApplicationJsonSchemaErrorsItems" }, "type": "array" } }, "required": [ "errors" ], "title": "ListLegalEntityRegistrationDocuments-v2026-08-17RequestBadRequestError", "type": "object" }, "ListLegalEntityRegistrationDocuments-v2026-08-17RequestForbiddenError": { "properties": { "errors": { "description": "List of errors that occurred while processing the request.", "items": { "$ref": "#/components/schemas/LegalEntitiesLegalEntityIdRegistrationDocumentsGetResponsesContentApplicationJsonSchemaErrorsItems" }, "type": "array" } }, "required": [ "errors" ], "title": "ListLegalEntityRegistrationDocuments-v2026-08-17RequestForbiddenError", "type": "object" }, "ListLegalEntityRegistrationDocuments-v2026-08-17RequestNotFoundError": { "properties": { "errors": { "description": "List of errors that occurred while processing the request.", "items": { "$ref": "#/components/schemas/LegalEntitiesLegalEntityIdRegistrationDocumentsGetResponsesContentApplicationJsonSchemaErrorsItems" }, "type": "array" } }, "required": [ "errors" ], "title": "ListLegalEntityRegistrationDocuments-v2026-08-17RequestNotFoundError", "type": "object" }, "ListLegalEntityRegistrationDocuments-v2026-08-17RequestUnauthorizedError": { "properties": { "errors": { "description": "List of errors that occurred while processing the request.", "items": { "$ref": "#/components/schemas/LegalEntitiesLegalEntityIdRegistrationDocumentsGetResponsesContentApplicationJsonSchemaErrorsItems" }, "type": "array" } }, "required": [ "errors" ], "title": "ListLegalEntityRegistrationDocuments-v2026-08-17RequestUnauthorizedError", "type": "object" }, "ListOfContracts-v2026-01-01RequestBadRequestError": { "properties": { "errors": { "description": "Error messages", "items": { "$ref": "#/components/schemas/ContractsGetResponsesContentApplicationJsonSchemaErrorsItems" }, "type": "array" }, "request": { "$ref": "#/components/schemas/ContractsGetResponsesContentApplicationJsonSchemaRequest", "description": "Error request details" } }, "required": [ "errors" ], "title": "ListOfContracts-v2026-01-01RequestBadRequestError", "type": "object" }, "ListOfEmployeeComplianceDocuments-v2026-01-01RequestForbiddenError": { "properties": { "errors": { "items": { "$ref": "#/components/schemas/EorWorkersComplianceDocumentsGetResponsesContentApplicationJsonSchemaErrorsItems" }, "type": "array" } }, "required": [ "errors" ], "title": "ListOfEmployeeComplianceDocuments-v2026-01-01RequestForbiddenError", "type": "object" }, "ListOfEmployeeComplianceDocuments-v2026-01-01RequestInternalServerError": { "properties": { "errors": { "items": { "$ref": "#/components/schemas/EorWorkersComplianceDocumentsGetResponsesContentApplicationJsonSchemaErrorsItems" }, "type": "array" } }, "required": [ "errors" ], "title": "ListOfEmployeeComplianceDocuments-v2026-01-01RequestInternalServerError", "type": "object" }, "ListOfEmployeeComplianceDocuments-v2026-01-01RequestUnauthorizedError": { "properties": { "errors": { "items": { "$ref": "#/components/schemas/EorWorkersComplianceDocumentsGetResponsesContentApplicationJsonSchemaErrorsItems" }, "type": "array" } }, "required": [ "errors" ], "title": "ListOfEmployeeComplianceDocuments-v2026-01-01RequestUnauthorizedError", "type": "object" }, "ListOfImmigrationCases-v2026-01-01RequestBadRequestError": { "properties": { "errors": { "items": { "$ref": "#/components/schemas/ImmigrationClientCasesGetResponsesContentApplicationJsonSchemaErrorsItems" }, "type": "array" } }, "title": "ListOfImmigrationCases-v2026-01-01RequestBadRequestError", "type": "object" }, "ListOfImmigrationCases-v2026-01-01RequestInternalServerError": { "properties": { "errors": { "items": { "$ref": "#/components/schemas/ImmigrationClientCasesGetResponsesContentApplicationJsonSchemaErrorsItems" }, "type": "array" } }, "title": "ListOfImmigrationCases-v2026-01-01RequestInternalServerError", "type": "object" }, "ListOfImmigrationCasesForWorkers-v2026-04-02RequestBadRequestError": { "properties": { "errors": { "items": { "$ref": "#/components/schemas/ImmigrationWorkersCasesGetResponsesContentApplicationJsonSchemaErrorsItems" }, "type": "array" } }, "title": "ListOfImmigrationCasesForWorkers-v2026-04-02RequestBadRequestError", "type": "object" }, "ListOfImmigrationCasesForWorkers-v2026-04-02RequestInternalServerError": { "properties": { "errors": { "items": { "$ref": "#/components/schemas/ImmigrationWorkersCasesGetResponsesContentApplicationJsonSchemaErrorsItems" }, "type": "array" } }, "title": "ListOfImmigrationCasesForWorkers-v2026-04-02RequestInternalServerError", "type": "object" }, "ListOfJobScopeTemplatesForEorContracts-v2026-01-01RequestNotFoundError": { "properties": { "error": { "$ref": "#/components/schemas/EorJobScopesGetResponsesContentApplicationJsonSchemaError", "description": "Error message indicating the missing entity" } }, "title": "ListOfJobScopeTemplatesForEorContracts-v2026-01-01RequestNotFoundError", "type": "object" }, "ListOfLegalEntities-v2026-01-01RequestBadRequestError": { "properties": { "errors": { "items": { "$ref": "#/components/schemas/LegalEntitiesGetResponsesContentApplicationJsonSchemaErrorsItems" }, "type": "array" } }, "title": "ListOfLegalEntities-v2026-01-01RequestBadRequestError", "type": "object" }, "ListOfPeople-v2026-01-01RequestInternalServerError": { "properties": { "error": { "$ref": "#/components/schemas/PeopleGetResponsesContentApplicationJsonSchemaError" } }, "required": [ "error" ], "title": "ListOfPeople-v2026-01-01RequestInternalServerError", "type": "object" }, "ListOfTimesheets-v2026-01-01RequestBadRequestError": { "properties": { "errors": { "description": "Error messages", "items": { "$ref": "#/components/schemas/TimesheetsGetResponsesContentApplicationJsonSchemaErrorsItems" }, "type": "array" }, "request": { "$ref": "#/components/schemas/TimesheetsGetResponsesContentApplicationJsonSchemaRequest", "description": "Error request details" } }, "required": [ "errors" ], "title": "ListOfTimesheets-v2026-01-01RequestBadRequestError", "type": "object" }, "ListOfWorkerComplianceDocuments-v2026-01-01RequestForbiddenError": { "properties": { "errors": { "items": { "$ref": "#/components/schemas/WorkersComplianceDocumentsGetResponsesContentApplicationJsonSchemaErrorsItems" }, "type": "array" } }, "title": "ListOfWorkerComplianceDocuments-v2026-01-01RequestForbiddenError", "type": "object" }, "ListOfWorkerComplianceDocuments-v2026-01-01RequestInternalServerError": { "properties": { "errors": { "items": { "$ref": "#/components/schemas/WorkersComplianceDocumentsGetResponsesContentApplicationJsonSchemaErrorsItems" }, "type": "array" } }, "title": "ListOfWorkerComplianceDocuments-v2026-01-01RequestInternalServerError", "type": "object" }, "ListOffers-v2026-01-01RequestBadRequestError": { "properties": { "errors": { "description": "List of error objects", "items": { "$ref": "#/components/schemas/AtsOffersGetResponsesContentApplicationJsonSchemaErrorsItems" }, "type": "array" } }, "required": [ "errors" ], "title": "ListOffers-v2026-01-01RequestBadRequestError", "type": "object" }, "ListOffers-v2026-01-01RequestForbiddenError": { "properties": { "errors": { "description": "List of error objects", "items": { "$ref": "#/components/schemas/AtsOffersGetResponsesContentApplicationJsonSchemaErrorsItems" }, "type": "array" } }, "required": [ "errors" ], "title": "ListOffers-v2026-01-01RequestForbiddenError", "type": "object" }, "ListOffers-v2026-01-01RequestInternalServerError": { "properties": { "errors": { "description": "List of error objects", "items": { "$ref": "#/components/schemas/AtsOffersGetResponsesContentApplicationJsonSchemaErrorsItems" }, "type": "array" } }, "required": [ "errors" ], "title": "ListOffers-v2026-01-01RequestInternalServerError", "type": "object" }, "ListOnDemandPayrollEntries-v2026-07-16RequestBadRequestError": { "properties": { "errors": { "description": "List of errors.", "items": { "$ref": "#/components/schemas/OnDemandPayrollContractContractIdEntriesGetResponsesContentApplicationJsonSchemaErrorsItems" }, "type": "array" } }, "required": [ "errors" ], "title": "ListOnDemandPayrollEntries-v2026-07-16RequestBadRequestError", "type": "object" }, "ListOnDemandPayrollEntries-v2026-07-16RequestForbiddenError": { "properties": { "errors": { "description": "List of errors.", "items": { "$ref": "#/components/schemas/OnDemandPayrollContractContractIdEntriesGetResponsesContentApplicationJsonSchemaErrorsItems" }, "type": "array" } }, "required": [ "errors" ], "title": "ListOnDemandPayrollEntries-v2026-07-16RequestForbiddenError", "type": "object" }, "ListOnDemandPayrollEntries-v2026-07-16RequestUnauthorizedError": { "properties": { "errors": { "description": "List of errors.", "items": { "$ref": "#/components/schemas/OnDemandPayrollContractContractIdEntriesGetResponsesContentApplicationJsonSchemaErrorsItems" }, "type": "array" } }, "required": [ "errors" ], "title": "ListOnDemandPayrollEntries-v2026-07-16RequestUnauthorizedError", "type": "object" }, "ListOnboardingEmployees-v2026-01-01RequestBadRequestError": { "properties": { "errors": { "$ref": "#/components/schemas/OnboardingTrackerGetResponsesContentApplicationJsonSchemaErrors", "description": "The errors, as an object for a combination of parameters the endpoint rejects, or as a list" }, "request": { "$ref": "#/components/schemas/OnboardingTrackerGetResponsesContentApplicationJsonSchemaRequest", "description": "Error request details. Absent for a cursor that cannot be read" } }, "required": [ "errors" ], "title": "ListOnboardingEmployees-v2026-01-01RequestBadRequestError", "type": "object" }, "ListOpenings-v2026-06-15RequestBadRequestError": { "properties": { "errors": { "description": "List of error objects", "items": { "$ref": "#/components/schemas/AtsOpeningsGetResponsesContentApplicationJsonSchemaErrorsItems" }, "type": "array" } }, "required": [ "errors" ], "title": "ListOpenings-v2026-06-15RequestBadRequestError", "type": "object" }, "ListOpenings-v2026-06-15RequestForbiddenError": { "properties": { "errors": { "description": "List of error objects", "items": { "$ref": "#/components/schemas/AtsOpeningsGetResponsesContentApplicationJsonSchemaErrorsItems" }, "type": "array" } }, "required": [ "errors" ], "title": "ListOpenings-v2026-06-15RequestForbiddenError", "type": "object" }, "ListOpenings-v2026-06-15RequestInternalServerError": { "properties": { "errors": { "description": "List of error objects", "items": { "$ref": "#/components/schemas/AtsOpeningsGetResponsesContentApplicationJsonSchemaErrorsItems" }, "type": "array" } }, "required": [ "errors" ], "title": "ListOpenings-v2026-06-15RequestInternalServerError", "type": "object" }, "ListOrganizationRegistrationDocuments-v2026-08-17RequestBadRequestError": { "properties": { "errors": { "description": "List of errors that occurred while processing the request.", "items": { "$ref": "#/components/schemas/LegalEntitiesRegistrationDocumentsGetResponsesContentApplicationJsonSchemaErrorsItems" }, "type": "array" } }, "required": [ "errors" ], "title": "ListOrganizationRegistrationDocuments-v2026-08-17RequestBadRequestError", "type": "object" }, "ListOrganizationRegistrationDocuments-v2026-08-17RequestForbiddenError": { "properties": { "errors": { "description": "List of errors that occurred while processing the request.", "items": { "$ref": "#/components/schemas/LegalEntitiesRegistrationDocumentsGetResponsesContentApplicationJsonSchemaErrorsItems" }, "type": "array" } }, "required": [ "errors" ], "title": "ListOrganizationRegistrationDocuments-v2026-08-17RequestForbiddenError", "type": "object" }, "ListOrganizationRegistrationDocuments-v2026-08-17RequestNotFoundError": { "properties": { "errors": { "description": "List of errors that occurred while processing the request.", "items": { "$ref": "#/components/schemas/LegalEntitiesRegistrationDocumentsGetResponsesContentApplicationJsonSchemaErrorsItems" }, "type": "array" } }, "required": [ "errors" ], "title": "ListOrganizationRegistrationDocuments-v2026-08-17RequestNotFoundError", "type": "object" }, "ListOrganizationRegistrationDocuments-v2026-08-17RequestUnauthorizedError": { "properties": { "errors": { "description": "List of errors that occurred while processing the request.", "items": { "$ref": "#/components/schemas/LegalEntitiesRegistrationDocumentsGetResponsesContentApplicationJsonSchemaErrorsItems" }, "type": "array" } }, "required": [ "errors" ], "title": "ListOrganizationRegistrationDocuments-v2026-08-17RequestUnauthorizedError", "type": "object" }, "ListOrganizationSecureVaultFolderItems-v2026-08-05RequestBadRequestError": { "properties": { "errors": { "description": "List of errors that occurred while processing the request.", "items": { "$ref": "#/components/schemas/OrganizationsSecureVaultFoldersFolderIdItemsGetResponsesContentApplicationJsonSchemaErrorsItems" }, "type": "array" } }, "required": [ "errors" ], "title": "ListOrganizationSecureVaultFolderItems-v2026-08-05RequestBadRequestError", "type": "object" }, "ListOrganizationSecureVaultFolderItems-v2026-08-05RequestForbiddenError": { "properties": { "errors": { "description": "List of errors that occurred while processing the request.", "items": { "$ref": "#/components/schemas/OrganizationsSecureVaultFoldersFolderIdItemsGetResponsesContentApplicationJsonSchemaErrorsItems" }, "type": "array" } }, "required": [ "errors" ], "title": "ListOrganizationSecureVaultFolderItems-v2026-08-05RequestForbiddenError", "type": "object" }, "ListOrganizationSecureVaultFolderItems-v2026-08-05RequestNotFoundError": { "properties": { "errors": { "description": "List of errors that occurred while processing the request.", "items": { "$ref": "#/components/schemas/OrganizationsSecureVaultFoldersFolderIdItemsGetResponsesContentApplicationJsonSchemaErrorsItems" }, "type": "array" } }, "required": [ "errors" ], "title": "ListOrganizationSecureVaultFolderItems-v2026-08-05RequestNotFoundError", "type": "object" }, "ListOrganizationSecureVaultFolderItems-v2026-08-05RequestUnauthorizedError": { "properties": { "errors": { "description": "List of errors that occurred while processing the request.", "items": { "$ref": "#/components/schemas/OrganizationsSecureVaultFoldersFolderIdItemsGetResponsesContentApplicationJsonSchemaErrorsItems" }, "type": "array" } }, "required": [ "errors" ], "title": "ListOrganizationSecureVaultFolderItems-v2026-08-05RequestUnauthorizedError", "type": "object" }, "ListOrganizationTasks-v2026-03-03RequestBadRequestError": { "properties": { "errors": { "description": "List of error entries.", "items": { "$ref": "#/components/schemas/OrganizationsTasksGetResponsesContentApplicationJsonSchemaErrorsItems" }, "type": "array" } }, "required": [ "errors" ], "title": "ListOrganizationTasks-v2026-03-03RequestBadRequestError", "type": "object" }, "ListOrganizationTasks-v2026-03-03RequestForbiddenError": { "properties": { "errors": { "description": "List of error entries.", "items": { "$ref": "#/components/schemas/OrganizationsTasksGetResponsesContentApplicationJsonSchemaErrorsItems" }, "type": "array" } }, "required": [ "errors" ], "title": "ListOrganizationTasks-v2026-03-03RequestForbiddenError", "type": "object" }, "ListOrganizationTasks-v2026-03-03RequestInternalServerError": { "properties": { "errors": { "description": "List of error entries.", "items": { "$ref": "#/components/schemas/OrganizationsTasksGetResponsesContentApplicationJsonSchemaErrorsItems" }, "type": "array" } }, "required": [ "errors" ], "title": "ListOrganizationTasks-v2026-03-03RequestInternalServerError", "type": "object" }, "ListOrganizationTasks-v2026-03-03RequestUnauthorizedError": { "properties": { "errors": { "description": "List of error entries.", "items": { "$ref": "#/components/schemas/OrganizationsTasksGetResponsesContentApplicationJsonSchemaErrorsItems" }, "type": "array" } }, "required": [ "errors" ], "title": "ListOrganizationTasks-v2026-03-03RequestUnauthorizedError", "type": "object" }, "ListOrganizationTasks-v2026-03-03RequestUnprocessableEntityError": { "properties": { "errors": { "description": "List of validation errors.", "items": { "$ref": "#/components/schemas/OrganizationsTasksGetResponsesContentApplicationJsonSchemaErrorsItems" }, "type": "array" } }, "required": [ "errors" ], "title": "ListOrganizationTasks-v2026-03-03RequestUnprocessableEntityError", "type": "object" }, "ListPayrollCycles-v2026-01-01RequestBadRequestError": { "properties": { "errors": { "items": { "$ref": "#/components/schemas/LegalEntitiesLegalEntityIdPayrollEventsGetResponsesContentApplicationJsonSchemaErrorsItems" }, "type": "array" } }, "title": "ListPayrollCycles-v2026-01-01RequestBadRequestError", "type": "object" }, "ListPayrollCycles-v2026-01-01RequestInternalServerError": { "properties": { "errors": { "items": { "$ref": "#/components/schemas/LegalEntitiesLegalEntityIdPayrollEventsGetResponsesContentApplicationJsonSchemaErrorsItems" }, "type": "array" } }, "title": "ListPayrollCycles-v2026-01-01RequestInternalServerError", "type": "object" }, "ListPayrollEventsByLegalEntity-v2026-01-01RequestBadRequestError": { "properties": { "errors": { "items": { "$ref": "#/components/schemas/GpLegalEntitiesLegalEntityIdReportsGetResponsesContentApplicationJsonSchemaErrorsItems" }, "type": "array" }, "request": { "$ref": "#/components/schemas/GpLegalEntitiesLegalEntityIdReportsGetResponsesContentApplicationJsonSchemaRequest" } }, "title": "ListPayrollEventsByLegalEntity-v2026-01-01RequestBadRequestError", "type": "object" }, "ListPayrollGroups-v2026-09-08RequestForbiddenError": { "properties": { "code": { "type": "string" }, "data": { "description": "Any type" }, "defined": { "type": "boolean" }, "message": { "default": "The caller is not authorized to access this legal entity.", "type": "string" }, "status": { "format": "double", "type": "number" } }, "required": [ "code", "status", "defined", "message" ], "title": "ListPayrollGroups-v2026-09-08RequestForbiddenError", "type": "object" }, "ListPayrollGroups-v2026-09-08RequestInternalServerError": { "properties": { "code": { "type": "string" }, "data": { "description": "Any type" }, "defined": { "type": "boolean" }, "message": { "default": "Unable to retrieve payroll groups from upstream.", "type": "string" }, "status": { "format": "double", "type": "number" } }, "required": [ "code", "status", "defined", "message" ], "title": "ListPayrollGroups-v2026-09-08RequestInternalServerError", "type": "object" }, "ListPayrollGroups-v2026-09-08RequestNotFoundError": { "properties": { "code": { "type": "string" }, "data": { "description": "Any type" }, "defined": { "type": "boolean" }, "message": { "default": "Legal entity not found.", "type": "string" }, "status": { "format": "double", "type": "number" } }, "required": [ "code", "status", "defined", "message" ], "title": "ListPayrollGroups-v2026-09-08RequestNotFoundError", "type": "object" }, "ListPayrollMigrationImports-v2026-09-15RequestBadRequestError": { "properties": { "code": { "type": "string" }, "data": { "description": "Any type" }, "defined": { "type": "boolean" }, "message": { "default": "The pagination cursor is invalid or no longer resolves.", "type": "string" }, "status": { "format": "double", "type": "number" } }, "required": [ "code", "status", "defined", "message" ], "title": "ListPayrollMigrationImports-v2026-09-15RequestBadRequestError", "type": "object" }, "ListPayrollMigrationImports-v2026-09-15RequestForbiddenError": { "properties": { "code": { "type": "string" }, "data": { "description": "Any type" }, "defined": { "type": "boolean" }, "message": { "default": "The caller is not authorized to act on this legal entity.", "type": "string" }, "status": { "format": "double", "type": "number" } }, "required": [ "code", "status", "defined", "message" ], "title": "ListPayrollMigrationImports-v2026-09-15RequestForbiddenError", "type": "object" }, "ListPayrollMigrationImports-v2026-09-15RequestInternalServerError": { "properties": { "code": { "type": "string" }, "data": { "description": "Any type" }, "defined": { "type": "boolean" }, "message": { "default": "Internal server error.", "type": "string" }, "status": { "format": "double", "type": "number" } }, "required": [ "code", "status", "defined", "message" ], "title": "ListPayrollMigrationImports-v2026-09-15RequestInternalServerError", "type": "object" }, "ListPayrollMigrationImports-v2026-09-15RequestNotFoundError": { "properties": { "code": { "type": "string" }, "data": { "description": "Any type" }, "defined": { "type": "boolean" }, "message": { "default": "Legal entity not found.", "type": "string" }, "status": { "format": "double", "type": "number" } }, "required": [ "code", "status", "defined", "message" ], "title": "ListPayrollMigrationImports-v2026-09-15RequestNotFoundError", "type": "object" }, "ListPayrollMigrationImports-v2026-09-15RequestUnauthorizedError": { "properties": { "code": { "type": "string" }, "data": { "description": "Any type" }, "defined": { "type": "boolean" }, "message": { "default": "The request carries no caller identity the gateway could resolve.", "type": "string" }, "status": { "format": "double", "type": "number" } }, "required": [ "code", "status", "defined", "message" ], "title": "ListPayrollMigrationImports-v2026-09-15RequestUnauthorizedError", "type": "object" }, "ListPolicies-v2026-01-01RequestNotFoundError": { "properties": { "message": { "type": "string" } }, "title": "ListPolicies-v2026-01-01RequestNotFoundError", "type": "object" }, "ListRequisitions-v2026-09-10RequestBadRequestError": { "properties": { "errors": { "description": "Validation errors that describe why the request was rejected.", "items": { "$ref": "#/components/schemas/VmsRequisitionsGetResponsesContentApplicationJsonSchemaErrorsItems" }, "type": "array" } }, "title": "ListRequisitions-v2026-09-10RequestBadRequestError", "type": "object" }, "ListRequisitions-v2026-09-10RequestForbiddenError": { "properties": { "errors": { "description": "Errors that describe why the request was not permitted.", "items": { "$ref": "#/components/schemas/VmsRequisitionsGetResponsesContentApplicationJsonSchemaErrorsItems" }, "type": "array" } }, "title": "ListRequisitions-v2026-09-10RequestForbiddenError", "type": "object" }, "ListRequisitions-v2026-09-10RequestInternalServerError": { "properties": { "errors": { "description": "Errors that describe the unexpected server failure.", "items": { "$ref": "#/components/schemas/VmsRequisitionsGetResponsesContentApplicationJsonSchemaErrorsItems" }, "type": "array" } }, "title": "ListRequisitions-v2026-09-10RequestInternalServerError", "type": "object" }, "ListRequisitions-v2026-09-10RequestUnauthorizedError": { "properties": { "errors": { "description": "Errors that describe why the request was not authenticated.", "items": { "$ref": "#/components/schemas/VmsRequisitionsGetResponsesContentApplicationJsonSchemaErrorsItems" }, "type": "array" } }, "title": "ListRequisitions-v2026-09-10RequestUnauthorizedError", "type": "object" }, "ListTags-v2026-01-01RequestBadRequestError": { "properties": { "errors": { "description": "List of error objects", "items": { "$ref": "#/components/schemas/AtsTagsGetResponsesContentApplicationJsonSchemaErrorsItems" }, "type": "array" } }, "required": [ "errors" ], "title": "ListTags-v2026-01-01RequestBadRequestError", "type": "object" }, "ListTags-v2026-01-01RequestForbiddenError": { "properties": { "errors": { "description": "List of error objects", "items": { "$ref": "#/components/schemas/AtsTagsGetResponsesContentApplicationJsonSchemaErrorsItems" }, "type": "array" } }, "required": [ "errors" ], "title": "ListTags-v2026-01-01RequestForbiddenError", "type": "object" }, "ListTags-v2026-01-01RequestInternalServerError": { "properties": { "errors": { "description": "List of error objects", "items": { "$ref": "#/components/schemas/AtsTagsGetResponsesContentApplicationJsonSchemaErrorsItems" }, "type": "array" } }, "required": [ "errors" ], "title": "ListTags-v2026-01-01RequestInternalServerError", "type": "object" }, "ListTaxFormsForAWorker-v2026-01-01RequestBadRequestError": { "properties": { "errors": { "items": { "$ref": "#/components/schemas/WorkersTaxFormsGetResponsesContentApplicationJsonSchemaErrorsItems" }, "type": "array" } }, "title": "ListTaxFormsForAWorker-v2026-01-01RequestBadRequestError", "type": "object" }, "ListTaxFormsForAWorker-v2026-01-01RequestInternalServerError": { "properties": { "errors": { "items": { "$ref": "#/components/schemas/WorkersTaxFormsGetResponsesContentApplicationJsonSchemaErrorsItems" }, "type": "array" } }, "title": "ListTaxFormsForAWorker-v2026-01-01RequestInternalServerError", "type": "object" }, "ListTaxFormsForAWorker-v2026-01-01RequestNotFoundError": { "properties": { "errors": { "items": { "$ref": "#/components/schemas/WorkersTaxFormsGetResponsesContentApplicationJsonSchemaErrorsItems" }, "type": "array" } }, "title": "ListTaxFormsForAWorker-v2026-01-01RequestNotFoundError", "type": "object" }, "ListTimeOffRequests-v2026-01-01RequestBadRequestError": { "properties": { "errors": { "items": { "$ref": "#/components/schemas/TimeOffsProfileHrisProfileIdGetResponsesContentApplicationJsonSchemaErrorsItems" }, "type": "array" }, "request": { "$ref": "#/components/schemas/TimeOffsProfileHrisProfileIdGetResponsesContentApplicationJsonSchemaRequest" } }, "title": "ListTimeOffRequests-v2026-01-01RequestBadRequestError", "type": "object" }, "ListTimeOffRequestsForOrganization-v2026-01-01RequestBadRequestError": { "properties": { "errors": { "items": { "$ref": "#/components/schemas/TimeOffsGetResponsesContentApplicationJsonSchemaErrorsItems" }, "type": "array" } }, "required": [ "errors" ], "title": "ListTimeOffRequestsForOrganization-v2026-01-01RequestBadRequestError", "type": "object" }, "ListTimeOffRequestsForOrganization-v2026-01-01RequestForbiddenError": { "properties": { "errors": { "items": { "$ref": "#/components/schemas/TimeOffsGetResponsesContentApplicationJsonSchemaErrorsItems" }, "type": "array" } }, "required": [ "errors" ], "title": "ListTimeOffRequestsForOrganization-v2026-01-01RequestForbiddenError", "type": "object" }, "ListTimeOffRequestsForOrganization-v2026-01-01RequestInternalServerError": { "properties": { "errors": { "items": { "$ref": "#/components/schemas/TimeOffsGetResponsesContentApplicationJsonSchemaErrorsItems" }, "type": "array" } }, "required": [ "errors" ], "title": "ListTimeOffRequestsForOrganization-v2026-01-01RequestInternalServerError", "type": "object" }, "ListTimeOffRequestsForOrganization-v2026-01-01RequestNotFoundError": { "properties": { "errors": { "items": { "$ref": "#/components/schemas/TimeOffsGetResponsesContentApplicationJsonSchemaErrorsItems" }, "type": "array" } }, "required": [ "errors" ], "title": "ListTimeOffRequestsForOrganization-v2026-01-01RequestNotFoundError", "type": "object" }, "ListTimeOffRequestsForOrganization-v2026-01-01RequestUnauthorizedError": { "properties": { "errors": { "items": { "$ref": "#/components/schemas/TimeOffsGetResponsesContentApplicationJsonSchemaErrorsItems" }, "type": "array" } }, "required": [ "errors" ], "title": "ListTimeOffRequestsForOrganization-v2026-01-01RequestUnauthorizedError", "type": "object" }, "ListUsers-v2026-01-01RequestInternalServerError": { "properties": { "error": { "$ref": "#/components/schemas/UsersGetResponsesContentApplicationJsonSchemaError" } }, "required": [ "error" ], "title": "ListUsers-v2026-01-01RequestInternalServerError", "type": "object" }, "ListWorkerContractComplianceDocuments-v2026-08-25RequestBadRequestError": { "properties": { "errors": { "description": "Errors that occurred while processing the request.", "items": { "$ref": "#/components/schemas/WorkersContractsContractIdComplianceDocumentsGetResponsesContentApplicationJsonSchemaErrorsItems" }, "type": "array" } }, "required": [ "errors" ], "title": "ListWorkerContractComplianceDocuments-v2026-08-25RequestBadRequestError", "type": "object" }, "ListWorkerContractComplianceDocuments-v2026-08-25RequestForbiddenError": { "properties": { "errors": { "description": "Errors that occurred while processing the request.", "items": { "$ref": "#/components/schemas/WorkersContractsContractIdComplianceDocumentsGetResponsesContentApplicationJsonSchemaErrorsItems" }, "type": "array" } }, "required": [ "errors" ], "title": "ListWorkerContractComplianceDocuments-v2026-08-25RequestForbiddenError", "type": "object" }, "ListWorkerContractComplianceDocuments-v2026-08-25RequestNotFoundError": { "properties": { "errors": { "description": "Errors that occurred while processing the request.", "items": { "$ref": "#/components/schemas/WorkersContractsContractIdComplianceDocumentsGetResponsesContentApplicationJsonSchemaErrorsItems" }, "type": "array" } }, "required": [ "errors" ], "title": "ListWorkerContractComplianceDocuments-v2026-08-25RequestNotFoundError", "type": "object" }, "ListWorkerContractComplianceDocuments-v2026-08-25RequestUnauthorizedError": { "properties": { "errors": { "description": "Errors that occurred while processing the request.", "items": { "$ref": "#/components/schemas/WorkersContractsContractIdComplianceDocumentsGetResponsesContentApplicationJsonSchemaErrorsItems" }, "type": "array" } }, "required": [ "errors" ], "title": "ListWorkerContractComplianceDocuments-v2026-08-25RequestUnauthorizedError", "type": "object" }, "ListWorkerContractComplianceDocuments-v2026-08-25RequestUnprocessableEntityError": { "properties": { "errors": { "description": "Errors that occurred while processing the request.", "items": { "$ref": "#/components/schemas/WorkersContractsContractIdComplianceDocumentsGetResponsesContentApplicationJsonSchemaErrorsItems" }, "type": "array" } }, "required": [ "errors" ], "title": "ListWorkerContractComplianceDocuments-v2026-08-25RequestUnprocessableEntityError", "type": "object" }, "List_Cycles_listPayrollCycles-v2026-01-01_Response_200": { "properties": { "data": { "items": { "$ref": "#/components/schemas/LegalEntitiesLegalEntityIdPayrollEventsGetResponsesContentApplicationJsonSchemaDataItems" }, "type": "array" }, "has_more": { "description": "Indicates whether more pages are available.", "type": "boolean" }, "items_per_page": { "description": "The number of items per page.", "type": "integer" }, "next_cursor": { "description": "Pagination cursor to fetch the next page of results.", "type": [ "string", "null" ] } }, "required": [ "data", "has_more", "items_per_page" ], "title": "List Cycles_listPayrollCycles-v2026-01-01_Response_200", "type": "object" }, "LookupsCountriesGetResponsesContentApplicationJsonSchemaDataItems": { "properties": { "code": { "description": "The ISO 3166-1 alpha-2 country code.", "maxLength": 2, "minLength": 2, "pattern": "^[A-Z]{2}$", "type": "string" }, "default_currency": { "description": "Indicates the default currency 3-letter ISO code", "maxLength": 3, "minLength": 3, "pattern": "^[A-Z]{3}$", "type": "string" }, "eor_support": { "description": "Indicates whether Deel provides Employer of Record (EoR) support in this country.", "type": "boolean" }, "name": { "description": "The official name of the country.", "minLength": 1, "type": "string" }, "state_type": { "description": "The designation for sub-territories within the country, such as 'state', 'province', 'prefecture', or 'region'. If none, this field will be null.", "type": [ "string", "null" ] }, "states": { "description": "List of sub-territories within the country. These may be called states, provinces, prefectures, regions, or may not exist.", "items": { "$ref": "#/components/schemas/LookupsCountriesGetResponsesContentApplicationJsonSchemaDataItemsStatesItems" }, "type": "array" }, "visa_support": { "description": "Indicates whether Deel provides visa support for employees being hired in this country.", "type": "boolean" } }, "required": [ "code", "name", "states", "state_type", "eor_support", "visa_support", "default_currency" ], "title": "LookupsCountriesGetResponsesContentApplicationJsonSchemaDataItems", "type": "object" }, "LookupsCountriesGetResponsesContentApplicationJsonSchemaDataItemsStatesItems": { "properties": { "code": { "description": "The code representing the sub-territory (e.g., state or region).", "minLength": 1, "type": "string" }, "name": { "description": "The name of the sub-territory (e.g., state or region).", "minLength": 1, "type": "string" } }, "required": [ "code", "name" ], "title": "LookupsCountriesGetResponsesContentApplicationJsonSchemaDataItemsStatesItems", "type": "object" }, "LookupsCurrenciesGetResponsesContentApplicationJsonSchemaDataItems": { "properties": { "code": { "description": "The ISO 4217 three-letter currency code.", "maxLength": 3, "minLength": 3, "pattern": "^[A-Z]{3}$", "type": "string" }, "name": { "description": "The name of the currency. This may be null if a name is not available.", "type": [ "string", "null" ] } }, "required": [ "code" ], "title": "LookupsCurrenciesGetResponsesContentApplicationJsonSchemaDataItems", "type": "object" }, "LookupsGetParametersDocuments": { "enum": [ "sicNumbers", "entityTypes", "countries" ], "title": "LookupsGetParametersDocuments", "type": "string" }, "LookupsGetResponsesContentApplicationJsonSchemaDataItems": { "properties": { "label": { "description": "The label for the lookup item (e.g., country name, entity type).", "type": "string" }, "value": { "description": "The value associated with the lookup item (e.g., ISO code, type identifier).", "type": "string" } }, "title": "LookupsGetResponsesContentApplicationJsonSchemaDataItems", "type": "object" }, "LookupsJobTitlesGetResponsesContentApplicationJsonSchemaDataItems": { "properties": { "id": { "description": "identifier of the job title", "format": "int64", "type": "integer" }, "name": { "description": "Job title.", "type": "string" } }, "required": [ "id", "name" ], "title": "LookupsJobTitlesGetResponsesContentApplicationJsonSchemaDataItems", "type": "object" }, "LookupsJobTitlesGetResponsesContentApplicationJsonSchemaPage": { "properties": { "cursor": { "description": "Use for pagination to get next set of records after the given cursor.", "type": "string" } }, "required": [ "cursor" ], "title": "LookupsJobTitlesGetResponsesContentApplicationJsonSchemaPage", "type": "object" }, "LookupsSenioritiesGetResponsesContentApplicationJsonSchemaDataItems": { "properties": { "id": { "description": "A unique identifier for the seniority level.", "format": "int64", "type": "integer" }, "level": { "description": "The hierarchical level of seniority, where higher numbers indicate greater seniority.", "format": "double", "type": [ "number", "null" ] }, "name": { "description": "The name of the seniority level, e.g., 'Mid (Individual Contributor Level 2)'.", "minLength": 1, "type": "string" } }, "required": [ "id", "name" ], "title": "LookupsSenioritiesGetResponsesContentApplicationJsonSchemaDataItems", "type": "object" }, "LookupsTimeOffTypesGetResponsesContentApplicationJsonSchemaDataItems": { "description": "Predefined time-off types. Possible values include 'VACATION', 'SICK_LEAVE', 'UNPAID_LEAVE' and 'OTHER'.", "enum": [ "VACATION", "SICK_LEAVE", "OTHER", "UNPAID_LEAVE" ], "title": "LookupsTimeOffTypesGetResponsesContentApplicationJsonSchemaDataItems", "type": "string" }, "LookupsTimeOffTypesGetResponsesContentApplicationJsonSchemaErrorsItems": { "properties": { "message": { "description": "Error message describing what went wrong.", "type": "string" } }, "required": [ "message" ], "title": "LookupsTimeOffTypesGetResponsesContentApplicationJsonSchemaErrorsItems", "type": "object" }, "Lookups_getLookups-v2026-01-01_Response_200": { "properties": { "data": { "items": { "$ref": "#/components/schemas/LookupsGetResponsesContentApplicationJsonSchemaDataItems" }, "type": "array" } }, "title": "Lookups_getLookups-v2026-01-01_Response_200", "type": "object" }, "MagicLinkPostRequestBodyContentApplicationJsonSchemaData": { "properties": { "redirect_path": { "description": "Path to redirect the user to after successful authentication.", "maxLength": 500, "type": "string" } }, "title": "MagicLinkPostRequestBodyContentApplicationJsonSchemaData", "type": "object" }, "MagicLinkPostResponsesContentApplicationJsonSchemaData": { "properties": { "expires_at": { "description": "When the magic link expires (ISO 8601 format)", "format": "date-time", "type": "string" }, "magic_link": { "description": "The magic link URL that users can click and log in to deel automatically.", "type": "string" } }, "required": [ "expires_at", "magic_link" ], "title": "MagicLinkPostResponsesContentApplicationJsonSchemaData", "type": "object" }, "ManagersGetResponsesContentApplicationJsonSchemaDataItems": { "properties": { "email": { "description": "The email address of the manager.", "format": "email", "type": "string" }, "first_name": { "description": "The first name of the manager.", "type": "string" }, "id": { "description": "Unique identifier of the manager.", "format": "uuid", "type": "string" }, "last_name": { "description": "The last name of the manager.", "type": "string" } }, "required": [ "id" ], "title": "ManagersGetResponsesContentApplicationJsonSchemaDataItems", "type": "object" }, "ManagersGetResponsesContentApplicationJsonSchemaPage": { "description": "Pagination details for the response.", "properties": { "items_per_page": { "description": "Number of items returned per page.", "format": "double", "type": [ "number", "null" ] }, "offset": { "description": "The offset/index of the current page.", "format": "double", "type": [ "number", "null" ] }, "total_rows": { "description": "Total number of rows available for this resource.", "format": "double", "type": "number" } }, "required": [ "total_rows" ], "title": "ManagersGetResponsesContentApplicationJsonSchemaPage", "type": "object" }, "ManagersMagicLinksPostRequestBodyContentApplicationJsonSchemaData": { "properties": { "manager_id": { "description": "Manager id.", "format": "uuid", "maxLength": 100, "type": "string" }, "redirect_path": { "description": "Optional path to redirect the manager to after login. Must start with /.", "maxLength": 1000, "type": "string" } }, "required": [ "manager_id" ], "title": "ManagersMagicLinksPostRequestBodyContentApplicationJsonSchemaData", "type": "object" }, "ManagersMagicLinksPostResponsesContentApplicationJsonSchemaData": { "properties": { "created_at": { "description": "When the magic link was created (ISO 8601 format)", "format": "date-time", "type": "string" }, "expires_at": { "description": "When the magic link expires (ISO 8601 format)", "format": "date-time", "type": "string" }, "magic_link": { "description": "The magic link URL that managers can click to log in to Deel automatically", "type": "string" } }, "required": [ "created_at", "expires_at", "magic_link" ], "title": "ManagersMagicLinksPostResponsesContentApplicationJsonSchemaData", "type": "object" }, "ManagersMagicLinksPostResponsesContentApplicationJsonSchemaErrorsItems": { "properties": { "code": { "description": "Machine-readable error code", "type": "string" }, "message": { "description": "Human-readable error message", "type": "string" } }, "required": [ "code", "message" ], "title": "ManagersMagicLinksPostResponsesContentApplicationJsonSchemaErrorsItems", "type": "object" }, "ManagersPostRequestBodyContentApplicationJsonSchemaData": { "properties": { "email": { "description": "The email address of the manager.", "format": "email", "type": "string" }, "first_name": { "description": "The first name of the manager.", "minLength": 1, "type": "string" }, "last_name": { "description": "The last name of the manager.", "minLength": 1, "type": "string" } }, "required": [ "email", "last_name", "first_name" ], "title": "ManagersPostRequestBodyContentApplicationJsonSchemaData", "type": "object" }, "ManagersPostResponsesContentApplicationJsonSchemaData": { "properties": { "email": { "description": "The email address of the created manager.", "format": "email", "type": "string" }, "first_name": { "description": "The first name of the created manager.", "type": "string" }, "id": { "description": "The unique identifier of the created manager.", "format": "uuid", "type": "string" }, "last_name": { "description": "The last name of the created manager.", "type": "string" } }, "required": [ "id", "email", "last_name", "first_name" ], "title": "ManagersPostResponsesContentApplicationJsonSchemaData", "type": "object" }, "Managers_generateMagicLinkForManagerLogin-v2026-01-01_Response_201": { "properties": { "data": { "$ref": "#/components/schemas/ManagersMagicLinksPostResponsesContentApplicationJsonSchemaData" } }, "required": [ "data" ], "title": "Managers_generateMagicLinkForManagerLogin-v2026-01-01_Response_201", "type": "object" }, "Off-cycle_Payments_getOffCyclePaymentByContractAndId-v2026-01-01_Response_200": { "properties": { "data": { "$ref": "#/components/schemas/ContractsContractIdOffCyclePaymentsOffCyclePaymentIdGetResponsesContentApplicationJsonSchemaData", "description": "Details of the off-cycle payment." } }, "required": [ "data" ], "title": "Off-cycle Payments_getOffCyclePaymentByContractAndId-v2026-01-01_Response_200", "type": "object" }, "OffboardingTrackerGetParametersHiringTypesSchemaItems": { "enum": [ "contractor", "eor", "peo", "hris_direct_employee", "direct_employee", "person_without_contract" ], "title": "OffboardingTrackerGetParametersHiringTypesSchemaItems", "type": "string" }, "OffboardingTrackerGetParametersPagination": { "properties": { "contractId": { "description": "Contract ID for pagination", "type": "string" }, "effectiveDate": { "description": "Effective date for pagination", "format": "date-time", "type": "string" }, "progressStatusWeight": { "description": "Progress status weight for pagination", "type": "integer" }, "referenceDate": { "description": "Reference date for pagination", "format": "date-time", "type": "string" } }, "title": "OffboardingTrackerGetParametersPagination", "type": "object" }, "OffboardingTrackerGetParametersProgressStatusesSchemaItems": { "enum": [ "IN_REVIEW", "DOCUMENT_PROCESSING", "EMPLOYEE_OFFBOARDING", "FINAL_PAYMENT_AND_REFUND", "COMPLETED", "AWAITING_CLIENT_SIGNATURE", "AWAITING_CONTRACTOR_SIGNATURE", "TERMINATION_LETTER_REJECTED", "CONTRACT_ENDING", "CONTRACT_ENDED", "OFFBOARDING", "INACTIVE", "AWAITING_TERMINATION_DETAILS" ], "title": "OffboardingTrackerGetParametersProgressStatusesSchemaItems", "type": "string" }, "OffboardingTrackerGetParametersSortBy": { "default": "progressStatusWeight", "enum": [ "progressStatusWeight" ], "title": "OffboardingTrackerGetParametersSortBy", "type": "string" }, "OffboardingTrackerGetParametersSortOrder": { "default": "ASC", "enum": [ "ASC", "DESC" ], "title": "OffboardingTrackerGetParametersSortOrder", "type": "string" }, "OffboardingTrackerGetResponsesContentApplicationJsonSchemaDataItems": { "properties": { "app_experience": { "$ref": "#/components/schemas/OffboardingTrackerGetResponsesContentApplicationJsonSchemaDataItemsAppExperience" }, "contract": { "$ref": "#/components/schemas/OffboardingTrackerGetResponsesContentApplicationJsonSchemaDataItemsContract" }, "hiring_type": { "description": "The hiring type for the individual (e.g., contractor).", "type": "string" }, "hris_profile": { "$ref": "#/components/schemas/OffboardingTrackerGetResponsesContentApplicationJsonSchemaDataItemsHrisProfile" }, "name": { "description": "The name of the individual associated with the offboarding.", "type": "string" }, "offboarding_type": { "$ref": "#/components/schemas/OffboardingTrackerGetResponsesContentApplicationJsonSchemaDataItemsOffboardingType", "description": "The type of offboarding." }, "progress": { "$ref": "#/components/schemas/OffboardingTrackerGetResponsesContentApplicationJsonSchemaDataItemsProgress" }, "termination_id": { "description": "The termination ID if the individual has been terminated.", "type": [ "string", "null" ] }, "unique_id": { "description": "Base64url-encoded JSON token identifying this offboarding tracker. Decodes to `{\"contractOid\":\"\",\"hiringType\":\"\"}`. Pass as the `id` path parameter to tracker detail or checklist endpoints. Obtain from the API — never construct manually.", "format": "base64url", "type": "string" } }, "title": "OffboardingTrackerGetResponsesContentApplicationJsonSchemaDataItems", "type": "object" }, "OffboardingTrackerGetResponsesContentApplicationJsonSchemaDataItemsAppExperience": { "properties": { "is_minimal_requirements": { "description": "Indicates whether the individual meets the minimal experience requirements for the role.", "type": "boolean" } }, "title": "OffboardingTrackerGetResponsesContentApplicationJsonSchemaDataItemsAppExperience", "type": "object" }, "OffboardingTrackerGetResponsesContentApplicationJsonSchemaDataItemsContract": { "properties": { "id": { "description": "The contract ID associated with the individual.", "type": "string" } }, "title": "OffboardingTrackerGetResponsesContentApplicationJsonSchemaDataItemsContract", "type": "object" }, "OffboardingTrackerGetResponsesContentApplicationJsonSchemaDataItemsHrisProfile": { "properties": { "oid": { "description": "The object ID for the HRIS profile of the individual. Null for hiring types without an associated HRIS profile (e.g. contractor, EOR, PEO).", "type": [ "string", "null" ] } }, "title": "OffboardingTrackerGetResponsesContentApplicationJsonSchemaDataItemsHrisProfile", "type": "object" }, "OffboardingTrackerGetResponsesContentApplicationJsonSchemaDataItemsOffboardingType": { "description": "The type of offboarding.", "enum": [ "TERMINATION", "RESIGNATION", "ENDING_CONTRACT" ], "title": "OffboardingTrackerGetResponsesContentApplicationJsonSchemaDataItemsOffboardingType", "type": "string" }, "OffboardingTrackerGetResponsesContentApplicationJsonSchemaDataItemsProgress": { "properties": { "reference_date": { "description": "The reference date for the offboarding status (e.g., the termination date).", "type": [ "string", "null" ] }, "reference_date_timezone": { "description": "The timezone of the reference date.", "type": [ "string", "null" ] }, "reference_date_type": { "description": "The type of reference date (e.g., END_DATE).", "type": "string" }, "status": { "description": "The current status of the offboarding process (e.g., OFFBOARDING_IN_PROGRESS).", "type": "string" } }, "title": "OffboardingTrackerGetResponsesContentApplicationJsonSchemaDataItemsProgress", "type": "object" }, "OffboardingTrackerGetResponsesContentApplicationJsonSchemaErrorsItems": { "properties": { "code": { "description": "Machine-readable error code", "maxLength": 255, "type": "string" }, "message": { "description": "Human-readable explanation", "type": "string" } }, "required": [ "message" ], "title": "OffboardingTrackerGetResponsesContentApplicationJsonSchemaErrorsItems", "type": "object" }, "OffboardingTrackerGetResponsesContentApplicationJsonSchemaPage": { "properties": { "cursor": { "description": "Cursor for pagination to fetch the next page of contractors", "type": [ "string", "null" ] }, "total_rows": { "description": "The total number of contractors available", "type": "integer" } }, "title": "OffboardingTrackerGetResponsesContentApplicationJsonSchemaPage", "type": "object" }, "OffboardingTrackerHrisProfileOidGetResponsesContentApplicationJsonSchemaData": { "properties": { "app_experience": { "$ref": "#/components/schemas/OffboardingTrackerHrisProfileOidGetResponsesContentApplicationJsonSchemaDataAppExperience" }, "contract": { "$ref": "#/components/schemas/OffboardingTrackerHrisProfileOidGetResponsesContentApplicationJsonSchemaDataContract" }, "hiring_type": { "description": "The hiring type for the contract (e.g., contractor).", "type": "string" }, "hris_profile": { "$ref": "#/components/schemas/OffboardingTrackerHrisProfileOidGetResponsesContentApplicationJsonSchemaDataHrisProfile" }, "progress": { "$ref": "#/components/schemas/OffboardingTrackerHrisProfileOidGetResponsesContentApplicationJsonSchemaDataProgress" }, "summary": { "items": { "$ref": "#/components/schemas/OffboardingTrackerHrisProfileOidGetResponsesContentApplicationJsonSchemaDataSummaryItems" }, "type": "array" }, "termination": { "$ref": "#/components/schemas/OffboardingTrackerHrisProfileOidGetResponsesContentApplicationJsonSchemaDataTermination" } }, "title": "OffboardingTrackerHrisProfileOidGetResponsesContentApplicationJsonSchemaData", "type": "object" }, "OffboardingTrackerHrisProfileOidGetResponsesContentApplicationJsonSchemaDataAppExperience": { "properties": { "is_minimal_requirements": { "description": "Indicates whether the individual meets the minimal experience requirements for the role.", "type": "boolean" } }, "title": "OffboardingTrackerHrisProfileOidGetResponsesContentApplicationJsonSchemaDataAppExperience", "type": "object" }, "OffboardingTrackerHrisProfileOidGetResponsesContentApplicationJsonSchemaDataContract": { "properties": { "contract_type": { "description": "The type of the contract (e.g., payg_tasks).", "type": "string" }, "eor": { "description": "Employer of Record (EOR) for the contract, if applicable.", "oneOf": [ { "$ref": "#/components/schemas/OffboardingTrackerHrisProfileOidGetResponsesContentApplicationJsonSchemaDataContractEor" }, { "type": "null" } ] }, "id": { "description": "The unique identifier for the contract.", "type": "string" }, "name": { "description": "The name or title of the contract.", "type": "string" }, "oid": { "description": "The object ID for the contract, which might be the same as the contract ID.", "type": "string" }, "timezone": { "description": "The timezone associated with the contract (e.g., Europe/Belgrade).", "type": "string" } }, "title": "OffboardingTrackerHrisProfileOidGetResponsesContentApplicationJsonSchemaDataContract", "type": "object" }, "OffboardingTrackerHrisProfileOidGetResponsesContentApplicationJsonSchemaDataContractEor": { "description": "Employer of Record (EOR) for the contract, if applicable.", "properties": { "probation_period": { "$ref": "#/components/schemas/OffboardingTrackerHrisProfileOidGetResponsesContentApplicationJsonSchemaDataContractEorProbationPeriod" } }, "title": "OffboardingTrackerHrisProfileOidGetResponsesContentApplicationJsonSchemaDataContractEor", "type": "object" }, "OffboardingTrackerHrisProfileOidGetResponsesContentApplicationJsonSchemaDataContractEorProbationPeriod": { "properties": { "period_end_at": { "description": "Period end date", "type": "string" }, "period_in_days": { "description": "total of days of period", "type": "integer" }, "status": { "description": "probation status", "type": "string" } }, "title": "OffboardingTrackerHrisProfileOidGetResponsesContentApplicationJsonSchemaDataContractEorProbationPeriod", "type": "object" }, "OffboardingTrackerHrisProfileOidGetResponsesContentApplicationJsonSchemaDataHrisProfile": { "properties": { "name": { "description": "The name of the individual in the HRIS profile.", "type": "string" }, "oid": { "description": "The unique object ID for the HRIS profile.", "type": "string" }, "work_email": { "description": "The work email address of the individual in the HRIS profile.", "type": [ "string", "null" ] } }, "title": "OffboardingTrackerHrisProfileOidGetResponsesContentApplicationJsonSchemaDataHrisProfile", "type": "object" }, "OffboardingTrackerHrisProfileOidGetResponsesContentApplicationJsonSchemaDataProgress": { "properties": { "reference_date": { "description": "The reference date for the offboarding status (e.g., the termination date).", "type": "string" }, "reference_date_timezone": { "description": "The timezone of the reference date.", "type": "string" }, "reference_date_type": { "description": "The type of reference date (e.g., END_DATE).", "type": "string" }, "status": { "description": "The current status of the offboarding process (e.g., OFFBOARDING_IN_PROGRESS).", "type": "string" } }, "title": "OffboardingTrackerHrisProfileOidGetResponsesContentApplicationJsonSchemaDataProgress", "type": "object" }, "OffboardingTrackerHrisProfileOidGetResponsesContentApplicationJsonSchemaDataSummaryItems": { "properties": { "data": { "$ref": "#/components/schemas/OffboardingTrackerHrisProfileOidGetResponsesContentApplicationJsonSchemaDataSummaryItemsData" }, "name": { "description": "The name of the summary item (e.g., Contract ending details).", "type": "string" }, "type": { "description": "The type of summary information (e.g., CONTRACT_ENDING_DETAILS).", "type": "string" }, "value": { "description": "The value or status associated with the summary item.", "type": "string" } }, "title": "OffboardingTrackerHrisProfileOidGetResponsesContentApplicationJsonSchemaDataSummaryItems", "type": "object" }, "OffboardingTrackerHrisProfileOidGetResponsesContentApplicationJsonSchemaDataSummaryItemsData": { "properties": { "id": { "description": "The unique identifier for the contract associated with the summary item.", "type": "string" } }, "title": "OffboardingTrackerHrisProfileOidGetResponsesContentApplicationJsonSchemaDataSummaryItemsData", "type": "object" }, "OffboardingTrackerHrisProfileOidGetResponsesContentApplicationJsonSchemaDataTermination": { "properties": { "eligible_for_rehire": { "description": "Indicates whether the individual is eligible for rehire.", "type": [ "string", "null" ] }, "eligible_for_rehire_reason": { "description": "The reason why the individual is or is not eligible for rehire.", "type": [ "string", "null" ] }, "end_date": { "description": "The end date of the contract termination.", "type": [ "string", "null" ] }, "ending_type": { "description": "The type of termination (e.g., ENDING_CONTRACT).", "type": "string" }, "id": { "description": "The termination ID", "type": [ "string", "null" ] }, "initiated_at": { "description": "The date and time when the termination was initiated.", "type": [ "string", "null" ] }, "initiated_by": { "description": "The individual that initiated the termination.", "oneOf": [ { "$ref": "#/components/schemas/OffboardingTrackerHrisProfileOidGetResponsesContentApplicationJsonSchemaDataTerminationInitiatedBy" }, { "type": "null" } ] }, "public_message": { "description": "A public message regarding the termination.", "type": [ "string", "null" ] }, "termination_impact": { "description": "The impact of the termination, if applicable.", "oneOf": [ { "$ref": "#/components/schemas/OffboardingTrackerHrisProfileOidGetResponsesContentApplicationJsonSchemaDataTerminationTerminationImpact" }, { "type": "null" } ] } }, "title": "OffboardingTrackerHrisProfileOidGetResponsesContentApplicationJsonSchemaDataTermination", "type": "object" }, "OffboardingTrackerHrisProfileOidGetResponsesContentApplicationJsonSchemaDataTerminationInitiatedBy": { "description": "The individual that initiated the termination.", "properties": { "name": { "description": "Name of individual", "type": "string" }, "profile_type": { "description": "individual's type", "type": "string" } }, "title": "OffboardingTrackerHrisProfileOidGetResponsesContentApplicationJsonSchemaDataTerminationInitiatedBy", "type": "object" }, "OffboardingTrackerHrisProfileOidGetResponsesContentApplicationJsonSchemaDataTerminationTerminationImpact": { "description": "The impact of the termination, if applicable.", "properties": { "description": { "description": "Description of termination impact", "type": "string" }, "title": { "description": "Title of termination impact", "type": "string" } }, "title": "OffboardingTrackerHrisProfileOidGetResponsesContentApplicationJsonSchemaDataTerminationTerminationImpact", "type": "object" }, "OffboardingTrackerIdGetResponsesContentApplicationJsonSchemaData": { "properties": { "app_experience": { "$ref": "#/components/schemas/OffboardingTrackerIdGetResponsesContentApplicationJsonSchemaDataAppExperience" }, "contract": { "$ref": "#/components/schemas/OffboardingTrackerIdGetResponsesContentApplicationJsonSchemaDataContract" }, "hiring_type": { "description": "The hiring type for the contract (e.g., contractor).", "type": "string" }, "hris_profile": { "oneOf": [ { "$ref": "#/components/schemas/OffboardingTrackerIdGetResponsesContentApplicationJsonSchemaDataHrisProfile" }, { "type": "null" } ] }, "progress": { "$ref": "#/components/schemas/OffboardingTrackerIdGetResponsesContentApplicationJsonSchemaDataProgress" }, "summary": { "items": { "$ref": "#/components/schemas/OffboardingTrackerIdGetResponsesContentApplicationJsonSchemaDataSummaryItems" }, "type": "array" }, "termination": { "$ref": "#/components/schemas/OffboardingTrackerIdGetResponsesContentApplicationJsonSchemaDataTermination" } }, "title": "OffboardingTrackerIdGetResponsesContentApplicationJsonSchemaData", "type": "object" }, "OffboardingTrackerIdGetResponsesContentApplicationJsonSchemaDataAppExperience": { "properties": { "is_minimal_requirements": { "description": "Indicates whether the individual meets the minimal experience requirements for the role.", "type": "boolean" } }, "title": "OffboardingTrackerIdGetResponsesContentApplicationJsonSchemaDataAppExperience", "type": "object" }, "OffboardingTrackerIdGetResponsesContentApplicationJsonSchemaDataContract": { "properties": { "contract_type": { "description": "The type of the contract (e.g., payg_tasks).", "type": "string" }, "eor": { "description": "Employer of Record (EOR) for the contract, if applicable.", "oneOf": [ { "$ref": "#/components/schemas/OffboardingTrackerIdGetResponsesContentApplicationJsonSchemaDataContractEor" }, { "type": "null" } ] }, "id": { "description": "The unique identifier for the contract.", "type": "string" }, "name": { "description": "The name or title of the contract.", "type": "string" }, "oid": { "description": "The object ID for the contract, which might be the same as the contract ID.", "type": "string" }, "timezone": { "description": "The timezone associated with the contract (e.g., Europe/Belgrade).", "type": "string" } }, "title": "OffboardingTrackerIdGetResponsesContentApplicationJsonSchemaDataContract", "type": "object" }, "OffboardingTrackerIdGetResponsesContentApplicationJsonSchemaDataContractEor": { "description": "Employer of Record (EOR) for the contract, if applicable.", "properties": { "probation_period": { "$ref": "#/components/schemas/OffboardingTrackerIdGetResponsesContentApplicationJsonSchemaDataContractEorProbationPeriod" } }, "title": "OffboardingTrackerIdGetResponsesContentApplicationJsonSchemaDataContractEor", "type": "object" }, "OffboardingTrackerIdGetResponsesContentApplicationJsonSchemaDataContractEorProbationPeriod": { "properties": { "period_end_at": { "description": "Period end date", "type": "string" }, "period_in_days": { "description": "total of days of period", "type": "integer" }, "status": { "description": "probation status", "type": "string" } }, "title": "OffboardingTrackerIdGetResponsesContentApplicationJsonSchemaDataContractEorProbationPeriod", "type": "object" }, "OffboardingTrackerIdGetResponsesContentApplicationJsonSchemaDataHrisProfile": { "properties": { "name": { "description": "The name of the individual in the HRIS profile.", "type": "string" }, "oid": { "description": "The unique object ID for the HRIS profile.", "type": "string" }, "work_email": { "description": "The work email address of the individual in the HRIS profile.", "type": [ "string", "null" ] } }, "title": "OffboardingTrackerIdGetResponsesContentApplicationJsonSchemaDataHrisProfile", "type": "object" }, "OffboardingTrackerIdGetResponsesContentApplicationJsonSchemaDataProgress": { "properties": { "reference_date": { "description": "The reference date for the offboarding status (e.g., the termination date).", "type": [ "string", "null" ] }, "reference_date_timezone": { "description": "The timezone of the reference date.", "type": "string" }, "reference_date_type": { "description": "The type of reference date (e.g., END_DATE).", "type": "string" }, "status": { "description": "The current status of the offboarding process (e.g., OFFBOARDING_IN_PROGRESS).", "type": "string" } }, "title": "OffboardingTrackerIdGetResponsesContentApplicationJsonSchemaDataProgress", "type": "object" }, "OffboardingTrackerIdGetResponsesContentApplicationJsonSchemaDataSummaryItems": { "properties": { "data": { "$ref": "#/components/schemas/OffboardingTrackerIdGetResponsesContentApplicationJsonSchemaDataSummaryItemsData" }, "name": { "description": "The name of the summary item (e.g., Contract ending details).", "type": "string" }, "type": { "description": "The type of summary information (e.g., CONTRACT_ENDING_DETAILS).", "type": "string" }, "value": { "description": "The value or status associated with the summary item.", "type": [ "string", "null" ] } }, "title": "OffboardingTrackerIdGetResponsesContentApplicationJsonSchemaDataSummaryItems", "type": "object" }, "OffboardingTrackerIdGetResponsesContentApplicationJsonSchemaDataSummaryItemsData": { "properties": { "id": { "$ref": "#/components/schemas/OffboardingTrackerIdGetResponsesContentApplicationJsonSchemaDataSummaryItemsDataId", "description": "The unique identifier for the contract associated with the summary item." } }, "title": "OffboardingTrackerIdGetResponsesContentApplicationJsonSchemaDataSummaryItemsData", "type": "object" }, "OffboardingTrackerIdGetResponsesContentApplicationJsonSchemaDataSummaryItemsDataId": { "description": "The unique identifier for the contract associated with the summary item.", "oneOf": [ { "type": "string" }, { "type": "integer" } ], "title": "OffboardingTrackerIdGetResponsesContentApplicationJsonSchemaDataSummaryItemsDataId" }, "OffboardingTrackerIdGetResponsesContentApplicationJsonSchemaDataTermination": { "properties": { "eligible_for_rehire": { "description": "Indicates whether the individual is eligible for rehire.", "type": [ "string", "null" ] }, "eligible_for_rehire_reason": { "description": "The reason why the individual is or is not eligible for rehire.", "type": [ "string", "null" ] }, "end_date": { "description": "The end date of the contract termination.", "type": [ "string", "null" ] }, "ending_type": { "description": "The type of termination (e.g., ENDING_CONTRACT).", "type": "string" }, "id": { "description": "The termination ID", "type": [ "string", "null" ] }, "initiated_at": { "description": "The date and time when the termination was initiated.", "type": [ "string", "null" ] }, "initiated_by": { "description": "The individual that initiated the termination.", "oneOf": [ { "$ref": "#/components/schemas/OffboardingTrackerIdGetResponsesContentApplicationJsonSchemaDataTerminationInitiatedBy" }, { "type": "null" } ] }, "public_message": { "description": "A public message regarding the termination.", "type": [ "string", "null" ] }, "termination_impact": { "description": "The impact of the termination, if applicable.", "oneOf": [ { "$ref": "#/components/schemas/OffboardingTrackerIdGetResponsesContentApplicationJsonSchemaDataTerminationTerminationImpact" }, { "type": "null" } ] } }, "title": "OffboardingTrackerIdGetResponsesContentApplicationJsonSchemaDataTermination", "type": "object" }, "OffboardingTrackerIdGetResponsesContentApplicationJsonSchemaDataTerminationInitiatedBy": { "description": "The individual that initiated the termination.", "properties": { "name": { "description": "Name of individual", "type": "string" }, "profile_type": { "description": "individual's type", "type": [ "string", "null" ] } }, "title": "OffboardingTrackerIdGetResponsesContentApplicationJsonSchemaDataTerminationInitiatedBy", "type": "object" }, "OffboardingTrackerIdGetResponsesContentApplicationJsonSchemaDataTerminationTerminationImpact": { "description": "The impact of the termination, if applicable.", "properties": { "description": { "description": "Description of termination impact", "type": "string" }, "title": { "description": "Title of termination impact", "type": "string" } }, "title": "OffboardingTrackerIdGetResponsesContentApplicationJsonSchemaDataTerminationTerminationImpact", "type": "object" }, "OffboardingTrackerIdGetResponsesContentApplicationJsonSchemaErrorsItems": { "properties": { "code": { "description": "Machine-readable error code", "type": "string" }, "message": { "description": "Human-readable explanation of the error", "type": "string" } }, "title": "OffboardingTrackerIdGetResponsesContentApplicationJsonSchemaErrorsItems", "type": "object" }, "Offboarding_retrieveOffboardingList-v2026-01-01_Response_200": { "properties": { "data": { "description": "A list of offboarding items.", "items": { "$ref": "#/components/schemas/OffboardingTrackerGetResponsesContentApplicationJsonSchemaDataItems" }, "type": "array" }, "page": { "$ref": "#/components/schemas/OffboardingTrackerGetResponsesContentApplicationJsonSchemaPage" } }, "title": "Offboarding_retrieveOffboardingList-v2026-01-01_Response_200", "type": "object" }, "Offboarding_retrieveTerminationDetails-v2026-01-01_Response_200": { "properties": { "data": { "$ref": "#/components/schemas/OffboardingTrackerIdGetResponsesContentApplicationJsonSchemaData" } }, "title": "Offboarding_retrieveTerminationDetails-v2026-01-01_Response_200", "type": "object" }, "Offboarding_retrieveTerminationDetailsByHrisProfileIdentifier-v2026-01-01_Response_200": { "properties": { "data": { "$ref": "#/components/schemas/OffboardingTrackerHrisProfileOidGetResponsesContentApplicationJsonSchemaData" } }, "title": "Offboarding_retrieveTerminationDetailsByHrisProfileIdentifier-v2026-01-01_Response_200", "type": "object" }, "On-Demand_Payroll_attachOnDemandPayrollEntries-v2026-07-31_Response_200": { "properties": { "data": { "$ref": "#/components/schemas/OnDemandPayrollOdpIdEntriesAttachPatchResponsesContentApplicationJsonSchemaData", "description": "An On-Demand Payroll for a contract." } }, "required": [ "data" ], "title": "On-Demand Payroll_attachOnDemandPayrollEntries-v2026-07-31_Response_200", "type": "object" }, "On-Demand_Payroll_createOnDemandPayroll-v2026-07-28_Response_201": { "properties": { "data": { "$ref": "#/components/schemas/OnDemandPayrollContractContractIdPostResponsesContentApplicationJsonSchemaData", "description": "An On-Demand Payroll for a contract." } }, "required": [ "data" ], "title": "On-Demand Payroll_createOnDemandPayroll-v2026-07-28_Response_201", "type": "object" }, "On-Demand_Payroll_listOnDemandPayrollEntries-v2026-07-16_Response_200": { "properties": { "data": { "description": "List of contracts with their eligible entries.", "items": { "$ref": "#/components/schemas/OnDemandPayrollContractContractIdEntriesGetResponsesContentApplicationJsonSchemaDataItems" }, "type": "array" } }, "required": [ "data" ], "title": "On-Demand Payroll_listOnDemandPayrollEntries-v2026-07-16_Response_200", "type": "object" }, "On-Demand_Payroll_retrieveCurrentOnDemandPayroll-v2026-07-16_Response_200": { "properties": { "data": { "$ref": "#/components/schemas/OnDemandPayrollContractContractIdCurrentGetResponsesContentApplicationJsonSchemaData", "description": "An On-Demand Payroll for a contract." } }, "required": [ "data" ], "title": "On-Demand Payroll_retrieveCurrentOnDemandPayroll-v2026-07-16_Response_200", "type": "object" }, "OnDemandPayrollContractContractIdCurrentGetResponsesContentApplicationJsonSchemaData": { "description": "An On-Demand Payroll for a contract.", "properties": { "deel_reviewed_at": { "description": "Timestamp when Deel reviewed the ODP, when reviewed.", "format": "date-time", "type": [ "string", "null" ] }, "entries": { "description": "Entries currently attached to the ODP.", "items": { "$ref": "#/components/schemas/OnDemandPayrollContractContractIdCurrentGetResponsesContentApplicationJsonSchemaDataEntriesItems" }, "type": "array" }, "estimated_payday": { "description": "Estimated payday for the ODP (YYYY-MM-DD).", "format": "date", "type": [ "string", "null" ] }, "id": { "description": "Public ID of the On-Demand Payroll.", "type": "string" }, "invoice_id": { "description": "Public ID of the invoice associated with the ODP, when one has been generated. Use the Invoices API to fetch its details.", "type": [ "string", "null" ] }, "next_available_payment_date": { "description": "Next available payment date for the EOR contract (YYYY-MM-DD), when applicable.", "format": "date", "type": [ "string", "null" ] }, "sla": { "$ref": "#/components/schemas/OnDemandPayrollContractContractIdCurrentGetResponsesContentApplicationJsonSchemaDataSla", "description": "Processing SLAs (in days) configured for the contract EOR entity." }, "status": { "$ref": "#/components/schemas/OnDemandPayrollContractContractIdCurrentGetResponsesContentApplicationJsonSchemaDataStatus", "description": "Lifecycle status of the ODP." }, "submitted_at": { "description": "Timestamp when the ODP was submitted, when submitted.", "format": "date-time", "type": [ "string", "null" ] }, "submitted_by": { "description": "Name of the person who submitted the ODP, when submitted.", "type": [ "string", "null" ] } }, "required": [ "id", "sla", "status", "entries" ], "title": "OnDemandPayrollContractContractIdCurrentGetResponsesContentApplicationJsonSchemaData", "type": "object" }, "OnDemandPayrollContractContractIdCurrentGetResponsesContentApplicationJsonSchemaDataEntriesItems": { "description": "An On-Demand Payroll entry (an adjustment attached to the ODP).", "properties": { "amount": { "description": "The entry amount in the contract currency.", "format": "double", "type": "number" }, "currency": { "description": "ISO 4217 currency code of the entry amount.", "type": "string" }, "date_of_entry": { "description": "Date the entry applies to (YYYY-MM-DD). Null when not available for the entry.", "format": "date", "type": [ "string", "null" ] }, "description": { "description": "Free-text description of the entry.", "type": [ "string", "null" ] }, "metadata": { "$ref": "#/components/schemas/OnDemandPayrollContractContractIdCurrentGetResponsesContentApplicationJsonSchemaDataEntriesItemsMetadata", "description": "Additional, non-contractual metadata about the entry." }, "submitter": { "description": "The person who submitted the entry.", "oneOf": [ { "$ref": "#/components/schemas/OnDemandPayrollContractContractIdCurrentGetResponsesContentApplicationJsonSchemaDataEntriesItemsSubmitter" }, { "type": "null" } ] }, "title": { "description": "Short human-readable title of the entry.", "type": "string" }, "type": { "description": "The adjustment type of the entry.", "type": "string" }, "uom": { "$ref": "#/components/schemas/OnDemandPayrollContractContractIdCurrentGetResponsesContentApplicationJsonSchemaDataEntriesItemsUom", "description": "Unit of measure of the entry amount. Always CURRENCY." } }, "required": [ "uom", "type", "title", "amount", "currency", "metadata" ], "title": "OnDemandPayrollContractContractIdCurrentGetResponsesContentApplicationJsonSchemaDataEntriesItems", "type": "object" }, "OnDemandPayrollContractContractIdCurrentGetResponsesContentApplicationJsonSchemaDataEntriesItemsMetadata": { "description": "Additional, non-contractual metadata about the entry.", "properties": { "category_group_label": { "description": "Label of the adjustment category group.", "type": [ "string", "null" ] }, "category_label": { "description": "Label of the adjustment category.", "type": [ "string", "null" ] }, "public_id": { "description": "Public ID of the underlying adjustment.", "type": "string" }, "reviewed_at": { "description": "Timestamp of the last review of the entry.", "format": "date-time", "type": [ "string", "null" ] }, "submission_date": { "description": "Timestamp when the entry was submitted.", "format": "date-time", "type": [ "string", "null" ] }, "type": { "description": "The adjustment type of the entry.", "type": "string" }, "vendor_name": { "description": "Vendor associated with the entry, when applicable.", "type": [ "string", "null" ] } }, "title": "OnDemandPayrollContractContractIdCurrentGetResponsesContentApplicationJsonSchemaDataEntriesItemsMetadata", "type": "object" }, "OnDemandPayrollContractContractIdCurrentGetResponsesContentApplicationJsonSchemaDataEntriesItemsSubmitter": { "description": "The person who submitted the entry.", "properties": { "id": { "description": "Public ID of the submitter, when available.", "type": [ "string", "null" ] }, "name": { "description": "Full name of the submitter.", "type": "string" } }, "title": "OnDemandPayrollContractContractIdCurrentGetResponsesContentApplicationJsonSchemaDataEntriesItemsSubmitter", "type": "object" }, "OnDemandPayrollContractContractIdCurrentGetResponsesContentApplicationJsonSchemaDataEntriesItemsUom": { "description": "Unit of measure of the entry amount. Always CURRENCY.", "enum": [ "CURRENCY" ], "title": "OnDemandPayrollContractContractIdCurrentGetResponsesContentApplicationJsonSchemaDataEntriesItemsUom", "type": "string" }, "OnDemandPayrollContractContractIdCurrentGetResponsesContentApplicationJsonSchemaDataSla": { "description": "Processing SLAs (in days) configured for the contract EOR entity.", "properties": { "payment_buffer": { "description": "Payment buffer in days.", "type": [ "integer", "null" ] }, "payment_processing": { "description": "Payment processing SLA in days.", "type": [ "integer", "null" ] }, "payment_settlement": { "description": "Payment settlement SLA in days.", "type": [ "integer", "null" ] }, "payroll_processing": { "description": "Payroll processing SLA in days.", "type": [ "integer", "null" ] }, "post_termination_buffer": { "description": "Post-termination buffer in days during which an ODP is still allowed.", "type": [ "integer", "null" ] } }, "title": "OnDemandPayrollContractContractIdCurrentGetResponsesContentApplicationJsonSchemaDataSla", "type": "object" }, "OnDemandPayrollContractContractIdCurrentGetResponsesContentApplicationJsonSchemaDataStatus": { "description": "Lifecycle status of the ODP.", "enum": [ "AWAITING_CLIENT_APPROVAL", "AWAITING_CLIENT_SUBMISSION", "AWAITING_ADJUSTMENTS_TO_BE_READY", "AWAITING_DEEL_PROCESSING", "DEEL_PROCESSING", "REJECTED", "CANCELLED", "PARTIALLY_APPROVED", "APPROVED" ], "title": "OnDemandPayrollContractContractIdCurrentGetResponsesContentApplicationJsonSchemaDataStatus", "type": "string" }, "OnDemandPayrollContractContractIdCurrentGetResponsesContentApplicationJsonSchemaErrorsItems": { "properties": { "code": { "description": "Machine-readable error code.", "type": "string" }, "field": { "description": "Field that caused the error, when applicable.", "type": "string" }, "message": { "description": "Human-readable error message.", "type": "string" } }, "title": "OnDemandPayrollContractContractIdCurrentGetResponsesContentApplicationJsonSchemaErrorsItems", "type": "object" }, "OnDemandPayrollContractContractIdEntriesGetResponsesContentApplicationJsonSchemaDataItems": { "description": "A contract and its entries eligible for On-Demand Payroll.", "properties": { "contract_id": { "description": "Public ID (oid) of the contract.", "type": "string" }, "currency": { "description": "ISO 4217 currency code of the contract.", "type": "string" }, "employee_name": { "description": "Full name of the employee.", "type": "string" }, "entries": { "description": "Eligible entries for the contract.", "items": { "$ref": "#/components/schemas/OnDemandPayrollContractContractIdEntriesGetResponsesContentApplicationJsonSchemaDataItemsEntriesItems" }, "type": "array" }, "has_pending_items": { "description": "Whether the contract has entries in a pending state.", "type": "boolean" }, "is_odp_enabled": { "description": "Whether On-Demand Payroll is enabled for the contract.", "type": "boolean" }, "job_title": { "description": "Job title of the employee.", "type": [ "string", "null" ] }, "odp_limit": { "description": "Maximum total ODP amount allowed, in the contract currency.", "format": "double", "type": "number" }, "odp_warning_limit": { "description": "Amount above which the client is warned (3x the salary per cycle).", "format": "double", "type": "number" }, "ongoing_odp": { "description": "The ongoing ODP for the contract, if one exists.", "oneOf": [ { "$ref": "#/components/schemas/OnDemandPayrollContractContractIdEntriesGetResponsesContentApplicationJsonSchemaDataItemsOngoingOdp" }, { "type": "null" } ] }, "salary_advance_limit": { "description": "Maximum salary advance allowed, in the contract currency.", "format": "double", "type": "number" }, "team": { "description": "Team the contract belongs to.", "oneOf": [ { "$ref": "#/components/schemas/OnDemandPayrollContractContractIdEntriesGetResponsesContentApplicationJsonSchemaDataItemsTeam" }, { "type": "null" } ] } }, "required": [ "entries", "currency", "contract_id", "is_odp_enabled", "has_pending_items" ], "title": "OnDemandPayrollContractContractIdEntriesGetResponsesContentApplicationJsonSchemaDataItems", "type": "object" }, "OnDemandPayrollContractContractIdEntriesGetResponsesContentApplicationJsonSchemaDataItemsEntriesItems": { "description": "An On-Demand Payroll entry (an adjustment attached to the ODP).", "properties": { "amount": { "description": "The entry amount in the contract currency.", "format": "double", "type": "number" }, "currency": { "description": "ISO 4217 currency code of the entry amount.", "type": "string" }, "date_of_entry": { "description": "Date the entry applies to (YYYY-MM-DD). Null when not available for the entry.", "format": "date", "type": [ "string", "null" ] }, "description": { "description": "Free-text description of the entry.", "type": [ "string", "null" ] }, "id": { "description": "Public ID of the On-Demand Payroll entry.", "type": "string" }, "metadata": { "$ref": "#/components/schemas/OnDemandPayrollContractContractIdEntriesGetResponsesContentApplicationJsonSchemaDataItemsEntriesItemsMetadata", "description": "Additional, non-contractual metadata about the entry." }, "submitter": { "description": "The person who submitted the entry.", "oneOf": [ { "$ref": "#/components/schemas/OnDemandPayrollContractContractIdEntriesGetResponsesContentApplicationJsonSchemaDataItemsEntriesItemsSubmitter" }, { "type": "null" } ] }, "title": { "description": "Short human-readable title of the entry.", "type": "string" }, "type": { "description": "The adjustment type of the entry.", "type": "string" }, "uom": { "$ref": "#/components/schemas/OnDemandPayrollContractContractIdEntriesGetResponsesContentApplicationJsonSchemaDataItemsEntriesItemsUom", "description": "Unit of measure of the entry amount. Always CURRENCY." } }, "required": [ "id", "uom", "type", "title", "amount", "currency", "metadata" ], "title": "OnDemandPayrollContractContractIdEntriesGetResponsesContentApplicationJsonSchemaDataItemsEntriesItems", "type": "object" }, "OnDemandPayrollContractContractIdEntriesGetResponsesContentApplicationJsonSchemaDataItemsEntriesItemsMetadata": { "description": "Additional, non-contractual metadata about the entry.", "properties": { "category_group_label": { "description": "Label of the adjustment category group.", "type": [ "string", "null" ] }, "category_label": { "description": "Label of the adjustment category.", "type": [ "string", "null" ] }, "reviewed_at": { "description": "Timestamp of the last review of the entry.", "format": "date-time", "type": [ "string", "null" ] }, "source_service_entry_id": { "description": "Public ID of the entry in the service it originates from (for example, the adjustment ID for an adjustment entry). Use it to correlate the entry with the source resource.", "type": "string" }, "submission_date": { "description": "Timestamp when the entry was submitted.", "format": "date-time", "type": [ "string", "null" ] }, "type": { "description": "The adjustment type of the entry.", "type": "string" }, "vendor_name": { "description": "Vendor associated with the entry, when applicable.", "type": [ "string", "null" ] } }, "title": "OnDemandPayrollContractContractIdEntriesGetResponsesContentApplicationJsonSchemaDataItemsEntriesItemsMetadata", "type": "object" }, "OnDemandPayrollContractContractIdEntriesGetResponsesContentApplicationJsonSchemaDataItemsEntriesItemsSubmitter": { "description": "The person who submitted the entry.", "properties": { "id": { "description": "Public ID of the submitter, when available.", "type": [ "string", "null" ] }, "name": { "description": "Full name of the submitter.", "type": "string" } }, "title": "OnDemandPayrollContractContractIdEntriesGetResponsesContentApplicationJsonSchemaDataItemsEntriesItemsSubmitter", "type": "object" }, "OnDemandPayrollContractContractIdEntriesGetResponsesContentApplicationJsonSchemaDataItemsEntriesItemsUom": { "description": "Unit of measure of the entry amount. Always CURRENCY.", "enum": [ "CURRENCY" ], "title": "OnDemandPayrollContractContractIdEntriesGetResponsesContentApplicationJsonSchemaDataItemsEntriesItemsUom", "type": "string" }, "OnDemandPayrollContractContractIdEntriesGetResponsesContentApplicationJsonSchemaDataItemsOngoingOdp": { "description": "The ongoing ODP for the contract, if one exists.", "properties": { "status": { "$ref": "#/components/schemas/OnDemandPayrollContractContractIdEntriesGetResponsesContentApplicationJsonSchemaDataItemsOngoingOdpStatus", "description": "Status of the ongoing ODP." } }, "title": "OnDemandPayrollContractContractIdEntriesGetResponsesContentApplicationJsonSchemaDataItemsOngoingOdp", "type": "object" }, "OnDemandPayrollContractContractIdEntriesGetResponsesContentApplicationJsonSchemaDataItemsOngoingOdpStatus": { "description": "Status of the ongoing ODP.", "enum": [ "AWAITING_CLIENT_APPROVAL", "AWAITING_CLIENT_SUBMISSION", "AWAITING_ADJUSTMENTS_TO_BE_READY", "AWAITING_DEEL_PROCESSING", "DEEL_PROCESSING", "REJECTED", "CANCELLED", "PARTIALLY_APPROVED", "APPROVED" ], "title": "OnDemandPayrollContractContractIdEntriesGetResponsesContentApplicationJsonSchemaDataItemsOngoingOdpStatus", "type": "string" }, "OnDemandPayrollContractContractIdEntriesGetResponsesContentApplicationJsonSchemaDataItemsTeam": { "description": "Team the contract belongs to.", "properties": { "id": { "description": "Public ID of the team.", "type": "string" }, "name": { "description": "Name of the team.", "type": "string" } }, "title": "OnDemandPayrollContractContractIdEntriesGetResponsesContentApplicationJsonSchemaDataItemsTeam", "type": "object" }, "OnDemandPayrollContractContractIdEntriesGetResponsesContentApplicationJsonSchemaErrorsItems": { "properties": { "code": { "description": "Machine-readable error code.", "type": "string" }, "field": { "description": "Field that caused the error, when applicable.", "type": "string" }, "message": { "description": "Human-readable error message.", "type": "string" } }, "title": "OnDemandPayrollContractContractIdEntriesGetResponsesContentApplicationJsonSchemaErrorsItems", "type": "object" }, "OnDemandPayrollContractContractIdPostRequestBodyContentApplicationJsonSchemaData": { "properties": { "existing_entry_ids": { "description": "Public IDs of existing entries (adjustments) to attach to the ODP.", "items": { "type": "string" }, "type": "array" }, "salary_advance": { "description": "Salary advance amount to include in the ODP, in the contract currency.", "format": "double", "type": "number" } }, "title": "OnDemandPayrollContractContractIdPostRequestBodyContentApplicationJsonSchemaData", "type": "object" }, "OnDemandPayrollContractContractIdPostResponsesContentApplicationJsonSchemaData": { "description": "An On-Demand Payroll for a contract.", "properties": { "deel_reviewed_at": { "description": "Timestamp when Deel reviewed the ODP, when reviewed.", "format": "date-time", "type": [ "string", "null" ] }, "entries": { "description": "Entries currently attached to the ODP.", "items": { "$ref": "#/components/schemas/OnDemandPayrollContractContractIdPostResponsesContentApplicationJsonSchemaDataEntriesItems" }, "type": "array" }, "estimated_payday": { "description": "Estimated payday for the ODP (YYYY-MM-DD).", "format": "date", "type": [ "string", "null" ] }, "id": { "description": "Public ID of the On-Demand Payroll.", "type": "string" }, "invoice_id": { "description": "Public ID of the invoice associated with the ODP, when one has been generated. Use the Invoices API to fetch its details.", "type": [ "string", "null" ] }, "next_available_payment_date": { "description": "Next available payment date for the EOR contract (YYYY-MM-DD), when applicable.", "format": "date", "type": [ "string", "null" ] }, "sla": { "$ref": "#/components/schemas/OnDemandPayrollContractContractIdPostResponsesContentApplicationJsonSchemaDataSla", "description": "Processing SLAs (in days) configured for the contract EOR entity." }, "status": { "$ref": "#/components/schemas/OnDemandPayrollContractContractIdPostResponsesContentApplicationJsonSchemaDataStatus", "description": "Lifecycle status of the ODP." }, "submitted_at": { "description": "Timestamp when the ODP was submitted, when submitted.", "format": "date-time", "type": [ "string", "null" ] }, "submitted_by": { "description": "Name of the person who submitted the ODP, when submitted.", "type": [ "string", "null" ] } }, "required": [ "id", "sla", "status", "entries" ], "title": "OnDemandPayrollContractContractIdPostResponsesContentApplicationJsonSchemaData", "type": "object" }, "OnDemandPayrollContractContractIdPostResponsesContentApplicationJsonSchemaDataEntriesItems": { "description": "An On-Demand Payroll entry (an adjustment attached to the ODP).", "properties": { "amount": { "description": "The entry amount in the contract currency.", "format": "double", "type": "number" }, "currency": { "description": "ISO 4217 currency code of the entry amount.", "type": "string" }, "date_of_entry": { "description": "Date the entry applies to (YYYY-MM-DD). Null when not available for the entry.", "format": "date", "type": [ "string", "null" ] }, "description": { "description": "Free-text description of the entry.", "type": [ "string", "null" ] }, "metadata": { "$ref": "#/components/schemas/OnDemandPayrollContractContractIdPostResponsesContentApplicationJsonSchemaDataEntriesItemsMetadata", "description": "Additional, non-contractual metadata about the entry." }, "submitter": { "description": "The person who submitted the entry.", "oneOf": [ { "$ref": "#/components/schemas/OnDemandPayrollContractContractIdPostResponsesContentApplicationJsonSchemaDataEntriesItemsSubmitter" }, { "type": "null" } ] }, "title": { "description": "Short human-readable title of the entry.", "type": "string" }, "type": { "description": "The adjustment type of the entry.", "type": "string" }, "uom": { "$ref": "#/components/schemas/OnDemandPayrollContractContractIdPostResponsesContentApplicationJsonSchemaDataEntriesItemsUom", "description": "Unit of measure of the entry amount. Always CURRENCY." } }, "required": [ "uom", "type", "title", "amount", "currency", "metadata" ], "title": "OnDemandPayrollContractContractIdPostResponsesContentApplicationJsonSchemaDataEntriesItems", "type": "object" }, "OnDemandPayrollContractContractIdPostResponsesContentApplicationJsonSchemaDataEntriesItemsMetadata": { "description": "Additional, non-contractual metadata about the entry.", "properties": { "category_group_label": { "description": "Label of the adjustment category group.", "type": [ "string", "null" ] }, "category_label": { "description": "Label of the adjustment category.", "type": [ "string", "null" ] }, "public_id": { "description": "Public ID of the underlying adjustment.", "type": "string" }, "reviewed_at": { "description": "Timestamp of the last review of the entry.", "format": "date-time", "type": [ "string", "null" ] }, "submission_date": { "description": "Timestamp when the entry was submitted.", "format": "date-time", "type": [ "string", "null" ] }, "type": { "description": "The adjustment type of the entry.", "type": "string" }, "vendor_name": { "description": "Vendor associated with the entry, when applicable.", "type": [ "string", "null" ] } }, "title": "OnDemandPayrollContractContractIdPostResponsesContentApplicationJsonSchemaDataEntriesItemsMetadata", "type": "object" }, "OnDemandPayrollContractContractIdPostResponsesContentApplicationJsonSchemaDataEntriesItemsSubmitter": { "description": "The person who submitted the entry.", "properties": { "id": { "description": "Public ID of the submitter, when available.", "type": [ "string", "null" ] }, "name": { "description": "Full name of the submitter.", "type": "string" } }, "title": "OnDemandPayrollContractContractIdPostResponsesContentApplicationJsonSchemaDataEntriesItemsSubmitter", "type": "object" }, "OnDemandPayrollContractContractIdPostResponsesContentApplicationJsonSchemaDataEntriesItemsUom": { "description": "Unit of measure of the entry amount. Always CURRENCY.", "enum": [ "CURRENCY" ], "title": "OnDemandPayrollContractContractIdPostResponsesContentApplicationJsonSchemaDataEntriesItemsUom", "type": "string" }, "OnDemandPayrollContractContractIdPostResponsesContentApplicationJsonSchemaDataSla": { "description": "Processing SLAs (in days) configured for the contract EOR entity.", "properties": { "payment_buffer": { "description": "Payment buffer in days.", "type": [ "integer", "null" ] }, "payment_processing": { "description": "Payment processing SLA in days.", "type": [ "integer", "null" ] }, "payment_settlement": { "description": "Payment settlement SLA in days.", "type": [ "integer", "null" ] }, "payroll_processing": { "description": "Payroll processing SLA in days.", "type": [ "integer", "null" ] }, "post_termination_buffer": { "description": "Post-termination buffer in days during which an ODP is still allowed.", "type": [ "integer", "null" ] } }, "title": "OnDemandPayrollContractContractIdPostResponsesContentApplicationJsonSchemaDataSla", "type": "object" }, "OnDemandPayrollContractContractIdPostResponsesContentApplicationJsonSchemaDataStatus": { "description": "Lifecycle status of the ODP.", "enum": [ "AWAITING_CLIENT_APPROVAL", "AWAITING_CLIENT_SUBMISSION", "AWAITING_ADJUSTMENTS_TO_BE_READY", "AWAITING_DEEL_PROCESSING", "DEEL_PROCESSING", "REJECTED", "CANCELLED", "PARTIALLY_APPROVED", "APPROVED" ], "title": "OnDemandPayrollContractContractIdPostResponsesContentApplicationJsonSchemaDataStatus", "type": "string" }, "OnDemandPayrollContractContractIdPostResponsesContentApplicationJsonSchemaErrorsItems": { "properties": { "code": { "description": "Machine-readable error code.", "type": "string" }, "field": { "description": "Field that caused the error, when applicable.", "type": "string" }, "message": { "description": "Human-readable error message.", "type": "string" } }, "title": "OnDemandPayrollContractContractIdPostResponsesContentApplicationJsonSchemaErrorsItems", "type": "object" }, "OnDemandPayrollOdpIdCancelPostRequestBodyContentApplicationJsonSchemaData": { "properties": { "move_to_regular": { "description": "Public IDs of the entries to move to the regular payroll cycle instead of cancelling them with the ODP.", "items": { "type": "string" }, "type": "array" } }, "title": "OnDemandPayrollOdpIdCancelPostRequestBodyContentApplicationJsonSchemaData", "type": "object" }, "OnDemandPayrollOdpIdCancelPostResponsesContentApplicationJsonSchemaErrorsItems": { "properties": { "code": { "description": "Machine-readable error code.", "type": "string" }, "field": { "description": "Field that caused the error, when applicable.", "type": "string" }, "message": { "description": "Human-readable error message.", "type": "string" } }, "title": "OnDemandPayrollOdpIdCancelPostResponsesContentApplicationJsonSchemaErrorsItems", "type": "object" }, "OnDemandPayrollOdpIdEntriesAttachPatchRequestBodyContentApplicationJsonSchemaData": { "properties": { "existing_entry_ids": { "description": "Public IDs of existing entries (adjustments) to attach to the ODP.", "items": { "type": "string" }, "type": "array" }, "salary_advance": { "description": "Salary advance amount to include in the ODP, in the contract currency.", "format": "double", "type": "number" } }, "title": "OnDemandPayrollOdpIdEntriesAttachPatchRequestBodyContentApplicationJsonSchemaData", "type": "object" }, "OnDemandPayrollOdpIdEntriesAttachPatchResponsesContentApplicationJsonSchemaData": { "description": "An On-Demand Payroll for a contract.", "properties": { "deel_reviewed_at": { "description": "Timestamp when Deel reviewed the ODP, when reviewed.", "format": "date-time", "type": [ "string", "null" ] }, "entries": { "description": "Entries currently attached to the ODP.", "items": { "$ref": "#/components/schemas/OnDemandPayrollOdpIdEntriesAttachPatchResponsesContentApplicationJsonSchemaDataEntriesItems" }, "type": "array" }, "estimated_payday": { "description": "Estimated payday for the ODP (YYYY-MM-DD).", "format": "date", "type": [ "string", "null" ] }, "id": { "description": "Public ID of the On-Demand Payroll.", "type": "string" }, "invoice_id": { "description": "Public ID of the invoice associated with the ODP, when one has been generated. Use the Invoices API to fetch its details.", "type": [ "string", "null" ] }, "next_available_payment_date": { "description": "Next available payment date for the EOR contract (YYYY-MM-DD), when applicable.", "format": "date", "type": [ "string", "null" ] }, "sla": { "$ref": "#/components/schemas/OnDemandPayrollOdpIdEntriesAttachPatchResponsesContentApplicationJsonSchemaDataSla", "description": "Processing SLAs (in days) configured for the contract EOR entity." }, "status": { "$ref": "#/components/schemas/OnDemandPayrollOdpIdEntriesAttachPatchResponsesContentApplicationJsonSchemaDataStatus", "description": "Lifecycle status of the ODP." }, "submitted_at": { "description": "Timestamp when the ODP was submitted, when submitted.", "format": "date-time", "type": [ "string", "null" ] }, "submitted_by": { "description": "Name of the person who submitted the ODP, when submitted.", "type": [ "string", "null" ] } }, "required": [ "id", "sla", "status", "entries" ], "title": "OnDemandPayrollOdpIdEntriesAttachPatchResponsesContentApplicationJsonSchemaData", "type": "object" }, "OnDemandPayrollOdpIdEntriesAttachPatchResponsesContentApplicationJsonSchemaDataEntriesItems": { "description": "An On-Demand Payroll entry (an adjustment attached to the ODP).", "properties": { "amount": { "description": "The entry amount in the contract currency.", "format": "double", "type": "number" }, "currency": { "description": "ISO 4217 currency code of the entry amount.", "type": "string" }, "date_of_entry": { "description": "Date the entry applies to (YYYY-MM-DD). Null when not available for the entry.", "format": "date", "type": [ "string", "null" ] }, "description": { "description": "Free-text description of the entry.", "type": [ "string", "null" ] }, "metadata": { "$ref": "#/components/schemas/OnDemandPayrollOdpIdEntriesAttachPatchResponsesContentApplicationJsonSchemaDataEntriesItemsMetadata", "description": "Additional, non-contractual metadata about the entry." }, "submitter": { "description": "The person who submitted the entry.", "oneOf": [ { "$ref": "#/components/schemas/OnDemandPayrollOdpIdEntriesAttachPatchResponsesContentApplicationJsonSchemaDataEntriesItemsSubmitter" }, { "type": "null" } ] }, "title": { "description": "Short human-readable title of the entry.", "type": "string" }, "type": { "description": "The adjustment type of the entry.", "type": "string" }, "uom": { "$ref": "#/components/schemas/OnDemandPayrollOdpIdEntriesAttachPatchResponsesContentApplicationJsonSchemaDataEntriesItemsUom", "description": "Unit of measure of the entry amount. Always CURRENCY." } }, "required": [ "uom", "type", "title", "amount", "currency", "metadata" ], "title": "OnDemandPayrollOdpIdEntriesAttachPatchResponsesContentApplicationJsonSchemaDataEntriesItems", "type": "object" }, "OnDemandPayrollOdpIdEntriesAttachPatchResponsesContentApplicationJsonSchemaDataEntriesItemsMetadata": { "description": "Additional, non-contractual metadata about the entry.", "properties": { "category_group_label": { "description": "Label of the adjustment category group.", "type": [ "string", "null" ] }, "category_label": { "description": "Label of the adjustment category.", "type": [ "string", "null" ] }, "public_id": { "description": "Public ID of the underlying adjustment.", "type": "string" }, "reviewed_at": { "description": "Timestamp of the last review of the entry.", "format": "date-time", "type": [ "string", "null" ] }, "submission_date": { "description": "Timestamp when the entry was submitted.", "format": "date-time", "type": [ "string", "null" ] }, "type": { "description": "The adjustment type of the entry.", "type": "string" }, "vendor_name": { "description": "Vendor associated with the entry, when applicable.", "type": [ "string", "null" ] } }, "title": "OnDemandPayrollOdpIdEntriesAttachPatchResponsesContentApplicationJsonSchemaDataEntriesItemsMetadata", "type": "object" }, "OnDemandPayrollOdpIdEntriesAttachPatchResponsesContentApplicationJsonSchemaDataEntriesItemsSubmitter": { "description": "The person who submitted the entry.", "properties": { "id": { "description": "Public ID of the submitter, when available.", "type": [ "string", "null" ] }, "name": { "description": "Full name of the submitter.", "type": "string" } }, "title": "OnDemandPayrollOdpIdEntriesAttachPatchResponsesContentApplicationJsonSchemaDataEntriesItemsSubmitter", "type": "object" }, "OnDemandPayrollOdpIdEntriesAttachPatchResponsesContentApplicationJsonSchemaDataEntriesItemsUom": { "description": "Unit of measure of the entry amount. Always CURRENCY.", "enum": [ "CURRENCY" ], "title": "OnDemandPayrollOdpIdEntriesAttachPatchResponsesContentApplicationJsonSchemaDataEntriesItemsUom", "type": "string" }, "OnDemandPayrollOdpIdEntriesAttachPatchResponsesContentApplicationJsonSchemaDataSla": { "description": "Processing SLAs (in days) configured for the contract EOR entity.", "properties": { "payment_buffer": { "description": "Payment buffer in days.", "type": [ "integer", "null" ] }, "payment_processing": { "description": "Payment processing SLA in days.", "type": [ "integer", "null" ] }, "payment_settlement": { "description": "Payment settlement SLA in days.", "type": [ "integer", "null" ] }, "payroll_processing": { "description": "Payroll processing SLA in days.", "type": [ "integer", "null" ] }, "post_termination_buffer": { "description": "Post-termination buffer in days during which an ODP is still allowed.", "type": [ "integer", "null" ] } }, "title": "OnDemandPayrollOdpIdEntriesAttachPatchResponsesContentApplicationJsonSchemaDataSla", "type": "object" }, "OnDemandPayrollOdpIdEntriesAttachPatchResponsesContentApplicationJsonSchemaDataStatus": { "description": "Lifecycle status of the ODP.", "enum": [ "AWAITING_CLIENT_APPROVAL", "AWAITING_CLIENT_SUBMISSION", "AWAITING_ADJUSTMENTS_TO_BE_READY", "AWAITING_DEEL_PROCESSING", "DEEL_PROCESSING", "REJECTED", "CANCELLED", "PARTIALLY_APPROVED", "APPROVED" ], "title": "OnDemandPayrollOdpIdEntriesAttachPatchResponsesContentApplicationJsonSchemaDataStatus", "type": "string" }, "OnDemandPayrollOdpIdEntriesAttachPatchResponsesContentApplicationJsonSchemaErrorsItems": { "properties": { "code": { "description": "Machine-readable error code.", "type": "string" }, "field": { "description": "Field that caused the error, when applicable.", "type": "string" }, "message": { "description": "Human-readable error message.", "type": "string" } }, "title": "OnDemandPayrollOdpIdEntriesAttachPatchResponsesContentApplicationJsonSchemaErrorsItems", "type": "object" }, "OnDemandPayrollOdpIdEntriesDetachPatchRequestBodyContentApplicationJsonSchemaData": { "properties": { "entries_to_delete": { "description": "Public IDs of the entries to permanently delete from the ODP.", "items": { "type": "string" }, "type": "array" }, "move_to_regular": { "description": "Public IDs of the entries to remove from the ODP and move to the regular payroll cycle.", "items": { "type": "string" }, "type": "array" } }, "title": "OnDemandPayrollOdpIdEntriesDetachPatchRequestBodyContentApplicationJsonSchemaData", "type": "object" }, "OnDemandPayrollOdpIdEntriesDetachPatchResponsesContentApplicationJsonSchemaErrorsItems": { "properties": { "code": { "description": "Machine-readable error code.", "type": "string" }, "field": { "description": "Field that caused the error, when applicable.", "type": "string" }, "message": { "description": "Human-readable error message.", "type": "string" } }, "title": "OnDemandPayrollOdpIdEntriesDetachPatchResponsesContentApplicationJsonSchemaErrorsItems", "type": "object" }, "OnDemandPayrollOdpIdSubmitPostResponsesContentApplicationJsonSchemaErrorsItems": { "properties": { "code": { "description": "Machine-readable error code.", "type": "string" }, "field": { "description": "Field that caused the error, when applicable.", "type": "string" }, "message": { "description": "Human-readable error message.", "type": "string" } }, "title": "OnDemandPayrollOdpIdSubmitPostResponsesContentApplicationJsonSchemaErrorsItems", "type": "object" }, "OnboardingTrackerGetParametersActionsSchemaItems": { "enum": [ "CLIENT_ACTION_REQUIRED", "CLIENT_ACTION_NOT_REQUIRED" ], "title": "OnboardingTrackerGetParametersActionsSchemaItems", "type": "string" }, "OnboardingTrackerGetParametersCard": { "enum": [ "ACTION_REQUIRED", "OVERDUE", "WITH_DEEL_FOR_REVIEW", "READY_TO_START", "STARTING_THIS_WEEK" ], "title": "OnboardingTrackerGetParametersCard", "type": "string" }, "OnboardingTrackerGetParametersHiringTypesSchemaItems": { "description": "Hiring type (e.g., contractor, eor)", "enum": [ "contractor", "direct_employee", "hris_direct_employee", "hris_direct_contractor", "eor", "peo", "person_without_contract" ], "title": "OnboardingTrackerGetParametersHiringTypesSchemaItems", "type": "string" }, "OnboardingTrackerGetParametersLifecycleStatusesSchemaItems": { "description": "Lifecycle status of the onboarding", "enum": [ "DRAFT", "IN_REVIEW", "QUOTE_REQUIRES_CHANGES", "PENDING_INVITE", "INVITED", "ONBOARDING", "ONBOARDING_AT_RISK", "ONBOARDING_OVERDUE", "OFFBOARDING", "ONBOARDED" ], "title": "OnboardingTrackerGetParametersLifecycleStatusesSchemaItems", "type": "string" }, "OnboardingTrackerGetParametersProgressStatusesSchemaItems": { "description": "Progress status of the contract", "enum": [ "ONBOARDING_AT_RISK", "ONBOARDING_OVERDUE", "INVITED", "ONBOARDING", "READY_TO_START", "INACTIVE", "PENDING_INVITE", "ACTIVE", "DRAFT", "OFFBOARDING", "QUOTE_REQUIRES_CHANGES", "IN_REVIEW", "IN_OFFER_STAGE" ], "title": "OnboardingTrackerGetParametersProgressStatusesSchemaItems", "type": "string" }, "OnboardingTrackerGetParametersSortBy": { "default": "progressStatusWeight", "enum": [ "progressStatusWeight" ], "title": "OnboardingTrackerGetParametersSortBy", "type": "string" }, "OnboardingTrackerGetParametersSortOrder": { "default": "ASC", "enum": [ "ASC", "DESC" ], "title": "OnboardingTrackerGetParametersSortOrder", "type": "string" }, "OnboardingTrackerGetParametersWaitingOnPartiesSchemaItems": { "description": "Party the onboarding is waiting on", "enum": [ "WORKER", "CLIENT", "DEEL" ], "title": "OnboardingTrackerGetParametersWaitingOnPartiesSchemaItems", "type": "string" }, "OnboardingTrackerGetResponsesContentApplicationJsonSchemaDataItems": { "properties": { "app_experience": { "$ref": "#/components/schemas/OnboardingTrackerGetResponsesContentApplicationJsonSchemaDataItemsAppExperience", "description": "The app experience of the employee" }, "can_send_invitation": { "description": "Only for a Global Payroll direct employee, when the organization sends app invitations. Whether the invitation to the app can be sent: the employee has app access and has not signed up yet", "type": "boolean" }, "contract": { "$ref": "#/components/schemas/OnboardingTrackerGetResponsesContentApplicationJsonSchemaDataItemsContract", "description": "The contract associated with the onboarding" }, "contracts": { "description": "Every contract of the worker the caller can see, the main one first, so each row of the worker lists the same contracts. A worker has one row per worker type, so the main contract can belong to another row: compare `contract_oid` with `contract.id`. Empty for a draft quote", "items": { "$ref": "#/components/schemas/OnboardingTrackerGetResponsesContentApplicationJsonSchemaDataItemsContractsItems" }, "type": "array" }, "country": { "$ref": "#/components/schemas/OnboardingTrackerGetResponsesContentApplicationJsonSchemaDataItemsCountry", "description": "The country of the contract" }, "hiring_type": { "description": "The type of hiring (e.g., contractor)", "type": "string" }, "hris_profile": { "$ref": "#/components/schemas/OnboardingTrackerGetResponsesContentApplicationJsonSchemaDataItemsHrisProfile", "description": "The profile associated with the onboarding" }, "invitation_sent": { "description": "Only for a Global Payroll direct employee, when the organization sends app invitations. Whether the invitation to the app was sent and the employee has not signed up yet", "type": "boolean" }, "name": { "description": "The name associated with the onboarding", "type": "string" }, "overview": { "description": "Only with `include_overview`. The onboarding overview of the contract, as `GET /onboarding/tracker/{tracker_id}` returns it in `data`", "oneOf": [ { "$ref": "#/components/schemas/OnboardingTrackerGetResponsesContentApplicationJsonSchemaDataItemsOverview" }, { "type": "null" } ] }, "pending_steps": { "description": "Only with `include_overview`. The labels of the checklist steps not done yet, comma separated", "type": "string" }, "profile": { "$ref": "#/components/schemas/OnboardingTrackerGetResponsesContentApplicationJsonSchemaDataItemsProfile", "description": "Only when the worker has an avatar" }, "progress": { "$ref": "#/components/schemas/OnboardingTrackerGetResponsesContentApplicationJsonSchemaDataItemsProgress", "description": "The progress state of the onboarding" }, "start_date": { "description": "The start date of the contract", "format": "date", "type": [ "string", "null" ] }, "unique_id": { "description": "A unique identifier for the tracker", "type": "string" }, "worker": { "$ref": "#/components/schemas/OnboardingTrackerGetResponsesContentApplicationJsonSchemaDataItemsWorker", "description": "The worker being onboarded" } }, "title": "OnboardingTrackerGetResponsesContentApplicationJsonSchemaDataItems", "type": "object" }, "OnboardingTrackerGetResponsesContentApplicationJsonSchemaDataItemsAppExperience": { "description": "The app experience of the employee", "properties": { "experience_type": { "description": "The app experience the employee is given, when there is a specific one", "oneOf": [ { "$ref": "#/components/schemas/OnboardingTrackerGetResponsesContentApplicationJsonSchemaDataItemsAppExperienceExperienceType" }, { "type": "null" } ] }, "is_minimal_requirements": { "description": "Indicates if the employee meets minimal requirements", "type": "boolean" } }, "title": "OnboardingTrackerGetResponsesContentApplicationJsonSchemaDataItemsAppExperience", "type": "object" }, "OnboardingTrackerGetResponsesContentApplicationJsonSchemaDataItemsAppExperienceExperienceType": { "description": "The app experience the employee is given, when there is a specific one", "enum": [ "LIGHTWEIGHT" ], "title": "OnboardingTrackerGetResponsesContentApplicationJsonSchemaDataItemsAppExperienceExperienceType", "type": "string" }, "OnboardingTrackerGetResponsesContentApplicationJsonSchemaDataItemsContract": { "description": "The contract associated with the onboarding", "properties": { "effective_date": { "description": "The effective date of the contract. Null for a person without a contract", "format": "date", "type": [ "string", "null" ] }, "eor": { "$ref": "#/components/schemas/OnboardingTrackerGetResponsesContentApplicationJsonSchemaDataItemsContractEor", "description": "Only for an EOR contract" }, "global_payroll": { "$ref": "#/components/schemas/OnboardingTrackerGetResponsesContentApplicationJsonSchemaDataItemsContractGlobalPayroll", "description": "Only for a Global Payroll direct employee" }, "id": { "description": "The unique identifier for the contract. Null for a person without a contract", "type": [ "string", "null" ] }, "is_pwac": { "description": "Whether the worker is a person without a contract", "type": "boolean" }, "offer_letter_id": { "description": "Only for an EOR contract with an offer letter. The identifier of the offer letter", "format": "uuid", "type": "string" } }, "title": "OnboardingTrackerGetResponsesContentApplicationJsonSchemaDataItemsContract", "type": "object" }, "OnboardingTrackerGetResponsesContentApplicationJsonSchemaDataItemsContractEor": { "description": "Only for an EOR contract", "properties": { "has_additional_active_eor_contracts": { "description": "Whether the employee has other active EOR contracts", "type": "boolean" }, "is_unassigned_candidate": { "description": "Whether the candidate still waits to be assigned through the Deel interview process", "type": [ "boolean", "null" ] } }, "title": "OnboardingTrackerGetResponsesContentApplicationJsonSchemaDataItemsContractEor", "type": "object" }, "OnboardingTrackerGetResponsesContentApplicationJsonSchemaDataItemsContractGlobalPayroll": { "description": "Only for a Global Payroll direct employee", "properties": { "has_direct_employee_app": { "description": "Whether the employee has access to the app", "type": "boolean" } }, "title": "OnboardingTrackerGetResponsesContentApplicationJsonSchemaDataItemsContractGlobalPayroll", "type": "object" }, "OnboardingTrackerGetResponsesContentApplicationJsonSchemaDataItemsContractsItems": { "properties": { "contract_oid": { "description": "The unique identifier for the contract", "type": [ "string", "null" ] }, "entity": { "description": "The legal entity the contract sits under. Null when there is none", "oneOf": [ { "$ref": "#/components/schemas/OnboardingTrackerGetResponsesContentApplicationJsonSchemaDataItemsContractsItemsEntity" }, { "type": "null" } ] }, "is_attention_needed": { "description": "Whether the onboarding on this contract is overdue or at risk", "type": "boolean" }, "is_main": { "description": "Whether this is the main contract of the worker: the most urgent status, then a new contract before a person without a contract, then the latest start date, then the latest created contract", "type": "boolean" }, "is_pwac": { "description": "Whether the contract is the placeholder contract of a person without a contract", "type": "boolean" }, "job_title": { "description": "The job title on the contract", "type": [ "string", "null" ] }, "lifecycle_status": { "$ref": "#/components/schemas/OnboardingTrackerGetResponsesContentApplicationJsonSchemaDataItemsContractsItemsLifecycleStatus", "description": "Lifecycle status of this contract, the same value the People list shows for it" }, "start_date": { "description": "The start date of the contract", "format": "date", "type": [ "string", "null" ] }, "status": { "$ref": "#/components/schemas/OnboardingTrackerGetResponsesContentApplicationJsonSchemaDataItemsContractsItemsStatus", "description": "Current status of the onboarding on this contract" }, "tracker_id": { "description": "The tracker identifier that loads this contract", "type": "string" }, "worker_type": { "$ref": "#/components/schemas/OnboardingTrackerGetResponsesContentApplicationJsonSchemaDataItemsContractsItemsWorkerType", "description": "The worker type of the contract, as the hiring_types filter takes it" } }, "title": "OnboardingTrackerGetResponsesContentApplicationJsonSchemaDataItemsContractsItems", "type": "object" }, "OnboardingTrackerGetResponsesContentApplicationJsonSchemaDataItemsContractsItemsEntity": { "description": "The legal entity the contract sits under. Null when there is none", "properties": { "id": { "description": "The unique identifier for the legal entity", "type": "string" }, "name": { "description": "The name of the legal entity. A Deel entity that a contractor of record works under ends in (COR)", "type": [ "string", "null" ] } }, "title": "OnboardingTrackerGetResponsesContentApplicationJsonSchemaDataItemsContractsItemsEntity", "type": "object" }, "OnboardingTrackerGetResponsesContentApplicationJsonSchemaDataItemsContractsItemsLifecycleStatus": { "description": "Lifecycle status of this contract, the same value the People list shows for it", "enum": [ "DRAFT", "IN_REVIEW", "QUOTE_REQUIRES_CHANGES", "PENDING_INVITE", "INVITED", "ONBOARDING", "ONBOARDING_AT_RISK", "ONBOARDING_OVERDUE", "OFFBOARDING", "ONBOARDED" ], "title": "OnboardingTrackerGetResponsesContentApplicationJsonSchemaDataItemsContractsItemsLifecycleStatus", "type": "string" }, "OnboardingTrackerGetResponsesContentApplicationJsonSchemaDataItemsContractsItemsStatus": { "description": "Current status of the onboarding on this contract", "enum": [ "ONBOARDING_AT_RISK", "ONBOARDING_OVERDUE", "INVITED", "ONBOARDING", "READY_TO_START", "INACTIVE", "PENDING_INVITE", "ACTIVE", "DRAFT", "OFFBOARDING", "QUOTE_REQUIRES_CHANGES", "IN_REVIEW", "IN_OFFER_STAGE" ], "title": "OnboardingTrackerGetResponsesContentApplicationJsonSchemaDataItemsContractsItemsStatus", "type": "string" }, "OnboardingTrackerGetResponsesContentApplicationJsonSchemaDataItemsContractsItemsWorkerType": { "description": "The worker type of the contract, as the hiring_types filter takes it", "enum": [ "contractor", "direct_employee", "hris_direct_employee", "hris_direct_contractor", "eor", "peo", "person_without_contract" ], "title": "OnboardingTrackerGetResponsesContentApplicationJsonSchemaDataItemsContractsItemsWorkerType", "type": "string" }, "OnboardingTrackerGetResponsesContentApplicationJsonSchemaDataItemsCountry": { "description": "The country of the contract", "properties": { "code": { "description": "ISO 3166-1 alpha-2 country code", "type": [ "string", "null" ] }, "name": { "description": "The country display name", "type": [ "string", "null" ] } }, "title": "OnboardingTrackerGetResponsesContentApplicationJsonSchemaDataItemsCountry", "type": "object" }, "OnboardingTrackerGetResponsesContentApplicationJsonSchemaDataItemsHrisProfile": { "description": "The profile associated with the onboarding", "properties": { "oid": { "description": "The unique identifier for the HRIS profile", "type": "string" }, "work_email": { "description": "The work email of the employee", "type": [ "string", "null" ] } }, "title": "OnboardingTrackerGetResponsesContentApplicationJsonSchemaDataItemsHrisProfile", "type": "object" }, "OnboardingTrackerGetResponsesContentApplicationJsonSchemaDataItemsOverview": { "description": "Only with `include_overview`. The onboarding overview of the contract, as `GET /onboarding/tracker/{tracker_id}` returns it in `data`", "properties": { "actions": { "description": "Actions the caller can take on this onboarding", "items": { "$ref": "#/components/schemas/OnboardingTrackerGetResponsesContentApplicationJsonSchemaDataItemsOverviewActionsItems" }, "type": "array" }, "app_experience": { "$ref": "#/components/schemas/OnboardingTrackerGetResponsesContentApplicationJsonSchemaDataItemsOverviewAppExperience", "description": "The app experience of the employee" }, "banner": { "description": "The one thing worth saying about this worker, or null when there is nothing", "oneOf": [ { "$ref": "#/components/schemas/OnboardingTrackerGetResponsesContentApplicationJsonSchemaDataItemsOverviewBanner" }, { "type": "null" } ] }, "checklist": { "$ref": "#/components/schemas/OnboardingTrackerGetResponsesContentApplicationJsonSchemaDataItemsOverviewChecklist", "description": "List of checklist steps" }, "contract": { "$ref": "#/components/schemas/OnboardingTrackerGetResponsesContentApplicationJsonSchemaDataItemsOverviewContract", "description": "Information about the contract" }, "contracts": { "description": "Every contract of the worker the caller can see, the main one first", "items": { "$ref": "#/components/schemas/OnboardingTrackerGetResponsesContentApplicationJsonSchemaDataItemsOverviewContractsItems" }, "type": "array" }, "hiring_type": { "description": "Hiring type (e.g., contractor)", "type": "string" }, "hris_profile": { "description": "Employee HRIS profile information", "oneOf": [ { "$ref": "#/components/schemas/OnboardingTrackerGetResponsesContentApplicationJsonSchemaDataItemsOverviewHrisProfile" }, { "type": "null" } ] }, "profile": { "description": "Employee profile information", "oneOf": [ { "$ref": "#/components/schemas/OnboardingTrackerGetResponsesContentApplicationJsonSchemaDataItemsOverviewProfile" }, { "type": "null" } ] }, "progress": { "$ref": "#/components/schemas/OnboardingTrackerGetResponsesContentApplicationJsonSchemaDataItemsOverviewProgress", "description": "Progress of the onboarding process" }, "stepper": { "description": "List of stepper actions taken during the onboarding process", "items": { "$ref": "#/components/schemas/OnboardingTrackerGetResponsesContentApplicationJsonSchemaDataItemsOverviewStepperItems" }, "type": "array" }, "summary": { "description": "Summary of the onboarding process", "items": { "$ref": "#/components/schemas/OnboardingTrackerGetResponsesContentApplicationJsonSchemaDataItemsOverviewSummaryItems" }, "type": "array" } }, "title": "OnboardingTrackerGetResponsesContentApplicationJsonSchemaDataItemsOverview", "type": "object" }, "OnboardingTrackerGetResponsesContentApplicationJsonSchemaDataItemsOverviewActionsItems": { "properties": { "available": { "description": "Whether the action can be taken now", "type": "boolean" }, "data": { "additionalProperties": { "description": "Any type" }, "description": "Details the action needs, which vary by action", "type": "object" }, "last_execution_at": { "description": "When the action was last taken, if ever", "format": "date-time", "type": [ "string", "null" ] }, "type": { "$ref": "#/components/schemas/OnboardingTrackerGetResponsesContentApplicationJsonSchemaDataItemsOverviewActionsItemsType", "description": "The action" } }, "title": "OnboardingTrackerGetResponsesContentApplicationJsonSchemaDataItemsOverviewActionsItems", "type": "object" }, "OnboardingTrackerGetResponsesContentApplicationJsonSchemaDataItemsOverviewActionsItemsType": { "description": "The action", "enum": [ "MANAGE_INVITE", "RESEND_INVITE", "SEND_REMINDER", "CANCEL_CONTRACT", "END_CONTRACT", "GET_HELP" ], "title": "OnboardingTrackerGetResponsesContentApplicationJsonSchemaDataItemsOverviewActionsItemsType", "type": "string" }, "OnboardingTrackerGetResponsesContentApplicationJsonSchemaDataItemsOverviewAppExperience": { "description": "The app experience of the employee", "properties": { "experience_type": { "description": "The app experience the employee is given, when there is a specific one", "oneOf": [ { "$ref": "#/components/schemas/OnboardingTrackerGetResponsesContentApplicationJsonSchemaDataItemsOverviewAppExperienceExperienceType" }, { "type": "null" } ] }, "is_minimal_requirements": { "description": "Whether the worker gets the minimal app experience, as a person without a contract does", "type": "boolean" } }, "title": "OnboardingTrackerGetResponsesContentApplicationJsonSchemaDataItemsOverviewAppExperience", "type": "object" }, "OnboardingTrackerGetResponsesContentApplicationJsonSchemaDataItemsOverviewAppExperienceExperienceType": { "description": "The app experience the employee is given, when there is a specific one", "enum": [ "LIGHTWEIGHT" ], "title": "OnboardingTrackerGetResponsesContentApplicationJsonSchemaDataItemsOverviewAppExperienceExperienceType", "type": "string" }, "OnboardingTrackerGetResponsesContentApplicationJsonSchemaDataItemsOverviewBanner": { "description": "The one thing worth saying about this worker, or null when there is nothing", "properties": { "action": { "description": "What the client can do about it, when there is something", "oneOf": [ { "$ref": "#/components/schemas/OnboardingTrackerGetResponsesContentApplicationJsonSchemaDataItemsOverviewBannerAction" }, { "type": "null" } ] }, "key": { "$ref": "#/components/schemas/OnboardingTrackerGetResponsesContentApplicationJsonSchemaDataItemsOverviewBannerKey", "description": "What the banner is about" }, "severity": { "$ref": "#/components/schemas/OnboardingTrackerGetResponsesContentApplicationJsonSchemaDataItemsOverviewBannerSeverity", "description": "How serious it is" } }, "title": "OnboardingTrackerGetResponsesContentApplicationJsonSchemaDataItemsOverviewBanner", "type": "object" }, "OnboardingTrackerGetResponsesContentApplicationJsonSchemaDataItemsOverviewBannerAction": { "description": "What the client can do about it, when there is something", "enum": [ "CANCEL_CONTRACT", "REVIEW_EMPLOYEE_AGREEMENT", "PAY_DEPOSIT", "VIEW_CONTRACT" ], "title": "OnboardingTrackerGetResponsesContentApplicationJsonSchemaDataItemsOverviewBannerAction", "type": "string" }, "OnboardingTrackerGetResponsesContentApplicationJsonSchemaDataItemsOverviewBannerKey": { "description": "What the banner is about", "enum": [ "DOCUMENT_REJECTED", "ONBOARDING_OVERDUE", "ONBOARDING_AT_RISK", "START_DATE_PASSED_WITHOUT_INVITE", "EMPLOYEE_AGREEMENT_AWAITING_REVIEW", "AWAITING_DEPOSIT_PAYMENT", "CONTRACT_REDLINING", "CONTRACT_AMENDMENTS_IN_PROGRESS", "QUOTE_REQUIRES_CHANGES", "DRAFT_QUOTE", "CONTRACT_DRAFT", "QUOTE_READY_TO_ACCEPT", "NO_APP_ACCESS", "NO_ONBOARDING_STEPS", "IN_REVIEW_WITH_DEEL", "IN_OFFER_STAGE", "PENDING_INVITE", "INVITED", "ONBOARDING" ], "title": "OnboardingTrackerGetResponsesContentApplicationJsonSchemaDataItemsOverviewBannerKey", "type": "string" }, "OnboardingTrackerGetResponsesContentApplicationJsonSchemaDataItemsOverviewBannerSeverity": { "description": "How serious it is", "enum": [ "ERROR", "WARNING", "INFO" ], "title": "OnboardingTrackerGetResponsesContentApplicationJsonSchemaDataItemsOverviewBannerSeverity", "type": "string" }, "OnboardingTrackerGetResponsesContentApplicationJsonSchemaDataItemsOverviewChecklist": { "description": "List of checklist steps", "properties": { "steps": { "description": "List of checklist steps", "items": { "$ref": "#/components/schemas/OnboardingTrackerGetResponsesContentApplicationJsonSchemaDataItemsOverviewChecklistStepsItems" }, "type": "array" }, "summary": { "$ref": "#/components/schemas/OnboardingTrackerGetResponsesContentApplicationJsonSchemaDataItemsOverviewChecklistSummary", "description": "How far along the checklist is" } }, "title": "OnboardingTrackerGetResponsesContentApplicationJsonSchemaDataItemsOverviewChecklist", "type": "object" }, "OnboardingTrackerGetResponsesContentApplicationJsonSchemaDataItemsOverviewChecklistStepsItems": { "description": "Checklist step information", "properties": { "category": { "description": "Heading the step sits under", "type": [ "string", "null" ] }, "category_key": { "description": "Stable identifier of the heading, which keeps its value when the heading is renamed", "type": [ "string", "null" ] }, "completed_at": { "description": "Completion timestamp of the checklist step", "format": "date-time", "type": [ "string", "null" ] }, "data": { "additionalProperties": { "description": "Any type" }, "description": "Details of the step, which vary by step", "type": "object" }, "description": { "description": "What the step asks of the worker", "type": "string" }, "display_key": { "description": "Stable identifier of the step, the same across every worker type. Null when the step has no catalogue entry", "type": [ "string", "null" ] }, "due_date": { "description": "When the step is due, when the source carries one", "format": "date-time", "type": [ "string", "null" ] }, "group": { "$ref": "#/components/schemas/OnboardingTrackerGetResponsesContentApplicationJsonSchemaDataItemsOverviewChecklistStepsItemsGroup", "description": "Whether the worker still owes the step" }, "label": { "description": "The label for the checklist step", "type": "string" }, "ordinal": { "description": "Position of the step in the onboarding sequence, starting at one", "type": "integer" }, "reject_reason": { "description": "Reason for rejecting the checklist step (It may contain HTML elements)", "type": "string" }, "state": { "$ref": "#/components/schemas/OnboardingTrackerGetResponsesContentApplicationJsonSchemaDataItemsOverviewChecklistStepsItemsState", "description": "State of the step, reported the same way for every worker type" }, "status": { "description": "Status of the checklist step", "type": "string" }, "type": { "description": "The type of checklist step", "type": "string" } }, "title": "OnboardingTrackerGetResponsesContentApplicationJsonSchemaDataItemsOverviewChecklistStepsItems", "type": "object" }, "OnboardingTrackerGetResponsesContentApplicationJsonSchemaDataItemsOverviewChecklistStepsItemsGroup": { "description": "Whether the worker still owes the step", "enum": [ "COMPLETED", "OUTSTANDING" ], "title": "OnboardingTrackerGetResponsesContentApplicationJsonSchemaDataItemsOverviewChecklistStepsItemsGroup", "type": "string" }, "OnboardingTrackerGetResponsesContentApplicationJsonSchemaDataItemsOverviewChecklistStepsItemsState": { "description": "State of the step, reported the same way for every worker type", "enum": [ "NOT_STARTED", "IN_PROGRESS", "IN_REVIEW", "COMPLETED", "OVERDUE" ], "title": "OnboardingTrackerGetResponsesContentApplicationJsonSchemaDataItemsOverviewChecklistStepsItemsState", "type": "string" }, "OnboardingTrackerGetResponsesContentApplicationJsonSchemaDataItemsOverviewChecklistSummary": { "description": "How far along the checklist is", "properties": { "completed": { "description": "Number of completed steps", "type": "integer" }, "outstanding": { "description": "Number of steps the worker still owes", "type": "integer" }, "total": { "description": "Number of checklist steps", "type": "integer" } }, "title": "OnboardingTrackerGetResponsesContentApplicationJsonSchemaDataItemsOverviewChecklistSummary", "type": "object" }, "OnboardingTrackerGetResponsesContentApplicationJsonSchemaDataItemsOverviewContract": { "description": "Information about the contract", "properties": { "client_signed_at": { "description": "Timestamp when the client signed the contract", "format": "date-time", "type": [ "string", "null" ] }, "completion_date": { "description": "The completion date of the contract, if applicable", "format": "date-time", "type": [ "string", "null" ] }, "contractor_signed_at": { "description": "Timestamp when the contractor signed the contract", "format": "date-time", "type": [ "string", "null" ] }, "created_at": { "description": "Contract creation timestamp", "format": "date-time", "type": "string" }, "employee_agreement": { "description": "Information about the Employment Agreement", "oneOf": [ { "$ref": "#/components/schemas/OnboardingTrackerGetResponsesContentApplicationJsonSchemaDataItemsOverviewContractEmployeeAgreement" }, { "type": "null" } ] }, "first_early_invoice": { "description": "Applicable only for EOR contracts. First early invoice (EOR funding statement) for the contract, if any", "oneOf": [ { "$ref": "#/components/schemas/OnboardingTrackerGetResponsesContentApplicationJsonSchemaDataItemsOverviewContractFirstEarlyInvoice" }, { "type": "null" } ] }, "first_sign": { "description": "The first sign (either 'client' or 'contractor')", "type": [ "string", "null" ] }, "id": { "description": "Unique contract ID", "type": "string" }, "invited_contractor_email": { "description": "Email of the invited contractor", "format": "email", "type": [ "string", "null" ] }, "is_pwac": { "description": "Whether the worker is a person without a contract", "type": "boolean" }, "name": { "description": "Contract name", "type": "string" }, "oid": { "description": "Contract OID", "type": "string" }, "status": { "description": "Contract status (e.g., in_progress)", "type": [ "string", "null" ] } }, "title": "OnboardingTrackerGetResponsesContentApplicationJsonSchemaDataItemsOverviewContract", "type": "object" }, "OnboardingTrackerGetResponsesContentApplicationJsonSchemaDataItemsOverviewContractEmployeeAgreement": { "description": "Information about the Employment Agreement", "properties": { "phase": { "description": "Signing-lifecycle phase that produced the current Employment Agreement PDF. Can be null if the EA has not yet been generated", "oneOf": [ { "$ref": "#/components/schemas/OnboardingTrackerGetResponsesContentApplicationJsonSchemaDataItemsOverviewContractEmployeeAgreementPhase" }, { "type": "null" } ] }, "status": { "description": "Status of the Employment Agreement. Can be null if the EA has not yet been generated", "type": [ "string", "null" ] }, "version_hash": { "description": "Version of the Employment Agreement. Can be null if the EA has not yet been generated", "type": [ "string", "null" ] } }, "title": "OnboardingTrackerGetResponsesContentApplicationJsonSchemaDataItemsOverviewContractEmployeeAgreement", "type": "object" }, "OnboardingTrackerGetResponsesContentApplicationJsonSchemaDataItemsOverviewContractEmployeeAgreementPhase": { "description": "Signing-lifecycle phase that produced the current Employment Agreement PDF. Can be null if the EA has not yet been generated", "enum": [ "unsigned", "employee_signed", "countersigned" ], "title": "OnboardingTrackerGetResponsesContentApplicationJsonSchemaDataItemsOverviewContractEmployeeAgreementPhase", "type": "string" }, "OnboardingTrackerGetResponsesContentApplicationJsonSchemaDataItemsOverviewContractFirstEarlyInvoice": { "description": "Applicable only for EOR contracts. First early invoice (EOR funding statement) for the contract, if any", "properties": { "amount": { "description": "Invoice amount", "type": "string" }, "currency": { "description": "Currency code for the invoice amount", "type": "string" }, "description": { "description": "Invoice description", "type": "string" }, "due_date": { "description": "Due date for the invoice", "format": "date-time", "type": [ "string", "null" ] }, "id": { "description": "Unique invoice ID", "type": "string" }, "paid_at": { "description": "Timestamp when the invoice was paid, if applicable", "format": "date-time", "type": [ "string", "null" ] }, "status": { "$ref": "#/components/schemas/OnboardingTrackerGetResponsesContentApplicationJsonSchemaDataItemsOverviewContractFirstEarlyInvoiceStatus", "description": "Status of the invoice" } }, "title": "OnboardingTrackerGetResponsesContentApplicationJsonSchemaDataItemsOverviewContractFirstEarlyInvoice", "type": "object" }, "OnboardingTrackerGetResponsesContentApplicationJsonSchemaDataItemsOverviewContractFirstEarlyInvoiceStatus": { "description": "Status of the invoice", "enum": [ "OPEN", "PENDING", "SKIPPED", "PREPROCESSING", "PROCESSING", "CREDITED", "PROCESSED", "PAID", "FAILED", "CANCELLED", "REFUNDED", "UNPAYABLE", "AWAITING_PAYMENT", "open", "pending", "skipped", "preprocessing", "processing", "credited", "processed", "paid", "failed", "cancelled", "refunded", "unpayable", "awaiting_payment" ], "title": "OnboardingTrackerGetResponsesContentApplicationJsonSchemaDataItemsOverviewContractFirstEarlyInvoiceStatus", "type": "string" }, "OnboardingTrackerGetResponsesContentApplicationJsonSchemaDataItemsOverviewContractsItems": { "properties": { "contract_oid": { "description": "The unique identifier for the contract", "type": [ "string", "null" ] }, "entity": { "description": "The legal entity the contract sits under. Null when there is none", "oneOf": [ { "$ref": "#/components/schemas/OnboardingTrackerGetResponsesContentApplicationJsonSchemaDataItemsOverviewContractsItemsEntity" }, { "type": "null" } ] }, "is_attention_needed": { "description": "Whether the onboarding on this contract is overdue or at risk", "type": "boolean" }, "is_current": { "description": "Whether this is the contract the overview is about", "type": "boolean" }, "is_main": { "description": "Whether this is the main contract of the worker: the most urgent status, then a new contract before a person without a contract, then the latest start date, then the latest created contract", "type": "boolean" }, "is_pwac": { "description": "Whether the contract is the placeholder contract of a person without a contract", "type": "boolean" }, "job_title": { "description": "The job title on the contract", "type": [ "string", "null" ] }, "lifecycle_status": { "$ref": "#/components/schemas/OnboardingTrackerGetResponsesContentApplicationJsonSchemaDataItemsOverviewContractsItemsLifecycleStatus", "description": "Lifecycle status of this contract, the same value the People list shows for it" }, "start_date": { "description": "The start date of the contract", "format": "date", "type": [ "string", "null" ] }, "status": { "$ref": "#/components/schemas/OnboardingTrackerGetResponsesContentApplicationJsonSchemaDataItemsOverviewContractsItemsStatus", "description": "Current status of the onboarding on this contract" }, "tracker_id": { "description": "The tracker identifier that loads this contract", "type": "string" }, "worker_type": { "$ref": "#/components/schemas/OnboardingTrackerGetResponsesContentApplicationJsonSchemaDataItemsOverviewContractsItemsWorkerType", "description": "The worker type of the contract, as the hiring_types filter takes it" } }, "title": "OnboardingTrackerGetResponsesContentApplicationJsonSchemaDataItemsOverviewContractsItems", "type": "object" }, "OnboardingTrackerGetResponsesContentApplicationJsonSchemaDataItemsOverviewContractsItemsEntity": { "description": "The legal entity the contract sits under. Null when there is none", "properties": { "id": { "description": "The unique identifier for the legal entity", "type": "string" }, "name": { "description": "The name of the legal entity. A Deel entity that a contractor of record works under ends in (COR)", "type": [ "string", "null" ] } }, "title": "OnboardingTrackerGetResponsesContentApplicationJsonSchemaDataItemsOverviewContractsItemsEntity", "type": "object" }, "OnboardingTrackerGetResponsesContentApplicationJsonSchemaDataItemsOverviewContractsItemsLifecycleStatus": { "description": "Lifecycle status of this contract, the same value the People list shows for it", "enum": [ "DRAFT", "IN_REVIEW", "QUOTE_REQUIRES_CHANGES", "PENDING_INVITE", "INVITED", "ONBOARDING", "ONBOARDING_AT_RISK", "ONBOARDING_OVERDUE", "OFFBOARDING", "ONBOARDED" ], "title": "OnboardingTrackerGetResponsesContentApplicationJsonSchemaDataItemsOverviewContractsItemsLifecycleStatus", "type": "string" }, "OnboardingTrackerGetResponsesContentApplicationJsonSchemaDataItemsOverviewContractsItemsStatus": { "description": "Current status of the onboarding on this contract", "enum": [ "ONBOARDING_AT_RISK", "ONBOARDING_OVERDUE", "INVITED", "ONBOARDING", "READY_TO_START", "INACTIVE", "PENDING_INVITE", "ACTIVE", "DRAFT", "OFFBOARDING", "QUOTE_REQUIRES_CHANGES", "IN_REVIEW", "IN_OFFER_STAGE" ], "title": "OnboardingTrackerGetResponsesContentApplicationJsonSchemaDataItemsOverviewContractsItemsStatus", "type": "string" }, "OnboardingTrackerGetResponsesContentApplicationJsonSchemaDataItemsOverviewContractsItemsWorkerType": { "description": "The worker type of the contract, as the hiring_types filter takes it", "enum": [ "contractor", "direct_employee", "hris_direct_employee", "hris_direct_contractor", "eor", "peo", "person_without_contract" ], "title": "OnboardingTrackerGetResponsesContentApplicationJsonSchemaDataItemsOverviewContractsItemsWorkerType", "type": "string" }, "OnboardingTrackerGetResponsesContentApplicationJsonSchemaDataItemsOverviewHrisProfile": { "description": "Employee HRIS profile information", "properties": { "direct_manager": { "description": "The direct manager of the employee, when one is set", "oneOf": [ { "$ref": "#/components/schemas/OnboardingTrackerGetResponsesContentApplicationJsonSchemaDataItemsOverviewHrisProfileDirectManager" }, { "type": "null" } ] }, "email": { "description": "Email of the HRIS profile", "format": "email", "type": [ "string", "null" ] }, "invitations": { "description": "Invitations to the employee that are not sent yet", "items": { "$ref": "#/components/schemas/OnboardingTrackerGetResponsesContentApplicationJsonSchemaDataItemsOverviewHrisProfileInvitationsItems" }, "type": "array" }, "name": { "description": "HRIS Profile name", "type": [ "string", "null" ] }, "oid": { "description": "HRIS Profile OID", "type": [ "string", "null" ] }, "work_email": { "description": "Work email of the HRIS profile", "format": "email", "type": [ "string", "null" ] } }, "title": "OnboardingTrackerGetResponsesContentApplicationJsonSchemaDataItemsOverviewHrisProfile", "type": "object" }, "OnboardingTrackerGetResponsesContentApplicationJsonSchemaDataItemsOverviewHrisProfileDirectManager": { "description": "The direct manager of the employee, when one is set", "properties": { "job_title": { "description": "Job title of the manager", "type": [ "string", "null" ] }, "name": { "description": "Name of the manager", "type": [ "string", "null" ] }, "oid": { "description": "HRIS profile OID of the manager", "type": "string" }, "pic_url": { "description": "URL of the manager profile picture", "type": [ "string", "null" ] }, "work_email": { "description": "Work email of the manager", "format": "email", "type": [ "string", "null" ] } }, "title": "OnboardingTrackerGetResponsesContentApplicationJsonSchemaDataItemsOverviewHrisProfileDirectManager", "type": "object" }, "OnboardingTrackerGetResponsesContentApplicationJsonSchemaDataItemsOverviewHrisProfileInvitationsItems": { "properties": { "oid": { "description": "Invitation OID", "type": "string" }, "send_at": { "description": "When the invitation is or was sent", "format": "date-time", "type": [ "string", "null" ] }, "status": { "$ref": "#/components/schemas/OnboardingTrackerGetResponsesContentApplicationJsonSchemaDataItemsOverviewHrisProfileInvitationsItemsStatus", "description": "Status of the invitation" }, "timezone": { "description": "Timezone the invitation is scheduled in", "type": [ "string", "null" ] } }, "title": "OnboardingTrackerGetResponsesContentApplicationJsonSchemaDataItemsOverviewHrisProfileInvitationsItems", "type": "object" }, "OnboardingTrackerGetResponsesContentApplicationJsonSchemaDataItemsOverviewHrisProfileInvitationsItemsStatus": { "description": "Status of the invitation", "enum": [ "SENT", "DISABLED", "SUSPENDED", "SCHEDULED", "FAILED" ], "title": "OnboardingTrackerGetResponsesContentApplicationJsonSchemaDataItemsOverviewHrisProfileInvitationsItemsStatus", "type": "string" }, "OnboardingTrackerGetResponsesContentApplicationJsonSchemaDataItemsOverviewProfile": { "description": "Employee profile information", "properties": { "country": { "description": "Country code", "type": [ "string", "null" ] }, "email": { "description": "Email of the profile", "format": "email", "type": [ "string", "null" ] }, "id": { "description": "Internal ID of the profile", "type": "integer" }, "last_login": { "description": "Last login timestamp", "format": "date-time", "type": [ "string", "null" ] }, "name": { "description": "Name associated with the profile", "type": "string" }, "paid_invoices": { "description": "A paid invoice on the contract, if any, at most one. Only for a contractor, empty for other worker types", "items": { "$ref": "#/components/schemas/OnboardingTrackerGetResponsesContentApplicationJsonSchemaDataItemsOverviewProfilePaidInvoicesItems" }, "type": "array" }, "pic_url": { "description": "URL of the profile picture", "type": [ "string", "null" ] }, "previously_onboarded": { "description": "Indicates if the contractor has previously onboarded", "type": "boolean" } }, "title": "OnboardingTrackerGetResponsesContentApplicationJsonSchemaDataItemsOverviewProfile", "type": "object" }, "OnboardingTrackerGetResponsesContentApplicationJsonSchemaDataItemsOverviewProfilePaidInvoicesItems": { "properties": { "id": { "description": "Internal ID of the invoice", "type": "integer" }, "status": { "description": "Status of the invoice", "type": "string" } }, "title": "OnboardingTrackerGetResponsesContentApplicationJsonSchemaDataItemsOverviewProfilePaidInvoicesItems", "type": "object" }, "OnboardingTrackerGetResponsesContentApplicationJsonSchemaDataItemsOverviewProgress": { "description": "Progress of the onboarding process", "properties": { "is_action_required_from_client": { "description": "Indicates if action is required from the client", "type": "boolean" }, "reference_date": { "description": "Reference date for the progress", "format": "date-time", "type": [ "string", "null" ] }, "reference_date_timezone": { "description": "Timezone of the reference date", "type": [ "string", "null" ] }, "status": { "description": "Current status of the onboarding process (e.g., ACTIVE)", "type": "string" }, "sub_status": { "description": "Finer state within the status, when there is one", "oneOf": [ { "$ref": "#/components/schemas/OnboardingTrackerGetResponsesContentApplicationJsonSchemaDataItemsOverviewProgressSubStatus" }, { "type": "null" } ] }, "subject_to_overdue": { "description": "Indicates if the onboarding is subject to overdue", "type": "boolean" } }, "title": "OnboardingTrackerGetResponsesContentApplicationJsonSchemaDataItemsOverviewProgress", "type": "object" }, "OnboardingTrackerGetResponsesContentApplicationJsonSchemaDataItemsOverviewProgressSubStatus": { "description": "Finer state within the status, when there is one", "enum": [ "PENDING_INVITE", "INVITED", "ONBOARDING", "AWAITING_CLIENT_REVIEW", "CANCELLED", "REJECTED" ], "title": "OnboardingTrackerGetResponsesContentApplicationJsonSchemaDataItemsOverviewProgressSubStatus", "type": "string" }, "OnboardingTrackerGetResponsesContentApplicationJsonSchemaDataItemsOverviewStepperItems": { "description": "Stepper action information", "properties": { "completed_at": { "description": "Completion timestamp of the stepper action", "format": "date-time", "type": [ "string", "null" ] }, "data": { "oneOf": [ { "$ref": "#/components/schemas/OnboardingTrackerGetResponsesContentApplicationJsonSchemaDataItemsOverviewStepperItemsData" }, { "type": "null" } ] }, "type": { "description": "Type of the stepper action", "type": "string" } }, "title": "OnboardingTrackerGetResponsesContentApplicationJsonSchemaDataItemsOverviewStepperItems", "type": "object" }, "OnboardingTrackerGetResponsesContentApplicationJsonSchemaDataItemsOverviewStepperItemsData": { "properties": { "completed": { "description": "Checklist steps completed, on the checklist progress step", "type": "integer" }, "emails": { "description": "List of emails sent during the stepper process", "items": { "$ref": "#/components/schemas/OnboardingTrackerGetResponsesContentApplicationJsonSchemaDataItemsOverviewStepperItemsDataEmailsItems" }, "type": "array" }, "next_reminder_date": { "description": "Next reminder date, if applicable", "format": "date-time", "type": [ "string", "null" ] }, "onboarding_due_date": { "description": "When onboarding is due, on the checklist progress step", "format": "date-time", "type": [ "string", "null" ] }, "remaining": { "description": "Checklist steps remaining, on the checklist progress step", "type": "integer" }, "total": { "description": "Checklist steps in total, on the checklist progress step", "type": "integer" } }, "title": "OnboardingTrackerGetResponsesContentApplicationJsonSchemaDataItemsOverviewStepperItemsData", "type": "object" }, "OnboardingTrackerGetResponsesContentApplicationJsonSchemaDataItemsOverviewStepperItemsDataEmailsItems": { "properties": { "meta": { "$ref": "#/components/schemas/OnboardingTrackerGetResponsesContentApplicationJsonSchemaDataItemsOverviewStepperItemsDataEmailsItemsMeta", "description": "Email metadata" } }, "title": "OnboardingTrackerGetResponsesContentApplicationJsonSchemaDataItemsOverviewStepperItemsDataEmailsItems", "type": "object" }, "OnboardingTrackerGetResponsesContentApplicationJsonSchemaDataItemsOverviewStepperItemsDataEmailsItemsMeta": { "description": "Email metadata", "properties": { "email": { "description": "Email address", "format": "email", "type": "string" }, "sent_at": { "description": "Timestamp when the email was sent", "format": "date-time", "type": "string" }, "type": { "description": "Type of email", "type": "string" } }, "title": "OnboardingTrackerGetResponsesContentApplicationJsonSchemaDataItemsOverviewStepperItemsDataEmailsItemsMeta", "type": "object" }, "OnboardingTrackerGetResponsesContentApplicationJsonSchemaDataItemsOverviewSummaryItems": { "description": "Summary item information", "properties": { "data": { "$ref": "#/components/schemas/OnboardingTrackerGetResponsesContentApplicationJsonSchemaDataItemsOverviewSummaryItemsData", "description": "Additional data about the summary item" }, "name": { "description": "Name of the summary item", "type": "string" }, "type": { "description": "Type of the summary item", "type": "string" }, "value": { "$ref": "#/components/schemas/OnboardingTrackerGetResponsesContentApplicationJsonSchemaDataItemsOverviewSummaryItemsValue", "description": "Value of the summary item" } }, "title": "OnboardingTrackerGetResponsesContentApplicationJsonSchemaDataItemsOverviewSummaryItems", "type": "object" }, "OnboardingTrackerGetResponsesContentApplicationJsonSchemaDataItemsOverviewSummaryItemsData": { "description": "Additional data about the summary item", "properties": { "country": { "description": "Country code for location-related summaries", "type": "string" }, "has_withdraw_methods": { "description": "Indicates if withdrawal methods exist", "type": "boolean" }, "timezone": { "description": "Timezone information", "type": "string" } }, "title": "OnboardingTrackerGetResponsesContentApplicationJsonSchemaDataItemsOverviewSummaryItemsData", "type": "object" }, "OnboardingTrackerGetResponsesContentApplicationJsonSchemaDataItemsOverviewSummaryItemsValue": { "description": "Value of the summary item", "oneOf": [ { "type": "string" }, { "format": "double", "type": "number" }, { "type": "boolean" }, { "format": "date-time", "type": "string" }, { "additionalProperties": { "description": "Any type" }, "type": "object" } ], "title": "OnboardingTrackerGetResponsesContentApplicationJsonSchemaDataItemsOverviewSummaryItemsValue" }, "OnboardingTrackerGetResponsesContentApplicationJsonSchemaDataItemsProfile": { "description": "Only when the worker has an avatar", "properties": { "pic_url": { "description": "The avatar URL of the worker, the same value as `worker.avatar_url`", "type": "string" } }, "title": "OnboardingTrackerGetResponsesContentApplicationJsonSchemaDataItemsProfile", "type": "object" }, "OnboardingTrackerGetResponsesContentApplicationJsonSchemaDataItemsProgress": { "description": "The progress state of the onboarding", "properties": { "is_action_required_from_client": { "description": "Whether action is required from the client", "type": [ "boolean", "null" ] }, "lifecycle_status": { "$ref": "#/components/schemas/OnboardingTrackerGetResponsesContentApplicationJsonSchemaDataItemsProgressLifecycleStatus", "description": "Lifecycle status of this contract, the same value the People list shows for it" }, "onboarding_due_date": { "$ref": "#/components/schemas/OnboardingTrackerGetResponsesContentApplicationJsonSchemaDataItemsProgressOnboardingDueDate", "description": "Due date for onboarding" }, "people_list_status": { "description": "Status of the people list", "type": "string" }, "reference_date": { "$ref": "#/components/schemas/OnboardingTrackerGetResponsesContentApplicationJsonSchemaDataItemsProgressReferenceDate", "description": "The reference date determining the onboarding status" }, "reference_date_timezone": { "description": "Timezone of the reference date", "type": [ "string", "null" ] }, "reference_date_type": { "description": "Type of the reference date (e.g., EFFECTIVE_DATE)", "type": [ "string", "null" ] }, "status": { "description": "Current status of the onboarding", "type": "string" }, "steps": { "description": "Onboarding checklist step counts per state. Null when the counts are not available: the worker has no checklist yet, the row is a contractor draft or a draft quote, or the steps could not be read", "oneOf": [ { "$ref": "#/components/schemas/OnboardingTrackerGetResponsesContentApplicationJsonSchemaDataItemsProgressSteps" }, { "type": "null" } ] }, "sub_status": { "description": "Finer state within the status, when there is one", "oneOf": [ { "$ref": "#/components/schemas/OnboardingTrackerGetResponsesContentApplicationJsonSchemaDataItemsProgressSubStatus" }, { "type": "null" } ] }, "subject_to_overdue": { "description": "Whether the onboarding is subject to overdue", "type": "boolean" }, "waiting_on": { "description": "The party whose action the onboarding waits on. Null when nothing is outstanding, which includes a settled onboarding (READY_TO_START, ACTIVE, OFFBOARDING, INACTIVE) with no client action required", "oneOf": [ { "$ref": "#/components/schemas/OnboardingTrackerGetResponsesContentApplicationJsonSchemaDataItemsProgressWaitingOn" }, { "type": "null" } ] } }, "title": "OnboardingTrackerGetResponsesContentApplicationJsonSchemaDataItemsProgress", "type": "object" }, "OnboardingTrackerGetResponsesContentApplicationJsonSchemaDataItemsProgressLifecycleStatus": { "description": "Lifecycle status of this contract, the same value the People list shows for it", "enum": [ "DRAFT", "IN_REVIEW", "QUOTE_REQUIRES_CHANGES", "PENDING_INVITE", "INVITED", "ONBOARDING", "ONBOARDING_AT_RISK", "ONBOARDING_OVERDUE", "OFFBOARDING", "ONBOARDED" ], "title": "OnboardingTrackerGetResponsesContentApplicationJsonSchemaDataItemsProgressLifecycleStatus", "type": "string" }, "OnboardingTrackerGetResponsesContentApplicationJsonSchemaDataItemsProgressOnboardingDueDate": { "description": "Due date for onboarding", "oneOf": [ { "format": "date", "type": "string" }, { "format": "date-time", "type": "string" } ], "title": "OnboardingTrackerGetResponsesContentApplicationJsonSchemaDataItemsProgressOnboardingDueDate" }, "OnboardingTrackerGetResponsesContentApplicationJsonSchemaDataItemsProgressReferenceDate": { "description": "The reference date determining the onboarding status", "oneOf": [ { "format": "date", "type": "string" }, { "format": "date-time", "type": "string" }, { "maxLength": 0, "type": "string" } ], "title": "OnboardingTrackerGetResponsesContentApplicationJsonSchemaDataItemsProgressReferenceDate" }, "OnboardingTrackerGetResponsesContentApplicationJsonSchemaDataItemsProgressSteps": { "description": "Onboarding checklist step counts per state. Null when the counts are not available: the worker has no checklist yet, the row is a contractor draft or a draft quote, or the steps could not be read", "properties": { "completed": { "description": "Completed steps", "type": "integer" }, "in_progress": { "description": "Steps started but not completed", "type": "integer" }, "in_review": { "description": "Steps waiting for a review", "type": "integer" }, "not_started": { "description": "Steps not started yet", "type": "integer" }, "overdue": { "description": "Steps past their due date and not completed", "type": "integer" }, "total": { "description": "Number of checklist steps", "type": "integer" } }, "title": "OnboardingTrackerGetResponsesContentApplicationJsonSchemaDataItemsProgressSteps", "type": "object" }, "OnboardingTrackerGetResponsesContentApplicationJsonSchemaDataItemsProgressSubStatus": { "description": "Finer state within the status, when there is one", "enum": [ "PENDING_INVITE", "INVITED", "ONBOARDING", "AWAITING_CLIENT_REVIEW", "CANCELLED", "REJECTED" ], "title": "OnboardingTrackerGetResponsesContentApplicationJsonSchemaDataItemsProgressSubStatus", "type": "string" }, "OnboardingTrackerGetResponsesContentApplicationJsonSchemaDataItemsProgressWaitingOn": { "description": "The party whose action the onboarding waits on. Null when nothing is outstanding, which includes a settled onboarding (READY_TO_START, ACTIVE, OFFBOARDING, INACTIVE) with no client action required", "enum": [ "WORKER", "CLIENT", "DEEL" ], "title": "OnboardingTrackerGetResponsesContentApplicationJsonSchemaDataItemsProgressWaitingOn", "type": "string" }, "OnboardingTrackerGetResponsesContentApplicationJsonSchemaDataItemsWorker": { "description": "The worker being onboarded", "properties": { "avatar_url": { "description": "The avatar URL of the worker", "type": [ "string", "null" ] }, "id": { "description": "The HRIS profile identifier of the worker. Null for a draft quote", "type": [ "string", "null" ] }, "is_contractor_of_record": { "description": "Whether a contractor is engaged through Contractor of Record", "type": "boolean" }, "is_entity_contractor": { "description": "Whether a contractor is engaged through a company rather than as an individual", "type": "boolean" }, "job_title": { "description": "The job title on the contract", "type": [ "string", "null" ] }, "name": { "description": "The full name of the worker", "type": [ "string", "null" ] } }, "title": "OnboardingTrackerGetResponsesContentApplicationJsonSchemaDataItemsWorker", "type": "object" }, "OnboardingTrackerGetResponsesContentApplicationJsonSchemaErrors": { "description": "The errors, as an object for a combination of parameters the endpoint rejects, or as a list", "oneOf": [ { "$ref": "#/components/schemas/OnboardingTrackerGetResponsesContentApplicationJsonSchemaErrors0" }, { "$ref": "#/components/schemas/OnboardingTrackerGetResponsesContentApplicationJsonSchemaErrors1" } ], "title": "OnboardingTrackerGetResponsesContentApplicationJsonSchemaErrors" }, "OnboardingTrackerGetResponsesContentApplicationJsonSchemaErrors0": { "description": "The parameters the endpoint rejects", "properties": { "errors": { "description": "One item per query parameter that failed", "items": { "$ref": "#/components/schemas/OnboardingTrackerGetResponsesContentApplicationJsonSchemaErrorsOneOf0ErrorsItems" }, "type": "array" } }, "title": "OnboardingTrackerGetResponsesContentApplicationJsonSchemaErrors0", "type": "object" }, "OnboardingTrackerGetResponsesContentApplicationJsonSchemaErrors1": { "description": "The parameters outside their declared values, format or length, or the cursor error", "items": { "$ref": "#/components/schemas/OnboardingTrackerGetResponsesContentApplicationJsonSchemaErrorsOneOf1Items" }, "title": "OnboardingTrackerGetResponsesContentApplicationJsonSchemaErrors1", "type": "array" }, "OnboardingTrackerGetResponsesContentApplicationJsonSchemaErrorsOneOf0ErrorsItems": { "properties": { "context": { "additionalProperties": { "description": "Any type" }, "description": "Details of the failure, which vary by rule", "type": "object" }, "key": { "description": "The parameter that failed, with the position for a list", "type": "string" }, "message": { "description": "What is wrong with the value", "type": "string" }, "path": { "description": "The parameter that failed, as a path", "items": { "$ref": "#/components/schemas/OnboardingTrackerGetResponsesContentApplicationJsonSchemaErrorsOneOf0ErrorsItemsPathItems" }, "type": "array" }, "type": { "description": "The validation rule that failed", "type": "string" } }, "title": "OnboardingTrackerGetResponsesContentApplicationJsonSchemaErrorsOneOf0ErrorsItems", "type": "object" }, "OnboardingTrackerGetResponsesContentApplicationJsonSchemaErrorsOneOf0ErrorsItemsPathItems": { "oneOf": [ { "type": "string" }, { "type": "integer" } ], "title": "OnboardingTrackerGetResponsesContentApplicationJsonSchemaErrorsOneOf0ErrorsItemsPathItems" }, "OnboardingTrackerGetResponsesContentApplicationJsonSchemaErrorsOneOf1Items": { "properties": { "code": { "description": "Machine-readable error code", "type": "string" }, "details": { "additionalProperties": { "description": "Any type" }, "description": "The parameter that failed validation", "type": "object" }, "message": { "description": "Error response", "type": "string" }, "path": { "description": "Where the request failed, for a parameter outside its declared values, format or length", "type": "string" }, "type": { "description": "Error category, for the cursor error", "type": "string" } }, "required": [ "message" ], "title": "OnboardingTrackerGetResponsesContentApplicationJsonSchemaErrorsOneOf1Items", "type": "object" }, "OnboardingTrackerGetResponsesContentApplicationJsonSchemaPage": { "properties": { "cursor": { "description": "Cursor for pagination", "type": [ "string", "null" ] }, "total_rows": { "description": "Total number of onboardings matching the filters. Stays the same across every page of a cursor walk.", "type": "integer" } }, "title": "OnboardingTrackerGetResponsesContentApplicationJsonSchemaPage", "type": "object" }, "OnboardingTrackerGetResponsesContentApplicationJsonSchemaRequest": { "description": "Error request details. Absent for a cursor that cannot be read", "properties": { "api_req_id": { "description": "The request ID", "type": "string" }, "docs": { "description": "Link to the documentation of the endpoint, or `no match` when there is none", "type": "string" }, "method": { "description": "Method of the API", "type": "string" }, "source": { "description": "The source handler that produced the error", "type": "string" }, "status": { "description": "Status of API response", "format": "double", "type": "number" }, "url": { "description": "The request URL", "type": "string" } }, "title": "OnboardingTrackerGetResponsesContentApplicationJsonSchemaRequest", "type": "object" }, "OnboardingTrackerHrisProfileHrisProfileIdGetResponsesContentApplicationJsonSchemaData": { "properties": { "actions": { "description": "Actions the caller can take on this onboarding", "items": { "$ref": "#/components/schemas/OnboardingTrackerHrisProfileHrisProfileIdGetResponsesContentApplicationJsonSchemaDataActionsItems" }, "type": "array" }, "app_experience": { "$ref": "#/components/schemas/OnboardingTrackerHrisProfileHrisProfileIdGetResponsesContentApplicationJsonSchemaDataAppExperience", "description": "The app experience of the employee" }, "banner": { "description": "The one thing worth saying about this worker, or null when there is nothing", "oneOf": [ { "$ref": "#/components/schemas/OnboardingTrackerHrisProfileHrisProfileIdGetResponsesContentApplicationJsonSchemaDataBanner" }, { "type": "null" } ] }, "checklist": { "$ref": "#/components/schemas/OnboardingTrackerHrisProfileHrisProfileIdGetResponsesContentApplicationJsonSchemaDataChecklist", "description": "List of checklist steps" }, "contract": { "$ref": "#/components/schemas/OnboardingTrackerHrisProfileHrisProfileIdGetResponsesContentApplicationJsonSchemaDataContract", "description": "Information about the contract" }, "contracts": { "description": "Every contract of the worker the caller can see, the main one first", "items": { "$ref": "#/components/schemas/OnboardingTrackerHrisProfileHrisProfileIdGetResponsesContentApplicationJsonSchemaDataContractsItems" }, "type": "array" }, "hiring_type": { "description": "Hiring type (e.g., contractor)", "type": "string" }, "hris_profile": { "$ref": "#/components/schemas/OnboardingTrackerHrisProfileHrisProfileIdGetResponsesContentApplicationJsonSchemaDataHrisProfile", "description": "Employee HRIS profile information" }, "profile": { "description": "Employee profile information", "oneOf": [ { "$ref": "#/components/schemas/OnboardingTrackerHrisProfileHrisProfileIdGetResponsesContentApplicationJsonSchemaDataProfile" }, { "type": "null" } ] }, "progress": { "$ref": "#/components/schemas/OnboardingTrackerHrisProfileHrisProfileIdGetResponsesContentApplicationJsonSchemaDataProgress", "description": "Progress of the onboarding process" }, "stepper": { "description": "List of stepper actions taken during the onboarding process", "items": { "$ref": "#/components/schemas/OnboardingTrackerHrisProfileHrisProfileIdGetResponsesContentApplicationJsonSchemaDataStepperItems" }, "type": "array" }, "summary": { "description": "Summary of the onboarding process", "items": { "$ref": "#/components/schemas/OnboardingTrackerHrisProfileHrisProfileIdGetResponsesContentApplicationJsonSchemaDataSummaryItems" }, "type": "array" } }, "title": "OnboardingTrackerHrisProfileHrisProfileIdGetResponsesContentApplicationJsonSchemaData", "type": "object" }, "OnboardingTrackerHrisProfileHrisProfileIdGetResponsesContentApplicationJsonSchemaDataActionsItems": { "properties": { "available": { "description": "Whether the action can be taken now", "type": "boolean" }, "data": { "additionalProperties": { "description": "Any type" }, "description": "Details the action needs, which vary by action", "type": "object" }, "last_execution_at": { "description": "When the action was last taken, if ever", "format": "date-time", "type": [ "string", "null" ] }, "type": { "$ref": "#/components/schemas/OnboardingTrackerHrisProfileHrisProfileIdGetResponsesContentApplicationJsonSchemaDataActionsItemsType", "description": "The action" } }, "title": "OnboardingTrackerHrisProfileHrisProfileIdGetResponsesContentApplicationJsonSchemaDataActionsItems", "type": "object" }, "OnboardingTrackerHrisProfileHrisProfileIdGetResponsesContentApplicationJsonSchemaDataActionsItemsType": { "description": "The action", "enum": [ "MANAGE_INVITE", "RESEND_INVITE", "SEND_REMINDER", "CANCEL_CONTRACT", "END_CONTRACT", "GET_HELP" ], "title": "OnboardingTrackerHrisProfileHrisProfileIdGetResponsesContentApplicationJsonSchemaDataActionsItemsType", "type": "string" }, "OnboardingTrackerHrisProfileHrisProfileIdGetResponsesContentApplicationJsonSchemaDataAppExperience": { "description": "The app experience of the employee", "properties": { "experience_type": { "description": "The app experience the employee is given, when there is a specific one", "oneOf": [ { "$ref": "#/components/schemas/OnboardingTrackerHrisProfileHrisProfileIdGetResponsesContentApplicationJsonSchemaDataAppExperienceExperienceType" }, { "type": "null" } ] }, "is_minimal_requirements": { "description": "Whether the worker gets the minimal app experience, as a person without a contract does", "type": "boolean" } }, "title": "OnboardingTrackerHrisProfileHrisProfileIdGetResponsesContentApplicationJsonSchemaDataAppExperience", "type": "object" }, "OnboardingTrackerHrisProfileHrisProfileIdGetResponsesContentApplicationJsonSchemaDataAppExperienceExperienceType": { "description": "The app experience the employee is given, when there is a specific one", "enum": [ "LIGHTWEIGHT" ], "title": "OnboardingTrackerHrisProfileHrisProfileIdGetResponsesContentApplicationJsonSchemaDataAppExperienceExperienceType", "type": "string" }, "OnboardingTrackerHrisProfileHrisProfileIdGetResponsesContentApplicationJsonSchemaDataBanner": { "description": "The one thing worth saying about this worker, or null when there is nothing", "properties": { "action": { "description": "What the client can do about it, when there is something", "oneOf": [ { "$ref": "#/components/schemas/OnboardingTrackerHrisProfileHrisProfileIdGetResponsesContentApplicationJsonSchemaDataBannerAction" }, { "type": "null" } ] }, "key": { "$ref": "#/components/schemas/OnboardingTrackerHrisProfileHrisProfileIdGetResponsesContentApplicationJsonSchemaDataBannerKey", "description": "What the banner is about" }, "severity": { "$ref": "#/components/schemas/OnboardingTrackerHrisProfileHrisProfileIdGetResponsesContentApplicationJsonSchemaDataBannerSeverity", "description": "How serious it is" } }, "title": "OnboardingTrackerHrisProfileHrisProfileIdGetResponsesContentApplicationJsonSchemaDataBanner", "type": "object" }, "OnboardingTrackerHrisProfileHrisProfileIdGetResponsesContentApplicationJsonSchemaDataBannerAction": { "description": "What the client can do about it, when there is something", "enum": [ "CANCEL_CONTRACT", "REVIEW_EMPLOYEE_AGREEMENT", "PAY_DEPOSIT", "VIEW_CONTRACT" ], "title": "OnboardingTrackerHrisProfileHrisProfileIdGetResponsesContentApplicationJsonSchemaDataBannerAction", "type": "string" }, "OnboardingTrackerHrisProfileHrisProfileIdGetResponsesContentApplicationJsonSchemaDataBannerKey": { "description": "What the banner is about", "enum": [ "DOCUMENT_REJECTED", "ONBOARDING_OVERDUE", "ONBOARDING_AT_RISK", "START_DATE_PASSED_WITHOUT_INVITE", "EMPLOYEE_AGREEMENT_AWAITING_REVIEW", "AWAITING_DEPOSIT_PAYMENT", "CONTRACT_REDLINING", "CONTRACT_AMENDMENTS_IN_PROGRESS", "QUOTE_REQUIRES_CHANGES", "DRAFT_QUOTE", "CONTRACT_DRAFT", "QUOTE_READY_TO_ACCEPT", "NO_APP_ACCESS", "NO_ONBOARDING_STEPS", "IN_REVIEW_WITH_DEEL", "IN_OFFER_STAGE", "PENDING_INVITE", "INVITED", "ONBOARDING" ], "title": "OnboardingTrackerHrisProfileHrisProfileIdGetResponsesContentApplicationJsonSchemaDataBannerKey", "type": "string" }, "OnboardingTrackerHrisProfileHrisProfileIdGetResponsesContentApplicationJsonSchemaDataBannerSeverity": { "description": "How serious it is", "enum": [ "ERROR", "WARNING", "INFO" ], "title": "OnboardingTrackerHrisProfileHrisProfileIdGetResponsesContentApplicationJsonSchemaDataBannerSeverity", "type": "string" }, "OnboardingTrackerHrisProfileHrisProfileIdGetResponsesContentApplicationJsonSchemaDataChecklist": { "description": "List of checklist steps", "properties": { "steps": { "description": "List of checklist steps", "items": { "$ref": "#/components/schemas/OnboardingTrackerHrisProfileHrisProfileIdGetResponsesContentApplicationJsonSchemaDataChecklistStepsItems" }, "type": "array" }, "summary": { "$ref": "#/components/schemas/OnboardingTrackerHrisProfileHrisProfileIdGetResponsesContentApplicationJsonSchemaDataChecklistSummary", "description": "How far along the checklist is" } }, "title": "OnboardingTrackerHrisProfileHrisProfileIdGetResponsesContentApplicationJsonSchemaDataChecklist", "type": "object" }, "OnboardingTrackerHrisProfileHrisProfileIdGetResponsesContentApplicationJsonSchemaDataChecklistStepsItems": { "description": "Checklist step information", "properties": { "category": { "description": "Heading the step sits under", "type": [ "string", "null" ] }, "category_key": { "description": "Stable identifier of the heading, which keeps its value when the heading is renamed", "type": [ "string", "null" ] }, "completed_at": { "description": "Completion timestamp of the checklist step", "format": "date-time", "type": [ "string", "null" ] }, "data": { "additionalProperties": { "description": "Any type" }, "description": "Details of the step, which vary by step", "type": "object" }, "description": { "description": "What the step asks of the worker", "type": "string" }, "display_key": { "description": "Stable identifier of the step, the same across every worker type. Null when the step has no catalogue entry", "type": [ "string", "null" ] }, "due_date": { "description": "When the step is due, when the source carries one", "format": "date-time", "type": [ "string", "null" ] }, "group": { "$ref": "#/components/schemas/OnboardingTrackerHrisProfileHrisProfileIdGetResponsesContentApplicationJsonSchemaDataChecklistStepsItemsGroup", "description": "Whether the worker still owes the step" }, "label": { "description": "The label for the checklist step", "type": "string" }, "ordinal": { "description": "Position of the step in the onboarding sequence, starting at one", "type": "integer" }, "reject_reason": { "description": "Reason for rejecting the checklist step (It may contain HTML elements)", "type": "string" }, "state": { "$ref": "#/components/schemas/OnboardingTrackerHrisProfileHrisProfileIdGetResponsesContentApplicationJsonSchemaDataChecklistStepsItemsState", "description": "State of the step, reported the same way for every worker type" }, "status": { "description": "Status of the checklist step", "type": "string" }, "type": { "description": "The type of checklist step", "type": "string" } }, "title": "OnboardingTrackerHrisProfileHrisProfileIdGetResponsesContentApplicationJsonSchemaDataChecklistStepsItems", "type": "object" }, "OnboardingTrackerHrisProfileHrisProfileIdGetResponsesContentApplicationJsonSchemaDataChecklistStepsItemsGroup": { "description": "Whether the worker still owes the step", "enum": [ "COMPLETED", "OUTSTANDING" ], "title": "OnboardingTrackerHrisProfileHrisProfileIdGetResponsesContentApplicationJsonSchemaDataChecklistStepsItemsGroup", "type": "string" }, "OnboardingTrackerHrisProfileHrisProfileIdGetResponsesContentApplicationJsonSchemaDataChecklistStepsItemsState": { "description": "State of the step, reported the same way for every worker type", "enum": [ "NOT_STARTED", "IN_PROGRESS", "IN_REVIEW", "COMPLETED", "OVERDUE" ], "title": "OnboardingTrackerHrisProfileHrisProfileIdGetResponsesContentApplicationJsonSchemaDataChecklistStepsItemsState", "type": "string" }, "OnboardingTrackerHrisProfileHrisProfileIdGetResponsesContentApplicationJsonSchemaDataChecklistSummary": { "description": "How far along the checklist is", "properties": { "completed": { "description": "Number of completed steps", "type": "integer" }, "outstanding": { "description": "Number of steps the worker still owes", "type": "integer" }, "total": { "description": "Number of checklist steps", "type": "integer" } }, "title": "OnboardingTrackerHrisProfileHrisProfileIdGetResponsesContentApplicationJsonSchemaDataChecklistSummary", "type": "object" }, "OnboardingTrackerHrisProfileHrisProfileIdGetResponsesContentApplicationJsonSchemaDataContract": { "description": "Information about the contract", "properties": { "client_signed_at": { "description": "Timestamp when the client signed the contract", "format": "date-time", "type": [ "string", "null" ] }, "completion_date": { "description": "The completion date of the contract, if applicable", "format": "date-time", "type": [ "string", "null" ] }, "contractor_signed_at": { "description": "Timestamp when the contractor signed the contract", "format": "date-time", "type": [ "string", "null" ] }, "created_at": { "description": "Contract creation timestamp", "format": "date-time", "type": "string" }, "employee_agreement": { "$ref": "#/components/schemas/OnboardingTrackerHrisProfileHrisProfileIdGetResponsesContentApplicationJsonSchemaDataContractEmployeeAgreement", "description": "Information about the Employment Agreement" }, "first_early_invoice": { "description": "Only applicable for EOR contracts. First early invoice (EOR funding statement) for the contract, if any", "oneOf": [ { "$ref": "#/components/schemas/OnboardingTrackerHrisProfileHrisProfileIdGetResponsesContentApplicationJsonSchemaDataContractFirstEarlyInvoice" }, { "type": "null" } ] }, "first_sign": { "description": "The first sign (either 'client' or 'contractor')", "type": "string" }, "id": { "description": "Unique contract ID", "type": "string" }, "invited_contractor_email": { "description": "Email of the invited contractor", "format": "email", "type": [ "string", "null" ] }, "is_pwac": { "description": "Whether the worker is a person without a contract", "type": "boolean" }, "name": { "description": "Contract name", "type": "string" }, "oid": { "description": "Contract OID", "type": "string" }, "status": { "description": "Contract status (e.g., in_progress)", "type": "string" } }, "title": "OnboardingTrackerHrisProfileHrisProfileIdGetResponsesContentApplicationJsonSchemaDataContract", "type": "object" }, "OnboardingTrackerHrisProfileHrisProfileIdGetResponsesContentApplicationJsonSchemaDataContractEmployeeAgreement": { "description": "Information about the Employment Agreement", "properties": { "phase": { "description": "Signing-lifecycle phase that produced the current Employment Agreement PDF. Can be null if the EA has not yet been generated", "oneOf": [ { "$ref": "#/components/schemas/OnboardingTrackerHrisProfileHrisProfileIdGetResponsesContentApplicationJsonSchemaDataContractEmployeeAgreementPhase" }, { "type": "null" } ] }, "status": { "description": "Status of the Employment Agreement. Can be null if the EA has not yet been generated", "type": [ "string", "null" ] }, "version_hash": { "description": "Version of the Employment Agreement. Can be null if the EA has not yet been generated", "type": [ "string", "null" ] } }, "title": "OnboardingTrackerHrisProfileHrisProfileIdGetResponsesContentApplicationJsonSchemaDataContractEmployeeAgreement", "type": "object" }, "OnboardingTrackerHrisProfileHrisProfileIdGetResponsesContentApplicationJsonSchemaDataContractEmployeeAgreementPhase": { "description": "Signing-lifecycle phase that produced the current Employment Agreement PDF. Can be null if the EA has not yet been generated", "enum": [ "unsigned", "employee_signed", "countersigned" ], "title": "OnboardingTrackerHrisProfileHrisProfileIdGetResponsesContentApplicationJsonSchemaDataContractEmployeeAgreementPhase", "type": "string" }, "OnboardingTrackerHrisProfileHrisProfileIdGetResponsesContentApplicationJsonSchemaDataContractFirstEarlyInvoice": { "description": "Only applicable for EOR contracts. First early invoice (EOR funding statement) for the contract, if any", "properties": { "amount": { "description": "Invoice amount", "type": "string" }, "currency": { "description": "Currency code for the invoice amount", "type": "string" }, "description": { "description": "Invoice description", "type": "string" }, "due_date": { "description": "Due date for the invoice", "format": "date-time", "type": [ "string", "null" ] }, "id": { "description": "Unique invoice ID", "type": "string" }, "paid_at": { "description": "Timestamp when the invoice was paid, if applicable", "format": "date-time", "type": [ "string", "null" ] }, "status": { "$ref": "#/components/schemas/OnboardingTrackerHrisProfileHrisProfileIdGetResponsesContentApplicationJsonSchemaDataContractFirstEarlyInvoiceStatus", "description": "Status of the invoice" } }, "title": "OnboardingTrackerHrisProfileHrisProfileIdGetResponsesContentApplicationJsonSchemaDataContractFirstEarlyInvoice", "type": "object" }, "OnboardingTrackerHrisProfileHrisProfileIdGetResponsesContentApplicationJsonSchemaDataContractFirstEarlyInvoiceStatus": { "description": "Status of the invoice", "enum": [ "OPEN", "PENDING", "SKIPPED", "PREPROCESSING", "PROCESSING", "CREDITED", "PROCESSED", "PAID", "FAILED", "CANCELLED", "REFUNDED", "UNPAYABLE", "AWAITING_PAYMENT" ], "title": "OnboardingTrackerHrisProfileHrisProfileIdGetResponsesContentApplicationJsonSchemaDataContractFirstEarlyInvoiceStatus", "type": "string" }, "OnboardingTrackerHrisProfileHrisProfileIdGetResponsesContentApplicationJsonSchemaDataContractsItems": { "properties": { "contract_oid": { "description": "The unique identifier for the contract", "type": [ "string", "null" ] }, "entity": { "description": "The legal entity the contract sits under. Null when there is none", "oneOf": [ { "$ref": "#/components/schemas/OnboardingTrackerHrisProfileHrisProfileIdGetResponsesContentApplicationJsonSchemaDataContractsItemsEntity" }, { "type": "null" } ] }, "is_attention_needed": { "description": "Whether the onboarding on this contract is overdue or at risk", "type": "boolean" }, "is_current": { "description": "Whether this is the contract the overview is about", "type": "boolean" }, "is_main": { "description": "Whether this is the main contract of the worker: the most urgent status, then a new contract before a person without a contract, then the latest start date, then the latest created contract", "type": "boolean" }, "is_pwac": { "description": "Whether the contract is the placeholder contract of a person without a contract", "type": "boolean" }, "job_title": { "description": "The job title on the contract", "type": [ "string", "null" ] }, "lifecycle_status": { "$ref": "#/components/schemas/OnboardingTrackerHrisProfileHrisProfileIdGetResponsesContentApplicationJsonSchemaDataContractsItemsLifecycleStatus", "description": "Lifecycle status of this contract, the same value the People list shows for it" }, "start_date": { "description": "The start date of the contract", "format": "date", "type": [ "string", "null" ] }, "status": { "$ref": "#/components/schemas/OnboardingTrackerHrisProfileHrisProfileIdGetResponsesContentApplicationJsonSchemaDataContractsItemsStatus", "description": "Current status of the onboarding on this contract" }, "tracker_id": { "description": "The tracker identifier that loads this contract", "type": "string" }, "worker_type": { "$ref": "#/components/schemas/OnboardingTrackerHrisProfileHrisProfileIdGetResponsesContentApplicationJsonSchemaDataContractsItemsWorkerType", "description": "The worker type of the contract, as the hiring_types filter takes it" } }, "title": "OnboardingTrackerHrisProfileHrisProfileIdGetResponsesContentApplicationJsonSchemaDataContractsItems", "type": "object" }, "OnboardingTrackerHrisProfileHrisProfileIdGetResponsesContentApplicationJsonSchemaDataContractsItemsEntity": { "description": "The legal entity the contract sits under. Null when there is none", "properties": { "id": { "description": "The unique identifier for the legal entity", "type": "string" }, "name": { "description": "The name of the legal entity. A Deel entity that a contractor of record works under ends in (COR)", "type": [ "string", "null" ] } }, "title": "OnboardingTrackerHrisProfileHrisProfileIdGetResponsesContentApplicationJsonSchemaDataContractsItemsEntity", "type": "object" }, "OnboardingTrackerHrisProfileHrisProfileIdGetResponsesContentApplicationJsonSchemaDataContractsItemsLifecycleStatus": { "description": "Lifecycle status of this contract, the same value the People list shows for it", "enum": [ "DRAFT", "IN_REVIEW", "QUOTE_REQUIRES_CHANGES", "PENDING_INVITE", "INVITED", "ONBOARDING", "ONBOARDING_AT_RISK", "ONBOARDING_OVERDUE", "OFFBOARDING", "ONBOARDED" ], "title": "OnboardingTrackerHrisProfileHrisProfileIdGetResponsesContentApplicationJsonSchemaDataContractsItemsLifecycleStatus", "type": "string" }, "OnboardingTrackerHrisProfileHrisProfileIdGetResponsesContentApplicationJsonSchemaDataContractsItemsStatus": { "description": "Current status of the onboarding on this contract", "enum": [ "ONBOARDING_AT_RISK", "ONBOARDING_OVERDUE", "INVITED", "ONBOARDING", "READY_TO_START", "INACTIVE", "PENDING_INVITE", "ACTIVE", "DRAFT", "OFFBOARDING", "QUOTE_REQUIRES_CHANGES", "IN_REVIEW", "IN_OFFER_STAGE" ], "title": "OnboardingTrackerHrisProfileHrisProfileIdGetResponsesContentApplicationJsonSchemaDataContractsItemsStatus", "type": "string" }, "OnboardingTrackerHrisProfileHrisProfileIdGetResponsesContentApplicationJsonSchemaDataContractsItemsWorkerType": { "description": "The worker type of the contract, as the hiring_types filter takes it", "enum": [ "contractor", "direct_employee", "hris_direct_employee", "hris_direct_contractor", "eor", "peo", "person_without_contract" ], "title": "OnboardingTrackerHrisProfileHrisProfileIdGetResponsesContentApplicationJsonSchemaDataContractsItemsWorkerType", "type": "string" }, "OnboardingTrackerHrisProfileHrisProfileIdGetResponsesContentApplicationJsonSchemaDataHrisProfile": { "description": "Employee HRIS profile information", "properties": { "direct_manager": { "description": "The direct manager of the employee, when one is set", "oneOf": [ { "$ref": "#/components/schemas/OnboardingTrackerHrisProfileHrisProfileIdGetResponsesContentApplicationJsonSchemaDataHrisProfileDirectManager" }, { "type": "null" } ] }, "email": { "description": "Email of the HRIS profile", "format": "email", "type": "string" }, "invitations": { "description": "Invitations to the employee that are not sent yet", "items": { "$ref": "#/components/schemas/OnboardingTrackerHrisProfileHrisProfileIdGetResponsesContentApplicationJsonSchemaDataHrisProfileInvitationsItems" }, "type": "array" }, "name": { "description": "HRIS Profile name", "type": "string" }, "oid": { "description": "HRIS Profile OID", "type": "string" }, "work_email": { "description": "Work email of the HRIS profile", "format": "email", "type": [ "string", "null" ] } }, "title": "OnboardingTrackerHrisProfileHrisProfileIdGetResponsesContentApplicationJsonSchemaDataHrisProfile", "type": "object" }, "OnboardingTrackerHrisProfileHrisProfileIdGetResponsesContentApplicationJsonSchemaDataHrisProfileDirectManager": { "description": "The direct manager of the employee, when one is set", "properties": { "job_title": { "description": "Job title of the manager", "type": [ "string", "null" ] }, "name": { "description": "Name of the manager", "type": [ "string", "null" ] }, "oid": { "description": "HRIS profile OID of the manager", "type": "string" }, "pic_url": { "description": "URL of the manager profile picture", "type": [ "string", "null" ] }, "work_email": { "description": "Work email of the manager", "format": "email", "type": [ "string", "null" ] } }, "title": "OnboardingTrackerHrisProfileHrisProfileIdGetResponsesContentApplicationJsonSchemaDataHrisProfileDirectManager", "type": "object" }, "OnboardingTrackerHrisProfileHrisProfileIdGetResponsesContentApplicationJsonSchemaDataHrisProfileInvitationsItems": { "properties": { "oid": { "description": "Invitation OID", "type": "string" }, "send_at": { "description": "When the invitation is or was sent", "format": "date-time", "type": [ "string", "null" ] }, "status": { "$ref": "#/components/schemas/OnboardingTrackerHrisProfileHrisProfileIdGetResponsesContentApplicationJsonSchemaDataHrisProfileInvitationsItemsStatus", "description": "Status of the invitation" }, "timezone": { "description": "Timezone the invitation is scheduled in", "type": [ "string", "null" ] } }, "title": "OnboardingTrackerHrisProfileHrisProfileIdGetResponsesContentApplicationJsonSchemaDataHrisProfileInvitationsItems", "type": "object" }, "OnboardingTrackerHrisProfileHrisProfileIdGetResponsesContentApplicationJsonSchemaDataHrisProfileInvitationsItemsStatus": { "description": "Status of the invitation", "enum": [ "SENT", "DISABLED", "SUSPENDED", "SCHEDULED", "FAILED" ], "title": "OnboardingTrackerHrisProfileHrisProfileIdGetResponsesContentApplicationJsonSchemaDataHrisProfileInvitationsItemsStatus", "type": "string" }, "OnboardingTrackerHrisProfileHrisProfileIdGetResponsesContentApplicationJsonSchemaDataProfile": { "description": "Employee profile information", "properties": { "country": { "description": "Country code", "type": [ "string", "null" ] }, "email": { "description": "Email of the profile", "format": "email", "type": "string" }, "id": { "description": "Internal ID of the profile", "type": "integer" }, "last_login": { "description": "Last login timestamp", "format": "date-time", "type": "string" }, "name": { "description": "Name associated with the profile", "type": "string" }, "paid_invoices": { "description": "A paid invoice on the contract, if any, at most one. Only for a contractor, empty for other worker types", "items": { "$ref": "#/components/schemas/OnboardingTrackerHrisProfileHrisProfileIdGetResponsesContentApplicationJsonSchemaDataProfilePaidInvoicesItems" }, "type": "array" }, "pic_url": { "description": "URL of the profile picture", "type": [ "string", "null" ] }, "previously_onboarded": { "description": "Indicates if the contractor has previously onboarded", "type": "boolean" } }, "title": "OnboardingTrackerHrisProfileHrisProfileIdGetResponsesContentApplicationJsonSchemaDataProfile", "type": "object" }, "OnboardingTrackerHrisProfileHrisProfileIdGetResponsesContentApplicationJsonSchemaDataProfilePaidInvoicesItems": { "properties": { "id": { "description": "Internal ID of the invoice", "type": "integer" }, "status": { "description": "Status of the invoice", "type": "string" } }, "title": "OnboardingTrackerHrisProfileHrisProfileIdGetResponsesContentApplicationJsonSchemaDataProfilePaidInvoicesItems", "type": "object" }, "OnboardingTrackerHrisProfileHrisProfileIdGetResponsesContentApplicationJsonSchemaDataProgress": { "description": "Progress of the onboarding process", "properties": { "is_action_required_from_client": { "description": "Indicates if action is required from the client", "type": "boolean" }, "reference_date": { "description": "Reference date for the progress", "format": "date-time", "type": "string" }, "reference_date_timezone": { "description": "Timezone of the reference date", "type": "string" }, "status": { "description": "Current status of the onboarding process (e.g., ACTIVE)", "type": "string" }, "sub_status": { "description": "Finer state within the status, when there is one", "oneOf": [ { "$ref": "#/components/schemas/OnboardingTrackerHrisProfileHrisProfileIdGetResponsesContentApplicationJsonSchemaDataProgressSubStatus" }, { "type": "null" } ] }, "subject_to_overdue": { "description": "Indicates if the onboarding is subject to overdue", "type": "boolean" } }, "title": "OnboardingTrackerHrisProfileHrisProfileIdGetResponsesContentApplicationJsonSchemaDataProgress", "type": "object" }, "OnboardingTrackerHrisProfileHrisProfileIdGetResponsesContentApplicationJsonSchemaDataProgressSubStatus": { "description": "Finer state within the status, when there is one", "enum": [ "PENDING_INVITE", "INVITED", "ONBOARDING", "AWAITING_CLIENT_REVIEW", "CANCELLED", "REJECTED" ], "title": "OnboardingTrackerHrisProfileHrisProfileIdGetResponsesContentApplicationJsonSchemaDataProgressSubStatus", "type": "string" }, "OnboardingTrackerHrisProfileHrisProfileIdGetResponsesContentApplicationJsonSchemaDataStepperItems": { "description": "Stepper action information", "properties": { "completed_at": { "description": "Completion timestamp of the stepper action", "format": "date-time", "type": [ "string", "null" ] }, "data": { "$ref": "#/components/schemas/OnboardingTrackerHrisProfileHrisProfileIdGetResponsesContentApplicationJsonSchemaDataStepperItemsData" }, "type": { "description": "Type of the stepper action", "type": "string" } }, "title": "OnboardingTrackerHrisProfileHrisProfileIdGetResponsesContentApplicationJsonSchemaDataStepperItems", "type": "object" }, "OnboardingTrackerHrisProfileHrisProfileIdGetResponsesContentApplicationJsonSchemaDataStepperItemsData": { "properties": { "completed": { "description": "Checklist steps completed, on the checklist progress step", "type": "integer" }, "emails": { "description": "List of emails sent during the stepper process", "items": { "$ref": "#/components/schemas/OnboardingTrackerHrisProfileHrisProfileIdGetResponsesContentApplicationJsonSchemaDataStepperItemsDataEmailsItems" }, "type": "array" }, "next_reminder_date": { "description": "Next reminder date, if applicable", "format": "date-time", "type": [ "string", "null" ] }, "onboarding_due_date": { "description": "When onboarding is due, on the checklist progress step", "format": "date-time", "type": [ "string", "null" ] }, "remaining": { "description": "Checklist steps remaining, on the checklist progress step", "type": "integer" }, "total": { "description": "Checklist steps in total, on the checklist progress step", "type": "integer" } }, "title": "OnboardingTrackerHrisProfileHrisProfileIdGetResponsesContentApplicationJsonSchemaDataStepperItemsData", "type": "object" }, "OnboardingTrackerHrisProfileHrisProfileIdGetResponsesContentApplicationJsonSchemaDataStepperItemsDataEmailsItems": { "properties": { "meta": { "$ref": "#/components/schemas/OnboardingTrackerHrisProfileHrisProfileIdGetResponsesContentApplicationJsonSchemaDataStepperItemsDataEmailsItemsMeta", "description": "Email metadata" } }, "title": "OnboardingTrackerHrisProfileHrisProfileIdGetResponsesContentApplicationJsonSchemaDataStepperItemsDataEmailsItems", "type": "object" }, "OnboardingTrackerHrisProfileHrisProfileIdGetResponsesContentApplicationJsonSchemaDataStepperItemsDataEmailsItemsMeta": { "description": "Email metadata", "properties": { "email": { "description": "Email address", "format": "email", "type": "string" }, "sent_at": { "description": "Timestamp when the email was sent", "format": "date-time", "type": "string" }, "type": { "description": "Type of email", "type": "string" } }, "title": "OnboardingTrackerHrisProfileHrisProfileIdGetResponsesContentApplicationJsonSchemaDataStepperItemsDataEmailsItemsMeta", "type": "object" }, "OnboardingTrackerHrisProfileHrisProfileIdGetResponsesContentApplicationJsonSchemaDataSummaryItems": { "description": "Summary item information", "properties": { "data": { "$ref": "#/components/schemas/OnboardingTrackerHrisProfileHrisProfileIdGetResponsesContentApplicationJsonSchemaDataSummaryItemsData", "description": "Additional data about the summary item" }, "name": { "description": "Name of the summary item", "type": "string" }, "type": { "description": "Type of the summary item", "type": "string" }, "value": { "$ref": "#/components/schemas/OnboardingTrackerHrisProfileHrisProfileIdGetResponsesContentApplicationJsonSchemaDataSummaryItemsValue", "description": "Value of the summary item" } }, "title": "OnboardingTrackerHrisProfileHrisProfileIdGetResponsesContentApplicationJsonSchemaDataSummaryItems", "type": "object" }, "OnboardingTrackerHrisProfileHrisProfileIdGetResponsesContentApplicationJsonSchemaDataSummaryItemsData": { "description": "Additional data about the summary item", "properties": { "country": { "description": "Country code for location-related summaries", "type": "string" }, "has_withdraw_methods": { "description": "Indicates if withdrawal methods exist", "type": "boolean" }, "timezone": { "description": "Timezone information", "type": "string" } }, "title": "OnboardingTrackerHrisProfileHrisProfileIdGetResponsesContentApplicationJsonSchemaDataSummaryItemsData", "type": "object" }, "OnboardingTrackerHrisProfileHrisProfileIdGetResponsesContentApplicationJsonSchemaDataSummaryItemsValue": { "description": "Value of the summary item", "oneOf": [ { "type": "string" }, { "format": "double", "type": "number" }, { "type": "boolean" }, { "format": "date-time", "type": "string" }, { "additionalProperties": { "description": "Any type" }, "type": "object" } ], "title": "OnboardingTrackerHrisProfileHrisProfileIdGetResponsesContentApplicationJsonSchemaDataSummaryItemsValue" }, "OnboardingTrackerHrisProfileHrisProfileIdGetResponsesContentApplicationJsonSchemaErrors": { "description": "The errors, as an object with an `errors` list, or as the list", "oneOf": [ { "$ref": "#/components/schemas/OnboardingTrackerHrisProfileHrisProfileIdGetResponsesContentApplicationJsonSchemaErrors0" }, { "$ref": "#/components/schemas/OnboardingTrackerHrisProfileHrisProfileIdGetResponsesContentApplicationJsonSchemaErrors1" } ], "title": "OnboardingTrackerHrisProfileHrisProfileIdGetResponsesContentApplicationJsonSchemaErrors" }, "OnboardingTrackerHrisProfileHrisProfileIdGetResponsesContentApplicationJsonSchemaErrors0": { "description": "The errors the endpoint returned", "properties": { "errors": { "description": "Error messages", "items": { "$ref": "#/components/schemas/OnboardingTrackerHrisProfileHrisProfileIdGetResponsesContentApplicationJsonSchemaErrorsOneOf0ErrorsItems" }, "type": "array" } }, "title": "OnboardingTrackerHrisProfileHrisProfileIdGetResponsesContentApplicationJsonSchemaErrors0", "type": "object" }, "OnboardingTrackerHrisProfileHrisProfileIdGetResponsesContentApplicationJsonSchemaErrors1": { "description": "Error messages", "items": { "$ref": "#/components/schemas/OnboardingTrackerHrisProfileHrisProfileIdGetResponsesContentApplicationJsonSchemaErrorsOneOf1Items" }, "title": "OnboardingTrackerHrisProfileHrisProfileIdGetResponsesContentApplicationJsonSchemaErrors1", "type": "array" }, "OnboardingTrackerHrisProfileHrisProfileIdGetResponsesContentApplicationJsonSchemaErrorsOneOf0ErrorsItems": { "properties": { "code": { "description": "Machine-readable error code", "type": "string" }, "context": { "additionalProperties": { "description": "Any type" }, "description": "Additional error context", "type": "object" }, "message": { "description": "Human-readable error message", "type": "string" }, "type": { "description": "Error category", "type": "string" } }, "required": [ "code", "type", "message" ], "title": "OnboardingTrackerHrisProfileHrisProfileIdGetResponsesContentApplicationJsonSchemaErrorsOneOf0ErrorsItems", "type": "object" }, "OnboardingTrackerHrisProfileHrisProfileIdGetResponsesContentApplicationJsonSchemaErrorsOneOf1Items": { "properties": { "code": { "description": "Machine-readable error code", "type": "string" }, "context": { "additionalProperties": { "description": "Any type" }, "description": "Additional error context", "type": "object" }, "message": { "description": "Human-readable error message", "type": "string" }, "type": { "description": "Error category", "type": "string" } }, "required": [ "code", "type", "message" ], "title": "OnboardingTrackerHrisProfileHrisProfileIdGetResponsesContentApplicationJsonSchemaErrorsOneOf1Items", "type": "object" }, "OnboardingTrackerHrisProfileHrisProfileIdGetResponsesContentApplicationJsonSchemaRequest": { "description": "Error request details", "properties": { "api_req_id": { "description": "The request ID", "type": "string" }, "docs": { "description": "Link to the documentation of the endpoint, or `no match` when there is none", "type": "string" }, "method": { "description": "Method of the API", "type": "string" }, "source": { "description": "The source handler that produced the error", "type": "string" }, "status": { "description": "Status of API response", "format": "double", "type": "number" }, "url": { "description": "The request URL", "type": "string" } }, "title": "OnboardingTrackerHrisProfileHrisProfileIdGetResponsesContentApplicationJsonSchemaRequest", "type": "object" }, "OnboardingTrackerTrackerIdGetResponsesContentApplicationJsonSchemaData": { "properties": { "actions": { "description": "Actions the caller can take on this onboarding", "items": { "$ref": "#/components/schemas/OnboardingTrackerTrackerIdGetResponsesContentApplicationJsonSchemaDataActionsItems" }, "type": "array" }, "app_experience": { "$ref": "#/components/schemas/OnboardingTrackerTrackerIdGetResponsesContentApplicationJsonSchemaDataAppExperience", "description": "The app experience of the employee" }, "banner": { "description": "The one thing worth saying about this worker, or null when there is nothing", "oneOf": [ { "$ref": "#/components/schemas/OnboardingTrackerTrackerIdGetResponsesContentApplicationJsonSchemaDataBanner" }, { "type": "null" } ] }, "checklist": { "$ref": "#/components/schemas/OnboardingTrackerTrackerIdGetResponsesContentApplicationJsonSchemaDataChecklist", "description": "List of checklist steps" }, "contract": { "$ref": "#/components/schemas/OnboardingTrackerTrackerIdGetResponsesContentApplicationJsonSchemaDataContract", "description": "Information about the contract" }, "contracts": { "description": "Every contract of the worker the caller can see, the main one first", "items": { "$ref": "#/components/schemas/OnboardingTrackerTrackerIdGetResponsesContentApplicationJsonSchemaDataContractsItems" }, "type": "array" }, "hiring_type": { "description": "Hiring type (e.g., contractor)", "type": "string" }, "hris_profile": { "$ref": "#/components/schemas/OnboardingTrackerTrackerIdGetResponsesContentApplicationJsonSchemaDataHrisProfile", "description": "Employee HRIS profile information" }, "profile": { "description": "Employee profile information", "oneOf": [ { "$ref": "#/components/schemas/OnboardingTrackerTrackerIdGetResponsesContentApplicationJsonSchemaDataProfile" }, { "type": "null" } ] }, "progress": { "$ref": "#/components/schemas/OnboardingTrackerTrackerIdGetResponsesContentApplicationJsonSchemaDataProgress", "description": "Progress of the onboarding process" }, "stepper": { "description": "List of stepper actions taken during the onboarding process", "items": { "$ref": "#/components/schemas/OnboardingTrackerTrackerIdGetResponsesContentApplicationJsonSchemaDataStepperItems" }, "type": "array" }, "summary": { "description": "Summary of the onboarding process", "items": { "$ref": "#/components/schemas/OnboardingTrackerTrackerIdGetResponsesContentApplicationJsonSchemaDataSummaryItems" }, "type": "array" } }, "title": "OnboardingTrackerTrackerIdGetResponsesContentApplicationJsonSchemaData", "type": "object" }, "OnboardingTrackerTrackerIdGetResponsesContentApplicationJsonSchemaDataActionsItems": { "properties": { "available": { "description": "Whether the action can be taken now", "type": "boolean" }, "data": { "additionalProperties": { "description": "Any type" }, "description": "Details the action needs, which vary by action", "type": "object" }, "last_execution_at": { "description": "When the action was last taken, if ever", "format": "date-time", "type": [ "string", "null" ] }, "type": { "$ref": "#/components/schemas/OnboardingTrackerTrackerIdGetResponsesContentApplicationJsonSchemaDataActionsItemsType", "description": "The action" } }, "title": "OnboardingTrackerTrackerIdGetResponsesContentApplicationJsonSchemaDataActionsItems", "type": "object" }, "OnboardingTrackerTrackerIdGetResponsesContentApplicationJsonSchemaDataActionsItemsType": { "description": "The action", "enum": [ "MANAGE_INVITE", "RESEND_INVITE", "SEND_REMINDER", "CANCEL_CONTRACT", "END_CONTRACT", "GET_HELP" ], "title": "OnboardingTrackerTrackerIdGetResponsesContentApplicationJsonSchemaDataActionsItemsType", "type": "string" }, "OnboardingTrackerTrackerIdGetResponsesContentApplicationJsonSchemaDataAppExperience": { "description": "The app experience of the employee", "properties": { "experience_type": { "description": "The app experience the employee is given, when there is a specific one", "oneOf": [ { "$ref": "#/components/schemas/OnboardingTrackerTrackerIdGetResponsesContentApplicationJsonSchemaDataAppExperienceExperienceType" }, { "type": "null" } ] }, "is_minimal_requirements": { "description": "Whether the worker gets the minimal app experience, as a person without a contract does", "type": "boolean" } }, "title": "OnboardingTrackerTrackerIdGetResponsesContentApplicationJsonSchemaDataAppExperience", "type": "object" }, "OnboardingTrackerTrackerIdGetResponsesContentApplicationJsonSchemaDataAppExperienceExperienceType": { "description": "The app experience the employee is given, when there is a specific one", "enum": [ "LIGHTWEIGHT" ], "title": "OnboardingTrackerTrackerIdGetResponsesContentApplicationJsonSchemaDataAppExperienceExperienceType", "type": "string" }, "OnboardingTrackerTrackerIdGetResponsesContentApplicationJsonSchemaDataBanner": { "description": "The one thing worth saying about this worker, or null when there is nothing", "properties": { "action": { "description": "What the client can do about it, when there is something", "oneOf": [ { "$ref": "#/components/schemas/OnboardingTrackerTrackerIdGetResponsesContentApplicationJsonSchemaDataBannerAction" }, { "type": "null" } ] }, "key": { "$ref": "#/components/schemas/OnboardingTrackerTrackerIdGetResponsesContentApplicationJsonSchemaDataBannerKey", "description": "What the banner is about" }, "severity": { "$ref": "#/components/schemas/OnboardingTrackerTrackerIdGetResponsesContentApplicationJsonSchemaDataBannerSeverity", "description": "How serious it is" } }, "title": "OnboardingTrackerTrackerIdGetResponsesContentApplicationJsonSchemaDataBanner", "type": "object" }, "OnboardingTrackerTrackerIdGetResponsesContentApplicationJsonSchemaDataBannerAction": { "description": "What the client can do about it, when there is something", "enum": [ "CANCEL_CONTRACT", "REVIEW_EMPLOYEE_AGREEMENT", "PAY_DEPOSIT", "VIEW_CONTRACT" ], "title": "OnboardingTrackerTrackerIdGetResponsesContentApplicationJsonSchemaDataBannerAction", "type": "string" }, "OnboardingTrackerTrackerIdGetResponsesContentApplicationJsonSchemaDataBannerKey": { "description": "What the banner is about", "enum": [ "DOCUMENT_REJECTED", "ONBOARDING_OVERDUE", "ONBOARDING_AT_RISK", "START_DATE_PASSED_WITHOUT_INVITE", "EMPLOYEE_AGREEMENT_AWAITING_REVIEW", "AWAITING_DEPOSIT_PAYMENT", "CONTRACT_REDLINING", "CONTRACT_AMENDMENTS_IN_PROGRESS", "QUOTE_REQUIRES_CHANGES", "DRAFT_QUOTE", "CONTRACT_DRAFT", "QUOTE_READY_TO_ACCEPT", "NO_APP_ACCESS", "NO_ONBOARDING_STEPS", "IN_REVIEW_WITH_DEEL", "IN_OFFER_STAGE", "PENDING_INVITE", "INVITED", "ONBOARDING" ], "title": "OnboardingTrackerTrackerIdGetResponsesContentApplicationJsonSchemaDataBannerKey", "type": "string" }, "OnboardingTrackerTrackerIdGetResponsesContentApplicationJsonSchemaDataBannerSeverity": { "description": "How serious it is", "enum": [ "ERROR", "WARNING", "INFO" ], "title": "OnboardingTrackerTrackerIdGetResponsesContentApplicationJsonSchemaDataBannerSeverity", "type": "string" }, "OnboardingTrackerTrackerIdGetResponsesContentApplicationJsonSchemaDataChecklist": { "description": "List of checklist steps", "properties": { "steps": { "description": "List of checklist steps", "items": { "$ref": "#/components/schemas/OnboardingTrackerTrackerIdGetResponsesContentApplicationJsonSchemaDataChecklistStepsItems" }, "type": "array" }, "summary": { "$ref": "#/components/schemas/OnboardingTrackerTrackerIdGetResponsesContentApplicationJsonSchemaDataChecklistSummary", "description": "How far along the checklist is" } }, "title": "OnboardingTrackerTrackerIdGetResponsesContentApplicationJsonSchemaDataChecklist", "type": "object" }, "OnboardingTrackerTrackerIdGetResponsesContentApplicationJsonSchemaDataChecklistStepsItems": { "description": "Checklist step information", "properties": { "category": { "description": "Heading the step sits under", "type": [ "string", "null" ] }, "category_key": { "description": "Stable identifier of the heading, which keeps its value when the heading is renamed", "type": [ "string", "null" ] }, "completed_at": { "description": "Completion timestamp of the checklist step", "format": "date-time", "type": [ "string", "null" ] }, "data": { "additionalProperties": { "description": "Any type" }, "description": "Details of the step, which vary by step", "type": "object" }, "description": { "description": "What the step asks of the worker", "type": "string" }, "display_key": { "description": "Stable identifier of the step, the same across every worker type. Null when the step has no catalogue entry", "type": [ "string", "null" ] }, "due_date": { "description": "When the step is due, when the source carries one", "format": "date-time", "type": [ "string", "null" ] }, "group": { "$ref": "#/components/schemas/OnboardingTrackerTrackerIdGetResponsesContentApplicationJsonSchemaDataChecklistStepsItemsGroup", "description": "Whether the worker still owes the step" }, "label": { "description": "The label for the checklist step", "type": "string" }, "ordinal": { "description": "Position of the step in the onboarding sequence, starting at one", "type": "integer" }, "reject_reason": { "description": "Reason for rejecting the checklist step (It may contain HTML elements)", "type": "string" }, "state": { "$ref": "#/components/schemas/OnboardingTrackerTrackerIdGetResponsesContentApplicationJsonSchemaDataChecklistStepsItemsState", "description": "State of the step, reported the same way for every worker type" }, "status": { "description": "Status of the checklist step", "type": "string" }, "type": { "description": "The type of checklist step", "type": "string" } }, "title": "OnboardingTrackerTrackerIdGetResponsesContentApplicationJsonSchemaDataChecklistStepsItems", "type": "object" }, "OnboardingTrackerTrackerIdGetResponsesContentApplicationJsonSchemaDataChecklistStepsItemsGroup": { "description": "Whether the worker still owes the step", "enum": [ "COMPLETED", "OUTSTANDING" ], "title": "OnboardingTrackerTrackerIdGetResponsesContentApplicationJsonSchemaDataChecklistStepsItemsGroup", "type": "string" }, "OnboardingTrackerTrackerIdGetResponsesContentApplicationJsonSchemaDataChecklistStepsItemsState": { "description": "State of the step, reported the same way for every worker type", "enum": [ "NOT_STARTED", "IN_PROGRESS", "IN_REVIEW", "COMPLETED", "OVERDUE" ], "title": "OnboardingTrackerTrackerIdGetResponsesContentApplicationJsonSchemaDataChecklistStepsItemsState", "type": "string" }, "OnboardingTrackerTrackerIdGetResponsesContentApplicationJsonSchemaDataChecklistSummary": { "description": "How far along the checklist is", "properties": { "completed": { "description": "Number of completed steps", "type": "integer" }, "outstanding": { "description": "Number of steps the worker still owes", "type": "integer" }, "total": { "description": "Number of checklist steps", "type": "integer" } }, "title": "OnboardingTrackerTrackerIdGetResponsesContentApplicationJsonSchemaDataChecklistSummary", "type": "object" }, "OnboardingTrackerTrackerIdGetResponsesContentApplicationJsonSchemaDataContract": { "description": "Information about the contract", "properties": { "client_signed_at": { "description": "Timestamp when the client signed the contract", "format": "date-time", "type": [ "string", "null" ] }, "completion_date": { "description": "The completion date of the contract, if applicable", "format": "date-time", "type": [ "string", "null" ] }, "contractor_signed_at": { "description": "Timestamp when the contractor signed the contract", "format": "date-time", "type": [ "string", "null" ] }, "created_at": { "description": "Contract creation timestamp", "format": "date-time", "type": "string" }, "employee_agreement": { "$ref": "#/components/schemas/OnboardingTrackerTrackerIdGetResponsesContentApplicationJsonSchemaDataContractEmployeeAgreement", "description": "Information about the Employment Agreement" }, "first_early_invoice": { "description": "Applicable only for EOR contracts. First early invoice (EOR funding statement) for the contract, if any", "oneOf": [ { "$ref": "#/components/schemas/OnboardingTrackerTrackerIdGetResponsesContentApplicationJsonSchemaDataContractFirstEarlyInvoice" }, { "type": "null" } ] }, "first_sign": { "description": "The first sign (either 'client' or 'contractor')", "type": "string" }, "id": { "description": "Unique contract ID", "type": "string" }, "invited_contractor_email": { "description": "Email of the invited contractor", "format": "email", "type": [ "string", "null" ] }, "is_pwac": { "description": "Whether the worker is a person without a contract", "type": "boolean" }, "name": { "description": "Contract name", "type": "string" }, "oid": { "description": "Contract OID", "type": "string" }, "status": { "description": "Contract status (e.g., in_progress)", "type": "string" } }, "title": "OnboardingTrackerTrackerIdGetResponsesContentApplicationJsonSchemaDataContract", "type": "object" }, "OnboardingTrackerTrackerIdGetResponsesContentApplicationJsonSchemaDataContractEmployeeAgreement": { "description": "Information about the Employment Agreement", "properties": { "phase": { "description": "Signing-lifecycle phase that produced the current Employment Agreement PDF. Can be null if the EA has not yet been generated", "oneOf": [ { "$ref": "#/components/schemas/OnboardingTrackerTrackerIdGetResponsesContentApplicationJsonSchemaDataContractEmployeeAgreementPhase" }, { "type": "null" } ] }, "status": { "description": "Status of the Employment Agreement. Can be null if the EA has not yet been generated", "type": [ "string", "null" ] }, "version_hash": { "description": "Version of the Employment Agreement. Can be null if the EA has not yet been generated", "type": [ "string", "null" ] } }, "title": "OnboardingTrackerTrackerIdGetResponsesContentApplicationJsonSchemaDataContractEmployeeAgreement", "type": "object" }, "OnboardingTrackerTrackerIdGetResponsesContentApplicationJsonSchemaDataContractEmployeeAgreementPhase": { "description": "Signing-lifecycle phase that produced the current Employment Agreement PDF. Can be null if the EA has not yet been generated", "enum": [ "unsigned", "employee_signed", "countersigned" ], "title": "OnboardingTrackerTrackerIdGetResponsesContentApplicationJsonSchemaDataContractEmployeeAgreementPhase", "type": "string" }, "OnboardingTrackerTrackerIdGetResponsesContentApplicationJsonSchemaDataContractFirstEarlyInvoice": { "description": "Applicable only for EOR contracts. First early invoice (EOR funding statement) for the contract, if any", "properties": { "amount": { "description": "Invoice amount", "type": "string" }, "currency": { "description": "Currency code for the invoice amount", "type": "string" }, "description": { "description": "Invoice description", "type": "string" }, "due_date": { "description": "Due date for the invoice", "format": "date-time", "type": [ "string", "null" ] }, "id": { "description": "Unique invoice ID", "type": "string" }, "paid_at": { "description": "Timestamp when the invoice was paid, if applicable", "format": "date-time", "type": [ "string", "null" ] }, "status": { "$ref": "#/components/schemas/OnboardingTrackerTrackerIdGetResponsesContentApplicationJsonSchemaDataContractFirstEarlyInvoiceStatus", "description": "Status of the invoice" } }, "title": "OnboardingTrackerTrackerIdGetResponsesContentApplicationJsonSchemaDataContractFirstEarlyInvoice", "type": "object" }, "OnboardingTrackerTrackerIdGetResponsesContentApplicationJsonSchemaDataContractFirstEarlyInvoiceStatus": { "description": "Status of the invoice", "enum": [ "OPEN", "PENDING", "SKIPPED", "PREPROCESSING", "PROCESSING", "CREDITED", "PROCESSED", "PAID", "FAILED", "CANCELLED", "REFUNDED", "UNPAYABLE", "AWAITING_PAYMENT" ], "title": "OnboardingTrackerTrackerIdGetResponsesContentApplicationJsonSchemaDataContractFirstEarlyInvoiceStatus", "type": "string" }, "OnboardingTrackerTrackerIdGetResponsesContentApplicationJsonSchemaDataContractsItems": { "properties": { "contract_oid": { "description": "The unique identifier for the contract", "type": [ "string", "null" ] }, "entity": { "description": "The legal entity the contract sits under. Null when there is none", "oneOf": [ { "$ref": "#/components/schemas/OnboardingTrackerTrackerIdGetResponsesContentApplicationJsonSchemaDataContractsItemsEntity" }, { "type": "null" } ] }, "is_attention_needed": { "description": "Whether the onboarding on this contract is overdue or at risk", "type": "boolean" }, "is_current": { "description": "Whether this is the contract the overview is about", "type": "boolean" }, "is_main": { "description": "Whether this is the main contract of the worker: the most urgent status, then a new contract before a person without a contract, then the latest start date, then the latest created contract", "type": "boolean" }, "is_pwac": { "description": "Whether the contract is the placeholder contract of a person without a contract", "type": "boolean" }, "job_title": { "description": "The job title on the contract", "type": [ "string", "null" ] }, "lifecycle_status": { "$ref": "#/components/schemas/OnboardingTrackerTrackerIdGetResponsesContentApplicationJsonSchemaDataContractsItemsLifecycleStatus", "description": "Lifecycle status of this contract, the same value the People list shows for it" }, "start_date": { "description": "The start date of the contract", "format": "date", "type": [ "string", "null" ] }, "status": { "$ref": "#/components/schemas/OnboardingTrackerTrackerIdGetResponsesContentApplicationJsonSchemaDataContractsItemsStatus", "description": "Current status of the onboarding on this contract" }, "tracker_id": { "description": "The tracker identifier that loads this contract", "type": "string" }, "worker_type": { "$ref": "#/components/schemas/OnboardingTrackerTrackerIdGetResponsesContentApplicationJsonSchemaDataContractsItemsWorkerType", "description": "The worker type of the contract, as the hiring_types filter takes it" } }, "title": "OnboardingTrackerTrackerIdGetResponsesContentApplicationJsonSchemaDataContractsItems", "type": "object" }, "OnboardingTrackerTrackerIdGetResponsesContentApplicationJsonSchemaDataContractsItemsEntity": { "description": "The legal entity the contract sits under. Null when there is none", "properties": { "id": { "description": "The unique identifier for the legal entity", "type": "string" }, "name": { "description": "The name of the legal entity. A Deel entity that a contractor of record works under ends in (COR)", "type": [ "string", "null" ] } }, "title": "OnboardingTrackerTrackerIdGetResponsesContentApplicationJsonSchemaDataContractsItemsEntity", "type": "object" }, "OnboardingTrackerTrackerIdGetResponsesContentApplicationJsonSchemaDataContractsItemsLifecycleStatus": { "description": "Lifecycle status of this contract, the same value the People list shows for it", "enum": [ "DRAFT", "IN_REVIEW", "QUOTE_REQUIRES_CHANGES", "PENDING_INVITE", "INVITED", "ONBOARDING", "ONBOARDING_AT_RISK", "ONBOARDING_OVERDUE", "OFFBOARDING", "ONBOARDED" ], "title": "OnboardingTrackerTrackerIdGetResponsesContentApplicationJsonSchemaDataContractsItemsLifecycleStatus", "type": "string" }, "OnboardingTrackerTrackerIdGetResponsesContentApplicationJsonSchemaDataContractsItemsStatus": { "description": "Current status of the onboarding on this contract", "enum": [ "ONBOARDING_AT_RISK", "ONBOARDING_OVERDUE", "INVITED", "ONBOARDING", "READY_TO_START", "INACTIVE", "PENDING_INVITE", "ACTIVE", "DRAFT", "OFFBOARDING", "QUOTE_REQUIRES_CHANGES", "IN_REVIEW", "IN_OFFER_STAGE" ], "title": "OnboardingTrackerTrackerIdGetResponsesContentApplicationJsonSchemaDataContractsItemsStatus", "type": "string" }, "OnboardingTrackerTrackerIdGetResponsesContentApplicationJsonSchemaDataContractsItemsWorkerType": { "description": "The worker type of the contract, as the hiring_types filter takes it", "enum": [ "contractor", "direct_employee", "hris_direct_employee", "hris_direct_contractor", "eor", "peo", "person_without_contract" ], "title": "OnboardingTrackerTrackerIdGetResponsesContentApplicationJsonSchemaDataContractsItemsWorkerType", "type": "string" }, "OnboardingTrackerTrackerIdGetResponsesContentApplicationJsonSchemaDataHrisProfile": { "description": "Employee HRIS profile information", "properties": { "direct_manager": { "description": "The direct manager of the employee, when one is set", "oneOf": [ { "$ref": "#/components/schemas/OnboardingTrackerTrackerIdGetResponsesContentApplicationJsonSchemaDataHrisProfileDirectManager" }, { "type": "null" } ] }, "email": { "description": "Email of the HRIS profile", "format": "email", "type": "string" }, "invitations": { "description": "Invitations to the employee that are not sent yet", "items": { "$ref": "#/components/schemas/OnboardingTrackerTrackerIdGetResponsesContentApplicationJsonSchemaDataHrisProfileInvitationsItems" }, "type": "array" }, "name": { "description": "HRIS Profile name", "type": "string" }, "oid": { "description": "HRIS Profile OID", "type": "string" }, "work_email": { "description": "Work email of the HRIS profile", "format": "email", "type": [ "string", "null" ] } }, "title": "OnboardingTrackerTrackerIdGetResponsesContentApplicationJsonSchemaDataHrisProfile", "type": "object" }, "OnboardingTrackerTrackerIdGetResponsesContentApplicationJsonSchemaDataHrisProfileDirectManager": { "description": "The direct manager of the employee, when one is set", "properties": { "job_title": { "description": "Job title of the manager", "type": [ "string", "null" ] }, "name": { "description": "Name of the manager", "type": [ "string", "null" ] }, "oid": { "description": "HRIS profile OID of the manager", "type": "string" }, "pic_url": { "description": "URL of the manager profile picture", "type": [ "string", "null" ] }, "work_email": { "description": "Work email of the manager", "format": "email", "type": [ "string", "null" ] } }, "title": "OnboardingTrackerTrackerIdGetResponsesContentApplicationJsonSchemaDataHrisProfileDirectManager", "type": "object" }, "OnboardingTrackerTrackerIdGetResponsesContentApplicationJsonSchemaDataHrisProfileInvitationsItems": { "properties": { "oid": { "description": "Invitation OID", "type": "string" }, "send_at": { "description": "When the invitation is or was sent", "format": "date-time", "type": [ "string", "null" ] }, "status": { "$ref": "#/components/schemas/OnboardingTrackerTrackerIdGetResponsesContentApplicationJsonSchemaDataHrisProfileInvitationsItemsStatus", "description": "Status of the invitation" }, "timezone": { "description": "Timezone the invitation is scheduled in", "type": [ "string", "null" ] } }, "title": "OnboardingTrackerTrackerIdGetResponsesContentApplicationJsonSchemaDataHrisProfileInvitationsItems", "type": "object" }, "OnboardingTrackerTrackerIdGetResponsesContentApplicationJsonSchemaDataHrisProfileInvitationsItemsStatus": { "description": "Status of the invitation", "enum": [ "SENT", "DISABLED", "SUSPENDED", "SCHEDULED", "FAILED" ], "title": "OnboardingTrackerTrackerIdGetResponsesContentApplicationJsonSchemaDataHrisProfileInvitationsItemsStatus", "type": "string" }, "OnboardingTrackerTrackerIdGetResponsesContentApplicationJsonSchemaDataProfile": { "description": "Employee profile information", "properties": { "country": { "description": "Country code", "type": [ "string", "null" ] }, "email": { "description": "Email of the profile", "format": "email", "type": "string" }, "id": { "description": "Internal ID of the profile", "type": "integer" }, "last_login": { "description": "Last login timestamp", "format": "date-time", "type": "string" }, "name": { "description": "Name associated with the profile", "type": "string" }, "paid_invoices": { "description": "A paid invoice on the contract, if any, at most one. Only for a contractor, empty for other worker types", "items": { "$ref": "#/components/schemas/OnboardingTrackerTrackerIdGetResponsesContentApplicationJsonSchemaDataProfilePaidInvoicesItems" }, "type": "array" }, "pic_url": { "description": "URL of the profile picture", "type": [ "string", "null" ] }, "previously_onboarded": { "description": "Indicates if the contractor has previously onboarded", "type": "boolean" } }, "title": "OnboardingTrackerTrackerIdGetResponsesContentApplicationJsonSchemaDataProfile", "type": "object" }, "OnboardingTrackerTrackerIdGetResponsesContentApplicationJsonSchemaDataProfilePaidInvoicesItems": { "properties": { "id": { "description": "Internal ID of the invoice", "type": "integer" }, "status": { "description": "Status of the invoice", "type": "string" } }, "title": "OnboardingTrackerTrackerIdGetResponsesContentApplicationJsonSchemaDataProfilePaidInvoicesItems", "type": "object" }, "OnboardingTrackerTrackerIdGetResponsesContentApplicationJsonSchemaDataProgress": { "description": "Progress of the onboarding process", "properties": { "is_action_required_from_client": { "description": "Indicates if action is required from the client", "type": "boolean" }, "reference_date": { "description": "Reference date for the progress", "format": "date-time", "type": "string" }, "reference_date_timezone": { "description": "Timezone of the reference date", "type": "string" }, "status": { "description": "Current status of the onboarding process (e.g., ACTIVE)", "type": "string" }, "sub_status": { "description": "Finer state within the status, when there is one", "oneOf": [ { "$ref": "#/components/schemas/OnboardingTrackerTrackerIdGetResponsesContentApplicationJsonSchemaDataProgressSubStatus" }, { "type": "null" } ] }, "subject_to_overdue": { "description": "Indicates if the onboarding is subject to overdue", "type": "boolean" } }, "title": "OnboardingTrackerTrackerIdGetResponsesContentApplicationJsonSchemaDataProgress", "type": "object" }, "OnboardingTrackerTrackerIdGetResponsesContentApplicationJsonSchemaDataProgressSubStatus": { "description": "Finer state within the status, when there is one", "enum": [ "PENDING_INVITE", "INVITED", "ONBOARDING", "AWAITING_CLIENT_REVIEW", "CANCELLED", "REJECTED" ], "title": "OnboardingTrackerTrackerIdGetResponsesContentApplicationJsonSchemaDataProgressSubStatus", "type": "string" }, "OnboardingTrackerTrackerIdGetResponsesContentApplicationJsonSchemaDataStepperItems": { "description": "Stepper action information", "properties": { "completed_at": { "description": "Completion timestamp of the stepper action", "format": "date-time", "type": [ "string", "null" ] }, "data": { "$ref": "#/components/schemas/OnboardingTrackerTrackerIdGetResponsesContentApplicationJsonSchemaDataStepperItemsData" }, "type": { "description": "Type of the stepper action", "type": "string" } }, "title": "OnboardingTrackerTrackerIdGetResponsesContentApplicationJsonSchemaDataStepperItems", "type": "object" }, "OnboardingTrackerTrackerIdGetResponsesContentApplicationJsonSchemaDataStepperItemsData": { "properties": { "completed": { "description": "Checklist steps completed, on the checklist progress step", "type": "integer" }, "emails": { "description": "List of emails sent during the stepper process", "items": { "$ref": "#/components/schemas/OnboardingTrackerTrackerIdGetResponsesContentApplicationJsonSchemaDataStepperItemsDataEmailsItems" }, "type": "array" }, "next_reminder_date": { "description": "Next reminder date, if applicable", "format": "date-time", "type": [ "string", "null" ] }, "onboarding_due_date": { "description": "When onboarding is due, on the checklist progress step", "format": "date-time", "type": [ "string", "null" ] }, "remaining": { "description": "Checklist steps remaining, on the checklist progress step", "type": "integer" }, "total": { "description": "Checklist steps in total, on the checklist progress step", "type": "integer" } }, "title": "OnboardingTrackerTrackerIdGetResponsesContentApplicationJsonSchemaDataStepperItemsData", "type": "object" }, "OnboardingTrackerTrackerIdGetResponsesContentApplicationJsonSchemaDataStepperItemsDataEmailsItems": { "properties": { "meta": { "$ref": "#/components/schemas/OnboardingTrackerTrackerIdGetResponsesContentApplicationJsonSchemaDataStepperItemsDataEmailsItemsMeta", "description": "Email metadata" } }, "title": "OnboardingTrackerTrackerIdGetResponsesContentApplicationJsonSchemaDataStepperItemsDataEmailsItems", "type": "object" }, "OnboardingTrackerTrackerIdGetResponsesContentApplicationJsonSchemaDataStepperItemsDataEmailsItemsMeta": { "description": "Email metadata", "properties": { "email": { "description": "Email address", "format": "email", "type": "string" }, "sent_at": { "description": "Timestamp when the email was sent", "format": "date-time", "type": "string" }, "type": { "description": "Type of email", "type": "string" } }, "title": "OnboardingTrackerTrackerIdGetResponsesContentApplicationJsonSchemaDataStepperItemsDataEmailsItemsMeta", "type": "object" }, "OnboardingTrackerTrackerIdGetResponsesContentApplicationJsonSchemaDataSummaryItems": { "description": "Summary item information", "properties": { "data": { "$ref": "#/components/schemas/OnboardingTrackerTrackerIdGetResponsesContentApplicationJsonSchemaDataSummaryItemsData", "description": "Additional data about the summary item" }, "name": { "description": "Name of the summary item", "type": "string" }, "type": { "description": "Type of the summary item", "type": "string" }, "value": { "$ref": "#/components/schemas/OnboardingTrackerTrackerIdGetResponsesContentApplicationJsonSchemaDataSummaryItemsValue", "description": "Value of the summary item" } }, "title": "OnboardingTrackerTrackerIdGetResponsesContentApplicationJsonSchemaDataSummaryItems", "type": "object" }, "OnboardingTrackerTrackerIdGetResponsesContentApplicationJsonSchemaDataSummaryItemsData": { "description": "Additional data about the summary item", "properties": { "country": { "description": "Country code for location-related summaries", "type": "string" }, "has_withdraw_methods": { "description": "Indicates if withdrawal methods exist", "type": "boolean" }, "timezone": { "description": "Timezone information", "type": "string" } }, "title": "OnboardingTrackerTrackerIdGetResponsesContentApplicationJsonSchemaDataSummaryItemsData", "type": "object" }, "OnboardingTrackerTrackerIdGetResponsesContentApplicationJsonSchemaDataSummaryItemsValue": { "description": "Value of the summary item", "oneOf": [ { "type": "string" }, { "format": "double", "type": "number" }, { "type": "boolean" }, { "format": "date-time", "type": "string" }, { "additionalProperties": { "description": "Any type" }, "type": "object" } ], "title": "OnboardingTrackerTrackerIdGetResponsesContentApplicationJsonSchemaDataSummaryItemsValue" }, "OnboardingTrackerTrackerIdGetResponsesContentApplicationJsonSchemaErrors": { "description": "The errors, as an object with an `errors` list, or as the list", "oneOf": [ { "$ref": "#/components/schemas/OnboardingTrackerTrackerIdGetResponsesContentApplicationJsonSchemaErrors0" }, { "$ref": "#/components/schemas/OnboardingTrackerTrackerIdGetResponsesContentApplicationJsonSchemaErrors1" } ], "title": "OnboardingTrackerTrackerIdGetResponsesContentApplicationJsonSchemaErrors" }, "OnboardingTrackerTrackerIdGetResponsesContentApplicationJsonSchemaErrors0": { "description": "The errors the endpoint returned", "properties": { "errors": { "description": "Error messages", "items": { "$ref": "#/components/schemas/OnboardingTrackerTrackerIdGetResponsesContentApplicationJsonSchemaErrorsOneOf0ErrorsItems" }, "type": "array" } }, "title": "OnboardingTrackerTrackerIdGetResponsesContentApplicationJsonSchemaErrors0", "type": "object" }, "OnboardingTrackerTrackerIdGetResponsesContentApplicationJsonSchemaErrors1": { "description": "Error messages", "items": { "$ref": "#/components/schemas/OnboardingTrackerTrackerIdGetResponsesContentApplicationJsonSchemaErrorsOneOf1Items" }, "title": "OnboardingTrackerTrackerIdGetResponsesContentApplicationJsonSchemaErrors1", "type": "array" }, "OnboardingTrackerTrackerIdGetResponsesContentApplicationJsonSchemaErrorsOneOf0ErrorsItems": { "properties": { "code": { "description": "Machine-readable error code", "type": "string" }, "context": { "additionalProperties": { "description": "Any type" }, "description": "Additional error context", "type": "object" }, "message": { "description": "Human-readable error message", "type": "string" }, "type": { "description": "Error category", "type": "string" } }, "required": [ "code", "type", "message" ], "title": "OnboardingTrackerTrackerIdGetResponsesContentApplicationJsonSchemaErrorsOneOf0ErrorsItems", "type": "object" }, "OnboardingTrackerTrackerIdGetResponsesContentApplicationJsonSchemaErrorsOneOf1Items": { "properties": { "code": { "description": "Machine-readable error code", "type": "string" }, "context": { "additionalProperties": { "description": "Any type" }, "description": "Additional error context", "type": "object" }, "message": { "description": "Human-readable error message", "type": "string" }, "type": { "description": "Error category", "type": "string" } }, "required": [ "code", "type", "message" ], "title": "OnboardingTrackerTrackerIdGetResponsesContentApplicationJsonSchemaErrorsOneOf1Items", "type": "object" }, "OnboardingTrackerTrackerIdGetResponsesContentApplicationJsonSchemaRequest": { "description": "Error request details", "properties": { "api_req_id": { "description": "The request ID", "type": "string" }, "docs": { "description": "Link to the documentation of the endpoint, or `no match` when there is none", "type": "string" }, "method": { "description": "Method of the API", "type": "string" }, "source": { "description": "The source handler that produced the error", "type": "string" }, "status": { "description": "Status of API response", "format": "double", "type": "number" }, "url": { "description": "The request URL", "type": "string" } }, "title": "OnboardingTrackerTrackerIdGetResponsesContentApplicationJsonSchemaRequest", "type": "object" }, "OnboardingWorkersIndividualPostRequestBodyContentApplicationJsonSchemaData": { "properties": { "abn": { "description": "Australian Business Number (11 digits). Required when tax_residence is AU.", "type": "string" }, "address_confirmed_by_user": { "description": "Whether the user has confirmed the address is correct.", "type": "boolean" }, "address_valid": { "description": "Whether the provided address has been validated.", "type": "boolean" }, "citizen": { "description": "Citizenship country as an ISO 3166-1 alpha-2 code.", "type": "string" }, "city": { "description": "City of residence.", "type": "string" }, "country": { "description": "Country of residence as an ISO 3166-1 alpha-2 code.", "type": "string" }, "entity_tax_residence": { "description": "Tax residence country for the entity, if different from the individual.", "type": "string" }, "id_type": { "description": "Type of identification document provided.", "type": "string" }, "legal_status": { "description": "Legal status of the individual contractor.", "type": "string" }, "personal_id": { "description": "Passport or national ID number. Required when tax_residence is not US.", "type": "string" }, "phone": { "description": "Phone number in E.164 format.", "type": "string" }, "province": { "description": "Province or state code within the country.", "type": "string" }, "ssn": { "description": "Social Security Number (9 digits, no dashes). Required when tax_residence is US.", "type": "string" }, "street": { "description": "Street address of the contractor.", "type": "string" }, "tax_residence": { "description": "Tax residence country as an ISO 3166-1 alpha-2 code. Defaults to the country field if omitted.", "type": "string" }, "timezone": { "description": "IANA timezone identifier.", "type": "string" }, "zip": { "description": "Postal or ZIP code.", "type": "string" } }, "required": [ "zip", "city", "street", "citizen", "country", "legal_status" ], "title": "OnboardingWorkersIndividualPostRequestBodyContentApplicationJsonSchemaData", "type": "object" }, "OnboardingWorkersIndividualPostResponsesContentApplicationJsonSchemaData": { "properties": { "abn": { "description": "Australian Business Number (11 digits).", "type": "string" }, "address_confirmed_by_user": { "description": "Whether the user has confirmed the address is correct.", "type": "boolean" }, "address_valid": { "description": "Whether the provided address has been validated.", "type": "boolean" }, "citizen": { "description": "Citizenship country as an ISO 3166-1 alpha-2 code.", "type": "string" }, "city": { "description": "City of residence.", "type": "string" }, "company_type": { "description": "Type of company set up for the contractor.", "type": "string" }, "country": { "description": "Country of residence as an ISO 3166-1 alpha-2 code.", "type": "string" }, "entity_tax_residence": { "description": "Tax residence country for the entity, if different from the individual.", "type": "string" }, "id_type": { "description": "Type of identification document provided.", "type": "string" }, "legal_status": { "description": "Legal status of the individual contractor.", "type": "string" }, "onboarding_step": { "description": "Current onboarding step after setup completes.", "type": [ "string", "null" ] }, "personal_id": { "description": "Passport or national ID number.", "type": "string" }, "phone": { "description": "Phone number in E.164 format.", "type": "string" }, "profile_id": { "description": "Internal profile identifier for the contractor.", "type": "integer" }, "province": { "description": "Province or state code within the country.", "type": "string" }, "ssn": { "description": "Social Security Number (9 digits).", "type": "string" }, "street": { "description": "Street address of the contractor.", "type": "string" }, "tax_residence": { "description": "Tax residence country as an ISO 3166-1 alpha-2 code.", "type": "string" }, "timezone": { "description": "IANA timezone identifier.", "type": "string" }, "zip": { "description": "Postal or ZIP code.", "type": "string" } }, "required": [ "profile_id", "company_type" ], "title": "OnboardingWorkersIndividualPostResponsesContentApplicationJsonSchemaData", "type": "object" }, "OnboardingWorkersIndividualPostResponsesContentApplicationJsonSchemaErrorsItems": { "properties": { "code": { "description": "Machine-readable error code", "type": "string" }, "message": { "description": "Human-readable explanation of the error", "type": "string" } }, "title": "OnboardingWorkersIndividualPostResponsesContentApplicationJsonSchemaErrorsItems", "type": "object" }, "Onboarding_getOnboardingDetailsByEmployeeHrisProfileId-v2026-01-01_Response_200": { "properties": { "data": { "$ref": "#/components/schemas/OnboardingTrackerHrisProfileHrisProfileIdGetResponsesContentApplicationJsonSchemaData" } }, "title": "Onboarding_getOnboardingDetailsByEmployeeHrisProfileId-v2026-01-01_Response_200", "type": "object" }, "Onboarding_getOnboardingDetailsByOnboardingTrackerId-v2026-01-01_Response_200": { "properties": { "data": { "$ref": "#/components/schemas/OnboardingTrackerTrackerIdGetResponsesContentApplicationJsonSchemaData" } }, "title": "Onboarding_getOnboardingDetailsByOnboardingTrackerId-v2026-01-01_Response_200", "type": "object" }, "Onboarding_listOnboardingEmployees-v2026-01-01_Response_200": { "properties": { "data": { "items": { "$ref": "#/components/schemas/OnboardingTrackerGetResponsesContentApplicationJsonSchemaDataItems" }, "type": "array" }, "page": { "$ref": "#/components/schemas/OnboardingTrackerGetResponsesContentApplicationJsonSchemaPage" } }, "title": "Onboarding_listOnboardingEmployees-v2026-01-01_Response_200", "type": "object" }, "Organization_Tasks_listOrganizationTasks-v2026-03-03_Response_200": { "properties": { "data": { "description": "List of task objects for the organization.", "items": { "$ref": "#/components/schemas/OrganizationsTasksGetResponsesContentApplicationJsonSchemaDataItems" }, "type": "array" }, "has_more": { "description": "Flag to highlight if there are more items to be fetched.", "type": "boolean" }, "next_cursor": { "description": "Cursor to request the next page; null if there are no more pages.", "type": [ "string", "null" ] }, "total_count": { "description": "Total number of tasks matching the filter.", "minimum": 0, "type": "integer" } }, "required": [ "data", "has_more", "next_cursor", "total_count" ], "title": "Organization Tasks_listOrganizationTasks-v2026-03-03_Response_200", "type": "object" }, "OrganizationsChildrenAdminsPostParametersXBeta": { "default": "true", "enum": [ "true" ], "title": "OrganizationsChildrenAdminsPostParametersXBeta", "type": "string" }, "OrganizationsChildrenAdminsPostRequestBodyContentApplicationJsonSchemaData": { "description": "The request payload.", "properties": { "admins": { "description": "The people to add as admins of every submitted child organization.", "items": { "$ref": "#/components/schemas/OrganizationsChildrenAdminsPostRequestBodyContentApplicationJsonSchemaDataAdminsItems" }, "type": "array" }, "child_org_ids": { "description": "Public ids of the target child organizations, as returned in the id field of the create child organization response. Every id must be a direct child organization of the authenticated organization. The number of admins multiplied by the number of child organizations must not exceed 100.", "items": { "format": "uuid", "type": "string" }, "type": "array" } }, "required": [ "admins", "child_org_ids" ], "title": "OrganizationsChildrenAdminsPostRequestBodyContentApplicationJsonSchemaData", "type": "object" }, "OrganizationsChildrenAdminsPostRequestBodyContentApplicationJsonSchemaDataAdminsItems": { "properties": { "email": { "description": "The email of the person. Each email may appear once per request, ignoring case.", "format": "email", "maxLength": 255, "type": "string" }, "first_name": { "description": "The first name of the person. Used only when the email has no Deel account yet.", "maxLength": 100, "minLength": 1, "type": "string" }, "last_name": { "description": "The last name of the person. Used only when the email has no Deel account yet.", "maxLength": 100, "minLength": 1, "type": "string" } }, "required": [ "email", "last_name", "first_name" ], "title": "OrganizationsChildrenAdminsPostRequestBodyContentApplicationJsonSchemaDataAdminsItems", "type": "object" }, "OrganizationsChildrenAdminsPostResponsesContentApplicationJsonSchemaData": { "description": "The outcome of the request.", "properties": { "items": { "description": "One item per admin and child organization pair of the request.", "items": { "$ref": "#/components/schemas/OrganizationsChildrenAdminsPostResponsesContentApplicationJsonSchemaDataItemsItems" }, "type": "array" } }, "required": [ "items" ], "title": "OrganizationsChildrenAdminsPostResponsesContentApplicationJsonSchemaData", "type": "object" }, "OrganizationsChildrenAdminsPostResponsesContentApplicationJsonSchemaDataItemsItems": { "properties": { "child_org_id": { "description": "The public id of the child organization.", "format": "uuid", "type": "string" }, "email": { "description": "The email of the admin, as submitted.", "format": "email", "type": "string" }, "status": { "$ref": "#/components/schemas/OrganizationsChildrenAdminsPostResponsesContentApplicationJsonSchemaDataItemsItemsStatus", "description": "The outcome for the pair. ADDED means the person is now an admin of the child organization: a person who was not a member is added with the admin role and receives the invitation email, and a member with another role is made an admin. ALREADY_ADMIN means the person already was, and nothing changed or was sent. FAILED means the pair could not be processed; the other pairs are unaffected and the same request can be retried." } }, "required": [ "email", "status", "child_org_id" ], "title": "OrganizationsChildrenAdminsPostResponsesContentApplicationJsonSchemaDataItemsItems", "type": "object" }, "OrganizationsChildrenAdminsPostResponsesContentApplicationJsonSchemaDataItemsItemsStatus": { "description": "The outcome for the pair. ADDED means the person is now an admin of the child organization: a person who was not a member is added with the admin role and receives the invitation email, and a member with another role is made an admin. ALREADY_ADMIN means the person already was, and nothing changed or was sent. FAILED means the pair could not be processed; the other pairs are unaffected and the same request can be retried.", "enum": [ "ADDED", "ALREADY_ADMIN", "FAILED" ], "title": "OrganizationsChildrenAdminsPostResponsesContentApplicationJsonSchemaDataItemsItemsStatus", "type": "string" }, "OrganizationsChildrenAdminsPostResponsesContentApplicationJsonSchemaErrorsItems": { "properties": { "code": { "description": "Machine-readable error code.", "type": "string" }, "message": { "description": "Human-readable explanation of the error.", "type": "string" } }, "required": [ "code", "message" ], "title": "OrganizationsChildrenAdminsPostResponsesContentApplicationJsonSchemaErrorsItems", "type": "object" }, "OrganizationsChildrenChildOrganizationIdSessionPostResponsesContentApplicationJsonSchemaData": { "description": "The issued session token.", "properties": { "expires_at": { "description": "ISO 8601 timestamp when the session token expires (6 hours from issuance).", "format": "date-time", "type": "string" }, "token": { "description": "The short-lived session token for the child organisation.", "type": "string" } }, "required": [ "token", "expires_at" ], "title": "OrganizationsChildrenChildOrganizationIdSessionPostResponsesContentApplicationJsonSchemaData", "type": "object" }, "OrganizationsChildrenChildOrganizationIdSessionPostResponsesContentApplicationJsonSchemaErrorsItems": { "properties": { "code": { "description": "Machine-readable error code.", "type": "string" }, "message": { "description": "Human-readable description of the error.", "type": "string" } }, "required": [ "message" ], "title": "OrganizationsChildrenChildOrganizationIdSessionPostResponsesContentApplicationJsonSchemaErrorsItems", "type": "object" }, "OrganizationsChildrenPostRequestBodyContentApplicationJsonSchemaData": { "description": "The request payload.", "properties": { "child_admins": { "description": "People from the child organization to add as its admins. Each person receives an invite to the child organization.", "items": { "$ref": "#/components/schemas/OrganizationsChildrenPostRequestBodyContentApplicationJsonSchemaDataChildAdminsItems" }, "type": "array" }, "child_organization": { "$ref": "#/components/schemas/OrganizationsChildrenPostRequestBodyContentApplicationJsonSchemaDataChildOrganization", "description": "The object that contains all the information related to the child organization that will be created." }, "parent_admin_emails": { "description": "More admins of the parent organization to add as admins of the child organization, as the Partner Portal create form does. Every email must belong to an existing admin of the parent organization, otherwise creation fails and no child organization is created. Each admin receives an invite to the child organization.", "items": { "format": "email", "maxLength": 255, "type": "string" }, "type": "array" }, "parent_organization": { "$ref": "#/components/schemas/OrganizationsChildrenPostRequestBodyContentApplicationJsonSchemaDataParentOrganization", "description": "The object that contains the information related to the parent_organization." } }, "required": [ "child_organization", "parent_organization" ], "title": "OrganizationsChildrenPostRequestBodyContentApplicationJsonSchemaData", "type": "object" }, "OrganizationsChildrenPostRequestBodyContentApplicationJsonSchemaDataChildAdminsItems": { "description": "A person from the child organization who becomes one of its admins.", "properties": { "email": { "description": "The email of the person from the child organization.", "format": "email", "maxLength": 255, "type": "string" }, "first_name": { "description": "The first name of the person from the child organization.", "maxLength": 100, "type": "string" }, "last_name": { "description": "The last name of the person from the child organization.", "maxLength": 100, "type": "string" } }, "required": [ "email", "last_name", "first_name" ], "title": "OrganizationsChildrenPostRequestBodyContentApplicationJsonSchemaDataChildAdminsItems", "type": "object" }, "OrganizationsChildrenPostRequestBodyContentApplicationJsonSchemaDataChildOrganization": { "description": "The object that contains all the information related to the child organization that will be created.", "properties": { "department": { "default": "Founder", "description": "The department's name where the manager will be added. Defaults to \"Founder\" when omitted.", "maxLength": 255, "type": "string" }, "headquarters_country": { "description": "The organization's headquarters country as an ISO 3166-1 alpha-2 code. Validated against Deel's country whitelist; unknown codes are rejected.", "maxLength": 2, "minLength": 2, "type": "string" }, "is_api_enabled": { "default": false, "description": "The flag that enables the public API for the child organization. Defaults to false when omitted.", "type": "boolean" }, "name": { "description": "The organization's name.", "maxLength": 255, "type": "string" }, "workforce_size": { "description": "The workforce size of the child organization.", "maximum": 1000000, "minimum": 1, "type": "integer" } }, "required": [ "name" ], "title": "OrganizationsChildrenPostRequestBodyContentApplicationJsonSchemaDataChildOrganization", "type": "object" }, "OrganizationsChildrenPostRequestBodyContentApplicationJsonSchemaDataParentOrganization": { "description": "The object that contains the information related to the parent_organization.", "properties": { "admin_email": { "description": "The email of one of the managers of the parent organization. It must belong to an existing admin/manager of the parent organization, otherwise creation fails. This manager is the user that creates the child organization.", "format": "email", "type": "string" } }, "required": [ "admin_email" ], "title": "OrganizationsChildrenPostRequestBodyContentApplicationJsonSchemaDataParentOrganization", "type": "object" }, "OrganizationsChildrenPostResponsesContentApplicationJsonSchemaData": { "properties": { "created_at": { "description": "When the created child organization was created (ISO 8601 format)", "format": "date-time", "type": "string" }, "id": { "description": "The unique identifier of the created child organization.", "type": "string" }, "token": { "description": "The API token generated for the created child organization", "type": "string" }, "updated_at": { "description": "When the created child organization was updated for the last time (ISO 8601 format)", "format": "date-time", "type": "string" } }, "required": [ "id", "token", "created_at", "updated_at" ], "title": "OrganizationsChildrenPostResponsesContentApplicationJsonSchemaData", "type": "object" }, "OrganizationsChildrenPostResponsesContentApplicationJsonSchemaErrorsItems": { "properties": { "code": { "description": "Machine-readable error code", "type": "string" }, "message": { "description": "Human-readable explanation of the error", "type": "string" } }, "title": "OrganizationsChildrenPostResponsesContentApplicationJsonSchemaErrorsItems", "type": "object" }, "OrganizationsChildrenPostResponsesContentApplicationJsonSchemaRequest": { "properties": { "api_req_id": { "description": "The request ID of the failed request", "type": "string" }, "code": { "description": "The code of the source handler which produced the returned error", "format": "double", "type": "number" }, "docs": { "description": "A link to the official documentation for the requested endpoint resource", "type": "string" }, "method": { "description": "The HTTP method of the failed request", "type": "string" }, "source": { "description": "The source handler which produced the returned error", "type": "string" }, "status": { "description": "The status code of the response", "format": "double", "type": "number" }, "url": { "description": "The relative URL of the failed request", "type": "string" } }, "title": "OrganizationsChildrenPostResponsesContentApplicationJsonSchemaRequest", "type": "object" }, "OrganizationsDealRegistrationsPostParametersXBeta": { "default": "true", "enum": [ "true" ], "title": "OrganizationsDealRegistrationsPostParametersXBeta", "type": "string" }, "OrganizationsDealRegistrationsPostRequestBodyContentApplicationJsonSchemaData": { "description": "The request payload.", "properties": { "company_domain": { "description": "The end client's company domain. A scheme, a \"www.\" prefix and a path are accepted and stripped before matching.", "maxLength": 255, "minLength": 4, "type": "string" }, "company_name": { "description": "The end client's legal company name.", "maxLength": 255, "minLength": 1, "type": "string" }, "countries": { "description": "Optional ISO 3166-1 alpha-2 codes for the countries the deal covers.", "items": { "maxLength": 2, "minLength": 2, "type": "string" }, "type": "array" }, "expected_deal_size": { "description": "The expected annual contract value of the deal.", "format": "double", "maximum": 1000000000, "minimum": 1, "type": "number" }, "products": { "description": "The Deel products the partner expects to sell.", "items": { "$ref": "#/components/schemas/OrganizationsDealRegistrationsPostRequestBodyContentApplicationJsonSchemaDataProductsItems" }, "type": "array" }, "region": { "$ref": "#/components/schemas/OrganizationsDealRegistrationsPostRequestBodyContentApplicationJsonSchemaDataRegion", "description": "The sales region the deal belongs to." } }, "required": [ "region", "products", "company_name", "company_domain", "expected_deal_size" ], "title": "OrganizationsDealRegistrationsPostRequestBodyContentApplicationJsonSchemaData", "type": "object" }, "OrganizationsDealRegistrationsPostRequestBodyContentApplicationJsonSchemaDataProductsItems": { "enum": [ "EOR", "IC", "COR", "GP", "Contractor Management", "US Payroll", "PEO", "Immigration", "Deel HR", "Deel IT" ], "title": "OrganizationsDealRegistrationsPostRequestBodyContentApplicationJsonSchemaDataProductsItems", "type": "string" }, "OrganizationsDealRegistrationsPostRequestBodyContentApplicationJsonSchemaDataRegion": { "description": "The sales region the deal belongs to.", "enum": [ "NAM", "EMEA", "APAC", "LATAM" ], "title": "OrganizationsDealRegistrationsPostRequestBodyContentApplicationJsonSchemaDataRegion", "type": "string" }, "OrganizationsDealRegistrationsPostResponsesContentApplicationJsonSchemaData": { "properties": { "approved_at": { "description": "The date the registration was approved. Present only when the status is APPROVED.", "format": "date", "type": "string" }, "company_domain": { "description": "The normalised root domain stored on the registration. Absent when the status is REJECTED.", "type": "string" }, "company_name": { "description": "The company name stored on the registration. Absent when the status is REJECTED.", "type": "string" }, "countries": { "description": "The countries stored on the registration, or an empty array when none are stored. Absent when the status is REJECTED.", "items": { "type": "string" }, "type": "array" }, "expected_deal_size": { "description": "The expected deal size stored on the registration. Absent when the status is REJECTED.", "format": "double", "type": "number" }, "expires_at": { "description": "The date the 90-day protection window ends. Present only when the status is APPROVED.", "format": "date", "type": "string" }, "message": { "description": "A generic ineligibility message. Present only when the status is REJECTED. It is deliberately identical for every rejection reason.", "type": "string" }, "products": { "description": "The products stored on the registration. Absent when the status is REJECTED.", "items": { "type": "string" }, "type": "array" }, "region": { "description": "The region stored on the registration. Absent when the status is REJECTED.", "type": "string" }, "status": { "$ref": "#/components/schemas/OrganizationsDealRegistrationsPostResponsesContentApplicationJsonSchemaDataStatus", "description": "The eligibility outcome. APPROVED means the protection window is now active. REJECTED means the deal is not eligible." } }, "required": [ "status" ], "title": "OrganizationsDealRegistrationsPostResponsesContentApplicationJsonSchemaData", "type": "object" }, "OrganizationsDealRegistrationsPostResponsesContentApplicationJsonSchemaDataStatus": { "description": "The eligibility outcome. APPROVED means the protection window is now active. REJECTED means the deal is not eligible.", "enum": [ "APPROVED", "REJECTED" ], "title": "OrganizationsDealRegistrationsPostResponsesContentApplicationJsonSchemaDataStatus", "type": "string" }, "OrganizationsDealRegistrationsPostResponsesContentApplicationJsonSchemaErrorsItems": { "properties": { "code": { "description": "Machine-readable error code.", "type": "string" }, "message": { "description": "Human-readable explanation of the error.", "type": "string" } }, "required": [ "code", "message" ], "title": "OrganizationsDealRegistrationsPostResponsesContentApplicationJsonSchemaErrorsItems", "type": "object" }, "OrganizationsGetResponsesContentApplicationJsonSchemaDataItems": { "properties": { "id": { "description": "The unique identifier of the organization.", "format": "uuid", "type": "string" }, "name": { "description": "The name of the organization.", "minLength": 1, "type": "string" } }, "required": [ "id", "name" ], "title": "OrganizationsGetResponsesContentApplicationJsonSchemaDataItems", "type": "object" }, "OrganizationsSecureVaultFilesFileIdDeleteResponsesContentApplicationJsonSchemaErrorsItems": { "properties": { "code": { "description": "Machine-readable error code", "maxLength": 255, "type": "string" }, "field": { "description": "Field that caused the error, if applicable.", "type": [ "string", "null" ] }, "message": { "description": "Human-readable explanation", "type": "string" } }, "required": [ "message" ], "title": "OrganizationsSecureVaultFilesFileIdDeleteResponsesContentApplicationJsonSchemaErrorsItems", "type": "object" }, "OrganizationsSecureVaultFilesPostRequestBodyContentApplicationJsonSchemaData": { "description": "The files to attach to the Organization Secure Vault.", "properties": { "files": { "description": "Files previously uploaded to the File Service. Allowed types: pdf, jpg, jpeg, png, doc, docx, csv, xls, xlsx, txt, xml, zip, mov, mp4.", "items": { "$ref": "#/components/schemas/OrganizationsSecureVaultFilesPostRequestBodyContentApplicationJsonSchemaDataFilesItems" }, "type": "array" } }, "required": [ "files" ], "title": "OrganizationsSecureVaultFilesPostRequestBodyContentApplicationJsonSchemaData", "type": "object" }, "OrganizationsSecureVaultFilesPostRequestBodyContentApplicationJsonSchemaDataFilesItems": { "properties": { "content_type": { "description": "MIME type.", "maxLength": 255, "type": "string" }, "file_id": { "description": "File Service file id.", "format": "uuid", "type": "string" }, "one_time_secret": { "description": "File Service one-time secret.", "maxLength": 1024, "minLength": 1, "type": "string" }, "original_filename": { "description": "Original filename.", "maxLength": 500, "type": "string" } }, "required": [ "file_id", "content_type", "one_time_secret", "original_filename" ], "title": "OrganizationsSecureVaultFilesPostRequestBodyContentApplicationJsonSchemaDataFilesItems", "type": "object" }, "OrganizationsSecureVaultFilesPostResponsesContentApplicationJsonSchemaData": { "description": "Result of the upload.", "properties": { "file_ids": { "description": "Public UUIDs of the created Organization Secure Vault files, in upload order.", "items": { "format": "uuid", "type": "string" }, "type": "array" }, "folder": { "description": "Folder the files were stored in. When no folder is given, files land in the organization's \"Other Files\" folder.", "oneOf": [ { "$ref": "#/components/schemas/OrganizationsSecureVaultFilesPostResponsesContentApplicationJsonSchemaDataFolder" }, { "type": "null" } ] } }, "required": [ "file_ids" ], "title": "OrganizationsSecureVaultFilesPostResponsesContentApplicationJsonSchemaData", "type": "object" }, "OrganizationsSecureVaultFilesPostResponsesContentApplicationJsonSchemaDataFolder": { "description": "Folder the files were stored in. When no folder is given, files land in the organization's \"Other Files\" folder.", "properties": { "id": { "description": "Public UUID of the folder.", "format": "uuid", "type": [ "string", "null" ] }, "name": { "description": "Folder name.", "type": [ "string", "null" ] } }, "title": "OrganizationsSecureVaultFilesPostResponsesContentApplicationJsonSchemaDataFolder", "type": "object" }, "OrganizationsSecureVaultFilesPostResponsesContentApplicationJsonSchemaErrorsItems": { "properties": { "code": { "description": "Machine-readable error code", "maxLength": 255, "type": "string" }, "field": { "description": "Field that caused the error, if applicable.", "type": [ "string", "null" ] }, "message": { "description": "Human-readable explanation", "type": "string" } }, "required": [ "message" ], "title": "OrganizationsSecureVaultFilesPostResponsesContentApplicationJsonSchemaErrorsItems", "type": "object" }, "OrganizationsSecureVaultFoldersFolderIdDeleteResponsesContentApplicationJsonSchemaErrorsItems": { "properties": { "code": { "description": "Machine-readable error code", "maxLength": 255, "type": "string" }, "field": { "description": "Field that caused the error, if applicable.", "type": [ "string", "null" ] }, "message": { "description": "Human-readable explanation", "type": "string" } }, "required": [ "message" ], "title": "OrganizationsSecureVaultFoldersFolderIdDeleteResponsesContentApplicationJsonSchemaErrorsItems", "type": "object" }, "OrganizationsSecureVaultFoldersFolderIdFilesPostRequestBodyContentApplicationJsonSchemaData": { "description": "The files to attach to the Organization Secure Vault.", "properties": { "files": { "description": "Files previously uploaded to the File Service. Allowed types: pdf, jpg, jpeg, png, doc, docx, csv, xls, xlsx, txt, xml, zip, mov, mp4.", "items": { "$ref": "#/components/schemas/OrganizationsSecureVaultFoldersFolderIdFilesPostRequestBodyContentApplicationJsonSchemaDataFilesItems" }, "type": "array" } }, "required": [ "files" ], "title": "OrganizationsSecureVaultFoldersFolderIdFilesPostRequestBodyContentApplicationJsonSchemaData", "type": "object" }, "OrganizationsSecureVaultFoldersFolderIdFilesPostRequestBodyContentApplicationJsonSchemaDataFilesItems": { "properties": { "content_type": { "description": "MIME type.", "maxLength": 255, "type": "string" }, "file_id": { "description": "File Service file id.", "format": "uuid", "type": "string" }, "one_time_secret": { "description": "File Service one-time secret.", "maxLength": 1024, "minLength": 1, "type": "string" }, "original_filename": { "description": "Original filename.", "maxLength": 500, "type": "string" } }, "required": [ "file_id", "content_type", "one_time_secret", "original_filename" ], "title": "OrganizationsSecureVaultFoldersFolderIdFilesPostRequestBodyContentApplicationJsonSchemaDataFilesItems", "type": "object" }, "OrganizationsSecureVaultFoldersFolderIdFilesPostResponsesContentApplicationJsonSchemaData": { "description": "Result of the upload.", "properties": { "file_ids": { "description": "Public UUIDs of the created Organization Secure Vault files, in upload order.", "items": { "format": "uuid", "type": "string" }, "type": "array" }, "folder": { "description": "Folder the files were stored in. When no folder is given, files land in the organization's \"Other Files\" folder.", "oneOf": [ { "$ref": "#/components/schemas/OrganizationsSecureVaultFoldersFolderIdFilesPostResponsesContentApplicationJsonSchemaDataFolder" }, { "type": "null" } ] } }, "required": [ "file_ids" ], "title": "OrganizationsSecureVaultFoldersFolderIdFilesPostResponsesContentApplicationJsonSchemaData", "type": "object" }, "OrganizationsSecureVaultFoldersFolderIdFilesPostResponsesContentApplicationJsonSchemaDataFolder": { "description": "Folder the files were stored in. When no folder is given, files land in the organization's \"Other Files\" folder.", "properties": { "id": { "description": "Public UUID of the folder.", "format": "uuid", "type": [ "string", "null" ] }, "name": { "description": "Folder name.", "type": [ "string", "null" ] } }, "title": "OrganizationsSecureVaultFoldersFolderIdFilesPostResponsesContentApplicationJsonSchemaDataFolder", "type": "object" }, "OrganizationsSecureVaultFoldersFolderIdFilesPostResponsesContentApplicationJsonSchemaErrorsItems": { "properties": { "code": { "description": "Machine-readable error code", "maxLength": 255, "type": "string" }, "field": { "description": "Field that caused the error, if applicable.", "type": [ "string", "null" ] }, "message": { "description": "Human-readable explanation", "type": "string" } }, "required": [ "message" ], "title": "OrganizationsSecureVaultFoldersFolderIdFilesPostResponsesContentApplicationJsonSchemaErrorsItems", "type": "object" }, "OrganizationsSecureVaultFoldersFolderIdGetResponsesContentApplicationJsonSchemaData": { "description": "The folder.", "properties": { "ancestors": { "description": "Ancestor folders ordered from the root down to the direct parent.", "items": { "$ref": "#/components/schemas/OrganizationsSecureVaultFoldersFolderIdGetResponsesContentApplicationJsonSchemaDataAncestorsItems" }, "type": "array" }, "description": { "description": "Folder description.", "type": [ "string", "null" ] }, "has_upload_permission": { "description": "Whether the caller may upload files into this folder.", "type": "boolean" }, "id": { "description": "Public UUID of the folder.", "format": "uuid", "type": [ "string", "null" ] }, "is_sub_folder": { "description": "Whether the folder is nested under another folder.", "type": "boolean" }, "item_type": { "description": "Kind of folder.", "oneOf": [ { "$ref": "#/components/schemas/OrganizationsSecureVaultFoldersFolderIdGetResponsesContentApplicationJsonSchemaDataItemType" }, { "type": "null" } ] }, "name": { "description": "Folder name.", "type": [ "string", "null" ] }, "parent_folder_id": { "description": "Public UUID of the parent folder.", "format": "uuid", "type": [ "string", "null" ] } }, "required": [ "id", "name", "ancestors" ], "title": "OrganizationsSecureVaultFoldersFolderIdGetResponsesContentApplicationJsonSchemaData", "type": "object" }, "OrganizationsSecureVaultFoldersFolderIdGetResponsesContentApplicationJsonSchemaDataAncestorsItems": { "description": "An ancestor folder.", "properties": { "id": { "description": "Public UUID of the ancestor folder.", "format": "uuid", "type": "string" }, "name": { "description": "Name of the ancestor folder.", "type": "string" } }, "title": "OrganizationsSecureVaultFoldersFolderIdGetResponsesContentApplicationJsonSchemaDataAncestorsItems", "type": "object" }, "OrganizationsSecureVaultFoldersFolderIdGetResponsesContentApplicationJsonSchemaDataItemType": { "description": "Kind of folder.", "enum": [ "CUSTOM_FOLDER", "REGISTRATION_DOC_FOLDER", "DOCUMENTS_TO_SIGN_FOLDER" ], "title": "OrganizationsSecureVaultFoldersFolderIdGetResponsesContentApplicationJsonSchemaDataItemType", "type": "string" }, "OrganizationsSecureVaultFoldersFolderIdGetResponsesContentApplicationJsonSchemaErrorsItems": { "properties": { "code": { "description": "Machine-readable error code", "maxLength": 255, "type": "string" }, "field": { "description": "Field that caused the error, if applicable.", "type": [ "string", "null" ] }, "message": { "description": "Human-readable explanation", "type": "string" } }, "required": [ "message" ], "title": "OrganizationsSecureVaultFoldersFolderIdGetResponsesContentApplicationJsonSchemaErrorsItems", "type": "object" }, "OrganizationsSecureVaultFoldersFolderIdItemsGetResponsesContentApplicationJsonSchemaDataItems": { "properties": { "content_type": { "description": "MIME type. Files only.", "type": [ "string", "null" ] }, "created_at": { "description": "Creation timestamp.", "format": "date-time", "type": [ "string", "null" ] }, "description": { "description": "Folder description. Null for files.", "type": [ "string", "null" ] }, "folder_id": { "description": "Public UUID of the containing folder. Files only.", "format": "uuid", "type": [ "string", "null" ] }, "id": { "description": "Public UUID of the folder or file.", "format": "uuid", "type": [ "string", "null" ] }, "is_sub_folder": { "description": "Whether the folder is nested under another folder. Folders only.", "type": "boolean" }, "item_type": { "description": "Specific kind of folder or file.", "oneOf": [ { "$ref": "#/components/schemas/OrganizationsSecureVaultFoldersFolderIdItemsGetResponsesContentApplicationJsonSchemaDataItemsItemType" }, { "type": "null" } ] }, "name": { "description": "Folder name, or the original filename for a file.", "type": [ "string", "null" ] }, "parent_folder_id": { "description": "Parent folder public UUID. Folders only.", "format": "uuid", "type": [ "string", "null" ] }, "type": { "$ref": "#/components/schemas/OrganizationsSecureVaultFoldersFolderIdItemsGetResponsesContentApplicationJsonSchemaDataItemsType", "description": "Discriminates folders from files." }, "uploaded_by": { "description": "Who uploaded the file. Files only.", "oneOf": [ { "$ref": "#/components/schemas/OrganizationsSecureVaultFoldersFolderIdItemsGetResponsesContentApplicationJsonSchemaDataItemsUploadedBy" }, { "type": "null" } ] } }, "required": [ "id", "name", "type" ], "title": "OrganizationsSecureVaultFoldersFolderIdItemsGetResponsesContentApplicationJsonSchemaDataItems", "type": "object" }, "OrganizationsSecureVaultFoldersFolderIdItemsGetResponsesContentApplicationJsonSchemaDataItemsItemType": { "description": "Specific kind of folder or file.", "enum": [ "CUSTOM_FOLDER", "REGISTRATION_DOC_FOLDER", "DOCUMENTS_TO_SIGN_FOLDER", "REGISTRATION_DOC_FILE", "SECURE_FILE_VAULT_FILE", "DOCUMENTS_TO_SIGN_FILE" ], "title": "OrganizationsSecureVaultFoldersFolderIdItemsGetResponsesContentApplicationJsonSchemaDataItemsItemType", "type": "string" }, "OrganizationsSecureVaultFoldersFolderIdItemsGetResponsesContentApplicationJsonSchemaDataItemsType": { "description": "Discriminates folders from files.", "enum": [ "FOLDER", "FILE" ], "title": "OrganizationsSecureVaultFoldersFolderIdItemsGetResponsesContentApplicationJsonSchemaDataItemsType", "type": "string" }, "OrganizationsSecureVaultFoldersFolderIdItemsGetResponsesContentApplicationJsonSchemaDataItemsUploadedBy": { "description": "Who uploaded the file. Files only.", "properties": { "name": { "description": "Display name of the uploader.", "type": "string" } }, "title": "OrganizationsSecureVaultFoldersFolderIdItemsGetResponsesContentApplicationJsonSchemaDataItemsUploadedBy", "type": "object" }, "OrganizationsSecureVaultFoldersFolderIdItemsGetResponsesContentApplicationJsonSchemaErrorsItems": { "properties": { "code": { "description": "Machine-readable error code", "maxLength": 255, "type": "string" }, "field": { "description": "Field that caused the error, if applicable.", "type": [ "string", "null" ] }, "message": { "description": "Human-readable explanation", "type": "string" } }, "required": [ "message" ], "title": "OrganizationsSecureVaultFoldersFolderIdItemsGetResponsesContentApplicationJsonSchemaErrorsItems", "type": "object" }, "OrganizationsSecureVaultFoldersFolderIdPatchRequestBodyContentApplicationJsonSchemaData": { "description": "Fields to update on the folder.", "properties": { "description": { "description": "New folder description.", "maxLength": 2000, "type": [ "string", "null" ] }, "name": { "description": "New folder name.", "maxLength": 255, "minLength": 1, "type": "string" } }, "required": [ "name" ], "title": "OrganizationsSecureVaultFoldersFolderIdPatchRequestBodyContentApplicationJsonSchemaData", "type": "object" }, "OrganizationsSecureVaultFoldersFolderIdPatchResponsesContentApplicationJsonSchemaErrorsItems": { "properties": { "code": { "description": "Machine-readable error code", "maxLength": 255, "type": "string" }, "field": { "description": "Field that caused the error, if applicable.", "type": [ "string", "null" ] }, "message": { "description": "Human-readable explanation", "type": "string" } }, "required": [ "message" ], "title": "OrganizationsSecureVaultFoldersFolderIdPatchResponsesContentApplicationJsonSchemaErrorsItems", "type": "object" }, "OrganizationsSecureVaultFoldersPostRequestBodyContentApplicationJsonSchemaData": { "description": "The folder to create.", "properties": { "description": { "description": "Optional folder description.", "maxLength": 2000, "type": [ "string", "null" ] }, "name": { "description": "Folder name.", "maxLength": 255, "minLength": 1, "type": "string" }, "parent_folder_id": { "description": "Public UUID of the parent folder. Omit to create a root folder.", "format": "uuid", "type": [ "string", "null" ] } }, "required": [ "name" ], "title": "OrganizationsSecureVaultFoldersPostRequestBodyContentApplicationJsonSchemaData", "type": "object" }, "OrganizationsSecureVaultFoldersPostResponsesContentApplicationJsonSchemaData": { "description": "The created folder.", "properties": { "id": { "description": "Public UUID of the created folder.", "format": "uuid", "type": [ "string", "null" ] } }, "required": [ "id" ], "title": "OrganizationsSecureVaultFoldersPostResponsesContentApplicationJsonSchemaData", "type": "object" }, "OrganizationsSecureVaultFoldersPostResponsesContentApplicationJsonSchemaErrorsItems": { "properties": { "code": { "description": "Machine-readable error code", "maxLength": 255, "type": "string" }, "field": { "description": "Field that caused the error, if applicable.", "type": [ "string", "null" ] }, "message": { "description": "Human-readable explanation", "type": "string" } }, "required": [ "message" ], "title": "OrganizationsSecureVaultFoldersPostResponsesContentApplicationJsonSchemaErrorsItems", "type": "object" }, "OrganizationsTasksGetParametersCategory": { "enum": [ "SETUP", "EXPENSE_REQUESTS", "EXPENSES_TO_CLARIFY", "DOCUMENT_ACTIONS", "LEGAL_ENTITY_DOCUMENTS", "OTHER_TASKS", "DEEL_IT", "COMPLIANCE", "PAYMENT_METHODS", "ACCOUNTING", "APPROVE_CHILD_ORG_CONTRACT_EDIT" ], "title": "OrganizationsTasksGetParametersCategory", "type": "string" }, "OrganizationsTasksGetParametersStatusesSchemaItems": { "enum": [ "PENDING", "COMPLETED", "DISMISSED", "FAILED" ], "title": "OrganizationsTasksGetParametersStatusesSchemaItems", "type": "string" }, "OrganizationsTasksGetResponsesContentApplicationJsonSchemaDataItems": { "properties": { "assignees": { "description": "List of users assigned to this task. Each assignee is either an HRIS profile (worker in organization context) or a profile without organization context.", "items": { "$ref": "#/components/schemas/OrganizationsTasksGetResponsesContentApplicationJsonSchemaDataItemsAssigneesItems" }, "type": "array" }, "category": { "description": "Category of the task.", "type": "string" }, "created_at": { "description": "When the task was created.", "format": "date-time", "type": "string" }, "description": { "description": "Detailed description of the task.", "type": [ "string", "null" ] }, "display_name": { "description": "Human-readable title of the task.", "type": "string" }, "due_date": { "description": "When the task is due.", "format": "date-time", "type": [ "string", "null" ] }, "expired_at": { "description": "When the task expires, if set.", "format": "date-time", "type": [ "string", "null" ] }, "external_id": { "description": "External reference ID, if the task was created with one.", "type": [ "string", "null" ] }, "id": { "description": "Unique identifier of the task.", "format": "uuid", "type": "string" }, "resolved_at": { "description": "When the task was resolved (completed or dismissed).", "format": "date-time", "type": [ "string", "null" ] }, "status": { "$ref": "#/components/schemas/OrganizationsTasksGetResponsesContentApplicationJsonSchemaDataItemsStatus", "description": "Current status of the task." } }, "title": "OrganizationsTasksGetResponsesContentApplicationJsonSchemaDataItems", "type": "object" }, "OrganizationsTasksGetResponsesContentApplicationJsonSchemaDataItemsAssigneesItems": { "properties": { "email": { "description": "Assignee's email address.", "type": [ "string", "null" ] }, "first_name": { "description": "Assignee's first name.", "type": [ "string", "null" ] }, "id": { "description": "Public identifier of the assignee (HRIS profile OID or profile public_id).", "type": "string" }, "last_name": { "description": "Assignee's last name.", "type": [ "string", "null" ] } }, "required": [ "id" ], "title": "OrganizationsTasksGetResponsesContentApplicationJsonSchemaDataItemsAssigneesItems", "type": "object" }, "OrganizationsTasksGetResponsesContentApplicationJsonSchemaDataItemsStatus": { "description": "Current status of the task.", "enum": [ "PENDING", "COMPLETED", "DISMISSED", "FAILED" ], "title": "OrganizationsTasksGetResponsesContentApplicationJsonSchemaDataItemsStatus", "type": "string" }, "OrganizationsTasksGetResponsesContentApplicationJsonSchemaErrorsItems": { "properties": { "code": { "description": "Machine-readable error code.", "type": "string" }, "details": { "description": "Additional error details.", "oneOf": [ { "$ref": "#/components/schemas/OrganizationsTasksGetResponsesContentApplicationJsonSchemaErrorsItemsDetails" }, { "type": "null" } ] }, "field": { "description": "Request field that caused the error, if applicable.", "type": [ "string", "null" ] }, "message": { "description": "Human-readable error message.", "type": "string" } }, "required": [ "code", "message" ], "title": "OrganizationsTasksGetResponsesContentApplicationJsonSchemaErrorsItems", "type": "object" }, "OrganizationsTasksGetResponsesContentApplicationJsonSchemaErrorsItemsDetails": { "description": "Additional error details.", "properties": {}, "title": "OrganizationsTasksGetResponsesContentApplicationJsonSchemaErrorsItemsDetails", "type": "object" }, "Organizations_CreateOrganizationRole-v2026-01-01_Response_200": { "properties": { "description": { "description": "Organization role description", "type": "string" }, "hrisOrgStructureId": { "description": "HRIS organization structure id", "type": "string" }, "id": { "description": "Organization role id", "format": "double", "type": "number" }, "name": { "description": "Organization role name", "type": "string" }, "permissionSets": { "items": { "type": "string" }, "type": "array" }, "scope": { "description": "Organization role scope", "type": "string" } }, "title": "Organizations_CreateOrganizationRole-v2026-01-01_Response_200", "type": "object" }, "Organizations_GetDepartments-v2026-01-01_Response_200": { "properties": { "data": { "items": { "$ref": "#/components/schemas/DepartmentsGetResponsesContentApplicationJsonSchemaDataItems" }, "type": "array" } }, "title": "Organizations_GetDepartments-v2026-01-01_Response_200", "type": "object" }, "Organizations_UpdateOrganizationRole-v2026-01-01_Response_200": { "properties": { "description": { "description": "Description of the role", "type": "string" }, "id": { "description": "ID of the role", "format": "double", "type": "number" }, "name": { "description": "Name of the role", "type": "string" }, "permissionSets": { "items": { "type": "string" }, "type": "array" }, "scope": { "description": "Scope of the role", "type": "string" } }, "title": "Organizations_UpdateOrganizationRole-v2026-01-01_Response_200", "type": "object" }, "Organizations_addChildOrganizationAdmins-v2026-10-12_Response_200": { "properties": { "data": { "$ref": "#/components/schemas/OrganizationsChildrenAdminsPostResponsesContentApplicationJsonSchemaData", "description": "The outcome of the request." } }, "required": [ "data" ], "title": "Organizations_addChildOrganizationAdmins-v2026-10-12_Response_200", "type": "object" }, "Organizations_createChildOrgSessionToken-v2026-07-14_Response_201": { "properties": { "data": { "$ref": "#/components/schemas/OrganizationsChildrenChildOrganizationIdSessionPostResponsesContentApplicationJsonSchemaData", "description": "The issued session token." } }, "required": [ "data" ], "title": "Organizations_createChildOrgSessionToken-v2026-07-14_Response_201", "type": "object" }, "Organizations_createDealRegistration-v2026-09-30_Response_200": { "properties": { "data": { "$ref": "#/components/schemas/OrganizationsDealRegistrationsPostResponsesContentApplicationJsonSchemaData" } }, "required": [ "data" ], "title": "Organizations_createDealRegistration-v2026-09-30_Response_200", "type": "object" }, "Organizations_getTeams-v2026-01-01_Response_200": { "properties": { "data": { "items": { "$ref": "#/components/schemas/TeamsGetResponsesContentApplicationJsonSchemaDataItems" }, "type": "array" } }, "required": [ "data" ], "title": "Organizations_getTeams-v2026-01-01_Response_200", "type": "object" }, "Organizations_getTheRolesOfTheCurrentOrganization-v2026-01-01_Response_200": { "properties": { "data": { "items": { "$ref": "#/components/schemas/RolesGetResponsesContentApplicationJsonSchemaDataItems" }, "type": "array" } }, "required": [ "data" ], "title": "Organizations_getTheRolesOfTheCurrentOrganization-v2026-01-01_Response_200", "type": "object" }, "Organizations_retrieveWorkingLocations-v2026-01-01_Response_200": { "properties": { "data": { "items": { "$ref": "#/components/schemas/WorkingLocationsGetResponsesContentApplicationJsonSchemaDataItems" }, "type": "array" } }, "required": [ "data" ], "title": "Organizations_retrieveWorkingLocations-v2026-01-01_Response_200", "type": "object" }, "PatchGpContractBankAccount-v2026-09-17RequestBadRequestError": { "properties": { "errors": { "items": { "$ref": "#/components/schemas/GpContractsContractIdBanksBankIdPatchResponsesContentApplicationJsonSchemaErrorsItems" }, "type": "array" } }, "title": "PatchGpContractBankAccount-v2026-09-17RequestBadRequestError", "type": "object" }, "PaymentsGetParametersEntitiesSchemaItems": { "enum": [ "individual", "company" ], "title": "PaymentsGetParametersEntitiesSchemaItems", "type": "string" }, "PaymentsGetParametersStatusesSchemaItems": { "enum": [ "paid", "processing" ], "title": "PaymentsGetParametersStatusesSchemaItems", "type": "string" }, "PaymentsGetResponsesContentApplicationJsonSchemaData": { "properties": { "has_more": { "description": "Inform if there are more entries to be fetched using next cursor.", "type": "boolean" }, "next_cursor": { "description": "A cursor for pagination. Use the value returned in the 'next_cursor' field to get the next page of results. If there are no more results, this will be null.", "type": [ "string", "null" ] }, "rows": { "description": "Array of payment receipts matching the query criteria.", "items": { "$ref": "#/components/schemas/PaymentsGetResponsesContentApplicationJsonSchemaDataRowsItems" }, "type": "array" }, "total": { "description": "The total number of payments matching the query.", "format": "double", "type": "number" }, "total_count": { "description": "The total number of payments matching the query.", "format": "double", "type": "number" } }, "title": "PaymentsGetResponsesContentApplicationJsonSchemaData", "type": "object" }, "PaymentsGetResponsesContentApplicationJsonSchemaDataRowsItems": { "properties": { "created_at": { "description": "Date and time when the payment was created, in ISO-8601 format.", "format": "date-time", "type": "string" }, "deel_granted_credits_used": { "$ref": "#/components/schemas/PaymentsGetResponsesContentApplicationJsonSchemaDataRowsItemsDeelGrantedCreditsUsed", "description": "Amount paid using Deel-granted credits." }, "deel_reference": { "description": "Deel reference identifier for the payment.", "type": [ "string", "null" ] }, "eor_early_invoicing_funds_used": { "$ref": "#/components/schemas/PaymentsGetResponsesContentApplicationJsonSchemaDataRowsItemsEorEarlyInvoicingFundsUsed", "description": "Amount paid using EOR early invoicing funds." }, "general_funds_used": { "$ref": "#/components/schemas/PaymentsGetResponsesContentApplicationJsonSchemaDataRowsItemsGeneralFundsUsed", "description": "Amount paid using the client's general balance funds." }, "id": { "description": "Unique identifier of the payment.", "type": "string" }, "label": { "description": "A descriptive label for the payment.", "type": "string" }, "paid_at": { "description": "Date and time when the payment was completed, in ISO-8601 format.", "format": "date-time", "type": "string" }, "payment_currency": { "description": "Three or four-letter currency code for the payment, following ISO 4217 (e.g., USD, USDC).", "maxLength": 4, "minLength": 3, "pattern": "^[A-Z]{3,4}$", "type": "string" }, "payment_method": { "$ref": "#/components/schemas/PaymentsGetResponsesContentApplicationJsonSchemaDataRowsItemsPaymentMethod", "description": "Payment method details for the transaction." }, "prepaid_billing_credits_used": { "$ref": "#/components/schemas/PaymentsGetResponsesContentApplicationJsonSchemaDataRowsItemsPrepaidBillingCreditsUsed", "description": "Amount paid using prepaid billing credits." }, "status": { "$ref": "#/components/schemas/PaymentsGetResponsesContentApplicationJsonSchemaDataRowsItemsStatus", "description": "Status of the payment. Either 'paid' or 'processing'." }, "timezone": { "description": "Timezone offset in ISO 8601 format (e.g., +02:00, -05:00).", "pattern": "^[+-]\\d{2}:\\d{2}$", "type": "string" }, "total": { "description": "Original invoice total before any credits or balance were applied.", "type": "string" }, "total_due": { "description": "Amount due for the payment after applying any credits or balance. Equals 'total' when no credits were used.", "type": "string" } }, "title": "PaymentsGetResponsesContentApplicationJsonSchemaDataRowsItems", "type": "object" }, "PaymentsGetResponsesContentApplicationJsonSchemaDataRowsItemsDeelGrantedCreditsUsed": { "description": "Amount paid using Deel-granted credits.", "properties": { "amount": { "description": "Amount deducted from Deel-granted credits, in the payment currency. '0.00' if not used.", "type": "string" }, "original_amount": { "description": "Amount deducted from Deel-granted credits, in the original currency they were held in. Null if not used.", "type": [ "string", "null" ] }, "original_currency": { "description": "Currency in which the Deel-granted credits were held, following ISO 4217 (e.g., USD, USDC). Null if not used.", "maxLength": 4, "minLength": 3, "pattern": "^[A-Z]{3,4}$", "type": [ "string", "null" ] } }, "title": "PaymentsGetResponsesContentApplicationJsonSchemaDataRowsItemsDeelGrantedCreditsUsed", "type": "object" }, "PaymentsGetResponsesContentApplicationJsonSchemaDataRowsItemsEorEarlyInvoicingFundsUsed": { "description": "Amount paid using EOR early invoicing funds.", "properties": { "amount": { "description": "Amount deducted from EOR early invoicing funds, in the payment currency. '0.00' if not used.", "type": "string" }, "original_amount": { "description": "Amount deducted from EOR early invoicing funds, in the original currency they were held in. Null if not used.", "type": [ "string", "null" ] }, "original_currency": { "description": "Currency in which the EOR early invoicing funds were held, following ISO 4217 (e.g., USD, USDC). Null if not used.", "maxLength": 4, "minLength": 3, "pattern": "^[A-Z]{3,4}$", "type": [ "string", "null" ] } }, "title": "PaymentsGetResponsesContentApplicationJsonSchemaDataRowsItemsEorEarlyInvoicingFundsUsed", "type": "object" }, "PaymentsGetResponsesContentApplicationJsonSchemaDataRowsItemsGeneralFundsUsed": { "description": "Amount paid using the client's general balance funds.", "properties": { "amount": { "description": "Amount deducted from general funds, in the payment currency. '0.00' if not used.", "type": "string" }, "original_amount": { "description": "Amount deducted from general funds, in the original currency it was held in. Null if not used.", "type": [ "string", "null" ] }, "original_currency": { "description": "Currency in which the general funds were held, following ISO 4217 (e.g., USD, USDC). Null if not used.", "maxLength": 4, "minLength": 3, "pattern": "^[A-Z]{3,4}$", "type": [ "string", "null" ] } }, "title": "PaymentsGetResponsesContentApplicationJsonSchemaDataRowsItemsGeneralFundsUsed", "type": "object" }, "PaymentsGetResponsesContentApplicationJsonSchemaDataRowsItemsPaymentMethod": { "description": "Payment method details for the transaction.", "properties": { "type": { "$ref": "#/components/schemas/PaymentsGetResponsesContentApplicationJsonSchemaDataRowsItemsPaymentMethodType", "description": "Type of payment method used for the transaction." } }, "title": "PaymentsGetResponsesContentApplicationJsonSchemaDataRowsItemsPaymentMethod", "type": "object" }, "PaymentsGetResponsesContentApplicationJsonSchemaDataRowsItemsPaymentMethodType": { "description": "Type of payment method used for the transaction.", "enum": [ "stripe_bacs_debit", "pay_pal", "stripe_card", "bt_card", "stripe_ach", "coinbase", "go_cardless", "brex", "stripe_sepa_debit", "transferwise", "go_cardless_becs", "bank_transfer", "mercury_wire", "bt_pay_pal", "ach", "client_balance", "fee_credits", "dbc_credits", "eor_funding_balance", "alviere_ach", "adyen_card", "stablecoin_transfer", "sepa_debit", "bacs_debit", "wallet_balance" ], "title": "PaymentsGetResponsesContentApplicationJsonSchemaDataRowsItemsPaymentMethodType", "type": "string" }, "PaymentsGetResponsesContentApplicationJsonSchemaDataRowsItemsPrepaidBillingCreditsUsed": { "description": "Amount paid using prepaid billing credits.", "properties": { "amount": { "description": "Amount deducted from prepaid billing credits, in the payment currency. '0.00' if not used.", "type": "string" }, "original_amount": { "description": "Amount deducted from prepaid billing credits, in the original currency they were held in. Null if not used.", "type": [ "string", "null" ] }, "original_currency": { "description": "Currency in which the prepaid billing credits were held, following ISO 4217 (e.g., USD, USDC). Null if not used.", "maxLength": 4, "minLength": 3, "pattern": "^[A-Z]{3,4}$", "type": [ "string", "null" ] } }, "title": "PaymentsGetResponsesContentApplicationJsonSchemaDataRowsItemsPrepaidBillingCreditsUsed", "type": "object" }, "PaymentsGetResponsesContentApplicationJsonSchemaDataRowsItemsStatus": { "description": "Status of the payment. Either 'paid' or 'processing'.", "enum": [ "paid", "processing" ], "title": "PaymentsGetResponsesContentApplicationJsonSchemaDataRowsItemsStatus", "type": "string" }, "PaymentsGetResponsesContentApplicationJsonSchemaErrorsItems": { "properties": { "code": { "type": "string" }, "message": { "type": "string" } }, "required": [ "code", "message" ], "title": "PaymentsGetResponsesContentApplicationJsonSchemaErrorsItems", "type": "object" }, "PaymentsPaymentIdBreakdownGetResponsesContentApplicationJsonSchemaDataItems": { "properties": { "adjustment": { "description": "Adjustment amount for the payment.", "type": "string" }, "approve_date": { "$ref": "#/components/schemas/PaymentsPaymentIdBreakdownGetResponsesContentApplicationJsonSchemaDataItemsApproveDate", "description": "Date when the work report was approved by designated approvers. Empty for payments that don't require work report approval, such as service fees, management fees, and automated payments." }, "approvers": { "description": "Comma-separated list of names of people who approved this payment. May be empty if no approvals were required or recorded.", "type": "string" }, "bonus": { "description": "Additional bonus payment amount awarded to the worker.", "type": "string" }, "commissions": { "description": "Commissions included in the payment.", "type": "string" }, "contract_country": { "description": "Country where the contract is established.", "type": "string" }, "contract_id": { "description": "Public identifier of the contract this line item belongs to. Null for service-fee and similar non-contract line items.", "type": [ "string", "null" ] }, "contract_start_date": { "$ref": "#/components/schemas/PaymentsPaymentIdBreakdownGetResponsesContentApplicationJsonSchemaDataItemsContractStartDate", "description": "Start date of the contract. Empty for service agreements and fee-related contracts (such as equipment payments, insurance payments, and management fees) that don't have traditional contract start dates." }, "contract_type": { "description": "Type of contract this payment relates to. Determines the nature of the work relationship and payment structure.", "oneOf": [ { "$ref": "#/components/schemas/PaymentsPaymentIdBreakdownGetResponsesContentApplicationJsonSchemaDataItemsContractType" }, { "type": "null" } ] }, "contractor_email": { "description": "Email address of the worker.", "type": "string" }, "contractor_employee_name": { "description": "Name of the worker.", "type": "string" }, "contractor_pic_url": { "description": "URL to the worker's Deel avatar. Null if the worker has no avatar set or for non-worker line items.", "type": [ "string", "null" ] }, "contractor_unique_identifier": { "$ref": "#/components/schemas/PaymentsPaymentIdBreakdownGetResponsesContentApplicationJsonSchemaDataItemsContractorUniqueIdentifier", "description": "Unique identifier for the worker. May be empty for certain contract types such as service agreements and fees." }, "currency": { "description": "Currency code for this payment.", "type": "string" }, "date": { "description": "Date associated with the payment breakdown.", "format": "date-time", "type": "string" }, "deductions": { "description": "Deductions from the payment.", "type": "string" }, "expenses": { "description": "Expenses related to the payment.", "type": "string" }, "frequency": { "$ref": "#/components/schemas/PaymentsPaymentIdBreakdownGetResponsesContentApplicationJsonSchemaDataItemsFrequency", "description": "Work unit scale from the contractor's work statement. Indicates how work is measured and reported (hourly, daily, weekly, monthly, or custom units). Empty for contracts with fixed payments that don't require work quantity tracking, such as milestone-based contracts and consulting agreements." }, "general_ledger_account": { "description": "General ledger account code or name for accounting purposes. May be configured at the group, company, or organization level. Empty if not configured.", "type": "string" }, "group_id": { "$ref": "#/components/schemas/PaymentsPaymentIdBreakdownGetResponsesContentApplicationJsonSchemaDataItemsGroupId", "description": "Unique identifier for the group associated with this payment. Empty for organization-level payments, individual payments, and standalone service fees that are not associated with a specific group." }, "invoice_id": { "description": "Unique identifier of this resource.", "type": "string" }, "others": { "description": "Other payment amounts.", "type": "string" }, "overtime": { "description": "Overtime payment amount.", "type": "string" }, "payment_currency": { "description": "Currency in which the payment was processed.", "type": "string" }, "payment_date": { "description": "Date when the payment was made.", "format": "date-time", "type": "string" }, "pro_rata": { "description": "Pro-rated payment amount.", "type": "string" }, "processing_fee": { "description": "Processing fee amount applied to the payment.", "type": "string" }, "total": { "description": "Total payment due for this breakdown item.", "type": "string" }, "total_payment_currency": { "description": "Total payment in the payment currency.", "type": "string" }, "work": { "description": "Base payment amount for work performed, including regular salary/wages and off-cycle payments.", "type": "string" } }, "title": "PaymentsPaymentIdBreakdownGetResponsesContentApplicationJsonSchemaDataItems", "type": "object" }, "PaymentsPaymentIdBreakdownGetResponsesContentApplicationJsonSchemaDataItemsApproveDate": { "description": "Date when the work report was approved by designated approvers. Empty for payments that don't require work report approval, such as service fees, management fees, and automated payments.", "oneOf": [ { "format": "date-time", "type": "string" }, { "$ref": "#/components/schemas/PaymentsPaymentIdBreakdownGetResponsesContentApplicationJsonSchemaDataItemsApproveDate1" } ], "title": "PaymentsPaymentIdBreakdownGetResponsesContentApplicationJsonSchemaDataItemsApproveDate" }, "PaymentsPaymentIdBreakdownGetResponsesContentApplicationJsonSchemaDataItemsApproveDate1": { "enum": [ "" ], "title": "PaymentsPaymentIdBreakdownGetResponsesContentApplicationJsonSchemaDataItemsApproveDate1", "type": "string" }, "PaymentsPaymentIdBreakdownGetResponsesContentApplicationJsonSchemaDataItemsContractStartDate": { "description": "Start date of the contract. Empty for service agreements and fee-related contracts (such as equipment payments, insurance payments, and management fees) that don't have traditional contract start dates.", "oneOf": [ { "format": "date-time", "type": "string" }, { "$ref": "#/components/schemas/PaymentsPaymentIdBreakdownGetResponsesContentApplicationJsonSchemaDataItemsContractStartDate1" } ], "title": "PaymentsPaymentIdBreakdownGetResponsesContentApplicationJsonSchemaDataItemsContractStartDate" }, "PaymentsPaymentIdBreakdownGetResponsesContentApplicationJsonSchemaDataItemsContractStartDate1": { "enum": [ "" ], "title": "PaymentsPaymentIdBreakdownGetResponsesContentApplicationJsonSchemaDataItemsContractStartDate1", "type": "string" }, "PaymentsPaymentIdBreakdownGetResponsesContentApplicationJsonSchemaDataItemsContractType": { "description": "Type of contract this payment relates to. Determines the nature of the work relationship and payment structure.", "enum": [ "milestones", "time_based", "ongoing_time_based", "pay_as_you_go_time_based", "commission", "payg_milestones", "payg_tasks", "eor", "peo", "peo_csa", "unknown", "employee", "global_payroll", "shield_msa", "gp_client_agreement", "ep_client_agreement", "power_of_attorney", "debt_authorization", "hris_direct_employee", "hris_service_agreement", "hofy_standalone_payment", "wework_standalone_payment", "travel_insurance_standalone_payment", "health_insurance_standalone_payment", "prepaid_billing", "missing_saas_fees", "one_off_service_fee", "eor_management_fee", "eor_one_off_management_fee", "engage_monthly_subscription_fee", "ats_subscription_fee", "benefits_admin_monthly_platform_fee", "contractor_outside_deel", "late_payment_fee", "background_check_standalone_payment", "peo_service_fee", "payment_processing_fee", "deel_percentage_fee", "netx_fee", "prepaid_funding_statement", "one_off_mobility_service_fee", "prepaid_billing_expired_credits", "implementation_delay", "managed_hr_monthly_subscription_fee", "expense_card", "anon_report_fee", "ic_maintenance_platform_fee", "deel_it_order_statement" ], "title": "PaymentsPaymentIdBreakdownGetResponsesContentApplicationJsonSchemaDataItemsContractType", "type": "string" }, "PaymentsPaymentIdBreakdownGetResponsesContentApplicationJsonSchemaDataItemsContractorUniqueIdentifier": { "description": "Unique identifier for the worker. May be empty for certain contract types such as service agreements and fees.", "oneOf": [ { "format": "uuid", "type": "string" }, { "$ref": "#/components/schemas/PaymentsPaymentIdBreakdownGetResponsesContentApplicationJsonSchemaDataItemsContractorUniqueIdentifier1" } ], "title": "PaymentsPaymentIdBreakdownGetResponsesContentApplicationJsonSchemaDataItemsContractorUniqueIdentifier" }, "PaymentsPaymentIdBreakdownGetResponsesContentApplicationJsonSchemaDataItemsContractorUniqueIdentifier1": { "enum": [ "" ], "title": "PaymentsPaymentIdBreakdownGetResponsesContentApplicationJsonSchemaDataItemsContractorUniqueIdentifier1", "type": "string" }, "PaymentsPaymentIdBreakdownGetResponsesContentApplicationJsonSchemaDataItemsFrequency": { "description": "Work unit scale from the contractor's work statement. Indicates how work is measured and reported (hourly, daily, weekly, monthly, or custom units). Empty for contracts with fixed payments that don't require work quantity tracking, such as milestone-based contracts and consulting agreements.", "enum": [ "hourly", "daily", "weekly", "biweekly", "semimonthly", "monthly", "custom", "" ], "title": "PaymentsPaymentIdBreakdownGetResponsesContentApplicationJsonSchemaDataItemsFrequency", "type": "string" }, "PaymentsPaymentIdBreakdownGetResponsesContentApplicationJsonSchemaDataItemsGroupId": { "description": "Unique identifier for the group associated with this payment. Empty for organization-level payments, individual payments, and standalone service fees that are not associated with a specific group.", "oneOf": [ { "format": "uuid", "type": "string" }, { "$ref": "#/components/schemas/PaymentsPaymentIdBreakdownGetResponsesContentApplicationJsonSchemaDataItemsGroupId1" } ], "title": "PaymentsPaymentIdBreakdownGetResponsesContentApplicationJsonSchemaDataItemsGroupId" }, "PaymentsPaymentIdBreakdownGetResponsesContentApplicationJsonSchemaDataItemsGroupId1": { "enum": [ "" ], "title": "PaymentsPaymentIdBreakdownGetResponsesContentApplicationJsonSchemaDataItemsGroupId1", "type": "string" }, "PaymentsPaymentIdBreakdownGetResponsesContentApplicationJsonSchemaErrorsItems": { "properties": { "code": { "type": "string" }, "message": { "type": "string" } }, "required": [ "code", "message" ], "title": "PaymentsPaymentIdBreakdownGetResponsesContentApplicationJsonSchemaErrorsItems", "type": "object" }, "PaymentsStatementsPaymentStatementIdGetResponsesContentApplicationJsonSchemaData": { "properties": { "amount": { "description": "Total amount of the payment statement before any balance is applied. Null until the amount is set.", "type": [ "string", "null" ] }, "amount_due": { "description": "Amount still due after any applied balance and fee credits. Null until the amount is set.", "type": [ "string", "null" ] }, "balance_applied": { "description": "Amount of client balance applied to the payment statement.", "type": "string" }, "beneficiary_details": { "description": "Beneficiary bank details the payment is settled to. Null when not yet resolved.", "oneOf": [ { "$ref": "#/components/schemas/PaymentsStatementsPaymentStatementIdGetResponsesContentApplicationJsonSchemaDataBeneficiaryDetails" }, { "type": "null" } ] }, "created_at": { "description": "Date and time when the payment statement was created, in ISO-8601 format.", "format": "date-time", "type": "string" }, "fee_credits_applied": { "description": "Amount of fee credits applied to the payment statement.", "type": "string" }, "id": { "description": "Unique identifier of the payment statement.", "type": "string" }, "invoices": { "description": "Authoritative superset of invoices settled by this payment statement. It always contains the requested invoices and may include additional overdue or required fee invoices that Deel attaches automatically.", "items": { "$ref": "#/components/schemas/PaymentsStatementsPaymentStatementIdGetResponsesContentApplicationJsonSchemaDataInvoicesItems" }, "type": "array" }, "paid_at": { "description": "Date and time when the client paid, in ISO-8601 format. For bank transfers this can be set while the status is still processing. Null until payment is captured.", "format": "date-time", "type": [ "string", "null" ] }, "payment_currency": { "description": "Three-letter currency code of the payment statement, following ISO 4217. Null until a payment method is attached.", "maxLength": 3, "minLength": 3, "pattern": "^[A-Z]{3}$", "type": [ "string", "null" ] }, "payment_method": { "description": "Method used to settle the payment statement. Null until a payment method is attached.", "type": [ "string", "null" ] }, "reference": { "description": "Reference to use when reconciling this payment statement against incoming wires.", "type": [ "string", "null" ] }, "status": { "$ref": "#/components/schemas/PaymentsStatementsPaymentStatementIdGetResponsesContentApplicationJsonSchemaDataStatus", "description": "Normalized status of the payment statement. 'PROCESSING' covers any in-flight state (pending, preprocessing, awaiting payment); 'paid', 'cancelled' and 'failed' are terminal." } }, "required": [ "id", "amount", "status", "invoices", "amount_due", "payment_currency" ], "title": "PaymentsStatementsPaymentStatementIdGetResponsesContentApplicationJsonSchemaData", "type": "object" }, "PaymentsStatementsPaymentStatementIdGetResponsesContentApplicationJsonSchemaDataBeneficiaryDetails": { "description": "Beneficiary bank details the payment is settled to. Null when not yet resolved.", "properties": { "account_holder": { "description": "Name of the beneficiary account holder. Null when not modeled on the rail.", "type": [ "string", "null" ] }, "account_number": { "description": "Beneficiary account number. Null on IBAN-only rails.", "type": [ "string", "null" ] }, "account_type": { "description": "Type of the beneficiary account. Null when not applicable.", "type": [ "string", "null" ] }, "ach_routing_number": { "description": "Routing number to use for ACH transfers. Null when not applicable.", "type": [ "string", "null" ] }, "address": { "description": "Address to include on the transfer for this rail. Null when not applicable.", "type": [ "string", "null" ] }, "bank_address": { "description": "Address of the beneficiary bank. Null when not applicable.", "type": [ "string", "null" ] }, "bank_code": { "description": "Local bank code or institution number of the beneficiary bank. Null when not applicable.", "type": [ "string", "null" ] }, "bank_name": { "description": "Name of the beneficiary bank.", "type": [ "string", "null" ] }, "branch_code": { "description": "Branch code or transit number of the beneficiary bank. Null when not applicable.", "type": [ "string", "null" ] }, "bsb_code": { "description": "BSB code of the beneficiary bank, used for AUD transfers. Null when not applicable.", "type": [ "string", "null" ] }, "country": { "description": "Two-letter country code of the beneficiary. Best-effort; null when not modeled.", "type": [ "string", "null" ] }, "currency": { "description": "Three-letter currency code of the beneficiary account, following ISO 4217. Null when not modeled on the rail.", "maxLength": 3, "minLength": 3, "pattern": "^[A-Z]{3}$", "type": [ "string", "null" ] }, "iban": { "description": "IBAN of the beneficiary account. Null on non-IBAN rails.", "type": [ "string", "null" ] }, "ifsc_code": { "description": "IFSC code of the beneficiary bank, used for INR transfers. Null when not applicable.", "type": [ "string", "null" ] }, "intermediary_bank": { "description": "Intermediary bank to route the transfer through. Null when the rail has none.", "oneOf": [ { "$ref": "#/components/schemas/PaymentsStatementsPaymentStatementIdGetResponsesContentApplicationJsonSchemaDataBeneficiaryDetailsIntermediaryBank" }, { "type": "null" } ] }, "routing_number": { "description": "Routing number of the beneficiary bank when the rail uses one number for both ACH and wire. Null when not applicable.", "type": [ "string", "null" ] }, "sort_code": { "description": "Sort code of the beneficiary bank. Best-effort; null on most rails.", "type": [ "string", "null" ] }, "swift": { "description": "SWIFT/BIC code of the beneficiary bank. Null when not applicable.", "type": [ "string", "null" ] }, "wire_routing_number": { "description": "Routing number to use for wire transfers. Null when not applicable.", "type": [ "string", "null" ] } }, "title": "PaymentsStatementsPaymentStatementIdGetResponsesContentApplicationJsonSchemaDataBeneficiaryDetails", "type": "object" }, "PaymentsStatementsPaymentStatementIdGetResponsesContentApplicationJsonSchemaDataBeneficiaryDetailsIntermediaryBank": { "description": "Intermediary bank to route the transfer through. Null when the rail has none.", "properties": { "bank_name": { "description": "Name of the intermediary bank.", "type": [ "string", "null" ] }, "swift": { "description": "SWIFT/BIC code of the intermediary bank.", "type": [ "string", "null" ] } }, "title": "PaymentsStatementsPaymentStatementIdGetResponsesContentApplicationJsonSchemaDataBeneficiaryDetailsIntermediaryBank", "type": "object" }, "PaymentsStatementsPaymentStatementIdGetResponsesContentApplicationJsonSchemaDataInvoicesItems": { "properties": { "amount": { "description": "Amount of the invoice.", "type": "string" }, "currency": { "description": "Three-letter currency code of the invoice, following ISO 4217.", "maxLength": 3, "minLength": 3, "pattern": "^[A-Z]{3}$", "type": "string" }, "id": { "description": "Unique identifier of the invoice.", "type": "string" }, "is_auto_added": { "description": "True when Deel automatically attached this invoice (e.g. an overdue or required fee invoice) beyond the requested set.", "type": "boolean" }, "label": { "description": "Descriptive label for the invoice.", "type": [ "string", "null" ] } }, "required": [ "id", "amount", "currency" ], "title": "PaymentsStatementsPaymentStatementIdGetResponsesContentApplicationJsonSchemaDataInvoicesItems", "type": "object" }, "PaymentsStatementsPaymentStatementIdGetResponsesContentApplicationJsonSchemaDataStatus": { "description": "Normalized status of the payment statement. 'PROCESSING' covers any in-flight state (pending, preprocessing, awaiting payment); 'paid', 'cancelled' and 'failed' are terminal.", "enum": [ "PROCESSING", "PAID", "CANCELLED", "FAILED" ], "title": "PaymentsStatementsPaymentStatementIdGetResponsesContentApplicationJsonSchemaDataStatus", "type": "string" }, "PaymentsStatementsPaymentStatementIdGetResponsesContentApplicationJsonSchemaErrorsItems": { "properties": { "code": { "description": "Machine-readable error code.", "type": "string" }, "message": { "description": "Human-readable explanation of the error.", "type": "string" } }, "required": [ "code", "message" ], "title": "PaymentsStatementsPaymentStatementIdGetResponsesContentApplicationJsonSchemaErrorsItems", "type": "object" }, "PaymentsStatementsPostRequestBodyContentApplicationJsonSchemaData": { "properties": { "invoice_ids": { "description": "Identifiers of the invoices to include in the payment statement. A maximum of 100 invoices can be paid in one request.", "items": { "type": "string" }, "type": "array" }, "payment": { "$ref": "#/components/schemas/PaymentsStatementsPostRequestBodyContentApplicationJsonSchemaDataPayment", "description": "Settlement details for the payment." } }, "required": [ "payment", "invoice_ids" ], "title": "PaymentsStatementsPostRequestBodyContentApplicationJsonSchemaData", "type": "object" }, "PaymentsStatementsPostRequestBodyContentApplicationJsonSchemaDataPayment": { "description": "Settlement details for the payment.", "properties": { "country": { "description": "Two-letter country code for the bank transfer method, following ISO 3166-1 alpha-2.", "maxLength": 2, "minLength": 2, "pattern": "^[A-Z]{2}$", "type": "string" }, "currency": { "description": "Three-letter currency code of the payment statement, following ISO 4217. Must match the currency of the created statement.", "maxLength": 3, "minLength": 3, "pattern": "^[A-Z]{3}$", "type": "string" } }, "required": [ "country", "currency" ], "title": "PaymentsStatementsPostRequestBodyContentApplicationJsonSchemaDataPayment", "type": "object" }, "PaymentsStatementsPostResponsesContentApplicationJsonSchemaData": { "properties": { "amount": { "description": "Total amount of the payment statement before any balance is applied. Null until the amount is set.", "type": [ "string", "null" ] }, "amount_due": { "description": "Amount still due after any applied balance and fee credits. Null until the amount is set.", "type": [ "string", "null" ] }, "balance_applied": { "description": "Amount of client balance applied to the payment statement.", "type": "string" }, "beneficiary_details": { "description": "Beneficiary bank details the payment is settled to. Null when not yet resolved.", "oneOf": [ { "$ref": "#/components/schemas/PaymentsStatementsPostResponsesContentApplicationJsonSchemaDataBeneficiaryDetails" }, { "type": "null" } ] }, "created_at": { "description": "Date and time when the payment statement was created, in ISO-8601 format.", "format": "date-time", "type": "string" }, "fee_credits_applied": { "description": "Amount of fee credits applied to the payment statement.", "type": "string" }, "id": { "description": "Unique identifier of the payment statement.", "type": "string" }, "invoices": { "description": "Authoritative superset of invoices settled by this payment statement. It always contains the requested invoices and may include additional overdue or required fee invoices that Deel attaches automatically.", "items": { "$ref": "#/components/schemas/PaymentsStatementsPostResponsesContentApplicationJsonSchemaDataInvoicesItems" }, "type": "array" }, "paid_at": { "description": "Date and time when the client paid, in ISO-8601 format. For bank transfers this can be set while the status is still processing. Null until payment is captured.", "format": "date-time", "type": [ "string", "null" ] }, "payment_currency": { "description": "Three-letter currency code of the payment statement, following ISO 4217. Null until a payment method is attached.", "maxLength": 3, "minLength": 3, "pattern": "^[A-Z]{3}$", "type": [ "string", "null" ] }, "payment_method": { "description": "Method used to settle the payment statement. Null until a payment method is attached.", "type": [ "string", "null" ] }, "reference": { "description": "Reference to use when reconciling this payment statement against incoming wires.", "type": [ "string", "null" ] }, "status": { "$ref": "#/components/schemas/PaymentsStatementsPostResponsesContentApplicationJsonSchemaDataStatus", "description": "Normalized status of the payment statement. 'PROCESSING' covers any in-flight state (pending, preprocessing, awaiting payment); 'paid', 'cancelled' and 'failed' are terminal." } }, "required": [ "id", "amount", "status", "invoices", "amount_due", "payment_currency" ], "title": "PaymentsStatementsPostResponsesContentApplicationJsonSchemaData", "type": "object" }, "PaymentsStatementsPostResponsesContentApplicationJsonSchemaDataBeneficiaryDetails": { "description": "Beneficiary bank details the payment is settled to. Null when not yet resolved.", "properties": { "account_holder": { "description": "Name of the beneficiary account holder. Null when not modeled on the rail.", "type": [ "string", "null" ] }, "account_number": { "description": "Beneficiary account number. Null on IBAN-only rails.", "type": [ "string", "null" ] }, "account_type": { "description": "Type of the beneficiary account. Null when not applicable.", "type": [ "string", "null" ] }, "ach_routing_number": { "description": "Routing number to use for ACH transfers. Null when not applicable.", "type": [ "string", "null" ] }, "address": { "description": "Address to include on the transfer for this rail. Null when not applicable.", "type": [ "string", "null" ] }, "bank_address": { "description": "Address of the beneficiary bank. Null when not applicable.", "type": [ "string", "null" ] }, "bank_code": { "description": "Local bank code or institution number of the beneficiary bank. Null when not applicable.", "type": [ "string", "null" ] }, "bank_name": { "description": "Name of the beneficiary bank.", "type": [ "string", "null" ] }, "branch_code": { "description": "Branch code or transit number of the beneficiary bank. Null when not applicable.", "type": [ "string", "null" ] }, "bsb_code": { "description": "BSB code of the beneficiary bank, used for AUD transfers. Null when not applicable.", "type": [ "string", "null" ] }, "country": { "description": "Two-letter country code of the beneficiary. Best-effort; null when not modeled.", "type": [ "string", "null" ] }, "currency": { "description": "Three-letter currency code of the beneficiary account, following ISO 4217. Null when not modeled on the rail.", "maxLength": 3, "minLength": 3, "pattern": "^[A-Z]{3}$", "type": [ "string", "null" ] }, "iban": { "description": "IBAN of the beneficiary account. Null on non-IBAN rails.", "type": [ "string", "null" ] }, "ifsc_code": { "description": "IFSC code of the beneficiary bank, used for INR transfers. Null when not applicable.", "type": [ "string", "null" ] }, "intermediary_bank": { "description": "Intermediary bank to route the transfer through. Null when the rail has none.", "oneOf": [ { "$ref": "#/components/schemas/PaymentsStatementsPostResponsesContentApplicationJsonSchemaDataBeneficiaryDetailsIntermediaryBank" }, { "type": "null" } ] }, "routing_number": { "description": "Routing number of the beneficiary bank when the rail uses one number for both ACH and wire. Null when not applicable.", "type": [ "string", "null" ] }, "sort_code": { "description": "Sort code of the beneficiary bank. Best-effort; null on most rails.", "type": [ "string", "null" ] }, "swift": { "description": "SWIFT/BIC code of the beneficiary bank. Null when not applicable.", "type": [ "string", "null" ] }, "wire_routing_number": { "description": "Routing number to use for wire transfers. Null when not applicable.", "type": [ "string", "null" ] } }, "title": "PaymentsStatementsPostResponsesContentApplicationJsonSchemaDataBeneficiaryDetails", "type": "object" }, "PaymentsStatementsPostResponsesContentApplicationJsonSchemaDataBeneficiaryDetailsIntermediaryBank": { "description": "Intermediary bank to route the transfer through. Null when the rail has none.", "properties": { "bank_name": { "description": "Name of the intermediary bank.", "type": [ "string", "null" ] }, "swift": { "description": "SWIFT/BIC code of the intermediary bank.", "type": [ "string", "null" ] } }, "title": "PaymentsStatementsPostResponsesContentApplicationJsonSchemaDataBeneficiaryDetailsIntermediaryBank", "type": "object" }, "PaymentsStatementsPostResponsesContentApplicationJsonSchemaDataInvoicesItems": { "properties": { "amount": { "description": "Amount of the invoice.", "type": "string" }, "currency": { "description": "Three-letter currency code of the invoice, following ISO 4217.", "maxLength": 3, "minLength": 3, "pattern": "^[A-Z]{3}$", "type": "string" }, "id": { "description": "Unique identifier of the invoice.", "type": "string" }, "is_auto_added": { "description": "True when Deel automatically attached this invoice (e.g. an overdue or required fee invoice) beyond the requested set.", "type": "boolean" }, "label": { "description": "Descriptive label for the invoice.", "type": [ "string", "null" ] } }, "required": [ "id", "amount", "currency" ], "title": "PaymentsStatementsPostResponsesContentApplicationJsonSchemaDataInvoicesItems", "type": "object" }, "PaymentsStatementsPostResponsesContentApplicationJsonSchemaDataStatus": { "description": "Normalized status of the payment statement. 'PROCESSING' covers any in-flight state (pending, preprocessing, awaiting payment); 'paid', 'cancelled' and 'failed' are terminal.", "enum": [ "PROCESSING", "PAID", "CANCELLED", "FAILED" ], "title": "PaymentsStatementsPostResponsesContentApplicationJsonSchemaDataStatus", "type": "string" }, "PaymentsStatementsPostResponsesContentApplicationJsonSchemaErrorsItems": { "properties": { "code": { "description": "Machine-readable error code.", "type": "string" }, "message": { "description": "Human-readable explanation of the error.", "type": "string" } }, "required": [ "code", "message" ], "title": "PaymentsStatementsPostResponsesContentApplicationJsonSchemaErrorsItems", "type": "object" }, "Payments_createPaymentStatement-v2026-07-23_Response_201": { "properties": { "data": { "$ref": "#/components/schemas/PaymentsStatementsPostResponsesContentApplicationJsonSchemaData" } }, "required": [ "data" ], "title": "Payments_createPaymentStatement-v2026-07-23_Response_201", "type": "object" }, "Payments_getPaymentStatement-v2026-07-23_Response_200": { "properties": { "data": { "$ref": "#/components/schemas/PaymentsStatementsPaymentStatementIdGetResponsesContentApplicationJsonSchemaData" } }, "required": [ "data" ], "title": "Payments_getPaymentStatement-v2026-07-23_Response_200", "type": "object" }, "PayoutsAutoWithdrawalSettingGetResponsesContentApplicationJsonSchemaData": { "properties": { "is_auto_withdraw_enabled": { "description": "Whether auto withdrawal is enabled", "type": "boolean" }, "method_id": { "description": "The ID of the withdrawal method to be used for auto withdrawal", "format": "uuid", "type": [ "string", "null" ] } }, "title": "PayoutsAutoWithdrawalSettingGetResponsesContentApplicationJsonSchemaData", "type": "object" }, "PayoutsAutoWithdrawalSettingPatchRequestBodyContentApplicationJsonSchemaData": { "properties": { "is_auto_withdraw_enabled": { "description": "Whether auto withdrawal should be enabled", "type": "boolean" }, "method_id": { "description": "The ID of the withdrawal method to be used for auto withdrawal", "format": "uuid", "type": "string" } }, "title": "PayoutsAutoWithdrawalSettingPatchRequestBodyContentApplicationJsonSchemaData", "type": "object" }, "PayoutsAutoWithdrawalSettingPatchResponsesContentApplicationJsonSchemaData": { "properties": { "is_auto_withdraw_enabled": { "description": "Whether auto withdrawal is enabled", "type": "boolean" }, "method_id": { "description": "The ID of the withdrawal method to be used for auto withdrawal", "format": "uuid", "type": "string" } }, "title": "PayoutsAutoWithdrawalSettingPatchResponsesContentApplicationJsonSchemaData", "type": "object" }, "PayoutsBalancesGetResponsesContentApplicationJsonSchemaData": { "properties": { "balances": { "items": { "$ref": "#/components/schemas/PayoutsBalancesGetResponsesContentApplicationJsonSchemaDataBalancesItems" }, "type": "array" }, "balances_total": { "$ref": "#/components/schemas/PayoutsBalancesGetResponsesContentApplicationJsonSchemaDataBalancesTotal" } }, "title": "PayoutsBalancesGetResponsesContentApplicationJsonSchemaData", "type": "object" }, "PayoutsBalancesGetResponsesContentApplicationJsonSchemaDataBalancesItems": { "properties": { "amount": { "description": "amount of that currency in the contractor balance", "type": "string" }, "currency": { "description": "currency of that amount", "type": "string" } }, "title": "PayoutsBalancesGetResponsesContentApplicationJsonSchemaDataBalancesItems", "type": "object" }, "PayoutsBalancesGetResponsesContentApplicationJsonSchemaDataBalancesTotal": { "properties": { "amount": { "description": "total amount of all currencies in the contractor balance", "type": "string" }, "currency": { "description": "currency of the total amount", "type": "string" } }, "title": "PayoutsBalancesGetResponsesContentApplicationJsonSchemaDataBalancesTotal", "type": "object" }, "PayoutsBalancesGetResponsesContentApplicationJsonSchemaItems": { "properties": { "message": { "description": "error message", "type": "string" } }, "title": "PayoutsBalancesGetResponsesContentApplicationJsonSchemaItems", "type": "object" }, "PayoutsContractorsMethodsBankTransfersRequirementsGetResponsesContentApplicationJsonSchemaDataItems": { "properties": { "fields": { "description": "Each field key is input field for the bank transfer method creation payload.", "items": { "$ref": "#/components/schemas/PayoutsContractorsMethodsBankTransfersRequirementsGetResponsesContentApplicationJsonSchemaDataItemsFieldsItems" }, "type": "array" }, "intermediary": { "description": "Each field is input for the bank transfer method creation payload intermediary object", "items": { "$ref": "#/components/schemas/PayoutsContractorsMethodsBankTransfersRequirementsGetResponsesContentApplicationJsonSchemaDataItemsIntermediaryItems" }, "type": "array" }, "title": { "description": "Title of the bank transfer method", "type": "string" }, "total_fee": { "description": "Fee preview for amount provided in query parameter", "type": "string" }, "type": { "description": "Type of bank transfer, such as local, swift, iban. Maps to selected_option in method creation data.", "type": "string" } }, "required": [ "type", "title", "fields", "total_fee" ], "title": "PayoutsContractorsMethodsBankTransfersRequirementsGetResponsesContentApplicationJsonSchemaDataItems", "type": "object" }, "PayoutsContractorsMethodsBankTransfersRequirementsGetResponsesContentApplicationJsonSchemaDataItemsFieldsItems": { "properties": { "group": { "description": "List of input field definitions within this group.", "items": { "$ref": "#/components/schemas/PayoutsContractorsMethodsBankTransfersRequirementsGetResponsesContentApplicationJsonSchemaDataItemsFieldsItemsGroupItems" }, "type": "array" }, "name": { "description": "User-facing label for the field group.", "type": "string" } }, "required": [ "name", "group" ], "title": "PayoutsContractorsMethodsBankTransfersRequirementsGetResponsesContentApplicationJsonSchemaDataItemsFieldsItems", "type": "object" }, "PayoutsContractorsMethodsBankTransfersRequirementsGetResponsesContentApplicationJsonSchemaDataItemsFieldsItemsGroupItems": { "properties": { "display_format": { "description": "Optional display format hint for the field", "type": [ "string", "null" ] }, "example": { "description": "Example value for the field", "type": "string" }, "key": { "description": "The key of the field in the method creation payload", "type": "string" }, "max_length": { "description": "The maximum length of the field", "type": [ "integer", "null" ] }, "min_length": { "description": "The minimum length of the field", "type": [ "integer", "null" ] }, "name": { "description": "User facing name of property", "type": "string" }, "refresh_requirements_on_change": { "description": "Whether to refresh the requirements when the field value changes with field key as query parameter", "type": "boolean" }, "required": { "description": "Whether the field is required", "type": "boolean" }, "type": { "$ref": "#/components/schemas/PayoutsContractorsMethodsBankTransfersRequirementsGetResponsesContentApplicationJsonSchemaDataItemsFieldsItemsGroupItemsType", "description": "The type of the field, such as text, radio, select, or date_local." }, "validation_regexp": { "description": "The regular expression to validate the field", "type": [ "string", "null" ] }, "values_allowed": { "description": "An array of allowed values with corresponding key and name.", "items": { "$ref": "#/components/schemas/PayoutsContractorsMethodsBankTransfersRequirementsGetResponsesContentApplicationJsonSchemaDataItemsFieldsItemsGroupItemsValuesAllowedItems" }, "type": [ "array", "null" ] } }, "required": [ "key", "name", "type", "required" ], "title": "PayoutsContractorsMethodsBankTransfersRequirementsGetResponsesContentApplicationJsonSchemaDataItemsFieldsItemsGroupItems", "type": "object" }, "PayoutsContractorsMethodsBankTransfersRequirementsGetResponsesContentApplicationJsonSchemaDataItemsFieldsItemsGroupItemsType": { "description": "The type of the field, such as text, radio, select, or date_local.", "enum": [ "text", "radio", "select", "date_local" ], "title": "PayoutsContractorsMethodsBankTransfersRequirementsGetResponsesContentApplicationJsonSchemaDataItemsFieldsItemsGroupItemsType", "type": "string" }, "PayoutsContractorsMethodsBankTransfersRequirementsGetResponsesContentApplicationJsonSchemaDataItemsFieldsItemsGroupItemsValuesAllowedItems": { "properties": { "key": { "description": "The country code (e.g., AL for Albania).", "type": "string" }, "name": { "description": "The full name of the country (e.g., Albania).", "type": "string" } }, "required": [ "key", "name" ], "title": "PayoutsContractorsMethodsBankTransfersRequirementsGetResponsesContentApplicationJsonSchemaDataItemsFieldsItemsGroupItemsValuesAllowedItems", "type": "object" }, "PayoutsContractorsMethodsBankTransfersRequirementsGetResponsesContentApplicationJsonSchemaDataItemsIntermediaryItems": { "properties": { "group": { "description": "List of input field definitions for the intermediary bank.", "items": { "$ref": "#/components/schemas/PayoutsContractorsMethodsBankTransfersRequirementsGetResponsesContentApplicationJsonSchemaDataItemsIntermediaryItemsGroupItems" }, "type": "array" }, "name": { "description": "User facing name of the intermediary object", "type": "string" } }, "required": [ "name", "group" ], "title": "PayoutsContractorsMethodsBankTransfersRequirementsGetResponsesContentApplicationJsonSchemaDataItemsIntermediaryItems", "type": "object" }, "PayoutsContractorsMethodsBankTransfersRequirementsGetResponsesContentApplicationJsonSchemaDataItemsIntermediaryItemsGroupItems": { "properties": { "example": { "description": "Example value for the field", "type": "string" }, "key": { "description": "The key of the intermediary field in the method creation payload.", "type": "string" }, "max_length": { "description": "The maximum length of the field", "type": [ "integer", "null" ] }, "min_length": { "description": "The minimum length of the field", "type": [ "integer", "null" ] }, "name": { "description": "User facing name of the intermediary object", "type": "string" }, "required": { "description": "Whether the field is required", "type": "boolean" }, "type": { "description": "The type of the field, such as text, radio, select, or date_local.", "type": "string" }, "validation_regexp": { "description": "The regular expression to validate the field", "type": [ "string", "null" ] }, "values_allowed": { "description": "An array of allowed values with corresponding key and name.", "items": { "$ref": "#/components/schemas/PayoutsContractorsMethodsBankTransfersRequirementsGetResponsesContentApplicationJsonSchemaDataItemsIntermediaryItemsGroupItemsValuesAllowedItems" }, "type": [ "array", "null" ] } }, "required": [ "key", "name", "type", "required" ], "title": "PayoutsContractorsMethodsBankTransfersRequirementsGetResponsesContentApplicationJsonSchemaDataItemsIntermediaryItemsGroupItems", "type": "object" }, "PayoutsContractorsMethodsBankTransfersRequirementsGetResponsesContentApplicationJsonSchemaDataItemsIntermediaryItemsGroupItemsValuesAllowedItems": { "properties": { "key": { "description": "The country code (e.g., AL for Albania).", "type": "string" }, "name": { "description": "The full name of the country (e.g., Albania).", "type": "string" } }, "required": [ "key", "name" ], "title": "PayoutsContractorsMethodsBankTransfersRequirementsGetResponsesContentApplicationJsonSchemaDataItemsIntermediaryItemsGroupItemsValuesAllowedItems", "type": "object" }, "PayoutsContractorsMethodsBankTransfersRequirementsGetResponsesContentApplicationJsonSchemaErrorsItems": { "properties": { "code": { "description": "Machine-readable error code.", "type": "string" }, "message": { "description": "Human-readable explanation.", "type": "string" } }, "title": "PayoutsContractorsMethodsBankTransfersRequirementsGetResponsesContentApplicationJsonSchemaErrorsItems", "type": "object" }, "PayoutsContractorsMethodsGetResponsesContentApplicationJsonSchemaDataItems": { "properties": { "address": { "description": "Address associated with the payout method, when available.", "oneOf": [ { "$ref": "#/components/schemas/PayoutsContractorsMethodsGetResponsesContentApplicationJsonSchemaDataItemsAddress" }, { "type": "null" } ] }, "created_at": { "description": "Timestamp when the payout method was created.", "format": "date-time", "type": "string" }, "id": { "description": "Unique identifier of the payout method (method chain ID).", "format": "uuid", "type": "string" }, "is_default": { "description": "Specifies if the method is the default payout method - if true, autowithdrawal will be enabled for the contractor using this method", "type": "boolean" }, "method_name": { "description": "Name for the method.", "type": [ "string", "null" ] }, "payload": { "additionalProperties": { "description": "Any type" }, "description": "Dynamic properties based on selected option. For example, if `selected_option` is `SWIFT CODE`, payload may include `swiftCode`, `accountHolderName`, and `accountNumber`.", "type": "object" }, "payment_method": { "description": "Type of payout method.", "type": "string" }, "selected_option": { "description": "Specifies the type of bank transfer method. Maps from the requirements type field.", "type": "string" }, "status": { "description": "Current status of the payout method (e.g. PENDING, VERIFYING, APPROVED, FAILED).", "type": "string" }, "updated_at": { "description": "Timestamp when the payout method was last updated.", "format": "date-time", "type": "string" }, "version": { "description": "Unique identifier of the specific version of the payout method.", "format": "uuid", "type": "string" } }, "required": [ "id", "status", "payload", "version", "created_at", "is_default", "updated_at", "payment_method", "selected_option" ], "title": "PayoutsContractorsMethodsGetResponsesContentApplicationJsonSchemaDataItems", "type": "object" }, "PayoutsContractorsMethodsGetResponsesContentApplicationJsonSchemaDataItemsAddress": { "description": "Address associated with the payout method, when available.", "properties": { "city": { "description": "City name", "type": "string" }, "country": { "description": "Country code", "type": "string" }, "first_line": { "description": "First line of the address", "type": "string" }, "post_code": { "description": "Post code", "type": "string" }, "state": { "description": "State code", "type": "string" } }, "title": "PayoutsContractorsMethodsGetResponsesContentApplicationJsonSchemaDataItemsAddress", "type": "object" }, "PayoutsContractorsMethodsGetResponsesContentApplicationJsonSchemaErrorsItems": { "properties": { "code": { "description": "Machine-readable error code.", "type": "string" }, "message": { "description": "Human-readable explanation.", "type": "string" } }, "title": "PayoutsContractorsMethodsGetResponsesContentApplicationJsonSchemaErrorsItems", "type": "object" }, "PayoutsContractorsMethodsIdPutRequestBodyContentApplicationJsonSchemaData": { "properties": { "address": { "$ref": "#/components/schemas/PayoutsContractorsMethodsIdPutRequestBodyContentApplicationJsonSchemaDataAddress" }, "is_default": { "description": "Specifies if the method is the default payout method - if true, autowithdrawal will be enabled for the contractor using this method", "type": "boolean" }, "method_name": { "description": "Name for method", "type": "string" }, "payload": { "additionalProperties": { "description": "Any type" }, "description": "Dynamic properties based on selected option. For example, if `selectedOption` is `swift_code`, payload may include `swiftCode`, `accountHolderName`, and `accountNumber`.", "type": "object" }, "payment_method": { "$ref": "#/components/schemas/PayoutsContractorsMethodsIdPutRequestBodyContentApplicationJsonSchemaDataPaymentMethod", "description": "Specifies the type of payment method" }, "selectedOption": { "description": "Specifies the type of bank transfer method. Maps from requirements type field", "type": "string" } }, "required": [ "address", "payload", "payment_method" ], "title": "PayoutsContractorsMethodsIdPutRequestBodyContentApplicationJsonSchemaData", "type": "object" }, "PayoutsContractorsMethodsIdPutRequestBodyContentApplicationJsonSchemaDataAddress": { "properties": { "city": { "description": "City name", "type": "string" }, "country": { "description": "Country code", "pattern": "^[A-Z]{2}$", "type": "string" }, "first_line": { "description": "First line of the address", "type": "string" }, "post_code": { "description": "Post code", "type": "string" }, "state": { "description": "State code", "type": "string" } }, "required": [ "city", "country", "post_code", "first_line" ], "title": "PayoutsContractorsMethodsIdPutRequestBodyContentApplicationJsonSchemaDataAddress", "type": "object" }, "PayoutsContractorsMethodsIdPutRequestBodyContentApplicationJsonSchemaDataPaymentMethod": { "description": "Specifies the type of payment method", "enum": [ "bank_transfer" ], "title": "PayoutsContractorsMethodsIdPutRequestBodyContentApplicationJsonSchemaDataPaymentMethod", "type": "string" }, "PayoutsContractorsMethodsIdPutResponsesContentApplicationJsonSchemaData": { "properties": { "id": { "description": "Unique identifier for the bank transfer method", "type": "string" }, "status": { "$ref": "#/components/schemas/PayoutsContractorsMethodsIdPutResponsesContentApplicationJsonSchemaDataStatus", "description": "Status of the method" }, "version": { "description": "Version identifier for the bank transfer method", "type": "string" } }, "title": "PayoutsContractorsMethodsIdPutResponsesContentApplicationJsonSchemaData", "type": "object" }, "PayoutsContractorsMethodsIdPutResponsesContentApplicationJsonSchemaDataStatus": { "description": "Status of the method", "enum": [ "PENDING", "VERIFYING", "FAILED", "APPROVED" ], "title": "PayoutsContractorsMethodsIdPutResponsesContentApplicationJsonSchemaDataStatus", "type": "string" }, "PayoutsContractorsMethodsIdPutResponsesContentApplicationJsonSchemaErrorsItems": { "properties": { "code": { "description": "Machine-readable error code.", "type": "string" }, "message": { "description": "Human-readable explanation.", "type": "string" } }, "title": "PayoutsContractorsMethodsIdPutResponsesContentApplicationJsonSchemaErrorsItems", "type": "object" }, "PayoutsContractorsMethodsPostRequestBodyContentApplicationJsonSchemaData": { "properties": { "address": { "$ref": "#/components/schemas/PayoutsContractorsMethodsPostRequestBodyContentApplicationJsonSchemaDataAddress" }, "is_default": { "description": "Specifies if the method is the default payout method - if true, autowithdrawal will be enabled for the contractor using this method", "type": "boolean" }, "method_name": { "description": "Name for method", "type": "string" }, "payload": { "additionalProperties": { "description": "Any type" }, "description": "Dynamic properties based on selected option. For example, if `selectedOption` is `swift_code`, payload may include `swiftCode`, `accountHolderName`, and `accountNumber`.", "type": "object" }, "payment_method": { "$ref": "#/components/schemas/PayoutsContractorsMethodsPostRequestBodyContentApplicationJsonSchemaDataPaymentMethod", "description": "Specifies the type of payment method" }, "selectedOption": { "description": "Specifies the type of bank transfer method. Maps from requirements type field", "type": "string" } }, "required": [ "address", "payload", "payment_method" ], "title": "PayoutsContractorsMethodsPostRequestBodyContentApplicationJsonSchemaData", "type": "object" }, "PayoutsContractorsMethodsPostRequestBodyContentApplicationJsonSchemaDataAddress": { "properties": { "city": { "description": "City name", "type": "string" }, "country": { "description": "Country code", "pattern": "^[A-Z]{2}$", "type": "string" }, "first_line": { "description": "First line of the address", "type": "string" }, "post_code": { "description": "Post code", "type": "string" }, "state": { "description": "State code", "type": "string" } }, "required": [ "city", "country", "post_code", "first_line" ], "title": "PayoutsContractorsMethodsPostRequestBodyContentApplicationJsonSchemaDataAddress", "type": "object" }, "PayoutsContractorsMethodsPostRequestBodyContentApplicationJsonSchemaDataPaymentMethod": { "description": "Specifies the type of payment method", "enum": [ "bank_transfer" ], "title": "PayoutsContractorsMethodsPostRequestBodyContentApplicationJsonSchemaDataPaymentMethod", "type": "string" }, "PayoutsContractorsMethodsPostResponsesContentApplicationJsonSchemaData": { "properties": { "id": { "description": "Unique identifier for the bank transfer method", "type": "string" }, "status": { "$ref": "#/components/schemas/PayoutsContractorsMethodsPostResponsesContentApplicationJsonSchemaDataStatus", "description": "Status of the bank transfer method" } }, "title": "PayoutsContractorsMethodsPostResponsesContentApplicationJsonSchemaData", "type": "object" }, "PayoutsContractorsMethodsPostResponsesContentApplicationJsonSchemaDataStatus": { "description": "Status of the bank transfer method", "enum": [ "pending", "verifying", "failed", "approved" ], "title": "PayoutsContractorsMethodsPostResponsesContentApplicationJsonSchemaDataStatus", "type": "string" }, "PayoutsContractorsMethodsPostResponsesContentApplicationJsonSchemaErrorsItems": { "properties": { "code": { "description": "Machine-readable error code.", "type": "string" }, "message": { "description": "Human-readable explanation.", "type": "string" } }, "title": "PayoutsContractorsMethodsPostResponsesContentApplicationJsonSchemaErrorsItems", "type": "object" }, "PayoutsContractorsSettingsAutoWithdrawPostRequestBodyContentApplicationJsonSchemaData": { "properties": { "is_auto_withdraw_enabled": { "description": "Sets auto withdraw to enabled or disabled for contractor", "type": "boolean" } }, "required": [ "is_auto_withdraw_enabled" ], "title": "PayoutsContractorsSettingsAutoWithdrawPostRequestBodyContentApplicationJsonSchemaData", "type": "object" }, "PayoutsEmployeesMethodsBankTransfersRequirementsGetResponsesContentApplicationJsonSchemaDataItems": { "properties": { "fields": { "description": "Groups of input fields to collect for this transfer type.", "items": { "$ref": "#/components/schemas/PayoutsEmployeesMethodsBankTransfersRequirementsGetResponsesContentApplicationJsonSchemaDataItemsFieldsItems" }, "type": "array" }, "intermediary": { "description": "Groups of intermediary bank fields to collect for this transfer type, when applicable.", "items": { "$ref": "#/components/schemas/PayoutsEmployeesMethodsBankTransfersRequirementsGetResponsesContentApplicationJsonSchemaDataItemsIntermediaryItems" }, "type": "array" }, "title": { "description": "User-facing title of the transfer type.", "type": "string" }, "type": { "description": "Transfer type identifier, for example `bts`, `iban` or `swift_code`.", "type": "string" } }, "required": [ "type", "title", "fields" ], "title": "PayoutsEmployeesMethodsBankTransfersRequirementsGetResponsesContentApplicationJsonSchemaDataItems", "type": "object" }, "PayoutsEmployeesMethodsBankTransfersRequirementsGetResponsesContentApplicationJsonSchemaDataItemsFieldsItems": { "properties": { "group": { "description": "Input fields within this group.", "items": { "$ref": "#/components/schemas/PayoutsEmployeesMethodsBankTransfersRequirementsGetResponsesContentApplicationJsonSchemaDataItemsFieldsItemsGroupItems" }, "type": "array" }, "name": { "description": "User-facing label for the field group.", "type": "string" } }, "required": [ "name", "group" ], "title": "PayoutsEmployeesMethodsBankTransfersRequirementsGetResponsesContentApplicationJsonSchemaDataItemsFieldsItems", "type": "object" }, "PayoutsEmployeesMethodsBankTransfersRequirementsGetResponsesContentApplicationJsonSchemaDataItemsFieldsItemsGroupItems": { "properties": { "display_format": { "description": "Optional display format hint for the field.", "type": [ "string", "null" ] }, "example": { "description": "Example value for the field.", "type": [ "string", "null" ] }, "is_required": { "description": "Whether the field is required.", "type": "boolean" }, "key": { "description": "Identifier of the input field. Dotted keys (for example `intermediary.bic`) denote nested properties.", "type": "string" }, "max_length": { "description": "Maximum length of the field value.", "type": [ "integer", "null" ] }, "min_length": { "description": "Minimum length of the field value.", "type": [ "integer", "null" ] }, "name": { "description": "User-facing name of the field.", "type": "string" }, "should_refresh_requirements_on_change": { "description": "Whether the requirements can change depending on this field's value. This lookup does not re-evaluate requirements; when `true`, use `POST /payouts/employees/methods/bank_transfers/requirements`.", "type": "boolean" }, "type": { "description": "Input type of the field, for example `text`, `select`, `country`, `number` or `date_local`.", "type": "string" }, "validation_regexp": { "description": "Regular expression the field value must match.", "type": [ "string", "null" ] }, "values_allowed": { "description": "Allowed values for select-type fields; null otherwise.", "items": { "$ref": "#/components/schemas/PayoutsEmployeesMethodsBankTransfersRequirementsGetResponsesContentApplicationJsonSchemaDataItemsFieldsItemsGroupItemsValuesAllowedItems" }, "type": [ "array", "null" ] } }, "required": [ "key", "name", "is_required" ], "title": "PayoutsEmployeesMethodsBankTransfersRequirementsGetResponsesContentApplicationJsonSchemaDataItemsFieldsItemsGroupItems", "type": "object" }, "PayoutsEmployeesMethodsBankTransfersRequirementsGetResponsesContentApplicationJsonSchemaDataItemsFieldsItemsGroupItemsValuesAllowedItems": { "properties": { "key": { "description": "Value to submit for this option (for example, a country code such as `AL`).", "type": "string" }, "name": { "description": "User-facing label for this option.", "type": "string" } }, "required": [ "key", "name" ], "title": "PayoutsEmployeesMethodsBankTransfersRequirementsGetResponsesContentApplicationJsonSchemaDataItemsFieldsItemsGroupItemsValuesAllowedItems", "type": "object" }, "PayoutsEmployeesMethodsBankTransfersRequirementsGetResponsesContentApplicationJsonSchemaDataItemsIntermediaryItems": { "properties": { "group": { "description": "Input fields within this group.", "items": { "$ref": "#/components/schemas/PayoutsEmployeesMethodsBankTransfersRequirementsGetResponsesContentApplicationJsonSchemaDataItemsIntermediaryItemsGroupItems" }, "type": "array" }, "name": { "description": "User-facing label for the field group.", "type": "string" } }, "required": [ "name", "group" ], "title": "PayoutsEmployeesMethodsBankTransfersRequirementsGetResponsesContentApplicationJsonSchemaDataItemsIntermediaryItems", "type": "object" }, "PayoutsEmployeesMethodsBankTransfersRequirementsGetResponsesContentApplicationJsonSchemaDataItemsIntermediaryItemsGroupItems": { "properties": { "display_format": { "description": "Optional display format hint for the field.", "type": [ "string", "null" ] }, "example": { "description": "Example value for the field.", "type": [ "string", "null" ] }, "is_required": { "description": "Whether the field is required.", "type": "boolean" }, "key": { "description": "Identifier of the input field. Dotted keys (for example `intermediary.bic`) denote nested properties.", "type": "string" }, "max_length": { "description": "Maximum length of the field value.", "type": [ "integer", "null" ] }, "min_length": { "description": "Minimum length of the field value.", "type": [ "integer", "null" ] }, "name": { "description": "User-facing name of the field.", "type": "string" }, "should_refresh_requirements_on_change": { "description": "Whether the requirements can change depending on this field's value. This lookup does not re-evaluate requirements; when `true`, use `POST /payouts/employees/methods/bank_transfers/requirements`.", "type": "boolean" }, "type": { "description": "Input type of the field, for example `text`, `select`, `country`, `number` or `date_local`.", "type": "string" }, "validation_regexp": { "description": "Regular expression the field value must match.", "type": [ "string", "null" ] }, "values_allowed": { "description": "Allowed values for select-type fields; null otherwise.", "items": { "$ref": "#/components/schemas/PayoutsEmployeesMethodsBankTransfersRequirementsGetResponsesContentApplicationJsonSchemaDataItemsIntermediaryItemsGroupItemsValuesAllowedItems" }, "type": [ "array", "null" ] } }, "required": [ "key", "name", "is_required" ], "title": "PayoutsEmployeesMethodsBankTransfersRequirementsGetResponsesContentApplicationJsonSchemaDataItemsIntermediaryItemsGroupItems", "type": "object" }, "PayoutsEmployeesMethodsBankTransfersRequirementsGetResponsesContentApplicationJsonSchemaDataItemsIntermediaryItemsGroupItemsValuesAllowedItems": { "properties": { "key": { "description": "Value to submit for this option (for example, a country code such as `AL`).", "type": "string" }, "name": { "description": "User-facing label for this option.", "type": "string" } }, "required": [ "key", "name" ], "title": "PayoutsEmployeesMethodsBankTransfersRequirementsGetResponsesContentApplicationJsonSchemaDataItemsIntermediaryItemsGroupItemsValuesAllowedItems", "type": "object" }, "PayoutsEmployeesMethodsBankTransfersRequirementsGetResponsesContentApplicationJsonSchemaErrorsItems": { "properties": { "code": { "description": "Machine-readable error code.", "type": "string" }, "field": { "description": "Name of the field causing the error, when applicable.", "type": "string" }, "message": { "description": "Human-readable explanation.", "type": "string" } }, "required": [ "code", "message" ], "title": "PayoutsEmployeesMethodsBankTransfersRequirementsGetResponsesContentApplicationJsonSchemaErrorsItems", "type": "object" }, "PayoutsEmployeesMethodsBankTransfersRequirementsPostRequestBodyContentApplicationJsonSchemaData": { "description": "Request data", "properties": { "current_state": { "$ref": "#/components/schemas/PayoutsEmployeesMethodsBankTransfersRequirementsPostRequestBodyContentApplicationJsonSchemaDataCurrentState", "description": "Current state of the bank details" } }, "title": "PayoutsEmployeesMethodsBankTransfersRequirementsPostRequestBodyContentApplicationJsonSchemaData", "type": "object" }, "PayoutsEmployeesMethodsBankTransfersRequirementsPostRequestBodyContentApplicationJsonSchemaDataCurrentState": { "description": "Current state of the bank details", "properties": { "bank_country_code": { "description": "Country code of the bank", "type": "string" }, "currency_code": { "description": "Currency code", "type": "string" }, "payment_type": { "description": "Type of payment", "type": "string" } }, "title": "PayoutsEmployeesMethodsBankTransfersRequirementsPostRequestBodyContentApplicationJsonSchemaDataCurrentState", "type": "object" }, "PayoutsEmployeesMethodsBankTransfersRequirementsPostResponsesContentApplicationJsonSchemaData": { "description": "Response data", "properties": { "is_final": { "description": "Indicates if the requirements are final", "type": "boolean" }, "requirements_id": { "description": "ID of the requirements", "format": "double", "type": "number" }, "steps": { "description": "Steps to fulfill the requirements", "items": { "$ref": "#/components/schemas/PayoutsEmployeesMethodsBankTransfersRequirementsPostResponsesContentApplicationJsonSchemaDataStepsItems" }, "type": "array" } }, "title": "PayoutsEmployeesMethodsBankTransfersRequirementsPostResponsesContentApplicationJsonSchemaData", "type": "object" }, "PayoutsEmployeesMethodsBankTransfersRequirementsPostResponsesContentApplicationJsonSchemaDataStepsItems": { "properties": { "banner": { "description": "Banner information (present when there is additional guidance to show; null otherwise).", "oneOf": [ { "$ref": "#/components/schemas/PayoutsEmployeesMethodsBankTransfersRequirementsPostResponsesContentApplicationJsonSchemaDataStepsItemsBanner" }, { "type": "null" } ] }, "categories": { "description": "Categories of the steps", "items": { "$ref": "#/components/schemas/PayoutsEmployeesMethodsBankTransfersRequirementsPostResponsesContentApplicationJsonSchemaDataStepsItemsCategoriesItems" }, "type": "array" }, "header": { "description": "Step header", "type": "string" }, "name": { "description": "Step name", "type": "string" }, "right_side_placeholder": { "description": "Right side placeholder", "type": "string" } }, "title": "PayoutsEmployeesMethodsBankTransfersRequirementsPostResponsesContentApplicationJsonSchemaDataStepsItems", "type": "object" }, "PayoutsEmployeesMethodsBankTransfersRequirementsPostResponsesContentApplicationJsonSchemaDataStepsItemsBanner": { "description": "Banner information (present when there is additional guidance to show; null otherwise).", "properties": { "additional_data": { "$ref": "#/components/schemas/PayoutsEmployeesMethodsBankTransfersRequirementsPostResponsesContentApplicationJsonSchemaDataStepsItemsBannerAdditionalData", "description": "Additional banner-specific data" }, "banner_type": { "description": "Banner type", "type": "string" }, "placement": { "description": "Where the banner should be displayed", "type": "string" } }, "title": "PayoutsEmployeesMethodsBankTransfersRequirementsPostResponsesContentApplicationJsonSchemaDataStepsItemsBanner", "type": "object" }, "PayoutsEmployeesMethodsBankTransfersRequirementsPostResponsesContentApplicationJsonSchemaDataStepsItemsBannerAdditionalData": { "description": "Additional banner-specific data", "properties": {}, "title": "PayoutsEmployeesMethodsBankTransfersRequirementsPostResponsesContentApplicationJsonSchemaDataStepsItemsBannerAdditionalData", "type": "object" }, "PayoutsEmployeesMethodsBankTransfersRequirementsPostResponsesContentApplicationJsonSchemaDataStepsItemsCategoriesItems": { "properties": { "alert": { "$ref": "#/components/schemas/PayoutsEmployeesMethodsBankTransfersRequirementsPostResponsesContentApplicationJsonSchemaDataStepsItemsCategoriesItemsAlert", "description": "Alert information" }, "banner": { "description": "Banner information (present when there is additional guidance to show; null otherwise).", "oneOf": [ { "$ref": "#/components/schemas/PayoutsEmployeesMethodsBankTransfersRequirementsPostResponsesContentApplicationJsonSchemaDataStepsItemsCategoriesItemsBanner" }, { "type": "null" } ] }, "fields": { "description": "Fields in the category", "items": { "$ref": "#/components/schemas/PayoutsEmployeesMethodsBankTransfersRequirementsPostResponsesContentApplicationJsonSchemaDataStepsItemsCategoriesItemsFieldsItems" }, "type": "array" }, "header": { "description": "Category header", "type": "string" }, "name": { "description": "Category name", "type": "string" }, "priority": { "description": "Category priority", "format": "double", "type": "number" } }, "title": "PayoutsEmployeesMethodsBankTransfersRequirementsPostResponsesContentApplicationJsonSchemaDataStepsItemsCategoriesItems", "type": "object" }, "PayoutsEmployeesMethodsBankTransfersRequirementsPostResponsesContentApplicationJsonSchemaDataStepsItemsCategoriesItemsAlert": { "description": "Alert information", "properties": { "message": { "description": "Alert message", "type": "string" }, "title": { "description": "Alert title", "type": "string" }, "type": { "description": "Alert type", "type": "string" } }, "title": "PayoutsEmployeesMethodsBankTransfersRequirementsPostResponsesContentApplicationJsonSchemaDataStepsItemsCategoriesItemsAlert", "type": "object" }, "PayoutsEmployeesMethodsBankTransfersRequirementsPostResponsesContentApplicationJsonSchemaDataStepsItemsCategoriesItemsBanner": { "description": "Banner information (present when there is additional guidance to show; null otherwise).", "properties": { "additional_data": { "$ref": "#/components/schemas/PayoutsEmployeesMethodsBankTransfersRequirementsPostResponsesContentApplicationJsonSchemaDataStepsItemsCategoriesItemsBannerAdditionalData", "description": "Additional banner-specific data" }, "banner_type": { "description": "Banner type", "type": "string" }, "placement": { "description": "Where the banner should be displayed", "type": "string" } }, "title": "PayoutsEmployeesMethodsBankTransfersRequirementsPostResponsesContentApplicationJsonSchemaDataStepsItemsCategoriesItemsBanner", "type": "object" }, "PayoutsEmployeesMethodsBankTransfersRequirementsPostResponsesContentApplicationJsonSchemaDataStepsItemsCategoriesItemsBannerAdditionalData": { "description": "Additional banner-specific data", "properties": {}, "title": "PayoutsEmployeesMethodsBankTransfersRequirementsPostResponsesContentApplicationJsonSchemaDataStepsItemsCategoriesItemsBannerAdditionalData", "type": "object" }, "PayoutsEmployeesMethodsBankTransfersRequirementsPostResponsesContentApplicationJsonSchemaDataStepsItemsCategoriesItemsFieldsItems": { "properties": { "category": { "description": "Field category", "type": "string" }, "disabled": { "description": "Indicates if the field is disabled", "type": "boolean" }, "example": { "description": "Example value", "type": [ "string", "null" ] }, "id": { "description": "Field ID", "format": "double", "type": "number" }, "key": { "description": "Field key", "type": "string" }, "max_length": { "description": "Maximum length of the field", "type": "string" }, "min_length": { "description": "Minimum length of the field", "type": "string" }, "name": { "description": "Field name", "type": "string" }, "required": { "description": "Indicates if the field is required", "type": "boolean" }, "sensitive": { "description": "Indicates if the field is sensitive", "type": "boolean" }, "tooltip": { "description": "Tooltip information", "type": [ "string", "null" ] }, "type": { "description": "Field type", "type": "string" }, "validation_regex_flags": { "description": "Validation regex flags", "type": [ "string", "null" ] }, "validation_regexp": { "description": "Validation regex pattern", "type": [ "string", "null" ] }, "values_allowed": { "description": "Allowed values for the field (present for select-type fields; null otherwise).", "items": { "$ref": "#/components/schemas/PayoutsEmployeesMethodsBankTransfersRequirementsPostResponsesContentApplicationJsonSchemaDataStepsItemsCategoriesItemsFieldsItemsValuesAllowedItems" }, "type": [ "array", "null" ] } }, "title": "PayoutsEmployeesMethodsBankTransfersRequirementsPostResponsesContentApplicationJsonSchemaDataStepsItemsCategoriesItemsFieldsItems", "type": "object" }, "PayoutsEmployeesMethodsBankTransfersRequirementsPostResponsesContentApplicationJsonSchemaDataStepsItemsCategoriesItemsFieldsItemsValuesAllowedItems": { "properties": { "key": { "description": "Machine-readable option key.", "type": "string" }, "name": { "description": "Human-readable option label.", "type": "string" } }, "required": [ "key", "name" ], "title": "PayoutsEmployeesMethodsBankTransfersRequirementsPostResponsesContentApplicationJsonSchemaDataStepsItemsCategoriesItemsFieldsItemsValuesAllowedItems", "type": "object" }, "PayoutsEmployeesMethodsBankTransfersRequirementsPostResponsesContentApplicationJsonSchemaErrorsItems": { "properties": { "code": { "description": "Machine-readable error code.", "type": "string" }, "message": { "description": "Human-readable explanation.", "type": "string" } }, "title": "PayoutsEmployeesMethodsBankTransfersRequirementsPostResponsesContentApplicationJsonSchemaErrorsItems", "type": "object" }, "PayoutsEmployeesMethodsGetResponsesContentApplicationJsonSchemaDataItems": { "properties": { "created_at": { "description": "Creation timestamp", "type": "string" }, "data": { "$ref": "#/components/schemas/PayoutsEmployeesMethodsGetResponsesContentApplicationJsonSchemaDataItemsData" }, "funds_distribution": { "description": "Funds distribution percentage", "format": "double", "type": "number" }, "id": { "description": "Unique identifier for the bank details", "type": "string" }, "is_active_version": { "description": "Indicates if this is the active version", "type": "boolean" }, "status": { "description": "Status of the bank details", "type": "string" }, "updated_at": { "description": "Last update timestamp", "type": "string" }, "version": { "description": "Version identifier", "type": "string" } }, "title": "PayoutsEmployeesMethodsGetResponsesContentApplicationJsonSchemaDataItems", "type": "object" }, "PayoutsEmployeesMethodsGetResponsesContentApplicationJsonSchemaDataItemsData": { "properties": { "address_line1": { "description": "Address line 1", "type": "string" }, "bank_country_code": { "description": "Country code of the bank", "type": "string" }, "bank_name": { "description": "Name of the bank", "type": "string" }, "city": { "description": "Name of the city", "type": "string" }, "country_code": { "description": "Country code", "type": "string" }, "full_name": { "description": "Full name of the account holder", "type": "string" }, "iban": { "description": "International Bank Account Number", "type": "string" }, "original_name": { "description": "Original name of the account holder", "type": "string" }, "postal": { "description": "Postal code", "type": "string" }, "province_state": { "description": "Province or state", "type": "string" }, "swift_bic": { "description": "SWIFT/BIC code", "type": "string" } }, "title": "PayoutsEmployeesMethodsGetResponsesContentApplicationJsonSchemaDataItemsData", "type": "object" }, "PayoutsEmployeesMethodsPostRequestBodyContentApplicationJsonSchemaData": { "description": "Request data", "properties": { "id": { "description": "Unique identifier for the bank details", "type": "string" }, "payload": { "$ref": "#/components/schemas/PayoutsEmployeesMethodsPostRequestBodyContentApplicationJsonSchemaDataPayload", "description": "Payload containing bank details" } }, "title": "PayoutsEmployeesMethodsPostRequestBodyContentApplicationJsonSchemaData", "type": "object" }, "PayoutsEmployeesMethodsPostRequestBodyContentApplicationJsonSchemaDataPayload": { "description": "Payload containing bank details", "properties": { "address_line1": { "description": "Address line 1", "type": "string" }, "bank_country_code": { "description": "Country code of the bank", "type": "string" }, "bank_name": { "description": "Name of the bank", "type": "string" }, "city": { "description": "Name of the city", "type": "string" }, "country_code": { "description": "Country code", "type": "string" }, "full_name": { "description": "Full name of the account holder", "type": "string" }, "iban": { "description": "International Bank Account Number", "type": "string" }, "original_name": { "description": "Original name of the account holder", "type": "string" }, "postal": { "description": "Postal code", "type": "string" }, "province_state": { "description": "Province or state", "type": "string" }, "swift_bic": { "description": "SWIFT/BIC code", "type": "string" } }, "title": "PayoutsEmployeesMethodsPostRequestBodyContentApplicationJsonSchemaDataPayload", "type": "object" }, "PayoutsEmployeesMethodsPostResponsesContentApplicationJsonSchemaData": { "properties": { "created_at": { "description": "Creation timestamp", "type": "string" }, "data": { "$ref": "#/components/schemas/PayoutsEmployeesMethodsPostResponsesContentApplicationJsonSchemaDataData" }, "funds_distribution": { "description": "Funds distribution percentage", "format": "double", "type": "number" }, "id": { "description": "Unique identifier for the bank details", "type": "string" }, "is_active_version": { "description": "Indicates if this is the active version", "type": "boolean" }, "status": { "description": "Status of the bank details", "type": "string" }, "updated_at": { "description": "Last update timestamp", "type": "string" }, "version": { "description": "Version identifier", "type": "string" } }, "title": "PayoutsEmployeesMethodsPostResponsesContentApplicationJsonSchemaData", "type": "object" }, "PayoutsEmployeesMethodsPostResponsesContentApplicationJsonSchemaDataData": { "properties": { "address_line1": { "description": "Address line 1", "type": "string" }, "bank_country_code": { "description": "Country code of the bank", "type": "string" }, "bank_name": { "description": "Name of the bank", "type": "string" }, "city": { "description": "Name of the city", "type": "string" }, "country_code": { "description": "Country code", "type": "string" }, "full_name": { "description": "Full name of the account holder", "type": "string" }, "iban": { "description": "International Bank Account Number", "type": "string" }, "original_name": { "description": "Original name of the account holder", "type": "string" }, "postal": { "description": "Postal code", "type": "string" }, "province_state": { "description": "Province or state", "type": "string" }, "swift_bic": { "description": "SWIFT/BIC code", "type": "string" } }, "title": "PayoutsEmployeesMethodsPostResponsesContentApplicationJsonSchemaDataData", "type": "object" }, "PayoutsWithdrawalsPostRequestBodyContentApplicationJsonSchemaData": { "properties": { "amount": { "description": "Amount to withdraw (must be positive)", "format": "double", "type": "number" }, "currency": { "description": "Currency code for the withdrawal amount", "type": "string" }, "withdrawal_method_id": { "description": "Id of the withdrawal method to use", "format": "uuid", "type": "string" } }, "required": [ "amount", "currency", "withdrawal_method_id" ], "title": "PayoutsWithdrawalsPostRequestBodyContentApplicationJsonSchemaData", "type": "object" }, "PayoutsWithdrawalsPostResponsesContentApplicationJsonSchemaData": { "properties": { "amount": { "description": "Amount of the transaction", "format": "double", "type": "number" }, "created_at": { "description": "Timestamp of the transaction creation", "format": "date-time", "type": "string" }, "currency": { "description": "Currency of the transaction", "type": "string" }, "id": { "description": "ID of the created transaction", "format": "uuid", "type": "string" }, "updated_at": { "description": "Timestamp of the transaction update", "format": "date-time", "type": "string" } }, "title": "PayoutsWithdrawalsPostResponsesContentApplicationJsonSchemaData", "type": "object" }, "PayoutsWithdrawalsPostResponsesContentApplicationJsonSchemaErrorsItems": { "properties": { "message": { "description": "Error message", "type": "string" } }, "title": "PayoutsWithdrawalsPostResponsesContentApplicationJsonSchemaErrorsItems", "type": "object" }, "Payouts_addEditBankDetails-v2026-01-01_Response_200": { "properties": { "data": { "$ref": "#/components/schemas/PayoutsEmployeesMethodsPostResponsesContentApplicationJsonSchemaData" } }, "title": "Payouts_addEditBankDetails-v2026-01-01_Response_200", "type": "object" }, "Payouts_changeTheAutoWithdrawalSetting-v2026-01-01_Response_200": { "properties": { "data": { "$ref": "#/components/schemas/PayoutsAutoWithdrawalSettingPatchResponsesContentApplicationJsonSchemaData" } }, "title": "Payouts_changeTheAutoWithdrawalSetting-v2026-01-01_Response_200", "type": "object" }, "Payouts_createABankTransferMethod-v2026-01-01_Response_201": { "properties": { "data": { "$ref": "#/components/schemas/PayoutsContractorsMethodsPostResponsesContentApplicationJsonSchemaData" } }, "required": [ "data" ], "title": "Payouts_createABankTransferMethod-v2026-01-01_Response_201", "type": "object" }, "Payouts_deleteBankDetails-v2026-01-01_Response_200": { "description": "Empty response body", "properties": {}, "title": "Payouts_deleteBankDetails-v2026-01-01_Response_200", "type": "object" }, "Payouts_dynamicRequirements-v2026-01-01_Response_200": { "properties": { "data": { "$ref": "#/components/schemas/PayoutsEmployeesMethodsBankTransfersRequirementsPostResponsesContentApplicationJsonSchemaData", "description": "Response data" } }, "title": "Payouts_dynamicRequirements-v2026-01-01_Response_200", "type": "object" }, "Payouts_fetchAllPayoutMethods-v2026-01-01_Response_200": { "properties": { "data": { "description": "List of payout methods associated with the account.", "items": { "$ref": "#/components/schemas/PayoutsContractorsMethodsGetResponsesContentApplicationJsonSchemaDataItems" }, "type": "array" } }, "required": [ "data" ], "title": "Payouts_fetchAllPayoutMethods-v2026-01-01_Response_200", "type": "object" }, "Payouts_getBankDetails-v2026-01-01_Response_200": { "properties": { "data": { "items": { "$ref": "#/components/schemas/PayoutsEmployeesMethodsGetResponsesContentApplicationJsonSchemaDataItems" }, "type": "array" } }, "title": "Payouts_getBankDetails-v2026-01-01_Response_200", "type": "object" }, "Payouts_getBankTransferRequirements-v2026-01-01_Response_200": { "properties": { "data": { "items": { "$ref": "#/components/schemas/PayoutsContractorsMethodsBankTransfersRequirementsGetResponsesContentApplicationJsonSchemaDataItems" }, "type": "array" } }, "required": [ "data" ], "title": "Payouts_getBankTransferRequirements-v2026-01-01_Response_200", "type": "object" }, "Payouts_getBankTransferSupportedRoutes-v2026-01-01_Response_200": { "properties": { "data": { "additionalProperties": { "items": { "type": "string" }, "type": "array" }, "description": "A mapping of country codes to arrays of supported currency codes", "type": "object" } }, "required": [ "data" ], "title": "Payouts_getBankTransferSupportedRoutes-v2026-01-01_Response_200", "type": "object" }, "Payouts_getStaticEmployeeBankTransferRequirements-v2026-09-28_Response_200": { "properties": { "data": { "description": "The preferred transfer type for the country and currency, as a list of at most one item. Empty when no route supports them.", "items": { "$ref": "#/components/schemas/PayoutsEmployeesMethodsBankTransfersRequirementsGetResponsesContentApplicationJsonSchemaDataItems" }, "type": "array" } }, "required": [ "data" ], "title": "Payouts_getStaticEmployeeBankTransferRequirements-v2026-09-28_Response_200", "type": "object" }, "Payouts_getTheAutoWithdrawalSetting-v2026-01-01_Response_200": { "properties": { "data": { "$ref": "#/components/schemas/PayoutsAutoWithdrawalSettingGetResponsesContentApplicationJsonSchemaData" } }, "title": "Payouts_getTheAutoWithdrawalSetting-v2026-01-01_Response_200", "type": "object" }, "Payouts_listContractorBalances-v2026-01-01_Response_200": { "properties": { "data": { "$ref": "#/components/schemas/PayoutsBalancesGetResponsesContentApplicationJsonSchemaData" } }, "title": "Payouts_listContractorBalances-v2026-01-01_Response_200", "type": "object" }, "Payouts_requestToWithdrawFunds-v2026-01-01_Response_201": { "properties": { "data": { "$ref": "#/components/schemas/PayoutsWithdrawalsPostResponsesContentApplicationJsonSchemaData" } }, "title": "Payouts_requestToWithdrawFunds-v2026-01-01_Response_201", "type": "object" }, "Payouts_updateABankTransferMethod-v2026-01-01_Response_200": { "properties": { "data": { "$ref": "#/components/schemas/PayoutsContractorsMethodsIdPutResponsesContentApplicationJsonSchemaData" } }, "required": [ "data" ], "title": "Payouts_updateABankTransferMethod-v2026-01-01_Response_200", "type": "object" }, "Payouts_updateAutoWithdrawSetting-v2026-01-01_Response_200": { "description": "Empty response body", "properties": {}, "title": "Payouts_updateAutoWithdrawSetting-v2026-01-01_Response_200", "type": "object" }, "PayrollActivationsGetParametersXBeta": { "default": "true", "enum": [ "true" ], "title": "PayrollActivationsGetParametersXBeta", "type": "string" }, "PayrollActivationsGetResponsesContentApplicationJsonSchemaData": { "properties": { "is_ready": { "description": "Whether the payroll activation has reached the READY stage. False if there is none yet.", "type": "boolean" } }, "required": [ "is_ready" ], "title": "PayrollActivationsGetResponsesContentApplicationJsonSchemaData", "type": "object" }, "PayrollGroupsGetParametersPagination": { "properties": { "cursor": { "maxLength": 256, "minLength": 1, "pattern": "^[A-Za-z0-9_-]+$", "type": "string" }, "limit": { "default": 10, "maximum": 15, "minimum": 1, "type": "integer" } }, "title": "PayrollGroupsGetParametersPagination", "type": "object" }, "PayrollGroupsGetResponsesContentApplicationJsonSchemaDataItems": { "properties": { "calendars": { "description": "REGULAR calendars for this group within the requested year.", "items": { "$ref": "#/components/schemas/PayrollGroupsGetResponsesContentApplicationJsonSchemaDataItemsCalendarsItems" }, "type": "array" }, "id": { "description": "Unique identifier of the payroll group.", "type": "string" }, "is_active": { "description": "Whether the payroll group is currently active.", "type": "boolean" }, "name": { "description": "Human-readable name of the payroll group.", "type": "string" }, "regular_cycle_cadence": { "$ref": "#/components/schemas/PayrollGroupsGetResponsesContentApplicationJsonSchemaDataItemsRegularCycleCadence", "description": "Frequency at which regular payroll cycles are run for this group." } }, "required": [ "id", "name", "calendars", "is_active", "regular_cycle_cadence" ], "title": "PayrollGroupsGetResponsesContentApplicationJsonSchemaDataItems", "type": "object" }, "PayrollGroupsGetResponsesContentApplicationJsonSchemaDataItemsCalendarsItems": { "properties": { "calendar_type": { "description": "Type of the calendar, e.g. REGULAR.", "type": "string" }, "id": { "description": "Unique identifier of the calendar.", "type": "string" }, "values": { "additionalProperties": { "$ref": "#/components/schemas/PayrollGroupsGetResponsesContentApplicationJsonSchemaDataItemsCalendarsItemsValues" }, "description": "Map of calendar milestone keys to their scheduled date-time values. A calendar holds only the milestones its payroll uses. Possible keys:\n- `START`: Start date of the payroll cycle.\n- `END`: End date of the payroll cycle.\n- `CYCLE_SUBMISSION`: Deadline to submit payroll inputs for the cycle.\n- `CYCLE_PUBLISHING`: Date the processed payroll is published for review.\n- `CYCLE_APPROVAL`: Deadline to approve the payroll (for EOR, the payments package).\n- `PAYROLL_FUNDING`: Date the payroll funding invoice is issued.\n- `FUNDING_PAYMENT_RECEIPT`: Date the funding payment must be received.\n- `INVOICE_PUBLISHING`: Date the payroll invoices are published.\n- `PAYMENT_RELEASE`: Date the salary payments are released.\n- `PAYSLIPS_PUBLISHING`: Date the payslips are published.\n- `SALARY_PAY`: Date the employees are paid.\n- `TIME_SHEETS_CUT_OFF`: Cut-off date for timesheets to be included in the cycle.\n- `LATE_STARTERS_CUTOFF`: Cut-off date for new hires to be included in the cycle.\n- `SOFT_G2N_UPLOAD`: Date the gross-to-net (G2N) report is uploaded.\n- `FINAL_BATCH_REPORTS`: Date the final batch reports are delivered.", "type": "object" } }, "required": [ "id", "values", "calendar_type" ], "title": "PayrollGroupsGetResponsesContentApplicationJsonSchemaDataItemsCalendarsItems", "type": "object" }, "PayrollGroupsGetResponsesContentApplicationJsonSchemaDataItemsCalendarsItemsValues": { "properties": { "value": { "description": "ISO-8601 date-time value for this calendar key.", "type": "string" } }, "required": [ "value" ], "title": "PayrollGroupsGetResponsesContentApplicationJsonSchemaDataItemsCalendarsItemsValues", "type": "object" }, "PayrollGroupsGetResponsesContentApplicationJsonSchemaDataItemsRegularCycleCadence": { "description": "Frequency at which regular payroll cycles are run for this group.", "enum": [ "WEEKLY", "BIWEEKLY", "MONTHLY", "BIMONTHLY", "FOUR_WEEKLY", "QUARTERLY" ], "title": "PayrollGroupsGetResponsesContentApplicationJsonSchemaDataItemsRegularCycleCadence", "type": "string" }, "PayrollGroupsGetResponsesContentApplicationJsonSchemaPagination": { "properties": { "hasMore": { "description": "Whether additional pages exist after this one.", "type": "boolean" }, "limit": { "description": "Maximum number of items returned in this page.", "maximum": 9007199254740991, "minimum": 1, "type": "integer" }, "nextCursor": { "description": "Opaque cursor for the next page, or null when there are no more results.", "type": [ "string", "null" ] } }, "required": [ "limit", "hasMore", "nextCursor" ], "title": "PayrollGroupsGetResponsesContentApplicationJsonSchemaPagination", "type": "object" }, "PeopleCustomFieldsGetResponsesContentApplicationJsonSchemaDataItems": { "properties": { "created_at": { "description": "Creation date of the custom field", "format": "date-time", "type": "string" }, "description": { "description": "Description of the custom field", "maxLength": 140, "type": [ "string", "null" ] }, "id": { "description": "Unique identifier of the custom field", "format": "uuid", "type": "string" }, "name": { "description": "Name of the custom field", "maxLength": 255, "type": "string" }, "placement": { "description": "Valid placements for custom field", "oneOf": [ { "$ref": "#/components/schemas/PeopleCustomFieldsGetResponsesContentApplicationJsonSchemaDataItemsPlacement" }, { "type": "null" } ] }, "settings": { "$ref": "#/components/schemas/PeopleCustomFieldsGetResponsesContentApplicationJsonSchemaDataItemsSettings", "description": "Settings for the custom field" }, "type": { "$ref": "#/components/schemas/PeopleCustomFieldsGetResponsesContentApplicationJsonSchemaDataItemsType", "description": "Type of the custom field" } }, "title": "PeopleCustomFieldsGetResponsesContentApplicationJsonSchemaDataItems", "type": "object" }, "PeopleCustomFieldsGetResponsesContentApplicationJsonSchemaDataItemsPlacement": { "description": "Valid placements for custom field", "enum": [ "profile", "contract" ], "title": "PeopleCustomFieldsGetResponsesContentApplicationJsonSchemaDataItemsPlacement", "type": "string" }, "PeopleCustomFieldsGetResponsesContentApplicationJsonSchemaDataItemsSettings": { "description": "Settings for the custom field", "properties": { "access": { "$ref": "#/components/schemas/PeopleCustomFieldsGetResponsesContentApplicationJsonSchemaDataItemsSettingsAccess", "description": "Access settings for the custom field" }, "countries": { "description": "Countries for which the custom field is applicable.", "items": { "type": "string" }, "type": "array" }, "is_enabled": { "description": "Whether the custom field is enabled", "type": "boolean" }, "required": { "description": "Whether the custom field is required", "type": "boolean" }, "worker_types": { "description": "Worker types for which the custom field is applicable", "items": { "$ref": "#/components/schemas/PeopleCustomFieldsGetResponsesContentApplicationJsonSchemaDataItemsSettingsWorkerTypesItems" }, "type": "array" } }, "required": [ "access", "required", "is_enabled" ], "title": "PeopleCustomFieldsGetResponsesContentApplicationJsonSchemaDataItemsSettings", "type": "object" }, "PeopleCustomFieldsGetResponsesContentApplicationJsonSchemaDataItemsSettingsAccess": { "description": "Access settings for the custom field", "properties": { "group_permission_set": { "description": "Permission set identifier for the custom field", "type": [ "string", "null" ] }, "is_sensitive": { "description": "Whether the custom field is sensitive", "type": "boolean" }, "provided_by": { "description": "Entity providing access to the custom field", "oneOf": [ { "$ref": "#/components/schemas/PeopleCustomFieldsGetResponsesContentApplicationJsonSchemaDataItemsSettingsAccessProvidedBy" }, { "type": "null" } ] } }, "required": [ "is_sensitive" ], "title": "PeopleCustomFieldsGetResponsesContentApplicationJsonSchemaDataItemsSettingsAccess", "type": "object" }, "PeopleCustomFieldsGetResponsesContentApplicationJsonSchemaDataItemsSettingsAccessProvidedBy": { "description": "Entity providing access to the custom field", "enum": [ "organization", "worker" ], "title": "PeopleCustomFieldsGetResponsesContentApplicationJsonSchemaDataItemsSettingsAccessProvidedBy", "type": "string" }, "PeopleCustomFieldsGetResponsesContentApplicationJsonSchemaDataItemsSettingsWorkerTypesItems": { "enum": [ "eor", "peo", "contractor", "hris_direct_employee", "hris_direct_contractor", "direct_employee", "contractor_outside_deel", "person_without_contract" ], "title": "PeopleCustomFieldsGetResponsesContentApplicationJsonSchemaDataItemsSettingsWorkerTypesItems", "type": "string" }, "PeopleCustomFieldsGetResponsesContentApplicationJsonSchemaDataItemsType": { "description": "Type of the custom field", "oneOf": [ { "$ref": "#/components/schemas/PeopleCustomFieldsGetResponsesContentApplicationJsonSchemaDataItemsType0" }, { "$ref": "#/components/schemas/PeopleCustomFieldsGetResponsesContentApplicationJsonSchemaDataItemsType1" }, { "$ref": "#/components/schemas/PeopleCustomFieldsGetResponsesContentApplicationJsonSchemaDataItemsType2" } ], "title": "PeopleCustomFieldsGetResponsesContentApplicationJsonSchemaDataItemsType" }, "PeopleCustomFieldsGetResponsesContentApplicationJsonSchemaDataItemsType0": { "properties": { "name": { "$ref": "#/components/schemas/PeopleCustomFieldsGetResponsesContentApplicationJsonSchemaDataItemsTypeOneOf0Name", "description": "Simple types" } }, "required": [ "name" ], "title": "PeopleCustomFieldsGetResponsesContentApplicationJsonSchemaDataItemsType0", "type": "object" }, "PeopleCustomFieldsGetResponsesContentApplicationJsonSchemaDataItemsType1": { "properties": { "currency": { "description": "Currency code", "maxLength": 3, "type": [ "string", "null" ] }, "is_fixed": { "description": "When currency is fixed, only the amount can be edited by the users", "type": "boolean" }, "name": { "$ref": "#/components/schemas/PeopleCustomFieldsGetResponsesContentApplicationJsonSchemaDataItemsTypeOneOf1Name", "description": "Currency type" } }, "required": [ "name", "is_fixed" ], "title": "PeopleCustomFieldsGetResponsesContentApplicationJsonSchemaDataItemsType1", "type": "object" }, "PeopleCustomFieldsGetResponsesContentApplicationJsonSchemaDataItemsType2": { "properties": { "name": { "$ref": "#/components/schemas/PeopleCustomFieldsGetResponsesContentApplicationJsonSchemaDataItemsTypeOneOf2Name", "description": "List types" }, "options": { "description": "List of options for the custom field", "items": { "type": "string" }, "type": "array" } }, "required": [ "name", "options" ], "title": "PeopleCustomFieldsGetResponsesContentApplicationJsonSchemaDataItemsType2", "type": "object" }, "PeopleCustomFieldsGetResponsesContentApplicationJsonSchemaDataItemsTypeOneOf0Name": { "description": "Simple types", "enum": [ "text", "number", "date", "percentage", "hyperlink" ], "title": "PeopleCustomFieldsGetResponsesContentApplicationJsonSchemaDataItemsTypeOneOf0Name", "type": "string" }, "PeopleCustomFieldsGetResponsesContentApplicationJsonSchemaDataItemsTypeOneOf1Name": { "description": "Currency type", "enum": [ "currency" ], "title": "PeopleCustomFieldsGetResponsesContentApplicationJsonSchemaDataItemsTypeOneOf1Name", "type": "string" }, "PeopleCustomFieldsGetResponsesContentApplicationJsonSchemaDataItemsTypeOneOf2Name": { "description": "List types", "enum": [ "list", "multiselect" ], "title": "PeopleCustomFieldsGetResponsesContentApplicationJsonSchemaDataItemsTypeOneOf2Name", "type": "string" }, "PeopleCustomFieldsIdGetResponsesContentApplicationJsonSchemaData": { "properties": { "created_at": { "description": "Creation date of the custom field", "format": "date", "type": "string" }, "description": { "description": "Description of the custom field", "type": "string" }, "id": { "description": "Custom field id", "format": "uuid", "type": "string" }, "name": { "description": "Name of the custom field", "type": "string" }, "placement": { "$ref": "#/components/schemas/PeopleCustomFieldsIdGetResponsesContentApplicationJsonSchemaDataPlacement", "description": "Valid placements for custom field" }, "settings": { "$ref": "#/components/schemas/PeopleCustomFieldsIdGetResponsesContentApplicationJsonSchemaDataSettings" }, "type": { "$ref": "#/components/schemas/PeopleCustomFieldsIdGetResponsesContentApplicationJsonSchemaDataType" } }, "title": "PeopleCustomFieldsIdGetResponsesContentApplicationJsonSchemaData", "type": "object" }, "PeopleCustomFieldsIdGetResponsesContentApplicationJsonSchemaDataPlacement": { "description": "Valid placements for custom field", "enum": [ "profile", "contract" ], "title": "PeopleCustomFieldsIdGetResponsesContentApplicationJsonSchemaDataPlacement", "type": "string" }, "PeopleCustomFieldsIdGetResponsesContentApplicationJsonSchemaDataSettings": { "properties": { "access": { "$ref": "#/components/schemas/PeopleCustomFieldsIdGetResponsesContentApplicationJsonSchemaDataSettingsAccess", "description": "Access settings for the custom field" }, "countries": { "description": "Countries for which the custom field is applicable.", "items": { "type": "string" }, "type": "array" }, "is_enabled": { "description": "Whether the custom field is enabled", "type": "boolean" }, "required": { "description": "Whether the custom field is required", "type": "boolean" }, "worker_types": { "description": "Worker types for which the custom field is applicable", "items": { "$ref": "#/components/schemas/PeopleCustomFieldsIdGetResponsesContentApplicationJsonSchemaDataSettingsWorkerTypesItems" }, "type": "array" } }, "title": "PeopleCustomFieldsIdGetResponsesContentApplicationJsonSchemaDataSettings", "type": "object" }, "PeopleCustomFieldsIdGetResponsesContentApplicationJsonSchemaDataSettingsAccess": { "description": "Access settings for the custom field", "properties": { "is_sensitive": { "description": "Whether the custom field is sensitive", "type": "boolean" }, "provided_by": { "description": "Entities providing access to the custom field", "items": { "$ref": "#/components/schemas/PeopleCustomFieldsIdGetResponsesContentApplicationJsonSchemaDataSettingsAccessProvidedByItems" }, "type": "array" } }, "title": "PeopleCustomFieldsIdGetResponsesContentApplicationJsonSchemaDataSettingsAccess", "type": "object" }, "PeopleCustomFieldsIdGetResponsesContentApplicationJsonSchemaDataSettingsAccessProvidedByItems": { "enum": [ "organization", "worker" ], "title": "PeopleCustomFieldsIdGetResponsesContentApplicationJsonSchemaDataSettingsAccessProvidedByItems", "type": "string" }, "PeopleCustomFieldsIdGetResponsesContentApplicationJsonSchemaDataSettingsWorkerTypesItems": { "enum": [ "eor", "contractor", "hris_direct_employee", "direct_employee" ], "title": "PeopleCustomFieldsIdGetResponsesContentApplicationJsonSchemaDataSettingsWorkerTypesItems", "type": "string" }, "PeopleCustomFieldsIdGetResponsesContentApplicationJsonSchemaDataType": { "oneOf": [ { "$ref": "#/components/schemas/PeopleCustomFieldsIdGetResponsesContentApplicationJsonSchemaDataType0" }, { "$ref": "#/components/schemas/PeopleCustomFieldsIdGetResponsesContentApplicationJsonSchemaDataType1" }, { "$ref": "#/components/schemas/PeopleCustomFieldsIdGetResponsesContentApplicationJsonSchemaDataType2" } ], "title": "PeopleCustomFieldsIdGetResponsesContentApplicationJsonSchemaDataType" }, "PeopleCustomFieldsIdGetResponsesContentApplicationJsonSchemaDataType0": { "properties": { "name": { "$ref": "#/components/schemas/PeopleCustomFieldsIdGetResponsesContentApplicationJsonSchemaDataTypeOneOf0Name", "description": "Simple types" } }, "title": "PeopleCustomFieldsIdGetResponsesContentApplicationJsonSchemaDataType0", "type": "object" }, "PeopleCustomFieldsIdGetResponsesContentApplicationJsonSchemaDataType1": { "properties": { "currency": { "description": "Currency code", "type": "string" }, "is_fixed": { "description": "When currency is fixed, only the amount can be edited by the users", "type": "boolean" }, "name": { "$ref": "#/components/schemas/PeopleCustomFieldsIdGetResponsesContentApplicationJsonSchemaDataTypeOneOf1Name", "description": "Currency type" } }, "title": "PeopleCustomFieldsIdGetResponsesContentApplicationJsonSchemaDataType1", "type": "object" }, "PeopleCustomFieldsIdGetResponsesContentApplicationJsonSchemaDataType2": { "properties": { "name": { "$ref": "#/components/schemas/PeopleCustomFieldsIdGetResponsesContentApplicationJsonSchemaDataTypeOneOf2Name", "description": "List types" }, "options": { "description": "List of options for the custom field", "items": { "type": "string" }, "type": "array" } }, "title": "PeopleCustomFieldsIdGetResponsesContentApplicationJsonSchemaDataType2", "type": "object" }, "PeopleCustomFieldsIdGetResponsesContentApplicationJsonSchemaDataTypeOneOf0Name": { "description": "Simple types", "enum": [ "text", "number", "date", "percentage" ], "title": "PeopleCustomFieldsIdGetResponsesContentApplicationJsonSchemaDataTypeOneOf0Name", "type": "string" }, "PeopleCustomFieldsIdGetResponsesContentApplicationJsonSchemaDataTypeOneOf1Name": { "description": "Currency type", "enum": [ "currency" ], "title": "PeopleCustomFieldsIdGetResponsesContentApplicationJsonSchemaDataTypeOneOf1Name", "type": "string" }, "PeopleCustomFieldsIdGetResponsesContentApplicationJsonSchemaDataTypeOneOf2Name": { "description": "List types", "enum": [ "list", "multiselect" ], "title": "PeopleCustomFieldsIdGetResponsesContentApplicationJsonSchemaDataTypeOneOf2Name", "type": "string" }, "PeopleExternalWorkerIdPersonalPatchRequestBodyContentApplicationJsonSchemaData": { "properties": { "date_of_birth": { "description": "The date of birth of the worker. Format: YYYY-MM-DD.", "format": "date", "type": "string" }, "legal_first_name": { "description": "The legal first name of the worker.", "maxLength": 100, "type": "string" }, "legal_last_name": { "description": "The legal last name of the worker.", "maxLength": 100, "type": "string" }, "personal_email": { "description": "The personal email of the worker.", "format": "email", "maxLength": 255, "type": "string" }, "preferred_name": { "description": "The preferred name of the worker.", "maxLength": 255, "type": [ "string", "null" ] } }, "title": "PeopleExternalWorkerIdPersonalPatchRequestBodyContentApplicationJsonSchemaData", "type": "object" }, "PeopleGetParametersBandPlacementsSchemaItems": { "enum": [ "ABOVE", "WITHIN", "BELOW" ], "title": "PeopleGetParametersBandPlacementsSchemaItems", "type": "string" }, "PeopleGetParametersFieldsSchemaItems": { "enum": [ "id", "created_at", "first_name", "last_name", "full_name", "preferred_first_name", "preferred_last_name", "worker_id", "external_id", "hris_organization_user_id", "termination_last_day", "worker_relations", "custom_field_values", "emails", "birth_date", "start_date", "nationalities", "client_legal_entity", "state", "seniority", "completion_date", "direct_manager", "direct_reports", "direct_reports_count", "employments", "employments[0].id", "employments[0].name", "employments[0].team", "employments[0].custom_field_values", "employments[0].email", "employments[0].state", "employments[0].country", "employments[0].payment", "employments[0].is_ended", "employments[0].termination_last_day", "employments[0].timezone", "employments[0].job_title", "employments[0].seniority", "employments[0].start_date", "employments[0].work_email", "employments[0].hiring_type", "employments[0].hiring_status", "employments[0].completion_date", "employments[0].contract_status", "employments[0].voluntarily_left", "employments[0].contract_coverage", "employments[0].new_hiring_status", "employments[0].client_legal_entity", "employments[0].has_eor_termination", "employments[0].contract_is_archived", "employments[0].contract_has_contractor", "employments[0].is_user_contract_deleted", "employments[0].hris_direct_employee_invitation", "employments[0].employee_number", "hiring_status", "new_hiring_status", "is_pwac", "hiring_type", "job_title", "country", "timezone", "department", "work_location", "updated_at", "addresses", "additional_details", "profile_organizational_structures", "worker_termination_last_date_of_work", "active_worker_termination_status", "last_day_of_work_local_date", "person_status" ], "title": "PeopleGetParametersFieldsSchemaItems", "type": "string" }, "PeopleGetParametersHiringStatusesSchemaItems": { "enum": [ "pending_invite", "draft", "invited", "onboarding", "onboarding_at_risk", "onboarding_overdue", "onboarded", "offboarding", "active", "inactive", "in_review", "quote_requires_changes" ], "title": "PeopleGetParametersHiringStatusesSchemaItems", "type": "string" }, "PeopleGetParametersHiringTypesSchemaItems": { "enum": [ "contractor", "eor", "peo", "hris_direct_employee", "hris_direct_contractor", "direct_employee", "contractor_outside_deel", "person_without_contract" ], "title": "PeopleGetParametersHiringTypesSchemaItems", "type": "string" }, "PeopleGetParametersPersonStatusesSchemaItems": { "enum": [ "ACTIVE", "NOT_STARTED", "INACTIVE" ], "title": "PeopleGetParametersPersonStatusesSchemaItems", "type": "string" }, "PeopleGetParametersSortBy": { "enum": [ "id", "first_name", "last_name", "full_name", "email", "country", "birth_date", "hiring_type", "start_date", "team", "job_title", "hiring_status", "completion_date", "direct_manager", "direct_reports_count", "band_placement", "comparative_ratio" ], "title": "PeopleGetParametersSortBy", "type": "string" }, "PeopleGetParametersSortOrder": { "enum": [ "asc", "desc" ], "title": "PeopleGetParametersSortOrder", "type": "string" }, "PeopleGetResponsesContentApplicationJsonSchemaDataItems": { "properties": { "active_worker_termination_status": { "description": "The status of the active worker termination.", "oneOf": [ { "$ref": "#/components/schemas/PeopleGetResponsesContentApplicationJsonSchemaDataItemsActiveWorkerTerminationStatus" }, { "type": "null" } ] }, "additional_details": { "description": "Country-scoped additional employment data points (national IDs, tax IDs, etc.) sourced from hris_employment_eligibility.eligibility_data. Returned only when the caller's organization has the feature flag enable and the request is not redacting PII.", "items": { "$ref": "#/components/schemas/PeopleGetResponsesContentApplicationJsonSchemaDataItemsAdditionalDetailsItems" }, "type": [ "array", "null" ] }, "addresses": { "description": "An array of address objects containing the employee's physical addresses.", "items": { "$ref": "#/components/schemas/PeopleGetResponsesContentApplicationJsonSchemaDataItemsAddressesItems" }, "type": [ "array", "null" ] }, "birth_date": { "description": "The birth date of the employee.", "type": [ "string", "null" ] }, "client_legal_entity": { "$ref": "#/components/schemas/PeopleGetResponsesContentApplicationJsonSchemaDataItemsClientLegalEntity", "description": "The primary client legal entity associated with the employee." }, "completion_date": { "description": "The completion date of the task or project.", "type": [ "string", "null" ] }, "country": { "description": "The country of the employee.", "type": [ "string", "null" ] }, "created_at": { "description": "The creation timestamp of the employee record.", "format": "date-time", "type": "string" }, "department": { "$ref": "#/components/schemas/PeopleGetResponsesContentApplicationJsonSchemaDataItemsDepartment", "description": "The department of the employee." }, "direct_employee_termination_last_day": { "description": "The last day of work mentioned on the primary contract termination.", "format": "date-time", "type": "string" }, "direct_manager": { "description": "The direct manager of the employee.", "oneOf": [ { "$ref": "#/components/schemas/PeopleGetResponsesContentApplicationJsonSchemaDataItemsDirectManager" }, { "type": "null" } ] }, "direct_reports": { "description": "The direct reports to the employee.", "items": { "$ref": "#/components/schemas/PeopleGetResponsesContentApplicationJsonSchemaDataItemsDirectReportsItems" }, "type": [ "array", "null" ] }, "direct_reports_count": { "description": "The count of direct reports to the employee.", "type": "integer" }, "emails": { "description": "An array of the employee's email addresses.", "items": { "$ref": "#/components/schemas/PeopleGetResponsesContentApplicationJsonSchemaDataItemsEmailsItems" }, "type": [ "array", "null" ] }, "employments": { "description": "An array of employment records associated with the employee, including contract details, team information, payment details, and employment status.", "items": { "$ref": "#/components/schemas/PeopleGetResponsesContentApplicationJsonSchemaDataItemsEmploymentsItems" }, "type": [ "array", "null" ] }, "external_id": { "description": "The external ID of the employee.", "type": [ "string", "null" ] }, "first_name": { "description": "The first name of the employee.", "type": "string" }, "full_name": { "description": "The full name of the employee.", "type": "string" }, "hiring_status": { "description": "The current hiring status of the employee.", "type": "string" }, "hiring_type": { "description": "The type of hiring of the employee.", "type": [ "string", "null" ] }, "hris_organization_user_id": { "description": "HRIS Organization User ID of the employee. Used in products like Deel Engage.", "format": "uuid", "type": [ "string", "null" ] }, "id": { "description": "Unique identifier for the employee.", "type": "string" }, "is_pwac": { "description": "Whether the worker is a Person Without a Contract (PWAC)", "type": "boolean" }, "job_title": { "description": "The job title of the employee.", "type": [ "string", "null" ] }, "last_name": { "description": "The last name of the employee.", "type": [ "string", "null" ] }, "middle_name": { "description": "The middle name of the employee.", "type": [ "string", "null" ] }, "nationalities": { "description": "The nationality of the employee.", "items": { "type": "string" }, "type": "array" }, "new_hiring_status": { "description": "The new hiring status of the employee.", "type": [ "string", "null" ] }, "person_status": { "description": "Lifecycle status of the person (worker profile). Omitted or null without people_person_status.view; excluded from the response when using `fields` if not requested.", "oneOf": [ { "$ref": "#/components/schemas/PeopleGetResponsesContentApplicationJsonSchemaDataItemsPersonStatus" }, { "type": "null" } ] }, "preferred_first_name": { "description": "The preferred first name of the employee.", "type": [ "string", "null" ] }, "preferred_last_name": { "description": "The preferred last name of the employee.", "type": [ "string", "null" ] }, "seniority": { "description": "The seniority level of the employee.", "type": [ "string", "null" ] }, "start_date": { "description": "The date the employee started working.", "format": "date", "type": [ "string", "null" ] }, "state": { "description": "The state of the employee.", "type": [ "string", "null" ] }, "timezone": { "description": "The timezone of the employee.", "type": [ "string", "null" ] }, "updated_at": { "description": "Long date-time format following ISO-8601", "format": "date-time", "type": [ "string", "null" ] }, "work_location": { "description": "The work location of the employee.", "type": [ "string", "null" ] }, "worker_id": { "description": "The worker ID of the employee.", "type": "string" } }, "title": "PeopleGetResponsesContentApplicationJsonSchemaDataItems", "type": "object" }, "PeopleGetResponsesContentApplicationJsonSchemaDataItemsActiveWorkerTerminationStatus": { "description": "The status of the active worker termination.", "enum": [ "PENDING", "CONTRACT_TERMINATION_DATA_COLLECTED", "IN_PROGRESS", "COMPLETED", "FAILED", "CANCELED" ], "title": "PeopleGetResponsesContentApplicationJsonSchemaDataItemsActiveWorkerTerminationStatus", "type": "string" }, "PeopleGetResponsesContentApplicationJsonSchemaDataItemsAdditionalDetailsItems": { "properties": { "country": { "description": "ISO-2 country code that scopes this entry.", "maxLength": 2, "minLength": 2, "pattern": "^[A-Z]{2}$", "type": "string" }, "type": { "description": "Field name (the JSONB key from hris_employment_eligibility.eligibility_data, e.g. socialSecurity, idNumber, taxIdentificationNumber).", "type": "string" }, "value": { "$ref": "#/components/schemas/PeopleGetResponsesContentApplicationJsonSchemaDataItemsAdditionalDetailsItemsValue", "description": "Raw value associated with the field. May be a string, number, boolean, or null." } }, "title": "PeopleGetResponsesContentApplicationJsonSchemaDataItemsAdditionalDetailsItems", "type": "object" }, "PeopleGetResponsesContentApplicationJsonSchemaDataItemsAdditionalDetailsItemsValue": { "description": "Raw value associated with the field. May be a string, number, boolean, or null.", "oneOf": [ { "type": "string" }, { "format": "double", "type": "number" }, { "type": "boolean" }, { "additionalProperties": { "description": "Any type" }, "type": "object" } ], "title": "PeopleGetResponsesContentApplicationJsonSchemaDataItemsAdditionalDetailsItemsValue" }, "PeopleGetResponsesContentApplicationJsonSchemaDataItemsAddressesItems": { "properties": { "country": { "description": "Country code.", "maxLength": 2, "minLength": 2, "pattern": "^[A-Z]{2}$", "type": [ "string", "null" ] }, "lineTwo": { "description": "Second address line.", "type": "string" }, "locality": { "description": "Locality name.", "type": "string" }, "postalCode": { "description": "Postal code.", "type": "string" }, "region": { "description": "Region code.", "type": "string" }, "streetAddress": { "description": "Street and number.", "type": "string" } }, "title": "PeopleGetResponsesContentApplicationJsonSchemaDataItemsAddressesItems", "type": "object" }, "PeopleGetResponsesContentApplicationJsonSchemaDataItemsClientLegalEntity": { "description": "The primary client legal entity associated with the employee.", "properties": { "id": { "description": "Unique identifier of this resource.", "format": "uuid", "type": [ "string", "null" ] }, "name": { "description": "The name of the client legal entity.", "type": [ "string", "null" ] } }, "title": "PeopleGetResponsesContentApplicationJsonSchemaDataItemsClientLegalEntity", "type": "object" }, "PeopleGetResponsesContentApplicationJsonSchemaDataItemsDepartment": { "description": "The department of the employee.", "properties": { "id": { "description": "Unique identifier of this resource.", "format": "uuid", "type": "string" }, "name": { "description": "The name of the department.", "type": "string" }, "parent": { "description": "The parent department name.", "type": "string" } }, "title": "PeopleGetResponsesContentApplicationJsonSchemaDataItemsDepartment", "type": "object" }, "PeopleGetResponsesContentApplicationJsonSchemaDataItemsDirectManager": { "description": "The direct manager of the employee.", "properties": { "first_name": { "description": "The first name of the manager.", "type": "string" }, "id": { "description": "Unique identifier for the manager.", "type": "string" }, "last_name": { "description": "The last name of the manager.", "type": "string" }, "work_email": { "description": "The work email of the manager.", "type": [ "string", "null" ] }, "worker_id": { "description": "The worker ID of the manager.", "format": "double", "type": "number" } }, "title": "PeopleGetResponsesContentApplicationJsonSchemaDataItemsDirectManager", "type": "object" }, "PeopleGetResponsesContentApplicationJsonSchemaDataItemsDirectReportsItems": { "properties": { "first_name": { "description": "The first name of the direct report.", "type": "string" }, "id": { "description": "Unique identifier for the direct report.", "type": "string" }, "last_name": { "description": "The last name of the direct report.", "type": "string" }, "work_email": { "description": "The work email of the direct report.", "type": [ "string", "null" ] } }, "title": "PeopleGetResponsesContentApplicationJsonSchemaDataItemsDirectReportsItems", "type": "object" }, "PeopleGetResponsesContentApplicationJsonSchemaDataItemsEmailsItems": { "properties": { "type": { "description": "The type of email.", "type": [ "string", "null" ] }, "value": { "description": "The email address.", "type": [ "string", "null" ] } }, "title": "PeopleGetResponsesContentApplicationJsonSchemaDataItemsEmailsItems", "type": "object" }, "PeopleGetResponsesContentApplicationJsonSchemaDataItemsEmploymentsItems": { "properties": { "band_placement": { "description": "Where the employee falls in their compensation band", "oneOf": [ { "$ref": "#/components/schemas/PeopleGetResponsesContentApplicationJsonSchemaDataItemsEmploymentsItemsBandPlacement" }, { "type": "null" } ] }, "client_legal_entity": { "$ref": "#/components/schemas/PeopleGetResponsesContentApplicationJsonSchemaDataItemsEmploymentsItemsClientLegalEntity", "description": "The client legal entity associated with this employment contract." }, "comparative_ratio": { "description": "Number comparing an employee's compensation to the band midpoint", "format": "double", "type": [ "number", "null" ] }, "compensation_band_id": { "description": "The employee's assigned compensation band", "type": [ "string", "null" ] }, "completion_date": { "description": "The completion date of the employment contract.", "type": [ "string", "null" ] }, "contract_coverage": { "description": "The coverage of the employment contract.", "oneOf": [ { "$ref": "#/components/schemas/PeopleGetResponsesContentApplicationJsonSchemaDataItemsEmploymentsItemsContractCoverage" }, { "type": "null" } ] }, "contract_has_contractor": { "description": "Whether the contract has a contractor.", "type": "boolean" }, "contract_is_archived": { "description": "Whether the employment contract is archived.", "type": "boolean" }, "contract_status": { "description": "The status of the employment contract.", "type": "string" }, "country": { "description": "The country of employment.", "type": [ "string", "null" ] }, "email": { "description": "The work email of the employee.", "type": "string" }, "has_eor_termination": { "description": "Whether the employment has an EOR termination.", "type": [ "boolean", "null" ] }, "hiring_status": { "description": "The current hiring status of the employment.", "type": "string" }, "hiring_type": { "description": "The type of hiring of the employment.", "type": [ "string", "null" ] }, "hris_direct_employee_invitation": { "description": "The HRIS direct employee invitation status.", "oneOf": [ { "$ref": "#/components/schemas/PeopleGetResponsesContentApplicationJsonSchemaDataItemsEmploymentsItemsHrisDirectEmployeeInvitation" }, { "type": "null" } ] }, "id": { "description": "Unique identifier for the employment.", "type": "string" }, "is_ended": { "description": "Whether the employment has ended.", "type": "boolean" }, "is_user_contract_deleted": { "description": "Whether the user contract is deleted.", "type": "boolean" }, "job_title": { "description": "The job title of the employment.", "type": [ "string", "null" ] }, "name": { "description": "Name of the employee.", "type": "string" }, "new_hiring_status": { "description": "The new hiring status of the employment.", "type": [ "string", "null" ] }, "payment": { "$ref": "#/components/schemas/PeopleGetResponsesContentApplicationJsonSchemaDataItemsEmploymentsItemsPayment", "description": "Payment information for the employment, including rate, scale, currency, and associated contract name." }, "seniority": { "description": "The seniority level of the employment.", "type": [ "string", "null" ] }, "start_date": { "description": "The start date of the employment.", "format": "date", "type": [ "string", "null" ] }, "state": { "description": "The state of employment.", "type": [ "string", "null" ] }, "team": { "$ref": "#/components/schemas/PeopleGetResponsesContentApplicationJsonSchemaDataItemsEmploymentsItemsTeam", "description": "The team to which the employee belongs." }, "termination_last_day": { "description": "The last day of work mentioned on the contract termination.", "format": "date-time", "type": [ "string", "null" ] }, "timezone": { "description": "The timezone of the employment.", "type": [ "string", "null" ] }, "voluntarily_left": { "description": "Whether the employee voluntarily left the employment.", "type": [ "boolean", "null" ] }, "work_email": { "description": "The work email of the employment.", "type": [ "string", "null" ] } }, "title": "PeopleGetResponsesContentApplicationJsonSchemaDataItemsEmploymentsItems", "type": "object" }, "PeopleGetResponsesContentApplicationJsonSchemaDataItemsEmploymentsItemsBandPlacement": { "description": "Where the employee falls in their compensation band", "enum": [ "ABOVE", "WITHIN", "BELOW" ], "title": "PeopleGetResponsesContentApplicationJsonSchemaDataItemsEmploymentsItemsBandPlacement", "type": "string" }, "PeopleGetResponsesContentApplicationJsonSchemaDataItemsEmploymentsItemsClientLegalEntity": { "description": "The client legal entity associated with this employment contract.", "properties": { "id": { "description": "Unique identifier of this resource.", "format": "uuid", "type": [ "string", "null" ] }, "name": { "description": "The name of the client legal entity.", "type": [ "string", "null" ] } }, "title": "PeopleGetResponsesContentApplicationJsonSchemaDataItemsEmploymentsItemsClientLegalEntity", "type": "object" }, "PeopleGetResponsesContentApplicationJsonSchemaDataItemsEmploymentsItemsContractCoverage": { "description": "The coverage of the employment contract.", "enum": [ "is_premium", "is_shielded", "no_coverage" ], "title": "PeopleGetResponsesContentApplicationJsonSchemaDataItemsEmploymentsItemsContractCoverage", "type": "string" }, "PeopleGetResponsesContentApplicationJsonSchemaDataItemsEmploymentsItemsHrisDirectEmployeeInvitation": { "description": "The HRIS direct employee invitation status.", "properties": { "oid": { "description": "Unique identifier of this resource.", "type": "string" }, "send_at": { "description": "The HRIS direct employee invitation send date.", "format": "date-time", "type": [ "string", "null" ] }, "status": { "description": "The HRIS direct employee invitation status.", "type": [ "string", "null" ] }, "timezone": { "description": "The HRIS direct employee invitation timezone.", "type": [ "string", "null" ] } }, "title": "PeopleGetResponsesContentApplicationJsonSchemaDataItemsEmploymentsItemsHrisDirectEmployeeInvitation", "type": "object" }, "PeopleGetResponsesContentApplicationJsonSchemaDataItemsEmploymentsItemsPayment": { "description": "Payment information for the employment, including rate, scale, currency, and associated contract name.", "properties": { "contract_name": { "description": "The name of the contract associated with the payment", "type": "string" }, "currency": { "description": "The currency code (ISO 4217) for the payment", "type": "string" }, "rate": { "description": "The payment rate", "title": "float", "type": [ "string", "null" ] }, "scale": { "description": "The payment scale (e.g., hourly, weekly, monthly, etc.)", "type": [ "string", "null" ] } }, "title": "PeopleGetResponsesContentApplicationJsonSchemaDataItemsEmploymentsItemsPayment", "type": "object" }, "PeopleGetResponsesContentApplicationJsonSchemaDataItemsEmploymentsItemsTeam": { "description": "The team to which the employee belongs.", "properties": { "id": { "description": "Refers to Groups in the platform. Working groups that reflect the organization's structure.", "format": "uuid", "type": "string" }, "name": { "description": "The team name.", "type": "string" } }, "title": "PeopleGetResponsesContentApplicationJsonSchemaDataItemsEmploymentsItemsTeam", "type": "object" }, "PeopleGetResponsesContentApplicationJsonSchemaDataItemsPersonStatus": { "description": "Lifecycle status of the person (worker profile). Omitted or null without people_person_status.view; excluded from the response when using `fields` if not requested.", "enum": [ "ACTIVE", "NOT_STARTED", "INACTIVE" ], "title": "PeopleGetResponsesContentApplicationJsonSchemaDataItemsPersonStatus", "type": "string" }, "PeopleGetResponsesContentApplicationJsonSchemaError": { "properties": { "code": { "description": "Error code identifying the type of error.", "type": "string" }, "details": { "description": "Additional details about the error.", "type": [ "string", "null" ] }, "message": { "description": "Error message describing what went wrong.", "type": "string" } }, "required": [ "code", "message" ], "title": "PeopleGetResponsesContentApplicationJsonSchemaError", "type": "object" }, "PeopleGetResponsesContentApplicationJsonSchemaPage": { "properties": { "items_per_page": { "format": "double", "maximum": 200, "minimum": 1, "type": "number" }, "offset": { "maximum": 999999999, "minimum": 0, "type": "integer" }, "total_rows": { "format": "double", "type": "number" } }, "required": [ "offset", "total_rows", "items_per_page" ], "title": "PeopleGetResponsesContentApplicationJsonSchemaPage", "type": "object" }, "PeopleHrisProfileIdGetResponsesContentApplicationJsonSchemaData": { "properties": { "active_worker_termination_status": { "description": "The status of the active worker termination.", "oneOf": [ { "$ref": "#/components/schemas/PeopleHrisProfileIdGetResponsesContentApplicationJsonSchemaDataActiveWorkerTerminationStatus" }, { "type": "null" } ] }, "additional_details": { "description": "Country-scoped additional employment data points (national IDs, tax IDs, etc.) sourced from hris_employment_eligibility.eligibility_data. Returned only when the caller's organization has the feature flag enabled and the request is not redacting PII.", "items": { "$ref": "#/components/schemas/PeopleHrisProfileIdGetResponsesContentApplicationJsonSchemaDataAdditionalDetailsItems" }, "type": [ "array", "null" ] }, "addresses": { "description": "An array of address objects containing the employee's physical addresses.", "items": { "$ref": "#/components/schemas/PeopleHrisProfileIdGetResponsesContentApplicationJsonSchemaDataAddressesItems" }, "type": "array" }, "birth_date": { "description": "The birth date of the employee.", "type": [ "string", "null" ] }, "client_legal_entity": { "$ref": "#/components/schemas/PeopleHrisProfileIdGetResponsesContentApplicationJsonSchemaDataClientLegalEntity", "description": "The primary client legal entity associated with the employee." }, "completion_date": { "description": "The completion date of the task or project.", "type": [ "string", "null" ] }, "country": { "description": "The country of the employee.", "type": [ "string", "null" ] }, "created_at": { "description": "The creation timestamp of the employee record.", "format": "date-time", "type": "string" }, "custom_fields": { "description": "An array of custom field objects containing additional attributes associated with the employee (e.g., Job title, Project code, etc.).", "items": { "$ref": "#/components/schemas/PeopleHrisProfileIdGetResponsesContentApplicationJsonSchemaDataCustomFieldsItems" }, "type": "array" }, "department": { "$ref": "#/components/schemas/PeopleHrisProfileIdGetResponsesContentApplicationJsonSchemaDataDepartment", "description": "The department of the employee." }, "direct_employee_termination_last_day": { "description": "The last day of work mentioned on the primary contract termination.", "format": "date", "type": "string" }, "direct_manager": { "description": "The direct manager of the employee.", "oneOf": [ { "$ref": "#/components/schemas/PeopleHrisProfileIdGetResponsesContentApplicationJsonSchemaDataDirectManager" }, { "type": "null" } ] }, "direct_reports": { "description": "The direct reports to the employee.", "items": { "$ref": "#/components/schemas/PeopleHrisProfileIdGetResponsesContentApplicationJsonSchemaDataDirectReportsItems" }, "type": [ "array", "null" ] }, "direct_reports_count": { "description": "The count of direct reports to the employee.", "type": "integer" }, "emails": { "description": "An array of the employee's email addresses.", "items": { "$ref": "#/components/schemas/PeopleHrisProfileIdGetResponsesContentApplicationJsonSchemaDataEmailsItems" }, "type": "array" }, "employments": { "description": "An array of employment records associated with the employee, including contract details, team information, payment details, and employment status.", "items": { "$ref": "#/components/schemas/PeopleHrisProfileIdGetResponsesContentApplicationJsonSchemaDataEmploymentsItems" }, "type": "array" }, "external_id": { "description": "The external ID of the employee.", "type": [ "string", "null" ] }, "first_name": { "description": "The first name of the employee.", "type": "string" }, "full_name": { "description": "The full name of the employee.", "type": "string" }, "hiring_status": { "description": "The current hiring status of the employee.", "type": "string" }, "hiring_type": { "description": "The type of hiring of the employee.", "type": "string" }, "id": { "description": "Unique identifier for the employee.", "format": "uuid", "type": "string" }, "job_title": { "description": "The job title of the employee.", "type": [ "string", "null" ] }, "last_name": { "description": "The last name of the employee.", "type": "string" }, "nationalities": { "description": "The nationality of the employee.", "items": { "type": "string" }, "type": "array" }, "new_hiring_status": { "description": "The new hiring status of the employee.", "type": "string" }, "preferred_first_name": { "description": "The preferred first name of the employee.", "type": [ "string", "null" ] }, "preferred_last_name": { "description": "The preferred last name of the employee.", "type": [ "string", "null" ] }, "profile_organizational_structures": { "description": "An array of organizational structures associated with the employee profile.", "items": { "$ref": "#/components/schemas/PeopleHrisProfileIdGetResponsesContentApplicationJsonSchemaDataProfileOrganizationalStructuresItems" }, "type": "array" }, "seniority": { "description": "The seniority level of the employee.", "type": [ "string", "null" ] }, "start_date": { "description": "The date the employee started working.", "format": "date", "type": [ "string", "null" ] }, "state": { "description": "The state of the employee.", "type": [ "string", "null" ] }, "timezone": { "description": "The timezone of the employee.", "type": [ "string", "null" ] }, "updated_at": { "description": "Long date-time format following ISO-8601", "format": "date-time", "type": [ "string", "null" ] }, "work_location": { "description": "The work location of the employee.", "type": [ "string", "null" ] }, "worker_id": { "description": "The worker ID of the employee.", "type": "string" } }, "title": "PeopleHrisProfileIdGetResponsesContentApplicationJsonSchemaData", "type": "object" }, "PeopleHrisProfileIdGetResponsesContentApplicationJsonSchemaDataActiveWorkerTerminationStatus": { "description": "The status of the active worker termination.", "enum": [ "PENDING", "CONTRACT_TERMINATION_DATA_COLLECTED", "IN_PROGRESS", "COMPLETED", "FAILED", "CANCELED" ], "title": "PeopleHrisProfileIdGetResponsesContentApplicationJsonSchemaDataActiveWorkerTerminationStatus", "type": "string" }, "PeopleHrisProfileIdGetResponsesContentApplicationJsonSchemaDataAdditionalDetailsItems": { "properties": { "country": { "description": "ISO-2 country code that scopes this entry.", "maxLength": 2, "minLength": 2, "pattern": "^[A-Z]{2}$", "type": "string" }, "type": { "description": "Field name (the JSONB key from hris_employment_eligibility.eligibility_data, e.g. socialSecurity, idNumber, taxIdentificationNumber).", "type": "string" }, "value": { "$ref": "#/components/schemas/PeopleHrisProfileIdGetResponsesContentApplicationJsonSchemaDataAdditionalDetailsItemsValue", "description": "Raw value associated with the field. May be a string, number, boolean, or null." } }, "title": "PeopleHrisProfileIdGetResponsesContentApplicationJsonSchemaDataAdditionalDetailsItems", "type": "object" }, "PeopleHrisProfileIdGetResponsesContentApplicationJsonSchemaDataAdditionalDetailsItemsValue": { "description": "Raw value associated with the field. May be a string, number, boolean, or null.", "oneOf": [ { "type": "string" }, { "format": "double", "type": "number" }, { "type": "boolean" }, { "additionalProperties": { "description": "Any type" }, "type": "object" } ], "title": "PeopleHrisProfileIdGetResponsesContentApplicationJsonSchemaDataAdditionalDetailsItemsValue" }, "PeopleHrisProfileIdGetResponsesContentApplicationJsonSchemaDataAddressesItems": { "properties": { "country": { "description": "Country code.", "maxLength": 2, "minLength": 2, "pattern": "^[A-Z]{2}$", "type": "string" }, "locality": { "description": "Locality name.", "type": "string" }, "postalCode": { "description": "Postal code.", "type": "string" }, "region": { "description": "Region code.", "type": "string" }, "streetAddress": { "description": "Street and number.", "type": "string" } }, "title": "PeopleHrisProfileIdGetResponsesContentApplicationJsonSchemaDataAddressesItems", "type": "object" }, "PeopleHrisProfileIdGetResponsesContentApplicationJsonSchemaDataClientLegalEntity": { "description": "The primary client legal entity associated with the employee.", "properties": { "id": { "description": "Unique identifier of this resource.", "format": "uuid", "type": [ "string", "null" ] }, "name": { "description": "The name of the client legal entity.", "type": [ "string", "null" ] } }, "title": "PeopleHrisProfileIdGetResponsesContentApplicationJsonSchemaDataClientLegalEntity", "type": "object" }, "PeopleHrisProfileIdGetResponsesContentApplicationJsonSchemaDataCustomFieldsItems": { "description": "Customized attributes on people (Job title, Project code, etc).", "properties": { "name": { "description": "Custom field property name.", "type": "string" }, "value": { "description": "Custom field property value.", "type": [ "string", "null" ] } }, "title": "PeopleHrisProfileIdGetResponsesContentApplicationJsonSchemaDataCustomFieldsItems", "type": "object" }, "PeopleHrisProfileIdGetResponsesContentApplicationJsonSchemaDataDepartment": { "description": "The department of the employee.", "properties": { "id": { "description": "Unique identifier of this resource.", "format": "uuid", "type": "string" }, "name": { "description": "The name of the department.", "type": "string" }, "parent": { "description": "The parent department.", "type": "string" } }, "title": "PeopleHrisProfileIdGetResponsesContentApplicationJsonSchemaDataDepartment", "type": "object" }, "PeopleHrisProfileIdGetResponsesContentApplicationJsonSchemaDataDirectManager": { "description": "The direct manager of the employee.", "properties": { "first_name": { "description": "The first name of the manager.", "type": "string" }, "id": { "description": "Unique identifier for the manager.", "format": "uuid", "type": "string" }, "last_name": { "description": "The last name of the manager.", "type": "string" }, "work_email": { "description": "The work email of the manager.", "type": [ "string", "null" ] }, "worker_id": { "description": "The worker ID of the manager.", "format": "double", "type": "number" } }, "title": "PeopleHrisProfileIdGetResponsesContentApplicationJsonSchemaDataDirectManager", "type": "object" }, "PeopleHrisProfileIdGetResponsesContentApplicationJsonSchemaDataDirectReportsItems": { "properties": { "first_name": { "description": "The first name of the direct report.", "type": "string" }, "id": { "description": "Unique identifier for the direct report.", "format": "uuid", "type": "string" }, "last_name": { "description": "The last name of the direct report.", "type": "string" }, "work_email": { "description": "The work email of the direct report.", "type": [ "string", "null" ] } }, "title": "PeopleHrisProfileIdGetResponsesContentApplicationJsonSchemaDataDirectReportsItems", "type": "object" }, "PeopleHrisProfileIdGetResponsesContentApplicationJsonSchemaDataEmailsItems": { "properties": { "type": { "description": "The type of email.", "type": "string" }, "value": { "description": "The email address.", "type": [ "string", "null" ] } }, "title": "PeopleHrisProfileIdGetResponsesContentApplicationJsonSchemaDataEmailsItems", "type": "object" }, "PeopleHrisProfileIdGetResponsesContentApplicationJsonSchemaDataEmploymentsItems": { "properties": { "client_legal_entity": { "description": "The client legal entity associated with this employment contract.", "oneOf": [ { "$ref": "#/components/schemas/PeopleHrisProfileIdGetResponsesContentApplicationJsonSchemaDataEmploymentsItemsClientLegalEntity" }, { "type": "null" } ] }, "completion_date": { "description": "The completion date of the employment contract.", "type": [ "string", "null" ] }, "contract_coverage": { "description": "The coverage type of the employment contract. 'is_shielded' = Contractor of Record, 'is_premium' = Premium, null = Standard (no coverage).", "oneOf": [ { "$ref": "#/components/schemas/PeopleHrisProfileIdGetResponsesContentApplicationJsonSchemaDataEmploymentsItemsContractCoverage" }, { "type": "null" } ] }, "contract_has_contractor": { "description": "Whether the contract has a contractor.", "type": "boolean" }, "contract_is_archived": { "description": "Whether the employment contract is archived.", "type": "boolean" }, "contract_status": { "description": "The status of the employment contract.", "type": "string" }, "country": { "description": "The country of employment.", "type": [ "string", "null" ] }, "email": { "description": "The work email of the employee.", "type": "string" }, "has_eor_termination": { "description": "Whether the employment has an EOR termination.", "type": [ "boolean", "null" ] }, "hiring_status": { "description": "The current hiring status of the employment.", "type": "string" }, "hiring_type": { "description": "The type of hiring of the employment.", "type": "string" }, "hris_direct_employee_invitation": { "description": "The HRIS direct employee invitation status.", "oneOf": [ { "$ref": "#/components/schemas/PeopleHrisProfileIdGetResponsesContentApplicationJsonSchemaDataEmploymentsItemsHrisDirectEmployeeInvitation" }, { "type": "null" } ] }, "id": { "description": "Unique identifier for the employment.", "type": "string" }, "is_ended": { "description": "Whether the employment has ended.", "type": "boolean" }, "is_user_contract_deleted": { "description": "Whether the user contract is deleted.", "type": "boolean" }, "job_title": { "description": "The job title of the employment.", "type": [ "string", "null" ] }, "name": { "description": "Name of the employee.", "type": "string" }, "new_hiring_status": { "description": "The new hiring status of the employment.", "type": "string" }, "payment": { "$ref": "#/components/schemas/PeopleHrisProfileIdGetResponsesContentApplicationJsonSchemaDataEmploymentsItemsPayment", "description": "Payment information for the employment, including rate, scale, currency, and associated contract name." }, "seniority": { "description": "The seniority level of the employment.", "type": [ "string", "null" ] }, "start_date": { "description": "The start date of the employment.", "format": "date", "type": [ "string", "null" ] }, "state": { "description": "The state of employment.", "type": [ "string", "null" ] }, "team": { "$ref": "#/components/schemas/PeopleHrisProfileIdGetResponsesContentApplicationJsonSchemaDataEmploymentsItemsTeam", "description": "The team to which the employee belongs." }, "termination_last_day": { "description": "The last day of work mentioned on the contract termination.", "format": "date-time", "type": [ "string", "null" ] }, "timezone": { "description": "The timezone of the employment.", "type": [ "string", "null" ] }, "voluntarily_left": { "description": "Whether the employee voluntarily left the employment.", "type": [ "boolean", "null" ] }, "work_email": { "description": "The work email of the employment.", "type": [ "string", "null" ] } }, "title": "PeopleHrisProfileIdGetResponsesContentApplicationJsonSchemaDataEmploymentsItems", "type": "object" }, "PeopleHrisProfileIdGetResponsesContentApplicationJsonSchemaDataEmploymentsItemsClientLegalEntity": { "description": "The client legal entity associated with this employment contract.", "properties": { "id": { "description": "Unique identifier of this resource.", "format": "uuid", "type": [ "string", "null" ] }, "name": { "description": "The name of the client legal entity.", "type": [ "string", "null" ] } }, "title": "PeopleHrisProfileIdGetResponsesContentApplicationJsonSchemaDataEmploymentsItemsClientLegalEntity", "type": "object" }, "PeopleHrisProfileIdGetResponsesContentApplicationJsonSchemaDataEmploymentsItemsContractCoverage": { "description": "The coverage type of the employment contract. 'is_shielded' = Contractor of Record, 'is_premium' = Premium, null = Standard (no coverage).", "enum": [ "is_shielded", "is_premium" ], "title": "PeopleHrisProfileIdGetResponsesContentApplicationJsonSchemaDataEmploymentsItemsContractCoverage", "type": "string" }, "PeopleHrisProfileIdGetResponsesContentApplicationJsonSchemaDataEmploymentsItemsHrisDirectEmployeeInvitation": { "description": "The HRIS direct employee invitation status.", "properties": { "oid": { "description": "Unique identifier of this resource.", "type": "string" }, "send_at": { "description": "The HRIS direct employee invitation send date.", "format": "date-time", "type": [ "string", "null" ] }, "status": { "description": "The HRIS direct employee invitation status.", "type": [ "string", "null" ] }, "timezone": { "description": "The HRIS direct employee invitation timezone.", "type": [ "string", "null" ] } }, "title": "PeopleHrisProfileIdGetResponsesContentApplicationJsonSchemaDataEmploymentsItemsHrisDirectEmployeeInvitation", "type": "object" }, "PeopleHrisProfileIdGetResponsesContentApplicationJsonSchemaDataEmploymentsItemsPayment": { "description": "Payment information for the employment, including rate, scale, currency, and associated contract name.", "properties": { "contract_name": { "description": "The name of the contract associated with the payment", "type": "string" }, "currency": { "description": "The currency code (ISO 4217) for the payment", "type": "string" }, "rate": { "$ref": "#/components/schemas/PeopleHrisProfileIdGetResponsesContentApplicationJsonSchemaDataEmploymentsItemsPaymentRate", "description": "The payment rate. Value is a string if contract type is PEO." }, "scale": { "description": "The payment scale (e.g., hourly, weekly, monthly, etc.)", "type": [ "string", "null" ] } }, "title": "PeopleHrisProfileIdGetResponsesContentApplicationJsonSchemaDataEmploymentsItemsPayment", "type": "object" }, "PeopleHrisProfileIdGetResponsesContentApplicationJsonSchemaDataEmploymentsItemsPaymentRate": { "description": "The payment rate. Value is a string if contract type is PEO.", "oneOf": [ { "type": "string" }, { "format": "double", "type": "number" } ], "title": "PeopleHrisProfileIdGetResponsesContentApplicationJsonSchemaDataEmploymentsItemsPaymentRate" }, "PeopleHrisProfileIdGetResponsesContentApplicationJsonSchemaDataEmploymentsItemsTeam": { "description": "The team to which the employee belongs.", "properties": { "id": { "description": "Refers to Groups in the platform. Working groups that reflect the organization's structure.", "format": "uuid", "type": "string" }, "name": { "description": "The team name.", "type": "string" } }, "title": "PeopleHrisProfileIdGetResponsesContentApplicationJsonSchemaDataEmploymentsItemsTeam", "type": "object" }, "PeopleHrisProfileIdGetResponsesContentApplicationJsonSchemaDataProfileOrganizationalStructuresItems": { "properties": { "id": { "description": "Id of the Organizational structure.", "format": "uuid", "type": "string" }, "name": { "description": "Name of the Organizational structure.", "type": "string" }, "teams": { "description": "List of teams in the organizational structure.", "items": { "$ref": "#/components/schemas/PeopleHrisProfileIdGetResponsesContentApplicationJsonSchemaDataProfileOrganizationalStructuresItemsTeamsItems" }, "type": "array" } }, "title": "PeopleHrisProfileIdGetResponsesContentApplicationJsonSchemaDataProfileOrganizationalStructuresItems", "type": "object" }, "PeopleHrisProfileIdGetResponsesContentApplicationJsonSchemaDataProfileOrganizationalStructuresItemsTeamsItems": { "properties": { "id": { "description": "Id of the team.", "format": "uuid", "type": "string" }, "name": { "description": "Name of the team.", "type": "string" }, "name_hierarchy": { "description": "Hierarchy of the team.", "type": [ "string", "null" ] }, "positions": { "description": "An array of positions held by the employee within this team.", "items": { "$ref": "#/components/schemas/PeopleHrisProfileIdGetResponsesContentApplicationJsonSchemaDataProfileOrganizationalStructuresItemsTeamsItemsPositionsItems" }, "type": "array" } }, "title": "PeopleHrisProfileIdGetResponsesContentApplicationJsonSchemaDataProfileOrganizationalStructuresItemsTeamsItems", "type": "object" }, "PeopleHrisProfileIdGetResponsesContentApplicationJsonSchemaDataProfileOrganizationalStructuresItemsTeamsItemsPositionsItems": { "properties": { "id": { "description": "Id of the position.", "format": "uuid", "type": "string" }, "is_supportive": { "description": "Whether the position is supportive or not.", "type": "boolean" }, "role": { "description": "The role associated with this position, including role ID and name.", "oneOf": [ { "$ref": "#/components/schemas/PeopleHrisProfileIdGetResponsesContentApplicationJsonSchemaDataProfileOrganizationalStructuresItemsTeamsItemsPositionsItemsRole" }, { "type": "null" } ] } }, "title": "PeopleHrisProfileIdGetResponsesContentApplicationJsonSchemaDataProfileOrganizationalStructuresItemsTeamsItemsPositionsItems", "type": "object" }, "PeopleHrisProfileIdGetResponsesContentApplicationJsonSchemaDataProfileOrganizationalStructuresItemsTeamsItemsPositionsItemsRole": { "description": "The role associated with this position, including role ID and name.", "properties": { "id": { "description": "Id of the role.", "format": "uuid", "type": "string" }, "name": { "description": "Name of the role.", "type": "string" } }, "title": "PeopleHrisProfileIdGetResponsesContentApplicationJsonSchemaDataProfileOrganizationalStructuresItemsTeamsItemsPositionsItemsRole", "type": "object" }, "PeopleHrisProfileIdGetResponsesContentApplicationJsonSchemaError": { "properties": { "code": { "description": "Error code identifying the type of error.", "type": "string" }, "details": { "description": "Additional details about the error.", "type": [ "string", "null" ] }, "message": { "description": "Error message describing what went wrong.", "type": "string" } }, "required": [ "code", "message" ], "title": "PeopleHrisProfileIdGetResponsesContentApplicationJsonSchemaError", "type": "object" }, "PeopleIdDepartmentPutRequestBodyContentApplicationJsonSchemaData": { "properties": { "department_id": { "description": "Unique identifier of this resource.", "format": "uuid", "type": "string" }, "effective_date": { "description": "Effective date in YYYY-MM-DD format.", "format": "date", "type": "string" } }, "required": [ "department_id" ], "title": "PeopleIdDepartmentPutRequestBodyContentApplicationJsonSchemaData", "type": "object" }, "PeopleIdDepartmentPutResponsesContentApplicationJsonSchemaData": { "properties": { "updated": { "description": "Indicates if the resource was updated successfully.", "type": "boolean" } }, "required": [ "updated" ], "title": "PeopleIdDepartmentPutResponsesContentApplicationJsonSchemaData", "type": "object" }, "PeopleIdWorkingLocationPutRequestBodyContentApplicationJsonSchemaData": { "properties": { "working_location_id": { "description": "Unique identifier of this resource.", "format": "double", "type": "number" } }, "required": [ "working_location_id" ], "title": "PeopleIdWorkingLocationPutRequestBodyContentApplicationJsonSchemaData", "type": "object" }, "PeopleIdWorkingLocationPutResponsesContentApplicationJsonSchemaData": { "properties": { "updated": { "description": "Indicates if the resource was updated successfully.", "type": "boolean" } }, "required": [ "updated" ], "title": "PeopleIdWorkingLocationPutResponsesContentApplicationJsonSchemaData", "type": "object" }, "PeopleMeGetResponsesContentApplicationJsonSchemaErrorsItems": { "properties": { "code": { "description": "Machine-readable error code.", "type": "string" }, "message": { "description": "A human-readable description of the error.", "type": "string" } }, "required": [ "message" ], "title": "PeopleMeGetResponsesContentApplicationJsonSchemaErrorsItems", "type": "object" }, "PeopleMeGetResponsesContentApplicationJsonSchemaProfileType": { "description": "Type of profile", "enum": [ "client", "contractor", "icp", "direct_employee", "hris_direct_employee", "peo_employee", "service_account" ], "title": "PeopleMeGetResponsesContentApplicationJsonSchemaProfileType", "type": "string" }, "PeoplePostRequestBodyContentApplicationJsonSchemaData": { "properties": { "client": { "$ref": "#/components/schemas/PeoplePostRequestBodyContentApplicationJsonSchemaDataClient", "description": "The entity that is hiring the employee" }, "compensation_details": { "$ref": "#/components/schemas/PeoplePostRequestBodyContentApplicationJsonSchemaDataCompensationDetails", "description": "The compensation details of the employee" }, "employee": { "$ref": "#/components/schemas/PeoplePostRequestBodyContentApplicationJsonSchemaDataEmployee", "description": "The person that is being hired" }, "employment": { "$ref": "#/components/schemas/PeoplePostRequestBodyContentApplicationJsonSchemaDataEmployment", "description": "The employment details of the employee" } }, "required": [ "client", "employee", "employment", "compensation_details" ], "title": "PeoplePostRequestBodyContentApplicationJsonSchemaData", "type": "object" }, "PeoplePostRequestBodyContentApplicationJsonSchemaDataClient": { "description": "The entity that is hiring the employee", "properties": { "department": { "$ref": "#/components/schemas/PeoplePostRequestBodyContentApplicationJsonSchemaDataClientDepartment", "description": "The department information for the employee" }, "legal_entity": { "$ref": "#/components/schemas/PeoplePostRequestBodyContentApplicationJsonSchemaDataClientLegalEntity", "description": "The legal entity information for the employee" }, "team": { "$ref": "#/components/schemas/PeoplePostRequestBodyContentApplicationJsonSchemaDataClientTeam", "description": "The team information for the employee" } }, "required": [ "team", "legal_entity" ], "title": "PeoplePostRequestBodyContentApplicationJsonSchemaDataClient", "type": "object" }, "PeoplePostRequestBodyContentApplicationJsonSchemaDataClientDepartment": { "description": "The department information for the employee", "properties": { "id": { "description": "The department that the employee is part of", "format": "uuid", "type": "string" } }, "required": [ "id" ], "title": "PeoplePostRequestBodyContentApplicationJsonSchemaDataClientDepartment", "type": "object" }, "PeoplePostRequestBodyContentApplicationJsonSchemaDataClientLegalEntity": { "description": "The legal entity information for the employee", "properties": { "id": { "description": "The legal entity that the employee is part of", "format": "uuid", "type": "string" } }, "required": [ "id" ], "title": "PeoplePostRequestBodyContentApplicationJsonSchemaDataClientLegalEntity", "type": "object" }, "PeoplePostRequestBodyContentApplicationJsonSchemaDataClientTeam": { "description": "The team information for the employee", "properties": { "direct_manager_id": { "description": "The direct manager of the employee", "format": "uuid", "type": "string" }, "id": { "description": "The team that the employee is part of", "format": "uuid", "type": "string" } }, "required": [ "id" ], "title": "PeoplePostRequestBodyContentApplicationJsonSchemaDataClientTeam", "type": "object" }, "PeoplePostRequestBodyContentApplicationJsonSchemaDataCompensationDetails": { "description": "The compensation details of the employee", "properties": { "currency": { "description": "The currency of the salary", "maxLength": 3, "minLength": 3, "type": "string" }, "salary": { "description": "The salary of the employee", "title": "float", "type": "string" }, "scale": { "$ref": "#/components/schemas/PeoplePostRequestBodyContentApplicationJsonSchemaDataCompensationDetailsScale", "default": "ANNUAL", "description": "The scale at which the salary is paid" } }, "required": [ "salary", "currency" ], "title": "PeoplePostRequestBodyContentApplicationJsonSchemaDataCompensationDetails", "type": "object" }, "PeoplePostRequestBodyContentApplicationJsonSchemaDataCompensationDetailsScale": { "default": "ANNUAL", "description": "The scale at which the salary is paid", "enum": [ "ANNUAL", "MONTHLY", "SEMIMONTHLY", "BIWEEKLY", "WEEKLY", "DAILY", "HOURLY" ], "title": "PeoplePostRequestBodyContentApplicationJsonSchemaDataCompensationDetailsScale", "type": "string" }, "PeoplePostRequestBodyContentApplicationJsonSchemaDataEmployee": { "description": "The person that is being hired", "properties": { "country": { "description": "The country of the person being hired", "maxLength": 2, "minLength": 2, "type": "string" }, "email": { "description": "The personal email of the person being hired", "format": "email", "maxLength": 255, "minLength": 3, "type": "string" }, "external_id": { "description": "An external identifier for the person being hired", "type": "string" }, "first_name": { "description": "The first name of the person being hired", "maxLength": 100, "minLength": 3, "type": "string" }, "last_name": { "description": "The last name of the person being hired", "maxLength": 100, "minLength": 3, "type": "string" }, "nationality": { "description": "The nationality of the person being hired", "maxLength": 2, "minLength": 2, "type": "string" }, "state": { "description": "The state of the person being hired", "maxLength": 50, "minLength": 1, "type": "string" }, "work_email": { "description": "The work email of the person being hired", "format": "email", "maxLength": 255, "minLength": 3, "type": "string" } }, "required": [ "email", "country", "last_name", "first_name", "nationality" ], "title": "PeoplePostRequestBodyContentApplicationJsonSchemaDataEmployee", "type": "object" }, "PeoplePostRequestBodyContentApplicationJsonSchemaDataEmployment": { "description": "The employment details of the employee", "oneOf": [ { "$ref": "#/components/schemas/PeoplePostRequestBodyContentApplicationJsonSchemaDataEmployment0" }, { "$ref": "#/components/schemas/PeoplePostRequestBodyContentApplicationJsonSchemaDataEmployment1" } ], "title": "PeoplePostRequestBodyContentApplicationJsonSchemaDataEmployment" }, "PeoplePostRequestBodyContentApplicationJsonSchemaDataEmployment0": { "properties": { "document_template_id": { "description": "The document template ID for the employment contract", "format": "uuid", "type": "string" }, "end_date": { "description": "The end date of the employment", "format": "date", "type": "string" }, "job_title": { "description": "The job title of the employment", "type": "string" }, "part_time_percentage": { "description": "The percentage of PART_TIME employment", "format": "double", "maximum": 99, "minimum": 1, "type": "number" }, "seniority": { "description": "The seniority of the employment", "type": "string" }, "start_date": { "description": "The start date of the employment", "format": "date", "type": "string" }, "type": { "$ref": "#/components/schemas/PeoplePostRequestBodyContentApplicationJsonSchemaDataEmploymentOneOf0Type", "description": "The type of employment" } }, "required": [ "type", "job_title", "seniority", "start_date", "part_time_percentage" ], "title": "PeoplePostRequestBodyContentApplicationJsonSchemaDataEmployment0", "type": "object" }, "PeoplePostRequestBodyContentApplicationJsonSchemaDataEmployment1": { "properties": { "document_template_id": { "description": "The document template ID for the employment contract", "format": "uuid", "type": "string" }, "end_date": { "description": "The end date of the employment", "format": "date", "type": "string" }, "job_title": { "description": "The job title of the employment", "type": "string" }, "seniority": { "description": "The seniority of the employment", "type": "string" }, "start_date": { "description": "The start date of the employment", "format": "date", "type": "string" }, "type": { "$ref": "#/components/schemas/PeoplePostRequestBodyContentApplicationJsonSchemaDataEmploymentOneOf1Type", "description": "The type of employment" } }, "required": [ "type", "job_title", "seniority", "start_date" ], "title": "PeoplePostRequestBodyContentApplicationJsonSchemaDataEmployment1", "type": "object" }, "PeoplePostRequestBodyContentApplicationJsonSchemaDataEmploymentOneOf0Type": { "description": "The type of employment", "enum": [ "PART_TIME" ], "title": "PeoplePostRequestBodyContentApplicationJsonSchemaDataEmploymentOneOf0Type", "type": "string" }, "PeoplePostRequestBodyContentApplicationJsonSchemaDataEmploymentOneOf1Type": { "description": "The type of employment", "enum": [ "FULL_TIME" ], "title": "PeoplePostRequestBodyContentApplicationJsonSchemaDataEmploymentOneOf1Type", "type": "string" }, "PeoplePostResponsesContentApplicationJsonSchemaData": { "properties": { "compensation_details": { "$ref": "#/components/schemas/PeoplePostResponsesContentApplicationJsonSchemaDataCompensationDetails", "description": "The compensation details of the employee" }, "employee": { "$ref": "#/components/schemas/PeoplePostResponsesContentApplicationJsonSchemaDataEmployee", "description": "The person that is being hired" }, "employment": { "$ref": "#/components/schemas/PeoplePostResponsesContentApplicationJsonSchemaDataEmployment", "description": "The employment details of the employee" }, "id": { "description": "The unique identifier of the created employee record", "format": "uuid", "type": "string" } }, "required": [ "id", "employee", "employment", "compensation_details" ], "title": "PeoplePostResponsesContentApplicationJsonSchemaData", "type": "object" }, "PeoplePostResponsesContentApplicationJsonSchemaDataCompensationDetails": { "description": "The compensation details of the employee", "properties": { "currency": { "description": "The currency of the salary", "maxLength": 3, "minLength": 3, "type": "string" }, "salary": { "description": "The salary of the employee", "title": "float", "type": "string" }, "scale": { "$ref": "#/components/schemas/PeoplePostResponsesContentApplicationJsonSchemaDataCompensationDetailsScale", "default": "ANNUAL", "description": "The scale at which the salary is paid" } }, "required": [ "salary", "currency" ], "title": "PeoplePostResponsesContentApplicationJsonSchemaDataCompensationDetails", "type": "object" }, "PeoplePostResponsesContentApplicationJsonSchemaDataCompensationDetailsScale": { "default": "ANNUAL", "description": "The scale at which the salary is paid", "enum": [ "ANNUAL", "MONTHLY", "SEMIMONTHLY", "BIWEEKLY", "WEEKLY", "DAILY", "HOURLY" ], "title": "PeoplePostResponsesContentApplicationJsonSchemaDataCompensationDetailsScale", "type": "string" }, "PeoplePostResponsesContentApplicationJsonSchemaDataEmployee": { "description": "The person that is being hired", "properties": { "email": { "description": "The personal email of the person being hired", "format": "email", "maxLength": 255, "minLength": 3, "type": "string" }, "external_id": { "description": "An external identifier for the person being hired", "type": "string" }, "first_name": { "description": "The first name of the person being hired", "maxLength": 100, "minLength": 3, "type": "string" }, "last_name": { "description": "The last name of the person being hired", "maxLength": 100, "minLength": 3, "type": "string" }, "nationality": { "description": "The nationality of the person being hired", "maxLength": 2, "minLength": 2, "type": "string" }, "work_email": { "description": "The work email of the person being hired", "format": "email", "maxLength": 255, "minLength": 3, "type": "string" } }, "required": [ "email", "last_name", "first_name", "nationality" ], "title": "PeoplePostResponsesContentApplicationJsonSchemaDataEmployee", "type": "object" }, "PeoplePostResponsesContentApplicationJsonSchemaDataEmployment": { "description": "The employment details of the employee", "properties": { "contract_id": { "description": "The unique identifier of the worker contract", "type": "string" }, "country": { "description": "The country of the employment", "maxLength": 2, "minLength": 2, "type": "string" }, "end_date": { "description": "The end date of the employment", "format": "date", "type": "string" }, "job_title": { "description": "The job title of the employment", "type": "string" }, "part_time_percentage": { "description": "The percentage of PART_TIME employment", "format": "double", "maximum": 99, "minimum": 1, "type": "number" }, "seniority": { "description": "The seniority of the employment", "type": "string" }, "start_date": { "description": "The start date of the employment", "format": "date", "type": "string" }, "type": { "$ref": "#/components/schemas/PeoplePostResponsesContentApplicationJsonSchemaDataEmploymentType", "description": "The type of employment" } }, "required": [ "type", "country", "end_date", "job_title", "seniority", "start_date", "contract_id" ], "title": "PeoplePostResponsesContentApplicationJsonSchemaDataEmployment", "type": "object" }, "PeoplePostResponsesContentApplicationJsonSchemaDataEmploymentType": { "description": "The type of employment", "enum": [ "FULL_TIME", "PART_TIME" ], "title": "PeoplePostResponsesContentApplicationJsonSchemaDataEmploymentType", "type": "string" }, "PeoplePostResponsesContentApplicationJsonSchemaError": { "properties": { "code": { "description": "Error code identifying the type of error", "type": "string" }, "message": { "description": "Human readable error message", "type": "string" } }, "required": [ "code", "message" ], "title": "PeoplePostResponsesContentApplicationJsonSchemaError", "type": "object" }, "PeopleWorkerIdCustomFieldsGetResponsesContentApplicationJsonSchemaDataItems": { "properties": { "data": { "$ref": "#/components/schemas/PeopleWorkerIdCustomFieldsGetResponsesContentApplicationJsonSchemaDataItemsData" }, "id": { "description": "UUID for the custom field value", "format": "uuid", "type": "string" }, "name": { "description": "Name of the custom field", "type": "string" }, "type": { "$ref": "#/components/schemas/PeopleWorkerIdCustomFieldsGetResponsesContentApplicationJsonSchemaDataItemsType", "description": "Type of the custom field" } }, "required": [ "id", "data", "name", "type" ], "title": "PeopleWorkerIdCustomFieldsGetResponsesContentApplicationJsonSchemaDataItems", "type": "object" }, "PeopleWorkerIdCustomFieldsGetResponsesContentApplicationJsonSchemaDataItemsData": { "oneOf": [ { "$ref": "#/components/schemas/PeopleWorkerIdCustomFieldsGetResponsesContentApplicationJsonSchemaDataItemsData0" }, { "$ref": "#/components/schemas/PeopleWorkerIdCustomFieldsGetResponsesContentApplicationJsonSchemaDataItemsData1" }, { "$ref": "#/components/schemas/PeopleWorkerIdCustomFieldsGetResponsesContentApplicationJsonSchemaDataItemsData2" }, { "$ref": "#/components/schemas/PeopleWorkerIdCustomFieldsGetResponsesContentApplicationJsonSchemaDataItemsData3" }, { "$ref": "#/components/schemas/PeopleWorkerIdCustomFieldsGetResponsesContentApplicationJsonSchemaDataItemsData4" }, { "$ref": "#/components/schemas/PeopleWorkerIdCustomFieldsGetResponsesContentApplicationJsonSchemaDataItemsData5" }, { "$ref": "#/components/schemas/PeopleWorkerIdCustomFieldsGetResponsesContentApplicationJsonSchemaDataItemsData6" } ], "title": "PeopleWorkerIdCustomFieldsGetResponsesContentApplicationJsonSchemaDataItemsData" }, "PeopleWorkerIdCustomFieldsGetResponsesContentApplicationJsonSchemaDataItemsData0": { "description": "Text type", "properties": { "value": { "type": "string" } }, "title": "PeopleWorkerIdCustomFieldsGetResponsesContentApplicationJsonSchemaDataItemsData0", "type": "object" }, "PeopleWorkerIdCustomFieldsGetResponsesContentApplicationJsonSchemaDataItemsData1": { "description": "Number type", "properties": { "value": { "format": "double", "type": "number" } }, "title": "PeopleWorkerIdCustomFieldsGetResponsesContentApplicationJsonSchemaDataItemsData1", "type": "object" }, "PeopleWorkerIdCustomFieldsGetResponsesContentApplicationJsonSchemaDataItemsData2": { "description": "Date type: YYYY-MM-DD", "properties": { "value": { "format": "date", "type": "string" } }, "title": "PeopleWorkerIdCustomFieldsGetResponsesContentApplicationJsonSchemaDataItemsData2", "type": "object" }, "PeopleWorkerIdCustomFieldsGetResponsesContentApplicationJsonSchemaDataItemsData3": { "description": "Percentage type", "properties": { "text": { "type": "string" }, "value": { "format": "double", "type": "number" } }, "title": "PeopleWorkerIdCustomFieldsGetResponsesContentApplicationJsonSchemaDataItemsData3", "type": "object" }, "PeopleWorkerIdCustomFieldsGetResponsesContentApplicationJsonSchemaDataItemsData4": { "description": "Currency type", "properties": { "amount": { "format": "double", "type": "number" }, "currency": { "description": "The currency code in ISO 4217 format", "type": "string" } }, "title": "PeopleWorkerIdCustomFieldsGetResponsesContentApplicationJsonSchemaDataItemsData4", "type": "object" }, "PeopleWorkerIdCustomFieldsGetResponsesContentApplicationJsonSchemaDataItemsData5": { "description": "List type", "properties": { "option": { "type": "string" } }, "title": "PeopleWorkerIdCustomFieldsGetResponsesContentApplicationJsonSchemaDataItemsData5", "type": "object" }, "PeopleWorkerIdCustomFieldsGetResponsesContentApplicationJsonSchemaDataItemsData6": { "description": "Multiselect type", "properties": { "options": { "items": { "type": "string" }, "type": "array" } }, "title": "PeopleWorkerIdCustomFieldsGetResponsesContentApplicationJsonSchemaDataItemsData6", "type": "object" }, "PeopleWorkerIdCustomFieldsGetResponsesContentApplicationJsonSchemaDataItemsType": { "description": "Type of the custom field", "enum": [ "text", "number", "currency", "date", "percentage", "list", "multiselect", "hyperlink" ], "title": "PeopleWorkerIdCustomFieldsGetResponsesContentApplicationJsonSchemaDataItemsType", "type": "string" }, "PeopleWorkerIdCustomFieldsGetResponsesContentApplicationJsonSchemaErrorsItems": { "properties": { "code": { "description": "Machine-readable error code", "type": "string" }, "message": { "description": "Human-readable explanation of the error", "type": "string" } }, "required": [ "code", "message" ], "title": "PeopleWorkerIdCustomFieldsGetResponsesContentApplicationJsonSchemaErrorsItems", "type": "object" }, "PeopleWorkerIdCustomFieldsPutRequestBodyContentApplicationJsonSchemaData": { "properties": { "data": { "$ref": "#/components/schemas/PeopleWorkerIdCustomFieldsPutRequestBodyContentApplicationJsonSchemaDataData" }, "id": { "description": "UUID for the custom field value", "format": "uuid", "type": "string" } }, "required": [ "id", "data" ], "title": "PeopleWorkerIdCustomFieldsPutRequestBodyContentApplicationJsonSchemaData", "type": "object" }, "PeopleWorkerIdCustomFieldsPutRequestBodyContentApplicationJsonSchemaDataData": { "oneOf": [ { "$ref": "#/components/schemas/PeopleWorkerIdCustomFieldsPutRequestBodyContentApplicationJsonSchemaDataData0" }, { "$ref": "#/components/schemas/PeopleWorkerIdCustomFieldsPutRequestBodyContentApplicationJsonSchemaDataData1" }, { "$ref": "#/components/schemas/PeopleWorkerIdCustomFieldsPutRequestBodyContentApplicationJsonSchemaDataData2" }, { "$ref": "#/components/schemas/PeopleWorkerIdCustomFieldsPutRequestBodyContentApplicationJsonSchemaDataData3" }, { "$ref": "#/components/schemas/PeopleWorkerIdCustomFieldsPutRequestBodyContentApplicationJsonSchemaDataData4" }, { "$ref": "#/components/schemas/PeopleWorkerIdCustomFieldsPutRequestBodyContentApplicationJsonSchemaDataData5" }, { "$ref": "#/components/schemas/PeopleWorkerIdCustomFieldsPutRequestBodyContentApplicationJsonSchemaDataData6" } ], "title": "PeopleWorkerIdCustomFieldsPutRequestBodyContentApplicationJsonSchemaDataData" }, "PeopleWorkerIdCustomFieldsPutRequestBodyContentApplicationJsonSchemaDataData0": { "description": "Text type", "properties": { "value": { "description": "Text type", "type": "string" } }, "title": "PeopleWorkerIdCustomFieldsPutRequestBodyContentApplicationJsonSchemaDataData0", "type": "object" }, "PeopleWorkerIdCustomFieldsPutRequestBodyContentApplicationJsonSchemaDataData1": { "description": "Number type", "properties": { "value": { "description": "Number type", "format": "double", "type": "number" } }, "title": "PeopleWorkerIdCustomFieldsPutRequestBodyContentApplicationJsonSchemaDataData1", "type": "object" }, "PeopleWorkerIdCustomFieldsPutRequestBodyContentApplicationJsonSchemaDataData2": { "description": "Date type: YYYY-MM-DD", "properties": { "value": { "description": "Date type: YYYY-MM-DD", "format": "date", "type": "string" } }, "title": "PeopleWorkerIdCustomFieldsPutRequestBodyContentApplicationJsonSchemaDataData2", "type": "object" }, "PeopleWorkerIdCustomFieldsPutRequestBodyContentApplicationJsonSchemaDataData3": { "description": "Percentage type", "properties": { "value": { "description": "Percentage type", "format": "double", "type": "number" } }, "title": "PeopleWorkerIdCustomFieldsPutRequestBodyContentApplicationJsonSchemaDataData3", "type": "object" }, "PeopleWorkerIdCustomFieldsPutRequestBodyContentApplicationJsonSchemaDataData4": { "description": "Currency type", "properties": { "amount": { "format": "double", "type": "number" }, "currency": { "description": "Important: When currency type is fixed, the currency field is ignored. ", "pattern": "^[A-Z]{3}$", "type": "string" } }, "title": "PeopleWorkerIdCustomFieldsPutRequestBodyContentApplicationJsonSchemaDataData4", "type": "object" }, "PeopleWorkerIdCustomFieldsPutRequestBodyContentApplicationJsonSchemaDataData5": { "description": "List type", "properties": { "option": { "description": "Option type", "type": "string" } }, "title": "PeopleWorkerIdCustomFieldsPutRequestBodyContentApplicationJsonSchemaDataData5", "type": "object" }, "PeopleWorkerIdCustomFieldsPutRequestBodyContentApplicationJsonSchemaDataData6": { "description": "Multiselect type", "properties": { "options": { "items": { "type": "string" }, "type": "array" } }, "title": "PeopleWorkerIdCustomFieldsPutRequestBodyContentApplicationJsonSchemaDataData6", "type": "object" }, "PeopleWorkerIdPersonalGetResponsesContentApplicationJsonSchemaData": { "properties": { "addresses": { "description": "Array of addresses associated with the worker.", "items": { "$ref": "#/components/schemas/PeopleWorkerIdPersonalGetResponsesContentApplicationJsonSchemaDataAddressesItems" }, "type": [ "array", "null" ] }, "date_of_birth": { "description": "The date of birth of the worker.", "format": "date", "type": [ "string", "null" ] }, "demographics": { "description": "Demographic information for the worker, including gender and ethnicity.", "oneOf": [ { "$ref": "#/components/schemas/PeopleWorkerIdPersonalGetResponsesContentApplicationJsonSchemaDataDemographics" }, { "type": "null" } ] }, "emergency_contacts": { "description": "Array of emergency contacts associated with the worker.", "items": { "$ref": "#/components/schemas/PeopleWorkerIdPersonalGetResponsesContentApplicationJsonSchemaDataEmergencyContactsItems" }, "type": "array" }, "external_id": { "description": "The external id of the worker.", "maxLength": 100, "type": [ "string", "null" ] }, "id": { "description": "Unique identifier for the worker.", "format": "uuid", "type": "string" }, "kyc": { "$ref": "#/components/schemas/PeopleWorkerIdPersonalGetResponsesContentApplicationJsonSchemaDataKyc", "description": "KYC (Know Your Customer) verification information for the worker." }, "legal_first_name": { "description": "The legal first name of the worker.", "maxLength": 100, "type": [ "string", "null" ] }, "legal_last_name": { "description": "The legal last name of the worker.", "maxLength": 100, "type": [ "string", "null" ] }, "nationalities": { "description": "Array of nationalities associated with the worker.", "items": { "$ref": "#/components/schemas/PeopleWorkerIdPersonalGetResponsesContentApplicationJsonSchemaDataNationalitiesItems" }, "type": [ "array", "null" ] }, "ooo": { "description": "Out of office information for the worker, including leave type and dates.", "oneOf": [ { "$ref": "#/components/schemas/PeopleWorkerIdPersonalGetResponsesContentApplicationJsonSchemaDataOoo" }, { "type": "null" } ] }, "personal_email": { "description": "The personal email of the worker.", "format": "email", "maxLength": 255, "type": [ "string", "null" ] }, "phone_numbers": { "description": "Array of phone numbers associated with the worker.", "items": { "$ref": "#/components/schemas/PeopleWorkerIdPersonalGetResponsesContentApplicationJsonSchemaDataPhoneNumbersItems" }, "type": [ "array", "null" ] }, "preferred_name": { "description": "The preferred name of the worker.", "maxLength": 255, "type": [ "string", "null" ] }, "work_email": { "description": "The work email of the worker.", "format": "email", "maxLength": 255, "type": [ "string", "null" ] }, "worker_id": { "description": "The worker id.", "type": "integer" } }, "required": [ "id", "worker_id", "emergency_contacts" ], "title": "PeopleWorkerIdPersonalGetResponsesContentApplicationJsonSchemaData", "type": "object" }, "PeopleWorkerIdPersonalGetResponsesContentApplicationJsonSchemaDataAddressesItems": { "properties": { "city": { "description": "The city.", "maxLength": 255, "type": [ "string", "null" ] }, "country": { "description": "The country.", "maxLength": 255, "type": "string" }, "id": { "description": "Unique identifier for the address.", "format": "uuid", "type": "string" }, "state": { "description": "The state.", "maxLength": 255, "type": [ "string", "null" ] }, "street": { "description": "The street address.", "maxLength": 255, "type": [ "string", "null" ] }, "type": { "$ref": "#/components/schemas/PeopleWorkerIdPersonalGetResponsesContentApplicationJsonSchemaDataAddressesItemsType", "description": "The type of the address." }, "zip": { "description": "The zip code.", "maxLength": 255, "type": [ "string", "null" ] } }, "required": [ "id", "zip", "city", "type", "state", "street", "country" ], "title": "PeopleWorkerIdPersonalGetResponsesContentApplicationJsonSchemaDataAddressesItems", "type": "object" }, "PeopleWorkerIdPersonalGetResponsesContentApplicationJsonSchemaDataAddressesItemsType": { "description": "The type of the address.", "enum": [ "HOME", "POSTAL", "CONTRACT" ], "title": "PeopleWorkerIdPersonalGetResponsesContentApplicationJsonSchemaDataAddressesItemsType", "type": "string" }, "PeopleWorkerIdPersonalGetResponsesContentApplicationJsonSchemaDataDemographics": { "description": "Demographic information for the worker, including gender and ethnicity.", "properties": { "ethnicity": { "description": "Ethnicity information for the worker.", "oneOf": [ { "$ref": "#/components/schemas/PeopleWorkerIdPersonalGetResponsesContentApplicationJsonSchemaDataDemographicsEthnicity" }, { "type": "null" } ] }, "gender": { "description": "Gender information for the worker.", "oneOf": [ { "$ref": "#/components/schemas/PeopleWorkerIdPersonalGetResponsesContentApplicationJsonSchemaDataDemographicsGender" }, { "type": "null" } ] } }, "required": [ "gender", "ethnicity" ], "title": "PeopleWorkerIdPersonalGetResponsesContentApplicationJsonSchemaDataDemographics", "type": "object" }, "PeopleWorkerIdPersonalGetResponsesContentApplicationJsonSchemaDataDemographicsEthnicity": { "description": "Ethnicity information for the worker.", "properties": { "id": { "description": "Unique identifier for the ethnicity.", "format": "uuid", "type": "string" }, "name": { "description": "The name of the ethnicity.", "maxLength": 100, "type": "string" }, "other_name": { "description": "Ethnicity added by user when \"Other\" option was chosen.", "maxLength": 100, "type": [ "string", "null" ] } }, "required": [ "id", "name", "other_name" ], "title": "PeopleWorkerIdPersonalGetResponsesContentApplicationJsonSchemaDataDemographicsEthnicity", "type": "object" }, "PeopleWorkerIdPersonalGetResponsesContentApplicationJsonSchemaDataDemographicsGender": { "description": "Gender information for the worker.", "properties": { "id": { "description": "Unique identifier for the gender.", "format": "uuid", "type": "string" }, "name": { "description": "The name of the gender.", "maxLength": 100, "type": "string" }, "other_name": { "description": "Gender added by user when \"Other\" option was chosen.", "maxLength": 100, "type": [ "string", "null" ] } }, "required": [ "id", "name", "other_name" ], "title": "PeopleWorkerIdPersonalGetResponsesContentApplicationJsonSchemaDataDemographicsGender", "type": "object" }, "PeopleWorkerIdPersonalGetResponsesContentApplicationJsonSchemaDataEmergencyContactsItems": { "properties": { "email": { "description": "The email of the emergency contact.", "format": "email", "maxLength": 255, "type": [ "string", "null" ] }, "id": { "description": "Unique identifier for the emergency contact.", "format": "uuid", "type": "string" }, "name": { "description": "The name of the emergency contact.", "maxLength": 255, "type": "string" }, "phone": { "description": "The phone number of the emergency contact.", "maxLength": 30, "type": "string" }, "preferred_language": { "description": "The preferred language in which the emergency contact should be contacted.", "oneOf": [ { "$ref": "#/components/schemas/PeopleWorkerIdPersonalGetResponsesContentApplicationJsonSchemaDataEmergencyContactsItemsPreferredLanguage" }, { "type": "null" } ] }, "relationship": { "description": "The type of relationship between the owner and the emergency contact.", "maxLength": 100, "type": "string" } }, "required": [ "id", "name", "email", "phone", "relationship", "preferred_language" ], "title": "PeopleWorkerIdPersonalGetResponsesContentApplicationJsonSchemaDataEmergencyContactsItems", "type": "object" }, "PeopleWorkerIdPersonalGetResponsesContentApplicationJsonSchemaDataEmergencyContactsItemsPreferredLanguage": { "description": "The preferred language in which the emergency contact should be contacted.", "properties": { "id": { "description": "Unique identifier for the preferred language.", "type": "integer" }, "language": { "description": "The name of the language.", "maxLength": 32, "type": "string" } }, "required": [ "id", "language" ], "title": "PeopleWorkerIdPersonalGetResponsesContentApplicationJsonSchemaDataEmergencyContactsItemsPreferredLanguage", "type": "object" }, "PeopleWorkerIdPersonalGetResponsesContentApplicationJsonSchemaDataKyc": { "description": "KYC (Know Your Customer) verification information for the worker.", "properties": { "is_kyc_approved": { "description": "Boolean to identify if the user is KYC verified", "type": "boolean" }, "kyc_approval_date": { "description": "The Date the user was KYC verified if applicable", "type": [ "string", "null" ] } }, "required": [ "is_kyc_approved", "kyc_approval_date" ], "title": "PeopleWorkerIdPersonalGetResponsesContentApplicationJsonSchemaDataKyc", "type": "object" }, "PeopleWorkerIdPersonalGetResponsesContentApplicationJsonSchemaDataNationalitiesItems": { "properties": { "code": { "description": "Unique 2-letters ISO country code.", "maxLength": 2, "type": "string" }, "name": { "description": "The name of the country.", "maxLength": 100, "type": "string" } }, "required": [ "code", "name" ], "title": "PeopleWorkerIdPersonalGetResponsesContentApplicationJsonSchemaDataNationalitiesItems", "type": "object" }, "PeopleWorkerIdPersonalGetResponsesContentApplicationJsonSchemaDataOoo": { "description": "Out of office information for the worker, including leave type and dates.", "properties": { "end_date": { "description": "The worker out of office end date.", "maxLength": 10, "type": "string" }, "leave_type": { "$ref": "#/components/schemas/PeopleWorkerIdPersonalGetResponsesContentApplicationJsonSchemaDataOooLeaveType", "description": "The worker leave type." }, "name": { "description": "The worker out of office name.", "type": "string" }, "start_date": { "description": "The worker out of office start date.", "format": "date", "type": "string" } }, "required": [ "name", "end_date", "leave_type", "start_date" ], "title": "PeopleWorkerIdPersonalGetResponsesContentApplicationJsonSchemaDataOoo", "type": "object" }, "PeopleWorkerIdPersonalGetResponsesContentApplicationJsonSchemaDataOooLeaveType": { "description": "The worker leave type.", "enum": [ "LONG_TERM_LEAVE", "SHORT_TERM_LEAVE" ], "title": "PeopleWorkerIdPersonalGetResponsesContentApplicationJsonSchemaDataOooLeaveType", "type": "string" }, "PeopleWorkerIdPersonalGetResponsesContentApplicationJsonSchemaDataPhoneNumbersItems": { "properties": { "dial_code": { "description": "The dial code (also known as country code).", "maxLength": 10, "type": "string" }, "phone_number": { "description": "The phone number.", "maxLength": 30, "type": "string" }, "type": { "$ref": "#/components/schemas/PeopleWorkerIdPersonalGetResponsesContentApplicationJsonSchemaDataPhoneNumbersItemsType", "description": "The type of the phone number." } }, "required": [ "type", "dial_code", "phone_number" ], "title": "PeopleWorkerIdPersonalGetResponsesContentApplicationJsonSchemaDataPhoneNumbersItems", "type": "object" }, "PeopleWorkerIdPersonalGetResponsesContentApplicationJsonSchemaDataPhoneNumbersItemsType": { "description": "The type of the phone number.", "enum": [ "PERSONAL", "WORK", "HOME" ], "title": "PeopleWorkerIdPersonalGetResponsesContentApplicationJsonSchemaDataPhoneNumbersItemsType", "type": "string" }, "PeopleWorkerIdPersonalGetResponsesContentApplicationJsonSchemaError": { "properties": { "code": { "description": "Error code identifying the type of error.", "type": "string" }, "details": { "description": "Additional details about the error.", "type": [ "string", "null" ] }, "message": { "description": "Error message describing what went wrong.", "type": "string" } }, "required": [ "code", "message" ], "title": "PeopleWorkerIdPersonalGetResponsesContentApplicationJsonSchemaError", "type": "object" }, "PeopleWorkerIdPersonalPatchRequestBodyContentApplicationJsonSchemaData": { "properties": { "date_of_birth": { "description": "The date of birth of the worker. Format: YYYY-MM-DD.", "format": "date", "type": "string" }, "legal_first_name": { "description": "The legal first name of the worker.", "maxLength": 100, "type": "string" }, "legal_last_name": { "description": "The legal last name of the worker.", "maxLength": 100, "type": "string" }, "personal_email": { "description": "The personal email of the worker.", "format": "email", "maxLength": 255, "type": "string" }, "phone_numbers": { "items": { "$ref": "#/components/schemas/PeopleWorkerIdPersonalPatchRequestBodyContentApplicationJsonSchemaDataPhoneNumbersItems" }, "type": "array" }, "preferred_name": { "description": "The preferred name of the worker.", "maxLength": 255, "type": [ "string", "null" ] }, "work_email": { "description": "The personal email of the worker.", "format": "email", "maxLength": 255, "type": "string" } }, "title": "PeopleWorkerIdPersonalPatchRequestBodyContentApplicationJsonSchemaData", "type": "object" }, "PeopleWorkerIdPersonalPatchRequestBodyContentApplicationJsonSchemaDataPhoneNumbersItems": { "properties": { "dial_code": { "description": "The dial code (also known as country code).", "maxLength": 10, "type": "string" }, "phone_number": { "description": "The phone number.", "maxLength": 30, "type": "string" }, "type": { "$ref": "#/components/schemas/PeopleWorkerIdPersonalPatchRequestBodyContentApplicationJsonSchemaDataPhoneNumbersItemsType", "description": "The type of the phone number." } }, "required": [ "type", "dial_code", "phone_number" ], "title": "PeopleWorkerIdPersonalPatchRequestBodyContentApplicationJsonSchemaDataPhoneNumbersItems", "type": "object" }, "PeopleWorkerIdPersonalPatchRequestBodyContentApplicationJsonSchemaDataPhoneNumbersItemsType": { "description": "The type of the phone number.", "enum": [ "PERSONAL", "WORK", "HOME" ], "title": "PeopleWorkerIdPersonalPatchRequestBodyContentApplicationJsonSchemaDataPhoneNumbersItemsType", "type": "string" }, "People_createADirectEmployee-v2026-01-01_Response_201": { "properties": { "data": { "$ref": "#/components/schemas/PeoplePostResponsesContentApplicationJsonSchemaData" } }, "required": [ "data" ], "title": "People_createADirectEmployee-v2026-01-01_Response_201", "type": "object" }, "People_getMyCurrentPersonalProfile-v2026-01-01_Response_200": { "description": "People object representing a Deel", "properties": { "avatar_url": { "description": "URL of the user's avatar", "type": [ "string", "null" ] }, "client_country": { "description": "Country code.", "maxLength": 2, "minLength": 2, "pattern": "^[A-Z]{2}$", "type": [ "string", "null" ] }, "contractor_country": { "description": "Country code.", "maxLength": 2, "minLength": 2, "pattern": "^[A-Z]{2}$", "type": [ "string", "null" ] }, "email": { "description": "Email address of the user", "type": "string" }, "first_name": { "description": "First name of the user", "type": "string" }, "full_name": { "description": "Full name of the user", "type": "string" }, "hris_enabled": { "description": "HRIS feature enabled.", "type": [ "boolean", "null" ] }, "hris_organization_user_id": { "description": "HRIS Organization User ID of the user. Used in products like Deel Engage.", "format": "uuid", "type": [ "string", "null" ] }, "id": { "description": "Unique identifier for the user profile ", "format": "double", "type": "number" }, "last_name": { "description": "Last name of the user", "type": "string" }, "middle_name": { "description": "Middle name of the user", "type": [ "string", "null" ] }, "organization_id": { "description": "Unique identifier for the organization", "format": "double", "type": "number" }, "organization_name": { "description": "Name of the organization", "type": [ "string", "null" ] }, "profile_type": { "$ref": "#/components/schemas/PeopleMeGetResponsesContentApplicationJsonSchemaProfileType", "description": "Type of profile" }, "slack_team_id": { "description": "User's team slack id", "type": [ "string", "null" ] }, "slack_user_id": { "description": "User's slack id", "type": [ "string", "null" ] }, "user_id": { "description": "Unique identifier for the user", "format": "double", "type": "number" }, "username": { "description": "Username of the user", "type": "string" } }, "title": "People_getMyCurrentPersonalProfile-v2026-01-01_Response_200", "type": "object" }, "PreviewResignationLetter-v2026-01-01RequestBadRequestError": { "properties": { "errors": { "items": { "$ref": "#/components/schemas/EorWorkersContractsContractIdOffboardingResignationLetterGetResponsesContentApplicationJsonSchemaErrorsItems" }, "type": "array" } }, "title": "PreviewResignationLetter-v2026-01-01RequestBadRequestError", "type": "object" }, "PreviewResignationLetter-v2026-01-01RequestForbiddenError": { "properties": { "errors": { "items": { "$ref": "#/components/schemas/EorWorkersContractsContractIdOffboardingResignationLetterGetResponsesContentApplicationJsonSchemaErrorsItems" }, "type": "array" } }, "title": "PreviewResignationLetter-v2026-01-01RequestForbiddenError", "type": "object" }, "PreviewResignationLetter-v2026-01-01RequestInternalServerError": { "properties": { "errors": { "items": { "$ref": "#/components/schemas/EorWorkersContractsContractIdOffboardingResignationLetterGetResponsesContentApplicationJsonSchemaErrorsItems" }, "type": "array" } }, "title": "PreviewResignationLetter-v2026-01-01RequestInternalServerError", "type": "object" }, "PreviewResignationLetter-v2026-01-01RequestUnauthorizedError": { "properties": { "errors": { "items": { "$ref": "#/components/schemas/EorWorkersContractsContractIdOffboardingResignationLetterGetResponsesContentApplicationJsonSchemaErrorsItems" }, "type": "array" } }, "title": "PreviewResignationLetter-v2026-01-01RequestUnauthorizedError", "type": "object" }, "Profiles-v2026-01-01RequestBadRequestError": { "properties": { "message": { "description": "Error message explaining what went wrong.", "type": "string" } }, "title": "Profiles-v2026-01-01RequestBadRequestError", "type": "object" }, "ProfilesPatchRequestBodyContentApplicationJsonSchemaData": { "properties": { "currency": { "description": "The preferred currency for the profile.", "type": "string" }, "first_name": { "description": "The first name of the profile.", "type": "string" }, "last_name": { "description": "The last name of the profile.", "type": "string" }, "phone": { "description": "The contact number for the profile.", "type": "string" }, "preferred_name": { "description": "The preferred name of the profile.", "type": "string" }, "timezone": { "description": "The timezone of the profile.", "type": "string" } }, "title": "ProfilesPatchRequestBodyContentApplicationJsonSchemaData", "type": "object" }, "ProfilesPatchResponsesContentApplicationJsonSchemaData": { "properties": { "currency": { "description": "The preferred currency for the profile.", "type": "string" }, "first_name": { "description": "The first name of the profile.", "type": "string" }, "last_name": { "description": "The last name of the profile.", "type": "string" }, "phone": { "description": "The contact number for the profile.", "type": "string" }, "preferred_name": { "description": "The preferred name of the profile.", "type": "string" }, "timezone": { "description": "The timezone of the profile.", "type": "string" } }, "title": "ProfilesPatchResponsesContentApplicationJsonSchemaData", "type": "object" }, "Projects_createRootTimesheetsPreset_Response_200": { "properties": { "data": { "$ref": "#/components/schemas/TimesheetsRootPresetsPostResponsesContentApplicationJsonSchemaData" } }, "required": [ "data" ], "title": "Projects_createRootTimesheetsPreset_Response_200", "type": "object" }, "Projects_createTimesheetsPreset_Response_201": { "properties": { "data": { "$ref": "#/components/schemas/TimesheetsPresetsPostResponsesContentApplicationJsonSchemaData" } }, "required": [ "data" ], "title": "Projects_createTimesheetsPreset_Response_201", "type": "object" }, "Projects_deleteTimesheetsPreset_Response_200": { "properties": { "data": { "$ref": "#/components/schemas/TimesheetsPresetsIdDeleteResponsesContentApplicationJsonSchemaData" } }, "required": [ "data" ], "title": "Projects_deleteTimesheetsPreset_Response_200", "type": "object" }, "Projects_getContractTimesheetsPresets_Response_200": { "properties": { "data": { "description": "List of hourly report presets matching the requested filters.", "items": { "$ref": "#/components/schemas/ContractsContractIdTimesheetsPresetsGetResponsesContentApplicationJsonSchemaDataItems" }, "type": "array" }, "page": { "$ref": "#/components/schemas/ContractsContractIdTimesheetsPresetsGetResponsesContentApplicationJsonSchemaPage", "description": "Pagination metadata for the response." } }, "required": [ "data", "page" ], "title": "Projects_getContractTimesheetsPresets_Response_200", "type": "object" }, "Projects_getHourlyReportRootPresetById-v2026-01-01_Response_200": { "properties": { "data": { "$ref": "#/components/schemas/TimesheetsRootPresetsIdGetResponsesContentApplicationJsonSchemaData" } }, "required": [ "data" ], "title": "Projects_getHourlyReportRootPresetById-v2026-01-01_Response_200", "type": "object" }, "Projects_getHourlyReportRootPresets-v2026-01-01_Response_200": { "properties": { "data": { "items": { "$ref": "#/components/schemas/TimesheetsRootPresetsGetResponsesContentApplicationJsonSchemaDataItems" }, "type": "array" }, "page": { "$ref": "#/components/schemas/TimesheetsRootPresetsGetResponsesContentApplicationJsonSchemaPage" } }, "required": [ "data", "page" ], "title": "Projects_getHourlyReportRootPresets-v2026-01-01_Response_200", "type": "object" }, "Projects_getTimesheetsPresetById_Response_200": { "properties": { "data": { "$ref": "#/components/schemas/TimesheetsPresetsIdGetResponsesContentApplicationJsonSchemaData" } }, "required": [ "data" ], "title": "Projects_getTimesheetsPresetById_Response_200", "type": "object" }, "Projects_updateTimesheetsPreset_Response_200": { "properties": { "data": { "$ref": "#/components/schemas/TimesheetsPresetsIdPatchResponsesContentApplicationJsonSchemaData" } }, "required": [ "data" ], "title": "Projects_updateTimesheetsPreset_Response_200", "type": "object" }, "PwacPostRequestBodyContentApplicationJsonSchemaData": { "properties": { "client": { "$ref": "#/components/schemas/PwacPostRequestBodyContentApplicationJsonSchemaDataClient" }, "invitation": { "$ref": "#/components/schemas/PwacPostRequestBodyContentApplicationJsonSchemaDataInvitation", "description": "Optional invitation configuration for the new hire. Defaults to 'disable' if not provided." }, "person": { "$ref": "#/components/schemas/PwacPostRequestBodyContentApplicationJsonSchemaDataPerson", "description": "The person that is being hired" } }, "required": [ "client", "person" ], "title": "PwacPostRequestBodyContentApplicationJsonSchemaData", "type": "object" }, "PwacPostRequestBodyContentApplicationJsonSchemaDataClient": { "properties": { "department": { "$ref": "#/components/schemas/PwacPostRequestBodyContentApplicationJsonSchemaDataClientDepartment" }, "legal_entity": { "$ref": "#/components/schemas/PwacPostRequestBodyContentApplicationJsonSchemaDataClientLegalEntity" }, "team": { "$ref": "#/components/schemas/PwacPostRequestBodyContentApplicationJsonSchemaDataClientTeam" } }, "required": [ "team", "legal_entity" ], "title": "PwacPostRequestBodyContentApplicationJsonSchemaDataClient", "type": "object" }, "PwacPostRequestBodyContentApplicationJsonSchemaDataClientDepartment": { "properties": { "id": { "description": "The department that the person is part of", "format": "uuid", "type": "string" } }, "required": [ "id" ], "title": "PwacPostRequestBodyContentApplicationJsonSchemaDataClientDepartment", "type": "object" }, "PwacPostRequestBodyContentApplicationJsonSchemaDataClientLegalEntity": { "properties": { "id": { "description": "The legal entity that the person is part of", "format": "uuid", "type": "string" } }, "required": [ "id" ], "title": "PwacPostRequestBodyContentApplicationJsonSchemaDataClientLegalEntity", "type": "object" }, "PwacPostRequestBodyContentApplicationJsonSchemaDataClientTeam": { "properties": { "direct_manager_id": { "description": "The direct manager of the person", "format": "uuid", "type": "string" }, "direct_reports_ids": { "description": "The direct reports of the person", "items": { "format": "uuid", "type": "string" }, "type": "array" }, "id": { "description": "The team that the person is part of", "format": "uuid", "type": "string" } }, "required": [ "id" ], "title": "PwacPostRequestBodyContentApplicationJsonSchemaDataClientTeam", "type": "object" }, "PwacPostRequestBodyContentApplicationJsonSchemaDataInvitation": { "description": "Optional invitation configuration for the new hire. Defaults to 'disable' if not provided.", "properties": { "action": { "$ref": "#/components/schemas/PwacPostRequestBodyContentApplicationJsonSchemaDataInvitationAction", "description": "Controls whether to send an invitation email." } }, "title": "PwacPostRequestBodyContentApplicationJsonSchemaDataInvitation", "type": "object" }, "PwacPostRequestBodyContentApplicationJsonSchemaDataInvitationAction": { "description": "Controls whether to send an invitation email.", "enum": [ "DISABLE", "IMMEDIATE" ], "title": "PwacPostRequestBodyContentApplicationJsonSchemaDataInvitationAction", "type": "string" }, "PwacPostRequestBodyContentApplicationJsonSchemaDataPerson": { "description": "The person that is being hired", "properties": { "address": { "$ref": "#/components/schemas/PwacPostRequestBodyContentApplicationJsonSchemaDataPersonAddress", "description": "The home address of the person being hired" }, "country": { "description": "The country of the person being hired", "maxLength": 2, "minLength": 2, "type": "string" }, "email": { "description": "The personal email of the person being hired", "format": "email", "maxLength": 255, "minLength": 3, "type": "string" }, "end_date": { "description": "The end date of the person being hired", "format": "date", "type": "string" }, "external_id": { "description": "An external identifier for the person being hired", "maxLength": 100, "type": "string" }, "first_name": { "description": "The first name of the person being hired", "maxLength": 100, "minLength": 1, "type": "string" }, "job_title": { "description": "The job title of the person being hired", "maxLength": 255, "type": "string" }, "last_name": { "description": "The last name of the person being hired", "maxLength": 100, "minLength": 1, "type": "string" }, "nationality": { "description": "The nationality of the person being hired", "maxLength": 2, "minLength": 2, "type": "string" }, "preferred_first_name": { "description": "The preferred first name of the person being hired", "maxLength": 100, "minLength": 1, "type": "string" }, "preferred_last_name": { "description": "The preferred last name of the person being hired", "maxLength": 100, "minLength": 1, "type": "string" }, "seniority": { "description": "The seniority of the person being hired", "maxLength": 255, "type": "string" }, "start_date": { "description": "The start date of the person being hired", "format": "date", "type": "string" }, "state": { "description": "The state of the person being hired", "maxLength": 50, "minLength": 1, "type": "string" }, "work_email": { "description": "The work email of the person being hired", "format": "email", "maxLength": 255, "minLength": 3, "type": "string" } }, "required": [ "email", "last_name", "first_name", "start_date" ], "title": "PwacPostRequestBodyContentApplicationJsonSchemaDataPerson", "type": "object" }, "PwacPostRequestBodyContentApplicationJsonSchemaDataPersonAddress": { "description": "The home address of the person being hired", "properties": { "city": { "description": "The city of the home address", "type": "string" }, "country": { "description": "The country of the home address as an ISO 3166-1 alpha-2 code", "maxLength": 2, "minLength": 2, "type": "string" }, "line_two": { "description": "The second line of the home address", "type": [ "string", "null" ] }, "state": { "description": "The state or province of the home address", "type": [ "string", "null" ] }, "street": { "description": "The street and number of the home address", "type": "string" }, "zip": { "description": "The postal code of the home address", "type": "string" } }, "required": [ "country" ], "title": "PwacPostRequestBodyContentApplicationJsonSchemaDataPersonAddress", "type": "object" }, "PwacPostResponsesContentApplicationJsonSchemaData": { "properties": { "id": { "description": "The id of the person", "format": "uuid", "type": "string" }, "person": { "$ref": "#/components/schemas/PwacPostResponsesContentApplicationJsonSchemaDataPerson", "description": "The person that is being hired" } }, "required": [ "id", "person" ], "title": "PwacPostResponsesContentApplicationJsonSchemaData", "type": "object" }, "PwacPostResponsesContentApplicationJsonSchemaDataPerson": { "description": "The person that is being hired", "properties": { "country": { "description": "The country of the person being hired", "maxLength": 2, "minLength": 2, "type": "string" }, "email": { "description": "The personal email of the person being hired", "format": "email", "type": "string" }, "end_date": { "description": "The end date of the person being hired", "format": "date", "type": [ "string", "null" ] }, "external_id": { "description": "An external identifier for the person being hired", "type": [ "string", "null" ] }, "first_name": { "description": "The first name of the person being hired", "type": "string" }, "job_title": { "description": "The job title of the person being hired", "type": "string" }, "last_name": { "description": "The last name of the person being hired", "type": "string" }, "nationality": { "description": "The nationality of the person being hired", "maxLength": 2, "minLength": 2, "type": "string" }, "seniority": { "description": "The seniority of the person being hired", "type": "string" }, "start_date": { "description": "The start date of the person being hired", "format": "date", "type": "string" }, "state": { "description": "The state of the person being hired", "maxLength": 50, "minLength": 1, "type": "string" }, "work_email": { "description": "The work email of the person being hired", "format": "email", "type": "string" }, "worker_id": { "description": "The worker ID of the person being hired", "format": "double", "type": "number" } }, "required": [ "email", "last_name", "first_name", "start_date" ], "title": "PwacPostResponsesContentApplicationJsonSchemaDataPerson", "type": "object" }, "PwacPostResponsesContentApplicationJsonSchemaError": { "properties": { "code": { "description": "Error code identifying the type of error", "type": "string" }, "message": { "description": "Human readable error message", "type": "string" } }, "required": [ "code", "message" ], "title": "PwacPostResponsesContentApplicationJsonSchemaError", "type": "object" }, "ReassignItAgreement-v2026-09-17RequestBadRequestError": { "properties": { "errors": { "items": { "$ref": "#/components/schemas/ItAgreementsAgreementIdReassignPostResponsesContentApplicationJsonSchemaErrorsItems" }, "type": "array" } }, "required": [ "errors" ], "title": "ReassignItAgreement-v2026-09-17RequestBadRequestError", "type": "object" }, "ReassignItAgreement-v2026-09-17RequestConflictError": { "properties": { "errors": { "items": { "$ref": "#/components/schemas/ItAgreementsAgreementIdReassignPostResponsesContentApplicationJsonSchemaErrorsItems" }, "type": "array" } }, "required": [ "errors" ], "title": "ReassignItAgreement-v2026-09-17RequestConflictError", "type": "object" }, "ReassignItAgreement-v2026-09-17RequestForbiddenError": { "properties": { "errors": { "items": { "$ref": "#/components/schemas/ItAgreementsAgreementIdReassignPostResponsesContentApplicationJsonSchemaErrorsItems" }, "type": "array" } }, "required": [ "errors" ], "title": "ReassignItAgreement-v2026-09-17RequestForbiddenError", "type": "object" }, "ReassignItAgreement-v2026-09-17RequestInternalServerError": { "properties": { "errors": { "items": { "$ref": "#/components/schemas/ItAgreementsAgreementIdReassignPostResponsesContentApplicationJsonSchemaErrorsItems" }, "type": "array" } }, "required": [ "errors" ], "title": "ReassignItAgreement-v2026-09-17RequestInternalServerError", "type": "object" }, "ReassignItAgreement-v2026-09-17RequestNotFoundError": { "properties": { "errors": { "items": { "$ref": "#/components/schemas/ItAgreementsAgreementIdReassignPostResponsesContentApplicationJsonSchemaErrorsItems" }, "type": "array" } }, "required": [ "errors" ], "title": "ReassignItAgreement-v2026-09-17RequestNotFoundError", "type": "object" }, "ReassignItAgreement-v2026-09-17RequestUnauthorizedError": { "properties": { "errors": { "items": { "$ref": "#/components/schemas/ItAgreementsAgreementIdReassignPostResponsesContentApplicationJsonSchemaErrorsItems" }, "type": "array" } }, "required": [ "errors" ], "title": "ReassignItAgreement-v2026-09-17RequestUnauthorizedError", "type": "object" }, "RefundStatementsGetParametersEntitiesSchemaItems": { "enum": [ "individual", "company" ], "title": "RefundStatementsGetParametersEntitiesSchemaItems", "type": "string" }, "RefundStatementsGetResponsesContentApplicationJsonSchemaData": { "properties": { "has_more": { "description": "Inform if there are more entries to be fetched using next cursor,.", "type": "boolean" }, "next_cursor": { "description": "A cursor for pagination. Use the value returned in the 'next_cursor' field to get the next page of results. If there are no more results, this will be null.", "type": [ "string", "null" ] }, "rows": { "description": "Array of refund statements matching the query criteria.", "items": { "$ref": "#/components/schemas/RefundStatementsGetResponsesContentApplicationJsonSchemaDataRowsItems" }, "type": "array" }, "total_count": { "description": "The total number of refund statements matching the query.", "type": "integer" } }, "required": [ "rows", "has_more", "next_cursor", "total_count" ], "title": "RefundStatementsGetResponsesContentApplicationJsonSchemaData", "type": "object" }, "RefundStatementsGetResponsesContentApplicationJsonSchemaDataRowsItems": { "properties": { "amount": { "description": "Amount of the payment.", "type": "string" }, "created_at": { "description": "Date and time when the refund statement was created, in ISO-8601 format.", "format": "date-time", "type": "string" }, "currency": { "description": "Three-letter currency code for the payment, following ISO 4217.", "maxLength": 3, "minLength": 3, "pattern": "^[A-Z]{3}$", "type": "string" }, "id": { "description": "Unique identifier of the refund statement.", "type": "string" }, "label": { "description": "A descriptive label for the refund statement.", "type": "string" }, "paid_at": { "description": "Date and time when the refund statement was completed, in ISO-8601 format.", "format": "date-time", "type": [ "string", "null" ] }, "payment_method": { "$ref": "#/components/schemas/RefundStatementsGetResponsesContentApplicationJsonSchemaDataRowsItemsPaymentMethod", "description": "Method of payment used for the refund statement." }, "status": { "$ref": "#/components/schemas/RefundStatementsGetResponsesContentApplicationJsonSchemaDataRowsItemsStatus", "description": "Status of the refund statement. Either 'paid', 'processing', 'cancelled' or 'failed'." } }, "required": [ "id", "label", "amount", "status", "currency", "created_at", "payment_method" ], "title": "RefundStatementsGetResponsesContentApplicationJsonSchemaDataRowsItems", "type": "object" }, "RefundStatementsGetResponsesContentApplicationJsonSchemaDataRowsItemsPaymentMethod": { "description": "Method of payment used for the refund statement.", "enum": [ "bank_transfer", "client_balance" ], "title": "RefundStatementsGetResponsesContentApplicationJsonSchemaDataRowsItemsPaymentMethod", "type": "string" }, "RefundStatementsGetResponsesContentApplicationJsonSchemaDataRowsItemsStatus": { "description": "Status of the refund statement. Either 'paid', 'processing', 'cancelled' or 'failed'.", "enum": [ "paid", "processing", "cancelled", "failed" ], "title": "RefundStatementsGetResponsesContentApplicationJsonSchemaDataRowsItemsStatus", "type": "string" }, "RefundStatementsGetResponsesContentApplicationJsonSchemaErrorsItems": { "properties": { "code": { "description": "Machine-readable error code", "type": "string" }, "message": { "description": "Human-readable explanation of the error", "type": "string" } }, "required": [ "code", "message" ], "title": "RefundStatementsGetResponsesContentApplicationJsonSchemaErrorsItems", "type": "object" }, "RefundStatementsRefundStatementIdBreakdownGetResponsesContentApplicationJsonSchemaDataItems": { "properties": { "amount": { "description": "Credit amount; typically negative for credits.", "type": "string" }, "contract_id": { "description": "Contract `oid` when the credit note is tied to a contract; otherwise null.", "type": [ "string", "null" ] }, "currency": { "description": "ISO 4217 currency code.", "type": "string" }, "id": { "description": "Public id of the credit note (or credit statement line) invoice.", "type": "string" }, "label": { "description": "Display label (sequencing label or description fallback).", "type": "string" }, "original_invoice_id": { "description": "Public id of the invoice being credited when applicable; `null` when not linked.", "type": [ "string", "null" ] } }, "required": [ "id", "label", "amount", "currency" ], "title": "RefundStatementsRefundStatementIdBreakdownGetResponsesContentApplicationJsonSchemaDataItems", "type": "object" }, "RefundStatementsRefundStatementIdBreakdownGetResponsesContentApplicationJsonSchemaErrorsItems": { "properties": { "code": { "description": "Machine-readable code when present.", "type": "string" }, "message": { "description": "Human-readable message when present.", "type": "string" } }, "title": "RefundStatementsRefundStatementIdBreakdownGetResponsesContentApplicationJsonSchemaErrorsItems", "type": "object" }, "Refund_Statements_retrieveRefundStatementCreditNoteBreakdown-v2026-05-11_Response_200": { "properties": { "data": { "description": "Credit note / credit statement lines linked to this refund statement.", "items": { "$ref": "#/components/schemas/RefundStatementsRefundStatementIdBreakdownGetResponsesContentApplicationJsonSchemaDataItems" }, "type": "array" }, "hasMore": { "description": "Reserved for pagination; currently always false (full breakdown returned in `data`).", "type": "boolean" }, "nextCursor": { "description": "Reserved for cursor pagination; currently always null for this endpoint.", "type": [ "string", "null" ] } }, "required": [ "data", "hasMore", "nextCursor" ], "title": "Refund Statements_retrieveRefundStatementCreditNoteBreakdown-v2026-05-11_Response_200", "type": "object" }, "RegistrationDocumentRequirementsRequirementIdTemplateGetResponsesContentApplicationJsonSchemaData": { "properties": { "url": { "description": "Time-limited download URL. Expires shortly after issue, so fetch it rather than storing it.", "type": "string" } }, "required": [ "url" ], "title": "RegistrationDocumentRequirementsRequirementIdTemplateGetResponsesContentApplicationJsonSchemaData", "type": "object" }, "RegistrationDocumentRequirementsRequirementIdTemplateGetResponsesContentApplicationJsonSchemaErrorsItems": { "properties": { "code": { "description": "Machine-readable error code", "maxLength": 255, "type": "string" }, "field": { "description": "Field that caused the error, if applicable.", "type": [ "string", "null" ] }, "message": { "description": "Human-readable explanation", "type": "string" } }, "required": [ "message" ], "title": "RegistrationDocumentRequirementsRequirementIdTemplateGetResponsesContentApplicationJsonSchemaErrorsItems", "type": "object" }, "RejectContract-v2026-01-01RequestBadRequestError": { "properties": { "errors": { "items": { "$ref": "#/components/schemas/WorkersContractsContractIdRejectPostResponsesContentApplicationJsonSchemaErrorsItems" }, "type": "array" } }, "title": "RejectContract-v2026-01-01RequestBadRequestError", "type": "object" }, "RejectContract-v2026-01-01RequestInternalServerError": { "properties": { "errors": { "items": { "$ref": "#/components/schemas/WorkersContractsContractIdRejectPostResponsesContentApplicationJsonSchemaErrorsItems" }, "type": "array" } }, "title": "RejectContract-v2026-01-01RequestInternalServerError", "type": "object" }, "RejectEorQuote-v2026-09-10RequestBadRequestError": { "properties": { "errors": { "items": { "$ref": "#/components/schemas/EorContractsContractIdRejectPatchResponsesContentApplicationJsonSchemaErrorsItems" }, "type": "array" } }, "title": "RejectEorQuote-v2026-09-10RequestBadRequestError", "type": "object" }, "RejectEorQuote-v2026-09-10RequestForbiddenError": { "properties": { "errors": { "items": { "$ref": "#/components/schemas/EorContractsContractIdRejectPatchResponsesContentApplicationJsonSchemaErrorsItems" }, "type": "array" } }, "title": "RejectEorQuote-v2026-09-10RequestForbiddenError", "type": "object" }, "RejectEorQuote-v2026-09-10RequestInternalServerError": { "properties": { "errors": { "items": { "$ref": "#/components/schemas/EorContractsContractIdRejectPatchResponsesContentApplicationJsonSchemaErrorsItems" }, "type": "array" } }, "title": "RejectEorQuote-v2026-09-10RequestInternalServerError", "type": "object" }, "RejectEorQuote-v2026-09-10RequestNotFoundError": { "properties": { "errors": { "items": { "$ref": "#/components/schemas/EorContractsContractIdRejectPatchResponsesContentApplicationJsonSchemaErrorsItems" }, "type": "array" } }, "title": "RejectEorQuote-v2026-09-10RequestNotFoundError", "type": "object" }, "ReplaceATaxFormForAWorker-v2026-01-01RequestBadRequestError": { "properties": { "errors": { "items": { "$ref": "#/components/schemas/WorkersTaxFormsTaxFormIdPutResponsesContentApplicationJsonSchemaErrorsItems" }, "type": "array" } }, "title": "ReplaceATaxFormForAWorker-v2026-01-01RequestBadRequestError", "type": "object" }, "ReplaceATaxFormForAWorker-v2026-01-01RequestConflictError": { "properties": { "errors": { "items": { "$ref": "#/components/schemas/WorkersTaxFormsTaxFormIdPutResponsesContentApplicationJsonSchemaErrorsItems" }, "type": "array" } }, "title": "ReplaceATaxFormForAWorker-v2026-01-01RequestConflictError", "type": "object" }, "ReplaceATaxFormForAWorker-v2026-01-01RequestForbiddenError": { "properties": { "errors": { "items": { "$ref": "#/components/schemas/WorkersTaxFormsTaxFormIdPutResponsesContentApplicationJsonSchemaErrorsItems" }, "type": "array" } }, "title": "ReplaceATaxFormForAWorker-v2026-01-01RequestForbiddenError", "type": "object" }, "ReplaceATaxFormForAWorker-v2026-01-01RequestInternalServerError": { "properties": { "errors": { "items": { "$ref": "#/components/schemas/WorkersTaxFormsTaxFormIdPutResponsesContentApplicationJsonSchemaErrorsItems" }, "type": "array" } }, "title": "ReplaceATaxFormForAWorker-v2026-01-01RequestInternalServerError", "type": "object" }, "ReplaceATaxFormForAWorker-v2026-01-01RequestNotFoundError": { "properties": { "errors": { "items": { "$ref": "#/components/schemas/WorkersTaxFormsTaxFormIdPutResponsesContentApplicationJsonSchemaErrorsItems" }, "type": "array" } }, "title": "ReplaceATaxFormForAWorker-v2026-01-01RequestNotFoundError", "type": "object" }, "ReportsPayrollCyclesCycleIdGrossToNetGetResponsesContentApplicationJsonSchemaDataItems": { "properties": { "contract_oid": { "description": "Unique identifier for the contract.", "type": "string" }, "currency": { "description": "Currency associated with the payroll event.", "type": "string" }, "items": { "description": "List of payroll-related items.", "items": { "$ref": "#/components/schemas/ReportsPayrollCyclesCycleIdGrossToNetGetResponsesContentApplicationJsonSchemaDataItemsItemsItems" }, "type": "array" }, "payment_data": { "description": "Payment details associated with the payroll event. Null if no payment data is available.", "oneOf": [ { "$ref": "#/components/schemas/ReportsPayrollCyclesCycleIdGrossToNetGetResponsesContentApplicationJsonSchemaDataItemsPaymentData" }, { "type": "null" } ] } }, "title": "ReportsPayrollCyclesCycleIdGrossToNetGetResponsesContentApplicationJsonSchemaDataItems", "type": "object" }, "ReportsPayrollCyclesCycleIdGrossToNetGetResponsesContentApplicationJsonSchemaDataItemsItemsItems": { "properties": { "category": { "description": "Category of the item.", "type": "string" }, "category_group": { "$ref": "#/components/schemas/ReportsPayrollCyclesCycleIdGrossToNetGetResponsesContentApplicationJsonSchemaDataItemsItemsItemsCategoryGroup", "description": "Category group for the reporting label." }, "label": { "description": "Label of the payroll item.", "type": "string" }, "sub_category": { "description": "Sub-category of the item.", "type": "string" }, "value": { "description": "Value associated with the payroll item.", "format": "double", "type": "number" } }, "title": "ReportsPayrollCyclesCycleIdGrossToNetGetResponsesContentApplicationJsonSchemaDataItemsItemsItems", "type": "object" }, "ReportsPayrollCyclesCycleIdGrossToNetGetResponsesContentApplicationJsonSchemaDataItemsItemsItemsCategoryGroup": { "description": "Category group for the reporting label.", "enum": [ "ADDITIONS", "DEDUCTIONS", "BENEFITS", "INFOS", "CONTRIBUTIONS", "TOTALS" ], "title": "ReportsPayrollCyclesCycleIdGrossToNetGetResponsesContentApplicationJsonSchemaDataItemsItemsItemsCategoryGroup", "type": "string" }, "ReportsPayrollCyclesCycleIdGrossToNetGetResponsesContentApplicationJsonSchemaDataItemsPaymentData": { "description": "Payment details associated with the payroll event. Null if no payment data is available.", "properties": { "conversion_rate": { "description": "Conversion rate applied between the payroll currency and the payment currency.", "type": "string" }, "payment_currency": { "description": "Currency in which the payment is made.", "type": "string" } }, "title": "ReportsPayrollCyclesCycleIdGrossToNetGetResponsesContentApplicationJsonSchemaDataItemsPaymentData", "type": "object" }, "ReportsPayrollCyclesCycleIdGrossToNetGetResponsesContentApplicationJsonSchemaErrorsItems": { "properties": { "code": { "description": "Machine-readable error code.", "type": "string" }, "message": { "description": "Human-readable explanation of the server error.", "type": "string" } }, "title": "ReportsPayrollCyclesCycleIdGrossToNetGetResponsesContentApplicationJsonSchemaErrorsItems", "type": "object" }, "Reports_getsG2NReportDataForAGivenPayrollCycleByItsId-v2026-01-01_Response_200": { "properties": { "created_at": { "description": "Timestamp when the report was generated", "format": "date-time", "type": "string" }, "data": { "description": "List of contracts associated with the payroll event.", "items": { "$ref": "#/components/schemas/ReportsPayrollCyclesCycleIdGrossToNetGetResponsesContentApplicationJsonSchemaDataItems" }, "type": "array" }, "has_more": { "description": "Indicates whether more pages are available.", "type": "boolean" }, "items_per_page": { "description": "The number of items per page.", "type": "integer" }, "next_cursor": { "description": "Pagination cursor to fetch the next page of results.", "type": [ "string", "null" ] }, "updated_at": { "description": "Timestamp when the report was updated", "format": "date-time", "type": "string" } }, "required": [ "data", "has_more", "created_at", "updated_at", "next_cursor", "items_per_page" ], "title": "Reports_getsG2NReportDataForAGivenPayrollCycleByItsId-v2026-01-01_Response_200", "type": "object" }, "RequestContractResignation-v2026-01-01RequestBadRequestError": { "properties": { "errors": { "items": { "$ref": "#/components/schemas/EorContractsContractIdOffboardingResignationPostResponsesContentApplicationJsonSchemaErrorsItems" }, "type": "array" } }, "title": "RequestContractResignation-v2026-01-01RequestBadRequestError", "type": "object" }, "RequestContractResignation-v2026-01-01RequestForbiddenError": { "properties": { "errors": { "items": { "$ref": "#/components/schemas/EorContractsContractIdOffboardingResignationPostResponsesContentApplicationJsonSchemaErrorsItems" }, "type": "array" } }, "title": "RequestContractResignation-v2026-01-01RequestForbiddenError", "type": "object" }, "RequestContractResignation-v2026-01-01RequestInternalServerError": { "properties": { "errors": { "items": { "$ref": "#/components/schemas/EorContractsContractIdOffboardingResignationPostResponsesContentApplicationJsonSchemaErrorsItems" }, "type": "array" } }, "title": "RequestContractResignation-v2026-01-01RequestInternalServerError", "type": "object" }, "RequestContractResignation-v2026-01-01RequestUnauthorizedError": { "properties": { "errors": { "items": { "$ref": "#/components/schemas/EorContractsContractIdOffboardingResignationPostResponsesContentApplicationJsonSchemaErrorsItems" }, "type": "array" } }, "title": "RequestContractResignation-v2026-01-01RequestUnauthorizedError", "type": "object" }, "RequestJobScopeValidation-v2026-01-01RequestBadRequestError": { "properties": { "errors": { "items": { "$ref": "#/components/schemas/EorJobScopesValidatePostResponsesContentApplicationJsonSchemaErrorsItems" }, "type": "array" }, "request": { "$ref": "#/components/schemas/EorJobScopesValidatePostResponsesContentApplicationJsonSchemaRequest" } }, "title": "RequestJobScopeValidation-v2026-01-01RequestBadRequestError", "type": "object" }, "RequestToWithdrawFunds-v2026-01-01RequestInternalServerError": { "properties": { "errors": { "items": { "$ref": "#/components/schemas/PayoutsWithdrawalsPostResponsesContentApplicationJsonSchemaErrorsItems" }, "type": "array" } }, "title": "RequestToWithdrawFunds-v2026-01-01RequestInternalServerError", "type": "object" }, "ResubmitLegalEntityRegistrationDocument-v2026-08-17RequestBadRequestError": { "properties": { "errors": { "description": "List of errors that occurred while processing the request.", "items": { "$ref": "#/components/schemas/LegalEntitiesLegalEntityIdRegistrationDocumentsDocumentIdPutResponsesContentApplicationJsonSchemaErrorsItems" }, "type": "array" } }, "required": [ "errors" ], "title": "ResubmitLegalEntityRegistrationDocument-v2026-08-17RequestBadRequestError", "type": "object" }, "ResubmitLegalEntityRegistrationDocument-v2026-08-17RequestForbiddenError": { "properties": { "errors": { "description": "List of errors that occurred while processing the request.", "items": { "$ref": "#/components/schemas/LegalEntitiesLegalEntityIdRegistrationDocumentsDocumentIdPutResponsesContentApplicationJsonSchemaErrorsItems" }, "type": "array" } }, "required": [ "errors" ], "title": "ResubmitLegalEntityRegistrationDocument-v2026-08-17RequestForbiddenError", "type": "object" }, "ResubmitLegalEntityRegistrationDocument-v2026-08-17RequestNotFoundError": { "properties": { "errors": { "description": "List of errors that occurred while processing the request.", "items": { "$ref": "#/components/schemas/LegalEntitiesLegalEntityIdRegistrationDocumentsDocumentIdPutResponsesContentApplicationJsonSchemaErrorsItems" }, "type": "array" } }, "required": [ "errors" ], "title": "ResubmitLegalEntityRegistrationDocument-v2026-08-17RequestNotFoundError", "type": "object" }, "ResubmitLegalEntityRegistrationDocument-v2026-08-17RequestUnauthorizedError": { "properties": { "errors": { "description": "List of errors that occurred while processing the request.", "items": { "$ref": "#/components/schemas/LegalEntitiesLegalEntityIdRegistrationDocumentsDocumentIdPutResponsesContentApplicationJsonSchemaErrorsItems" }, "type": "array" } }, "required": [ "errors" ], "title": "ResubmitLegalEntityRegistrationDocument-v2026-08-17RequestUnauthorizedError", "type": "object" }, "ResubmitLegalEntityRegistrationDocument-v2026-08-17RequestUnprocessableEntityError": { "properties": { "errors": { "items": { "$ref": "#/components/schemas/LegalEntitiesLegalEntityIdRegistrationDocumentsDocumentIdPutResponsesContentApplicationJsonSchemaErrorsItems" }, "type": "array" } }, "required": [ "errors" ], "title": "ResubmitLegalEntityRegistrationDocument-v2026-08-17RequestUnprocessableEntityError", "type": "object" }, "RetrieveAClearanceRequest-v2026-09-15RequestBadRequestError": { "properties": { "errors": { "items": { "$ref": "#/components/schemas/ItClearanceRequestsClearanceRequestIdGetResponsesContentApplicationJsonSchemaErrorsItems" }, "type": "array" } }, "required": [ "errors" ], "title": "RetrieveAClearanceRequest-v2026-09-15RequestBadRequestError", "type": "object" }, "RetrieveAClearanceRequest-v2026-09-15RequestForbiddenError": { "properties": { "errors": { "items": { "$ref": "#/components/schemas/ItClearanceRequestsClearanceRequestIdGetResponsesContentApplicationJsonSchemaErrorsItems" }, "type": "array" } }, "required": [ "errors" ], "title": "RetrieveAClearanceRequest-v2026-09-15RequestForbiddenError", "type": "object" }, "RetrieveAClearanceRequest-v2026-09-15RequestInternalServerError": { "properties": { "errors": { "items": { "$ref": "#/components/schemas/ItClearanceRequestsClearanceRequestIdGetResponsesContentApplicationJsonSchemaErrorsItems" }, "type": "array" } }, "required": [ "errors" ], "title": "RetrieveAClearanceRequest-v2026-09-15RequestInternalServerError", "type": "object" }, "RetrieveAClearanceRequest-v2026-09-15RequestNotFoundError": { "properties": { "errors": { "items": { "$ref": "#/components/schemas/ItClearanceRequestsClearanceRequestIdGetResponsesContentApplicationJsonSchemaErrorsItems" }, "type": "array" } }, "required": [ "errors" ], "title": "RetrieveAClearanceRequest-v2026-09-15RequestNotFoundError", "type": "object" }, "RetrieveAClearanceRequest-v2026-09-15RequestUnauthorizedError": { "properties": { "errors": { "items": { "$ref": "#/components/schemas/ItClearanceRequestsClearanceRequestIdGetResponsesContentApplicationJsonSchemaErrorsItems" }, "type": "array" } }, "required": [ "errors" ], "title": "RetrieveAClearanceRequest-v2026-09-15RequestUnauthorizedError", "type": "object" }, "RetrieveAListOfAtsApplicationSources-v2026-01-01RequestBadRequestError": { "properties": { "errors": { "description": "List of error objects", "items": { "$ref": "#/components/schemas/AtsApplicationSourcesGetResponsesContentApplicationJsonSchemaErrorsItems" }, "type": "array" } }, "required": [ "errors" ], "title": "RetrieveAListOfAtsApplicationSources-v2026-01-01RequestBadRequestError", "type": "object" }, "RetrieveAListOfAtsApplicationSources-v2026-01-01RequestForbiddenError": { "properties": { "errors": { "description": "List of error objects", "items": { "$ref": "#/components/schemas/AtsApplicationSourcesGetResponsesContentApplicationJsonSchemaErrorsItems" }, "type": "array" } }, "required": [ "errors" ], "title": "RetrieveAListOfAtsApplicationSources-v2026-01-01RequestForbiddenError", "type": "object" }, "RetrieveAListOfAtsApplicationSources-v2026-01-01RequestInternalServerError": { "properties": { "errors": { "description": "List of error objects", "items": { "$ref": "#/components/schemas/AtsApplicationSourcesGetResponsesContentApplicationJsonSchemaErrorsItems" }, "type": "array" } }, "required": [ "errors" ], "title": "RetrieveAListOfAtsApplicationSources-v2026-01-01RequestInternalServerError", "type": "object" }, "RetrieveAListOfAtsApplications-v2026-01-01RequestBadRequestError": { "properties": { "errors": { "description": "List of error objects", "items": { "$ref": "#/components/schemas/AtsApplicationsGetResponsesContentApplicationJsonSchemaErrorsItems" }, "type": "array" } }, "required": [ "errors" ], "title": "RetrieveAListOfAtsApplications-v2026-01-01RequestBadRequestError", "type": "object" }, "RetrieveAListOfAtsApplications-v2026-01-01RequestForbiddenError": { "properties": { "errors": { "description": "List of error objects", "items": { "$ref": "#/components/schemas/AtsApplicationsGetResponsesContentApplicationJsonSchemaErrorsItems" }, "type": "array" } }, "required": [ "errors" ], "title": "RetrieveAListOfAtsApplications-v2026-01-01RequestForbiddenError", "type": "object" }, "RetrieveAListOfAtsApplications-v2026-01-01RequestInternalServerError": { "properties": { "errors": { "description": "List of error objects", "items": { "$ref": "#/components/schemas/AtsApplicationsGetResponsesContentApplicationJsonSchemaErrorsItems" }, "type": "array" } }, "required": [ "errors" ], "title": "RetrieveAListOfAtsApplications-v2026-01-01RequestInternalServerError", "type": "object" }, "RetrieveAListOfAtsDepartments-v2026-01-01RequestBadRequestError": { "properties": { "errors": { "description": "List of error objects", "items": { "$ref": "#/components/schemas/AtsDepartmentsGetResponsesContentApplicationJsonSchemaErrorsItems" }, "type": "array" } }, "required": [ "errors" ], "title": "RetrieveAListOfAtsDepartments-v2026-01-01RequestBadRequestError", "type": "object" }, "RetrieveAListOfAtsDepartments-v2026-01-01RequestForbiddenError": { "properties": { "errors": { "description": "List of error objects", "items": { "$ref": "#/components/schemas/AtsDepartmentsGetResponsesContentApplicationJsonSchemaErrorsItems" }, "type": "array" } }, "required": [ "errors" ], "title": "RetrieveAListOfAtsDepartments-v2026-01-01RequestForbiddenError", "type": "object" }, "RetrieveAListOfAtsDepartments-v2026-01-01RequestInternalServerError": { "properties": { "errors": { "description": "List of error objects", "items": { "$ref": "#/components/schemas/AtsDepartmentsGetResponsesContentApplicationJsonSchemaErrorsItems" }, "type": "array" } }, "required": [ "errors" ], "title": "RetrieveAListOfAtsDepartments-v2026-01-01RequestInternalServerError", "type": "object" }, "RetrieveAListOfAtsEmploymentTypes-v2026-01-01RequestBadRequestError": { "properties": { "errors": { "description": "List of error objects", "items": { "$ref": "#/components/schemas/AtsEmploymentTypesGetResponsesContentApplicationJsonSchemaErrorsItems" }, "type": "array" } }, "required": [ "errors" ], "title": "RetrieveAListOfAtsEmploymentTypes-v2026-01-01RequestBadRequestError", "type": "object" }, "RetrieveAListOfAtsEmploymentTypes-v2026-01-01RequestForbiddenError": { "properties": { "errors": { "description": "List of error objects", "items": { "$ref": "#/components/schemas/AtsEmploymentTypesGetResponsesContentApplicationJsonSchemaErrorsItems" }, "type": "array" } }, "required": [ "errors" ], "title": "RetrieveAListOfAtsEmploymentTypes-v2026-01-01RequestForbiddenError", "type": "object" }, "RetrieveAListOfAtsEmploymentTypes-v2026-01-01RequestInternalServerError": { "properties": { "errors": { "description": "List of error objects", "items": { "$ref": "#/components/schemas/AtsEmploymentTypesGetResponsesContentApplicationJsonSchemaErrorsItems" }, "type": "array" } }, "required": [ "errors" ], "title": "RetrieveAListOfAtsEmploymentTypes-v2026-01-01RequestInternalServerError", "type": "object" }, "RetrieveAListOfAtsHires-v2026-10-01RequestBadRequestError": { "properties": { "errors": { "description": "List of error objects", "items": { "$ref": "#/components/schemas/AtsHiresGetResponsesContentApplicationJsonSchemaErrorsItems" }, "type": "array" } }, "required": [ "errors" ], "title": "RetrieveAListOfAtsHires-v2026-10-01RequestBadRequestError", "type": "object" }, "RetrieveAListOfAtsHires-v2026-10-01RequestForbiddenError": { "properties": { "errors": { "description": "List of error objects", "items": { "$ref": "#/components/schemas/AtsHiresGetResponsesContentApplicationJsonSchemaErrorsItems" }, "type": "array" } }, "required": [ "errors" ], "title": "RetrieveAListOfAtsHires-v2026-10-01RequestForbiddenError", "type": "object" }, "RetrieveAListOfAtsHires-v2026-10-01RequestInternalServerError": { "properties": { "errors": { "description": "List of error objects", "items": { "$ref": "#/components/schemas/AtsHiresGetResponsesContentApplicationJsonSchemaErrorsItems" }, "type": "array" } }, "required": [ "errors" ], "title": "RetrieveAListOfAtsHires-v2026-10-01RequestInternalServerError", "type": "object" }, "RetrieveAListOfAtsJobBoards-v2026-02-09RequestBadRequestError": { "properties": { "errors": { "description": "List of error objects", "items": { "$ref": "#/components/schemas/AtsJobBoardsGetResponsesContentApplicationJsonSchemaErrorsItems" }, "type": "array" } }, "required": [ "errors" ], "title": "RetrieveAListOfAtsJobBoards-v2026-02-09RequestBadRequestError", "type": "object" }, "RetrieveAListOfAtsJobBoards-v2026-02-09RequestForbiddenError": { "properties": { "errors": { "description": "List of error objects", "items": { "$ref": "#/components/schemas/AtsJobBoardsGetResponsesContentApplicationJsonSchemaErrorsItems" }, "type": "array" } }, "required": [ "errors" ], "title": "RetrieveAListOfAtsJobBoards-v2026-02-09RequestForbiddenError", "type": "object" }, "RetrieveAListOfAtsJobBoards-v2026-02-09RequestInternalServerError": { "properties": { "errors": { "description": "List of error objects", "items": { "$ref": "#/components/schemas/AtsJobBoardsGetResponsesContentApplicationJsonSchemaErrorsItems" }, "type": "array" } }, "required": [ "errors" ], "title": "RetrieveAListOfAtsJobBoards-v2026-02-09RequestInternalServerError", "type": "object" }, "RetrieveAListOfAtsJobPostings-v2026-01-01RequestBadRequestError": { "properties": { "errors": { "description": "List of error objects", "items": { "$ref": "#/components/schemas/AtsJobBoardsJobBoardIdJobPostingsGetResponsesContentApplicationJsonSchemaErrorsItems" }, "type": "array" } }, "required": [ "errors" ], "title": "RetrieveAListOfAtsJobPostings-v2026-01-01RequestBadRequestError", "type": "object" }, "RetrieveAListOfAtsJobPostings-v2026-01-01RequestForbiddenError": { "properties": { "errors": { "description": "List of error objects", "items": { "$ref": "#/components/schemas/AtsJobBoardsJobBoardIdJobPostingsGetResponsesContentApplicationJsonSchemaErrorsItems" }, "type": "array" } }, "required": [ "errors" ], "title": "RetrieveAListOfAtsJobPostings-v2026-01-01RequestForbiddenError", "type": "object" }, "RetrieveAListOfAtsJobPostings-v2026-01-01RequestInternalServerError": { "properties": { "errors": { "description": "List of error objects", "items": { "$ref": "#/components/schemas/AtsJobBoardsJobBoardIdJobPostingsGetResponsesContentApplicationJsonSchemaErrorsItems" }, "type": "array" } }, "required": [ "errors" ], "title": "RetrieveAListOfAtsJobPostings-v2026-01-01RequestInternalServerError", "type": "object" }, "RetrieveAListOfAtsJobs-v2026-01-01RequestBadRequestError": { "properties": { "errors": { "description": "List of error objects", "items": { "$ref": "#/components/schemas/AtsJobsGetResponsesContentApplicationJsonSchemaErrorsItems" }, "type": "array" } }, "required": [ "errors" ], "title": "RetrieveAListOfAtsJobs-v2026-01-01RequestBadRequestError", "type": "object" }, "RetrieveAListOfAtsJobs-v2026-01-01RequestForbiddenError": { "properties": { "errors": { "description": "List of error objects", "items": { "$ref": "#/components/schemas/AtsJobsGetResponsesContentApplicationJsonSchemaErrorsItems" }, "type": "array" } }, "required": [ "errors" ], "title": "RetrieveAListOfAtsJobs-v2026-01-01RequestForbiddenError", "type": "object" }, "RetrieveAListOfAtsJobs-v2026-01-01RequestInternalServerError": { "properties": { "errors": { "description": "List of error objects", "items": { "$ref": "#/components/schemas/AtsJobsGetResponsesContentApplicationJsonSchemaErrorsItems" }, "type": "array" } }, "required": [ "errors" ], "title": "RetrieveAListOfAtsJobs-v2026-01-01RequestInternalServerError", "type": "object" }, "RetrieveAListOfAtsLocations-v2026-01-01RequestBadRequestError": { "properties": { "errors": { "description": "List of error objects", "items": { "$ref": "#/components/schemas/AtsLocationsGetResponsesContentApplicationJsonSchemaErrorsItems" }, "type": "array" } }, "required": [ "errors" ], "title": "RetrieveAListOfAtsLocations-v2026-01-01RequestBadRequestError", "type": "object" }, "RetrieveAListOfAtsLocations-v2026-01-01RequestForbiddenError": { "properties": { "errors": { "description": "List of error objects", "items": { "$ref": "#/components/schemas/AtsLocationsGetResponsesContentApplicationJsonSchemaErrorsItems" }, "type": "array" } }, "required": [ "errors" ], "title": "RetrieveAListOfAtsLocations-v2026-01-01RequestForbiddenError", "type": "object" }, "RetrieveAListOfAtsLocations-v2026-01-01RequestInternalServerError": { "properties": { "errors": { "description": "List of error objects", "items": { "$ref": "#/components/schemas/AtsLocationsGetResponsesContentApplicationJsonSchemaErrorsItems" }, "type": "array" } }, "required": [ "errors" ], "title": "RetrieveAListOfAtsLocations-v2026-01-01RequestInternalServerError", "type": "object" }, "RetrieveAListOfAtsTeams-v2026-06-24RequestBadRequestError": { "properties": { "errors": { "description": "List of error objects", "items": { "$ref": "#/components/schemas/AtsTeamsGetResponsesContentApplicationJsonSchemaErrorsItems" }, "type": "array" } }, "required": [ "errors" ], "title": "RetrieveAListOfAtsTeams-v2026-06-24RequestBadRequestError", "type": "object" }, "RetrieveAListOfAtsTeams-v2026-06-24RequestForbiddenError": { "properties": { "errors": { "description": "List of error objects", "items": { "$ref": "#/components/schemas/AtsTeamsGetResponsesContentApplicationJsonSchemaErrorsItems" }, "type": "array" } }, "required": [ "errors" ], "title": "RetrieveAListOfAtsTeams-v2026-06-24RequestForbiddenError", "type": "object" }, "RetrieveAListOfAtsTeams-v2026-06-24RequestInternalServerError": { "properties": { "errors": { "description": "List of error objects", "items": { "$ref": "#/components/schemas/AtsTeamsGetResponsesContentApplicationJsonSchemaErrorsItems" }, "type": "array" } }, "required": [ "errors" ], "title": "RetrieveAListOfAtsTeams-v2026-06-24RequestInternalServerError", "type": "object" }, "RetrieveAListOfPublishedAtsEmailTemplates-v2026-02-11RequestBadRequestError": { "properties": { "error": { "type": "string" }, "message": { "items": { "type": "string" }, "type": "array" }, "statusCode": { "format": "double", "type": "number" } }, "title": "RetrieveAListOfPublishedAtsEmailTemplates-v2026-02-11RequestBadRequestError", "type": "object" }, "RetrieveAListOfPublishedAtsEmailTemplates-v2026-02-11RequestForbiddenError": { "properties": { "errors": { "description": "List of error objects", "items": { "$ref": "#/components/schemas/AtsEmailTemplatesGetResponsesContentApplicationJsonSchemaErrorsItems" }, "type": "array" } }, "required": [ "errors" ], "title": "RetrieveAListOfPublishedAtsEmailTemplates-v2026-02-11RequestForbiddenError", "type": "object" }, "RetrieveAListOfPublishedAtsEmailTemplates-v2026-02-11RequestInternalServerError": { "properties": { "errors": { "description": "List of error objects", "items": { "$ref": "#/components/schemas/AtsEmailTemplatesGetResponsesContentApplicationJsonSchemaErrorsItems" }, "type": "array" } }, "required": [ "errors" ], "title": "RetrieveAListOfPublishedAtsEmailTemplates-v2026-02-11RequestInternalServerError", "type": "object" }, "RetrieveAPaymentBreakdown-v2026-01-01RequestInternalServerError": { "properties": { "errors": { "items": { "$ref": "#/components/schemas/PaymentsPaymentIdBreakdownGetResponsesContentApplicationJsonSchemaErrorsItems" }, "type": "array" } }, "required": [ "errors" ], "title": "RetrieveAPaymentBreakdown-v2026-01-01RequestInternalServerError", "type": "object" }, "RetrieveASingleContract-v2026-01-01RequestNotFoundError": { "properties": { "errors": { "description": "Error messages", "items": { "$ref": "#/components/schemas/ContractsContractIdGetResponsesContentApplicationJsonSchemaErrorsItems" }, "type": "array" }, "request": { "$ref": "#/components/schemas/ContractsContractIdGetResponsesContentApplicationJsonSchemaRequest", "description": "Error request details" } }, "required": [ "errors" ], "title": "RetrieveASingleContract-v2026-01-01RequestNotFoundError", "type": "object" }, "RetrieveASinglePerson-v2026-01-01RequestInternalServerError": { "properties": { "error": { "$ref": "#/components/schemas/PeopleHrisProfileIdGetResponsesContentApplicationJsonSchemaError" } }, "required": [ "error" ], "title": "RetrieveASinglePerson-v2026-01-01RequestInternalServerError", "type": "object" }, "RetrieveASingleUser-v2026-01-01RequestNotFoundError": { "properties": { "errors": { "items": { "$ref": "#/components/schemas/UsersHrisProfileIdGetResponsesContentApplicationJsonSchemaErrorsItems" }, "type": "array" }, "request": { "$ref": "#/components/schemas/UsersHrisProfileIdGetResponsesContentApplicationJsonSchemaRequest" } }, "title": "RetrieveASingleUser-v2026-01-01RequestNotFoundError", "type": "object" }, "RetrieveATimesheet-v2026-01-01RequestNotFoundError": { "properties": { "errors": { "items": { "$ref": "#/components/schemas/TimeTrackingTimesheetsTimesheetIdGetResponsesContentApplicationJsonSchemaErrorsItems" }, "type": "array" } }, "required": [ "errors" ], "title": "RetrieveATimesheet-v2026-01-01RequestNotFoundError", "type": "object" }, "RetrieveAdditionalInformationFieldsForGpWorkersByCountry-v2026-01-01RequestBadRequestError": { "properties": { "errors": { "description": "Use this array to identify each validation failure. Each item describes one parameter that failed validation.", "items": { "$ref": "#/components/schemas/FormsGpWorkerAdditionalFieldsCountryCodeGetResponsesContentApplicationJsonSchemaErrorsItems" }, "type": "array" } }, "required": [ "errors" ], "title": "RetrieveAdditionalInformationFieldsForGpWorkersByCountry-v2026-01-01RequestBadRequestError", "type": "object" }, "RetrieveAdditionalInformationFieldsForGpWorkersByCountry-v2026-01-01RequestForbiddenError": { "properties": { "errors": { "items": { "$ref": "#/components/schemas/FormsGpWorkerAdditionalFieldsCountryCodeGetResponsesContentApplicationJsonSchemaErrorsItems" }, "type": "array" } }, "required": [ "errors" ], "title": "RetrieveAdditionalInformationFieldsForGpWorkersByCountry-v2026-01-01RequestForbiddenError", "type": "object" }, "RetrieveAdditionalInformationFieldsForGpWorkersByCountry-v2026-01-01RequestInternalServerError": { "properties": { "message": { "description": "Use this message for logging and debugging purposes. Contains a general error description.", "type": "string" } }, "title": "RetrieveAdditionalInformationFieldsForGpWorkersByCountry-v2026-01-01RequestInternalServerError", "type": "object" }, "RetrieveAdditionalInformationFieldsForGpWorkersByCountry-v2026-01-01RequestNotFoundError": { "properties": { "message": { "description": "Use this message to understand why the request failed. Indicates the country does not have an additional info template configured.", "type": "string" } }, "required": [ "message" ], "title": "RetrieveAdditionalInformationFieldsForGpWorkersByCountry-v2026-01-01RequestNotFoundError", "type": "object" }, "RetrieveAdditionalInformationFieldsForGpWorkersByCountry-v2026-01-01RequestTooManyRequestsError": { "properties": { "errors": { "items": { "$ref": "#/components/schemas/FormsGpWorkerAdditionalFieldsCountryCodeGetResponsesContentApplicationJsonSchemaErrorsItems" }, "type": "array" } }, "required": [ "errors" ], "title": "RetrieveAdditionalInformationFieldsForGpWorkersByCountry-v2026-01-01RequestTooManyRequestsError", "type": "object" }, "RetrieveAdditionalInformationFieldsForGpWorkersByCountry-v2026-01-01RequestUnauthorizedError": { "properties": { "errors": { "items": { "$ref": "#/components/schemas/FormsGpWorkerAdditionalFieldsCountryCodeGetResponsesContentApplicationJsonSchemaErrorsItems" }, "type": "array" } }, "required": [ "errors" ], "title": "RetrieveAdditionalInformationFieldsForGpWorkersByCountry-v2026-01-01RequestUnauthorizedError", "type": "object" }, "RetrieveAdjustments-v2026-01-01RequestBadRequestError": { "properties": { "errors": { "items": { "$ref": "#/components/schemas/ContractsContractIdAdjustmentsGetResponsesContentApplicationJsonSchemaErrorsItems" }, "type": "array" } }, "title": "RetrieveAdjustments-v2026-01-01RequestBadRequestError", "type": "object" }, "RetrieveAllWorkerRelationTypes-v2026-01-01RequestBadRequestError": { "properties": { "errors": { "items": { "$ref": "#/components/schemas/HrisWorkerRelationsTypesGetResponsesContentApplicationJsonSchemaErrorsItems" }, "type": "array" } }, "title": "RetrieveAllWorkerRelationTypes-v2026-01-01RequestBadRequestError", "type": "object" }, "RetrieveAllWorkerRelationTypes-v2026-01-01RequestInternalServerError": { "properties": { "errors": { "items": { "$ref": "#/components/schemas/HrisWorkerRelationsTypesGetResponsesContentApplicationJsonSchemaErrorsItems" }, "type": "array" } }, "title": "RetrieveAllWorkerRelationTypes-v2026-01-01RequestInternalServerError", "type": "object" }, "RetrieveAnAdjustment-v2026-01-01RequestBadRequestError": { "properties": { "errors": { "items": { "$ref": "#/components/schemas/AdjustmentsIdGetResponsesContentApplicationJsonSchemaErrorsItems" }, "type": "array" } }, "title": "RetrieveAnAdjustment-v2026-01-01RequestBadRequestError", "type": "object" }, "RetrieveAnItAgreement-v2026-09-15RequestBadRequestError": { "properties": { "errors": { "items": { "$ref": "#/components/schemas/ItAgreementsAgreementIdGetResponsesContentApplicationJsonSchemaErrorsItems" }, "type": "array" } }, "required": [ "errors" ], "title": "RetrieveAnItAgreement-v2026-09-15RequestBadRequestError", "type": "object" }, "RetrieveAnItAgreement-v2026-09-15RequestInternalServerError": { "properties": { "errors": { "items": { "$ref": "#/components/schemas/ItAgreementsAgreementIdGetResponsesContentApplicationJsonSchemaErrorsItems" }, "type": "array" } }, "required": [ "errors" ], "title": "RetrieveAnItAgreement-v2026-09-15RequestInternalServerError", "type": "object" }, "RetrieveAnItAgreement-v2026-09-15RequestNotFoundError": { "properties": { "errors": { "items": { "$ref": "#/components/schemas/ItAgreementsAgreementIdGetResponsesContentApplicationJsonSchemaErrorsItems" }, "type": "array" } }, "required": [ "errors" ], "title": "RetrieveAnItAgreement-v2026-09-15RequestNotFoundError", "type": "object" }, "RetrieveAnItAsset-v2026-01-01RequestBadRequestError": { "properties": { "errors": { "items": { "$ref": "#/components/schemas/ItAssetsAssetIdGetResponsesContentApplicationJsonSchemaErrorsItems" }, "type": "array" } }, "required": [ "errors" ], "title": "RetrieveAnItAsset-v2026-01-01RequestBadRequestError", "type": "object" }, "RetrieveAnItAsset-v2026-01-01RequestInternalServerError": { "properties": { "errors": { "items": { "$ref": "#/components/schemas/ItAssetsAssetIdGetResponsesContentApplicationJsonSchemaErrorsItems" }, "type": "array" } }, "required": [ "errors" ], "title": "RetrieveAnItAsset-v2026-01-01RequestInternalServerError", "type": "object" }, "RetrieveAnItOrder-v2026-01-01RequestBadRequestError": { "properties": { "errors": { "items": { "$ref": "#/components/schemas/ItOrdersOrderIdGetResponsesContentApplicationJsonSchemaErrorsItems" }, "type": "array" } }, "required": [ "errors" ], "title": "RetrieveAnItOrder-v2026-01-01RequestBadRequestError", "type": "object" }, "RetrieveAnItOrder-v2026-01-01RequestInternalServerError": { "properties": { "errors": { "items": { "$ref": "#/components/schemas/ItOrdersOrderIdGetResponsesContentApplicationJsonSchemaErrorsItems" }, "type": "array" } }, "required": [ "errors" ], "title": "RetrieveAnItOrder-v2026-01-01RequestInternalServerError", "type": "object" }, "RetrieveAnItOrder-v2026-01-01RequestNotFoundError": { "properties": { "errors": { "items": { "$ref": "#/components/schemas/ItOrdersOrderIdGetResponsesContentApplicationJsonSchemaErrorsItems" }, "type": "array" } }, "required": [ "errors" ], "title": "RetrieveAnItOrder-v2026-01-01RequestNotFoundError", "type": "object" }, "RetrieveAnItProduct-v2026-09-17RequestBadRequestError": { "properties": { "errors": { "items": { "$ref": "#/components/schemas/ItProductsProductIdGetResponsesContentApplicationJsonSchemaErrorsItems" }, "type": "array" } }, "required": [ "errors" ], "title": "RetrieveAnItProduct-v2026-09-17RequestBadRequestError", "type": "object" }, "RetrieveAnItProduct-v2026-09-17RequestInternalServerError": { "properties": { "errors": { "items": { "$ref": "#/components/schemas/ItProductsProductIdGetResponsesContentApplicationJsonSchemaErrorsItems" }, "type": "array" } }, "required": [ "errors" ], "title": "RetrieveAnItProduct-v2026-09-17RequestInternalServerError", "type": "object" }, "RetrieveAnItProduct-v2026-09-17RequestNotFoundError": { "properties": { "errors": { "items": { "$ref": "#/components/schemas/ItProductsProductIdGetResponsesContentApplicationJsonSchemaErrorsItems" }, "type": "array" } }, "required": [ "errors" ], "title": "RetrieveAnItProduct-v2026-09-17RequestNotFoundError", "type": "object" }, "RetrieveAnItWarehouse-v2026-09-15RequestBadRequestError": { "properties": { "errors": { "items": { "$ref": "#/components/schemas/ItWarehousesWarehouseIdGetResponsesContentApplicationJsonSchemaErrorsItems" }, "type": "array" } }, "required": [ "errors" ], "title": "RetrieveAnItWarehouse-v2026-09-15RequestBadRequestError", "type": "object" }, "RetrieveAnItWarehouse-v2026-09-15RequestInternalServerError": { "properties": { "errors": { "items": { "$ref": "#/components/schemas/ItWarehousesWarehouseIdGetResponsesContentApplicationJsonSchemaErrorsItems" }, "type": "array" } }, "required": [ "errors" ], "title": "RetrieveAnItWarehouse-v2026-09-15RequestInternalServerError", "type": "object" }, "RetrieveAnItWarehouse-v2026-09-15RequestNotFoundError": { "properties": { "errors": { "items": { "$ref": "#/components/schemas/ItWarehousesWarehouseIdGetResponsesContentApplicationJsonSchemaErrorsItems" }, "type": "array" } }, "required": [ "errors" ], "title": "RetrieveAnItWarehouse-v2026-09-15RequestNotFoundError", "type": "object" }, "RetrieveAtsApplication-v2026-01-01RequestBadRequestError": { "properties": { "errors": { "description": "List of error objects", "items": { "$ref": "#/components/schemas/AtsApplicationsApplicationIdGetResponsesContentApplicationJsonSchemaErrorsItems" }, "type": "array" } }, "required": [ "errors" ], "title": "RetrieveAtsApplication-v2026-01-01RequestBadRequestError", "type": "object" }, "RetrieveAtsApplication-v2026-01-01RequestForbiddenError": { "properties": { "errors": { "description": "List of error objects", "items": { "$ref": "#/components/schemas/AtsApplicationsApplicationIdGetResponsesContentApplicationJsonSchemaErrorsItems" }, "type": "array" } }, "required": [ "errors" ], "title": "RetrieveAtsApplication-v2026-01-01RequestForbiddenError", "type": "object" }, "RetrieveAtsApplication-v2026-01-01RequestInternalServerError": { "properties": { "errors": { "description": "List of error objects", "items": { "$ref": "#/components/schemas/AtsApplicationsApplicationIdGetResponsesContentApplicationJsonSchemaErrorsItems" }, "type": "array" } }, "required": [ "errors" ], "title": "RetrieveAtsApplication-v2026-01-01RequestInternalServerError", "type": "object" }, "RetrieveAtsApplicationForm-v2026-01-01RequestBadRequestError": { "properties": { "errors": { "description": "List of error objects", "items": { "$ref": "#/components/schemas/AtsApplicationFormsApplicationFormIdGetResponsesContentApplicationJsonSchemaErrorsItems" }, "type": "array" } }, "required": [ "errors" ], "title": "RetrieveAtsApplicationForm-v2026-01-01RequestBadRequestError", "type": "object" }, "RetrieveAtsApplicationForm-v2026-01-01RequestForbiddenError": { "properties": { "errors": { "description": "List of error objects", "items": { "$ref": "#/components/schemas/AtsApplicationFormsApplicationFormIdGetResponsesContentApplicationJsonSchemaErrorsItems" }, "type": "array" } }, "required": [ "errors" ], "title": "RetrieveAtsApplicationForm-v2026-01-01RequestForbiddenError", "type": "object" }, "RetrieveAtsApplicationForm-v2026-01-01RequestInternalServerError": { "properties": { "errors": { "description": "List of error objects", "items": { "$ref": "#/components/schemas/AtsApplicationFormsApplicationFormIdGetResponsesContentApplicationJsonSchemaErrorsItems" }, "type": "array" } }, "required": [ "errors" ], "title": "RetrieveAtsApplicationForm-v2026-01-01RequestInternalServerError", "type": "object" }, "RetrieveAtsCandidate-v2026-09-18RequestBadRequestError": { "properties": { "errors": { "description": "List of error objects", "items": { "$ref": "#/components/schemas/AtsCandidatesCandidateIdGetResponsesContentApplicationJsonSchemaErrorsItems" }, "type": "array" } }, "required": [ "errors" ], "title": "RetrieveAtsCandidate-v2026-09-18RequestBadRequestError", "type": "object" }, "RetrieveAtsCandidate-v2026-09-18RequestForbiddenError": { "properties": { "errors": { "description": "List of error objects", "items": { "$ref": "#/components/schemas/AtsCandidatesCandidateIdGetResponsesContentApplicationJsonSchemaErrorsItems" }, "type": "array" } }, "required": [ "errors" ], "title": "RetrieveAtsCandidate-v2026-09-18RequestForbiddenError", "type": "object" }, "RetrieveAtsCandidate-v2026-09-18RequestInternalServerError": { "properties": { "errors": { "description": "List of error objects", "items": { "$ref": "#/components/schemas/AtsCandidatesCandidateIdGetResponsesContentApplicationJsonSchemaErrorsItems" }, "type": "array" } }, "required": [ "errors" ], "title": "RetrieveAtsCandidate-v2026-09-18RequestInternalServerError", "type": "object" }, "RetrieveAtsHiringMembers-v2026-01-01RequestBadRequestError": { "properties": { "errors": { "description": "List of error objects", "items": { "$ref": "#/components/schemas/AtsHiringMembersGetResponsesContentApplicationJsonSchemaErrorsItems" }, "type": "array" } }, "required": [ "errors" ], "title": "RetrieveAtsHiringMembers-v2026-01-01RequestBadRequestError", "type": "object" }, "RetrieveAtsHiringMembers-v2026-01-01RequestForbiddenError": { "properties": { "errors": { "description": "List of error objects", "items": { "$ref": "#/components/schemas/AtsHiringMembersGetResponsesContentApplicationJsonSchemaErrorsItems" }, "type": "array" } }, "required": [ "errors" ], "title": "RetrieveAtsHiringMembers-v2026-01-01RequestForbiddenError", "type": "object" }, "RetrieveAtsHiringMembers-v2026-01-01RequestInternalServerError": { "properties": { "errors": { "description": "List of error objects", "items": { "$ref": "#/components/schemas/AtsHiringMembersGetResponsesContentApplicationJsonSchemaErrorsItems" }, "type": "array" } }, "required": [ "errors" ], "title": "RetrieveAtsHiringMembers-v2026-01-01RequestInternalServerError", "type": "object" }, "RetrieveAtsJobPosting-v2026-01-01RequestBadRequestError": { "properties": { "errors": { "description": "List of error objects", "items": { "$ref": "#/components/schemas/AtsJobPostingsJobPostingIdGetResponsesContentApplicationJsonSchemaErrorsItems" }, "type": "array" } }, "required": [ "errors" ], "title": "RetrieveAtsJobPosting-v2026-01-01RequestBadRequestError", "type": "object" }, "RetrieveAtsJobPosting-v2026-01-01RequestForbiddenError": { "properties": { "errors": { "description": "List of error objects", "items": { "$ref": "#/components/schemas/AtsJobPostingsJobPostingIdGetResponsesContentApplicationJsonSchemaErrorsItems" }, "type": "array" } }, "required": [ "errors" ], "title": "RetrieveAtsJobPosting-v2026-01-01RequestForbiddenError", "type": "object" }, "RetrieveAtsJobPosting-v2026-01-01RequestInternalServerError": { "properties": { "errors": { "description": "List of error objects", "items": { "$ref": "#/components/schemas/AtsJobPostingsJobPostingIdGetResponsesContentApplicationJsonSchemaErrorsItems" }, "type": "array" } }, "required": [ "errors" ], "title": "RetrieveAtsJobPosting-v2026-01-01RequestInternalServerError", "type": "object" }, "RetrieveAtsJobPostings-v2026-04-10RequestBadRequestError": { "properties": { "errors": { "description": "List of error objects", "items": { "$ref": "#/components/schemas/AtsJobPostingsGetResponsesContentApplicationJsonSchemaErrorsItems" }, "type": "array" } }, "required": [ "errors" ], "title": "RetrieveAtsJobPostings-v2026-04-10RequestBadRequestError", "type": "object" }, "RetrieveAtsJobPostings-v2026-04-10RequestForbiddenError": { "properties": { "errors": { "description": "List of error objects", "items": { "$ref": "#/components/schemas/AtsJobPostingsGetResponsesContentApplicationJsonSchemaErrorsItems" }, "type": "array" } }, "required": [ "errors" ], "title": "RetrieveAtsJobPostings-v2026-04-10RequestForbiddenError", "type": "object" }, "RetrieveAtsJobPostings-v2026-04-10RequestInternalServerError": { "properties": { "errors": { "description": "List of error objects", "items": { "$ref": "#/components/schemas/AtsJobPostingsGetResponsesContentApplicationJsonSchemaErrorsItems" }, "type": "array" } }, "required": [ "errors" ], "title": "RetrieveAtsJobPostings-v2026-04-10RequestInternalServerError", "type": "object" }, "RetrieveBankAccountGuide-v2026-01-01RequestBadRequestError": { "properties": { "errors": { "items": { "$ref": "#/components/schemas/EorWorkersBanksGuideCountryCountryCurrencyCurrencyGetResponsesContentApplicationJsonSchemaErrorsItems" }, "type": "array" } }, "title": "RetrieveBankAccountGuide-v2026-01-01RequestBadRequestError", "type": "object" }, "RetrieveBenefitsByCountry-v2026-01-01RequestBadRequestError": { "properties": { "errors": { "items": { "$ref": "#/components/schemas/EorBenefitsGetResponsesContentApplicationJsonSchemaErrorsItems" }, "type": "array" }, "request": { "$ref": "#/components/schemas/EorBenefitsGetResponsesContentApplicationJsonSchemaRequest" } }, "title": "RetrieveBenefitsByCountry-v2026-01-01RequestBadRequestError", "type": "object" }, "RetrieveBenefitsForEmployee-v2026-01-01RequestBadRequestError": { "properties": { "errors": { "items": { "$ref": "#/components/schemas/EorWorkerBenefitsGetResponsesContentApplicationJsonSchemaErrorsItems" }, "type": "array" }, "request": { "$ref": "#/components/schemas/EorWorkerBenefitsGetResponsesContentApplicationJsonSchemaRequest" } }, "title": "RetrieveBenefitsForEmployee-v2026-01-01RequestBadRequestError", "type": "object" }, "RetrieveContractPdfDownloadLink-v2026-01-01RequestBadRequestError": { "properties": { "errors": { "items": { "$ref": "#/components/schemas/WorkersContractsContractIdPdfGetResponsesContentApplicationJsonSchemaErrorsItems" }, "type": "array" } }, "title": "RetrieveContractPdfDownloadLink-v2026-01-01RequestBadRequestError", "type": "object" }, "RetrieveContractPdfDownloadLink-v2026-01-01RequestInternalServerError": { "properties": { "errors": { "items": { "$ref": "#/components/schemas/WorkersContractsContractIdPdfGetResponsesContentApplicationJsonSchemaErrorsItems" }, "type": "array" } }, "title": "RetrieveContractPdfDownloadLink-v2026-01-01RequestInternalServerError", "type": "object" }, "RetrieveCurrentOnDemandPayroll-v2026-07-16RequestBadRequestError": { "properties": { "errors": { "description": "List of errors.", "items": { "$ref": "#/components/schemas/OnDemandPayrollContractContractIdCurrentGetResponsesContentApplicationJsonSchemaErrorsItems" }, "type": "array" } }, "required": [ "errors" ], "title": "RetrieveCurrentOnDemandPayroll-v2026-07-16RequestBadRequestError", "type": "object" }, "RetrieveCurrentOnDemandPayroll-v2026-07-16RequestForbiddenError": { "properties": { "errors": { "description": "List of errors.", "items": { "$ref": "#/components/schemas/OnDemandPayrollContractContractIdCurrentGetResponsesContentApplicationJsonSchemaErrorsItems" }, "type": "array" } }, "required": [ "errors" ], "title": "RetrieveCurrentOnDemandPayroll-v2026-07-16RequestForbiddenError", "type": "object" }, "RetrieveCurrentOnDemandPayroll-v2026-07-16RequestNotFoundError": { "properties": { "errors": { "description": "List of errors.", "items": { "$ref": "#/components/schemas/OnDemandPayrollContractContractIdCurrentGetResponsesContentApplicationJsonSchemaErrorsItems" }, "type": "array" } }, "required": [ "errors" ], "title": "RetrieveCurrentOnDemandPayroll-v2026-07-16RequestNotFoundError", "type": "object" }, "RetrieveCurrentOnDemandPayroll-v2026-07-16RequestUnauthorizedError": { "properties": { "errors": { "description": "List of errors.", "items": { "$ref": "#/components/schemas/OnDemandPayrollContractContractIdCurrentGetResponsesContentApplicationJsonSchemaErrorsItems" }, "type": "array" } }, "required": [ "errors" ], "title": "RetrieveCurrentOnDemandPayroll-v2026-07-16RequestUnauthorizedError", "type": "object" }, "RetrieveCustomFieldsForAWorker-v2026-01-01RequestNotFoundError": { "properties": { "errors": { "items": { "$ref": "#/components/schemas/PeopleWorkerIdCustomFieldsGetResponsesContentApplicationJsonSchemaErrorsItems" }, "type": "array" } }, "title": "RetrieveCustomFieldsForAWorker-v2026-01-01RequestNotFoundError", "type": "object" }, "RetrieveDeelInvoices-v2026-01-01RequestBadRequestError": { "properties": { "errors": { "items": { "$ref": "#/components/schemas/InvoicesDeelGetResponsesContentApplicationJsonSchemaErrorsItems" }, "type": "array" } }, "required": [ "errors" ], "title": "RetrieveDeelInvoices-v2026-01-01RequestBadRequestError", "type": "object" }, "RetrieveEffectiveDateLimitations-v2026-01-01RequestBadRequestError": { "properties": { "errors": { "items": { "$ref": "#/components/schemas/EorContractsContractIdAmendmentsAmendmentIdEffectiveDateLimitationsGetResponsesContentApplicationJsonSchemaErrorsItems" }, "type": "array" } }, "required": [ "errors" ], "title": "RetrieveEffectiveDateLimitations-v2026-01-01RequestBadRequestError", "type": "object" }, "RetrieveEffectiveDateLimitations-v2026-01-01RequestForbiddenError": { "properties": { "errors": { "items": { "$ref": "#/components/schemas/EorContractsContractIdAmendmentsAmendmentIdEffectiveDateLimitationsGetResponsesContentApplicationJsonSchemaErrorsItems" }, "type": "array" } }, "required": [ "errors" ], "title": "RetrieveEffectiveDateLimitations-v2026-01-01RequestForbiddenError", "type": "object" }, "RetrieveEffectiveDateLimitations-v2026-01-01RequestInternalServerError": { "properties": { "errors": { "items": { "$ref": "#/components/schemas/EorContractsContractIdAmendmentsAmendmentIdEffectiveDateLimitationsGetResponsesContentApplicationJsonSchemaErrorsItems" }, "type": "array" } }, "required": [ "errors" ], "title": "RetrieveEffectiveDateLimitations-v2026-01-01RequestInternalServerError", "type": "object" }, "RetrieveEffectiveDateLimitations-v2026-01-01RequestNotFoundError": { "properties": { "errors": { "items": { "$ref": "#/components/schemas/EorContractsContractIdAmendmentsAmendmentIdEffectiveDateLimitationsGetResponsesContentApplicationJsonSchemaErrorsItems" }, "type": "array" } }, "required": [ "errors" ], "title": "RetrieveEffectiveDateLimitations-v2026-01-01RequestNotFoundError", "type": "object" }, "RetrieveEmployeePayslips-v2026-01-01RequestBadRequestError": { "properties": { "errors": { "description": "Error messages", "items": { "$ref": "#/components/schemas/GpWorkersIdPayslipsGetResponsesContentApplicationJsonSchemaErrorsItems" }, "type": "array" }, "request": { "$ref": "#/components/schemas/GpWorkersIdPayslipsGetResponsesContentApplicationJsonSchemaRequest", "description": "Error request details" } }, "required": [ "errors" ], "title": "RetrieveEmployeePayslips-v2026-01-01RequestBadRequestError", "type": "object" }, "RetrieveEmployeeTimeOffDataForOffboarding-v2026-01-01RequestBadRequestError": { "properties": { "errors": { "items": { "$ref": "#/components/schemas/EorContractsContractIdOffboardingTimeOffsGetResponsesContentApplicationJsonSchemaErrorsItems" }, "type": "array" } }, "title": "RetrieveEmployeeTimeOffDataForOffboarding-v2026-01-01RequestBadRequestError", "type": "object" }, "RetrieveEmployeeTimeOffDataForOffboarding-v2026-01-01RequestForbiddenError": { "properties": { "errors": { "items": { "$ref": "#/components/schemas/EorContractsContractIdOffboardingTimeOffsGetResponsesContentApplicationJsonSchemaErrorsItems" }, "type": "array" } }, "title": "RetrieveEmployeeTimeOffDataForOffboarding-v2026-01-01RequestForbiddenError", "type": "object" }, "RetrieveEmployeeTimeOffDataForOffboarding-v2026-01-01RequestInternalServerError": { "properties": { "errors": { "items": { "$ref": "#/components/schemas/EorContractsContractIdOffboardingTimeOffsGetResponsesContentApplicationJsonSchemaErrorsItems" }, "type": "array" } }, "title": "RetrieveEmployeeTimeOffDataForOffboarding-v2026-01-01RequestInternalServerError", "type": "object" }, "RetrieveEmployeeTimeOffDataForOffboarding-v2026-01-01RequestUnauthorizedError": { "properties": { "errors": { "items": { "$ref": "#/components/schemas/EorContractsContractIdOffboardingTimeOffsGetResponsesContentApplicationJsonSchemaErrorsItems" }, "type": "array" } }, "title": "RetrieveEmployeeTimeOffDataForOffboarding-v2026-01-01RequestUnauthorizedError", "type": "object" }, "RetrieveEorContractDetails-v2026-01-01RequestForbiddenError": { "properties": { "error": { "description": "Contract is not accessible to the user/organization", "type": "string" } }, "title": "RetrieveEorContractDetails-v2026-01-01RequestForbiddenError", "type": "object" }, "RetrieveEorContractDetails-v2026-01-01RequestInternalServerError": { "properties": { "errors": { "items": { "$ref": "#/components/schemas/EorContractsContractIdDetailsGetResponsesContentApplicationJsonSchemaErrorsItems" }, "type": "array" } }, "required": [ "errors" ], "title": "RetrieveEorContractDetails-v2026-01-01RequestInternalServerError", "type": "object" }, "RetrieveEorContractDetails-v2026-01-01RequestNotFoundError": { "properties": { "errors": { "items": { "$ref": "#/components/schemas/EorContractsContractIdDetailsGetResponsesContentApplicationJsonSchemaErrorsItems" }, "type": "array" } }, "required": [ "errors" ], "title": "RetrieveEorContractDetails-v2026-01-01RequestNotFoundError", "type": "object" }, "RetrieveGpWorkerCreationSchema-v2026-10-01RequestBadRequestError": { "properties": { "errors": { "items": { "$ref": "#/components/schemas/GpWorkersCreationSchemaGetResponsesContentApplicationJsonSchemaErrorsItems" }, "type": "array" } }, "required": [ "errors" ], "title": "RetrieveGpWorkerCreationSchema-v2026-10-01RequestBadRequestError", "type": "object" }, "RetrieveGpWorkerCreationSchema-v2026-10-01RequestForbiddenError": { "properties": { "errors": { "items": { "$ref": "#/components/schemas/GpWorkersCreationSchemaGetResponsesContentApplicationJsonSchemaErrorsItems" }, "type": "array" } }, "required": [ "errors" ], "title": "RetrieveGpWorkerCreationSchema-v2026-10-01RequestForbiddenError", "type": "object" }, "RetrieveGpWorkerCreationSchema-v2026-10-01RequestInternalServerError": { "properties": { "errors": { "items": { "$ref": "#/components/schemas/GpWorkersCreationSchemaGetResponsesContentApplicationJsonSchemaErrorsItems" }, "type": "array" } }, "required": [ "errors" ], "title": "RetrieveGpWorkerCreationSchema-v2026-10-01RequestInternalServerError", "type": "object" }, "RetrieveGpWorkerCreationSchema-v2026-10-01RequestNotFoundError": { "properties": { "errors": { "items": { "$ref": "#/components/schemas/GpWorkersCreationSchemaGetResponsesContentApplicationJsonSchemaErrorsItems" }, "type": "array" } }, "required": [ "errors" ], "title": "RetrieveGpWorkerCreationSchema-v2026-10-01RequestNotFoundError", "type": "object" }, "RetrieveGpWorkerCreationSchema-v2026-10-01RequestUnauthorizedError": { "properties": { "errors": { "items": { "$ref": "#/components/schemas/GpWorkersCreationSchemaGetResponsesContentApplicationJsonSchemaErrorsItems" }, "type": "array" } }, "required": [ "errors" ], "title": "RetrieveGpWorkerCreationSchema-v2026-10-01RequestUnauthorizedError", "type": "object" }, "RetrieveHrxDocuments-v2026-01-01RequestBadRequestError": { "properties": { "errors": { "items": { "$ref": "#/components/schemas/EorContractsContractIdHrxDocumentsGetResponsesContentApplicationJsonSchemaErrorsItems" }, "type": "array" } }, "title": "RetrieveHrxDocuments-v2026-01-01RequestBadRequestError", "type": "object" }, "RetrieveHrxDocuments-v2026-01-01RequestInternalServerError": { "properties": { "errors": { "items": { "$ref": "#/components/schemas/EorContractsContractIdHrxDocumentsGetResponsesContentApplicationJsonSchemaErrorsItems" }, "type": "array" } }, "title": "RetrieveHrxDocuments-v2026-01-01RequestInternalServerError", "type": "object" }, "RetrieveHrxDocuments-v2026-01-01RequestUnauthorizedError": { "properties": { "errors": { "items": { "$ref": "#/components/schemas/EorContractsContractIdHrxDocumentsGetResponsesContentApplicationJsonSchemaErrorsItems" }, "type": "array" } }, "title": "RetrieveHrxDocuments-v2026-01-01RequestUnauthorizedError", "type": "object" }, "RetrieveOffboardingAttachment-v2026-01-01RequestBadRequestError": { "properties": { "errors": { "items": { "$ref": "#/components/schemas/EorContractsContractIdOffboardingAttachmentsAttachmentIdGetResponsesContentApplicationJsonSchemaErrorsItems" }, "type": "array" } }, "title": "RetrieveOffboardingAttachment-v2026-01-01RequestBadRequestError", "type": "object" }, "RetrieveOffboardingAttachment-v2026-01-01RequestForbiddenError": { "properties": { "errors": { "items": { "$ref": "#/components/schemas/EorContractsContractIdOffboardingAttachmentsAttachmentIdGetResponsesContentApplicationJsonSchemaErrorsItems" }, "type": "array" } }, "title": "RetrieveOffboardingAttachment-v2026-01-01RequestForbiddenError", "type": "object" }, "RetrieveOffboardingAttachment-v2026-01-01RequestInternalServerError": { "properties": { "errors": { "items": { "$ref": "#/components/schemas/EorContractsContractIdOffboardingAttachmentsAttachmentIdGetResponsesContentApplicationJsonSchemaErrorsItems" }, "type": "array" } }, "title": "RetrieveOffboardingAttachment-v2026-01-01RequestInternalServerError", "type": "object" }, "RetrieveOffboardingAttachment-v2026-01-01RequestUnauthorizedError": { "properties": { "errors": { "items": { "$ref": "#/components/schemas/EorContractsContractIdOffboardingAttachmentsAttachmentIdGetResponsesContentApplicationJsonSchemaErrorsItems" }, "type": "array" } }, "title": "RetrieveOffboardingAttachment-v2026-01-01RequestUnauthorizedError", "type": "object" }, "RetrieveOffboardingList-v2026-01-01RequestBadRequestError": { "properties": { "errors": { "description": "List of errors that occurred while processing the request.", "items": { "$ref": "#/components/schemas/OffboardingTrackerGetResponsesContentApplicationJsonSchemaErrorsItems" }, "type": "array" } }, "required": [ "errors" ], "title": "RetrieveOffboardingList-v2026-01-01RequestBadRequestError", "type": "object" }, "RetrieveOffboardingRequest-v2026-01-01RequestBadRequestError": { "properties": { "errors": { "items": { "$ref": "#/components/schemas/EorContractsContractIdOffboardingGetResponsesContentApplicationJsonSchemaErrorsItems" }, "type": "array" } }, "title": "RetrieveOffboardingRequest-v2026-01-01RequestBadRequestError", "type": "object" }, "RetrieveOffboardingRequest-v2026-01-01RequestForbiddenError": { "properties": { "errors": { "items": { "$ref": "#/components/schemas/EorContractsContractIdOffboardingGetResponsesContentApplicationJsonSchemaErrorsItems" }, "type": "array" } }, "title": "RetrieveOffboardingRequest-v2026-01-01RequestForbiddenError", "type": "object" }, "RetrieveOffboardingRequest-v2026-01-01RequestInternalServerError": { "properties": { "errors": { "items": { "$ref": "#/components/schemas/EorContractsContractIdOffboardingGetResponsesContentApplicationJsonSchemaErrorsItems" }, "type": "array" } }, "title": "RetrieveOffboardingRequest-v2026-01-01RequestInternalServerError", "type": "object" }, "RetrieveOffboardingRequest-v2026-01-01RequestUnauthorizedError": { "properties": { "errors": { "items": { "$ref": "#/components/schemas/EorContractsContractIdOffboardingGetResponsesContentApplicationJsonSchemaErrorsItems" }, "type": "array" } }, "title": "RetrieveOffboardingRequest-v2026-01-01RequestUnauthorizedError", "type": "object" }, "RetrieveOnboardingRightToWorkCaseForAWorker-v2026-01-01RequestBadRequestError": { "properties": { "errors": { "items": { "$ref": "#/components/schemas/ImmigrationWorkersWorkerIdOnboardingCaseGetResponsesContentApplicationJsonSchemaErrorsItems" }, "type": "array" } }, "title": "RetrieveOnboardingRightToWorkCaseForAWorker-v2026-01-01RequestBadRequestError", "type": "object" }, "RetrieveOnboardingRightToWorkCaseForAWorker-v2026-01-01RequestInternalServerError": { "properties": { "errors": { "items": { "$ref": "#/components/schemas/ImmigrationWorkersWorkerIdOnboardingCaseGetResponsesContentApplicationJsonSchemaErrorsItems" }, "type": "array" } }, "title": "RetrieveOnboardingRightToWorkCaseForAWorker-v2026-01-01RequestInternalServerError", "type": "object" }, "RetrieveOnboardingRightToWorkCaseForAWorker-v2026-01-01RequestNotFoundError": { "properties": { "errors": { "items": { "$ref": "#/components/schemas/ImmigrationWorkersWorkerIdOnboardingCaseGetResponsesContentApplicationJsonSchemaErrorsItems" }, "type": "array" } }, "required": [ "errors" ], "title": "RetrieveOnboardingRightToWorkCaseForAWorker-v2026-01-01RequestNotFoundError", "type": "object" }, "RetrievePaginatedListOfAtsAttachmentFiles-v2026-01-01RequestBadRequestError": { "properties": { "errors": { "description": "List of error objects", "items": { "$ref": "#/components/schemas/AtsAttachmentsAttachableTypeSlugAttachableIdAttachmentTypeSlugGetResponsesContentApplicationJsonSchemaErrorsItems" }, "type": "array" } }, "required": [ "errors" ], "title": "RetrievePaginatedListOfAtsAttachmentFiles-v2026-01-01RequestBadRequestError", "type": "object" }, "RetrievePaginatedListOfAtsAttachmentFiles-v2026-01-01RequestForbiddenError": { "properties": { "errors": { "description": "List of error objects", "items": { "$ref": "#/components/schemas/AtsAttachmentsAttachableTypeSlugAttachableIdAttachmentTypeSlugGetResponsesContentApplicationJsonSchemaErrorsItems" }, "type": "array" } }, "required": [ "errors" ], "title": "RetrievePaginatedListOfAtsAttachmentFiles-v2026-01-01RequestForbiddenError", "type": "object" }, "RetrievePaginatedListOfAtsAttachmentFiles-v2026-01-01RequestInternalServerError": { "properties": { "errors": { "description": "List of error objects", "items": { "$ref": "#/components/schemas/AtsAttachmentsAttachableTypeSlugAttachableIdAttachmentTypeSlugGetResponsesContentApplicationJsonSchemaErrorsItems" }, "type": "array" } }, "required": [ "errors" ], "title": "RetrievePaginatedListOfAtsAttachmentFiles-v2026-01-01RequestInternalServerError", "type": "object" }, "RetrievePaginatedListOfAtsCandidates-v2026-01-01RequestBadRequestError": { "properties": { "errors": { "description": "List of error objects", "items": { "$ref": "#/components/schemas/AtsCandidatesGetResponsesContentApplicationJsonSchemaErrorsItems" }, "type": "array" } }, "required": [ "errors" ], "title": "RetrievePaginatedListOfAtsCandidates-v2026-01-01RequestBadRequestError", "type": "object" }, "RetrievePaginatedListOfAtsCandidates-v2026-01-01RequestForbiddenError": { "properties": { "errors": { "description": "List of error objects", "items": { "$ref": "#/components/schemas/AtsCandidatesGetResponsesContentApplicationJsonSchemaErrorsItems" }, "type": "array" } }, "required": [ "errors" ], "title": "RetrievePaginatedListOfAtsCandidates-v2026-01-01RequestForbiddenError", "type": "object" }, "RetrievePaginatedListOfAtsCandidates-v2026-01-01RequestInternalServerError": { "properties": { "errors": { "description": "List of error objects", "items": { "$ref": "#/components/schemas/AtsCandidatesGetResponsesContentApplicationJsonSchemaErrorsItems" }, "type": "array" } }, "required": [ "errors" ], "title": "RetrievePaginatedListOfAtsCandidates-v2026-01-01RequestInternalServerError", "type": "object" }, "RetrievePaginatedListOfAtsRejectionArchivationReasons-v2026-01-01RequestBadRequestError": { "properties": { "errors": { "description": "List of error objects", "items": { "$ref": "#/components/schemas/AtsReasonsGetResponsesContentApplicationJsonSchemaErrorsItems" }, "type": "array" } }, "required": [ "errors" ], "title": "RetrievePaginatedListOfAtsRejectionArchivationReasons-v2026-01-01RequestBadRequestError", "type": "object" }, "RetrievePaginatedListOfAtsRejectionArchivationReasons-v2026-01-01RequestForbiddenError": { "properties": { "errors": { "description": "List of error objects", "items": { "$ref": "#/components/schemas/AtsReasonsGetResponsesContentApplicationJsonSchemaErrorsItems" }, "type": "array" } }, "required": [ "errors" ], "title": "RetrievePaginatedListOfAtsRejectionArchivationReasons-v2026-01-01RequestForbiddenError", "type": "object" }, "RetrievePaginatedListOfAtsRejectionArchivationReasons-v2026-01-01RequestInternalServerError": { "properties": { "errors": { "description": "List of error objects", "items": { "$ref": "#/components/schemas/AtsReasonsGetResponsesContentApplicationJsonSchemaErrorsItems" }, "type": "array" } }, "required": [ "errors" ], "title": "RetrievePaginatedListOfAtsRejectionArchivationReasons-v2026-01-01RequestInternalServerError", "type": "object" }, "RetrievePaymentReceipts-v2027-01-01RequestInternalServerError": { "properties": { "errors": { "items": { "$ref": "#/components/schemas/PaymentsGetResponsesContentApplicationJsonSchemaErrorsItems" }, "type": "array" } }, "required": [ "errors" ], "title": "RetrievePaymentReceipts-v2027-01-01RequestInternalServerError", "type": "object" }, "RetrievePolicyValidationTemplates-v2026-01-01RequestBadRequestError": { "properties": { "errors": { "items": { "$ref": "#/components/schemas/TimeOffsPolicyValidationTemplatesGetResponsesContentApplicationJsonSchemaErrorsItems" }, "type": "array" }, "request": { "$ref": "#/components/schemas/TimeOffsPolicyValidationTemplatesGetResponsesContentApplicationJsonSchemaRequest" } }, "title": "RetrievePolicyValidationTemplates-v2026-01-01RequestBadRequestError", "type": "object" }, "RetrieveRefundStatementCreditNoteBreakdown-v2026-05-11RequestBadRequestError": { "properties": { "errors": { "items": { "$ref": "#/components/schemas/RefundStatementsRefundStatementIdBreakdownGetResponsesContentApplicationJsonSchemaErrorsItems" }, "type": "array" } }, "required": [ "errors" ], "title": "RetrieveRefundStatementCreditNoteBreakdown-v2026-05-11RequestBadRequestError", "type": "object" }, "RetrieveRefundStatementCreditNoteBreakdown-v2026-05-11RequestForbiddenError": { "properties": { "errors": { "items": { "$ref": "#/components/schemas/RefundStatementsRefundStatementIdBreakdownGetResponsesContentApplicationJsonSchemaErrorsItems" }, "type": "array" } }, "required": [ "errors" ], "title": "RetrieveRefundStatementCreditNoteBreakdown-v2026-05-11RequestForbiddenError", "type": "object" }, "RetrieveRefundStatementCreditNoteBreakdown-v2026-05-11RequestInternalServerError": { "description": "No guaranteed error shape for unhandled failures; body may omit structured errors or differ by gateway.", "properties": { "errors": { "description": "Structured errors when the runtime could serialize them; may be absent or empty.", "items": { "$ref": "#/components/schemas/RefundStatementsRefundStatementIdBreakdownGetResponsesContentApplicationJsonSchemaErrorsItems" }, "type": "array" } }, "title": "RetrieveRefundStatementCreditNoteBreakdown-v2026-05-11RequestInternalServerError", "type": "object" }, "RetrieveRefundStatementCreditNoteBreakdown-v2026-05-11RequestNotFoundError": { "properties": { "errors": { "items": { "$ref": "#/components/schemas/RefundStatementsRefundStatementIdBreakdownGetResponsesContentApplicationJsonSchemaErrorsItems" }, "type": "array" } }, "required": [ "errors" ], "title": "RetrieveRefundStatementCreditNoteBreakdown-v2026-05-11RequestNotFoundError", "type": "object" }, "RetrieveRefundStatementCreditNoteBreakdown-v2026-05-11RequestUnauthorizedError": { "properties": { "errors": { "items": { "$ref": "#/components/schemas/RefundStatementsRefundStatementIdBreakdownGetResponsesContentApplicationJsonSchemaErrorsItems" }, "type": "array" } }, "required": [ "errors" ], "title": "RetrieveRefundStatementCreditNoteBreakdown-v2026-05-11RequestUnauthorizedError", "type": "object" }, "RetrieveRefundStatements-v2026-04-30RequestBadRequestError": { "properties": { "errors": { "items": { "$ref": "#/components/schemas/RefundStatementsGetResponsesContentApplicationJsonSchemaErrorsItems" }, "type": "array" } }, "required": [ "errors" ], "title": "RetrieveRefundStatements-v2026-04-30RequestBadRequestError", "type": "object" }, "RetrieveRefundStatements-v2026-04-30RequestForbiddenError": { "properties": { "errors": { "items": { "$ref": "#/components/schemas/RefundStatementsGetResponsesContentApplicationJsonSchemaErrorsItems" }, "type": "array" } }, "required": [ "errors" ], "title": "RetrieveRefundStatements-v2026-04-30RequestForbiddenError", "type": "object" }, "RetrieveRefundStatements-v2026-04-30RequestInternalServerError": { "properties": { "errors": { "items": { "$ref": "#/components/schemas/RefundStatementsGetResponsesContentApplicationJsonSchemaErrorsItems" }, "type": "array" } }, "required": [ "errors" ], "title": "RetrieveRefundStatements-v2026-04-30RequestInternalServerError", "type": "object" }, "RetrieveRestrictedOffboardingDates-v2026-01-01RequestBadRequestError": { "properties": { "errors": { "items": { "$ref": "#/components/schemas/EorContractsContractIdOffboardingRestrictedDatesGetResponsesContentApplicationJsonSchemaErrorsItems" }, "type": "array" } }, "title": "RetrieveRestrictedOffboardingDates-v2026-01-01RequestBadRequestError", "type": "object" }, "RetrieveRestrictedOffboardingDates-v2026-01-01RequestForbiddenError": { "properties": { "errors": { "items": { "$ref": "#/components/schemas/EorContractsContractIdOffboardingRestrictedDatesGetResponsesContentApplicationJsonSchemaErrorsItems" }, "type": "array" } }, "title": "RetrieveRestrictedOffboardingDates-v2026-01-01RequestForbiddenError", "type": "object" }, "RetrieveRestrictedOffboardingDates-v2026-01-01RequestInternalServerError": { "properties": { "errors": { "items": { "$ref": "#/components/schemas/EorContractsContractIdOffboardingRestrictedDatesGetResponsesContentApplicationJsonSchemaErrorsItems" }, "type": "array" } }, "title": "RetrieveRestrictedOffboardingDates-v2026-01-01RequestInternalServerError", "type": "object" }, "RetrieveRestrictedOffboardingDates-v2026-01-01RequestUnauthorizedError": { "properties": { "errors": { "items": { "$ref": "#/components/schemas/EorContractsContractIdOffboardingRestrictedDatesGetResponsesContentApplicationJsonSchemaErrorsItems" }, "type": "array" } }, "title": "RetrieveRestrictedOffboardingDates-v2026-01-01RequestUnauthorizedError", "type": "object" }, "RetrieveTerminationDetails-v2026-01-01RequestInternalServerError": { "properties": { "errors": { "items": { "$ref": "#/components/schemas/OffboardingTrackerIdGetResponsesContentApplicationJsonSchemaErrorsItems" }, "type": "array" } }, "title": "RetrieveTerminationDetails-v2026-01-01RequestInternalServerError", "type": "object" }, "RetrieveTheItSeatContract-v2026-09-25RequestBadRequestError": { "properties": { "errors": { "items": { "$ref": "#/components/schemas/ItSeatsStatusGetResponsesContentApplicationJsonSchemaErrorsItems" }, "type": "array" } }, "required": [ "errors" ], "title": "RetrieveTheItSeatContract-v2026-09-25RequestBadRequestError", "type": "object" }, "RetrieveTheItSeatContract-v2026-09-25RequestConflictError": { "properties": { "errors": { "items": { "$ref": "#/components/schemas/ItSeatsStatusGetResponsesContentApplicationJsonSchemaErrorsItems" }, "type": "array" } }, "required": [ "errors" ], "title": "RetrieveTheItSeatContract-v2026-09-25RequestConflictError", "type": "object" }, "RetrieveTheItSeatContract-v2026-09-25RequestForbiddenError": { "properties": { "errors": { "items": { "$ref": "#/components/schemas/ItSeatsStatusGetResponsesContentApplicationJsonSchemaErrorsItems" }, "type": "array" } }, "required": [ "errors" ], "title": "RetrieveTheItSeatContract-v2026-09-25RequestForbiddenError", "type": "object" }, "RetrieveTheItSeatContract-v2026-09-25RequestInternalServerError": { "properties": { "errors": { "items": { "$ref": "#/components/schemas/ItSeatsStatusGetResponsesContentApplicationJsonSchemaErrorsItems" }, "type": "array" } }, "required": [ "errors" ], "title": "RetrieveTheItSeatContract-v2026-09-25RequestInternalServerError", "type": "object" }, "RetrieveTheItSeatContract-v2026-09-25RequestNotFoundError": { "properties": { "errors": { "items": { "$ref": "#/components/schemas/ItSeatsStatusGetResponsesContentApplicationJsonSchemaErrorsItems" }, "type": "array" } }, "required": [ "errors" ], "title": "RetrieveTheItSeatContract-v2026-09-25RequestNotFoundError", "type": "object" }, "RetrieveTheItSeatContract-v2026-09-25RequestUnauthorizedError": { "properties": { "errors": { "items": { "$ref": "#/components/schemas/ItSeatsStatusGetResponsesContentApplicationJsonSchemaErrorsItems" }, "type": "array" } }, "required": [ "errors" ], "title": "RetrieveTheItSeatContract-v2026-09-25RequestUnauthorizedError", "type": "object" }, "RetrieveTimeOffTypes-v2026-01-01RequestNotFoundError": { "properties": { "errors": { "description": "Array of error objects containing error messages.", "items": { "$ref": "#/components/schemas/LookupsTimeOffTypesGetResponsesContentApplicationJsonSchemaErrorsItems" }, "type": "array" } }, "required": [ "errors" ], "title": "RetrieveTimeOffTypes-v2026-01-01RequestNotFoundError", "type": "object" }, "RetrieveWorkerResignations-v2026-01-01RequestBadRequestError": { "properties": { "errors": { "items": { "$ref": "#/components/schemas/EorWorkersResignationsGetResponsesContentApplicationJsonSchemaErrorsItems" }, "type": "array" } }, "title": "RetrieveWorkerResignations-v2026-01-01RequestBadRequestError", "type": "object" }, "RetrieveWorkerResignations-v2026-01-01RequestForbiddenError": { "properties": { "errors": { "items": { "$ref": "#/components/schemas/EorWorkersResignationsGetResponsesContentApplicationJsonSchemaErrorsItems" }, "type": "array" } }, "title": "RetrieveWorkerResignations-v2026-01-01RequestForbiddenError", "type": "object" }, "RetrieveWorkerResignations-v2026-01-01RequestInternalServerError": { "properties": { "errors": { "items": { "$ref": "#/components/schemas/EorWorkersResignationsGetResponsesContentApplicationJsonSchemaErrorsItems" }, "type": "array" } }, "title": "RetrieveWorkerResignations-v2026-01-01RequestInternalServerError", "type": "object" }, "RetrieveWorkerResignations-v2026-01-01RequestUnauthorizedError": { "properties": { "errors": { "items": { "$ref": "#/components/schemas/EorWorkersResignationsGetResponsesContentApplicationJsonSchemaErrorsItems" }, "type": "array" } }, "title": "RetrieveWorkerResignations-v2026-01-01RequestUnauthorizedError", "type": "object" }, "RetrieveWorkersActionableJourneys-v2026-01-01RequestBadRequestError": { "properties": { "errors": { "items": { "$ref": "#/components/schemas/EngageLearningActionableJourneysGetResponsesContentApplicationJsonSchemaErrorsItems" }, "type": "array" }, "request": { "$ref": "#/components/schemas/EngageLearningActionableJourneysGetResponsesContentApplicationJsonSchemaRequest" } }, "title": "RetrieveWorkersActionableJourneys-v2026-01-01RequestBadRequestError", "type": "object" }, "ReviewASingleTask-v2026-01-01RequestBadRequestError": { "properties": { "error": { "type": "string" } }, "title": "ReviewASingleTask-v2026-01-01RequestBadRequestError", "type": "object" }, "ReviewASingleTask-v2026-01-01RequestInternalServerError": { "properties": { "error": { "type": "string" } }, "title": "ReviewASingleTask-v2026-01-01RequestInternalServerError", "type": "object" }, "ReviewASingleTask-v2026-01-01RequestNotFoundError": { "properties": { "error": { "type": "string" } }, "title": "ReviewASingleTask-v2026-01-01RequestNotFoundError", "type": "object" }, "ReviewASingleTask-v2026-01-01RequestUnauthorizedError": { "properties": { "error": { "type": "string" } }, "title": "ReviewASingleTask-v2026-01-01RequestUnauthorizedError", "type": "object" }, "ReviewASubmittedTimesheet-v2026-01-01RequestNotFoundError": { "properties": { "errors": { "items": { "$ref": "#/components/schemas/TimeTrackingTimesheetsTimesheetIdReviewPostResponsesContentApplicationJsonSchemaErrorsItems" }, "type": "array" } }, "required": [ "errors" ], "title": "ReviewASubmittedTimesheet-v2026-01-01RequestNotFoundError", "type": "object" }, "ReviewASubmittedTimesheet-v2026-01-01RequestUnprocessableEntityError": { "properties": { "errors": { "items": { "$ref": "#/components/schemas/TimeTrackingTimesheetsTimesheetIdReviewPostResponsesContentApplicationJsonSchemaErrorsItems" }, "type": "array" } }, "required": [ "errors" ], "title": "ReviewASubmittedTimesheet-v2026-01-01RequestUnprocessableEntityError", "type": "object" }, "ReviewApproveOrRequestChangesToEorOffboardingDocuments-v2026-01-01RequestBadRequestError": { "properties": { "errors": { "items": { "$ref": "#/components/schemas/EorContractsContractIdOffboardingReviewClientSignOffsPostResponsesContentApplicationJsonSchemaErrorsItems" }, "type": "array" } }, "title": "ReviewApproveOrRequestChangesToEorOffboardingDocuments-v2026-01-01RequestBadRequestError", "type": "object" }, "ReviewApproveOrRequestChangesToEorOffboardingDocuments-v2026-01-01RequestForbiddenError": { "properties": { "errors": { "items": { "$ref": "#/components/schemas/EorContractsContractIdOffboardingReviewClientSignOffsPostResponsesContentApplicationJsonSchemaErrorsItems" }, "type": "array" } }, "title": "ReviewApproveOrRequestChangesToEorOffboardingDocuments-v2026-01-01RequestForbiddenError", "type": "object" }, "ReviewApproveOrRequestChangesToEorOffboardingDocuments-v2026-01-01RequestInternalServerError": { "properties": { "errors": { "items": { "$ref": "#/components/schemas/EorContractsContractIdOffboardingReviewClientSignOffsPostResponsesContentApplicationJsonSchemaErrorsItems" }, "type": "array" } }, "title": "ReviewApproveOrRequestChangesToEorOffboardingDocuments-v2026-01-01RequestInternalServerError", "type": "object" }, "ReviewApproveOrRequestChangesToEorOffboardingDocuments-v2026-01-01RequestUnauthorizedError": { "properties": { "errors": { "items": { "$ref": "#/components/schemas/EorContractsContractIdOffboardingReviewClientSignOffsPostResponsesContentApplicationJsonSchemaErrorsItems" }, "type": "array" } }, "title": "ReviewApproveOrRequestChangesToEorOffboardingDocuments-v2026-01-01RequestUnauthorizedError", "type": "object" }, "ReviewMultipleTasks-v2026-01-01RequestBadRequestError": { "properties": { "error": { "type": "string" } }, "title": "ReviewMultipleTasks-v2026-01-01RequestBadRequestError", "type": "object" }, "ReviewMultipleTasks-v2026-01-01RequestInternalServerError": { "properties": { "error": { "type": "string" } }, "title": "ReviewMultipleTasks-v2026-01-01RequestInternalServerError", "type": "object" }, "ReviewMultipleTasks-v2026-01-01RequestNotFoundError": { "properties": { "error": { "type": "string" } }, "title": "ReviewMultipleTasks-v2026-01-01RequestNotFoundError", "type": "object" }, "ReviewMultipleTasks-v2026-01-01RequestUnauthorizedError": { "properties": { "error": { "type": "string" } }, "title": "ReviewMultipleTasks-v2026-01-01RequestUnauthorizedError", "type": "object" }, "RolesGetResponsesContentApplicationJsonSchemaDataItems": { "properties": { "hrisOrgStructureId": { "description": "The HRIS (Human Resource Information System) organization structure ID associated with the role, if applicable.", "type": [ "string", "null" ] }, "id": { "description": "The unique identifier for the role.", "format": "double", "type": "number" }, "name": { "description": "The name of the role.", "type": "string" }, "scope": { "description": "The scope of the role, which can define the level of access. For example, 'ORGANIZATION' represents a global role within the organization.", "type": "string" } }, "required": [ "id", "name", "scope" ], "title": "RolesGetResponsesContentApplicationJsonSchemaDataItems", "type": "object" }, "RolesPostRequestBodyContentApplicationJsonSchemaData": { "properties": { "description": { "description": "Organization role description", "type": "string" }, "hrisOrgStructureId": { "description": "HRIS organization structure id", "type": "string" }, "name": { "description": "Organization role name", "type": "string" }, "permissionSets": { "items": { "type": "string" }, "type": "array" }, "scope": { "description": "Organization role scope", "type": "string" } }, "required": [ "name", "scope", "description", "permissionSets" ], "title": "RolesPostRequestBodyContentApplicationJsonSchemaData", "type": "object" }, "RolesRoleIdPatchRequestBodyContentApplicationJsonSchemaData": { "properties": { "description": { "description": "Description of the role", "type": "string" }, "name": { "description": "Name of the role", "type": "string" }, "permissionSets": { "items": { "type": "string" }, "type": "array" } }, "title": "RolesRoleIdPatchRequestBodyContentApplicationJsonSchemaData", "type": "object" }, "ScreeningsAmlEntityTypeEntityIdGetParametersEntityType": { "enum": [ "profile", "hris_profile", "legal_entity" ], "title": "ScreeningsAmlEntityTypeEntityIdGetParametersEntityType", "type": "string" }, "ScreeningsAmlEntityTypeEntityIdGetResponsesContentApplicationJsonSchemaDetailedResults": { "description": "Details of checks performed for this screening.", "properties": { "adverse_media": { "$ref": "#/components/schemas/ScreeningsAmlEntityTypeEntityIdGetResponsesContentApplicationJsonSchemaDetailedResultsAdverseMedia", "description": "The result of the adverse media check." }, "pep": { "$ref": "#/components/schemas/ScreeningsAmlEntityTypeEntityIdGetResponsesContentApplicationJsonSchemaDetailedResultsPep", "description": "The result of the PEP (Politically Exposed Person) check." }, "sanctions": { "$ref": "#/components/schemas/ScreeningsAmlEntityTypeEntityIdGetResponsesContentApplicationJsonSchemaDetailedResultsSanctions", "description": "The result of the sanctions check." } }, "title": "ScreeningsAmlEntityTypeEntityIdGetResponsesContentApplicationJsonSchemaDetailedResults", "type": "object" }, "ScreeningsAmlEntityTypeEntityIdGetResponsesContentApplicationJsonSchemaDetailedResultsAdverseMedia": { "description": "The result of the adverse media check.", "enum": [ "PASS", "FAIL" ], "title": "ScreeningsAmlEntityTypeEntityIdGetResponsesContentApplicationJsonSchemaDetailedResultsAdverseMedia", "type": "string" }, "ScreeningsAmlEntityTypeEntityIdGetResponsesContentApplicationJsonSchemaDetailedResultsPep": { "description": "The result of the PEP (Politically Exposed Person) check.", "enum": [ "PASS", "FAIL" ], "title": "ScreeningsAmlEntityTypeEntityIdGetResponsesContentApplicationJsonSchemaDetailedResultsPep", "type": "string" }, "ScreeningsAmlEntityTypeEntityIdGetResponsesContentApplicationJsonSchemaDetailedResultsSanctions": { "description": "The result of the sanctions check.", "enum": [ "PASS", "FAIL" ], "title": "ScreeningsAmlEntityTypeEntityIdGetResponsesContentApplicationJsonSchemaDetailedResultsSanctions", "type": "string" }, "ScreeningsAmlEntityTypeEntityIdGetResponsesContentApplicationJsonSchemaEntityType": { "description": "The type of entity being screened.", "enum": [ "profile", "hris_profile", "legal_entity" ], "title": "ScreeningsAmlEntityTypeEntityIdGetResponsesContentApplicationJsonSchemaEntityType", "type": "string" }, "ScreeningsAmlEntityTypeEntityIdGetResponsesContentApplicationJsonSchemaErrorsItems": { "properties": { "message": { "description": "A description of the returned error", "type": "string" } }, "title": "ScreeningsAmlEntityTypeEntityIdGetResponsesContentApplicationJsonSchemaErrorsItems", "type": "object" }, "ScreeningsAmlEntityTypeEntityIdGetResponsesContentApplicationJsonSchemaResult": { "description": "The result of the screening. ACCEPT means the screening passed, REJECT means it failed, and REFERRED means it is pending further review.", "enum": [ "ACCEPT", "REJECT", "REFERRED", "PENDING" ], "title": "ScreeningsAmlEntityTypeEntityIdGetResponsesContentApplicationJsonSchemaResult", "type": "string" }, "ScreeningsKycDetailsGetResponsesContentApplicationJsonSchemaData": { "properties": { "approval_date": { "description": "The date and time when the KYC screening was approved (null if not approved)", "format": "date-time", "type": [ "string", "null" ] }, "created_at": { "description": "The date and time when the KYC screening was created", "format": "date-time", "type": [ "string", "null" ] }, "document_extracted_first_name": { "description": "The first name extracted from the submitted document", "type": [ "string", "null" ] }, "document_extracted_last_name": { "description": "The last name extracted from the submitted document", "type": [ "string", "null" ] }, "document_extracted_middle_name": { "description": "The middle name extracted from the submitted document", "type": [ "string", "null" ] }, "expiration_date": { "description": "The date and time when the KYC screening expires (null if no expiry)", "format": "date-time", "type": [ "string", "null" ] }, "identity_document_name": { "description": "The name of the identity document used for verification (in case of other document type)", "type": [ "string", "null" ] }, "identity_document_number": { "description": "Number of the submitted document", "type": [ "string", "null" ] }, "identity_document_type": { "description": "The type of identity document used for verification", "oneOf": [ { "$ref": "#/components/schemas/ScreeningsKycDetailsGetResponsesContentApplicationJsonSchemaDataIdentityDocumentType" }, { "type": "null" } ] }, "kyc_status": { "$ref": "#/components/schemas/ScreeningsKycDetailsGetResponsesContentApplicationJsonSchemaDataKycStatus", "description": "The current KYC verification status of the profile" }, "rejection_date": { "description": "The date and time when the KYC screening was rejected (null if not rejected or pending review for Veriff)", "format": "date-time", "type": [ "string", "null" ] }, "submission_date": { "description": "The date and time when the KYC screening was submitted", "format": "date-time", "type": [ "string", "null" ] }, "updated_at": { "description": "The date and time when the KYC screening was last updated", "format": "date-time", "type": [ "string", "null" ] } }, "required": [ "created_at", "kyc_status", "updated_at", "approval_date", "rejection_date", "expiration_date", "submission_date", "identity_document_type", "document_extracted_middle_name" ], "title": "ScreeningsKycDetailsGetResponsesContentApplicationJsonSchemaData", "type": "object" }, "ScreeningsKycDetailsGetResponsesContentApplicationJsonSchemaDataIdentityDocumentType": { "description": "The type of identity document used for verification", "enum": [ "DRIVING_LICENSE", "PASSPORT", "GOVERNMENT_ID", "SELFIE_WITH_ID", "PROOF_OF_RESIDENCY", "OTHER" ], "title": "ScreeningsKycDetailsGetResponsesContentApplicationJsonSchemaDataIdentityDocumentType", "type": "string" }, "ScreeningsKycDetailsGetResponsesContentApplicationJsonSchemaDataKycStatus": { "description": "The current KYC verification status of the profile", "enum": [ "APPROVED", "REJECTED", "PENDING_REVIEW", "EXPIRED", "EXPIRING_SOON", "NOT_SUBMITTED", "NOT_REQUESTED" ], "title": "ScreeningsKycDetailsGetResponsesContentApplicationJsonSchemaDataKycStatus", "type": "string" }, "ScreeningsKycDetailsGetResponsesContentApplicationJsonSchemaErrors": { "oneOf": [ { "type": "string" }, { "additionalProperties": { "description": "Any type" }, "type": "object" }, { "$ref": "#/components/schemas/ScreeningsKycDetailsGetResponsesContentApplicationJsonSchemaErrors2" } ], "title": "ScreeningsKycDetailsGetResponsesContentApplicationJsonSchemaErrors" }, "ScreeningsKycDetailsGetResponsesContentApplicationJsonSchemaErrors2": { "items": { "$ref": "#/components/schemas/ScreeningsKycDetailsGetResponsesContentApplicationJsonSchemaErrorsOneOf2Items" }, "title": "ScreeningsKycDetailsGetResponsesContentApplicationJsonSchemaErrors2", "type": "array" }, "ScreeningsKycDetailsGetResponsesContentApplicationJsonSchemaErrorsItems": { "properties": { "code": { "description": "Machine-readable error code", "type": "string" }, "message": { "description": "Human-readable explanation of the error", "type": "string" } }, "title": "ScreeningsKycDetailsGetResponsesContentApplicationJsonSchemaErrorsItems", "type": "object" }, "ScreeningsKycDetailsGetResponsesContentApplicationJsonSchemaErrorsOneOf2Items": { "oneOf": [ { "type": "string" }, { "$ref": "#/components/schemas/ScreeningsKycDetailsGetResponsesContentApplicationJsonSchemaErrorsOneOf2Items1" } ], "title": "ScreeningsKycDetailsGetResponsesContentApplicationJsonSchemaErrorsOneOf2Items" }, "ScreeningsKycDetailsGetResponsesContentApplicationJsonSchemaErrorsOneOf2Items1": { "properties": { "code": { "description": "Machine-readable error code", "type": "string" }, "message": { "description": "Human-readable explanation of the error", "type": "string" } }, "title": "ScreeningsKycDetailsGetResponsesContentApplicationJsonSchemaErrorsOneOf2Items1", "type": "object" }, "ScreeningsKycExternalPostRequestBodyContentMultipartFormDataSchemaData": { "properties": { "back": { "description": "Back side file of the KYC document. Required when kyc_document.type equals to either 'driving_license' or 'government_id'. Not needed when equals to 'passport'. Optional when type is 'other'", "format": "binary", "type": "string" }, "date_of_birth": { "description": "Worker's date of birth (YYYY-MM-DD)", "format": "date", "type": "string" }, "first_name": { "description": "Worker's first name", "maxLength": 100, "type": "string" }, "front": { "description": "Front side file of the KYC document", "format": "binary", "type": "string" }, "kyc_document": { "$ref": "#/components/schemas/ScreeningsKycExternalPostRequestBodyContentMultipartFormDataSchemaDataKycDocument" }, "last_name": { "description": "Worker's last name", "maxLength": 100, "type": "string" }, "middle_name": { "description": "Worker's middle name (if available)", "maxLength": 100, "type": [ "string", "null" ] }, "screening_status": { "$ref": "#/components/schemas/ScreeningsKycExternalPostRequestBodyContentMultipartFormDataSchemaDataScreeningStatus", "description": "The result of the screening process" }, "screening_type": { "$ref": "#/components/schemas/ScreeningsKycExternalPostRequestBodyContentMultipartFormDataSchemaDataScreeningType", "description": "Tells your API whether the identity verification check should be performed automatically (“live”) or via human review (“manual”)" }, "selfie_with_id": { "description": "Selfie file for identity verification", "format": "binary", "type": "string" } }, "required": [ "front", "last_name", "first_name", "kyc_document", "date_of_birth", "screening_type", "selfie_with_id", "screening_status" ], "title": "ScreeningsKycExternalPostRequestBodyContentMultipartFormDataSchemaData", "type": "object" }, "ScreeningsKycExternalPostRequestBodyContentMultipartFormDataSchemaDataKycDocument": { "properties": { "document_name": { "description": "Name of the document when type is 'other'", "maxLength": 100, "type": "string" }, "expiration_date": { "description": "Expiry date of the document (YYYY-MM-DD)", "format": "date", "type": "string" }, "id_number": { "description": "Document identification number", "maxLength": 50, "type": "string" }, "issuance_country": { "description": "Country where the document was issued (ISO 3166‑1 alpha‑2)", "maxLength": 2, "minLength": 2, "type": "string" }, "issuance_date": { "description": "Date when the document was issued (YYYY-MM-DD)", "format": "date", "type": "string" }, "type": { "$ref": "#/components/schemas/ScreeningsKycExternalPostRequestBodyContentMultipartFormDataSchemaDataKycDocumentType", "description": "Type of KYC document (e.g., passport, driver's license)" } }, "required": [ "type", "id_number", "issuance_country" ], "title": "ScreeningsKycExternalPostRequestBodyContentMultipartFormDataSchemaDataKycDocument", "type": "object" }, "ScreeningsKycExternalPostRequestBodyContentMultipartFormDataSchemaDataKycDocumentType": { "description": "Type of KYC document (e.g., passport, driver's license)", "enum": [ "passport", "driving_license", "government_id", "other" ], "title": "ScreeningsKycExternalPostRequestBodyContentMultipartFormDataSchemaDataKycDocumentType", "type": "string" }, "ScreeningsKycExternalPostRequestBodyContentMultipartFormDataSchemaDataScreeningStatus": { "description": "The result of the screening process", "enum": [ "approved", "rejected" ], "title": "ScreeningsKycExternalPostRequestBodyContentMultipartFormDataSchemaDataScreeningStatus", "type": "string" }, "ScreeningsKycExternalPostRequestBodyContentMultipartFormDataSchemaDataScreeningType": { "description": "Tells your API whether the identity verification check should be performed automatically (“live”) or via human review (“manual”)", "enum": [ "live", "manual" ], "title": "ScreeningsKycExternalPostRequestBodyContentMultipartFormDataSchemaDataScreeningType", "type": "string" }, "ScreeningsKycExternalPostResponsesContentApplicationJsonSchemaData": { "properties": { "created_at": { "description": "Timestamp when screening was successfully received and processed (ISO 8601)", "format": "date-time", "type": "string" }, "request_id": { "description": "Request identifier for this KYC submission", "type": "string" } }, "required": [ "created_at", "request_id" ], "title": "ScreeningsKycExternalPostResponsesContentApplicationJsonSchemaData", "type": "object" }, "ScreeningsKycExternalPostResponsesContentApplicationJsonSchemaErrorsItems": { "properties": { "message": { "description": "A description of the returned error", "type": "string" }, "path": { "description": "The JSON path where input validation failed", "type": "string" } }, "title": "ScreeningsKycExternalPostResponsesContentApplicationJsonSchemaErrorsItems", "type": "object" }, "ScreeningsKycExternalPostResponsesContentApplicationJsonSchemaRequest": { "properties": { "api_req_id": { "description": "The request ID of the failed request", "type": "string" }, "code": { "description": "The code of the source handler which produced the returned error", "format": "double", "type": "number" }, "docs": { "description": "A link to the official documentation for the requested endpoint resource", "type": "string" }, "method": { "description": "The HTTP method of the failed request", "type": "string" }, "source": { "description": "The source handler which produced the returned error", "type": "string" }, "status": { "description": "The status code of the response", "format": "double", "type": "number" }, "url": { "description": "The relative URL of the failed request", "type": "string" } }, "title": "ScreeningsKycExternalPostResponsesContentApplicationJsonSchemaRequest", "type": "object" }, "ScreeningsManualVerificationPostRequestBodyContentMultipartFormDataSchemaDocumentType": { "description": "The type of document to be verified", "enum": [ "PASSPORT", "DRIVING_LICENSE", "GOVERNMENT_ID", "OTHER" ], "title": "ScreeningsManualVerificationPostRequestBodyContentMultipartFormDataSchemaDocumentType", "type": "string" }, "ScreeningsManualVerificationPostRequestBodyContentMultipartFormDataSchemaOperationType": { "description": "The type of KYC operation to perform", "enum": [ "IDENTITY_RESUBMISSION_KYC", "IDENTITY_VERIFICATION_KYC", "NAME_CHANGE_KYC" ], "title": "ScreeningsManualVerificationPostRequestBodyContentMultipartFormDataSchemaOperationType", "type": "string" }, "ScreeningsManualVerificationPostResponsesContentApplicationJsonSchemaData": { "properties": { "created_at": { "description": "Timestamp when screening was successfully received and processed (ISO 8601)", "format": "date-time", "type": "string" }, "request_id": { "description": "Unique request identifier", "type": "string" } }, "required": [ "created_at", "request_id" ], "title": "ScreeningsManualVerificationPostResponsesContentApplicationJsonSchemaData", "type": "object" }, "ScreeningsVerificationMethodGetParametersDocumentType": { "enum": [ "passport", "government_id", "driving_license", "other" ], "title": "ScreeningsVerificationMethodGetParametersDocumentType", "type": "string" }, "ScreeningsVerificationMethodGetResponsesContentApplicationJsonSchemaData": { "properties": { "verification_method": { "description": "The supported method for KYC", "type": "string" } }, "required": [ "verification_method" ], "title": "ScreeningsVerificationMethodGetResponsesContentApplicationJsonSchemaData", "type": "object" }, "Screenings_submitExternalKyc-v2026-01-01_Response_201": { "properties": { "data": { "$ref": "#/components/schemas/ScreeningsKycExternalPostResponsesContentApplicationJsonSchemaData" } }, "required": [ "data" ], "title": "Screenings_submitExternalKyc-v2026-01-01_Response_201", "type": "object" }, "SetGpContractBankSettings-v2026-09-17RequestBadRequestError": { "properties": { "errors": { "items": { "$ref": "#/components/schemas/GpContractsContractIdBanksSettingsPatchResponsesContentApplicationJsonSchemaErrorsItems" }, "type": "array" } }, "title": "SetGpContractBankSettings-v2026-09-17RequestBadRequestError", "type": "object" }, "SignAContract-v2026-01-01RequestConflictError": { "properties": { "errors": { "items": { "$ref": "#/components/schemas/EorWorkersContractsContractIdSignaturesPostResponsesContentApplicationJsonSchemaErrorsItems" }, "type": "array" }, "request": { "$ref": "#/components/schemas/EorWorkersContractsContractIdSignaturesPostResponsesContentApplicationJsonSchemaRequest" } }, "title": "SignAContract-v2026-01-01RequestConflictError", "type": "object" }, "SignAContractAmendmentEmployee-v2026-01-01RequestBadRequestError": { "properties": { "errors": { "items": { "$ref": "#/components/schemas/EorContractsContractIdAmendmentsAmendmentIdSignPostResponsesContentApplicationJsonSchemaErrorsItems" }, "type": "array" } }, "required": [ "errors" ], "title": "SignAContractAmendmentEmployee-v2026-01-01RequestBadRequestError", "type": "object" }, "SignAContractAmendmentEmployee-v2026-01-01RequestInternalServerError": { "properties": { "errors": { "items": { "$ref": "#/components/schemas/EorContractsContractIdAmendmentsAmendmentIdSignPostResponsesContentApplicationJsonSchemaErrorsItems" }, "type": "array" } }, "required": [ "errors" ], "title": "SignAContractAmendmentEmployee-v2026-01-01RequestInternalServerError", "type": "object" }, "SignAContractAmendmentEmployee-v2026-01-01RequestNotFoundError": { "properties": { "errors": { "items": { "$ref": "#/components/schemas/EorContractsContractIdAmendmentsAmendmentIdSignPostResponsesContentApplicationJsonSchemaErrorsItems" }, "type": "array" } }, "required": [ "errors" ], "title": "SignAContractAmendmentEmployee-v2026-01-01RequestNotFoundError", "type": "object" }, "SignAmendment-v2026-01-01RequestBadRequestError": { "properties": { "errors": { "items": { "$ref": "#/components/schemas/WorkersAmendmentsAmendmentIdSignPostResponsesContentApplicationJsonSchemaErrorsItems" }, "type": "array" }, "request": { "$ref": "#/components/schemas/WorkersAmendmentsAmendmentIdSignPostResponsesContentApplicationJsonSchemaRequest" } }, "title": "SignAmendment-v2026-01-01RequestBadRequestError", "type": "object" }, "SignEorContractDocument-v2026-01-01RequestBadRequestError": { "properties": { "errors": { "items": { "$ref": "#/components/schemas/EorContractsContractIdDocumentsTypeSignPostResponsesContentApplicationJsonSchemaErrorsItems" }, "type": "array" }, "request": { "$ref": "#/components/schemas/EorContractsContractIdDocumentsTypeSignPostResponsesContentApplicationJsonSchemaRequest" } }, "title": "SignEorContractDocument-v2026-01-01RequestBadRequestError", "type": "object" }, "SignGlobalPayrollAmendment-v2026-09-29RequestBadRequestError": { "properties": { "errors": { "items": { "$ref": "#/components/schemas/ContractsContractIdAmendmentsAmendmentIdSignPostResponsesContentApplicationJsonSchemaErrorsItems" }, "type": "array" } }, "title": "SignGlobalPayrollAmendment-v2026-09-29RequestBadRequestError", "type": "object" }, "SignGlobalPayrollAmendment-v2026-09-29RequestInternalServerError": { "properties": { "errors": { "items": { "$ref": "#/components/schemas/ContractsContractIdAmendmentsAmendmentIdSignPostResponsesContentApplicationJsonSchemaErrorsItems" }, "type": "array" } }, "title": "SignGlobalPayrollAmendment-v2026-09-29RequestInternalServerError", "type": "object" }, "SignGlobalPayrollAmendment-v2026-09-29RequestNotFoundError": { "properties": { "errors": { "items": { "$ref": "#/components/schemas/ContractsContractIdAmendmentsAmendmentIdSignPostResponsesContentApplicationJsonSchemaErrorsItems" }, "type": "array" } }, "title": "SignGlobalPayrollAmendment-v2026-09-29RequestNotFoundError", "type": "object" }, "SignResignationLetter-v2026-01-01RequestBadRequestError": { "properties": { "errors": { "items": { "$ref": "#/components/schemas/EorWorkersContractsContractIdOffboardingResignationLetterSignPostResponsesContentApplicationJsonSchemaErrorsItems" }, "type": "array" } }, "title": "SignResignationLetter-v2026-01-01RequestBadRequestError", "type": "object" }, "SignResignationLetter-v2026-01-01RequestForbiddenError": { "properties": { "errors": { "items": { "$ref": "#/components/schemas/EorWorkersContractsContractIdOffboardingResignationLetterSignPostResponsesContentApplicationJsonSchemaErrorsItems" }, "type": "array" } }, "title": "SignResignationLetter-v2026-01-01RequestForbiddenError", "type": "object" }, "SignResignationLetter-v2026-01-01RequestInternalServerError": { "properties": { "errors": { "items": { "$ref": "#/components/schemas/EorWorkersContractsContractIdOffboardingResignationLetterSignPostResponsesContentApplicationJsonSchemaErrorsItems" }, "type": "array" } }, "title": "SignResignationLetter-v2026-01-01RequestInternalServerError", "type": "object" }, "SignResignationLetter-v2026-01-01RequestUnauthorizedError": { "properties": { "errors": { "items": { "$ref": "#/components/schemas/EorWorkersContractsContractIdOffboardingResignationLetterSignPostResponsesContentApplicationJsonSchemaErrorsItems" }, "type": "array" } }, "title": "SignResignationLetter-v2026-01-01RequestUnauthorizedError", "type": "object" }, "SignWorkerContract-v2026-01-01RequestBadRequestError": { "properties": { "errors": { "items": { "$ref": "#/components/schemas/WorkersContractsContractIdSignaturesPostResponsesContentApplicationJsonSchemaErrorsItems" }, "type": "array" } }, "title": "SignWorkerContract-v2026-01-01RequestBadRequestError", "type": "object" }, "SignWorkerContract-v2026-01-01RequestInternalServerError": { "properties": { "errors": { "items": { "$ref": "#/components/schemas/WorkersContractsContractIdSignaturesPostResponsesContentApplicationJsonSchemaErrorsItems" }, "type": "array" } }, "title": "SignWorkerContract-v2026-01-01RequestInternalServerError", "type": "object" }, "SubmitEmployeeResignationPtoReview-v2026-01-01RequestBadRequestError": { "properties": { "errors": { "items": { "$ref": "#/components/schemas/EorContractsContractIdOffboardingResignationsReviewPtoPostResponsesContentApplicationJsonSchemaErrorsItems" }, "type": "array" } }, "title": "SubmitEmployeeResignationPtoReview-v2026-01-01RequestBadRequestError", "type": "object" }, "SubmitEmployeeResignationPtoReview-v2026-01-01RequestForbiddenError": { "properties": { "errors": { "items": { "$ref": "#/components/schemas/EorContractsContractIdOffboardingResignationsReviewPtoPostResponsesContentApplicationJsonSchemaErrorsItems" }, "type": "array" } }, "title": "SubmitEmployeeResignationPtoReview-v2026-01-01RequestForbiddenError", "type": "object" }, "SubmitEmployeeResignationPtoReview-v2026-01-01RequestInternalServerError": { "properties": { "errors": { "items": { "$ref": "#/components/schemas/EorContractsContractIdOffboardingResignationsReviewPtoPostResponsesContentApplicationJsonSchemaErrorsItems" }, "type": "array" } }, "title": "SubmitEmployeeResignationPtoReview-v2026-01-01RequestInternalServerError", "type": "object" }, "SubmitEmployeeResignationPtoReview-v2026-01-01RequestUnauthorizedError": { "properties": { "errors": { "items": { "$ref": "#/components/schemas/EorContractsContractIdOffboardingResignationsReviewPtoPostResponsesContentApplicationJsonSchemaErrorsItems" }, "type": "array" } }, "title": "SubmitEmployeeResignationPtoReview-v2026-01-01RequestUnauthorizedError", "type": "object" }, "SubmitEmployeeSignOffReviewForOffboardingDocuments-v2026-01-01RequestBadRequestError": { "properties": { "errors": { "items": { "$ref": "#/components/schemas/EorContractsContractIdOffboardingReviewEmployeeSignOffsPostResponsesContentApplicationJsonSchemaErrorsItems" }, "type": "array" } }, "title": "SubmitEmployeeSignOffReviewForOffboardingDocuments-v2026-01-01RequestBadRequestError", "type": "object" }, "SubmitEmployeeSignOffReviewForOffboardingDocuments-v2026-01-01RequestForbiddenError": { "properties": { "errors": { "items": { "$ref": "#/components/schemas/EorContractsContractIdOffboardingReviewEmployeeSignOffsPostResponsesContentApplicationJsonSchemaErrorsItems" }, "type": "array" } }, "title": "SubmitEmployeeSignOffReviewForOffboardingDocuments-v2026-01-01RequestForbiddenError", "type": "object" }, "SubmitEmployeeSignOffReviewForOffboardingDocuments-v2026-01-01RequestInternalServerError": { "properties": { "errors": { "items": { "$ref": "#/components/schemas/EorContractsContractIdOffboardingReviewEmployeeSignOffsPostResponsesContentApplicationJsonSchemaErrorsItems" }, "type": "array" } }, "title": "SubmitEmployeeSignOffReviewForOffboardingDocuments-v2026-01-01RequestInternalServerError", "type": "object" }, "SubmitEmployeeSignOffReviewForOffboardingDocuments-v2026-01-01RequestUnauthorizedError": { "properties": { "errors": { "items": { "$ref": "#/components/schemas/EorContractsContractIdOffboardingReviewEmployeeSignOffsPostResponsesContentApplicationJsonSchemaErrorsItems" }, "type": "array" } }, "title": "SubmitEmployeeSignOffReviewForOffboardingDocuments-v2026-01-01RequestUnauthorizedError", "type": "object" }, "SubmitEorWorkerResignation-v2026-01-01RequestBadRequestError": { "properties": { "errors": { "items": { "$ref": "#/components/schemas/EorWorkersContractsContractIdOffboardingPostResponsesContentApplicationJsonSchemaErrorsItems" }, "type": "array" } }, "title": "SubmitEorWorkerResignation-v2026-01-01RequestBadRequestError", "type": "object" }, "SubmitEorWorkerResignation-v2026-01-01RequestForbiddenError": { "properties": { "errors": { "items": { "$ref": "#/components/schemas/EorWorkersContractsContractIdOffboardingPostResponsesContentApplicationJsonSchemaErrorsItems" }, "type": "array" } }, "title": "SubmitEorWorkerResignation-v2026-01-01RequestForbiddenError", "type": "object" }, "SubmitEorWorkerResignation-v2026-01-01RequestInternalServerError": { "properties": { "errors": { "items": { "$ref": "#/components/schemas/EorWorkersContractsContractIdOffboardingPostResponsesContentApplicationJsonSchemaErrorsItems" }, "type": "array" } }, "title": "SubmitEorWorkerResignation-v2026-01-01RequestInternalServerError", "type": "object" }, "SubmitEorWorkerResignation-v2026-01-01RequestUnauthorizedError": { "properties": { "errors": { "items": { "$ref": "#/components/schemas/EorWorkersContractsContractIdOffboardingPostResponsesContentApplicationJsonSchemaErrorsItems" }, "type": "array" } }, "title": "SubmitEorWorkerResignation-v2026-01-01RequestUnauthorizedError", "type": "object" }, "SubmitExternalKyc-v2026-01-01RequestBadRequestError": { "properties": { "errors": { "items": { "$ref": "#/components/schemas/ScreeningsKycExternalPostResponsesContentApplicationJsonSchemaErrorsItems" }, "type": "array" }, "request": { "$ref": "#/components/schemas/ScreeningsKycExternalPostResponsesContentApplicationJsonSchemaRequest" } }, "title": "SubmitExternalKyc-v2026-01-01RequestBadRequestError", "type": "object" }, "SubmitLegalEntityKyb-v2026-10-12RequestBadRequestError": { "properties": { "errors": { "items": { "$ref": "#/components/schemas/LegalEntitiesLegalEntityIdKybPostResponsesContentApplicationJsonSchemaErrorsItems" }, "type": "array" } }, "required": [ "errors" ], "title": "SubmitLegalEntityKyb-v2026-10-12RequestBadRequestError", "type": "object" }, "SubmitLegalEntityKyb-v2026-10-12RequestConflictError": { "properties": { "errors": { "items": { "$ref": "#/components/schemas/LegalEntitiesLegalEntityIdKybPostResponsesContentApplicationJsonSchemaErrorsItems" }, "type": "array" } }, "required": [ "errors" ], "title": "SubmitLegalEntityKyb-v2026-10-12RequestConflictError", "type": "object" }, "SubmitLegalEntityKyb-v2026-10-12RequestForbiddenError": { "properties": { "errors": { "items": { "$ref": "#/components/schemas/LegalEntitiesLegalEntityIdKybPostResponsesContentApplicationJsonSchemaErrorsItems" }, "type": "array" } }, "required": [ "errors" ], "title": "SubmitLegalEntityKyb-v2026-10-12RequestForbiddenError", "type": "object" }, "SubmitLegalEntityKyb-v2026-10-12RequestNotFoundError": { "properties": { "errors": { "items": { "$ref": "#/components/schemas/LegalEntitiesLegalEntityIdKybPostResponsesContentApplicationJsonSchemaErrorsItems" }, "type": "array" } }, "required": [ "errors" ], "title": "SubmitLegalEntityKyb-v2026-10-12RequestNotFoundError", "type": "object" }, "SubmitLegalEntityKyb-v2026-10-12RequestServiceUnavailableError": { "properties": { "errors": { "items": { "$ref": "#/components/schemas/LegalEntitiesLegalEntityIdKybPostResponsesContentApplicationJsonSchemaErrorsItems" }, "type": "array" } }, "required": [ "errors" ], "title": "SubmitLegalEntityKyb-v2026-10-12RequestServiceUnavailableError", "type": "object" }, "SubmitLegalEntityKyb-v2026-10-12RequestTooManyRequestsError": { "properties": { "errors": { "items": { "$ref": "#/components/schemas/LegalEntitiesLegalEntityIdKybPostResponsesContentApplicationJsonSchemaErrorsItems" }, "type": "array" } }, "required": [ "errors" ], "title": "SubmitLegalEntityKyb-v2026-10-12RequestTooManyRequestsError", "type": "object" }, "SubmitLegalEntityKyb-v2026-10-12RequestUnauthorizedError": { "properties": { "errors": { "items": { "$ref": "#/components/schemas/LegalEntitiesLegalEntityIdKybPostResponsesContentApplicationJsonSchemaErrorsItems" }, "type": "array" } }, "required": [ "errors" ], "title": "SubmitLegalEntityKyb-v2026-10-12RequestUnauthorizedError", "type": "object" }, "SubmitLegalEntityKyb-v2026-10-12RequestUnprocessableEntityError": { "properties": { "errors": { "items": { "$ref": "#/components/schemas/LegalEntitiesLegalEntityIdKybPostResponsesContentApplicationJsonSchemaErrorsItems" }, "type": "array" } }, "required": [ "errors" ], "title": "SubmitLegalEntityKyb-v2026-10-12RequestUnprocessableEntityError", "type": "object" }, "SubmitLegalEntityRegistrationDocuments-v2026-08-17RequestBadRequestError": { "properties": { "errors": { "description": "List of errors that occurred while processing the request.", "items": { "$ref": "#/components/schemas/LegalEntitiesLegalEntityIdRegistrationDocumentsPostResponsesContentApplicationJsonSchemaErrorsItems" }, "type": "array" } }, "required": [ "errors" ], "title": "SubmitLegalEntityRegistrationDocuments-v2026-08-17RequestBadRequestError", "type": "object" }, "SubmitLegalEntityRegistrationDocuments-v2026-08-17RequestForbiddenError": { "properties": { "errors": { "description": "List of errors that occurred while processing the request.", "items": { "$ref": "#/components/schemas/LegalEntitiesLegalEntityIdRegistrationDocumentsPostResponsesContentApplicationJsonSchemaErrorsItems" }, "type": "array" } }, "required": [ "errors" ], "title": "SubmitLegalEntityRegistrationDocuments-v2026-08-17RequestForbiddenError", "type": "object" }, "SubmitLegalEntityRegistrationDocuments-v2026-08-17RequestNotFoundError": { "properties": { "errors": { "description": "List of errors that occurred while processing the request.", "items": { "$ref": "#/components/schemas/LegalEntitiesLegalEntityIdRegistrationDocumentsPostResponsesContentApplicationJsonSchemaErrorsItems" }, "type": "array" } }, "required": [ "errors" ], "title": "SubmitLegalEntityRegistrationDocuments-v2026-08-17RequestNotFoundError", "type": "object" }, "SubmitLegalEntityRegistrationDocuments-v2026-08-17RequestUnauthorizedError": { "properties": { "errors": { "description": "List of errors that occurred while processing the request.", "items": { "$ref": "#/components/schemas/LegalEntitiesLegalEntityIdRegistrationDocumentsPostResponsesContentApplicationJsonSchemaErrorsItems" }, "type": "array" } }, "required": [ "errors" ], "title": "SubmitLegalEntityRegistrationDocuments-v2026-08-17RequestUnauthorizedError", "type": "object" }, "SubmitLegalEntityRegistrationDocuments-v2026-08-17RequestUnprocessableEntityError": { "properties": { "errors": { "items": { "$ref": "#/components/schemas/LegalEntitiesLegalEntityIdRegistrationDocumentsPostResponsesContentApplicationJsonSchemaErrorsItems" }, "type": "array" } }, "required": [ "errors" ], "title": "SubmitLegalEntityRegistrationDocuments-v2026-08-17RequestUnprocessableEntityError", "type": "object" }, "SubmitOnDemandPayroll-v2026-07-17RequestBadRequestError": { "properties": { "errors": { "description": "List of errors.", "items": { "$ref": "#/components/schemas/OnDemandPayrollOdpIdSubmitPostResponsesContentApplicationJsonSchemaErrorsItems" }, "type": "array" } }, "required": [ "errors" ], "title": "SubmitOnDemandPayroll-v2026-07-17RequestBadRequestError", "type": "object" }, "SubmitOnDemandPayroll-v2026-07-17RequestForbiddenError": { "properties": { "errors": { "description": "List of errors.", "items": { "$ref": "#/components/schemas/OnDemandPayrollOdpIdSubmitPostResponsesContentApplicationJsonSchemaErrorsItems" }, "type": "array" } }, "required": [ "errors" ], "title": "SubmitOnDemandPayroll-v2026-07-17RequestForbiddenError", "type": "object" }, "SubmitOnDemandPayroll-v2026-07-17RequestNotFoundError": { "properties": { "errors": { "description": "List of errors.", "items": { "$ref": "#/components/schemas/OnDemandPayrollOdpIdSubmitPostResponsesContentApplicationJsonSchemaErrorsItems" }, "type": "array" } }, "required": [ "errors" ], "title": "SubmitOnDemandPayroll-v2026-07-17RequestNotFoundError", "type": "object" }, "SubmitOnDemandPayroll-v2026-07-17RequestUnauthorizedError": { "properties": { "errors": { "description": "List of errors.", "items": { "$ref": "#/components/schemas/OnDemandPayrollOdpIdSubmitPostResponsesContentApplicationJsonSchemaErrorsItems" }, "type": "array" } }, "required": [ "errors" ], "title": "SubmitOnDemandPayroll-v2026-07-17RequestUnauthorizedError", "type": "object" }, "SubmitPayrollMigrationImport-v2026-09-14RequestConflictError": { "properties": { "code": { "type": "string" }, "data": { "description": "Any type" }, "defined": { "type": "boolean" }, "message": { "default": "This payroll migration import has already been submitted.", "type": "string" }, "status": { "format": "double", "type": "number" } }, "required": [ "code", "status", "defined", "message" ], "title": "SubmitPayrollMigrationImport-v2026-09-14RequestConflictError", "type": "object" }, "SubmitPayrollMigrationImport-v2026-09-14RequestForbiddenError": { "properties": { "code": { "type": "string" }, "data": { "description": "Any type" }, "defined": { "type": "boolean" }, "message": { "default": "The caller is not authorized to act on this legal entity.", "type": "string" }, "status": { "format": "double", "type": "number" } }, "required": [ "code", "status", "defined", "message" ], "title": "SubmitPayrollMigrationImport-v2026-09-14RequestForbiddenError", "type": "object" }, "SubmitPayrollMigrationImport-v2026-09-14RequestInternalServerError": { "properties": { "code": { "type": "string" }, "data": { "description": "Any type" }, "defined": { "type": "boolean" }, "message": { "default": "Internal server error.", "type": "string" }, "status": { "format": "double", "type": "number" } }, "required": [ "code", "status", "defined", "message" ], "title": "SubmitPayrollMigrationImport-v2026-09-14RequestInternalServerError", "type": "object" }, "SubmitPayrollMigrationImport-v2026-09-14RequestNotFoundError": { "properties": { "code": { "type": "string" }, "data": { "description": "Any type" }, "defined": { "type": "boolean" }, "message": { "default": "Payroll migration import not found.", "type": "string" }, "status": { "format": "double", "type": "number" } }, "required": [ "code", "status", "defined", "message" ], "title": "SubmitPayrollMigrationImport-v2026-09-14RequestNotFoundError", "type": "object" }, "SubmitPayrollMigrationImport-v2026-09-14RequestUnauthorizedError": { "properties": { "code": { "type": "string" }, "data": { "description": "Any type" }, "defined": { "type": "boolean" }, "message": { "default": "The request carries no caller identity the gateway could resolve.", "type": "string" }, "status": { "format": "double", "type": "number" } }, "required": [ "code", "status", "defined", "message" ], "title": "SubmitPayrollMigrationImport-v2026-09-14RequestUnauthorizedError", "type": "object" }, "SubmitProjectAssignmentCheckinQuestionnaireData-v2026-01-01RequestBadRequestError": { "properties": { "errors": { "items": { "$ref": "#/components/schemas/EorContractsContractIdProjectAssignmentCheckinPostResponsesContentApplicationJsonSchemaErrorsItems" }, "type": "array" } }, "title": "SubmitProjectAssignmentCheckinQuestionnaireData-v2026-01-01RequestBadRequestError", "type": "object" }, "SubmitProjectAssignmentCheckinQuestionnaireData-v2026-01-01RequestConflictError": { "properties": { "errors": { "items": { "$ref": "#/components/schemas/EorContractsContractIdProjectAssignmentCheckinPostResponsesContentApplicationJsonSchemaErrorsItems" }, "type": "array" } }, "required": [ "errors" ], "title": "SubmitProjectAssignmentCheckinQuestionnaireData-v2026-01-01RequestConflictError", "type": "object" }, "SubmitProjectAssignmentCheckinQuestionnaireData-v2026-01-01RequestInternalServerError": { "properties": { "errors": { "items": { "$ref": "#/components/schemas/EorContractsContractIdProjectAssignmentCheckinPostResponsesContentApplicationJsonSchemaErrorsItems" }, "type": "array" } }, "title": "SubmitProjectAssignmentCheckinQuestionnaireData-v2026-01-01RequestInternalServerError", "type": "object" }, "SubmitWorkerContractComplianceDocumentFiles-v2026-08-25RequestBadRequestError": { "properties": { "errors": { "description": "Errors that occurred while processing the request.", "items": { "$ref": "#/components/schemas/WorkersContractsContractIdComplianceDocumentsDocumentIdPostResponsesContentApplicationJsonSchemaErrorsItems" }, "type": "array" } }, "required": [ "errors" ], "title": "SubmitWorkerContractComplianceDocumentFiles-v2026-08-25RequestBadRequestError", "type": "object" }, "SubmitWorkerContractComplianceDocumentFiles-v2026-08-25RequestForbiddenError": { "properties": { "errors": { "description": "Errors that occurred while processing the request.", "items": { "$ref": "#/components/schemas/WorkersContractsContractIdComplianceDocumentsDocumentIdPostResponsesContentApplicationJsonSchemaErrorsItems" }, "type": "array" } }, "required": [ "errors" ], "title": "SubmitWorkerContractComplianceDocumentFiles-v2026-08-25RequestForbiddenError", "type": "object" }, "SubmitWorkerContractComplianceDocumentFiles-v2026-08-25RequestNotFoundError": { "properties": { "errors": { "description": "Errors that occurred while processing the request.", "items": { "$ref": "#/components/schemas/WorkersContractsContractIdComplianceDocumentsDocumentIdPostResponsesContentApplicationJsonSchemaErrorsItems" }, "type": "array" } }, "required": [ "errors" ], "title": "SubmitWorkerContractComplianceDocumentFiles-v2026-08-25RequestNotFoundError", "type": "object" }, "SubmitWorkerContractComplianceDocumentFiles-v2026-08-25RequestUnauthorizedError": { "properties": { "errors": { "description": "Errors that occurred while processing the request.", "items": { "$ref": "#/components/schemas/WorkersContractsContractIdComplianceDocumentsDocumentIdPostResponsesContentApplicationJsonSchemaErrorsItems" }, "type": "array" } }, "required": [ "errors" ], "title": "SubmitWorkerContractComplianceDocumentFiles-v2026-08-25RequestUnauthorizedError", "type": "object" }, "SubmitWorkerContractComplianceDocumentFiles-v2026-08-25RequestUnprocessableEntityError": { "properties": { "errors": { "description": "Errors that occurred while processing the request.", "items": { "$ref": "#/components/schemas/WorkersContractsContractIdComplianceDocumentsDocumentIdPostResponsesContentApplicationJsonSchemaErrorsItems" }, "type": "array" } }, "required": [ "errors" ], "title": "SubmitWorkerContractComplianceDocumentFiles-v2026-08-25RequestUnprocessableEntityError", "type": "object" }, "SyncCostCentersForLegalEntity-v2026-01-01RequestBadRequestError": { "properties": { "errors": { "items": { "$ref": "#/components/schemas/LegalEntitiesLegalEntityIdCostCentersSynchronizePostResponsesContentApplicationJsonSchemaErrorsItems" }, "type": "array" }, "request": { "$ref": "#/components/schemas/LegalEntitiesLegalEntityIdCostCentersSynchronizePostResponsesContentApplicationJsonSchemaRequest" } }, "title": "SyncCostCentersForLegalEntity-v2026-01-01RequestBadRequestError", "type": "object" }, "SyncCostCentersForLegalEntity-v2026-01-01RequestInternalServerError": { "properties": { "errors": { "items": { "$ref": "#/components/schemas/LegalEntitiesLegalEntityIdCostCentersSynchronizePostResponsesContentApplicationJsonSchemaErrorsItems" }, "type": "array" }, "request": { "$ref": "#/components/schemas/LegalEntitiesLegalEntityIdCostCentersSynchronizePostResponsesContentApplicationJsonSchemaRequest" } }, "title": "SyncCostCentersForLegalEntity-v2026-01-01RequestInternalServerError", "type": "object" }, "Talent_listRequisitions-v2026-09-10_Response_200": { "properties": { "data": { "description": "The job requests on the requested page.", "items": { "$ref": "#/components/schemas/VmsRequisitionsGetResponsesContentApplicationJsonSchemaDataItems" }, "type": "array" }, "page": { "$ref": "#/components/schemas/VmsRequisitionsGetResponsesContentApplicationJsonSchemaPage", "description": "Pagination metadata." } }, "required": [ "data", "page" ], "title": "Talent_listRequisitions-v2026-09-10_Response_200", "type": "object" }, "TasksTaskIdPatchRequestBodyContentApplicationJsonSchemaData": { "properties": { "amount": { "description": "The amount to be associated with the task, in the appropriate currency.", "type": [ "string", "null" ] }, "description": { "description": "A description of the task.", "type": [ "string", "null" ] }, "hourly_report_preset_id": { "description": "Public ID of the hourly report preset, if applicable.", "type": [ "string", "null" ] } }, "title": "TasksTaskIdPatchRequestBodyContentApplicationJsonSchemaData", "type": "object" }, "TasksTaskIdPatchResponsesContentApplicationJsonSchemaData": { "properties": { "created_at": { "description": "Timestamp indicating when the task was last updated.", "format": "date-time", "type": "string" }, "updated_at": { "description": "Timestamp indicating when the task was last updated.", "format": "date-time", "type": "string" } }, "required": [ "created_at", "updated_at" ], "title": "TasksTaskIdPatchResponsesContentApplicationJsonSchemaData", "type": "object" }, "TasksTaskIdPatchResponsesContentApplicationJsonSchemaErrorsItems": { "properties": { "code": { "description": "Machine-readable error code", "type": "string" }, "message": { "description": "Human-readable explanation of the error", "type": "string" } }, "title": "TasksTaskIdPatchResponsesContentApplicationJsonSchemaErrorsItems", "type": "object" }, "Tasks_reviewMultipleTasks-v2026-01-01_Response_201": { "properties": { "data": { "$ref": "#/components/schemas/ContractsContractIdTasksManyReviewsPostResponsesContentApplicationJsonSchemaData" } }, "required": [ "data" ], "title": "Tasks_reviewMultipleTasks-v2026-01-01_Response_201", "type": "object" }, "Tasks_updateTaskById-v2026-01-01_Response_200": { "properties": { "data": { "$ref": "#/components/schemas/TasksTaskIdPatchResponsesContentApplicationJsonSchemaData" } }, "title": "Tasks_updateTaskById-v2026-01-01_Response_200", "type": "object" }, "TeamsGetResponsesContentApplicationJsonSchemaDataItems": { "properties": { "id": { "description": "The unique identifier of the team within the organization.", "format": "uuid", "type": "string" }, "name": { "description": "The name of the team.", "minLength": 1, "type": "string" } }, "required": [ "id", "name" ], "title": "TeamsGetResponsesContentApplicationJsonSchemaDataItems", "type": "object" }, "TerminateContract-v2026-01-01RequestBadRequestError": { "properties": { "errors": { "items": { "$ref": "#/components/schemas/ContractsContractIdTerminationsPostResponsesContentApplicationJsonSchemaErrorsItems" }, "type": "array" } }, "title": "TerminateContract-v2026-01-01RequestBadRequestError", "type": "object" }, "TerminateContract-v2026-01-01RequestConflictError": { "properties": { "errors": { "items": { "$ref": "#/components/schemas/ContractsContractIdTerminationsPostResponsesContentApplicationJsonSchemaErrorsItems" }, "type": "array" } }, "title": "TerminateContract-v2026-01-01RequestConflictError", "type": "object" }, "TerminateContract-v2026-01-01RequestForbiddenError": { "properties": { "errors": { "items": { "$ref": "#/components/schemas/ContractsContractIdTerminationsPostResponsesContentApplicationJsonSchemaErrorsItems" }, "type": "array" } }, "title": "TerminateContract-v2026-01-01RequestForbiddenError", "type": "object" }, "TerminateContract-v2026-01-01RequestInternalServerError": { "properties": { "errors": { "items": { "$ref": "#/components/schemas/ContractsContractIdTerminationsPostResponsesContentApplicationJsonSchemaErrorsItems" }, "type": "array" } }, "title": "TerminateContract-v2026-01-01RequestInternalServerError", "type": "object" }, "TerminateContract-v2026-01-01RequestNotFoundError": { "properties": { "errors": { "items": { "$ref": "#/components/schemas/ContractsContractIdTerminationsPostResponsesContentApplicationJsonSchemaErrorsItems" }, "type": "array" } }, "title": "TerminateContract-v2026-01-01RequestNotFoundError", "type": "object" }, "TerminateContract-v2026-01-01RequestUnauthorizedError": { "properties": { "errors": { "items": { "$ref": "#/components/schemas/ContractsContractIdTerminationsPostResponsesContentApplicationJsonSchemaErrorsItems" }, "type": "array" } }, "title": "TerminateContract-v2026-01-01RequestUnauthorizedError", "type": "object" }, "TimeOffsAttachmentsAttachmentIdDownloadGetResponsesContentApplicationJsonSchemaData": { "properties": { "url": { "description": "Presigned URL to download the attachment directly from object storage. Valid for a limited time.", "type": "string" } }, "required": [ "url" ], "title": "TimeOffsAttachmentsAttachmentIdDownloadGetResponsesContentApplicationJsonSchemaData", "type": "object" }, "TimeOffsAttachmentsAttachmentIdDownloadGetResponsesContentApplicationJsonSchemaErrorsItems": { "properties": { "code": { "type": "string" }, "message": { "type": "string" } }, "required": [ "code", "message" ], "title": "TimeOffsAttachmentsAttachmentIdDownloadGetResponsesContentApplicationJsonSchemaErrorsItems", "type": "object" }, "TimeOffsDailiesGetResponsesContentApplicationJsonSchemaDataItems": { "properties": { "holidays": { "description": "List of holidays within the date range", "items": { "$ref": "#/components/schemas/TimeOffsDailiesGetResponsesContentApplicationJsonSchemaDataItemsHolidaysItems" }, "type": "array" }, "time_off_dailies": { "description": "List of days with holiday or work status", "items": { "$ref": "#/components/schemas/TimeOffsDailiesGetResponsesContentApplicationJsonSchemaDataItemsTimeOffDailiesItems" }, "type": "array" }, "work_schedule": { "$ref": "#/components/schemas/TimeOffsDailiesGetResponsesContentApplicationJsonSchemaDataItemsWorkSchedule", "description": "Detail of working hours by week day for an HRIS profile" } }, "required": [ "holidays", "work_schedule", "time_off_dailies" ], "title": "TimeOffsDailiesGetResponsesContentApplicationJsonSchemaDataItems", "type": "object" }, "TimeOffsDailiesGetResponsesContentApplicationJsonSchemaDataItemsHolidaysItems": { "properties": { "country": { "description": "The ISO 3166-1 alpha-2 country code.", "maxLength": 2, "minLength": 2, "pattern": "^[A-Z]{2}$", "type": "string" }, "created_by_profile_id": { "description": "HRIS profile id of the creator of the holiday", "format": "double", "type": [ "number", "null" ] }, "date": { "description": "Date of the holiday", "format": "date-time", "type": "string" }, "description": { "description": "Description of the holiday", "type": [ "string", "null" ] }, "formatted_date": { "description": "Formatted 'YYYY-MM-DD' date of the holiday", "format": "date", "type": "string" }, "is_every_year": { "description": "Sets if the holiday is a recurring event", "type": "boolean" }, "is_mandatory": { "description": "Describes if the holiday is mandatory", "type": "boolean" }, "name": { "description": "Name of the holiday", "type": "string" }, "name_variations": { "description": "Alternative names or labels used to refer to this holiday", "items": { "type": "string" }, "type": "array" }, "parsed_date": { "description": "Parsed date time of the holiday", "format": "date-time", "type": "string" }, "source": { "description": "Source of creation of the holiday", "oneOf": [ { "$ref": "#/components/schemas/TimeOffsDailiesGetResponsesContentApplicationJsonSchemaDataItemsHolidaysItemsSource" }, { "type": "null" } ] }, "states": { "description": "List of states where the holiday is celebrated, if empty it is a country holiday", "items": { "type": "string" }, "type": "array" }, "type": { "$ref": "#/components/schemas/TimeOffsDailiesGetResponsesContentApplicationJsonSchemaDataItemsHolidaysItemsType", "description": "Type of the holiday" } }, "required": [ "date", "name", "type", "source", "description", "is_mandatory", "is_every_year", "formatted_date" ], "title": "TimeOffsDailiesGetResponsesContentApplicationJsonSchemaDataItemsHolidaysItems", "type": "object" }, "TimeOffsDailiesGetResponsesContentApplicationJsonSchemaDataItemsHolidaysItemsSource": { "description": "Source of creation of the holiday", "enum": [ "EXTERNAL", "DEEL", "ORGANIZATION_CUSTOM", "ORGANIZATION_OVERRIDE", "ORGANIZATION_CONVERT" ], "title": "TimeOffsDailiesGetResponsesContentApplicationJsonSchemaDataItemsHolidaysItemsSource", "type": "string" }, "TimeOffsDailiesGetResponsesContentApplicationJsonSchemaDataItemsHolidaysItemsType": { "description": "Type of the holiday", "enum": [ "MANDATORY", "OPTIONAL", "HIDDEN", "HOLIDAY", "WORKING_DAY" ], "title": "TimeOffsDailiesGetResponsesContentApplicationJsonSchemaDataItemsHolidaysItemsType", "type": "string" }, "TimeOffsDailiesGetResponsesContentApplicationJsonSchemaDataItemsTimeOffDailiesItems": { "properties": { "date": { "description": "Date of the daily", "format": "date", "type": "string" }, "time_off_daily_type": { "$ref": "#/components/schemas/TimeOffsDailiesGetResponsesContentApplicationJsonSchemaDataItemsTimeOffDailiesItemsTimeOffDailyType", "description": "Type of work status or holiday" } }, "required": [ "date", "time_off_daily_type" ], "title": "TimeOffsDailiesGetResponsesContentApplicationJsonSchemaDataItemsTimeOffDailiesItems", "type": "object" }, "TimeOffsDailiesGetResponsesContentApplicationJsonSchemaDataItemsTimeOffDailiesItemsTimeOffDailyType": { "description": "Type of work status or holiday", "enum": [ "HOLIDAY", "WORKING_DAY", "NON_WORKING_DAY" ], "title": "TimeOffsDailiesGetResponsesContentApplicationJsonSchemaDataItemsTimeOffDailiesItemsTimeOffDailyType", "type": "string" }, "TimeOffsDailiesGetResponsesContentApplicationJsonSchemaDataItemsWorkSchedule": { "description": "Detail of working hours by week day for an HRIS profile", "properties": { "hours_per_day": { "description": "Working hours per day", "format": "double", "maximum": 24, "minimum": 0, "type": "number" }, "hris_profile_id": { "description": "HRIS profile id", "format": "uuid", "type": "string" }, "work_week": { "$ref": "#/components/schemas/TimeOffsDailiesGetResponsesContentApplicationJsonSchemaDataItemsWorkScheduleWorkWeek", "description": "The work week schedule for the HRIS profile" } }, "title": "TimeOffsDailiesGetResponsesContentApplicationJsonSchemaDataItemsWorkSchedule", "type": "object" }, "TimeOffsDailiesGetResponsesContentApplicationJsonSchemaDataItemsWorkScheduleWorkWeek": { "description": "The work week schedule for the HRIS profile", "properties": { "friday": { "description": "Working hours on friday", "format": "double", "maximum": 24, "minimum": 0, "type": "number" }, "monday": { "description": "Working hours on monday", "format": "double", "maximum": 24, "minimum": 0, "type": "number" }, "saturday": { "description": "Working hours on saturday", "format": "double", "maximum": 24, "minimum": 0, "type": "number" }, "sunday": { "description": "Working hours on sunday", "format": "double", "maximum": 24, "minimum": 0, "type": "number" }, "thursday": { "description": "Working hours on thursday", "format": "double", "maximum": 24, "minimum": 0, "type": "number" }, "tuesday": { "description": "Working hours on tuesday", "format": "double", "maximum": 24, "minimum": 0, "type": "number" }, "wednesday": { "description": "Working hours on wednesday", "format": "double", "maximum": 24, "minimum": 0, "type": "number" } }, "required": [ "friday", "monday", "sunday", "tuesday", "saturday", "thursday", "wednesday" ], "title": "TimeOffsDailiesGetResponsesContentApplicationJsonSchemaDataItemsWorkScheduleWorkWeek", "type": "object" }, "TimeOffsDailiesGetResponsesContentApplicationJsonSchemaErrorsItems": { "properties": { "message": { "description": "A description of the returned error", "type": "string" }, "path": { "description": "The JSON path where input validation failed", "type": "string" } }, "title": "TimeOffsDailiesGetResponsesContentApplicationJsonSchemaErrorsItems", "type": "object" }, "TimeOffsDailiesGetResponsesContentApplicationJsonSchemaRequest": { "properties": { "api_req_id": { "description": "The request ID of the failed request", "type": "string" }, "code": { "description": "The code of the source handler which produced the returned error", "format": "double", "type": "number" }, "docs": { "description": "A link to the official documentation for the requested endpoint resource", "type": "string" }, "method": { "description": "The HTTP method of the failed request", "type": "string" }, "source": { "description": "The source handler which produced the returned error", "type": "string" }, "status": { "description": "The status code of the response", "format": "double", "type": "number" }, "url": { "description": "The relative URL of the failed request", "type": "string" } }, "title": "TimeOffsDailiesGetResponsesContentApplicationJsonSchemaRequest", "type": "object" }, "TimeOffsGetParametersPolicyTypeNamesSchemaItems": { "enum": [ "Adoption leave", "Advanced vacation", "Bereaved partner's paternity leave", "Bereavement leave", "Blood donation leave", "Breastfeeding leave", "Carer's leave", "Childbirth leave", "Childcare leave", "Civic/public duty leave", "Compensatory leave", "Disability leave", "Doctor's appointment leave", "Family & domestic violence leave", "Family responsibility leave", "Floating Holiday Allowance", "Hajj leave", "Hospitalization leave", "Long Service Leave", "Marriage/wedding leave", "Maternity leave", "Menstrual leave", "Military leave", "Moving leave", "Neonatal care leave", "Other leave", "Paid leave", "Parental bereavement leave", "Parental leave", "Paternity leave", "Personal leave", "Pregnancy leave", "Regional holiday", "RTT", "Shared parental leave", "Sick leave", "Study leave", "Supplementary Leave", "Unpaid leave", "Vacation", "Vacation - public holidays replacement", "Volunteer leave", "Work accident leave", "Work Location" ], "title": "TimeOffsGetParametersPolicyTypeNamesSchemaItems", "type": "string" }, "TimeOffsGetParametersStatusSchemaItems": { "enum": [ "REQUESTED", "APPROVED", "REJECTED", "USED", "CANCELED", "DELETED" ], "title": "TimeOffsGetParametersStatusSchemaItems", "type": "string" }, "TimeOffsGetResponsesContentApplicationJsonSchemaDataItems": { "properties": { "amount": { "description": "Amount of time off", "title": "float", "type": "string" }, "approved_at": { "description": "Time off approval date", "format": "date-time", "type": [ "string", "null" ] }, "canceled_at": { "description": "Time off cancellation date", "format": "date-time", "type": [ "string", "null" ] }, "contract_oid": { "description": "Contract id", "type": "string" }, "created_at": { "description": "Time off creation date", "format": "date-time", "type": "string" }, "custom_field_values": { "description": "Answers to the custom fields the request policy declares. Omitted when the policy declares none.", "items": { "$ref": "#/components/schemas/TimeOffsGetResponsesContentApplicationJsonSchemaDataItemsCustomFieldValuesItems" }, "type": "array" }, "deduction_amount": { "description": "Deduction amount", "title": "float", "type": [ "string", "null" ] }, "deleted_at": { "description": "Time off deletion date. Present only when the time-off is soft-deleted and include_deleted_time_offs was requested.", "format": "date-time", "type": [ "string", "null" ] }, "description": { "description": "Time off description", "type": [ "string", "null" ] }, "end_date": { "description": "End date of time off", "format": "date", "type": "string" }, "entitlement_unit": { "$ref": "#/components/schemas/TimeOffsGetResponsesContentApplicationJsonSchemaDataItemsEntitlementUnit", "description": "The unit in which the time off usage and entitlement are calculated." }, "half_end_date": { "description": "Is half end date", "type": "boolean" }, "half_start_date": { "description": "Is half start date", "type": "boolean" }, "id": { "description": "Time off id", "format": "uuid", "type": "string" }, "is_end_date_estimated": { "description": "Is end date estimated", "type": "boolean" }, "is_paid": { "description": "Is time off paid", "type": "boolean" }, "other_type_description": { "description": "Other type description", "type": [ "string", "null" ] }, "reason": { "description": "Reason for time off", "type": "string" }, "recipient_profile": { "$ref": "#/components/schemas/TimeOffsGetResponsesContentApplicationJsonSchemaDataItemsRecipientProfile" }, "requested_at": { "description": "Time off request date", "format": "date", "type": "string" }, "requester_profile": { "$ref": "#/components/schemas/TimeOffsGetResponsesContentApplicationJsonSchemaDataItemsRequesterProfile" }, "start_date": { "description": "Start date of time off", "format": "date", "type": "string" }, "status": { "$ref": "#/components/schemas/TimeOffsGetResponsesContentApplicationJsonSchemaDataItemsStatus", "description": "Status of time off" }, "time_off_dailies": { "items": { "$ref": "#/components/schemas/TimeOffsGetResponsesContentApplicationJsonSchemaDataItemsTimeOffDailiesItems" }, "type": "array" }, "time_off_origin": { "$ref": "#/components/schemas/TimeOffsGetResponsesContentApplicationJsonSchemaDataItemsTimeOffOrigin", "description": "Time off origin. AUTO_BANK_HOLIDAY is a bank holiday request that the system books for the worker." }, "time_off_percentage": { "description": "Time off percentage", "title": "float", "type": [ "string", "null" ] }, "time_off_type": { "$ref": "#/components/schemas/TimeOffsGetResponsesContentApplicationJsonSchemaDataItemsTimeOffType" }, "time_off_type_id": { "description": "Time off type id", "type": "string" }, "updated_at": { "description": "Time off update date", "format": "date-time", "type": "string" } }, "required": [ "id", "amount", "is_paid", "end_date", "created_at", "start_date", "updated_at", "requested_at", "half_end_date", "half_start_date", "entitlement_unit", "time_off_type_id" ], "title": "TimeOffsGetResponsesContentApplicationJsonSchemaDataItems", "type": "object" }, "TimeOffsGetResponsesContentApplicationJsonSchemaDataItemsCustomFieldValuesItems": { "properties": { "field_id": { "description": "The id of the custom field this value answers.", "format": "uuid", "type": "string" }, "value": { "description": "The submitted value for the custom field, serialized as text. When no value is provided, this will be null.", "type": [ "string", "null" ] } }, "required": [ "value", "field_id" ], "title": "TimeOffsGetResponsesContentApplicationJsonSchemaDataItemsCustomFieldValuesItems", "type": "object" }, "TimeOffsGetResponsesContentApplicationJsonSchemaDataItemsEntitlementUnit": { "description": "The unit in which the time off usage and entitlement are calculated.", "enum": [ "HOUR", "BUSINESS_DAY", "CALENDAR_DAY", "WEEK", "MONTH", "YEAR" ], "title": "TimeOffsGetResponsesContentApplicationJsonSchemaDataItemsEntitlementUnit", "type": "string" }, "TimeOffsGetResponsesContentApplicationJsonSchemaDataItemsRecipientProfile": { "properties": { "client_profile_id": { "description": "Recipient client profile id", "format": "uuid", "type": "string" }, "hris_profile_id": { "description": "Recipient hris profile id", "format": "uuid", "type": "string" }, "organization_id": { "description": "Recipient organization id", "format": "uuid", "type": "string" } }, "title": "TimeOffsGetResponsesContentApplicationJsonSchemaDataItemsRecipientProfile", "type": "object" }, "TimeOffsGetResponsesContentApplicationJsonSchemaDataItemsRequesterProfile": { "properties": { "client_profile_id": { "description": "Request client profile id", "format": "uuid", "type": "string" }, "hris_profile_id": { "description": "Request hris profile id", "format": "uuid", "type": "string" }, "organization_id": { "description": "Request organization id", "format": "uuid", "type": "string" } }, "title": "TimeOffsGetResponsesContentApplicationJsonSchemaDataItemsRequesterProfile", "type": "object" }, "TimeOffsGetResponsesContentApplicationJsonSchemaDataItemsStatus": { "description": "Status of time off", "enum": [ "REQUESTED", "APPROVED", "REJECTED", "USED", "CANCELED", "DELETED" ], "title": "TimeOffsGetResponsesContentApplicationJsonSchemaDataItemsStatus", "type": "string" }, "TimeOffsGetResponsesContentApplicationJsonSchemaDataItemsTimeOffDailiesItems": { "properties": { "amount": { "description": "Time off daily amount", "title": "float", "type": "string" }, "created_at": { "description": "Time off daily creation date", "format": "date-time", "type": "string" }, "date": { "description": "Time off daily date", "format": "date", "type": "string" }, "description": { "description": "Time off daily description", "type": [ "string", "null" ] }, "id": { "description": "Time off daily id", "format": "uuid", "type": "string" }, "time_off_id": { "description": "Time off id", "format": "uuid", "type": "string" }, "type": { "$ref": "#/components/schemas/TimeOffsGetResponsesContentApplicationJsonSchemaDataItemsTimeOffDailiesItemsType", "description": "Time off daily type" }, "updated_at": { "description": "Time off daily update date", "format": "date-time", "type": "string" } }, "required": [ "id", "date", "type", "amount", "created_at", "updated_at", "time_off_id" ], "title": "TimeOffsGetResponsesContentApplicationJsonSchemaDataItemsTimeOffDailiesItems", "type": "object" }, "TimeOffsGetResponsesContentApplicationJsonSchemaDataItemsTimeOffDailiesItemsType": { "description": "Time off daily type", "enum": [ "WORKING_DAY", "NON_WORKING_DAY", "HOLIDAY", "FORFAIT_HOUR_DAY" ], "title": "TimeOffsGetResponsesContentApplicationJsonSchemaDataItemsTimeOffDailiesItemsType", "type": "string" }, "TimeOffsGetResponsesContentApplicationJsonSchemaDataItemsTimeOffOrigin": { "description": "Time off origin. AUTO_BANK_HOLIDAY is a bank holiday request that the system books for the worker.", "enum": [ "ADMIN", "BULK_IMPORT", "DEEL_APP", "ENGAGE", "INTEGRATION", "PUBLIC_API", "SLACK", "TEAMS", "AUTO_BANK_HOLIDAY", "UNKNOWN" ], "title": "TimeOffsGetResponsesContentApplicationJsonSchemaDataItemsTimeOffOrigin", "type": "string" }, "TimeOffsGetResponsesContentApplicationJsonSchemaDataItemsTimeOffType": { "properties": { "id": { "description": "Time off type id.", "format": "uuid", "type": "string" }, "name": { "description": "Time off type name. Basically the reason or category of time-off taken. For SICK leave, it can be doctor appointment, surgery etc.", "type": "string" }, "policy": { "$ref": "#/components/schemas/TimeOffsGetResponsesContentApplicationJsonSchemaDataItemsTimeOffTypePolicy" } }, "required": [ "id", "name" ], "title": "TimeOffsGetResponsesContentApplicationJsonSchemaDataItemsTimeOffType", "type": "object" }, "TimeOffsGetResponsesContentApplicationJsonSchemaDataItemsTimeOffTypePolicy": { "properties": { "id": { "description": "Policy id", "format": "uuid", "type": "string" }, "name": { "description": "The custom name given to policy during policy creation.", "type": "string" }, "policy_type": { "$ref": "#/components/schemas/TimeOffsGetResponsesContentApplicationJsonSchemaDataItemsTimeOffTypePolicyPolicyType" } }, "required": [ "id", "name", "policy_type" ], "title": "TimeOffsGetResponsesContentApplicationJsonSchemaDataItemsTimeOffTypePolicy", "type": "object" }, "TimeOffsGetResponsesContentApplicationJsonSchemaDataItemsTimeOffTypePolicyPolicyType": { "properties": { "id": { "description": "Policy type id", "format": "uuid", "type": "string" }, "name": { "description": "Depicts the type of policy, like VACATION, SICK etc", "type": "string" } }, "required": [ "id", "name" ], "title": "TimeOffsGetResponsesContentApplicationJsonSchemaDataItemsTimeOffTypePolicyPolicyType", "type": "object" }, "TimeOffsGetResponsesContentApplicationJsonSchemaErrorsItems": { "properties": { "code": { "type": "string" }, "message": { "type": "string" } }, "required": [ "code", "message" ], "title": "TimeOffsGetResponsesContentApplicationJsonSchemaErrorsItems", "type": "object" }, "TimeOffsGlobalPayrollSyncPostRequestBodyContentApplicationJsonSchemaData": { "properties": { "time_offs": { "items": { "$ref": "#/components/schemas/TimeOffsGlobalPayrollSyncPostRequestBodyContentApplicationJsonSchemaDataTimeOffsItems" }, "type": "array" } }, "required": [ "time_offs" ], "title": "TimeOffsGlobalPayrollSyncPostRequestBodyContentApplicationJsonSchemaData", "type": "object" }, "TimeOffsGlobalPayrollSyncPostRequestBodyContentApplicationJsonSchemaDataTimeOffsItems": { "oneOf": [ { "$ref": "#/components/schemas/TimeOffsGlobalPayrollSyncPostRequestBodyContentApplicationJsonSchemaDataTimeOffsItems0" }, { "$ref": "#/components/schemas/TimeOffsGlobalPayrollSyncPostRequestBodyContentApplicationJsonSchemaDataTimeOffsItems1" } ], "title": "TimeOffsGlobalPayrollSyncPostRequestBodyContentApplicationJsonSchemaDataTimeOffsItems" }, "TimeOffsGlobalPayrollSyncPostRequestBodyContentApplicationJsonSchemaDataTimeOffsItems0": { "properties": { "amount": { "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.", "title": "float", "type": "string" }, "approved_at": { "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.", "format": "date", "type": "string" }, "contract_oid": { "description": "The contract id that has requested the time off.", "maxLength": 24, "type": "string" }, "description": { "description": "The description of the time off.", "maxLength": 500, "type": [ "string", "null" ] }, "end_date": { "description": "The end date of the time off.", "format": "date", "type": "string" }, "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." }, "external_id": { "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.", "maxLength": 48, "type": "string" }, "is_paid": { "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.", "type": "boolean" }, "policy_name": { "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).", "maxLength": 256, "type": "string" }, "policy_type": { "description": "The Deel policy type of the policy the time off is being requested for.", "oneOf": [ { "$ref": "#/components/schemas/TimeOffsGlobalPayrollSyncPostRequestBodyContentApplicationJsonSchemaDataTimeOffsItemsOneOf0PolicyType" }, { "type": "null" } ] }, "requested_at": { "description": "The request date of the time off.", "format": "date", "type": "string" }, "start_date": { "description": "The start date of the time off.", "format": "date", "type": "string" } }, "required": [ "end_date", "start_date", "external_id", "policy_type", "contract_oid" ], "title": "TimeOffsGlobalPayrollSyncPostRequestBodyContentApplicationJsonSchemaDataTimeOffsItems0", "type": "object" }, "TimeOffsGlobalPayrollSyncPostRequestBodyContentApplicationJsonSchemaDataTimeOffsItems1": { "properties": { "contract_oid": { "description": "The contract id that has requested the time off.", "maxLength": 24, "type": "string" }, "deleted": { "description": "Indicates this time off request must be deleted", "type": "boolean" }, "external_id": { "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.", "maxLength": 48, "type": "string" } }, "required": [ "deleted", "external_id", "contract_oid" ], "title": "TimeOffsGlobalPayrollSyncPostRequestBodyContentApplicationJsonSchemaDataTimeOffsItems1", "type": "object" }, "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.", "enum": [ "HOUR", "BUSINESS_DAY", "CALENDAR_DAY", "WEEK", "MONTH", "YEAR" ], "title": "TimeOffsGlobalPayrollSyncPostRequestBodyContentApplicationJsonSchemaDataTimeOffsItemsOneOf0EntitlementUnit", "type": "string" }, "TimeOffsGlobalPayrollSyncPostRequestBodyContentApplicationJsonSchemaDataTimeOffsItemsOneOf0PolicyType": { "description": "The Deel policy type of the policy the time off is being requested for.", "enum": [ "Adoption leave", "Advanced vacation", "Bereaved partner's paternity leave", "Bereavement leave", "Blood donation leave", "Breastfeeding leave", "Carer's leave", "Childbirth leave", "Childcare leave", "Civic/public duty leave", "Compensatory leave", "Disability leave", "Doctor's appointment leave", "Family & domestic violence leave", "Family responsibility leave", "Floating Holiday Allowance", "Hajj leave", "Hospitalization leave", "Long Service Leave", "Marriage/wedding leave", "Maternity leave", "Menstrual leave", "Military leave", "Moving leave", "Neonatal care leave", "Other leave", "Paid leave", "Parental bereavement leave", "Parental leave", "Paternity leave", "Personal leave", "Pregnancy leave", "Regional holiday", "RTT", "Shared parental leave", "Sick leave", "Study leave", "Supplementary Leave", "Unpaid leave", "Vacation", "Vacation - public holidays replacement", "Volunteer leave", "Work accident leave", "Work Location" ], "title": "TimeOffsGlobalPayrollSyncPostRequestBodyContentApplicationJsonSchemaDataTimeOffsItemsOneOf0PolicyType", "type": "string" }, "TimeOffsGlobalPayrollSyncPostResponsesContentApplicationJsonSchemaData": { "properties": { "deleted": { "description": "Number of time off requests that were deleted", "format": "double", "type": "number" }, "inserted": { "description": "Number of time off requests that were inserted", "format": "double", "type": "number" }, "updated": { "description": "Number of time off requests that were updated", "format": "double", "type": "number" } }, "title": "TimeOffsGlobalPayrollSyncPostResponsesContentApplicationJsonSchemaData", "type": "object" }, "TimeOffsGlobalPayrollSyncPostResponsesContentApplicationJsonSchemaErrorsItems": { "properties": { "message": { "description": "A description of the returned error", "type": "string" }, "path": { "description": "The JSON path where input validation failed", "type": "string" } }, "title": "TimeOffsGlobalPayrollSyncPostResponsesContentApplicationJsonSchemaErrorsItems", "type": "object" }, "TimeOffsGlobalPayrollSyncPostResponsesContentApplicationJsonSchemaRequest": { "properties": { "api_req_id": { "description": "The request ID of the failed request", "type": "string" }, "code": { "description": "The code of the source handler which produced the returned error", "format": "double", "type": "number" }, "docs": { "description": "A link to the official documentation for the requested endpoint resource", "type": "string" }, "method": { "description": "The HTTP method of the failed request", "type": "string" }, "source": { "description": "The source handler which produced the returned error", "type": "string" }, "status": { "description": "The status code of the response", "format": "double", "type": "number" }, "url": { "description": "The relative URL of the failed request", "type": "string" } }, "title": "TimeOffsGlobalPayrollSyncPostResponsesContentApplicationJsonSchemaRequest", "type": "object" }, "TimeOffsPolicyGetParametersPolicyTypeSchemaItems": { "enum": [ "Adoption leave", "Advanced vacation", "Bereaved partner's paternity leave", "Bereavement leave", "Blood donation leave", "Breastfeeding leave", "Carer's leave", "Childbirth leave", "Childcare leave", "Civic/public duty leave", "Compensatory leave", "Disability leave", "Doctor's appointment leave", "Family & domestic violence leave", "Family responsibility leave", "Floating Holiday Allowance", "Hajj leave", "Hospitalization leave", "Long Service Leave", "Marriage/wedding leave", "Maternity leave", "Menstrual leave", "Military leave", "Moving leave", "Neonatal care leave", "Other leave", "Paid leave", "Parental bereavement leave", "Parental leave", "Paternity leave", "Personal leave", "Pregnancy leave", "Regional holiday", "RTT", "Shared parental leave", "Sick leave", "Study leave", "Supplementary Leave", "Unpaid leave", "Vacation", "Vacation - public holidays replacement", "Volunteer leave", "Work accident leave", "Work Location" ], "title": "TimeOffsPolicyGetParametersPolicyTypeSchemaItems", "type": "string" }, "TimeOffsPolicyGetResponsesContentApplicationJsonSchemaDataItems": { "properties": { "assigned_profiles_count": { "description": "Count of profiles assigned to this policy.", "type": "integer" }, "auto_approval_inactivity_time_unit": { "$ref": "#/components/schemas/TimeOffsPolicyGetResponsesContentApplicationJsonSchemaDataItemsAutoApprovalInactivityTimeUnit", "description": "Unit of time used for calculating the auto-approval after inactivity on reviewing the leave, if applicable" }, "auto_approval_inactivity_time_unit_amount": { "description": "Amount of time units used for calculating the auto-approval after inactivity on reviewing the leave, if applicable", "format": "double", "type": "number" }, "created_at": { "description": "Timestamp when the policy was created", "format": "date-time", "type": "string" }, "custom_fields": { "description": "The custom fields the policy declares. Empty when the policy collects none.", "items": { "$ref": "#/components/schemas/TimeOffsPolicyGetResponsesContentApplicationJsonSchemaDataItemsCustomFieldsItems" }, "type": "array" }, "description": { "description": "Policy description", "type": "string" }, "has_custom_fields": { "description": "Whether the policy collects any custom field answers on its requests.", "type": "boolean" }, "id": { "description": "Policy UID", "format": "uuid", "type": "string" }, "is_attachment_required": { "description": "Indicates if an attachment is required for the time off request", "type": "boolean" }, "is_description_required": { "description": "Indicates if a description is required for the time off request", "type": "boolean" }, "is_event_based": { "description": "Indicates if the policy's base allowance accrues based on an event (e.g., a life event like child birth) rather than on a time-based schedule", "type": "boolean" }, "is_requiring_custom_fields": { "description": "Whether at least one of the policy's custom fields can be mandatory (ALWAYS_REQUIRED or REQUIRED_CONDITIONALLY). False when every custom field is OPTIONAL, or when the policy has none.", "type": "boolean" }, "leave_type": { "$ref": "#/components/schemas/TimeOffsPolicyGetResponsesContentApplicationJsonSchemaDataItemsLeaveType", "description": "Type of leave policy. Either short-term leave (e.g., PTO, vacation) or long-term leave (e.g., maternity, paternity)" }, "name": { "description": "Policy name", "type": "string" }, "notice_period_unit": { "$ref": "#/components/schemas/TimeOffsPolicyGetResponsesContentApplicationJsonSchemaDataItemsNoticePeriodUnit", "description": "Unit of time used for calculating the notice period, if applicable. This is the minimum amount of time before the start of the leave that a worker must submit a request" }, "notice_period_unit_amount": { "description": "Amount of time units used for calculating the notice period, if applicable", "format": "double", "type": "number" }, "overlap_request_type": { "$ref": "#/components/schemas/TimeOffsPolicyGetResponsesContentApplicationJsonSchemaDataItemsOverlapRequestType", "description": "Defines if overlap requests are allowed or not. Overlap requests are requests that overlap with existing time off requests" }, "payment_type": { "$ref": "#/components/schemas/TimeOffsPolicyGetResponsesContentApplicationJsonSchemaDataItemsPaymentType", "description": "Type of payment for the time off" }, "policy_allowance_proration": { "$ref": "#/components/schemas/TimeOffsPolicyGetResponsesContentApplicationJsonSchemaDataItemsPolicyAllowanceProration", "description": "Details of the proration rules for the policy allowance" }, "policy_allowances": { "description": "Details of the policy allowances associated with this policy", "items": { "$ref": "#/components/schemas/TimeOffsPolicyGetResponsesContentApplicationJsonSchemaDataItemsPolicyAllowancesItems" }, "type": "array" }, "policy_type": { "$ref": "#/components/schemas/TimeOffsPolicyGetResponsesContentApplicationJsonSchemaDataItemsPolicyType", "description": "Details of the policy type associated with this policy" }, "request_start_type": { "$ref": "#/components/schemas/TimeOffsPolicyGetResponsesContentApplicationJsonSchemaDataItemsRequestStartType", "description": "Defines when a the worker can start to request leaves. Either immediately or after a fixed period of time from the start of the tracking period" }, "request_start_unit": { "$ref": "#/components/schemas/TimeOffsPolicyGetResponsesContentApplicationJsonSchemaDataItemsRequestStartUnit", "description": "Unit of time used for calculating the request start period, if applicable. This is used when the request start type is FIXED_PERIOD" }, "request_start_unit_amount": { "description": "Amount of time units used for calculating the request start period, if applicable. This is used when the request start type is FIXED_PERIOD", "format": "double", "type": "number" }, "retrospective_request_type": { "$ref": "#/components/schemas/TimeOffsPolicyGetResponsesContentApplicationJsonSchemaDataItemsRetrospectiveRequestType", "description": "Defines if retrospective requests are allowed or not. Retrospective requests are requests for time off in the past" }, "should_allow_editing_past_time_offs": { "description": "Indicates if users are allowed to edit past time off requests", "type": "boolean" }, "time_off_request_type": { "$ref": "#/components/schemas/TimeOffsPolicyGetResponsesContentApplicationJsonSchemaDataItemsTimeOffRequestType", "description": "Type of time off request. Can be full day, half day, or partial day" }, "time_off_types": { "items": { "$ref": "#/components/schemas/TimeOffsPolicyGetResponsesContentApplicationJsonSchemaDataItemsTimeOffTypesItems" }, "type": "array" }, "tracking_cadence": { "$ref": "#/components/schemas/TimeOffsPolicyGetResponsesContentApplicationJsonSchemaDataItemsTrackingCadence", "description": "Cadence of the tracking period. Either a fixed day (e.g., Jan 1), based on the anniversary of the employee's start date, or NOT_SPECIFIED if the policy has no tracking cadence configured" }, "tracking_start_date": { "description": "Start date for tracking periods, if applicable. This is used when the tracking cadence is FIXED_DAY. So all tracking periods starts in the given month and day of each year", "format": "date", "type": "string" }, "tracking_unit": { "$ref": "#/components/schemas/TimeOffsPolicyGetResponsesContentApplicationJsonSchemaDataItemsTrackingUnit", "description": "Unit of time used for calculating tracking periods" }, "tracking_unit_amount": { "description": "Amount of the tracking unit", "format": "double", "type": "number" }, "updated_at": { "description": "Timestamp when the policy was last updated", "format": "date-time", "type": "string" } }, "required": [ "id", "name", "created_at", "leave_type", "updated_at", "policy_type", "payment_type", "custom_fields", "is_event_based", "time_off_types", "tracking_cadence", "has_custom_fields", "policy_allowances", "request_start_type", "overlap_request_type", "time_off_request_type", "is_attachment_required", "assigned_profiles_count", "is_description_required", "is_requiring_custom_fields", "policy_allowance_proration", "retrospective_request_type", "should_allow_editing_past_time_offs" ], "title": "TimeOffsPolicyGetResponsesContentApplicationJsonSchemaDataItems", "type": "object" }, "TimeOffsPolicyGetResponsesContentApplicationJsonSchemaDataItemsAutoApprovalInactivityTimeUnit": { "description": "Unit of time used for calculating the auto-approval after inactivity on reviewing the leave, if applicable", "enum": [ "HOUR", "BUSINESS_DAY", "CALENDAR_DAY", "WEEK", "MONTH", "YEAR" ], "title": "TimeOffsPolicyGetResponsesContentApplicationJsonSchemaDataItemsAutoApprovalInactivityTimeUnit", "type": "string" }, "TimeOffsPolicyGetResponsesContentApplicationJsonSchemaDataItemsCustomFieldsItems": { "properties": { "field_requirement": { "$ref": "#/components/schemas/TimeOffsPolicyGetResponsesContentApplicationJsonSchemaDataItemsCustomFieldsItemsFieldRequirement", "description": "Whether an answer is mandatory, and under which conditions." }, "id": { "description": "The custom field id.", "format": "uuid", "type": "string" }, "key": { "description": "Machine key, unique within the policy.", "type": "string" }, "name": { "description": "Human-facing field name shown on the request form.", "type": "string" }, "requirement_conditions": { "description": "Present only for a REQUIRED_CONDITIONALLY field: the conditions under which it becomes required.", "items": { "$ref": "#/components/schemas/TimeOffsPolicyGetResponsesContentApplicationJsonSchemaDataItemsCustomFieldsItemsRequirementConditionsItems" }, "type": [ "array", "null" ] }, "schema": { "$ref": "#/components/schemas/TimeOffsPolicyGetResponsesContentApplicationJsonSchemaDataItemsCustomFieldsItemsSchema", "description": "The value type plus shape/constraints of the field." } }, "required": [ "id", "key", "name", "schema", "field_requirement" ], "title": "TimeOffsPolicyGetResponsesContentApplicationJsonSchemaDataItemsCustomFieldsItems", "type": "object" }, "TimeOffsPolicyGetResponsesContentApplicationJsonSchemaDataItemsCustomFieldsItemsFieldRequirement": { "description": "Whether an answer is mandatory, and under which conditions.", "enum": [ "ALWAYS_REQUIRED", "REQUIRED_CONDITIONALLY", "OPTIONAL" ], "title": "TimeOffsPolicyGetResponsesContentApplicationJsonSchemaDataItemsCustomFieldsItemsFieldRequirement", "type": "string" }, "TimeOffsPolicyGetResponsesContentApplicationJsonSchemaDataItemsCustomFieldsItemsRequirementConditionsItems": { "properties": { "left_field_key": { "description": "Machine key of the field whose answer is being compared.", "type": "string" }, "operator": { "$ref": "#/components/schemas/TimeOffsPolicyGetResponsesContentApplicationJsonSchemaDataItemsCustomFieldsItemsRequirementConditionsItemsOperator", "description": "How the left field's answer is compared against the right side." }, "right_field_key": { "description": "Machine key of another field to compare against, when the right side is itself an answer rather than a static value.", "type": "string" }, "static_items": { "description": "Literal list to compare against, for IS_ANY_OF.", "items": { "type": "string" }, "type": [ "array", "null" ] }, "static_value": { "description": "Literal value to compare against, for a single-value operator (IS, IS_NOT, IS_AT_LEAST, IS_AT_MOST, IS_LESS_THAN, IS_MORE_THAN).", "type": [ "string", "null" ] } }, "required": [ "operator" ], "title": "TimeOffsPolicyGetResponsesContentApplicationJsonSchemaDataItemsCustomFieldsItemsRequirementConditionsItems", "type": "object" }, "TimeOffsPolicyGetResponsesContentApplicationJsonSchemaDataItemsCustomFieldsItemsRequirementConditionsItemsOperator": { "description": "How the left field's answer is compared against the right side.", "enum": [ "IS", "IS_NOT", "IS_ANY_OF", "IS_AT_LEAST", "IS_AT_MOST", "IS_LESS_THAN", "IS_MORE_THAN" ], "title": "TimeOffsPolicyGetResponsesContentApplicationJsonSchemaDataItemsCustomFieldsItemsRequirementConditionsItemsOperator", "type": "string" }, "TimeOffsPolicyGetResponsesContentApplicationJsonSchemaDataItemsCustomFieldsItemsSchema": { "description": "The value type plus shape/constraints of the field.", "properties": { "enum": { "description": "Allowed values, when the field is a closed list.", "items": { "type": "string" }, "type": "array" }, "is_nullable": { "description": "Whether the field accepts a null answer. Always `false` today — nullable custom fields are not supported yet, but the flag is present from the start so support can be added later without a breaking change.", "type": "boolean" }, "type": { "$ref": "#/components/schemas/TimeOffsPolicyGetResponsesContentApplicationJsonSchemaDataItemsCustomFieldsItemsSchemaType", "description": "The value type of the field." } }, "required": [ "type", "is_nullable" ], "title": "TimeOffsPolicyGetResponsesContentApplicationJsonSchemaDataItemsCustomFieldsItemsSchema", "type": "object" }, "TimeOffsPolicyGetResponsesContentApplicationJsonSchemaDataItemsCustomFieldsItemsSchemaType": { "description": "The value type of the field.", "enum": [ "string", "number", "boolean", "date", "datetime" ], "title": "TimeOffsPolicyGetResponsesContentApplicationJsonSchemaDataItemsCustomFieldsItemsSchemaType", "type": "string" }, "TimeOffsPolicyGetResponsesContentApplicationJsonSchemaDataItemsLeaveType": { "description": "Type of leave policy. Either short-term leave (e.g., PTO, vacation) or long-term leave (e.g., maternity, paternity)", "enum": [ "SHORT_TERM_LEAVE", "LONG_TERM_LEAVE" ], "title": "TimeOffsPolicyGetResponsesContentApplicationJsonSchemaDataItemsLeaveType", "type": "string" }, "TimeOffsPolicyGetResponsesContentApplicationJsonSchemaDataItemsNoticePeriodUnit": { "description": "Unit of time used for calculating the notice period, if applicable. This is the minimum amount of time before the start of the leave that a worker must submit a request", "enum": [ "HOUR", "BUSINESS_DAY", "CALENDAR_DAY", "WEEK", "MONTH", "YEAR" ], "title": "TimeOffsPolicyGetResponsesContentApplicationJsonSchemaDataItemsNoticePeriodUnit", "type": "string" }, "TimeOffsPolicyGetResponsesContentApplicationJsonSchemaDataItemsOverlapRequestType": { "description": "Defines if overlap requests are allowed or not. Overlap requests are requests that overlap with existing time off requests", "enum": [ "ALLOWED", "NOT_ALLOWED" ], "title": "TimeOffsPolicyGetResponsesContentApplicationJsonSchemaDataItemsOverlapRequestType", "type": "string" }, "TimeOffsPolicyGetResponsesContentApplicationJsonSchemaDataItemsPaymentType": { "description": "Type of payment for the time off", "enum": [ "PAID", "UNPAID", "PARTIALLY_PAID" ], "title": "TimeOffsPolicyGetResponsesContentApplicationJsonSchemaDataItemsPaymentType", "type": "string" }, "TimeOffsPolicyGetResponsesContentApplicationJsonSchemaDataItemsPolicyAllowanceProration": { "description": "Details of the proration rules for the policy allowance", "properties": { "is_prorated_on_hire": { "description": "Indicates if the allowance is prorated on hire", "type": "boolean" }, "is_prorated_on_termination": { "description": "Indicates if the allowance is prorated on termination", "type": "boolean" }, "part_time_worker_treatment_specific_amount": { "description": "Specific amount for part-time worker treatment, if applicable.", "format": "double", "type": [ "number", "null" ] }, "part_time_worker_treatment_type": { "$ref": "#/components/schemas/TimeOffsPolicyGetResponsesContentApplicationJsonSchemaDataItemsPolicyAllowanceProrationPartTimeWorkerTreatmentType", "description": "Defines how the allowance is prorated for part-time workers. Either no proration, full month proration based on day, tenure boundary proration, or country specific proration" } }, "required": [ "is_prorated_on_hire", "is_prorated_on_termination", "part_time_worker_treatment_type" ], "title": "TimeOffsPolicyGetResponsesContentApplicationJsonSchemaDataItemsPolicyAllowanceProration", "type": "object" }, "TimeOffsPolicyGetResponsesContentApplicationJsonSchemaDataItemsPolicyAllowanceProrationPartTimeWorkerTreatmentType": { "description": "Defines how the allowance is prorated for part-time workers. Either no proration, full month proration based on day, tenure boundary proration, or country specific proration", "enum": [ "SAME_AS_FTE", "PERCENTAGE_OF_FTE", "BASED_ON_WORK_HOURS", "BASED_ON_WORK_DAYS", "CUSTOM_ENTITLEMENT" ], "title": "TimeOffsPolicyGetResponsesContentApplicationJsonSchemaDataItemsPolicyAllowanceProrationPartTimeWorkerTreatmentType", "type": "string" }, "TimeOffsPolicyGetResponsesContentApplicationJsonSchemaDataItemsPolicyAllowancesItems": { "properties": { "accrual_application_type": { "$ref": "#/components/schemas/TimeOffsPolicyGetResponsesContentApplicationJsonSchemaDataItemsPolicyAllowancesItemsAccrualApplicationType", "description": "Defines when the accruals are applied. Either at the beginning of the cycle, at the end of the cycle, or at the beginning of the next cycle" }, "accrual_type": { "$ref": "#/components/schemas/TimeOffsPolicyGetResponsesContentApplicationJsonSchemaDataItemsPolicyAllowancesItemsAccrualType", "description": "Determines how and when profiles earn this allowance: LUMPSUM (accrued all at once at the start of the tracking period), TIMEFRAME (accrued periodically, e.g. monthly), EVENT (accrued based on a life event, e.g. child birth), TIME_OFF_IN_LIEU (accrued from extra hours worked), HOURLY (accrued based on hours worked), or NO_AUTO_ACCRUAL (balance managed only via manual adjustments)" }, "accrual_unit": { "$ref": "#/components/schemas/TimeOffsPolicyGetResponsesContentApplicationJsonSchemaDataItemsPolicyAllowancesItemsAccrualUnit", "description": "Unit for how long are the accrual period in each tracking period" }, "accrual_unit_amount": { "description": "Amount of time units for how long are the accrual period in each tracking period", "format": "double", "type": "number" }, "balance_tracking_flexible_custom_request_amount": { "description": "Limit allowed for the worker balance to be negative. This value if applicable is always positive", "format": "double", "type": "number" }, "balance_tracking_type": { "$ref": "#/components/schemas/TimeOffsPolicyGetResponsesContentApplicationJsonSchemaDataItemsPolicyAllowancesItemsBalanceTrackingType", "description": "Defines if the balance tracking is flexible or inflexible. INFLEXIBLE means the worker cannot go below zero. The FLEXIBLE_* values allow the worker to request more time off than their allowance and go negative, either without limit (FLEXIBLE_NO_LIMIT), up to a custom amount (FLEXIBLE_CUSTOM_AMOUNT), or up to the yearly allowance (FLEXIBLE_UP_TO_YEARLY_ALLOWANCE)" }, "entitlement_expiration_unit": { "$ref": "#/components/schemas/TimeOffsPolicyGetResponsesContentApplicationJsonSchemaDataItemsPolicyAllowancesItemsEntitlementExpirationUnit", "description": "Unit for the entitlement expiration period, if applicable" }, "entitlement_expiration_unit_amount": { "description": "Amount of time units for the entitlement expiration period, if applicable", "format": "double", "type": "number" }, "entitlement_start_date": { "description": "Start date for the entitlement, if applicable. This is used when the entitlement start type is FIXED_DAY. So all entitlements starts in the given month and day of each year", "format": "date", "type": "string" }, "entitlement_start_type": { "$ref": "#/components/schemas/TimeOffsPolicyGetResponsesContentApplicationJsonSchemaDataItemsPolicyAllowancesItemsEntitlementStartType", "description": "Defines when the workers start to receive their allowance" }, "entitlement_start_unit": { "$ref": "#/components/schemas/TimeOffsPolicyGetResponsesContentApplicationJsonSchemaDataItemsPolicyAllowancesItemsEntitlementStartUnit", "description": "Unit for the entitlement start period, if applicable. This is used when the entitlement start type is FIXED_PERIOD" }, "entitlement_start_unit_amount": { "description": "Amount of time units for the entitlement start period, if applicable. This is used when the entitlement start type is FIXED_PERIOD", "format": "double", "type": "number" }, "entitlement_unit": { "$ref": "#/components/schemas/TimeOffsPolicyGetResponsesContentApplicationJsonSchemaDataItemsPolicyAllowancesItemsEntitlementUnit", "description": "Unit for the entitled allowance" }, "entitlement_unit_amount": { "description": "Amount of time units for the entitled allowance. Null means unlimited allowance", "format": "double", "type": [ "number", "null" ] }, "id": { "description": "Policy allowance UID", "format": "uuid", "type": "string" }, "is_bank_holidays_enabled": { "description": "Indicates if bank holidays are enabled used considered non-working days when calculating leave usage for this allowance", "type": "boolean" }, "is_unlimited_allowance": { "description": "Indicates if the allowance is unlimited. Unlimited means that the worker can request any amount of time off without any limit", "type": "boolean" }, "part_time_prorated_entitlement_unit_amount": { "description": "Amount of time units for part-time prorated entitlement, if applicable", "format": "double", "type": [ "number", "null" ] }, "rollover_expiration_unit": { "$ref": "#/components/schemas/TimeOffsPolicyGetResponsesContentApplicationJsonSchemaDataItemsPolicyAllowancesItemsRolloverExpirationUnit", "description": "Unit for the rollover expiration period, if applicable" }, "rollover_expiration_unit_amount": { "description": "Amount of time units for the rollover expiration period, if applicable", "format": "double", "type": "number" }, "rollover_limit_unit_amount": { "description": "Maximum amount that can be rolled over, if applicable", "format": "double", "type": "number" }, "rollover_type": { "$ref": "#/components/schemas/TimeOffsPolicyGetResponsesContentApplicationJsonSchemaDataItemsPolicyAllowancesItemsRolloverType", "description": "Defines if the rollover carryover treatment for the policy allowance" }, "should_zero_out_negative_balances_on_rollover": { "description": "Indicates if negative balances should be zeroed out on rollover", "type": "boolean" }, "type": { "$ref": "#/components/schemas/TimeOffsPolicyGetResponsesContentApplicationJsonSchemaDataItemsPolicyAllowancesItemsType", "description": "Type of policy allowance. Either a base allowance or an additional allowance" } }, "required": [ "id", "type", "accrual_type", "rollover_type", "balance_tracking_type", "entitlement_start_type", "is_unlimited_allowance", "is_bank_holidays_enabled", "should_zero_out_negative_balances_on_rollover" ], "title": "TimeOffsPolicyGetResponsesContentApplicationJsonSchemaDataItemsPolicyAllowancesItems", "type": "object" }, "TimeOffsPolicyGetResponsesContentApplicationJsonSchemaDataItemsPolicyAllowancesItemsAccrualApplicationType": { "description": "Defines when the accruals are applied. Either at the beginning of the cycle, at the end of the cycle, or at the beginning of the next cycle", "enum": [ "BEGIN_OF_CYCLE", "END_OF_CYCLE", "BEGIN_OF_NEXT_CYCLE" ], "title": "TimeOffsPolicyGetResponsesContentApplicationJsonSchemaDataItemsPolicyAllowancesItemsAccrualApplicationType", "type": "string" }, "TimeOffsPolicyGetResponsesContentApplicationJsonSchemaDataItemsPolicyAllowancesItemsAccrualType": { "description": "Determines how and when profiles earn this allowance: LUMPSUM (accrued all at once at the start of the tracking period), TIMEFRAME (accrued periodically, e.g. monthly), EVENT (accrued based on a life event, e.g. child birth), TIME_OFF_IN_LIEU (accrued from extra hours worked), HOURLY (accrued based on hours worked), or NO_AUTO_ACCRUAL (balance managed only via manual adjustments)", "enum": [ "LUMPSUM", "TIMEFRAME", "EVENT", "TIME_OFF_IN_LIEU", "HOURLY", "NO_AUTO_ACCRUAL" ], "title": "TimeOffsPolicyGetResponsesContentApplicationJsonSchemaDataItemsPolicyAllowancesItemsAccrualType", "type": "string" }, "TimeOffsPolicyGetResponsesContentApplicationJsonSchemaDataItemsPolicyAllowancesItemsAccrualUnit": { "description": "Unit for how long are the accrual period in each tracking period", "enum": [ "HOUR", "BUSINESS_DAY", "CALENDAR_DAY", "WEEK", "MONTH", "YEAR" ], "title": "TimeOffsPolicyGetResponsesContentApplicationJsonSchemaDataItemsPolicyAllowancesItemsAccrualUnit", "type": "string" }, "TimeOffsPolicyGetResponsesContentApplicationJsonSchemaDataItemsPolicyAllowancesItemsBalanceTrackingType": { "description": "Defines if the balance tracking is flexible or inflexible. INFLEXIBLE means the worker cannot go below zero. The FLEXIBLE_* values allow the worker to request more time off than their allowance and go negative, either without limit (FLEXIBLE_NO_LIMIT), up to a custom amount (FLEXIBLE_CUSTOM_AMOUNT), or up to the yearly allowance (FLEXIBLE_UP_TO_YEARLY_ALLOWANCE)", "enum": [ "INFLEXIBLE", "FLEXIBLE_NO_LIMIT", "FLEXIBLE_CUSTOM_AMOUNT", "FLEXIBLE_UP_TO_YEARLY_ALLOWANCE" ], "title": "TimeOffsPolicyGetResponsesContentApplicationJsonSchemaDataItemsPolicyAllowancesItemsBalanceTrackingType", "type": "string" }, "TimeOffsPolicyGetResponsesContentApplicationJsonSchemaDataItemsPolicyAllowancesItemsEntitlementExpirationUnit": { "description": "Unit for the entitlement expiration period, if applicable", "enum": [ "HOUR", "BUSINESS_DAY", "CALENDAR_DAY", "WEEK", "MONTH", "YEAR" ], "title": "TimeOffsPolicyGetResponsesContentApplicationJsonSchemaDataItemsPolicyAllowancesItemsEntitlementExpirationUnit", "type": "string" }, "TimeOffsPolicyGetResponsesContentApplicationJsonSchemaDataItemsPolicyAllowancesItemsEntitlementStartType": { "description": "Defines when the workers start to receive their allowance", "enum": [ "IMMEDIATELY", "FIXED_PERIOD", "FIXED_DAY" ], "title": "TimeOffsPolicyGetResponsesContentApplicationJsonSchemaDataItemsPolicyAllowancesItemsEntitlementStartType", "type": "string" }, "TimeOffsPolicyGetResponsesContentApplicationJsonSchemaDataItemsPolicyAllowancesItemsEntitlementStartUnit": { "description": "Unit for the entitlement start period, if applicable. This is used when the entitlement start type is FIXED_PERIOD", "enum": [ "HOUR", "BUSINESS_DAY", "CALENDAR_DAY", "WEEK", "MONTH", "YEAR" ], "title": "TimeOffsPolicyGetResponsesContentApplicationJsonSchemaDataItemsPolicyAllowancesItemsEntitlementStartUnit", "type": "string" }, "TimeOffsPolicyGetResponsesContentApplicationJsonSchemaDataItemsPolicyAllowancesItemsEntitlementUnit": { "description": "Unit for the entitled allowance", "enum": [ "HOUR", "BUSINESS_DAY", "CALENDAR_DAY", "WEEK", "MONTH", "YEAR" ], "title": "TimeOffsPolicyGetResponsesContentApplicationJsonSchemaDataItemsPolicyAllowancesItemsEntitlementUnit", "type": "string" }, "TimeOffsPolicyGetResponsesContentApplicationJsonSchemaDataItemsPolicyAllowancesItemsRolloverExpirationUnit": { "description": "Unit for the rollover expiration period, if applicable", "enum": [ "HOUR", "BUSINESS_DAY", "CALENDAR_DAY", "WEEK", "MONTH", "YEAR" ], "title": "TimeOffsPolicyGetResponsesContentApplicationJsonSchemaDataItemsPolicyAllowancesItemsRolloverExpirationUnit", "type": "string" }, "TimeOffsPolicyGetResponsesContentApplicationJsonSchemaDataItemsPolicyAllowancesItemsRolloverType": { "description": "Defines if the rollover carryover treatment for the policy allowance", "enum": [ "NO_ROLLOVER", "PAY_OUT", "CARRY_OVER", "CARRY_OVER_PAY_OUT" ], "title": "TimeOffsPolicyGetResponsesContentApplicationJsonSchemaDataItemsPolicyAllowancesItemsRolloverType", "type": "string" }, "TimeOffsPolicyGetResponsesContentApplicationJsonSchemaDataItemsPolicyAllowancesItemsType": { "description": "Type of policy allowance. Either a base allowance or an additional allowance", "enum": [ "BASE_ALLOWANCE", "ADDITIONAL_ALLOWANCE" ], "title": "TimeOffsPolicyGetResponsesContentApplicationJsonSchemaDataItemsPolicyAllowancesItemsType", "type": "string" }, "TimeOffsPolicyGetResponsesContentApplicationJsonSchemaDataItemsPolicyType": { "description": "Details of the policy type associated with this policy", "properties": { "id": { "description": "Policy type UID", "format": "uuid", "type": "string" }, "name": { "description": "Policy type name", "type": "string" } }, "required": [ "id", "name" ], "title": "TimeOffsPolicyGetResponsesContentApplicationJsonSchemaDataItemsPolicyType", "type": "object" }, "TimeOffsPolicyGetResponsesContentApplicationJsonSchemaDataItemsRequestStartType": { "description": "Defines when a the worker can start to request leaves. Either immediately or after a fixed period of time from the start of the tracking period", "enum": [ "IMMEDIATELY", "FIXED_PERIOD" ], "title": "TimeOffsPolicyGetResponsesContentApplicationJsonSchemaDataItemsRequestStartType", "type": "string" }, "TimeOffsPolicyGetResponsesContentApplicationJsonSchemaDataItemsRequestStartUnit": { "description": "Unit of time used for calculating the request start period, if applicable. This is used when the request start type is FIXED_PERIOD", "enum": [ "HOUR", "BUSINESS_DAY", "CALENDAR_DAY", "WEEK", "MONTH", "YEAR" ], "title": "TimeOffsPolicyGetResponsesContentApplicationJsonSchemaDataItemsRequestStartUnit", "type": "string" }, "TimeOffsPolicyGetResponsesContentApplicationJsonSchemaDataItemsRetrospectiveRequestType": { "description": "Defines if retrospective requests are allowed or not. Retrospective requests are requests for time off in the past", "enum": [ "ALLOWED", "NOT_ALLOWED" ], "title": "TimeOffsPolicyGetResponsesContentApplicationJsonSchemaDataItemsRetrospectiveRequestType", "type": "string" }, "TimeOffsPolicyGetResponsesContentApplicationJsonSchemaDataItemsTimeOffRequestType": { "description": "Type of time off request. Can be full day, half day, or partial day", "enum": [ "HALF_DAY", "HOURLY", "FULL_DAY", "PERCENTAGE", "PARTIAL_HOURS" ], "title": "TimeOffsPolicyGetResponsesContentApplicationJsonSchemaDataItemsTimeOffRequestType", "type": "string" }, "TimeOffsPolicyGetResponsesContentApplicationJsonSchemaDataItemsTimeOffTypesItems": { "description": "Details of the time-off type associated with this policy. Time-off types are subcategories for a policy and represent different reasons for requesting a leave", "properties": { "description": { "description": "Time-off type description", "type": "string" }, "id": { "description": "Time-off type UID", "format": "uuid", "type": "string" }, "name": { "description": "Time-off type name", "type": "string" } }, "required": [ "id", "name" ], "title": "TimeOffsPolicyGetResponsesContentApplicationJsonSchemaDataItemsTimeOffTypesItems", "type": "object" }, "TimeOffsPolicyGetResponsesContentApplicationJsonSchemaDataItemsTrackingCadence": { "description": "Cadence of the tracking period. Either a fixed day (e.g., Jan 1), based on the anniversary of the employee's start date, or NOT_SPECIFIED if the policy has no tracking cadence configured", "enum": [ "FIXED_DAY", "ANNIVERSARY", "NOT_SPECIFIED" ], "title": "TimeOffsPolicyGetResponsesContentApplicationJsonSchemaDataItemsTrackingCadence", "type": "string" }, "TimeOffsPolicyGetResponsesContentApplicationJsonSchemaDataItemsTrackingUnit": { "description": "Unit of time used for calculating tracking periods", "enum": [ "HOUR", "BUSINESS_DAY", "CALENDAR_DAY", "WEEK", "MONTH", "YEAR" ], "title": "TimeOffsPolicyGetResponsesContentApplicationJsonSchemaDataItemsTrackingUnit", "type": "string" }, "TimeOffsPolicyGetResponsesContentApplicationJsonSchemaErrorsItems": { "properties": { "code": { "type": "string" }, "message": { "type": "string" } }, "required": [ "code", "message" ], "title": "TimeOffsPolicyGetResponsesContentApplicationJsonSchemaErrorsItems", "type": "object" }, "TimeOffsPolicyPolicyIdAssignmentsGetResponsesContentApplicationJsonSchemaDataItems": { "properties": { "country": { "description": "ISO 3166-1 alpha-2 country code of the assigned worker's employment. Null if not set", "type": [ "string", "null" ] }, "email": { "description": "Personal email address of the assigned worker", "format": "email", "type": "string" }, "hris_profile_id": { "description": "HRIS profile UID of the assigned worker. Null if the assigned profile has no linked HRIS profile", "format": "uuid", "type": [ "string", "null" ] }, "name": { "description": "Full name of the assigned worker", "type": "string" }, "state": { "description": "State or region code of the assigned worker's employment, if applicable", "type": [ "string", "null" ] }, "work_email": { "description": "Work email address of the assigned worker, if set", "format": "email", "type": [ "string", "null" ] }, "worker_type": { "$ref": "#/components/schemas/TimeOffsPolicyPolicyIdAssignmentsGetResponsesContentApplicationJsonSchemaDataItemsWorkerType", "description": "Type of worker relationship the assigned profile has with the organization" } }, "required": [ "name", "email", "country", "worker_type", "hris_profile_id" ], "title": "TimeOffsPolicyPolicyIdAssignmentsGetResponsesContentApplicationJsonSchemaDataItems", "type": "object" }, "TimeOffsPolicyPolicyIdAssignmentsGetResponsesContentApplicationJsonSchemaDataItemsWorkerType": { "description": "Type of worker relationship the assigned profile has with the organization", "enum": [ "milestones_contractor", "payg_contractor", "time_based_contractor", "eor", "direct_employee", "hris_direct_employee", "peo", "hris_placeholder", "hris_direct_contractor" ], "title": "TimeOffsPolicyPolicyIdAssignmentsGetResponsesContentApplicationJsonSchemaDataItemsWorkerType", "type": "string" }, "TimeOffsPolicyPolicyIdAssignmentsGetResponsesContentApplicationJsonSchemaErrorsItems": { "properties": { "code": { "type": "string" }, "message": { "type": "string" } }, "required": [ "code", "message" ], "title": "TimeOffsPolicyPolicyIdAssignmentsGetResponsesContentApplicationJsonSchemaErrorsItems", "type": "object" }, "TimeOffsPolicyValidationTemplatesGetResponsesContentApplicationJsonSchemaData": { "properties": { "policy_types": { "description": "List of unique policy types associated with the retrieved templates.", "items": { "$ref": "#/components/schemas/TimeOffsPolicyValidationTemplatesGetResponsesContentApplicationJsonSchemaDataPolicyTypesItems" }, "type": "array" }, "policy_validation_templates": { "description": "List of policy validation templates matching the criteria.", "items": { "$ref": "#/components/schemas/TimeOffsPolicyValidationTemplatesGetResponsesContentApplicationJsonSchemaDataPolicyValidationTemplatesItems" }, "type": "array" } }, "title": "TimeOffsPolicyValidationTemplatesGetResponsesContentApplicationJsonSchemaData", "type": "object" }, "TimeOffsPolicyValidationTemplatesGetResponsesContentApplicationJsonSchemaDataPolicyTypesItems": { "properties": { "description": { "description": "Description of the policy type.", "type": [ "string", "null" ] }, "id": { "description": "Unique identifier of the policy type.", "format": "uuid", "type": "string" }, "name": { "description": "Name of the policy type.", "type": "string" } }, "title": "TimeOffsPolicyValidationTemplatesGetResponsesContentApplicationJsonSchemaDataPolicyTypesItems", "type": "object" }, "TimeOffsPolicyValidationTemplatesGetResponsesContentApplicationJsonSchemaDataPolicyValidationTemplatesItems": { "properties": { "adoption_date_definition": { "$ref": "#/components/schemas/TimeOffsPolicyValidationTemplatesGetResponsesContentApplicationJsonSchemaDataPolicyValidationTemplatesItemsAdoptionDateDefinition", "description": "Rule regarding the requirement of an adoption date for relevant policies." }, "allow_approvers_to_request": { "description": "Whether designated approvers can also request time off under this policy.", "type": "boolean" }, "allow_estimated_end_date": { "description": "Whether an estimated end date can be provided for the time off request.", "type": "boolean" }, "allow_time_off_payment_treatment_upsert": { "description": "Whether payment treatment details can be updated.", "type": [ "boolean", "null" ] }, "allow_to_edit_past_time_offs": { "description": "Whether past time off requests under this policy can be edited.", "type": "boolean" }, "attachment_condition": { "description": "Comparison operator if attachment is conditionally required.", "oneOf": [ { "$ref": "#/components/schemas/TimeOffsPolicyValidationTemplatesGetResponsesContentApplicationJsonSchemaDataPolicyValidationTemplatesItemsAttachmentCondition" }, { "type": "null" } ] }, "attachment_condition_amount": { "description": "Threshold amount for the attachment condition.", "type": [ "integer", "null" ] }, "attachment_condition_unit": { "description": "Unit for the attachment condition amount.", "oneOf": [ { "$ref": "#/components/schemas/TimeOffsPolicyValidationTemplatesGetResponsesContentApplicationJsonSchemaDataPolicyValidationTemplatesItemsAttachmentConditionUnit" }, { "type": "null" } ] }, "auto_approval_inactivity_time_unit": { "description": "Unit for the auto-approval inactivity period.", "oneOf": [ { "$ref": "#/components/schemas/TimeOffsPolicyValidationTemplatesGetResponsesContentApplicationJsonSchemaDataPolicyValidationTemplatesItemsAutoApprovalInactivityTimeUnit" }, { "type": "null" } ] }, "auto_approval_inactivity_time_unit_amount": { "description": "Amount for the auto-approval inactivity period.", "type": [ "integer", "null" ] }, "benefits_payer_type": { "$ref": "#/components/schemas/TimeOffsPolicyValidationTemplatesGetResponsesContentApplicationJsonSchemaDataPolicyValidationTemplatesItemsBenefitsPayerType", "description": "Who pays for the benefits associated with this time off." }, "country": { "description": "Country code associated with this specific template instance, if applicable.", "maxLength": 2, "minLength": 2, "pattern": "^[A-Z]{2}$", "type": [ "string", "null" ] }, "default_entitlement_unit_amount": { "description": "Default amount of entitlement granted per cycle.", "format": "double", "type": [ "number", "null" ] }, "disable_termination_editing": { "description": "Whether editing related to termination is disabled.", "type": "boolean" }, "edit_approved_mode": { "description": "Controls edit/cancel permissions on approved time off requests. Supersedes allow_to_edit_past_time_offs.", "oneOf": [ { "$ref": "#/components/schemas/TimeOffsPolicyValidationTemplatesGetResponsesContentApplicationJsonSchemaDataPolicyValidationTemplatesItemsEditApprovedMode" }, { "type": "null" } ] }, "enable_absence_percentage_requests": { "description": "Whether requests can be made as a percentage of the workday.", "type": "boolean" }, "enable_accrued_days_for_policy_on_termination_flow": { "description": "Calculate accrued days specifically for this policy during termination.", "type": "boolean" }, "enable_high_accuracy_accrued_days_on_termination_flow": { "description": "Use high accuracy calculation for accrued days during termination.", "type": "boolean" }, "enable_pay_out_balance": { "description": "Whether unused balance can be paid out.", "type": "boolean" }, "enabled_policy_fields": { "description": "List of specific policy fields that are enabled or configurable.", "items": { "type": "string" }, "type": [ "array", "null" ] }, "estimated_end_date_client_reminder": { "description": "Days before estimated end date to remind the client/manager.", "items": { "type": "integer" }, "type": [ "array", "null" ] }, "estimated_end_date_worker_reminder": { "description": "Days before estimated end date to remind the worker.", "items": { "type": "integer" }, "type": [ "array", "null" ] }, "id": { "description": "Unique identifier for the policy validation template.", "format": "uuid", "type": "string" }, "include_in_termination_flow": { "description": "Whether this policy is considered during the termination process.", "type": "boolean" }, "is_auto_approval_on_inactivity_enabled": { "description": "Whether requests are automatically approved after a period of inactivity.", "type": [ "boolean", "null" ] }, "is_payment_top_off": { "description": "Indicates if the policy involves payment top-offs.", "type": "boolean" }, "leave_type": { "$ref": "#/components/schemas/TimeOffsPolicyValidationTemplatesGetResponsesContentApplicationJsonSchemaDataPolicyValidationTemplatesItemsLeaveType", "description": "Classification of the leave duration." }, "max_entitlement_unit_amount": { "description": "Maximum allowed entitlement amount.", "format": "double", "type": [ "number", "null" ] }, "max_request_start_unit_amount": { "description": "Maximum waiting period amount if request_start_type is FIXED_PERIOD.", "type": [ "integer", "null" ] }, "max_time_off_per_tracking": { "description": "Maximum amount of time off allowed per tracking cycle.", "format": "double", "type": [ "number", "null" ] }, "max_tracking_unit_amount": { "description": "Maximum duration of the tracking cycle in tracking_unit.", "type": [ "integer", "null" ] }, "maximum_time_off_request_amount": { "description": "Maximum amount that can be requested in a single time off request.", "format": "double", "type": [ "number", "null" ] }, "min_entitlement_unit_amount": { "description": "Minimum allowed entitlement amount.", "format": "double", "type": [ "number", "null" ] }, "min_request_start_unit_amount": { "description": "Minimum waiting period amount if request_start_type is FIXED_PERIOD.", "type": [ "integer", "null" ] }, "min_time_off_per_tracking": { "description": "Minimum amount of time off required per tracking cycle.", "format": "double", "type": [ "number", "null" ] }, "min_tracking_unit_amount": { "description": "Minimum duration of the tracking cycle in tracking_unit.", "type": [ "integer", "null" ] }, "minimum_time_off_request_amount": { "description": "Minimum amount that can be requested in a single time off request.", "format": "double", "type": [ "number", "null" ] }, "notice_period_unit": { "description": "Unit for the required notice period.", "oneOf": [ { "$ref": "#/components/schemas/TimeOffsPolicyValidationTemplatesGetResponsesContentApplicationJsonSchemaDataPolicyValidationTemplatesItemsNoticePeriodUnit" }, { "type": "null" } ] }, "notice_period_unit_amount": { "description": "Amount for the required notice period.", "type": [ "integer", "null" ] }, "ops_workbench_process_template_reference": { "description": "Reference to an Ops Workbench process template, if applicable.", "type": [ "string", "null" ] }, "overlap_request_type": { "$ref": "#/components/schemas/TimeOffsPolicyValidationTemplatesGetResponsesContentApplicationJsonSchemaDataPolicyValidationTemplatesItemsOverlapRequestType", "description": "Rule for requesting time off that overlaps with existing requests." }, "policy_allowance_proration": { "description": "Proration rules applied to the policy allowances.", "oneOf": [ { "$ref": "#/components/schemas/TimeOffsPolicyValidationTemplatesGetResponsesContentApplicationJsonSchemaDataPolicyValidationTemplatesItemsPolicyAllowanceProration" }, { "type": "null" } ] }, "policy_allowances": { "description": "List of allowances defined within this policy template.", "items": { "$ref": "#/components/schemas/TimeOffsPolicyValidationTemplatesGetResponsesContentApplicationJsonSchemaDataPolicyValidationTemplatesItemsPolicyAllowancesItems" }, "type": "array" }, "policy_type": { "$ref": "#/components/schemas/TimeOffsPolicyValidationTemplatesGetResponsesContentApplicationJsonSchemaDataPolicyValidationTemplatesItemsPolicyType", "description": "Details of the associated policy type." }, "policy_type_id": { "description": "Identifier of the associated policy type.", "format": "uuid", "type": "string" }, "policy_validation_template_reminders": { "description": "Configuration for reminders related to this policy template.", "items": { "$ref": "#/components/schemas/TimeOffsPolicyValidationTemplatesGetResponsesContentApplicationJsonSchemaDataPolicyValidationTemplatesItemsPolicyValidationTemplateRemindersItems" }, "type": "array" }, "request_start_type": { "description": "When a worker can start requesting time off after becoming eligible.", "oneOf": [ { "$ref": "#/components/schemas/TimeOffsPolicyValidationTemplatesGetResponsesContentApplicationJsonSchemaDataPolicyValidationTemplatesItemsRequestStartType" }, { "type": "null" } ] }, "request_start_unit": { "description": "Unit for the waiting period if request_start_type is FIXED_PERIOD.", "oneOf": [ { "$ref": "#/components/schemas/TimeOffsPolicyValidationTemplatesGetResponsesContentApplicationJsonSchemaDataPolicyValidationTemplatesItemsRequestStartUnit" }, { "type": "null" } ] }, "require_notice_period": { "description": "Whether a notice period is required before taking time off.", "type": [ "boolean", "null" ] }, "retrospective_request_type": { "$ref": "#/components/schemas/TimeOffsPolicyValidationTemplatesGetResponsesContentApplicationJsonSchemaDataPolicyValidationTemplatesItemsRetrospectiveRequestType", "description": "Rule for requesting time off for past dates." }, "template_name": { "description": "Optional name for this specific template instance.", "type": [ "string", "null" ] }, "time_off_request_type": { "$ref": "#/components/schemas/TimeOffsPolicyValidationTemplatesGetResponsesContentApplicationJsonSchemaDataPolicyValidationTemplatesItemsTimeOffRequestType", "description": "Allowed types of time off requests (e.g., full day, hourly)." }, "time_off_type_validations": { "description": "Specific validation rules applied to time off types under this policy.", "items": { "$ref": "#/components/schemas/TimeOffsPolicyValidationTemplatesGetResponsesContentApplicationJsonSchemaDataPolicyValidationTemplatesItemsTimeOffTypeValidationsItems" }, "type": "array" }, "tracking_cadence": { "$ref": "#/components/schemas/TimeOffsPolicyValidationTemplatesGetResponsesContentApplicationJsonSchemaDataPolicyValidationTemplatesItemsTrackingCadence", "description": "Determines when the tracking cycle starts." }, "tracking_start_date": { "description": "Specific start date for FIXED_DAY tracking cadence (YYYY-MM-DD).", "format": "date", "type": [ "string", "null" ] }, "tracking_unit": { "description": "The unit used for tracking the policy cycle (e.g., yearly).", "oneOf": [ { "$ref": "#/components/schemas/TimeOffsPolicyValidationTemplatesGetResponsesContentApplicationJsonSchemaDataPolicyValidationTemplatesItemsTrackingUnit" }, { "type": "null" } ] }, "upload_attachment_condition": { "$ref": "#/components/schemas/TimeOffsPolicyValidationTemplatesGetResponsesContentApplicationJsonSchemaDataPolicyValidationTemplatesItemsUploadAttachmentCondition", "description": "Condition under which an attachment is needed for a request." } }, "title": "TimeOffsPolicyValidationTemplatesGetResponsesContentApplicationJsonSchemaDataPolicyValidationTemplatesItems", "type": "object" }, "TimeOffsPolicyValidationTemplatesGetResponsesContentApplicationJsonSchemaDataPolicyValidationTemplatesItemsAdoptionDateDefinition": { "description": "Rule regarding the requirement of an adoption date for relevant policies.", "enum": [ "REQUIRED", "OPTIONAL", "FORBIDDEN" ], "title": "TimeOffsPolicyValidationTemplatesGetResponsesContentApplicationJsonSchemaDataPolicyValidationTemplatesItemsAdoptionDateDefinition", "type": "string" }, "TimeOffsPolicyValidationTemplatesGetResponsesContentApplicationJsonSchemaDataPolicyValidationTemplatesItemsAttachmentCondition": { "description": "Comparison operator if attachment is conditionally required.", "enum": [ "GREATER_THAN", "LESS_THAN", "GREATER_THAN_OR_EQUAL", "LESS_THAN_OR_EQUAL" ], "title": "TimeOffsPolicyValidationTemplatesGetResponsesContentApplicationJsonSchemaDataPolicyValidationTemplatesItemsAttachmentCondition", "type": "string" }, "TimeOffsPolicyValidationTemplatesGetResponsesContentApplicationJsonSchemaDataPolicyValidationTemplatesItemsAttachmentConditionUnit": { "description": "Unit for the attachment condition amount.", "enum": [ "YEAR", "MONTH", "WEEK", "DAY", "BUSINESS_DAY", "CALENDAR_DAY", "HOUR" ], "title": "TimeOffsPolicyValidationTemplatesGetResponsesContentApplicationJsonSchemaDataPolicyValidationTemplatesItemsAttachmentConditionUnit", "type": "string" }, "TimeOffsPolicyValidationTemplatesGetResponsesContentApplicationJsonSchemaDataPolicyValidationTemplatesItemsAutoApprovalInactivityTimeUnit": { "description": "Unit for the auto-approval inactivity period.", "enum": [ "YEAR", "MONTH", "WEEK", "DAY", "BUSINESS_DAY", "CALENDAR_DAY", "HOUR" ], "title": "TimeOffsPolicyValidationTemplatesGetResponsesContentApplicationJsonSchemaDataPolicyValidationTemplatesItemsAutoApprovalInactivityTimeUnit", "type": "string" }, "TimeOffsPolicyValidationTemplatesGetResponsesContentApplicationJsonSchemaDataPolicyValidationTemplatesItemsBenefitsPayerType": { "description": "Who pays for the benefits associated with this time off.", "enum": [ "ORGANIZATION", "GOVERNMENT" ], "title": "TimeOffsPolicyValidationTemplatesGetResponsesContentApplicationJsonSchemaDataPolicyValidationTemplatesItemsBenefitsPayerType", "type": "string" }, "TimeOffsPolicyValidationTemplatesGetResponsesContentApplicationJsonSchemaDataPolicyValidationTemplatesItemsEditApprovedMode": { "description": "Controls edit/cancel permissions on approved time off requests. Supersedes allow_to_edit_past_time_offs.", "enum": [ "RESTRICT_FULLY", "RESTRICT_BEYOND_CYCLE", "NO_RESTRICT" ], "title": "TimeOffsPolicyValidationTemplatesGetResponsesContentApplicationJsonSchemaDataPolicyValidationTemplatesItemsEditApprovedMode", "type": "string" }, "TimeOffsPolicyValidationTemplatesGetResponsesContentApplicationJsonSchemaDataPolicyValidationTemplatesItemsLeaveType": { "description": "Classification of the leave duration.", "enum": [ "SHORT_TERM_LEAVE", "LONG_TERM_LEAVE" ], "title": "TimeOffsPolicyValidationTemplatesGetResponsesContentApplicationJsonSchemaDataPolicyValidationTemplatesItemsLeaveType", "type": "string" }, "TimeOffsPolicyValidationTemplatesGetResponsesContentApplicationJsonSchemaDataPolicyValidationTemplatesItemsNoticePeriodUnit": { "description": "Unit for the required notice period.", "enum": [ "YEAR", "MONTH", "WEEK", "DAY", "BUSINESS_DAY", "CALENDAR_DAY", "HOUR" ], "title": "TimeOffsPolicyValidationTemplatesGetResponsesContentApplicationJsonSchemaDataPolicyValidationTemplatesItemsNoticePeriodUnit", "type": "string" }, "TimeOffsPolicyValidationTemplatesGetResponsesContentApplicationJsonSchemaDataPolicyValidationTemplatesItemsOverlapRequestType": { "description": "Rule for requesting time off that overlaps with existing requests.", "enum": [ "ALLOWED", "NOT_ALLOWED", "ALLOWED_WITH_APPROVAL" ], "title": "TimeOffsPolicyValidationTemplatesGetResponsesContentApplicationJsonSchemaDataPolicyValidationTemplatesItemsOverlapRequestType", "type": "string" }, "TimeOffsPolicyValidationTemplatesGetResponsesContentApplicationJsonSchemaDataPolicyValidationTemplatesItemsPolicyAllowanceProration": { "description": "Proration rules applied to the policy allowances.", "properties": { "has_partial_prorate": { "description": "Indicates if partial proration rules are applied.", "type": "boolean" }, "hire_proration_cut_off_date": { "description": "Day of the month used as cut-off for hire proration.", "type": [ "integer", "null" ] }, "hire_proration_rule": { "$ref": "#/components/schemas/TimeOffsPolicyValidationTemplatesGetResponsesContentApplicationJsonSchemaDataPolicyValidationTemplatesItemsPolicyAllowanceProrationHireProrationRule", "description": "Rule for prorating entitlement upon hiring." }, "id": { "description": "Unique identifier for the proration settings.", "format": "uuid", "type": "string" }, "is_accrual_prorate_policy": { "description": "Indicates if accrual is prorated based on policy rules.", "type": "boolean" }, "max_part_time_worker_treatment_specific_amount": { "description": "Maximum specific amount for part-time treatment.", "format": "double", "type": [ "number", "null" ] }, "min_part_time_worker_treatment_specific_amount": { "description": "Minimum specific amount for part-time treatment.", "format": "double", "type": [ "number", "null" ] }, "part_time_worker_treatment_specific_amount": { "description": "Specific amount if treatment type is SPECIFIC_AMOUNT.", "format": "double", "type": [ "number", "null" ] }, "part_time_worker_treatment_type": { "$ref": "#/components/schemas/TimeOffsPolicyValidationTemplatesGetResponsesContentApplicationJsonSchemaDataPolicyValidationTemplatesItemsPolicyAllowanceProrationPartTimeWorkerTreatmentType", "description": "How part-time workers are treated regarding entitlement." }, "termination_proration_cut_off_date": { "description": "Day of the month used as cut-off for termination proration.", "type": [ "integer", "null" ] }, "termination_proration_rule": { "$ref": "#/components/schemas/TimeOffsPolicyValidationTemplatesGetResponsesContentApplicationJsonSchemaDataPolicyValidationTemplatesItemsPolicyAllowanceProrationTerminationProrationRule", "description": "Rule for prorating entitlement upon termination." } }, "title": "TimeOffsPolicyValidationTemplatesGetResponsesContentApplicationJsonSchemaDataPolicyValidationTemplatesItemsPolicyAllowanceProration", "type": "object" }, "TimeOffsPolicyValidationTemplatesGetResponsesContentApplicationJsonSchemaDataPolicyValidationTemplatesItemsPolicyAllowanceProrationHireProrationRule": { "description": "Rule for prorating entitlement upon hiring.", "enum": [ "NO_PRORATION", "FULL_AMOUNT", "PRORATED_MONTHLY", "PRORATED_DAILY", "COUNTRY_SPECIFIC", "FULL_MONTH_PRORATION_BASED_ON_DAY", "TENURE_BOUNDARY_PRORATION" ], "title": "TimeOffsPolicyValidationTemplatesGetResponsesContentApplicationJsonSchemaDataPolicyValidationTemplatesItemsPolicyAllowanceProrationHireProrationRule", "type": "string" }, "TimeOffsPolicyValidationTemplatesGetResponsesContentApplicationJsonSchemaDataPolicyValidationTemplatesItemsPolicyAllowanceProrationPartTimeWorkerTreatmentType": { "description": "How part-time workers are treated regarding entitlement.", "enum": [ "SAME_AS_FTE", "SPECIFIC_AMOUNT", "PRO_RATA", "PERCENTAGE_OF_FTE", "BASED_ON_WORK_HOURS", "BASED_ON_WORK_DAYS", "CUSTOM_ENTITLEMENT" ], "title": "TimeOffsPolicyValidationTemplatesGetResponsesContentApplicationJsonSchemaDataPolicyValidationTemplatesItemsPolicyAllowanceProrationPartTimeWorkerTreatmentType", "type": "string" }, "TimeOffsPolicyValidationTemplatesGetResponsesContentApplicationJsonSchemaDataPolicyValidationTemplatesItemsPolicyAllowanceProrationTerminationProrationRule": { "description": "Rule for prorating entitlement upon termination.", "enum": [ "NO_PRORATION", "FULL_AMOUNT", "PRORATED_MONTHLY", "PRORATED_DAILY", "COUNTRY_SPECIFIC", "FULL_MONTH_PRORATION_BASED_ON_DAY", "TENURE_BOUNDARY_PRORATION" ], "title": "TimeOffsPolicyValidationTemplatesGetResponsesContentApplicationJsonSchemaDataPolicyValidationTemplatesItemsPolicyAllowanceProrationTerminationProrationRule", "type": "string" }, "TimeOffsPolicyValidationTemplatesGetResponsesContentApplicationJsonSchemaDataPolicyValidationTemplatesItemsPolicyAllowancesItems": { "properties": { "accrual_application_type": { "description": "When the accrued amount is applied to the balance.", "oneOf": [ { "$ref": "#/components/schemas/TimeOffsPolicyValidationTemplatesGetResponsesContentApplicationJsonSchemaDataPolicyValidationTemplatesItemsPolicyAllowancesItemsAccrualApplicationType" }, { "type": "null" } ] }, "accrual_prorate_types": { "description": "Specifies conditions under which accrual should be prorated.", "items": { "$ref": "#/components/schemas/TimeOffsPolicyValidationTemplatesGetResponsesContentApplicationJsonSchemaDataPolicyValidationTemplatesItemsPolicyAllowancesItemsAccrualProrateTypesItems" }, "type": [ "array", "null" ] }, "accrual_type": { "$ref": "#/components/schemas/TimeOffsPolicyValidationTemplatesGetResponsesContentApplicationJsonSchemaDataPolicyValidationTemplatesItemsPolicyAllowancesItemsAccrualType", "description": "How entitlement accrues (over time or based on events)." }, "accrual_unit": { "description": "Unit for accrual if type is TIMEFRAME.", "oneOf": [ { "$ref": "#/components/schemas/TimeOffsPolicyValidationTemplatesGetResponsesContentApplicationJsonSchemaDataPolicyValidationTemplatesItemsPolicyAllowancesItemsAccrualUnit" }, { "type": "null" } ] }, "accrual_unit_amount": { "description": "Amount of accrual per unit if type is TIMEFRAME.", "type": [ "integer", "null" ] }, "additional_allowance_rules": { "description": "Specific rules governing additional allowances.", "items": { "$ref": "#/components/schemas/TimeOffsPolicyValidationTemplatesGetResponsesContentApplicationJsonSchemaDataPolicyValidationTemplatesItemsPolicyAllowancesItemsAdditionalAllowanceRulesItems" }, "type": "array" }, "balance_tracking_flexible_custom_request_amount": { "description": "Custom amount for flexible balance tracking if applicable.", "type": [ "integer", "null" ] }, "balance_tracking_type": { "description": "How the balance is tracked (e.g., flexible, inflexible).", "oneOf": [ { "$ref": "#/components/schemas/TimeOffsPolicyValidationTemplatesGetResponsesContentApplicationJsonSchemaDataPolicyValidationTemplatesItemsPolicyAllowancesItemsBalanceTrackingType" }, { "type": "null" } ] }, "enable_bank_holidays": { "description": "Whether bank holidays affect the entitlement or usage.", "type": "boolean" }, "entitlement_expiration_unit": { "description": "Unit for entitlement expiration period.", "oneOf": [ { "$ref": "#/components/schemas/TimeOffsPolicyValidationTemplatesGetResponsesContentApplicationJsonSchemaDataPolicyValidationTemplatesItemsPolicyAllowancesItemsEntitlementExpirationUnit" }, { "type": "null" } ] }, "entitlement_expiration_unit_amount": { "description": "Amount for entitlement expiration period.", "type": [ "integer", "null" ] }, "entitlement_start_type": { "description": "When the entitlement starts.", "oneOf": [ { "$ref": "#/components/schemas/TimeOffsPolicyValidationTemplatesGetResponsesContentApplicationJsonSchemaDataPolicyValidationTemplatesItemsPolicyAllowancesItemsEntitlementStartType" }, { "type": "null" } ] }, "entitlement_start_unit": { "description": "Unit for the start period if type is FIXED_PERIOD.", "oneOf": [ { "$ref": "#/components/schemas/TimeOffsPolicyValidationTemplatesGetResponsesContentApplicationJsonSchemaDataPolicyValidationTemplatesItemsPolicyAllowancesItemsEntitlementStartUnit" }, { "type": "null" } ] }, "entitlement_start_unit_amount": { "description": "Amount for the start period if type is FIXED_PERIOD.", "type": [ "integer", "null" ] }, "entitlement_unit": { "$ref": "#/components/schemas/TimeOffsPolicyValidationTemplatesGetResponsesContentApplicationJsonSchemaDataPolicyValidationTemplatesItemsPolicyAllowancesItemsEntitlementUnit", "description": "Unit in which the entitlement is measured." }, "entitlement_unit_amount": { "description": "Amount of entitlement granted in entitlement_unit.", "format": "double", "type": [ "number", "null" ] }, "id": { "description": "Unique identifier for the policy allowance.", "format": "uuid", "type": "string" }, "name": { "description": "Name of the allowance.", "type": "string" }, "part_time_worker_additional_allowance_type": { "$ref": "#/components/schemas/TimeOffsPolicyValidationTemplatesGetResponsesContentApplicationJsonSchemaDataPolicyValidationTemplatesItemsPolicyAllowancesItemsPartTimeWorkerAdditionalAllowanceType", "description": "How additional allowances apply to part-time workers." }, "rollover_expiration_unit": { "description": "Unit for the expiration period of rolled-over balance.", "oneOf": [ { "$ref": "#/components/schemas/TimeOffsPolicyValidationTemplatesGetResponsesContentApplicationJsonSchemaDataPolicyValidationTemplatesItemsPolicyAllowancesItemsRolloverExpirationUnit" }, { "type": "null" } ] }, "rollover_expiration_unit_amount": { "description": "Amount for the expiration period of rolled-over balance.", "type": [ "integer", "null" ] }, "rollover_limit_unit_amount": { "description": "Maximum amount that can be rolled over if type is LIMITED_ROLLOVER.", "type": [ "integer", "null" ] }, "rollover_type": { "description": "Rule for carrying over unused balance to the next cycle.", "oneOf": [ { "$ref": "#/components/schemas/TimeOffsPolicyValidationTemplatesGetResponsesContentApplicationJsonSchemaDataPolicyValidationTemplatesItemsPolicyAllowancesItemsRolloverType" }, { "type": "null" } ] }, "termination_type": { "$ref": "#/components/schemas/TimeOffsPolicyValidationTemplatesGetResponsesContentApplicationJsonSchemaDataPolicyValidationTemplatesItemsPolicyAllowancesItemsTerminationType", "description": "Rule for handling the balance upon termination." }, "type": { "$ref": "#/components/schemas/TimeOffsPolicyValidationTemplatesGetResponsesContentApplicationJsonSchemaDataPolicyValidationTemplatesItemsPolicyAllowancesItemsType", "description": "Type of allowance (base or additional)." }, "zero_out_negative_balances_on_rollover": { "description": "Whether negative balances are reset to zero at rollover.", "type": "boolean" } }, "title": "TimeOffsPolicyValidationTemplatesGetResponsesContentApplicationJsonSchemaDataPolicyValidationTemplatesItemsPolicyAllowancesItems", "type": "object" }, "TimeOffsPolicyValidationTemplatesGetResponsesContentApplicationJsonSchemaDataPolicyValidationTemplatesItemsPolicyAllowancesItemsAccrualApplicationType": { "description": "When the accrued amount is applied to the balance.", "enum": [ "BEGIN_OF_CYCLE", "BEGIN_OF_NEXT_CYCLE", "END_OF_CYCLE" ], "title": "TimeOffsPolicyValidationTemplatesGetResponsesContentApplicationJsonSchemaDataPolicyValidationTemplatesItemsPolicyAllowancesItemsAccrualApplicationType", "type": "string" }, "TimeOffsPolicyValidationTemplatesGetResponsesContentApplicationJsonSchemaDataPolicyValidationTemplatesItemsPolicyAllowancesItemsAccrualProrateTypesItems": { "enum": [ "PRORATE_UNPAID_LEAVE", "PRORATE_PAID_LEAVE", "NO_PRORATE" ], "title": "TimeOffsPolicyValidationTemplatesGetResponsesContentApplicationJsonSchemaDataPolicyValidationTemplatesItemsPolicyAllowancesItemsAccrualProrateTypesItems", "type": "string" }, "TimeOffsPolicyValidationTemplatesGetResponsesContentApplicationJsonSchemaDataPolicyValidationTemplatesItemsPolicyAllowancesItemsAccrualType": { "description": "How entitlement accrues (over time or based on events).", "enum": [ "TIMEFRAME", "EVENT", "TIME_OFF_IN_LIEU", "HOURLY", "LUMPSUM", "NO_AUTO_ACCRUAL" ], "title": "TimeOffsPolicyValidationTemplatesGetResponsesContentApplicationJsonSchemaDataPolicyValidationTemplatesItemsPolicyAllowancesItemsAccrualType", "type": "string" }, "TimeOffsPolicyValidationTemplatesGetResponsesContentApplicationJsonSchemaDataPolicyValidationTemplatesItemsPolicyAllowancesItemsAccrualUnit": { "description": "Unit for accrual if type is TIMEFRAME.", "enum": [ "YEAR", "MONTH", "WEEK", "DAY", "BUSINESS_DAY", "CALENDAR_DAY", "HOUR" ], "title": "TimeOffsPolicyValidationTemplatesGetResponsesContentApplicationJsonSchemaDataPolicyValidationTemplatesItemsPolicyAllowancesItemsAccrualUnit", "type": "string" }, "TimeOffsPolicyValidationTemplatesGetResponsesContentApplicationJsonSchemaDataPolicyValidationTemplatesItemsPolicyAllowancesItemsAdditionalAllowanceRulesItems": { "properties": {}, "title": "TimeOffsPolicyValidationTemplatesGetResponsesContentApplicationJsonSchemaDataPolicyValidationTemplatesItemsPolicyAllowancesItemsAdditionalAllowanceRulesItems", "type": "object" }, "TimeOffsPolicyValidationTemplatesGetResponsesContentApplicationJsonSchemaDataPolicyValidationTemplatesItemsPolicyAllowancesItemsBalanceTrackingType": { "description": "How the balance is tracked (e.g., flexible, inflexible).", "enum": [ "FLEXIBLE_UP_TO_YEARLY_ALLOWANCE", "FLEXIBLE_NO_LIMIT", "FLEXIBLE_CUSTOM_AMOUNT", "INFLEXIBLE" ], "title": "TimeOffsPolicyValidationTemplatesGetResponsesContentApplicationJsonSchemaDataPolicyValidationTemplatesItemsPolicyAllowancesItemsBalanceTrackingType", "type": "string" }, "TimeOffsPolicyValidationTemplatesGetResponsesContentApplicationJsonSchemaDataPolicyValidationTemplatesItemsPolicyAllowancesItemsEntitlementExpirationUnit": { "description": "Unit for entitlement expiration period.", "enum": [ "YEAR", "MONTH", "WEEK", "DAY", "BUSINESS_DAY", "CALENDAR_DAY", "HOUR" ], "title": "TimeOffsPolicyValidationTemplatesGetResponsesContentApplicationJsonSchemaDataPolicyValidationTemplatesItemsPolicyAllowancesItemsEntitlementExpirationUnit", "type": "string" }, "TimeOffsPolicyValidationTemplatesGetResponsesContentApplicationJsonSchemaDataPolicyValidationTemplatesItemsPolicyAllowancesItemsEntitlementStartType": { "description": "When the entitlement starts.", "enum": [ "IMMEDIATELY", "FIXED_PERIOD", "FIXED_DATE" ], "title": "TimeOffsPolicyValidationTemplatesGetResponsesContentApplicationJsonSchemaDataPolicyValidationTemplatesItemsPolicyAllowancesItemsEntitlementStartType", "type": "string" }, "TimeOffsPolicyValidationTemplatesGetResponsesContentApplicationJsonSchemaDataPolicyValidationTemplatesItemsPolicyAllowancesItemsEntitlementStartUnit": { "description": "Unit for the start period if type is FIXED_PERIOD.", "enum": [ "YEAR", "MONTH", "WEEK", "DAY", "BUSINESS_DAY", "CALENDAR_DAY", "HOUR" ], "title": "TimeOffsPolicyValidationTemplatesGetResponsesContentApplicationJsonSchemaDataPolicyValidationTemplatesItemsPolicyAllowancesItemsEntitlementStartUnit", "type": "string" }, "TimeOffsPolicyValidationTemplatesGetResponsesContentApplicationJsonSchemaDataPolicyValidationTemplatesItemsPolicyAllowancesItemsEntitlementUnit": { "description": "Unit in which the entitlement is measured.", "enum": [ "YEAR", "MONTH", "WEEK", "DAY", "BUSINESS_DAY", "CALENDAR_DAY", "HOUR" ], "title": "TimeOffsPolicyValidationTemplatesGetResponsesContentApplicationJsonSchemaDataPolicyValidationTemplatesItemsPolicyAllowancesItemsEntitlementUnit", "type": "string" }, "TimeOffsPolicyValidationTemplatesGetResponsesContentApplicationJsonSchemaDataPolicyValidationTemplatesItemsPolicyAllowancesItemsPartTimeWorkerAdditionalAllowanceType": { "description": "How additional allowances apply to part-time workers.", "enum": [ "SAME_AS_FTE", "PERCENTAGE_OF_FTE", "NO_ADDITIONAL_ALLOWANCE" ], "title": "TimeOffsPolicyValidationTemplatesGetResponsesContentApplicationJsonSchemaDataPolicyValidationTemplatesItemsPolicyAllowancesItemsPartTimeWorkerAdditionalAllowanceType", "type": "string" }, "TimeOffsPolicyValidationTemplatesGetResponsesContentApplicationJsonSchemaDataPolicyValidationTemplatesItemsPolicyAllowancesItemsRolloverExpirationUnit": { "description": "Unit for the expiration period of rolled-over balance.", "enum": [ "YEAR", "MONTH", "WEEK", "DAY", "BUSINESS_DAY", "CALENDAR_DAY", "HOUR" ], "title": "TimeOffsPolicyValidationTemplatesGetResponsesContentApplicationJsonSchemaDataPolicyValidationTemplatesItemsPolicyAllowancesItemsRolloverExpirationUnit", "type": "string" }, "TimeOffsPolicyValidationTemplatesGetResponsesContentApplicationJsonSchemaDataPolicyValidationTemplatesItemsPolicyAllowancesItemsRolloverType": { "description": "Rule for carrying over unused balance to the next cycle.", "enum": [ "NO_ROLLOVER", "LIMITED_ROLLOVER", "UNLIMITED_ROLLOVER", "PAY_OUT", "CARRY_OVER", "CARRY_OVER_PAY_OUT" ], "title": "TimeOffsPolicyValidationTemplatesGetResponsesContentApplicationJsonSchemaDataPolicyValidationTemplatesItemsPolicyAllowancesItemsRolloverType", "type": "string" }, "TimeOffsPolicyValidationTemplatesGetResponsesContentApplicationJsonSchemaDataPolicyValidationTemplatesItemsPolicyAllowancesItemsTerminationType": { "description": "Rule for handling the balance upon termination.", "enum": [ "NO_PAYOUT", "PAYOUT_BALANCE" ], "title": "TimeOffsPolicyValidationTemplatesGetResponsesContentApplicationJsonSchemaDataPolicyValidationTemplatesItemsPolicyAllowancesItemsTerminationType", "type": "string" }, "TimeOffsPolicyValidationTemplatesGetResponsesContentApplicationJsonSchemaDataPolicyValidationTemplatesItemsPolicyAllowancesItemsType": { "description": "Type of allowance (base or additional).", "enum": [ "BASE_ALLOWANCE", "ADDITIONAL_ALLOWANCE" ], "title": "TimeOffsPolicyValidationTemplatesGetResponsesContentApplicationJsonSchemaDataPolicyValidationTemplatesItemsPolicyAllowancesItemsType", "type": "string" }, "TimeOffsPolicyValidationTemplatesGetResponsesContentApplicationJsonSchemaDataPolicyValidationTemplatesItemsPolicyType": { "description": "Details of the associated policy type.", "properties": { "description": { "description": "Description of the policy type.", "type": [ "string", "null" ] }, "id": { "description": "Unique identifier of the policy type.", "format": "uuid", "type": "string" }, "name": { "description": "Name of the policy type.", "type": "string" } }, "title": "TimeOffsPolicyValidationTemplatesGetResponsesContentApplicationJsonSchemaDataPolicyValidationTemplatesItemsPolicyType", "type": "object" }, "TimeOffsPolicyValidationTemplatesGetResponsesContentApplicationJsonSchemaDataPolicyValidationTemplatesItemsPolicyValidationTemplateRemindersItems": { "properties": {}, "title": "TimeOffsPolicyValidationTemplatesGetResponsesContentApplicationJsonSchemaDataPolicyValidationTemplatesItemsPolicyValidationTemplateRemindersItems", "type": "object" }, "TimeOffsPolicyValidationTemplatesGetResponsesContentApplicationJsonSchemaDataPolicyValidationTemplatesItemsRequestStartType": { "description": "When a worker can start requesting time off after becoming eligible.", "enum": [ "IMMEDIATELY", "FIXED_PERIOD" ], "title": "TimeOffsPolicyValidationTemplatesGetResponsesContentApplicationJsonSchemaDataPolicyValidationTemplatesItemsRequestStartType", "type": "string" }, "TimeOffsPolicyValidationTemplatesGetResponsesContentApplicationJsonSchemaDataPolicyValidationTemplatesItemsRequestStartUnit": { "description": "Unit for the waiting period if request_start_type is FIXED_PERIOD.", "enum": [ "YEAR", "MONTH", "WEEK", "DAY", "BUSINESS_DAY", "CALENDAR_DAY", "HOUR" ], "title": "TimeOffsPolicyValidationTemplatesGetResponsesContentApplicationJsonSchemaDataPolicyValidationTemplatesItemsRequestStartUnit", "type": "string" }, "TimeOffsPolicyValidationTemplatesGetResponsesContentApplicationJsonSchemaDataPolicyValidationTemplatesItemsRetrospectiveRequestType": { "description": "Rule for requesting time off for past dates.", "enum": [ "ALLOWED", "NOT_ALLOWED", "ALLOWED_WITH_APPROVAL" ], "title": "TimeOffsPolicyValidationTemplatesGetResponsesContentApplicationJsonSchemaDataPolicyValidationTemplatesItemsRetrospectiveRequestType", "type": "string" }, "TimeOffsPolicyValidationTemplatesGetResponsesContentApplicationJsonSchemaDataPolicyValidationTemplatesItemsTimeOffRequestType": { "description": "Allowed types of time off requests (e.g., full day, hourly).", "enum": [ "FULL_DAY", "HALF_DAY", "HOURLY", "PERCENTAGE", "FLEXIBLE" ], "title": "TimeOffsPolicyValidationTemplatesGetResponsesContentApplicationJsonSchemaDataPolicyValidationTemplatesItemsTimeOffRequestType", "type": "string" }, "TimeOffsPolicyValidationTemplatesGetResponsesContentApplicationJsonSchemaDataPolicyValidationTemplatesItemsTimeOffTypeValidationsItems": { "properties": {}, "title": "TimeOffsPolicyValidationTemplatesGetResponsesContentApplicationJsonSchemaDataPolicyValidationTemplatesItemsTimeOffTypeValidationsItems", "type": "object" }, "TimeOffsPolicyValidationTemplatesGetResponsesContentApplicationJsonSchemaDataPolicyValidationTemplatesItemsTrackingCadence": { "description": "Determines when the tracking cycle starts.", "enum": [ "FIXED_DAY", "ANNIVERSARY", "NOT_SPECIFIED" ], "title": "TimeOffsPolicyValidationTemplatesGetResponsesContentApplicationJsonSchemaDataPolicyValidationTemplatesItemsTrackingCadence", "type": "string" }, "TimeOffsPolicyValidationTemplatesGetResponsesContentApplicationJsonSchemaDataPolicyValidationTemplatesItemsTrackingUnit": { "description": "The unit used for tracking the policy cycle (e.g., yearly).", "enum": [ "YEAR", "MONTH", "WEEK", "DAY", "BUSINESS_DAY", "CALENDAR_DAY", "HOUR" ], "title": "TimeOffsPolicyValidationTemplatesGetResponsesContentApplicationJsonSchemaDataPolicyValidationTemplatesItemsTrackingUnit", "type": "string" }, "TimeOffsPolicyValidationTemplatesGetResponsesContentApplicationJsonSchemaDataPolicyValidationTemplatesItemsUploadAttachmentCondition": { "description": "Condition under which an attachment is needed for a request.", "enum": [ "REQUIRED", "NOT_REQUIRED", "CONDITIONALLY_REQUIRED", "REQUIRED_WITH_CONDITION", "ALWAYS_REQUIRED" ], "title": "TimeOffsPolicyValidationTemplatesGetResponsesContentApplicationJsonSchemaDataPolicyValidationTemplatesItemsUploadAttachmentCondition", "type": "string" }, "TimeOffsPolicyValidationTemplatesGetResponsesContentApplicationJsonSchemaErrorsItems": { "properties": { "message": { "description": "A description of the returned error", "type": "string" }, "path": { "description": "The JSON path where input validation failed", "type": "string" } }, "title": "TimeOffsPolicyValidationTemplatesGetResponsesContentApplicationJsonSchemaErrorsItems", "type": "object" }, "TimeOffsPolicyValidationTemplatesGetResponsesContentApplicationJsonSchemaRequest": { "properties": { "api_req_id": { "description": "The request ID of the failed request", "type": "string" }, "code": { "description": "The code of the source handler which produced the returned error", "format": "double", "type": "number" }, "docs": { "description": "A link to the official documentation for the requested endpoint resource", "type": "string" }, "method": { "description": "The HTTP method of the failed request", "type": "string" }, "source": { "description": "The source handler which produced the returned error", "type": "string" }, "status": { "description": "The status code of the response", "format": "double", "type": "number" }, "url": { "description": "The relative URL of the failed request", "type": "string" } }, "title": "TimeOffsPolicyValidationTemplatesGetResponsesContentApplicationJsonSchemaRequest", "type": "object" }, "TimeOffsPostRequestBodyContentApplicationJsonSchemaData": { "description": "The time off request data", "properties": { "contract_oid": { "description": "Contract id. This is the id of the contract associated with the time off request.", "maxLength": 24, "type": [ "string", "null" ] }, "custom_field_values": { "description": "Answers to the custom fields the request policy declares, addressed by custom field id.", "items": { "$ref": "#/components/schemas/TimeOffsPostRequestBodyContentApplicationJsonSchemaDataCustomFieldValuesItems" }, "type": [ "array", "null" ] }, "dates": { "description": "The dates breakdown for the time off request.", "items": { "$ref": "#/components/schemas/TimeOffsPostRequestBodyContentApplicationJsonSchemaDataDatesItems" }, "type": "array" }, "deduction_amount": { "description": "Deduction amount. Available for independent contractor's policies", "title": "float", "type": [ "string", "null" ] }, "description": { "description": "Description of the time off request. Some policies require that a description is provided.", "maxLength": 500, "type": [ "string", "null" ] }, "end_date": { "$ref": "#/components/schemas/TimeOffsPostRequestBodyContentApplicationJsonSchemaDataEndDate", "description": "End date of the time off request. This is the date when the time off ends. For example, if you take 2 days off, this will be the end date of the second day." }, "event_details": { "$ref": "#/components/schemas/TimeOffsPostRequestBodyContentApplicationJsonSchemaDataEventDetails", "description": "Details of the event associated with the time off request. Required for event based policies such as parental leave." }, "is_paid": { "description": "Whether the time off is paid or unpaid. By default it follows the policy configuration.", "type": "boolean" }, "other_type_description": { "description": "Description of the time off type. This is used when the policy is OTHER.", "maxLength": 255, "type": [ "string", "null" ] }, "policy_id": { "description": "The time off policy id. Can be used in place of time_off_type_id", "format": "uuid", "type": "string" }, "reason": { "description": "Reason for taking time off. This is complementary information for the time-off description. Useful to provide sub categories for the same policy.", "maxLength": 500, "type": [ "string", "null" ] }, "recipient_profile_id": { "description": "The hris profile id of the recipient", "format": "uuid", "type": "string" }, "start_date": { "$ref": "#/components/schemas/TimeOffsPostRequestBodyContentApplicationJsonSchemaDataStartDate", "description": "Start date of the time off request. This is the date when the time off starts. For example, if you take 2 days off, this will be the start date of the first day." }, "status": { "$ref": "#/components/schemas/TimeOffsPostRequestBodyContentApplicationJsonSchemaDataStatus", "default": "APPROVED", "description": "Status for the time off request. When set to REQUESTED, the time off should be reviewed later through POST /time_offs/review." }, "time_off_event_id": { "description": "The time off event id. This is used to link the time off request to an event.", "format": "uuid", "type": "string" }, "time_off_percentage": { "description": "This is the percentage of time off taken. This is used when the time off request is a percentage.", "format": "double", "maximum": 1, "minimum": 0, "type": [ "number", "null" ] }, "time_off_type_id": { "description": "The time off type id. Required when policy_id is not provided", "format": "uuid", "type": "string" }, "use_deel_approval_flow": { "default": false, "description": "Whether to use Deel's approval flow for this time off request. If set to true, the time off request will go through Deel's approval flow instead of being handled through the public-api review time-off endpoint.", "type": "boolean" } }, "required": [ "end_date", "start_date", "recipient_profile_id" ], "title": "TimeOffsPostRequestBodyContentApplicationJsonSchemaData", "type": "object" }, "TimeOffsPostRequestBodyContentApplicationJsonSchemaDataCustomFieldValuesItems": { "properties": { "field_id": { "description": "The id of the custom field this value answers.", "format": "uuid", "type": "string" }, "value": { "description": "The submitted value for the custom field. Accepts a string, number, or boolean — always stored as text. `null` means \"no answer for this field\" and is rejected today, since no field supports a null answer yet.", "oneOf": [ { "$ref": "#/components/schemas/TimeOffsPostRequestBodyContentApplicationJsonSchemaDataCustomFieldValuesItemsValue" }, { "type": "null" } ] } }, "required": [ "value", "field_id" ], "title": "TimeOffsPostRequestBodyContentApplicationJsonSchemaDataCustomFieldValuesItems", "type": "object" }, "TimeOffsPostRequestBodyContentApplicationJsonSchemaDataCustomFieldValuesItemsValue": { "description": "The submitted value for the custom field. Accepts a string, number, or boolean — always stored as text. `null` means \"no answer for this field\" and is rejected today, since no field supports a null answer yet.", "oneOf": [ { "type": "string" }, { "format": "double", "type": "number" }, { "type": "boolean" } ], "title": "TimeOffsPostRequestBodyContentApplicationJsonSchemaDataCustomFieldValuesItemsValue" }, "TimeOffsPostRequestBodyContentApplicationJsonSchemaDataDatesItems": { "description": "The dates breakdown for the time off request.", "properties": { "amount": { "description": "The amount of time off requested for the date. It must be in the same time unit as in the total amount for the time off request.", "title": "float", "type": "string" }, "date": { "$ref": "#/components/schemas/TimeOffsPostRequestBodyContentApplicationJsonSchemaDataDatesItemsDate", "description": "An specific date in the time-off request" }, "day_type": { "$ref": "#/components/schemas/TimeOffsPostRequestBodyContentApplicationJsonSchemaDataDatesItemsDayType", "description": "The type of day for the time off request. All dates must follow the same type." }, "hours": { "description": "The amount taken in hours during this specific date. It can not exceed the maximum allowed hours for the date.", "title": "float", "type": "string" } }, "required": [ "date" ], "title": "TimeOffsPostRequestBodyContentApplicationJsonSchemaDataDatesItems", "type": "object" }, "TimeOffsPostRequestBodyContentApplicationJsonSchemaDataDatesItemsDate": { "description": "An specific date in the time-off request", "oneOf": [ { "format": "date", "type": "string" }, { "format": "date-time", "type": "string" } ], "title": "TimeOffsPostRequestBodyContentApplicationJsonSchemaDataDatesItemsDate" }, "TimeOffsPostRequestBodyContentApplicationJsonSchemaDataDatesItemsDayType": { "description": "The type of day for the time off request. All dates must follow the same type.", "enum": [ "HALF_DAY", "FULL_DAY", "PERCENTAGE", "HOURLY" ], "title": "TimeOffsPostRequestBodyContentApplicationJsonSchemaDataDatesItemsDayType", "type": "string" }, "TimeOffsPostRequestBodyContentApplicationJsonSchemaDataEndDate": { "description": "End date of the time off request. This is the date when the time off ends. For example, if you take 2 days off, this will be the end date of the second day.", "oneOf": [ { "format": "date", "type": "string" }, { "format": "date-time", "type": "string" } ], "title": "TimeOffsPostRequestBodyContentApplicationJsonSchemaDataEndDate" }, "TimeOffsPostRequestBodyContentApplicationJsonSchemaDataEventDetails": { "description": "Details of the event associated with the time off request. Required for event based policies such as parental leave.", "properties": { "adoption_date": { "description": "The date of adoption. This is used for parental leave requests.", "format": "date", "type": "string" }, "birth_date": { "description": "The birth date of the child. This is used for parental leave requests.", "format": "date", "type": "string" }, "had_multiple_children": { "description": "Whether the birth was multiple or not. This is used for parental leave requests.", "type": "boolean" }, "was_premature_birth": { "description": "Whether the birth was premature or not. This is used for parental leave requests.", "type": "boolean" } }, "required": [ "birth_date", "was_premature_birth", "had_multiple_children" ], "title": "TimeOffsPostRequestBodyContentApplicationJsonSchemaDataEventDetails", "type": "object" }, "TimeOffsPostRequestBodyContentApplicationJsonSchemaDataStartDate": { "description": "Start date of the time off request. This is the date when the time off starts. For example, if you take 2 days off, this will be the start date of the first day.", "oneOf": [ { "format": "date", "type": "string" }, { "format": "date-time", "type": "string" } ], "title": "TimeOffsPostRequestBodyContentApplicationJsonSchemaDataStartDate" }, "TimeOffsPostRequestBodyContentApplicationJsonSchemaDataStatus": { "default": "APPROVED", "description": "Status for the time off request. When set to REQUESTED, the time off should be reviewed later through POST /time_offs/review.", "enum": [ "REQUESTED", "APPROVED" ], "title": "TimeOffsPostRequestBodyContentApplicationJsonSchemaDataStatus", "type": "string" }, "TimeOffsPostResponsesContentApplicationJsonSchemaErrorsItems": { "properties": { "code": { "description": "A machine-readable error code", "type": "string" }, "message": { "description": "A description of the returned error", "type": "string" } }, "title": "TimeOffsPostResponsesContentApplicationJsonSchemaErrorsItems", "type": "object" }, "TimeOffsPostResponsesContentApplicationJsonSchemaRequest": { "description": "Request metadata", "properties": { "api_req_id": { "description": "Unique API request identifier", "type": "string" }, "docs": { "description": "Documentation reference", "type": "string" }, "method": { "description": "HTTP method", "type": "string" }, "source": { "description": "Request source", "type": "string" }, "status": { "description": "HTTP status code", "type": "integer" }, "url": { "description": "Request URL path", "type": "string" } }, "title": "TimeOffsPostResponsesContentApplicationJsonSchemaRequest", "type": "object" }, "TimeOffsPostResponsesContentApplicationJsonSchemaTimeOffsItems": { "description": "Created time off request", "properties": { "amount": { "description": "Amount of time off taken. This is the total amount of time off taken. For example, if you take 2 days off, this will be 2. If you take 1 day off, this will be 1.", "title": "float", "type": "string" }, "approved_at": { "description": "This is the date when the time off request was approved. This will be null if the time off request is not approved yet.", "format": "date-time", "type": [ "string", "null" ] }, "attachments": { "description": "List of attachments associated with the time off request.", "items": { "$ref": "#/components/schemas/TimeOffsPostResponsesContentApplicationJsonSchemaTimeOffsItemsAttachmentsItems" }, "type": "array" }, "canceled_at": { "description": "Time off cancellation date", "format": "date-time", "type": [ "string", "null" ] }, "contract_oid": { "description": "Contract id. This is the id of the contract associated with the time off request.", "type": [ "string", "null" ] }, "created_at": { "description": "This is the date when the time off request was created in the database.", "format": "date-time", "type": "string" }, "custom_field_values": { "description": "Answers to the custom fields the request policy declares. Omitted when the policy declares none.", "items": { "$ref": "#/components/schemas/TimeOffsPostResponsesContentApplicationJsonSchemaTimeOffsItemsCustomFieldValuesItems" }, "type": "array" }, "deduction_amount": { "description": "Deduction amount. Available for independent contractor's policies", "title": "float", "type": [ "string", "null" ] }, "deleted_at": { "description": "Time off deletion date. Present only when the time-off is soft-deleted and include_deleted_time_offs was requested.", "format": "date-time", "type": [ "string", "null" ] }, "description": { "description": "Description of the time off request. Some policies require that a description is provided.", "type": "string" }, "end_date": { "description": "End date of the time off request. This is the date when the time off ends. For example, if you take 2 days off, this will be the end date of the second day.", "format": "date", "type": "string" }, "entitlement_unit": { "$ref": "#/components/schemas/TimeOffsPostResponsesContentApplicationJsonSchemaTimeOffsItemsEntitlementUnit", "description": "The unit in which the time off usage and entitlement are calculated." }, "half_end_date": { "description": "Whether the end date is a half day or not.", "type": "boolean" }, "half_start_date": { "description": "Whether the start date is a half day or not.", "type": "boolean" }, "is_end_date_estimated": { "description": "Whether the end date is estimated or not. This is used on event based policies such as Parental leave.", "type": "boolean" }, "is_paid": { "description": "Whether the time off is paid or unpaid.", "type": "boolean" }, "other_type_description": { "description": "Description of the time off type. This is used when the policy is OTHER.", "type": [ "string", "null" ] }, "reason": { "description": "Reason for taking time off. This is complementary information for the time-off description. Useful to provide sub categories for the same policy.", "type": "string" }, "recipient_profile": { "$ref": "#/components/schemas/TimeOffsPostResponsesContentApplicationJsonSchemaTimeOffsItemsRecipientProfile", "description": "The time off profile of the recipient of the time off request. Must be a worker profile." }, "requested_at": { "description": "This is the date when the time off request was made.", "format": "date", "type": "string" }, "requester_profile": { "$ref": "#/components/schemas/TimeOffsPostResponsesContentApplicationJsonSchemaTimeOffsItemsRequesterProfile", "description": "The time off profile of the requester of the time off request. Can be either a client or worker profile." }, "start_date": { "description": "Start date of the time off request. This is the date when the time off starts. For example, if you take 2 days off, this will be the start date of the first day.", "format": "date", "type": "string" }, "status": { "$ref": "#/components/schemas/TimeOffsPostResponsesContentApplicationJsonSchemaTimeOffsItemsStatus", "description": "Status of the time off request. Can be REQUESTED, APPROVED, REJECTED, USED or CANCELED." }, "time_off_dailies": { "items": { "$ref": "#/components/schemas/TimeOffsPostResponsesContentApplicationJsonSchemaTimeOffsItemsTimeOffDailiesItems" }, "type": "array" }, "time_off_event": { "$ref": "#/components/schemas/TimeOffsPostResponsesContentApplicationJsonSchemaTimeOffsItemsTimeOffEvent" }, "time_off_percentage": { "description": "This is the percentage of time off taken.", "title": "float", "type": [ "string", "null" ] }, "time_off_type": { "$ref": "#/components/schemas/TimeOffsPostResponsesContentApplicationJsonSchemaTimeOffsItemsTimeOffType", "description": "The type of time off taken." }, "time_off_type_id": { "description": "Time off type id. This is the id of the time off type associated with the time off request.", "format": "uuid", "type": "string" }, "updated_at": { "description": "This is the date when the time off request was last updated in the database.", "format": "date-time", "type": "string" } }, "required": [ "is_paid", "end_date", "created_at", "start_date", "updated_at", "requested_at", "half_end_date", "half_start_date", "entitlement_unit", "time_off_type_id" ], "title": "TimeOffsPostResponsesContentApplicationJsonSchemaTimeOffsItems", "type": "object" }, "TimeOffsPostResponsesContentApplicationJsonSchemaTimeOffsItemsAttachmentsItems": { "description": "An attachment associated with the time off request.", "properties": { "created_at": { "description": "This is the date when the attachment was created in the database.", "format": "date-time", "type": "string" }, "filename": { "description": "Filename of the attachment", "type": "string" }, "id": { "description": "Attachment id", "format": "uuid", "type": "string" }, "updated_at": { "description": "This is the date when the attachment was last updated in the database.", "format": "date-time", "type": "string" } }, "required": [ "id", "filename", "created_at", "updated_at" ], "title": "TimeOffsPostResponsesContentApplicationJsonSchemaTimeOffsItemsAttachmentsItems", "type": "object" }, "TimeOffsPostResponsesContentApplicationJsonSchemaTimeOffsItemsCustomFieldValuesItems": { "properties": { "field_id": { "description": "The id of the custom field this value answers.", "format": "uuid", "type": "string" }, "value": { "description": "The submitted value for the custom field, serialized as text. When no value is provided, this will be null.", "type": [ "string", "null" ] } }, "required": [ "value", "field_id" ], "title": "TimeOffsPostResponsesContentApplicationJsonSchemaTimeOffsItemsCustomFieldValuesItems", "type": "object" }, "TimeOffsPostResponsesContentApplicationJsonSchemaTimeOffsItemsEntitlementUnit": { "description": "The unit in which the time off usage and entitlement are calculated.", "enum": [ "HOUR", "BUSINESS_DAY", "CALENDAR_DAY", "WEEK", "MONTH", "YEAR" ], "title": "TimeOffsPostResponsesContentApplicationJsonSchemaTimeOffsItemsEntitlementUnit", "type": "string" }, "TimeOffsPostResponsesContentApplicationJsonSchemaTimeOffsItemsRecipientProfile": { "description": "The time off profile of the recipient of the time off request. Must be a worker profile.", "properties": { "hris_profile_id": { "description": "The worker HRIS profile id in the given organization.", "format": "uuid", "type": "string" }, "organization_id": { "description": "Id of the organization the profile belongs to.", "format": "uuid", "type": "string" } }, "required": [ "hris_profile_id", "organization_id" ], "title": "TimeOffsPostResponsesContentApplicationJsonSchemaTimeOffsItemsRecipientProfile", "type": "object" }, "TimeOffsPostResponsesContentApplicationJsonSchemaTimeOffsItemsRequesterProfile": { "description": "The time off profile of the requester of the time off request. Can be either a client or worker profile.", "properties": { "client_profile_id": { "description": "Id of the client profile. Available when the requester is a client.", "format": "uuid", "type": "string" }, "hris_profile_id": { "description": "The worker HRIS profile id in the given organization. Available when the requester is a worker.", "format": "uuid", "type": "string" }, "organization_id": { "description": "Id of the organization the profile belongs to.", "format": "uuid", "type": "string" } }, "required": [ "organization_id" ], "title": "TimeOffsPostResponsesContentApplicationJsonSchemaTimeOffsItemsRequesterProfile", "type": "object" }, "TimeOffsPostResponsesContentApplicationJsonSchemaTimeOffsItemsStatus": { "description": "Status of the time off request. Can be REQUESTED, APPROVED, REJECTED, USED or CANCELED.", "enum": [ "REQUESTED", "APPROVED", "REJECTED", "USED", "CANCELED", "DELETED" ], "title": "TimeOffsPostResponsesContentApplicationJsonSchemaTimeOffsItemsStatus", "type": "string" }, "TimeOffsPostResponsesContentApplicationJsonSchemaTimeOffsItemsTimeOffDailiesItems": { "properties": { "amount": { "description": "Amount of time off taken in this specific date.", "title": "float", "type": "string" }, "created_at": { "description": "This is the date when the time off daily was created in the database.", "format": "date-time", "type": "string" }, "date": { "description": "Date of the time off daily. This is the date when the time off was taken.", "format": "date", "type": "string" }, "description": { "description": "Description of the time off daily. When it is a HOLIDAY this is the holiday name.", "type": [ "string", "null" ] }, "id": { "description": "Time off daily id", "format": "uuid", "type": "string" }, "time_off_id": { "description": "Time off id. This is the id of the time off request associated with the time off daily.", "format": "uuid", "type": "string" }, "type": { "$ref": "#/components/schemas/TimeOffsPostResponsesContentApplicationJsonSchemaTimeOffsItemsTimeOffDailiesItemsType", "description": "Type of the time off daily. Can be WORKING_DAY, NON_WORKING_DAY, HOLIDAY or FORFAIT_HOUR_DAY." }, "updated_at": { "description": "This is the date when the time off daily was last updated in the database.", "format": "date-time", "type": "string" } }, "required": [ "id", "date", "type", "amount", "created_at", "updated_at", "time_off_id" ], "title": "TimeOffsPostResponsesContentApplicationJsonSchemaTimeOffsItemsTimeOffDailiesItems", "type": "object" }, "TimeOffsPostResponsesContentApplicationJsonSchemaTimeOffsItemsTimeOffDailiesItemsType": { "description": "Type of the time off daily. Can be WORKING_DAY, NON_WORKING_DAY, HOLIDAY or FORFAIT_HOUR_DAY.", "enum": [ "WORKING_DAY", "NON_WORKING_DAY", "HOLIDAY", "FORFAIT_HOUR_DAY" ], "title": "TimeOffsPostResponsesContentApplicationJsonSchemaTimeOffsItemsTimeOffDailiesItemsType", "type": "string" }, "TimeOffsPostResponsesContentApplicationJsonSchemaTimeOffsItemsTimeOffEvent": { "properties": { "created_at": { "description": "The date when the time off event was created in the database.", "format": "date-time", "type": "string" }, "event_details": { "$ref": "#/components/schemas/TimeOffsPostResponsesContentApplicationJsonSchemaTimeOffsItemsTimeOffEventEventDetails", "description": "Details of the event associated with the time off request. Required for event based policies such as parental leave." }, "hris_profile_id": { "description": "The HRIS profile id of the worker associated with the time off event. Same as the hris_profile_id in the recipient_profile.", "format": "uuid", "type": "string" }, "id": { "description": "The time off event id. This is used to link the time off request to an event.", "format": "uuid", "type": "string" }, "policy_id": { "description": "The policy id associated with the time off event. Same as the policy_id in the time off type.", "format": "uuid", "type": "string" }, "time_off_type_id": { "description": "The time off type id associated with the time off event. Same as the time_off_type_id in the time off request.", "format": "uuid", "type": "string" }, "type": { "$ref": "#/components/schemas/TimeOffsPostResponsesContentApplicationJsonSchemaTimeOffsItemsTimeOffEventType", "description": "The type of the time off event." }, "updated_at": { "description": "The date when the time off event was last updated in the database.", "format": "date-time", "type": "string" } }, "title": "TimeOffsPostResponsesContentApplicationJsonSchemaTimeOffsItemsTimeOffEvent", "type": "object" }, "TimeOffsPostResponsesContentApplicationJsonSchemaTimeOffsItemsTimeOffEventEventDetails": { "description": "Details of the event associated with the time off request. Required for event based policies such as parental leave.", "properties": { "adoption_date": { "description": "The date of adoption. This is used for parental leave requests.", "format": "date", "type": "string" }, "birth_date": { "description": "The birth date of the child. This is used for parental leave requests.", "format": "date", "type": "string" }, "estimated_adoption_date": { "description": "The estimated adoption date of the child. Birth is estimated when the adoption date has not been confirmed yet.", "format": "date", "type": "string" }, "estimated_birth_date": { "description": "The estimated birth date of the child. Birth is estimated when the birth date has not been confirmed yet.", "format": "date", "type": "string" }, "had_multiple_children": { "description": "Whether the birth was multiple or not. This is used for parental leave requests.", "type": "boolean" }, "was_premature_birth": { "description": "Whether the birth was premature or not. This is used for parental leave requests.", "type": "boolean" } }, "required": [ "was_premature_birth", "had_multiple_children" ], "title": "TimeOffsPostResponsesContentApplicationJsonSchemaTimeOffsItemsTimeOffEventEventDetails", "type": "object" }, "TimeOffsPostResponsesContentApplicationJsonSchemaTimeOffsItemsTimeOffEventType": { "description": "The type of the time off event.", "enum": [ "PARENTAL_LEAVE" ], "title": "TimeOffsPostResponsesContentApplicationJsonSchemaTimeOffsItemsTimeOffEventType", "type": "string" }, "TimeOffsPostResponsesContentApplicationJsonSchemaTimeOffsItemsTimeOffType": { "description": "The type of time off taken.", "properties": { "id": { "description": "Time off type id.", "format": "uuid", "type": "string" }, "name": { "description": "Time off type name. Basically the reason or category of time-off taken. For SICK leave, it can be doctor appointment, surgery etc.", "type": "string" }, "policy": { "$ref": "#/components/schemas/TimeOffsPostResponsesContentApplicationJsonSchemaTimeOffsItemsTimeOffTypePolicy", "description": "The policy associated with the time off type." } }, "required": [ "id", "name" ], "title": "TimeOffsPostResponsesContentApplicationJsonSchemaTimeOffsItemsTimeOffType", "type": "object" }, "TimeOffsPostResponsesContentApplicationJsonSchemaTimeOffsItemsTimeOffTypePolicy": { "description": "The policy associated with the time off type.", "properties": { "id": { "description": "Policy id", "format": "uuid", "type": "string" }, "name": { "description": "The custom name given to policy during policy creation.", "type": "string" }, "policy_type": { "$ref": "#/components/schemas/TimeOffsPostResponsesContentApplicationJsonSchemaTimeOffsItemsTimeOffTypePolicyPolicyType" } }, "required": [ "id", "name", "policy_type" ], "title": "TimeOffsPostResponsesContentApplicationJsonSchemaTimeOffsItemsTimeOffTypePolicy", "type": "object" }, "TimeOffsPostResponsesContentApplicationJsonSchemaTimeOffsItemsTimeOffTypePolicyPolicyType": { "properties": { "id": { "description": "Policy type id", "format": "uuid", "type": "string" }, "name": { "description": "Depicts the type of policy, like VACATION, SICK etc", "type": "string" } }, "required": [ "id", "name" ], "title": "TimeOffsPostResponsesContentApplicationJsonSchemaTimeOffsItemsTimeOffTypePolicyPolicyType", "type": "object" }, "TimeOffsProfileHrisProfileIdEntitlementsGetParametersPolicyTypeName": { "enum": [ "Adoption leave", "Advanced vacation", "Bereaved partner's paternity leave", "Bereavement leave", "Blood donation leave", "Breastfeeding leave", "Carer's leave", "Childbirth leave", "Childcare leave", "Civic/public duty leave", "Compensatory leave", "Disability leave", "Doctor's appointment leave", "Family & domestic violence leave", "Family responsibility leave", "Floating Holiday Allowance", "Hajj leave", "Hospitalization leave", "Long Service Leave", "Marriage/wedding leave", "Maternity leave", "Menstrual leave", "Military leave", "Moving leave", "Neonatal care leave", "Other leave", "Paid leave", "Parental bereavement leave", "Parental leave", "Paternity leave", "Personal leave", "Pregnancy leave", "Regional holiday", "RTT", "Shared parental leave", "Sick leave", "Study leave", "Supplementary Leave", "Unpaid leave", "Vacation", "Vacation - public holidays replacement", "Volunteer leave", "Work accident leave", "Work Location" ], "title": "TimeOffsProfileHrisProfileIdEntitlementsGetParametersPolicyTypeName", "type": "string" }, "TimeOffsProfileHrisProfileIdEntitlementsGetResponsesContentApplicationJsonSchemaEntitlementsItems": { "properties": { "accrual_amount": { "description": "Accrual amount", "type": "string" }, "accrual_unit": { "$ref": "#/components/schemas/TimeOffsProfileHrisProfileIdEntitlementsGetResponsesContentApplicationJsonSchemaEntitlementsItemsAccrualUnit", "description": "Accrual unit" }, "accrued": { "description": "Accrued time off", "type": [ "string", "null" ] }, "allowance": { "description": "Time off allowance", "type": [ "string", "null" ] }, "approved": { "description": "Approved time off", "type": "string" }, "available": { "description": "Available time off. Will be null if is_allowance_unlimited is true", "type": [ "string", "null" ] }, "balance_adjusted": { "description": "Balance adjusted", "type": [ "string", "null" ] }, "events": { "items": { "$ref": "#/components/schemas/TimeOffsProfileHrisProfileIdEntitlementsGetResponsesContentApplicationJsonSchemaEntitlementsItemsEventsItems" }, "type": [ "array", "null" ] }, "expired": { "description": "Expired time off", "type": "string" }, "future_events": { "items": { "$ref": "#/components/schemas/TimeOffsProfileHrisProfileIdEntitlementsGetResponsesContentApplicationJsonSchemaEntitlementsItemsFutureEventsItems" }, "type": [ "array", "null" ] }, "id": { "description": "Entitlement ID", "type": "string" }, "is_allowance_unlimited": { "description": "True when the allowance is unlimited", "type": "boolean" }, "past_tracking_periods": { "items": { "type": "string" }, "type": "array" }, "policy": { "$ref": "#/components/schemas/TimeOffsProfileHrisProfileIdEntitlementsGetResponsesContentApplicationJsonSchemaEntitlementsItemsPolicy" }, "requested": { "description": "Requested time off", "type": "string" }, "rollovers": { "items": { "$ref": "#/components/schemas/TimeOffsProfileHrisProfileIdEntitlementsGetResponsesContentApplicationJsonSchemaEntitlementsItemsRolloversItems" }, "type": [ "array", "null" ] }, "time_off_event_id": { "description": "Time off event ID", "type": "string" }, "total_entitlements": { "description": "Total entitlements", "type": "string" }, "tracking_period": { "description": "Tracking period", "type": "string" }, "tracking_period_end_date": { "description": "Tracking period end date. Null when the entitlement never expires.", "type": [ "string", "null" ] }, "upcoming_accruals": { "description": "Upcoming accruals", "type": "string" }, "used": { "description": "Used time off", "type": "string" } }, "required": [ "available", "tracking_period", "total_entitlements", "is_allowance_unlimited", "tracking_period_end_date" ], "title": "TimeOffsProfileHrisProfileIdEntitlementsGetResponsesContentApplicationJsonSchemaEntitlementsItems", "type": "object" }, "TimeOffsProfileHrisProfileIdEntitlementsGetResponsesContentApplicationJsonSchemaEntitlementsItemsAccrualUnit": { "description": "Accrual unit", "enum": [ "HOUR", "BUSINESS_DAY", "CALENDAR_DAY", "WEEK", "MONTH", "YEAR" ], "title": "TimeOffsProfileHrisProfileIdEntitlementsGetResponsesContentApplicationJsonSchemaEntitlementsItemsAccrualUnit", "type": "string" }, "TimeOffsProfileHrisProfileIdEntitlementsGetResponsesContentApplicationJsonSchemaEntitlementsItemsEventsItems": { "properties": { "accrual_date": { "description": "Accrual date", "format": "date-time", "type": "string" }, "amount": { "description": "Event amount", "title": "float", "type": "string" }, "created_at": { "description": "Event creation date", "format": "date-time", "type": "string" }, "description": { "description": "Event description", "type": "string" }, "event_date": { "description": "Event date", "format": "date-time", "type": "string" }, "expiration_date": { "description": "Expiration date", "format": "date-time", "type": "string" }, "id": { "description": "Event ID", "format": "uuid", "type": "string" }, "policy_id": { "description": "Policy ID", "format": "uuid", "type": "string" }, "profile_id": { "description": "Profile ID", "format": "uuid", "type": "string" }, "rollover_tracking_period": { "description": "Rollover tracking period", "format": "date-time", "type": "string" }, "time_off_id": { "description": "Time off ID", "format": "uuid", "type": "string" }, "tracking_period": { "description": "Tracking period", "format": "date-time", "type": "string" }, "type": { "$ref": "#/components/schemas/TimeOffsProfileHrisProfileIdEntitlementsGetResponsesContentApplicationJsonSchemaEntitlementsItemsEventsItemsType", "description": "Event type" }, "updated_at": { "description": "Event update date", "format": "date-time", "type": "string" } }, "required": [ "id", "type", "amount", "policy_id", "created_at", "profile_id", "updated_at", "tracking_period" ], "title": "TimeOffsProfileHrisProfileIdEntitlementsGetResponsesContentApplicationJsonSchemaEntitlementsItemsEventsItems", "type": "object" }, "TimeOffsProfileHrisProfileIdEntitlementsGetResponsesContentApplicationJsonSchemaEntitlementsItemsEventsItemsType": { "description": "Event type", "enum": [ "ACCRUAL", "ACCRUAL_DEDUCTION", "ACCRUAL_PRORATE", "ACCRUAL_TERMINATION", "MANUAL_ADJUSTMENT", "NO_ROLLOVER", "ROLLOVER_ADJUSTMENT", "ROLLOVER_CARRY_OVER", "ROLLOVER_EXPIRATION", "ROLLOVER_PAYOUT", "ROLLOVER_PROJECTED", "TIME_OFF" ], "title": "TimeOffsProfileHrisProfileIdEntitlementsGetResponsesContentApplicationJsonSchemaEntitlementsItemsEventsItemsType", "type": "string" }, "TimeOffsProfileHrisProfileIdEntitlementsGetResponsesContentApplicationJsonSchemaEntitlementsItemsFutureEventsItems": { "properties": { "accrual_date": { "description": "Accrual date", "format": "date-time", "type": "string" }, "amount": { "description": "Event amount", "title": "float", "type": "string" }, "created_at": { "description": "Event creation date", "format": "date-time", "type": "string" }, "description": { "description": "Event description", "type": "string" }, "event_date": { "description": "Event date", "format": "date-time", "type": "string" }, "expiration_date": { "description": "Expiration date", "format": "date-time", "type": "string" }, "id": { "description": "Event ID", "format": "uuid", "type": "string" }, "policy_id": { "description": "Policy ID", "format": "uuid", "type": "string" }, "profile_id": { "description": "Profile ID", "format": "uuid", "type": "string" }, "rollover_tracking_period": { "description": "Rollover tracking period", "format": "date-time", "type": "string" }, "time_off_id": { "description": "Time off ID", "format": "uuid", "type": "string" }, "tracking_period": { "description": "Tracking period", "format": "date-time", "type": "string" }, "type": { "$ref": "#/components/schemas/TimeOffsProfileHrisProfileIdEntitlementsGetResponsesContentApplicationJsonSchemaEntitlementsItemsFutureEventsItemsType", "description": "Event type" }, "updated_at": { "description": "Event update date", "format": "date-time", "type": "string" } }, "required": [ "id", "type", "amount", "policy_id", "created_at", "profile_id", "updated_at", "tracking_period" ], "title": "TimeOffsProfileHrisProfileIdEntitlementsGetResponsesContentApplicationJsonSchemaEntitlementsItemsFutureEventsItems", "type": "object" }, "TimeOffsProfileHrisProfileIdEntitlementsGetResponsesContentApplicationJsonSchemaEntitlementsItemsFutureEventsItemsType": { "description": "Event type", "enum": [ "ACCRUAL", "ACCRUAL_DEDUCTION", "ACCRUAL_PRORATE", "ACCRUAL_TERMINATION", "MANUAL_ADJUSTMENT", "NO_ROLLOVER", "ROLLOVER_ADJUSTMENT", "ROLLOVER_CARRY_OVER", "ROLLOVER_EXPIRATION", "ROLLOVER_PAYOUT", "ROLLOVER_PROJECTED", "TIME_OFF" ], "title": "TimeOffsProfileHrisProfileIdEntitlementsGetResponsesContentApplicationJsonSchemaEntitlementsItemsFutureEventsItemsType", "type": "string" }, "TimeOffsProfileHrisProfileIdEntitlementsGetResponsesContentApplicationJsonSchemaEntitlementsItemsPolicy": { "properties": { "created_at": { "description": "Policy creation date", "format": "date-time", "type": "string" }, "description": { "description": "Policy description", "type": "string" }, "id": { "description": "Policy ID", "format": "uuid", "type": "string" }, "leave_type": { "$ref": "#/components/schemas/TimeOffsProfileHrisProfileIdEntitlementsGetResponsesContentApplicationJsonSchemaEntitlementsItemsPolicyLeaveType", "description": "Leave type" }, "name": { "description": "Policy name", "type": "string" }, "policy_type": { "$ref": "#/components/schemas/TimeOffsProfileHrisProfileIdEntitlementsGetResponsesContentApplicationJsonSchemaEntitlementsItemsPolicyPolicyType" }, "policy_type_id": { "description": "Policy type ID", "format": "uuid", "type": "string" }, "time_off_types": { "items": { "$ref": "#/components/schemas/TimeOffsProfileHrisProfileIdEntitlementsGetResponsesContentApplicationJsonSchemaEntitlementsItemsPolicyTimeOffTypesItems" }, "type": "array" }, "tracking_cadence": { "$ref": "#/components/schemas/TimeOffsProfileHrisProfileIdEntitlementsGetResponsesContentApplicationJsonSchemaEntitlementsItemsPolicyTrackingCadence", "description": "Tracking cadence" }, "tracking_start_date": { "description": "Tracking start date", "format": "date", "type": "string" }, "tracking_unit": { "$ref": "#/components/schemas/TimeOffsProfileHrisProfileIdEntitlementsGetResponsesContentApplicationJsonSchemaEntitlementsItemsPolicyTrackingUnit", "description": "Tracking unit" }, "tracking_unit_amount": { "description": "Tracking unit amount", "title": "float", "type": "string" }, "updated_at": { "description": "Policy update date", "format": "date-time", "type": "string" } }, "required": [ "id", "name", "created_at", "updated_at" ], "title": "TimeOffsProfileHrisProfileIdEntitlementsGetResponsesContentApplicationJsonSchemaEntitlementsItemsPolicy", "type": "object" }, "TimeOffsProfileHrisProfileIdEntitlementsGetResponsesContentApplicationJsonSchemaEntitlementsItemsPolicyLeaveType": { "description": "Leave type", "enum": [ "SHORT_TERM_LEAVE", "LONG_TERM_LEAVE" ], "title": "TimeOffsProfileHrisProfileIdEntitlementsGetResponsesContentApplicationJsonSchemaEntitlementsItemsPolicyLeaveType", "type": "string" }, "TimeOffsProfileHrisProfileIdEntitlementsGetResponsesContentApplicationJsonSchemaEntitlementsItemsPolicyPolicyType": { "properties": { "id": { "description": "Policy type ID", "format": "uuid", "type": "string" }, "name": { "description": "Policy type name", "type": "string" } }, "required": [ "id", "name" ], "title": "TimeOffsProfileHrisProfileIdEntitlementsGetResponsesContentApplicationJsonSchemaEntitlementsItemsPolicyPolicyType", "type": "object" }, "TimeOffsProfileHrisProfileIdEntitlementsGetResponsesContentApplicationJsonSchemaEntitlementsItemsPolicyTimeOffTypesItems": { "properties": { "id": { "description": "Time off type ID", "format": "uuid", "type": "string" }, "name": { "description": "Time off type name", "type": "string" } }, "required": [ "id", "name" ], "title": "TimeOffsProfileHrisProfileIdEntitlementsGetResponsesContentApplicationJsonSchemaEntitlementsItemsPolicyTimeOffTypesItems", "type": "object" }, "TimeOffsProfileHrisProfileIdEntitlementsGetResponsesContentApplicationJsonSchemaEntitlementsItemsPolicyTrackingCadence": { "description": "Tracking cadence", "enum": [ "FIXED_DAY", "ANNIVERSARY", "NOT_SPECIFIED" ], "title": "TimeOffsProfileHrisProfileIdEntitlementsGetResponsesContentApplicationJsonSchemaEntitlementsItemsPolicyTrackingCadence", "type": "string" }, "TimeOffsProfileHrisProfileIdEntitlementsGetResponsesContentApplicationJsonSchemaEntitlementsItemsPolicyTrackingUnit": { "description": "Tracking unit", "enum": [ "HOUR", "BUSINESS_DAY", "CALENDAR_DAY", "WEEK", "MONTH", "YEAR" ], "title": "TimeOffsProfileHrisProfileIdEntitlementsGetResponsesContentApplicationJsonSchemaEntitlementsItemsPolicyTrackingUnit", "type": "string" }, "TimeOffsProfileHrisProfileIdEntitlementsGetResponsesContentApplicationJsonSchemaEntitlementsItemsRolloversItems": { "properties": { "amount": { "$ref": "#/components/schemas/TimeOffsProfileHrisProfileIdEntitlementsGetResponsesContentApplicationJsonSchemaEntitlementsItemsRolloversItemsAmount" }, "expiration_date": { "description": "Rollover expiration date", "format": "date-time", "type": "string" }, "rollover_tracking_period": { "description": "Rollover tracking period", "format": "date-time", "type": "string" } }, "required": [ "amount", "rollover_tracking_period" ], "title": "TimeOffsProfileHrisProfileIdEntitlementsGetResponsesContentApplicationJsonSchemaEntitlementsItemsRolloversItems", "type": "object" }, "TimeOffsProfileHrisProfileIdEntitlementsGetResponsesContentApplicationJsonSchemaEntitlementsItemsRolloversItemsAmount": { "oneOf": [ { "title": "float", "type": "string" }, { "type": "string" } ], "title": "TimeOffsProfileHrisProfileIdEntitlementsGetResponsesContentApplicationJsonSchemaEntitlementsItemsRolloversItemsAmount" }, "TimeOffsProfileHrisProfileIdEntitlementsGetResponsesContentApplicationJsonSchemaErrorsItems": { "properties": { "message": { "description": "A description of the returned error", "type": "string" }, "path": { "description": "The JSON path where input validation failed", "type": "string" } }, "title": "TimeOffsProfileHrisProfileIdEntitlementsGetResponsesContentApplicationJsonSchemaErrorsItems", "type": "object" }, "TimeOffsProfileHrisProfileIdEntitlementsGetResponsesContentApplicationJsonSchemaRequest": { "properties": { "api_req_id": { "description": "The request ID of the failed request", "type": "string" }, "code": { "description": "The code of the source handler which produced the returned error", "format": "double", "type": "number" }, "docs": { "description": "A link to the official documentation for the requested endpoint resource", "type": "string" }, "method": { "description": "The HTTP method of the failed request", "type": "string" }, "source": { "description": "The source handler which produced the returned error", "type": "string" }, "status": { "description": "The status code of the response", "format": "double", "type": "number" }, "url": { "description": "The relative URL of the failed request", "type": "string" } }, "title": "TimeOffsProfileHrisProfileIdEntitlementsGetResponsesContentApplicationJsonSchemaRequest", "type": "object" }, "TimeOffsProfileHrisProfileIdGetParametersPolicyTypeNamesSchemaItems": { "enum": [ "Adoption leave", "Advanced vacation", "Bereaved partner's paternity leave", "Bereavement leave", "Blood donation leave", "Breastfeeding leave", "Carer's leave", "Childbirth leave", "Childcare leave", "Civic/public duty leave", "Compensatory leave", "Disability leave", "Doctor's appointment leave", "Family & domestic violence leave", "Family responsibility leave", "Floating Holiday Allowance", "Hajj leave", "Hospitalization leave", "Long Service Leave", "Marriage/wedding leave", "Maternity leave", "Menstrual leave", "Military leave", "Moving leave", "Neonatal care leave", "Other leave", "Paid leave", "Parental bereavement leave", "Parental leave", "Paternity leave", "Personal leave", "Pregnancy leave", "Regional holiday", "RTT", "Shared parental leave", "Sick leave", "Study leave", "Supplementary Leave", "Unpaid leave", "Vacation", "Vacation - public holidays replacement", "Volunteer leave", "Work accident leave", "Work Location" ], "title": "TimeOffsProfileHrisProfileIdGetParametersPolicyTypeNamesSchemaItems", "type": "string" }, "TimeOffsProfileHrisProfileIdGetParametersStatusSchemaItems": { "enum": [ "REQUESTED", "APPROVED", "REJECTED", "USED", "CANCELED" ], "title": "TimeOffsProfileHrisProfileIdGetParametersStatusSchemaItems", "type": "string" }, "TimeOffsProfileHrisProfileIdGetResponsesContentApplicationJsonSchemaDataItems": { "properties": { "amount": { "description": "Amount of time off", "title": "float", "type": "string" }, "approved_at": { "description": "Time off approval date", "format": "date-time", "type": [ "string", "null" ] }, "contract_oid": { "description": "Contract id", "type": "string" }, "created_at": { "description": "Time off creation date", "format": "date-time", "type": "string" }, "custom_field_values": { "description": "Answers to the custom fields the request policy declares. Omitted when the policy declares none.", "items": { "$ref": "#/components/schemas/TimeOffsProfileHrisProfileIdGetResponsesContentApplicationJsonSchemaDataItemsCustomFieldValuesItems" }, "type": "array" }, "deduction_amount": { "description": "Deduction amount", "title": "float", "type": [ "string", "null" ] }, "description": { "description": "Time off description", "type": [ "string", "null" ] }, "end_date": { "description": "End date of time off", "format": "date", "type": "string" }, "entitlement_unit": { "$ref": "#/components/schemas/TimeOffsProfileHrisProfileIdGetResponsesContentApplicationJsonSchemaDataItemsEntitlementUnit", "description": "The unit in which the time off usage and entitlement are calculated." }, "half_end_date": { "description": "Is half end date. Only used for backwards compatibility, please do not use.", "type": "boolean" }, "half_start_date": { "description": "Is half start date. Only used for backwards compatibility, please do not use.", "type": "boolean" }, "id": { "description": "Time off id", "format": "uuid", "type": "string" }, "is_end_date_estimated": { "description": "Is end date estimated", "type": "boolean" }, "is_paid": { "description": "Is time off paid", "type": "boolean" }, "other_type_description": { "description": "Other type description", "type": [ "string", "null" ] }, "reason": { "description": "Reason for time off", "type": "string" }, "recipient_profile": { "$ref": "#/components/schemas/TimeOffsProfileHrisProfileIdGetResponsesContentApplicationJsonSchemaDataItemsRecipientProfile" }, "requested_at": { "description": "Time off request date", "format": "date", "type": "string" }, "requester_profile": { "$ref": "#/components/schemas/TimeOffsProfileHrisProfileIdGetResponsesContentApplicationJsonSchemaDataItemsRequesterProfile" }, "start_date": { "description": "Start date of time off", "format": "date", "type": "string" }, "status": { "$ref": "#/components/schemas/TimeOffsProfileHrisProfileIdGetResponsesContentApplicationJsonSchemaDataItemsStatus", "description": "Status of time off" }, "time_off_dailies": { "items": { "$ref": "#/components/schemas/TimeOffsProfileHrisProfileIdGetResponsesContentApplicationJsonSchemaDataItemsTimeOffDailiesItems" }, "type": "array" }, "time_off_percentage": { "description": "Time off percentage", "title": "float", "type": [ "string", "null" ] }, "time_off_type_id": { "description": "Time off type id", "type": "string" }, "updated_at": { "description": "Time off update date", "format": "date-time", "type": "string" } }, "required": [ "id", "amount", "is_paid", "end_date", "created_at", "start_date", "updated_at", "requested_at", "half_end_date", "half_start_date", "entitlement_unit", "time_off_type_id" ], "title": "TimeOffsProfileHrisProfileIdGetResponsesContentApplicationJsonSchemaDataItems", "type": "object" }, "TimeOffsProfileHrisProfileIdGetResponsesContentApplicationJsonSchemaDataItemsCustomFieldValuesItems": { "properties": { "field_id": { "description": "The id of the custom field this value answers.", "format": "uuid", "type": "string" }, "value": { "description": "The submitted value for the custom field, serialized as text. When no value is provided, this will be null.", "type": [ "string", "null" ] } }, "required": [ "value", "field_id" ], "title": "TimeOffsProfileHrisProfileIdGetResponsesContentApplicationJsonSchemaDataItemsCustomFieldValuesItems", "type": "object" }, "TimeOffsProfileHrisProfileIdGetResponsesContentApplicationJsonSchemaDataItemsEntitlementUnit": { "description": "The unit in which the time off usage and entitlement are calculated.", "enum": [ "HOUR", "BUSINESS_DAY", "CALENDAR_DAY", "WEEK", "MONTH", "YEAR" ], "title": "TimeOffsProfileHrisProfileIdGetResponsesContentApplicationJsonSchemaDataItemsEntitlementUnit", "type": "string" }, "TimeOffsProfileHrisProfileIdGetResponsesContentApplicationJsonSchemaDataItemsRecipientProfile": { "properties": { "client_profile_id": { "description": "Recipient client profile id", "format": "uuid", "type": "string" }, "hris_profile_id": { "description": "Recipient hris profile id", "format": "uuid", "type": "string" }, "organization_id": { "description": "Recipient organization id", "format": "uuid", "type": "string" } }, "title": "TimeOffsProfileHrisProfileIdGetResponsesContentApplicationJsonSchemaDataItemsRecipientProfile", "type": "object" }, "TimeOffsProfileHrisProfileIdGetResponsesContentApplicationJsonSchemaDataItemsRequesterProfile": { "properties": { "client_profile_id": { "description": "Request client profile id", "format": "uuid", "type": "string" }, "hris_profile_id": { "description": "Request hris profile id", "format": "uuid", "type": "string" }, "organization_id": { "description": "Request organization id", "format": "uuid", "type": "string" } }, "title": "TimeOffsProfileHrisProfileIdGetResponsesContentApplicationJsonSchemaDataItemsRequesterProfile", "type": "object" }, "TimeOffsProfileHrisProfileIdGetResponsesContentApplicationJsonSchemaDataItemsStatus": { "description": "Status of time off", "enum": [ "REQUESTED", "APPROVED", "REJECTED", "USED", "CANCELED" ], "title": "TimeOffsProfileHrisProfileIdGetResponsesContentApplicationJsonSchemaDataItemsStatus", "type": "string" }, "TimeOffsProfileHrisProfileIdGetResponsesContentApplicationJsonSchemaDataItemsTimeOffDailiesItems": { "properties": { "amount": { "description": "Time off daily amount", "title": "float", "type": "string" }, "created_at": { "description": "Time off daily creation date", "format": "date-time", "type": "string" }, "date": { "description": "Time off daily date", "format": "date", "type": "string" }, "description": { "description": "Time off daily description", "type": [ "string", "null" ] }, "id": { "description": "Time off daily id", "format": "uuid", "type": "string" }, "time_off_id": { "description": "Time off id", "format": "uuid", "type": "string" }, "type": { "$ref": "#/components/schemas/TimeOffsProfileHrisProfileIdGetResponsesContentApplicationJsonSchemaDataItemsTimeOffDailiesItemsType", "description": "Time off daily type" }, "updated_at": { "description": "Time off daily update date", "format": "date-time", "type": "string" } }, "required": [ "id", "date", "type", "amount", "created_at", "updated_at", "time_off_id" ], "title": "TimeOffsProfileHrisProfileIdGetResponsesContentApplicationJsonSchemaDataItemsTimeOffDailiesItems", "type": "object" }, "TimeOffsProfileHrisProfileIdGetResponsesContentApplicationJsonSchemaDataItemsTimeOffDailiesItemsType": { "description": "Time off daily type", "enum": [ "WORKING_DAY", "NON_WORKING_DAY", "HOLIDAY", "FORFAIT_HOUR_DAY" ], "title": "TimeOffsProfileHrisProfileIdGetResponsesContentApplicationJsonSchemaDataItemsTimeOffDailiesItemsType", "type": "string" }, "TimeOffsProfileHrisProfileIdGetResponsesContentApplicationJsonSchemaErrorsItems": { "properties": { "message": { "description": "A description of the returned error", "type": "string" }, "path": { "description": "The JSON path where input validation failed", "type": "string" } }, "title": "TimeOffsProfileHrisProfileIdGetResponsesContentApplicationJsonSchemaErrorsItems", "type": "object" }, "TimeOffsProfileHrisProfileIdGetResponsesContentApplicationJsonSchemaRequest": { "properties": { "api_req_id": { "description": "The request ID of the failed request", "type": "string" }, "code": { "description": "The code of the source handler which produced the returned error", "format": "double", "type": "number" }, "docs": { "description": "A link to the official documentation for the requested endpoint resource", "type": "string" }, "method": { "description": "The HTTP method of the failed request", "type": "string" }, "source": { "description": "The source handler which produced the returned error", "type": "string" }, "status": { "description": "The status code of the response", "format": "double", "type": "number" }, "url": { "description": "The relative URL of the failed request", "type": "string" } }, "title": "TimeOffsProfileHrisProfileIdGetResponsesContentApplicationJsonSchemaRequest", "type": "object" }, "TimeOffsProfileHrisProfileIdPoliciesGetParametersPolicyTypeName": { "enum": [ "Adoption leave", "Advanced vacation", "Bereaved partner's paternity leave", "Bereavement leave", "Blood donation leave", "Breastfeeding leave", "Carer's leave", "Childbirth leave", "Childcare leave", "Civic/public duty leave", "Compensatory leave", "Disability leave", "Doctor's appointment leave", "Family & domestic violence leave", "Family responsibility leave", "Floating Holiday Allowance", "Hajj leave", "Hospitalization leave", "Long Service Leave", "Marriage/wedding leave", "Maternity leave", "Menstrual leave", "Military leave", "Moving leave", "Neonatal care leave", "Other leave", "Paid leave", "Parental bereavement leave", "Parental leave", "Paternity leave", "Personal leave", "Pregnancy leave", "Regional holiday", "RTT", "Shared parental leave", "Sick leave", "Study leave", "Supplementary Leave", "Unpaid leave", "Vacation", "Vacation - public holidays replacement", "Volunteer leave", "Work accident leave", "Work Location" ], "title": "TimeOffsProfileHrisProfileIdPoliciesGetParametersPolicyTypeName", "type": "string" }, "TimeOffsProfileHrisProfileIdPoliciesGetResponsesContentApplicationJsonSchemaPoliciesItems": { "description": "Time off policy", "properties": { "allow_to_edit_past_time_offs": { "description": "Whether editing past time offs is allowed", "type": "boolean" }, "auto_approval_inactivity_time_unit": { "description": "Unit for auto-approval inactivity time", "oneOf": [ { "$ref": "#/components/schemas/TimeOffsProfileHrisProfileIdPoliciesGetResponsesContentApplicationJsonSchemaPoliciesItemsAutoApprovalInactivityTimeUnit" }, { "type": "null" } ] }, "auto_approval_inactivity_time_unit_amount": { "description": "Amount of auto-approval inactivity time units", "format": "double", "type": [ "number", "null" ] }, "created_at": { "description": "Date and time when the policy was created", "format": "date-time", "type": "string" }, "custom_fields": { "description": "The custom fields the policy declares. Empty when the policy collects none.", "items": { "$ref": "#/components/schemas/TimeOffsProfileHrisProfileIdPoliciesGetResponsesContentApplicationJsonSchemaPoliciesItemsCustomFieldsItems" }, "type": "array" }, "description": { "description": "Description of the policy", "type": [ "string", "null" ] }, "has_custom_fields": { "description": "Whether the policy collects any custom field answers on its requests.", "type": "boolean" }, "id": { "description": "Unique identifier of the policy", "format": "uuid", "type": "string" }, "is_attachment_required": { "$ref": "#/components/schemas/TimeOffsProfileHrisProfileIdPoliciesGetResponsesContentApplicationJsonSchemaPoliciesItemsIsAttachmentRequired", "description": "Whether an attachment is required for time off requests" }, "is_description_required": { "description": "Whether a description is required for time off requests", "type": "boolean" }, "is_requiring_custom_fields": { "description": "Whether at least one of the policy's custom fields can be mandatory (ALWAYS_REQUIRED or REQUIRED_CONDITIONALLY). False when every custom field is OPTIONAL, or when the policy has none.", "type": "boolean" }, "leave_type": { "$ref": "#/components/schemas/TimeOffsProfileHrisProfileIdPoliciesGetResponsesContentApplicationJsonSchemaPoliciesItemsLeaveType", "description": "Type of leave for this policy" }, "name": { "description": "Name of the policy", "type": "string" }, "notice_period_unit": { "description": "Unit for notice period", "oneOf": [ { "$ref": "#/components/schemas/TimeOffsProfileHrisProfileIdPoliciesGetResponsesContentApplicationJsonSchemaPoliciesItemsNoticePeriodUnit" }, { "type": "null" } ] }, "notice_period_unit_amount": { "description": "Amount of notice period units", "format": "double", "type": [ "number", "null" ] }, "overlap_request_type": { "$ref": "#/components/schemas/TimeOffsProfileHrisProfileIdPoliciesGetResponsesContentApplicationJsonSchemaPoliciesItemsOverlapRequestType", "description": "Type of overlapping requests allowed" }, "payment_type": { "$ref": "#/components/schemas/TimeOffsProfileHrisProfileIdPoliciesGetResponsesContentApplicationJsonSchemaPoliciesItemsPaymentType", "description": "Payment type for the time off policy" }, "policy_allowance_proration": { "$ref": "#/components/schemas/TimeOffsProfileHrisProfileIdPoliciesGetResponsesContentApplicationJsonSchemaPoliciesItemsPolicyAllowanceProration", "description": "Proration configuration for policy allowances" }, "policy_allowances": { "description": "Allowances associated with this policy", "items": { "$ref": "#/components/schemas/TimeOffsProfileHrisProfileIdPoliciesGetResponsesContentApplicationJsonSchemaPoliciesItemsPolicyAllowancesItems" }, "type": "array" }, "policy_type": { "$ref": "#/components/schemas/TimeOffsProfileHrisProfileIdPoliciesGetResponsesContentApplicationJsonSchemaPoliciesItemsPolicyType", "description": "Type of this policy" }, "policy_type_id": { "description": "Unique identifier of the policy type", "format": "uuid", "type": "string" }, "request_start_type": { "description": "Type of request start configuration", "oneOf": [ { "$ref": "#/components/schemas/TimeOffsProfileHrisProfileIdPoliciesGetResponsesContentApplicationJsonSchemaPoliciesItemsRequestStartType" }, { "type": "null" } ] }, "request_start_unit": { "description": "Unit used for request start configuration", "oneOf": [ { "$ref": "#/components/schemas/TimeOffsProfileHrisProfileIdPoliciesGetResponsesContentApplicationJsonSchemaPoliciesItemsRequestStartUnit" }, { "type": "null" } ] }, "request_start_unit_amount": { "description": "Amount of request start units", "format": "double", "type": [ "number", "null" ] }, "retrospective_request_type": { "$ref": "#/components/schemas/TimeOffsProfileHrisProfileIdPoliciesGetResponsesContentApplicationJsonSchemaPoliciesItemsRetrospectiveRequestType", "description": "Type of retrospective requests allowed" }, "time_off_request_type": { "$ref": "#/components/schemas/TimeOffsProfileHrisProfileIdPoliciesGetResponsesContentApplicationJsonSchemaPoliciesItemsTimeOffRequestType", "description": "Type of time off requests allowed" }, "time_off_types": { "description": "Time off types associated with this policy", "items": { "$ref": "#/components/schemas/TimeOffsProfileHrisProfileIdPoliciesGetResponsesContentApplicationJsonSchemaPoliciesItemsTimeOffTypesItems" }, "type": "array" }, "tracking_cadence": { "$ref": "#/components/schemas/TimeOffsProfileHrisProfileIdPoliciesGetResponsesContentApplicationJsonSchemaPoliciesItemsTrackingCadence", "description": "Cadence for tracking policy periods" }, "tracking_start_date": { "description": "Start date for tracking policy periods", "format": "date", "type": [ "string", "null" ] }, "tracking_unit": { "description": "Unit used for tracking policy periods", "oneOf": [ { "$ref": "#/components/schemas/TimeOffsProfileHrisProfileIdPoliciesGetResponsesContentApplicationJsonSchemaPoliciesItemsTrackingUnit" }, { "type": "null" } ] }, "tracking_unit_amount": { "description": "Amount of tracking units", "format": "double", "type": [ "number", "null" ] }, "updated_at": { "description": "Date and time when the policy was last updated", "format": "date-time", "type": "string" } }, "required": [ "id", "name", "created_at", "leave_type", "updated_at", "policy_type", "payment_type", "custom_fields", "tracking_unit", "has_custom_fields", "policy_allowances", "notice_period_unit", "request_start_type", "request_start_unit", "overlap_request_type", "tracking_unit_amount", "time_off_request_type", "is_attachment_required", "is_description_required", "notice_period_unit_amount", "request_start_unit_amount", "is_requiring_custom_fields", "policy_allowance_proration", "retrospective_request_type", "allow_to_edit_past_time_offs", "auto_approval_inactivity_time_unit", "auto_approval_inactivity_time_unit_amount" ], "title": "TimeOffsProfileHrisProfileIdPoliciesGetResponsesContentApplicationJsonSchemaPoliciesItems", "type": "object" }, "TimeOffsProfileHrisProfileIdPoliciesGetResponsesContentApplicationJsonSchemaPoliciesItemsAutoApprovalInactivityTimeUnit": { "description": "Unit for auto-approval inactivity time", "enum": [ "HOUR", "BUSINESS_DAY", "CALENDAR_DAY", "WEEK", "MONTH", "YEAR" ], "title": "TimeOffsProfileHrisProfileIdPoliciesGetResponsesContentApplicationJsonSchemaPoliciesItemsAutoApprovalInactivityTimeUnit", "type": "string" }, "TimeOffsProfileHrisProfileIdPoliciesGetResponsesContentApplicationJsonSchemaPoliciesItemsCustomFieldsItems": { "properties": { "field_requirement": { "$ref": "#/components/schemas/TimeOffsProfileHrisProfileIdPoliciesGetResponsesContentApplicationJsonSchemaPoliciesItemsCustomFieldsItemsFieldRequirement", "description": "Whether an answer is mandatory, and under which conditions." }, "id": { "description": "The custom field id.", "format": "uuid", "type": "string" }, "key": { "description": "Machine key, unique within the policy.", "type": "string" }, "name": { "description": "Human-facing field name shown on the request form.", "type": "string" }, "requirement_conditions": { "description": "Present only for a REQUIRED_CONDITIONALLY field: the conditions under which it becomes required.", "items": { "$ref": "#/components/schemas/TimeOffsProfileHrisProfileIdPoliciesGetResponsesContentApplicationJsonSchemaPoliciesItemsCustomFieldsItemsRequirementConditionsItems" }, "type": [ "array", "null" ] }, "schema": { "$ref": "#/components/schemas/TimeOffsProfileHrisProfileIdPoliciesGetResponsesContentApplicationJsonSchemaPoliciesItemsCustomFieldsItemsSchema", "description": "The value type plus shape/constraints of the field." } }, "required": [ "id", "key", "name", "schema", "field_requirement" ], "title": "TimeOffsProfileHrisProfileIdPoliciesGetResponsesContentApplicationJsonSchemaPoliciesItemsCustomFieldsItems", "type": "object" }, "TimeOffsProfileHrisProfileIdPoliciesGetResponsesContentApplicationJsonSchemaPoliciesItemsCustomFieldsItemsFieldRequirement": { "description": "Whether an answer is mandatory, and under which conditions.", "enum": [ "ALWAYS_REQUIRED", "REQUIRED_CONDITIONALLY", "OPTIONAL" ], "title": "TimeOffsProfileHrisProfileIdPoliciesGetResponsesContentApplicationJsonSchemaPoliciesItemsCustomFieldsItemsFieldRequirement", "type": "string" }, "TimeOffsProfileHrisProfileIdPoliciesGetResponsesContentApplicationJsonSchemaPoliciesItemsCustomFieldsItemsRequirementConditionsItems": { "properties": { "left_field_key": { "description": "Machine key of the field whose answer is being compared.", "type": "string" }, "operator": { "$ref": "#/components/schemas/TimeOffsProfileHrisProfileIdPoliciesGetResponsesContentApplicationJsonSchemaPoliciesItemsCustomFieldsItemsRequirementConditionsItemsOperator", "description": "How the left field's answer is compared against the right side." }, "right_field_key": { "description": "Machine key of another field to compare against, when the right side is itself an answer rather than a static value.", "type": "string" }, "static_items": { "description": "Literal list to compare against, for IS_ANY_OF.", "items": { "type": "string" }, "type": [ "array", "null" ] }, "static_value": { "description": "Literal value to compare against, for a single-value operator (IS, IS_NOT, IS_AT_LEAST, IS_AT_MOST, IS_LESS_THAN, IS_MORE_THAN).", "type": [ "string", "null" ] } }, "required": [ "operator" ], "title": "TimeOffsProfileHrisProfileIdPoliciesGetResponsesContentApplicationJsonSchemaPoliciesItemsCustomFieldsItemsRequirementConditionsItems", "type": "object" }, "TimeOffsProfileHrisProfileIdPoliciesGetResponsesContentApplicationJsonSchemaPoliciesItemsCustomFieldsItemsRequirementConditionsItemsOperator": { "description": "How the left field's answer is compared against the right side.", "enum": [ "IS", "IS_NOT", "IS_ANY_OF", "IS_AT_LEAST", "IS_AT_MOST", "IS_LESS_THAN", "IS_MORE_THAN" ], "title": "TimeOffsProfileHrisProfileIdPoliciesGetResponsesContentApplicationJsonSchemaPoliciesItemsCustomFieldsItemsRequirementConditionsItemsOperator", "type": "string" }, "TimeOffsProfileHrisProfileIdPoliciesGetResponsesContentApplicationJsonSchemaPoliciesItemsCustomFieldsItemsSchema": { "description": "The value type plus shape/constraints of the field.", "properties": { "enum": { "description": "Allowed values, when the field is a closed list.", "items": { "type": "string" }, "type": "array" }, "is_nullable": { "description": "Whether the field accepts a null answer. Always `false` today — nullable custom fields are not supported yet, but the flag is present from the start so support can be added later without a breaking change.", "type": "boolean" }, "type": { "$ref": "#/components/schemas/TimeOffsProfileHrisProfileIdPoliciesGetResponsesContentApplicationJsonSchemaPoliciesItemsCustomFieldsItemsSchemaType", "description": "The value type of the field." } }, "required": [ "type", "is_nullable" ], "title": "TimeOffsProfileHrisProfileIdPoliciesGetResponsesContentApplicationJsonSchemaPoliciesItemsCustomFieldsItemsSchema", "type": "object" }, "TimeOffsProfileHrisProfileIdPoliciesGetResponsesContentApplicationJsonSchemaPoliciesItemsCustomFieldsItemsSchemaType": { "description": "The value type of the field.", "enum": [ "string", "number", "boolean", "date", "datetime" ], "title": "TimeOffsProfileHrisProfileIdPoliciesGetResponsesContentApplicationJsonSchemaPoliciesItemsCustomFieldsItemsSchemaType", "type": "string" }, "TimeOffsProfileHrisProfileIdPoliciesGetResponsesContentApplicationJsonSchemaPoliciesItemsIsAttachmentRequired": { "description": "Whether an attachment is required for time off requests", "enum": [ "NOT_REQUIRED", "REQUIRED", "CONDITIONALLY_REQUIRED" ], "title": "TimeOffsProfileHrisProfileIdPoliciesGetResponsesContentApplicationJsonSchemaPoliciesItemsIsAttachmentRequired", "type": "string" }, "TimeOffsProfileHrisProfileIdPoliciesGetResponsesContentApplicationJsonSchemaPoliciesItemsLeaveType": { "description": "Type of leave for this policy", "enum": [ "SHORT_TERM_LEAVE", "LONG_TERM_LEAVE" ], "title": "TimeOffsProfileHrisProfileIdPoliciesGetResponsesContentApplicationJsonSchemaPoliciesItemsLeaveType", "type": "string" }, "TimeOffsProfileHrisProfileIdPoliciesGetResponsesContentApplicationJsonSchemaPoliciesItemsNoticePeriodUnit": { "description": "Unit for notice period", "enum": [ "HOUR", "BUSINESS_DAY", "CALENDAR_DAY", "WEEK", "MONTH", "YEAR" ], "title": "TimeOffsProfileHrisProfileIdPoliciesGetResponsesContentApplicationJsonSchemaPoliciesItemsNoticePeriodUnit", "type": "string" }, "TimeOffsProfileHrisProfileIdPoliciesGetResponsesContentApplicationJsonSchemaPoliciesItemsOverlapRequestType": { "description": "Type of overlapping requests allowed", "enum": [ "ALLOWED", "NOT_ALLOWED" ], "title": "TimeOffsProfileHrisProfileIdPoliciesGetResponsesContentApplicationJsonSchemaPoliciesItemsOverlapRequestType", "type": "string" }, "TimeOffsProfileHrisProfileIdPoliciesGetResponsesContentApplicationJsonSchemaPoliciesItemsPaymentType": { "description": "Payment type for the time off policy", "enum": [ "PAID", "UNPAID" ], "title": "TimeOffsProfileHrisProfileIdPoliciesGetResponsesContentApplicationJsonSchemaPoliciesItemsPaymentType", "type": "string" }, "TimeOffsProfileHrisProfileIdPoliciesGetResponsesContentApplicationJsonSchemaPoliciesItemsPolicyAllowanceProration": { "description": "Proration configuration for policy allowances", "properties": { "part_time_worker_treatment_specific_amount": { "description": "Specific amount for part-time worker treatment when the type is CUSTOM_ENTITLEMENT", "format": "double", "type": [ "number", "null" ] }, "part_time_worker_treatment_type": { "$ref": "#/components/schemas/TimeOffsProfileHrisProfileIdPoliciesGetResponsesContentApplicationJsonSchemaPoliciesItemsPolicyAllowanceProrationPartTimeWorkerTreatmentType", "description": "Type of treatment for part-time workers" }, "prorates_on_hire": { "description": "Whether proration is applied on hire", "type": "boolean" }, "prorates_on_termination": { "description": "Whether proration is applied on termination", "type": "boolean" } }, "required": [ "prorates_on_hire", "prorates_on_termination", "part_time_worker_treatment_type", "part_time_worker_treatment_specific_amount" ], "title": "TimeOffsProfileHrisProfileIdPoliciesGetResponsesContentApplicationJsonSchemaPoliciesItemsPolicyAllowanceProration", "type": "object" }, "TimeOffsProfileHrisProfileIdPoliciesGetResponsesContentApplicationJsonSchemaPoliciesItemsPolicyAllowanceProrationPartTimeWorkerTreatmentType": { "description": "Type of treatment for part-time workers", "enum": [ "SAME_AS_FTE", "PERCENTAGE_OF_FTE", "BASED_ON_WORK_HOURS", "BASED_ON_WORK_DAYS", "CUSTOM_ENTITLEMENT" ], "title": "TimeOffsProfileHrisProfileIdPoliciesGetResponsesContentApplicationJsonSchemaPoliciesItemsPolicyAllowanceProrationPartTimeWorkerTreatmentType", "type": "string" }, "TimeOffsProfileHrisProfileIdPoliciesGetResponsesContentApplicationJsonSchemaPoliciesItemsPolicyAllowancesItems": { "properties": { "accrual_application_type": { "description": "Type of accrual application. Enum to indicate when accruals will be applied within the accrual cycles.", "oneOf": [ { "$ref": "#/components/schemas/TimeOffsProfileHrisProfileIdPoliciesGetResponsesContentApplicationJsonSchemaPoliciesItemsPolicyAllowancesItemsAccrualApplicationType" }, { "type": "null" } ] }, "accrual_type": { "$ref": "#/components/schemas/TimeOffsProfileHrisProfileIdPoliciesGetResponsesContentApplicationJsonSchemaPoliciesItemsPolicyAllowancesItemsAccrualType", "description": "Type of accrual for the allowance. Determines how/when profiles should earn their entitlement (aka: allowance)." }, "accrual_unit": { "description": "Unit used for accrual", "oneOf": [ { "$ref": "#/components/schemas/TimeOffsProfileHrisProfileIdPoliciesGetResponsesContentApplicationJsonSchemaPoliciesItemsPolicyAllowancesItemsAccrualUnit" }, { "type": "null" } ] }, "accrual_unit_amount": { "description": "Amount of accrual units", "format": "double", "type": [ "number", "null" ] }, "balance_tracking_flexible_custom_request_amount": { "description": "Amount for flexible custom request balance tracking. The flexible custom extra amount request of the policy allowance.", "format": "double", "type": [ "number", "null" ] }, "balance_tracking_type": { "description": "Type of balance tracking. Determines how workers can request their time off.", "oneOf": [ { "$ref": "#/components/schemas/TimeOffsProfileHrisProfileIdPoliciesGetResponsesContentApplicationJsonSchemaPoliciesItemsPolicyAllowancesItemsBalanceTrackingType" }, { "type": "null" } ] }, "enable_bank_holidays": { "description": "Whether bank holidays are enabled for this allowance", "type": "boolean" }, "entitlement_expiration_unit": { "description": "Unit used for entitlement expiration", "oneOf": [ { "$ref": "#/components/schemas/TimeOffsProfileHrisProfileIdPoliciesGetResponsesContentApplicationJsonSchemaPoliciesItemsPolicyAllowancesItemsEntitlementExpirationUnit" }, { "type": "null" } ] }, "entitlement_expiration_unit_amount": { "description": "Amount of entitlement expiration units", "format": "double", "type": [ "number", "null" ] }, "entitlement_start_date": { "description": "Start date for entitlement", "format": "date", "type": [ "string", "null" ] }, "entitlement_start_type": { "$ref": "#/components/schemas/TimeOffsProfileHrisProfileIdPoliciesGetResponsesContentApplicationJsonSchemaPoliciesItemsPolicyAllowancesItemsEntitlementStartType", "description": "Type of entitlement start" }, "entitlement_start_unit": { "description": "Unit used for entitlement start", "oneOf": [ { "$ref": "#/components/schemas/TimeOffsProfileHrisProfileIdPoliciesGetResponsesContentApplicationJsonSchemaPoliciesItemsPolicyAllowancesItemsEntitlementStartUnit" }, { "type": "null" } ] }, "entitlement_start_unit_amount": { "description": "Amount of entitlement start units", "format": "double", "type": [ "number", "null" ] }, "entitlement_unit": { "description": "Unit used for entitlement", "oneOf": [ { "$ref": "#/components/schemas/TimeOffsProfileHrisProfileIdPoliciesGetResponsesContentApplicationJsonSchemaPoliciesItemsPolicyAllowancesItemsEntitlementUnit" }, { "type": "null" } ] }, "entitlement_unit_amount": { "description": "Amount of entitlement units", "format": "double", "type": [ "number", "null" ] }, "id": { "description": "Unique identifier of the policy allowance", "format": "uuid", "type": "string" }, "part_time_prorated_entitlement_unit_amount": { "description": "The total prorated policy allowance entitlement amount if the worker is part-time.", "format": "double", "type": [ "number", "null" ] }, "rollover_expiration_unit": { "description": "Unit used for rollover expiration", "oneOf": [ { "$ref": "#/components/schemas/TimeOffsProfileHrisProfileIdPoliciesGetResponsesContentApplicationJsonSchemaPoliciesItemsPolicyAllowancesItemsRolloverExpirationUnit" }, { "type": "null" } ] }, "rollover_expiration_unit_amount": { "description": "Amount of rollover expiration units", "format": "double", "type": [ "number", "null" ] }, "rollover_limit_unit_amount": { "description": "Amount of rollover limit units", "format": "double", "type": [ "number", "null" ] }, "rollover_type": { "description": "Type of rollover", "oneOf": [ { "$ref": "#/components/schemas/TimeOffsProfileHrisProfileIdPoliciesGetResponsesContentApplicationJsonSchemaPoliciesItemsPolicyAllowancesItemsRolloverType" }, { "type": "null" } ] }, "type": { "$ref": "#/components/schemas/TimeOffsProfileHrisProfileIdPoliciesGetResponsesContentApplicationJsonSchemaPoliciesItemsPolicyAllowancesItemsType", "description": "Type of the policy allowance" }, "zero_out_negative_balances_on_rollover": { "description": "Whether negative balances are zeroed out on rollover", "type": "boolean" } }, "required": [ "id", "type", "accrual_type", "accrual_unit", "rollover_type", "entitlement_unit", "accrual_unit_amount", "enable_bank_holidays", "balance_tracking_type", "entitlement_start_date", "entitlement_start_type", "entitlement_start_unit", "entitlement_unit_amount", "accrual_application_type", "rollover_expiration_unit", "rollover_limit_unit_amount", "entitlement_expiration_unit", "entitlement_start_unit_amount", "rollover_expiration_unit_amount", "entitlement_expiration_unit_amount", "zero_out_negative_balances_on_rollover", "balance_tracking_flexible_custom_request_amount" ], "title": "TimeOffsProfileHrisProfileIdPoliciesGetResponsesContentApplicationJsonSchemaPoliciesItemsPolicyAllowancesItems", "type": "object" }, "TimeOffsProfileHrisProfileIdPoliciesGetResponsesContentApplicationJsonSchemaPoliciesItemsPolicyAllowancesItemsAccrualApplicationType": { "description": "Type of accrual application. Enum to indicate when accruals will be applied within the accrual cycles.", "enum": [ "BEGIN_OF_CYCLE", "END_OF_CYCLE", "BEGIN_OF_NEXT_CYCLE" ], "title": "TimeOffsProfileHrisProfileIdPoliciesGetResponsesContentApplicationJsonSchemaPoliciesItemsPolicyAllowancesItemsAccrualApplicationType", "type": "string" }, "TimeOffsProfileHrisProfileIdPoliciesGetResponsesContentApplicationJsonSchemaPoliciesItemsPolicyAllowancesItemsAccrualType": { "description": "Type of accrual for the allowance. Determines how/when profiles should earn their entitlement (aka: allowance).", "enum": [ "TIMEFRAME", "EVENT", "TIME_OFF_IN_LIEU", "HOURLY", "LUMPSUM", "NO_AUTO_ACCRUAL" ], "title": "TimeOffsProfileHrisProfileIdPoliciesGetResponsesContentApplicationJsonSchemaPoliciesItemsPolicyAllowancesItemsAccrualType", "type": "string" }, "TimeOffsProfileHrisProfileIdPoliciesGetResponsesContentApplicationJsonSchemaPoliciesItemsPolicyAllowancesItemsAccrualUnit": { "description": "Unit used for accrual", "enum": [ "HOUR", "BUSINESS_DAY", "CALENDAR_DAY", "WEEK", "MONTH", "YEAR" ], "title": "TimeOffsProfileHrisProfileIdPoliciesGetResponsesContentApplicationJsonSchemaPoliciesItemsPolicyAllowancesItemsAccrualUnit", "type": "string" }, "TimeOffsProfileHrisProfileIdPoliciesGetResponsesContentApplicationJsonSchemaPoliciesItemsPolicyAllowancesItemsBalanceTrackingType": { "description": "Type of balance tracking. Determines how workers can request their time off.", "enum": [ "INFLEXIBLE", "FLEXIBLE_NO_LIMIT", "FLEXIBLE_CUSTOM_AMOUNT", "FLEXIBLE_UP_TO_YEARLY_ALLOWANCE" ], "title": "TimeOffsProfileHrisProfileIdPoliciesGetResponsesContentApplicationJsonSchemaPoliciesItemsPolicyAllowancesItemsBalanceTrackingType", "type": "string" }, "TimeOffsProfileHrisProfileIdPoliciesGetResponsesContentApplicationJsonSchemaPoliciesItemsPolicyAllowancesItemsEntitlementExpirationUnit": { "description": "Unit used for entitlement expiration", "enum": [ "HOUR", "BUSINESS_DAY", "CALENDAR_DAY", "WEEK", "MONTH", "YEAR" ], "title": "TimeOffsProfileHrisProfileIdPoliciesGetResponsesContentApplicationJsonSchemaPoliciesItemsPolicyAllowancesItemsEntitlementExpirationUnit", "type": "string" }, "TimeOffsProfileHrisProfileIdPoliciesGetResponsesContentApplicationJsonSchemaPoliciesItemsPolicyAllowancesItemsEntitlementStartType": { "description": "Type of entitlement start", "enum": [ "IMMEDIATELY", "FIXED_PERIOD", "FIXED_DAY" ], "title": "TimeOffsProfileHrisProfileIdPoliciesGetResponsesContentApplicationJsonSchemaPoliciesItemsPolicyAllowancesItemsEntitlementStartType", "type": "string" }, "TimeOffsProfileHrisProfileIdPoliciesGetResponsesContentApplicationJsonSchemaPoliciesItemsPolicyAllowancesItemsEntitlementStartUnit": { "description": "Unit used for entitlement start", "enum": [ "HOUR", "BUSINESS_DAY", "CALENDAR_DAY", "WEEK", "MONTH", "YEAR" ], "title": "TimeOffsProfileHrisProfileIdPoliciesGetResponsesContentApplicationJsonSchemaPoliciesItemsPolicyAllowancesItemsEntitlementStartUnit", "type": "string" }, "TimeOffsProfileHrisProfileIdPoliciesGetResponsesContentApplicationJsonSchemaPoliciesItemsPolicyAllowancesItemsEntitlementUnit": { "description": "Unit used for entitlement", "enum": [ "HOUR", "BUSINESS_DAY", "CALENDAR_DAY", "WEEK", "MONTH", "YEAR" ], "title": "TimeOffsProfileHrisProfileIdPoliciesGetResponsesContentApplicationJsonSchemaPoliciesItemsPolicyAllowancesItemsEntitlementUnit", "type": "string" }, "TimeOffsProfileHrisProfileIdPoliciesGetResponsesContentApplicationJsonSchemaPoliciesItemsPolicyAllowancesItemsRolloverExpirationUnit": { "description": "Unit used for rollover expiration", "enum": [ "HOUR", "BUSINESS_DAY", "CALENDAR_DAY", "WEEK", "MONTH", "YEAR" ], "title": "TimeOffsProfileHrisProfileIdPoliciesGetResponsesContentApplicationJsonSchemaPoliciesItemsPolicyAllowancesItemsRolloverExpirationUnit", "type": "string" }, "TimeOffsProfileHrisProfileIdPoliciesGetResponsesContentApplicationJsonSchemaPoliciesItemsPolicyAllowancesItemsRolloverType": { "description": "Type of rollover", "enum": [ "NO_ROLLOVER", "PAY_OUT", "CARRY_OVER", "CARRY_OVER_PAY_OUT" ], "title": "TimeOffsProfileHrisProfileIdPoliciesGetResponsesContentApplicationJsonSchemaPoliciesItemsPolicyAllowancesItemsRolloverType", "type": "string" }, "TimeOffsProfileHrisProfileIdPoliciesGetResponsesContentApplicationJsonSchemaPoliciesItemsPolicyAllowancesItemsType": { "description": "Type of the policy allowance", "enum": [ "BASE_ALLOWANCE", "ADDITIONAL_ALLOWANCE" ], "title": "TimeOffsProfileHrisProfileIdPoliciesGetResponsesContentApplicationJsonSchemaPoliciesItemsPolicyAllowancesItemsType", "type": "string" }, "TimeOffsProfileHrisProfileIdPoliciesGetResponsesContentApplicationJsonSchemaPoliciesItemsPolicyType": { "description": "Type of this policy", "properties": { "id": { "description": "Unique identifier of the policy type", "format": "uuid", "type": "string" }, "name": { "description": "Name of the policy type", "type": "string" } }, "required": [ "id", "name" ], "title": "TimeOffsProfileHrisProfileIdPoliciesGetResponsesContentApplicationJsonSchemaPoliciesItemsPolicyType", "type": "object" }, "TimeOffsProfileHrisProfileIdPoliciesGetResponsesContentApplicationJsonSchemaPoliciesItemsRequestStartType": { "description": "Type of request start configuration", "enum": [ "IMMEDIATELY", "FIXED_PERIOD" ], "title": "TimeOffsProfileHrisProfileIdPoliciesGetResponsesContentApplicationJsonSchemaPoliciesItemsRequestStartType", "type": "string" }, "TimeOffsProfileHrisProfileIdPoliciesGetResponsesContentApplicationJsonSchemaPoliciesItemsRequestStartUnit": { "description": "Unit used for request start configuration", "enum": [ "HOUR", "BUSINESS_DAY", "CALENDAR_DAY", "WEEK", "MONTH", "YEAR" ], "title": "TimeOffsProfileHrisProfileIdPoliciesGetResponsesContentApplicationJsonSchemaPoliciesItemsRequestStartUnit", "type": "string" }, "TimeOffsProfileHrisProfileIdPoliciesGetResponsesContentApplicationJsonSchemaPoliciesItemsRetrospectiveRequestType": { "description": "Type of retrospective requests allowed", "enum": [ "ALLOWED", "NOT_ALLOWED" ], "title": "TimeOffsProfileHrisProfileIdPoliciesGetResponsesContentApplicationJsonSchemaPoliciesItemsRetrospectiveRequestType", "type": "string" }, "TimeOffsProfileHrisProfileIdPoliciesGetResponsesContentApplicationJsonSchemaPoliciesItemsTimeOffRequestType": { "description": "Type of time off requests allowed", "enum": [ "HALF_DAY", "HOURLY", "FULL_DAY", "PERCENTAGE", "PARTIAL_HOURS" ], "title": "TimeOffsProfileHrisProfileIdPoliciesGetResponsesContentApplicationJsonSchemaPoliciesItemsTimeOffRequestType", "type": "string" }, "TimeOffsProfileHrisProfileIdPoliciesGetResponsesContentApplicationJsonSchemaPoliciesItemsTimeOffTypesItems": { "properties": { "description": { "description": "Description of the time off type", "type": [ "string", "null" ] }, "id": { "description": "Unique identifier of the time off type", "format": "uuid", "type": "string" }, "name": { "description": "Name of the time off type", "type": "string" } }, "title": "TimeOffsProfileHrisProfileIdPoliciesGetResponsesContentApplicationJsonSchemaPoliciesItemsTimeOffTypesItems", "type": "object" }, "TimeOffsProfileHrisProfileIdPoliciesGetResponsesContentApplicationJsonSchemaPoliciesItemsTrackingCadence": { "description": "Cadence for tracking policy periods", "enum": [ "FIXED_DAY", "ANNIVERSARY", "NOT_SPECIFIED" ], "title": "TimeOffsProfileHrisProfileIdPoliciesGetResponsesContentApplicationJsonSchemaPoliciesItemsTrackingCadence", "type": "string" }, "TimeOffsProfileHrisProfileIdPoliciesGetResponsesContentApplicationJsonSchemaPoliciesItemsTrackingUnit": { "description": "Unit used for tracking policy periods", "enum": [ "HOUR", "BUSINESS_DAY", "CALENDAR_DAY", "WEEK", "MONTH", "YEAR" ], "title": "TimeOffsProfileHrisProfileIdPoliciesGetResponsesContentApplicationJsonSchemaPoliciesItemsTrackingUnit", "type": "string" }, "TimeOffsReviewPostRequestBodyContentApplicationJsonSchemaDataItems": { "properties": { "id": { "description": "Time off id", "type": "string" }, "status": { "$ref": "#/components/schemas/TimeOffsReviewPostRequestBodyContentApplicationJsonSchemaDataItemsStatus", "description": "Decision on whether the time off request was approved or rejected" } }, "required": [ "id", "status" ], "title": "TimeOffsReviewPostRequestBodyContentApplicationJsonSchemaDataItems", "type": "object" }, "TimeOffsReviewPostRequestBodyContentApplicationJsonSchemaDataItemsStatus": { "description": "Decision on whether the time off request was approved or rejected", "enum": [ "APPROVED", "REJECTED" ], "title": "TimeOffsReviewPostRequestBodyContentApplicationJsonSchemaDataItemsStatus", "type": "string" }, "TimeOffsReviewPostResponsesContentApplicationJsonSchemaData": { "properties": { "not_reviewed": { "items": { "$ref": "#/components/schemas/TimeOffsReviewPostResponsesContentApplicationJsonSchemaDataNotReviewedItems" }, "type": "array" }, "reviewed": { "items": { "$ref": "#/components/schemas/TimeOffsReviewPostResponsesContentApplicationJsonSchemaDataReviewedItems" }, "type": "array" } }, "required": [ "reviewed", "not_reviewed" ], "title": "TimeOffsReviewPostResponsesContentApplicationJsonSchemaData", "type": "object" }, "TimeOffsReviewPostResponsesContentApplicationJsonSchemaDataNotReviewedItems": { "properties": { "error": { "description": "The error or reason why a time-off could not be reviewed", "type": "string" }, "id": { "description": "Time off id", "format": "uuid", "type": "string" } }, "required": [ "id", "error" ], "title": "TimeOffsReviewPostResponsesContentApplicationJsonSchemaDataNotReviewedItems", "type": "object" }, "TimeOffsReviewPostResponsesContentApplicationJsonSchemaDataReviewedItems": { "properties": { "id": { "description": "Time off id", "format": "uuid", "type": "string" }, "status": { "$ref": "#/components/schemas/TimeOffsReviewPostResponsesContentApplicationJsonSchemaDataReviewedItemsStatus", "description": "Time off status after review" } }, "required": [ "id", "status" ], "title": "TimeOffsReviewPostResponsesContentApplicationJsonSchemaDataReviewedItems", "type": "object" }, "TimeOffsReviewPostResponsesContentApplicationJsonSchemaDataReviewedItemsStatus": { "description": "Time off status after review", "enum": [ "APPROVED", "USED", "REJECTED" ], "title": "TimeOffsReviewPostResponsesContentApplicationJsonSchemaDataReviewedItemsStatus", "type": "string" }, "TimeOffsReviewPostResponsesContentApplicationJsonSchemaErrorsItems": { "properties": { "message": { "description": "A description of the returned error", "type": "string" }, "path": { "description": "The JSON path where input validation failed", "type": "string" } }, "title": "TimeOffsReviewPostResponsesContentApplicationJsonSchemaErrorsItems", "type": "object" }, "TimeOffsReviewPostResponsesContentApplicationJsonSchemaRequest": { "properties": { "api_req_id": { "description": "The request ID of the failed request", "type": "string" }, "code": { "description": "The code of the source handler which produced the returned error", "format": "double", "type": "number" }, "docs": { "description": "A link to the official documentation for the requested endpoint resource", "type": "string" }, "method": { "description": "The HTTP method of the failed request", "type": "string" }, "source": { "description": "The source handler which produced the returned error", "type": "string" }, "status": { "description": "The status code of the response", "format": "double", "type": "number" }, "url": { "description": "The relative URL of the failed request", "type": "string" } }, "title": "TimeOffsReviewPostResponsesContentApplicationJsonSchemaRequest", "type": "object" }, "TimeOffsTimeOffEventsGetResponsesContentApplicationJsonSchemaDataItems": { "description": "Time off event object", "properties": { "created_at": { "description": "Time off creation date", "format": "date-time", "type": "string" }, "event_details": { "$ref": "#/components/schemas/TimeOffsTimeOffEventsGetResponsesContentApplicationJsonSchemaDataItemsEventDetails", "description": "Details of the time off event" }, "hris_profile_id": { "description": "Worker hris profile id", "format": "uuid", "type": "string" }, "id": { "description": "Time off event id", "format": "uuid", "type": "string" }, "policy_id": { "description": "Policy id", "type": "string" }, "time_off_type_id": { "description": "Time off type id", "type": "string" }, "type": { "description": "The type of event", "type": "string" }, "updated_at": { "description": "Time off update date", "format": "date-time", "type": "string" } }, "required": [ "id", "type", "policy_id", "created_at", "updated_at", "event_details", "hris_profile_id", "time_off_type_id" ], "title": "TimeOffsTimeOffEventsGetResponsesContentApplicationJsonSchemaDataItems", "type": "object" }, "TimeOffsTimeOffEventsGetResponsesContentApplicationJsonSchemaDataItemsEventDetails": { "description": "Details of the time off event", "properties": { "adoption_date": { "description": "End date of the time off", "format": "date", "type": "string" }, "birth_date": { "description": "Start date of the time off", "format": "date", "type": "string" }, "estimated_adoption_date": { "description": "The estimated date of the child adoption", "format": "date", "type": "string" }, "estimated_birth_date": { "description": "The estimated date of the child birth", "format": "date", "type": "string" }, "had_multiple_children": { "description": "Was it the birth of multiple children?", "type": "boolean" }, "was_premature_birth": { "description": "Was the child born prematurely?", "type": "boolean" } }, "title": "TimeOffsTimeOffEventsGetResponsesContentApplicationJsonSchemaDataItemsEventDetails", "type": "object" }, "TimeOffsTimeOffEventsGetResponsesContentApplicationJsonSchemaErrorsItems": { "properties": { "message": { "description": "A description of the returned error", "type": "string" }, "path": { "description": "The JSON path where input validation failed", "type": "string" } }, "title": "TimeOffsTimeOffEventsGetResponsesContentApplicationJsonSchemaErrorsItems", "type": "object" }, "TimeOffsTimeOffEventsGetResponsesContentApplicationJsonSchemaRequest": { "properties": { "api_req_id": { "description": "The request ID of the failed request", "type": "string" }, "code": { "description": "The code of the source handler which produced the returned error", "format": "double", "type": "number" }, "docs": { "description": "A link to the official documentation for the requested endpoint resource", "type": "string" }, "method": { "description": "The HTTP method of the failed request", "type": "string" }, "source": { "description": "The source handler which produced the returned error", "type": "string" }, "status": { "description": "The status code of the response", "format": "double", "type": "number" }, "url": { "description": "The relative URL of the failed request", "type": "string" } }, "title": "TimeOffsTimeOffEventsGetResponsesContentApplicationJsonSchemaRequest", "type": "object" }, "TimeOffsTimeOffIdPatchRequestBodyContentApplicationJsonSchemaData": { "description": "Time off update request data", "properties": { "contract_oid": { "description": "Contract id. This is the id of the contract associated with the time off request.", "maxLength": 24, "type": [ "string", "null" ] }, "custom_field_values": { "description": "Answers to the custom fields the request policy declares, addressed by custom field id.", "items": { "$ref": "#/components/schemas/TimeOffsTimeOffIdPatchRequestBodyContentApplicationJsonSchemaDataCustomFieldValuesItems" }, "type": [ "array", "null" ] }, "dates": { "description": "The dates breakdown for the time off request.", "items": { "$ref": "#/components/schemas/TimeOffsTimeOffIdPatchRequestBodyContentApplicationJsonSchemaDataDatesItems" }, "type": "array" }, "deduction_amount": { "description": "Deduction amount. Available for independent contractor's policies", "title": "float", "type": [ "string", "null" ] }, "description": { "description": "Description of the time off request. Some policies require that a description is provided.", "maxLength": 500, "type": [ "string", "null" ] }, "end_date": { "$ref": "#/components/schemas/TimeOffsTimeOffIdPatchRequestBodyContentApplicationJsonSchemaDataEndDate", "description": "End date of the time off request. This is the date when the time off ends. For example, if you take 2 days off, this will be the end date of the second day." }, "event_details": { "$ref": "#/components/schemas/TimeOffsTimeOffIdPatchRequestBodyContentApplicationJsonSchemaDataEventDetails", "description": "Details of the event associated with the time off request. Required for event based policies such as parental leave." }, "is_paid": { "description": "Whether the time off is paid or unpaid. By default it follows the policy configuration.", "type": "boolean" }, "other_type_description": { "description": "Description of the time off type. This is used when the policy is OTHER.", "maxLength": 255, "type": [ "string", "null" ] }, "policy_id": { "description": "The time off policy id. Can be used in place of time_off_type_id", "format": "uuid", "type": "string" }, "reason": { "description": "Reason for taking time off. This is complementary information for the time-off description. Useful to provide sub categories for the same policy.", "maxLength": 500, "type": [ "string", "null" ] }, "recipient_profile_id": { "description": "The hris profile id of the recipient", "format": "uuid", "type": "string" }, "start_date": { "$ref": "#/components/schemas/TimeOffsTimeOffIdPatchRequestBodyContentApplicationJsonSchemaDataStartDate", "description": "Start date of the time off request. This is the date when the time off starts. For example, if you take 2 days off, this will be the start date of the first day." }, "time_off_event_id": { "description": "The time off event id. This is used to link the time off request to an event.", "format": "uuid", "type": "string" }, "time_off_percentage": { "description": "This is the percentage of time off taken. This is used when the time off request is a percentage.", "format": "double", "maximum": 1, "minimum": 0, "type": [ "number", "null" ] }, "time_off_type_id": { "description": "The time off type id. Required when policy_id is not provided", "format": "uuid", "type": "string" } }, "required": [ "end_date", "start_date", "recipient_profile_id" ], "title": "TimeOffsTimeOffIdPatchRequestBodyContentApplicationJsonSchemaData", "type": "object" }, "TimeOffsTimeOffIdPatchRequestBodyContentApplicationJsonSchemaDataCustomFieldValuesItems": { "properties": { "field_id": { "description": "The id of the custom field this value answers.", "format": "uuid", "type": "string" }, "value": { "description": "The submitted value for the custom field. Accepts a string, number, or boolean — always stored as text. `null` means \"no answer for this field\" and is rejected today, since no field supports a null answer yet.", "oneOf": [ { "$ref": "#/components/schemas/TimeOffsTimeOffIdPatchRequestBodyContentApplicationJsonSchemaDataCustomFieldValuesItemsValue" }, { "type": "null" } ] } }, "required": [ "value", "field_id" ], "title": "TimeOffsTimeOffIdPatchRequestBodyContentApplicationJsonSchemaDataCustomFieldValuesItems", "type": "object" }, "TimeOffsTimeOffIdPatchRequestBodyContentApplicationJsonSchemaDataCustomFieldValuesItemsValue": { "description": "The submitted value for the custom field. Accepts a string, number, or boolean — always stored as text. `null` means \"no answer for this field\" and is rejected today, since no field supports a null answer yet.", "oneOf": [ { "type": "string" }, { "format": "double", "type": "number" }, { "type": "boolean" } ], "title": "TimeOffsTimeOffIdPatchRequestBodyContentApplicationJsonSchemaDataCustomFieldValuesItemsValue" }, "TimeOffsTimeOffIdPatchRequestBodyContentApplicationJsonSchemaDataDatesItems": { "description": "The dates breakdown for the time off request.", "properties": { "amount": { "description": "The amount of time off requested for the date. It must be in the same time unit as in the total amount for the time off request.", "title": "float", "type": "string" }, "date": { "$ref": "#/components/schemas/TimeOffsTimeOffIdPatchRequestBodyContentApplicationJsonSchemaDataDatesItemsDate", "description": "An specific date in the time-off request" }, "day_type": { "$ref": "#/components/schemas/TimeOffsTimeOffIdPatchRequestBodyContentApplicationJsonSchemaDataDatesItemsDayType", "description": "The type of day for the time off request. All dates must follow the same type." }, "hours": { "description": "The amount taken in hours during this specific date. It can not exceed the maximum allowed hours for the date.", "title": "float", "type": "string" } }, "required": [ "date" ], "title": "TimeOffsTimeOffIdPatchRequestBodyContentApplicationJsonSchemaDataDatesItems", "type": "object" }, "TimeOffsTimeOffIdPatchRequestBodyContentApplicationJsonSchemaDataDatesItemsDate": { "description": "An specific date in the time-off request", "oneOf": [ { "format": "date", "type": "string" }, { "format": "date-time", "type": "string" } ], "title": "TimeOffsTimeOffIdPatchRequestBodyContentApplicationJsonSchemaDataDatesItemsDate" }, "TimeOffsTimeOffIdPatchRequestBodyContentApplicationJsonSchemaDataDatesItemsDayType": { "description": "The type of day for the time off request. All dates must follow the same type.", "enum": [ "HALF_DAY", "FULL_DAY", "PERCENTAGE", "HOURLY" ], "title": "TimeOffsTimeOffIdPatchRequestBodyContentApplicationJsonSchemaDataDatesItemsDayType", "type": "string" }, "TimeOffsTimeOffIdPatchRequestBodyContentApplicationJsonSchemaDataEndDate": { "description": "End date of the time off request. This is the date when the time off ends. For example, if you take 2 days off, this will be the end date of the second day.", "oneOf": [ { "format": "date", "type": "string" }, { "format": "date-time", "type": "string" } ], "title": "TimeOffsTimeOffIdPatchRequestBodyContentApplicationJsonSchemaDataEndDate" }, "TimeOffsTimeOffIdPatchRequestBodyContentApplicationJsonSchemaDataEventDetails": { "description": "Details of the event associated with the time off request. Required for event based policies such as parental leave.", "properties": { "adoption_date": { "description": "The date of adoption. This is used for parental leave requests.", "format": "date", "type": "string" }, "birth_date": { "description": "The birth date of the child. This is used for parental leave requests.", "format": "date", "type": "string" }, "had_multiple_children": { "description": "Whether the birth was multiple or not. This is used for parental leave requests.", "type": "boolean" }, "is_confirmation": { "description": "Whether the event date are a confirmed or not. This is used for parental leave requests when either the birth date or adoption date are not estimated anymore but actually confirmed.", "type": "boolean" }, "was_premature_birth": { "description": "Whether the birth was premature or not. This is used for parental leave requests.", "type": "boolean" } }, "required": [ "birth_date", "was_premature_birth", "had_multiple_children" ], "title": "TimeOffsTimeOffIdPatchRequestBodyContentApplicationJsonSchemaDataEventDetails", "type": "object" }, "TimeOffsTimeOffIdPatchRequestBodyContentApplicationJsonSchemaDataStartDate": { "description": "Start date of the time off request. This is the date when the time off starts. For example, if you take 2 days off, this will be the start date of the first day.", "oneOf": [ { "format": "date", "type": "string" }, { "format": "date-time", "type": "string" } ], "title": "TimeOffsTimeOffIdPatchRequestBodyContentApplicationJsonSchemaDataStartDate" }, "TimeOffsTimeOffIdPatchResponsesContentApplicationJsonSchemaErrorsItems": { "properties": { "code": { "description": "A machine-readable error code", "type": "string" }, "details": { "description": "Additional error details, if applicable", "oneOf": [ { "$ref": "#/components/schemas/TimeOffsTimeOffIdPatchResponsesContentApplicationJsonSchemaErrorsItemsDetails" }, { "type": "null" } ] }, "field": { "description": "The field associated with the error, if applicable", "type": [ "string", "null" ] }, "message": { "description": "A description of the returned error", "type": "string" } }, "title": "TimeOffsTimeOffIdPatchResponsesContentApplicationJsonSchemaErrorsItems", "type": "object" }, "TimeOffsTimeOffIdPatchResponsesContentApplicationJsonSchemaErrorsItemsDetails": { "description": "Additional error details, if applicable", "properties": {}, "title": "TimeOffsTimeOffIdPatchResponsesContentApplicationJsonSchemaErrorsItemsDetails", "type": "object" }, "TimeOffsTimeOffIdPatchResponsesContentApplicationJsonSchemaRequest": { "description": "Request metadata", "properties": { "api_req_id": { "description": "Unique API request identifier", "type": "string" }, "docs": { "description": "Documentation reference", "type": "string" }, "method": { "description": "HTTP method", "type": "string" }, "source": { "description": "Request source", "type": "string" }, "status": { "description": "HTTP status code", "type": "integer" }, "url": { "description": "Request URL path", "type": "string" } }, "title": "TimeOffsTimeOffIdPatchResponsesContentApplicationJsonSchemaRequest", "type": "object" }, "TimeOffsTimeOffIdPatchResponsesContentApplicationJsonSchemaTimeOff": { "description": "Used to return the updated time off request after modification. Contains all the time off details including status, dates, amounts, and associated metadata.", "properties": { "amount": { "description": "Amount of time off taken. This is the total amount of time off taken. For example, if you take 2 days off, this will be 2. If you take 1 day off, this will be 1.", "title": "float", "type": "string" }, "approved_at": { "description": "This is the date when the time off request was approved. This will be null if the time off request is not approved yet.", "format": "date-time", "type": [ "string", "null" ] }, "attachments": { "description": "List of attachments associated with the time off request.", "items": { "$ref": "#/components/schemas/TimeOffsTimeOffIdPatchResponsesContentApplicationJsonSchemaTimeOffAttachmentsItems" }, "type": "array" }, "canceled_at": { "description": "Time off cancellation date", "format": "date-time", "type": [ "string", "null" ] }, "contract_oid": { "description": "Contract id. This is the id of the contract associated with the time off request.", "type": "string" }, "created_at": { "description": "This is the date when the time off request was created in the database.", "format": "date-time", "type": "string" }, "custom_field_values": { "description": "Answers to the custom fields the request policy declares. Omitted when the policy declares none.", "items": { "$ref": "#/components/schemas/TimeOffsTimeOffIdPatchResponsesContentApplicationJsonSchemaTimeOffCustomFieldValuesItems" }, "type": "array" }, "deduction_amount": { "description": "Deduction amount. Available for independent contractor's policies", "title": "float", "type": "string" }, "deleted_at": { "description": "Time off deletion date. Present only when the time-off is soft-deleted and include_deleted_time_offs was requested.", "format": "date-time", "type": [ "string", "null" ] }, "description": { "description": "Description of the time off request. Some policies require that a description is provided.", "type": "string" }, "end_date": { "description": "End date of the time off request. This is the date when the time off ends. For example, if you take 2 days off, this will be the end date of the second day.", "format": "date", "type": "string" }, "entitlement_unit": { "$ref": "#/components/schemas/TimeOffsTimeOffIdPatchResponsesContentApplicationJsonSchemaTimeOffEntitlementUnit", "description": "The unit in which the time off usage and entitlement are calculated." }, "half_end_date": { "description": "Whether the end date is a half day or not.", "type": "boolean" }, "half_start_date": { "description": "Whether the start date is a half day or not.", "type": "boolean" }, "is_end_date_estimated": { "description": "Used to indicate if the end date is an estimate rather than a confirmed date. This is particularly important for event-based policies such as Parental Leave, where the actual end date may depend on the actual birth or adoption date, which may not be known at the time of request submission.", "type": "boolean" }, "is_paid": { "description": "Whether the time off is paid or unpaid.", "type": "boolean" }, "other_type_description": { "description": "Used to provide a custom description when the time off type is categorized as 'OTHER'. This allows users to specify the nature of time off that doesn't fit into standard categories, providing flexibility for unique or organization-specific time off types.", "type": "string" }, "reason": { "description": "Reason for taking time off. This is complementary information for the time-off description. Useful to provide sub categories for the same policy.", "type": "string" }, "recipient_profile": { "$ref": "#/components/schemas/TimeOffsTimeOffIdPatchResponsesContentApplicationJsonSchemaTimeOffRecipientProfile", "description": "The time off profile of the recipient of the time off request. Must be a worker profile." }, "requested_at": { "description": "This is the date when the time off request was made.", "format": "date", "type": "string" }, "requester_profile": { "$ref": "#/components/schemas/TimeOffsTimeOffIdPatchResponsesContentApplicationJsonSchemaTimeOffRequesterProfile", "description": "The time off profile of the requester of the time off request. Can be either a client or worker profile." }, "start_date": { "description": "Start date of the time off request. This is the date when the time off starts. For example, if you take 2 days off, this will be the start date of the first day.", "format": "date", "type": "string" }, "status": { "$ref": "#/components/schemas/TimeOffsTimeOffIdPatchResponsesContentApplicationJsonSchemaTimeOffStatus", "description": "Status of the time off request. Can be REQUESTED, APPROVED, REJECTED, USED or CANCELED." }, "time_off_dailies": { "description": "Used to break down the time off request into daily records. Each entry represents a single day within the time off period, allowing for detailed tracking of working days, non-working days, and holidays included in the request.", "items": { "$ref": "#/components/schemas/TimeOffsTimeOffIdPatchResponsesContentApplicationJsonSchemaTimeOffTimeOffDailiesItems" }, "type": "array" }, "time_off_event": { "$ref": "#/components/schemas/TimeOffsTimeOffIdPatchResponsesContentApplicationJsonSchemaTimeOffTimeOffEvent" }, "time_off_percentage": { "description": "Used to specify the percentage of time off taken relative to full-time employment. This value ranges from 0 to 1, where 1 represents full-time (100%) and 0.5 represents part-time (50%). This is useful for part-time workers or when taking partial time off.", "title": "float", "type": "string" }, "time_off_type": { "$ref": "#/components/schemas/TimeOffsTimeOffIdPatchResponsesContentApplicationJsonSchemaTimeOffTimeOffType", "description": "The type of time off taken." }, "time_off_type_id": { "description": "Time off type id. This is the id of the time off type associated with the time off request.", "format": "uuid", "type": "string" }, "updated_at": { "description": "This is the date when the time off request was last updated in the database.", "format": "date-time", "type": "string" } }, "required": [ "amount", "is_paid", "end_date", "created_at", "start_date", "updated_at", "requested_at", "half_end_date", "half_start_date", "entitlement_unit", "time_off_type_id" ], "title": "TimeOffsTimeOffIdPatchResponsesContentApplicationJsonSchemaTimeOff", "type": "object" }, "TimeOffsTimeOffIdPatchResponsesContentApplicationJsonSchemaTimeOffAttachmentsItems": { "description": "An attachment associated with the time off request.", "properties": { "created_at": { "description": "This is the date when the attachment was created in the database.", "format": "date-time", "type": "string" }, "filename": { "description": "Filename of the attachment", "type": "string" }, "id": { "description": "Attachment id", "format": "uuid", "type": "string" }, "updated_at": { "description": "This is the date when the attachment was last updated in the database.", "format": "date-time", "type": "string" } }, "required": [ "id", "filename", "created_at", "updated_at" ], "title": "TimeOffsTimeOffIdPatchResponsesContentApplicationJsonSchemaTimeOffAttachmentsItems", "type": "object" }, "TimeOffsTimeOffIdPatchResponsesContentApplicationJsonSchemaTimeOffCustomFieldValuesItems": { "properties": { "field_id": { "description": "The id of the custom field this value answers.", "format": "uuid", "type": "string" }, "value": { "description": "The submitted value for the custom field, serialized as text. When no value is provided, this will be null.", "type": [ "string", "null" ] } }, "required": [ "value", "field_id" ], "title": "TimeOffsTimeOffIdPatchResponsesContentApplicationJsonSchemaTimeOffCustomFieldValuesItems", "type": "object" }, "TimeOffsTimeOffIdPatchResponsesContentApplicationJsonSchemaTimeOffEntitlementUnit": { "description": "The unit in which the time off usage and entitlement are calculated.", "enum": [ "HOUR", "BUSINESS_DAY", "CALENDAR_DAY", "WEEK", "MONTH", "YEAR" ], "title": "TimeOffsTimeOffIdPatchResponsesContentApplicationJsonSchemaTimeOffEntitlementUnit", "type": "string" }, "TimeOffsTimeOffIdPatchResponsesContentApplicationJsonSchemaTimeOffRecipientProfile": { "description": "The time off profile of the recipient of the time off request. Must be a worker profile.", "properties": { "hris_profile_id": { "description": "The worker HRIS profile id in the given organization.", "format": "uuid", "type": "string" }, "organization_id": { "description": "Id of the organization the profile belongs to.", "format": "uuid", "type": "string" } }, "required": [ "hris_profile_id", "organization_id" ], "title": "TimeOffsTimeOffIdPatchResponsesContentApplicationJsonSchemaTimeOffRecipientProfile", "type": "object" }, "TimeOffsTimeOffIdPatchResponsesContentApplicationJsonSchemaTimeOffRequesterProfile": { "description": "The time off profile of the requester of the time off request. Can be either a client or worker profile.", "properties": { "client_profile_id": { "description": "Id of the client profile. Available when the requester is a client.", "format": "uuid", "type": "string" }, "hris_profile_id": { "description": "The worker HRIS profile id in the given organization. Available when the requester is a worker.", "format": "uuid", "type": "string" }, "organization_id": { "description": "Id of the organization the profile belongs to.", "format": "uuid", "type": "string" } }, "required": [ "organization_id" ], "title": "TimeOffsTimeOffIdPatchResponsesContentApplicationJsonSchemaTimeOffRequesterProfile", "type": "object" }, "TimeOffsTimeOffIdPatchResponsesContentApplicationJsonSchemaTimeOffStatus": { "description": "Status of the time off request. Can be REQUESTED, APPROVED, REJECTED, USED or CANCELED.", "enum": [ "REQUESTED", "APPROVED", "REJECTED", "USED", "CANCELED", "DELETED" ], "title": "TimeOffsTimeOffIdPatchResponsesContentApplicationJsonSchemaTimeOffStatus", "type": "string" }, "TimeOffsTimeOffIdPatchResponsesContentApplicationJsonSchemaTimeOffTimeOffDailiesItems": { "properties": { "amount": { "description": "Amount of time off taken in this specific date.", "title": "float", "type": "string" }, "created_at": { "description": "This is the date when the time off daily was created in the database.", "format": "date-time", "type": "string" }, "date": { "description": "Date of the time off daily. This is the date when the time off was taken.", "format": "date", "type": "string" }, "description": { "description": "Description of the time off daily. When it is a HOLIDAY this is the holiday name.", "type": [ "string", "null" ] }, "id": { "description": "Time off daily id", "format": "uuid", "type": "string" }, "time_off_id": { "description": "Time off id. This is the id of the time off request associated with the time off daily.", "format": "uuid", "type": "string" }, "type": { "$ref": "#/components/schemas/TimeOffsTimeOffIdPatchResponsesContentApplicationJsonSchemaTimeOffTimeOffDailiesItemsType", "description": "Type of the time off daily. Can be WORKING_DAY, NON_WORKING_DAY, HOLIDAY or FORFAIT_HOUR_DAY." }, "updated_at": { "description": "This is the date when the time off daily was last updated in the database.", "format": "date-time", "type": "string" } }, "required": [ "id", "date", "type", "amount", "created_at", "updated_at", "time_off_id" ], "title": "TimeOffsTimeOffIdPatchResponsesContentApplicationJsonSchemaTimeOffTimeOffDailiesItems", "type": "object" }, "TimeOffsTimeOffIdPatchResponsesContentApplicationJsonSchemaTimeOffTimeOffDailiesItemsType": { "description": "Type of the time off daily. Can be WORKING_DAY, NON_WORKING_DAY, HOLIDAY or FORFAIT_HOUR_DAY.", "enum": [ "WORKING_DAY", "NON_WORKING_DAY", "HOLIDAY", "FORFAIT_HOUR_DAY" ], "title": "TimeOffsTimeOffIdPatchResponsesContentApplicationJsonSchemaTimeOffTimeOffDailiesItemsType", "type": "string" }, "TimeOffsTimeOffIdPatchResponsesContentApplicationJsonSchemaTimeOffTimeOffEvent": { "properties": { "created_at": { "description": "The date when the time off event was created in the database.", "format": "date-time", "type": "string" }, "event_details": { "$ref": "#/components/schemas/TimeOffsTimeOffIdPatchResponsesContentApplicationJsonSchemaTimeOffTimeOffEventEventDetails", "description": "Details of the event associated with the time off request. Required for event based policies such as parental leave." }, "hris_profile_id": { "description": "The HRIS profile id of the worker associated with the time off event. Same as the hris_profile_id in the recipient_profile.", "format": "uuid", "type": "string" }, "id": { "description": "The time off event id. This is used to link the time off request to an event.", "format": "uuid", "type": "string" }, "policy_id": { "description": "The policy id associated with the time off event. Same as the policy_id in the time off type.", "format": "uuid", "type": "string" }, "time_off_type_id": { "description": "The time off type id associated with the time off event. Same as the time_off_type_id in the time off request.", "format": "uuid", "type": "string" }, "type": { "$ref": "#/components/schemas/TimeOffsTimeOffIdPatchResponsesContentApplicationJsonSchemaTimeOffTimeOffEventType", "description": "The type of the time off event." }, "updated_at": { "description": "The date when the time off event was last updated in the database.", "format": "date-time", "type": "string" } }, "title": "TimeOffsTimeOffIdPatchResponsesContentApplicationJsonSchemaTimeOffTimeOffEvent", "type": "object" }, "TimeOffsTimeOffIdPatchResponsesContentApplicationJsonSchemaTimeOffTimeOffEventEventDetails": { "description": "Details of the event associated with the time off request. Required for event based policies such as parental leave.", "properties": { "adoption_date": { "description": "The date of adoption. This is used for parental leave requests.", "format": "date", "type": "string" }, "birth_date": { "description": "The birth date of the child. This is used for parental leave requests.", "format": "date", "type": "string" }, "estimated_adoption_date": { "description": "The estimated adoption date of the child. Birth is estimated when the adoption date has not been confirmed yet.", "format": "date", "type": "string" }, "estimated_birth_date": { "description": "The estimated birth date of the child. Birth is estimated when the birth date has not been confirmed yet.", "format": "date", "type": "string" }, "had_multiple_children": { "description": "Whether the birth was multiple or not. This is used for parental leave requests.", "type": "boolean" }, "was_premature_birth": { "description": "Whether the birth was premature or not. This is used for parental leave requests.", "type": "boolean" } }, "required": [ "was_premature_birth", "had_multiple_children" ], "title": "TimeOffsTimeOffIdPatchResponsesContentApplicationJsonSchemaTimeOffTimeOffEventEventDetails", "type": "object" }, "TimeOffsTimeOffIdPatchResponsesContentApplicationJsonSchemaTimeOffTimeOffEventType": { "description": "The type of the time off event.", "enum": [ "PARENTAL_LEAVE" ], "title": "TimeOffsTimeOffIdPatchResponsesContentApplicationJsonSchemaTimeOffTimeOffEventType", "type": "string" }, "TimeOffsTimeOffIdPatchResponsesContentApplicationJsonSchemaTimeOffTimeOffType": { "description": "The type of time off taken.", "properties": { "id": { "description": "Time off type id.", "format": "uuid", "type": "string" }, "name": { "description": "Time off type name. Basically the reason or category of time-off taken. For SICK leave, it can be doctor appointment, surgery etc.", "type": "string" }, "policy": { "$ref": "#/components/schemas/TimeOffsTimeOffIdPatchResponsesContentApplicationJsonSchemaTimeOffTimeOffTypePolicy", "description": "The policy associated with the time off type." } }, "required": [ "id", "name" ], "title": "TimeOffsTimeOffIdPatchResponsesContentApplicationJsonSchemaTimeOffTimeOffType", "type": "object" }, "TimeOffsTimeOffIdPatchResponsesContentApplicationJsonSchemaTimeOffTimeOffTypePolicy": { "description": "The policy associated with the time off type.", "properties": { "id": { "description": "Policy id", "format": "uuid", "type": "string" }, "name": { "description": "The custom name given to policy during policy creation.", "type": "string" }, "policy_type": { "$ref": "#/components/schemas/TimeOffsTimeOffIdPatchResponsesContentApplicationJsonSchemaTimeOffTimeOffTypePolicyPolicyType" } }, "required": [ "id", "name", "policy_type" ], "title": "TimeOffsTimeOffIdPatchResponsesContentApplicationJsonSchemaTimeOffTimeOffTypePolicy", "type": "object" }, "TimeOffsTimeOffIdPatchResponsesContentApplicationJsonSchemaTimeOffTimeOffTypePolicyPolicyType": { "properties": { "id": { "description": "Policy type id", "format": "uuid", "type": "string" }, "name": { "description": "Depicts the type of policy, like VACATION, SICK etc", "type": "string" } }, "required": [ "id", "name" ], "title": "TimeOffsTimeOffIdPatchResponsesContentApplicationJsonSchemaTimeOffTimeOffTypePolicyPolicyType", "type": "object" }, "TimeOffsValidatePostRequestBodyContentApplicationJsonSchemaData": { "description": "Time off request data", "properties": { "custom_field_values": { "description": "Answers to the custom fields the request policy declares, addressed by custom field id.", "items": { "$ref": "#/components/schemas/TimeOffsValidatePostRequestBodyContentApplicationJsonSchemaDataCustomFieldValuesItems" }, "type": [ "array", "null" ] }, "dates": { "description": "The dates breakdown for the time off request.", "items": { "$ref": "#/components/schemas/TimeOffsValidatePostRequestBodyContentApplicationJsonSchemaDataDatesItems" }, "type": "array" }, "deduction_amount": { "description": "The amount to be deducted from the time off balance. Only valid for policies used by independent contractors", "title": "float", "type": "string" }, "description": { "description": "The description of the time off request", "maxLength": 500, "type": [ "string", "null" ] }, "end_date": { "description": "The end date of the time off request.", "format": "date", "type": "string" }, "event_details": { "$ref": "#/components/schemas/TimeOffsValidatePostRequestBodyContentApplicationJsonSchemaDataEventDetails", "description": "Event details regarding the leave. Required for event based policies such as parental leave." }, "id": { "description": "The time off id. Required when validating a time off update request", "type": "string" }, "is_paid": { "description": "Indicates if the time off request is paid or not. By default it follows the policy configuration.", "type": "boolean" }, "policy_id": { "description": "The time off policy id. Can be used in place of time_off_type_id", "type": "string" }, "recipient_profile_id": { "description": "The hris profile id of the recipient", "type": "string" }, "start_date": { "description": "The start date of the time off request.", "format": "date", "type": "string" }, "time_off_event_id": { "description": "The time off event id that this request is associated with. Only present for event-based policies such as parental leave.", "type": "string" }, "time_off_percentage": { "description": "The percentage of time off requested. For example, if the request is for a full day, the percentage will be 1. If it's for half a day, the percentage will be 0.5.", "title": "float", "type": [ "string", "null" ] }, "time_off_type_id": { "description": "The time off type id. Required when policy_id is not provided", "type": "string" } }, "required": [ "end_date", "start_date", "recipient_profile_id" ], "title": "TimeOffsValidatePostRequestBodyContentApplicationJsonSchemaData", "type": "object" }, "TimeOffsValidatePostRequestBodyContentApplicationJsonSchemaDataCustomFieldValuesItems": { "properties": { "field_id": { "description": "The id of the custom field this value answers.", "format": "uuid", "type": "string" }, "value": { "description": "The submitted value for the custom field. Accepts a string, number, or boolean — always stored as text. `null` means \"no answer for this field\" and is rejected today, since no field supports a null answer yet.", "oneOf": [ { "$ref": "#/components/schemas/TimeOffsValidatePostRequestBodyContentApplicationJsonSchemaDataCustomFieldValuesItemsValue" }, { "type": "null" } ] } }, "required": [ "value", "field_id" ], "title": "TimeOffsValidatePostRequestBodyContentApplicationJsonSchemaDataCustomFieldValuesItems", "type": "object" }, "TimeOffsValidatePostRequestBodyContentApplicationJsonSchemaDataCustomFieldValuesItemsValue": { "description": "The submitted value for the custom field. Accepts a string, number, or boolean — always stored as text. `null` means \"no answer for this field\" and is rejected today, since no field supports a null answer yet.", "oneOf": [ { "type": "string" }, { "format": "double", "type": "number" }, { "type": "boolean" } ], "title": "TimeOffsValidatePostRequestBodyContentApplicationJsonSchemaDataCustomFieldValuesItemsValue" }, "TimeOffsValidatePostRequestBodyContentApplicationJsonSchemaDataDatesItems": { "description": "The dates breakdown for the time off request.", "properties": { "amount": { "description": "The amount of time off requested for the date. It must be in the same time unit as in the total amount for the time off request.", "title": "float", "type": "string" }, "date": { "description": "An specific date in the time-off request", "format": "date", "type": "string" }, "day_type": { "$ref": "#/components/schemas/TimeOffsValidatePostRequestBodyContentApplicationJsonSchemaDataDatesItemsDayType", "description": "The type of day for the time off request. All dates must follow the same type." }, "hours": { "description": "The amount taken in hours during this specific date. It can not exceed the maximum allowed hours for the date.", "title": "float", "type": "string" } }, "required": [ "date" ], "title": "TimeOffsValidatePostRequestBodyContentApplicationJsonSchemaDataDatesItems", "type": "object" }, "TimeOffsValidatePostRequestBodyContentApplicationJsonSchemaDataDatesItemsDayType": { "description": "The type of day for the time off request. All dates must follow the same type.", "enum": [ "HALF_DAY", "FULL_DAY", "PERCENTAGE", "HOURLY" ], "title": "TimeOffsValidatePostRequestBodyContentApplicationJsonSchemaDataDatesItemsDayType", "type": "string" }, "TimeOffsValidatePostRequestBodyContentApplicationJsonSchemaDataEventDetails": { "description": "Event details regarding the leave. Required for event based policies such as parental leave.", "properties": { "adoption_date": { "description": "The adoption-date of the child. Required depending on the type of the leave requests.", "format": "date", "type": "string" }, "birth_date": { "description": "The birth-date of the child. Required for parental leave requests.", "format": "date", "type": "string" }, "had_multiple_children": { "description": "Indicates if the request is for multiple children. Required for parental leave requests.", "type": "boolean" }, "was_premature_birth": { "description": "Indicates if the child was born prematurely. Required for parental leave requests.", "type": "boolean" } }, "title": "TimeOffsValidatePostRequestBodyContentApplicationJsonSchemaDataEventDetails", "type": "object" }, "TimeOffsValidatePostResponsesContentApplicationJsonSchemaData": { "description": "Time off request validation result", "properties": { "amount": { "description": "The amount of time off requested.", "title": "float", "type": "string" }, "amount_next_tracking_period": { "description": "The amount of time off requested to be applicable in the next tracking period.", "title": "float", "type": "string" }, "country_specific_validation_results": { "description": "Results of country-specific validation rules", "items": { "$ref": "#/components/schemas/TimeOffsValidatePostResponsesContentApplicationJsonSchemaDataCountrySpecificValidationResultsItems" }, "type": "array" }, "country_specific_validation_results_next_tracking_period": { "description": "Results of country-specific validation rules", "items": { "$ref": "#/components/schemas/TimeOffsValidatePostResponsesContentApplicationJsonSchemaDataCountrySpecificValidationResultsNextTrackingPeriodItems" }, "type": "array" }, "custom_field_validation_results": { "description": "Every rejected custom field answer. Omitted when all answers are valid.", "items": { "$ref": "#/components/schemas/TimeOffsValidatePostResponsesContentApplicationJsonSchemaDataCustomFieldValidationResultsItems" }, "type": "array" }, "custom_fields": { "description": "The custom fields the request policy declares. Omitted when the policy declares none.", "items": { "$ref": "#/components/schemas/TimeOffsValidatePostResponsesContentApplicationJsonSchemaDataCustomFieldsItems" }, "type": "array" }, "dates": { "description": "The dates breakdown for the time off request.", "items": { "$ref": "#/components/schemas/TimeOffsValidatePostResponsesContentApplicationJsonSchemaDataDatesItems" }, "type": "array" }, "event_details_fields": { "$ref": "#/components/schemas/TimeOffsValidatePostResponsesContentApplicationJsonSchemaDataEventDetailsFields", "description": "Fields required for specific time off requests, such as parental leave." }, "is_event_based": { "description": "Indicates if the time off request is event-based, such as parental leave", "type": "boolean" }, "is_valid": { "description": "Indicates if the time off request is valid or not. When false, the response will contain an error message.", "type": "boolean" }, "max_time_off_percentage": { "description": "The maximum time off percentage allowed for the request", "title": "float", "type": "string" }, "new_end_date": { "description": "The new end date for the time off request. It could be different from the original end date depending on the policy configuration. For example, for forfait-jour policies", "format": "date", "type": "string" }, "new_start_date": { "description": "The new start date for the time off request. It could be different from the original start date depending on the policy configuration. For example, for forfait-jour policies", "format": "date", "type": "string" }, "remaining_balance": { "description": "The remaining policy balance for the tracking period", "title": "float", "type": "string" }, "remaining_balance_next_tracking_period": { "description": "The remaining policy balance for the next tracking period", "title": "float", "type": "string" }, "require_attachment": { "description": "Indicates if an attachment is required for the time off request", "type": "boolean" }, "require_description": { "description": "Indicates if a description is required for the time off request", "type": "boolean" }, "validation_error_message": { "description": "Error message when the time off request is invalid", "type": "string" } }, "required": [ "is_valid" ], "title": "TimeOffsValidatePostResponsesContentApplicationJsonSchemaData", "type": "object" }, "TimeOffsValidatePostResponsesContentApplicationJsonSchemaDataCountrySpecificValidationResultsItems": { "description": "Result of a specific country validation rule", "properties": { "data": { "$ref": "#/components/schemas/TimeOffsValidatePostResponsesContentApplicationJsonSchemaDataCountrySpecificValidationResultsItemsData" }, "description": { "description": "A human-readable description of the validation result", "type": "string" }, "is_valid": { "description": "Indicates if this specific validation passed", "type": "boolean" }, "validation_type": { "description": "The type of validation rule being applied", "type": "string" } }, "required": [ "validation_type" ], "title": "TimeOffsValidatePostResponsesContentApplicationJsonSchemaDataCountrySpecificValidationResultsItems", "type": "object" }, "TimeOffsValidatePostResponsesContentApplicationJsonSchemaDataCountrySpecificValidationResultsItemsData": { "properties": { "max_requests": { "description": "Maximum number of requests allowed by this validation rule", "format": "double", "type": "number" }, "ranges": { "description": "Date ranges that were validated", "items": { "$ref": "#/components/schemas/TimeOffsValidatePostResponsesContentApplicationJsonSchemaDataCountrySpecificValidationResultsItemsDataRangesItems" }, "type": "array" }, "remaining_balance": { "description": "Remaining balance at the time of applying this rule", "format": "double", "type": "number" } }, "title": "TimeOffsValidatePostResponsesContentApplicationJsonSchemaDataCountrySpecificValidationResultsItemsData", "type": "object" }, "TimeOffsValidatePostResponsesContentApplicationJsonSchemaDataCountrySpecificValidationResultsItemsDataRangesItems": { "properties": { "end_day": { "description": "The end day in the range", "format": "double", "type": "number" }, "start_day": { "description": "The start day in the range", "format": "double", "type": "number" } }, "required": [ "start_day" ], "title": "TimeOffsValidatePostResponsesContentApplicationJsonSchemaDataCountrySpecificValidationResultsItemsDataRangesItems", "type": "object" }, "TimeOffsValidatePostResponsesContentApplicationJsonSchemaDataCountrySpecificValidationResultsNextTrackingPeriodItems": { "description": "Result of a specific country validation rule", "properties": { "data": { "$ref": "#/components/schemas/TimeOffsValidatePostResponsesContentApplicationJsonSchemaDataCountrySpecificValidationResultsNextTrackingPeriodItemsData" }, "description": { "description": "A human-readable description of the validation result", "type": "string" }, "is_valid": { "description": "Indicates if this specific validation passed", "type": "boolean" }, "validation_type": { "description": "The type of validation rule being applied", "type": "string" } }, "required": [ "validation_type" ], "title": "TimeOffsValidatePostResponsesContentApplicationJsonSchemaDataCountrySpecificValidationResultsNextTrackingPeriodItems", "type": "object" }, "TimeOffsValidatePostResponsesContentApplicationJsonSchemaDataCountrySpecificValidationResultsNextTrackingPeriodItemsData": { "properties": { "max_requests": { "description": "Maximum number of requests allowed by this validation rule", "format": "double", "type": "number" }, "ranges": { "description": "Date ranges that were validated", "items": { "$ref": "#/components/schemas/TimeOffsValidatePostResponsesContentApplicationJsonSchemaDataCountrySpecificValidationResultsNextTrackingPeriodItemsDataRangesItems" }, "type": "array" }, "remaining_balance": { "description": "Remaining balance at the time of applying this rule", "format": "double", "type": "number" } }, "title": "TimeOffsValidatePostResponsesContentApplicationJsonSchemaDataCountrySpecificValidationResultsNextTrackingPeriodItemsData", "type": "object" }, "TimeOffsValidatePostResponsesContentApplicationJsonSchemaDataCountrySpecificValidationResultsNextTrackingPeriodItemsDataRangesItems": { "properties": { "end_day": { "description": "The end day in the range", "format": "double", "type": "number" }, "start_day": { "description": "The start day in the range", "format": "double", "type": "number" } }, "required": [ "start_day" ], "title": "TimeOffsValidatePostResponsesContentApplicationJsonSchemaDataCountrySpecificValidationResultsNextTrackingPeriodItemsDataRangesItems", "type": "object" }, "TimeOffsValidatePostResponsesContentApplicationJsonSchemaDataCustomFieldValidationResultsItems": { "properties": { "field_id": { "description": "The id of the rejected custom field. Absent for payload-level errors.", "format": "uuid", "type": "string" }, "key": { "description": "Machine key of the rejected field, when it resolved.", "type": "string" }, "message": { "description": "Human-readable description of the rejection.", "type": "string" }, "reason": { "description": "Why the answer was rejected.", "type": "string" } }, "required": [ "reason", "message" ], "title": "TimeOffsValidatePostResponsesContentApplicationJsonSchemaDataCustomFieldValidationResultsItems", "type": "object" }, "TimeOffsValidatePostResponsesContentApplicationJsonSchemaDataCustomFieldsItems": { "properties": { "field_requirement": { "$ref": "#/components/schemas/TimeOffsValidatePostResponsesContentApplicationJsonSchemaDataCustomFieldsItemsFieldRequirement", "description": "Whether an answer is mandatory, and under which conditions." }, "id": { "description": "The custom field id.", "format": "uuid", "type": "string" }, "key": { "description": "Machine key, unique within the policy.", "type": "string" }, "name": { "description": "Human-facing field name shown on the request form.", "type": "string" }, "requirement_conditions": { "description": "Present only for a REQUIRED_CONDITIONALLY field: the conditions under which it becomes required.", "items": { "$ref": "#/components/schemas/TimeOffsValidatePostResponsesContentApplicationJsonSchemaDataCustomFieldsItemsRequirementConditionsItems" }, "type": [ "array", "null" ] }, "schema": { "$ref": "#/components/schemas/TimeOffsValidatePostResponsesContentApplicationJsonSchemaDataCustomFieldsItemsSchema", "description": "The value type plus shape/constraints of the field." } }, "required": [ "id", "key", "name", "schema", "field_requirement" ], "title": "TimeOffsValidatePostResponsesContentApplicationJsonSchemaDataCustomFieldsItems", "type": "object" }, "TimeOffsValidatePostResponsesContentApplicationJsonSchemaDataCustomFieldsItemsFieldRequirement": { "description": "Whether an answer is mandatory, and under which conditions.", "enum": [ "ALWAYS_REQUIRED", "REQUIRED_CONDITIONALLY", "OPTIONAL" ], "title": "TimeOffsValidatePostResponsesContentApplicationJsonSchemaDataCustomFieldsItemsFieldRequirement", "type": "string" }, "TimeOffsValidatePostResponsesContentApplicationJsonSchemaDataCustomFieldsItemsRequirementConditionsItems": { "properties": { "left_field_key": { "description": "Machine key of the field whose answer is being compared.", "type": "string" }, "operator": { "$ref": "#/components/schemas/TimeOffsValidatePostResponsesContentApplicationJsonSchemaDataCustomFieldsItemsRequirementConditionsItemsOperator", "description": "How the left field's answer is compared against the right side." }, "right_field_key": { "description": "Machine key of another field to compare against, when the right side is itself an answer rather than a static value.", "type": "string" }, "static_items": { "description": "Literal list to compare against, for IS_ANY_OF.", "items": { "type": "string" }, "type": [ "array", "null" ] }, "static_value": { "description": "Literal value to compare against, for a single-value operator (IS, IS_NOT, IS_AT_LEAST, IS_AT_MOST, IS_LESS_THAN, IS_MORE_THAN).", "type": [ "string", "null" ] } }, "required": [ "operator" ], "title": "TimeOffsValidatePostResponsesContentApplicationJsonSchemaDataCustomFieldsItemsRequirementConditionsItems", "type": "object" }, "TimeOffsValidatePostResponsesContentApplicationJsonSchemaDataCustomFieldsItemsRequirementConditionsItemsOperator": { "description": "How the left field's answer is compared against the right side.", "enum": [ "IS", "IS_NOT", "IS_ANY_OF", "IS_AT_LEAST", "IS_AT_MOST", "IS_LESS_THAN", "IS_MORE_THAN" ], "title": "TimeOffsValidatePostResponsesContentApplicationJsonSchemaDataCustomFieldsItemsRequirementConditionsItemsOperator", "type": "string" }, "TimeOffsValidatePostResponsesContentApplicationJsonSchemaDataCustomFieldsItemsSchema": { "description": "The value type plus shape/constraints of the field.", "properties": { "enum": { "description": "Allowed values, when the field is a closed list.", "items": { "type": "string" }, "type": "array" }, "is_nullable": { "description": "Whether the field accepts a null answer. Always `false` today — nullable custom fields are not supported yet, but the flag is present from the start so support can be added later without a breaking change.", "type": "boolean" }, "type": { "$ref": "#/components/schemas/TimeOffsValidatePostResponsesContentApplicationJsonSchemaDataCustomFieldsItemsSchemaType", "description": "The value type of the field." } }, "required": [ "type", "is_nullable" ], "title": "TimeOffsValidatePostResponsesContentApplicationJsonSchemaDataCustomFieldsItemsSchema", "type": "object" }, "TimeOffsValidatePostResponsesContentApplicationJsonSchemaDataCustomFieldsItemsSchemaType": { "description": "The value type of the field.", "enum": [ "string", "number", "boolean", "date", "datetime" ], "title": "TimeOffsValidatePostResponsesContentApplicationJsonSchemaDataCustomFieldsItemsSchemaType", "type": "string" }, "TimeOffsValidatePostResponsesContentApplicationJsonSchemaDataDatesItems": { "properties": { "amount": { "description": "The amount of time off requested for the date. It uses the same time unit as in the total amount for the time off request.", "title": "float", "type": "string" }, "date": { "description": "An specific date in the time-off request", "format": "date", "type": "string" }, "day_types": { "description": "The types of leave available for the date. Either FULL_DAY or HALF_DAY.", "items": { "$ref": "#/components/schemas/TimeOffsValidatePostResponsesContentApplicationJsonSchemaDataDatesItemsDayTypesItems" }, "type": "array" }, "holiday_name": { "description": "The name of the holiday for the date. Only applicable for holidays. Only present when date type is HOLIDAY.", "type": "string" }, "hours": { "description": "The maximum allowed number of hours that can be take in this specific date. For example, if there is another leave taking 3 hours in the same date, the maximum allowed hours will be 5 (assuming a work schedule of 8 hours).", "items": { "title": "float", "type": "string" }, "type": "array" }, "time_off_percentage": { "description": "The percentage of time off requested for the date. For example, if the request is for a full day, the percentage will be 1. If it's for half a day, the percentage will be 0.5.", "title": "float", "type": "string" }, "type": { "$ref": "#/components/schemas/TimeOffsValidatePostResponsesContentApplicationJsonSchemaDataDatesItemsType", "description": "The type of day for the time off request. All dates must follow the same type." } }, "required": [ "date", "type" ], "title": "TimeOffsValidatePostResponsesContentApplicationJsonSchemaDataDatesItems", "type": "object" }, "TimeOffsValidatePostResponsesContentApplicationJsonSchemaDataDatesItemsDayTypesItems": { "description": "The type of leave for the day.", "enum": [ "FULL_DAY", "HALF_DAY", "PERCENTAGE", "HOURLY" ], "title": "TimeOffsValidatePostResponsesContentApplicationJsonSchemaDataDatesItemsDayTypesItems", "type": "string" }, "TimeOffsValidatePostResponsesContentApplicationJsonSchemaDataDatesItemsType": { "description": "The type of day for the time off request. All dates must follow the same type.", "enum": [ "WORKING_DAY", "NON_WORKING_DAY", "HOLIDAY", "FORFAIT_HOUR_DAY" ], "title": "TimeOffsValidatePostResponsesContentApplicationJsonSchemaDataDatesItemsType", "type": "string" }, "TimeOffsValidatePostResponsesContentApplicationJsonSchemaDataEventDetailsFields": { "description": "Fields required for specific time off requests, such as parental leave.", "properties": { "adoption_date": { "$ref": "#/components/schemas/TimeOffsValidatePostResponsesContentApplicationJsonSchemaDataEventDetailsFieldsAdoptionDate", "description": "The adoption-date of the child. Might be required depending on the type if leave requests." }, "birth_date": { "$ref": "#/components/schemas/TimeOffsValidatePostResponsesContentApplicationJsonSchemaDataEventDetailsFieldsBirthDate", "description": "The birth-date of the child. Required for parental leave requests." }, "had_multiple_children": { "$ref": "#/components/schemas/TimeOffsValidatePostResponsesContentApplicationJsonSchemaDataEventDetailsFieldsHadMultipleChildren", "description": "Indicates if the request is for multiple children. Required for parental leave requests." }, "was_premature_birth": { "$ref": "#/components/schemas/TimeOffsValidatePostResponsesContentApplicationJsonSchemaDataEventDetailsFieldsWasPrematureBirth", "description": "Indicates if the child was born prematurely. Required for parental leave requests." } }, "title": "TimeOffsValidatePostResponsesContentApplicationJsonSchemaDataEventDetailsFields", "type": "object" }, "TimeOffsValidatePostResponsesContentApplicationJsonSchemaDataEventDetailsFieldsAdoptionDate": { "description": "The adoption-date of the child. Might be required depending on the type if leave requests.", "properties": { "required": { "description": "Indicates if the field is required", "type": "boolean" }, "type": { "$ref": "#/components/schemas/TimeOffsValidatePostResponsesContentApplicationJsonSchemaDataEventDetailsFieldsAdoptionDateType", "description": "The type of the field, indicating it is a date-only field" } }, "required": [ "type", "required" ], "title": "TimeOffsValidatePostResponsesContentApplicationJsonSchemaDataEventDetailsFieldsAdoptionDate", "type": "object" }, "TimeOffsValidatePostResponsesContentApplicationJsonSchemaDataEventDetailsFieldsAdoptionDateType": { "description": "The type of the field, indicating it is a date-only field", "enum": [ "date-only" ], "title": "TimeOffsValidatePostResponsesContentApplicationJsonSchemaDataEventDetailsFieldsAdoptionDateType", "type": "string" }, "TimeOffsValidatePostResponsesContentApplicationJsonSchemaDataEventDetailsFieldsBirthDate": { "description": "The birth-date of the child. Required for parental leave requests.", "properties": { "required": { "description": "Indicates if the field is required", "type": "boolean" }, "type": { "$ref": "#/components/schemas/TimeOffsValidatePostResponsesContentApplicationJsonSchemaDataEventDetailsFieldsBirthDateType", "description": "The type of the field, indicating it is a date-only field" } }, "required": [ "type", "required" ], "title": "TimeOffsValidatePostResponsesContentApplicationJsonSchemaDataEventDetailsFieldsBirthDate", "type": "object" }, "TimeOffsValidatePostResponsesContentApplicationJsonSchemaDataEventDetailsFieldsBirthDateType": { "description": "The type of the field, indicating it is a date-only field", "enum": [ "date-only" ], "title": "TimeOffsValidatePostResponsesContentApplicationJsonSchemaDataEventDetailsFieldsBirthDateType", "type": "string" }, "TimeOffsValidatePostResponsesContentApplicationJsonSchemaDataEventDetailsFieldsHadMultipleChildren": { "description": "Indicates if the request is for multiple children. Required for parental leave requests.", "properties": { "required": { "description": "Indicates if the field is required", "type": "boolean" }, "type": { "$ref": "#/components/schemas/TimeOffsValidatePostResponsesContentApplicationJsonSchemaDataEventDetailsFieldsHadMultipleChildrenType", "description": "The type of the field, indicating it is a boolean field" } }, "required": [ "type", "required" ], "title": "TimeOffsValidatePostResponsesContentApplicationJsonSchemaDataEventDetailsFieldsHadMultipleChildren", "type": "object" }, "TimeOffsValidatePostResponsesContentApplicationJsonSchemaDataEventDetailsFieldsHadMultipleChildrenType": { "description": "The type of the field, indicating it is a boolean field", "enum": [ "boolean" ], "title": "TimeOffsValidatePostResponsesContentApplicationJsonSchemaDataEventDetailsFieldsHadMultipleChildrenType", "type": "string" }, "TimeOffsValidatePostResponsesContentApplicationJsonSchemaDataEventDetailsFieldsWasPrematureBirth": { "description": "Indicates if the child was born prematurely. Required for parental leave requests.", "properties": { "required": { "description": "Indicates if the field is required", "type": "boolean" }, "type": { "$ref": "#/components/schemas/TimeOffsValidatePostResponsesContentApplicationJsonSchemaDataEventDetailsFieldsWasPrematureBirthType", "description": "The type of the field, indicating it is a boolean field" } }, "required": [ "type", "required" ], "title": "TimeOffsValidatePostResponsesContentApplicationJsonSchemaDataEventDetailsFieldsWasPrematureBirth", "type": "object" }, "TimeOffsValidatePostResponsesContentApplicationJsonSchemaDataEventDetailsFieldsWasPrematureBirthType": { "description": "The type of the field, indicating it is a boolean field", "enum": [ "boolean" ], "title": "TimeOffsValidatePostResponsesContentApplicationJsonSchemaDataEventDetailsFieldsWasPrematureBirthType", "type": "string" }, "TimeOffsValidatePostResponsesContentApplicationJsonSchemaErrorsItems": { "properties": { "message": { "description": "A description of the returned error", "type": "string" }, "path": { "description": "The JSON path where input validation failed", "type": "string" } }, "title": "TimeOffsValidatePostResponsesContentApplicationJsonSchemaErrorsItems", "type": "object" }, "TimeOffsValidatePostResponsesContentApplicationJsonSchemaRequest": { "properties": { "api_req_id": { "description": "The request ID of the failed request", "type": "string" }, "code": { "description": "The code of the source handler which produced the returned error", "format": "double", "type": "number" }, "docs": { "description": "A link to the official documentation for the requested endpoint resource", "type": "string" }, "method": { "description": "The HTTP method of the failed request", "type": "string" }, "source": { "description": "The source handler which produced the returned error", "type": "string" }, "status": { "description": "The status code of the response", "format": "double", "type": "number" }, "url": { "description": "The relative URL of the failed request", "type": "string" } }, "title": "TimeOffsValidatePostResponsesContentApplicationJsonSchemaRequest", "type": "object" }, "TimeTrackingShiftRatesExternalIdGetResponsesContentApplicationJsonSchemaData": { "properties": { "created_at": { "description": "Date when the shift rate was created", "format": "date-time", "type": "string" }, "external_id": { "description": "ID specified by the client for uniquely identifying shift rate across organization", "type": "string" }, "name": { "description": "Name of the shift rate policy", "type": "string" }, "type": { "$ref": "#/components/schemas/TimeTrackingShiftRatesExternalIdGetResponsesContentApplicationJsonSchemaDataType", "description": "Type of the shift rate" }, "updated_at": { "description": "Date when the shift rate was last updated", "format": "date-time", "type": "string" }, "value": { "description": "The value of the shift rate (supports up to 2 decimal places)", "exclusiveMinimum": 0, "format": "double", "multipleOf": 0.01, "type": "number" } }, "required": [ "name", "created_at", "updated_at", "external_id" ], "title": "TimeTrackingShiftRatesExternalIdGetResponsesContentApplicationJsonSchemaData", "type": "object" }, "TimeTrackingShiftRatesExternalIdGetResponsesContentApplicationJsonSchemaDataType": { "description": "Type of the shift rate", "enum": [ "MULTIPLIER_PERCENTAGE", "PER_HOUR_FLAT_RATE", "PER_UNIT_FLAT_RATE" ], "title": "TimeTrackingShiftRatesExternalIdGetResponsesContentApplicationJsonSchemaDataType", "type": "string" }, "TimeTrackingShiftRatesExternalIdPatchRequestBodyContentApplicationJsonSchemaData": { "properties": { "name": { "description": "The updated name of the shift rate.", "maxLength": 3000, "minLength": 1, "type": "string" }, "type": { "$ref": "#/components/schemas/TimeTrackingShiftRatesExternalIdPatchRequestBodyContentApplicationJsonSchemaDataType", "description": "The updated type of shift rate." }, "value": { "description": "The updated value of the shift rate.", "exclusiveMinimum": 0, "format": "double", "multipleOf": 0.01, "type": "number" } }, "title": "TimeTrackingShiftRatesExternalIdPatchRequestBodyContentApplicationJsonSchemaData", "type": "object" }, "TimeTrackingShiftRatesExternalIdPatchRequestBodyContentApplicationJsonSchemaDataType": { "description": "The updated type of shift rate.", "enum": [ "MULTIPLIER_PERCENTAGE", "PER_HOUR_FLAT_RATE", "PER_UNIT_FLAT_RATE" ], "title": "TimeTrackingShiftRatesExternalIdPatchRequestBodyContentApplicationJsonSchemaDataType", "type": "string" }, "TimeTrackingShiftRatesExternalIdPatchResponsesContentApplicationJsonSchemaData": { "properties": { "created_at": { "description": "Date when the shift rate was created", "format": "date-time", "type": "string" }, "external_id": { "description": "ID specified by the client for uniquely identifying shift rate across organization", "type": "string" }, "name": { "description": "Name of the shift rate policy", "type": "string" }, "type": { "$ref": "#/components/schemas/TimeTrackingShiftRatesExternalIdPatchResponsesContentApplicationJsonSchemaDataType", "description": "Type of the shift rate" }, "updated_at": { "description": "Date when the shift rate was last updated", "format": "date-time", "type": "string" }, "value": { "description": "The value of the shift rate (supports up to 2 decimal places)", "exclusiveMinimum": 0, "format": "double", "multipleOf": 0.01, "type": "number" } }, "required": [ "name", "created_at", "updated_at", "external_id" ], "title": "TimeTrackingShiftRatesExternalIdPatchResponsesContentApplicationJsonSchemaData", "type": "object" }, "TimeTrackingShiftRatesExternalIdPatchResponsesContentApplicationJsonSchemaDataType": { "description": "Type of the shift rate", "enum": [ "MULTIPLIER_PERCENTAGE", "PER_HOUR_FLAT_RATE", "PER_UNIT_FLAT_RATE" ], "title": "TimeTrackingShiftRatesExternalIdPatchResponsesContentApplicationJsonSchemaDataType", "type": "string" }, "TimeTrackingShiftRatesExternalIdPatchResponsesContentApplicationJsonSchemaError": { "properties": { "message": { "description": "Description of the error.", "type": "string" } }, "title": "TimeTrackingShiftRatesExternalIdPatchResponsesContentApplicationJsonSchemaError", "type": "object" }, "TimeTrackingShiftsExternalIdGetResponsesContentApplicationJsonSchemaData": { "properties": { "contract_id": { "description": "Associated contract ID for the shift", "type": "string" }, "created_at": { "description": "Date when the shift was created", "format": "date-time", "type": "string" }, "date_of_work": { "description": "Date when the shift takes place, in YYYY-MM-DD format", "type": "string" }, "description": { "description": "Description of the shift", "type": "string" }, "external_id": { "description": "ID specified by the client for uniquely identifying the shift", "type": "string" }, "meta": { "$ref": "#/components/schemas/TimeTrackingShiftsExternalIdGetResponsesContentApplicationJsonSchemaDataMeta" }, "payroll_cycle_ref": { "$ref": "#/components/schemas/TimeTrackingShiftsExternalIdGetResponsesContentApplicationJsonSchemaDataPayrollCycleRef", "description": "Payroll cycle reference" }, "shift_reference_id": { "description": "External ID of the original shift this one references (set on correction shifts).", "maxLength": 48, "minLength": 8, "type": "string" }, "shift_type": { "$ref": "#/components/schemas/TimeTrackingShiftsExternalIdGetResponsesContentApplicationJsonSchemaDataShiftType", "description": "Type of the shift" }, "summary": { "$ref": "#/components/schemas/TimeTrackingShiftsExternalIdGetResponsesContentApplicationJsonSchemaDataSummary" }, "updated_at": { "description": "Date when the shift was last updated", "format": "date-time", "type": "string" } }, "required": [ "created_at", "shift_type", "updated_at", "contract_id", "description", "external_id", "date_of_work" ], "title": "TimeTrackingShiftsExternalIdGetResponsesContentApplicationJsonSchemaData", "type": "object" }, "TimeTrackingShiftsExternalIdGetResponsesContentApplicationJsonSchemaDataMeta": { "properties": { "approval_date": { "description": "Approval date for the shift, in ISO format", "type": "string" }, "breaks": { "items": { "$ref": "#/components/schemas/TimeTrackingShiftsExternalIdGetResponsesContentApplicationJsonSchemaDataMetaBreaksItems" }, "type": "array" }, "end": { "$ref": "#/components/schemas/TimeTrackingShiftsExternalIdGetResponsesContentApplicationJsonSchemaDataMetaEnd" }, "start": { "$ref": "#/components/schemas/TimeTrackingShiftsExternalIdGetResponsesContentApplicationJsonSchemaDataMetaStart" } }, "required": [ "end", "start" ], "title": "TimeTrackingShiftsExternalIdGetResponsesContentApplicationJsonSchemaDataMeta", "type": "object" }, "TimeTrackingShiftsExternalIdGetResponsesContentApplicationJsonSchemaDataMetaBreaksItems": { "properties": { "end": { "$ref": "#/components/schemas/TimeTrackingShiftsExternalIdGetResponsesContentApplicationJsonSchemaDataMetaBreaksItemsEnd" }, "is_paid": { "description": "Indicates if the break is paid", "type": "boolean" }, "start": { "$ref": "#/components/schemas/TimeTrackingShiftsExternalIdGetResponsesContentApplicationJsonSchemaDataMetaBreaksItemsStart" } }, "required": [ "end", "start" ], "title": "TimeTrackingShiftsExternalIdGetResponsesContentApplicationJsonSchemaDataMetaBreaksItems", "type": "object" }, "TimeTrackingShiftsExternalIdGetResponsesContentApplicationJsonSchemaDataMetaBreaksItemsEnd": { "properties": { "date": { "description": "Break end date", "type": "string" }, "time": { "description": "Break end time in HH:mm format", "type": "string" } }, "required": [ "date", "time" ], "title": "TimeTrackingShiftsExternalIdGetResponsesContentApplicationJsonSchemaDataMetaBreaksItemsEnd", "type": "object" }, "TimeTrackingShiftsExternalIdGetResponsesContentApplicationJsonSchemaDataMetaBreaksItemsStart": { "properties": { "date": { "description": "Break start date", "type": "string" }, "time": { "description": "Break start time in HH:mm format", "type": "string" } }, "required": [ "date", "time" ], "title": "TimeTrackingShiftsExternalIdGetResponsesContentApplicationJsonSchemaDataMetaBreaksItemsStart", "type": "object" }, "TimeTrackingShiftsExternalIdGetResponsesContentApplicationJsonSchemaDataMetaEnd": { "properties": { "date": { "description": "Shift end date", "type": "string" }, "is_public_holiday": { "description": "Indicates if it is a public holiday", "type": "boolean" }, "is_rest_day": { "description": "Indicates if it is a rest day", "type": "boolean" }, "time": { "description": "Shift end time in HH:mm format", "type": "string" } }, "required": [ "date", "time", "is_rest_day", "is_public_holiday" ], "title": "TimeTrackingShiftsExternalIdGetResponsesContentApplicationJsonSchemaDataMetaEnd", "type": "object" }, "TimeTrackingShiftsExternalIdGetResponsesContentApplicationJsonSchemaDataMetaStart": { "properties": { "date": { "description": "Shift start date", "type": "string" }, "is_public_holiday": { "description": "Indicates if it is a public holiday", "type": "boolean" }, "is_rest_day": { "description": "Indicates if it is a rest day", "type": "boolean" }, "time": { "description": "Shift start time in HH:mm format", "type": "string" } }, "required": [ "date", "time", "is_rest_day", "is_public_holiday" ], "title": "TimeTrackingShiftsExternalIdGetResponsesContentApplicationJsonSchemaDataMetaStart", "type": "object" }, "TimeTrackingShiftsExternalIdGetResponsesContentApplicationJsonSchemaDataPayrollCycleRef": { "description": "Payroll cycle reference", "properties": { "date": { "description": "date in ISO", "format": "date-time", "type": "string" } }, "required": [ "date" ], "title": "TimeTrackingShiftsExternalIdGetResponsesContentApplicationJsonSchemaDataPayrollCycleRef", "type": "object" }, "TimeTrackingShiftsExternalIdGetResponsesContentApplicationJsonSchemaDataShiftType": { "description": "Type of the shift", "enum": [ "REGULAR", "CORRECTION_ABSOLUTE", "CORRECTION_DELTA", "TIME_OFF_QUALIFYING" ], "title": "TimeTrackingShiftsExternalIdGetResponsesContentApplicationJsonSchemaDataShiftType", "type": "string" }, "TimeTrackingShiftsExternalIdGetResponsesContentApplicationJsonSchemaDataSummary": { "properties": { "payable_break_hours": { "description": "Break hours that are payable", "format": "double", "type": "number" }, "shift_duration_hours": { "description": "Total duration of the shift in hours", "format": "double", "type": "number" }, "shift_rate_external_id": { "description": "External ID of the shift rate associated with this shift", "type": "string" }, "time_amount": { "description": "The amount of time for the shift", "exclusiveMinimum": 0, "format": "double", "type": "number" }, "time_unit": { "$ref": "#/components/schemas/TimeTrackingShiftsExternalIdGetResponsesContentApplicationJsonSchemaDataSummaryTimeUnit", "description": "The unit of time for the shift (DAY, HOUR, MONTH, WEEK)" }, "total_break_hours": { "description": "Total break duration in hours", "format": "double", "type": "number" }, "total_payable_hours": { "description": "Total payable working hours after break deductions", "format": "double", "type": "number" } }, "required": [ "shift_rate_external_id" ], "title": "TimeTrackingShiftsExternalIdGetResponsesContentApplicationJsonSchemaDataSummary", "type": "object" }, "TimeTrackingShiftsExternalIdGetResponsesContentApplicationJsonSchemaDataSummaryTimeUnit": { "description": "The unit of time for the shift (DAY, HOUR, MONTH, WEEK)", "enum": [ "DAY", "HOUR", "MONTH", "WEEK" ], "title": "TimeTrackingShiftsExternalIdGetResponsesContentApplicationJsonSchemaDataSummaryTimeUnit", "type": "string" }, "TimeTrackingShiftsExternalIdGetResponsesContentApplicationJsonSchemaError": { "properties": { "message": { "description": "Description of the error.", "type": "string" } }, "title": "TimeTrackingShiftsExternalIdGetResponsesContentApplicationJsonSchemaError", "type": "object" }, "TimeTrackingShiftsExternalIdPatchRequestBodyContentApplicationJsonSchemaData": { "properties": { "date_of_work": { "description": "The updated date of the shift, in YYYY-MM-DD format.", "pattern": "^\\d{4}-\\d{2}-\\d{2}$", "type": "string" }, "description": { "description": "The updated description of the shift.", "maxLength": 30000, "minLength": 1, "type": "string" }, "payroll_cycle_ref": { "$ref": "#/components/schemas/TimeTrackingShiftsExternalIdPatchRequestBodyContentApplicationJsonSchemaDataPayrollCycleRef", "description": "Payroll cycle reference" }, "summary": { "$ref": "#/components/schemas/TimeTrackingShiftsExternalIdPatchRequestBodyContentApplicationJsonSchemaDataSummary" } }, "title": "TimeTrackingShiftsExternalIdPatchRequestBodyContentApplicationJsonSchemaData", "type": "object" }, "TimeTrackingShiftsExternalIdPatchRequestBodyContentApplicationJsonSchemaDataPayrollCycleRef": { "description": "Payroll cycle reference", "properties": { "date": { "description": "date in ISO", "format": "date-time", "type": "string" } }, "required": [ "date" ], "title": "TimeTrackingShiftsExternalIdPatchRequestBodyContentApplicationJsonSchemaDataPayrollCycleRef", "type": "object" }, "TimeTrackingShiftsExternalIdPatchRequestBodyContentApplicationJsonSchemaDataSummary": { "properties": { "payable_break_hours": { "description": "Break hours that are payable. Part of the hours-based summary group (see `shift_duration_hours`).", "exclusiveMinimum": 0, "format": "double", "type": "number" }, "shift_duration_hours": { "description": "Total duration of the shift in hours. Part of the hours-based summary group, used when the shift rate is PER_HOUR_FLAT_RATE (or MULTIPLIER_PERCENTAGE/omitted, where either group is accepted). Mutually exclusive with `time_amount`/`time_unit` — do not send both groups.", "exclusiveMinimum": 0, "format": "double", "type": "number" }, "shift_rate_external_id": { "description": "External ID of the shift rate associated with this shift. Its type (PER_UNIT_FLAT_RATE, PER_HOUR_FLAT_RATE, or MULTIPLIER_PERCENTAGE) determines which of the two field groups below is required — see the group descriptions.", "maxLength": 48, "minLength": 8, "type": "string" }, "time_amount": { "description": "The amount of time for the shift. Part of the unit-amount summary group, required when the shift rate is PER_UNIT_FLAT_RATE (or MULTIPLIER_PERCENTAGE/omitted, where either group is accepted). Mutually exclusive with `shift_duration_hours`/`total_break_hours`/`payable_break_hours`/`total_payable_hours` — do not send both groups.", "exclusiveMinimum": 0, "format": "double", "type": "number" }, "total_break_hours": { "description": "Total break duration in hours. Part of the hours-based summary group (see `shift_duration_hours`).", "exclusiveMinimum": 0, "format": "double", "type": "number" }, "total_payable_hours": { "description": "Total payable working hours after break deductions. Part of the hours-based summary group (see `shift_duration_hours`).", "exclusiveMinimum": 0, "format": "double", "type": "number" } }, "title": "TimeTrackingShiftsExternalIdPatchRequestBodyContentApplicationJsonSchemaDataSummary", "type": "object" }, "TimeTrackingShiftsExternalIdPatchResponsesContentApplicationJsonSchemaData": { "properties": { "contract_id": { "description": "Associated contract ID for the shift", "type": "string" }, "created_at": { "description": "Date when the shift was created", "format": "date-time", "type": "string" }, "date_of_work": { "description": "Date when the shift takes place, in YYYY-MM-DD format", "type": "string" }, "description": { "description": "Description of the shift", "type": "string" }, "external_id": { "description": "ID specified by the client for uniquely identifying the shift", "type": "string" }, "meta": { "$ref": "#/components/schemas/TimeTrackingShiftsExternalIdPatchResponsesContentApplicationJsonSchemaDataMeta" }, "payroll_cycle_ref": { "$ref": "#/components/schemas/TimeTrackingShiftsExternalIdPatchResponsesContentApplicationJsonSchemaDataPayrollCycleRef", "description": "Payroll cycle reference" }, "shift_reference_id": { "description": "External ID of the original shift this one references (set on correction shifts).", "maxLength": 48, "minLength": 8, "type": "string" }, "shift_type": { "$ref": "#/components/schemas/TimeTrackingShiftsExternalIdPatchResponsesContentApplicationJsonSchemaDataShiftType", "description": "Type of the shift" }, "summary": { "$ref": "#/components/schemas/TimeTrackingShiftsExternalIdPatchResponsesContentApplicationJsonSchemaDataSummary" }, "updated_at": { "description": "Date when the shift was last updated", "format": "date-time", "type": "string" } }, "required": [ "created_at", "shift_type", "updated_at", "contract_id", "description", "external_id", "date_of_work" ], "title": "TimeTrackingShiftsExternalIdPatchResponsesContentApplicationJsonSchemaData", "type": "object" }, "TimeTrackingShiftsExternalIdPatchResponsesContentApplicationJsonSchemaDataMeta": { "properties": { "approval_date": { "description": "Approval date for the shift, in ISO format", "type": "string" }, "breaks": { "items": { "$ref": "#/components/schemas/TimeTrackingShiftsExternalIdPatchResponsesContentApplicationJsonSchemaDataMetaBreaksItems" }, "type": "array" }, "end": { "$ref": "#/components/schemas/TimeTrackingShiftsExternalIdPatchResponsesContentApplicationJsonSchemaDataMetaEnd" }, "start": { "$ref": "#/components/schemas/TimeTrackingShiftsExternalIdPatchResponsesContentApplicationJsonSchemaDataMetaStart" } }, "required": [ "end", "start" ], "title": "TimeTrackingShiftsExternalIdPatchResponsesContentApplicationJsonSchemaDataMeta", "type": "object" }, "TimeTrackingShiftsExternalIdPatchResponsesContentApplicationJsonSchemaDataMetaBreaksItems": { "properties": { "end": { "$ref": "#/components/schemas/TimeTrackingShiftsExternalIdPatchResponsesContentApplicationJsonSchemaDataMetaBreaksItemsEnd" }, "is_paid": { "description": "Indicates if the break is paid", "type": "boolean" }, "start": { "$ref": "#/components/schemas/TimeTrackingShiftsExternalIdPatchResponsesContentApplicationJsonSchemaDataMetaBreaksItemsStart" } }, "required": [ "end", "start" ], "title": "TimeTrackingShiftsExternalIdPatchResponsesContentApplicationJsonSchemaDataMetaBreaksItems", "type": "object" }, "TimeTrackingShiftsExternalIdPatchResponsesContentApplicationJsonSchemaDataMetaBreaksItemsEnd": { "properties": { "date": { "description": "Break end date", "type": "string" }, "time": { "description": "Break end time in HH:mm format", "type": "string" } }, "required": [ "date", "time" ], "title": "TimeTrackingShiftsExternalIdPatchResponsesContentApplicationJsonSchemaDataMetaBreaksItemsEnd", "type": "object" }, "TimeTrackingShiftsExternalIdPatchResponsesContentApplicationJsonSchemaDataMetaBreaksItemsStart": { "properties": { "date": { "description": "Break start date", "type": "string" }, "time": { "description": "Break start time in HH:mm format", "type": "string" } }, "required": [ "date", "time" ], "title": "TimeTrackingShiftsExternalIdPatchResponsesContentApplicationJsonSchemaDataMetaBreaksItemsStart", "type": "object" }, "TimeTrackingShiftsExternalIdPatchResponsesContentApplicationJsonSchemaDataMetaEnd": { "properties": { "date": { "description": "Shift end date", "type": "string" }, "is_public_holiday": { "description": "Indicates if it is a public holiday", "type": "boolean" }, "is_rest_day": { "description": "Indicates if it is a rest day", "type": "boolean" }, "time": { "description": "Shift end time in HH:mm format", "type": "string" } }, "required": [ "date", "time", "is_rest_day", "is_public_holiday" ], "title": "TimeTrackingShiftsExternalIdPatchResponsesContentApplicationJsonSchemaDataMetaEnd", "type": "object" }, "TimeTrackingShiftsExternalIdPatchResponsesContentApplicationJsonSchemaDataMetaStart": { "properties": { "date": { "description": "Shift start date", "type": "string" }, "is_public_holiday": { "description": "Indicates if it is a public holiday", "type": "boolean" }, "is_rest_day": { "description": "Indicates if it is a rest day", "type": "boolean" }, "time": { "description": "Shift start time in HH:mm format", "type": "string" } }, "required": [ "date", "time", "is_rest_day", "is_public_holiday" ], "title": "TimeTrackingShiftsExternalIdPatchResponsesContentApplicationJsonSchemaDataMetaStart", "type": "object" }, "TimeTrackingShiftsExternalIdPatchResponsesContentApplicationJsonSchemaDataPayrollCycleRef": { "description": "Payroll cycle reference", "properties": { "date": { "description": "date in ISO", "format": "date-time", "type": "string" } }, "required": [ "date" ], "title": "TimeTrackingShiftsExternalIdPatchResponsesContentApplicationJsonSchemaDataPayrollCycleRef", "type": "object" }, "TimeTrackingShiftsExternalIdPatchResponsesContentApplicationJsonSchemaDataShiftType": { "description": "Type of the shift", "enum": [ "REGULAR", "CORRECTION_ABSOLUTE", "CORRECTION_DELTA", "TIME_OFF_QUALIFYING" ], "title": "TimeTrackingShiftsExternalIdPatchResponsesContentApplicationJsonSchemaDataShiftType", "type": "string" }, "TimeTrackingShiftsExternalIdPatchResponsesContentApplicationJsonSchemaDataSummary": { "properties": { "payable_break_hours": { "description": "Break hours that are payable", "format": "double", "type": "number" }, "shift_duration_hours": { "description": "Total duration of the shift in hours", "format": "double", "type": "number" }, "shift_rate_external_id": { "description": "External ID of the shift rate associated with this shift", "type": "string" }, "time_amount": { "description": "The amount of time for the shift", "format": "double", "minimum": 0, "type": "number" }, "time_unit": { "$ref": "#/components/schemas/TimeTrackingShiftsExternalIdPatchResponsesContentApplicationJsonSchemaDataSummaryTimeUnit", "description": "The unit of time for the shift (DAY, HOUR, MONTH, WEEK)" }, "total_break_hours": { "description": "Total break duration in hours", "format": "double", "type": "number" }, "total_payable_hours": { "description": "Total payable working hours after break deductions", "format": "double", "type": "number" } }, "required": [ "shift_rate_external_id" ], "title": "TimeTrackingShiftsExternalIdPatchResponsesContentApplicationJsonSchemaDataSummary", "type": "object" }, "TimeTrackingShiftsExternalIdPatchResponsesContentApplicationJsonSchemaDataSummaryTimeUnit": { "description": "The unit of time for the shift (DAY, HOUR, MONTH, WEEK)", "enum": [ "DAY", "HOUR", "MONTH", "WEEK" ], "title": "TimeTrackingShiftsExternalIdPatchResponsesContentApplicationJsonSchemaDataSummaryTimeUnit", "type": "string" }, "TimeTrackingTimesheetsTimesheetIdGetResponsesContentApplicationJsonSchemaData": { "description": "Timesheet data including validation errors if applicable. When extend=file_data, also includes file_data object with file details and download URL.", "properties": { "contract_id": { "description": "External id of the worker's contract associated with the timesheet", "type": "string" }, "created_at": { "description": "Timestamp when the timesheet was created", "format": "date-time", "type": "string" }, "end_date": { "description": "End date of the timesheet period", "format": "date", "type": "string" }, "file_data": { "description": "Present only when `extend=file_data` is provided. Contains file details and download URL.", "oneOf": [ { "$ref": "#/components/schemas/TimeTrackingTimesheetsTimesheetIdGetResponsesContentApplicationJsonSchemaDataFileData" }, { "type": "null" } ] }, "id": { "description": "Unique identifier for the timesheet", "format": "uuid", "type": "string" }, "review_status": { "$ref": "#/components/schemas/TimeTrackingTimesheetsTimesheetIdGetResponsesContentApplicationJsonSchemaDataReviewStatus", "description": "Current status of the timesheet review" }, "start_date": { "description": "Start date of the timesheet period", "format": "date", "type": "string" }, "submission_status": { "$ref": "#/components/schemas/TimeTrackingTimesheetsTimesheetIdGetResponsesContentApplicationJsonSchemaDataSubmissionStatus", "description": "Current status of the timesheet submission" }, "updated_at": { "description": "Timestamp when the timesheet was last updated", "format": "date-time", "type": "string" }, "validation_errors": { "description": "Array of validation errors found during timesheet processing. Null if no errors found.", "items": { "$ref": "#/components/schemas/TimeTrackingTimesheetsTimesheetIdGetResponsesContentApplicationJsonSchemaDataValidationErrorsItems" }, "type": [ "array", "null" ] } }, "required": [ "id", "end_date", "created_at", "start_date", "updated_at", "contract_id", "review_status", "submission_status", "validation_errors" ], "title": "TimeTrackingTimesheetsTimesheetIdGetResponsesContentApplicationJsonSchemaData", "type": "object" }, "TimeTrackingTimesheetsTimesheetIdGetResponsesContentApplicationJsonSchemaDataFileData": { "description": "Present only when `extend=file_data` is provided. Contains file details and download URL.", "properties": { "download_url": { "description": "Pre-signed S3 URL for downloading the timesheet file", "format": "uri", "type": "string" }, "file_id": { "description": "Unique identifier for the timesheet file", "format": "uuid", "type": "string" }, "file_name": { "description": "Name of the timesheet file", "type": "string" } }, "required": [ "file_id", "file_name", "download_url" ], "title": "TimeTrackingTimesheetsTimesheetIdGetResponsesContentApplicationJsonSchemaDataFileData", "type": "object" }, "TimeTrackingTimesheetsTimesheetIdGetResponsesContentApplicationJsonSchemaDataReviewStatus": { "description": "Current status of the timesheet review", "enum": [ "PENDING_CREATION", "PENDING_REVIEW", "APPROVED", "REJECTED" ], "title": "TimeTrackingTimesheetsTimesheetIdGetResponsesContentApplicationJsonSchemaDataReviewStatus", "type": "string" }, "TimeTrackingTimesheetsTimesheetIdGetResponsesContentApplicationJsonSchemaDataSubmissionStatus": { "description": "Current status of the timesheet submission", "enum": [ "UPLOADING", "UPLOAD_FAILED", "PROCESSING", "SUBMITTED", "INVALID", "FAILED" ], "title": "TimeTrackingTimesheetsTimesheetIdGetResponsesContentApplicationJsonSchemaDataSubmissionStatus", "type": "string" }, "TimeTrackingTimesheetsTimesheetIdGetResponsesContentApplicationJsonSchemaDataValidationErrorsItems": { "properties": { "column": { "description": "Column name in the timesheet file where the error occurred", "type": [ "string", "null" ] }, "context": { "additionalProperties": { "description": "Any type" }, "description": "Additional context information about the error", "type": [ "object", "null" ] }, "message": { "description": "Human-readable error message", "type": "string" }, "row": { "description": "Row number in the timesheet file where the error occurred", "format": "double", "type": [ "number", "null" ] }, "type": { "$ref": "#/components/schemas/TimeTrackingTimesheetsTimesheetIdGetResponsesContentApplicationJsonSchemaDataValidationErrorsItemsType", "description": "Type of validation error" } }, "required": [ "type", "message" ], "title": "TimeTrackingTimesheetsTimesheetIdGetResponsesContentApplicationJsonSchemaDataValidationErrorsItems", "type": "object" }, "TimeTrackingTimesheetsTimesheetIdGetResponsesContentApplicationJsonSchemaDataValidationErrorsItemsType": { "description": "Type of validation error", "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" ], "title": "TimeTrackingTimesheetsTimesheetIdGetResponsesContentApplicationJsonSchemaDataValidationErrorsItemsType", "type": "string" }, "TimeTrackingTimesheetsTimesheetIdGetResponsesContentApplicationJsonSchemaErrorsItems": { "properties": { "code": { "description": "Machine-readable error code", "type": "string" }, "field": { "description": "Name of the field causing the error (for validation issues)", "type": "string" }, "message": { "description": "Human-readable explanation of the error", "type": "string" } }, "required": [ "code", "field", "message" ], "title": "TimeTrackingTimesheetsTimesheetIdGetResponsesContentApplicationJsonSchemaErrorsItems", "type": "object" }, "TimeTrackingTimesheetsTimesheetIdReviewPostRequestBodyContentApplicationJsonSchemaData": { "properties": { "review_reason": { "description": "Reason for rejecting the timesheet. Required when review_status is REJECTED, optional when APPROVED.", "maxLength": 30000, "minLength": 0, "type": [ "string", "null" ] }, "review_status": { "$ref": "#/components/schemas/TimeTrackingTimesheetsTimesheetIdReviewPostRequestBodyContentApplicationJsonSchemaDataReviewStatus", "description": "The review status for the timesheet. Must be APPROVED or REJECTED." } }, "required": [ "review_status" ], "title": "TimeTrackingTimesheetsTimesheetIdReviewPostRequestBodyContentApplicationJsonSchemaData", "type": "object" }, "TimeTrackingTimesheetsTimesheetIdReviewPostRequestBodyContentApplicationJsonSchemaDataReviewStatus": { "description": "The review status for the timesheet. Must be APPROVED or REJECTED.", "enum": [ "APPROVED", "REJECTED" ], "title": "TimeTrackingTimesheetsTimesheetIdReviewPostRequestBodyContentApplicationJsonSchemaDataReviewStatus", "type": "string" }, "TimeTrackingTimesheetsTimesheetIdReviewPostResponsesContentApplicationJsonSchemaData": { "description": "Updated timesheet details after review", "properties": { "id": { "description": "Unique identifier for the timesheet", "format": "uuid", "type": "string" }, "review_reason": { "description": "Reason provided by the reviewer when rejecting the timesheet. Only present when review_status is REJECTED.", "type": [ "string", "null" ] }, "review_status": { "$ref": "#/components/schemas/TimeTrackingTimesheetsTimesheetIdReviewPostResponsesContentApplicationJsonSchemaDataReviewStatus", "description": "Current status of the timesheet review" }, "reviewed_at": { "description": "Timestamp when the timesheet was reviewed", "format": "date-time", "type": "string" } }, "required": [ "id", "reviewed_at", "review_status" ], "title": "TimeTrackingTimesheetsTimesheetIdReviewPostResponsesContentApplicationJsonSchemaData", "type": "object" }, "TimeTrackingTimesheetsTimesheetIdReviewPostResponsesContentApplicationJsonSchemaDataReviewStatus": { "description": "Current status of the timesheet review", "enum": [ "PENDING_CREATION", "PENDING_REVIEW", "APPROVED", "REJECTED" ], "title": "TimeTrackingTimesheetsTimesheetIdReviewPostResponsesContentApplicationJsonSchemaDataReviewStatus", "type": "string" }, "TimeTrackingTimesheetsTimesheetIdReviewPostResponsesContentApplicationJsonSchemaErrorsItems": { "properties": { "code": { "description": "Machine-readable error code", "type": "string" }, "details": { "$ref": "#/components/schemas/TimeTrackingTimesheetsTimesheetIdReviewPostResponsesContentApplicationJsonSchemaErrorsItemsDetails", "description": "Additional details about the error, including the current timesheet state" }, "field": { "description": "Name of the field causing the error (for validation issues)", "type": [ "string", "null" ] }, "message": { "description": "Human-readable explanation of the error", "type": "string" } }, "required": [ "code", "details", "message" ], "title": "TimeTrackingTimesheetsTimesheetIdReviewPostResponsesContentApplicationJsonSchemaErrorsItems", "type": "object" }, "TimeTrackingTimesheetsTimesheetIdReviewPostResponsesContentApplicationJsonSchemaErrorsItemsDetails": { "description": "Additional details about the error, including the current timesheet state", "properties": { "timesheet": { "$ref": "#/components/schemas/TimeTrackingTimesheetsTimesheetIdReviewPostResponsesContentApplicationJsonSchemaErrorsItemsDetailsTimesheet", "description": "Current state of the timesheet that cannot be reviewed" } }, "required": [ "timesheet" ], "title": "TimeTrackingTimesheetsTimesheetIdReviewPostResponsesContentApplicationJsonSchemaErrorsItemsDetails", "type": "object" }, "TimeTrackingTimesheetsTimesheetIdReviewPostResponsesContentApplicationJsonSchemaErrorsItemsDetailsTimesheet": { "description": "Current state of the timesheet that cannot be reviewed", "properties": { "contract_id": { "description": "External id of the worker's contract associated with the timesheet", "type": "string" }, "id": { "description": "Unique identifier for the timesheet", "format": "uuid", "type": "string" }, "review_status": { "$ref": "#/components/schemas/TimeTrackingTimesheetsTimesheetIdReviewPostResponsesContentApplicationJsonSchemaErrorsItemsDetailsTimesheetReviewStatus", "description": "Current status of the timesheet review" }, "reviewed_at": { "description": "Timestamp when the timesheet was reviewed (if already reviewed)", "format": "date-time", "type": [ "string", "null" ] }, "submission_status": { "$ref": "#/components/schemas/TimeTrackingTimesheetsTimesheetIdReviewPostResponsesContentApplicationJsonSchemaErrorsItemsDetailsTimesheetSubmissionStatus", "description": "Current status of the timesheet submission" } }, "required": [ "id", "contract_id", "review_status", "submission_status" ], "title": "TimeTrackingTimesheetsTimesheetIdReviewPostResponsesContentApplicationJsonSchemaErrorsItemsDetailsTimesheet", "type": "object" }, "TimeTrackingTimesheetsTimesheetIdReviewPostResponsesContentApplicationJsonSchemaErrorsItemsDetailsTimesheetReviewStatus": { "description": "Current status of the timesheet review", "enum": [ "PENDING_CREATION", "PENDING_REVIEW", "APPROVED", "REJECTED" ], "title": "TimeTrackingTimesheetsTimesheetIdReviewPostResponsesContentApplicationJsonSchemaErrorsItemsDetailsTimesheetReviewStatus", "type": "string" }, "TimeTrackingTimesheetsTimesheetIdReviewPostResponsesContentApplicationJsonSchemaErrorsItemsDetailsTimesheetSubmissionStatus": { "description": "Current status of the timesheet submission", "enum": [ "UPLOADING", "UPLOAD_FAILED", "PROCESSING", "SUBMITTED", "INVALID", "FAILED" ], "title": "TimeTrackingTimesheetsTimesheetIdReviewPostResponsesContentApplicationJsonSchemaErrorsItemsDetailsTimesheetSubmissionStatus", "type": "string" }, "TimeTrackingTimesheetsUploadUrlPostRequestBodyContentApplicationJsonSchemaData": { "properties": { "contract_id": { "description": "Id of the worker's contract associated with the timesheet", "maxLength": 50, "minLength": 1, "type": "string" }, "end_date": { "description": "End date of the timesheet period. Must be equal to or later than start_date.", "format": "date", "type": "string" }, "file_name": { "description": "Name of the timesheet file. Must end with .csv extension.", "maxLength": 255, "minLength": 1, "pattern": "\\.csv$", "type": "string" }, "start_date": { "description": "Start date of the timesheet period. Must be equal to or earlier than end_date.", "format": "date", "type": "string" } }, "required": [ "end_date", "file_name", "start_date", "contract_id" ], "title": "TimeTrackingTimesheetsUploadUrlPostRequestBodyContentApplicationJsonSchemaData", "type": "object" }, "TimeTrackingTimesheetsUploadUrlPostResponsesContentApplicationJsonSchemaData": { "properties": { "created_at": { "description": "Timestamp when the timesheet was created", "format": "date-time", "type": "string" }, "id": { "description": "Unique identifier for the created timesheet", "format": "uuid", "type": "string" }, "updated_at": { "description": "Timestamp when the timesheet was last updated", "format": "date-time", "type": "string" }, "upload_fields": { "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.", "type": "object" }, "upload_url": { "description": "Pre-signed S3 URL for uploading the timesheet file", "format": "uri", "type": "string" } }, "required": [ "id", "created_at", "updated_at", "upload_url", "upload_fields" ], "title": "TimeTrackingTimesheetsUploadUrlPostResponsesContentApplicationJsonSchemaData", "type": "object" }, "TimeTrackingTimesheetsUploadUrlPostResponsesContentApplicationJsonSchemaErrorsItems": { "properties": { "code": { "description": "Machine-readable error code", "type": "string" }, "field": { "description": "Name of the field causing the error (for validation issues)", "type": "string" }, "message": { "description": "Human-readable explanation of the error", "type": "string" } }, "required": [ "code", "field", "message" ], "title": "TimeTrackingTimesheetsUploadUrlPostResponsesContentApplicationJsonSchemaErrorsItems", "type": "object" }, "Time_Off_getPoliciesForOrganization-v2026-09-09_Response_200": { "properties": { "data": { "items": { "$ref": "#/components/schemas/TimeOffsPolicyGetResponsesContentApplicationJsonSchemaDataItems" }, "type": "array" }, "has_next_page": { "description": "Indicates if there are more results available beyond the current page", "type": "boolean" }, "next": { "description": "Opaque cursor to fetch the next page of results. Null when there are no more results", "type": [ "string", "null" ] } }, "required": [ "data" ], "title": "Time Off_getPoliciesForOrganization-v2026-09-09_Response_200", "type": "object" }, "Time_Off_getProfilesAssignedToPolicy-v2026-09-09_Response_200": { "properties": { "data": { "description": "Profiles currently assigned to the policy", "items": { "$ref": "#/components/schemas/TimeOffsPolicyPolicyIdAssignmentsGetResponsesContentApplicationJsonSchemaDataItems" }, "type": "array" }, "has_next_page": { "description": "Indicates if there are more results available beyond the current page", "type": "boolean" }, "next": { "description": "Opaque cursor to fetch the next page of results. Null when there are no more results", "type": [ "string", "null" ] } }, "required": [ "data", "has_next_page" ], "title": "Time Off_getProfilesAssignedToPolicy-v2026-09-09_Response_200", "type": "object" }, "Time_Off_getTimeOffAttachmentDownloadUrl-v2026-07-31_Response_200": { "properties": { "data": { "$ref": "#/components/schemas/TimeOffsAttachmentsAttachmentIdDownloadGetResponsesContentApplicationJsonSchemaData" } }, "required": [ "data" ], "title": "Time Off_getTimeOffAttachmentDownloadUrl-v2026-07-31_Response_200", "type": "object" }, "Time_Off_listTimeOffRequestsForOrganization-v2026-01-01_Response_200": { "description": "Time offs associated to the query", "properties": { "count": { "description": "Total count of items", "type": "integer" }, "data": { "items": { "$ref": "#/components/schemas/TimeOffsGetResponsesContentApplicationJsonSchemaDataItems" }, "type": "array" }, "has_next_page": { "description": "Has next page", "type": "boolean" }, "next": { "type": "string" }, "page_size": { "description": "Page size", "maximum": 200, "minimum": 5, "type": "integer" } }, "required": [ "data", "page_size", "has_next_page" ], "title": "Time Off_listTimeOffRequestsForOrganization-v2026-01-01_Response_200", "type": "object" }, "Time_Tracking_Shifts_deleteMultipleShiftsByExternalId-v2026-01-01_Response_200": { "description": "Response body for bulk delete shifts", "properties": { "data": { "$ref": "#/components/schemas/V2TimeTrackingShiftsBulkDeletePostResponsesContentApplicationJsonSchemaData" } }, "required": [ "data" ], "title": "Time Tracking Shifts_deleteMultipleShiftsByExternalId-v2026-01-01_Response_200", "type": "object" }, "TimesheetsGetParametersContractTypesSchemaItems": { "description": "Type of a contract", "enum": [ "ongoing_time_based", "pay_as_you_go_time_based", "payg_milestones", "payg_tasks" ], "title": "TimesheetsGetParametersContractTypesSchemaItems", "type": "string" }, "TimesheetsGetParametersStatusesSchemaItems": { "description": "Current processing status of the timesheet.", "enum": [ "approved", "declined", "not_payable", "paid", "pending", "processing" ], "title": "TimesheetsGetParametersStatusesSchemaItems", "type": "string" }, "TimesheetsGetResponsesContentApplicationJsonSchemaDataItems": { "properties": { "attachment": { "description": "This object is used for linking file attachments to your records.", "oneOf": [ { "$ref": "#/components/schemas/TimesheetsGetResponsesContentApplicationJsonSchemaDataItemsAttachment" }, { "type": "null" } ] }, "contract": { "$ref": "#/components/schemas/TimesheetsGetResponsesContentApplicationJsonSchemaDataItemsContract" }, "created_at": { "description": "Timestamp when the timesheet was created (ISO-8601).", "format": "date-time", "type": "string" }, "currency_code": { "description": "ISO 4217 currency code used for the amount.", "maxLength": 3, "minLength": 3, "pattern": "^[A-Z]{3}$", "type": "string" }, "custom_scale": { "description": "Custom scale label defined by the client for non-standard billing rates.", "type": [ "string", "null" ] }, "date_submitted": { "description": "Timestamp when the timesheet was submitted for review (ISO-8601).", "format": "date-time", "type": "string" }, "description": { "description": "Human-readable description of the work performed.", "type": "string" }, "hourly_report_preset": { "description": "Timesheet preset linked to this entry, if any.", "oneOf": [ { "$ref": "#/components/schemas/TimesheetsGetResponsesContentApplicationJsonSchemaDataItemsHourlyReportPreset" }, { "type": "null" } ] }, "id": { "description": "Unique identifier of this resource.", "format": "uuid", "type": "string" }, "payment_cycle": { "$ref": "#/components/schemas/TimesheetsGetResponsesContentApplicationJsonSchemaDataItemsPaymentCycle", "description": "Payment cycle associated with this timesheet." }, "quantity": { "description": "Quantity of work units (hours, days, etc.) used to calculate the total amount.", "format": "double", "type": [ "number", "null" ] }, "reported_by": { "$ref": "#/components/schemas/TimesheetsGetResponsesContentApplicationJsonSchemaDataItemsReportedBy", "description": "User who submitted the timesheet." }, "reviewed_by": { "description": "Reviewer information if the timesheet has been reviewed.", "oneOf": [ { "$ref": "#/components/schemas/TimesheetsGetResponsesContentApplicationJsonSchemaDataItemsReviewedBy" }, { "type": "null" } ] }, "scale": { "description": "Predefined scale used to calculate the timesheet amount (e.g. hourly, daily, custom).", "type": [ "string", "null" ] }, "status": { "description": "Current processing status of the timesheet.", "oneOf": [ { "$ref": "#/components/schemas/TimesheetsGetResponsesContentApplicationJsonSchemaDataItemsStatus" }, { "type": "null" } ] }, "total_amount": { "description": "Total monetary value equal to quantity times rate of active work statement plus any bonus.", "type": "string" }, "type": { "description": "Deprecated - it is always \"work\"", "type": "string" }, "worksheet": { "description": "Breakdown of time worked across different units.", "oneOf": [ { "$ref": "#/components/schemas/TimesheetsGetResponsesContentApplicationJsonSchemaDataItemsWorksheet" }, { "type": "null" } ] } }, "required": [ "id", "type", "status", "contract", "quantity", "worksheet", "created_at", "description", "reported_by", "total_amount", "currency_code", "date_submitted" ], "title": "TimesheetsGetResponsesContentApplicationJsonSchemaDataItems", "type": "object" }, "TimesheetsGetResponsesContentApplicationJsonSchemaDataItemsAttachment": { "description": "This object is used for linking file attachments to your records.", "properties": { "filename": { "description": "Original filename you used to upload using attachments end-point.", "type": "string" }, "key": { "description": "You can call attachments end-point, get key and URL to upload your file.", "type": "string" } }, "required": [ "key", "filename" ], "title": "TimesheetsGetResponsesContentApplicationJsonSchemaDataItemsAttachment", "type": "object" }, "TimesheetsGetResponsesContentApplicationJsonSchemaDataItemsContract": { "properties": { "id": { "description": "Unique identifier of the contract.", "type": "string" }, "title": { "description": "Human-readable title of the contract.", "type": "string" }, "type": { "$ref": "#/components/schemas/TimesheetsGetResponsesContentApplicationJsonSchemaDataItemsContractType", "description": "Type of a contract" } }, "required": [ "id", "type", "title" ], "title": "TimesheetsGetResponsesContentApplicationJsonSchemaDataItemsContract", "type": "object" }, "TimesheetsGetResponsesContentApplicationJsonSchemaDataItemsContractType": { "description": "Type of a contract", "enum": [ "ongoing_time_based", "milestones", "time_based", "pay_as_you_go_time_based", "commission", "payg_milestones", "payg_tasks", "eor", "unknown", "employee", "global_payroll", "shield_msa", "hris_direct_employee", "peo" ], "title": "TimesheetsGetResponsesContentApplicationJsonSchemaDataItemsContractType", "type": "string" }, "TimesheetsGetResponsesContentApplicationJsonSchemaDataItemsHourlyReportPreset": { "description": "Timesheet preset linked to this entry, if any.", "properties": { "description": { "description": "Description of the related timesheet preset.", "type": [ "string", "null" ] }, "id": { "description": "Unique identifier of the related timesheet preset.", "type": [ "string", "null" ] }, "rate": { "description": "Hourly rate of the related timesheet preset.", "format": "double", "type": [ "number", "null" ] }, "title": { "description": "Title of the related timesheet preset.", "type": [ "string", "null" ] } }, "title": "TimesheetsGetResponsesContentApplicationJsonSchemaDataItemsHourlyReportPreset", "type": "object" }, "TimesheetsGetResponsesContentApplicationJsonSchemaDataItemsPaymentCycle": { "description": "Payment cycle associated with this timesheet.", "properties": { "end_date": { "description": "End date of the payment cycle (ISO-8601).", "format": "date-time", "type": "string" }, "start_date": { "description": "Start date of the payment cycle (ISO-8601).", "format": "date-time", "type": "string" } }, "title": "TimesheetsGetResponsesContentApplicationJsonSchemaDataItemsPaymentCycle", "type": "object" }, "TimesheetsGetResponsesContentApplicationJsonSchemaDataItemsReportedBy": { "description": "User who submitted the timesheet.", "properties": { "full_name": { "description": "Full name of the user who submitted the timesheet.", "type": "string" }, "id": { "description": "Unique identifier of the reporting user.", "format": "uuid", "type": "string" } }, "required": [ "id" ], "title": "TimesheetsGetResponsesContentApplicationJsonSchemaDataItemsReportedBy", "type": "object" }, "TimesheetsGetResponsesContentApplicationJsonSchemaDataItemsReviewedBy": { "description": "Reviewer information if the timesheet has been reviewed.", "properties": { "full_name": { "description": "Full name of the reviewer.", "type": "string" }, "id": { "description": "Unique identifier of the reviewer.", "format": "uuid", "type": "string" }, "remarks": { "description": "Reviewer remarks or decision notes.", "type": "string" }, "reviewed_at": { "description": "Timestamp when the review occurred (ISO-8601).", "format": "date-time", "type": "string" } }, "required": [ "id", "remarks", "reviewed_at" ], "title": "TimesheetsGetResponsesContentApplicationJsonSchemaDataItemsReviewedBy", "type": "object" }, "TimesheetsGetResponsesContentApplicationJsonSchemaDataItemsStatus": { "description": "Current processing status of the timesheet.", "enum": [ "approved", "declined", "not_payable", "paid", "pending", "processing" ], "title": "TimesheetsGetResponsesContentApplicationJsonSchemaDataItemsStatus", "type": "string" }, "TimesheetsGetResponsesContentApplicationJsonSchemaDataItemsWorksheet": { "description": "Breakdown of time worked across different units.", "properties": { "days": { "description": "Number of days reported.", "format": "double", "minimum": 0, "type": "number" }, "hours": { "description": "Number of hours reported.", "format": "double", "minimum": 0, "type": "number" }, "minutes": { "description": "Number of minutes reported.", "format": "double", "minimum": 0, "type": "number" }, "weeks": { "description": "Number of weeks reported.", "format": "double", "minimum": 0, "type": "number" } }, "required": [ "days", "hours", "weeks", "minutes" ], "title": "TimesheetsGetResponsesContentApplicationJsonSchemaDataItemsWorksheet", "type": "object" }, "TimesheetsGetResponsesContentApplicationJsonSchemaErrorsItems": { "properties": { "message": { "description": "Error response", "type": "string" } }, "required": [ "message" ], "title": "TimesheetsGetResponsesContentApplicationJsonSchemaErrorsItems", "type": "object" }, "TimesheetsGetResponsesContentApplicationJsonSchemaPage": { "description": "Pagination metadata for the response.", "properties": { "total_rows": { "description": "Total number of records available.", "format": "double", "type": "number" } }, "required": [ "total_rows" ], "title": "TimesheetsGetResponsesContentApplicationJsonSchemaPage", "type": "object" }, "TimesheetsGetResponsesContentApplicationJsonSchemaRequest": { "description": "Error request details", "properties": { "method": { "description": "Method of the API", "type": "string" }, "status": { "description": "Status of API response", "format": "double", "type": "number" } }, "title": "TimesheetsGetResponsesContentApplicationJsonSchemaRequest", "type": "object" }, "TimesheetsManyReviewsPostRequestBodyContentApplicationJsonSchemaData": { "properties": { "ids": { "items": { "type": "string" }, "type": "array" }, "reason": { "description": "The reason for review status", "type": [ "string", "null" ] }, "status": { "$ref": "#/components/schemas/TimesheetsManyReviewsPostRequestBodyContentApplicationJsonSchemaDataStatus", "description": "The status to set for the timesheets" } }, "required": [ "ids", "status" ], "title": "TimesheetsManyReviewsPostRequestBodyContentApplicationJsonSchemaData", "type": "object" }, "TimesheetsManyReviewsPostRequestBodyContentApplicationJsonSchemaDataStatus": { "description": "The status to set for the timesheets", "enum": [ "approved", "declined" ], "title": "TimesheetsManyReviewsPostRequestBodyContentApplicationJsonSchemaDataStatus", "type": "string" }, "TimesheetsManyReviewsPostResponsesContentApplicationJsonSchemaData": { "properties": { "created": { "description": "Indicates if the timesheet review was created successfully", "type": "boolean" } }, "required": [ "created" ], "title": "TimesheetsManyReviewsPostResponsesContentApplicationJsonSchemaData", "type": "object" }, "TimesheetsManyReviewsPostResponsesContentApplicationJsonSchemaErrorsItems": { "properties": { "code": { "description": "Machine-readable error code identifying the failure category.", "type": "string" }, "message": { "description": "Human-readable error message describing the unexpected condition.", "type": "string" } }, "required": [ "message" ], "title": "TimesheetsManyReviewsPostResponsesContentApplicationJsonSchemaErrorsItems", "type": "object" }, "TimesheetsPostRequestBodyContentApplicationJsonSchemaData": { "description": "Payload attributes required to create one timesheet entry with optional approval, preset, and grouping metadata.", "properties": { "contract_id": { "description": "Unique Deel contract identifier (public id) that receives this timesheet entry line item.", "type": "string" }, "date_submitted": { "description": "Date the work was performed in ISO-8601 short-date format (YYYY-MM-DD) used for filtering and approvals.", "format": "date", "type": "string" }, "description": { "default": "", "description": "Detailed human-readable explanation of the work performed that appears on the invoice and audit records.", "type": "string" }, "group_key": { "description": "When provided, timesheets sharing the same group_key within the same payment cycle are merged into a single aggregated line item on the invoice. Requires is_auto_approved to be true.", "maxLength": 300, "type": [ "string", "null" ] }, "hourly_report_preset_id": { "description": "Identifier of an existing timesheet preset used to link a standardized hourly rate and label to this entry.", "type": [ "string", "null" ] }, "is_auto_approved": { "description": "When true, the created timesheet entry skips manual approval and is approved immediately on creation.", "type": "boolean" }, "quantity": { "description": "Number of work units (typically hours) to record based on the scale defined in the associated contract work statement.", "format": "double", "minimum": 0.01, "type": "number" } }, "required": [ "quantity", "contract_id", "description", "date_submitted" ], "title": "TimesheetsPostRequestBodyContentApplicationJsonSchemaData", "type": "object" }, "TimesheetsPostResponsesContentApplicationJsonSchemaData": { "description": "Container object with identifiers, status, and creation metadata for the newly created timesheet entry.", "properties": { "created": { "description": "Flag indicating whether the timesheet entry record was successfully persisted by this request.", "type": "boolean" }, "created_at": { "description": "ISO-8601 timestamp recording the exact moment the timesheet entry was created in the system.", "format": "date-time", "type": [ "string", "null" ] }, "id": { "description": "Unique identifier returned for the created timesheet entry resource after persistence succeeds.", "format": "uuid", "type": "string" }, "status": { "description": "Current processing status assigned to the timesheet entry after the create workflow finishes executing.", "oneOf": [ { "$ref": "#/components/schemas/TimesheetsPostResponsesContentApplicationJsonSchemaDataStatus" }, { "type": "null" } ] } }, "required": [ "created" ], "title": "TimesheetsPostResponsesContentApplicationJsonSchemaData", "type": "object" }, "TimesheetsPostResponsesContentApplicationJsonSchemaDataStatus": { "description": "Current processing status assigned to the timesheet entry after the create workflow finishes executing.", "enum": [ "approved", "declined", "not_payable", "paid", "pending", "processing" ], "title": "TimesheetsPostResponsesContentApplicationJsonSchemaDataStatus", "type": "string" }, "TimesheetsPostResponsesContentApplicationJsonSchemaErrorsItems": { "properties": { "code": { "description": "Stable machine-readable error code identifying the upstream or internal failure category.", "type": "string" }, "message": { "description": "Human-readable error message describing the unexpected condition that prevented completing the request.", "type": "string" } }, "required": [ "message" ], "title": "TimesheetsPostResponsesContentApplicationJsonSchemaErrorsItems", "type": "object" }, "TimesheetsPresetsIdDeleteResponsesContentApplicationJsonSchemaData": { "properties": { "deleted": { "description": "Indicates whether the hourly report preset was successfully deleted", "type": "boolean" } }, "required": [ "deleted" ], "title": "TimesheetsPresetsIdDeleteResponsesContentApplicationJsonSchemaData", "type": "object" }, "TimesheetsPresetsIdGetResponsesContentApplicationJsonSchemaData": { "properties": { "description": { "description": "A detailed description of the hourly report preset", "type": "string" }, "file": { "oneOf": [ { "$ref": "#/components/schemas/TimesheetsPresetsIdGetResponsesContentApplicationJsonSchemaDataFile" }, { "type": "null" } ] }, "id": { "description": "The unique identifier of the hourly report preset", "format": "uuid", "type": "string" }, "status": { "description": "The current status of the hourly report preset", "type": "string" }, "title": { "description": "The title of the hourly report preset", "type": "string" }, "type": { "$ref": "#/components/schemas/TimesheetsPresetsIdGetResponsesContentApplicationJsonSchemaDataType", "description": "The type of preset based on type of root preset" } }, "required": [ "id", "title", "status", "description" ], "title": "TimesheetsPresetsIdGetResponsesContentApplicationJsonSchemaData", "type": "object" }, "TimesheetsPresetsIdGetResponsesContentApplicationJsonSchemaDataFile": { "properties": { "id": { "description": "The unique identifier of the file", "type": "string" }, "name": { "description": "The name of the file", "type": "string" }, "type": { "description": "The type of the file", "type": "string" } }, "title": "TimesheetsPresetsIdGetResponsesContentApplicationJsonSchemaDataFile", "type": "object" }, "TimesheetsPresetsIdGetResponsesContentApplicationJsonSchemaDataType": { "description": "The type of preset based on type of root preset", "enum": [ "RATE", "TRACKING" ], "title": "TimesheetsPresetsIdGetResponsesContentApplicationJsonSchemaDataType", "type": "string" }, "TimesheetsPresetsIdPatchRequestBodyContentApplicationJsonSchemaData": { "properties": { "description": { "description": "A detailed description of the hourly report preset's purpose and contents (maximum 30000 characters)", "maxLength": 30000, "type": [ "string", "null" ] }, "file": { "description": "The file to be attached to this hourly report preset (optional)", "format": "binary", "type": [ "string", "null" ] }, "rate": { "description": "The hourly rate for this preset (must be greater than 0)", "title": "float", "type": "string" }, "title": { "description": "The title of the hourly report preset (maximum 255 characters)", "maxLength": 255, "type": "string" } }, "title": "TimesheetsPresetsIdPatchRequestBodyContentApplicationJsonSchemaData", "type": "object" }, "TimesheetsPresetsIdPatchResponsesContentApplicationJsonSchemaData": { "properties": { "id": { "description": "The unique identifier of the updated hourly report preset", "format": "uuid", "type": "string" } }, "required": [ "id" ], "title": "TimesheetsPresetsIdPatchResponsesContentApplicationJsonSchemaData", "type": "object" }, "TimesheetsPresetsPostRequestBodyContentApplicationJsonSchemaData": { "properties": { "description": { "description": "A detailed description of the hourly report preset's purpose and contents", "maxLength": 30000, "type": [ "string", "null" ] }, "file": { "description": "Optional file attachment for the hourly report preset", "format": "binary", "type": [ "string", "null" ] }, "hourly_report_root_preset_id": { "description": "The unique identifier of the root preset this report is based on", "format": "uuid", "type": "string" }, "rate": { "description": "The hourly rate for this preset (must be greater than 0)", "format": "double", "minimum": 0.1, "type": "number" }, "title": { "description": "The title of the hourly report preset", "maxLength": 255, "type": "string" }, "work_statement_id": { "description": "The unique identifier of the associated work statement", "format": "uuid", "type": "string" } }, "required": [ "work_statement_id", "hourly_report_root_preset_id" ], "title": "TimesheetsPresetsPostRequestBodyContentApplicationJsonSchemaData", "type": "object" }, "TimesheetsPresetsPostResponsesContentApplicationJsonSchemaData": { "properties": { "id": { "description": "The unique identifier of the newly created hourly report preset", "format": "uuid", "type": "string" } }, "required": [ "id" ], "title": "TimesheetsPresetsPostResponsesContentApplicationJsonSchemaData", "type": "object" }, "TimesheetsRootPresetsGetParametersOrderBy": { "default": "created_at", "enum": [ "created_at" ], "title": "TimesheetsRootPresetsGetParametersOrderBy", "type": "string" }, "TimesheetsRootPresetsGetParametersOrderDirection": { "default": "DESC", "enum": [ "ASC", "DESC" ], "title": "TimesheetsRootPresetsGetParametersOrderDirection", "type": "string" }, "TimesheetsRootPresetsGetResponsesContentApplicationJsonSchemaDataItems": { "properties": { "contracts_count": { "description": "Number of contracts using this root preset", "type": "integer" }, "description": { "description": "Detailed description of the hourly report root preset", "type": "string" }, "file": { "oneOf": [ { "$ref": "#/components/schemas/TimesheetsRootPresetsGetResponsesContentApplicationJsonSchemaDataItemsFile" }, { "type": "null" } ] }, "hourly_report_presets_count": { "description": "Number of hourly report presets created from this root preset", "type": "integer" }, "id": { "description": "The unique identifier of the hourly report root preset", "format": "uuid", "type": "string" }, "title": { "description": "The title of the hourly report root preset", "type": "string" }, "type": { "$ref": "#/components/schemas/TimesheetsRootPresetsGetResponsesContentApplicationJsonSchemaDataItemsType", "description": "The type of preset, RATE – indicates a preset that overrides the default contract rate, TRACKING - used exclusively for tracking, applying the default contract rate" } }, "required": [ "id", "title", "description", "contracts_count", "hourly_report_presets_count" ], "title": "TimesheetsRootPresetsGetResponsesContentApplicationJsonSchemaDataItems", "type": "object" }, "TimesheetsRootPresetsGetResponsesContentApplicationJsonSchemaDataItemsFile": { "properties": { "id": { "description": "The unique identifier of the file", "type": "string" }, "name": { "description": "The name of the file", "type": "string" }, "type": { "description": "The type of the file", "type": "string" } }, "title": "TimesheetsRootPresetsGetResponsesContentApplicationJsonSchemaDataItemsFile", "type": "object" }, "TimesheetsRootPresetsGetResponsesContentApplicationJsonSchemaDataItemsType": { "description": "The type of preset, RATE – indicates a preset that overrides the default contract rate, TRACKING - used exclusively for tracking, applying the default contract rate", "enum": [ "RATE", "TRACKING" ], "title": "TimesheetsRootPresetsGetResponsesContentApplicationJsonSchemaDataItemsType", "type": "string" }, "TimesheetsRootPresetsGetResponsesContentApplicationJsonSchemaPage": { "properties": { "cursor": { "description": "Pagination cursor for fetching the next set of results", "type": "string" }, "total_rows": { "description": "Total number of root presets available", "type": "integer" } }, "required": [ "cursor", "total_rows" ], "title": "TimesheetsRootPresetsGetResponsesContentApplicationJsonSchemaPage", "type": "object" }, "TimesheetsRootPresetsIdGetResponsesContentApplicationJsonSchemaData": { "properties": { "description": { "description": "Detailed description of the hourly report root preset's purpose and contents", "type": "string" }, "file": { "oneOf": [ { "$ref": "#/components/schemas/TimesheetsRootPresetsIdGetResponsesContentApplicationJsonSchemaDataFile" }, { "type": "null" } ] }, "id": { "description": "The unique identifier of the hourly report root preset", "format": "uuid", "type": "string" }, "status": { "description": "The current status of the hourly report root preset", "type": "string" }, "title": { "description": "The title of the hourly report root preset", "type": "string" }, "type": { "$ref": "#/components/schemas/TimesheetsRootPresetsIdGetResponsesContentApplicationJsonSchemaDataType", "description": "The type of preset, RATE – indicates a preset that overrides the default contract rate, TRACKING - used exclusively for tracking, applying the default contract rate" } }, "required": [ "id", "title", "status", "description" ], "title": "TimesheetsRootPresetsIdGetResponsesContentApplicationJsonSchemaData", "type": "object" }, "TimesheetsRootPresetsIdGetResponsesContentApplicationJsonSchemaDataFile": { "properties": { "id": { "description": "The unique identifier of the file", "type": "string" }, "name": { "description": "The name of the file", "type": "string" }, "type": { "description": "The type of the file", "type": "string" } }, "title": "TimesheetsRootPresetsIdGetResponsesContentApplicationJsonSchemaDataFile", "type": "object" }, "TimesheetsRootPresetsIdGetResponsesContentApplicationJsonSchemaDataType": { "description": "The type of preset, RATE – indicates a preset that overrides the default contract rate, TRACKING - used exclusively for tracking, applying the default contract rate", "enum": [ "RATE", "TRACKING" ], "title": "TimesheetsRootPresetsIdGetResponsesContentApplicationJsonSchemaDataType", "type": "string" }, "TimesheetsRootPresetsPostRequestBodyContentApplicationJsonSchemaHourlyReportPresetsItems": { "properties": { "action_type": { "$ref": "#/components/schemas/TimesheetsRootPresetsPostRequestBodyContentApplicationJsonSchemaHourlyReportPresetsItemsActionType", "default": "ADD", "description": "The action to perform with this preset (currently only ADD is supported)" }, "contract_id": { "description": "The unique identifier of the contract this preset is associated with", "type": "string" }, "description": { "description": "Detailed description for this specific preset instance (maximum 30000 characters)", "maxLength": 30000, "type": [ "string", "null" ] }, "file": { "description": "Optional file attachment for this specific preset instance", "format": "binary", "type": [ "string", "null" ] }, "rate": { "description": "The hourly rate for this preset (must be greater than 0)", "format": "double", "minimum": 0.1, "type": "number" }, "title": { "description": "The title for this specific preset instance (maximum 255 characters)", "maxLength": 255, "type": "string" } }, "required": [ "contract_id" ], "title": "TimesheetsRootPresetsPostRequestBodyContentApplicationJsonSchemaHourlyReportPresetsItems", "type": "object" }, "TimesheetsRootPresetsPostRequestBodyContentApplicationJsonSchemaHourlyReportPresetsItemsActionType": { "default": "ADD", "description": "The action to perform with this preset (currently only ADD is supported)", "enum": [ "ADD" ], "title": "TimesheetsRootPresetsPostRequestBodyContentApplicationJsonSchemaHourlyReportPresetsItemsActionType", "type": "string" }, "TimesheetsRootPresetsPostRequestBodyContentApplicationJsonSchemaHourlyReportPresetsProcessingType": { "default": "SYNC", "description": "Determines whether presets should be processed synchronously or asynchronously", "enum": [ "ASYNC", "SYNC" ], "title": "TimesheetsRootPresetsPostRequestBodyContentApplicationJsonSchemaHourlyReportPresetsProcessingType", "type": "string" }, "TimesheetsRootPresetsPostRequestBodyContentApplicationJsonSchemaType": { "description": "The type of preset, RATE – indicates a preset that overrides the default contract rate, TRACKING - used exclusively for tracking, applying the default contract rate", "enum": [ "RATE", "TRACKING" ], "title": "TimesheetsRootPresetsPostRequestBodyContentApplicationJsonSchemaType", "type": "string" }, "TimesheetsRootPresetsPostResponsesContentApplicationJsonSchemaData": { "properties": { "async_task": { "$ref": "#/components/schemas/TimesheetsRootPresetsPostResponsesContentApplicationJsonSchemaDataAsyncTask" }, "id": { "description": "The unique identifier of the created root preset", "format": "uuid", "type": "string" } }, "required": [ "id" ], "title": "TimesheetsRootPresetsPostResponsesContentApplicationJsonSchemaData", "type": "object" }, "TimesheetsRootPresetsPostResponsesContentApplicationJsonSchemaDataAsyncTask": { "properties": { "id": { "description": "The identifier of the asynchronous task processing this request", "type": "integer" } }, "title": "TimesheetsRootPresetsPostResponsesContentApplicationJsonSchemaDataAsyncTask", "type": "object" }, "TimesheetsTimesheetIdDeleteResponsesContentApplicationJsonSchemaData": { "description": "Container object confirming the outcome of the delete operation.", "properties": { "deleted": { "description": "Confirms the deletion.", "type": "boolean" } }, "required": [ "deleted" ], "title": "TimesheetsTimesheetIdDeleteResponsesContentApplicationJsonSchemaData", "type": "object" }, "TimesheetsTimesheetIdDeleteResponsesContentApplicationJsonSchemaErrorsItems": { "properties": { "code": { "description": "Machine-readable error code identifying the failure category.", "type": "string" }, "message": { "description": "Human-readable error message describing the unexpected condition.", "type": "string" } }, "required": [ "message" ], "title": "TimesheetsTimesheetIdDeleteResponsesContentApplicationJsonSchemaErrorsItems", "type": "object" }, "TimesheetsTimesheetIdGetResponsesContentApplicationJsonSchemaData": { "description": "Timesheet entry combining its core fields with any approver decisions recorded against it.", "properties": { "approvers": { "description": "List of approvers and their decisions recorded against this timesheet.", "items": { "$ref": "#/components/schemas/TimesheetsTimesheetIdGetResponsesContentApplicationJsonSchemaDataApproversItems" }, "type": "array" }, "attachment": { "description": "This object is used for linking file attachments to your records.", "oneOf": [ { "$ref": "#/components/schemas/TimesheetsTimesheetIdGetResponsesContentApplicationJsonSchemaDataAttachment" }, { "type": "null" } ] }, "contract": { "$ref": "#/components/schemas/TimesheetsTimesheetIdGetResponsesContentApplicationJsonSchemaDataContract", "description": "Contract associated with this timesheet." }, "created_at": { "description": "Timestamp when the timesheet was created (ISO-8601).", "type": "string" }, "currency_code": { "description": "ISO 4217 currency code used for the amount.", "maxLength": 3, "minLength": 3, "pattern": "^[A-Z]{3}$", "type": "string" }, "custom_scale": { "description": "Custom scale label defined by the client for non-standard billing rates.", "type": [ "string", "null" ] }, "date_submitted": { "description": "Long date-time format following ISO-8601", "format": "date-time", "type": "string" }, "description": { "description": "Human-readable description of the work performed.", "type": "string" }, "hourly_report_preset": { "description": "Timesheet preset linked to this entry, if any.", "oneOf": [ { "$ref": "#/components/schemas/TimesheetsTimesheetIdGetResponsesContentApplicationJsonSchemaDataHourlyReportPreset" }, { "type": "null" } ] }, "id": { "$ref": "#/components/schemas/TimesheetsTimesheetIdGetResponsesContentApplicationJsonSchemaDataId", "description": "Unique identifier of this resource." }, "payment_cycle": { "$ref": "#/components/schemas/TimesheetsTimesheetIdGetResponsesContentApplicationJsonSchemaDataPaymentCycle", "description": "Payment cycle associated with this timesheet." }, "quantity": { "description": "Quantity of work units (hours, days, etc.) used to calculate the total amount.", "format": "double", "type": [ "number", "null" ] }, "reported_by": { "$ref": "#/components/schemas/TimesheetsTimesheetIdGetResponsesContentApplicationJsonSchemaDataReportedBy", "description": "User who submitted the timesheet." }, "reviewed_by": { "description": "Reviewer information if the timesheet has been reviewed.", "oneOf": [ { "$ref": "#/components/schemas/TimesheetsTimesheetIdGetResponsesContentApplicationJsonSchemaDataReviewedBy" }, { "type": "null" } ] }, "scale": { "description": "Predefined scale used to calculate the timesheet amount (e.g. hourly, daily, custom).", "type": [ "string", "null" ] }, "status": { "description": "Status of this entry.", "oneOf": [ { "$ref": "#/components/schemas/TimesheetsTimesheetIdGetResponsesContentApplicationJsonSchemaDataStatus" }, { "type": "null" } ] }, "total_amount": { "description": "is equal to quantity times rate of active work statement + bonus in this record", "type": "string" }, "type": { "description": "Deprecated - it is always \"work\"", "type": "string" }, "worksheet": { "description": "Breakdown of time worked across different units.", "oneOf": [ { "$ref": "#/components/schemas/TimesheetsTimesheetIdGetResponsesContentApplicationJsonSchemaDataWorksheet" }, { "type": "null" } ] } }, "required": [ "id", "type", "status", "contract", "quantity", "worksheet", "attachment", "created_at", "description", "reported_by", "reviewed_by", "total_amount", "currency_code", "date_submitted", "approvers" ], "title": "TimesheetsTimesheetIdGetResponsesContentApplicationJsonSchemaData", "type": "object" }, "TimesheetsTimesheetIdGetResponsesContentApplicationJsonSchemaDataApproversItems": { "properties": { "approved": { "description": "Whether the approver has approved the timesheet.", "type": "boolean" }, "email": { "description": "Email address of the approver.", "type": "string" }, "full_name": { "description": "Full name of the approver.", "type": "string" } }, "required": [ "approved" ], "title": "TimesheetsTimesheetIdGetResponsesContentApplicationJsonSchemaDataApproversItems", "type": "object" }, "TimesheetsTimesheetIdGetResponsesContentApplicationJsonSchemaDataAttachment": { "description": "This object is used for linking file attachments to your records.", "properties": { "filename": { "description": "Original filename you used to upload using attachments end-point.", "type": "string" }, "key": { "description": "You can call attachments end-point, get key and URL to upload your file.", "type": "string" } }, "required": [ "key", "filename" ], "title": "TimesheetsTimesheetIdGetResponsesContentApplicationJsonSchemaDataAttachment", "type": "object" }, "TimesheetsTimesheetIdGetResponsesContentApplicationJsonSchemaDataContract": { "description": "Contract associated with this timesheet.", "properties": { "id": { "description": "Unique identifier of the contract.", "type": "string" }, "title": { "description": "Human-readable title of the contract.", "type": "string" }, "type": { "$ref": "#/components/schemas/TimesheetsTimesheetIdGetResponsesContentApplicationJsonSchemaDataContractType", "description": "Type of a contract" } }, "required": [ "id", "type", "title" ], "title": "TimesheetsTimesheetIdGetResponsesContentApplicationJsonSchemaDataContract", "type": "object" }, "TimesheetsTimesheetIdGetResponsesContentApplicationJsonSchemaDataContractType": { "description": "Type of a contract", "enum": [ "ongoing_time_based", "milestones", "time_based", "pay_as_you_go_time_based", "commission", "payg_milestones", "payg_tasks", "eor", "unknown", "employee", "global_payroll", "shield_msa", "hris_direct_employee", "peo" ], "title": "TimesheetsTimesheetIdGetResponsesContentApplicationJsonSchemaDataContractType", "type": "string" }, "TimesheetsTimesheetIdGetResponsesContentApplicationJsonSchemaDataHourlyReportPreset": { "description": "Timesheet preset linked to this entry, if any.", "properties": { "description": { "description": "the description of the related timesheet preset", "type": [ "string", "null" ] }, "id": { "description": "unique identifier of the related timesheet preset", "type": [ "string", "null" ] }, "rate": { "description": "the hourly rate of the related timesheet preset", "format": "double", "type": [ "number", "null" ] }, "title": { "description": "the title of the related timesheet preset", "type": [ "string", "null" ] } }, "title": "TimesheetsTimesheetIdGetResponsesContentApplicationJsonSchemaDataHourlyReportPreset", "type": "object" }, "TimesheetsTimesheetIdGetResponsesContentApplicationJsonSchemaDataId": { "description": "Unique identifier of this resource.", "oneOf": [ { "type": "string" }, { "format": "int64", "type": "integer" } ], "title": "TimesheetsTimesheetIdGetResponsesContentApplicationJsonSchemaDataId" }, "TimesheetsTimesheetIdGetResponsesContentApplicationJsonSchemaDataPaymentCycle": { "description": "Payment cycle associated with this timesheet.", "properties": { "end_date": { "description": "Long date-time format following ISO-8601", "format": "date-time", "type": [ "string", "null" ] }, "start_date": { "description": "Long date-time format following ISO-8601", "format": "date-time", "type": [ "string", "null" ] } }, "title": "TimesheetsTimesheetIdGetResponsesContentApplicationJsonSchemaDataPaymentCycle", "type": "object" }, "TimesheetsTimesheetIdGetResponsesContentApplicationJsonSchemaDataReportedBy": { "description": "User who submitted the timesheet.", "properties": { "full_name": { "description": "Full name of the user who submitted the timesheet.", "type": "string" }, "id": { "$ref": "#/components/schemas/TimesheetsTimesheetIdGetResponsesContentApplicationJsonSchemaDataReportedById", "description": "Unique identifier of the reporting user." } }, "required": [ "id" ], "title": "TimesheetsTimesheetIdGetResponsesContentApplicationJsonSchemaDataReportedBy", "type": "object" }, "TimesheetsTimesheetIdGetResponsesContentApplicationJsonSchemaDataReportedById": { "description": "Unique identifier of the reporting user.", "oneOf": [ { "type": "string" }, { "format": "int64", "type": "integer" } ], "title": "TimesheetsTimesheetIdGetResponsesContentApplicationJsonSchemaDataReportedById" }, "TimesheetsTimesheetIdGetResponsesContentApplicationJsonSchemaDataReviewedBy": { "description": "Reviewer information if the timesheet has been reviewed.", "properties": { "full_name": { "description": "Full name of the reviewer.", "type": "string" }, "id": { "$ref": "#/components/schemas/TimesheetsTimesheetIdGetResponsesContentApplicationJsonSchemaDataReviewedById", "description": "Unique identifier of the reviewer." }, "remarks": { "description": "Reviewer remarks or decision notes.", "type": "string" }, "reviewed_at": { "description": "Timestamp when the review occurred (ISO-8601).", "type": "string" } }, "required": [ "id", "remarks", "reviewed_at" ], "title": "TimesheetsTimesheetIdGetResponsesContentApplicationJsonSchemaDataReviewedBy", "type": "object" }, "TimesheetsTimesheetIdGetResponsesContentApplicationJsonSchemaDataReviewedById": { "description": "Unique identifier of the reviewer.", "oneOf": [ { "type": "string" }, { "format": "int64", "type": "integer" } ], "title": "TimesheetsTimesheetIdGetResponsesContentApplicationJsonSchemaDataReviewedById" }, "TimesheetsTimesheetIdGetResponsesContentApplicationJsonSchemaDataStatus": { "description": "Status of this entry.", "enum": [ "approved", "declined", "not_payable", "paid", "pending", "processing" ], "title": "TimesheetsTimesheetIdGetResponsesContentApplicationJsonSchemaDataStatus", "type": "string" }, "TimesheetsTimesheetIdGetResponsesContentApplicationJsonSchemaDataWorksheet": { "description": "Breakdown of time worked across different units.", "properties": { "days": { "description": "Number of days reported.", "format": "double", "minimum": 0, "type": "number" }, "hours": { "description": "Number of hours reported.", "format": "double", "minimum": 0, "type": "number" }, "minutes": { "description": "Number of minutes reported.", "format": "double", "minimum": 0, "type": "number" }, "weeks": { "description": "Number of weeks reported.", "format": "double", "minimum": 0, "type": "number" } }, "required": [ "days", "hours", "weeks", "minutes" ], "title": "TimesheetsTimesheetIdGetResponsesContentApplicationJsonSchemaDataWorksheet", "type": "object" }, "TimesheetsTimesheetIdGetResponsesContentApplicationJsonSchemaErrorsItems": { "properties": { "code": { "description": "Machine-readable error code identifying the failure category.", "type": "string" }, "message": { "description": "Human-readable error message describing the unexpected condition.", "type": "string" } }, "required": [ "message" ], "title": "TimesheetsTimesheetIdGetResponsesContentApplicationJsonSchemaErrorsItems", "type": "object" }, "TimesheetsTimesheetIdPatchRequestBodyContentApplicationJsonSchemaData": { "description": "Fields to update on the existing timesheet entry.", "properties": { "description": { "description": "Detailed human-readable explanation of the work performed.", "maxLength": 255, "type": "string" }, "hourly_report_preset_id": { "description": "Id of an existing timesheets preset. Created through /rest/v2/timesheets/presets", "type": [ "string", "null" ] }, "quantity": { "description": "Number of work units (typically hours) to record based on the scale defined in the associated contract work statement.", "format": "double", "type": "number" } }, "required": [ "quantity", "description" ], "title": "TimesheetsTimesheetIdPatchRequestBodyContentApplicationJsonSchemaData", "type": "object" }, "TimesheetsTimesheetIdPatchResponsesContentApplicationJsonSchemaData": { "description": "Container object confirming the outcome of the update operation.", "properties": { "updated": { "description": "Confirms the update.", "type": "boolean" } }, "required": [ "updated" ], "title": "TimesheetsTimesheetIdPatchResponsesContentApplicationJsonSchemaData", "type": "object" }, "TimesheetsTimesheetIdPatchResponsesContentApplicationJsonSchemaErrorsItems": { "properties": { "code": { "description": "Machine-readable error code identifying the failure category.", "type": "string" }, "message": { "description": "Human-readable error message describing the unexpected condition.", "type": "string" } }, "required": [ "message" ], "title": "TimesheetsTimesheetIdPatchResponsesContentApplicationJsonSchemaErrorsItems", "type": "object" }, "TimesheetsTimesheetIdReviewsPostRequestBodyContentApplicationJsonSchemaData": { "description": "Review decision payload to apply to the timesheet entry.", "properties": { "reason": { "description": "Optional reason accompanying the review decision, typically used when declining a timesheet.", "type": [ "string", "null" ] }, "status": { "$ref": "#/components/schemas/TimesheetsTimesheetIdReviewsPostRequestBodyContentApplicationJsonSchemaDataStatus", "description": "Review decision to apply to the timesheet." } }, "required": [ "status" ], "title": "TimesheetsTimesheetIdReviewsPostRequestBodyContentApplicationJsonSchemaData", "type": "object" }, "TimesheetsTimesheetIdReviewsPostRequestBodyContentApplicationJsonSchemaDataStatus": { "description": "Review decision to apply to the timesheet.", "enum": [ "approved", "declined" ], "title": "TimesheetsTimesheetIdReviewsPostRequestBodyContentApplicationJsonSchemaDataStatus", "type": "string" }, "TimesheetsTimesheetIdReviewsPostResponsesContentApplicationJsonSchemaData": { "description": "Container object confirming the outcome of the review operation.", "properties": { "created": { "description": "Confirms the review was recorded.", "type": "boolean" } }, "required": [ "created" ], "title": "TimesheetsTimesheetIdReviewsPostResponsesContentApplicationJsonSchemaData", "type": "object" }, "TimesheetsTimesheetIdReviewsPostResponsesContentApplicationJsonSchemaErrorsItems": { "properties": { "code": { "description": "Machine-readable error code identifying the failure category.", "type": "string" }, "message": { "description": "Human-readable error message describing the unexpected condition.", "type": "string" } }, "required": [ "message" ], "title": "TimesheetsTimesheetIdReviewsPostResponsesContentApplicationJsonSchemaErrorsItems", "type": "object" }, "Timesheets_createTimesheetReview-v2026-01-01_Response_201": { "properties": { "data": { "$ref": "#/components/schemas/TimesheetsTimesheetIdReviewsPostResponsesContentApplicationJsonSchemaData", "description": "Container object confirming the outcome of the review operation." } }, "required": [ "data" ], "title": "Timesheets_createTimesheetReview-v2026-01-01_Response_201", "type": "object" }, "Timesheets_createtimesheetreviews-v2026-01-01_Response_201": { "properties": { "data": { "$ref": "#/components/schemas/TimesheetsManyReviewsPostResponsesContentApplicationJsonSchemaData" } }, "required": [ "data" ], "title": "Timesheets_createtimesheetreviews-v2026-01-01_Response_201", "type": "object" }, "Timesheets_deleteTimesheetById-v2026-01-01_Response_200": { "properties": { "data": { "$ref": "#/components/schemas/TimesheetsTimesheetIdDeleteResponsesContentApplicationJsonSchemaData", "description": "Container object confirming the outcome of the delete operation." } }, "required": [ "data" ], "title": "Timesheets_deleteTimesheetById-v2026-01-01_Response_200", "type": "object" }, "Timesheets_getTimesheetById-v2026-01-01_Response_200": { "properties": { "data": { "$ref": "#/components/schemas/TimesheetsTimesheetIdGetResponsesContentApplicationJsonSchemaData", "description": "Timesheet entry combining its core fields with any approver decisions recorded against it." } }, "required": [ "data" ], "title": "Timesheets_getTimesheetById-v2026-01-01_Response_200", "type": "object" }, "Timesheets_updateATimesheetEntry-v2026-01-01_Response_200": { "properties": { "data": { "$ref": "#/components/schemas/TimesheetsTimesheetIdPatchResponsesContentApplicationJsonSchemaData", "description": "Container object confirming the outcome of the update operation." } }, "required": [ "data" ], "title": "Timesheets_updateATimesheetEntry-v2026-01-01_Response_200", "type": "object" }, "TransferItAsset-v2026-09-17RequestBadRequestError": { "properties": { "errors": { "items": { "$ref": "#/components/schemas/ItAssetsAssetIdTransferPostResponsesContentApplicationJsonSchemaErrorsItems" }, "type": "array" } }, "required": [ "errors" ], "title": "TransferItAsset-v2026-09-17RequestBadRequestError", "type": "object" }, "TransferItAsset-v2026-09-17RequestConflictError": { "properties": { "errors": { "items": { "$ref": "#/components/schemas/ItAssetsAssetIdTransferPostResponsesContentApplicationJsonSchemaErrorsItems" }, "type": "array" } }, "required": [ "errors" ], "title": "TransferItAsset-v2026-09-17RequestConflictError", "type": "object" }, "TransferItAsset-v2026-09-17RequestForbiddenError": { "properties": { "errors": { "items": { "$ref": "#/components/schemas/ItAssetsAssetIdTransferPostResponsesContentApplicationJsonSchemaErrorsItems" }, "type": "array" } }, "required": [ "errors" ], "title": "TransferItAsset-v2026-09-17RequestForbiddenError", "type": "object" }, "TransferItAsset-v2026-09-17RequestInternalServerError": { "properties": { "errors": { "items": { "$ref": "#/components/schemas/ItAssetsAssetIdTransferPostResponsesContentApplicationJsonSchemaErrorsItems" }, "type": "array" } }, "required": [ "errors" ], "title": "TransferItAsset-v2026-09-17RequestInternalServerError", "type": "object" }, "TransferItAsset-v2026-09-17RequestNotFoundError": { "properties": { "errors": { "items": { "$ref": "#/components/schemas/ItAssetsAssetIdTransferPostResponsesContentApplicationJsonSchemaErrorsItems" }, "type": "array" } }, "required": [ "errors" ], "title": "TransferItAsset-v2026-09-17RequestNotFoundError", "type": "object" }, "TransferItAsset-v2026-09-17RequestUnauthorizedError": { "properties": { "errors": { "items": { "$ref": "#/components/schemas/ItAssetsAssetIdTransferPostResponsesContentApplicationJsonSchemaErrorsItems" }, "type": "array" } }, "required": [ "errors" ], "title": "TransferItAsset-v2026-09-17RequestUnauthorizedError", "type": "object" }, "Treasury_createVendorBill-v2026-01-01_Response_201": { "properties": { "data": { "$ref": "#/components/schemas/AccountsPayableVendorBillsPostResponsesContentApplicationJsonSchemaData" } }, "required": [ "data" ], "title": "Treasury_createVendorBill-v2026-01-01_Response_201", "type": "object" }, "Treasury_uploadVendorBillAttachment-v2026-01-01_Response_201": { "properties": { "data": { "$ref": "#/components/schemas/AccountsPayableVendorBillsVendorBillIdAttachmentsPostResponsesContentApplicationJsonSchemaData" } }, "required": [ "data" ], "title": "Treasury_uploadVendorBillAttachment-v2026-01-01_Response_201", "type": "object" }, "UnarchiveAsset-v2026-09-17RequestBadRequestError": { "properties": { "errors": { "items": { "$ref": "#/components/schemas/ItAssetsAssetIdUnarchivePostResponsesContentApplicationJsonSchemaErrorsItems" }, "type": "array" } }, "required": [ "errors" ], "title": "UnarchiveAsset-v2026-09-17RequestBadRequestError", "type": "object" }, "UnarchiveAsset-v2026-09-17RequestConflictError": { "properties": { "errors": { "items": { "$ref": "#/components/schemas/ItAssetsAssetIdUnarchivePostResponsesContentApplicationJsonSchemaErrorsItems" }, "type": "array" } }, "required": [ "errors" ], "title": "UnarchiveAsset-v2026-09-17RequestConflictError", "type": "object" }, "UnarchiveAsset-v2026-09-17RequestForbiddenError": { "properties": { "errors": { "items": { "$ref": "#/components/schemas/ItAssetsAssetIdUnarchivePostResponsesContentApplicationJsonSchemaErrorsItems" }, "type": "array" } }, "required": [ "errors" ], "title": "UnarchiveAsset-v2026-09-17RequestForbiddenError", "type": "object" }, "UnarchiveAsset-v2026-09-17RequestInternalServerError": { "properties": { "errors": { "items": { "$ref": "#/components/schemas/ItAssetsAssetIdUnarchivePostResponsesContentApplicationJsonSchemaErrorsItems" }, "type": "array" } }, "required": [ "errors" ], "title": "UnarchiveAsset-v2026-09-17RequestInternalServerError", "type": "object" }, "UnarchiveAsset-v2026-09-17RequestUnauthorizedError": { "properties": { "errors": { "items": { "$ref": "#/components/schemas/ItAssetsAssetIdUnarchivePostResponsesContentApplicationJsonSchemaErrorsItems" }, "type": "array" } }, "required": [ "errors" ], "title": "UnarchiveAsset-v2026-09-17RequestUnauthorizedError", "type": "object" }, "UnassignWorkersFromItSeats-v2026-09-25RequestBadRequestError": { "properties": { "errors": { "items": { "$ref": "#/components/schemas/ItSeatsUnassignPostResponsesContentApplicationJsonSchemaErrorsItems" }, "type": "array" } }, "required": [ "errors" ], "title": "UnassignWorkersFromItSeats-v2026-09-25RequestBadRequestError", "type": "object" }, "UnassignWorkersFromItSeats-v2026-09-25RequestConflictError": { "properties": { "errors": { "items": { "$ref": "#/components/schemas/ItSeatsUnassignPostResponsesContentApplicationJsonSchemaErrorsItems" }, "type": "array" } }, "required": [ "errors" ], "title": "UnassignWorkersFromItSeats-v2026-09-25RequestConflictError", "type": "object" }, "UnassignWorkersFromItSeats-v2026-09-25RequestForbiddenError": { "properties": { "errors": { "items": { "$ref": "#/components/schemas/ItSeatsUnassignPostResponsesContentApplicationJsonSchemaErrorsItems" }, "type": "array" } }, "required": [ "errors" ], "title": "UnassignWorkersFromItSeats-v2026-09-25RequestForbiddenError", "type": "object" }, "UnassignWorkersFromItSeats-v2026-09-25RequestInternalServerError": { "properties": { "errors": { "items": { "$ref": "#/components/schemas/ItSeatsUnassignPostResponsesContentApplicationJsonSchemaErrorsItems" }, "type": "array" } }, "required": [ "errors" ], "title": "UnassignWorkersFromItSeats-v2026-09-25RequestInternalServerError", "type": "object" }, "UnassignWorkersFromItSeats-v2026-09-25RequestNotFoundError": { "properties": { "errors": { "items": { "$ref": "#/components/schemas/ItSeatsUnassignPostResponsesContentApplicationJsonSchemaErrorsItems" }, "type": "array" } }, "required": [ "errors" ], "title": "UnassignWorkersFromItSeats-v2026-09-25RequestNotFoundError", "type": "object" }, "UnassignWorkersFromItSeats-v2026-09-25RequestUnauthorizedError": { "properties": { "errors": { "items": { "$ref": "#/components/schemas/ItSeatsUnassignPostResponsesContentApplicationJsonSchemaErrorsItems" }, "type": "array" } }, "required": [ "errors" ], "title": "UnassignWorkersFromItSeats-v2026-09-25RequestUnauthorizedError", "type": "object" }, "UpdateABankTransferMethod-v2026-01-01RequestBadRequestError": { "properties": { "errors": { "items": { "$ref": "#/components/schemas/PayoutsContractorsMethodsIdPutResponsesContentApplicationJsonSchemaErrorsItems" }, "type": "array" } }, "title": "UpdateABankTransferMethod-v2026-01-01RequestBadRequestError", "type": "object" }, "UpdateAShiftRate-v2026-01-01RequestBadRequestError": { "properties": { "error": { "$ref": "#/components/schemas/TimeTrackingShiftRatesExternalIdPatchResponsesContentApplicationJsonSchemaError" } }, "title": "UpdateAShiftRate-v2026-01-01RequestBadRequestError", "type": "object" }, "UpdateASpecificEorContractAmendment-v2026-01-01RequestBadRequestError": { "properties": { "errors": { "items": { "$ref": "#/components/schemas/EorContractsContractIdAmendmentsAmendmentIdPatchResponsesContentApplicationJsonSchemaErrorsItems" }, "type": "array" } }, "required": [ "errors" ], "title": "UpdateASpecificEorContractAmendment-v2026-01-01RequestBadRequestError", "type": "object" }, "UpdateASpecificEorContractAmendment-v2026-01-01RequestConflictError": { "properties": { "errors": { "items": { "$ref": "#/components/schemas/EorContractsContractIdAmendmentsAmendmentIdPatchResponsesContentApplicationJsonSchemaErrorsItems" }, "type": "array" } }, "required": [ "errors" ], "title": "UpdateASpecificEorContractAmendment-v2026-01-01RequestConflictError", "type": "object" }, "UpdateASpecificEorContractAmendment-v2026-01-01RequestInternalServerError": { "properties": { "errors": { "items": { "$ref": "#/components/schemas/EorContractsContractIdAmendmentsAmendmentIdPatchResponsesContentApplicationJsonSchemaErrorsItems" }, "type": "array" } }, "required": [ "errors" ], "title": "UpdateASpecificEorContractAmendment-v2026-01-01RequestInternalServerError", "type": "object" }, "UpdateASpecificEorContractAmendment-v2026-01-01RequestNotFoundError": { "properties": { "errors": { "items": { "$ref": "#/components/schemas/EorContractsContractIdAmendmentsAmendmentIdPatchResponsesContentApplicationJsonSchemaErrorsItems" }, "type": "array" } }, "required": [ "errors" ], "title": "UpdateASpecificEorContractAmendment-v2026-01-01RequestNotFoundError", "type": "object" }, "UpdateASpecificEorContractAmendment-v2026-01-01RequestUnprocessableEntityError": { "properties": { "errors": { "description": "List of validation or business rule errors.", "items": { "$ref": "#/components/schemas/EorContractsContractIdAmendmentsAmendmentIdPatchResponsesContentApplicationJsonSchemaErrorsItems" }, "type": "array" } }, "required": [ "errors" ], "title": "UpdateASpecificEorContractAmendment-v2026-01-01RequestUnprocessableEntityError", "type": "object" }, "UpdateATimesheetEntry-v2026-01-01RequestBadRequestError": { "properties": { "errors": { "description": "Validation or business rule errors describing why the timesheet could not be updated, such as invalid input or its current status.", "items": { "$ref": "#/components/schemas/TimesheetsTimesheetIdPatchResponsesContentApplicationJsonSchemaErrorsItems" }, "type": "array" } }, "required": [ "errors" ], "title": "UpdateATimesheetEntry-v2026-01-01RequestBadRequestError", "type": "object" }, "UpdateATimesheetEntry-v2026-01-01RequestForbiddenError": { "properties": { "errors": { "description": "Errors describing why the timesheet could not be found or accessed.", "items": { "$ref": "#/components/schemas/TimesheetsTimesheetIdPatchResponsesContentApplicationJsonSchemaErrorsItems" }, "type": "array" } }, "required": [ "errors" ], "title": "UpdateATimesheetEntry-v2026-01-01RequestForbiddenError", "type": "object" }, "UpdateATimesheetEntry-v2026-01-01RequestInternalServerError": { "properties": { "errors": { "description": "Generic upstream or internal errors emitted when the timesheet cannot be updated.", "items": { "$ref": "#/components/schemas/TimesheetsTimesheetIdPatchResponsesContentApplicationJsonSchemaErrorsItems" }, "type": "array" } }, "required": [ "errors" ], "title": "UpdateATimesheetEntry-v2026-01-01RequestInternalServerError", "type": "object" }, "UpdateATimesheetEntry-v2026-01-01RequestNotFoundError": { "properties": { "errors": { "description": "Errors describing why the timesheet could not be found.", "items": { "$ref": "#/components/schemas/TimesheetsTimesheetIdPatchResponsesContentApplicationJsonSchemaErrorsItems" }, "type": "array" } }, "required": [ "errors" ], "title": "UpdateATimesheetEntry-v2026-01-01RequestNotFoundError", "type": "object" }, "UpdateAdditionalInformation-v2026-01-01RequestBadRequestError": { "properties": { "errors": { "items": { "$ref": "#/components/schemas/EorWorkersContractsContractIdAdditionalInformationPatchResponsesContentApplicationJsonSchemaErrorsItems" }, "type": "array" } }, "required": [ "errors" ], "title": "UpdateAdditionalInformation-v2026-01-01RequestBadRequestError", "type": "object" }, "UpdateAdditionalInformation-v2026-01-01RequestForbiddenError": { "properties": { "errors": { "items": { "$ref": "#/components/schemas/EorWorkersContractsContractIdAdditionalInformationPatchResponsesContentApplicationJsonSchemaErrorsItems" }, "type": "array" } }, "required": [ "errors" ], "title": "UpdateAdditionalInformation-v2026-01-01RequestForbiddenError", "type": "object" }, "UpdateAdditionalInformation-v2026-01-01RequestInternalServerError": { "properties": { "errors": { "items": { "$ref": "#/components/schemas/EorWorkersContractsContractIdAdditionalInformationPatchResponsesContentApplicationJsonSchemaErrorsItems" }, "type": "array" } }, "required": [ "errors" ], "title": "UpdateAdditionalInformation-v2026-01-01RequestInternalServerError", "type": "object" }, "UpdateAdditionalInformation-v2026-01-01RequestNotFoundError": { "properties": { "errors": { "items": { "$ref": "#/components/schemas/EorWorkersContractsContractIdAdditionalInformationPatchResponsesContentApplicationJsonSchemaErrorsItems" }, "type": "array" } }, "required": [ "errors" ], "title": "UpdateAdditionalInformation-v2026-01-01RequestNotFoundError", "type": "object" }, "UpdateAdditionalInformation-v2026-01-01RequestTooManyRequestsError": { "properties": { "errors": { "items": { "$ref": "#/components/schemas/EorWorkersContractsContractIdAdditionalInformationPatchResponsesContentApplicationJsonSchemaErrorsItems" }, "type": "array" } }, "required": [ "errors" ], "title": "UpdateAdditionalInformation-v2026-01-01RequestTooManyRequestsError", "type": "object" }, "UpdateAdditionalInformation-v2026-01-01RequestUnauthorizedError": { "properties": { "errors": { "items": { "$ref": "#/components/schemas/EorWorkersContractsContractIdAdditionalInformationPatchResponsesContentApplicationJsonSchemaErrorsItems" }, "type": "array" } }, "required": [ "errors" ], "title": "UpdateAdditionalInformation-v2026-01-01RequestUnauthorizedError", "type": "object" }, "UpdateAdjustment-v2026-01-01RequestBadRequestError": { "properties": { "errors": { "items": { "$ref": "#/components/schemas/AdjustmentsIdPatchResponsesContentApplicationJsonSchemaErrorsItems" }, "type": "array" } }, "title": "UpdateAdjustment-v2026-01-01RequestBadRequestError", "type": "object" }, "UpdateAnExistingHrisOrgStructure-v2026-01-01RequestBadRequestError": { "properties": { "errors": { "items": { "$ref": "#/components/schemas/HrisOrganizationStructuresHrisOrgStructureIdPatchResponsesContentApplicationJsonSchemaErrorsItems" }, "type": "array" } }, "title": "UpdateAnExistingHrisOrgStructure-v2026-01-01RequestBadRequestError", "type": "object" }, "UpdateAnExistingHrisOrgStructure-v2026-01-01RequestInternalServerError": { "properties": { "errors": { "items": { "$ref": "#/components/schemas/HrisOrganizationStructuresHrisOrgStructureIdPatchResponsesContentApplicationJsonSchemaErrorsItems" }, "type": "array" } }, "title": "UpdateAnExistingHrisOrgStructure-v2026-01-01RequestInternalServerError", "type": "object" }, "UpdateAnExistingHrisOrgStructureByExternalId-v2026-01-01RequestBadRequestError": { "properties": { "errors": { "items": { "$ref": "#/components/schemas/HrisOrganizationStructuresExternalExternalIdPatchResponsesContentApplicationJsonSchemaErrorsItems" }, "type": "array" } }, "required": [ "errors" ], "title": "UpdateAnExistingHrisOrgStructureByExternalId-v2026-01-01RequestBadRequestError", "type": "object" }, "UpdateAnExistingHrisOrgStructureByExternalId-v2026-01-01RequestNotFoundError": { "properties": { "errors": { "items": { "$ref": "#/components/schemas/HrisOrganizationStructuresExternalExternalIdPatchResponsesContentApplicationJsonSchemaErrorsItems" }, "type": "array" } }, "required": [ "errors" ], "title": "UpdateAnExistingHrisOrgStructureByExternalId-v2026-01-01RequestNotFoundError", "type": "object" }, "UpdateAnInvoiceAdjustment-v2026-01-01RequestBadRequestError": { "properties": { "errors": { "description": "Validation or business rule errors describing why the invoice adjustment could not be updated.", "items": { "$ref": "#/components/schemas/InvoiceAdjustmentsIdPatchResponsesContentApplicationJsonSchemaErrorsItems" }, "type": "array" } }, "required": [ "errors" ], "title": "UpdateAnInvoiceAdjustment-v2026-01-01RequestBadRequestError", "type": "object" }, "UpdateAnInvoiceAdjustment-v2026-01-01RequestForbiddenError": { "properties": { "errors": { "description": "Errors describing why the invoice adjustment could not be accessed.", "items": { "$ref": "#/components/schemas/InvoiceAdjustmentsIdPatchResponsesContentApplicationJsonSchemaErrorsItems" }, "type": "array" } }, "required": [ "errors" ], "title": "UpdateAnInvoiceAdjustment-v2026-01-01RequestForbiddenError", "type": "object" }, "UpdateAnInvoiceAdjustment-v2026-01-01RequestInternalServerError": { "properties": { "errors": { "description": "Generic upstream or internal errors emitted when the invoice adjustment cannot be updated.", "items": { "$ref": "#/components/schemas/InvoiceAdjustmentsIdPatchResponsesContentApplicationJsonSchemaErrorsItems" }, "type": "array" } }, "required": [ "errors" ], "title": "UpdateAnInvoiceAdjustment-v2026-01-01RequestInternalServerError", "type": "object" }, "UpdateAnInvoiceAdjustment-v2026-01-01RequestNotFoundError": { "properties": { "errors": { "description": "Errors describing why the invoice adjustment could not be found.", "items": { "$ref": "#/components/schemas/InvoiceAdjustmentsIdPatchResponsesContentApplicationJsonSchemaErrorsItems" }, "type": "array" } }, "required": [ "errors" ], "title": "UpdateAnInvoiceAdjustment-v2026-01-01RequestNotFoundError", "type": "object" }, "UpdateAsset-v2026-09-29RequestBadRequestError": { "properties": { "errors": { "items": { "$ref": "#/components/schemas/ItAssetsAssetIdPatchResponsesContentApplicationJsonSchemaErrorsItems" }, "type": "array" } }, "required": [ "errors" ], "title": "UpdateAsset-v2026-09-29RequestBadRequestError", "type": "object" }, "UpdateAsset-v2026-09-29RequestConflictError": { "properties": { "errors": { "items": { "$ref": "#/components/schemas/ItAssetsAssetIdPatchResponsesContentApplicationJsonSchemaErrorsItems" }, "type": "array" } }, "required": [ "errors" ], "title": "UpdateAsset-v2026-09-29RequestConflictError", "type": "object" }, "UpdateAsset-v2026-09-29RequestForbiddenError": { "properties": { "errors": { "items": { "$ref": "#/components/schemas/ItAssetsAssetIdPatchResponsesContentApplicationJsonSchemaErrorsItems" }, "type": "array" } }, "required": [ "errors" ], "title": "UpdateAsset-v2026-09-29RequestForbiddenError", "type": "object" }, "UpdateAsset-v2026-09-29RequestInternalServerError": { "properties": { "errors": { "items": { "$ref": "#/components/schemas/ItAssetsAssetIdPatchResponsesContentApplicationJsonSchemaErrorsItems" }, "type": "array" } }, "required": [ "errors" ], "title": "UpdateAsset-v2026-09-29RequestInternalServerError", "type": "object" }, "UpdateAsset-v2026-09-29RequestNotFoundError": { "properties": { "errors": { "items": { "$ref": "#/components/schemas/ItAssetsAssetIdPatchResponsesContentApplicationJsonSchemaErrorsItems" }, "type": "array" } }, "required": [ "errors" ], "title": "UpdateAsset-v2026-09-29RequestNotFoundError", "type": "object" }, "UpdateAsset-v2026-09-29RequestUnauthorizedError": { "properties": { "errors": { "items": { "$ref": "#/components/schemas/ItAssetsAssetIdPatchResponsesContentApplicationJsonSchemaErrorsItems" }, "type": "array" } }, "required": [ "errors" ], "title": "UpdateAsset-v2026-09-29RequestUnauthorizedError", "type": "object" }, "UpdateAssetLocation-v2026-09-15RequestBadRequestError": { "properties": { "errors": { "items": { "$ref": "#/components/schemas/ItAssetsAssetIdLocationPostResponsesContentApplicationJsonSchemaErrorsItems" }, "type": "array" } }, "required": [ "errors" ], "title": "UpdateAssetLocation-v2026-09-15RequestBadRequestError", "type": "object" }, "UpdateAssetLocation-v2026-09-15RequestConflictError": { "properties": { "errors": { "items": { "$ref": "#/components/schemas/ItAssetsAssetIdLocationPostResponsesContentApplicationJsonSchemaErrorsItems" }, "type": "array" } }, "required": [ "errors" ], "title": "UpdateAssetLocation-v2026-09-15RequestConflictError", "type": "object" }, "UpdateAssetLocation-v2026-09-15RequestForbiddenError": { "properties": { "errors": { "items": { "$ref": "#/components/schemas/ItAssetsAssetIdLocationPostResponsesContentApplicationJsonSchemaErrorsItems" }, "type": "array" } }, "required": [ "errors" ], "title": "UpdateAssetLocation-v2026-09-15RequestForbiddenError", "type": "object" }, "UpdateAssetLocation-v2026-09-15RequestInternalServerError": { "properties": { "errors": { "items": { "$ref": "#/components/schemas/ItAssetsAssetIdLocationPostResponsesContentApplicationJsonSchemaErrorsItems" }, "type": "array" } }, "required": [ "errors" ], "title": "UpdateAssetLocation-v2026-09-15RequestInternalServerError", "type": "object" }, "UpdateAssetLocation-v2026-09-15RequestNotFoundError": { "properties": { "errors": { "items": { "$ref": "#/components/schemas/ItAssetsAssetIdLocationPostResponsesContentApplicationJsonSchemaErrorsItems" }, "type": "array" } }, "required": [ "errors" ], "title": "UpdateAssetLocation-v2026-09-15RequestNotFoundError", "type": "object" }, "UpdateAssetLocation-v2026-09-15RequestUnauthorizedError": { "properties": { "errors": { "items": { "$ref": "#/components/schemas/ItAssetsAssetIdLocationPostResponsesContentApplicationJsonSchemaErrorsItems" }, "type": "array" } }, "required": [ "errors" ], "title": "UpdateAssetLocation-v2026-09-15RequestUnauthorizedError", "type": "object" }, "UpdateAtsApplication-v2026-09-17RequestBadRequestError": { "properties": { "errors": { "description": "List of error objects", "items": { "$ref": "#/components/schemas/AtsApplicationsApplicationIdPatchResponsesContentApplicationJsonSchemaErrorsItems" }, "type": "array" } }, "required": [ "errors" ], "title": "UpdateAtsApplication-v2026-09-17RequestBadRequestError", "type": "object" }, "UpdateAtsApplication-v2026-09-17RequestForbiddenError": { "properties": { "errors": { "description": "List of error objects", "items": { "$ref": "#/components/schemas/AtsApplicationsApplicationIdPatchResponsesContentApplicationJsonSchemaErrorsItems" }, "type": "array" } }, "required": [ "errors" ], "title": "UpdateAtsApplication-v2026-09-17RequestForbiddenError", "type": "object" }, "UpdateAtsApplication-v2026-09-17RequestInternalServerError": { "properties": { "errors": { "description": "List of error objects", "items": { "$ref": "#/components/schemas/AtsApplicationsApplicationIdPatchResponsesContentApplicationJsonSchemaErrorsItems" }, "type": "array" } }, "required": [ "errors" ], "title": "UpdateAtsApplication-v2026-09-17RequestInternalServerError", "type": "object" }, "UpdateAtsCandidate-v2026-09-16RequestBadRequestError": { "properties": { "errors": { "description": "List of error objects", "items": { "$ref": "#/components/schemas/AtsCandidatesCandidateIdPatchResponsesContentApplicationJsonSchemaErrorsItems" }, "type": "array" } }, "required": [ "errors" ], "title": "UpdateAtsCandidate-v2026-09-16RequestBadRequestError", "type": "object" }, "UpdateAtsCandidate-v2026-09-16RequestForbiddenError": { "properties": { "errors": { "description": "List of error objects", "items": { "$ref": "#/components/schemas/AtsCandidatesCandidateIdPatchResponsesContentApplicationJsonSchemaErrorsItems" }, "type": "array" } }, "required": [ "errors" ], "title": "UpdateAtsCandidate-v2026-09-16RequestForbiddenError", "type": "object" }, "UpdateAtsCandidate-v2026-09-16RequestInternalServerError": { "properties": { "errors": { "description": "List of error objects", "items": { "$ref": "#/components/schemas/AtsCandidatesCandidateIdPatchResponsesContentApplicationJsonSchemaErrorsItems" }, "type": "array" } }, "required": [ "errors" ], "title": "UpdateAtsCandidate-v2026-09-16RequestInternalServerError", "type": "object" }, "UpdateContractPlatformPaymentType-v2026-06-24RequestBadRequestError": { "properties": { "errors": { "items": { "$ref": "#/components/schemas/ContractsContractIdPlatformPaymentPatchResponsesContentApplicationJsonSchemaErrorsItems" }, "type": "array" } }, "title": "UpdateContractPlatformPaymentType-v2026-06-24RequestBadRequestError", "type": "object" }, "UpdateContractPlatformPaymentType-v2026-06-24RequestInternalServerError": { "properties": { "errors": { "items": { "$ref": "#/components/schemas/ContractsContractIdPlatformPaymentPatchResponsesContentApplicationJsonSchemaErrorsItems" }, "type": "array" } }, "title": "UpdateContractPlatformPaymentType-v2026-06-24RequestInternalServerError", "type": "object" }, "UpdateContractPlatformPaymentType-v2026-06-24RequestNotFoundError": { "properties": { "errors": { "items": { "$ref": "#/components/schemas/ContractsContractIdPlatformPaymentPatchResponsesContentApplicationJsonSchemaErrorsItems" }, "type": "array" } }, "title": "UpdateContractPlatformPaymentType-v2026-06-24RequestNotFoundError", "type": "object" }, "UpdateEmployeeInformationForEorContract-v2026-01-01RequestBadRequestError": { "properties": { "errors": { "items": { "$ref": "#/components/schemas/EorContractsContractIdEmployeeInformationPatchResponsesContentApplicationJsonSchemaErrorsItems" }, "type": "array" } }, "title": "UpdateEmployeeInformationForEorContract-v2026-01-01RequestBadRequestError", "type": "object" }, "UpdateEmployeeInformationForEorContract-v2026-01-01RequestInternalServerError": { "properties": { "errors": { "items": { "$ref": "#/components/schemas/EorContractsContractIdEmployeeInformationPatchResponsesContentApplicationJsonSchemaErrorsItems" }, "type": "array" } }, "title": "UpdateEmployeeInformationForEorContract-v2026-01-01RequestInternalServerError", "type": "object" }, "UpdateEmployeeInformationForEorContract-v2026-01-01RequestNotFoundError": { "properties": { "errors": { "items": { "$ref": "#/components/schemas/EorContractsContractIdEmployeeInformationPatchResponsesContentApplicationJsonSchemaErrorsItems" }, "type": "array" } }, "title": "UpdateEmployeeInformationForEorContract-v2026-01-01RequestNotFoundError", "type": "object" }, "UpdateEmploymentTypeForAContract-v2026-07-07RequestForbiddenError": { "properties": { "code": { "type": "string" }, "data": { "description": "Any type" }, "defined": { "type": "boolean" }, "message": { "default": "The caller is not authorized to act on this contract.", "type": "string" }, "status": { "format": "double", "type": "number" } }, "required": [ "code", "status", "defined", "message" ], "title": "UpdateEmploymentTypeForAContract-v2026-07-07RequestForbiddenError", "type": "object" }, "UpdateEndDateForAContract-v2026-10-12RequestForbiddenError": { "properties": { "code": { "type": "string" }, "data": { "description": "Any type" }, "defined": { "type": "boolean" }, "message": { "default": "The caller is not authorized to act on this contract.", "type": "string" }, "status": { "format": "double", "type": "number" } }, "required": [ "code", "status", "defined", "message" ], "title": "UpdateEndDateForAContract-v2026-10-12RequestForbiddenError", "type": "object" }, "UpdateEorContract-v2026-01-01RequestBadRequestError": { "properties": { "errors": { "items": { "$ref": "#/components/schemas/EorContractContractIdPatchResponsesContentApplicationJsonSchemaErrorsItems" }, "type": "array" } }, "required": [ "errors" ], "title": "UpdateEorContract-v2026-01-01RequestBadRequestError", "type": "object" }, "UpdateEorContract-v2026-01-01RequestForbiddenError": { "properties": { "errors": { "items": { "$ref": "#/components/schemas/EorContractContractIdPatchResponsesContentApplicationJsonSchemaErrorsItems" }, "type": "array" } }, "required": [ "errors" ], "title": "UpdateEorContract-v2026-01-01RequestForbiddenError", "type": "object" }, "UpdateEorContract-v2026-01-01RequestInternalServerError": { "properties": { "errors": { "items": { "$ref": "#/components/schemas/EorContractContractIdPatchResponsesContentApplicationJsonSchemaErrorsItems" }, "type": "array" } }, "required": [ "errors" ], "title": "UpdateEorContract-v2026-01-01RequestInternalServerError", "type": "object" }, "UpdateEorContract-v2026-01-01RequestNotFoundError": { "properties": { "errors": { "items": { "$ref": "#/components/schemas/EorContractContractIdPatchResponsesContentApplicationJsonSchemaErrorsItems" }, "type": "array" } }, "required": [ "errors" ], "title": "UpdateEorContract-v2026-01-01RequestNotFoundError", "type": "object" }, "UpdateGpWorkersAdditionalInformation-v2026-01-01RequestBadRequestError": { "properties": { "errors": { "items": { "$ref": "#/components/schemas/GpWorkersContractsContractIdAdditionalInformationPatchResponsesContentApplicationJsonSchemaErrorsItems" }, "type": "array" } }, "title": "UpdateGpWorkersAdditionalInformation-v2026-01-01RequestBadRequestError", "type": "object" }, "UpdateGpWorkersAdditionalInformation-v2026-01-01RequestForbiddenError": { "properties": { "errors": { "items": { "$ref": "#/components/schemas/GpWorkersContractsContractIdAdditionalInformationPatchResponsesContentApplicationJsonSchemaErrorsItems" }, "type": "array" } }, "title": "UpdateGpWorkersAdditionalInformation-v2026-01-01RequestForbiddenError", "type": "object" }, "UpdateGpWorkersAdditionalInformation-v2026-01-01RequestInternalServerError": { "properties": { "errors": { "items": { "$ref": "#/components/schemas/GpWorkersContractsContractIdAdditionalInformationPatchResponsesContentApplicationJsonSchemaErrorsItems" }, "type": "array" } }, "title": "UpdateGpWorkersAdditionalInformation-v2026-01-01RequestInternalServerError", "type": "object" }, "UpdateGpWorkersAdditionalInformation-v2026-01-01RequestNotFoundError": { "properties": { "errors": { "items": { "$ref": "#/components/schemas/GpWorkersContractsContractIdAdditionalInformationPatchResponsesContentApplicationJsonSchemaErrorsItems" }, "type": "array" } }, "title": "UpdateGpWorkersAdditionalInformation-v2026-01-01RequestNotFoundError", "type": "object" }, "UpdateGpWorkersAdditionalInformation-v2026-01-01RequestUnauthorizedError": { "properties": { "errors": { "items": { "$ref": "#/components/schemas/GpWorkersContractsContractIdAdditionalInformationPatchResponsesContentApplicationJsonSchemaErrorsItems" }, "type": "array" } }, "title": "UpdateGpWorkersAdditionalInformation-v2026-01-01RequestUnauthorizedError", "type": "object" }, "UpdateHourlyReportPreset-v2026-01-01RequestBadRequestError": { "properties": { "error": { "type": "string" } }, "title": "UpdateHourlyReportPreset-v2026-01-01RequestBadRequestError", "type": "object" }, "UpdateHourlyReportPreset-v2026-01-01RequestForbiddenError": { "properties": { "error": { "type": "string" } }, "title": "UpdateHourlyReportPreset-v2026-01-01RequestForbiddenError", "type": "object" }, "UpdateHourlyReportPreset-v2026-01-01RequestNotFoundError": { "properties": { "error": { "type": "string" } }, "title": "UpdateHourlyReportPreset-v2026-01-01RequestNotFoundError", "type": "object" }, "UpdateIcInvoicingTax-v2026-01-01RequestBadRequestError": { "properties": { "errors": { "description": "Validation or business rule errors describing why the IC invoicing tax could not be updated, such as an unsupported contract type, a missing active payment cycle, or the tax not currently existing on the contract.", "items": { "$ref": "#/components/schemas/ContractsContractIdIcInvoicingTaxesPatchResponsesContentApplicationJsonSchemaErrorsItems" }, "type": "array" } }, "required": [ "errors" ], "title": "UpdateIcInvoicingTax-v2026-01-01RequestBadRequestError", "type": "object" }, "UpdateIcInvoicingTax-v2026-01-01RequestInternalServerError": { "properties": { "errors": { "description": "Generic upstream or internal errors emitted when the IC invoicing tax cannot be updated.", "items": { "$ref": "#/components/schemas/ContractsContractIdIcInvoicingTaxesPatchResponsesContentApplicationJsonSchemaErrorsItems" }, "type": "array" } }, "required": [ "errors" ], "title": "UpdateIcInvoicingTax-v2026-01-01RequestInternalServerError", "type": "object" }, "UpdateIcInvoicingTax-v2026-01-01RequestNotFoundError": { "properties": { "errors": { "description": "Errors describing why the contract could not be found.", "items": { "$ref": "#/components/schemas/ContractsContractIdIcInvoicingTaxesPatchResponsesContentApplicationJsonSchemaErrorsItems" }, "type": "array" } }, "required": [ "errors" ], "title": "UpdateIcInvoicingTax-v2026-01-01RequestNotFoundError", "type": "object" }, "UpdateInvoiceAdjustmentById-v2026-01-01RequestBadRequestError": { "properties": { "errors": { "description": "Validation or business rule errors describing why the review decision could not be applied.", "items": { "$ref": "#/components/schemas/InvoiceAdjustmentsIdReviewsPostResponsesContentApplicationJsonSchemaErrorsItems" }, "type": "array" } }, "required": [ "errors" ], "title": "UpdateInvoiceAdjustmentById-v2026-01-01RequestBadRequestError", "type": "object" }, "UpdateInvoiceAdjustmentById-v2026-01-01RequestInternalServerError": { "properties": { "errors": { "description": "Generic upstream or internal errors emitted when the invoice adjustment review cannot be processed.", "items": { "$ref": "#/components/schemas/InvoiceAdjustmentsIdReviewsPostResponsesContentApplicationJsonSchemaErrorsItems" }, "type": "array" } }, "required": [ "errors" ], "title": "UpdateInvoiceAdjustmentById-v2026-01-01RequestInternalServerError", "type": "object" }, "UpdateInvoiceAdjustmentById-v2026-01-01RequestNotFoundError": { "properties": { "errors": { "description": "Errors describing why the invoice adjustment to review could not be found.", "items": { "$ref": "#/components/schemas/InvoiceAdjustmentsIdReviewsPostResponsesContentApplicationJsonSchemaErrorsItems" }, "type": "array" } }, "required": [ "errors" ], "title": "UpdateInvoiceAdjustmentById-v2026-01-01RequestNotFoundError", "type": "object" }, "UpdateLegalEntitySetting-v2026-09-02RequestBadRequestError": { "properties": { "message": { "description": "Error message explaining what went wrong.", "type": "string" } }, "title": "UpdateLegalEntitySetting-v2026-09-02RequestBadRequestError", "type": "object" }, "UpdateOrganizationSecureVaultFolder-v2026-08-05RequestBadRequestError": { "properties": { "errors": { "description": "List of errors that occurred while processing the request.", "items": { "$ref": "#/components/schemas/OrganizationsSecureVaultFoldersFolderIdPatchResponsesContentApplicationJsonSchemaErrorsItems" }, "type": "array" } }, "required": [ "errors" ], "title": "UpdateOrganizationSecureVaultFolder-v2026-08-05RequestBadRequestError", "type": "object" }, "UpdateOrganizationSecureVaultFolder-v2026-08-05RequestForbiddenError": { "properties": { "errors": { "description": "List of errors that occurred while processing the request.", "items": { "$ref": "#/components/schemas/OrganizationsSecureVaultFoldersFolderIdPatchResponsesContentApplicationJsonSchemaErrorsItems" }, "type": "array" } }, "required": [ "errors" ], "title": "UpdateOrganizationSecureVaultFolder-v2026-08-05RequestForbiddenError", "type": "object" }, "UpdateOrganizationSecureVaultFolder-v2026-08-05RequestNotFoundError": { "properties": { "errors": { "description": "List of errors that occurred while processing the request.", "items": { "$ref": "#/components/schemas/OrganizationsSecureVaultFoldersFolderIdPatchResponsesContentApplicationJsonSchemaErrorsItems" }, "type": "array" } }, "required": [ "errors" ], "title": "UpdateOrganizationSecureVaultFolder-v2026-08-05RequestNotFoundError", "type": "object" }, "UpdateOrganizationSecureVaultFolder-v2026-08-05RequestUnauthorizedError": { "properties": { "errors": { "description": "List of errors that occurred while processing the request.", "items": { "$ref": "#/components/schemas/OrganizationsSecureVaultFoldersFolderIdPatchResponsesContentApplicationJsonSchemaErrorsItems" }, "type": "array" } }, "required": [ "errors" ], "title": "UpdateOrganizationSecureVaultFolder-v2026-08-05RequestUnauthorizedError", "type": "object" }, "UpdateTaskById-v2026-01-01RequestBadRequestError": { "properties": { "errors": { "items": { "$ref": "#/components/schemas/TasksTaskIdPatchResponsesContentApplicationJsonSchemaErrorsItems" }, "type": "array" } }, "title": "UpdateTaskById-v2026-01-01RequestBadRequestError", "type": "object" }, "UpdateTaskById-v2026-01-01RequestInternalServerError": { "properties": { "errors": { "items": { "$ref": "#/components/schemas/TasksTaskIdPatchResponsesContentApplicationJsonSchemaErrorsItems" }, "type": "array" } }, "title": "UpdateTaskById-v2026-01-01RequestInternalServerError", "type": "object" }, "UpdateTimeOffRequest-v2026-01-01RequestBadRequestError": { "properties": { "errors": { "description": "List of errors describing what went wrong", "items": { "$ref": "#/components/schemas/TimeOffsTimeOffIdPatchResponsesContentApplicationJsonSchemaErrorsItems" }, "type": "array" }, "request": { "$ref": "#/components/schemas/TimeOffsTimeOffIdPatchResponsesContentApplicationJsonSchemaRequest", "description": "Request metadata" } }, "title": "UpdateTimeOffRequest-v2026-01-01RequestBadRequestError", "type": "object" }, "UpdateWebhookById-v2026-01-01RequestBadRequestError": { "properties": { "errors": { "description": "The list of errors that caused the request to fail.", "items": { "$ref": "#/components/schemas/WebhooksIdPatchResponsesContentApplicationJsonSchemaErrorsItems" }, "type": "array" } }, "required": [ "errors" ], "title": "UpdateWebhookById-v2026-01-01RequestBadRequestError", "type": "object" }, "UpdateWebhookById-v2026-01-01RequestForbiddenError": { "properties": { "errors": { "description": "The list of errors that caused the request to fail.", "items": { "$ref": "#/components/schemas/WebhooksIdPatchResponsesContentApplicationJsonSchemaErrorsItems" }, "type": "array" } }, "required": [ "errors" ], "title": "UpdateWebhookById-v2026-01-01RequestForbiddenError", "type": "object" }, "UpdateWebhookById-v2026-01-01RequestInternalServerError": { "properties": { "errors": { "description": "The list of errors that caused the request to fail.", "items": { "$ref": "#/components/schemas/WebhooksIdPatchResponsesContentApplicationJsonSchemaErrorsItems" }, "type": "array" } }, "required": [ "errors" ], "title": "UpdateWebhookById-v2026-01-01RequestInternalServerError", "type": "object" }, "UpdateWebhookById-v2026-01-01RequestMethodNotAllowedError": { "properties": { "errors": { "description": "The list of errors that caused the request to fail.", "items": { "$ref": "#/components/schemas/WebhooksIdPatchResponsesContentApplicationJsonSchemaErrorsItems" }, "type": "array" } }, "required": [ "errors" ], "title": "UpdateWebhookById-v2026-01-01RequestMethodNotAllowedError", "type": "object" }, "UpdateWebhookById-v2026-01-01RequestNotFoundError": { "properties": { "errors": { "description": "The list of errors that caused the request to fail.", "items": { "$ref": "#/components/schemas/WebhooksIdPatchResponsesContentApplicationJsonSchemaErrorsItems" }, "type": "array" } }, "required": [ "errors" ], "title": "UpdateWebhookById-v2026-01-01RequestNotFoundError", "type": "object" }, "UpdateWebhookById-v2026-01-01RequestTooManyRequestsError": { "properties": { "errors": { "description": "The list of errors that caused the request to fail.", "items": { "$ref": "#/components/schemas/WebhooksIdPatchResponsesContentApplicationJsonSchemaErrorsItems" }, "type": "array" } }, "required": [ "errors" ], "title": "UpdateWebhookById-v2026-01-01RequestTooManyRequestsError", "type": "object" }, "UpdateWebhookById-v2026-01-01RequestUnauthorizedError": { "properties": { "errors": { "description": "The list of errors that caused the request to fail.", "items": { "$ref": "#/components/schemas/WebhooksIdPatchResponsesContentApplicationJsonSchemaErrorsItems" }, "type": "array" } }, "required": [ "errors" ], "title": "UpdateWebhookById-v2026-01-01RequestUnauthorizedError", "type": "object" }, "UploadLegalEntityKybDocument-v2026-10-02RequestBadRequestError": { "properties": { "errors": { "items": { "$ref": "#/components/schemas/LegalEntitiesLegalEntityIdKybDocumentsPostResponsesContentApplicationJsonSchemaErrorsItems" }, "type": "array" } }, "required": [ "errors" ], "title": "UploadLegalEntityKybDocument-v2026-10-02RequestBadRequestError", "type": "object" }, "UploadLegalEntityKybDocument-v2026-10-02RequestForbiddenError": { "properties": { "errors": { "items": { "$ref": "#/components/schemas/LegalEntitiesLegalEntityIdKybDocumentsPostResponsesContentApplicationJsonSchemaErrorsItems" }, "type": "array" } }, "required": [ "errors" ], "title": "UploadLegalEntityKybDocument-v2026-10-02RequestForbiddenError", "type": "object" }, "UploadLegalEntityKybDocument-v2026-10-02RequestNotFoundError": { "properties": { "errors": { "items": { "$ref": "#/components/schemas/LegalEntitiesLegalEntityIdKybDocumentsPostResponsesContentApplicationJsonSchemaErrorsItems" }, "type": "array" } }, "required": [ "errors" ], "title": "UploadLegalEntityKybDocument-v2026-10-02RequestNotFoundError", "type": "object" }, "UploadLegalEntityKybDocument-v2026-10-02RequestTooManyRequestsError": { "properties": { "errors": { "items": { "$ref": "#/components/schemas/LegalEntitiesLegalEntityIdKybDocumentsPostResponsesContentApplicationJsonSchemaErrorsItems" }, "type": "array" } }, "required": [ "errors" ], "title": "UploadLegalEntityKybDocument-v2026-10-02RequestTooManyRequestsError", "type": "object" }, "UploadLegalEntityKybDocument-v2026-10-02RequestUnauthorizedError": { "properties": { "errors": { "items": { "$ref": "#/components/schemas/LegalEntitiesLegalEntityIdKybDocumentsPostResponsesContentApplicationJsonSchemaErrorsItems" }, "type": "array" } }, "required": [ "errors" ], "title": "UploadLegalEntityKybDocument-v2026-10-02RequestUnauthorizedError", "type": "object" }, "UploadLegalEntityKybDocument-v2026-10-02RequestUnprocessableEntityError": { "properties": { "errors": { "items": { "$ref": "#/components/schemas/LegalEntitiesLegalEntityIdKybDocumentsPostResponsesContentApplicationJsonSchemaErrorsItems" }, "type": "array" } }, "required": [ "errors" ], "title": "UploadLegalEntityKybDocument-v2026-10-02RequestUnprocessableEntityError", "type": "object" }, "UploadLegalEntityKybDocument-v2026-10-02RequestUnsupportedMediaTypeError": { "properties": { "errors": { "items": { "$ref": "#/components/schemas/LegalEntitiesLegalEntityIdKybDocumentsPostResponsesContentApplicationJsonSchemaErrorsItems" }, "type": "array" } }, "required": [ "errors" ], "title": "UploadLegalEntityKybDocument-v2026-10-02RequestUnsupportedMediaTypeError", "type": "object" }, "UploadLegalEntityKybEddDocument-v2026-10-14RequestBadRequestError": { "properties": { "errors": { "items": { "$ref": "#/components/schemas/LegalEntitiesLegalEntityIdKybEddDocumentsPostResponsesContentApplicationJsonSchemaErrorsItems" }, "type": "array" } }, "required": [ "errors" ], "title": "UploadLegalEntityKybEddDocument-v2026-10-14RequestBadRequestError", "type": "object" }, "UploadLegalEntityKybEddDocument-v2026-10-14RequestConflictError": { "properties": { "errors": { "items": { "$ref": "#/components/schemas/LegalEntitiesLegalEntityIdKybEddDocumentsPostResponsesContentApplicationJsonSchemaErrorsItems" }, "type": "array" } }, "required": [ "errors" ], "title": "UploadLegalEntityKybEddDocument-v2026-10-14RequestConflictError", "type": "object" }, "UploadLegalEntityKybEddDocument-v2026-10-14RequestForbiddenError": { "properties": { "errors": { "items": { "$ref": "#/components/schemas/LegalEntitiesLegalEntityIdKybEddDocumentsPostResponsesContentApplicationJsonSchemaErrorsItems" }, "type": "array" } }, "required": [ "errors" ], "title": "UploadLegalEntityKybEddDocument-v2026-10-14RequestForbiddenError", "type": "object" }, "UploadLegalEntityKybEddDocument-v2026-10-14RequestNotFoundError": { "properties": { "errors": { "items": { "$ref": "#/components/schemas/LegalEntitiesLegalEntityIdKybEddDocumentsPostResponsesContentApplicationJsonSchemaErrorsItems" }, "type": "array" } }, "required": [ "errors" ], "title": "UploadLegalEntityKybEddDocument-v2026-10-14RequestNotFoundError", "type": "object" }, "UploadLegalEntityKybEddDocument-v2026-10-14RequestServiceUnavailableError": { "properties": { "errors": { "items": { "$ref": "#/components/schemas/LegalEntitiesLegalEntityIdKybEddDocumentsPostResponsesContentApplicationJsonSchemaErrorsItems" }, "type": "array" } }, "required": [ "errors" ], "title": "UploadLegalEntityKybEddDocument-v2026-10-14RequestServiceUnavailableError", "type": "object" }, "UploadLegalEntityKybEddDocument-v2026-10-14RequestTooManyRequestsError": { "properties": { "errors": { "items": { "$ref": "#/components/schemas/LegalEntitiesLegalEntityIdKybEddDocumentsPostResponsesContentApplicationJsonSchemaErrorsItems" }, "type": "array" } }, "required": [ "errors" ], "title": "UploadLegalEntityKybEddDocument-v2026-10-14RequestTooManyRequestsError", "type": "object" }, "UploadLegalEntityKybEddDocument-v2026-10-14RequestUnauthorizedError": { "properties": { "errors": { "items": { "$ref": "#/components/schemas/LegalEntitiesLegalEntityIdKybEddDocumentsPostResponsesContentApplicationJsonSchemaErrorsItems" }, "type": "array" } }, "required": [ "errors" ], "title": "UploadLegalEntityKybEddDocument-v2026-10-14RequestUnauthorizedError", "type": "object" }, "UploadLegalEntityKybEddDocument-v2026-10-14RequestUnprocessableEntityError": { "properties": { "errors": { "items": { "$ref": "#/components/schemas/LegalEntitiesLegalEntityIdKybEddDocumentsPostResponsesContentApplicationJsonSchemaErrorsItems" }, "type": "array" } }, "required": [ "errors" ], "title": "UploadLegalEntityKybEddDocument-v2026-10-14RequestUnprocessableEntityError", "type": "object" }, "UploadLegalEntityKybEddDocument-v2026-10-14RequestUnsupportedMediaTypeError": { "properties": { "errors": { "items": { "$ref": "#/components/schemas/LegalEntitiesLegalEntityIdKybEddDocumentsPostResponsesContentApplicationJsonSchemaErrorsItems" }, "type": "array" } }, "required": [ "errors" ], "title": "UploadLegalEntityKybEddDocument-v2026-10-14RequestUnsupportedMediaTypeError", "type": "object" }, "UploadOrganizationSecureVaultFiles-v2026-08-05RequestBadRequestError": { "properties": { "errors": { "description": "List of errors that occurred while processing the request.", "items": { "$ref": "#/components/schemas/OrganizationsSecureVaultFilesPostResponsesContentApplicationJsonSchemaErrorsItems" }, "type": "array" } }, "required": [ "errors" ], "title": "UploadOrganizationSecureVaultFiles-v2026-08-05RequestBadRequestError", "type": "object" }, "UploadOrganizationSecureVaultFiles-v2026-08-05RequestForbiddenError": { "properties": { "errors": { "description": "List of errors that occurred while processing the request.", "items": { "$ref": "#/components/schemas/OrganizationsSecureVaultFilesPostResponsesContentApplicationJsonSchemaErrorsItems" }, "type": "array" } }, "required": [ "errors" ], "title": "UploadOrganizationSecureVaultFiles-v2026-08-05RequestForbiddenError", "type": "object" }, "UploadOrganizationSecureVaultFiles-v2026-08-05RequestNotFoundError": { "properties": { "errors": { "description": "List of errors that occurred while processing the request.", "items": { "$ref": "#/components/schemas/OrganizationsSecureVaultFilesPostResponsesContentApplicationJsonSchemaErrorsItems" }, "type": "array" } }, "required": [ "errors" ], "title": "UploadOrganizationSecureVaultFiles-v2026-08-05RequestNotFoundError", "type": "object" }, "UploadOrganizationSecureVaultFiles-v2026-08-05RequestUnauthorizedError": { "properties": { "errors": { "description": "List of errors that occurred while processing the request.", "items": { "$ref": "#/components/schemas/OrganizationsSecureVaultFilesPostResponsesContentApplicationJsonSchemaErrorsItems" }, "type": "array" } }, "required": [ "errors" ], "title": "UploadOrganizationSecureVaultFiles-v2026-08-05RequestUnauthorizedError", "type": "object" }, "UploadOrganizationSecureVaultFiles-v2026-08-05RequestUnprocessableEntityError": { "properties": { "errors": { "items": { "$ref": "#/components/schemas/OrganizationsSecureVaultFilesPostResponsesContentApplicationJsonSchemaErrorsItems" }, "type": "array" } }, "required": [ "errors" ], "title": "UploadOrganizationSecureVaultFiles-v2026-08-05RequestUnprocessableEntityError", "type": "object" }, "UploadOrganizationSecureVaultFilesToFolder-v2026-08-05RequestBadRequestError": { "properties": { "errors": { "description": "List of errors that occurred while processing the request.", "items": { "$ref": "#/components/schemas/OrganizationsSecureVaultFoldersFolderIdFilesPostResponsesContentApplicationJsonSchemaErrorsItems" }, "type": "array" } }, "required": [ "errors" ], "title": "UploadOrganizationSecureVaultFilesToFolder-v2026-08-05RequestBadRequestError", "type": "object" }, "UploadOrganizationSecureVaultFilesToFolder-v2026-08-05RequestForbiddenError": { "properties": { "errors": { "description": "List of errors that occurred while processing the request.", "items": { "$ref": "#/components/schemas/OrganizationsSecureVaultFoldersFolderIdFilesPostResponsesContentApplicationJsonSchemaErrorsItems" }, "type": "array" } }, "required": [ "errors" ], "title": "UploadOrganizationSecureVaultFilesToFolder-v2026-08-05RequestForbiddenError", "type": "object" }, "UploadOrganizationSecureVaultFilesToFolder-v2026-08-05RequestNotFoundError": { "properties": { "errors": { "description": "List of errors that occurred while processing the request.", "items": { "$ref": "#/components/schemas/OrganizationsSecureVaultFoldersFolderIdFilesPostResponsesContentApplicationJsonSchemaErrorsItems" }, "type": "array" } }, "required": [ "errors" ], "title": "UploadOrganizationSecureVaultFilesToFolder-v2026-08-05RequestNotFoundError", "type": "object" }, "UploadOrganizationSecureVaultFilesToFolder-v2026-08-05RequestUnauthorizedError": { "properties": { "errors": { "description": "List of errors that occurred while processing the request.", "items": { "$ref": "#/components/schemas/OrganizationsSecureVaultFoldersFolderIdFilesPostResponsesContentApplicationJsonSchemaErrorsItems" }, "type": "array" } }, "required": [ "errors" ], "title": "UploadOrganizationSecureVaultFilesToFolder-v2026-08-05RequestUnauthorizedError", "type": "object" }, "UploadOrganizationSecureVaultFilesToFolder-v2026-08-05RequestUnprocessableEntityError": { "properties": { "errors": { "items": { "$ref": "#/components/schemas/OrganizationsSecureVaultFoldersFolderIdFilesPostResponsesContentApplicationJsonSchemaErrorsItems" }, "type": "array" } }, "required": [ "errors" ], "title": "UploadOrganizationSecureVaultFilesToFolder-v2026-08-05RequestUnprocessableEntityError", "type": "object" }, "UploadVendorBillAttachment-v2026-01-01RequestBadRequestError": { "properties": { "errors": { "items": { "$ref": "#/components/schemas/AccountsPayableVendorBillsVendorBillIdAttachmentsPostResponsesContentApplicationJsonSchemaErrorsItems" }, "type": "array" } }, "required": [ "errors" ], "title": "UploadVendorBillAttachment-v2026-01-01RequestBadRequestError", "type": "object" }, "UploadVendorBillAttachment-v2026-01-01RequestInternalServerError": { "properties": { "errors": { "items": { "$ref": "#/components/schemas/AccountsPayableVendorBillsVendorBillIdAttachmentsPostResponsesContentApplicationJsonSchemaErrorsItems" }, "type": "array" } }, "required": [ "errors" ], "title": "UploadVendorBillAttachment-v2026-01-01RequestInternalServerError", "type": "object" }, "UploadVendorBillAttachment-v2026-01-01RequestNotFoundError": { "properties": { "errors": { "items": { "$ref": "#/components/schemas/AccountsPayableVendorBillsVendorBillIdAttachmentsPostResponsesContentApplicationJsonSchemaErrorsItems" }, "type": "array" } }, "required": [ "errors" ], "title": "UploadVendorBillAttachment-v2026-01-01RequestNotFoundError", "type": "object" }, "UsersGetParametersFilter": { "oneOf": [ { "type": "string" }, { "items": { "type": "string" }, "type": "array" } ], "title": "UsersGetParametersFilter" }, "UsersGetResponsesContentApplicationJsonSchemaError": { "properties": { "code": { "description": "Error code identifying the type of error.", "type": "string" }, "details": { "description": "Additional details about the error.", "type": [ "string", "null" ] }, "message": { "description": "Error message describing what went wrong.", "type": "string" } }, "required": [ "code", "message" ], "title": "UsersGetResponsesContentApplicationJsonSchemaError", "type": "object" }, "UsersGetResponsesContentApplicationJsonSchemaResourcesItems": { "properties": { "active": { "default": false, "type": "boolean" }, "addresses": { "items": { "$ref": "#/components/schemas/UsersGetResponsesContentApplicationJsonSchemaResourcesItemsAddressesItems" }, "type": "array" }, "emails": { "items": { "$ref": "#/components/schemas/UsersGetResponsesContentApplicationJsonSchemaResourcesItemsEmailsItems" }, "type": "array" }, "id": { "type": "string" }, "meta": { "$ref": "#/components/schemas/UsersGetResponsesContentApplicationJsonSchemaResourcesItemsMeta" }, "name": { "$ref": "#/components/schemas/UsersGetResponsesContentApplicationJsonSchemaResourcesItemsName" }, "schemas": { "items": { "$ref": "#/components/schemas/UsersGetResponsesContentApplicationJsonSchemaResourcesItemsSchemasItems" }, "type": "array" }, "title": { "type": "string" }, "urn:ietf:params:scim:schemas:extension:2.0:User": { "$ref": "#/components/schemas/UsersGetResponsesContentApplicationJsonSchemaResourcesItemsUrnIetfParamsScimSchemasExtension20User" }, "urn:ietf:params:scim:schemas:extension:enterprise:2.0:User": { "$ref": "#/components/schemas/UsersGetResponsesContentApplicationJsonSchemaResourcesItemsUrnIetfParamsScimSchemasExtensionEnterprise20User" }, "userName": { "type": "string" }, "userType": { "type": "string" } }, "required": [ "meta", "name", "emails", "schemas", "userName" ], "title": "UsersGetResponsesContentApplicationJsonSchemaResourcesItems", "type": "object" }, "UsersGetResponsesContentApplicationJsonSchemaResourcesItemsAddressesItems": { "properties": { "country": { "maxLength": 2, "minLength": 2, "pattern": "^[A-Z]{2}$", "type": [ "string", "null" ] }, "lineTwo": { "type": "string" }, "locality": { "type": "string" }, "postalCode": { "type": "string" }, "region": { "type": "string" }, "streetAddress": { "type": "string" }, "type": { "type": "string" } }, "title": "UsersGetResponsesContentApplicationJsonSchemaResourcesItemsAddressesItems", "type": "object" }, "UsersGetResponsesContentApplicationJsonSchemaResourcesItemsEmailsItems": { "properties": { "primary": { "default": false, "type": "boolean" }, "type": { "$ref": "#/components/schemas/UsersGetResponsesContentApplicationJsonSchemaResourcesItemsEmailsItemsType" }, "value": { "type": "string" } }, "required": [ "type", "value" ], "title": "UsersGetResponsesContentApplicationJsonSchemaResourcesItemsEmailsItems", "type": "object" }, "UsersGetResponsesContentApplicationJsonSchemaResourcesItemsEmailsItemsType": { "enum": [ "home", "work", "other" ], "title": "UsersGetResponsesContentApplicationJsonSchemaResourcesItemsEmailsItemsType", "type": "string" }, "UsersGetResponsesContentApplicationJsonSchemaResourcesItemsMeta": { "properties": { "created": { "type": "string" }, "lastModified": { "type": "string" }, "location": { "type": "string" }, "resourceType": { "$ref": "#/components/schemas/UsersGetResponsesContentApplicationJsonSchemaResourcesItemsMetaResourceType" } }, "title": "UsersGetResponsesContentApplicationJsonSchemaResourcesItemsMeta", "type": "object" }, "UsersGetResponsesContentApplicationJsonSchemaResourcesItemsMetaResourceType": { "enum": [ "User", "Group" ], "title": "UsersGetResponsesContentApplicationJsonSchemaResourcesItemsMetaResourceType", "type": "string" }, "UsersGetResponsesContentApplicationJsonSchemaResourcesItemsName": { "properties": { "familyName": { "type": [ "string", "null" ] }, "givenName": { "type": [ "string", "null" ] } }, "required": [ "givenName", "familyName" ], "title": "UsersGetResponsesContentApplicationJsonSchemaResourcesItemsName", "type": "object" }, "UsersGetResponsesContentApplicationJsonSchemaResourcesItemsSchemasItems": { "enum": [ "urn:ietf:params:scim:schemas:core:2.0:User" ], "title": "UsersGetResponsesContentApplicationJsonSchemaResourcesItemsSchemasItems", "type": "string" }, "UsersGetResponsesContentApplicationJsonSchemaResourcesItemsUrnIetfParamsScimSchemasExtension20User": { "properties": { "birthday": { "type": "string" }, "country": { "type": [ "string", "null" ] }, "customFields": { "items": { "$ref": "#/components/schemas/UsersGetResponsesContentApplicationJsonSchemaResourcesItemsUrnIetfParamsScimSchemasExtension20UserCustomFieldsItems" }, "type": [ "array", "null" ] }, "departmentCustomFields": { "additionalProperties": { "type": "string" }, "description": "Org-structure custom fields resolved for the department node, keyed by normalized field name. Only present when the department custom fields feature flag is enabled for the organization.", "type": [ "object", "null" ] }, "departmentExternalId": { "type": [ "string", "null" ] }, "departmentExternalIdHierarchy": { "type": [ "string", "null" ] }, "departmentHierarchy": { "type": [ "string", "null" ] }, "employments": { "items": { "$ref": "#/components/schemas/UsersGetResponsesContentApplicationJsonSchemaResourcesItemsUrnIetfParamsScimSchemasExtension20UserEmploymentsItems" }, "type": [ "array", "null" ] }, "endDate": { "type": "string" }, "hiringStatus": { "type": "string" }, "isManager": { "default": false, "type": "boolean" }, "jobProfile": { "description": "Active job profile of the worker from job architecture. Present only when job profiles are enabled for the organization and job architecture is set up; null when the worker has no active job profile or the token lacks the job_profile.view permission.", "oneOf": [ { "$ref": "#/components/schemas/UsersGetResponsesContentApplicationJsonSchemaResourcesItemsUrnIetfParamsScimSchemasExtension20UserJobProfile" }, { "type": "null" } ] }, "organizationalStructures": { "items": { "$ref": "#/components/schemas/UsersGetResponsesContentApplicationJsonSchemaResourcesItemsUrnIetfParamsScimSchemasExtension20UserOrganizationalStructuresItems" }, "type": "array" }, "preferredFirstName": { "type": "string" }, "preferredLastName": { "type": "string" }, "preferredName": { "type": "string" }, "startDate": { "type": [ "string", "null" ] }, "state": { "type": [ "string", "null" ] }, "workLocation": { "description": "The work location label assigned to the worker's HRIS profile", "type": [ "string", "null" ] }, "workerId": { "type": [ "string", "null" ] }, "workerTerminationLastDateOfWork": { "type": [ "string", "null" ] } }, "title": "UsersGetResponsesContentApplicationJsonSchemaResourcesItemsUrnIetfParamsScimSchemasExtension20User", "type": "object" }, "UsersGetResponsesContentApplicationJsonSchemaResourcesItemsUrnIetfParamsScimSchemasExtension20UserCustomFieldsItems": { "properties": { "id": { "type": "string" }, "name": { "type": [ "string", "null" ] }, "value": { "type": [ "string", "null" ] } }, "title": "UsersGetResponsesContentApplicationJsonSchemaResourcesItemsUrnIetfParamsScimSchemasExtension20UserCustomFieldsItems", "type": "object" }, "UsersGetResponsesContentApplicationJsonSchemaResourcesItemsUrnIetfParamsScimSchemasExtension20UserEmploymentsItems": { "properties": { "active": { "default": false, "type": "boolean" }, "contractId": { "type": "string" }, "contractType": { "type": [ "string", "null" ] }, "country": { "type": [ "string", "null" ] }, "customFields": { "description": "Contract-level custom fields associated with the employment", "items": { "$ref": "#/components/schemas/UsersGetResponsesContentApplicationJsonSchemaResourcesItemsUrnIetfParamsScimSchemasExtension20UserEmploymentsItemsCustomFieldsItems" }, "type": "array" }, "employeeNumber": { "type": [ "string", "null" ] }, "startDate": { "type": [ "string", "null" ] }, "state": { "type": [ "string", "null" ] }, "team": { "$ref": "#/components/schemas/UsersGetResponsesContentApplicationJsonSchemaResourcesItemsUrnIetfParamsScimSchemasExtension20UserEmploymentsItemsTeam" }, "title": { "type": [ "string", "null" ] } }, "title": "UsersGetResponsesContentApplicationJsonSchemaResourcesItemsUrnIetfParamsScimSchemasExtension20UserEmploymentsItems", "type": "object" }, "UsersGetResponsesContentApplicationJsonSchemaResourcesItemsUrnIetfParamsScimSchemasExtension20UserEmploymentsItemsCustomFieldsItems": { "properties": { "data": { "description": "The custom field value payload. Structure varies by field type: Text/Number/Date have {value}, Percentage has {value, text}, Currency has {amount, currency}, List has {option}, Multiselect has {options}.", "oneOf": [ { "$ref": "#/components/schemas/UsersGetResponsesContentApplicationJsonSchemaResourcesItemsUrnIetfParamsScimSchemasExtension20UserEmploymentsItemsCustomFieldsItemsData" }, { "type": "null" } ] }, "id": { "type": "string" }, "name": { "type": "string" }, "type": { "type": "string" } }, "title": "UsersGetResponsesContentApplicationJsonSchemaResourcesItemsUrnIetfParamsScimSchemasExtension20UserEmploymentsItemsCustomFieldsItems", "type": "object" }, "UsersGetResponsesContentApplicationJsonSchemaResourcesItemsUrnIetfParamsScimSchemasExtension20UserEmploymentsItemsCustomFieldsItemsData": { "description": "The custom field value payload. Structure varies by field type: Text/Number/Date have {value}, Percentage has {value, text}, Currency has {amount, currency}, List has {option}, Multiselect has {options}.", "properties": {}, "title": "UsersGetResponsesContentApplicationJsonSchemaResourcesItemsUrnIetfParamsScimSchemasExtension20UserEmploymentsItemsCustomFieldsItemsData", "type": "object" }, "UsersGetResponsesContentApplicationJsonSchemaResourcesItemsUrnIetfParamsScimSchemasExtension20UserEmploymentsItemsTeam": { "properties": { "name": { "type": [ "string", "null" ] } }, "title": "UsersGetResponsesContentApplicationJsonSchemaResourcesItemsUrnIetfParamsScimSchemasExtension20UserEmploymentsItemsTeam", "type": "object" }, "UsersGetResponsesContentApplicationJsonSchemaResourcesItemsUrnIetfParamsScimSchemasExtension20UserJobProfile": { "description": "Active job profile of the worker from job architecture. Present only when job profiles are enabled for the organization and job architecture is set up; null when the worker has no active job profile or the token lacks the job_profile.view permission.", "properties": { "id": { "description": "Job profile id.", "type": "string" }, "jobFamily": { "description": "Job family of the job profile.", "oneOf": [ { "$ref": "#/components/schemas/UsersGetResponsesContentApplicationJsonSchemaResourcesItemsUrnIetfParamsScimSchemasExtension20UserJobProfileJobFamily" }, { "type": "null" } ] }, "jobFamilyGroup": { "description": "Job family group of the job family.", "oneOf": [ { "$ref": "#/components/schemas/UsersGetResponsesContentApplicationJsonSchemaResourcesItemsUrnIetfParamsScimSchemasExtension20UserJobProfileJobFamilyGroup" }, { "type": "null" } ] }, "level": { "description": "Job profile level.", "type": [ "integer", "null" ] }, "name": { "description": "Job profile name.", "type": "string" }, "track": { "description": "Job profile track, as configured in job architecture (free text).", "type": [ "string", "null" ] } }, "title": "UsersGetResponsesContentApplicationJsonSchemaResourcesItemsUrnIetfParamsScimSchemasExtension20UserJobProfile", "type": "object" }, "UsersGetResponsesContentApplicationJsonSchemaResourcesItemsUrnIetfParamsScimSchemasExtension20UserJobProfileJobFamily": { "description": "Job family of the job profile.", "properties": { "id": { "description": "Job family id.", "type": "string" }, "name": { "description": "Job family name.", "type": "string" } }, "title": "UsersGetResponsesContentApplicationJsonSchemaResourcesItemsUrnIetfParamsScimSchemasExtension20UserJobProfileJobFamily", "type": "object" }, "UsersGetResponsesContentApplicationJsonSchemaResourcesItemsUrnIetfParamsScimSchemasExtension20UserJobProfileJobFamilyGroup": { "description": "Job family group of the job family.", "properties": { "id": { "description": "Job family group id.", "type": "string" }, "name": { "description": "Job family group name.", "type": "string" } }, "title": "UsersGetResponsesContentApplicationJsonSchemaResourcesItemsUrnIetfParamsScimSchemasExtension20UserJobProfileJobFamilyGroup", "type": "object" }, "UsersGetResponsesContentApplicationJsonSchemaResourcesItemsUrnIetfParamsScimSchemasExtension20UserOrganizationalStructuresItems": { "properties": { "externalId": { "type": [ "string", "null" ] }, "externalIdHierarchy": { "type": [ "string", "null" ] }, "name": { "type": "string" }, "nameHierarchy": { "type": "string" }, "structureId": { "type": "string" }, "structureName": { "type": "string" } }, "title": "UsersGetResponsesContentApplicationJsonSchemaResourcesItemsUrnIetfParamsScimSchemasExtension20UserOrganizationalStructuresItems", "type": "object" }, "UsersGetResponsesContentApplicationJsonSchemaResourcesItemsUrnIetfParamsScimSchemasExtensionEnterprise20User": { "properties": { "costCenter": { "type": "string" }, "customFields": { "additionalProperties": { "type": "string" }, "type": "object" }, "department": { "type": "string" }, "manager": { "$ref": "#/components/schemas/UsersGetResponsesContentApplicationJsonSchemaResourcesItemsUrnIetfParamsScimSchemasExtensionEnterprise20UserManager" }, "organization": { "type": "string" }, "preferredFirstName": { "type": "string" }, "preferredLastName": { "type": "string" } }, "title": "UsersGetResponsesContentApplicationJsonSchemaResourcesItemsUrnIetfParamsScimSchemasExtensionEnterprise20User", "type": "object" }, "UsersGetResponsesContentApplicationJsonSchemaResourcesItemsUrnIetfParamsScimSchemasExtensionEnterprise20UserManager": { "properties": { "displayName": { "type": "string" }, "email": { "type": "string" }, "value": { "type": "string" } }, "required": [ "value" ], "title": "UsersGetResponsesContentApplicationJsonSchemaResourcesItemsUrnIetfParamsScimSchemasExtensionEnterprise20UserManager", "type": "object" }, "UsersGetResponsesContentApplicationJsonSchemaSchemasItems": { "enum": [ "urn:ietf:params:scim:api:messages:2.0:ListResponse" ], "title": "UsersGetResponsesContentApplicationJsonSchemaSchemasItems", "type": "string" }, "UsersHrisProfileIdGetResponsesContentApplicationJsonSchemaAddressesItems": { "properties": { "country": { "maxLength": 2, "minLength": 2, "pattern": "^[A-Z]{2}$", "type": [ "string", "null" ] }, "locality": { "type": "string" }, "postalCode": { "type": "string" }, "region": { "type": "string" }, "streetAddress": { "type": "string" }, "type": { "type": "string" } }, "title": "UsersHrisProfileIdGetResponsesContentApplicationJsonSchemaAddressesItems", "type": "object" }, "UsersHrisProfileIdGetResponsesContentApplicationJsonSchemaEmailsItems": { "properties": { "primary": { "default": false, "type": "boolean" }, "type": { "$ref": "#/components/schemas/UsersHrisProfileIdGetResponsesContentApplicationJsonSchemaEmailsItemsType" }, "value": { "type": "string" } }, "required": [ "type", "value" ], "title": "UsersHrisProfileIdGetResponsesContentApplicationJsonSchemaEmailsItems", "type": "object" }, "UsersHrisProfileIdGetResponsesContentApplicationJsonSchemaEmailsItemsType": { "enum": [ "home", "work", "other" ], "title": "UsersHrisProfileIdGetResponsesContentApplicationJsonSchemaEmailsItemsType", "type": "string" }, "UsersHrisProfileIdGetResponsesContentApplicationJsonSchemaErrorsItems": { "properties": { "context": { "$ref": "#/components/schemas/UsersHrisProfileIdGetResponsesContentApplicationJsonSchemaErrorsItemsContext" }, "key": { "type": "string" }, "message": { "type": "string" }, "path": { "items": { "type": "string" }, "type": "array" }, "type": { "type": "string" } }, "title": "UsersHrisProfileIdGetResponsesContentApplicationJsonSchemaErrorsItems", "type": "object" }, "UsersHrisProfileIdGetResponsesContentApplicationJsonSchemaErrorsItemsContext": { "properties": {}, "title": "UsersHrisProfileIdGetResponsesContentApplicationJsonSchemaErrorsItemsContext", "type": "object" }, "UsersHrisProfileIdGetResponsesContentApplicationJsonSchemaMeta": { "properties": { "created": { "format": "date-time", "type": "string" }, "lastModified": { "format": "date-time", "type": "string" }, "location": { "type": "string" }, "resourceType": { "$ref": "#/components/schemas/UsersHrisProfileIdGetResponsesContentApplicationJsonSchemaMetaResourceType" } }, "title": "UsersHrisProfileIdGetResponsesContentApplicationJsonSchemaMeta", "type": "object" }, "UsersHrisProfileIdGetResponsesContentApplicationJsonSchemaMetaResourceType": { "enum": [ "User", "Group" ], "title": "UsersHrisProfileIdGetResponsesContentApplicationJsonSchemaMetaResourceType", "type": "string" }, "UsersHrisProfileIdGetResponsesContentApplicationJsonSchemaName": { "properties": { "familyName": { "type": "string" }, "givenName": { "type": "string" } }, "required": [ "givenName", "familyName" ], "title": "UsersHrisProfileIdGetResponsesContentApplicationJsonSchemaName", "type": "object" }, "UsersHrisProfileIdGetResponsesContentApplicationJsonSchemaPhoneNumbersItems": { "properties": { "primary": { "default": false, "type": "boolean" }, "type": { "$ref": "#/components/schemas/UsersHrisProfileIdGetResponsesContentApplicationJsonSchemaPhoneNumbersItemsType" }, "value": { "type": "string" } }, "required": [ "type", "value", "primary" ], "title": "UsersHrisProfileIdGetResponsesContentApplicationJsonSchemaPhoneNumbersItems", "type": "object" }, "UsersHrisProfileIdGetResponsesContentApplicationJsonSchemaPhoneNumbersItemsType": { "enum": [ "home", "work", "other" ], "title": "UsersHrisProfileIdGetResponsesContentApplicationJsonSchemaPhoneNumbersItemsType", "type": "string" }, "UsersHrisProfileIdGetResponsesContentApplicationJsonSchemaRequest": { "properties": { "api_req_id": { "type": "string" }, "docs": { "type": "string" }, "method": { "type": "string" }, "source": { "type": "string" }, "status": { "type": "integer" }, "url": { "type": "string" } }, "title": "UsersHrisProfileIdGetResponsesContentApplicationJsonSchemaRequest", "type": "object" }, "UsersHrisProfileIdGetResponsesContentApplicationJsonSchemaSchemasItems": { "enum": [ "urn:ietf:params:scim:schemas:core:2.0:User" ], "title": "UsersHrisProfileIdGetResponsesContentApplicationJsonSchemaSchemasItems", "type": "string" }, "UsersHrisProfileIdGetResponsesContentApplicationJsonSchemaUrnIetfParamsScimSchemasExtension20User": { "properties": { "country": { "type": [ "string", "null" ] }, "customFields": { "items": { "$ref": "#/components/schemas/UsersHrisProfileIdGetResponsesContentApplicationJsonSchemaUrnIetfParamsScimSchemasExtension20UserCustomFieldsItems" }, "type": [ "array", "null" ] }, "customFieldsFlattened": { "additionalProperties": { "$ref": "#/components/schemas/UsersHrisProfileIdGetResponsesContentApplicationJsonSchemaUrnIetfParamsScimSchemasExtension20UserCustomFieldsFlattened" }, "description": "Custom fields keyed by field UUID. Only present when the scimFlattenedFields feature flag is enabled.", "type": [ "object", "null" ] }, "departmentCustomFields": { "additionalProperties": { "type": "string" }, "description": "Org-structure custom fields resolved for the department node, keyed by normalized field name. Only present when the department custom fields feature flag is enabled for the organization.", "type": [ "object", "null" ] }, "departmentExternalId": { "type": [ "string", "null" ] }, "departmentExternalIdHierarchy": { "type": [ "string", "null" ] }, "departmentHierarchy": { "type": [ "string", "null" ] }, "employments": { "items": { "$ref": "#/components/schemas/UsersHrisProfileIdGetResponsesContentApplicationJsonSchemaUrnIetfParamsScimSchemasExtension20UserEmploymentsItems" }, "type": [ "array", "null" ] }, "endDate": { "$ref": "#/components/schemas/UsersHrisProfileIdGetResponsesContentApplicationJsonSchemaUrnIetfParamsScimSchemasExtension20UserEndDate" }, "hiringStatus": { "type": "string" }, "isManager": { "default": false, "type": "boolean" }, "jobProfile": { "description": "Active job profile of the worker from job architecture. Present only when job profiles are enabled for the organization and job architecture is set up; null when the worker has no active job profile or the token lacks the job_profile.view permission.", "oneOf": [ { "$ref": "#/components/schemas/UsersHrisProfileIdGetResponsesContentApplicationJsonSchemaUrnIetfParamsScimSchemasExtension20UserJobProfile" }, { "type": "null" } ] }, "organizationalStructuresFlattened": { "additionalProperties": { "$ref": "#/components/schemas/UsersHrisProfileIdGetResponsesContentApplicationJsonSchemaUrnIetfParamsScimSchemasExtension20UserOrganizationalStructuresFlattened" }, "description": "Org structures keyed by structure UUID. Only present when the scimFlattenedFields feature flag is enabled.", "type": [ "object", "null" ] }, "startDate": { "format": "date", "type": [ "string", "null" ] }, "state": { "type": [ "string", "null" ] }, "workLocation": { "description": "The work location label assigned to the worker's HRIS profile", "type": [ "string", "null" ] } }, "title": "UsersHrisProfileIdGetResponsesContentApplicationJsonSchemaUrnIetfParamsScimSchemasExtension20User", "type": "object" }, "UsersHrisProfileIdGetResponsesContentApplicationJsonSchemaUrnIetfParamsScimSchemasExtension20UserCustomFieldsFlattened": { "properties": { "name": { "type": "string" }, "value": { "type": [ "string", "null" ] } }, "title": "UsersHrisProfileIdGetResponsesContentApplicationJsonSchemaUrnIetfParamsScimSchemasExtension20UserCustomFieldsFlattened", "type": "object" }, "UsersHrisProfileIdGetResponsesContentApplicationJsonSchemaUrnIetfParamsScimSchemasExtension20UserCustomFieldsItems": { "properties": { "id": { "type": "string" }, "name": { "type": [ "string", "null" ] }, "value": { "type": [ "string", "null" ] } }, "title": "UsersHrisProfileIdGetResponsesContentApplicationJsonSchemaUrnIetfParamsScimSchemasExtension20UserCustomFieldsItems", "type": "object" }, "UsersHrisProfileIdGetResponsesContentApplicationJsonSchemaUrnIetfParamsScimSchemasExtension20UserEmploymentsItems": { "properties": { "active": { "default": false, "type": "boolean" }, "contractId": { "type": "string" }, "contractType": { "type": [ "string", "null" ] }, "country": { "type": [ "string", "null" ] }, "customFields": { "description": "Contract-level custom fields associated with the employment", "items": { "$ref": "#/components/schemas/UsersHrisProfileIdGetResponsesContentApplicationJsonSchemaUrnIetfParamsScimSchemasExtension20UserEmploymentsItemsCustomFieldsItems" }, "type": "array" }, "startDate": { "type": [ "string", "null" ] }, "state": { "type": [ "string", "null" ] }, "team": { "$ref": "#/components/schemas/UsersHrisProfileIdGetResponsesContentApplicationJsonSchemaUrnIetfParamsScimSchemasExtension20UserEmploymentsItemsTeam" }, "title": { "type": [ "string", "null" ] } }, "title": "UsersHrisProfileIdGetResponsesContentApplicationJsonSchemaUrnIetfParamsScimSchemasExtension20UserEmploymentsItems", "type": "object" }, "UsersHrisProfileIdGetResponsesContentApplicationJsonSchemaUrnIetfParamsScimSchemasExtension20UserEmploymentsItemsCustomFieldsItems": { "properties": { "data": { "description": "The custom field value payload, structure varies by field type", "oneOf": [ { "$ref": "#/components/schemas/UsersHrisProfileIdGetResponsesContentApplicationJsonSchemaUrnIetfParamsScimSchemasExtension20UserEmploymentsItemsCustomFieldsItemsData" }, { "type": "null" } ] }, "id": { "type": "string" }, "name": { "type": "string" }, "type": { "type": "string" } }, "title": "UsersHrisProfileIdGetResponsesContentApplicationJsonSchemaUrnIetfParamsScimSchemasExtension20UserEmploymentsItemsCustomFieldsItems", "type": "object" }, "UsersHrisProfileIdGetResponsesContentApplicationJsonSchemaUrnIetfParamsScimSchemasExtension20UserEmploymentsItemsCustomFieldsItemsData": { "description": "The custom field value payload, structure varies by field type", "properties": {}, "title": "UsersHrisProfileIdGetResponsesContentApplicationJsonSchemaUrnIetfParamsScimSchemasExtension20UserEmploymentsItemsCustomFieldsItemsData", "type": "object" }, "UsersHrisProfileIdGetResponsesContentApplicationJsonSchemaUrnIetfParamsScimSchemasExtension20UserEmploymentsItemsTeam": { "properties": { "name": { "type": "string" } }, "title": "UsersHrisProfileIdGetResponsesContentApplicationJsonSchemaUrnIetfParamsScimSchemasExtension20UserEmploymentsItemsTeam", "type": "object" }, "UsersHrisProfileIdGetResponsesContentApplicationJsonSchemaUrnIetfParamsScimSchemasExtension20UserEndDate": { "oneOf": [ { "format": "date-time", "type": "string" }, { "$ref": "#/components/schemas/UsersHrisProfileIdGetResponsesContentApplicationJsonSchemaUrnIetfParamsScimSchemasExtension20UserEndDate1" } ], "title": "UsersHrisProfileIdGetResponsesContentApplicationJsonSchemaUrnIetfParamsScimSchemasExtension20UserEndDate" }, "UsersHrisProfileIdGetResponsesContentApplicationJsonSchemaUrnIetfParamsScimSchemasExtension20UserEndDate1": { "enum": [ "" ], "title": "UsersHrisProfileIdGetResponsesContentApplicationJsonSchemaUrnIetfParamsScimSchemasExtension20UserEndDate1", "type": "string" }, "UsersHrisProfileIdGetResponsesContentApplicationJsonSchemaUrnIetfParamsScimSchemasExtension20UserJobProfile": { "description": "Active job profile of the worker from job architecture. Present only when job profiles are enabled for the organization and job architecture is set up; null when the worker has no active job profile or the token lacks the job_profile.view permission.", "properties": { "id": { "description": "Job profile id.", "type": "string" }, "jobFamily": { "description": "Job family of the job profile.", "oneOf": [ { "$ref": "#/components/schemas/UsersHrisProfileIdGetResponsesContentApplicationJsonSchemaUrnIetfParamsScimSchemasExtension20UserJobProfileJobFamily" }, { "type": "null" } ] }, "jobFamilyGroup": { "description": "Job family group of the job family.", "oneOf": [ { "$ref": "#/components/schemas/UsersHrisProfileIdGetResponsesContentApplicationJsonSchemaUrnIetfParamsScimSchemasExtension20UserJobProfileJobFamilyGroup" }, { "type": "null" } ] }, "level": { "description": "Job profile level.", "type": [ "integer", "null" ] }, "name": { "description": "Job profile name.", "type": "string" }, "track": { "description": "Job profile track, as configured in job architecture (free text).", "type": [ "string", "null" ] } }, "title": "UsersHrisProfileIdGetResponsesContentApplicationJsonSchemaUrnIetfParamsScimSchemasExtension20UserJobProfile", "type": "object" }, "UsersHrisProfileIdGetResponsesContentApplicationJsonSchemaUrnIetfParamsScimSchemasExtension20UserJobProfileJobFamily": { "description": "Job family of the job profile.", "properties": { "id": { "description": "Job family id.", "type": "string" }, "name": { "description": "Job family name.", "type": "string" } }, "title": "UsersHrisProfileIdGetResponsesContentApplicationJsonSchemaUrnIetfParamsScimSchemasExtension20UserJobProfileJobFamily", "type": "object" }, "UsersHrisProfileIdGetResponsesContentApplicationJsonSchemaUrnIetfParamsScimSchemasExtension20UserJobProfileJobFamilyGroup": { "description": "Job family group of the job family.", "properties": { "id": { "description": "Job family group id.", "type": "string" }, "name": { "description": "Job family group name.", "type": "string" } }, "title": "UsersHrisProfileIdGetResponsesContentApplicationJsonSchemaUrnIetfParamsScimSchemasExtension20UserJobProfileJobFamilyGroup", "type": "object" }, "UsersHrisProfileIdGetResponsesContentApplicationJsonSchemaUrnIetfParamsScimSchemasExtension20UserOrganizationalStructuresFlattened": { "properties": { "externalIdHierarchies": { "items": { "type": "string" }, "type": "array" }, "externalIds": { "items": { "type": "string" }, "type": "array" }, "nameHierarchies": { "items": { "type": "string" }, "type": "array" }, "names": { "items": { "type": "string" }, "type": "array" }, "orgStructureName": { "type": "string" } }, "title": "UsersHrisProfileIdGetResponsesContentApplicationJsonSchemaUrnIetfParamsScimSchemasExtension20UserOrganizationalStructuresFlattened", "type": "object" }, "UsersHrisProfileIdGetResponsesContentApplicationJsonSchemaUrnIetfParamsScimSchemasExtensionEnterprise20User": { "properties": { "costCenter": { "type": "string" }, "department": { "type": "string" }, "manager": { "$ref": "#/components/schemas/UsersHrisProfileIdGetResponsesContentApplicationJsonSchemaUrnIetfParamsScimSchemasExtensionEnterprise20UserManager" }, "organization": { "type": "string" } }, "title": "UsersHrisProfileIdGetResponsesContentApplicationJsonSchemaUrnIetfParamsScimSchemasExtensionEnterprise20User", "type": "object" }, "UsersHrisProfileIdGetResponsesContentApplicationJsonSchemaUrnIetfParamsScimSchemasExtensionEnterprise20UserManager": { "properties": { "displayName": { "type": "string" }, "value": { "type": "string" } }, "required": [ "value" ], "title": "UsersHrisProfileIdGetResponsesContentApplicationJsonSchemaUrnIetfParamsScimSchemasExtensionEnterprise20UserManager", "type": "object" }, "Users_getUserById_Response_200": { "properties": { "active": { "default": false, "type": "boolean" }, "addresses": { "items": { "$ref": "#/components/schemas/UsersHrisProfileIdGetResponsesContentApplicationJsonSchemaAddressesItems" }, "type": "array" }, "emails": { "items": { "$ref": "#/components/schemas/UsersHrisProfileIdGetResponsesContentApplicationJsonSchemaEmailsItems" }, "type": "array" }, "id": { "type": "string" }, "meta": { "$ref": "#/components/schemas/UsersHrisProfileIdGetResponsesContentApplicationJsonSchemaMeta" }, "name": { "$ref": "#/components/schemas/UsersHrisProfileIdGetResponsesContentApplicationJsonSchemaName" }, "phoneNumbers": { "items": { "$ref": "#/components/schemas/UsersHrisProfileIdGetResponsesContentApplicationJsonSchemaPhoneNumbersItems" }, "type": "array" }, "schemas": { "items": { "$ref": "#/components/schemas/UsersHrisProfileIdGetResponsesContentApplicationJsonSchemaSchemasItems" }, "type": "array" }, "title": { "type": "string" }, "urn:ietf:params:scim:schemas:extension:2.0:User": { "$ref": "#/components/schemas/UsersHrisProfileIdGetResponsesContentApplicationJsonSchemaUrnIetfParamsScimSchemasExtension20User" }, "urn:ietf:params:scim:schemas:extension:enterprise:2.0:User": { "$ref": "#/components/schemas/UsersHrisProfileIdGetResponsesContentApplicationJsonSchemaUrnIetfParamsScimSchemasExtensionEnterprise20User" }, "userName": { "type": "string" }, "userType": { "type": "string" } }, "required": [ "meta", "name", "emails", "schemas", "userName", "phoneNumbers" ], "title": "Users_getUserById_Response_200", "type": "object" }, "Users_getUsers_Response_200": { "properties": { "Resources": { "items": { "$ref": "#/components/schemas/UsersGetResponsesContentApplicationJsonSchemaResourcesItems" }, "type": "array" }, "itemsPerPage": { "format": "int64", "type": "integer" }, "schemas": { "items": { "$ref": "#/components/schemas/UsersGetResponsesContentApplicationJsonSchemaSchemasItems" }, "type": "array" }, "startIndex": { "format": "int64", "type": "integer" }, "totalResults": { "format": "int64", "type": "integer" } }, "title": "Users_getUsers_Response_200", "type": "object" }, "V2TimeTrackingShiftRatesGetResponsesContentApplicationJsonSchemaDataItems": { "properties": { "created_at": { "description": "Date when the shift rate was created", "format": "date-time", "type": "string" }, "external_id": { "description": "ID specified by the client for uniquely identifying shift rate across organization", "type": "string" }, "name": { "description": "Name of the shift rate policy", "type": "string" }, "type": { "$ref": "#/components/schemas/V2TimeTrackingShiftRatesGetResponsesContentApplicationJsonSchemaDataItemsType", "description": "Type of the shift rate" }, "updated_at": { "description": "Date when the shift rate was last updated", "format": "date-time", "type": "string" }, "value": { "description": "The value of the shift rate (supports up to 2 decimal places)", "exclusiveMinimum": 0, "format": "double", "multipleOf": 0.01, "type": "number" } }, "required": [ "name", "created_at", "updated_at", "external_id" ], "title": "V2TimeTrackingShiftRatesGetResponsesContentApplicationJsonSchemaDataItems", "type": "object" }, "V2TimeTrackingShiftRatesGetResponsesContentApplicationJsonSchemaDataItemsType": { "description": "Type of the shift rate", "enum": [ "MULTIPLIER_PERCENTAGE", "PER_HOUR_FLAT_RATE", "PER_UNIT_FLAT_RATE" ], "title": "V2TimeTrackingShiftRatesGetResponsesContentApplicationJsonSchemaDataItemsType", "type": "string" }, "V2TimeTrackingShiftRatesGetResponsesContentApplicationJsonSchemaPage": { "properties": { "items_per_page": { "description": "Number of shift rate policies per page", "format": "double", "type": "number" }, "offset": { "description": "Offset for pagination", "format": "double", "type": "number" }, "total_rows": { "description": "Total number of shift rate policies", "format": "double", "type": "number" } }, "required": [ "offset", "total_rows", "items_per_page" ], "title": "V2TimeTrackingShiftRatesGetResponsesContentApplicationJsonSchemaPage", "type": "object" }, "V2TimeTrackingShiftRatesPostRequestBodyContentApplicationJsonSchemaData": { "properties": { "external_id": { "description": "ID specified by the client for uniquely identifying shift rate across organization", "maxLength": 48, "minLength": 8, "type": "string" }, "name": { "description": "Name of the shift rate policy", "maxLength": 3000, "minLength": 1, "type": "string" }, "type": { "$ref": "#/components/schemas/V2TimeTrackingShiftRatesPostRequestBodyContentApplicationJsonSchemaDataType", "description": "Type of the shift" }, "value": { "description": "The value of the shift rate (supports up to 2 decimal places)", "exclusiveMinimum": 0, "format": "double", "multipleOf": 0.01, "type": "number" } }, "required": [ "name", "external_id" ], "title": "V2TimeTrackingShiftRatesPostRequestBodyContentApplicationJsonSchemaData", "type": "object" }, "V2TimeTrackingShiftRatesPostRequestBodyContentApplicationJsonSchemaDataType": { "description": "Type of the shift", "enum": [ "MULTIPLIER_PERCENTAGE", "PER_HOUR_FLAT_RATE", "PER_UNIT_FLAT_RATE" ], "title": "V2TimeTrackingShiftRatesPostRequestBodyContentApplicationJsonSchemaDataType", "type": "string" }, "V2TimeTrackingShiftRatesPostResponsesContentApplicationJsonSchemaData": { "properties": { "created_at": { "description": "Date when the shift rate was created", "format": "date-time", "type": "string" }, "external_id": { "description": "ID specified by the client for uniquely identifying shift rate across organization", "type": "string" }, "name": { "description": "Name of the shift rate policy", "type": "string" }, "type": { "$ref": "#/components/schemas/V2TimeTrackingShiftRatesPostResponsesContentApplicationJsonSchemaDataType", "description": "Type of the shift rate" }, "updated_at": { "description": "Date when the shift rate was last updated", "format": "date-time", "type": "string" }, "value": { "description": "The value of the shift rate (supports up to 2 decimal places)", "exclusiveMinimum": 0, "format": "double", "multipleOf": 0.01, "type": "number" } }, "required": [ "name", "created_at", "updated_at", "external_id" ], "title": "V2TimeTrackingShiftRatesPostResponsesContentApplicationJsonSchemaData", "type": "object" }, "V2TimeTrackingShiftRatesPostResponsesContentApplicationJsonSchemaDataType": { "description": "Type of the shift rate", "enum": [ "MULTIPLIER_PERCENTAGE", "PER_HOUR_FLAT_RATE", "PER_UNIT_FLAT_RATE" ], "title": "V2TimeTrackingShiftRatesPostResponsesContentApplicationJsonSchemaDataType", "type": "string" }, "V2TimeTrackingShiftsBulkDeletePostRequestBodyContentApplicationJsonSchemaData": { "properties": { "external_ids": { "description": "Array of shift external_ids to delete", "items": { "type": "string" }, "type": "array" } }, "required": [ "external_ids" ], "title": "V2TimeTrackingShiftsBulkDeletePostRequestBodyContentApplicationJsonSchemaData", "type": "object" }, "V2TimeTrackingShiftsBulkDeletePostResponsesContentApplicationJsonSchemaData": { "properties": { "message": { "description": "Success message indicating the number of shifts deleted", "maxLength": 200, "type": "string" } }, "required": [ "message" ], "title": "V2TimeTrackingShiftsBulkDeletePostResponsesContentApplicationJsonSchemaData", "type": "object" }, "V2TimeTrackingShiftsGetResponsesContentApplicationJsonSchemaDataItems": { "properties": { "contract_id": { "description": "Associated contract ID for the shift", "type": "string" }, "created_at": { "description": "Date when the shift was created", "format": "date-time", "type": "string" }, "date_of_work": { "description": "Date when the shift takes place, in YYYY-MM-DD format", "type": "string" }, "description": { "description": "Description of the shift", "type": "string" }, "external_id": { "description": "ID specified by the client for uniquely identifying the shift", "type": "string" }, "meta": { "$ref": "#/components/schemas/V2TimeTrackingShiftsGetResponsesContentApplicationJsonSchemaDataItemsMeta" }, "payroll_cycle_ref": { "$ref": "#/components/schemas/V2TimeTrackingShiftsGetResponsesContentApplicationJsonSchemaDataItemsPayrollCycleRef", "description": "Payroll cycle reference" }, "shift_reference_id": { "description": "External ID of the original shift this one references (set on correction shifts).", "maxLength": 48, "minLength": 8, "type": "string" }, "shift_type": { "$ref": "#/components/schemas/V2TimeTrackingShiftsGetResponsesContentApplicationJsonSchemaDataItemsShiftType", "description": "Type of the shift" }, "summary": { "$ref": "#/components/schemas/V2TimeTrackingShiftsGetResponsesContentApplicationJsonSchemaDataItemsSummary" }, "updated_at": { "description": "Date when the shift was last updated", "format": "date-time", "type": "string" } }, "required": [ "created_at", "shift_type", "updated_at", "contract_id", "description", "external_id", "date_of_work" ], "title": "V2TimeTrackingShiftsGetResponsesContentApplicationJsonSchemaDataItems", "type": "object" }, "V2TimeTrackingShiftsGetResponsesContentApplicationJsonSchemaDataItemsMeta": { "properties": { "approval_date": { "description": "Approval date for the shift, in ISO format", "type": "string" }, "breaks": { "items": { "$ref": "#/components/schemas/V2TimeTrackingShiftsGetResponsesContentApplicationJsonSchemaDataItemsMetaBreaksItems" }, "type": "array" }, "end": { "$ref": "#/components/schemas/V2TimeTrackingShiftsGetResponsesContentApplicationJsonSchemaDataItemsMetaEnd" }, "start": { "$ref": "#/components/schemas/V2TimeTrackingShiftsGetResponsesContentApplicationJsonSchemaDataItemsMetaStart" } }, "required": [ "end", "start" ], "title": "V2TimeTrackingShiftsGetResponsesContentApplicationJsonSchemaDataItemsMeta", "type": "object" }, "V2TimeTrackingShiftsGetResponsesContentApplicationJsonSchemaDataItemsMetaBreaksItems": { "properties": { "end": { "$ref": "#/components/schemas/V2TimeTrackingShiftsGetResponsesContentApplicationJsonSchemaDataItemsMetaBreaksItemsEnd" }, "is_paid": { "description": "Indicates if the break is paid", "type": "boolean" }, "start": { "$ref": "#/components/schemas/V2TimeTrackingShiftsGetResponsesContentApplicationJsonSchemaDataItemsMetaBreaksItemsStart" } }, "required": [ "end", "start" ], "title": "V2TimeTrackingShiftsGetResponsesContentApplicationJsonSchemaDataItemsMetaBreaksItems", "type": "object" }, "V2TimeTrackingShiftsGetResponsesContentApplicationJsonSchemaDataItemsMetaBreaksItemsEnd": { "properties": { "date": { "description": "Break end date", "type": "string" }, "time": { "description": "Break end time in HH:mm format", "type": "string" } }, "required": [ "date", "time" ], "title": "V2TimeTrackingShiftsGetResponsesContentApplicationJsonSchemaDataItemsMetaBreaksItemsEnd", "type": "object" }, "V2TimeTrackingShiftsGetResponsesContentApplicationJsonSchemaDataItemsMetaBreaksItemsStart": { "properties": { "date": { "description": "Break start date", "type": "string" }, "time": { "description": "Break start time in HH:mm format", "type": "string" } }, "required": [ "date", "time" ], "title": "V2TimeTrackingShiftsGetResponsesContentApplicationJsonSchemaDataItemsMetaBreaksItemsStart", "type": "object" }, "V2TimeTrackingShiftsGetResponsesContentApplicationJsonSchemaDataItemsMetaEnd": { "properties": { "date": { "description": "Shift end date", "type": "string" }, "is_public_holiday": { "description": "Indicates if it is a public holiday", "type": "boolean" }, "is_rest_day": { "description": "Indicates if it is a rest day", "type": "boolean" }, "time": { "description": "Shift end time in HH:mm format", "type": "string" } }, "required": [ "date", "time", "is_rest_day", "is_public_holiday" ], "title": "V2TimeTrackingShiftsGetResponsesContentApplicationJsonSchemaDataItemsMetaEnd", "type": "object" }, "V2TimeTrackingShiftsGetResponsesContentApplicationJsonSchemaDataItemsMetaStart": { "properties": { "date": { "description": "Shift start date", "type": "string" }, "is_public_holiday": { "description": "Indicates if it is a public holiday", "type": "boolean" }, "is_rest_day": { "description": "Indicates if it is a rest day", "type": "boolean" }, "time": { "description": "Shift start time in HH:mm format", "type": "string" } }, "required": [ "date", "time", "is_rest_day", "is_public_holiday" ], "title": "V2TimeTrackingShiftsGetResponsesContentApplicationJsonSchemaDataItemsMetaStart", "type": "object" }, "V2TimeTrackingShiftsGetResponsesContentApplicationJsonSchemaDataItemsPayrollCycleRef": { "description": "Payroll cycle reference", "properties": { "date": { "description": "date in ISO", "format": "date-time", "type": "string" } }, "required": [ "date" ], "title": "V2TimeTrackingShiftsGetResponsesContentApplicationJsonSchemaDataItemsPayrollCycleRef", "type": "object" }, "V2TimeTrackingShiftsGetResponsesContentApplicationJsonSchemaDataItemsShiftType": { "description": "Type of the shift", "enum": [ "REGULAR", "CORRECTION_ABSOLUTE", "CORRECTION_DELTA", "TIME_OFF_QUALIFYING" ], "title": "V2TimeTrackingShiftsGetResponsesContentApplicationJsonSchemaDataItemsShiftType", "type": "string" }, "V2TimeTrackingShiftsGetResponsesContentApplicationJsonSchemaDataItemsSummary": { "properties": { "payable_break_hours": { "description": "Break hours that are payable", "format": "double", "type": "number" }, "shift_duration_hours": { "description": "Total duration of the shift in hours", "format": "double", "type": "number" }, "shift_rate_external_id": { "description": "External ID of the shift rate associated with this shift", "type": "string" }, "time_amount": { "description": "The amount of time for the shift", "format": "double", "minimum": 0, "type": "number" }, "time_unit": { "$ref": "#/components/schemas/V2TimeTrackingShiftsGetResponsesContentApplicationJsonSchemaDataItemsSummaryTimeUnit", "description": "The unit of time for the shift (DAY, HOUR, MONTH, WEEK)" }, "total_break_hours": { "description": "Total break duration in hours", "format": "double", "type": "number" }, "total_payable_hours": { "description": "Total payable working hours after break deductions", "format": "double", "type": "number" } }, "required": [ "shift_rate_external_id" ], "title": "V2TimeTrackingShiftsGetResponsesContentApplicationJsonSchemaDataItemsSummary", "type": "object" }, "V2TimeTrackingShiftsGetResponsesContentApplicationJsonSchemaDataItemsSummaryTimeUnit": { "description": "The unit of time for the shift (DAY, HOUR, MONTH, WEEK)", "enum": [ "DAY", "HOUR", "MONTH", "WEEK" ], "title": "V2TimeTrackingShiftsGetResponsesContentApplicationJsonSchemaDataItemsSummaryTimeUnit", "type": "string" }, "V2TimeTrackingShiftsGetResponsesContentApplicationJsonSchemaPage": { "properties": { "items_per_page": { "description": "Number of shifts per page", "format": "double", "type": "number" }, "offset": { "description": "Offset for pagination", "format": "double", "type": "number" }, "total_rows": { "description": "Total number of shifts", "format": "double", "type": "number" } }, "required": [ "offset", "total_rows", "items_per_page" ], "title": "V2TimeTrackingShiftsGetResponsesContentApplicationJsonSchemaPage", "type": "object" }, "V2TimeTrackingShiftsPostRequestBodyContentApplicationJsonSchemaData": { "properties": { "contract_id": { "description": "The unique identifier of the employee contract.", "type": "string" }, "shifts": { "items": { "$ref": "#/components/schemas/V2TimeTrackingShiftsPostRequestBodyContentApplicationJsonSchemaDataShiftsItems" }, "type": "array" } }, "required": [ "shifts", "contract_id" ], "title": "V2TimeTrackingShiftsPostRequestBodyContentApplicationJsonSchemaData", "type": "object" }, "V2TimeTrackingShiftsPostRequestBodyContentApplicationJsonSchemaDataShiftsItems": { "oneOf": [ { "$ref": "#/components/schemas/V2TimeTrackingShiftsPostRequestBodyContentApplicationJsonSchemaDataShiftsItems0" }, { "$ref": "#/components/schemas/V2TimeTrackingShiftsPostRequestBodyContentApplicationJsonSchemaDataShiftsItems1" }, { "$ref": "#/components/schemas/V2TimeTrackingShiftsPostRequestBodyContentApplicationJsonSchemaDataShiftsItems2" } ], "title": "V2TimeTrackingShiftsPostRequestBodyContentApplicationJsonSchemaDataShiftsItems" }, "V2TimeTrackingShiftsPostRequestBodyContentApplicationJsonSchemaDataShiftsItems0": { "properties": { "date_of_work": { "pattern": "^\\d{4}-\\d{2}-\\d{2}$", "type": "string" }, "description": { "description": "Description of the shift.", "maxLength": 30000, "minLength": 1, "type": "string" }, "external_id": { "description": "External ID of the shift.", "maxLength": 48, "minLength": 8, "type": "string" }, "payroll_cycle_ref": { "$ref": "#/components/schemas/V2TimeTrackingShiftsPostRequestBodyContentApplicationJsonSchemaDataShiftsItemsOneOf0PayrollCycleRef", "description": "Payroll cycle reference" }, "shift_type": { "$ref": "#/components/schemas/V2TimeTrackingShiftsPostRequestBodyContentApplicationJsonSchemaDataShiftsItemsOneOf0ShiftType", "default": "REGULAR", "description": "Type of the shift" }, "summary": { "$ref": "#/components/schemas/V2TimeTrackingShiftsPostRequestBodyContentApplicationJsonSchemaDataShiftsItemsOneOf0Summary", "description": "Shift summary. The fields here form two mutually exclusive groups — hours-based (`shift_duration_hours`, `total_break_hours`, `payable_break_hours`, `total_payable_hours`) and unit-amount (`time_amount`, `time_unit`) — and the schema cannot express this as a strict either/or because which group is required depends on the shift rate (`shift_rate_external_id`) type, resolved server-side: PER_UNIT_FLAT_RATE requires the unit-amount group, PER_HOUR_FLAT_RATE requires the hours-based group, and MULTIPLIER_PERCENTAGE (or no shift rate) accepts either group but not a mix of both. Sending fields from both groups, or the wrong group for the rate type, is rejected." } }, "required": [ "summary", "description", "external_id", "date_of_work" ], "title": "V2TimeTrackingShiftsPostRequestBodyContentApplicationJsonSchemaDataShiftsItems0", "type": "object" }, "V2TimeTrackingShiftsPostRequestBodyContentApplicationJsonSchemaDataShiftsItems1": { "properties": { "description": { "description": "Description of the shift.", "maxLength": 30000, "minLength": 1, "type": "string" }, "external_id": { "description": "External ID of the shift.", "maxLength": 48, "minLength": 8, "type": "string" }, "payroll_cycle_ref": { "$ref": "#/components/schemas/V2TimeTrackingShiftsPostRequestBodyContentApplicationJsonSchemaDataShiftsItemsOneOf1PayrollCycleRef", "description": "Payroll cycle reference" }, "shift_reference_id": { "description": "External ID of the original shift being corrected.", "maxLength": 48, "minLength": 8, "type": "string" }, "shift_type": { "$ref": "#/components/schemas/V2TimeTrackingShiftsPostRequestBodyContentApplicationJsonSchemaDataShiftsItemsOneOf1ShiftType", "description": "Type of the shift" }, "summary": { "$ref": "#/components/schemas/V2TimeTrackingShiftsPostRequestBodyContentApplicationJsonSchemaDataShiftsItemsOneOf1Summary" } }, "required": [ "summary", "shift_type", "description", "external_id", "shift_reference_id" ], "title": "V2TimeTrackingShiftsPostRequestBodyContentApplicationJsonSchemaDataShiftsItems1", "type": "object" }, "V2TimeTrackingShiftsPostRequestBodyContentApplicationJsonSchemaDataShiftsItems2": { "properties": { "corrections": { "items": { "$ref": "#/components/schemas/V2TimeTrackingShiftsPostRequestBodyContentApplicationJsonSchemaDataShiftsItemsOneOf2CorrectionsItems" }, "type": "array" }, "description": { "description": "Description of the shift.", "maxLength": 30000, "minLength": 1, "type": "string" }, "external_id": { "description": "External ID of the shift.", "maxLength": 48, "minLength": 8, "type": "string" }, "payroll_cycle_ref": { "$ref": "#/components/schemas/V2TimeTrackingShiftsPostRequestBodyContentApplicationJsonSchemaDataShiftsItemsOneOf2PayrollCycleRef", "description": "Payroll cycle reference" }, "shift_reference_id": { "description": "External ID of the original shift being corrected.", "maxLength": 48, "minLength": 8, "type": "string" }, "shift_type": { "$ref": "#/components/schemas/V2TimeTrackingShiftsPostRequestBodyContentApplicationJsonSchemaDataShiftsItemsOneOf2ShiftType", "description": "Type of the shift" } }, "required": [ "shift_type", "corrections", "description", "external_id", "shift_reference_id" ], "title": "V2TimeTrackingShiftsPostRequestBodyContentApplicationJsonSchemaDataShiftsItems2", "type": "object" }, "V2TimeTrackingShiftsPostRequestBodyContentApplicationJsonSchemaDataShiftsItemsOneOf0PayrollCycleRef": { "description": "Payroll cycle reference", "properties": { "date": { "description": "date in ISO", "format": "date-time", "type": "string" } }, "required": [ "date" ], "title": "V2TimeTrackingShiftsPostRequestBodyContentApplicationJsonSchemaDataShiftsItemsOneOf0PayrollCycleRef", "type": "object" }, "V2TimeTrackingShiftsPostRequestBodyContentApplicationJsonSchemaDataShiftsItemsOneOf0ShiftType": { "default": "REGULAR", "description": "Type of the shift", "enum": [ "REGULAR" ], "title": "V2TimeTrackingShiftsPostRequestBodyContentApplicationJsonSchemaDataShiftsItemsOneOf0ShiftType", "type": "string" }, "V2TimeTrackingShiftsPostRequestBodyContentApplicationJsonSchemaDataShiftsItemsOneOf0Summary": { "description": "Shift summary. The fields here form two mutually exclusive groups — hours-based (`shift_duration_hours`, `total_break_hours`, `payable_break_hours`, `total_payable_hours`) and unit-amount (`time_amount`, `time_unit`) — and the schema cannot express this as a strict either/or because which group is required depends on the shift rate (`shift_rate_external_id`) type, resolved server-side: PER_UNIT_FLAT_RATE requires the unit-amount group, PER_HOUR_FLAT_RATE requires the hours-based group, and MULTIPLIER_PERCENTAGE (or no shift rate) accepts either group but not a mix of both. Sending fields from both groups, or the wrong group for the rate type, is rejected.", "properties": { "payable_break_hours": { "description": "Break hours that are payable. Part of the hours-based summary group (see `shift_duration_hours`).", "exclusiveMinimum": 0, "format": "double", "type": "number" }, "shift_duration_hours": { "description": "Total duration of the shift in hours. Part of the hours-based summary group, used when the shift rate is PER_HOUR_FLAT_RATE (or MULTIPLIER_PERCENTAGE/omitted, where either group is accepted). Mutually exclusive with `time_amount`/`time_unit` — do not send both groups.", "exclusiveMinimum": 0, "format": "double", "type": "number" }, "shift_rate_external_id": { "description": "External ID of the shift rate associated with this shift. Its type (PER_UNIT_FLAT_RATE, PER_HOUR_FLAT_RATE, or MULTIPLIER_PERCENTAGE) determines which of the two field groups below is required — see the group descriptions.", "maxLength": 48, "minLength": 8, "type": "string" }, "time_amount": { "description": "The amount of time for the shift. Part of the unit-amount summary group, required when the shift rate is PER_UNIT_FLAT_RATE (or MULTIPLIER_PERCENTAGE/omitted, where either group is accepted). Mutually exclusive with `shift_duration_hours`/`total_break_hours`/`payable_break_hours`/`total_payable_hours` — do not send both groups.", "exclusiveMinimum": 0, "format": "double", "type": "number" }, "time_unit": { "$ref": "#/components/schemas/V2TimeTrackingShiftsPostRequestBodyContentApplicationJsonSchemaDataShiftsItemsOneOf0SummaryTimeUnit", "description": "The unit of time for the shift (DAY, HOUR, MONTH, WEEK). Part of the unit-amount summary group (see `time_amount`)." }, "total_break_hours": { "description": "Total break duration in hours. Part of the hours-based summary group (see `shift_duration_hours`).", "exclusiveMinimum": 0, "format": "double", "type": "number" }, "total_payable_hours": { "description": "Total payable working hours after break deductions. Part of the hours-based summary group (see `shift_duration_hours`).", "exclusiveMinimum": 0, "format": "double", "type": "number" } }, "title": "V2TimeTrackingShiftsPostRequestBodyContentApplicationJsonSchemaDataShiftsItemsOneOf0Summary", "type": "object" }, "V2TimeTrackingShiftsPostRequestBodyContentApplicationJsonSchemaDataShiftsItemsOneOf0SummaryTimeUnit": { "description": "The unit of time for the shift (DAY, HOUR, MONTH, WEEK). Part of the unit-amount summary group (see `time_amount`).", "enum": [ "DAY", "HOUR", "MONTH", "WEEK" ], "title": "V2TimeTrackingShiftsPostRequestBodyContentApplicationJsonSchemaDataShiftsItemsOneOf0SummaryTimeUnit", "type": "string" }, "V2TimeTrackingShiftsPostRequestBodyContentApplicationJsonSchemaDataShiftsItemsOneOf1PayrollCycleRef": { "description": "Payroll cycle reference", "properties": { "date": { "description": "date in ISO", "format": "date-time", "type": "string" } }, "required": [ "date" ], "title": "V2TimeTrackingShiftsPostRequestBodyContentApplicationJsonSchemaDataShiftsItemsOneOf1PayrollCycleRef", "type": "object" }, "V2TimeTrackingShiftsPostRequestBodyContentApplicationJsonSchemaDataShiftsItemsOneOf1ShiftType": { "description": "Type of the shift", "enum": [ "CORRECTION_ABSOLUTE" ], "title": "V2TimeTrackingShiftsPostRequestBodyContentApplicationJsonSchemaDataShiftsItemsOneOf1ShiftType", "type": "string" }, "V2TimeTrackingShiftsPostRequestBodyContentApplicationJsonSchemaDataShiftsItemsOneOf1Summary": { "properties": { "payable_break_hours": { "description": "Break hours that are payable. Part of the hours-based summary group (see `shift_duration_hours`).", "exclusiveMinimum": 0, "format": "double", "type": "number" }, "shift_duration_hours": { "description": "Total duration of the shift in hours. Part of the hours-based summary group, used when the shift rate is PER_HOUR_FLAT_RATE (or MULTIPLIER_PERCENTAGE/omitted, where either group is accepted). Mutually exclusive with `time_amount`/`time_unit` — do not send both groups.", "exclusiveMinimum": 0, "format": "double", "type": "number" }, "time_amount": { "description": "Corrected amount of time (0 zeroes the original shift). Part of the unit-amount summary group, required when the shift rate is PER_UNIT_FLAT_RATE (or MULTIPLIER_PERCENTAGE/omitted, where either group is accepted). Mutually exclusive with `shift_duration_hours`/`total_break_hours`/`payable_break_hours`/`total_payable_hours` — do not send both groups.", "format": "double", "minimum": 0, "type": "number" }, "time_unit": { "$ref": "#/components/schemas/V2TimeTrackingShiftsPostRequestBodyContentApplicationJsonSchemaDataShiftsItemsOneOf1SummaryTimeUnit", "description": "The unit of time for the shift (DAY, HOUR, MONTH, WEEK). Part of the unit-amount summary group (see `time_amount`)." }, "total_break_hours": { "description": "Total break duration in hours. Part of the hours-based summary group (see `shift_duration_hours`).", "exclusiveMinimum": 0, "format": "double", "type": "number" }, "total_payable_hours": { "description": "Corrected total payable hours (0 zeroes the original shift). Part of the hours-based summary group (see `shift_duration_hours`).", "format": "double", "minimum": 0, "type": "number" } }, "title": "V2TimeTrackingShiftsPostRequestBodyContentApplicationJsonSchemaDataShiftsItemsOneOf1Summary", "type": "object" }, "V2TimeTrackingShiftsPostRequestBodyContentApplicationJsonSchemaDataShiftsItemsOneOf1SummaryTimeUnit": { "description": "The unit of time for the shift (DAY, HOUR, MONTH, WEEK). Part of the unit-amount summary group (see `time_amount`).", "enum": [ "DAY", "HOUR", "MONTH", "WEEK" ], "title": "V2TimeTrackingShiftsPostRequestBodyContentApplicationJsonSchemaDataShiftsItemsOneOf1SummaryTimeUnit", "type": "string" }, "V2TimeTrackingShiftsPostRequestBodyContentApplicationJsonSchemaDataShiftsItemsOneOf2CorrectionsItems": { "description": "Correction entry for delta shifts", "properties": { "payable_break_hours": { "description": "Payable break hours to add or subtract", "exclusiveMinimum": 0, "format": "double", "type": "number" }, "shift_duration_hours": { "description": "Shift duration hours to add or subtract", "exclusiveMinimum": 0, "format": "double", "type": "number" }, "time_amount": { "description": "Time amount to add or subtract", "exclusiveMinimum": 0, "format": "double", "type": "number" }, "total_break_hours": { "description": "Break hours to add or subtract", "exclusiveMinimum": 0, "format": "double", "type": "number" }, "total_payable_hours": { "description": "Payable hours to add or subtract", "exclusiveMinimum": 0, "format": "double", "type": "number" }, "type": { "$ref": "#/components/schemas/V2TimeTrackingShiftsPostRequestBodyContentApplicationJsonSchemaDataShiftsItemsOneOf2CorrectionsItemsType", "description": "Type of correction" } }, "required": [ "type" ], "title": "V2TimeTrackingShiftsPostRequestBodyContentApplicationJsonSchemaDataShiftsItemsOneOf2CorrectionsItems", "type": "object" }, "V2TimeTrackingShiftsPostRequestBodyContentApplicationJsonSchemaDataShiftsItemsOneOf2CorrectionsItemsType": { "description": "Type of correction", "enum": [ "ADDITION", "SUBTRACTION" ], "title": "V2TimeTrackingShiftsPostRequestBodyContentApplicationJsonSchemaDataShiftsItemsOneOf2CorrectionsItemsType", "type": "string" }, "V2TimeTrackingShiftsPostRequestBodyContentApplicationJsonSchemaDataShiftsItemsOneOf2PayrollCycleRef": { "description": "Payroll cycle reference", "properties": { "date": { "description": "date in ISO", "format": "date-time", "type": "string" } }, "required": [ "date" ], "title": "V2TimeTrackingShiftsPostRequestBodyContentApplicationJsonSchemaDataShiftsItemsOneOf2PayrollCycleRef", "type": "object" }, "V2TimeTrackingShiftsPostRequestBodyContentApplicationJsonSchemaDataShiftsItemsOneOf2ShiftType": { "description": "Type of the shift", "enum": [ "CORRECTION_DELTA" ], "title": "V2TimeTrackingShiftsPostRequestBodyContentApplicationJsonSchemaDataShiftsItemsOneOf2ShiftType", "type": "string" }, "V2TimeTrackingShiftsPostResponsesContentApplicationJsonSchemaDataItems": { "properties": { "contract_id": { "description": "Associated contract ID for the shift", "type": "string" }, "created_at": { "description": "Date when the shift was created", "format": "date-time", "type": "string" }, "date_of_work": { "description": "Date when the shift takes place, in YYYY-MM-DD format", "type": "string" }, "description": { "description": "Description of the shift", "type": "string" }, "external_id": { "description": "ID specified by the client for uniquely identifying the shift", "type": "string" }, "meta": { "$ref": "#/components/schemas/V2TimeTrackingShiftsPostResponsesContentApplicationJsonSchemaDataItemsMeta" }, "payroll_cycle_ref": { "$ref": "#/components/schemas/V2TimeTrackingShiftsPostResponsesContentApplicationJsonSchemaDataItemsPayrollCycleRef", "description": "Payroll cycle reference" }, "shift_reference_id": { "description": "External ID of the original shift this one references (set on correction shifts).", "maxLength": 48, "minLength": 8, "type": "string" }, "shift_type": { "$ref": "#/components/schemas/V2TimeTrackingShiftsPostResponsesContentApplicationJsonSchemaDataItemsShiftType", "description": "Type of the shift" }, "summary": { "$ref": "#/components/schemas/V2TimeTrackingShiftsPostResponsesContentApplicationJsonSchemaDataItemsSummary" }, "updated_at": { "description": "Date when the shift was last updated", "format": "date-time", "type": "string" } }, "required": [ "created_at", "shift_type", "updated_at", "contract_id", "description", "external_id", "date_of_work" ], "title": "V2TimeTrackingShiftsPostResponsesContentApplicationJsonSchemaDataItems", "type": "object" }, "V2TimeTrackingShiftsPostResponsesContentApplicationJsonSchemaDataItemsMeta": { "properties": { "approval_date": { "description": "Approval date for the shift, in ISO format", "type": "string" }, "breaks": { "items": { "$ref": "#/components/schemas/V2TimeTrackingShiftsPostResponsesContentApplicationJsonSchemaDataItemsMetaBreaksItems" }, "type": "array" }, "end": { "$ref": "#/components/schemas/V2TimeTrackingShiftsPostResponsesContentApplicationJsonSchemaDataItemsMetaEnd" }, "start": { "$ref": "#/components/schemas/V2TimeTrackingShiftsPostResponsesContentApplicationJsonSchemaDataItemsMetaStart" } }, "required": [ "end", "start" ], "title": "V2TimeTrackingShiftsPostResponsesContentApplicationJsonSchemaDataItemsMeta", "type": "object" }, "V2TimeTrackingShiftsPostResponsesContentApplicationJsonSchemaDataItemsMetaBreaksItems": { "properties": { "end": { "$ref": "#/components/schemas/V2TimeTrackingShiftsPostResponsesContentApplicationJsonSchemaDataItemsMetaBreaksItemsEnd" }, "is_paid": { "description": "Indicates if the break is paid", "type": "boolean" }, "start": { "$ref": "#/components/schemas/V2TimeTrackingShiftsPostResponsesContentApplicationJsonSchemaDataItemsMetaBreaksItemsStart" } }, "required": [ "end", "start" ], "title": "V2TimeTrackingShiftsPostResponsesContentApplicationJsonSchemaDataItemsMetaBreaksItems", "type": "object" }, "V2TimeTrackingShiftsPostResponsesContentApplicationJsonSchemaDataItemsMetaBreaksItemsEnd": { "properties": { "date": { "description": "Break end date", "type": "string" }, "time": { "description": "Break end time in HH:mm format", "type": "string" } }, "required": [ "date", "time" ], "title": "V2TimeTrackingShiftsPostResponsesContentApplicationJsonSchemaDataItemsMetaBreaksItemsEnd", "type": "object" }, "V2TimeTrackingShiftsPostResponsesContentApplicationJsonSchemaDataItemsMetaBreaksItemsStart": { "properties": { "date": { "description": "Break start date", "type": "string" }, "time": { "description": "Break start time in HH:mm format", "type": "string" } }, "required": [ "date", "time" ], "title": "V2TimeTrackingShiftsPostResponsesContentApplicationJsonSchemaDataItemsMetaBreaksItemsStart", "type": "object" }, "V2TimeTrackingShiftsPostResponsesContentApplicationJsonSchemaDataItemsMetaEnd": { "properties": { "date": { "description": "Shift end date", "type": "string" }, "is_public_holiday": { "description": "Indicates if it is a public holiday", "type": "boolean" }, "is_rest_day": { "description": "Indicates if it is a rest day", "type": "boolean" }, "time": { "description": "Shift end time in HH:mm format", "type": "string" } }, "required": [ "date", "time", "is_rest_day", "is_public_holiday" ], "title": "V2TimeTrackingShiftsPostResponsesContentApplicationJsonSchemaDataItemsMetaEnd", "type": "object" }, "V2TimeTrackingShiftsPostResponsesContentApplicationJsonSchemaDataItemsMetaStart": { "properties": { "date": { "description": "Shift start date", "type": "string" }, "is_public_holiday": { "description": "Indicates if it is a public holiday", "type": "boolean" }, "is_rest_day": { "description": "Indicates if it is a rest day", "type": "boolean" }, "time": { "description": "Shift start time in HH:mm format", "type": "string" } }, "required": [ "date", "time", "is_rest_day", "is_public_holiday" ], "title": "V2TimeTrackingShiftsPostResponsesContentApplicationJsonSchemaDataItemsMetaStart", "type": "object" }, "V2TimeTrackingShiftsPostResponsesContentApplicationJsonSchemaDataItemsPayrollCycleRef": { "description": "Payroll cycle reference", "properties": { "date": { "description": "date in ISO", "format": "date-time", "type": "string" } }, "required": [ "date" ], "title": "V2TimeTrackingShiftsPostResponsesContentApplicationJsonSchemaDataItemsPayrollCycleRef", "type": "object" }, "V2TimeTrackingShiftsPostResponsesContentApplicationJsonSchemaDataItemsShiftType": { "description": "Type of the shift", "enum": [ "REGULAR", "CORRECTION_ABSOLUTE", "CORRECTION_DELTA" ], "title": "V2TimeTrackingShiftsPostResponsesContentApplicationJsonSchemaDataItemsShiftType", "type": "string" }, "V2TimeTrackingShiftsPostResponsesContentApplicationJsonSchemaDataItemsSummary": { "properties": { "payable_break_hours": { "description": "Break hours that are payable", "format": "double", "type": "number" }, "shift_duration_hours": { "description": "Total duration of the shift in hours", "format": "double", "type": "number" }, "shift_rate_external_id": { "description": "External ID of the shift rate associated with this shift", "type": "string" }, "time_amount": { "description": "The amount of time for the shift", "format": "double", "minimum": 0, "type": "number" }, "time_unit": { "$ref": "#/components/schemas/V2TimeTrackingShiftsPostResponsesContentApplicationJsonSchemaDataItemsSummaryTimeUnit", "description": "The unit of time for the shift (DAY, HOUR, MONTH, WEEK)" }, "total_break_hours": { "description": "Total break duration in hours", "format": "double", "type": "number" }, "total_payable_hours": { "description": "Total payable working hours after break deductions", "format": "double", "type": "number" } }, "required": [ "shift_rate_external_id" ], "title": "V2TimeTrackingShiftsPostResponsesContentApplicationJsonSchemaDataItemsSummary", "type": "object" }, "V2TimeTrackingShiftsPostResponsesContentApplicationJsonSchemaDataItemsSummaryTimeUnit": { "description": "The unit of time for the shift (DAY, HOUR, MONTH, WEEK)", "enum": [ "DAY", "HOUR", "MONTH", "WEEK" ], "title": "V2TimeTrackingShiftsPostResponsesContentApplicationJsonSchemaDataItemsSummaryTimeUnit", "type": "string" }, "V2TimeTrackingShiftsRawPostRequestBodyContentApplicationJsonSchemaData": { "properties": { "contract_id": { "description": "The unique identifier of the employee contract.", "type": "string" }, "shifts": { "items": { "$ref": "#/components/schemas/V2TimeTrackingShiftsRawPostRequestBodyContentApplicationJsonSchemaDataShiftsItems" }, "type": "array" } }, "required": [ "shifts", "contract_id" ], "title": "V2TimeTrackingShiftsRawPostRequestBodyContentApplicationJsonSchemaData", "type": "object" }, "V2TimeTrackingShiftsRawPostRequestBodyContentApplicationJsonSchemaDataShiftsItems": { "properties": { "date_of_work": { "description": "Date of the shift, in YYYY-MM-DD format.", "pattern": "^\\d{4}-\\d{2}-\\d{2}$", "type": "string" }, "description": { "description": "Description of the shift.", "maxLength": 30000, "minLength": 1, "type": "string" }, "external_id": { "description": "ID specified by the client for uniquely identifying the shift.", "maxLength": 48, "minLength": 8, "type": "string" }, "meta": { "$ref": "#/components/schemas/V2TimeTrackingShiftsRawPostRequestBodyContentApplicationJsonSchemaDataShiftsItemsMeta" }, "payroll_cycle_ref": { "$ref": "#/components/schemas/V2TimeTrackingShiftsRawPostRequestBodyContentApplicationJsonSchemaDataShiftsItemsPayrollCycleRef", "description": "Payroll cycle reference" } }, "required": [ "meta", "description", "external_id", "date_of_work" ], "title": "V2TimeTrackingShiftsRawPostRequestBodyContentApplicationJsonSchemaDataShiftsItems", "type": "object" }, "V2TimeTrackingShiftsRawPostRequestBodyContentApplicationJsonSchemaDataShiftsItemsMeta": { "properties": { "approval_date": { "description": "Approval date for the shift", "pattern": "^\\d{4}-\\d{2}-\\d{2}$", "type": "string" }, "breaks": { "items": { "$ref": "#/components/schemas/V2TimeTrackingShiftsRawPostRequestBodyContentApplicationJsonSchemaDataShiftsItemsMetaBreaksItems" }, "type": "array" }, "end": { "$ref": "#/components/schemas/V2TimeTrackingShiftsRawPostRequestBodyContentApplicationJsonSchemaDataShiftsItemsMetaEnd", "description": "Shift end date and time" }, "start": { "$ref": "#/components/schemas/V2TimeTrackingShiftsRawPostRequestBodyContentApplicationJsonSchemaDataShiftsItemsMetaStart", "description": "Shift start date and time" } }, "required": [ "end", "start" ], "title": "V2TimeTrackingShiftsRawPostRequestBodyContentApplicationJsonSchemaDataShiftsItemsMeta", "type": "object" }, "V2TimeTrackingShiftsRawPostRequestBodyContentApplicationJsonSchemaDataShiftsItemsMetaBreaksItems": { "description": "Break start and end date and time", "properties": { "end": { "$ref": "#/components/schemas/V2TimeTrackingShiftsRawPostRequestBodyContentApplicationJsonSchemaDataShiftsItemsMetaBreaksItemsEnd", "description": "Break end date and time" }, "is_paid": { "description": "Indicates if the break is paid.", "type": "boolean" }, "start": { "$ref": "#/components/schemas/V2TimeTrackingShiftsRawPostRequestBodyContentApplicationJsonSchemaDataShiftsItemsMetaBreaksItemsStart", "description": "Break start date and time" } }, "required": [ "end", "start" ], "title": "V2TimeTrackingShiftsRawPostRequestBodyContentApplicationJsonSchemaDataShiftsItemsMetaBreaksItems", "type": "object" }, "V2TimeTrackingShiftsRawPostRequestBodyContentApplicationJsonSchemaDataShiftsItemsMetaBreaksItemsEnd": { "description": "Break end date and time", "properties": { "date": { "description": "Break end date, in YYYY-MM-DD format.", "pattern": "^\\d{4}-\\d{2}-\\d{2}$", "type": "string" }, "time": { "description": "Break end time, in HH:mm format.", "pattern": "^([0-1]\\d|2[0-3]):[0-5]\\d$", "type": "string" } }, "required": [ "date", "time" ], "title": "V2TimeTrackingShiftsRawPostRequestBodyContentApplicationJsonSchemaDataShiftsItemsMetaBreaksItemsEnd", "type": "object" }, "V2TimeTrackingShiftsRawPostRequestBodyContentApplicationJsonSchemaDataShiftsItemsMetaBreaksItemsStart": { "description": "Break start date and time", "properties": { "date": { "description": "Break start date, in YYYY-MM-DD format.", "pattern": "^\\d{4}-\\d{2}-\\d{2}$", "type": "string" }, "time": { "description": "Break start time, in HH:mm format.", "pattern": "^([0-1]\\d|2[0-3]):[0-5]\\d$", "type": "string" } }, "required": [ "date", "time" ], "title": "V2TimeTrackingShiftsRawPostRequestBodyContentApplicationJsonSchemaDataShiftsItemsMetaBreaksItemsStart", "type": "object" }, "V2TimeTrackingShiftsRawPostRequestBodyContentApplicationJsonSchemaDataShiftsItemsMetaEnd": { "description": "Shift end date and time", "properties": { "date": { "description": "Shift end date, in YYYY-MM-DD format.", "pattern": "^\\d{4}-\\d{2}-\\d{2}$", "type": "string" }, "is_public_holiday": { "description": "Indicates if the shift end day is a public holiday.", "type": "boolean" }, "is_rest_day": { "description": "Indicates if the shift end day is a rest day.", "type": "boolean" }, "time": { "description": "Shift end time, in HH:mm format.", "pattern": "^([0-1]\\d|2[0-3]):[0-5]\\d$", "type": "string" } }, "required": [ "date", "time", "is_rest_day", "is_public_holiday" ], "title": "V2TimeTrackingShiftsRawPostRequestBodyContentApplicationJsonSchemaDataShiftsItemsMetaEnd", "type": "object" }, "V2TimeTrackingShiftsRawPostRequestBodyContentApplicationJsonSchemaDataShiftsItemsMetaStart": { "description": "Shift start date and time", "properties": { "date": { "description": "Shift start date, in YYYY-MM-DD format.", "pattern": "^\\d{4}-\\d{2}-\\d{2}$", "type": "string" }, "is_public_holiday": { "description": "Indicates if the shift start day is a public holiday.", "type": "boolean" }, "is_rest_day": { "description": "Indicates if the shift start day is a rest day.", "type": "boolean" }, "time": { "description": "Shift start time, in HH:mm format.", "pattern": "^([0-1]\\d|2[0-3]):[0-5]\\d$", "type": "string" } }, "required": [ "date", "time", "is_rest_day", "is_public_holiday" ], "title": "V2TimeTrackingShiftsRawPostRequestBodyContentApplicationJsonSchemaDataShiftsItemsMetaStart", "type": "object" }, "V2TimeTrackingShiftsRawPostRequestBodyContentApplicationJsonSchemaDataShiftsItemsPayrollCycleRef": { "description": "Payroll cycle reference", "properties": { "date": { "description": "date in ISO", "format": "date-time", "type": "string" } }, "required": [ "date" ], "title": "V2TimeTrackingShiftsRawPostRequestBodyContentApplicationJsonSchemaDataShiftsItemsPayrollCycleRef", "type": "object" }, "V2TimeTrackingShiftsRawPostResponsesContentApplicationJsonSchemaDataItems": { "properties": { "contract_id": { "description": "Associated contract ID for the shift", "type": "string" }, "created_at": { "description": "Date when the shift was created", "format": "date-time", "type": "string" }, "date_of_work": { "description": "Date when the shift takes place, in YYYY-MM-DD format", "type": "string" }, "description": { "description": "Description of the shift", "type": "string" }, "external_id": { "description": "ID specified by the client for uniquely identifying the shift", "type": "string" }, "meta": { "$ref": "#/components/schemas/V2TimeTrackingShiftsRawPostResponsesContentApplicationJsonSchemaDataItemsMeta" }, "payroll_cycle_ref": { "$ref": "#/components/schemas/V2TimeTrackingShiftsRawPostResponsesContentApplicationJsonSchemaDataItemsPayrollCycleRef", "description": "Payroll cycle reference" }, "shift_reference_id": { "description": "External ID of the original shift this one references (set on correction shifts).", "maxLength": 48, "minLength": 8, "type": "string" }, "shift_type": { "$ref": "#/components/schemas/V2TimeTrackingShiftsRawPostResponsesContentApplicationJsonSchemaDataItemsShiftType", "description": "Type of the shift" }, "summary": { "$ref": "#/components/schemas/V2TimeTrackingShiftsRawPostResponsesContentApplicationJsonSchemaDataItemsSummary" }, "updated_at": { "description": "Date when the shift was last updated", "format": "date-time", "type": "string" } }, "required": [ "created_at", "shift_type", "updated_at", "contract_id", "description", "external_id", "date_of_work" ], "title": "V2TimeTrackingShiftsRawPostResponsesContentApplicationJsonSchemaDataItems", "type": "object" }, "V2TimeTrackingShiftsRawPostResponsesContentApplicationJsonSchemaDataItemsMeta": { "properties": { "approval_date": { "description": "Approval date for the shift, in ISO format", "type": "string" }, "breaks": { "items": { "$ref": "#/components/schemas/V2TimeTrackingShiftsRawPostResponsesContentApplicationJsonSchemaDataItemsMetaBreaksItems" }, "type": "array" }, "end": { "$ref": "#/components/schemas/V2TimeTrackingShiftsRawPostResponsesContentApplicationJsonSchemaDataItemsMetaEnd" }, "start": { "$ref": "#/components/schemas/V2TimeTrackingShiftsRawPostResponsesContentApplicationJsonSchemaDataItemsMetaStart" } }, "required": [ "end", "start" ], "title": "V2TimeTrackingShiftsRawPostResponsesContentApplicationJsonSchemaDataItemsMeta", "type": "object" }, "V2TimeTrackingShiftsRawPostResponsesContentApplicationJsonSchemaDataItemsMetaBreaksItems": { "properties": { "end": { "$ref": "#/components/schemas/V2TimeTrackingShiftsRawPostResponsesContentApplicationJsonSchemaDataItemsMetaBreaksItemsEnd" }, "is_paid": { "description": "Indicates if the break is paid", "type": "boolean" }, "start": { "$ref": "#/components/schemas/V2TimeTrackingShiftsRawPostResponsesContentApplicationJsonSchemaDataItemsMetaBreaksItemsStart" } }, "required": [ "end", "start" ], "title": "V2TimeTrackingShiftsRawPostResponsesContentApplicationJsonSchemaDataItemsMetaBreaksItems", "type": "object" }, "V2TimeTrackingShiftsRawPostResponsesContentApplicationJsonSchemaDataItemsMetaBreaksItemsEnd": { "properties": { "date": { "description": "Break end date", "type": "string" }, "time": { "description": "Break end time in HH:mm format", "type": "string" } }, "required": [ "date", "time" ], "title": "V2TimeTrackingShiftsRawPostResponsesContentApplicationJsonSchemaDataItemsMetaBreaksItemsEnd", "type": "object" }, "V2TimeTrackingShiftsRawPostResponsesContentApplicationJsonSchemaDataItemsMetaBreaksItemsStart": { "properties": { "date": { "description": "Break start date", "type": "string" }, "time": { "description": "Break start time in HH:mm format", "type": "string" } }, "required": [ "date", "time" ], "title": "V2TimeTrackingShiftsRawPostResponsesContentApplicationJsonSchemaDataItemsMetaBreaksItemsStart", "type": "object" }, "V2TimeTrackingShiftsRawPostResponsesContentApplicationJsonSchemaDataItemsMetaEnd": { "properties": { "date": { "description": "Shift end date", "type": "string" }, "is_public_holiday": { "description": "Indicates if it is a public holiday", "type": "boolean" }, "is_rest_day": { "description": "Indicates if it is a rest day", "type": "boolean" }, "time": { "description": "Shift end time in HH:mm format", "type": "string" } }, "required": [ "date", "time", "is_rest_day", "is_public_holiday" ], "title": "V2TimeTrackingShiftsRawPostResponsesContentApplicationJsonSchemaDataItemsMetaEnd", "type": "object" }, "V2TimeTrackingShiftsRawPostResponsesContentApplicationJsonSchemaDataItemsMetaStart": { "properties": { "date": { "description": "Shift start date", "type": "string" }, "is_public_holiday": { "description": "Indicates if it is a public holiday", "type": "boolean" }, "is_rest_day": { "description": "Indicates if it is a rest day", "type": "boolean" }, "time": { "description": "Shift start time in HH:mm format", "type": "string" } }, "required": [ "date", "time", "is_rest_day", "is_public_holiday" ], "title": "V2TimeTrackingShiftsRawPostResponsesContentApplicationJsonSchemaDataItemsMetaStart", "type": "object" }, "V2TimeTrackingShiftsRawPostResponsesContentApplicationJsonSchemaDataItemsPayrollCycleRef": { "description": "Payroll cycle reference", "properties": { "date": { "description": "date in ISO", "format": "date-time", "type": "string" } }, "required": [ "date" ], "title": "V2TimeTrackingShiftsRawPostResponsesContentApplicationJsonSchemaDataItemsPayrollCycleRef", "type": "object" }, "V2TimeTrackingShiftsRawPostResponsesContentApplicationJsonSchemaDataItemsShiftType": { "description": "Type of the shift", "enum": [ "REGULAR" ], "title": "V2TimeTrackingShiftsRawPostResponsesContentApplicationJsonSchemaDataItemsShiftType", "type": "string" }, "V2TimeTrackingShiftsRawPostResponsesContentApplicationJsonSchemaDataItemsSummary": { "properties": { "payable_break_hours": { "description": "Break hours that are payable", "format": "double", "type": "number" }, "shift_duration_hours": { "description": "Total duration of the shift in hours", "format": "double", "type": "number" }, "shift_rate_external_id": { "description": "External ID of the shift rate associated with this shift", "type": "string" }, "time_amount": { "description": "The amount of time for the shift", "exclusiveMinimum": 0, "format": "double", "type": "number" }, "time_unit": { "$ref": "#/components/schemas/V2TimeTrackingShiftsRawPostResponsesContentApplicationJsonSchemaDataItemsSummaryTimeUnit", "description": "The unit of time for the shift (DAY, HOUR, MONTH, WEEK)" }, "total_break_hours": { "description": "Total break duration in hours", "format": "double", "type": "number" }, "total_payable_hours": { "description": "Total payable working hours after break deductions", "format": "double", "type": "number" } }, "required": [ "shift_rate_external_id" ], "title": "V2TimeTrackingShiftsRawPostResponsesContentApplicationJsonSchemaDataItemsSummary", "type": "object" }, "V2TimeTrackingShiftsRawPostResponsesContentApplicationJsonSchemaDataItemsSummaryTimeUnit": { "description": "The unit of time for the shift (DAY, HOUR, MONTH, WEEK)", "enum": [ "DAY", "HOUR", "MONTH", "WEEK" ], "title": "V2TimeTrackingShiftsRawPostResponsesContentApplicationJsonSchemaDataItemsSummaryTimeUnit", "type": "string" }, "ValidateAmendmentDataPoints-v2026-01-01RequestBadRequestError": { "properties": { "errors": { "items": { "$ref": "#/components/schemas/EorContractsContractIdAmendmentsValidatePostResponsesContentApplicationJsonSchemaErrorsItems" }, "type": "array" } }, "required": [ "errors" ], "title": "ValidateAmendmentDataPoints-v2026-01-01RequestBadRequestError", "type": "object" }, "ValidateAmendmentDataPoints-v2026-01-01RequestInternalServerError": { "properties": { "errors": { "items": { "$ref": "#/components/schemas/EorContractsContractIdAmendmentsValidatePostResponsesContentApplicationJsonSchemaErrorsItems" }, "type": "array" } }, "required": [ "errors" ], "title": "ValidateAmendmentDataPoints-v2026-01-01RequestInternalServerError", "type": "object" }, "ValidateAmendmentDataPoints-v2026-01-01RequestNotFoundError": { "properties": { "errors": { "items": { "$ref": "#/components/schemas/EorContractsContractIdAmendmentsValidatePostResponsesContentApplicationJsonSchemaErrorsItems" }, "type": "array" } }, "required": [ "errors" ], "title": "ValidateAmendmentDataPoints-v2026-01-01RequestNotFoundError", "type": "object" }, "ValidateTimeOffRequest-v2026-01-01RequestBadRequestError": { "properties": { "errors": { "items": { "$ref": "#/components/schemas/TimeOffsValidatePostResponsesContentApplicationJsonSchemaErrorsItems" }, "type": "array" }, "request": { "$ref": "#/components/schemas/TimeOffsValidatePostResponsesContentApplicationJsonSchemaRequest" } }, "title": "ValidateTimeOffRequest-v2026-01-01RequestBadRequestError", "type": "object" }, "VeriffSessionPostRequestBodyContentApplicationJsonSchemaData": { "properties": { "operation_type": { "$ref": "#/components/schemas/VeriffSessionPostRequestBodyContentApplicationJsonSchemaDataOperationType", "description": "The type of KYC operation to perform" }, "user_input": { "$ref": "#/components/schemas/VeriffSessionPostRequestBodyContentApplicationJsonSchemaDataUserInput", "description": "Input data for the name change KYC operation" } }, "required": [ "operation_type" ], "title": "VeriffSessionPostRequestBodyContentApplicationJsonSchemaData", "type": "object" }, "VeriffSessionPostRequestBodyContentApplicationJsonSchemaDataOperationType": { "description": "The type of KYC operation to perform", "enum": [ "IDENTITY_RESUBMISSION_KYC", "IDENTITY_VERIFICATION_KYC", "NAME_CHANGE_KYC", "EMAIL_CHANGE_KYC" ], "title": "VeriffSessionPostRequestBodyContentApplicationJsonSchemaDataOperationType", "type": "string" }, "VeriffSessionPostRequestBodyContentApplicationJsonSchemaDataUserInput": { "description": "Input data for the name change KYC operation", "properties": { "first_name": { "description": "The desired first name of the user", "type": "string" }, "last_name": { "description": "The desired last name of the user", "type": "string" }, "middle_name": { "description": "The desired middle name of the user", "type": [ "string", "null" ] } }, "required": [ "last_name", "first_name" ], "title": "VeriffSessionPostRequestBodyContentApplicationJsonSchemaDataUserInput", "type": "object" }, "VeriffSessionPostResponsesContentApplicationJsonSchemaData": { "properties": { "url": { "description": "The URL of the Veriff session", "type": "string" } }, "required": [ "url" ], "title": "VeriffSessionPostResponsesContentApplicationJsonSchemaData", "type": "object" }, "ViewInformationAboutAmendment-v2026-01-01RequestBadRequestError": { "properties": { "errors": { "items": { "$ref": "#/components/schemas/EorContractsContractIdAmendmentsAmendmentIdGetResponsesContentApplicationJsonSchemaErrorsItems" }, "type": "array" } }, "required": [ "errors" ], "title": "ViewInformationAboutAmendment-v2026-01-01RequestBadRequestError", "type": "object" }, "ViewInformationAboutAmendment-v2026-01-01RequestInternalServerError": { "properties": { "errors": { "items": { "$ref": "#/components/schemas/EorContractsContractIdAmendmentsAmendmentIdGetResponsesContentApplicationJsonSchemaErrorsItems" }, "type": "array" } }, "required": [ "errors" ], "title": "ViewInformationAboutAmendment-v2026-01-01RequestInternalServerError", "type": "object" }, "ViewInformationAboutAmendment-v2026-01-01RequestNotFoundError": { "properties": { "errors": { "items": { "$ref": "#/components/schemas/EorContractsContractIdAmendmentsAmendmentIdGetResponsesContentApplicationJsonSchemaErrorsItems" }, "type": "array" } }, "required": [ "errors" ], "title": "ViewInformationAboutAmendment-v2026-01-01RequestNotFoundError", "type": "object" }, "VmsRequisitionsGetParametersApprovalStatusSchemaItems": { "enum": [ "NOT_REQUESTED", "REQUESTED", "APPROVED", "REJECTED", "CANCELLED" ], "title": "VmsRequisitionsGetParametersApprovalStatusSchemaItems", "type": "string" }, "VmsRequisitionsGetParametersContractTypeSchemaItems": { "enum": [ "EMPLOYEE", "CONTRACTOR" ], "title": "VmsRequisitionsGetParametersContractTypeSchemaItems", "type": "string" }, "VmsRequisitionsGetParametersRateScale": { "enum": [ "HOURLY", "MILESTONE", "DAILY", "WEEKLY", "MONTHLY", "ANNUAL" ], "title": "VmsRequisitionsGetParametersRateScale", "type": "string" }, "VmsRequisitionsGetParametersRequestType": { "default": "GENERAL", "enum": [ "GENERAL", "PENDING_TASKS" ], "title": "VmsRequisitionsGetParametersRequestType", "type": "string" }, "VmsRequisitionsGetParametersSortBy": { "default": "created_at", "enum": [ "n_candidates", "n_positions", "rate_min", "rate_max", "created_at", "start_date", "end_date", "status" ], "title": "VmsRequisitionsGetParametersSortBy", "type": "string" }, "VmsRequisitionsGetParametersSortOrder": { "default": "ASC", "enum": [ "ASC", "DESC" ], "title": "VmsRequisitionsGetParametersSortOrder", "type": "string" }, "VmsRequisitionsGetParametersStatusSchemaItems": { "enum": [ "ACTIVE", "PAUSED", "CLOSED", "NOT_SHARED" ], "title": "VmsRequisitionsGetParametersStatusSchemaItems", "type": "string" }, "VmsRequisitionsGetParametersWorkMode": { "enum": [ "REMOTE", "OFFICE", "HYBRID" ], "title": "VmsRequisitionsGetParametersWorkMode", "type": "string" }, "VmsRequisitionsGetResponsesContentApplicationJsonSchemaDataItems": { "properties": { "approval_policy_id": { "description": "Identifier of the approval policy applied to the job request.", "type": [ "string", "null" ] }, "approval_status": { "$ref": "#/components/schemas/VmsRequisitionsGetResponsesContentApplicationJsonSchemaDataItemsApprovalStatus", "description": "Approval status of the job request." }, "candidate_count": { "description": "Total number of candidates on the job request.", "type": "integer" }, "candidate_limit": { "description": "Maximum number of candidates each talent partner may submit.", "type": [ "integer", "null" ] }, "close_note": { "description": "Free-text note recorded when closing the job request.", "type": [ "string", "null" ] }, "close_reason": { "description": "Reason the job request was closed.", "type": [ "string", "null" ] }, "contract_length_type": { "description": "Whether the engagement is fixed-term or indefinite.", "oneOf": [ { "$ref": "#/components/schemas/VmsRequisitionsGetResponsesContentApplicationJsonSchemaDataItemsContractLengthType" }, { "type": "null" } ] }, "contract_type": { "description": "Contract type of the job request.", "oneOf": [ { "$ref": "#/components/schemas/VmsRequisitionsGetResponsesContentApplicationJsonSchemaDataItemsContractType" }, { "type": "null" } ] }, "created_at": { "description": "When the job request was created.", "format": "date-time", "type": "string" }, "currency": { "description": "ISO 4217 currency code of the rate.", "type": [ "string", "null" ] }, "description": { "description": "Job request description.", "type": [ "string", "null" ] }, "employment_type": { "description": "Employment type.", "oneOf": [ { "$ref": "#/components/schemas/VmsRequisitionsGetResponsesContentApplicationJsonSchemaDataItemsEmploymentType" }, { "type": "null" } ] }, "end_date": { "description": "Requested end date.", "format": "date-time", "type": [ "string", "null" ] }, "has_non_vendor_candidates": { "description": "Whether the job request has candidates not sourced through a talent partner.", "type": "boolean" }, "hours_per_month": { "description": "Expected hours per month.", "type": [ "integer", "null" ] }, "id": { "description": "Unique identifier of the job request.", "type": [ "string", "null" ] }, "job_family": { "description": "Job family.", "type": [ "string", "null" ] }, "locations": { "description": "ISO 3166-1 alpha-2 country codes the job request targets.", "items": { "type": "string" }, "type": [ "array", "null" ] }, "marked_as_inactive_at": { "description": "When the job request was flagged as inactive, if it was.", "format": "date-time", "type": [ "string", "null" ] }, "organization": { "$ref": "#/components/schemas/VmsRequisitionsGetResponsesContentApplicationJsonSchemaDataItemsOrganization", "description": "Organization the job request belongs to." }, "pending_initial_screening_candidates_count": { "description": "Candidates awaiting initial screening. Returned as `0` when the token owner is only an approver on the job request.", "type": "integer" }, "pending_interview_candidates_count": { "description": "Candidates awaiting an interview. Returned as `0` when the token owner is only an approver on the job request.", "type": "integer" }, "quantity": { "description": "Number of open positions.", "type": "integer" }, "rate_max": { "description": "Upper bound of the rate range.", "format": "double", "type": [ "number", "null" ] }, "rate_min": { "description": "Lower bound of the rate range.", "format": "double", "type": [ "number", "null" ] }, "rate_scale": { "description": "Scale the rate range is expressed in.", "oneOf": [ { "$ref": "#/components/schemas/VmsRequisitionsGetResponsesContentApplicationJsonSchemaDataItemsRateScale" }, { "type": "null" } ] }, "ready_for_offer_candidates_count": { "description": "Candidates ready to receive an offer. Returned as `0` when the token owner is only an approver on the job request.", "type": "integer" }, "ready_to_hire_candidates_count": { "description": "Candidates who accepted an offer and are ready to be hired. Returned as `0` when the token owner is only an approver on the job request.", "type": "integer" }, "service_status": { "description": "Whether Deel can service the job request.", "oneOf": [ { "$ref": "#/components/schemas/VmsRequisitionsGetResponsesContentApplicationJsonSchemaDataItemsServiceStatus" }, { "type": "null" } ] }, "start_date": { "description": "Requested start date.", "format": "date-time", "type": [ "string", "null" ] }, "status": { "$ref": "#/components/schemas/VmsRequisitionsGetResponsesContentApplicationJsonSchemaDataItemsStatus", "description": "Job request status." }, "title": { "description": "Job request title.", "type": "string" }, "total_hired_candidates": { "description": "Number of candidates hired on this job request.", "type": "integer" }, "total_vendors": { "description": "Number of talent partners attached to the job request.", "type": "integer" }, "total_vendors_per_status": { "additionalProperties": { "type": "integer" }, "description": "Count of attached talent partners per status.", "type": "object" }, "updated_at": { "description": "When the job request was last updated.", "format": "date-time", "type": "string" }, "vendors": { "description": "Talent partners attached to the job request.", "items": { "$ref": "#/components/schemas/VmsRequisitionsGetResponsesContentApplicationJsonSchemaDataItemsVendorsItems" }, "type": "array" }, "work_mode": { "description": "Work mode.", "oneOf": [ { "$ref": "#/components/schemas/VmsRequisitionsGetResponsesContentApplicationJsonSchemaDataItemsWorkMode" }, { "type": "null" } ] }, "yoe_min": { "description": "Minimum years of experience required.", "type": [ "integer", "null" ] } }, "title": "VmsRequisitionsGetResponsesContentApplicationJsonSchemaDataItems", "type": "object" }, "VmsRequisitionsGetResponsesContentApplicationJsonSchemaDataItemsApprovalStatus": { "description": "Approval status of the job request.", "enum": [ "NOT_REQUESTED", "REQUESTED", "APPROVED", "REJECTED", "CANCELLED" ], "title": "VmsRequisitionsGetResponsesContentApplicationJsonSchemaDataItemsApprovalStatus", "type": "string" }, "VmsRequisitionsGetResponsesContentApplicationJsonSchemaDataItemsContractLengthType": { "description": "Whether the engagement is fixed-term or indefinite.", "enum": [ "FIXED", "INDEFINITE" ], "title": "VmsRequisitionsGetResponsesContentApplicationJsonSchemaDataItemsContractLengthType", "type": "string" }, "VmsRequisitionsGetResponsesContentApplicationJsonSchemaDataItemsContractType": { "description": "Contract type of the job request.", "enum": [ "EMPLOYEE", "CONTRACTOR" ], "title": "VmsRequisitionsGetResponsesContentApplicationJsonSchemaDataItemsContractType", "type": "string" }, "VmsRequisitionsGetResponsesContentApplicationJsonSchemaDataItemsEmploymentType": { "description": "Employment type.", "enum": [ "FULL_TIME", "PART_TIME" ], "title": "VmsRequisitionsGetResponsesContentApplicationJsonSchemaDataItemsEmploymentType", "type": "string" }, "VmsRequisitionsGetResponsesContentApplicationJsonSchemaDataItemsOrganization": { "description": "Organization the job request belongs to.", "properties": { "id": { "description": "Unique identifier of the organization.", "type": [ "string", "null" ] }, "name": { "description": "Organization name.", "type": [ "string", "null" ] } }, "title": "VmsRequisitionsGetResponsesContentApplicationJsonSchemaDataItemsOrganization", "type": "object" }, "VmsRequisitionsGetResponsesContentApplicationJsonSchemaDataItemsRateScale": { "description": "Scale the rate range is expressed in.", "enum": [ "HOURLY", "MILESTONE", "DAILY", "WEEKLY", "MONTHLY", "ANNUAL" ], "title": "VmsRequisitionsGetResponsesContentApplicationJsonSchemaDataItemsRateScale", "type": "string" }, "VmsRequisitionsGetResponsesContentApplicationJsonSchemaDataItemsServiceStatus": { "description": "Whether Deel can service the job request.", "enum": [ "PENDING", "SERVICEABLE", "NOT_SERVICEABLE" ], "title": "VmsRequisitionsGetResponsesContentApplicationJsonSchemaDataItemsServiceStatus", "type": "string" }, "VmsRequisitionsGetResponsesContentApplicationJsonSchemaDataItemsStatus": { "description": "Job request status.", "enum": [ "ACTIVE", "PAUSED", "CLOSED", "NOT_SHARED" ], "title": "VmsRequisitionsGetResponsesContentApplicationJsonSchemaDataItemsStatus", "type": "string" }, "VmsRequisitionsGetResponsesContentApplicationJsonSchemaDataItemsVendorsItems": { "properties": { "created_at": { "description": "When the talent partner was attached.", "format": "date-time", "type": "string" }, "fee_type": { "$ref": "#/components/schemas/VmsRequisitionsGetResponsesContentApplicationJsonSchemaDataItemsVendorsItemsFeeType", "description": "Agreed fee type." }, "fee_value": { "description": "Agreed fee value.", "format": "double", "type": "number" }, "hirer_withdrawn_reason": { "description": "Reason the client withdrew the talent partner.", "type": [ "string", "null" ] }, "id": { "description": "Unique identifier of the talent partner.", "type": [ "string", "null" ] }, "logo_url": { "description": "Talent partner logo URL.", "type": [ "string", "null" ] }, "name": { "description": "Name of the talent partner.", "type": "string" }, "rejected_reason": { "description": "Reason the talent partner rejected the job request.", "type": [ "string", "null" ] }, "status": { "$ref": "#/components/schemas/VmsRequisitionsGetResponsesContentApplicationJsonSchemaDataItemsVendorsItemsStatus", "description": "Status of the talent partner on this job request." }, "status_updated_at": { "description": "When the status last changed.", "format": "date-time", "type": "string" }, "updated_at": { "description": "When the attachment was last updated.", "format": "date-time", "type": "string" }, "vendor_withdrawn_reason": { "description": "Reason the talent partner withdrew.", "type": [ "string", "null" ] }, "work_order_status": { "$ref": "#/components/schemas/VmsRequisitionsGetResponsesContentApplicationJsonSchemaDataItemsVendorsItemsWorkOrderStatus", "description": "Status of the associated work order." }, "work_order_status_updated_at": { "description": "When the work order status last changed.", "format": "date-time", "type": [ "string", "null" ] } }, "title": "VmsRequisitionsGetResponsesContentApplicationJsonSchemaDataItemsVendorsItems", "type": "object" }, "VmsRequisitionsGetResponsesContentApplicationJsonSchemaDataItemsVendorsItemsFeeType": { "description": "Agreed fee type.", "enum": [ "ONE_TIME_FIXED", "ONE_TIME_PERCENTAGE", "RECURRING_FIXED", "RECURRING_PERCENTAGE", "DEPRECATED" ], "title": "VmsRequisitionsGetResponsesContentApplicationJsonSchemaDataItemsVendorsItemsFeeType", "type": "string" }, "VmsRequisitionsGetResponsesContentApplicationJsonSchemaDataItemsVendorsItemsStatus": { "description": "Status of the talent partner on this job request.", "enum": [ "APPROVED", "REJECTED", "PENDING_APPROVAL", "HIDDEN_BY_HIRER", "WITHDRAWN_BY_HIRER", "WITHDRAWN_BY_VENDOR" ], "title": "VmsRequisitionsGetResponsesContentApplicationJsonSchemaDataItemsVendorsItemsStatus", "type": "string" }, "VmsRequisitionsGetResponsesContentApplicationJsonSchemaDataItemsVendorsItemsWorkOrderStatus": { "description": "Status of the associated work order.", "enum": [ "NOT_REQUIRED", "AWAITING_CREATION", "PENDING_VENDOR_SIGNATURE", "REJECTED_BY_VENDOR", "REJECTED_DUE_TO_INACTIVITY", "REJECTED_BY_HIRER", "SIGNED" ], "title": "VmsRequisitionsGetResponsesContentApplicationJsonSchemaDataItemsVendorsItemsWorkOrderStatus", "type": "string" }, "VmsRequisitionsGetResponsesContentApplicationJsonSchemaDataItemsWorkMode": { "description": "Work mode.", "enum": [ "REMOTE", "OFFICE", "HYBRID" ], "title": "VmsRequisitionsGetResponsesContentApplicationJsonSchemaDataItemsWorkMode", "type": "string" }, "VmsRequisitionsGetResponsesContentApplicationJsonSchemaErrorsItems": { "properties": { "code": { "description": "Machine-readable error code", "type": "string" }, "message": { "description": "Human-readable explanation", "type": "string" } }, "title": "VmsRequisitionsGetResponsesContentApplicationJsonSchemaErrorsItems", "type": "object" }, "VmsRequisitionsGetResponsesContentApplicationJsonSchemaPage": { "description": "Pagination metadata.", "properties": { "cursor": { "description": "Cursor to pass to the next request. Empty when no records remain.", "type": "string" }, "total_rows": { "description": "Total number of job requests matching the filters.", "type": "integer" } }, "required": [ "cursor", "total_rows" ], "title": "VmsRequisitionsGetResponsesContentApplicationJsonSchemaPage", "type": "object" }, "WebhooksEventsAtsApplicationCreatedPostPayloadContentApplicationJsonSchemaData": { "properties": { "meta": { "$ref": "#/components/schemas/WebhooksEventsAtsApplicationCreatedPostPayloadContentApplicationJsonSchemaDataMeta" }, "resource": { "$ref": "#/components/schemas/WebhooksEventsAtsApplicationCreatedPostPayloadContentApplicationJsonSchemaDataResource" } }, "title": "WebhooksEventsAtsApplicationCreatedPostPayloadContentApplicationJsonSchemaData", "type": "object" }, "WebhooksEventsAtsApplicationCreatedPostPayloadContentApplicationJsonSchemaDataMeta": { "properties": { "event_type": { "type": "string" }, "event_type_id": { "type": "string" }, "organization_id": { "type": "string" }, "organization_name": { "type": "string" }, "tracking_id": { "type": "string" } }, "title": "WebhooksEventsAtsApplicationCreatedPostPayloadContentApplicationJsonSchemaDataMeta", "type": "object" }, "WebhooksEventsAtsApplicationCreatedPostPayloadContentApplicationJsonSchemaDataResource": { "properties": { "candidate": { "$ref": "#/components/schemas/WebhooksEventsAtsApplicationCreatedPostPayloadContentApplicationJsonSchemaDataResourceCandidate" }, "created_at": { "type": "string" }, "current_application_interview_plan_stage_id": { "type": "string" }, "id": { "type": "string" }, "job": { "$ref": "#/components/schemas/WebhooksEventsAtsApplicationCreatedPostPayloadContentApplicationJsonSchemaDataResourceJob" }, "job_board_id": { "type": "string" }, "job_employment_type_id": { "type": "string" }, "job_posting_id": { "type": "string" }, "numeric_id": { "type": "integer" }, "source_slug": { "type": "string" } }, "title": "WebhooksEventsAtsApplicationCreatedPostPayloadContentApplicationJsonSchemaDataResource", "type": "object" }, "WebhooksEventsAtsApplicationCreatedPostPayloadContentApplicationJsonSchemaDataResourceCandidate": { "properties": { "email": { "type": "string" }, "first_name": { "type": "string" }, "id": { "type": "string" }, "last_name": { "type": "string" }, "linkedin_profile_url": { "type": "string" }, "numeric_id": { "type": "integer" }, "phone_number": { "type": "string" } }, "title": "WebhooksEventsAtsApplicationCreatedPostPayloadContentApplicationJsonSchemaDataResourceCandidate", "type": "object" }, "WebhooksEventsAtsApplicationCreatedPostPayloadContentApplicationJsonSchemaDataResourceJob": { "properties": { "id": { "type": "string" }, "title": { "type": "string" } }, "title": "WebhooksEventsAtsApplicationCreatedPostPayloadContentApplicationJsonSchemaDataResourceJob", "type": "object" }, "WebhooksEventsAtsApplicationTransitionedPostPayloadContentApplicationJsonSchemaData": { "properties": { "meta": { "$ref": "#/components/schemas/WebhooksEventsAtsApplicationTransitionedPostPayloadContentApplicationJsonSchemaDataMeta" }, "resource": { "$ref": "#/components/schemas/WebhooksEventsAtsApplicationTransitionedPostPayloadContentApplicationJsonSchemaDataResource" } }, "title": "WebhooksEventsAtsApplicationTransitionedPostPayloadContentApplicationJsonSchemaData", "type": "object" }, "WebhooksEventsAtsApplicationTransitionedPostPayloadContentApplicationJsonSchemaDataMeta": { "properties": { "event_type": { "type": "string" }, "event_type_id": { "type": "string" }, "organization_id": { "type": "string" }, "organization_name": { "type": "string" }, "tracking_id": { "type": "string" } }, "title": "WebhooksEventsAtsApplicationTransitionedPostPayloadContentApplicationJsonSchemaDataMeta", "type": "object" }, "WebhooksEventsAtsApplicationTransitionedPostPayloadContentApplicationJsonSchemaDataResource": { "properties": { "candidate": { "$ref": "#/components/schemas/WebhooksEventsAtsApplicationTransitionedPostPayloadContentApplicationJsonSchemaDataResourceCandidate" }, "current_application_interview_plan_stage": { "$ref": "#/components/schemas/WebhooksEventsAtsApplicationTransitionedPostPayloadContentApplicationJsonSchemaDataResourceCurrentApplicationInterviewPlanStage" }, "hired_at": { "type": "string" }, "id": { "type": "string" }, "job": { "$ref": "#/components/schemas/WebhooksEventsAtsApplicationTransitionedPostPayloadContentApplicationJsonSchemaDataResourceJob" }, "numeric_id": { "type": "integer" }, "previous_application_interview_plan_stage": { "$ref": "#/components/schemas/WebhooksEventsAtsApplicationTransitionedPostPayloadContentApplicationJsonSchemaDataResourcePreviousApplicationInterviewPlanStage" }, "transitioned_at": { "type": "string" } }, "title": "WebhooksEventsAtsApplicationTransitionedPostPayloadContentApplicationJsonSchemaDataResource", "type": "object" }, "WebhooksEventsAtsApplicationTransitionedPostPayloadContentApplicationJsonSchemaDataResourceCandidate": { "properties": { "email": { "type": "string" }, "first_name": { "type": "string" }, "id": { "type": "string" }, "last_name": { "type": "string" }, "linkedin_profile_url": { "type": "string" }, "numeric_id": { "type": "integer" }, "phone_number": { "type": "string" } }, "title": "WebhooksEventsAtsApplicationTransitionedPostPayloadContentApplicationJsonSchemaDataResourceCandidate", "type": "object" }, "WebhooksEventsAtsApplicationTransitionedPostPayloadContentApplicationJsonSchemaDataResourceCurrentApplicationInterviewPlanStage": { "properties": { "created_at": { "type": "string" }, "id": { "type": "string" }, "interview_plan_stage": { "$ref": "#/components/schemas/WebhooksEventsAtsApplicationTransitionedPostPayloadContentApplicationJsonSchemaDataResourceCurrentApplicationInterviewPlanStageInterviewPlanStage" } }, "title": "WebhooksEventsAtsApplicationTransitionedPostPayloadContentApplicationJsonSchemaDataResourceCurrentApplicationInterviewPlanStage", "type": "object" }, "WebhooksEventsAtsApplicationTransitionedPostPayloadContentApplicationJsonSchemaDataResourceCurrentApplicationInterviewPlanStageInterviewPlanStage": { "properties": { "category_type_slug": { "type": "string" }, "default_type_slug": { "type": "string" }, "id": { "type": "string" }, "name": { "type": "string" } }, "title": "WebhooksEventsAtsApplicationTransitionedPostPayloadContentApplicationJsonSchemaDataResourceCurrentApplicationInterviewPlanStageInterviewPlanStage", "type": "object" }, "WebhooksEventsAtsApplicationTransitionedPostPayloadContentApplicationJsonSchemaDataResourceJob": { "properties": { "id": { "type": "string" }, "title": { "type": "string" } }, "title": "WebhooksEventsAtsApplicationTransitionedPostPayloadContentApplicationJsonSchemaDataResourceJob", "type": "object" }, "WebhooksEventsAtsApplicationTransitionedPostPayloadContentApplicationJsonSchemaDataResourcePreviousApplicationInterviewPlanStage": { "properties": { "created_at": { "type": "string" }, "id": { "type": "string" }, "interview_plan_stage": { "$ref": "#/components/schemas/WebhooksEventsAtsApplicationTransitionedPostPayloadContentApplicationJsonSchemaDataResourcePreviousApplicationInterviewPlanStageInterviewPlanStage" } }, "title": "WebhooksEventsAtsApplicationTransitionedPostPayloadContentApplicationJsonSchemaDataResourcePreviousApplicationInterviewPlanStage", "type": "object" }, "WebhooksEventsAtsApplicationTransitionedPostPayloadContentApplicationJsonSchemaDataResourcePreviousApplicationInterviewPlanStageInterviewPlanStage": { "properties": { "category_type_slug": { "type": "string" }, "default_type_slug": { "type": "string" }, "id": { "type": "string" }, "name": { "type": "string" } }, "title": "WebhooksEventsAtsApplicationTransitionedPostPayloadContentApplicationJsonSchemaDataResourcePreviousApplicationInterviewPlanStageInterviewPlanStage", "type": "object" }, "WebhooksEventsAtsJobPostingCreatedPostPayloadContentApplicationJsonSchemaData": { "properties": { "meta": { "$ref": "#/components/schemas/WebhooksEventsAtsJobPostingCreatedPostPayloadContentApplicationJsonSchemaDataMeta" }, "resource": { "$ref": "#/components/schemas/WebhooksEventsAtsJobPostingCreatedPostPayloadContentApplicationJsonSchemaDataResource" } }, "title": "WebhooksEventsAtsJobPostingCreatedPostPayloadContentApplicationJsonSchemaData", "type": "object" }, "WebhooksEventsAtsJobPostingCreatedPostPayloadContentApplicationJsonSchemaDataMeta": { "properties": { "event_type": { "type": "string" }, "event_type_id": { "type": "string" }, "organization_id": { "type": "string" }, "organization_name": { "type": "string" }, "tracking_id": { "type": "string" } }, "title": "WebhooksEventsAtsJobPostingCreatedPostPayloadContentApplicationJsonSchemaDataMeta", "type": "object" }, "WebhooksEventsAtsJobPostingCreatedPostPayloadContentApplicationJsonSchemaDataResource": { "properties": { "created_at": { "type": "string" }, "id": { "type": "string" }, "job": { "$ref": "#/components/schemas/WebhooksEventsAtsJobPostingCreatedPostPayloadContentApplicationJsonSchemaDataResourceJob" }, "job_id": { "type": "string" }, "status": { "type": "string" }, "title": { "type": "string" }, "updated_at": { "type": "string" } }, "title": "WebhooksEventsAtsJobPostingCreatedPostPayloadContentApplicationJsonSchemaDataResource", "type": "object" }, "WebhooksEventsAtsJobPostingCreatedPostPayloadContentApplicationJsonSchemaDataResourceJob": { "properties": { "id": { "type": "string" }, "title": { "type": "string" } }, "title": "WebhooksEventsAtsJobPostingCreatedPostPayloadContentApplicationJsonSchemaDataResourceJob", "type": "object" }, "WebhooksEventsAtsJobPostingPublicationCreatedPostPayloadContentApplicationJsonSchemaData": { "properties": { "meta": { "$ref": "#/components/schemas/WebhooksEventsAtsJobPostingPublicationCreatedPostPayloadContentApplicationJsonSchemaDataMeta" }, "resource": { "$ref": "#/components/schemas/WebhooksEventsAtsJobPostingPublicationCreatedPostPayloadContentApplicationJsonSchemaDataResource" } }, "title": "WebhooksEventsAtsJobPostingPublicationCreatedPostPayloadContentApplicationJsonSchemaData", "type": "object" }, "WebhooksEventsAtsJobPostingPublicationCreatedPostPayloadContentApplicationJsonSchemaDataMeta": { "properties": { "event_type": { "type": "string" }, "event_type_id": { "type": "string" }, "organization_id": { "type": "string" }, "organization_name": { "type": "string" }, "tracking_id": { "type": "string" } }, "title": "WebhooksEventsAtsJobPostingPublicationCreatedPostPayloadContentApplicationJsonSchemaDataMeta", "type": "object" }, "WebhooksEventsAtsJobPostingPublicationCreatedPostPayloadContentApplicationJsonSchemaDataResource": { "properties": { "category_slugs": { "items": { "type": "string" }, "type": "array" }, "created_at": { "type": "string" }, "experience_level_slug": { "type": "string" }, "expires_at": { "type": [ "string", "null" ] }, "external_reference_id": { "type": [ "string", "null" ] }, "external_url": { "type": [ "string", "null" ] }, "id": { "type": "string" }, "job": { "$ref": "#/components/schemas/WebhooksEventsAtsJobPostingPublicationCreatedPostPayloadContentApplicationJsonSchemaDataResourceJob" }, "job_board": { "$ref": "#/components/schemas/WebhooksEventsAtsJobPostingPublicationCreatedPostPayloadContentApplicationJsonSchemaDataResourceJobBoard" }, "job_board_id": { "type": "string" }, "job_employment_type_id": { "type": "string" }, "job_location_id": { "type": "string" }, "job_posting": { "$ref": "#/components/schemas/WebhooksEventsAtsJobPostingPublicationCreatedPostPayloadContentApplicationJsonSchemaDataResourceJobPosting" }, "job_posting_id": { "type": "string" }, "state_slug": { "type": "string" }, "updated_at": { "type": "string" }, "workplace_location_enum": { "type": "string" } }, "title": "WebhooksEventsAtsJobPostingPublicationCreatedPostPayloadContentApplicationJsonSchemaDataResource", "type": "object" }, "WebhooksEventsAtsJobPostingPublicationCreatedPostPayloadContentApplicationJsonSchemaDataResourceJob": { "properties": { "id": { "type": "string" }, "title": { "type": "string" } }, "title": "WebhooksEventsAtsJobPostingPublicationCreatedPostPayloadContentApplicationJsonSchemaDataResourceJob", "type": "object" }, "WebhooksEventsAtsJobPostingPublicationCreatedPostPayloadContentApplicationJsonSchemaDataResourceJobBoard": { "properties": { "id": { "type": "string" }, "type_enum": { "type": "string" } }, "title": "WebhooksEventsAtsJobPostingPublicationCreatedPostPayloadContentApplicationJsonSchemaDataResourceJobBoard", "type": "object" }, "WebhooksEventsAtsJobPostingPublicationCreatedPostPayloadContentApplicationJsonSchemaDataResourceJobPosting": { "properties": { "id": { "type": "string" }, "title": { "type": "string" } }, "title": "WebhooksEventsAtsJobPostingPublicationCreatedPostPayloadContentApplicationJsonSchemaDataResourceJobPosting", "type": "object" }, "WebhooksEventsAtsJobPostingPublicationUpdatedPostPayloadContentApplicationJsonSchemaData": { "properties": { "meta": { "$ref": "#/components/schemas/WebhooksEventsAtsJobPostingPublicationUpdatedPostPayloadContentApplicationJsonSchemaDataMeta" }, "resource": { "$ref": "#/components/schemas/WebhooksEventsAtsJobPostingPublicationUpdatedPostPayloadContentApplicationJsonSchemaDataResource" } }, "title": "WebhooksEventsAtsJobPostingPublicationUpdatedPostPayloadContentApplicationJsonSchemaData", "type": "object" }, "WebhooksEventsAtsJobPostingPublicationUpdatedPostPayloadContentApplicationJsonSchemaDataMeta": { "properties": { "event_type": { "type": "string" }, "event_type_id": { "type": "string" }, "organization_id": { "type": "string" }, "organization_name": { "type": "string" }, "tracking_id": { "type": "string" } }, "title": "WebhooksEventsAtsJobPostingPublicationUpdatedPostPayloadContentApplicationJsonSchemaDataMeta", "type": "object" }, "WebhooksEventsAtsJobPostingPublicationUpdatedPostPayloadContentApplicationJsonSchemaDataResource": { "properties": { "category_slugs": { "items": { "type": "string" }, "type": "array" }, "created_at": { "type": "string" }, "experience_level_slug": { "type": "string" }, "expires_at": { "type": "string" }, "external_reference_id": { "type": "string" }, "external_url": { "type": "string" }, "id": { "type": "string" }, "job": { "$ref": "#/components/schemas/WebhooksEventsAtsJobPostingPublicationUpdatedPostPayloadContentApplicationJsonSchemaDataResourceJob" }, "job_board": { "$ref": "#/components/schemas/WebhooksEventsAtsJobPostingPublicationUpdatedPostPayloadContentApplicationJsonSchemaDataResourceJobBoard" }, "job_board_id": { "type": "string" }, "job_employment_type_id": { "type": "string" }, "job_location_id": { "type": "string" }, "job_posting": { "$ref": "#/components/schemas/WebhooksEventsAtsJobPostingPublicationUpdatedPostPayloadContentApplicationJsonSchemaDataResourceJobPosting" }, "job_posting_id": { "type": "string" }, "state_slug": { "type": "string" }, "updated_at": { "type": "string" }, "workplace_location_enum": { "type": "string" } }, "title": "WebhooksEventsAtsJobPostingPublicationUpdatedPostPayloadContentApplicationJsonSchemaDataResource", "type": "object" }, "WebhooksEventsAtsJobPostingPublicationUpdatedPostPayloadContentApplicationJsonSchemaDataResourceJob": { "properties": { "id": { "type": "string" }, "title": { "type": "string" } }, "title": "WebhooksEventsAtsJobPostingPublicationUpdatedPostPayloadContentApplicationJsonSchemaDataResourceJob", "type": "object" }, "WebhooksEventsAtsJobPostingPublicationUpdatedPostPayloadContentApplicationJsonSchemaDataResourceJobBoard": { "properties": { "id": { "type": "string" }, "type_enum": { "type": "string" } }, "title": "WebhooksEventsAtsJobPostingPublicationUpdatedPostPayloadContentApplicationJsonSchemaDataResourceJobBoard", "type": "object" }, "WebhooksEventsAtsJobPostingPublicationUpdatedPostPayloadContentApplicationJsonSchemaDataResourceJobPosting": { "properties": { "id": { "type": "string" }, "title": { "type": "string" } }, "title": "WebhooksEventsAtsJobPostingPublicationUpdatedPostPayloadContentApplicationJsonSchemaDataResourceJobPosting", "type": "object" }, "WebhooksEventsAtsJobPostingUpdatedPostPayloadContentApplicationJsonSchemaData": { "properties": { "meta": { "$ref": "#/components/schemas/WebhooksEventsAtsJobPostingUpdatedPostPayloadContentApplicationJsonSchemaDataMeta" }, "resource": { "$ref": "#/components/schemas/WebhooksEventsAtsJobPostingUpdatedPostPayloadContentApplicationJsonSchemaDataResource" } }, "title": "WebhooksEventsAtsJobPostingUpdatedPostPayloadContentApplicationJsonSchemaData", "type": "object" }, "WebhooksEventsAtsJobPostingUpdatedPostPayloadContentApplicationJsonSchemaDataMeta": { "properties": { "event_type": { "type": "string" }, "event_type_id": { "type": "string" }, "organization_id": { "type": "string" }, "organization_name": { "type": "string" }, "tracking_id": { "type": "string" } }, "title": "WebhooksEventsAtsJobPostingUpdatedPostPayloadContentApplicationJsonSchemaDataMeta", "type": "object" }, "WebhooksEventsAtsJobPostingUpdatedPostPayloadContentApplicationJsonSchemaDataResource": { "properties": { "created_at": { "type": "string" }, "id": { "type": "string" }, "job": { "$ref": "#/components/schemas/WebhooksEventsAtsJobPostingUpdatedPostPayloadContentApplicationJsonSchemaDataResourceJob" }, "job_id": { "type": "string" }, "status": { "type": "string" }, "title": { "type": "string" }, "updated_at": { "type": "string" } }, "title": "WebhooksEventsAtsJobPostingUpdatedPostPayloadContentApplicationJsonSchemaDataResource", "type": "object" }, "WebhooksEventsAtsJobPostingUpdatedPostPayloadContentApplicationJsonSchemaDataResourceJob": { "properties": { "id": { "type": "string" }, "title": { "type": "string" } }, "title": "WebhooksEventsAtsJobPostingUpdatedPostPayloadContentApplicationJsonSchemaDataResourceJob", "type": "object" }, "WebhooksEventsBgcheckResultAvailablePostPayloadContentApplicationJsonSchemaData": { "properties": { "meta": { "$ref": "#/components/schemas/WebhooksEventsBgcheckResultAvailablePostPayloadContentApplicationJsonSchemaDataMeta" }, "resource": { "$ref": "#/components/schemas/WebhooksEventsBgcheckResultAvailablePostPayloadContentApplicationJsonSchemaDataResource" } }, "title": "WebhooksEventsBgcheckResultAvailablePostPayloadContentApplicationJsonSchemaData", "type": "object" }, "WebhooksEventsBgcheckResultAvailablePostPayloadContentApplicationJsonSchemaDataMeta": { "properties": { "event_type": { "type": "string" }, "event_type_id": { "type": "string" }, "organization_id": { "type": "string" }, "organization_name": { "type": "string" }, "tracking_id": { "type": "string" } }, "title": "WebhooksEventsBgcheckResultAvailablePostPayloadContentApplicationJsonSchemaDataMeta", "type": "object" }, "WebhooksEventsBgcheckResultAvailablePostPayloadContentApplicationJsonSchemaDataResource": { "properties": { "candidate_email": { "type": "string" }, "completed_at": { "type": "string" }, "contract_id": { "type": "string" }, "created_at": { "type": "string" }, "id": { "type": "string" }, "is_complete": { "type": "boolean" }, "name": { "type": "string" }, "package": { "type": [ "string", "null" ] }, "result": { "type": "string" }, "status": { "type": "string" }, "third party_name": { "type": "string" } }, "title": "WebhooksEventsBgcheckResultAvailablePostPayloadContentApplicationJsonSchemaDataResource", "type": "object" }, "WebhooksEventsContractAmendedPostPayloadContentApplicationJsonSchemaData": { "properties": { "meta": { "$ref": "#/components/schemas/WebhooksEventsContractAmendedPostPayloadContentApplicationJsonSchemaDataMeta" }, "resource": { "$ref": "#/components/schemas/WebhooksEventsContractAmendedPostPayloadContentApplicationJsonSchemaDataResource" } }, "title": "WebhooksEventsContractAmendedPostPayloadContentApplicationJsonSchemaData", "type": "object" }, "WebhooksEventsContractAmendedPostPayloadContentApplicationJsonSchemaDataMeta": { "properties": { "event_type": { "type": "string" }, "event_type_id": { "type": "string" }, "organization_id": { "type": "string" }, "organization_name": { "type": "string" }, "tracking_id": { "type": "string" } }, "title": "WebhooksEventsContractAmendedPostPayloadContentApplicationJsonSchemaDataMeta", "type": "object" }, "WebhooksEventsContractAmendedPostPayloadContentApplicationJsonSchemaDataResource": { "properties": { "client": { "$ref": "#/components/schemas/WebhooksEventsContractAmendedPostPayloadContentApplicationJsonSchemaDataResourceClient" }, "compensation_details": { "$ref": "#/components/schemas/WebhooksEventsContractAmendedPostPayloadContentApplicationJsonSchemaDataResourceCompensationDetails" }, "created_at": { "type": "string" }, "employment_details": { "$ref": "#/components/schemas/WebhooksEventsContractAmendedPostPayloadContentApplicationJsonSchemaDataResourceEmploymentDetails" }, "id": { "type": "string" }, "invitations": { "$ref": "#/components/schemas/WebhooksEventsContractAmendedPostPayloadContentApplicationJsonSchemaDataResourceInvitations" }, "is_archived": { "type": "boolean" }, "job_title": { "type": "string" }, "notice_period": { "type": "integer" }, "scope_of_work": { "type": "string" }, "seniority": { "$ref": "#/components/schemas/WebhooksEventsContractAmendedPostPayloadContentApplicationJsonSchemaDataResourceSeniority" }, "signatures": { "$ref": "#/components/schemas/WebhooksEventsContractAmendedPostPayloadContentApplicationJsonSchemaDataResourceSignatures" }, "special_clause": { "type": "string" }, "start_date": { "type": "string" }, "status": { "type": "string" }, "termination_date": { "type": "string" }, "title": { "type": "string" }, "type": { "type": "string" }, "who_reports": { "type": "string" }, "worker": { "$ref": "#/components/schemas/WebhooksEventsContractAmendedPostPayloadContentApplicationJsonSchemaDataResourceWorker" } }, "title": "WebhooksEventsContractAmendedPostPayloadContentApplicationJsonSchemaDataResource", "type": "object" }, "WebhooksEventsContractAmendedPostPayloadContentApplicationJsonSchemaDataResourceClient": { "properties": { "email": { "type": "string" }, "full_name": { "type": "string" }, "id": { "type": "integer" }, "legal_entity": { "$ref": "#/components/schemas/WebhooksEventsContractAmendedPostPayloadContentApplicationJsonSchemaDataResourceClientLegalEntity" }, "team": { "$ref": "#/components/schemas/WebhooksEventsContractAmendedPostPayloadContentApplicationJsonSchemaDataResourceClientTeam" } }, "title": "WebhooksEventsContractAmendedPostPayloadContentApplicationJsonSchemaDataResourceClient", "type": "object" }, "WebhooksEventsContractAmendedPostPayloadContentApplicationJsonSchemaDataResourceClientLegalEntity": { "properties": { "email": { "type": "string" }, "id": { "type": "string" }, "name": { "type": "string" }, "registration_number": { "type": "string" }, "subtype": { "type": "string" }, "type": { "type": "string" }, "vat_number": { "type": "string" } }, "title": "WebhooksEventsContractAmendedPostPayloadContentApplicationJsonSchemaDataResourceClientLegalEntity", "type": "object" }, "WebhooksEventsContractAmendedPostPayloadContentApplicationJsonSchemaDataResourceClientTeam": { "properties": { "id": { "type": "string" }, "name": { "type": "string" } }, "title": "WebhooksEventsContractAmendedPostPayloadContentApplicationJsonSchemaDataResourceClientTeam", "type": "object" }, "WebhooksEventsContractAmendedPostPayloadContentApplicationJsonSchemaDataResourceCompensationDetails": { "properties": { "amount": { "type": "string" }, "currency_code": { "type": "string" }, "first_payment": { "type": "string" }, "first_payment_date": { "type": "string" }, "frequency": { "type": "string" }, "gross_annual_salary": { "type": "string" }, "gross_signing_bonus": { "type": "string" }, "gross_variable_bonus": { "type": "string" }, "scale": { "type": "string" } }, "title": "WebhooksEventsContractAmendedPostPayloadContentApplicationJsonSchemaDataResourceCompensationDetails", "type": "object" }, "WebhooksEventsContractAmendedPostPayloadContentApplicationJsonSchemaDataResourceEmploymentDetails": { "properties": { "days_per_week": { "type": "integer" }, "hours_per_day": { "type": "integer" }, "paid_vacation_days": { "type": "integer" }, "probation_period": { "type": "integer" }, "type": { "type": "string" } }, "title": "WebhooksEventsContractAmendedPostPayloadContentApplicationJsonSchemaDataResourceEmploymentDetails", "type": "object" }, "WebhooksEventsContractAmendedPostPayloadContentApplicationJsonSchemaDataResourceInvitations": { "properties": { "client_email": { "type": "string" }, "worker_email": { "type": "string" } }, "title": "WebhooksEventsContractAmendedPostPayloadContentApplicationJsonSchemaDataResourceInvitations", "type": "object" }, "WebhooksEventsContractAmendedPostPayloadContentApplicationJsonSchemaDataResourceSeniority": { "properties": { "id": { "type": "integer" }, "level": { "type": "integer" }, "name": { "type": "string" } }, "title": "WebhooksEventsContractAmendedPostPayloadContentApplicationJsonSchemaDataResourceSeniority", "type": "object" }, "WebhooksEventsContractAmendedPostPayloadContentApplicationJsonSchemaDataResourceSignatures": { "properties": { "client_signature": { "type": "string" }, "client_signed_at": { "type": "string" }, "signed_at": { "type": "string" }, "worker_signature": { "type": "string" }, "worker_signed_at": { "type": "string" } }, "title": "WebhooksEventsContractAmendedPostPayloadContentApplicationJsonSchemaDataResourceSignatures", "type": "object" }, "WebhooksEventsContractAmendedPostPayloadContentApplicationJsonSchemaDataResourceWorker": { "properties": { "country": { "type": "string" }, "date_of_birth": { "type": "string" }, "email": { "type": "string" }, "full_name": { "type": "string" }, "id": { "type": "integer" } }, "title": "WebhooksEventsContractAmendedPostPayloadContentApplicationJsonSchemaDataResourceWorker", "type": "object" }, "WebhooksEventsContractCreatedPostPayloadContentApplicationJsonSchemaData": { "properties": { "meta": { "$ref": "#/components/schemas/WebhooksEventsContractCreatedPostPayloadContentApplicationJsonSchemaDataMeta" }, "resource": { "$ref": "#/components/schemas/WebhooksEventsContractCreatedPostPayloadContentApplicationJsonSchemaDataResource" } }, "title": "WebhooksEventsContractCreatedPostPayloadContentApplicationJsonSchemaData", "type": "object" }, "WebhooksEventsContractCreatedPostPayloadContentApplicationJsonSchemaDataMeta": { "properties": { "event_type": { "type": "string" }, "event_type_id": { "type": "string" }, "organization_id": { "type": "string" }, "organization_name": { "type": "string" }, "tracking_id": { "type": "string" } }, "title": "WebhooksEventsContractCreatedPostPayloadContentApplicationJsonSchemaDataMeta", "type": "object" }, "WebhooksEventsContractCreatedPostPayloadContentApplicationJsonSchemaDataResource": { "properties": { "client": { "$ref": "#/components/schemas/WebhooksEventsContractCreatedPostPayloadContentApplicationJsonSchemaDataResourceClient" }, "compensation_details": { "$ref": "#/components/schemas/WebhooksEventsContractCreatedPostPayloadContentApplicationJsonSchemaDataResourceCompensationDetails" }, "created_at": { "type": "string" }, "employment_details": { "$ref": "#/components/schemas/WebhooksEventsContractCreatedPostPayloadContentApplicationJsonSchemaDataResourceEmploymentDetails" }, "id": { "type": "string" }, "invitations": { "$ref": "#/components/schemas/WebhooksEventsContractCreatedPostPayloadContentApplicationJsonSchemaDataResourceInvitations" }, "is_archived": { "type": "boolean" }, "notice_period": { "type": "integer" }, "signatures": { "$ref": "#/components/schemas/WebhooksEventsContractCreatedPostPayloadContentApplicationJsonSchemaDataResourceSignatures" }, "special_clause": { "type": "string" }, "start_date": { "type": "string" }, "status": { "type": "string" }, "termination_date": { "type": "string" }, "title": { "type": "string" }, "type": { "type": "string" }, "worker": { "$ref": "#/components/schemas/WebhooksEventsContractCreatedPostPayloadContentApplicationJsonSchemaDataResourceWorker" } }, "title": "WebhooksEventsContractCreatedPostPayloadContentApplicationJsonSchemaDataResource", "type": "object" }, "WebhooksEventsContractCreatedPostPayloadContentApplicationJsonSchemaDataResourceClient": { "properties": { "legal_entity": { "$ref": "#/components/schemas/WebhooksEventsContractCreatedPostPayloadContentApplicationJsonSchemaDataResourceClientLegalEntity" } }, "title": "WebhooksEventsContractCreatedPostPayloadContentApplicationJsonSchemaDataResourceClient", "type": "object" }, "WebhooksEventsContractCreatedPostPayloadContentApplicationJsonSchemaDataResourceClientLegalEntity": { "properties": { "email": { "type": "string" }, "name": { "type": "string" }, "registration_number": { "type": "string" }, "subtype": { "type": "string" }, "type": { "type": "string" }, "vat_number": { "type": "string" } }, "title": "WebhooksEventsContractCreatedPostPayloadContentApplicationJsonSchemaDataResourceClientLegalEntity", "type": "object" }, "WebhooksEventsContractCreatedPostPayloadContentApplicationJsonSchemaDataResourceCompensationDetails": { "properties": { "currency_code": { "type": "string" }, "first_payment": { "type": "string" }, "first_payment_date": { "type": "string" }, "frequency": { "type": "string" }, "gross_annual_salary": { "type": "string" }, "gross_signing_bonus": { "type": "string" }, "gross_variable_bonus": { "type": "string" }, "scale": { "type": "string" } }, "title": "WebhooksEventsContractCreatedPostPayloadContentApplicationJsonSchemaDataResourceCompensationDetails", "type": "object" }, "WebhooksEventsContractCreatedPostPayloadContentApplicationJsonSchemaDataResourceEmploymentDetails": { "properties": { "days_per_week": { "type": "integer" }, "hours_per_day": { "type": "integer" }, "paid_vacation_days": { "type": "integer" }, "probation_period": { "type": "integer" }, "type": { "type": "string" } }, "title": "WebhooksEventsContractCreatedPostPayloadContentApplicationJsonSchemaDataResourceEmploymentDetails", "type": "object" }, "WebhooksEventsContractCreatedPostPayloadContentApplicationJsonSchemaDataResourceInvitations": { "properties": { "client_email": { "type": "string" }, "worker_email": { "type": "string" } }, "title": "WebhooksEventsContractCreatedPostPayloadContentApplicationJsonSchemaDataResourceInvitations", "type": "object" }, "WebhooksEventsContractCreatedPostPayloadContentApplicationJsonSchemaDataResourceSignatures": { "properties": { "client_signature": { "type": "string" }, "client_signed_at": { "type": "string" }, "signed_at": { "type": "string" }, "worker_signature": { "type": "string" }, "worker_signed_at": { "type": "string" } }, "title": "WebhooksEventsContractCreatedPostPayloadContentApplicationJsonSchemaDataResourceSignatures", "type": "object" }, "WebhooksEventsContractCreatedPostPayloadContentApplicationJsonSchemaDataResourceWorker": { "properties": { "expected_email": { "type": "string" }, "first_name": { "type": "string" }, "last_name": { "type": "string" } }, "title": "WebhooksEventsContractCreatedPostPayloadContentApplicationJsonSchemaDataResourceWorker", "type": "object" }, "WebhooksEventsContractDuplicatedPostPayloadContentApplicationJsonSchemaData": { "properties": { "meta": { "$ref": "#/components/schemas/WebhooksEventsContractDuplicatedPostPayloadContentApplicationJsonSchemaDataMeta" }, "resource": { "$ref": "#/components/schemas/WebhooksEventsContractDuplicatedPostPayloadContentApplicationJsonSchemaDataResource" } }, "title": "WebhooksEventsContractDuplicatedPostPayloadContentApplicationJsonSchemaData", "type": "object" }, "WebhooksEventsContractDuplicatedPostPayloadContentApplicationJsonSchemaDataMeta": { "properties": { "event_type": { "type": "string" }, "event_type_id": { "type": "string" }, "organization_id": { "type": "string" }, "organization_name": { "type": "string" }, "tracking_id": { "type": "string" } }, "title": "WebhooksEventsContractDuplicatedPostPayloadContentApplicationJsonSchemaDataMeta", "type": "object" }, "WebhooksEventsContractDuplicatedPostPayloadContentApplicationJsonSchemaDataResource": { "properties": { "client": { "$ref": "#/components/schemas/WebhooksEventsContractDuplicatedPostPayloadContentApplicationJsonSchemaDataResourceClient" }, "compensation_details": { "$ref": "#/components/schemas/WebhooksEventsContractDuplicatedPostPayloadContentApplicationJsonSchemaDataResourceCompensationDetails" }, "created_at": { "type": "string" }, "employment_details": { "$ref": "#/components/schemas/WebhooksEventsContractDuplicatedPostPayloadContentApplicationJsonSchemaDataResourceEmploymentDetails" }, "id": { "type": "string" }, "invitations": { "$ref": "#/components/schemas/WebhooksEventsContractDuplicatedPostPayloadContentApplicationJsonSchemaDataResourceInvitations" }, "is_archived": { "type": "boolean" }, "job_title": { "type": "string" }, "notice_period": { "type": "integer" }, "signatures": { "$ref": "#/components/schemas/WebhooksEventsContractDuplicatedPostPayloadContentApplicationJsonSchemaDataResourceSignatures" }, "special_clause": { "type": "string" }, "start_date": { "type": "string" }, "status": { "type": "string" }, "termination_date": { "type": "string" }, "title": { "type": "string" }, "type": { "type": "string" }, "worker": { "$ref": "#/components/schemas/WebhooksEventsContractDuplicatedPostPayloadContentApplicationJsonSchemaDataResourceWorker" } }, "title": "WebhooksEventsContractDuplicatedPostPayloadContentApplicationJsonSchemaDataResource", "type": "object" }, "WebhooksEventsContractDuplicatedPostPayloadContentApplicationJsonSchemaDataResourceClient": { "properties": { "legal_entity": { "$ref": "#/components/schemas/WebhooksEventsContractDuplicatedPostPayloadContentApplicationJsonSchemaDataResourceClientLegalEntity" }, "team": { "$ref": "#/components/schemas/WebhooksEventsContractDuplicatedPostPayloadContentApplicationJsonSchemaDataResourceClientTeam" } }, "title": "WebhooksEventsContractDuplicatedPostPayloadContentApplicationJsonSchemaDataResourceClient", "type": "object" }, "WebhooksEventsContractDuplicatedPostPayloadContentApplicationJsonSchemaDataResourceClientLegalEntity": { "properties": { "email": { "type": "string" }, "id": { "type": "string" }, "name": { "type": "string" }, "registration_number": { "type": "string" }, "subtype": { "type": "string" }, "type": { "type": "string" }, "vat_number": { "type": "string" } }, "title": "WebhooksEventsContractDuplicatedPostPayloadContentApplicationJsonSchemaDataResourceClientLegalEntity", "type": "object" }, "WebhooksEventsContractDuplicatedPostPayloadContentApplicationJsonSchemaDataResourceClientTeam": { "properties": { "id": { "type": "string" }, "name": { "type": "string" } }, "title": "WebhooksEventsContractDuplicatedPostPayloadContentApplicationJsonSchemaDataResourceClientTeam", "type": "object" }, "WebhooksEventsContractDuplicatedPostPayloadContentApplicationJsonSchemaDataResourceCompensationDetails": { "properties": { "amount": { "type": "string" }, "currency_code": { "type": "string" }, "first_payment": { "type": "string" }, "first_payment_date": { "type": "string" }, "frequency": { "type": "string" }, "gross_annual_salary": { "type": "string" }, "gross_signing_bonus": { "type": "string" }, "gross_variable_bonus": { "type": "string" }, "scale": { "type": "string" } }, "title": "WebhooksEventsContractDuplicatedPostPayloadContentApplicationJsonSchemaDataResourceCompensationDetails", "type": "object" }, "WebhooksEventsContractDuplicatedPostPayloadContentApplicationJsonSchemaDataResourceEmploymentDetails": { "properties": { "days_per_week": { "type": "integer" }, "hours_per_day": { "type": "integer" }, "paid_vacation_days": { "type": "integer" }, "probation_period": { "type": "integer" }, "type": { "type": "string" } }, "title": "WebhooksEventsContractDuplicatedPostPayloadContentApplicationJsonSchemaDataResourceEmploymentDetails", "type": "object" }, "WebhooksEventsContractDuplicatedPostPayloadContentApplicationJsonSchemaDataResourceInvitations": { "properties": { "client_email": { "type": "string" }, "worker_email": { "type": "string" } }, "title": "WebhooksEventsContractDuplicatedPostPayloadContentApplicationJsonSchemaDataResourceInvitations", "type": "object" }, "WebhooksEventsContractDuplicatedPostPayloadContentApplicationJsonSchemaDataResourceSignatures": { "properties": { "client_signature": { "type": "string" }, "client_signed_at": { "type": "string" }, "signed_at": { "type": "string" }, "worker_signature": { "type": "string" }, "worker_signed_at": { "type": "string" } }, "title": "WebhooksEventsContractDuplicatedPostPayloadContentApplicationJsonSchemaDataResourceSignatures", "type": "object" }, "WebhooksEventsContractDuplicatedPostPayloadContentApplicationJsonSchemaDataResourceWorker": { "properties": { "expected_email": { "type": "string" }, "first_name": { "type": "string" }, "last_name": { "type": "string" } }, "title": "WebhooksEventsContractDuplicatedPostPayloadContentApplicationJsonSchemaDataResourceWorker", "type": "object" }, "WebhooksEventsContractSignTeamMemberInvitedPostPayloadContentApplicationJsonSchemaData": { "properties": { "meta": { "$ref": "#/components/schemas/WebhooksEventsContractSignTeamMemberInvitedPostPayloadContentApplicationJsonSchemaDataMeta" }, "resource": { "$ref": "#/components/schemas/WebhooksEventsContractSignTeamMemberInvitedPostPayloadContentApplicationJsonSchemaDataResource" } }, "title": "WebhooksEventsContractSignTeamMemberInvitedPostPayloadContentApplicationJsonSchemaData", "type": "object" }, "WebhooksEventsContractSignTeamMemberInvitedPostPayloadContentApplicationJsonSchemaDataMeta": { "properties": { "event_type": { "type": "string" }, "event_type_id": { "type": "string" }, "organization_id": { "type": "string" }, "organization_name": { "type": "string" }, "tracking_id": { "type": "string" } }, "title": "WebhooksEventsContractSignTeamMemberInvitedPostPayloadContentApplicationJsonSchemaDataMeta", "type": "object" }, "WebhooksEventsContractSignTeamMemberInvitedPostPayloadContentApplicationJsonSchemaDataResource": { "properties": { "contract_name": { "type": "string" }, "contract_oid": { "type": "string" }, "invitee_id": { "type": "integer" }, "invitee_name": { "type": "string" } }, "title": "WebhooksEventsContractSignTeamMemberInvitedPostPayloadContentApplicationJsonSchemaDataResource", "type": "object" }, "WebhooksEventsContractStatusUpdatedPostPayloadContentApplicationJsonSchemaData": { "properties": { "meta": { "$ref": "#/components/schemas/WebhooksEventsContractStatusUpdatedPostPayloadContentApplicationJsonSchemaDataMeta" }, "resource": { "$ref": "#/components/schemas/WebhooksEventsContractStatusUpdatedPostPayloadContentApplicationJsonSchemaDataResource" } }, "title": "WebhooksEventsContractStatusUpdatedPostPayloadContentApplicationJsonSchemaData", "type": "object" }, "WebhooksEventsContractStatusUpdatedPostPayloadContentApplicationJsonSchemaDataMeta": { "properties": { "event_type": { "type": "string" }, "event_type_id": { "type": "string" }, "organization_id": { "type": "string" }, "organization_name": { "type": "string" }, "tracking_id": { "type": "string" } }, "title": "WebhooksEventsContractStatusUpdatedPostPayloadContentApplicationJsonSchemaDataMeta", "type": "object" }, "WebhooksEventsContractStatusUpdatedPostPayloadContentApplicationJsonSchemaDataResource": { "properties": { "client": { "$ref": "#/components/schemas/WebhooksEventsContractStatusUpdatedPostPayloadContentApplicationJsonSchemaDataResourceClient" }, "compensation_details": { "$ref": "#/components/schemas/WebhooksEventsContractStatusUpdatedPostPayloadContentApplicationJsonSchemaDataResourceCompensationDetails" }, "created_at": { "type": "string" }, "employment_details": { "$ref": "#/components/schemas/WebhooksEventsContractStatusUpdatedPostPayloadContentApplicationJsonSchemaDataResourceEmploymentDetails" }, "id": { "type": "string" }, "invitations": { "$ref": "#/components/schemas/WebhooksEventsContractStatusUpdatedPostPayloadContentApplicationJsonSchemaDataResourceInvitations" }, "is_archived": { "type": "boolean" }, "job_title": { "type": "string" }, "notice_period": { "type": "integer" }, "scope_of_work": { "type": "string" }, "seniority": { "$ref": "#/components/schemas/WebhooksEventsContractStatusUpdatedPostPayloadContentApplicationJsonSchemaDataResourceSeniority" }, "signatures": { "$ref": "#/components/schemas/WebhooksEventsContractStatusUpdatedPostPayloadContentApplicationJsonSchemaDataResourceSignatures" }, "special_clause": { "type": "string" }, "start_date": { "type": "string" }, "status": { "type": "string" }, "termination_date": { "type": "string" }, "title": { "type": "string" }, "type": { "type": "string" }, "who_reports": { "type": "string" }, "worker": { "$ref": "#/components/schemas/WebhooksEventsContractStatusUpdatedPostPayloadContentApplicationJsonSchemaDataResourceWorker" } }, "title": "WebhooksEventsContractStatusUpdatedPostPayloadContentApplicationJsonSchemaDataResource", "type": "object" }, "WebhooksEventsContractStatusUpdatedPostPayloadContentApplicationJsonSchemaDataResourceClient": { "properties": { "email": { "type": "string" }, "full_name": { "type": "string" }, "id": { "type": "integer" }, "legal_entity": { "$ref": "#/components/schemas/WebhooksEventsContractStatusUpdatedPostPayloadContentApplicationJsonSchemaDataResourceClientLegalEntity" }, "team": { "$ref": "#/components/schemas/WebhooksEventsContractStatusUpdatedPostPayloadContentApplicationJsonSchemaDataResourceClientTeam" } }, "title": "WebhooksEventsContractStatusUpdatedPostPayloadContentApplicationJsonSchemaDataResourceClient", "type": "object" }, "WebhooksEventsContractStatusUpdatedPostPayloadContentApplicationJsonSchemaDataResourceClientLegalEntity": { "properties": { "email": { "type": "string" }, "id": { "type": "string" }, "name": { "type": "string" }, "registration_number": { "type": "string" }, "subtype": { "type": "string" }, "type": { "type": "string" }, "vat_number": { "type": "string" } }, "title": "WebhooksEventsContractStatusUpdatedPostPayloadContentApplicationJsonSchemaDataResourceClientLegalEntity", "type": "object" }, "WebhooksEventsContractStatusUpdatedPostPayloadContentApplicationJsonSchemaDataResourceClientTeam": { "properties": { "id": { "type": "string" }, "name": { "type": "string" } }, "title": "WebhooksEventsContractStatusUpdatedPostPayloadContentApplicationJsonSchemaDataResourceClientTeam", "type": "object" }, "WebhooksEventsContractStatusUpdatedPostPayloadContentApplicationJsonSchemaDataResourceCompensationDetails": { "properties": { "amount": { "type": "string" }, "currency_code": { "type": "string" }, "first_payment": { "type": "string" }, "first_payment_date": { "type": "string" }, "frequency": { "type": "string" }, "gross_annual_salary": { "type": "string" }, "gross_signing_bonus": { "type": "string" }, "gross_variable_bonus": { "type": "string" }, "scale": { "type": "string" } }, "title": "WebhooksEventsContractStatusUpdatedPostPayloadContentApplicationJsonSchemaDataResourceCompensationDetails", "type": "object" }, "WebhooksEventsContractStatusUpdatedPostPayloadContentApplicationJsonSchemaDataResourceEmploymentDetails": { "properties": { "days_per_week": { "type": "integer" }, "hours_per_day": { "type": "integer" }, "paid_vacation_days": { "type": "integer" }, "probation_period": { "type": "integer" }, "type": { "type": "string" } }, "title": "WebhooksEventsContractStatusUpdatedPostPayloadContentApplicationJsonSchemaDataResourceEmploymentDetails", "type": "object" }, "WebhooksEventsContractStatusUpdatedPostPayloadContentApplicationJsonSchemaDataResourceInvitations": { "properties": { "client_email": { "type": "string" }, "worker_email": { "type": "string" } }, "title": "WebhooksEventsContractStatusUpdatedPostPayloadContentApplicationJsonSchemaDataResourceInvitations", "type": "object" }, "WebhooksEventsContractStatusUpdatedPostPayloadContentApplicationJsonSchemaDataResourceSeniority": { "properties": { "id": { "type": "integer" }, "level": { "type": "integer" }, "name": { "type": "string" } }, "title": "WebhooksEventsContractStatusUpdatedPostPayloadContentApplicationJsonSchemaDataResourceSeniority", "type": "object" }, "WebhooksEventsContractStatusUpdatedPostPayloadContentApplicationJsonSchemaDataResourceSignatures": { "properties": { "client_signature": { "type": "string" }, "client_signed_at": { "type": "string" }, "signed_at": { "type": "string" }, "worker_signature": { "type": "string" }, "worker_signed_at": { "type": "string" } }, "title": "WebhooksEventsContractStatusUpdatedPostPayloadContentApplicationJsonSchemaDataResourceSignatures", "type": "object" }, "WebhooksEventsContractStatusUpdatedPostPayloadContentApplicationJsonSchemaDataResourceWorker": { "properties": { "expected_email": { "type": "string" }, "first_name": { "type": "string" }, "last_name": { "type": "string" } }, "title": "WebhooksEventsContractStatusUpdatedPostPayloadContentApplicationJsonSchemaDataResourceWorker", "type": "object" }, "WebhooksEventsContractTerminatedPostPayloadContentApplicationJsonSchemaData": { "properties": { "meta": { "$ref": "#/components/schemas/WebhooksEventsContractTerminatedPostPayloadContentApplicationJsonSchemaDataMeta" }, "resource": { "$ref": "#/components/schemas/WebhooksEventsContractTerminatedPostPayloadContentApplicationJsonSchemaDataResource" } }, "title": "WebhooksEventsContractTerminatedPostPayloadContentApplicationJsonSchemaData", "type": "object" }, "WebhooksEventsContractTerminatedPostPayloadContentApplicationJsonSchemaDataMeta": { "properties": { "event_type": { "type": "string" }, "event_type_id": { "type": "string" }, "organization_id": { "type": "string" }, "organization_name": { "type": "string" }, "tracking_id": { "type": "string" } }, "title": "WebhooksEventsContractTerminatedPostPayloadContentApplicationJsonSchemaDataMeta", "type": "object" }, "WebhooksEventsContractTerminatedPostPayloadContentApplicationJsonSchemaDataResource": { "properties": { "completion_date": { "type": "string" }, "id": { "type": "string" } }, "title": "WebhooksEventsContractTerminatedPostPayloadContentApplicationJsonSchemaDataResource", "type": "object" }, "WebhooksEventsEmployeeCreatedContractorPostPayloadContentApplicationJsonSchemaData": { "properties": { "meta": { "$ref": "#/components/schemas/WebhooksEventsEmployeeCreatedContractorPostPayloadContentApplicationJsonSchemaDataMeta" }, "resource": { "$ref": "#/components/schemas/WebhooksEventsEmployeeCreatedContractorPostPayloadContentApplicationJsonSchemaDataResource" } }, "title": "WebhooksEventsEmployeeCreatedContractorPostPayloadContentApplicationJsonSchemaData", "type": "object" }, "WebhooksEventsEmployeeCreatedContractorPostPayloadContentApplicationJsonSchemaDataMeta": { "properties": { "event_type": { "type": "string" }, "event_type_id": { "type": "string" }, "organization_id": { "type": "string" }, "organization_name": { "type": "string" }, "tracking_id": { "type": "string" } }, "title": "WebhooksEventsEmployeeCreatedContractorPostPayloadContentApplicationJsonSchemaDataMeta", "type": "object" }, "WebhooksEventsEmployeeCreatedContractorPostPayloadContentApplicationJsonSchemaDataResource": { "properties": { "client": { "$ref": "#/components/schemas/WebhooksEventsEmployeeCreatedContractorPostPayloadContentApplicationJsonSchemaDataResourceClient" }, "compensation_details": { "$ref": "#/components/schemas/WebhooksEventsEmployeeCreatedContractorPostPayloadContentApplicationJsonSchemaDataResourceCompensationDetails" }, "created_at": { "type": "string" }, "employment_details": { "$ref": "#/components/schemas/WebhooksEventsEmployeeCreatedContractorPostPayloadContentApplicationJsonSchemaDataResourceEmploymentDetails" }, "id": { "type": "string" }, "invitations": { "$ref": "#/components/schemas/WebhooksEventsEmployeeCreatedContractorPostPayloadContentApplicationJsonSchemaDataResourceInvitations" }, "is_archived": { "type": "boolean" }, "job_title": { "type": "string" }, "notice_period": { "type": "integer" }, "scope_of_work": { "type": "string" }, "signatures": { "$ref": "#/components/schemas/WebhooksEventsEmployeeCreatedContractorPostPayloadContentApplicationJsonSchemaDataResourceSignatures" }, "special_clause": { "type": "string" }, "start_date": { "type": "string" }, "status": { "type": "string" }, "termination_date": { "type": "string" }, "title": { "type": "string" }, "type": { "type": "string" }, "worker": { "$ref": "#/components/schemas/WebhooksEventsEmployeeCreatedContractorPostPayloadContentApplicationJsonSchemaDataResourceWorker" } }, "title": "WebhooksEventsEmployeeCreatedContractorPostPayloadContentApplicationJsonSchemaDataResource", "type": "object" }, "WebhooksEventsEmployeeCreatedContractorPostPayloadContentApplicationJsonSchemaDataResourceClient": { "properties": { "email": { "type": "string" }, "full_name": { "type": "string" }, "id": { "type": "integer" }, "legal_entity": { "$ref": "#/components/schemas/WebhooksEventsEmployeeCreatedContractorPostPayloadContentApplicationJsonSchemaDataResourceClientLegalEntity" }, "team": { "$ref": "#/components/schemas/WebhooksEventsEmployeeCreatedContractorPostPayloadContentApplicationJsonSchemaDataResourceClientTeam" } }, "title": "WebhooksEventsEmployeeCreatedContractorPostPayloadContentApplicationJsonSchemaDataResourceClient", "type": "object" }, "WebhooksEventsEmployeeCreatedContractorPostPayloadContentApplicationJsonSchemaDataResourceClientLegalEntity": { "properties": { "email": { "type": "string" }, "id": { "type": "string" }, "name": { "type": "string" }, "registration_number": { "type": "string" }, "subtype": { "type": "string" }, "type": { "type": "string" }, "vat_number": { "type": "string" } }, "title": "WebhooksEventsEmployeeCreatedContractorPostPayloadContentApplicationJsonSchemaDataResourceClientLegalEntity", "type": "object" }, "WebhooksEventsEmployeeCreatedContractorPostPayloadContentApplicationJsonSchemaDataResourceClientTeam": { "properties": { "id": { "type": "string" }, "name": { "type": "string" } }, "title": "WebhooksEventsEmployeeCreatedContractorPostPayloadContentApplicationJsonSchemaDataResourceClientTeam", "type": "object" }, "WebhooksEventsEmployeeCreatedContractorPostPayloadContentApplicationJsonSchemaDataResourceCompensationDetails": { "properties": { "amount": { "type": "string" }, "currency_code": { "type": "string" }, "first_payment": { "type": "string" }, "first_payment_date": { "type": "string" }, "frequency": { "type": "string" }, "gross_annual_salary": { "type": "string" }, "gross_signing_bonus": { "type": "string" }, "gross_variable_bonus": { "type": "string" }, "scale": { "type": "string" } }, "title": "WebhooksEventsEmployeeCreatedContractorPostPayloadContentApplicationJsonSchemaDataResourceCompensationDetails", "type": "object" }, "WebhooksEventsEmployeeCreatedContractorPostPayloadContentApplicationJsonSchemaDataResourceEmploymentDetails": { "properties": { "days_per_week": { "type": "integer" }, "hours_per_day": { "type": "integer" }, "paid_vacation_days": { "type": "integer" }, "probation_period": { "type": "integer" }, "type": { "type": "string" } }, "title": "WebhooksEventsEmployeeCreatedContractorPostPayloadContentApplicationJsonSchemaDataResourceEmploymentDetails", "type": "object" }, "WebhooksEventsEmployeeCreatedContractorPostPayloadContentApplicationJsonSchemaDataResourceInvitations": { "properties": { "client_email": { "type": "string" }, "worker_email": { "type": "string" } }, "title": "WebhooksEventsEmployeeCreatedContractorPostPayloadContentApplicationJsonSchemaDataResourceInvitations", "type": "object" }, "WebhooksEventsEmployeeCreatedContractorPostPayloadContentApplicationJsonSchemaDataResourceSignatures": { "properties": { "client_signature": { "type": "string" }, "client_signed_at": { "type": "string" }, "signed_at": { "type": "string" }, "worker_signature": { "type": "string" }, "worker_signed_at": { "type": "string" } }, "title": "WebhooksEventsEmployeeCreatedContractorPostPayloadContentApplicationJsonSchemaDataResourceSignatures", "type": "object" }, "WebhooksEventsEmployeeCreatedContractorPostPayloadContentApplicationJsonSchemaDataResourceWorker": { "properties": { "country": { "type": "string" }, "date_of_birth": { "type": "string" }, "email": { "type": "string" }, "expected_email": { "type": "string" }, "first_name": { "type": "string" }, "full_name": { "type": "string" }, "id": { "type": "integer" }, "last_name": { "type": "string" } }, "title": "WebhooksEventsEmployeeCreatedContractorPostPayloadContentApplicationJsonSchemaDataResourceWorker", "type": "object" }, "WebhooksEventsEmployeeCreatedDirectPostPayloadContentApplicationJsonSchemaData": { "properties": { "meta": { "$ref": "#/components/schemas/WebhooksEventsEmployeeCreatedDirectPostPayloadContentApplicationJsonSchemaDataMeta" }, "resource": { "$ref": "#/components/schemas/WebhooksEventsEmployeeCreatedDirectPostPayloadContentApplicationJsonSchemaDataResource" } }, "title": "WebhooksEventsEmployeeCreatedDirectPostPayloadContentApplicationJsonSchemaData", "type": "object" }, "WebhooksEventsEmployeeCreatedDirectPostPayloadContentApplicationJsonSchemaDataMeta": { "properties": { "event_type": { "type": "string" }, "event_type_id": { "type": "string" }, "organization_id": { "type": "string" }, "organization_name": { "type": "string" }, "tracking_id": { "type": "string" } }, "title": "WebhooksEventsEmployeeCreatedDirectPostPayloadContentApplicationJsonSchemaDataMeta", "type": "object" }, "WebhooksEventsEmployeeCreatedDirectPostPayloadContentApplicationJsonSchemaDataResource": { "properties": { "compensation": { "$ref": "#/components/schemas/WebhooksEventsEmployeeCreatedDirectPostPayloadContentApplicationJsonSchemaDataResourceCompensation" }, "contract": { "$ref": "#/components/schemas/WebhooksEventsEmployeeCreatedDirectPostPayloadContentApplicationJsonSchemaDataResourceContract" }, "employee_details": { "$ref": "#/components/schemas/WebhooksEventsEmployeeCreatedDirectPostPayloadContentApplicationJsonSchemaDataResourceEmployeeDetails" }, "id": { "type": "string" }, "job_information": { "$ref": "#/components/schemas/WebhooksEventsEmployeeCreatedDirectPostPayloadContentApplicationJsonSchemaDataResourceJobInformation" }, "team_information": { "$ref": "#/components/schemas/WebhooksEventsEmployeeCreatedDirectPostPayloadContentApplicationJsonSchemaDataResourceTeamInformation" } }, "title": "WebhooksEventsEmployeeCreatedDirectPostPayloadContentApplicationJsonSchemaDataResource", "type": "object" }, "WebhooksEventsEmployeeCreatedDirectPostPayloadContentApplicationJsonSchemaDataResourceCompensation": { "properties": { "currency": { "type": "string" }, "gross_annual_salary": { "type": "integer" } }, "title": "WebhooksEventsEmployeeCreatedDirectPostPayloadContentApplicationJsonSchemaDataResourceCompensation", "type": "object" }, "WebhooksEventsEmployeeCreatedDirectPostPayloadContentApplicationJsonSchemaDataResourceContract": { "properties": { "contract_oid": { "type": "string" }, "employment_type": { "type": "string" }, "start_date": { "type": "string" } }, "title": "WebhooksEventsEmployeeCreatedDirectPostPayloadContentApplicationJsonSchemaDataResourceContract", "type": "object" }, "WebhooksEventsEmployeeCreatedDirectPostPayloadContentApplicationJsonSchemaDataResourceEmployeeDetails": { "properties": { "email": { "type": "string" }, "first_name": { "type": "string" }, "last_name": { "type": "string" } }, "title": "WebhooksEventsEmployeeCreatedDirectPostPayloadContentApplicationJsonSchemaDataResourceEmployeeDetails", "type": "object" }, "WebhooksEventsEmployeeCreatedDirectPostPayloadContentApplicationJsonSchemaDataResourceJobInformation": { "properties": { "job_title_id": { "type": "integer" }, "seniority_id": { "type": "integer" } }, "title": "WebhooksEventsEmployeeCreatedDirectPostPayloadContentApplicationJsonSchemaDataResourceJobInformation", "type": "object" }, "WebhooksEventsEmployeeCreatedDirectPostPayloadContentApplicationJsonSchemaDataResourceTeamInformation": { "properties": { "legal_entity_id": { "type": "string" }, "team_id": { "type": "string" } }, "title": "WebhooksEventsEmployeeCreatedDirectPostPayloadContentApplicationJsonSchemaDataResourceTeamInformation", "type": "object" }, "WebhooksEventsEmployeeCreatedEorPostPayloadContentApplicationJsonSchemaData": { "properties": { "meta": { "$ref": "#/components/schemas/WebhooksEventsEmployeeCreatedEorPostPayloadContentApplicationJsonSchemaDataMeta" }, "resource": { "$ref": "#/components/schemas/WebhooksEventsEmployeeCreatedEorPostPayloadContentApplicationJsonSchemaDataResource" } }, "title": "WebhooksEventsEmployeeCreatedEorPostPayloadContentApplicationJsonSchemaData", "type": "object" }, "WebhooksEventsEmployeeCreatedEorPostPayloadContentApplicationJsonSchemaDataMeta": { "properties": { "event_type": { "type": "string" }, "event_type_id": { "type": "string" }, "organization_id": { "type": "string" }, "organization_name": { "type": "string" }, "tracking_id": { "type": "string" } }, "title": "WebhooksEventsEmployeeCreatedEorPostPayloadContentApplicationJsonSchemaDataMeta", "type": "object" }, "WebhooksEventsEmployeeCreatedEorPostPayloadContentApplicationJsonSchemaDataResource": { "properties": { "client": { "$ref": "#/components/schemas/WebhooksEventsEmployeeCreatedEorPostPayloadContentApplicationJsonSchemaDataResourceClient" }, "compensation_details": { "$ref": "#/components/schemas/WebhooksEventsEmployeeCreatedEorPostPayloadContentApplicationJsonSchemaDataResourceCompensationDetails" }, "created_at": { "type": "string" }, "employment_details": { "$ref": "#/components/schemas/WebhooksEventsEmployeeCreatedEorPostPayloadContentApplicationJsonSchemaDataResourceEmploymentDetails" }, "id": { "type": "string" }, "invitations": { "$ref": "#/components/schemas/WebhooksEventsEmployeeCreatedEorPostPayloadContentApplicationJsonSchemaDataResourceInvitations" }, "is_archived": { "type": "boolean" }, "job_title": { "type": "string" }, "notice_period": { "type": "integer" }, "seniority": { "$ref": "#/components/schemas/WebhooksEventsEmployeeCreatedEorPostPayloadContentApplicationJsonSchemaDataResourceSeniority" }, "signatures": { "$ref": "#/components/schemas/WebhooksEventsEmployeeCreatedEorPostPayloadContentApplicationJsonSchemaDataResourceSignatures" }, "special_clause": { "type": "string" }, "start_date": { "type": "string" }, "status": { "type": "string" }, "termination_date": { "type": "string" }, "title": { "type": "string" }, "type": { "type": "string" } }, "title": "WebhooksEventsEmployeeCreatedEorPostPayloadContentApplicationJsonSchemaDataResource", "type": "object" }, "WebhooksEventsEmployeeCreatedEorPostPayloadContentApplicationJsonSchemaDataResourceClient": { "properties": { "email": { "type": "string" }, "full_name": { "type": "string" }, "id": { "type": "integer" }, "legal_entity": { "$ref": "#/components/schemas/WebhooksEventsEmployeeCreatedEorPostPayloadContentApplicationJsonSchemaDataResourceClientLegalEntity" } }, "title": "WebhooksEventsEmployeeCreatedEorPostPayloadContentApplicationJsonSchemaDataResourceClient", "type": "object" }, "WebhooksEventsEmployeeCreatedEorPostPayloadContentApplicationJsonSchemaDataResourceClientLegalEntity": { "properties": { "email": { "type": "string" }, "name": { "type": "string" }, "registration_number": { "type": "string" }, "subtype": { "type": "string" }, "type": { "type": "string" }, "vat_number": { "type": "string" } }, "title": "WebhooksEventsEmployeeCreatedEorPostPayloadContentApplicationJsonSchemaDataResourceClientLegalEntity", "type": "object" }, "WebhooksEventsEmployeeCreatedEorPostPayloadContentApplicationJsonSchemaDataResourceCompensationDetails": { "properties": { "currency_code": { "type": "string" }, "first_payment": { "format": "double", "type": "number" }, "first_payment_date": { "type": "string" }, "frequency": { "type": "string" }, "gross_annual_salary": { "type": "integer" }, "gross_signing_bonus": { "type": "integer" }, "gross_variable_bonus": { "type": "string" }, "scale": { "type": "string" } }, "title": "WebhooksEventsEmployeeCreatedEorPostPayloadContentApplicationJsonSchemaDataResourceCompensationDetails", "type": "object" }, "WebhooksEventsEmployeeCreatedEorPostPayloadContentApplicationJsonSchemaDataResourceEmploymentDetails": { "properties": { "country": { "type": "string" }, "days_per_week": { "type": "integer" }, "hours_per_day": { "type": "integer" }, "paid_vacation_days": { "type": "integer" }, "probation_period": { "type": "integer" }, "type": { "type": "string" } }, "title": "WebhooksEventsEmployeeCreatedEorPostPayloadContentApplicationJsonSchemaDataResourceEmploymentDetails", "type": "object" }, "WebhooksEventsEmployeeCreatedEorPostPayloadContentApplicationJsonSchemaDataResourceInvitations": { "properties": { "client_email": { "type": "string" }, "worker_email": { "type": "string" } }, "title": "WebhooksEventsEmployeeCreatedEorPostPayloadContentApplicationJsonSchemaDataResourceInvitations", "type": "object" }, "WebhooksEventsEmployeeCreatedEorPostPayloadContentApplicationJsonSchemaDataResourceSeniority": { "properties": { "id": { "type": "integer" }, "name": { "type": "string" } }, "title": "WebhooksEventsEmployeeCreatedEorPostPayloadContentApplicationJsonSchemaDataResourceSeniority", "type": "object" }, "WebhooksEventsEmployeeCreatedEorPostPayloadContentApplicationJsonSchemaDataResourceSignatures": { "properties": { "client_signature": { "type": "string" }, "client_signed_at": { "type": "string" }, "signed_at": { "type": "string" }, "worker_signature": { "type": "string" }, "worker_signed_at": { "type": "string" } }, "title": "WebhooksEventsEmployeeCreatedEorPostPayloadContentApplicationJsonSchemaDataResourceSignatures", "type": "object" }, "WebhooksEventsEmployeeUpdatedDirectPostPayloadContentApplicationJsonSchemaData": { "properties": { "meta": { "$ref": "#/components/schemas/WebhooksEventsEmployeeUpdatedDirectPostPayloadContentApplicationJsonSchemaDataMeta" }, "resource": { "$ref": "#/components/schemas/WebhooksEventsEmployeeUpdatedDirectPostPayloadContentApplicationJsonSchemaDataResource" } }, "title": "WebhooksEventsEmployeeUpdatedDirectPostPayloadContentApplicationJsonSchemaData", "type": "object" }, "WebhooksEventsEmployeeUpdatedDirectPostPayloadContentApplicationJsonSchemaDataMeta": { "properties": { "event_type": { "type": "string" }, "event_type_id": { "type": "string" }, "organization_id": { "type": "string" }, "organization_name": { "type": "string" }, "tracking_id": { "type": "string" } }, "title": "WebhooksEventsEmployeeUpdatedDirectPostPayloadContentApplicationJsonSchemaDataMeta", "type": "object" }, "WebhooksEventsEmployeeUpdatedDirectPostPayloadContentApplicationJsonSchemaDataResource": { "properties": { "compensation": { "$ref": "#/components/schemas/WebhooksEventsEmployeeUpdatedDirectPostPayloadContentApplicationJsonSchemaDataResourceCompensation" }, "contract": { "$ref": "#/components/schemas/WebhooksEventsEmployeeUpdatedDirectPostPayloadContentApplicationJsonSchemaDataResourceContract" }, "employee_details": { "$ref": "#/components/schemas/WebhooksEventsEmployeeUpdatedDirectPostPayloadContentApplicationJsonSchemaDataResourceEmployeeDetails" }, "id": { "type": "string" }, "job_information": { "$ref": "#/components/schemas/WebhooksEventsEmployeeUpdatedDirectPostPayloadContentApplicationJsonSchemaDataResourceJobInformation" }, "team_information": { "$ref": "#/components/schemas/WebhooksEventsEmployeeUpdatedDirectPostPayloadContentApplicationJsonSchemaDataResourceTeamInformation" } }, "title": "WebhooksEventsEmployeeUpdatedDirectPostPayloadContentApplicationJsonSchemaDataResource", "type": "object" }, "WebhooksEventsEmployeeUpdatedDirectPostPayloadContentApplicationJsonSchemaDataResourceCompensation": { "properties": { "currency": { "type": "string" }, "gross_annual_salary": { "type": "integer" } }, "title": "WebhooksEventsEmployeeUpdatedDirectPostPayloadContentApplicationJsonSchemaDataResourceCompensation", "type": "object" }, "WebhooksEventsEmployeeUpdatedDirectPostPayloadContentApplicationJsonSchemaDataResourceContract": { "properties": { "contract_oid": { "type": "string" }, "employment_type": { "type": "string" }, "start_date": { "type": "string" } }, "title": "WebhooksEventsEmployeeUpdatedDirectPostPayloadContentApplicationJsonSchemaDataResourceContract", "type": "object" }, "WebhooksEventsEmployeeUpdatedDirectPostPayloadContentApplicationJsonSchemaDataResourceEmployeeDetails": { "properties": { "email": { "type": "string" }, "first_name": { "type": "string" }, "last_name": { "type": "string" } }, "title": "WebhooksEventsEmployeeUpdatedDirectPostPayloadContentApplicationJsonSchemaDataResourceEmployeeDetails", "type": "object" }, "WebhooksEventsEmployeeUpdatedDirectPostPayloadContentApplicationJsonSchemaDataResourceJobInformation": { "properties": { "job_title_id": { "type": "integer" }, "seniority_id": { "type": "integer" } }, "title": "WebhooksEventsEmployeeUpdatedDirectPostPayloadContentApplicationJsonSchemaDataResourceJobInformation", "type": "object" }, "WebhooksEventsEmployeeUpdatedDirectPostPayloadContentApplicationJsonSchemaDataResourceTeamInformation": { "properties": { "legal_entity_id": { "type": "integer" }, "team_id": { "type": "integer" } }, "title": "WebhooksEventsEmployeeUpdatedDirectPostPayloadContentApplicationJsonSchemaDataResourceTeamInformation", "type": "object" }, "WebhooksEventsEngageLearningJourneysAssignmentsCreatedPostPayloadContentApplicationJsonSchemaData": { "properties": { "meta": { "$ref": "#/components/schemas/WebhooksEventsEngageLearningJourneysAssignmentsCreatedPostPayloadContentApplicationJsonSchemaDataMeta" }, "resource": { "$ref": "#/components/schemas/WebhooksEventsEngageLearningJourneysAssignmentsCreatedPostPayloadContentApplicationJsonSchemaDataResource" } }, "title": "WebhooksEventsEngageLearningJourneysAssignmentsCreatedPostPayloadContentApplicationJsonSchemaData", "type": "object" }, "WebhooksEventsEngageLearningJourneysAssignmentsCreatedPostPayloadContentApplicationJsonSchemaDataMeta": { "properties": { "event_type": { "type": "string" }, "event_type_id": { "type": "string" }, "organization_id": { "type": "string" }, "organization_name": { "type": "string" }, "tracking_id": { "type": "string" } }, "title": "WebhooksEventsEngageLearningJourneysAssignmentsCreatedPostPayloadContentApplicationJsonSchemaDataMeta", "type": "object" }, "WebhooksEventsEngageLearningJourneysAssignmentsCreatedPostPayloadContentApplicationJsonSchemaDataResource": { "properties": { "assigned_by_hris_organization_user": { "$ref": "#/components/schemas/WebhooksEventsEngageLearningJourneysAssignmentsCreatedPostPayloadContentApplicationJsonSchemaDataResourceAssignedByHrisOrganizationUser" }, "assignee_hris_organization_user": { "$ref": "#/components/schemas/WebhooksEventsEngageLearningJourneysAssignmentsCreatedPostPayloadContentApplicationJsonSchemaDataResourceAssigneeHrisOrganizationUser" }, "created_at": { "type": "string" }, "due_at": { "type": [ "string", "null" ] }, "id": { "type": "string" }, "is_self_assignment": { "type": "boolean" }, "journey": { "$ref": "#/components/schemas/WebhooksEventsEngageLearningJourneysAssignmentsCreatedPostPayloadContentApplicationJsonSchemaDataResourceJourney" }, "journey_assignment_path": { "type": "string" }, "updated_at": { "type": "string" } }, "title": "WebhooksEventsEngageLearningJourneysAssignmentsCreatedPostPayloadContentApplicationJsonSchemaDataResource", "type": "object" }, "WebhooksEventsEngageLearningJourneysAssignmentsCreatedPostPayloadContentApplicationJsonSchemaDataResourceAssignedByHrisOrganizationUser": { "properties": { "email": { "type": "string" }, "first_name": { "type": "string" }, "id": { "type": "string" }, "last_name": { "type": "string" }, "preferred_first_name": { "type": [ "string", "null" ] }, "preferred_last_name": { "type": [ "string", "null" ] }, "preferred_name": { "type": "string" }, "work_email": { "type": "string" } }, "title": "WebhooksEventsEngageLearningJourneysAssignmentsCreatedPostPayloadContentApplicationJsonSchemaDataResourceAssignedByHrisOrganizationUser", "type": "object" }, "WebhooksEventsEngageLearningJourneysAssignmentsCreatedPostPayloadContentApplicationJsonSchemaDataResourceAssigneeHrisOrganizationUser": { "properties": { "email": { "type": "string" }, "first_name": { "type": "string" }, "id": { "type": "string" }, "last_name": { "type": "string" }, "preferred_first_name": { "type": [ "string", "null" ] }, "preferred_last_name": { "type": [ "string", "null" ] }, "preferred_name": { "type": "string" }, "work_email": { "type": "string" } }, "title": "WebhooksEventsEngageLearningJourneysAssignmentsCreatedPostPayloadContentApplicationJsonSchemaDataResourceAssigneeHrisOrganizationUser", "type": "object" }, "WebhooksEventsEngageLearningJourneysAssignmentsCreatedPostPayloadContentApplicationJsonSchemaDataResourceJourney": { "properties": { "cover_picture": { "type": "string" }, "description": { "type": [ "string", "null" ] }, "id": { "type": "string" }, "title": { "type": "string" } }, "title": "WebhooksEventsEngageLearningJourneysAssignmentsCreatedPostPayloadContentApplicationJsonSchemaDataResourceJourney", "type": "object" }, "WebhooksEventsEngageLearningJourneysAssignmentsRemindedPostPayloadContentApplicationJsonSchemaData": { "properties": { "meta": { "$ref": "#/components/schemas/WebhooksEventsEngageLearningJourneysAssignmentsRemindedPostPayloadContentApplicationJsonSchemaDataMeta" }, "resource": { "$ref": "#/components/schemas/WebhooksEventsEngageLearningJourneysAssignmentsRemindedPostPayloadContentApplicationJsonSchemaDataResource" } }, "title": "WebhooksEventsEngageLearningJourneysAssignmentsRemindedPostPayloadContentApplicationJsonSchemaData", "type": "object" }, "WebhooksEventsEngageLearningJourneysAssignmentsRemindedPostPayloadContentApplicationJsonSchemaDataMeta": { "properties": { "event_type": { "type": "string" }, "event_type_id": { "type": "string" }, "organization_id": { "type": "string" }, "organization_name": { "type": "string" }, "tracking_id": { "type": "string" } }, "title": "WebhooksEventsEngageLearningJourneysAssignmentsRemindedPostPayloadContentApplicationJsonSchemaDataMeta", "type": "object" }, "WebhooksEventsEngageLearningJourneysAssignmentsRemindedPostPayloadContentApplicationJsonSchemaDataResource": { "properties": { "assigned_by_hris_organization_user": { "$ref": "#/components/schemas/WebhooksEventsEngageLearningJourneysAssignmentsRemindedPostPayloadContentApplicationJsonSchemaDataResourceAssignedByHrisOrganizationUser" }, "assignee_hris_organization_user": { "$ref": "#/components/schemas/WebhooksEventsEngageLearningJourneysAssignmentsRemindedPostPayloadContentApplicationJsonSchemaDataResourceAssigneeHrisOrganizationUser" }, "created_at": { "type": "string" }, "due_at": { "type": [ "string", "null" ] }, "id": { "type": "string" }, "is_self_assignment": { "type": "boolean" }, "journey": { "$ref": "#/components/schemas/WebhooksEventsEngageLearningJourneysAssignmentsRemindedPostPayloadContentApplicationJsonSchemaDataResourceJourney" }, "journey_assignment_path": { "type": "string" }, "updated_at": { "type": "string" } }, "title": "WebhooksEventsEngageLearningJourneysAssignmentsRemindedPostPayloadContentApplicationJsonSchemaDataResource", "type": "object" }, "WebhooksEventsEngageLearningJourneysAssignmentsRemindedPostPayloadContentApplicationJsonSchemaDataResourceAssignedByHrisOrganizationUser": { "properties": { "email": { "type": "string" }, "first_name": { "type": "string" }, "id": { "type": "string" }, "last_name": { "type": "string" }, "preferred_first_name": { "type": [ "string", "null" ] }, "preferred_last_name": { "type": [ "string", "null" ] }, "preferred_name": { "type": "string" }, "work_email": { "type": "string" } }, "title": "WebhooksEventsEngageLearningJourneysAssignmentsRemindedPostPayloadContentApplicationJsonSchemaDataResourceAssignedByHrisOrganizationUser", "type": "object" }, "WebhooksEventsEngageLearningJourneysAssignmentsRemindedPostPayloadContentApplicationJsonSchemaDataResourceAssigneeHrisOrganizationUser": { "properties": { "email": { "type": "string" }, "first_name": { "type": "string" }, "id": { "type": "string" }, "last_name": { "type": "string" }, "preferred_first_name": { "type": [ "string", "null" ] }, "preferred_last_name": { "type": [ "string", "null" ] }, "preferred_name": { "type": "string" }, "work_email": { "type": "string" } }, "title": "WebhooksEventsEngageLearningJourneysAssignmentsRemindedPostPayloadContentApplicationJsonSchemaDataResourceAssigneeHrisOrganizationUser", "type": "object" }, "WebhooksEventsEngageLearningJourneysAssignmentsRemindedPostPayloadContentApplicationJsonSchemaDataResourceJourney": { "properties": { "cover_picture": { "type": "string" }, "description": { "type": [ "string", "null" ] }, "id": { "type": "string" }, "title": { "type": "string" } }, "title": "WebhooksEventsEngageLearningJourneysAssignmentsRemindedPostPayloadContentApplicationJsonSchemaDataResourceJourney", "type": "object" }, "WebhooksEventsEorAmendmentStatusUpdatedPostPayloadContentApplicationJsonSchemaData": { "properties": { "meta": { "$ref": "#/components/schemas/WebhooksEventsEorAmendmentStatusUpdatedPostPayloadContentApplicationJsonSchemaDataMeta" }, "resource": { "$ref": "#/components/schemas/WebhooksEventsEorAmendmentStatusUpdatedPostPayloadContentApplicationJsonSchemaDataResource" } }, "title": "WebhooksEventsEorAmendmentStatusUpdatedPostPayloadContentApplicationJsonSchemaData", "type": "object" }, "WebhooksEventsEorAmendmentStatusUpdatedPostPayloadContentApplicationJsonSchemaDataMeta": { "properties": { "event_type": { "type": "string" }, "event_type_id": { "type": "string" }, "organization_id": { "type": "string" }, "organization_name": { "type": "string" }, "tracking_id": { "type": "string" } }, "title": "WebhooksEventsEorAmendmentStatusUpdatedPostPayloadContentApplicationJsonSchemaDataMeta", "type": "object" }, "WebhooksEventsEorAmendmentStatusUpdatedPostPayloadContentApplicationJsonSchemaDataResource": { "properties": { "amendment_flow_id": { "type": "string" }, "contract_id": { "type": "string" }, "organization_id": { "type": "string" }, "status": { "type": "string" } }, "title": "WebhooksEventsEorAmendmentStatusUpdatedPostPayloadContentApplicationJsonSchemaDataResource", "type": "object" }, "WebhooksEventsEorPayslipsAvailablePostPayloadContentApplicationJsonSchemaData": { "properties": { "meta": { "$ref": "#/components/schemas/WebhooksEventsEorPayslipsAvailablePostPayloadContentApplicationJsonSchemaDataMeta" }, "resource": { "items": { "$ref": "#/components/schemas/WebhooksEventsEorPayslipsAvailablePostPayloadContentApplicationJsonSchemaDataResourceItems" }, "type": "array" } }, "title": "WebhooksEventsEorPayslipsAvailablePostPayloadContentApplicationJsonSchemaData", "type": "object" }, "WebhooksEventsEorPayslipsAvailablePostPayloadContentApplicationJsonSchemaDataMeta": { "properties": { "event_type": { "type": "string" }, "event_type_id": { "type": "string" }, "organization_id": { "type": "string" }, "organization_name": { "type": "string" }, "tracking_id": { "type": "string" } }, "title": "WebhooksEventsEorPayslipsAvailablePostPayloadContentApplicationJsonSchemaDataMeta", "type": "object" }, "WebhooksEventsEorPayslipsAvailablePostPayloadContentApplicationJsonSchemaDataResourceItems": { "properties": { "created_at": { "type": "string" }, "from": { "type": "string" }, "id": { "type": "integer" }, "status": { "type": "string" }, "to": { "type": "string" }, "updated_at": { "type": "string" }, "worker_id": { "type": "integer" } }, "title": "WebhooksEventsEorPayslipsAvailablePostPayloadContentApplicationJsonSchemaDataResourceItems", "type": "object" }, "WebhooksEventsEorProjectAssignmentCheckinCreatedPostPayloadContentApplicationJsonSchemaData": { "properties": { "meta": { "$ref": "#/components/schemas/WebhooksEventsEorProjectAssignmentCheckinCreatedPostPayloadContentApplicationJsonSchemaDataMeta" }, "resource": { "$ref": "#/components/schemas/WebhooksEventsEorProjectAssignmentCheckinCreatedPostPayloadContentApplicationJsonSchemaDataResource" } }, "title": "WebhooksEventsEorProjectAssignmentCheckinCreatedPostPayloadContentApplicationJsonSchemaData", "type": "object" }, "WebhooksEventsEorProjectAssignmentCheckinCreatedPostPayloadContentApplicationJsonSchemaDataMeta": { "properties": { "event_type": { "type": "string" }, "event_type_id": { "type": "string" }, "organization_id": { "type": "string" }, "organization_name": { "type": "string" }, "tracking_id": { "type": "string" } }, "title": "WebhooksEventsEorProjectAssignmentCheckinCreatedPostPayloadContentApplicationJsonSchemaDataMeta", "type": "object" }, "WebhooksEventsEorProjectAssignmentCheckinCreatedPostPayloadContentApplicationJsonSchemaDataResource": { "properties": { "contract_id": { "type": "string" }, "project_assignment_checkin_version": { "type": "string" }, "type": { "type": "string" } }, "title": "WebhooksEventsEorProjectAssignmentCheckinCreatedPostPayloadContentApplicationJsonSchemaDataResource", "type": "object" }, "WebhooksEventsEorProjectAssignmentCreatedPostPayloadContentApplicationJsonSchemaData": { "properties": { "meta": { "$ref": "#/components/schemas/WebhooksEventsEorProjectAssignmentCreatedPostPayloadContentApplicationJsonSchemaDataMeta" }, "resource": { "$ref": "#/components/schemas/WebhooksEventsEorProjectAssignmentCreatedPostPayloadContentApplicationJsonSchemaDataResource" } }, "title": "WebhooksEventsEorProjectAssignmentCreatedPostPayloadContentApplicationJsonSchemaData", "type": "object" }, "WebhooksEventsEorProjectAssignmentCreatedPostPayloadContentApplicationJsonSchemaDataMeta": { "properties": { "event_type": { "type": "string" }, "event_type_id": { "type": "string" }, "organization_id": { "type": "string" }, "organization_name": { "type": "string" }, "tracking_id": { "type": "string" } }, "title": "WebhooksEventsEorProjectAssignmentCreatedPostPayloadContentApplicationJsonSchemaDataMeta", "type": "object" }, "WebhooksEventsEorProjectAssignmentCreatedPostPayloadContentApplicationJsonSchemaDataResource": { "properties": { "contract_id": { "type": "string" }, "project_assignment_version": { "type": "string" } }, "title": "WebhooksEventsEorProjectAssignmentCreatedPostPayloadContentApplicationJsonSchemaDataResource", "type": "object" }, "WebhooksEventsEorQuoteCreatedPostPayloadContentApplicationJsonSchemaData": { "properties": { "meta": { "$ref": "#/components/schemas/WebhooksEventsEorQuoteCreatedPostPayloadContentApplicationJsonSchemaDataMeta" }, "resource": { "$ref": "#/components/schemas/WebhooksEventsEorQuoteCreatedPostPayloadContentApplicationJsonSchemaDataResource" } }, "title": "WebhooksEventsEorQuoteCreatedPostPayloadContentApplicationJsonSchemaData", "type": "object" }, "WebhooksEventsEorQuoteCreatedPostPayloadContentApplicationJsonSchemaDataMeta": { "properties": { "event_type": { "type": "string" }, "event_type_id": { "type": "string" }, "organization_id": { "type": "string" }, "organization_name": { "type": "string" }, "tracking_id": { "type": "string" } }, "title": "WebhooksEventsEorQuoteCreatedPostPayloadContentApplicationJsonSchemaDataMeta", "type": "object" }, "WebhooksEventsEorQuoteCreatedPostPayloadContentApplicationJsonSchemaDataResource": { "properties": { "annual_salary": { "type": "string" }, "breakdown_costs": { "$ref": "#/components/schemas/WebhooksEventsEorQuoteCreatedPostPayloadContentApplicationJsonSchemaDataResourceBreakdownCosts" }, "cba_total": { "type": "string" }, "cba_total_usd": { "type": "string" }, "contract_id": { "type": "string" }, "contract_name": { "type": "string" }, "country_name": { "type": "string" }, "created_at": { "type": "string" }, "currency": { "type": "string" }, "employer_cost_total": { "type": "string" }, "employer_cost_total_usd": { "type": "string" }, "gross_salary_total_usd": { "type": "string" }, "monthly_cost_total": { "type": "string" }, "monthly_cost_total_usd": { "type": "string" }, "platform_fee_total": { "type": "string" }, "platform_fee_total_usd": { "type": "string" }, "recurring_allowance_total": { "type": "string" }, "recurring_allowance_total_usd": { "type": "string" }, "salary_total": { "type": "string" }, "salary_total_usd": { "type": "string" }, "severance_accrual_total": { "type": "string" }, "severance_accrual_total_usd": { "type": "string" }, "updated_at": { "type": "string" } }, "title": "WebhooksEventsEorQuoteCreatedPostPayloadContentApplicationJsonSchemaDataResource", "type": "object" }, "WebhooksEventsEorQuoteCreatedPostPayloadContentApplicationJsonSchemaDataResourceBreakdownCosts": { "properties": { "monthly": { "$ref": "#/components/schemas/WebhooksEventsEorQuoteCreatedPostPayloadContentApplicationJsonSchemaDataResourceBreakdownCostsMonthly" } }, "title": "WebhooksEventsEorQuoteCreatedPostPayloadContentApplicationJsonSchemaDataResourceBreakdownCosts", "type": "object" }, "WebhooksEventsEorQuoteCreatedPostPayloadContentApplicationJsonSchemaDataResourceBreakdownCostsMonthly": { "properties": { "costs": { "items": { "$ref": "#/components/schemas/WebhooksEventsEorQuoteCreatedPostPayloadContentApplicationJsonSchemaDataResourceBreakdownCostsMonthlyCostsItems" }, "type": "array" }, "total": { "type": "string" }, "total_usd": { "type": "string" } }, "title": "WebhooksEventsEorQuoteCreatedPostPayloadContentApplicationJsonSchemaDataResourceBreakdownCostsMonthly", "type": "object" }, "WebhooksEventsEorQuoteCreatedPostPayloadContentApplicationJsonSchemaDataResourceBreakdownCostsMonthlyCostsItems": { "properties": { "currency": { "type": "string" }, "name": { "type": "string" }, "total": { "type": "string" }, "total_usd": { "type": "string" } }, "title": "WebhooksEventsEorQuoteCreatedPostPayloadContentApplicationJsonSchemaDataResourceBreakdownCostsMonthlyCostsItems", "type": "object" }, "WebhooksEventsGpPayslipsAvailablePostPayloadContentApplicationJsonSchemaData": { "properties": { "meta": { "$ref": "#/components/schemas/WebhooksEventsGpPayslipsAvailablePostPayloadContentApplicationJsonSchemaDataMeta" }, "resource": { "items": { "$ref": "#/components/schemas/WebhooksEventsGpPayslipsAvailablePostPayloadContentApplicationJsonSchemaDataResourceItems" }, "type": "array" } }, "title": "WebhooksEventsGpPayslipsAvailablePostPayloadContentApplicationJsonSchemaData", "type": "object" }, "WebhooksEventsGpPayslipsAvailablePostPayloadContentApplicationJsonSchemaDataMeta": { "properties": { "event_type": { "type": "string" }, "event_type_id": { "type": "string" }, "organization_id": { "type": "string" }, "organization_name": { "type": "string" }, "tracking_id": { "type": "string" } }, "title": "WebhooksEventsGpPayslipsAvailablePostPayloadContentApplicationJsonSchemaDataMeta", "type": "object" }, "WebhooksEventsGpPayslipsAvailablePostPayloadContentApplicationJsonSchemaDataResourceItems": { "properties": { "created_at": { "type": "string" }, "from": { "type": "string" }, "id": { "type": "integer" }, "status": { "type": "string" }, "to": { "type": "string" }, "updated_at": { "type": "string" }, "worker_id": { "type": "integer" } }, "title": "WebhooksEventsGpPayslipsAvailablePostPayloadContentApplicationJsonSchemaDataResourceItems", "type": "object" }, "WebhooksEventsGpTerminationConfirmedPostPayloadContentApplicationJsonSchemaData": { "properties": { "meta": { "$ref": "#/components/schemas/WebhooksEventsGpTerminationConfirmedPostPayloadContentApplicationJsonSchemaDataMeta" }, "resource": { "$ref": "#/components/schemas/WebhooksEventsGpTerminationConfirmedPostPayloadContentApplicationJsonSchemaDataResource" } }, "title": "WebhooksEventsGpTerminationConfirmedPostPayloadContentApplicationJsonSchemaData", "type": "object" }, "WebhooksEventsGpTerminationConfirmedPostPayloadContentApplicationJsonSchemaDataMeta": { "properties": { "event_type": { "type": "string" }, "event_type_id": { "type": "string" }, "organization_id": { "type": "string" }, "organization_name": { "type": "string" }, "tracking_id": { "type": "string" } }, "title": "WebhooksEventsGpTerminationConfirmedPostPayloadContentApplicationJsonSchemaDataMeta", "type": "object" }, "WebhooksEventsGpTerminationConfirmedPostPayloadContentApplicationJsonSchemaDataResource": { "properties": { "contract": { "$ref": "#/components/schemas/WebhooksEventsGpTerminationConfirmedPostPayloadContentApplicationJsonSchemaDataResourceContract" }, "organization_id": { "type": "integer" }, "worker": { "$ref": "#/components/schemas/WebhooksEventsGpTerminationConfirmedPostPayloadContentApplicationJsonSchemaDataResourceWorker" } }, "title": "WebhooksEventsGpTerminationConfirmedPostPayloadContentApplicationJsonSchemaDataResource", "type": "object" }, "WebhooksEventsGpTerminationConfirmedPostPayloadContentApplicationJsonSchemaDataResourceContract": { "properties": { "contract_type": { "type": "string" }, "country": { "type": "string" }, "created_at": { "type": "string" }, "id": { "type": "string" }, "name": { "type": "string" }, "state": { "type": "string" }, "termination_date": { "type": "string" } }, "title": "WebhooksEventsGpTerminationConfirmedPostPayloadContentApplicationJsonSchemaDataResourceContract", "type": "object" }, "WebhooksEventsGpTerminationConfirmedPostPayloadContentApplicationJsonSchemaDataResourceWorker": { "properties": { "country": { "type": "string" }, "created_at": { "type": "string" }, "email": { "type": "string" }, "first_name": { "type": "string" }, "id": { "type": "string" }, "last_name": { "type": "string" }, "nationality": { "type": "string" }, "type": { "type": "string" } }, "title": "WebhooksEventsGpTerminationConfirmedPostPayloadContentApplicationJsonSchemaDataResourceWorker", "type": "object" }, "WebhooksEventsImmigrationCaseProcessStatusUpdatePostPayloadContentApplicationJsonSchemaData": { "properties": { "meta": { "$ref": "#/components/schemas/WebhooksEventsImmigrationCaseProcessStatusUpdatePostPayloadContentApplicationJsonSchemaDataMeta" }, "resource": { "$ref": "#/components/schemas/WebhooksEventsImmigrationCaseProcessStatusUpdatePostPayloadContentApplicationJsonSchemaDataResource" } }, "title": "WebhooksEventsImmigrationCaseProcessStatusUpdatePostPayloadContentApplicationJsonSchemaData", "type": "object" }, "WebhooksEventsImmigrationCaseProcessStatusUpdatePostPayloadContentApplicationJsonSchemaDataMeta": { "properties": { "event_type": { "type": "string" }, "event_type_id": { "type": "string" }, "organization_id": { "type": "string" }, "organization_name": { "type": "string" }, "tracking_id": { "type": "string" } }, "title": "WebhooksEventsImmigrationCaseProcessStatusUpdatePostPayloadContentApplicationJsonSchemaDataMeta", "type": "object" }, "WebhooksEventsImmigrationCaseProcessStatusUpdatePostPayloadContentApplicationJsonSchemaDataResource": { "properties": { "applicant": { "$ref": "#/components/schemas/WebhooksEventsImmigrationCaseProcessStatusUpdatePostPayloadContentApplicationJsonSchemaDataResourceApplicant" }, "case_type": { "type": "string" }, "country_code": { "type": "string" }, "id": { "type": "string" }, "organization_id": { "type": "integer" }, "process": { "$ref": "#/components/schemas/WebhooksEventsImmigrationCaseProcessStatusUpdatePostPayloadContentApplicationJsonSchemaDataResourceProcess" }, "status": { "type": "string" } }, "title": "WebhooksEventsImmigrationCaseProcessStatusUpdatePostPayloadContentApplicationJsonSchemaDataResource", "type": "object" }, "WebhooksEventsImmigrationCaseProcessStatusUpdatePostPayloadContentApplicationJsonSchemaDataResourceApplicant": { "properties": { "id": { "type": "string" } }, "title": "WebhooksEventsImmigrationCaseProcessStatusUpdatePostPayloadContentApplicationJsonSchemaDataResourceApplicant", "type": "object" }, "WebhooksEventsImmigrationCaseProcessStatusUpdatePostPayloadContentApplicationJsonSchemaDataResourceProcess": { "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "status": { "type": "string" } }, "title": "WebhooksEventsImmigrationCaseProcessStatusUpdatePostPayloadContentApplicationJsonSchemaDataResourceProcess", "type": "object" }, "WebhooksEventsImmigrationCaseRenewalCreatedPostPayloadContentApplicationJsonSchemaData": { "properties": { "meta": { "$ref": "#/components/schemas/WebhooksEventsImmigrationCaseRenewalCreatedPostPayloadContentApplicationJsonSchemaDataMeta" }, "resource": { "$ref": "#/components/schemas/WebhooksEventsImmigrationCaseRenewalCreatedPostPayloadContentApplicationJsonSchemaDataResource" } }, "title": "WebhooksEventsImmigrationCaseRenewalCreatedPostPayloadContentApplicationJsonSchemaData", "type": "object" }, "WebhooksEventsImmigrationCaseRenewalCreatedPostPayloadContentApplicationJsonSchemaDataMeta": { "properties": { "event_type": { "type": "string" }, "event_type_id": { "type": "string" }, "organization_id": { "type": "string" }, "organization_name": { "type": "string" }, "tracking_id": { "type": "string" } }, "title": "WebhooksEventsImmigrationCaseRenewalCreatedPostPayloadContentApplicationJsonSchemaDataMeta", "type": "object" }, "WebhooksEventsImmigrationCaseRenewalCreatedPostPayloadContentApplicationJsonSchemaDataResource": { "properties": { "applicant": { "$ref": "#/components/schemas/WebhooksEventsImmigrationCaseRenewalCreatedPostPayloadContentApplicationJsonSchemaDataResourceApplicant" }, "case_type": { "$ref": "#/components/schemas/WebhooksEventsImmigrationCaseRenewalCreatedPostPayloadContentApplicationJsonSchemaDataResourceCaseType" }, "citizenships": { "items": { "type": "string" }, "type": "array" }, "closure": { "$ref": "#/components/schemas/WebhooksEventsImmigrationCaseRenewalCreatedPostPayloadContentApplicationJsonSchemaDataResourceClosure" }, "contract": { "$ref": "#/components/schemas/WebhooksEventsImmigrationCaseRenewalCreatedPostPayloadContentApplicationJsonSchemaDataResourceContract" }, "country_code": { "type": "string" }, "created_at": { "type": "string" }, "documents": { "items": { "$ref": "#/components/schemas/WebhooksEventsImmigrationCaseRenewalCreatedPostPayloadContentApplicationJsonSchemaDataResourceDocumentsItems" }, "type": "array" }, "estimated_completion_date": { "type": "string" }, "expiring_document": { "$ref": "#/components/schemas/WebhooksEventsImmigrationCaseRenewalCreatedPostPayloadContentApplicationJsonSchemaDataResourceExpiringDocument" }, "id": { "type": "string" }, "process": { "$ref": "#/components/schemas/WebhooksEventsImmigrationCaseRenewalCreatedPostPayloadContentApplicationJsonSchemaDataResourceProcess" }, "status": { "type": "string" }, "updated_at": { "type": "string" }, "visa_type": { "$ref": "#/components/schemas/WebhooksEventsImmigrationCaseRenewalCreatedPostPayloadContentApplicationJsonSchemaDataResourceVisaType" } }, "title": "WebhooksEventsImmigrationCaseRenewalCreatedPostPayloadContentApplicationJsonSchemaDataResource", "type": "object" }, "WebhooksEventsImmigrationCaseRenewalCreatedPostPayloadContentApplicationJsonSchemaDataResourceApplicant": { "properties": { "external_id": { "type": "string" }, "id": { "type": "string" }, "name": { "type": "string" } }, "title": "WebhooksEventsImmigrationCaseRenewalCreatedPostPayloadContentApplicationJsonSchemaDataResourceApplicant", "type": "object" }, "WebhooksEventsImmigrationCaseRenewalCreatedPostPayloadContentApplicationJsonSchemaDataResourceCaseType": { "properties": { "id": { "type": "string" }, "name": { "type": "string" } }, "title": "WebhooksEventsImmigrationCaseRenewalCreatedPostPayloadContentApplicationJsonSchemaDataResourceCaseType", "type": "object" }, "WebhooksEventsImmigrationCaseRenewalCreatedPostPayloadContentApplicationJsonSchemaDataResourceClosure": { "properties": { "note": { "type": "string" }, "reason": { "type": "string" } }, "title": "WebhooksEventsImmigrationCaseRenewalCreatedPostPayloadContentApplicationJsonSchemaDataResourceClosure", "type": "object" }, "WebhooksEventsImmigrationCaseRenewalCreatedPostPayloadContentApplicationJsonSchemaDataResourceContract": { "properties": { "id": { "type": "string" } }, "title": "WebhooksEventsImmigrationCaseRenewalCreatedPostPayloadContentApplicationJsonSchemaDataResourceContract", "type": "object" }, "WebhooksEventsImmigrationCaseRenewalCreatedPostPayloadContentApplicationJsonSchemaDataResourceDocumentsItems": { "properties": { "document_type": { "type": "string" }, "expiration_date": { "type": "string" }, "id": { "type": "string" }, "status": { "type": "string" } }, "title": "WebhooksEventsImmigrationCaseRenewalCreatedPostPayloadContentApplicationJsonSchemaDataResourceDocumentsItems", "type": "object" }, "WebhooksEventsImmigrationCaseRenewalCreatedPostPayloadContentApplicationJsonSchemaDataResourceExpiringDocument": { "properties": { "document_type": { "type": "string" }, "expiration_date": { "type": "string" }, "id": { "type": "string" }, "status": { "type": "string" } }, "title": "WebhooksEventsImmigrationCaseRenewalCreatedPostPayloadContentApplicationJsonSchemaDataResourceExpiringDocument", "type": "object" }, "WebhooksEventsImmigrationCaseRenewalCreatedPostPayloadContentApplicationJsonSchemaDataResourceProcess": { "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "status": { "$ref": "#/components/schemas/WebhooksEventsImmigrationCaseRenewalCreatedPostPayloadContentApplicationJsonSchemaDataResourceProcessStatus" } }, "title": "WebhooksEventsImmigrationCaseRenewalCreatedPostPayloadContentApplicationJsonSchemaDataResourceProcess", "type": "object" }, "WebhooksEventsImmigrationCaseRenewalCreatedPostPayloadContentApplicationJsonSchemaDataResourceProcessStatus": { "properties": { "id": { "type": "string" }, "name": { "type": "string" } }, "title": "WebhooksEventsImmigrationCaseRenewalCreatedPostPayloadContentApplicationJsonSchemaDataResourceProcessStatus", "type": "object" }, "WebhooksEventsImmigrationCaseRenewalCreatedPostPayloadContentApplicationJsonSchemaDataResourceVisaType": { "properties": { "id": { "type": "string" }, "name": { "type": "string" } }, "title": "WebhooksEventsImmigrationCaseRenewalCreatedPostPayloadContentApplicationJsonSchemaDataResourceVisaType", "type": "object" }, "WebhooksEventsInvoiceAdjustmentCreatedPostPayloadContentApplicationJsonSchemaData": { "properties": { "meta": { "$ref": "#/components/schemas/WebhooksEventsInvoiceAdjustmentCreatedPostPayloadContentApplicationJsonSchemaDataMeta" }, "resource": { "$ref": "#/components/schemas/WebhooksEventsInvoiceAdjustmentCreatedPostPayloadContentApplicationJsonSchemaDataResource" } }, "title": "WebhooksEventsInvoiceAdjustmentCreatedPostPayloadContentApplicationJsonSchemaData", "type": "object" }, "WebhooksEventsInvoiceAdjustmentCreatedPostPayloadContentApplicationJsonSchemaDataMeta": { "properties": { "event_type": { "type": "string" }, "event_type_id": { "type": "string" }, "organization_id": { "type": "string" }, "organization_name": { "type": "string" }, "tracking_id": { "type": "string" } }, "title": "WebhooksEventsInvoiceAdjustmentCreatedPostPayloadContentApplicationJsonSchemaDataMeta", "type": "object" }, "WebhooksEventsInvoiceAdjustmentCreatedPostPayloadContentApplicationJsonSchemaDataResource": { "properties": { "created": { "type": "boolean" }, "created_at": { "type": "string" }, "id": { "type": "string" }, "status": { "type": "string" } }, "title": "WebhooksEventsInvoiceAdjustmentCreatedPostPayloadContentApplicationJsonSchemaDataResource", "type": "object" }, "WebhooksEventsInvoiceAdjustmentPendingForApprovalPostPayloadContentApplicationJsonSchemaData": { "properties": { "meta": { "$ref": "#/components/schemas/WebhooksEventsInvoiceAdjustmentPendingForApprovalPostPayloadContentApplicationJsonSchemaDataMeta" }, "resource": { "$ref": "#/components/schemas/WebhooksEventsInvoiceAdjustmentPendingForApprovalPostPayloadContentApplicationJsonSchemaDataResource" } }, "title": "WebhooksEventsInvoiceAdjustmentPendingForApprovalPostPayloadContentApplicationJsonSchemaData", "type": "object" }, "WebhooksEventsInvoiceAdjustmentPendingForApprovalPostPayloadContentApplicationJsonSchemaDataMeta": { "properties": { "event_type": { "type": "string" }, "event_type_id": { "type": "string" }, "organization_id": { "type": "string" }, "organization_name": { "type": "string" }, "tracking_id": { "type": "string" } }, "title": "WebhooksEventsInvoiceAdjustmentPendingForApprovalPostPayloadContentApplicationJsonSchemaDataMeta", "type": "object" }, "WebhooksEventsInvoiceAdjustmentPendingForApprovalPostPayloadContentApplicationJsonSchemaDataResource": { "properties": { "adjustment_description": { "type": "string" }, "adjustment_id": { "type": "integer" }, "adjustment_type": { "type": "string" }, "approvers": { "items": { "$ref": "#/components/schemas/WebhooksEventsInvoiceAdjustmentPendingForApprovalPostPayloadContentApplicationJsonSchemaDataResourceApproversItems" }, "type": "array" }, "contract_name": { "type": "string" }, "contract_oid": { "type": "string" }, "event_type": { "type": "string" }, "team_id": { "type": "integer" } }, "title": "WebhooksEventsInvoiceAdjustmentPendingForApprovalPostPayloadContentApplicationJsonSchemaDataResource", "type": "object" }, "WebhooksEventsInvoiceAdjustmentPendingForApprovalPostPayloadContentApplicationJsonSchemaDataResourceApproversItems": { "properties": { "id": { "type": "integer" }, "name": { "type": "string" } }, "title": "WebhooksEventsInvoiceAdjustmentPendingForApprovalPostPayloadContentApplicationJsonSchemaDataResourceApproversItems", "type": "object" }, "WebhooksEventsInvoiceAdjustmentReviewedPostPayloadContentApplicationJsonSchemaData": { "properties": { "meta": { "$ref": "#/components/schemas/WebhooksEventsInvoiceAdjustmentReviewedPostPayloadContentApplicationJsonSchemaDataMeta" }, "resource": { "items": { "$ref": "#/components/schemas/WebhooksEventsInvoiceAdjustmentReviewedPostPayloadContentApplicationJsonSchemaDataResourceItems" }, "type": "array" } }, "title": "WebhooksEventsInvoiceAdjustmentReviewedPostPayloadContentApplicationJsonSchemaData", "type": "object" }, "WebhooksEventsInvoiceAdjustmentReviewedPostPayloadContentApplicationJsonSchemaDataMeta": { "properties": { "event_type": { "type": "string" }, "event_type_id": { "type": "string" }, "organization_id": { "type": "string" }, "organization_name": { "type": "string" }, "tracking_id": { "type": "string" } }, "title": "WebhooksEventsInvoiceAdjustmentReviewedPostPayloadContentApplicationJsonSchemaDataMeta", "type": "object" }, "WebhooksEventsInvoiceAdjustmentReviewedPostPayloadContentApplicationJsonSchemaDataResourceItems": { "properties": { "id": { "type": "string" }, "status": { "type": "string" } }, "title": "WebhooksEventsInvoiceAdjustmentReviewedPostPayloadContentApplicationJsonSchemaDataResourceItems", "type": "object" }, "WebhooksEventsItAssetArchivedPostPayloadContentApplicationJsonSchemaData": { "properties": { "meta": { "$ref": "#/components/schemas/WebhooksEventsItAssetArchivedPostPayloadContentApplicationJsonSchemaDataMeta" }, "resource": { "$ref": "#/components/schemas/WebhooksEventsItAssetArchivedPostPayloadContentApplicationJsonSchemaDataResource" } }, "title": "WebhooksEventsItAssetArchivedPostPayloadContentApplicationJsonSchemaData", "type": "object" }, "WebhooksEventsItAssetArchivedPostPayloadContentApplicationJsonSchemaDataMeta": { "properties": { "event_type": { "type": "string" }, "event_type_id": { "type": "string" }, "organization_id": { "type": "string" }, "organization_name": { "type": "string" }, "tracking_id": { "type": "string" } }, "title": "WebhooksEventsItAssetArchivedPostPayloadContentApplicationJsonSchemaDataMeta", "type": "object" }, "WebhooksEventsItAssetArchivedPostPayloadContentApplicationJsonSchemaDataResource": { "properties": { "assigned_user": { "type": [ "string", "null" ] }, "assigned_warehouse": { "type": [ "string", "null" ] }, "created_at": { "type": "string" }, "grade": { "type": "string" }, "id": { "type": "string" }, "location": { "type": "string" }, "ownership": { "$ref": "#/components/schemas/WebhooksEventsItAssetArchivedPostPayloadContentApplicationJsonSchemaDataResourceOwnership" }, "product": { "$ref": "#/components/schemas/WebhooksEventsItAssetArchivedPostPayloadContentApplicationJsonSchemaDataResourceProduct" }, "public_id": { "type": "string" }, "serial_number": { "type": [ "string", "null" ] }, "status": { "type": "string" }, "updated_at": { "type": "string" } }, "title": "WebhooksEventsItAssetArchivedPostPayloadContentApplicationJsonSchemaDataResource", "type": "object" }, "WebhooksEventsItAssetArchivedPostPayloadContentApplicationJsonSchemaDataResourceOwnership": { "properties": { "name": { "type": "string" }, "type": { "type": "string" } }, "title": "WebhooksEventsItAssetArchivedPostPayloadContentApplicationJsonSchemaDataResourceOwnership", "type": "object" }, "WebhooksEventsItAssetArchivedPostPayloadContentApplicationJsonSchemaDataResourceProduct": { "properties": { "brand": { "type": "string" }, "category": { "type": "string" }, "id": { "type": "string" }, "name": { "type": "string" } }, "title": "WebhooksEventsItAssetArchivedPostPayloadContentApplicationJsonSchemaDataResourceProduct", "type": "object" }, "WebhooksEventsItAssetCreatedPostPayloadContentApplicationJsonSchemaData": { "properties": { "meta": { "$ref": "#/components/schemas/WebhooksEventsItAssetCreatedPostPayloadContentApplicationJsonSchemaDataMeta" }, "resource": { "$ref": "#/components/schemas/WebhooksEventsItAssetCreatedPostPayloadContentApplicationJsonSchemaDataResource" } }, "title": "WebhooksEventsItAssetCreatedPostPayloadContentApplicationJsonSchemaData", "type": "object" }, "WebhooksEventsItAssetCreatedPostPayloadContentApplicationJsonSchemaDataMeta": { "properties": { "event_type": { "type": "string" }, "event_type_id": { "type": "string" }, "organization_id": { "type": "string" }, "organization_name": { "type": "string" }, "tracking_id": { "type": "string" } }, "title": "WebhooksEventsItAssetCreatedPostPayloadContentApplicationJsonSchemaDataMeta", "type": "object" }, "WebhooksEventsItAssetCreatedPostPayloadContentApplicationJsonSchemaDataResource": { "properties": { "assigned_user": { "$ref": "#/components/schemas/WebhooksEventsItAssetCreatedPostPayloadContentApplicationJsonSchemaDataResourceAssignedUser" }, "assigned_warehouse": { "$ref": "#/components/schemas/WebhooksEventsItAssetCreatedPostPayloadContentApplicationJsonSchemaDataResourceAssignedWarehouse" }, "created_at": { "type": "string" }, "grade": { "type": "string" }, "id": { "type": "string" }, "location": { "type": "string" }, "ownership": { "$ref": "#/components/schemas/WebhooksEventsItAssetCreatedPostPayloadContentApplicationJsonSchemaDataResourceOwnership" }, "product": { "$ref": "#/components/schemas/WebhooksEventsItAssetCreatedPostPayloadContentApplicationJsonSchemaDataResourceProduct" }, "public_id": { "type": "string" }, "purchase_date": { "type": "string" }, "purchase_value": { "$ref": "#/components/schemas/WebhooksEventsItAssetCreatedPostPayloadContentApplicationJsonSchemaDataResourcePurchaseValue" }, "serial_number": { "type": "string" }, "status": { "type": "string" }, "updated_at": { "type": "string" } }, "title": "WebhooksEventsItAssetCreatedPostPayloadContentApplicationJsonSchemaDataResource", "type": "object" }, "WebhooksEventsItAssetCreatedPostPayloadContentApplicationJsonSchemaDataResourceAssignedUser": { "properties": { "address": { "$ref": "#/components/schemas/WebhooksEventsItAssetCreatedPostPayloadContentApplicationJsonSchemaDataResourceAssignedUserAddress" }, "emails": { "items": { "type": "string" }, "type": "array" }, "first_name": { "type": "string" }, "hris_profile_id": { "type": "string" }, "last_name": { "type": "string" }, "public_id": { "type": "string" } }, "title": "WebhooksEventsItAssetCreatedPostPayloadContentApplicationJsonSchemaDataResourceAssignedUser", "type": "object" }, "WebhooksEventsItAssetCreatedPostPayloadContentApplicationJsonSchemaDataResourceAssignedUserAddress": { "properties": { "city": { "type": "string" }, "country": { "type": "string" }, "date_of_birth": { "type": [ "string", "null" ] }, "delivery_instructions": { "type": [ "string", "null" ] }, "id": { "type": "string" }, "is_valid": { "type": "boolean" }, "line1": { "type": "string" }, "line2": { "type": "string" }, "passport_number": { "type": [ "string", "null" ] }, "phone_number": { "type": "string" }, "post_code": { "type": "string" }, "state": { "type": "string" }, "tax_id_number": { "type": [ "string", "null" ] }, "type": { "type": "string" } }, "title": "WebhooksEventsItAssetCreatedPostPayloadContentApplicationJsonSchemaDataResourceAssignedUserAddress", "type": "object" }, "WebhooksEventsItAssetCreatedPostPayloadContentApplicationJsonSchemaDataResourceAssignedWarehouse": { "properties": { "address": { "$ref": "#/components/schemas/WebhooksEventsItAssetCreatedPostPayloadContentApplicationJsonSchemaDataResourceAssignedWarehouseAddress" }, "id": { "type": "string" }, "name": { "type": "string" }, "ownership": { "type": "string" }, "public_id": { "type": "string" } }, "title": "WebhooksEventsItAssetCreatedPostPayloadContentApplicationJsonSchemaDataResourceAssignedWarehouse", "type": "object" }, "WebhooksEventsItAssetCreatedPostPayloadContentApplicationJsonSchemaDataResourceAssignedWarehouseAddress": { "properties": { "country": { "type": "string" }, "id": { "type": "string" }, "type": { "type": "string" } }, "title": "WebhooksEventsItAssetCreatedPostPayloadContentApplicationJsonSchemaDataResourceAssignedWarehouseAddress", "type": "object" }, "WebhooksEventsItAssetCreatedPostPayloadContentApplicationJsonSchemaDataResourceOwnership": { "properties": { "name": { "type": "string" }, "type": { "type": "string" } }, "title": "WebhooksEventsItAssetCreatedPostPayloadContentApplicationJsonSchemaDataResourceOwnership", "type": "object" }, "WebhooksEventsItAssetCreatedPostPayloadContentApplicationJsonSchemaDataResourceProduct": { "properties": { "brand": { "type": "string" }, "category": { "type": "string" }, "id": { "type": "string" }, "name": { "type": "string" } }, "title": "WebhooksEventsItAssetCreatedPostPayloadContentApplicationJsonSchemaDataResourceProduct", "type": "object" }, "WebhooksEventsItAssetCreatedPostPayloadContentApplicationJsonSchemaDataResourcePurchaseValue": { "properties": { "amount": { "type": "string" }, "currency": { "type": "string" } }, "title": "WebhooksEventsItAssetCreatedPostPayloadContentApplicationJsonSchemaDataResourcePurchaseValue", "type": "object" }, "WebhooksEventsItAssetLocationUpdatedPostPayloadContentApplicationJsonSchemaData": { "properties": { "meta": { "$ref": "#/components/schemas/WebhooksEventsItAssetLocationUpdatedPostPayloadContentApplicationJsonSchemaDataMeta" }, "resource": { "$ref": "#/components/schemas/WebhooksEventsItAssetLocationUpdatedPostPayloadContentApplicationJsonSchemaDataResource" } }, "title": "WebhooksEventsItAssetLocationUpdatedPostPayloadContentApplicationJsonSchemaData", "type": "object" }, "WebhooksEventsItAssetLocationUpdatedPostPayloadContentApplicationJsonSchemaDataMeta": { "properties": { "event_type": { "type": "string" }, "event_type_id": { "type": "string" }, "organization_id": { "type": "string" }, "organization_name": { "type": "string" }, "tracking_id": { "type": "string" } }, "title": "WebhooksEventsItAssetLocationUpdatedPostPayloadContentApplicationJsonSchemaDataMeta", "type": "object" }, "WebhooksEventsItAssetLocationUpdatedPostPayloadContentApplicationJsonSchemaDataResource": { "properties": { "created_at": { "type": "string" }, "from": { "$ref": "#/components/schemas/WebhooksEventsItAssetLocationUpdatedPostPayloadContentApplicationJsonSchemaDataResourceFrom" }, "grade": { "type": "string" }, "id": { "type": "string" }, "ownership": { "$ref": "#/components/schemas/WebhooksEventsItAssetLocationUpdatedPostPayloadContentApplicationJsonSchemaDataResourceOwnership" }, "product": { "$ref": "#/components/schemas/WebhooksEventsItAssetLocationUpdatedPostPayloadContentApplicationJsonSchemaDataResourceProduct" }, "public_id": { "type": "string" }, "serial_number": { "type": "string" }, "status": { "type": "string" }, "to": { "$ref": "#/components/schemas/WebhooksEventsItAssetLocationUpdatedPostPayloadContentApplicationJsonSchemaDataResourceTo" }, "updated_at": { "type": "string" } }, "title": "WebhooksEventsItAssetLocationUpdatedPostPayloadContentApplicationJsonSchemaDataResource", "type": "object" }, "WebhooksEventsItAssetLocationUpdatedPostPayloadContentApplicationJsonSchemaDataResourceFrom": { "properties": { "assigned_user": { "$ref": "#/components/schemas/WebhooksEventsItAssetLocationUpdatedPostPayloadContentApplicationJsonSchemaDataResourceFromAssignedUser" }, "assigned_warehouse": { "type": [ "string", "null" ] }, "location": { "type": "string" } }, "title": "WebhooksEventsItAssetLocationUpdatedPostPayloadContentApplicationJsonSchemaDataResourceFrom", "type": "object" }, "WebhooksEventsItAssetLocationUpdatedPostPayloadContentApplicationJsonSchemaDataResourceFromAssignedUser": { "properties": { "address": { "$ref": "#/components/schemas/WebhooksEventsItAssetLocationUpdatedPostPayloadContentApplicationJsonSchemaDataResourceFromAssignedUserAddress" }, "emails": { "items": { "type": "string" }, "type": "array" }, "first_name": { "type": "string" }, "hris_profile_id": { "type": "string" }, "last_name": { "type": "string" }, "public_id": { "type": "string" } }, "title": "WebhooksEventsItAssetLocationUpdatedPostPayloadContentApplicationJsonSchemaDataResourceFromAssignedUser", "type": "object" }, "WebhooksEventsItAssetLocationUpdatedPostPayloadContentApplicationJsonSchemaDataResourceFromAssignedUserAddress": { "properties": { "city": { "type": "string" }, "country": { "type": "string" }, "date_of_birth": { "type": [ "string", "null" ] }, "delivery_instructions": { "type": [ "string", "null" ] }, "id": { "type": "string" }, "is_valid": { "type": "boolean" }, "line1": { "type": "string" }, "line2": { "type": "string" }, "passport_number": { "type": [ "string", "null" ] }, "phone_number": { "type": "string" }, "post_code": { "type": "string" }, "state": { "type": "string" }, "tax_id_number": { "type": "string" }, "type": { "type": "string" } }, "title": "WebhooksEventsItAssetLocationUpdatedPostPayloadContentApplicationJsonSchemaDataResourceFromAssignedUserAddress", "type": "object" }, "WebhooksEventsItAssetLocationUpdatedPostPayloadContentApplicationJsonSchemaDataResourceOwnership": { "properties": { "name": { "type": "string" }, "type": { "type": "string" } }, "title": "WebhooksEventsItAssetLocationUpdatedPostPayloadContentApplicationJsonSchemaDataResourceOwnership", "type": "object" }, "WebhooksEventsItAssetLocationUpdatedPostPayloadContentApplicationJsonSchemaDataResourceProduct": { "properties": { "brand": { "type": "string" }, "category": { "type": "string" }, "id": { "type": "string" }, "name": { "type": "string" } }, "title": "WebhooksEventsItAssetLocationUpdatedPostPayloadContentApplicationJsonSchemaDataResourceProduct", "type": "object" }, "WebhooksEventsItAssetLocationUpdatedPostPayloadContentApplicationJsonSchemaDataResourceTo": { "properties": { "assigned_user": { "$ref": "#/components/schemas/WebhooksEventsItAssetLocationUpdatedPostPayloadContentApplicationJsonSchemaDataResourceToAssignedUser" }, "assigned_warehouse": { "type": [ "string", "null" ] }, "location": { "type": "string" } }, "title": "WebhooksEventsItAssetLocationUpdatedPostPayloadContentApplicationJsonSchemaDataResourceTo", "type": "object" }, "WebhooksEventsItAssetLocationUpdatedPostPayloadContentApplicationJsonSchemaDataResourceToAssignedUser": { "properties": { "address": { "$ref": "#/components/schemas/WebhooksEventsItAssetLocationUpdatedPostPayloadContentApplicationJsonSchemaDataResourceToAssignedUserAddress" }, "emails": { "items": { "type": "string" }, "type": "array" }, "first_name": { "type": "string" }, "hris_profile_id": { "type": "string" }, "last_name": { "type": "string" }, "public_id": { "type": "string" } }, "title": "WebhooksEventsItAssetLocationUpdatedPostPayloadContentApplicationJsonSchemaDataResourceToAssignedUser", "type": "object" }, "WebhooksEventsItAssetLocationUpdatedPostPayloadContentApplicationJsonSchemaDataResourceToAssignedUserAddress": { "properties": { "city": { "type": "string" }, "country": { "type": "string" }, "date_of_birth": { "type": [ "string", "null" ] }, "delivery_instructions": { "type": [ "string", "null" ] }, "id": { "type": "string" }, "is_valid": { "type": "boolean" }, "line1": { "type": "string" }, "line2": { "type": "string" }, "passport_number": { "type": [ "string", "null" ] }, "phone_number": { "type": "string" }, "post_code": { "type": "string" }, "state": { "type": "string" }, "tax_id_number": { "type": "string" }, "type": { "type": "string" } }, "title": "WebhooksEventsItAssetLocationUpdatedPostPayloadContentApplicationJsonSchemaDataResourceToAssignedUserAddress", "type": "object" }, "WebhooksEventsItOrderCreatedPostPayloadContentApplicationJsonSchemaData": { "properties": { "meta": { "$ref": "#/components/schemas/WebhooksEventsItOrderCreatedPostPayloadContentApplicationJsonSchemaDataMeta" }, "resource": { "$ref": "#/components/schemas/WebhooksEventsItOrderCreatedPostPayloadContentApplicationJsonSchemaDataResource" } }, "title": "WebhooksEventsItOrderCreatedPostPayloadContentApplicationJsonSchemaData", "type": "object" }, "WebhooksEventsItOrderCreatedPostPayloadContentApplicationJsonSchemaDataMeta": { "properties": { "event_type": { "type": "string" }, "event_type_id": { "type": "string" }, "organization_id": { "type": "string" }, "organization_name": { "type": "string" }, "tracking_id": { "type": "string" } }, "title": "WebhooksEventsItOrderCreatedPostPayloadContentApplicationJsonSchemaDataMeta", "type": "object" }, "WebhooksEventsItOrderCreatedPostPayloadContentApplicationJsonSchemaDataResource": { "properties": { "created_at": { "type": "string" }, "id": { "type": "string" }, "order_items": { "items": { "$ref": "#/components/schemas/WebhooksEventsItOrderCreatedPostPayloadContentApplicationJsonSchemaDataResourceOrderItemsItems" }, "type": "array" }, "public_id": { "type": "string" }, "status": { "type": "string" }, "updated_at": { "type": "string" }, "user": { "$ref": "#/components/schemas/WebhooksEventsItOrderCreatedPostPayloadContentApplicationJsonSchemaDataResourceUser" } }, "title": "WebhooksEventsItOrderCreatedPostPayloadContentApplicationJsonSchemaDataResource", "type": "object" }, "WebhooksEventsItOrderCreatedPostPayloadContentApplicationJsonSchemaDataResourceOrderItemsItems": { "properties": { "is_approved": { "type": "boolean" }, "is_express_delivery_requested": { "type": "boolean" }, "product": { "$ref": "#/components/schemas/WebhooksEventsItOrderCreatedPostPayloadContentApplicationJsonSchemaDataResourceOrderItemsItemsProduct" }, "status": { "type": "string" } }, "title": "WebhooksEventsItOrderCreatedPostPayloadContentApplicationJsonSchemaDataResourceOrderItemsItems", "type": "object" }, "WebhooksEventsItOrderCreatedPostPayloadContentApplicationJsonSchemaDataResourceOrderItemsItemsProduct": { "properties": { "brand": { "type": "string" }, "category": { "type": "string" }, "id": { "type": "string" }, "name": { "type": "string" } }, "title": "WebhooksEventsItOrderCreatedPostPayloadContentApplicationJsonSchemaDataResourceOrderItemsItemsProduct", "type": "object" }, "WebhooksEventsItOrderCreatedPostPayloadContentApplicationJsonSchemaDataResourceUser": { "properties": { "address": { "$ref": "#/components/schemas/WebhooksEventsItOrderCreatedPostPayloadContentApplicationJsonSchemaDataResourceUserAddress" }, "emails": { "items": { "type": "string" }, "type": "array" }, "first_name": { "type": "string" }, "hris_profile_id": { "type": "string" }, "last_name": { "type": "string" }, "public_id": { "type": "string" } }, "title": "WebhooksEventsItOrderCreatedPostPayloadContentApplicationJsonSchemaDataResourceUser", "type": "object" }, "WebhooksEventsItOrderCreatedPostPayloadContentApplicationJsonSchemaDataResourceUserAddress": { "properties": { "city": { "type": "string" }, "country": { "type": "string" }, "date_of_birth": { "type": [ "string", "null" ] }, "delivery_instructions": { "type": [ "string", "null" ] }, "id": { "type": "string" }, "is_valid": { "type": "boolean" }, "line1": { "type": "string" }, "line2": { "type": [ "string", "null" ] }, "passport_number": { "type": [ "string", "null" ] }, "phone_number": { "type": "string" }, "post_code": { "type": "string" }, "state": { "type": "string" }, "tax_id_number": { "type": "string" }, "type": { "type": "string" } }, "title": "WebhooksEventsItOrderCreatedPostPayloadContentApplicationJsonSchemaDataResourceUserAddress", "type": "object" }, "WebhooksEventsItOrderUpdatedPostPayloadContentApplicationJsonSchemaData": { "properties": { "meta": { "$ref": "#/components/schemas/WebhooksEventsItOrderUpdatedPostPayloadContentApplicationJsonSchemaDataMeta" }, "resource": { "$ref": "#/components/schemas/WebhooksEventsItOrderUpdatedPostPayloadContentApplicationJsonSchemaDataResource" } }, "title": "WebhooksEventsItOrderUpdatedPostPayloadContentApplicationJsonSchemaData", "type": "object" }, "WebhooksEventsItOrderUpdatedPostPayloadContentApplicationJsonSchemaDataMeta": { "properties": { "event_type": { "type": "string" }, "event_type_id": { "type": "string" }, "organization_id": { "type": "string" }, "organization_name": { "type": "string" }, "tracking_id": { "type": "string" } }, "title": "WebhooksEventsItOrderUpdatedPostPayloadContentApplicationJsonSchemaDataMeta", "type": "object" }, "WebhooksEventsItOrderUpdatedPostPayloadContentApplicationJsonSchemaDataResource": { "properties": { "created_at": { "type": "string" }, "id": { "type": "string" }, "order_items": { "items": { "$ref": "#/components/schemas/WebhooksEventsItOrderUpdatedPostPayloadContentApplicationJsonSchemaDataResourceOrderItemsItems" }, "type": "array" }, "public_id": { "type": "string" }, "status": { "type": "string" }, "updated_at": { "type": "string" }, "user": { "$ref": "#/components/schemas/WebhooksEventsItOrderUpdatedPostPayloadContentApplicationJsonSchemaDataResourceUser" } }, "title": "WebhooksEventsItOrderUpdatedPostPayloadContentApplicationJsonSchemaDataResource", "type": "object" }, "WebhooksEventsItOrderUpdatedPostPayloadContentApplicationJsonSchemaDataResourceOrderItemsItems": { "properties": { "is_approved": { "type": "boolean" }, "is_express_delivery_requested": { "type": "boolean" }, "pricing_details": { "$ref": "#/components/schemas/WebhooksEventsItOrderUpdatedPostPayloadContentApplicationJsonSchemaDataResourceOrderItemsItemsPricingDetails" }, "product": { "$ref": "#/components/schemas/WebhooksEventsItOrderUpdatedPostPayloadContentApplicationJsonSchemaDataResourceOrderItemsItemsProduct" }, "status": { "type": "string" } }, "title": "WebhooksEventsItOrderUpdatedPostPayloadContentApplicationJsonSchemaDataResourceOrderItemsItems", "type": "object" }, "WebhooksEventsItOrderUpdatedPostPayloadContentApplicationJsonSchemaDataResourceOrderItemsItemsPricingDetails": { "properties": { "acquisition_type": { "type": "string" }, "asset_price": { "$ref": "#/components/schemas/WebhooksEventsItOrderUpdatedPostPayloadContentApplicationJsonSchemaDataResourceOrderItemsItemsPricingDetailsAssetPrice" }, "storefront_fee": { "$ref": "#/components/schemas/WebhooksEventsItOrderUpdatedPostPayloadContentApplicationJsonSchemaDataResourceOrderItemsItemsPricingDetailsStorefrontFee" } }, "title": "WebhooksEventsItOrderUpdatedPostPayloadContentApplicationJsonSchemaDataResourceOrderItemsItemsPricingDetails", "type": "object" }, "WebhooksEventsItOrderUpdatedPostPayloadContentApplicationJsonSchemaDataResourceOrderItemsItemsPricingDetailsAssetPrice": { "properties": { "amount": { "type": "string" }, "currency": { "type": "string" } }, "title": "WebhooksEventsItOrderUpdatedPostPayloadContentApplicationJsonSchemaDataResourceOrderItemsItemsPricingDetailsAssetPrice", "type": "object" }, "WebhooksEventsItOrderUpdatedPostPayloadContentApplicationJsonSchemaDataResourceOrderItemsItemsPricingDetailsStorefrontFee": { "properties": { "amount": { "type": "string" }, "currency": { "type": "string" } }, "title": "WebhooksEventsItOrderUpdatedPostPayloadContentApplicationJsonSchemaDataResourceOrderItemsItemsPricingDetailsStorefrontFee", "type": "object" }, "WebhooksEventsItOrderUpdatedPostPayloadContentApplicationJsonSchemaDataResourceOrderItemsItemsProduct": { "properties": { "brand": { "type": "string" }, "category": { "type": "string" }, "id": { "type": "string" }, "name": { "type": "string" } }, "title": "WebhooksEventsItOrderUpdatedPostPayloadContentApplicationJsonSchemaDataResourceOrderItemsItemsProduct", "type": "object" }, "WebhooksEventsItOrderUpdatedPostPayloadContentApplicationJsonSchemaDataResourceUser": { "properties": { "address": { "$ref": "#/components/schemas/WebhooksEventsItOrderUpdatedPostPayloadContentApplicationJsonSchemaDataResourceUserAddress" }, "emails": { "items": { "type": "string" }, "type": "array" }, "first_name": { "type": "string" }, "hris_profile_id": { "type": "string" }, "last_name": { "type": "string" }, "public_id": { "type": "string" } }, "title": "WebhooksEventsItOrderUpdatedPostPayloadContentApplicationJsonSchemaDataResourceUser", "type": "object" }, "WebhooksEventsItOrderUpdatedPostPayloadContentApplicationJsonSchemaDataResourceUserAddress": { "properties": { "city": { "type": "string" }, "country": { "type": "string" }, "date_of_birth": { "type": [ "string", "null" ] }, "delivery_instructions": { "type": [ "string", "null" ] }, "id": { "type": "string" }, "is_valid": { "type": "boolean" }, "line1": { "type": "string" }, "line2": { "type": [ "string", "null" ] }, "passport_number": { "type": [ "string", "null" ] }, "phone_number": { "type": "string" }, "post_code": { "type": "string" }, "state": { "type": "string" }, "tax_id_number": { "type": "string" }, "type": { "type": "string" } }, "title": "WebhooksEventsItOrderUpdatedPostPayloadContentApplicationJsonSchemaDataResourceUserAddress", "type": "object" }, "WebhooksEventsOauth2TokenRevokedPostPayloadContentApplicationJsonSchemaData": { "properties": { "meta": { "$ref": "#/components/schemas/WebhooksEventsOauth2TokenRevokedPostPayloadContentApplicationJsonSchemaDataMeta" }, "resource": { "$ref": "#/components/schemas/WebhooksEventsOauth2TokenRevokedPostPayloadContentApplicationJsonSchemaDataResource" } }, "title": "WebhooksEventsOauth2TokenRevokedPostPayloadContentApplicationJsonSchemaData", "type": "object" }, "WebhooksEventsOauth2TokenRevokedPostPayloadContentApplicationJsonSchemaDataMeta": { "properties": { "event_type": { "type": "string" }, "event_type_id": { "type": "string" }, "organization_id": { "type": "string" }, "organization_name": { "type": "string" }, "tracking_id": { "type": "string" } }, "title": "WebhooksEventsOauth2TokenRevokedPostPayloadContentApplicationJsonSchemaDataMeta", "type": "object" }, "WebhooksEventsOauth2TokenRevokedPostPayloadContentApplicationJsonSchemaDataResource": { "properties": { "client_id": { "type": "string" }, "created_at": { "type": "string" }, "expires_at": { "type": "string" }, "id": { "type": "string" }, "redirect_uri": { "type": "string" }, "scope": { "type": "string" }, "state": { "type": "string" }, "status": { "type": "string" }, "updated_at": { "type": "string" } }, "title": "WebhooksEventsOauth2TokenRevokedPostPayloadContentApplicationJsonSchemaDataResource", "type": "object" }, "WebhooksEventsOnboardingChecklistUpdatedPostPayloadContentApplicationJsonSchemaData": { "properties": { "meta": { "$ref": "#/components/schemas/WebhooksEventsOnboardingChecklistUpdatedPostPayloadContentApplicationJsonSchemaDataMeta" }, "resource": { "$ref": "#/components/schemas/WebhooksEventsOnboardingChecklistUpdatedPostPayloadContentApplicationJsonSchemaDataResource" } }, "title": "WebhooksEventsOnboardingChecklistUpdatedPostPayloadContentApplicationJsonSchemaData", "type": "object" }, "WebhooksEventsOnboardingChecklistUpdatedPostPayloadContentApplicationJsonSchemaDataMeta": { "properties": { "event_type": { "type": "string" }, "event_type_id": { "type": "string" }, "organization_id": { "type": "string" }, "organization_name": { "type": "string" }, "tracking_id": { "type": "string" } }, "title": "WebhooksEventsOnboardingChecklistUpdatedPostPayloadContentApplicationJsonSchemaDataMeta", "type": "object" }, "WebhooksEventsOnboardingChecklistUpdatedPostPayloadContentApplicationJsonSchemaDataResource": { "properties": { "checklist_id": { "type": "string" }, "hiring_type": { "type": "string" }, "hris_profile_id": { "type": "string" }, "old_status": { "type": "string" }, "status": { "type": "string" }, "step_id": { "type": "string" }, "step_slug": { "type": "string" }, "tracker_id": { "type": "string" } }, "title": "WebhooksEventsOnboardingChecklistUpdatedPostPayloadContentApplicationJsonSchemaDataResource", "type": "object" }, "WebhooksEventsOnboardingStatusUpdatedPostPayloadContentApplicationJsonSchemaData": { "properties": { "meta": { "$ref": "#/components/schemas/WebhooksEventsOnboardingStatusUpdatedPostPayloadContentApplicationJsonSchemaDataMeta" }, "resource": { "$ref": "#/components/schemas/WebhooksEventsOnboardingStatusUpdatedPostPayloadContentApplicationJsonSchemaDataResource" } }, "title": "WebhooksEventsOnboardingStatusUpdatedPostPayloadContentApplicationJsonSchemaData", "type": "object" }, "WebhooksEventsOnboardingStatusUpdatedPostPayloadContentApplicationJsonSchemaDataMeta": { "properties": { "event_type": { "type": "string" }, "event_type_id": { "type": "string" }, "organization_id": { "type": "string" }, "organization_name": { "type": "string" }, "tracking_id": { "type": "string" } }, "title": "WebhooksEventsOnboardingStatusUpdatedPostPayloadContentApplicationJsonSchemaDataMeta", "type": "object" }, "WebhooksEventsOnboardingStatusUpdatedPostPayloadContentApplicationJsonSchemaDataResource": { "properties": { "hiring_type": { "type": "string" }, "hris_profile_id": { "type": "string" }, "old_status": { "type": "string" }, "status": { "type": "string" }, "tracker_id": { "type": "string" } }, "title": "WebhooksEventsOnboardingStatusUpdatedPostPayloadContentApplicationJsonSchemaDataResource", "type": "object" }, "WebhooksEventsPaymentStatementInitiatedPostPayloadContentApplicationJsonSchemaData": { "properties": { "meta": { "$ref": "#/components/schemas/WebhooksEventsPaymentStatementInitiatedPostPayloadContentApplicationJsonSchemaDataMeta" }, "resource": { "$ref": "#/components/schemas/WebhooksEventsPaymentStatementInitiatedPostPayloadContentApplicationJsonSchemaDataResource" } }, "title": "WebhooksEventsPaymentStatementInitiatedPostPayloadContentApplicationJsonSchemaData", "type": "object" }, "WebhooksEventsPaymentStatementInitiatedPostPayloadContentApplicationJsonSchemaDataMeta": { "properties": { "event_type": { "type": "string" }, "event_type_id": { "type": "string" }, "organization_id": { "type": "string" }, "organization_name": { "type": "string" }, "tracking_id": { "type": "string" } }, "title": "WebhooksEventsPaymentStatementInitiatedPostPayloadContentApplicationJsonSchemaDataMeta", "type": "object" }, "WebhooksEventsPaymentStatementInitiatedPostPayloadContentApplicationJsonSchemaDataResource": { "properties": { "invoices": { "items": { "type": "integer" }, "type": "array" } }, "title": "WebhooksEventsPaymentStatementInitiatedPostPayloadContentApplicationJsonSchemaDataResource", "type": "object" }, "WebhooksEventsPaymentStatementMarkPaidPostPayloadContentApplicationJsonSchemaData": { "properties": { "meta": { "$ref": "#/components/schemas/WebhooksEventsPaymentStatementMarkPaidPostPayloadContentApplicationJsonSchemaDataMeta" }, "resource": { "$ref": "#/components/schemas/WebhooksEventsPaymentStatementMarkPaidPostPayloadContentApplicationJsonSchemaDataResource" } }, "title": "WebhooksEventsPaymentStatementMarkPaidPostPayloadContentApplicationJsonSchemaData", "type": "object" }, "WebhooksEventsPaymentStatementMarkPaidPostPayloadContentApplicationJsonSchemaDataMeta": { "properties": { "event_type": { "type": "string" }, "event_type_id": { "type": "string" }, "organization_id": { "type": "string" }, "organization_name": { "type": "string" }, "tracking_id": { "type": "string" } }, "title": "WebhooksEventsPaymentStatementMarkPaidPostPayloadContentApplicationJsonSchemaDataMeta", "type": "object" }, "WebhooksEventsPaymentStatementMarkPaidPostPayloadContentApplicationJsonSchemaDataResource": { "properties": { "invoices": { "items": { "type": "integer" }, "type": "array" } }, "title": "WebhooksEventsPaymentStatementMarkPaidPostPayloadContentApplicationJsonSchemaDataResource", "type": "object" }, "WebhooksEventsPayslipDocumentDeletedPostPayloadContentApplicationJsonSchemaData": { "properties": { "meta": { "$ref": "#/components/schemas/WebhooksEventsPayslipDocumentDeletedPostPayloadContentApplicationJsonSchemaDataMeta" }, "resource": { "items": { "$ref": "#/components/schemas/WebhooksEventsPayslipDocumentDeletedPostPayloadContentApplicationJsonSchemaDataResourceItems" }, "type": "array" } }, "title": "WebhooksEventsPayslipDocumentDeletedPostPayloadContentApplicationJsonSchemaData", "type": "object" }, "WebhooksEventsPayslipDocumentDeletedPostPayloadContentApplicationJsonSchemaDataMeta": { "properties": { "event_type": { "type": "string" }, "event_type_id": { "type": "string" }, "organization_id": { "type": "string" }, "organization_name": { "type": "string" }, "tracking_id": { "type": "string" } }, "title": "WebhooksEventsPayslipDocumentDeletedPostPayloadContentApplicationJsonSchemaDataMeta", "type": "object" }, "WebhooksEventsPayslipDocumentDeletedPostPayloadContentApplicationJsonSchemaDataResourceItems": { "properties": { "contract_oid": { "type": "string" }, "from": { "type": "string" }, "id": { "type": "integer" }, "status": { "type": "string" }, "to": { "type": "string" } }, "title": "WebhooksEventsPayslipDocumentDeletedPostPayloadContentApplicationJsonSchemaDataResourceItems", "type": "object" }, "WebhooksEventsProfileKycChangedPostPayloadContentApplicationJsonSchemaData": { "properties": { "meta": { "$ref": "#/components/schemas/WebhooksEventsProfileKycChangedPostPayloadContentApplicationJsonSchemaDataMeta" }, "resource": { "$ref": "#/components/schemas/WebhooksEventsProfileKycChangedPostPayloadContentApplicationJsonSchemaDataResource" } }, "title": "WebhooksEventsProfileKycChangedPostPayloadContentApplicationJsonSchemaData", "type": "object" }, "WebhooksEventsProfileKycChangedPostPayloadContentApplicationJsonSchemaDataMeta": { "properties": { "event_type": { "type": "string" }, "event_type_id": { "type": "string" }, "organization_id": { "type": "string" }, "organization_name": { "type": "string" }, "tracking_id": { "type": "string" } }, "title": "WebhooksEventsProfileKycChangedPostPayloadContentApplicationJsonSchemaDataMeta", "type": "object" }, "WebhooksEventsProfileKycChangedPostPayloadContentApplicationJsonSchemaDataResource": { "properties": { "email": { "type": "string" }, "first_name": { "type": "string" }, "hris_profile_id": { "type": "integer" }, "kyc_status": { "type": "string" }, "last_name": { "type": "string" }, "profile_id": { "type": "string" }, "profile_type": { "type": "string" } }, "title": "WebhooksEventsProfileKycChangedPostPayloadContentApplicationJsonSchemaDataResource", "type": "object" }, "WebhooksEventsTaxDocumentAvailablePostPayloadContentApplicationJsonSchemaData": { "properties": { "meta": { "$ref": "#/components/schemas/WebhooksEventsTaxDocumentAvailablePostPayloadContentApplicationJsonSchemaDataMeta" }, "resource": { "items": { "$ref": "#/components/schemas/WebhooksEventsTaxDocumentAvailablePostPayloadContentApplicationJsonSchemaDataResourceItems" }, "type": "array" } }, "title": "WebhooksEventsTaxDocumentAvailablePostPayloadContentApplicationJsonSchemaData", "type": "object" }, "WebhooksEventsTaxDocumentAvailablePostPayloadContentApplicationJsonSchemaDataMeta": { "properties": { "event_type": { "type": "string" }, "event_type_id": { "type": "string" }, "organization_id": { "type": "string" }, "organization_name": { "type": "string" }, "tracking_id": { "type": "string" } }, "title": "WebhooksEventsTaxDocumentAvailablePostPayloadContentApplicationJsonSchemaDataMeta", "type": "object" }, "WebhooksEventsTaxDocumentAvailablePostPayloadContentApplicationJsonSchemaDataResourceItems": { "properties": { "contract_oid": { "type": "string" }, "country": { "type": "string" }, "document_type": { "type": "string" }, "id": { "type": "integer" }, "month": { "type": [ "string", "null" ] }, "status": { "type": "string" }, "year": { "type": "integer" } }, "title": "WebhooksEventsTaxDocumentAvailablePostPayloadContentApplicationJsonSchemaDataResourceItems", "type": "object" }, "WebhooksEventsTaxDocumentDeletedPostPayloadContentApplicationJsonSchemaData": { "properties": { "meta": { "$ref": "#/components/schemas/WebhooksEventsTaxDocumentDeletedPostPayloadContentApplicationJsonSchemaDataMeta" }, "resource": { "items": { "$ref": "#/components/schemas/WebhooksEventsTaxDocumentDeletedPostPayloadContentApplicationJsonSchemaDataResourceItems" }, "type": "array" } }, "title": "WebhooksEventsTaxDocumentDeletedPostPayloadContentApplicationJsonSchemaData", "type": "object" }, "WebhooksEventsTaxDocumentDeletedPostPayloadContentApplicationJsonSchemaDataMeta": { "properties": { "event_type": { "type": "string" }, "event_type_id": { "type": "string" }, "organization_id": { "type": "string" }, "organization_name": { "type": "string" }, "tracking_id": { "type": "string" } }, "title": "WebhooksEventsTaxDocumentDeletedPostPayloadContentApplicationJsonSchemaDataMeta", "type": "object" }, "WebhooksEventsTaxDocumentDeletedPostPayloadContentApplicationJsonSchemaDataResourceItems": { "properties": { "contract_oid": { "type": "string" }, "country": { "type": "string" }, "document_type": { "type": "string" }, "id": { "type": "integer" }, "month": { "type": [ "string", "null" ] }, "status": { "type": "string" }, "year": { "type": "integer" } }, "title": "WebhooksEventsTaxDocumentDeletedPostPayloadContentApplicationJsonSchemaDataResourceItems", "type": "object" }, "WebhooksEventsTimeOffCreatedPostPayloadContentApplicationJsonSchemaData": { "properties": { "meta": { "$ref": "#/components/schemas/WebhooksEventsTimeOffCreatedPostPayloadContentApplicationJsonSchemaDataMeta" }, "resource": { "$ref": "#/components/schemas/WebhooksEventsTimeOffCreatedPostPayloadContentApplicationJsonSchemaDataResource" } }, "title": "WebhooksEventsTimeOffCreatedPostPayloadContentApplicationJsonSchemaData", "type": "object" }, "WebhooksEventsTimeOffCreatedPostPayloadContentApplicationJsonSchemaDataMeta": { "properties": { "event_type": { "type": "string" }, "event_type_id": { "type": "string" }, "organization_id": { "type": "string" }, "organization_name": { "type": "string" }, "tracking_id": { "type": "string" } }, "title": "WebhooksEventsTimeOffCreatedPostPayloadContentApplicationJsonSchemaDataMeta", "type": "object" }, "WebhooksEventsTimeOffCreatedPostPayloadContentApplicationJsonSchemaDataResource": { "properties": { "contract_id": { "type": "string" }, "created_at": { "type": "string" }, "date_is_half_day": { "type": "boolean" }, "end_date": { "type": "string" }, "end_date_is_half_day": { "type": "boolean" }, "id": { "type": "string" }, "reason": { "type": "string" }, "requested_at": { "type": "string" }, "requester": { "$ref": "#/components/schemas/WebhooksEventsTimeOffCreatedPostPayloadContentApplicationJsonSchemaDataResourceRequester" }, "start_date": { "type": "string" }, "start_date_is_half_day": { "type": "boolean" }, "status": { "type": "string" }, "type": { "type": "string" }, "updated_at": { "type": "string" } }, "title": "WebhooksEventsTimeOffCreatedPostPayloadContentApplicationJsonSchemaDataResource", "type": "object" }, "WebhooksEventsTimeOffCreatedPostPayloadContentApplicationJsonSchemaDataResourceRequester": { "properties": { "id": { "type": "string" }, "is_employee": { "type": "boolean" }, "name": { "type": "string" } }, "title": "WebhooksEventsTimeOffCreatedPostPayloadContentApplicationJsonSchemaDataResourceRequester", "type": "object" }, "WebhooksEventsTimeOffDeletedPostPayloadContentApplicationJsonSchemaData": { "properties": { "meta": { "$ref": "#/components/schemas/WebhooksEventsTimeOffDeletedPostPayloadContentApplicationJsonSchemaDataMeta" }, "resource": { "$ref": "#/components/schemas/WebhooksEventsTimeOffDeletedPostPayloadContentApplicationJsonSchemaDataResource" } }, "title": "WebhooksEventsTimeOffDeletedPostPayloadContentApplicationJsonSchemaData", "type": "object" }, "WebhooksEventsTimeOffDeletedPostPayloadContentApplicationJsonSchemaDataMeta": { "properties": { "event_type": { "type": "string" }, "event_type_id": { "type": "string" }, "organization_id": { "type": "string" }, "organization_name": { "type": "string" }, "tracking_id": { "type": "string" } }, "title": "WebhooksEventsTimeOffDeletedPostPayloadContentApplicationJsonSchemaDataMeta", "type": "object" }, "WebhooksEventsTimeOffDeletedPostPayloadContentApplicationJsonSchemaDataResource": { "properties": { "organization_id": { "type": "integer" }, "time_off_id": { "type": "string" } }, "title": "WebhooksEventsTimeOffDeletedPostPayloadContentApplicationJsonSchemaDataResource", "type": "object" }, "WebhooksEventsTimeOffReviewedPostPayloadContentApplicationJsonSchemaData": { "properties": { "meta": { "$ref": "#/components/schemas/WebhooksEventsTimeOffReviewedPostPayloadContentApplicationJsonSchemaDataMeta" }, "resource": { "$ref": "#/components/schemas/WebhooksEventsTimeOffReviewedPostPayloadContentApplicationJsonSchemaDataResource" } }, "title": "WebhooksEventsTimeOffReviewedPostPayloadContentApplicationJsonSchemaData", "type": "object" }, "WebhooksEventsTimeOffReviewedPostPayloadContentApplicationJsonSchemaDataMeta": { "properties": { "event_type": { "type": "string" }, "event_type_id": { "type": "string" }, "organization_id": { "type": "string" }, "organization_name": { "type": "string" }, "tracking_id": { "type": "string" } }, "title": "WebhooksEventsTimeOffReviewedPostPayloadContentApplicationJsonSchemaDataMeta", "type": "object" }, "WebhooksEventsTimeOffReviewedPostPayloadContentApplicationJsonSchemaDataResource": { "properties": { "contract_id": { "type": "string" }, "created_at": { "type": "string" }, "date_is_half_day": { "type": "boolean" }, "end_date": { "type": "string" }, "end_date_is_half_day": { "type": "boolean" }, "id": { "type": "string" }, "reason": { "type": "string" }, "requested_at": { "type": "string" }, "requester": { "$ref": "#/components/schemas/WebhooksEventsTimeOffReviewedPostPayloadContentApplicationJsonSchemaDataResourceRequester" }, "start_date": { "type": "string" }, "start_date_is_half_day": { "type": "boolean" }, "status": { "type": "string" }, "type": { "type": "string" }, "updated_at": { "type": "string" } }, "title": "WebhooksEventsTimeOffReviewedPostPayloadContentApplicationJsonSchemaDataResource", "type": "object" }, "WebhooksEventsTimeOffReviewedPostPayloadContentApplicationJsonSchemaDataResourceRequester": { "properties": { "id": { "type": "string" }, "is_employee": { "type": "boolean" }, "name": { "type": "string" } }, "title": "WebhooksEventsTimeOffReviewedPostPayloadContentApplicationJsonSchemaDataResourceRequester", "type": "object" }, "WebhooksEventsTimeOffUpdatedPostPayloadContentApplicationJsonSchemaData": { "properties": { "meta": { "$ref": "#/components/schemas/WebhooksEventsTimeOffUpdatedPostPayloadContentApplicationJsonSchemaDataMeta" }, "resource": { "$ref": "#/components/schemas/WebhooksEventsTimeOffUpdatedPostPayloadContentApplicationJsonSchemaDataResource" } }, "title": "WebhooksEventsTimeOffUpdatedPostPayloadContentApplicationJsonSchemaData", "type": "object" }, "WebhooksEventsTimeOffUpdatedPostPayloadContentApplicationJsonSchemaDataMeta": { "properties": { "event_type": { "type": "string" }, "event_type_id": { "type": "string" }, "organization_id": { "type": "string" }, "organization_name": { "type": "string" }, "tracking_id": { "type": "string" } }, "title": "WebhooksEventsTimeOffUpdatedPostPayloadContentApplicationJsonSchemaDataMeta", "type": "object" }, "WebhooksEventsTimeOffUpdatedPostPayloadContentApplicationJsonSchemaDataResource": { "properties": { "contract_id": { "type": "string" }, "created_at": { "type": "string" }, "date_is_half_day": { "type": "boolean" }, "end_date": { "type": "string" }, "end_date_is_half_day": { "type": "boolean" }, "id": { "type": "string" }, "reason": { "type": "string" }, "requested_at": { "type": "string" }, "requester": { "$ref": "#/components/schemas/WebhooksEventsTimeOffUpdatedPostPayloadContentApplicationJsonSchemaDataResourceRequester" }, "start_date": { "type": "string" }, "start_date_is_half_day": { "type": "boolean" }, "status": { "type": "string" }, "type": { "type": "string" }, "updated_at": { "type": "string" } }, "title": "WebhooksEventsTimeOffUpdatedPostPayloadContentApplicationJsonSchemaDataResource", "type": "object" }, "WebhooksEventsTimeOffUpdatedPostPayloadContentApplicationJsonSchemaDataResourceRequester": { "properties": { "id": { "type": "string" }, "is_employee": { "type": "boolean" }, "name": { "type": "string" } }, "title": "WebhooksEventsTimeOffUpdatedPostPayloadContentApplicationJsonSchemaDataResourceRequester", "type": "object" }, "WebhooksEventsTimesheetCreatedPostPayloadContentApplicationJsonSchemaData": { "properties": { "meta": { "$ref": "#/components/schemas/WebhooksEventsTimesheetCreatedPostPayloadContentApplicationJsonSchemaDataMeta" }, "resource": { "$ref": "#/components/schemas/WebhooksEventsTimesheetCreatedPostPayloadContentApplicationJsonSchemaDataResource" } }, "title": "WebhooksEventsTimesheetCreatedPostPayloadContentApplicationJsonSchemaData", "type": "object" }, "WebhooksEventsTimesheetCreatedPostPayloadContentApplicationJsonSchemaDataMeta": { "properties": { "event_type": { "type": "string" }, "event_type_id": { "type": "string" }, "organization_id": { "type": "string" }, "organization_name": { "type": "string" }, "tracking_id": { "type": "string" } }, "title": "WebhooksEventsTimesheetCreatedPostPayloadContentApplicationJsonSchemaDataMeta", "type": "object" }, "WebhooksEventsTimesheetCreatedPostPayloadContentApplicationJsonSchemaDataResource": { "properties": { "created": { "type": "boolean" }, "created_at": { "type": "string" }, "id": { "type": "string" }, "status": { "type": "string" } }, "title": "WebhooksEventsTimesheetCreatedPostPayloadContentApplicationJsonSchemaDataResource", "type": "object" }, "WebhooksEventsTimesheetReviewedPostPayloadContentApplicationJsonSchemaData": { "properties": { "meta": { "$ref": "#/components/schemas/WebhooksEventsTimesheetReviewedPostPayloadContentApplicationJsonSchemaDataMeta" }, "resource": { "items": { "$ref": "#/components/schemas/WebhooksEventsTimesheetReviewedPostPayloadContentApplicationJsonSchemaDataResourceItems" }, "type": "array" } }, "title": "WebhooksEventsTimesheetReviewedPostPayloadContentApplicationJsonSchemaData", "type": "object" }, "WebhooksEventsTimesheetReviewedPostPayloadContentApplicationJsonSchemaDataMeta": { "properties": { "event_type": { "type": "string" }, "event_type_id": { "type": "string" }, "organization_id": { "type": "string" }, "organization_name": { "type": "string" }, "tracking_id": { "type": "string" } }, "title": "WebhooksEventsTimesheetReviewedPostPayloadContentApplicationJsonSchemaDataMeta", "type": "object" }, "WebhooksEventsTimesheetReviewedPostPayloadContentApplicationJsonSchemaDataResourceItems": { "properties": { "id": { "type": "string" }, "status": { "type": "string" } }, "title": "WebhooksEventsTimesheetReviewedPostPayloadContentApplicationJsonSchemaDataResourceItems", "type": "object" }, "WebhooksEventsTypesGetResponsesContentApplicationJsonSchemaDataItems": { "properties": { "created_at": { "description": "Time at which the event type was created.", "type": "string" }, "description": { "description": "Describes the webhook event and other pertinent info.", "type": "string" }, "id": { "description": "Event type unique identifier.", "format": "double", "type": "number" }, "module_label": { "description": "Display name of the rabbit queue in Deel UI.", "type": "string" }, "module_name": { "description": "Name of the rabbit queue.", "type": "string" }, "name": { "description": "Name of the webhook event.", "type": "string" }, "payload_example": { "description": "JSON payload example of the specific event.", "type": [ "string", "null" ] }, "updated_at": { "description": "Time at which the event type was updated.", "type": "string" } }, "required": [ "id", "name", "description", "module_name", "module_label" ], "title": "WebhooksEventsTypesGetResponsesContentApplicationJsonSchemaDataItems", "type": "object" }, "WebhooksEventsTypesGetResponsesContentApplicationJsonSchemaErrorsItems": { "properties": { "error_code": { "description": "Machine-readable error code.", "type": "string" }, "message": { "description": "Human-readable description of the error.", "type": "string" } }, "required": [ "message" ], "title": "WebhooksEventsTypesGetResponsesContentApplicationJsonSchemaErrorsItems", "type": "object" }, "WebhooksEventsWorkerCreatedPostPayloadContentApplicationJsonSchemaData": { "properties": { "meta": { "$ref": "#/components/schemas/WebhooksEventsWorkerCreatedPostPayloadContentApplicationJsonSchemaDataMeta" }, "resource": { "$ref": "#/components/schemas/WebhooksEventsWorkerCreatedPostPayloadContentApplicationJsonSchemaDataResource" } }, "title": "WebhooksEventsWorkerCreatedPostPayloadContentApplicationJsonSchemaData", "type": "object" }, "WebhooksEventsWorkerCreatedPostPayloadContentApplicationJsonSchemaDataMeta": { "properties": { "event_type": { "type": "string" }, "event_type_id": { "type": "string" }, "organization_id": { "type": "string" }, "organization_name": { "type": "string" }, "tracking_id": { "type": "string" } }, "title": "WebhooksEventsWorkerCreatedPostPayloadContentApplicationJsonSchemaDataMeta", "type": "object" }, "WebhooksEventsWorkerCreatedPostPayloadContentApplicationJsonSchemaDataResource": { "properties": { "active": { "type": "boolean" }, "emails": { "items": { "$ref": "#/components/schemas/WebhooksEventsWorkerCreatedPostPayloadContentApplicationJsonSchemaDataResourceEmailsItems" }, "type": "array" }, "id": { "type": "string" }, "meta": { "$ref": "#/components/schemas/WebhooksEventsWorkerCreatedPostPayloadContentApplicationJsonSchemaDataResourceMeta" }, "name": { "$ref": "#/components/schemas/WebhooksEventsWorkerCreatedPostPayloadContentApplicationJsonSchemaDataResourceName" }, "schemas": { "items": { "type": "string" }, "type": "array" }, "title": { "type": "string" }, "urn:ietf:params:scim:schemas:extension:2": { "$ref": "#/components/schemas/WebhooksEventsWorkerCreatedPostPayloadContentApplicationJsonSchemaDataResourceUrnIetfParamsScimSchemasExtension2" }, "urn:ietf:params:scim:schemas:extension:enterprise:2": { "$ref": "#/components/schemas/WebhooksEventsWorkerCreatedPostPayloadContentApplicationJsonSchemaDataResourceUrnIetfParamsScimSchemasExtensionEnterprise2" }, "user_name": { "type": "string" }, "user_type": { "type": "string" } }, "title": "WebhooksEventsWorkerCreatedPostPayloadContentApplicationJsonSchemaDataResource", "type": "object" }, "WebhooksEventsWorkerCreatedPostPayloadContentApplicationJsonSchemaDataResourceEmailsItems": { "properties": { "primary": { "type": "boolean" }, "type": { "type": "string" }, "value": { "type": "string" } }, "title": "WebhooksEventsWorkerCreatedPostPayloadContentApplicationJsonSchemaDataResourceEmailsItems", "type": "object" }, "WebhooksEventsWorkerCreatedPostPayloadContentApplicationJsonSchemaDataResourceMeta": { "properties": { "created": { "type": "string" }, "last_modified": { "type": "string" }, "location": { "type": "string" }, "resource_type": { "type": "string" } }, "title": "WebhooksEventsWorkerCreatedPostPayloadContentApplicationJsonSchemaDataResourceMeta", "type": "object" }, "WebhooksEventsWorkerCreatedPostPayloadContentApplicationJsonSchemaDataResourceName": { "properties": { "family_name": { "type": "string" }, "given_name": { "type": "string" } }, "title": "WebhooksEventsWorkerCreatedPostPayloadContentApplicationJsonSchemaDataResourceName", "type": "object" }, "WebhooksEventsWorkerCreatedPostPayloadContentApplicationJsonSchemaDataResourceUrnIetfParamsScimSchemasExtension2": { "properties": { "0:_user": { "$ref": "#/components/schemas/WebhooksEventsWorkerCreatedPostPayloadContentApplicationJsonSchemaDataResourceUrnIetfParamsScimSchemasExtension20User" } }, "title": "WebhooksEventsWorkerCreatedPostPayloadContentApplicationJsonSchemaDataResourceUrnIetfParamsScimSchemasExtension2", "type": "object" }, "WebhooksEventsWorkerCreatedPostPayloadContentApplicationJsonSchemaDataResourceUrnIetfParamsScimSchemasExtension20User": { "properties": { "end_date": { "type": "string" }, "start_date": { "type": "string" } }, "title": "WebhooksEventsWorkerCreatedPostPayloadContentApplicationJsonSchemaDataResourceUrnIetfParamsScimSchemasExtension20User", "type": "object" }, "WebhooksEventsWorkerCreatedPostPayloadContentApplicationJsonSchemaDataResourceUrnIetfParamsScimSchemasExtensionEnterprise2": { "properties": { "0:_user": { "$ref": "#/components/schemas/WebhooksEventsWorkerCreatedPostPayloadContentApplicationJsonSchemaDataResourceUrnIetfParamsScimSchemasExtensionEnterprise20User" } }, "title": "WebhooksEventsWorkerCreatedPostPayloadContentApplicationJsonSchemaDataResourceUrnIetfParamsScimSchemasExtensionEnterprise2", "type": "object" }, "WebhooksEventsWorkerCreatedPostPayloadContentApplicationJsonSchemaDataResourceUrnIetfParamsScimSchemasExtensionEnterprise20User": { "properties": { "cost_center": { "type": "integer" }, "department": { "type": "string" }, "manager": { "$ref": "#/components/schemas/WebhooksEventsWorkerCreatedPostPayloadContentApplicationJsonSchemaDataResourceUrnIetfParamsScimSchemasExtensionEnterprise20UserManager" }, "organization": { "type": "string" } }, "title": "WebhooksEventsWorkerCreatedPostPayloadContentApplicationJsonSchemaDataResourceUrnIetfParamsScimSchemasExtensionEnterprise20User", "type": "object" }, "WebhooksEventsWorkerCreatedPostPayloadContentApplicationJsonSchemaDataResourceUrnIetfParamsScimSchemasExtensionEnterprise20UserManager": { "properties": { "value": { "type": "string" } }, "title": "WebhooksEventsWorkerCreatedPostPayloadContentApplicationJsonSchemaDataResourceUrnIetfParamsScimSchemasExtensionEnterprise20UserManager", "type": "object" }, "WebhooksEventsWorkerV2CreatedPostPayloadContentApplicationJsonSchemaData": { "properties": { "meta": { "$ref": "#/components/schemas/WebhooksEventsWorkerV2CreatedPostPayloadContentApplicationJsonSchemaDataMeta" }, "resource": { "$ref": "#/components/schemas/WebhooksEventsWorkerV2CreatedPostPayloadContentApplicationJsonSchemaDataResource" } }, "title": "WebhooksEventsWorkerV2CreatedPostPayloadContentApplicationJsonSchemaData", "type": "object" }, "WebhooksEventsWorkerV2CreatedPostPayloadContentApplicationJsonSchemaDataMeta": { "properties": { "event_type": { "type": "string" }, "event_type_id": { "type": "string" }, "organization_id": { "type": "string" }, "organization_name": { "type": "string" }, "tracking_id": { "type": "string" } }, "title": "WebhooksEventsWorkerV2CreatedPostPayloadContentApplicationJsonSchemaDataMeta", "type": "object" }, "WebhooksEventsWorkerV2CreatedPostPayloadContentApplicationJsonSchemaDataResource": { "properties": { "id": { "type": "string" } }, "title": "WebhooksEventsWorkerV2CreatedPostPayloadContentApplicationJsonSchemaDataResource", "type": "object" }, "WebhooksEventsWorkerV2DeletedPostPayloadContentApplicationJsonSchemaData": { "properties": { "meta": { "$ref": "#/components/schemas/WebhooksEventsWorkerV2DeletedPostPayloadContentApplicationJsonSchemaDataMeta" }, "resource": { "$ref": "#/components/schemas/WebhooksEventsWorkerV2DeletedPostPayloadContentApplicationJsonSchemaDataResource" } }, "title": "WebhooksEventsWorkerV2DeletedPostPayloadContentApplicationJsonSchemaData", "type": "object" }, "WebhooksEventsWorkerV2DeletedPostPayloadContentApplicationJsonSchemaDataMeta": { "properties": { "event_type": { "type": "string" }, "event_type_id": { "type": "string" }, "organization_id": { "type": "string" }, "organization_name": { "type": "string" }, "tracking_id": { "type": "string" } }, "title": "WebhooksEventsWorkerV2DeletedPostPayloadContentApplicationJsonSchemaDataMeta", "type": "object" }, "WebhooksEventsWorkerV2DeletedPostPayloadContentApplicationJsonSchemaDataResource": { "properties": { "id": { "type": "string" } }, "title": "WebhooksEventsWorkerV2DeletedPostPayloadContentApplicationJsonSchemaDataResource", "type": "object" }, "WebhooksEventsWorkerV2UpdatedPostPayloadContentApplicationJsonSchemaData": { "properties": { "meta": { "$ref": "#/components/schemas/WebhooksEventsWorkerV2UpdatedPostPayloadContentApplicationJsonSchemaDataMeta" }, "resource": { "$ref": "#/components/schemas/WebhooksEventsWorkerV2UpdatedPostPayloadContentApplicationJsonSchemaDataResource" } }, "title": "WebhooksEventsWorkerV2UpdatedPostPayloadContentApplicationJsonSchemaData", "type": "object" }, "WebhooksEventsWorkerV2UpdatedPostPayloadContentApplicationJsonSchemaDataMeta": { "properties": { "event_type": { "type": "string" }, "event_type_id": { "type": "string" }, "organization_id": { "type": "string" }, "organization_name": { "type": "string" }, "tracking_id": { "type": "string" } }, "title": "WebhooksEventsWorkerV2UpdatedPostPayloadContentApplicationJsonSchemaDataMeta", "type": "object" }, "WebhooksEventsWorkerV2UpdatedPostPayloadContentApplicationJsonSchemaDataResource": { "properties": { "id": { "type": "string" } }, "title": "WebhooksEventsWorkerV2UpdatedPostPayloadContentApplicationJsonSchemaDataResource", "type": "object" }, "WebhooksGetResponsesContentApplicationJsonSchemaDataItems": { "properties": { "api_version": { "default": "v2", "description": "Deel API version. Currently Deel accepts v1 or v2 version.", "type": "string" }, "created_at": { "description": "Time at which the webhook was created.", "type": "string" }, "deleted_at": { "description": "Time at which the webhook was deleted.", "type": [ "string", "null" ] }, "description": { "description": "Webhook subscription description.", "type": [ "string", "null" ] }, "events": { "description": "The list of events to enable for this subscription.", "items": { "type": "string" }, "type": "array" }, "hidden": { "description": "Property to hide the webhook from frontend view. Commonly by Deel 3rd party apps", "type": [ "boolean", "null" ] }, "id": { "description": "Unique identifier of this resource.", "type": "string" }, "include_child_orgs": { "description": "When true, the webhook will also receive events from child organizations.", "type": [ "boolean", "null" ] }, "internal": { "description": "Indicates whether the webhook is internal to Deel.", "type": "boolean" }, "name": { "description": "Webhook subscription name.", "type": [ "string", "null" ] }, "signing_key": { "description": "The webhook's signing key, used to generate webhook signatures.", "type": [ "string", "null" ] }, "status": { "$ref": "#/components/schemas/WebhooksGetResponsesContentApplicationJsonSchemaDataItemsStatus", "description": "Status of webhook." }, "updated_at": { "description": "Time at which the webhook was updated.", "type": "string" }, "url": { "description": "Endpoint to receive webhook.", "type": "string" } }, "required": [ "id", "url", "name", "events", "status", "created_at", "updated_at", "api_version", "description", "signing_key" ], "title": "WebhooksGetResponsesContentApplicationJsonSchemaDataItems", "type": "object" }, "WebhooksGetResponsesContentApplicationJsonSchemaDataItemsStatus": { "description": "Status of webhook.", "enum": [ "enabled", "disabled" ], "title": "WebhooksGetResponsesContentApplicationJsonSchemaDataItemsStatus", "type": "string" }, "WebhooksGetResponsesContentApplicationJsonSchemaErrorsItems": { "properties": { "error_code": { "description": "Machine-readable error code.", "type": "string" }, "message": { "description": "Human-readable description of the error.", "type": "string" } }, "required": [ "message" ], "title": "WebhooksGetResponsesContentApplicationJsonSchemaErrorsItems", "type": "object" }, "WebhooksIdDeleteResponsesContentApplicationJsonSchemaData": { "description": "The result of the delete operation.", "properties": { "deleted": { "description": "Confirms the deletion.", "type": "boolean" } }, "required": [ "deleted" ], "title": "WebhooksIdDeleteResponsesContentApplicationJsonSchemaData", "type": "object" }, "WebhooksIdDeleteResponsesContentApplicationJsonSchemaErrorsItems": { "properties": { "error_code": { "description": "Machine-readable error code.", "type": "string" }, "message": { "description": "Human-readable description of the error.", "type": "string" } }, "required": [ "message" ], "title": "WebhooksIdDeleteResponsesContentApplicationJsonSchemaErrorsItems", "type": "object" }, "WebhooksIdGetResponsesContentApplicationJsonSchemaData": { "description": "The webhook subscription.", "properties": { "api_version": { "default": "v2", "description": "Deel API version. Currently Deel accepts v1 or v2 version.", "type": "string" }, "created_at": { "description": "Time at which the webhook was created.", "type": "string" }, "deleted_at": { "description": "Time at which the webhook was deleted.", "type": [ "string", "null" ] }, "description": { "description": "Webhook subscription description.", "type": [ "string", "null" ] }, "events": { "description": "The list of events to enable for this subscription.", "items": { "type": "string" }, "type": "array" }, "hidden": { "description": "Property to hide the webhook from frontend view. Commonly by Deel 3rd party apps", "type": [ "boolean", "null" ] }, "id": { "description": "Unique identifier of this resource.", "type": "string" }, "include_child_orgs": { "description": "When true, the webhook will also receive events from child organizations.", "type": [ "boolean", "null" ] }, "internal": { "description": "Indicates whether the webhook is internal to Deel.", "type": "boolean" }, "name": { "description": "Webhook subscription name.", "type": [ "string", "null" ] }, "signing_key": { "description": "The webhook's signing key, used to generate webhook signatures.", "type": [ "string", "null" ] }, "status": { "$ref": "#/components/schemas/WebhooksIdGetResponsesContentApplicationJsonSchemaDataStatus", "description": "Status of webhook." }, "updated_at": { "description": "Time at which the webhook was updated.", "type": "string" }, "url": { "description": "Endpoint to receive webhook.", "type": "string" } }, "required": [ "id", "url", "name", "events", "status", "created_at", "updated_at", "api_version", "description", "signing_key" ], "title": "WebhooksIdGetResponsesContentApplicationJsonSchemaData", "type": "object" }, "WebhooksIdGetResponsesContentApplicationJsonSchemaDataStatus": { "description": "Status of webhook.", "enum": [ "enabled", "disabled" ], "title": "WebhooksIdGetResponsesContentApplicationJsonSchemaDataStatus", "type": "string" }, "WebhooksIdGetResponsesContentApplicationJsonSchemaErrorsItems": { "properties": { "error_code": { "description": "Machine-readable error code.", "type": "string" }, "message": { "description": "Human-readable description of the error.", "type": "string" } }, "required": [ "message" ], "title": "WebhooksIdGetResponsesContentApplicationJsonSchemaErrorsItems", "type": "object" }, "WebhooksIdPatchRequestBodyContentApplicationJsonSchemaStatus": { "description": "Status of webhook.", "enum": [ "enabled", "disabled" ], "title": "WebhooksIdPatchRequestBodyContentApplicationJsonSchemaStatus", "type": "string" }, "WebhooksIdPatchResponsesContentApplicationJsonSchemaData": { "description": "The webhook subscription.", "properties": { "api_version": { "default": "v2", "description": "Deel API version. Currently Deel accepts v1 or v2 version.", "type": "string" }, "created_at": { "description": "Time at which the webhook was created.", "type": "string" }, "deleted_at": { "description": "Time at which the webhook was deleted.", "type": [ "string", "null" ] }, "description": { "description": "Webhook subscription description.", "type": [ "string", "null" ] }, "events": { "description": "The list of events to enable for this subscription.", "items": { "type": "string" }, "type": "array" }, "hidden": { "description": "Property to hide the webhook from frontend view. Commonly by Deel 3rd party apps", "type": [ "boolean", "null" ] }, "id": { "description": "Unique identifier of this resource.", "type": "string" }, "include_child_orgs": { "description": "When true, the webhook will also receive events from child organizations.", "type": [ "boolean", "null" ] }, "internal": { "description": "Indicates whether the webhook is internal to Deel.", "type": "boolean" }, "name": { "description": "Webhook subscription name.", "type": [ "string", "null" ] }, "signing_key": { "description": "The webhook's signing key, used to generate webhook signatures.", "type": [ "string", "null" ] }, "status": { "$ref": "#/components/schemas/WebhooksIdPatchResponsesContentApplicationJsonSchemaDataStatus", "description": "Status of webhook." }, "updated_at": { "description": "Time at which the webhook was updated.", "type": "string" }, "url": { "description": "Endpoint to receive webhook.", "type": "string" } }, "required": [ "id", "url", "name", "events", "status", "created_at", "updated_at", "api_version", "description", "signing_key" ], "title": "WebhooksIdPatchResponsesContentApplicationJsonSchemaData", "type": "object" }, "WebhooksIdPatchResponsesContentApplicationJsonSchemaDataStatus": { "description": "Status of webhook.", "enum": [ "enabled", "disabled" ], "title": "WebhooksIdPatchResponsesContentApplicationJsonSchemaDataStatus", "type": "string" }, "WebhooksIdPatchResponsesContentApplicationJsonSchemaErrorsItems": { "properties": { "error_code": { "description": "Machine-readable error code.", "type": "string" }, "message": { "description": "Human-readable description of the error.", "type": "string" } }, "required": [ "message" ], "title": "WebhooksIdPatchResponsesContentApplicationJsonSchemaErrorsItems", "type": "object" }, "WebhooksPostRequestBodyContentApplicationJsonSchemaStatus": { "description": "Status of webhook.", "enum": [ "enabled", "disabled" ], "title": "WebhooksPostRequestBodyContentApplicationJsonSchemaStatus", "type": "string" }, "WebhooksPostResponsesContentApplicationJsonSchemaData": { "description": "The webhook subscription.", "properties": { "api_version": { "default": "v2", "description": "Deel API version. Currently Deel accepts v1 or v2 version.", "type": "string" }, "created_at": { "description": "Time at which the webhook was created.", "type": "string" }, "deleted_at": { "description": "Time at which the webhook was deleted.", "type": [ "string", "null" ] }, "description": { "description": "Webhook subscription description.", "type": [ "string", "null" ] }, "events": { "description": "The list of events to enable for this subscription.", "items": { "type": "string" }, "type": "array" }, "hidden": { "description": "Property to hide the webhook from frontend view. Commonly by Deel 3rd party apps", "type": [ "boolean", "null" ] }, "id": { "description": "Unique identifier of this resource.", "type": "string" }, "include_child_orgs": { "description": "When true, the webhook will also receive events from child organizations.", "type": [ "boolean", "null" ] }, "internal": { "description": "Indicates whether the webhook is internal to Deel.", "type": "boolean" }, "name": { "description": "Webhook subscription name.", "type": [ "string", "null" ] }, "signing_key": { "description": "The webhook's signing key, used to generate webhook signatures.", "type": [ "string", "null" ] }, "status": { "$ref": "#/components/schemas/WebhooksPostResponsesContentApplicationJsonSchemaDataStatus", "description": "Status of webhook." }, "updated_at": { "description": "Time at which the webhook was updated.", "type": "string" }, "url": { "description": "Endpoint to receive webhook.", "type": "string" } }, "required": [ "id", "url", "name", "events", "status", "created_at", "updated_at", "api_version", "description", "signing_key" ], "title": "WebhooksPostResponsesContentApplicationJsonSchemaData", "type": "object" }, "WebhooksPostResponsesContentApplicationJsonSchemaDataStatus": { "description": "Status of webhook.", "enum": [ "enabled", "disabled" ], "title": "WebhooksPostResponsesContentApplicationJsonSchemaDataStatus", "type": "string" }, "WebhooksPostResponsesContentApplicationJsonSchemaErrorsItems": { "properties": { "error_code": { "description": "Machine-readable error code.", "type": "string" }, "message": { "description": "Human-readable description of the error.", "type": "string" } }, "required": [ "message" ], "title": "WebhooksPostResponsesContentApplicationJsonSchemaErrorsItems", "type": "object" }, "WorkStatementPaymentPoliciesGetResponsesContentApplicationJsonSchemaDataItems": { "description": "A work statement payment policy of the organization.", "properties": { "description": { "description": "Description of the payment policy.", "type": [ "string", "null" ] }, "due_days": { "description": "Number of days after cycle end before payment is released.", "type": "integer" }, "due_type": { "$ref": "#/components/schemas/WorkStatementPaymentPoliciesGetResponsesContentApplicationJsonSchemaDataItemsDueType", "description": "How the payment due date is calculated relative to cycle end." }, "end_day": { "description": "Day the billing cycle ends. 1–31 when end_type is DAY_OF_MONTH, 1–7 when DAY_OF_WEEK or\n DAY_OF_LAST_WEEK.", "type": "integer" }, "end_type": { "$ref": "#/components/schemas/WorkStatementPaymentPoliciesGetResponsesContentApplicationJsonSchemaDataItemsEndType", "description": "How end_day is interpreted." }, "end_week_parity": { "description": "Week parity constraint for biweekly cycles. Null for non-biweekly scales.", "oneOf": [ { "$ref": "#/components/schemas/WorkStatementPaymentPoliciesGetResponsesContentApplicationJsonSchemaDataItemsEndWeekParity" }, { "type": "null" } ] }, "id": { "description": "The public ID (UUID) of the payment policy.", "format": "uuid", "type": "string" }, "name": { "description": "Name of the payment policy.", "type": "string" }, "scale": { "$ref": "#/components/schemas/WorkStatementPaymentPoliciesGetResponsesContentApplicationJsonSchemaDataItemsScale", "description": "Payment cycle frequency." }, "semimonthly_first_day": { "description": "First payment day of the month for semimonthly cycles. Null for other scales.", "type": [ "integer", "null" ] }, "semimonthly_second_day": { "description": "Second payment day of the month for semimonthly cycles. Null for other scales.", "type": [ "integer", "null" ] }, "should_pay_before_weekends": { "description": "Whether payment is moved earlier when the due date falls on a weekend.", "type": "boolean" } }, "required": [ "id", "name", "scale", "end_day", "due_days", "due_type", "end_type", "should_pay_before_weekends" ], "title": "WorkStatementPaymentPoliciesGetResponsesContentApplicationJsonSchemaDataItems", "type": "object" }, "WorkStatementPaymentPoliciesGetResponsesContentApplicationJsonSchemaDataItemsDueType": { "description": "How the payment due date is calculated relative to cycle end.", "enum": [ "REGULAR", "WITHIN_MONTH", "AFTER_MONTH", "BEFORE_CYCLE_END" ], "title": "WorkStatementPaymentPoliciesGetResponsesContentApplicationJsonSchemaDataItemsDueType", "type": "string" }, "WorkStatementPaymentPoliciesGetResponsesContentApplicationJsonSchemaDataItemsEndType": { "description": "How end_day is interpreted.", "enum": [ "DAY_OF_WEEK", "DAY_OF_LAST_WEEK", "DAY_OF_MONTH" ], "title": "WorkStatementPaymentPoliciesGetResponsesContentApplicationJsonSchemaDataItemsEndType", "type": "string" }, "WorkStatementPaymentPoliciesGetResponsesContentApplicationJsonSchemaDataItemsEndWeekParity": { "description": "Week parity constraint for biweekly cycles. Null for non-biweekly scales.", "enum": [ "AUTO", "ODD", "EVEN" ], "title": "WorkStatementPaymentPoliciesGetResponsesContentApplicationJsonSchemaDataItemsEndWeekParity", "type": "string" }, "WorkStatementPaymentPoliciesGetResponsesContentApplicationJsonSchemaDataItemsScale": { "description": "Payment cycle frequency.", "enum": [ "WEEKLY", "MONTHLY", "BIWEEKLY", "SEMIMONTHLY", "CALENDAR_MONTH" ], "title": "WorkStatementPaymentPoliciesGetResponsesContentApplicationJsonSchemaDataItemsScale", "type": "string" }, "WorkStatementPaymentPoliciesGetResponsesContentApplicationJsonSchemaErrorsItems": { "properties": { "code": { "description": "Machine-readable error code", "type": "string" }, "message": { "description": "Human-readable explanation of the error", "type": "string" } }, "title": "WorkStatementPaymentPoliciesGetResponsesContentApplicationJsonSchemaErrorsItems", "type": "object" }, "WorkStatementPaymentPoliciesPostRequestBodyContentApplicationJsonSchemaData": { "properties": { "description": { "description": "Description of the payment policy.", "maxLength": 400, "type": "string" }, "due_days": { "description": "Number of days after cycle end before payment is released. Defaults to 0.", "maximum": 90, "minimum": 0, "type": "integer" }, "due_type": { "$ref": "#/components/schemas/WorkStatementPaymentPoliciesPostRequestBodyContentApplicationJsonSchemaDataDueType", "description": "How the payment due date is calculated relative to cycle end. Defaults to REGULAR." }, "end_day": { "description": "Day the billing cycle ends. 1–31 when end_type is DAY_OF_MONTH, 1–7 when DAY_OF_WEEK or\n DAY_OF_LAST_WEEK.", "maximum": 31, "minimum": 1, "type": "integer" }, "end_type": { "$ref": "#/components/schemas/WorkStatementPaymentPoliciesPostRequestBodyContentApplicationJsonSchemaDataEndType", "description": "How end_day is interpreted. Defaults to DAY_OF_MONTH." }, "end_week_parity": { "$ref": "#/components/schemas/WorkStatementPaymentPoliciesPostRequestBodyContentApplicationJsonSchemaDataEndWeekParity", "description": "Week parity constraint for biweekly cycles. Only applicable when scale is BIWEEKLY." }, "name": { "description": "Name of the payment policy. Must be unique within the organization.", "maxLength": 255, "minLength": 3, "type": "string" }, "scale": { "$ref": "#/components/schemas/WorkStatementPaymentPoliciesPostRequestBodyContentApplicationJsonSchemaDataScale", "description": "Payment cycle frequency." }, "should_pay_before_weekends": { "description": "Whether payment is moved earlier when the due date falls on a weekend. Defaults to false.", "type": "boolean" } }, "required": [ "name", "scale", "end_day" ], "title": "WorkStatementPaymentPoliciesPostRequestBodyContentApplicationJsonSchemaData", "type": "object" }, "WorkStatementPaymentPoliciesPostRequestBodyContentApplicationJsonSchemaDataDueType": { "description": "How the payment due date is calculated relative to cycle end. Defaults to REGULAR.", "enum": [ "REGULAR", "WITHIN_MONTH", "AFTER_MONTH", "BEFORE_CYCLE_END" ], "title": "WorkStatementPaymentPoliciesPostRequestBodyContentApplicationJsonSchemaDataDueType", "type": "string" }, "WorkStatementPaymentPoliciesPostRequestBodyContentApplicationJsonSchemaDataEndType": { "description": "How end_day is interpreted. Defaults to DAY_OF_MONTH.", "enum": [ "DAY_OF_WEEK", "DAY_OF_LAST_WEEK", "DAY_OF_MONTH" ], "title": "WorkStatementPaymentPoliciesPostRequestBodyContentApplicationJsonSchemaDataEndType", "type": "string" }, "WorkStatementPaymentPoliciesPostRequestBodyContentApplicationJsonSchemaDataEndWeekParity": { "description": "Week parity constraint for biweekly cycles. Only applicable when scale is BIWEEKLY.", "enum": [ "AUTO", "ODD", "EVEN" ], "title": "WorkStatementPaymentPoliciesPostRequestBodyContentApplicationJsonSchemaDataEndWeekParity", "type": "string" }, "WorkStatementPaymentPoliciesPostRequestBodyContentApplicationJsonSchemaDataScale": { "description": "Payment cycle frequency.", "enum": [ "WEEKLY", "MONTHLY", "BIWEEKLY", "SEMIMONTHLY", "CALENDAR_MONTH" ], "title": "WorkStatementPaymentPoliciesPostRequestBodyContentApplicationJsonSchemaDataScale", "type": "string" }, "WorkStatementPaymentPoliciesPostResponsesContentApplicationJsonSchemaData": { "description": "The created work statement payment policy.", "properties": { "id": { "description": "The public ID (UUID) of the created payment policy.", "format": "uuid", "type": "string" } }, "required": [ "id" ], "title": "WorkStatementPaymentPoliciesPostResponsesContentApplicationJsonSchemaData", "type": "object" }, "WorkStatementPaymentPoliciesPostResponsesContentApplicationJsonSchemaErrorsItems": { "properties": { "code": { "description": "Machine-readable error code", "type": "string" }, "message": { "description": "Human-readable explanation of the error", "type": "string" } }, "title": "WorkStatementPaymentPoliciesPostResponsesContentApplicationJsonSchemaErrorsItems", "type": "object" }, "WorkerPostRequestBodyContentApplicationJsonSchemaData": { "properties": { "company": { "$ref": "#/components/schemas/WorkerPostRequestBodyContentApplicationJsonSchemaDataCompany" }, "contract_id": { "description": "Associated contract ID", "minLength": 1, "type": "string" }, "email": { "description": "Worker's email address", "format": "email", "minLength": 5, "type": "string" }, "first_name": { "description": "Worker's first name", "minLength": 1, "type": "string" }, "last_name": { "description": "Worker's last name", "minLength": 1, "type": "string" }, "middle_name": { "description": "Worker's middle name", "type": [ "string", "null" ] }, "preferred_firstname": { "description": "Worker's preferred first name", "type": [ "string", "null" ] }, "preferred_lastName": { "description": "Worker's preferred last name", "type": [ "string", "null" ] }, "preferred_name": { "description": "Worker's preferred name", "type": [ "string", "null" ] }, "profile_type": { "$ref": "#/components/schemas/WorkerPostRequestBodyContentApplicationJsonSchemaDataProfileType", "description": "Type of worker profile" }, "timezone": { "description": "Worker's timezone", "type": "string" } }, "required": [ "email", "company", "timezone", "last_name", "first_name", "contract_id", "profile_type" ], "title": "WorkerPostRequestBodyContentApplicationJsonSchemaData", "type": "object" }, "WorkerPostRequestBodyContentApplicationJsonSchemaDataCompany": { "properties": { "personal": { "$ref": "#/components/schemas/WorkerPostRequestBodyContentApplicationJsonSchemaDataCompanyPersonal" }, "type": { "$ref": "#/components/schemas/WorkerPostRequestBodyContentApplicationJsonSchemaDataCompanyType", "description": "Type of company registration" } }, "required": [ "type", "personal" ], "title": "WorkerPostRequestBodyContentApplicationJsonSchemaDataCompany", "type": "object" }, "WorkerPostRequestBodyContentApplicationJsonSchemaDataCompanyPersonal": { "properties": { "citizen": { "description": "Citizenship country code", "type": "string" }, "city": { "description": "City", "type": "string" }, "country": { "description": "Country code", "type": "string" }, "entity_tax_residence": { "description": "Entity tax residence (only applicable for company type)", "type": "string" }, "id_type": { "description": "Type of identification", "type": "string" }, "legal_status": { "description": "Legal status (required only when type is INDIVIDUAL)", "type": "string" }, "personal_id": { "description": "Personal identification number", "format": "double", "type": "number" }, "phone": { "description": "Phone number", "format": "double", "type": "number" }, "province": { "description": "Province/State", "type": [ "string", "null" ] }, "street": { "description": "Street address", "type": "string" }, "tax_residence": { "description": "Tax residence country code", "type": "string" }, "timezone": { "description": "Personal timezone", "type": "string" }, "zip": { "description": "Zip/Postal code", "format": "double", "type": "number" } }, "required": [ "zip", "city", "phone", "street", "citizen", "personal_id" ], "title": "WorkerPostRequestBodyContentApplicationJsonSchemaDataCompanyPersonal", "type": "object" }, "WorkerPostRequestBodyContentApplicationJsonSchemaDataCompanyType": { "description": "Type of company registration", "enum": [ "COMPANY", "INDIVIDUAL" ], "title": "WorkerPostRequestBodyContentApplicationJsonSchemaDataCompanyType", "type": "string" }, "WorkerPostRequestBodyContentApplicationJsonSchemaDataProfileType": { "description": "Type of worker profile", "enum": [ "CONTRACTOR", "EOR" ], "title": "WorkerPostRequestBodyContentApplicationJsonSchemaDataProfileType", "type": "string" }, "WorkerPostResponsesContentApplicationJsonSchemaData": { "properties": { "contract_id": { "description": "Associated contract ID", "minLength": 1, "type": "string" }, "profile_id": { "description": "Created profile ID", "minLength": 1, "type": "string" }, "user_id": { "description": "Created user ID", "minLength": 1, "type": "string" } }, "required": [ "user_id", "profile_id", "contract_id" ], "title": "WorkerPostResponsesContentApplicationJsonSchemaData", "type": "object" }, "Worker_HR_getHrxManagerForWorker-v2026-01-01_Response_200": { "properties": { "data": { "$ref": "#/components/schemas/EscalationsWorkersMeHrxGetResponsesContentApplicationJsonSchemaData" } }, "title": "Worker HR_getHrxManagerForWorker-v2026-01-01_Response_200", "type": "object" }, "Worker_Session_createWorkerAccessToken-v2026-01-01_Response_201": { "properties": { "data": { "$ref": "#/components/schemas/WorkersSessionPostResponsesContentApplicationJsonSchemaData" } }, "required": [ "data" ], "title": "Worker Session_createWorkerAccessToken-v2026-01-01_Response_201", "type": "object" }, "WorkersAmendmentsAmendmentIdSignPostRequestBodyContentApplicationJsonSchemaData": { "properties": { "contractor_signature": { "description": "The signature of the worker signing the amendment.", "minLength": 2, "type": "string" } }, "required": [ "contractor_signature" ], "title": "WorkersAmendmentsAmendmentIdSignPostRequestBodyContentApplicationJsonSchemaData", "type": "object" }, "WorkersAmendmentsAmendmentIdSignPostResponsesContentApplicationJsonSchemaData": { "properties": { "id": { "description": "The unique identifier of the signed amendment.", "type": "string" }, "is_signed": { "description": "Indicates whether the amendment was successfully signed.", "type": "boolean" } }, "required": [ "id", "is_signed" ], "title": "WorkersAmendmentsAmendmentIdSignPostResponsesContentApplicationJsonSchemaData", "type": "object" }, "WorkersAmendmentsAmendmentIdSignPostResponsesContentApplicationJsonSchemaErrorsItems": { "properties": { "message": { "description": "A description of the returned error", "type": "string" }, "path": { "description": "The JSON path where input validation failed", "type": "string" } }, "title": "WorkersAmendmentsAmendmentIdSignPostResponsesContentApplicationJsonSchemaErrorsItems", "type": "object" }, "WorkersAmendmentsAmendmentIdSignPostResponsesContentApplicationJsonSchemaRequest": { "properties": { "api_req_id": { "description": "The request ID of the failed request", "type": "string" }, "code": { "description": "The code of the source handler which produced the returned error", "format": "double", "type": "number" }, "docs": { "description": "A link to the official documentation for the requested endpoint resource", "type": "string" }, "method": { "description": "The HTTP method of the failed request", "type": "string" }, "source": { "description": "The source handler which produced the returned error", "type": "string" }, "status": { "description": "The status code of the response", "format": "double", "type": "number" }, "url": { "description": "The relative URL of the failed request", "type": "string" } }, "title": "WorkersAmendmentsAmendmentIdSignPostResponsesContentApplicationJsonSchemaRequest", "type": "object" }, "WorkersComplianceDocumentsGetResponsesContentApplicationJsonSchemaData": { "properties": { "documents": { "description": "List of compliance documents required for the worker.", "items": { "$ref": "#/components/schemas/WorkersComplianceDocumentsGetResponsesContentApplicationJsonSchemaDataDocumentsItems" }, "type": "array" } }, "required": [ "documents" ], "title": "WorkersComplianceDocumentsGetResponsesContentApplicationJsonSchemaData", "type": "object" }, "WorkersComplianceDocumentsGetResponsesContentApplicationJsonSchemaDataDocumentsItems": { "properties": { "country": { "description": "ISO 3166-1 alpha-2 country code where the document is required.", "type": [ "string", "null" ] }, "description": { "description": "Description of the document requirement. Empty string when no description exists.", "type": "string" }, "filenames": { "description": "List of uploaded file names. Empty array when no files have been uploaded.", "items": { "type": "string" }, "type": "array" }, "fillable": { "description": "Whether the document can be filled through the Deel platform.", "type": "boolean" }, "has_template": { "description": "Whether a template is available for this document.", "type": "boolean" }, "id": { "description": "Unique identifier for the compliance document requirement.", "format": "uuid", "type": "string" }, "is_acknowledgement_only_document": { "description": "Whether this document only requires acknowledgement without file upload.", "type": "boolean" }, "is_consent_required": { "description": "Whether consent is required for acknowledgement-only documents. Only present when is_acknowledgement_only_document is true.", "type": "boolean" }, "is_optional": { "description": "Whether the document is optional for the worker. Also true when the document is required within 30 days.", "type": "boolean" }, "name": { "description": "Display name of the compliance document.", "type": "string" }, "rejection_message": { "description": "Plain text message explaining why the document was rejected. Empty string when no rejection message exists.", "type": "string" }, "required_in_30_days": { "description": "Whether the document is required within 30 days of employment start.", "type": "boolean" }, "status": { "description": "Review status of the uploaded document, null if no document has been uploaded yet.", "oneOf": [ { "$ref": "#/components/schemas/WorkersComplianceDocumentsGetResponsesContentApplicationJsonSchemaDataDocumentsItemsStatus" }, { "type": "null" } ] }, "uploaded_at": { "description": "ISO 8601 timestamp when the document was uploaded, null if no document has been uploaded.", "format": "date-time", "type": [ "string", "null" ] } }, "required": [ "id", "name", "status", "country", "fillable", "filenames", "description", "is_optional", "uploaded_at", "has_template", "rejection_message", "required_in_30_days", "is_acknowledgement_only_document" ], "title": "WorkersComplianceDocumentsGetResponsesContentApplicationJsonSchemaDataDocumentsItems", "type": "object" }, "WorkersComplianceDocumentsGetResponsesContentApplicationJsonSchemaDataDocumentsItemsStatus": { "description": "Review status of the uploaded document, null if no document has been uploaded yet.", "enum": [ "AWAITING_EX_REVIEW", "AWAITING_EXTERNAL_REVIEW", "REJECTED", "APPROVED", "ON_HOLD" ], "title": "WorkersComplianceDocumentsGetResponsesContentApplicationJsonSchemaDataDocumentsItemsStatus", "type": "string" }, "WorkersComplianceDocumentsGetResponsesContentApplicationJsonSchemaErrorsItems": { "properties": { "code": { "description": "Machine-readable error code.", "type": "string" }, "field": { "description": "Name of the field causing the error, if applicable.", "type": "string" }, "message": { "description": "Human-readable error message.", "type": "string" } }, "required": [ "code", "message" ], "title": "WorkersComplianceDocumentsGetResponsesContentApplicationJsonSchemaErrorsItems", "type": "object" }, "WorkersContractsContractIdComplianceDocumentsDocumentIdDeleteResponsesContentApplicationJsonSchemaErrorsItems": { "properties": { "code": { "description": "Machine-readable error code.", "maxLength": 255, "type": "string" }, "field": { "description": "Field that caused the error, when the error is about one.", "type": [ "string", "null" ] }, "message": { "description": "Human-readable explanation.", "type": "string" } }, "required": [ "code", "message" ], "title": "WorkersContractsContractIdComplianceDocumentsDocumentIdDeleteResponsesContentApplicationJsonSchemaErrorsItems", "type": "object" }, "WorkersContractsContractIdComplianceDocumentsDocumentIdDownloadGetResponsesContentApplicationJsonSchemaData": { "properties": { "expires_at": { "description": "When the URL stops working. Null when the URL is not time-limited.", "format": "date-time", "type": [ "string", "null" ] }, "is_external_url": { "description": "Reserved. Not populated on this endpoint today.", "type": [ "boolean", "null" ] }, "updated_at": { "description": "Reserved. Not populated on this endpoint today.", "format": "date-time", "type": [ "string", "null" ] }, "url": { "description": "Time-limited download URL, valid for about 15 minutes. Fetch it rather than storing it.", "type": "string" } }, "required": [ "url", "expires_at" ], "title": "WorkersContractsContractIdComplianceDocumentsDocumentIdDownloadGetResponsesContentApplicationJsonSchemaData", "type": "object" }, "WorkersContractsContractIdComplianceDocumentsDocumentIdDownloadGetResponsesContentApplicationJsonSchemaErrorsItems": { "properties": { "code": { "description": "Machine-readable error code.", "maxLength": 255, "type": "string" }, "field": { "description": "Field that caused the error, when the error is about one.", "type": [ "string", "null" ] }, "message": { "description": "Human-readable explanation.", "type": "string" } }, "required": [ "code", "message" ], "title": "WorkersContractsContractIdComplianceDocumentsDocumentIdDownloadGetResponsesContentApplicationJsonSchemaErrorsItems", "type": "object" }, "WorkersContractsContractIdComplianceDocumentsDocumentIdGetResponsesContentApplicationJsonSchemaData": { "properties": { "country": { "description": "ISO 3166-1 alpha-2 country code the requirement applies to. Null for a requirement that applies everywhere.", "type": [ "string", "null" ] }, "created_at": { "description": "When the submission was created. Carries the same value as `uploaded_at`.", "format": "date-time", "type": [ "string", "null" ] }, "description": { "description": "What the document asks for, in the worker language. Empty string when the requirement has no description.", "type": "string" }, "filenames": { "description": "Names of the files submitted against this requirement. Empty array when nothing has been submitted.", "items": { "type": "string" }, "type": "array" }, "has_template": { "description": "Whether a template is provided for this document.", "type": "boolean" }, "id": { "description": "Public UUID of the compliance document requirement. Use it as `document_id` on the other endpoints.", "format": "uuid", "type": "string" }, "is_acknowledgement_only_document": { "description": "Whether the document only has to be acknowledged, with no file to submit.", "type": "boolean" }, "is_consent_required": { "description": "Whether the worker has to consent. Present only for acknowledgement-only documents that declare the flag.", "type": "boolean" }, "is_required": { "description": "Whether the worker has to submit this document. A requirement with a 30-day grace period after the employment start reads `true`: it is required, only not immediately.", "type": "boolean" }, "name": { "description": "Display name of the document, in the worker language.", "type": "string" }, "submission_status": { "description": "Reads `REVIEWING` while a submission is not final yet. Null at every other time.", "type": [ "string", "null" ] }, "updated_at": { "description": "When the submission was last changed. Null when nothing has been submitted.", "format": "date-time", "type": [ "string", "null" ] }, "uploaded_at": { "description": "When the submission was created. Null when nothing has been submitted.", "format": "date-time", "type": [ "string", "null" ] } }, "required": [ "id", "name", "country", "filenames", "created_at", "updated_at", "description", "is_required", "uploaded_at", "has_template", "submission_status", "is_acknowledgement_only_document" ], "title": "WorkersContractsContractIdComplianceDocumentsDocumentIdGetResponsesContentApplicationJsonSchemaData", "type": "object" }, "WorkersContractsContractIdComplianceDocumentsDocumentIdGetResponsesContentApplicationJsonSchemaErrorsItems": { "properties": { "code": { "description": "Machine-readable error code.", "maxLength": 255, "type": "string" }, "field": { "description": "Field that caused the error, when the error is about one.", "type": [ "string", "null" ] }, "message": { "description": "Human-readable explanation.", "type": "string" } }, "required": [ "code", "message" ], "title": "WorkersContractsContractIdComplianceDocumentsDocumentIdGetResponsesContentApplicationJsonSchemaErrorsItems", "type": "object" }, "WorkersContractsContractIdComplianceDocumentsDocumentIdPostRequestBodyContentApplicationJsonSchemaData": { "properties": { "files": { "description": "Files to submit against the requirement. Allowed types: pdf, png, jpg, jpeg, heic.", "items": { "$ref": "#/components/schemas/WorkersContractsContractIdComplianceDocumentsDocumentIdPostRequestBodyContentApplicationJsonSchemaDataFilesItems" }, "type": "array" } }, "required": [ "files" ], "title": "WorkersContractsContractIdComplianceDocumentsDocumentIdPostRequestBodyContentApplicationJsonSchemaData", "type": "object" }, "WorkersContractsContractIdComplianceDocumentsDocumentIdPostRequestBodyContentApplicationJsonSchemaDataFilesItems": { "properties": { "content_type": { "description": "MIME type of the file.", "maxLength": 255, "type": "string" }, "file_id": { "description": "File Service file id.", "format": "uuid", "type": "string" }, "one_time_secret": { "description": "File Service one-time secret for that file.", "maxLength": 1024, "minLength": 1, "type": "string" }, "original_filename": { "description": "Original filename, extension included.", "maxLength": 500, "minLength": 1, "type": "string" } }, "required": [ "file_id", "content_type", "one_time_secret", "original_filename" ], "title": "WorkersContractsContractIdComplianceDocumentsDocumentIdPostRequestBodyContentApplicationJsonSchemaDataFilesItems", "type": "object" }, "WorkersContractsContractIdComplianceDocumentsDocumentIdPostResponsesContentApplicationJsonSchemaErrorsItems": { "properties": { "code": { "description": "Machine-readable error code.", "maxLength": 255, "type": "string" }, "field": { "description": "Field that caused the error, when the error is about one.", "type": [ "string", "null" ] }, "message": { "description": "Human-readable explanation.", "type": "string" } }, "required": [ "code", "message" ], "title": "WorkersContractsContractIdComplianceDocumentsDocumentIdPostResponsesContentApplicationJsonSchemaErrorsItems", "type": "object" }, "WorkersContractsContractIdComplianceDocumentsGetResponsesContentApplicationJsonSchemaDataItems": { "properties": { "country": { "description": "ISO 3166-1 alpha-2 country code the requirement applies to. Null for a requirement that applies everywhere.", "type": [ "string", "null" ] }, "created_at": { "description": "When the submission was created. Carries the same value as `uploaded_at`.", "format": "date-time", "type": [ "string", "null" ] }, "description": { "description": "What the document asks for, in the worker language. Empty string when the requirement has no description.", "type": "string" }, "filenames": { "description": "Names of the files submitted against this requirement. Empty array when nothing has been submitted.", "items": { "type": "string" }, "type": "array" }, "has_template": { "description": "Whether a template is provided for this document.", "type": "boolean" }, "id": { "description": "Public UUID of the compliance document requirement. Use it as `document_id` on the other endpoints.", "format": "uuid", "type": "string" }, "is_acknowledgement_only_document": { "description": "Whether the document only has to be acknowledged, with no file to submit.", "type": "boolean" }, "is_consent_required": { "description": "Whether the worker has to consent. Present only for acknowledgement-only documents that declare the flag.", "type": "boolean" }, "is_required": { "description": "Whether the worker has to submit this document. A requirement with a 30-day grace period after the employment start reads `true`: it is required, only not immediately.", "type": "boolean" }, "name": { "description": "Display name of the document, in the worker language.", "type": "string" }, "submission_status": { "description": "Reads `REVIEWING` while a submission is not final yet. Null at every other time.", "type": [ "string", "null" ] }, "updated_at": { "description": "When the submission was last changed. Null when nothing has been submitted.", "format": "date-time", "type": [ "string", "null" ] }, "uploaded_at": { "description": "When the submission was created. Null when nothing has been submitted.", "format": "date-time", "type": [ "string", "null" ] } }, "required": [ "id", "name", "country", "filenames", "created_at", "updated_at", "description", "is_required", "uploaded_at", "has_template", "submission_status", "is_acknowledgement_only_document" ], "title": "WorkersContractsContractIdComplianceDocumentsGetResponsesContentApplicationJsonSchemaDataItems", "type": "object" }, "WorkersContractsContractIdComplianceDocumentsGetResponsesContentApplicationJsonSchemaErrorsItems": { "properties": { "code": { "description": "Machine-readable error code.", "maxLength": 255, "type": "string" }, "field": { "description": "Field that caused the error, when the error is about one.", "type": [ "string", "null" ] }, "message": { "description": "Human-readable explanation.", "type": "string" } }, "required": [ "code", "message" ], "title": "WorkersContractsContractIdComplianceDocumentsGetResponsesContentApplicationJsonSchemaErrorsItems", "type": "object" }, "WorkersContractsContractIdPdfGetResponsesContentApplicationJsonSchemaData": { "properties": { "url": { "description": "A pre-signed URL to download the PDF version of the specified contract", "format": "uri", "type": "string" } }, "required": [ "url" ], "title": "WorkersContractsContractIdPdfGetResponsesContentApplicationJsonSchemaData", "type": "object" }, "WorkersContractsContractIdPdfGetResponsesContentApplicationJsonSchemaErrorsItems": { "properties": { "code": { "description": "Machine-readable error code", "type": "string" }, "message": { "description": "Human-readable explanation of the error", "type": "string" } }, "title": "WorkersContractsContractIdPdfGetResponsesContentApplicationJsonSchemaErrorsItems", "type": "object" }, "WorkersContractsContractIdRejectPostResponsesContentApplicationJsonSchemaErrorsItems": { "properties": { "code": { "description": "Machine-readable error code", "type": "string" }, "message": { "description": "Human-readable explanation of the error", "type": "string" } }, "title": "WorkersContractsContractIdRejectPostResponsesContentApplicationJsonSchemaErrorsItems", "type": "object" }, "WorkersContractsContractIdSignaturesPostRequestBodyContentApplicationJsonSchemaData": { "properties": { "worker_signature": { "description": "Signature of the worker for the contract", "type": "string" } }, "required": [ "worker_signature" ], "title": "WorkersContractsContractIdSignaturesPostRequestBodyContentApplicationJsonSchemaData", "type": "object" }, "WorkersContractsContractIdSignaturesPostResponsesContentApplicationJsonSchemaData": { "properties": { "created_at": { "description": "The timestamp when the contract was created.", "format": "date-time", "type": "string" }, "id": { "description": "The unique identifier of the signed contract.", "type": "string" }, "is_signed": { "description": "Indicates whether the contract was successfully signed.", "type": "boolean" }, "updated_at": { "description": "The timestamp when the contract was last updated.", "format": "date-time", "type": "string" } }, "required": [ "id", "is_signed", "created_at", "updated_at" ], "title": "WorkersContractsContractIdSignaturesPostResponsesContentApplicationJsonSchemaData", "type": "object" }, "WorkersContractsContractIdSignaturesPostResponsesContentApplicationJsonSchemaErrorsItems": { "properties": { "code": { "description": "Machine-readable error code", "type": "string" }, "message": { "description": "Human-readable explanation of the error", "type": "string" } }, "title": "WorkersContractsContractIdSignaturesPostResponsesContentApplicationJsonSchemaErrorsItems", "type": "object" }, "WorkersSessionPostRequestBodyContentApplicationJsonSchemaData": { "properties": { "profile_id": { "description": "The ID of the profile to create access token for", "format": "uuid", "type": "string" } }, "required": [ "profile_id" ], "title": "WorkersSessionPostRequestBodyContentApplicationJsonSchemaData", "type": "object" }, "WorkersSessionPostResponsesContentApplicationJsonSchemaData": { "properties": { "expires_at": { "description": "Expiration date of the access token", "format": "date-time", "type": "string" }, "token": { "description": "Access token", "type": "string" } }, "required": [ "token", "expires_at" ], "title": "WorkersSessionPostResponsesContentApplicationJsonSchemaData", "type": "object" }, "WorkersTaxFormsGetResponsesContentApplicationJsonSchemaDataItems": { "discriminator": { "propertyName": "form_type" }, "oneOf": [ { "description": "W9_INDIVIDUAL variant", "properties": { "address": { "description": "Street address of permanent residence.", "type": "string" }, "business_name": { "description": "Business name. Present on W9_COMPANY forms and disregarded-entity W9_INDIVIDUAL forms.", "type": [ "string", "null" ] }, "city": { "description": "City name.", "type": [ "string", "null" ] }, "client_legal_entity_id": { "description": "Public ID of the client's legal entity the form was submitted against.", "format": "uuid", "type": "string" }, "contractor_signature": { "description": "The signer's digital signature.", "type": "string" }, "country": { "description": "ISO 3166-1 alpha-2 country code of permanent residence.", "type": "string" }, "created_at": { "description": "Timestamp of when the tax form was created.", "format": "date-time", "type": "string" }, "first_name": { "description": "Legal first name. Present on W9_INDIVIDUAL and W8_BEN forms.", "type": "string" }, "form_type": { "description": "Discriminator value: W9_INDIVIDUAL", "enum": [ "W9_INDIVIDUAL" ], "type": "string" }, "id": { "description": "The public ID (UUID) of the tax form.", "format": "uuid", "type": "string" }, "is_disregarded_entity": { "description": "Whether this is a disregarded entity. Present on W9_INDIVIDUAL and W8_BEN forms.", "type": "boolean" }, "is_subject_backup_withholding": { "description": "Whether the contractor is subject to backup withholding. Present on W-9 forms.", "type": "boolean" }, "last_name": { "description": "Legal last name. Present on W9_INDIVIDUAL and W8_BEN forms.", "type": "string" }, "middle_name": { "description": "Legal middle name. Present on W9_INDIVIDUAL and W8_BEN forms.", "type": "string" }, "pdf_url": { "description": "Pre-signed download URL for the generated form PDF. The link expires about 15 minutes after the response is issued — download promptly or request the list again. Null while the PDF has not been generated yet.", "type": [ "string", "null" ] }, "state": { "description": "State or province code.", "type": [ "string", "null" ] }, "tax_number": { "$ref": "#/components/schemas/WorkersTaxFormsGetResponsesContentApplicationJsonSchemaDataItemsOneOf0TaxNumber", "description": "Taxpayer identification number. Returned unmasked." }, "updated_at": { "description": "Timestamp of when the tax form was last updated.", "format": "date-time", "type": "string" }, "zip_code": { "description": "ZIP/postal code.", "type": "string" } }, "required": [ "form_type", "id", "created_at", "updated_at", "client_legal_entity_id" ], "type": "object" }, { "description": "W9_COMPANY variant", "properties": { "address": { "description": "Street address of permanent residence.", "type": "string" }, "business_name": { "description": "Business name. Present on W9_COMPANY forms and disregarded-entity W9_INDIVIDUAL forms.", "type": [ "string", "null" ] }, "city": { "description": "City name.", "type": [ "string", "null" ] }, "client_legal_entity_id": { "description": "Public ID of the client's legal entity the form was submitted against.", "format": "uuid", "type": "string" }, "contractor_signature": { "description": "The signer's digital signature.", "type": "string" }, "country": { "description": "ISO 3166-1 alpha-2 country code of permanent residence.", "type": "string" }, "created_at": { "description": "Timestamp of when the tax form was created.", "format": "date-time", "type": "string" }, "doing_business_as": { "description": "DBA name. Present on W9_COMPANY forms.", "type": [ "string", "null" ] }, "federal_tax_classification": { "$ref": "#/components/schemas/WorkersTaxFormsGetResponsesContentApplicationJsonSchemaDataItemsOneOf1FederalTaxClassification", "description": "Federal tax classification. Present on W9_COMPANY forms." }, "form_type": { "description": "Discriminator value: W9_COMPANY", "enum": [ "W9_COMPANY" ], "type": "string" }, "id": { "description": "The public ID (UUID) of the tax form.", "format": "uuid", "type": "string" }, "is_subject_backup_withholding": { "description": "Whether the contractor is subject to backup withholding. Present on W-9 forms.", "type": "boolean" }, "pdf_url": { "description": "Pre-signed download URL for the generated form PDF. The link expires about 15 minutes after the response is issued — download promptly or request the list again. Null while the PDF has not been generated yet.", "type": [ "string", "null" ] }, "state": { "description": "State or province code.", "type": [ "string", "null" ] }, "tax_number": { "$ref": "#/components/schemas/WorkersTaxFormsGetResponsesContentApplicationJsonSchemaDataItemsOneOf1TaxNumber", "description": "Taxpayer identification number. Returned unmasked." }, "updated_at": { "description": "Timestamp of when the tax form was last updated.", "format": "date-time", "type": "string" }, "zip_code": { "description": "ZIP/postal code.", "type": "string" } }, "required": [ "form_type", "id", "created_at", "updated_at", "client_legal_entity_id" ], "type": "object" }, { "description": "W8_BEN variant", "properties": { "address": { "description": "Street address of permanent residence.", "type": "string" }, "address_line2": { "description": "Street address line 2. Present on W8_BEN and W8_BEN_E forms.", "type": [ "string", "null" ] }, "city": { "description": "City name.", "type": [ "string", "null" ] }, "client_legal_entity_id": { "description": "Public ID of the client's legal entity the form was submitted against.", "format": "uuid", "type": "string" }, "contractor_signature": { "description": "The signer's digital signature.", "type": "string" }, "country": { "description": "ISO 3166-1 alpha-2 country code of permanent residence.", "type": "string" }, "country_of_citizenship": { "description": "ISO 3166-1 alpha-2 country code of citizenship (W8_BEN) or incorporation (W8_BEN_E).", "type": "string" }, "created_at": { "description": "Timestamp of when the tax form was created.", "format": "date-time", "type": "string" }, "date_of_birth": { "description": "Date of birth. Present on W8_BEN and W8_BEN_E forms.", "format": "date-time", "type": [ "string", "null" ] }, "first_name": { "description": "Legal first name. Present on W9_INDIVIDUAL and W8_BEN forms.", "type": "string" }, "form_type": { "description": "Discriminator value: W8_BEN", "enum": [ "W8_BEN" ], "type": "string" }, "id": { "description": "The public ID (UUID) of the tax form.", "format": "uuid", "type": "string" }, "is_certified_and_agreed": { "description": "Certification that the signer has read and agrees with the certification information. Present on W8_BEN forms.", "type": [ "boolean", "null" ] }, "is_disregarded_entity": { "description": "Whether this is a disregarded entity. Present on W9_INDIVIDUAL and W8_BEN forms.", "type": "boolean" }, "is_ftin_not_legally_required": { "description": "Whether an FTIN is not legally required in the country of residence. Present on W-8 forms.", "type": "boolean" }, "is_tax_treaty_enabled": { "description": "Whether tax treaty benefits are claimed. Present on W-8 forms.", "type": [ "boolean", "null" ] }, "last_name": { "description": "Legal last name. Present on W9_INDIVIDUAL and W8_BEN forms.", "type": "string" }, "mailing_address": { "description": "Mailing address if different from permanent residence. Present on W8_BEN and W8_BEN_E forms.", "oneOf": [ { "$ref": "#/components/schemas/WorkersTaxFormsGetResponsesContentApplicationJsonSchemaDataItemsOneOf2MailingAddress" }, { "type": "null" } ] }, "middle_name": { "description": "Legal middle name. Present on W9_INDIVIDUAL and W8_BEN forms.", "type": "string" }, "pdf_url": { "description": "Pre-signed download URL for the generated form PDF. The link expires about 15 minutes after the response is issued — download promptly or request the list again. Null while the PDF has not been generated yet.", "type": [ "string", "null" ] }, "print_name_of_signer": { "description": "Printed name of the signer. Present on W-8 forms.", "type": [ "string", "null" ] }, "referencing_information": { "description": "Reference number for the form. Present on W-8 forms.", "type": [ "string", "null" ] }, "state": { "description": "State or province code.", "type": [ "string", "null" ] }, "tax_number": { "$ref": "#/components/schemas/WorkersTaxFormsGetResponsesContentApplicationJsonSchemaDataItemsOneOf2TaxNumber", "description": "Foreign taxpayer identification number. Returned unmasked." }, "tax_treaty_benefits_form": { "description": "Tax treaty benefits details. Present when treaty benefits are claimed.", "oneOf": [ { "$ref": "#/components/schemas/WorkersTaxFormsGetResponsesContentApplicationJsonSchemaDataItemsOneOf2TaxTreatyBenefitsForm" }, { "type": "null" } ] }, "updated_at": { "description": "Timestamp of when the tax form was last updated.", "format": "date-time", "type": "string" }, "us_tax_number": { "$ref": "#/components/schemas/WorkersTaxFormsGetResponsesContentApplicationJsonSchemaDataItemsOneOf2UsTaxNumber", "description": "US Taxpayer Identification Number. Present on W8_BEN and W8_BEN_E forms. Returned unmasked." }, "zip_code": { "description": "ZIP/postal code.", "type": "string" } }, "required": [ "form_type", "id", "created_at", "updated_at", "client_legal_entity_id" ], "type": "object" }, { "description": "W8_BEN_E variant", "properties": { "address": { "description": "Street address of permanent residence.", "type": "string" }, "address_line2": { "description": "Street address line 2. Present on W8_BEN and W8_BEN_E forms.", "type": [ "string", "null" ] }, "city": { "description": "City name.", "type": [ "string", "null" ] }, "client_legal_entity_id": { "description": "Public ID of the client's legal entity the form was submitted against.", "format": "uuid", "type": "string" }, "contractor_signature": { "description": "The signer's digital signature.", "type": "string" }, "country": { "description": "ISO 3166-1 alpha-2 country code of permanent residence.", "type": "string" }, "country_of_citizenship": { "description": "ISO 3166-1 alpha-2 country code of citizenship (W8_BEN) or incorporation (W8_BEN_E).", "type": "string" }, "created_at": { "description": "Timestamp of when the tax form was created.", "format": "date-time", "type": "string" }, "date_of_birth": { "description": "Date of birth. Present on W8_BEN and W8_BEN_E forms.", "format": "date-time", "type": [ "string", "null" ] }, "entity_country": { "description": "ISO 3166-1 alpha-2 country code of the entity. Present on W8_BEN_E forms.", "type": [ "string", "null" ] }, "entity_type": { "$ref": "#/components/schemas/WorkersTaxFormsGetResponsesContentApplicationJsonSchemaDataItemsOneOf3EntityType", "description": "Chapter 3 entity type. Present on W8_BEN_E forms." }, "fatca_status": { "$ref": "#/components/schemas/WorkersTaxFormsGetResponsesContentApplicationJsonSchemaDataItemsOneOf3FatcaStatus", "description": "FATCA (Foreign Account Tax Compliance Act) status. Present on W8_BEN_E forms." }, "form_type": { "description": "Discriminator value: W8_BEN_E", "enum": [ "W8_BEN_E" ], "type": "string" }, "giin": { "description": "Global Intermediary Identification Number. Present on W8_BEN_E forms.", "type": [ "string", "null" ] }, "has_substantial_us_owner": { "description": "Whether the entity has a substantial US owner. Present on W8_BEN_E forms.", "type": "boolean" }, "id": { "description": "The public ID (UUID) of the tax form.", "format": "uuid", "type": "string" }, "is_entity_certification_confirmed": { "description": "Certification that the entity is the beneficial owner of all income. Present on W8_BEN_E forms.", "type": [ "boolean", "null" ] }, "is_ftin_not_legally_required": { "description": "Whether an FTIN is not legally required in the country of residence. Present on W-8 forms.", "type": "boolean" }, "is_tax_treaty_enabled": { "description": "Whether tax treaty benefits are claimed. Present on W-8 forms.", "type": [ "boolean", "null" ] }, "mailing_address": { "description": "Mailing address if different from permanent residence. Present on W8_BEN and W8_BEN_E forms.", "oneOf": [ { "$ref": "#/components/schemas/WorkersTaxFormsGetResponsesContentApplicationJsonSchemaDataItemsOneOf3MailingAddress" }, { "type": "null" } ] }, "name_of_disregarded_entity": { "description": "Name of the disregarded entity, if applicable. Present on W8_BEN_E forms.", "type": [ "string", "null" ] }, "name_of_organization": { "description": "Name of the organization. Present on W8_BEN_E forms.", "type": "string" }, "pdf_url": { "description": "Pre-signed download URL for the generated form PDF. The link expires about 15 minutes after the response is issued — download promptly or request the list again. Null while the PDF has not been generated yet.", "type": [ "string", "null" ] }, "print_name_of_signer": { "description": "Printed name of the signer. Present on W-8 forms.", "type": [ "string", "null" ] }, "referencing_information": { "description": "Reference number for the form. Present on W-8 forms.", "type": [ "string", "null" ] }, "state": { "description": "State or province code.", "type": [ "string", "null" ] }, "tax_number": { "$ref": "#/components/schemas/WorkersTaxFormsGetResponsesContentApplicationJsonSchemaDataItemsOneOf3TaxNumber", "description": "Foreign taxpayer identification number. Returned unmasked." }, "tax_treaty_benefits_form": { "description": "Tax treaty benefits details. Present when treaty benefits are claimed.", "oneOf": [ { "$ref": "#/components/schemas/WorkersTaxFormsGetResponsesContentApplicationJsonSchemaDataItemsOneOf3TaxTreatyBenefitsForm" }, { "type": "null" } ] }, "updated_at": { "description": "Timestamp of when the tax form was last updated.", "format": "date-time", "type": "string" }, "us_tax_number": { "$ref": "#/components/schemas/WorkersTaxFormsGetResponsesContentApplicationJsonSchemaDataItemsOneOf3UsTaxNumber", "description": "US Taxpayer Identification Number. Present on W8_BEN and W8_BEN_E forms. Returned unmasked." }, "zip_code": { "description": "ZIP/postal code.", "type": "string" } }, "required": [ "form_type", "id", "created_at", "updated_at", "client_legal_entity_id" ], "type": "object" } ], "title": "WorkersTaxFormsGetResponsesContentApplicationJsonSchemaDataItems" }, "WorkersTaxFormsGetResponsesContentApplicationJsonSchemaDataItemsOneOf0TaxNumber": { "description": "Taxpayer identification number. Returned unmasked.", "properties": { "type": { "$ref": "#/components/schemas/WorkersTaxFormsGetResponsesContentApplicationJsonSchemaDataItemsOneOf0TaxNumberType", "description": "Tax ID type." }, "value": { "description": "Tax ID value, unmasked.", "type": "string" } }, "title": "WorkersTaxFormsGetResponsesContentApplicationJsonSchemaDataItemsOneOf0TaxNumber", "type": "object" }, "WorkersTaxFormsGetResponsesContentApplicationJsonSchemaDataItemsOneOf0TaxNumberType": { "description": "Tax ID type.", "enum": [ "SSN", "ITIN", "EIN" ], "title": "WorkersTaxFormsGetResponsesContentApplicationJsonSchemaDataItemsOneOf0TaxNumberType", "type": "string" }, "WorkersTaxFormsGetResponsesContentApplicationJsonSchemaDataItemsOneOf1FederalTaxClassification": { "description": "Federal tax classification. Present on W9_COMPANY forms.", "properties": { "llc_classification": { "$ref": "#/components/schemas/WorkersTaxFormsGetResponsesContentApplicationJsonSchemaDataItemsOneOf1FederalTaxClassificationLlcClassification", "description": "LLC sub-classification. Present when type is 'LLC'." }, "other_additional_information": { "description": "Additional information. Present when type is 'OTHER'.", "type": "string" }, "type": { "$ref": "#/components/schemas/WorkersTaxFormsGetResponsesContentApplicationJsonSchemaDataItemsOneOf1FederalTaxClassificationType", "description": "Federal tax classification type." } }, "title": "WorkersTaxFormsGetResponsesContentApplicationJsonSchemaDataItemsOneOf1FederalTaxClassification", "type": "object" }, "WorkersTaxFormsGetResponsesContentApplicationJsonSchemaDataItemsOneOf1FederalTaxClassificationLlcClassification": { "description": "LLC sub-classification. Present when type is 'LLC'.", "enum": [ "P", "S", "C" ], "title": "WorkersTaxFormsGetResponsesContentApplicationJsonSchemaDataItemsOneOf1FederalTaxClassificationLlcClassification", "type": "string" }, "WorkersTaxFormsGetResponsesContentApplicationJsonSchemaDataItemsOneOf1FederalTaxClassificationType": { "description": "Federal tax classification type.", "enum": [ "C_CORPORATION", "S_CORPORATION", "OTHER", "PARTNERSHIP", "LLC", "TRUST_ESTATE" ], "title": "WorkersTaxFormsGetResponsesContentApplicationJsonSchemaDataItemsOneOf1FederalTaxClassificationType", "type": "string" }, "WorkersTaxFormsGetResponsesContentApplicationJsonSchemaDataItemsOneOf1TaxNumber": { "description": "Taxpayer identification number. Returned unmasked.", "properties": { "type": { "$ref": "#/components/schemas/WorkersTaxFormsGetResponsesContentApplicationJsonSchemaDataItemsOneOf1TaxNumberType", "description": "Tax ID type." }, "value": { "description": "Tax ID value, unmasked.", "type": "string" } }, "title": "WorkersTaxFormsGetResponsesContentApplicationJsonSchemaDataItemsOneOf1TaxNumber", "type": "object" }, "WorkersTaxFormsGetResponsesContentApplicationJsonSchemaDataItemsOneOf1TaxNumberType": { "description": "Tax ID type.", "enum": [ "SSN", "ITIN", "EIN" ], "title": "WorkersTaxFormsGetResponsesContentApplicationJsonSchemaDataItemsOneOf1TaxNumberType", "type": "string" }, "WorkersTaxFormsGetResponsesContentApplicationJsonSchemaDataItemsOneOf2MailingAddress": { "description": "Mailing address if different from permanent residence. Present on W8_BEN and W8_BEN_E forms.", "properties": { "address": { "description": "Mailing address.", "type": "string" }, "address_line2": { "description": "Mailing address line 2.", "type": [ "string", "null" ] }, "city": { "description": "Mailing address city.", "type": [ "string", "null" ] }, "country": { "description": "ISO 3166-1 alpha-2 country code.", "type": "string" }, "state": { "description": "Mailing address state.", "type": [ "string", "null" ] }, "zip_code": { "description": "Mailing address ZIP/postal code.", "type": "string" } }, "title": "WorkersTaxFormsGetResponsesContentApplicationJsonSchemaDataItemsOneOf2MailingAddress", "type": "object" }, "WorkersTaxFormsGetResponsesContentApplicationJsonSchemaDataItemsOneOf2TaxNumber": { "description": "Foreign taxpayer identification number. Returned unmasked.", "properties": { "type": { "$ref": "#/components/schemas/WorkersTaxFormsGetResponsesContentApplicationJsonSchemaDataItemsOneOf2TaxNumberType", "description": "Tax ID type." }, "value": { "description": "Tax ID value, unmasked.", "type": "string" } }, "title": "WorkersTaxFormsGetResponsesContentApplicationJsonSchemaDataItemsOneOf2TaxNumber", "type": "object" }, "WorkersTaxFormsGetResponsesContentApplicationJsonSchemaDataItemsOneOf2TaxNumberType": { "description": "Tax ID type.", "enum": [ "FTIN" ], "title": "WorkersTaxFormsGetResponsesContentApplicationJsonSchemaDataItemsOneOf2TaxNumberType", "type": "string" }, "WorkersTaxFormsGetResponsesContentApplicationJsonSchemaDataItemsOneOf2TaxTreatyBenefitsForm": { "description": "Tax treaty benefits details. Present when treaty benefits are claimed.", "properties": { "article_and_paragraph": { "description": "Article and paragraph of the applicable tax treaty.", "type": "string" }, "details": { "description": "Additional details about the treaty claim.", "type": "string" }, "owner_resident_country": { "description": "Country of residence of the beneficial owner.", "type": "string" }, "type_of_income": { "description": "Type of income covered by the treaty.", "type": "string" }, "withholding_rate": { "description": "Withholding rate under the treaty (percentage).", "format": "double", "type": "number" } }, "title": "WorkersTaxFormsGetResponsesContentApplicationJsonSchemaDataItemsOneOf2TaxTreatyBenefitsForm", "type": "object" }, "WorkersTaxFormsGetResponsesContentApplicationJsonSchemaDataItemsOneOf2UsTaxNumber": { "description": "US Taxpayer Identification Number. Present on W8_BEN and W8_BEN_E forms. Returned unmasked.", "properties": { "type": { "$ref": "#/components/schemas/WorkersTaxFormsGetResponsesContentApplicationJsonSchemaDataItemsOneOf2UsTaxNumberType", "description": "US tax ID type." }, "value": { "description": "US tax ID value, unmasked.", "type": "string" } }, "title": "WorkersTaxFormsGetResponsesContentApplicationJsonSchemaDataItemsOneOf2UsTaxNumber", "type": "object" }, "WorkersTaxFormsGetResponsesContentApplicationJsonSchemaDataItemsOneOf2UsTaxNumberType": { "description": "US tax ID type.", "enum": [ "SSN", "ITIN" ], "title": "WorkersTaxFormsGetResponsesContentApplicationJsonSchemaDataItemsOneOf2UsTaxNumberType", "type": "string" }, "WorkersTaxFormsGetResponsesContentApplicationJsonSchemaDataItemsOneOf3EntityType": { "description": "Chapter 3 entity type. Present on W8_BEN_E forms.", "enum": [ "CORPORATION", "DISREGARDED_ENTITY", "PARTNERSHIP", "SIMPLE_TRUST", "GRANTOR_TRUST", "COMPLEX_TRUST", "ESTATE", "GOVERNMENT", "CENTRAL_BANK_OF_ISSUE", "TAX_EXEMPT", "PRIVATE_FOUNDATION", "INTERNATIONAL", "FOREIGN_GOVERNMENT_CONTROLLED", "FOREIGN_GOVERNMENT_INTEGRAL" ], "title": "WorkersTaxFormsGetResponsesContentApplicationJsonSchemaDataItemsOneOf3EntityType", "type": "string" }, "WorkersTaxFormsGetResponsesContentApplicationJsonSchemaDataItemsOneOf3FatcaStatus": { "description": "FATCA (Foreign Account Tax Compliance Act) status. Present on W8_BEN_E forms.", "enum": [ "ACTIVE_NFFE", "PASSIVE_NFFE" ], "title": "WorkersTaxFormsGetResponsesContentApplicationJsonSchemaDataItemsOneOf3FatcaStatus", "type": "string" }, "WorkersTaxFormsGetResponsesContentApplicationJsonSchemaDataItemsOneOf3MailingAddress": { "description": "Mailing address if different from permanent residence. Present on W8_BEN and W8_BEN_E forms.", "properties": { "address": { "description": "Mailing address.", "type": "string" }, "address_line2": { "description": "Mailing address line 2.", "type": [ "string", "null" ] }, "city": { "description": "Mailing address city.", "type": [ "string", "null" ] }, "country": { "description": "ISO 3166-1 alpha-2 country code.", "type": "string" }, "state": { "description": "Mailing address state.", "type": [ "string", "null" ] }, "zip_code": { "description": "Mailing address ZIP/postal code.", "type": "string" } }, "title": "WorkersTaxFormsGetResponsesContentApplicationJsonSchemaDataItemsOneOf3MailingAddress", "type": "object" }, "WorkersTaxFormsGetResponsesContentApplicationJsonSchemaDataItemsOneOf3TaxNumber": { "description": "Foreign taxpayer identification number. Returned unmasked.", "properties": { "type": { "$ref": "#/components/schemas/WorkersTaxFormsGetResponsesContentApplicationJsonSchemaDataItemsOneOf3TaxNumberType", "description": "Tax ID type." }, "value": { "description": "Tax ID value, unmasked.", "type": "string" } }, "title": "WorkersTaxFormsGetResponsesContentApplicationJsonSchemaDataItemsOneOf3TaxNumber", "type": "object" }, "WorkersTaxFormsGetResponsesContentApplicationJsonSchemaDataItemsOneOf3TaxNumberType": { "description": "Tax ID type.", "enum": [ "FTIN" ], "title": "WorkersTaxFormsGetResponsesContentApplicationJsonSchemaDataItemsOneOf3TaxNumberType", "type": "string" }, "WorkersTaxFormsGetResponsesContentApplicationJsonSchemaDataItemsOneOf3TaxTreatyBenefitsForm": { "description": "Tax treaty benefits details. Present when treaty benefits are claimed.", "properties": { "article_and_paragraph": { "description": "Article and paragraph of the applicable tax treaty.", "type": "string" }, "details": { "description": "Additional details about the treaty claim.", "type": "string" }, "is_tax_residency_certified": { "description": "Whether tax residency is certified.", "type": [ "boolean", "null" ] }, "limitation_type": { "description": "Limitation on benefits (LOB) type.", "oneOf": [ { "$ref": "#/components/schemas/WorkersTaxFormsGetResponsesContentApplicationJsonSchemaDataItemsOneOf3TaxTreatyBenefitsFormLimitationType" }, { "type": "null" } ] }, "other_article_and_paragraph": { "description": "Other article and paragraph. Present when limitation_type is 'OTHER'.", "type": [ "string", "null" ] }, "owner_resident_country": { "description": "Country of residence of the beneficial owner.", "type": "string" }, "type_of_income": { "description": "Type of income covered by the treaty.", "type": "string" }, "withholding_rate": { "description": "Withholding rate under the treaty (percentage).", "format": "double", "type": "number" } }, "title": "WorkersTaxFormsGetResponsesContentApplicationJsonSchemaDataItemsOneOf3TaxTreatyBenefitsForm", "type": "object" }, "WorkersTaxFormsGetResponsesContentApplicationJsonSchemaDataItemsOneOf3TaxTreatyBenefitsFormLimitationType": { "description": "Limitation on benefits (LOB) type.", "enum": [ "GOVERNMENT", "PENSION_TRUST", "TAX_EXEMPT", "PUBLICLY_TRADED_CORPORATION", "SUBSIDIARY", "OWNERSHIP_TEST", "DERIVATIVE_TEST", "ACTIVE_TRADE_TEST", "FAVORABLE", "NO_ARTICLE", "OTHER" ], "title": "WorkersTaxFormsGetResponsesContentApplicationJsonSchemaDataItemsOneOf3TaxTreatyBenefitsFormLimitationType", "type": "string" }, "WorkersTaxFormsGetResponsesContentApplicationJsonSchemaDataItemsOneOf3UsTaxNumber": { "description": "US Taxpayer Identification Number. Present on W8_BEN and W8_BEN_E forms. Returned unmasked.", "properties": { "type": { "$ref": "#/components/schemas/WorkersTaxFormsGetResponsesContentApplicationJsonSchemaDataItemsOneOf3UsTaxNumberType", "description": "US tax ID type." }, "value": { "description": "US tax ID value, unmasked.", "type": "string" } }, "title": "WorkersTaxFormsGetResponsesContentApplicationJsonSchemaDataItemsOneOf3UsTaxNumber", "type": "object" }, "WorkersTaxFormsGetResponsesContentApplicationJsonSchemaDataItemsOneOf3UsTaxNumberType": { "description": "US tax ID type.", "enum": [ "SSN", "ITIN" ], "title": "WorkersTaxFormsGetResponsesContentApplicationJsonSchemaDataItemsOneOf3UsTaxNumberType", "type": "string" }, "WorkersTaxFormsGetResponsesContentApplicationJsonSchemaErrorsItems": { "properties": { "code": { "description": "Machine-readable error code", "type": "string" }, "message": { "description": "Human-readable explanation of the error", "type": "string" } }, "title": "WorkersTaxFormsGetResponsesContentApplicationJsonSchemaErrorsItems", "type": "object" }, "WorkersTaxFormsPostRequestBodyContentApplicationJsonSchemaData": { "discriminator": { "propertyName": "form_type" }, "oneOf": [ { "description": "W9_INDIVIDUAL variant", "properties": { "address": { "description": "Street address. Maximum 40 characters for 1099 reporting compliance.", "maxLength": 40, "type": "string" }, "business_name": { "description": "Business name. Only applicable when is_disregarded_entity is true.", "maxLength": 40, "type": [ "string", "null" ] }, "city": { "description": "City name.", "maxLength": 40, "minLength": 1, "type": "string" }, "client_legal_entity_id": { "description": "Public ID of the client's legal entity.", "format": "uuid", "type": "string" }, "contractor_signature": { "description": "Contractor's digital signature.", "maxLength": 100, "minLength": 1, "type": "string" }, "country": { "description": "ISO 3166-1 alpha-2 country code.", "maxLength": 2, "minLength": 2, "pattern": "^[A-Z]{2}$", "type": "string" }, "first_name": { "description": "Legal first name.", "maxLength": 40, "type": "string" }, "form_type": { "description": "Discriminator value: W9_INDIVIDUAL", "enum": [ "W9_INDIVIDUAL" ], "type": "string" }, "is_disregarded_entity": { "default": false, "description": "Whether this is a disregarded entity.", "type": "boolean" }, "is_subject_backup_withholding": { "default": false, "description": "Whether the contractor is subject to backup withholding.", "type": "boolean" }, "last_name": { "description": "Legal last name.", "maxLength": 40, "type": "string" }, "middle_name": { "description": "Legal middle name.", "maxLength": 100, "type": "string" }, "state": { "description": "US state code.", "maxLength": 10, "type": [ "string", "null" ] }, "tax_number": { "$ref": "#/components/schemas/WorkersTaxFormsPostRequestBodyContentApplicationJsonSchemaDataOneOf0TaxNumber", "description": "Taxpayer identification number." }, "zip_code": { "description": "ZIP/postal code. Must be a valid US ZIP code for US addresses.", "type": "string" } }, "required": [ "form_type", "city", "address", "country", "zip_code", "last_name", "first_name", "tax_number", "contractor_signature", "client_legal_entity_id" ], "type": "object" }, { "description": "W9_COMPANY variant", "properties": { "address": { "description": "Street address.", "maxLength": 40, "type": "string" }, "business_name": { "description": "Business name.", "maxLength": 40, "minLength": 1, "type": "string" }, "city": { "description": "City name.", "maxLength": 40, "minLength": 1, "type": "string" }, "client_legal_entity_id": { "description": "Public ID of the client's legal entity.", "format": "uuid", "type": "string" }, "contractor_signature": { "description": "Authorized signer's digital signature.", "maxLength": 100, "minLength": 1, "type": "string" }, "country": { "description": "ISO 3166-1 alpha-2 country code.", "maxLength": 2, "minLength": 2, "pattern": "^[A-Z]{2}$", "type": "string" }, "doing_business_as": { "description": "DBA name.", "maxLength": 50, "type": [ "string", "null" ] }, "federal_tax_classification": { "$ref": "#/components/schemas/WorkersTaxFormsPostRequestBodyContentApplicationJsonSchemaDataOneOf1FederalTaxClassification", "description": "Federal tax classification." }, "form_type": { "description": "Discriminator value: W9_COMPANY", "enum": [ "W9_COMPANY" ], "type": "string" }, "is_subject_backup_withholding": { "default": false, "description": "Whether the contractor is subject to backup withholding.", "type": "boolean" }, "state": { "description": "US state code.", "maxLength": 10, "type": [ "string", "null" ] }, "tax_number": { "$ref": "#/components/schemas/WorkersTaxFormsPostRequestBodyContentApplicationJsonSchemaDataOneOf1TaxNumber", "description": "Taxpayer identification number." }, "zip_code": { "description": "ZIP/postal code.", "type": "string" } }, "required": [ "form_type", "city", "address", "country", "zip_code", "tax_number", "business_name", "contractor_signature", "client_legal_entity_id", "federal_tax_classification" ], "type": "object" }, { "description": "W8_BEN variant", "properties": { "address": { "description": "Street address.", "maxLength": 100, "type": "string" }, "address_line2": { "description": "Street address line 2.", "maxLength": 100, "type": [ "string", "null" ] }, "city": { "description": "City name.", "maxLength": 50, "minLength": 1, "type": [ "string", "null" ] }, "client_legal_entity_id": { "description": "Public ID of the client's legal entity.", "format": "uuid", "type": "string" }, "contractor_signature": { "description": "Contractor's digital signature.", "maxLength": 100, "minLength": 1, "type": "string" }, "country": { "description": "ISO 3166-1 alpha-2 country code of permanent residence.", "maxLength": 2, "minLength": 2, "pattern": "^[A-Z]{2}$", "type": "string" }, "country_of_citizenship": { "description": "ISO 3166-1 alpha-2 country code of citizenship.", "maxLength": 2, "minLength": 2, "pattern": "^[A-Z]{2}$", "type": "string" }, "date_of_birth": { "description": "Date of birth. Must be at least 18 years ago and no more than 100 years ago.", "format": "date-time", "type": [ "string", "null" ] }, "first_name": { "description": "Legal first name.", "maxLength": 100, "type": "string" }, "form_type": { "description": "Discriminator value: W8_BEN", "enum": [ "W8_BEN" ], "type": "string" }, "is_certified_and_agreed": { "default": false, "description": "Certification that the signer has read and agrees with the certification information.", "type": [ "boolean", "null" ] }, "is_disregarded_entity": { "default": false, "description": "Whether this is a disregarded entity.", "type": "boolean" }, "is_ftin_not_legally_required": { "default": false, "description": "Check if FTIN is not legally required in your country of residence.", "type": "boolean" }, "is_tax_treaty_enabled": { "default": false, "description": "Whether the contractor claims tax treaty benefits.", "type": [ "boolean", "null" ] }, "last_name": { "description": "Legal last name.", "maxLength": 100, "type": "string" }, "mailing_address": { "description": "Mailing address if different from permanent residence.", "oneOf": [ { "$ref": "#/components/schemas/WorkersTaxFormsPostRequestBodyContentApplicationJsonSchemaDataOneOf2MailingAddress" }, { "type": "null" } ] }, "middle_name": { "description": "Legal middle name.", "maxLength": 100, "type": [ "string", "null" ] }, "print_name_of_signer": { "description": "Printed name of the signer.", "maxLength": 100, "type": [ "string", "null" ] }, "referencing_information": { "description": "Reference number for the form.", "maxLength": 100, "type": [ "string", "null" ] }, "state": { "description": "State or province code.", "maxLength": 10, "type": [ "string", "null" ] }, "tax_number": { "$ref": "#/components/schemas/WorkersTaxFormsPostRequestBodyContentApplicationJsonSchemaDataOneOf2TaxNumber", "description": "Foreign tax identifying number. At least one of us_tax_number or tax_number is required unless is_ftin_not_legally_required is true." }, "tax_treaty_benefits_form": { "description": "Tax treaty benefits details. Applicable when is_tax_treaty_enabled is true.", "oneOf": [ { "$ref": "#/components/schemas/WorkersTaxFormsPostRequestBodyContentApplicationJsonSchemaDataOneOf2TaxTreatyBenefitsForm" }, { "type": "null" } ] }, "us_tax_number": { "$ref": "#/components/schemas/WorkersTaxFormsPostRequestBodyContentApplicationJsonSchemaDataOneOf2UsTaxNumber", "description": "US Taxpayer Identification Number." }, "zip_code": { "description": "ZIP/postal code.", "type": "string" } }, "required": [ "form_type", "address", "country", "zip_code", "last_name", "first_name", "contractor_signature", "client_legal_entity_id", "country_of_citizenship" ], "type": "object" }, { "description": "W8_BEN_E variant", "properties": { "address": { "description": "Street address.", "maxLength": 100, "type": "string" }, "address_line2": { "description": "Street address line 2.", "maxLength": 100, "type": [ "string", "null" ] }, "city": { "description": "City of residence.", "maxLength": 50, "minLength": 1, "type": "string" }, "client_legal_entity_id": { "description": "Public ID of the client's legal entity.", "format": "uuid", "type": "string" }, "contractor_signature": { "description": "Authorized signer's digital signature.", "maxLength": 100, "minLength": 1, "type": "string" }, "country": { "description": "ISO 3166-1 alpha-2 country code of permanent residence.", "maxLength": 2, "minLength": 2, "pattern": "^[A-Z]{2}$", "type": "string" }, "country_of_citizenship": { "description": "ISO 3166-1 alpha-2 country code of incorporation/organization.", "maxLength": 2, "minLength": 2, "pattern": "^[A-Z]{2}$", "type": "string" }, "date_of_birth": { "description": "Date of birth of the beneficial owner.", "format": "date-time", "type": [ "string", "null" ] }, "entity_country": { "description": "ISO 3166-1 alpha-2 country code of the entity.", "maxLength": 2, "minLength": 2, "pattern": "^[A-Z]{2}$", "type": [ "string", "null" ] }, "entity_type": { "$ref": "#/components/schemas/WorkersTaxFormsPostRequestBodyContentApplicationJsonSchemaDataOneOf3EntityType", "description": "Chapter 3 entity type." }, "fatca_status": { "$ref": "#/components/schemas/WorkersTaxFormsPostRequestBodyContentApplicationJsonSchemaDataOneOf3FatcaStatus", "description": "FATCA (Foreign Account Tax Compliance Act) status." }, "form_type": { "description": "Discriminator value: W8_BEN_E", "enum": [ "W8_BEN_E" ], "type": "string" }, "giin": { "description": "Global Intermediary Identification Number (19 characters).", "maxLength": 19, "minLength": 19, "type": [ "string", "null" ] }, "has_substantial_us_owner": { "default": false, "description": "Whether the entity has a substantial US owner. Required when fatca_status is 'PASSIVE_NFFE'.", "type": "boolean" }, "is_entity_certification_confirmed": { "default": false, "description": "Certification that the entity is the beneficial owner of all income.", "type": [ "boolean", "null" ] }, "is_ftin_not_legally_required": { "default": false, "description": "Check if FTIN is not legally required in your country.", "type": "boolean" }, "is_tax_treaty_enabled": { "default": false, "description": "Whether the entity claims tax treaty benefits.", "type": [ "boolean", "null" ] }, "mailing_address": { "description": "Mailing address if different from permanent residence.", "oneOf": [ { "$ref": "#/components/schemas/WorkersTaxFormsPostRequestBodyContentApplicationJsonSchemaDataOneOf3MailingAddress" }, { "type": "null" } ] }, "name_of_disregarded_entity": { "description": "Name of the disregarded entity, if applicable.", "maxLength": 100, "type": [ "string", "null" ] }, "name_of_organization": { "description": "Name of the organization.", "maxLength": 100, "type": "string" }, "print_name_of_signer": { "description": "Printed name of the authorized signer.", "maxLength": 100, "type": [ "string", "null" ] }, "referencing_information": { "description": "Reference number for the form.", "maxLength": 100, "type": [ "string", "null" ] }, "state": { "description": "State or province code.", "maxLength": 10, "type": [ "string", "null" ] }, "tax_number": { "$ref": "#/components/schemas/WorkersTaxFormsPostRequestBodyContentApplicationJsonSchemaDataOneOf3TaxNumber", "description": "Foreign tax identifying number. At least one of us_tax_number, tax_number, or giin is required unless is_ftin_not_legally_required is true." }, "tax_treaty_benefits_form": { "description": "Tax treaty benefits details.", "oneOf": [ { "$ref": "#/components/schemas/WorkersTaxFormsPostRequestBodyContentApplicationJsonSchemaDataOneOf3TaxTreatyBenefitsForm" }, { "type": "null" } ] }, "us_tax_number": { "$ref": "#/components/schemas/WorkersTaxFormsPostRequestBodyContentApplicationJsonSchemaDataOneOf3UsTaxNumber", "description": "US Taxpayer Identification Number." }, "zip_code": { "description": "ZIP/postal code.", "type": "string" } }, "required": [ "form_type", "city", "address", "country", "zip_code", "entity_type", "fatca_status", "entity_country", "contractor_signature", "name_of_organization", "client_legal_entity_id", "country_of_citizenship" ], "type": "object" } ], "title": "WorkersTaxFormsPostRequestBodyContentApplicationJsonSchemaData" }, "WorkersTaxFormsPostRequestBodyContentApplicationJsonSchemaDataOneOf0TaxNumber": { "description": "Taxpayer identification number.", "properties": { "type": { "$ref": "#/components/schemas/WorkersTaxFormsPostRequestBodyContentApplicationJsonSchemaDataOneOf0TaxNumberType", "description": "Tax ID type. SSN/ITIN for individuals; EIN also allowed for disregarded entities." }, "value": { "description": "Tax ID value.", "type": "string" } }, "required": [ "type", "value" ], "title": "WorkersTaxFormsPostRequestBodyContentApplicationJsonSchemaDataOneOf0TaxNumber", "type": "object" }, "WorkersTaxFormsPostRequestBodyContentApplicationJsonSchemaDataOneOf0TaxNumberType": { "description": "Tax ID type. SSN/ITIN for individuals; EIN also allowed for disregarded entities.", "enum": [ "SSN", "ITIN", "EIN" ], "title": "WorkersTaxFormsPostRequestBodyContentApplicationJsonSchemaDataOneOf0TaxNumberType", "type": "string" }, "WorkersTaxFormsPostRequestBodyContentApplicationJsonSchemaDataOneOf1FederalTaxClassification": { "description": "Federal tax classification.", "properties": { "llc_classification": { "$ref": "#/components/schemas/WorkersTaxFormsPostRequestBodyContentApplicationJsonSchemaDataOneOf1FederalTaxClassificationLlcClassification", "description": "LLC sub-classification. Required when type is 'LLC'." }, "other_additional_information": { "description": "Additional information. Required when type is 'OTHER'.", "maxLength": 100, "type": "string" }, "type": { "$ref": "#/components/schemas/WorkersTaxFormsPostRequestBodyContentApplicationJsonSchemaDataOneOf1FederalTaxClassificationType", "description": "Federal tax classification type." } }, "required": [ "type" ], "title": "WorkersTaxFormsPostRequestBodyContentApplicationJsonSchemaDataOneOf1FederalTaxClassification", "type": "object" }, "WorkersTaxFormsPostRequestBodyContentApplicationJsonSchemaDataOneOf1FederalTaxClassificationLlcClassification": { "description": "LLC sub-classification. Required when type is 'LLC'.", "enum": [ "P", "S", "C" ], "title": "WorkersTaxFormsPostRequestBodyContentApplicationJsonSchemaDataOneOf1FederalTaxClassificationLlcClassification", "type": "string" }, "WorkersTaxFormsPostRequestBodyContentApplicationJsonSchemaDataOneOf1FederalTaxClassificationType": { "description": "Federal tax classification type.", "enum": [ "C_CORPORATION", "S_CORPORATION", "OTHER", "PARTNERSHIP", "LLC", "TRUST_ESTATE" ], "title": "WorkersTaxFormsPostRequestBodyContentApplicationJsonSchemaDataOneOf1FederalTaxClassificationType", "type": "string" }, "WorkersTaxFormsPostRequestBodyContentApplicationJsonSchemaDataOneOf1TaxNumber": { "description": "Taxpayer identification number.", "properties": { "type": { "$ref": "#/components/schemas/WorkersTaxFormsPostRequestBodyContentApplicationJsonSchemaDataOneOf1TaxNumberType", "description": "Tax ID type. EIN for most entities; SSN/ITIN/EIN for LLC." }, "value": { "description": "Tax ID value.", "type": "string" } }, "required": [ "type", "value" ], "title": "WorkersTaxFormsPostRequestBodyContentApplicationJsonSchemaDataOneOf1TaxNumber", "type": "object" }, "WorkersTaxFormsPostRequestBodyContentApplicationJsonSchemaDataOneOf1TaxNumberType": { "description": "Tax ID type. EIN for most entities; SSN/ITIN/EIN for LLC.", "enum": [ "SSN", "ITIN", "EIN" ], "title": "WorkersTaxFormsPostRequestBodyContentApplicationJsonSchemaDataOneOf1TaxNumberType", "type": "string" }, "WorkersTaxFormsPostRequestBodyContentApplicationJsonSchemaDataOneOf2MailingAddress": { "description": "Mailing address if different from permanent residence.", "properties": { "address": { "description": "Mailing address.", "maxLength": 100, "type": "string" }, "address_line2": { "description": "Mailing address line 2.", "maxLength": 100, "type": [ "string", "null" ] }, "city": { "description": "Mailing address city.", "maxLength": 50, "minLength": 1, "type": [ "string", "null" ] }, "country": { "description": "ISO 3166-1 alpha-2 country code.", "maxLength": 2, "minLength": 2, "pattern": "^[A-Z]{2}$", "type": "string" }, "state": { "description": "Mailing address state.", "maxLength": 10, "type": [ "string", "null" ] }, "zip_code": { "description": "Mailing address ZIP/postal code.", "type": "string" } }, "required": [ "address", "country", "zip_code" ], "title": "WorkersTaxFormsPostRequestBodyContentApplicationJsonSchemaDataOneOf2MailingAddress", "type": "object" }, "WorkersTaxFormsPostRequestBodyContentApplicationJsonSchemaDataOneOf2TaxNumber": { "description": "Foreign tax identifying number. At least one of us_tax_number or tax_number is required unless is_ftin_not_legally_required is true.", "properties": { "type": { "$ref": "#/components/schemas/WorkersTaxFormsPostRequestBodyContentApplicationJsonSchemaDataOneOf2TaxNumberType", "description": "Foreign tax ID type." }, "value": { "description": "Foreign tax identifying number.", "maxLength": 20, "type": "string" } }, "required": [ "type", "value" ], "title": "WorkersTaxFormsPostRequestBodyContentApplicationJsonSchemaDataOneOf2TaxNumber", "type": "object" }, "WorkersTaxFormsPostRequestBodyContentApplicationJsonSchemaDataOneOf2TaxNumberType": { "description": "Foreign tax ID type.", "enum": [ "FTIN" ], "title": "WorkersTaxFormsPostRequestBodyContentApplicationJsonSchemaDataOneOf2TaxNumberType", "type": "string" }, "WorkersTaxFormsPostRequestBodyContentApplicationJsonSchemaDataOneOf2TaxTreatyBenefitsForm": { "description": "Tax treaty benefits details. Applicable when is_tax_treaty_enabled is true.", "properties": { "article_and_paragraph": { "description": "Article and paragraph of the applicable tax treaty.", "maxLength": 100, "type": "string" }, "details": { "description": "Additional details about the treaty claim.", "maxLength": 400, "type": "string" }, "owner_resident_country": { "description": "Country of residence of the beneficial owner. Must be a US income tax treaty country.", "maxLength": 2, "minLength": 2, "pattern": "^[A-Z]{2}$", "type": "string" }, "type_of_income": { "description": "Type of income covered by the treaty.", "maxLength": 100, "type": "string" }, "withholding_rate": { "description": "Withholding rate under the treaty (percentage).", "format": "double", "maximum": 100, "minimum": 0, "type": "number" } }, "title": "WorkersTaxFormsPostRequestBodyContentApplicationJsonSchemaDataOneOf2TaxTreatyBenefitsForm", "type": "object" }, "WorkersTaxFormsPostRequestBodyContentApplicationJsonSchemaDataOneOf2UsTaxNumber": { "description": "US Taxpayer Identification Number.", "properties": { "type": { "$ref": "#/components/schemas/WorkersTaxFormsPostRequestBodyContentApplicationJsonSchemaDataOneOf2UsTaxNumberType", "description": "US tax ID type." }, "value": { "description": "US tax ID value.", "type": "string" } }, "required": [ "type", "value" ], "title": "WorkersTaxFormsPostRequestBodyContentApplicationJsonSchemaDataOneOf2UsTaxNumber", "type": "object" }, "WorkersTaxFormsPostRequestBodyContentApplicationJsonSchemaDataOneOf2UsTaxNumberType": { "description": "US tax ID type.", "enum": [ "SSN", "ITIN" ], "title": "WorkersTaxFormsPostRequestBodyContentApplicationJsonSchemaDataOneOf2UsTaxNumberType", "type": "string" }, "WorkersTaxFormsPostRequestBodyContentApplicationJsonSchemaDataOneOf3EntityType": { "description": "Chapter 3 entity type.", "enum": [ "CORPORATION", "DISREGARDED_ENTITY", "PARTNERSHIP", "SIMPLE_TRUST", "GRANTOR_TRUST", "COMPLEX_TRUST", "ESTATE", "GOVERNMENT", "CENTRAL_BANK_OF_ISSUE", "TAX_EXEMPT", "PRIVATE_FOUNDATION", "INTERNATIONAL", "FOREIGN_GOVERNMENT_CONTROLLED", "FOREIGN_GOVERNMENT_INTEGRAL" ], "title": "WorkersTaxFormsPostRequestBodyContentApplicationJsonSchemaDataOneOf3EntityType", "type": "string" }, "WorkersTaxFormsPostRequestBodyContentApplicationJsonSchemaDataOneOf3FatcaStatus": { "description": "FATCA (Foreign Account Tax Compliance Act) status.", "enum": [ "ACTIVE_NFFE", "PASSIVE_NFFE" ], "title": "WorkersTaxFormsPostRequestBodyContentApplicationJsonSchemaDataOneOf3FatcaStatus", "type": "string" }, "WorkersTaxFormsPostRequestBodyContentApplicationJsonSchemaDataOneOf3MailingAddress": { "description": "Mailing address if different from permanent residence.", "properties": { "address": { "description": "Mailing address.", "maxLength": 100, "type": "string" }, "address_line2": { "description": "Mailing address line 2.", "maxLength": 100, "type": [ "string", "null" ] }, "city": { "description": "Mailing address city.", "maxLength": 50, "minLength": 1, "type": [ "string", "null" ] }, "country": { "description": "ISO 3166-1 alpha-2 country code.", "maxLength": 2, "minLength": 2, "pattern": "^[A-Z]{2}$", "type": "string" }, "state": { "description": "Mailing address state.", "maxLength": 10, "type": [ "string", "null" ] }, "zip_code": { "description": "Mailing address ZIP/postal code.", "type": "string" } }, "required": [ "address", "country", "zip_code" ], "title": "WorkersTaxFormsPostRequestBodyContentApplicationJsonSchemaDataOneOf3MailingAddress", "type": "object" }, "WorkersTaxFormsPostRequestBodyContentApplicationJsonSchemaDataOneOf3TaxNumber": { "description": "Foreign tax identifying number. At least one of us_tax_number, tax_number, or giin is required unless is_ftin_not_legally_required is true.", "properties": { "type": { "$ref": "#/components/schemas/WorkersTaxFormsPostRequestBodyContentApplicationJsonSchemaDataOneOf3TaxNumberType", "description": "Foreign tax ID type." }, "value": { "description": "Foreign tax identifying number.", "maxLength": 20, "type": "string" } }, "required": [ "type", "value" ], "title": "WorkersTaxFormsPostRequestBodyContentApplicationJsonSchemaDataOneOf3TaxNumber", "type": "object" }, "WorkersTaxFormsPostRequestBodyContentApplicationJsonSchemaDataOneOf3TaxNumberType": { "description": "Foreign tax ID type.", "enum": [ "FTIN" ], "title": "WorkersTaxFormsPostRequestBodyContentApplicationJsonSchemaDataOneOf3TaxNumberType", "type": "string" }, "WorkersTaxFormsPostRequestBodyContentApplicationJsonSchemaDataOneOf3TaxTreatyBenefitsForm": { "description": "Tax treaty benefits details.", "properties": { "article_and_paragraph": { "description": "Article and paragraph of the applicable tax treaty.", "maxLength": 100, "type": "string" }, "details": { "description": "Additional details about the treaty claim.", "maxLength": 400, "type": "string" }, "is_tax_residency_certified": { "default": false, "description": "Whether tax residency is certified.", "type": [ "boolean", "null" ] }, "limitation_type": { "description": "Limitation on benefits (LOB) type.", "oneOf": [ { "$ref": "#/components/schemas/WorkersTaxFormsPostRequestBodyContentApplicationJsonSchemaDataOneOf3TaxTreatyBenefitsFormLimitationType" }, { "type": "null" } ] }, "other_article_and_paragraph": { "description": "Other article and paragraph. Required when limitation_type is 'OTHER'.", "maxLength": 50, "type": [ "string", "null" ] }, "owner_resident_country": { "description": "Country of residence of the beneficial owner.", "maxLength": 2, "minLength": 2, "pattern": "^[A-Z]{2}$", "type": "string" }, "type_of_income": { "description": "Type of income covered by the treaty.", "maxLength": 25, "type": "string" }, "withholding_rate": { "description": "Withholding rate under the treaty (percentage).", "format": "double", "maximum": 100, "minimum": 0, "type": "number" } }, "title": "WorkersTaxFormsPostRequestBodyContentApplicationJsonSchemaDataOneOf3TaxTreatyBenefitsForm", "type": "object" }, "WorkersTaxFormsPostRequestBodyContentApplicationJsonSchemaDataOneOf3TaxTreatyBenefitsFormLimitationType": { "description": "Limitation on benefits (LOB) type.", "enum": [ "GOVERNMENT", "PENSION_TRUST", "TAX_EXEMPT", "PUBLICLY_TRADED_CORPORATION", "SUBSIDIARY", "OWNERSHIP_TEST", "DERIVATIVE_TEST", "ACTIVE_TRADE_TEST", "FAVORABLE", "NO_ARTICLE", "OTHER" ], "title": "WorkersTaxFormsPostRequestBodyContentApplicationJsonSchemaDataOneOf3TaxTreatyBenefitsFormLimitationType", "type": "string" }, "WorkersTaxFormsPostRequestBodyContentApplicationJsonSchemaDataOneOf3UsTaxNumber": { "description": "US Taxpayer Identification Number.", "properties": { "type": { "$ref": "#/components/schemas/WorkersTaxFormsPostRequestBodyContentApplicationJsonSchemaDataOneOf3UsTaxNumberType", "description": "US tax ID type." }, "value": { "description": "US tax ID value.", "type": "string" } }, "required": [ "type", "value" ], "title": "WorkersTaxFormsPostRequestBodyContentApplicationJsonSchemaDataOneOf3UsTaxNumber", "type": "object" }, "WorkersTaxFormsPostRequestBodyContentApplicationJsonSchemaDataOneOf3UsTaxNumberType": { "description": "US tax ID type.", "enum": [ "SSN", "ITIN" ], "title": "WorkersTaxFormsPostRequestBodyContentApplicationJsonSchemaDataOneOf3UsTaxNumberType", "type": "string" }, "WorkersTaxFormsPostResponsesContentApplicationJsonSchemaData": { "properties": { "created_at": { "description": "Timestamp of when the tax form was created.", "format": "date-time", "type": "string" }, "id": { "description": "The public ID (UUID) of the created tax form.", "format": "uuid", "type": "string" } }, "required": [ "id", "created_at" ], "title": "WorkersTaxFormsPostResponsesContentApplicationJsonSchemaData", "type": "object" }, "WorkersTaxFormsPostResponsesContentApplicationJsonSchemaErrorsItems": { "properties": { "code": { "description": "Machine-readable error code", "type": "string" }, "message": { "description": "Human-readable explanation of the error", "type": "string" } }, "title": "WorkersTaxFormsPostResponsesContentApplicationJsonSchemaErrorsItems", "type": "object" }, "WorkersTaxFormsTaxFormIdPutRequestBodyContentApplicationJsonSchemaData": { "discriminator": { "propertyName": "form_type" }, "oneOf": [ { "description": "W9_INDIVIDUAL variant", "properties": { "address": { "description": "Street address. Maximum 40 characters for 1099 reporting compliance.", "maxLength": 40, "type": "string" }, "business_name": { "description": "Business name. Only applicable when is_disregarded_entity is true.", "maxLength": 40, "type": [ "string", "null" ] }, "city": { "description": "City name.", "maxLength": 40, "minLength": 1, "type": "string" }, "contractor_signature": { "description": "Contractor's digital signature.", "maxLength": 100, "minLength": 1, "type": "string" }, "country": { "description": "ISO 3166-1 alpha-2 country code.", "maxLength": 2, "minLength": 2, "pattern": "^[A-Z]{2}$", "type": "string" }, "first_name": { "description": "Legal first name.", "maxLength": 40, "type": "string" }, "form_type": { "description": "Discriminator value: W9_INDIVIDUAL", "enum": [ "W9_INDIVIDUAL" ], "type": "string" }, "is_disregarded_entity": { "default": false, "description": "Whether this is a disregarded entity.", "type": "boolean" }, "is_subject_backup_withholding": { "default": false, "description": "Whether the contractor is subject to backup withholding.", "type": "boolean" }, "last_name": { "description": "Legal last name.", "maxLength": 40, "type": "string" }, "middle_name": { "description": "Legal middle name.", "maxLength": 100, "type": "string" }, "state": { "description": "US state code.", "maxLength": 10, "type": [ "string", "null" ] }, "tax_number": { "$ref": "#/components/schemas/WorkersTaxFormsTaxFormIdPutRequestBodyContentApplicationJsonSchemaDataOneOf0TaxNumber", "description": "Taxpayer identification number." }, "zip_code": { "description": "ZIP/postal code. Must be a valid US ZIP code for US addresses.", "type": "string" } }, "required": [ "form_type", "city", "address", "country", "zip_code", "last_name", "first_name", "tax_number" ], "type": "object" }, { "description": "W9_COMPANY variant", "properties": { "address": { "description": "Street address.", "maxLength": 40, "type": "string" }, "business_name": { "description": "Business name.", "maxLength": 40, "minLength": 1, "type": "string" }, "city": { "description": "City name.", "maxLength": 40, "minLength": 1, "type": "string" }, "contractor_signature": { "description": "Authorized signer's digital signature.", "maxLength": 100, "minLength": 1, "type": "string" }, "country": { "description": "ISO 3166-1 alpha-2 country code.", "maxLength": 2, "minLength": 2, "pattern": "^[A-Z]{2}$", "type": "string" }, "doing_business_as": { "description": "DBA name.", "maxLength": 50, "type": [ "string", "null" ] }, "federal_tax_classification": { "$ref": "#/components/schemas/WorkersTaxFormsTaxFormIdPutRequestBodyContentApplicationJsonSchemaDataOneOf1FederalTaxClassification", "description": "Federal tax classification." }, "form_type": { "description": "Discriminator value: W9_COMPANY", "enum": [ "W9_COMPANY" ], "type": "string" }, "is_subject_backup_withholding": { "default": false, "description": "Whether the contractor is subject to backup withholding.", "type": "boolean" }, "state": { "description": "US state code.", "maxLength": 10, "type": [ "string", "null" ] }, "tax_number": { "$ref": "#/components/schemas/WorkersTaxFormsTaxFormIdPutRequestBodyContentApplicationJsonSchemaDataOneOf1TaxNumber", "description": "Taxpayer identification number." }, "zip_code": { "description": "ZIP/postal code.", "type": "string" } }, "required": [ "form_type", "city", "address", "country", "zip_code", "tax_number", "business_name", "federal_tax_classification" ], "type": "object" }, { "description": "W8_BEN variant", "properties": { "address": { "description": "Street address.", "maxLength": 100, "type": "string" }, "address_line2": { "description": "Street address line 2.", "maxLength": 100, "type": [ "string", "null" ] }, "city": { "description": "City name.", "maxLength": 50, "minLength": 1, "type": [ "string", "null" ] }, "contractor_signature": { "description": "Contractor's digital signature.", "maxLength": 100, "minLength": 1, "type": "string" }, "country": { "description": "ISO 3166-1 alpha-2 country code of permanent residence.", "maxLength": 2, "minLength": 2, "pattern": "^[A-Z]{2}$", "type": "string" }, "country_of_citizenship": { "description": "ISO 3166-1 alpha-2 country code of citizenship.", "maxLength": 2, "minLength": 2, "pattern": "^[A-Z]{2}$", "type": "string" }, "date_of_birth": { "description": "Date of birth. Must be at least 18 years ago and no more than 100 years ago.", "format": "date-time", "type": [ "string", "null" ] }, "first_name": { "description": "Legal first name.", "maxLength": 100, "type": "string" }, "form_type": { "description": "Discriminator value: W8_BEN", "enum": [ "W8_BEN" ], "type": "string" }, "is_certified_and_agreed": { "default": false, "description": "Certification that the signer has read and agrees with the certification information.", "type": [ "boolean", "null" ] }, "is_disregarded_entity": { "default": false, "description": "Whether this is a disregarded entity.", "type": "boolean" }, "is_ftin_not_legally_required": { "default": false, "description": "Check if FTIN is not legally required in your country of residence.", "type": "boolean" }, "is_tax_treaty_enabled": { "default": false, "description": "Whether the contractor claims tax treaty benefits.", "type": [ "boolean", "null" ] }, "last_name": { "description": "Legal last name.", "maxLength": 100, "type": "string" }, "mailing_address": { "description": "Mailing address if different from permanent residence.", "oneOf": [ { "$ref": "#/components/schemas/WorkersTaxFormsTaxFormIdPutRequestBodyContentApplicationJsonSchemaDataOneOf2MailingAddress" }, { "type": "null" } ] }, "middle_name": { "description": "Legal middle name.", "maxLength": 100, "type": [ "string", "null" ] }, "print_name_of_signer": { "description": "Printed name of the signer.", "maxLength": 100, "type": [ "string", "null" ] }, "referencing_information": { "description": "Reference number for the form.", "maxLength": 100, "type": [ "string", "null" ] }, "state": { "description": "State or province code.", "maxLength": 10, "type": [ "string", "null" ] }, "tax_number": { "$ref": "#/components/schemas/WorkersTaxFormsTaxFormIdPutRequestBodyContentApplicationJsonSchemaDataOneOf2TaxNumber", "description": "Foreign tax identifying number. At least one of us_tax_number or tax_number is required unless is_ftin_not_legally_required is true." }, "tax_treaty_benefits_form": { "description": "Tax treaty benefits details. Applicable when is_tax_treaty_enabled is true.", "oneOf": [ { "$ref": "#/components/schemas/WorkersTaxFormsTaxFormIdPutRequestBodyContentApplicationJsonSchemaDataOneOf2TaxTreatyBenefitsForm" }, { "type": "null" } ] }, "us_tax_number": { "$ref": "#/components/schemas/WorkersTaxFormsTaxFormIdPutRequestBodyContentApplicationJsonSchemaDataOneOf2UsTaxNumber", "description": "US Taxpayer Identification Number." }, "zip_code": { "description": "ZIP/postal code.", "type": "string" } }, "required": [ "form_type", "address", "country", "zip_code", "last_name", "first_name", "country_of_citizenship" ], "type": "object" }, { "description": "W8_BEN_E variant", "properties": { "address": { "description": "Street address.", "maxLength": 100, "type": "string" }, "address_line2": { "description": "Street address line 2.", "maxLength": 100, "type": [ "string", "null" ] }, "city": { "description": "City of residence.", "maxLength": 50, "minLength": 1, "type": "string" }, "contractor_signature": { "description": "Authorized signer's digital signature.", "maxLength": 100, "minLength": 1, "type": "string" }, "country": { "description": "ISO 3166-1 alpha-2 country code of permanent residence.", "maxLength": 2, "minLength": 2, "pattern": "^[A-Z]{2}$", "type": "string" }, "country_of_citizenship": { "description": "ISO 3166-1 alpha-2 country code of incorporation/organization.", "maxLength": 2, "minLength": 2, "pattern": "^[A-Z]{2}$", "type": "string" }, "date_of_birth": { "description": "Date of birth of the beneficial owner.", "format": "date-time", "type": [ "string", "null" ] }, "entity_country": { "description": "ISO 3166-1 alpha-2 country code of the entity.", "maxLength": 2, "minLength": 2, "pattern": "^[A-Z]{2}$", "type": [ "string", "null" ] }, "entity_type": { "$ref": "#/components/schemas/WorkersTaxFormsTaxFormIdPutRequestBodyContentApplicationJsonSchemaDataOneOf3EntityType", "description": "Chapter 3 entity type." }, "fatca_status": { "$ref": "#/components/schemas/WorkersTaxFormsTaxFormIdPutRequestBodyContentApplicationJsonSchemaDataOneOf3FatcaStatus", "description": "FATCA (Foreign Account Tax Compliance Act) status." }, "form_type": { "description": "Discriminator value: W8_BEN_E", "enum": [ "W8_BEN_E" ], "type": "string" }, "giin": { "description": "Global Intermediary Identification Number (19 characters).", "maxLength": 19, "minLength": 19, "type": [ "string", "null" ] }, "has_substantial_us_owner": { "default": false, "description": "Whether the entity has a substantial US owner. Required when fatca_status is 'PASSIVE_NFFE'.", "type": "boolean" }, "is_entity_certification_confirmed": { "default": false, "description": "Certification that the entity is the beneficial owner of all income.", "type": [ "boolean", "null" ] }, "is_ftin_not_legally_required": { "default": false, "description": "Check if FTIN is not legally required in your country.", "type": "boolean" }, "is_tax_treaty_enabled": { "default": false, "description": "Whether the entity claims tax treaty benefits.", "type": [ "boolean", "null" ] }, "mailing_address": { "description": "Mailing address if different from permanent residence.", "oneOf": [ { "$ref": "#/components/schemas/WorkersTaxFormsTaxFormIdPutRequestBodyContentApplicationJsonSchemaDataOneOf3MailingAddress" }, { "type": "null" } ] }, "name_of_disregarded_entity": { "description": "Name of the disregarded entity, if applicable.", "maxLength": 100, "type": [ "string", "null" ] }, "name_of_organization": { "description": "Name of the organization.", "maxLength": 100, "type": "string" }, "print_name_of_signer": { "description": "Printed name of the authorized signer.", "maxLength": 100, "type": [ "string", "null" ] }, "referencing_information": { "description": "Reference number for the form.", "maxLength": 100, "type": [ "string", "null" ] }, "state": { "description": "State or province code.", "maxLength": 10, "type": [ "string", "null" ] }, "tax_number": { "$ref": "#/components/schemas/WorkersTaxFormsTaxFormIdPutRequestBodyContentApplicationJsonSchemaDataOneOf3TaxNumber", "description": "Foreign tax identifying number. At least one of us_tax_number, tax_number, or giin is required unless is_ftin_not_legally_required is true." }, "tax_treaty_benefits_form": { "description": "Tax treaty benefits details.", "oneOf": [ { "$ref": "#/components/schemas/WorkersTaxFormsTaxFormIdPutRequestBodyContentApplicationJsonSchemaDataOneOf3TaxTreatyBenefitsForm" }, { "type": "null" } ] }, "us_tax_number": { "$ref": "#/components/schemas/WorkersTaxFormsTaxFormIdPutRequestBodyContentApplicationJsonSchemaDataOneOf3UsTaxNumber", "description": "US Taxpayer Identification Number." }, "zip_code": { "description": "ZIP/postal code.", "type": "string" } }, "required": [ "form_type", "city", "address", "country", "zip_code", "entity_type", "fatca_status", "entity_country", "name_of_organization", "country_of_citizenship" ], "type": "object" } ], "title": "WorkersTaxFormsTaxFormIdPutRequestBodyContentApplicationJsonSchemaData" }, "WorkersTaxFormsTaxFormIdPutRequestBodyContentApplicationJsonSchemaDataOneOf0TaxNumber": { "description": "Taxpayer identification number.", "properties": { "type": { "$ref": "#/components/schemas/WorkersTaxFormsTaxFormIdPutRequestBodyContentApplicationJsonSchemaDataOneOf0TaxNumberType", "description": "Tax ID type. SSN/ITIN for individuals; EIN also allowed for disregarded entities." }, "value": { "description": "Tax ID value.", "type": "string" } }, "required": [ "type", "value" ], "title": "WorkersTaxFormsTaxFormIdPutRequestBodyContentApplicationJsonSchemaDataOneOf0TaxNumber", "type": "object" }, "WorkersTaxFormsTaxFormIdPutRequestBodyContentApplicationJsonSchemaDataOneOf0TaxNumberType": { "description": "Tax ID type. SSN/ITIN for individuals; EIN also allowed for disregarded entities.", "enum": [ "SSN", "ITIN", "EIN" ], "title": "WorkersTaxFormsTaxFormIdPutRequestBodyContentApplicationJsonSchemaDataOneOf0TaxNumberType", "type": "string" }, "WorkersTaxFormsTaxFormIdPutRequestBodyContentApplicationJsonSchemaDataOneOf1FederalTaxClassification": { "description": "Federal tax classification.", "properties": { "llc_classification": { "$ref": "#/components/schemas/WorkersTaxFormsTaxFormIdPutRequestBodyContentApplicationJsonSchemaDataOneOf1FederalTaxClassificationLlcClassification", "description": "LLC sub-classification. Required when type is 'LLC'." }, "other_additional_information": { "description": "Additional information. Required when type is 'OTHER'.", "maxLength": 100, "type": "string" }, "type": { "$ref": "#/components/schemas/WorkersTaxFormsTaxFormIdPutRequestBodyContentApplicationJsonSchemaDataOneOf1FederalTaxClassificationType", "description": "Federal tax classification type." } }, "required": [ "type" ], "title": "WorkersTaxFormsTaxFormIdPutRequestBodyContentApplicationJsonSchemaDataOneOf1FederalTaxClassification", "type": "object" }, "WorkersTaxFormsTaxFormIdPutRequestBodyContentApplicationJsonSchemaDataOneOf1FederalTaxClassificationLlcClassification": { "description": "LLC sub-classification. Required when type is 'LLC'.", "enum": [ "P", "S", "C" ], "title": "WorkersTaxFormsTaxFormIdPutRequestBodyContentApplicationJsonSchemaDataOneOf1FederalTaxClassificationLlcClassification", "type": "string" }, "WorkersTaxFormsTaxFormIdPutRequestBodyContentApplicationJsonSchemaDataOneOf1FederalTaxClassificationType": { "description": "Federal tax classification type.", "enum": [ "C_CORPORATION", "S_CORPORATION", "OTHER", "PARTNERSHIP", "LLC", "TRUST_ESTATE" ], "title": "WorkersTaxFormsTaxFormIdPutRequestBodyContentApplicationJsonSchemaDataOneOf1FederalTaxClassificationType", "type": "string" }, "WorkersTaxFormsTaxFormIdPutRequestBodyContentApplicationJsonSchemaDataOneOf1TaxNumber": { "description": "Taxpayer identification number.", "properties": { "type": { "$ref": "#/components/schemas/WorkersTaxFormsTaxFormIdPutRequestBodyContentApplicationJsonSchemaDataOneOf1TaxNumberType", "description": "Tax ID type. EIN for most entities; SSN/ITIN/EIN for LLC." }, "value": { "description": "Tax ID value.", "type": "string" } }, "required": [ "type", "value" ], "title": "WorkersTaxFormsTaxFormIdPutRequestBodyContentApplicationJsonSchemaDataOneOf1TaxNumber", "type": "object" }, "WorkersTaxFormsTaxFormIdPutRequestBodyContentApplicationJsonSchemaDataOneOf1TaxNumberType": { "description": "Tax ID type. EIN for most entities; SSN/ITIN/EIN for LLC.", "enum": [ "SSN", "ITIN", "EIN" ], "title": "WorkersTaxFormsTaxFormIdPutRequestBodyContentApplicationJsonSchemaDataOneOf1TaxNumberType", "type": "string" }, "WorkersTaxFormsTaxFormIdPutRequestBodyContentApplicationJsonSchemaDataOneOf2MailingAddress": { "description": "Mailing address if different from permanent residence.", "properties": { "address": { "description": "Mailing address.", "maxLength": 100, "type": "string" }, "address_line2": { "description": "Mailing address line 2.", "maxLength": 100, "type": [ "string", "null" ] }, "city": { "description": "Mailing address city.", "maxLength": 50, "minLength": 1, "type": [ "string", "null" ] }, "country": { "description": "ISO 3166-1 alpha-2 country code.", "maxLength": 2, "minLength": 2, "pattern": "^[A-Z]{2}$", "type": "string" }, "state": { "description": "Mailing address state.", "maxLength": 10, "type": [ "string", "null" ] }, "zip_code": { "description": "Mailing address ZIP/postal code.", "type": "string" } }, "required": [ "address", "country", "zip_code" ], "title": "WorkersTaxFormsTaxFormIdPutRequestBodyContentApplicationJsonSchemaDataOneOf2MailingAddress", "type": "object" }, "WorkersTaxFormsTaxFormIdPutRequestBodyContentApplicationJsonSchemaDataOneOf2TaxNumber": { "description": "Foreign tax identifying number. At least one of us_tax_number or tax_number is required unless is_ftin_not_legally_required is true.", "properties": { "type": { "$ref": "#/components/schemas/WorkersTaxFormsTaxFormIdPutRequestBodyContentApplicationJsonSchemaDataOneOf2TaxNumberType", "description": "Foreign tax ID type." }, "value": { "description": "Foreign tax identifying number.", "maxLength": 20, "type": "string" } }, "required": [ "type", "value" ], "title": "WorkersTaxFormsTaxFormIdPutRequestBodyContentApplicationJsonSchemaDataOneOf2TaxNumber", "type": "object" }, "WorkersTaxFormsTaxFormIdPutRequestBodyContentApplicationJsonSchemaDataOneOf2TaxNumberType": { "description": "Foreign tax ID type.", "enum": [ "FTIN" ], "title": "WorkersTaxFormsTaxFormIdPutRequestBodyContentApplicationJsonSchemaDataOneOf2TaxNumberType", "type": "string" }, "WorkersTaxFormsTaxFormIdPutRequestBodyContentApplicationJsonSchemaDataOneOf2TaxTreatyBenefitsForm": { "description": "Tax treaty benefits details. Applicable when is_tax_treaty_enabled is true.", "properties": { "article_and_paragraph": { "description": "Article and paragraph of the applicable tax treaty.", "maxLength": 100, "type": "string" }, "details": { "description": "Additional details about the treaty claim.", "maxLength": 400, "type": "string" }, "owner_resident_country": { "description": "Country of residence of the beneficial owner. Must be a US income tax treaty country.", "maxLength": 2, "minLength": 2, "pattern": "^[A-Z]{2}$", "type": "string" }, "type_of_income": { "description": "Type of income covered by the treaty.", "maxLength": 100, "type": "string" }, "withholding_rate": { "description": "Withholding rate under the treaty (percentage).", "format": "double", "maximum": 100, "minimum": 0, "type": "number" } }, "title": "WorkersTaxFormsTaxFormIdPutRequestBodyContentApplicationJsonSchemaDataOneOf2TaxTreatyBenefitsForm", "type": "object" }, "WorkersTaxFormsTaxFormIdPutRequestBodyContentApplicationJsonSchemaDataOneOf2UsTaxNumber": { "description": "US Taxpayer Identification Number.", "properties": { "type": { "$ref": "#/components/schemas/WorkersTaxFormsTaxFormIdPutRequestBodyContentApplicationJsonSchemaDataOneOf2UsTaxNumberType", "description": "US tax ID type." }, "value": { "description": "US tax ID value.", "type": "string" } }, "required": [ "type", "value" ], "title": "WorkersTaxFormsTaxFormIdPutRequestBodyContentApplicationJsonSchemaDataOneOf2UsTaxNumber", "type": "object" }, "WorkersTaxFormsTaxFormIdPutRequestBodyContentApplicationJsonSchemaDataOneOf2UsTaxNumberType": { "description": "US tax ID type.", "enum": [ "SSN", "ITIN" ], "title": "WorkersTaxFormsTaxFormIdPutRequestBodyContentApplicationJsonSchemaDataOneOf2UsTaxNumberType", "type": "string" }, "WorkersTaxFormsTaxFormIdPutRequestBodyContentApplicationJsonSchemaDataOneOf3EntityType": { "description": "Chapter 3 entity type.", "enum": [ "CORPORATION", "DISREGARDED_ENTITY", "PARTNERSHIP", "SIMPLE_TRUST", "GRANTOR_TRUST", "COMPLEX_TRUST", "ESTATE", "GOVERNMENT", "CENTRAL_BANK_OF_ISSUE", "TAX_EXEMPT", "PRIVATE_FOUNDATION", "INTERNATIONAL", "FOREIGN_GOVERNMENT_CONTROLLED", "FOREIGN_GOVERNMENT_INTEGRAL" ], "title": "WorkersTaxFormsTaxFormIdPutRequestBodyContentApplicationJsonSchemaDataOneOf3EntityType", "type": "string" }, "WorkersTaxFormsTaxFormIdPutRequestBodyContentApplicationJsonSchemaDataOneOf3FatcaStatus": { "description": "FATCA (Foreign Account Tax Compliance Act) status.", "enum": [ "ACTIVE_NFFE", "PASSIVE_NFFE" ], "title": "WorkersTaxFormsTaxFormIdPutRequestBodyContentApplicationJsonSchemaDataOneOf3FatcaStatus", "type": "string" }, "WorkersTaxFormsTaxFormIdPutRequestBodyContentApplicationJsonSchemaDataOneOf3MailingAddress": { "description": "Mailing address if different from permanent residence.", "properties": { "address": { "description": "Mailing address.", "maxLength": 100, "type": "string" }, "address_line2": { "description": "Mailing address line 2.", "maxLength": 100, "type": [ "string", "null" ] }, "city": { "description": "Mailing address city.", "maxLength": 50, "minLength": 1, "type": [ "string", "null" ] }, "country": { "description": "ISO 3166-1 alpha-2 country code.", "maxLength": 2, "minLength": 2, "pattern": "^[A-Z]{2}$", "type": "string" }, "state": { "description": "Mailing address state.", "maxLength": 10, "type": [ "string", "null" ] }, "zip_code": { "description": "Mailing address ZIP/postal code.", "type": "string" } }, "required": [ "address", "country", "zip_code" ], "title": "WorkersTaxFormsTaxFormIdPutRequestBodyContentApplicationJsonSchemaDataOneOf3MailingAddress", "type": "object" }, "WorkersTaxFormsTaxFormIdPutRequestBodyContentApplicationJsonSchemaDataOneOf3TaxNumber": { "description": "Foreign tax identifying number. At least one of us_tax_number, tax_number, or giin is required unless is_ftin_not_legally_required is true.", "properties": { "type": { "$ref": "#/components/schemas/WorkersTaxFormsTaxFormIdPutRequestBodyContentApplicationJsonSchemaDataOneOf3TaxNumberType", "description": "Foreign tax ID type." }, "value": { "description": "Foreign tax identifying number.", "maxLength": 20, "type": "string" } }, "required": [ "type", "value" ], "title": "WorkersTaxFormsTaxFormIdPutRequestBodyContentApplicationJsonSchemaDataOneOf3TaxNumber", "type": "object" }, "WorkersTaxFormsTaxFormIdPutRequestBodyContentApplicationJsonSchemaDataOneOf3TaxNumberType": { "description": "Foreign tax ID type.", "enum": [ "FTIN" ], "title": "WorkersTaxFormsTaxFormIdPutRequestBodyContentApplicationJsonSchemaDataOneOf3TaxNumberType", "type": "string" }, "WorkersTaxFormsTaxFormIdPutRequestBodyContentApplicationJsonSchemaDataOneOf3TaxTreatyBenefitsForm": { "description": "Tax treaty benefits details.", "properties": { "article_and_paragraph": { "description": "Article and paragraph of the applicable tax treaty.", "maxLength": 100, "type": "string" }, "details": { "description": "Additional details about the treaty claim.", "maxLength": 400, "type": "string" }, "is_tax_residency_certified": { "default": false, "description": "Whether tax residency is certified.", "type": [ "boolean", "null" ] }, "limitation_type": { "description": "Limitation on benefits (LOB) type.", "oneOf": [ { "$ref": "#/components/schemas/WorkersTaxFormsTaxFormIdPutRequestBodyContentApplicationJsonSchemaDataOneOf3TaxTreatyBenefitsFormLimitationType" }, { "type": "null" } ] }, "other_article_and_paragraph": { "description": "Other article and paragraph. Required when limitation_type is 'OTHER'.", "maxLength": 50, "type": [ "string", "null" ] }, "owner_resident_country": { "description": "Country of residence of the beneficial owner.", "maxLength": 2, "minLength": 2, "pattern": "^[A-Z]{2}$", "type": "string" }, "type_of_income": { "description": "Type of income covered by the treaty.", "maxLength": 25, "type": "string" }, "withholding_rate": { "description": "Withholding rate under the treaty (percentage).", "format": "double", "maximum": 100, "minimum": 0, "type": "number" } }, "title": "WorkersTaxFormsTaxFormIdPutRequestBodyContentApplicationJsonSchemaDataOneOf3TaxTreatyBenefitsForm", "type": "object" }, "WorkersTaxFormsTaxFormIdPutRequestBodyContentApplicationJsonSchemaDataOneOf3TaxTreatyBenefitsFormLimitationType": { "description": "Limitation on benefits (LOB) type.", "enum": [ "GOVERNMENT", "PENSION_TRUST", "TAX_EXEMPT", "PUBLICLY_TRADED_CORPORATION", "SUBSIDIARY", "OWNERSHIP_TEST", "DERIVATIVE_TEST", "ACTIVE_TRADE_TEST", "FAVORABLE", "NO_ARTICLE", "OTHER" ], "title": "WorkersTaxFormsTaxFormIdPutRequestBodyContentApplicationJsonSchemaDataOneOf3TaxTreatyBenefitsFormLimitationType", "type": "string" }, "WorkersTaxFormsTaxFormIdPutRequestBodyContentApplicationJsonSchemaDataOneOf3UsTaxNumber": { "description": "US Taxpayer Identification Number.", "properties": { "type": { "$ref": "#/components/schemas/WorkersTaxFormsTaxFormIdPutRequestBodyContentApplicationJsonSchemaDataOneOf3UsTaxNumberType", "description": "US tax ID type." }, "value": { "description": "US tax ID value.", "type": "string" } }, "required": [ "type", "value" ], "title": "WorkersTaxFormsTaxFormIdPutRequestBodyContentApplicationJsonSchemaDataOneOf3UsTaxNumber", "type": "object" }, "WorkersTaxFormsTaxFormIdPutRequestBodyContentApplicationJsonSchemaDataOneOf3UsTaxNumberType": { "description": "US tax ID type.", "enum": [ "SSN", "ITIN" ], "title": "WorkersTaxFormsTaxFormIdPutRequestBodyContentApplicationJsonSchemaDataOneOf3UsTaxNumberType", "type": "string" }, "WorkersTaxFormsTaxFormIdPutResponsesContentApplicationJsonSchemaData": { "properties": { "created_at": { "description": "Timestamp of when the tax form was created.", "format": "date-time", "type": "string" }, "id": { "description": "The public ID (UUID) of the tax form.", "format": "uuid", "type": "string" }, "updated_at": { "description": "Timestamp of when the tax form was last updated.", "format": "date-time", "type": "string" } }, "required": [ "id", "created_at", "updated_at" ], "title": "WorkersTaxFormsTaxFormIdPutResponsesContentApplicationJsonSchemaData", "type": "object" }, "WorkersTaxFormsTaxFormIdPutResponsesContentApplicationJsonSchemaErrorsItems": { "properties": { "code": { "description": "Machine-readable error code", "type": "string" }, "message": { "description": "Human-readable explanation of the error", "type": "string" } }, "title": "WorkersTaxFormsTaxFormIdPutResponsesContentApplicationJsonSchemaErrorsItems", "type": "object" }, "Workers_completeIndividualContractorProfileSetup-v2026-01-01_Response_200": { "properties": { "data": { "$ref": "#/components/schemas/OnboardingWorkersIndividualPostResponsesContentApplicationJsonSchemaData" } }, "required": [ "data" ], "title": "Workers_completeIndividualContractorProfileSetup-v2026-01-01_Response_200", "type": "object" }, "Workers_createATaxFormForAWorker-v2026-01-01_Response_201": { "properties": { "data": { "$ref": "#/components/schemas/WorkersTaxFormsPostResponsesContentApplicationJsonSchemaData" } }, "required": [ "data" ], "title": "Workers_createATaxFormForAWorker-v2026-01-01_Response_201", "type": "object" }, "Workers_createWorker-v2026-01-01_Response_201": { "properties": { "data": { "$ref": "#/components/schemas/WorkerPostResponsesContentApplicationJsonSchemaData" } }, "required": [ "data" ], "title": "Workers_createWorker-v2026-01-01_Response_201", "type": "object" }, "Workers_downloadWorkerContractComplianceDocument-v2026-08-25_Response_200": { "properties": { "data": { "$ref": "#/components/schemas/WorkersContractsContractIdComplianceDocumentsDocumentIdDownloadGetResponsesContentApplicationJsonSchemaData" } }, "required": [ "data" ], "title": "Workers_downloadWorkerContractComplianceDocument-v2026-08-25_Response_200", "type": "object" }, "Workers_getInvoiceDetailsById-v2026-04-27_Response_200": { "properties": { "data": { "$ref": "#/components/schemas/IcWorkersInvoicesInvoiceIdGetResponsesContentApplicationJsonSchemaData", "description": "Invoice summary (snake_case; display card fields, amounts, and payment display)." } }, "required": [ "data" ], "title": "Workers_getInvoiceDetailsById-v2026-04-27_Response_200", "type": "object" }, "Workers_getWorkerContractComplianceDocument-v2026-08-25_Response_200": { "properties": { "data": { "$ref": "#/components/schemas/WorkersContractsContractIdComplianceDocumentsDocumentIdGetResponsesContentApplicationJsonSchemaData" } }, "required": [ "data" ], "title": "Workers_getWorkerContractComplianceDocument-v2026-08-25_Response_200", "type": "object" }, "Workers_icWorkersInvoicesInvoiceIdPdf-v2026-01-01_Response_200": { "description": "Envelope containing a time-limited signed URL to the invoice PDF.", "properties": { "data": { "$ref": "#/components/schemas/IcWorkersInvoicesInvoiceIdPdfGetResponsesContentApplicationJsonSchemaData", "description": "Payload with the signed download URL." } }, "required": [ "data" ], "title": "Workers_icWorkersInvoicesInvoiceIdPdf-v2026-01-01_Response_200", "type": "object" }, "Workers_listOfWorkerComplianceDocuments-v2026-01-01_Response_200": { "properties": { "data": { "$ref": "#/components/schemas/WorkersComplianceDocumentsGetResponsesContentApplicationJsonSchemaData" } }, "required": [ "data" ], "title": "Workers_listOfWorkerComplianceDocuments-v2026-01-01_Response_200", "type": "object" }, "Workers_listTaxFormsForAWorker-v2026-01-01_Response_200": { "properties": { "data": { "description": "The worker's tax forms, newest first.", "items": { "$ref": "#/components/schemas/WorkersTaxFormsGetResponsesContentApplicationJsonSchemaDataItems" }, "type": "array" }, "has_more": { "description": "Whether more tax forms exist beyond this page.", "type": "boolean" }, "next_cursor": { "description": "Cursor to pass as the cursor query parameter to fetch the next page. Null when has_more is false.", "type": [ "string", "null" ] }, "total_count": { "description": "Total number of the worker's tax forms across all pages.", "type": "integer" } }, "required": [ "data", "has_more", "next_cursor", "total_count" ], "title": "Workers_listTaxFormsForAWorker-v2026-01-01_Response_200", "type": "object" }, "Workers_listWorkerContractComplianceDocuments-v2026-08-25_Response_200": { "properties": { "data": { "description": "Documents on this page.", "items": { "$ref": "#/components/schemas/WorkersContractsContractIdComplianceDocumentsGetResponsesContentApplicationJsonSchemaDataItems" }, "type": "array" }, "has_more": { "description": "Whether another page follows this one.", "type": "boolean" }, "next_cursor": { "description": "Opaque token to pass as `cursor` to fetch the next page. Null on the last page. Never construct or parse one.", "type": [ "string", "null" ] }, "total_count": { "description": "Total number of documents for the contract, across every page.", "minimum": 0, "type": "integer" } }, "required": [ "data", "has_more", "next_cursor", "total_count" ], "title": "Workers_listWorkerContractComplianceDocuments-v2026-08-25_Response_200", "type": "object" }, "Workers_replaceATaxFormForAWorker-v2026-01-01_Response_200": { "properties": { "data": { "$ref": "#/components/schemas/WorkersTaxFormsTaxFormIdPutResponsesContentApplicationJsonSchemaData" } }, "required": [ "data" ], "title": "Workers_replaceATaxFormForAWorker-v2026-01-01_Response_200", "type": "object" }, "WorkingLocationsGetResponsesContentApplicationJsonSchemaDataItems": { "properties": { "id": { "description": "Unique identifier of this resource.", "format": "double", "type": "number" }, "name": { "type": "string" } }, "required": [ "id", "name" ], "title": "WorkingLocationsGetResponsesContentApplicationJsonSchemaDataItems", "type": "object" }, "adjustments_createContractAdjustment_Response_201": { "properties": { "data": { "$ref": "#/components/schemas/AdjustmentsPostResponsesContentApplicationJsonSchemaData" } }, "required": [ "data" ], "title": "adjustments_createContractAdjustment_Response_201", "type": "object" }, "adjustments_deleteContractAdjustment_Response_200": { "properties": { "data": { "$ref": "#/components/schemas/AdjustmentsIdDeleteResponsesContentApplicationJsonSchemaData" } }, "required": [ "data" ], "title": "adjustments_deleteContractAdjustment_Response_200", "type": "object" }, "adjustments_getAdjustmentCategories_Response_200": { "properties": { "data": { "items": { "$ref": "#/components/schemas/AdjustmentsCategoriesGetResponsesContentApplicationJsonSchemaDataItems" }, "type": "array" } }, "required": [ "data" ], "title": "adjustments_getAdjustmentCategories_Response_200", "type": "object" }, "adjustments_getContractAdjustment_Response_200": { "properties": { "data": { "$ref": "#/components/schemas/AdjustmentsIdGetResponsesContentApplicationJsonSchemaData" } }, "required": [ "data" ], "title": "adjustments_getContractAdjustment_Response_200", "type": "object" }, "adjustments_getContractAdjustments_Response_200": { "properties": { "data": { "items": { "$ref": "#/components/schemas/ContractsContractIdAdjustmentsGetResponsesContentApplicationJsonSchemaDataItems" }, "type": "array" } }, "required": [ "data" ], "title": "adjustments_getContractAdjustments_Response_200", "type": "object" }, "adjustments_updateContractAdjustment_Response_200": { "properties": { "data": { "$ref": "#/components/schemas/AdjustmentsIdPatchResponsesContentApplicationJsonSchemaData" } }, "required": [ "data" ], "title": "adjustments_updateContractAdjustment_Response_200", "type": "object" }, "ats-application-sources_retrieveAListOfAtsApplicationSources_Response_200": { "properties": { "data": { "description": "Page of application sources.", "items": { "$ref": "#/components/schemas/AtsApplicationSourcesGetResponsesContentApplicationJsonSchemaDataItems" }, "type": "array" }, "has_more": { "description": "Indicates if there are more application sources to fetch", "type": "boolean" }, "next_cursor": { "description": "Cursor for the next page of results", "type": [ "string", "null" ] }, "total_count": { "description": "Total number of application sources", "type": "integer" } }, "required": [ "data", "has_more", "next_cursor", "total_count" ], "title": "ats-application-sources_retrieveAListOfAtsApplicationSources_Response_200", "type": "object" }, "ats-applications_addNoteToAnApplication-v2026-01-01_Response_201": { "properties": { "data": { "$ref": "#/components/schemas/AtsApplicationsApplicationIdNotesPostResponsesContentApplicationJsonSchemaData", "description": "The created application note" } }, "required": [ "data" ], "title": "ats-applications_addNoteToAnApplication-v2026-01-01_Response_201", "type": "object" }, "ats-applications_associateApplicationWithAnInterviewPlanStage-v2026-01-01_Response_201": { "properties": { "data": { "$ref": "#/components/schemas/AtsApplicationsApplicationIdInterviewPlanStagesPostResponsesContentApplicationJsonSchemaData", "description": "The created application interview plan stage record" } }, "required": [ "data" ], "title": "ats-applications_associateApplicationWithAnInterviewPlanStage-v2026-01-01_Response_201", "type": "object" }, "ats-applications_createAtsApplication-v2026-01-01_Response_201": { "description": "Created application response", "properties": { "data": { "$ref": "#/components/schemas/AtsApplicationsPostResponsesContentApplicationJsonSchemaData" } }, "required": [ "data" ], "title": "ats-applications_createAtsApplication-v2026-01-01_Response_201", "type": "object" }, "ats-applications_retrieveAListOfAtsApplications-v2026-01-01_Response_200": { "description": "Paginated list of applications", "properties": { "data": { "description": "Page of applications", "items": { "$ref": "#/components/schemas/AtsApplicationsGetResponsesContentApplicationJsonSchemaDataItems" }, "type": "array" }, "has_more": { "description": "Whether more pages are available", "type": "boolean" }, "next_cursor": { "description": "Cursor to fetch the next page; null when there are no more pages", "type": [ "string", "null" ] }, "total_count": { "description": "Total number of applications", "type": "integer" } }, "required": [ "data", "has_more", "next_cursor", "total_count" ], "title": "ats-applications_retrieveAListOfAtsApplications-v2026-01-01_Response_200", "type": "object" }, "ats-applications_retrieveAtsApplication-v2026-01-01_Response_200": { "description": "Single application response", "properties": { "data": { "$ref": "#/components/schemas/AtsApplicationsApplicationIdGetResponsesContentApplicationJsonSchemaData", "description": "Complete application details" } }, "required": [ "data" ], "title": "ats-applications_retrieveAtsApplication-v2026-01-01_Response_200", "type": "object" }, "ats-attachments_retrievePaginatedListOfAtsAttachmentFiles-v2026-01-01_Response_200": { "properties": { "data": { "description": "Array of attachment objects", "items": { "$ref": "#/components/schemas/AtsAttachmentsAttachableTypeSlugAttachableIdAttachmentTypeSlugGetResponsesContentApplicationJsonSchemaDataItems" }, "type": "array" }, "has_more": { "description": "Indicates if there are more results available", "type": "boolean" }, "next_cursor": { "description": "Cursor for pagination to fetch next page", "maxLength": 1000, "type": [ "string", "null" ] }, "total_count": { "description": "Total count of attachments", "format": "double", "type": "number" } }, "required": [ "data", "has_more", "next_cursor", "total_count" ], "title": "ats-attachments_retrievePaginatedListOfAtsAttachmentFiles-v2026-01-01_Response_200", "type": "object" }, "ats-candidates_createAtsCandidate-v2026-01-01_Response_201": { "properties": { "data": { "$ref": "#/components/schemas/AtsCandidatesPostResponsesContentApplicationJsonSchemaData" } }, "required": [ "data" ], "title": "ats-candidates_createAtsCandidate-v2026-01-01_Response_201", "type": "object" }, "ats-candidates_createCandidateTags-v2026-02-27_Response_201": { "properties": { "data": { "description": "List of created candidate-tag associations.", "items": { "$ref": "#/components/schemas/AtsCandidatesCandidateIdTagsPostResponsesContentApplicationJsonSchemaDataItems" }, "type": "array" } }, "required": [ "data" ], "title": "ats-candidates_createCandidateTags-v2026-02-27_Response_201", "type": "object" }, "ats-candidates_retrievePaginatedListOfAtsCandidates-v2026-01-01_Response_200": { "properties": { "data": { "description": "List of candidates", "items": { "$ref": "#/components/schemas/AtsCandidatesGetResponsesContentApplicationJsonSchemaDataItems" }, "type": "array" }, "has_more": { "description": "Indicates if there are more items to fetch", "type": "boolean" }, "next_cursor": { "description": "Cursor for the next page of results", "type": [ "string", "null" ] }, "total_count": { "description": "Total number of candidates", "minimum": 0, "type": "integer" } }, "required": [ "data", "has_more", "next_cursor", "total_count" ], "title": "ats-candidates_retrievePaginatedListOfAtsCandidates-v2026-01-01_Response_200", "type": "object" }, "ats-departments_retrieveAListOfAtsDepartments_Response_200": { "properties": { "data": { "description": "Page of departments.", "items": { "$ref": "#/components/schemas/AtsDepartmentsGetResponsesContentApplicationJsonSchemaDataItems" }, "type": "array" }, "has_more": { "description": "Indicates if there are more departments available", "type": "boolean" }, "next_cursor": { "description": "Cursor for pagination to get the next set of results; null when there are no more pages", "type": [ "string", "null" ] }, "total_count": { "description": "Total number of departments available", "type": "integer" } }, "required": [ "data", "has_more", "next_cursor", "total_count" ], "title": "ats-departments_retrieveAListOfAtsDepartments_Response_200", "type": "object" }, "ats-email-templates_retrieveAListOfPublishedAtsEmailTemplates-v2026-02-11_Response_200": { "properties": { "data": { "description": "Page of email templates.", "items": { "$ref": "#/components/schemas/AtsEmailTemplatesGetResponsesContentApplicationJsonSchemaDataItems" }, "type": "array" }, "has_more": { "description": "Whether more pages are available.", "type": "boolean" }, "next_cursor": { "description": "Cursor to fetch the next page; null when there are no more pages.", "type": [ "string", "null" ] }, "total_count": { "description": "Total number of email templates matching filters.", "type": "integer" } }, "required": [ "data", "has_more", "next_cursor", "total_count" ], "title": "ats-email-templates_retrieveAListOfPublishedAtsEmailTemplates-v2026-02-11_Response_200", "type": "object" }, "ats-employment-types_retrieveAListOfAtsEmploymentTypes_Response_200": { "properties": { "data": { "description": "List of employment types", "items": { "$ref": "#/components/schemas/AtsEmploymentTypesGetResponsesContentApplicationJsonSchemaDataItems" }, "type": "array" }, "has_more": { "description": "Indicates if there are more employment types available", "type": "boolean" }, "next_cursor": { "description": "Cursor for pagination to get the next set of results", "type": [ "string", "null" ] }, "total_count": { "description": "Total number of employment types available", "minimum": 0, "type": "integer" } }, "required": [ "data", "has_more", "next_cursor", "total_count" ], "title": "ats-employment-types_retrieveAListOfAtsEmploymentTypes_Response_200", "type": "object" }, "ats-hiring-members_retrieveAtsHiringMembers_Response_200": { "properties": { "data": { "description": "Page of resources.", "items": { "$ref": "#/components/schemas/AtsHiringMembersGetResponsesContentApplicationJsonSchemaDataItems" }, "type": "array" }, "has_more": { "description": "Indicates if there are more items to fetch.", "type": "boolean" }, "next_cursor": { "description": "Cursor for the next page of results", "type": [ "string", "null" ] }, "total_count": { "description": "Total number of users", "minimum": 0, "type": "integer" } }, "required": [ "data", "has_more", "next_cursor", "total_count" ], "title": "ats-hiring-members_retrieveAtsHiringMembers_Response_200", "type": "object" }, "ats-job-postings_retrieveAListOfAtsJobPostings_Response_200": { "properties": { "data": { "items": { "$ref": "#/components/schemas/AtsJobBoardsJobBoardIdJobPostingsGetResponsesContentApplicationJsonSchemaDataItems" }, "type": "array" }, "has_more": { "description": "Indicates if there are more results available", "type": "boolean" }, "next_cursor": { "description": "Cursor for the next page of results", "type": [ "string", "null" ] }, "total_count": { "description": "Total number of job postings", "minimum": 0, "type": "integer" } }, "required": [ "data", "has_more", "next_cursor", "total_count" ], "title": "ats-job-postings_retrieveAListOfAtsJobPostings_Response_200", "type": "object" }, "ats-job-postings_retrieveAtsJobPosting_Response_200": { "description": "Successful operation.", "properties": { "data": { "$ref": "#/components/schemas/AtsJobPostingsJobPostingIdGetResponsesContentApplicationJsonSchemaData", "description": "Job posting with nested job details and publication status." } }, "title": "ats-job-postings_retrieveAtsJobPosting_Response_200", "type": "object" }, "ats-job-postings_retrieveAtsJobPostings-v2026-04-10_Response_200": { "properties": { "data": { "items": { "$ref": "#/components/schemas/AtsJobPostingsGetResponsesContentApplicationJsonSchemaDataItems" }, "type": "array" }, "has_more": { "description": "Indicates if there are more results available", "type": "boolean" }, "next_cursor": { "description": "Cursor for the next page of results", "type": [ "string", "null" ] }, "total_count": { "description": "Total number of job postings", "minimum": 0, "type": "integer" } }, "required": [ "data", "has_more", "next_cursor", "total_count" ], "title": "ats-job-postings_retrieveAtsJobPostings-v2026-04-10_Response_200", "type": "object" }, "ats-jobs_createAtsJob_Response_201": { "properties": { "data": { "$ref": "#/components/schemas/AtsJobsPostResponsesContentApplicationJsonSchemaData" } }, "required": [ "data" ], "title": "ats-jobs_createAtsJob_Response_201", "type": "object" }, "ats-jobs_retrieveAListOfAtsJobs_Response_200": { "properties": { "data": { "description": "Page of jobs.", "items": { "$ref": "#/components/schemas/AtsJobsGetResponsesContentApplicationJsonSchemaDataItems" }, "type": "array" }, "has_more": { "description": "Whether more pages are available.", "type": "boolean" }, "next_cursor": { "description": "Cursor to fetch the next page; null when there are no more pages.", "type": [ "string", "null" ] }, "total_count": { "description": "Total number of jobs matching filters.", "type": "integer" } }, "required": [ "data", "has_more", "next_cursor", "total_count" ], "title": "ats-jobs_retrieveAListOfAtsJobs_Response_200", "type": "object" }, "ats-locations_retrieveAListOfAtsLocations-v2026-01-01_Response_200": { "properties": { "data": { "description": "Page of locations.", "items": { "$ref": "#/components/schemas/AtsLocationsGetResponsesContentApplicationJsonSchemaDataItems" }, "type": "array" }, "has_more": { "description": "Indicates if there are more locations available", "type": "boolean" }, "next_cursor": { "description": "Cursor for pagination to get the next set of results", "type": [ "string", "null" ] }, "total_count": { "description": "Total number of locations available", "minimum": 0, "type": "integer" } }, "required": [ "data", "has_more", "next_cursor", "total_count" ], "title": "ats-locations_retrieveAListOfAtsLocations-v2026-01-01_Response_200", "type": "object" }, "ats-offers_retrieveAListOfAtsOffers-v2026-01-01_Response_200": { "properties": { "data": { "description": "Page of offers.", "items": { "$ref": "#/components/schemas/AtsOffersGetResponsesContentApplicationJsonSchemaDataItems" }, "type": "array" }, "has_more": { "description": "Indicates if there are more items to fetch.", "type": "boolean" }, "next_cursor": { "description": "Cursor for the next page of results", "type": [ "string", "null" ] }, "total_count": { "description": "Total number of offers", "format": "double", "type": "number" } }, "title": "ats-offers_retrieveAListOfAtsOffers-v2026-01-01_Response_200", "type": "object" }, "ats-reasons_retrievePaginatedListOfAtsRejectionArchivationReasons-v2026-01-01_Response_200": { "properties": { "data": { "description": "Array of reason objects", "items": { "$ref": "#/components/schemas/AtsReasonsGetResponsesContentApplicationJsonSchemaDataItems" }, "type": "array" }, "has_more": { "description": "Indicates if there are more results available", "type": "boolean" }, "next_cursor": { "description": "Cursor for pagination to fetch next page", "maxLength": 1000, "type": [ "string", "null" ] }, "total_count": { "description": "Total count of reasons", "format": "double", "type": "number" } }, "required": [ "data", "has_more", "next_cursor", "total_count" ], "title": "ats-reasons_retrievePaginatedListOfAtsRejectionArchivationReasons-v2026-01-01_Response_200", "type": "object" }, "ats-tags_listTags-v2026-02-27_Response_200": { "properties": { "data": { "description": "List of tags.", "items": { "$ref": "#/components/schemas/AtsTagsGetResponsesContentApplicationJsonSchemaDataItems" }, "type": "array" }, "has_more": { "description": "Whether more results exist (pagination).", "type": "boolean" }, "next_cursor": { "description": "Cursor for the next page of results, or null if none.", "maxLength": 1000, "type": [ "string", "null" ] }, "total_count": { "description": "Total number of tags returned.", "minimum": 0, "type": "integer" } }, "required": [ "data", "has_more", "next_cursor", "total_count" ], "title": "ats-tags_listTags-v2026-02-27_Response_200", "type": "object" }, "contractor-amendments_createContractAmendment_Response_201": { "properties": { "data": { "$ref": "#/components/schemas/ContractsContractIdAmendmentsPostResponsesContentApplicationJsonSchemaData" } }, "required": [ "data" ], "title": "contractor-amendments_createContractAmendment_Response_201", "type": "object" }, "contractor-amendments_getContractAmendments_Response_200": { "properties": { "cursor": { "description": "Cursor for the next page of results.", "type": [ "string", "null" ] }, "data": { "description": "List of amendments. IC contracts may return multiple; Global Payroll contracts return at most one (the current pending amendment).", "items": { "$ref": "#/components/schemas/ContractsContractIdAmendmentsGetResponsesContentApplicationJsonSchemaDataItems" }, "type": "array" }, "has_more": { "description": "Indicates if there are more work statements available.", "type": "boolean" }, "total_count": { "description": "Total number of work statements matching the filters.", "type": "integer" } }, "required": [ "data", "cursor", "has_more", "total_count" ], "title": "contractor-amendments_getContractAmendments_Response_200", "type": "object" }, "contractor-hiring_createContractDocument_Response_201": { "properties": { "data": { "description": "This object is used for linking file attachments to your records.", "oneOf": [ { "$ref": "#/components/schemas/ContractsContractIdDocumentsPostResponsesContentApplicationJsonSchemaData" }, { "type": "null" } ] } }, "required": [ "data" ], "title": "contractor-hiring_createContractDocument_Response_201", "type": "object" }, "contractor-hiring_createContractInvitation_Response_201": { "properties": { "data": { "$ref": "#/components/schemas/ContractsContractIdInvitationsPostResponsesContentApplicationJsonSchemaData" } }, "required": [ "data" ], "title": "contractor-hiring_createContractInvitation_Response_201", "type": "object" }, "contractor-hiring_createContractSignature_Response_201": { "properties": { "data": { "$ref": "#/components/schemas/ContractsContractIdSignaturesPostResponsesContentApplicationJsonSchemaData" } }, "required": [ "data" ], "title": "contractor-hiring_createContractSignature_Response_201", "type": "object" }, "contractor-hiring_getContractInvitations_Response_200": { "properties": { "data": { "$ref": "#/components/schemas/ContractsContractIdInvitationsDeleteResponsesContentApplicationJsonSchemaData" } }, "required": [ "data" ], "title": "contractor-hiring_getContractInvitations_Response_200", "type": "object" }, "contractor-hiring_getContractInvite_Response_200": { "properties": { "data": { "type": "string" } }, "required": [ "data" ], "title": "contractor-hiring_getContractInvite_Response_200", "type": "object" }, "contractor-hiring_getContractPaymentCycles_Response_200": { "properties": { "data": { "items": { "$ref": "#/components/schemas/ContractsContractIdPaymentCyclesGetResponsesContentApplicationJsonSchemaDataItems" }, "type": "array" } }, "required": [ "data" ], "title": "contractor-hiring_getContractPaymentCycles_Response_200", "type": "object" }, "contracts_createICContract_Response_201": { "properties": { "data": { "$ref": "#/components/schemas/ContractsPostResponsesContentApplicationJsonSchemaData" } }, "required": [ "data" ], "title": "contracts_createICContract_Response_201", "type": "object" }, "contracts_getContract_Response_200": { "properties": { "data": { "$ref": "#/components/schemas/ContractsContractIdGetResponsesContentApplicationJsonSchemaData" } }, "required": [ "data" ], "title": "contracts_getContract_Response_200", "type": "object" }, "contracts_getContracts_Response_200": { "properties": { "data": { "description": "Array of contract objects.", "items": { "$ref": "#/components/schemas/ContractsGetResponsesContentApplicationJsonSchemaDataItems" }, "type": "array" }, "page": { "$ref": "#/components/schemas/ContractsGetResponsesContentApplicationJsonSchemaPage", "description": "Pagination information for the response." } }, "required": [ "data", "page" ], "title": "contracts_getContracts_Response_200", "type": "object" }, "contracts_updateICContract_Response_200": { "properties": { "client": { "description": "Client details associated with the contract.", "oneOf": [ { "$ref": "#/components/schemas/ContractsContractIdPatchResponsesContentApplicationJsonSchemaClient" }, { "type": "null" } ] }, "compensation_details": { "$ref": "#/components/schemas/ContractsContractIdPatchResponsesContentApplicationJsonSchemaCompensationDetails", "description": "Compensation and payment configuration for the contract." }, "contract_template": { "description": "Contract template details.", "oneOf": [ { "$ref": "#/components/schemas/ContractsContractIdPatchResponsesContentApplicationJsonSchemaContractTemplate" }, { "type": "null" } ] }, "cost_centers": { "description": "List of cost centers associated with the contract.", "items": { "$ref": "#/components/schemas/ContractsContractIdPatchResponsesContentApplicationJsonSchemaCostCentersItems" }, "type": "array" }, "created_at": { "description": "Date and time when the contract was created.", "format": "date-time", "type": "string" }, "custom_fields": { "description": "List of custom fields attached to the contract.", "items": { "$ref": "#/components/schemas/ContractsContractIdPatchResponsesContentApplicationJsonSchemaCustomFieldsItems" }, "type": [ "array", "null" ] }, "employment_details": { "$ref": "#/components/schemas/ContractsContractIdPatchResponsesContentApplicationJsonSchemaEmploymentDetails", "description": "Employment-related details for the contract." }, "employment_type": { "description": "Type of employment.", "oneOf": [ { "$ref": "#/components/schemas/ContractsContractIdPatchResponsesContentApplicationJsonSchemaEmploymentType" }, { "type": "null" } ] }, "external_id": { "description": "External identifier of the contract.", "type": [ "string", "null" ] }, "id": { "description": "Unique identifier for the contract.", "minLength": 1, "type": "string" }, "invitations": { "$ref": "#/components/schemas/ContractsContractIdPatchResponsesContentApplicationJsonSchemaInvitations", "description": "Invitation email addresses for signing the contract." }, "is_archived": { "description": "Flag to indicate if the contract is archived.", "type": [ "boolean", "null" ] }, "job_title": { "description": "Job title associated with the contract.", "type": "string" }, "notice_period": { "description": "Notice period in days.", "format": "double", "type": [ "number", "null" ] }, "quote": { "$ref": "#/components/schemas/ContractsContractIdPatchResponsesContentApplicationJsonSchemaQuote", "description": "EOR quote approved by Deel." }, "scope_of_work": { "description": "Scope of work of the contract.", "type": [ "string", "null" ] }, "seniority": { "description": "Seniority describes level of expertise at a job e.g. junior.", "oneOf": [ { "$ref": "#/components/schemas/ContractsContractIdPatchResponsesContentApplicationJsonSchemaSeniority" }, { "type": "null" } ] }, "signatures": { "$ref": "#/components/schemas/ContractsContractIdPatchResponsesContentApplicationJsonSchemaSignatures", "description": "Signature information for the contract parties." }, "special_clause": { "description": "Special clause of the contract.", "type": [ "string", "null" ] }, "start_date": { "description": "Date and time when the contract starts.", "format": "date-time", "type": "string" }, "status": { "$ref": "#/components/schemas/ContractsContractIdPatchResponsesContentApplicationJsonSchemaStatus", "description": "Status of a contract in Deel workflow." }, "termination_date": { "description": "Date and time when the contract ends.", "type": [ "string", "null" ] }, "title": { "description": "Title of the contract.", "minLength": 1, "type": "string" }, "type": { "$ref": "#/components/schemas/ContractsContractIdPatchResponsesContentApplicationJsonSchemaType", "description": "Type of a contract." }, "updated_at": { "description": "Date and time when the contract was updated.", "format": "date-time", "type": "string" }, "who_reports": { "description": "Who reports the hours.", "type": "string" }, "work_schedule": { "description": "Defines a work schedule including working days, hours, and employment details", "oneOf": [ { "$ref": "#/components/schemas/ContractsContractIdPatchResponsesContentApplicationJsonSchemaWorkSchedule" }, { "type": "null" } ] }, "work_statement_id": { "description": "The unique identifier of the associated work statement.", "type": [ "string", "null" ] }, "worker": { "description": "Worker details associated with the contract.", "oneOf": [ { "$ref": "#/components/schemas/ContractsContractIdPatchResponsesContentApplicationJsonSchemaWorker" }, { "type": "null" } ] } }, "required": [ "id", "type", "title", "client", "status", "worker", "created_at", "signatures", "start_date", "updated_at", "invitations", "is_archived", "special_clause", "termination_date" ], "title": "contracts_updateICContract_Response_200", "type": "object" }, "cost-calculator_getEmploymentCost_Response_200": { "properties": { "additional_data": { "$ref": "#/components/schemas/EorEmploymentCostPostResponsesContentApplicationJsonSchemaAdditionalData" }, "benefits_data": { "items": { "$ref": "#/components/schemas/EorEmploymentCostPostResponsesContentApplicationJsonSchemaBenefitsDataItems" }, "type": "array" }, "costs": { "items": { "$ref": "#/components/schemas/EorEmploymentCostPostResponsesContentApplicationJsonSchemaCostsItems" }, "type": "array" }, "country": { "description": "The country where the employee is based.", "type": "string" }, "country_code": { "description": "ISO Alpha-2 code of the country.", "type": "string" }, "currency": { "description": "The currency used for cost calculation.", "type": "string" }, "deel_fee": { "description": "The Deel fee for managing the employee.", "type": "string" }, "employer_annual_costs": { "description": "Costs incurred by the employer for cost items with an annual payment frequency.", "type": "string" }, "employer_costs": { "description": "Costs incurred by the employer.", "type": "string" }, "employer_costs_usd": { "description": "Costs incurred by the employer, converted to USD.", "type": "string" }, "frequency": { "description": "Frequency of the salary payment (e.g., monthly).", "type": "string" }, "salary": { "description": "The base salary for the employee.", "type": "string" }, "severance_accural": { "description": "Severance accrual costs.", "type": "string" }, "severance_accural_usd": { "description": "Severance accrual costs, converted to USD.", "type": "string" }, "total_costs": { "description": "Total employment costs.", "type": "string" } }, "title": "cost-calculator_getEmploymentCost_Response_200", "type": "object" }, "cost-centers_getLegalEntityCostCenters_Response_200": { "properties": { "data": { "items": { "$ref": "#/components/schemas/LegalEntitiesLegalEntityIdCostCentersGetResponsesContentApplicationJsonSchemaDataItems" }, "type": "array" } }, "title": "cost-centers_getLegalEntityCostCenters_Response_200", "type": "object" }, "custom-fields-contracts_getContractCustomFields_Response_200": { "properties": { "data": { "items": { "$ref": "#/components/schemas/ContractsContractIdCustomFieldsGetResponsesContentApplicationJsonSchemaDataItems" }, "type": "array" } }, "required": [ "data" ], "title": "custom-fields-contracts_getContractCustomFields_Response_200", "type": "object" }, "custom-fields-contracts_getCustomField_Response_200": { "description": "Response wrapper object", "properties": { "data": { "$ref": "#/components/schemas/ContractsCustomFieldsIdGetResponsesContentApplicationJsonSchemaData", "description": "Custom field object" } }, "required": [ "data" ], "title": "custom-fields-contracts_getCustomField_Response_200", "type": "object" }, "custom-fields-contracts_listContractCustomFields_Response_200": { "properties": { "data": { "items": { "$ref": "#/components/schemas/ContractsCustomFieldsGetResponsesContentApplicationJsonSchemaDataItems" }, "type": "array" } }, "required": [ "data" ], "title": "custom-fields-contracts_listContractCustomFields_Response_200", "type": "object" }, "custom-fields-contracts_putContractCustomField_Response_200": { "description": "Empty response body", "properties": {}, "title": "custom-fields-contracts_putContractCustomField_Response_200", "type": "object" }, "custom-fields-people_getCustomFields_Response_200": { "properties": { "data": { "items": { "$ref": "#/components/schemas/PeopleCustomFieldsGetResponsesContentApplicationJsonSchemaDataItems" }, "type": "array" } }, "required": [ "data" ], "title": "custom-fields-people_getCustomFields_Response_200", "type": "object" }, "custom-fields-people_getPersonCustomField_Response_200": { "properties": { "data": { "$ref": "#/components/schemas/PeopleCustomFieldsIdGetResponsesContentApplicationJsonSchemaData" } }, "required": [ "data" ], "title": "custom-fields-people_getPersonCustomField_Response_200", "type": "object" }, "custom-fields-people_getPersonCustomFields_Response_200": { "properties": { "data": { "items": { "$ref": "#/components/schemas/PeopleWorkerIdCustomFieldsGetResponsesContentApplicationJsonSchemaDataItems" }, "type": "array" } }, "required": [ "data" ], "title": "custom-fields-people_getPersonCustomFields_Response_200", "type": "object" }, "custom-fields-people_putPersonCustomField_Response_200": { "description": "Empty response body", "properties": {}, "title": "custom-fields-people_putPersonCustomField_Response_200", "type": "object" }, "eor-amendments_acceptContractAmendment_Response_200": { "properties": { "data": { "$ref": "#/components/schemas/EorContractsContractIdAmendmentsAmendmentIdAcceptPostResponsesContentApplicationJsonSchemaData" } }, "title": "eor-amendments_acceptContractAmendment_Response_200", "type": "object" }, "eor-amendments_confirmContractAmendment_Response_200": { "properties": { "data": { "$ref": "#/components/schemas/EorContractsContractIdAmendmentsAmendmentIdConfirmPostResponsesContentApplicationJsonSchemaData" } }, "title": "eor-amendments_confirmContractAmendment_Response_200", "type": "object" }, "eor-amendments_createContractAmendment_Response_201": { "properties": { "data": { "$ref": "#/components/schemas/EorContractsContractIdAmendmentsPostResponsesContentApplicationJsonSchemaData" } }, "title": "eor-amendments_createContractAmendment_Response_201", "type": "object" }, "eor-amendments_deleteContractAmendment_Response_200": { "properties": { "data": { "$ref": "#/components/schemas/EorContractsContractIdAmendmentsAmendmentIdDeleteResponsesContentApplicationJsonSchemaData" } }, "required": [ "data" ], "title": "eor-amendments_deleteContractAmendment_Response_200", "type": "object" }, "eor-amendments_getContractAmendmentById_Response_200": { "properties": { "data": { "$ref": "#/components/schemas/EorContractsContractIdAmendmentsAmendmentIdGetResponsesContentApplicationJsonSchemaData" } }, "title": "eor-amendments_getContractAmendmentById_Response_200", "type": "object" }, "eor-amendments_getContractAmendmentEffectiveDateLimitations_Response_200": { "properties": { "data": { "$ref": "#/components/schemas/EorContractsContractIdAmendmentsAmendmentIdEffectiveDateLimitationsGetResponsesContentApplicationJsonSchemaData" } }, "title": "eor-amendments_getContractAmendmentEffectiveDateLimitations_Response_200", "type": "object" }, "eor-amendments_getContractAmendmentPdf_Response_200": { "properties": { "data": { "$ref": "#/components/schemas/EorContractsContractIdAmendmentsAmendmentIdPdfGetResponsesContentApplicationJsonSchemaData" } }, "title": "eor-amendments_getContractAmendmentPdf_Response_200", "type": "object" }, "eor-amendments_getContractAmendmentsValidationSettings_Response_200": { "properties": { "data": { "items": { "$ref": "#/components/schemas/EorContractsContractIdAmendmentsValidationSettingsGetResponsesContentApplicationJsonSchemaDataItems" }, "type": "array" } }, "title": "eor-amendments_getContractAmendmentsValidationSettings_Response_200", "type": "object" }, "eor-amendments_getContractAmendments_Response_200": { "properties": { "data": { "items": { "$ref": "#/components/schemas/EorContractsContractIdAmendmentsGetResponsesContentApplicationJsonSchemaDataItems" }, "type": "array" } }, "title": "eor-amendments_getContractAmendments_Response_200", "type": "object" }, "eor-amendments_signEORAmendment_Response_200": { "properties": { "data": { "$ref": "#/components/schemas/EorContractsContractIdAmendmentsAmendmentIdSignPostResponsesContentApplicationJsonSchemaData" } }, "title": "eor-amendments_signEORAmendment_Response_200", "type": "object" }, "eor-amendments_updateContractAmendment_Response_200": { "properties": { "data": { "$ref": "#/components/schemas/EorContractsContractIdAmendmentsAmendmentIdPatchResponsesContentApplicationJsonSchemaData" } }, "title": "eor-amendments_updateContractAmendment_Response_200", "type": "object" }, "eor-amendments_validateEORAmendments_Response_200": { "properties": { "data": { "additionalProperties": { "$ref": "#/components/schemas/EorContractsContractIdAmendmentsValidatePostResponsesContentApplicationJsonSchemaData" }, "description": "Validation results keyed by amendment field", "type": "object" } }, "title": "eor-amendments_validateEORAmendments_Response_200", "type": "object" }, "eor-benefits_getEORBenefitsByContractId_Response_200": { "properties": { "data": { "items": { "$ref": "#/components/schemas/EorContractIdBenefitsGetResponsesContentApplicationJsonSchemaDataItems" }, "type": "array" }, "worker_benefits_link": { "$ref": "#/components/schemas/EorContractIdBenefitsGetResponsesContentApplicationJsonSchemaWorkerBenefitsLink", "description": "Short-lived link where the worker completes their benefits enrolment and manages their benefits. Only returned for organisations set up as white-label with Deel, whose workers don't use the Deel app. Redirect the worker to it from your app; call this endpoint again for a new link after expires_at. Don't store, email or share it." } }, "title": "eor-benefits_getEORBenefitsByContractId_Response_200", "type": "object" }, "eor-contract-documents_getEORContractDocuments_Response_200": { "properties": { "data": { "items": { "$ref": "#/components/schemas/EorContractsContractIdDocumentsGetResponsesContentApplicationJsonSchemaDataItems" }, "type": "array" } }, "required": [ "data" ], "title": "eor-contract-documents_getEORContractDocuments_Response_200", "type": "object" }, "eor-contract_createEORContract_Response_201": { "properties": { "data": { "$ref": "#/components/schemas/EorPostResponsesContentApplicationJsonSchemaData" } }, "title": "eor-contract_createEORContract_Response_201", "type": "object" }, "eor-contract_getEORContractDetails_Response_200": { "properties": { "calculated_holidays": { "description": "Calculated number of holidays as a string.", "type": [ "string", "null" ] }, "can_adjust_on": { "description": "Time frame when adjustments can be made.", "oneOf": [ { "$ref": "#/components/schemas/EorContractsContractIdDetailsGetResponsesContentApplicationJsonSchemaCanAdjustOn" }, { "type": "null" } ] }, "can_remind_employee_to_sign": { "description": "Whether reminders to sign the employee resignation can be sent to the employee or not.", "type": "boolean" }, "cancelled_at": { "description": "The date and time when the contract was cancelled.", "format": "date-time", "type": [ "string", "null" ] }, "client_signature": { "description": "The signature of the client.", "type": [ "string", "null" ] }, "client_signed_at": { "description": "The date and time when the client signed the contract.", "format": "date-time", "type": [ "string", "null" ] }, "compensation_type": { "description": "Compensation type for the contract.", "oneOf": [ { "$ref": "#/components/schemas/EorContractsContractIdDetailsGetResponsesContentApplicationJsonSchemaCompensationType" }, { "type": "null" } ] }, "completed_at": { "description": "The date and time when the contract was completed.", "format": "date-time", "type": [ "string", "null" ] }, "completion_date": { "description": "The completion date of the contract.", "format": "date-time", "type": [ "string", "null" ] }, "completion_plain_date": { "description": "The completion date of the contract in plain contract.", "format": "date", "type": [ "string", "null" ] }, "contract_type": { "$ref": "#/components/schemas/EorContractsContractIdDetailsGetResponsesContentApplicationJsonSchemaContractType", "description": "The type of contract." }, "contractor_signature": { "description": "The signature of the EOR entity representative.", "type": [ "string", "null" ] }, "contractor_signed_at": { "description": "The date and time when the contractor signed the contract.", "format": "date-time", "type": [ "string", "null" ] }, "created_at": { "description": "The date and time when the contract was created.", "format": "date-time", "type": "string" }, "creator": { "$ref": "#/components/schemas/EorContractsContractIdDetailsGetResponsesContentApplicationJsonSchemaCreator" }, "currency": { "description": "The currency used in the contract.", "type": "string" }, "deposit_months": { "description": "Number of deposit months required.", "type": [ "string", "null" ] }, "description": { "description": "Contract description", "type": "string" }, "effective_date": { "description": "The date and time when the contract is effective.", "format": "date-time", "type": "string" }, "effective_plain_date": { "description": "The effective date in plain format.", "format": "date", "type": "string" }, "employee": { "$ref": "#/components/schemas/EorContractsContractIdDetailsGetResponsesContentApplicationJsonSchemaEmployee", "description": "Employee details" }, "employee_late_sign_start": { "description": "Date when employee signed late, if applicable.", "format": "date-time", "type": [ "string", "null" ] }, "employee_signed_at": { "description": "Date and time when the employee signed.", "format": "date-time", "type": [ "string", "null" ] }, "employment_costs": { "description": "Detailed breakdown of employment costs including summary totals, sectioned cost groups, and additional context notes.", "oneOf": [ { "$ref": "#/components/schemas/EorContractsContractIdDetailsGetResponsesContentApplicationJsonSchemaEmploymentCosts" }, { "type": "null" } ] }, "employment_country": { "description": "Two letter country code of the employment country.", "type": "string" }, "employment_state": { "description": "The state of the employment.", "type": [ "string", "null" ] }, "employment_type": { "$ref": "#/components/schemas/EorContractsContractIdDetailsGetResponsesContentApplicationJsonSchemaEmploymentType", "description": "The type of employment." }, "end_date": { "description": "The end date of the contract, if applicable.", "format": "date-time", "type": [ "string", "null" ] }, "fixed_adjustment_ids": { "description": "List of fixed adjustment ids.", "items": { "type": "string" }, "type": [ "array", "null" ] }, "hiring_objective": { "description": "Information about the hiring objective.", "oneOf": [ { "$ref": "#/components/schemas/EorContractsContractIdDetailsGetResponsesContentApplicationJsonSchemaHiringObjective" }, { "type": "null" } ] }, "holidays": { "description": "Number of holidays for the contract.", "type": [ "integer", "null" ] }, "hourly_rate": { "description": "Hourly rate as a string to preserve decimal precision.", "type": [ "string", "null" ] }, "hris_profile_id": { "description": "The HRIS profile ID linked to this contract.", "format": "uuid", "type": [ "string", "null" ] }, "id": { "description": "The unique identifier for the Deel contract.", "type": "string" }, "initial_effective_plain_date": { "description": "The initial effective date in plain format.", "format": "date", "type": "string" }, "invited_client_email": { "description": "The email address of the invited client.", "type": [ "string", "null" ] }, "is_early_invoice_enabled": { "description": "Whether early invoicing is enabled or not.", "type": "boolean" }, "is_employee_onboarding_delayed": { "description": "Determines if the invite for employee onboarding should be dispatch manually.", "type": "boolean" }, "is_foreign_currency_contract": { "description": "Whether the contract uses foreign currency or not.", "type": "boolean" }, "is_onboarding_on_hold": { "description": "Whether onboarding is currently on hold or not.", "type": "boolean" }, "job_title_name": { "description": "The contract's job title.", "type": [ "string", "null" ] }, "last_quote_rejection": { "description": "Timestamp of last quote rejection.", "oneOf": [ { "$ref": "#/components/schemas/EorContractsContractIdDetailsGetResponsesContentApplicationJsonSchemaLastQuoteRejection" }, { "type": "null" } ] }, "monthly_employer_cost": { "description": "Monthly cost to the employer.", "type": "string" }, "monthly_eor_management_fee_usd": { "description": "Monthly EOR management fee in USD.", "type": "string" }, "name": { "description": "Contract name", "type": "string" }, "notice_period_type": { "description": "Type of notice period if applicable.", "oneOf": [ { "$ref": "#/components/schemas/EorContractsContractIdDetailsGetResponsesContentApplicationJsonSchemaNoticePeriodType" }, { "type": "null" } ] }, "onboarding_step_duration": { "description": "Duration of onboarding steps in days.", "type": [ "integer", "null" ] }, "original_start_date": { "description": "The originally planned start date.", "format": "date-time", "type": "string" }, "payroll_type": { "$ref": "#/components/schemas/EorContractsContractIdDetailsGetResponsesContentApplicationJsonSchemaPayrollType", "description": "Payroll frequency for the contract" }, "probation_period": { "description": "Number of days in the probation period.", "type": "integer" }, "probation_period_type_for_definite": { "description": "Probation period type for definite contracts.", "oneOf": [ { "$ref": "#/components/schemas/EorContractsContractIdDetailsGetResponsesContentApplicationJsonSchemaProbationPeriodTypeForDefinite" }, { "type": "null" } ] }, "salary": { "description": "Annual salary as a string to preserve decimal precision.", "type": "string" }, "scope_of_work": { "description": "Description of job scope and responsibilities.", "type": "string" }, "seniority": { "$ref": "#/components/schemas/EorContractsContractIdDetailsGetResponsesContentApplicationJsonSchemaSeniority" }, "sick_days": { "$ref": "#/components/schemas/EorContractsContractIdDetailsGetResponsesContentApplicationJsonSchemaSickDays", "description": "Allowed sick days range." }, "signed_date": { "description": "The date and time when the contract was signed by both parties.", "format": "date-time", "type": [ "string", "null" ] }, "signing_bonus": { "description": "One-time bonus paid at contract sign.", "type": [ "string", "null" ] }, "signing_bonus_payout_type": { "description": "Defines when the signing bonus is paid. Set only when signing_bonus is present.", "oneOf": [ { "$ref": "#/components/schemas/EorContractsContractIdDetailsGetResponsesContentApplicationJsonSchemaSigningBonusPayoutType" }, { "type": "null" } ] }, "start_date": { "description": "The start date of the contract.", "format": "date-time", "type": "string" }, "status": { "$ref": "#/components/schemas/EorContractsContractIdDetailsGetResponsesContentApplicationJsonSchemaStatus", "description": "The current status of the contract." }, "team": { "$ref": "#/components/schemas/EorContractsContractIdDetailsGetResponsesContentApplicationJsonSchemaTeam" }, "time_off_type": { "$ref": "#/components/schemas/EorContractsContractIdDetailsGetResponsesContentApplicationJsonSchemaTimeOffType", "description": "Type of time off policy." }, "timezone": { "description": "The timezone of the contract.", "type": "string" }, "updated_at": { "description": "The date and time when the contract was last updated.", "format": "date-time", "type": "string" }, "variable_compensation_ids": { "description": "List of variable compensation IDs.", "items": { "type": "string" }, "type": "array" }, "work_arrangement_type": { "description": "Work arrangement type of the EOR contract (Deel Field Solutions classification). Null if unclassified.", "oneOf": [ { "$ref": "#/components/schemas/EorContractsContractIdDetailsGetResponsesContentApplicationJsonSchemaWorkArrangementType" }, { "type": "null" } ] }, "work_hours_per_week": { "description": "Number of work hours per week.", "type": "string" }, "work_schedule_assignment_settings": { "$ref": "#/components/schemas/EorContractsContractIdDetailsGetResponsesContentApplicationJsonSchemaWorkScheduleAssignmentSettings", "description": "Work schedule assignment setting." }, "work_visa": { "description": "Indicates if a work visa is required.", "type": "boolean" } }, "title": "eor-contract_getEORContractDetails_Response_200", "type": "object" }, "eor-contract_updateEORContract_Response_200": { "properties": { "oid": { "description": "The unique identifier of the employee contract.", "type": "string" }, "scope_of_work": { "description": "Scope of work description.", "type": "string" }, "status": { "$ref": "#/components/schemas/EorContractContractIdPatchResponsesContentApplicationJsonSchemaStatus", "description": "Current status of the contract" } }, "required": [ "oid", "status" ], "title": "eor-contract_updateEORContract_Response_200", "type": "object" }, "eor-hiring_delayOnboarding_Response_200": { "properties": { "contractOid": { "description": "Contract OID", "type": "string" }, "is_employee_onboarding_delayed": { "description": "Current onboarding delay status", "type": "boolean" }, "success": { "description": "Operation success status", "type": "boolean" } }, "required": [ "success" ], "title": "eor-hiring_delayOnboarding_Response_200", "type": "object" }, "eor-hiring_getAdditionalCosts_Response_200": { "properties": { "data": { "$ref": "#/components/schemas/EorAdditionalCostsCountryGetResponsesContentApplicationJsonSchemaData" } }, "title": "eor-hiring_getAdditionalCosts_Response_200", "type": "object" }, "eor-hiring_getBenefits_Response_200": { "properties": { "data": { "items": { "$ref": "#/components/schemas/EorBenefitsGetResponsesContentApplicationJsonSchemaDataItems" }, "type": "array" } }, "required": [ "data" ], "title": "eor-hiring_getBenefits_Response_200", "type": "object" }, "eor-hiring_getCreateContractForm_Response_200": { "properties": { "data": { "$ref": "#/components/schemas/FormsEorCreateContractCountryCodeGetResponsesContentApplicationJsonSchemaData" } }, "required": [ "data" ], "title": "eor-hiring_getCreateContractForm_Response_200", "type": "object" }, "eor-hiring_getEORHiringGuideByCountry_Response_200": { "properties": { "data": { "$ref": "#/components/schemas/EorValidationsCountryCodeGetResponsesContentApplicationJsonSchemaData" } }, "title": "eor-hiring_getEORHiringGuideByCountry_Response_200", "type": "object" }, "eor-hiring_getStartDate_Response_200": { "properties": { "data": { "$ref": "#/components/schemas/EorStartDateGetResponsesContentApplicationJsonSchemaData" } }, "required": [ "data" ], "title": "eor-hiring_getStartDate_Response_200", "type": "object" }, "eor-hiring_signContractDocument_Response_200": { "properties": { "data": { "$ref": "#/components/schemas/EorContractsContractIdDocumentsTypeSignPostResponsesContentApplicationJsonSchemaData" } }, "required": [ "data" ], "title": "eor-hiring_signContractDocument_Response_200", "type": "object" }, "eor-hiring_updateContractEmployeeInformation_Response_200": { "properties": { "data": { "$ref": "#/components/schemas/EorContractsContractIdEmployeeInformationPatchResponsesContentApplicationJsonSchemaData" } }, "title": "eor-hiring_updateContractEmployeeInformation_Response_200", "type": "object" }, "eor-job-scopes_validateJobScope_Response_200": { "properties": { "data_for_corrected_job_scope_endpoint": { "$ref": "#/components/schemas/EorJobScopesValidatePostResponsesContentApplicationJsonSchemaDataForCorrectedJobScopeEndpoint", "description": "Data for corrected job scope endpoint." }, "errors": { "description": "List of validation errors, if empty the validation was successfully.", "items": { "$ref": "#/components/schemas/EorJobScopesValidatePostResponsesContentApplicationJsonSchemaErrorsItems" }, "type": "array" }, "quote_validation_log_public_id": { "description": "Id from validation request.", "type": "string" } }, "title": "eor-job-scopes_validateJobScope_Response_200", "type": "object" }, "eor-offboarding_createEOROffboardingClientSignOff_Response_200": { "properties": { "data": { "$ref": "#/components/schemas/EorContractsContractIdOffboardingReviewClientSignOffsPostResponsesContentApplicationJsonSchemaData" } }, "required": [ "data" ], "title": "eor-offboarding_createEOROffboardingClientSignOff_Response_200", "type": "object" }, "eor-offboarding_getContractOffboardingRestrictedDates_Response_200": { "properties": { "data": { "$ref": "#/components/schemas/EorContractsContractIdOffboardingRestrictedDatesGetResponsesContentApplicationJsonSchemaData" } }, "required": [ "data" ], "title": "eor-offboarding_getContractOffboardingRestrictedDates_Response_200", "type": "object" }, "eor-offboarding_getContractOffboardingTimeOffs_Response_200": { "properties": { "data": { "$ref": "#/components/schemas/EorContractsContractIdOffboardingTimeOffsGetResponsesContentApplicationJsonSchemaData" } }, "required": [ "data" ], "title": "eor-offboarding_getContractOffboardingTimeOffs_Response_200", "type": "object" }, "eor-offboarding_getContractOffboarding_Response_200": { "properties": { "data": { "$ref": "#/components/schemas/EorContractsContractIdOffboardingGetResponsesContentApplicationJsonSchemaData" } }, "required": [ "data" ], "title": "eor-offboarding_getContractOffboarding_Response_200", "type": "object" }, "eor-offboarding_getEORContractOffboardingRequiredInformation_Response_200": { "properties": { "data": { "$ref": "#/components/schemas/EorContractsContractIdOffboardingRequiredInformationGetResponsesContentApplicationJsonSchemaData", "description": "Specifies the text of additional questions that the client must answer when requesting a termination" } }, "required": [ "data" ], "title": "eor-offboarding_getEORContractOffboardingRequiredInformation_Response_200", "type": "object" }, "eor-offboarding_reviewEOROffboardingEmployeeSignOffs_Response_200": { "properties": { "data": { "$ref": "#/components/schemas/EorContractsContractIdOffboardingReviewEmployeeSignOffsPostResponsesContentApplicationJsonSchemaData" } }, "required": [ "data" ], "title": "eor-offboarding_reviewEOROffboardingEmployeeSignOffs_Response_200", "type": "object" }, "eor-offboarding_reviewEOROffboardingPTO_Response_201": { "properties": { "data": { "$ref": "#/components/schemas/EorContractsContractIdOffboardingResignationsReviewPtoPostResponsesContentApplicationJsonSchemaData" } }, "required": [ "data" ], "title": "eor-offboarding_reviewEOROffboardingPTO_Response_201", "type": "object" }, "eor-payslips_getWorkerPayslips_Response_200": { "properties": { "data": { "items": { "$ref": "#/components/schemas/EorWorkersWorkerIdPayslipsGetResponsesContentApplicationJsonSchemaDataItems" }, "type": "array" } }, "required": [ "data" ], "title": "eor-payslips_getWorkerPayslips_Response_200", "type": "object" }, "eor-project-assignment_getProjectAssignmentCheckin_Response_200": { "properties": { "data": { "$ref": "#/components/schemas/EorContractsContractIdProjectAssignmentCheckinGetResponsesContentApplicationJsonSchemaData" } }, "required": [ "data" ], "title": "eor-project-assignment_getProjectAssignmentCheckin_Response_200", "type": "object" }, "eor-terminations_createOffboardingTermination_Response_201": { "properties": { "data": { "$ref": "#/components/schemas/EorContractsContractIdOffboardingTerminationPostResponsesContentApplicationJsonSchemaData" } }, "required": [ "data" ], "title": "eor-terminations_createOffboardingTermination_Response_201", "type": "object" }, "eor-terminations_createRegularTermination_Response_200": { "properties": { "contract_id": { "description": "Public contract oid", "type": "string" }, "desired_end_date": { "description": "The desired end date. If the date is not provided, it will be selected by HRX the closest date possible", "format": "date-time", "type": [ "string", "null" ] }, "end_date": { "description": "The definitive contract end date", "format": "date-time", "type": [ "string", "null" ] }, "id": { "title": "float", "type": "string" }, "request_data": { "oneOf": [ { "$ref": "#/components/schemas/EorOidTerminationsRegularPostResponsesContentApplicationJsonSchemaRequestData" }, { "type": "null" } ] } }, "title": "eor-terminations_createRegularTermination_Response_200", "type": "object" }, "eor-terminations_createResignation_Response_200": { "properties": { "data": { "$ref": "#/components/schemas/EorOidTerminationsResignationPostResponsesContentApplicationJsonSchemaData" } }, "required": [ "data" ], "title": "eor-terminations_createResignation_Response_200", "type": "object" }, "eor-terminations_getTermination_Response_200": { "properties": { "contract_id": { "description": "Public contract oid", "type": "string" }, "desired_end_date": { "description": "The desired end date. If the date is not provided, it will be selected by HRX the closest date possible", "format": "date-time", "type": [ "string", "null" ] }, "end_date": { "description": "The definitive contract end date", "format": "date-time", "type": [ "string", "null" ] }, "id": { "title": "float", "type": "string" }, "request_data": { "oneOf": [ { "$ref": "#/components/schemas/EorOidTerminationsTerminationIdGetResponsesContentApplicationJsonSchemaRequestData" }, { "type": "null" } ] } }, "title": "eor-terminations_getTermination_Response_200", "type": "object" }, "eor-worker-accounts_createWorker_Response_201": { "properties": { "data": { "$ref": "#/components/schemas/EorWorkerPostResponsesContentApplicationJsonSchemaData" } }, "required": [ "data" ], "title": "eor-worker-accounts_createWorker_Response_201", "type": "object" }, "eor-worker-agreements_downloadWorkerEmployeeAgreement_Response_200": { "properties": { "data": { "$ref": "#/components/schemas/EorWorkersContractsContractIdEmployeeAgreementDownloadGetResponsesContentApplicationJsonSchemaData" } }, "required": [ "data" ], "title": "eor-worker-agreements_downloadWorkerEmployeeAgreement_Response_200", "type": "object" }, "eor-worker-agreements_signEORContractAsWorker_Response_201": { "properties": { "data": { "$ref": "#/components/schemas/EorWorkersContractsContractIdSignaturesPostResponsesContentApplicationJsonSchemaData" } }, "required": [ "data" ], "title": "eor-worker-agreements_signEORContractAsWorker_Response_201", "type": "object" }, "eor-worker-banks_getEORWorkerBankGuideByCountryAndCurrency_Response_200": { "properties": { "data": { "items": { "$ref": "#/components/schemas/EorWorkersBanksGuideCountryCountryCurrencyCurrencyGetResponsesContentApplicationJsonSchemaDataItems" }, "type": "array" } }, "required": [ "data" ], "title": "eor-worker-banks_getEORWorkerBankGuideByCountryAndCurrency_Response_200", "type": "object" }, "eor-worker-banks_getEORWorkerBankGuide_Response_200": { "properties": { "data": { "items": { "$ref": "#/components/schemas/EorWorkersBanksGuideGetResponsesContentApplicationJsonSchemaDataItems" }, "type": "array" } }, "required": [ "data" ], "title": "eor-worker-banks_getEORWorkerBankGuide_Response_200", "type": "object" }, "eor-worker-benefits_getEORWorkerBenefits_Response_200": { "properties": { "data": { "description": "List of contracts with their associated benefits. An employee may have benefits across multiple contracts if they have more than one active engagement.", "items": { "$ref": "#/components/schemas/EorWorkerBenefitsGetResponsesContentApplicationJsonSchemaDataItems" }, "type": "array" } }, "required": [ "data" ], "title": "eor-worker-benefits_getEORWorkerBenefits_Response_200", "type": "object" }, "eor-worker-compliance_downloadComplianceDocumentTemplate_Response_200": { "properties": { "data": { "$ref": "#/components/schemas/EorWorkersComplianceDocumentsDocumentIdTemplatesDownloadGetResponsesContentApplicationJsonSchemaData" } }, "required": [ "data" ], "title": "eor-worker-compliance_downloadComplianceDocumentTemplate_Response_200", "type": "object" }, "eor-worker-compliance_downloadComplianceDocument_Response_200": { "properties": { "data": { "$ref": "#/components/schemas/EorWorkersComplianceDocumentsDocumentIdDownloadGetResponsesContentApplicationJsonSchemaData" } }, "required": [ "data" ], "title": "eor-worker-compliance_downloadComplianceDocument_Response_200", "type": "object" }, "eor-worker-compliance_getEORWorkerComplianceDocuments_Response_200": { "properties": { "data": { "$ref": "#/components/schemas/EorWorkersComplianceDocumentsGetResponsesContentApplicationJsonSchemaData" } }, "required": [ "data" ], "title": "eor-worker-compliance_getEORWorkerComplianceDocuments_Response_200", "type": "object" }, "eor-worker-compliance_uploadEORWorkerComplianceDocument_Response_200": { "properties": { "data": { "$ref": "#/components/schemas/EorWorkersComplianceDocumentsDocumentIdPostResponsesContentApplicationJsonSchemaData" } }, "required": [ "data" ], "title": "eor-worker-compliance_uploadEORWorkerComplianceDocument_Response_200", "type": "object" }, "eor-worker-documents_getEORWorkerHRDocuments_Response_200": { "properties": { "data": { "items": { "$ref": "#/components/schemas/EorWorkersContractsContractIdHrDocumentsGetResponsesContentApplicationJsonSchemaDataItems" }, "type": "array" } }, "required": [ "data" ], "title": "eor-worker-documents_getEORWorkerHRDocuments_Response_200", "type": "object" }, "eor-worker-information_createEORWorkerBankAccount_Response_201": { "properties": { "data": { "$ref": "#/components/schemas/EorWorkersBanksPostResponsesContentApplicationJsonSchemaData" } }, "required": [ "data" ], "title": "eor-worker-information_createEORWorkerBankAccount_Response_201", "type": "object" }, "eor-worker-information_createGPWorkerAdditionalInformation_Response_200": { "properties": { "data": { "$ref": "#/components/schemas/EorWorkersContractsContractIdAdditionalInformationPostResponsesContentApplicationJsonSchemaData" } }, "required": [ "data" ], "title": "eor-worker-information_createGPWorkerAdditionalInformation_Response_200", "type": "object" }, "eor-worker-information_getEORWorkerTaxDocuments_Response_200": { "properties": { "data": { "items": { "$ref": "#/components/schemas/EorWorkersTaxDocumentsGetResponsesContentApplicationJsonSchemaDataItems" }, "type": "array" } }, "required": [ "data" ], "title": "eor-worker-information_getEORWorkerTaxDocuments_Response_200", "type": "object" }, "eor-worker-information_updateEORWorkerAdditionalInformation_Response_200": { "properties": { "data": { "$ref": "#/components/schemas/EorWorkersContractsContractIdAdditionalInformationPatchResponsesContentApplicationJsonSchemaData" } }, "required": [ "data" ], "title": "eor-worker-information_updateEORWorkerAdditionalInformation_Response_200", "type": "object" }, "eor-worker-offboarding_createEmployeeResignation_Response_201": { "properties": { "data": { "$ref": "#/components/schemas/EorContractsContractIdOffboardingResignationPostResponsesContentApplicationJsonSchemaData" } }, "required": [ "data" ], "title": "eor-worker-offboarding_createEmployeeResignation_Response_201", "type": "object" }, "eor-worker-offboarding_getEmployeeResignations_Response_200": { "properties": { "data": { "items": { "$ref": "#/components/schemas/EorWorkersResignationsGetResponsesContentApplicationJsonSchemaDataItems" }, "type": "array" } }, "required": [ "data" ], "title": "eor-worker-offboarding_getEmployeeResignations_Response_200", "type": "object" }, "eor-worker-offboarding_signEmployeeResignationLetter_Response_201": { "properties": { "data": { "$ref": "#/components/schemas/EorWorkersContractsContractIdOffboardingResignationLetterSignPostResponsesContentApplicationJsonSchemaData" } }, "required": [ "data" ], "title": "eor-worker-offboarding_signEmployeeResignationLetter_Response_201", "type": "object" }, "eor-worker-offboarding_submitEORWorkerResignation_Response_201": { "properties": { "data": { "$ref": "#/components/schemas/EorWorkersContractsContractIdOffboardingPostResponsesContentApplicationJsonSchemaData" } }, "required": [ "data" ], "title": "eor-worker-offboarding_submitEORWorkerResignation_Response_201", "type": "object" }, "eor-worker-payslips_getWorkerPayslipsDownload_Response_200": { "properties": { "data": { "$ref": "#/components/schemas/EorWorkersWorkerIdPayslipsPayslipIdDownloadGetResponsesContentApplicationJsonSchemaData" } }, "required": [ "data" ], "title": "eor-worker-payslips_getWorkerPayslipsDownload_Response_200", "type": "object" }, "gp-hiring_createGPContract_Response_201": { "properties": { "data": { "$ref": "#/components/schemas/ContractsGpPostResponsesContentApplicationJsonSchemaData" } }, "required": [ "data" ], "title": "gp-hiring_createGPContract_Response_201", "type": "object" }, "gp-hiring_createGPWorkerTermination_Response_201": { "properties": { "data": { "$ref": "#/components/schemas/GpWorkersWorkerIdTerminationsPostResponsesContentApplicationJsonSchemaData" } }, "required": [ "data" ], "title": "gp-hiring_createGPWorkerTermination_Response_201", "type": "object" }, "groups_cloneGroup_Response_201": { "properties": { "data": { "$ref": "#/components/schemas/GroupsIdClonePostResponsesContentApplicationJsonSchemaData" } }, "title": "groups_cloneGroup_Response_201", "type": "object" }, "groups_createGroup_Response_200": { "properties": { "data": { "$ref": "#/components/schemas/GroupsPostResponsesContentApplicationJsonSchemaData" } }, "title": "groups_createGroup_Response_200", "type": "object" }, "groups_deleteGroup_Response_200": { "properties": { "data": { "$ref": "#/components/schemas/GroupsIdDeleteResponsesContentApplicationJsonSchemaData" } }, "title": "groups_deleteGroup_Response_200", "type": "object" }, "groups_getGroups_Response_200": { "properties": { "data": { "items": { "$ref": "#/components/schemas/GroupsGetResponsesContentApplicationJsonSchemaDataItems" }, "type": "array" }, "page": { "$ref": "#/components/schemas/GroupsGetResponsesContentApplicationJsonSchemaPage" } }, "title": "groups_getGroups_Response_200", "type": "object" }, "groups_updateGroup_Response_200": { "properties": { "data": { "$ref": "#/components/schemas/GroupsIdPatchResponsesContentApplicationJsonSchemaData" } }, "title": "groups_updateGroup_Response_200", "type": "object" }, "immigration_createClientCase_Response_201": { "properties": { "data": { "$ref": "#/components/schemas/ImmigrationClientCasesPostResponsesContentApplicationJsonSchemaData", "description": "The immigration case data returned after successful creation" } }, "required": [ "data" ], "title": "immigration_createClientCase_Response_201", "type": "object" }, "immigration_createWorkerCaseRequiredDocument_Response_201": { "properties": { "data": { "$ref": "#/components/schemas/ImmigrationWorkersWorkerIdCasesCaseIdRequiredDocumentDocumentRequestIdPostResponsesContentApplicationJsonSchemaData" } }, "title": "immigration_createWorkerCaseRequiredDocument_Response_201", "type": "object" }, "immigration_getBusinessVisaRequirement_Response_200": { "properties": { "data": { "$ref": "#/components/schemas/ImmigrationVisaRequirementBusinessGetResponsesContentApplicationJsonSchemaData" } }, "required": [ "data" ], "title": "immigration_getBusinessVisaRequirement_Response_200", "type": "object" }, "immigration_getClientCase_Response_200": { "properties": { "data": { "$ref": "#/components/schemas/ImmigrationClientCasesIdGetResponsesContentApplicationJsonSchemaData" } }, "title": "immigration_getClientCase_Response_200", "type": "object" }, "immigration_getClientCases_Response_200": { "properties": { "data": { "description": "List of cases in the current page.", "items": { "$ref": "#/components/schemas/ImmigrationClientCasesGetResponsesContentApplicationJsonSchemaDataItems" }, "type": "array" }, "has_more": { "description": "Indicates whether more results are available for pagination.", "type": "boolean" }, "next_cursor": { "description": "Cursor value to be used for fetching the next page of results.", "type": [ "string", "null" ] }, "total_count": { "description": "Total number of cases matching the search criteria.", "type": "integer" } }, "required": [ "data", "has_more", "total_count" ], "title": "immigration_getClientCases_Response_200", "type": "object" }, "immigration_getDocument_Response_200": { "properties": { "data": { "$ref": "#/components/schemas/ImmigrationDocumentsIdGetResponsesContentApplicationJsonSchemaData" } }, "title": "immigration_getDocument_Response_200", "type": "object" }, "immigration_getVisaTypes_Response_200": { "properties": { "data": { "items": { "$ref": "#/components/schemas/ImmigrationVisaTypesCountryCodeGetResponsesContentApplicationJsonSchemaDataItems" }, "type": "array" } }, "title": "immigration_getVisaTypes_Response_200", "type": "object" }, "immigration_getWorkerCaseRequiredDocument_Response_200": { "properties": { "data": { "$ref": "#/components/schemas/ImmigrationWorkersWorkerIdCasesCaseIdRequiredDocumentGetResponsesContentApplicationJsonSchemaData" } }, "title": "immigration_getWorkerCaseRequiredDocument_Response_200", "type": "object" }, "immigration_getWorkerCase_Response_200": { "properties": { "data": { "$ref": "#/components/schemas/ImmigrationWorkersCasesCaseIdGetResponsesContentApplicationJsonSchemaData" } }, "title": "immigration_getWorkerCase_Response_200", "type": "object" }, "immigration_getWorkerCases_Response_200": { "properties": { "data": { "description": "List of cases in the current page.", "items": { "$ref": "#/components/schemas/ImmigrationWorkersCasesGetResponsesContentApplicationJsonSchemaDataItems" }, "type": "array" }, "has_more": { "description": "Indicates whether more results are available for pagination.", "type": "boolean" }, "next_cursor": { "description": "Cursor value to be used for fetching the next page of results.", "type": [ "string", "null" ] }, "total_count": { "description": "Total number of cases matching the search criteria.", "type": "integer" } }, "required": [ "data", "has_more", "total_count" ], "title": "immigration_getWorkerCases_Response_200", "type": "object" }, "immigration_getWorkerOnboardingCase_Response_200": { "properties": { "data": { "$ref": "#/components/schemas/ImmigrationWorkersWorkerIdOnboardingCaseGetResponsesContentApplicationJsonSchemaData" } }, "title": "immigration_getWorkerOnboardingCase_Response_200", "type": "object" }, "invoice-adjustments_createInvoiceAdjustmentReview_Response_201": { "properties": { "data": { "$ref": "#/components/schemas/InvoiceAdjustmentsIdReviewsPostResponsesContentApplicationJsonSchemaData" } }, "required": [ "data" ], "title": "invoice-adjustments_createInvoiceAdjustmentReview_Response_201", "type": "object" }, "invoice-adjustments_createInvoiceAdjustment_Response_201": { "properties": { "data": { "$ref": "#/components/schemas/InvoiceAdjustmentsPostResponsesContentApplicationJsonSchemaData", "description": "Container object with identifiers, status, and creation metadata for the newly created invoice adjustment." } }, "required": [ "data" ], "title": "invoice-adjustments_createInvoiceAdjustment_Response_201", "type": "object" }, "invoice-adjustments_deleteInvoiceAdjustment_Response_200": { "properties": { "data": { "$ref": "#/components/schemas/InvoiceAdjustmentsIdDeleteResponsesContentApplicationJsonSchemaData" } }, "required": [ "data" ], "title": "invoice-adjustments_deleteInvoiceAdjustment_Response_200", "type": "object" }, "invoice-adjustments_getContractInvoiceAdjustments_Response_200": { "properties": { "data": { "items": { "$ref": "#/components/schemas/ContractsContractIdInvoiceAdjustmentsGetResponsesContentApplicationJsonSchemaDataItems" }, "type": "array" }, "page": { "$ref": "#/components/schemas/ContractsContractIdInvoiceAdjustmentsGetResponsesContentApplicationJsonSchemaPage", "description": "Pagination metadata for the response." } }, "required": [ "data", "page" ], "title": "invoice-adjustments_getContractInvoiceAdjustments_Response_200", "type": "object" }, "invoice-adjustments_getInvoiceAdjustmentById_Response_200": { "properties": { "data": { "$ref": "#/components/schemas/InvoiceAdjustmentsIdGetResponsesContentApplicationJsonSchemaData" } }, "required": [ "data" ], "title": "invoice-adjustments_getInvoiceAdjustmentById_Response_200", "type": "object" }, "invoice-adjustments_getInvoiceAdjustments_Response_200": { "properties": { "data": { "description": "List of invoice adjustments returned for the request.", "items": { "$ref": "#/components/schemas/InvoiceAdjustmentsGetResponsesContentApplicationJsonSchemaDataItems" }, "type": "array" }, "page": { "$ref": "#/components/schemas/InvoiceAdjustmentsGetResponsesContentApplicationJsonSchemaPage", "description": "Pagination metadata for the response." } }, "required": [ "data", "page" ], "title": "invoice-adjustments_getInvoiceAdjustments_Response_200", "type": "object" }, "invoice-adjustments_updateInvoiceAdjustment_Response_200": { "properties": { "data": { "$ref": "#/components/schemas/InvoiceAdjustmentsIdPatchResponsesContentApplicationJsonSchemaData" } }, "required": [ "data" ], "title": "invoice-adjustments_updateInvoiceAdjustment_Response_200", "type": "object" }, "legal-entities_createLegalEntity_Response_200": { "properties": { "data": { "$ref": "#/components/schemas/LegalEntitiesPostResponsesContentApplicationJsonSchemaData" } }, "title": "legal-entities_createLegalEntity_Response_200", "type": "object" }, "legal-entities_deleteLegalEntity_Response_200": { "properties": { "archived_at": { "description": "The timestamp when the legal entity was archived.", "format": "date-time", "type": "string" } }, "title": "legal-entities_deleteLegalEntity_Response_200", "type": "object" }, "legal-entities_getIndustries_Response_200": { "properties": { "data": { "description": "List of industry subcategories.", "items": { "$ref": "#/components/schemas/IndustriesGetResponsesContentApplicationJsonSchemaDataItems" }, "type": "array" }, "has_more": { "description": "Indicates if there are more results available.", "type": "boolean" }, "next_cursor": { "description": "Cursor to fetch the next page of results.", "type": [ "string", "null" ] }, "total_count": { "description": "Total number of results matching the query.", "type": "integer" } }, "required": [ "data", "has_more", "next_cursor", "total_count" ], "title": "legal-entities_getIndustries_Response_200", "type": "object" }, "legal-entities_getLegalEntities_Response_200": { "properties": { "data": { "items": { "$ref": "#/components/schemas/LegalEntitiesGetResponsesContentApplicationJsonSchemaDataItems" }, "type": "array" }, "page": { "$ref": "#/components/schemas/LegalEntitiesGetResponsesContentApplicationJsonSchemaPage" } }, "title": "legal-entities_getLegalEntities_Response_200", "type": "object" }, "legal-entities_updateLegalEntity_Response_200": { "properties": { "data": { "$ref": "#/components/schemas/LegalEntitiesIdPatchResponsesContentApplicationJsonSchemaData" } }, "title": "legal-entities_updateLegalEntity_Response_200", "type": "object" }, "lookups_getCountries_Response_200": { "properties": { "data": { "items": { "$ref": "#/components/schemas/LookupsCountriesGetResponsesContentApplicationJsonSchemaDataItems" }, "type": "array" } }, "title": "lookups_getCountries_Response_200", "type": "object" }, "lookups_getCurrencies_Response_200": { "properties": { "data": { "description": "List of currencies supported by Deel.", "items": { "$ref": "#/components/schemas/LookupsCurrenciesGetResponsesContentApplicationJsonSchemaDataItems" }, "type": "array" } }, "title": "lookups_getCurrencies_Response_200", "type": "object" }, "lookups_getJobTitles_Response_200": { "properties": { "data": { "items": { "$ref": "#/components/schemas/LookupsJobTitlesGetResponsesContentApplicationJsonSchemaDataItems" }, "type": "array" }, "page": { "$ref": "#/components/schemas/LookupsJobTitlesGetResponsesContentApplicationJsonSchemaPage" } }, "title": "lookups_getJobTitles_Response_200", "type": "object" }, "lookups_getSeniorityLevels_Response_200": { "properties": { "data": { "description": "List of predefined seniority levels supported by the Deel platform.", "items": { "$ref": "#/components/schemas/LookupsSenioritiesGetResponsesContentApplicationJsonSchemaDataItems" }, "type": "array" } }, "title": "lookups_getSeniorityLevels_Response_200", "type": "object" }, "lookups_getTimeOffTypes_Response_200": { "properties": { "data": { "description": "List of predefined time-off types supported by the Deel platform.", "items": { "$ref": "#/components/schemas/LookupsTimeOffTypesGetResponsesContentApplicationJsonSchemaDataItems" }, "type": "array" } }, "title": "lookups_getTimeOffTypes_Response_200", "type": "object" }, "magic-link_createMagicLink_Response_201": { "properties": { "data": { "$ref": "#/components/schemas/MagicLinkPostResponsesContentApplicationJsonSchemaData" } }, "required": [ "data" ], "title": "magic-link_createMagicLink_Response_201", "type": "object" }, "managers_createManager_Response_201": { "properties": { "data": { "$ref": "#/components/schemas/ManagersPostResponsesContentApplicationJsonSchemaData" } }, "required": [ "data" ], "title": "managers_createManager_Response_201", "type": "object" }, "managers_getManagers_Response_200": { "properties": { "data": { "description": "List of managers in the organization.", "items": { "$ref": "#/components/schemas/ManagersGetResponsesContentApplicationJsonSchemaDataItems" }, "type": "array" }, "page": { "$ref": "#/components/schemas/ManagersGetResponsesContentApplicationJsonSchemaPage", "description": "Pagination details for the response." } }, "required": [ "data", "page" ], "title": "managers_getManagers_Response_200", "type": "object" }, "milestones_createContractMilestone_Response_201": { "properties": { "data": { "$ref": "#/components/schemas/ContractsContractIdMilestonesPostResponsesContentApplicationJsonSchemaData" } }, "required": [ "data" ], "title": "milestones_createContractMilestone_Response_201", "type": "object" }, "milestones_deleteContractMilestone_Response_200": { "properties": { "data": { "$ref": "#/components/schemas/ContractsContractIdMilestonesMilestoneIdDeleteResponsesContentApplicationJsonSchemaData" } }, "required": [ "data" ], "title": "milestones_deleteContractMilestone_Response_200", "type": "object" }, "milestones_getContractMilestoneById_Response_200": { "properties": { "data": { "$ref": "#/components/schemas/ContractsContractIdMilestonesMilestoneIdGetResponsesContentApplicationJsonSchemaData" } }, "required": [ "data" ], "title": "milestones_getContractMilestoneById_Response_200", "type": "object" }, "milestones_getContractMilestones_Response_200": { "properties": { "data": { "description": "An array of milestone objects associated with the contract.", "items": { "$ref": "#/components/schemas/ContractsContractIdMilestonesGetResponsesContentApplicationJsonSchemaDataItems" }, "type": "array" } }, "required": [ "data" ], "title": "milestones_getContractMilestones_Response_200", "type": "object" }, "off-cycle_createContractOffCyclePayment_Response_201": { "properties": { "data": { "$ref": "#/components/schemas/ContractsContractIdOffCyclePaymentsPostResponsesContentApplicationJsonSchemaData", "description": "Details of the newly created off-cycle payment." } }, "required": [ "data" ], "title": "off-cycle_createContractOffCyclePayment_Response_201", "type": "object" }, "off-cycle_getContractOffCyclePayments_Response_200": { "properties": { "data": { "description": "List of off-cycle payments matching the requested contract.", "items": { "$ref": "#/components/schemas/ContractsContractIdOffCyclePaymentsGetResponsesContentApplicationJsonSchemaDataItems" }, "type": "array" } }, "required": [ "data" ], "title": "off-cycle_getContractOffCyclePayments_Response_200", "type": "object" }, "organization-structure_createOrganizationStructure_Response_200": { "properties": { "data": { "$ref": "#/components/schemas/HrisOrganizationStructuresPostResponsesContentApplicationJsonSchemaData" } }, "title": "organization-structure_createOrganizationStructure_Response_200", "type": "object" }, "organization-structure_deleteOrganizationStructureByExternalId_Response_200": { "description": "Empty response body", "properties": {}, "title": "organization-structure_deleteOrganizationStructureByExternalId_Response_200", "type": "object" }, "organization-structure_deleteOrganizationStructure_Response_200": { "description": "Empty response body", "properties": {}, "title": "organization-structure_deleteOrganizationStructure_Response_200", "type": "object" }, "organization-structure_getOrganizationStructureByExternalId_Response_200": { "properties": { "data": { "$ref": "#/components/schemas/HrisOrganizationStructuresExternalExternalIdGetResponsesContentApplicationJsonSchemaData" } }, "title": "organization-structure_getOrganizationStructureByExternalId_Response_200", "type": "object" }, "organization-structure_getOrganizationStructure_Response_200": { "properties": { "data": { "$ref": "#/components/schemas/HrisOrganizationStructuresHrisOrgStructureIdGetResponsesContentApplicationJsonSchemaData" } }, "title": "organization-structure_getOrganizationStructure_Response_200", "type": "object" }, "organization-structure_getOrganizationStructures_Response_200": { "properties": { "data": { "items": { "$ref": "#/components/schemas/HrisOrganizationStructuresGetResponsesContentApplicationJsonSchemaDataItems" }, "type": "array" } }, "title": "organization-structure_getOrganizationStructures_Response_200", "type": "object" }, "organization-structure_updateOrganizationStructureByExternalId_Response_200": { "description": "Empty response body", "properties": {}, "title": "organization-structure_updateOrganizationStructureByExternalId_Response_200", "type": "object" }, "organization-structure_updateOrganizationStructure_Response_200": { "description": "Empty response body", "properties": {}, "title": "organization-structure_updateOrganizationStructure_Response_200", "type": "object" }, "organization-structure_updatePersonDepartment_Response_200": { "properties": { "data": { "$ref": "#/components/schemas/PeopleIdDepartmentPutResponsesContentApplicationJsonSchemaData" } }, "required": [ "data" ], "title": "organization-structure_updatePersonDepartment_Response_200", "type": "object" }, "organizations_createOrganizationChild_Response_201": { "properties": { "data": { "$ref": "#/components/schemas/OrganizationsChildrenPostResponsesContentApplicationJsonSchemaData" } }, "required": [ "data" ], "title": "organizations_createOrganizationChild_Response_201", "type": "object" }, "organizations_getOrganizations_Response_200": { "properties": { "data": { "items": { "$ref": "#/components/schemas/OrganizationsGetResponsesContentApplicationJsonSchemaDataItems" }, "type": "array" } }, "title": "organizations_getOrganizations_Response_200", "type": "object" }, "payslips_getGPWorkerPayslips_Response_200": { "properties": { "data": { "items": { "$ref": "#/components/schemas/GpWorkersIdPayslipsGetResponsesContentApplicationJsonSchemaDataItems" }, "type": "array" } }, "required": [ "data" ], "title": "payslips_getGPWorkerPayslips_Response_200", "type": "object" }, "people_createPersonWithoutContract_Response_201": { "properties": { "data": { "$ref": "#/components/schemas/PwacPostResponsesContentApplicationJsonSchemaData" } }, "required": [ "data" ], "title": "people_createPersonWithoutContract_Response_201", "type": "object" }, "people_getPeople_Response_200": { "properties": { "data": { "items": { "$ref": "#/components/schemas/PeopleGetResponsesContentApplicationJsonSchemaDataItems" }, "type": "array" }, "page": { "$ref": "#/components/schemas/PeopleGetResponsesContentApplicationJsonSchemaPage" } }, "required": [ "data" ], "title": "people_getPeople_Response_200", "type": "object" }, "people_getPersonById_Response_200": { "properties": { "data": { "$ref": "#/components/schemas/PeopleHrisProfileIdGetResponsesContentApplicationJsonSchemaData" } }, "required": [ "data" ], "title": "people_getPersonById_Response_200", "type": "object" }, "people_updatePersonWorkingLocation_Response_200": { "properties": { "data": { "$ref": "#/components/schemas/PeopleIdWorkingLocationPutResponsesContentApplicationJsonSchemaData" } }, "required": [ "data" ], "title": "people_updatePersonWorkingLocation_Response_200", "type": "object" }, "personal-information_getPersonPersonalInfo_Response_200": { "properties": { "data": { "$ref": "#/components/schemas/PeopleWorkerIdPersonalGetResponsesContentApplicationJsonSchemaData" } }, "required": [ "data" ], "title": "personal-information_getPersonPersonalInfo_Response_200", "type": "object" }, "personal-information_updateProfile_Response_200": { "properties": { "data": { "$ref": "#/components/schemas/ProfilesPatchResponsesContentApplicationJsonSchemaData" } }, "title": "personal-information_updateProfile_Response_200", "type": "object" }, "positions_getPositionsByProfile_Response_200": { "properties": { "data": { "items": { "$ref": "#/components/schemas/HrisPositionsProfileHrisProfileIdGetResponsesContentApplicationJsonSchemaDataItems" }, "type": "array" } }, "title": "positions_getPositionsByProfile_Response_200", "type": "object" }, "reports_getGPLegalEntityReports_Response_200": { "properties": { "data": { "items": { "$ref": "#/components/schemas/GpLegalEntitiesLegalEntityIdReportsGetResponsesContentApplicationJsonSchemaDataItems" }, "type": "array" } }, "required": [ "data" ], "title": "reports_getGPLegalEntityReports_Response_200", "type": "object" }, "reports_getGPReportGrossToNet_Response_200": { "properties": { "data": { "description": "List of report rows (summary rows are filtered out). Each row contains dynamic column keys mapped to cell objects.", "items": { "additionalProperties": { "$ref": "#/components/schemas/GpReportsIdGrossToNetGetResponsesContentApplicationJsonSchemaDataItems" }, "type": "object" }, "type": "array" }, "page": { "$ref": "#/components/schemas/GpReportsIdGrossToNetGetResponsesContentApplicationJsonSchemaPage", "description": "Pagination metadata for the report rows." } }, "required": [ "data", "page" ], "title": "reports_getGPReportGrossToNet_Response_200", "type": "object" }, "screenings_createManualVerification_Response_201": { "properties": { "data": { "$ref": "#/components/schemas/ScreeningsManualVerificationPostResponsesContentApplicationJsonSchemaData" } }, "required": [ "data" ], "title": "screenings_createManualVerification_Response_201", "type": "object" }, "screenings_createVeriffSession_Response_201": { "properties": { "data": { "$ref": "#/components/schemas/VeriffSessionPostResponsesContentApplicationJsonSchemaData" } }, "required": [ "data" ], "title": "screenings_createVeriffSession_Response_201", "type": "object" }, "screenings_getAMLDetails_Response_200": { "properties": { "detailed_results": { "$ref": "#/components/schemas/ScreeningsAmlEntityTypeEntityIdGetResponsesContentApplicationJsonSchemaDetailedResults", "description": "Details of checks performed for this screening." }, "entity_id": { "description": "UUID of the entity.", "type": "string" }, "entity_type": { "$ref": "#/components/schemas/ScreeningsAmlEntityTypeEntityIdGetResponsesContentApplicationJsonSchemaEntityType", "description": "The type of entity being screened." }, "result": { "$ref": "#/components/schemas/ScreeningsAmlEntityTypeEntityIdGetResponsesContentApplicationJsonSchemaResult", "description": "The result of the screening. ACCEPT means the screening passed, REJECT means it failed, and REFERRED means it is pending further review." } }, "required": [ "result", "entity_id", "entity_type", "detailed_results" ], "title": "screenings_getAMLDetails_Response_200", "type": "object" }, "screenings_getKYCDetails_Response_200": { "properties": { "data": { "$ref": "#/components/schemas/ScreeningsKycDetailsGetResponsesContentApplicationJsonSchemaData" } }, "required": [ "data" ], "title": "screenings_getKYCDetails_Response_200", "type": "object" }, "screenings_getVerificationMethod_Response_200": { "properties": { "data": { "$ref": "#/components/schemas/ScreeningsVerificationMethodGetResponsesContentApplicationJsonSchemaData" } }, "required": [ "data" ], "title": "screenings_getVerificationMethod_Response_200", "type": "object" }, "tasks_createContractTaskReview_Response_201": { "properties": { "data": { "$ref": "#/components/schemas/ContractsContractIdTasksTaskIdReviewsPostResponsesContentApplicationJsonSchemaData" } }, "required": [ "data" ], "title": "tasks_createContractTaskReview_Response_201", "type": "object" }, "tasks_createContractTask_Response_201": { "properties": { "data": { "$ref": "#/components/schemas/ContractsContractIdTasksPostResponsesContentApplicationJsonSchemaData" } }, "required": [ "data" ], "title": "tasks_createContractTask_Response_201", "type": "object" }, "tasks_deleteContractTask_Response_200": { "properties": { "data": { "$ref": "#/components/schemas/ContractsContractIdTasksTaskIdDeleteResponsesContentApplicationJsonSchemaData" } }, "required": [ "data" ], "title": "tasks_deleteContractTask_Response_200", "type": "object" }, "tasks_getContractTasks_Response_200": { "properties": { "data": { "items": { "$ref": "#/components/schemas/ContractsContractIdTasksGetResponsesContentApplicationJsonSchemaDataItems" }, "type": "array" } }, "required": [ "data" ], "title": "tasks_getContractTasks_Response_200", "type": "object" }, "terminations_createContractTermination_Response_201": { "properties": { "data": { "$ref": "#/components/schemas/ContractsContractIdTerminationsPostResponsesContentApplicationJsonSchemaData" } }, "title": "terminations_createContractTermination_Response_201", "type": "object" }, "time-off_createTimeOffRequest_Response_201": { "description": "The list of created time offs. Depending on the selected dates, a time off can be split into more than one request.", "properties": { "time_offs": { "description": "The list of created time offs. Depending on the selected dates, a time off can be split into more than one request.", "items": { "$ref": "#/components/schemas/TimeOffsPostResponsesContentApplicationJsonSchemaTimeOffsItems" }, "type": "array" } }, "required": [ "time_offs" ], "title": "time-off_createTimeOffRequest_Response_201", "type": "object" }, "time-off_getTimeOffDailies_Response_200": { "properties": { "data": { "description": "List of holiday and work schedule information grouped by HRIS profile, including holidays within the date range, work schedule details, and daily work status", "items": { "$ref": "#/components/schemas/TimeOffsDailiesGetResponsesContentApplicationJsonSchemaDataItems" }, "type": "array" } }, "title": "time-off_getTimeOffDailies_Response_200", "type": "object" }, "time-off_getTimeOffEntitlements_Response_200": { "properties": { "entitlements": { "items": { "$ref": "#/components/schemas/TimeOffsProfileHrisProfileIdEntitlementsGetResponsesContentApplicationJsonSchemaEntitlementsItems" }, "type": "array" }, "hris_profile_id": { "description": "HRIS profile ID", "type": "string" } }, "required": [ "entitlements", "hris_profile_id" ], "title": "time-off_getTimeOffEntitlements_Response_200", "type": "object" }, "time-off_getTimeOffEvents_Response_200": { "description": "List of time off events for the profile", "properties": { "data": { "description": "List of time off events for the profile", "items": { "$ref": "#/components/schemas/TimeOffsTimeOffEventsGetResponsesContentApplicationJsonSchemaDataItems" }, "type": "array" } }, "required": [ "data" ], "title": "time-off_getTimeOffEvents_Response_200", "type": "object" }, "time-off_getTimeOffPolicies_Response_200": { "properties": { "policies": { "items": { "$ref": "#/components/schemas/TimeOffsProfileHrisProfileIdPoliciesGetResponsesContentApplicationJsonSchemaPoliciesItems" }, "type": "array" } }, "title": "time-off_getTimeOffPolicies_Response_200", "type": "object" }, "time-off_getTimeOffPolicyValidationTemplates_Response_200": { "properties": { "data": { "$ref": "#/components/schemas/TimeOffsPolicyValidationTemplatesGetResponsesContentApplicationJsonSchemaData" } }, "title": "time-off_getTimeOffPolicyValidationTemplates_Response_200", "type": "object" }, "time-off_getTimeOffProfile_Response_200": { "description": "Time offs associated to the query", "properties": { "count": { "description": "Total count of items", "type": "integer" }, "data": { "items": { "$ref": "#/components/schemas/TimeOffsProfileHrisProfileIdGetResponsesContentApplicationJsonSchemaDataItems" }, "type": "array" }, "has_next_page": { "description": "Has next page", "type": "boolean" }, "next": { "type": "string" }, "page_size": { "description": "Page size", "maximum": 200, "minimum": 5, "type": "integer" } }, "required": [ "data", "page_size", "has_next_page" ], "title": "time-off_getTimeOffProfile_Response_200", "type": "object" }, "time-off_reviewTimeOffRequest_Response_201": { "description": "The response contains two lists: one for time-offs that were successfully reviewed and another for those that could not be reviewed. Each time-off in the reviewed list contains its ID and the status it was set to (either APPROVED/USED or REJECTED). The notReviewed list contains the IDs of time-offs that could not be reviewed along with an error message explaining why.", "properties": { "data": { "$ref": "#/components/schemas/TimeOffsReviewPostResponsesContentApplicationJsonSchemaData" } }, "required": [ "data" ], "title": "time-off_reviewTimeOffRequest_Response_201", "type": "object" }, "time-off_syncTimeOffGlobalPayroll_Response_200": { "description": "List of time offs persisted at Deel", "properties": { "data": { "$ref": "#/components/schemas/TimeOffsGlobalPayrollSyncPostResponsesContentApplicationJsonSchemaData" } }, "title": "time-off_syncTimeOffGlobalPayroll_Response_200", "type": "object" }, "time-off_updateTimeOffRequest_Response_200": { "description": "Time off data to be updated", "properties": { "time_off": { "$ref": "#/components/schemas/TimeOffsTimeOffIdPatchResponsesContentApplicationJsonSchemaTimeOff", "description": "Used to return the updated time off request after modification. Contains all the time off details including status, dates, amounts, and associated metadata." } }, "required": [ "time_off" ], "title": "time-off_updateTimeOffRequest_Response_200", "type": "object" }, "time-off_validateTimeOff_Response_200": { "description": "Time off request validation result", "properties": { "data": { "$ref": "#/components/schemas/TimeOffsValidatePostResponsesContentApplicationJsonSchemaData", "description": "Time off request validation result" } }, "required": [ "data" ], "title": "time-off_validateTimeOff_Response_200", "type": "object" }, "time-tracking-shifts_createTimeTrackingShiftsRaw_Response_201": { "properties": { "data": { "items": { "$ref": "#/components/schemas/V2TimeTrackingShiftsRawPostResponsesContentApplicationJsonSchemaDataItems" }, "type": "array" } }, "required": [ "data" ], "title": "time-tracking-shifts_createTimeTrackingShiftsRaw_Response_201", "type": "object" }, "time-tracking-shifts_createTimeTrackingShifts_Response_201": { "properties": { "data": { "items": { "$ref": "#/components/schemas/V2TimeTrackingShiftsPostResponsesContentApplicationJsonSchemaDataItems" }, "type": "array" } }, "required": [ "data" ], "title": "time-tracking-shifts_createTimeTrackingShifts_Response_201", "type": "object" }, "time-tracking-shifts_getTimeTrackingShiftByExternalId_Response_200": { "description": "Shift response wrapper", "properties": { "data": { "$ref": "#/components/schemas/TimeTrackingShiftsExternalIdGetResponsesContentApplicationJsonSchemaData" } }, "required": [ "data" ], "title": "time-tracking-shifts_getTimeTrackingShiftByExternalId_Response_200", "type": "object" }, "time-tracking-shifts_getTimeTrackingShifts_Response_200": { "description": "Shifts response", "properties": { "data": { "items": { "$ref": "#/components/schemas/V2TimeTrackingShiftsGetResponsesContentApplicationJsonSchemaDataItems" }, "type": "array" }, "page": { "$ref": "#/components/schemas/V2TimeTrackingShiftsGetResponsesContentApplicationJsonSchemaPage" } }, "required": [ "data", "page" ], "title": "time-tracking-shifts_getTimeTrackingShifts_Response_200", "type": "object" }, "time-tracking-shifts_updateTimeTrackingShiftByExternalId_Response_200": { "description": "Shift response wrapper", "properties": { "data": { "$ref": "#/components/schemas/TimeTrackingShiftsExternalIdPatchResponsesContentApplicationJsonSchemaData" } }, "required": [ "data" ], "title": "time-tracking-shifts_updateTimeTrackingShiftByExternalId_Response_200", "type": "object" }, "time-tracking_createTimeTrackingShiftRate_Response_201": { "description": "Shift rate policy response", "properties": { "data": { "$ref": "#/components/schemas/V2TimeTrackingShiftRatesPostResponsesContentApplicationJsonSchemaData" } }, "required": [ "data" ], "title": "time-tracking_createTimeTrackingShiftRate_Response_201", "type": "object" }, "time-tracking_getTimeTrackingShiftRateByExternalId_Response_200": { "description": "Shift rate policy response", "properties": { "data": { "$ref": "#/components/schemas/TimeTrackingShiftRatesExternalIdGetResponsesContentApplicationJsonSchemaData" } }, "required": [ "data" ], "title": "time-tracking_getTimeTrackingShiftRateByExternalId_Response_200", "type": "object" }, "time-tracking_getTimeTrackingShiftRates_Response_200": { "description": "Shift rate policies response", "properties": { "data": { "items": { "$ref": "#/components/schemas/V2TimeTrackingShiftRatesGetResponsesContentApplicationJsonSchemaDataItems" }, "type": "array" }, "page": { "$ref": "#/components/schemas/V2TimeTrackingShiftRatesGetResponsesContentApplicationJsonSchemaPage" } }, "required": [ "data", "page" ], "title": "time-tracking_getTimeTrackingShiftRates_Response_200", "type": "object" }, "time-tracking_getTimeTrackingTimesheetById_Response_200": { "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", "type": "object" }, "time-tracking_getTimeTrackingTimesheetsUploadUrl_Response_201": { "properties": { "data": { "$ref": "#/components/schemas/TimeTrackingTimesheetsUploadUrlPostResponsesContentApplicationJsonSchemaData" } }, "required": [ "data" ], "title": "time-tracking_getTimeTrackingTimesheetsUploadUrl_Response_201", "type": "object" }, "time-tracking_reviewTimeTrackingTimesheet_Response_201": { "properties": { "data": { "$ref": "#/components/schemas/TimeTrackingTimesheetsTimesheetIdReviewPostResponsesContentApplicationJsonSchemaData", "description": "Updated timesheet details after review" } }, "required": [ "data" ], "title": "time-tracking_reviewTimeTrackingTimesheet_Response_201", "type": "object" }, "time-tracking_updateTimeTrackingShiftRateByExternalId_Response_200": { "description": "Shift rate policy response", "properties": { "data": { "$ref": "#/components/schemas/TimeTrackingShiftRatesExternalIdPatchResponsesContentApplicationJsonSchemaData" } }, "required": [ "data" ], "title": "time-tracking_updateTimeTrackingShiftRateByExternalId_Response_200", "type": "object" }, "timesheets_createTimesheet_Response_201": { "properties": { "data": { "$ref": "#/components/schemas/TimesheetsPostResponsesContentApplicationJsonSchemaData", "description": "Container object with identifiers, status, and creation metadata for the newly created timesheet entry." } }, "required": [ "data" ], "title": "timesheets_createTimesheet_Response_201", "type": "object" }, "timesheets_getContractTimesheets_Response_200": { "properties": { "data": { "description": "List of timesheet entries associated with the specified contract.", "items": { "$ref": "#/components/schemas/ContractsContractIdTimesheetsGetResponsesContentApplicationJsonSchemaDataItems" }, "type": "array" }, "page": { "$ref": "#/components/schemas/ContractsContractIdTimesheetsGetResponsesContentApplicationJsonSchemaPage", "description": "Pagination metadata for the response." } }, "required": [ "data", "page" ], "title": "timesheets_getContractTimesheets_Response_200", "type": "object" }, "timesheets_getTimesheets_Response_200": { "properties": { "data": { "items": { "$ref": "#/components/schemas/TimesheetsGetResponsesContentApplicationJsonSchemaDataItems" }, "type": "array" }, "page": { "$ref": "#/components/schemas/TimesheetsGetResponsesContentApplicationJsonSchemaPage", "description": "Pagination metadata for the response." } }, "required": [ "data", "page" ], "title": "timesheets_getTimesheets_Response_200", "type": "object" }, "webhooks_createWebhook_Response_201": { "properties": { "data": { "$ref": "#/components/schemas/WebhooksPostResponsesContentApplicationJsonSchemaData", "description": "The webhook subscription." } }, "required": [ "data" ], "title": "webhooks_createWebhook_Response_201", "type": "object" }, "webhooks_deleteWebhook_Response_200": { "properties": { "data": { "$ref": "#/components/schemas/WebhooksIdDeleteResponsesContentApplicationJsonSchemaData", "description": "The result of the delete operation." } }, "required": [ "data" ], "title": "webhooks_deleteWebhook_Response_200", "type": "object" }, "webhooks_getWebhookEvents_Response_200": { "properties": { "data": { "description": "The list of webhook event types.", "items": { "$ref": "#/components/schemas/WebhooksEventsTypesGetResponsesContentApplicationJsonSchemaDataItems" }, "type": "array" } }, "title": "webhooks_getWebhookEvents_Response_200", "type": "object" }, "webhooks_getWebhook_Response_200": { "properties": { "data": { "$ref": "#/components/schemas/WebhooksIdGetResponsesContentApplicationJsonSchemaData", "description": "The webhook subscription." } }, "required": [ "data" ], "title": "webhooks_getWebhook_Response_200", "type": "object" }, "webhooks_getWebhooks_Response_200": { "properties": { "data": { "description": "The list of webhook subscriptions.", "items": { "$ref": "#/components/schemas/WebhooksGetResponsesContentApplicationJsonSchemaDataItems" }, "type": "array" } }, "required": [ "data" ], "title": "webhooks_getWebhooks_Response_200", "type": "object" }, "webhooks_updateWebhook_Response_200": { "properties": { "data": { "$ref": "#/components/schemas/WebhooksIdPatchResponsesContentApplicationJsonSchemaData", "description": "The webhook subscription." } }, "required": [ "data" ], "title": "webhooks_updateWebhook_Response_200", "type": "object" }, "worker-information_createGPWorkerAdditionalInformation_Response_201": { "properties": { "data": { "$ref": "#/components/schemas/GpWorkersContractsContractIdAdditionalInformationPostResponsesContentApplicationJsonSchemaData" } }, "title": "worker-information_createGPWorkerAdditionalInformation_Response_201", "type": "object" }, "worker-information_createGPWorkerBank_Response_201": { "properties": { "data": { "$ref": "#/components/schemas/GpWorkersWorkerIdBanksPostResponsesContentApplicationJsonSchemaData" } }, "required": [ "data" ], "title": "worker-information_createGPWorkerBank_Response_201", "type": "object" }, "worker-information_getGPWorkerAdditionalInformation_Response_200": { "properties": { "data": { "$ref": "#/components/schemas/GpWorkersContractsContractIdAdditionalInformationPatchResponsesContentApplicationJsonSchemaData" } }, "required": [ "data" ], "title": "worker-information_getGPWorkerAdditionalInformation_Response_200", "type": "object" }, "worker-information_getGPWorkerBankGuide_Response_200": { "properties": { "data": { "items": { "$ref": "#/components/schemas/GpWorkersWorkerIdBanksGuideGetResponsesContentApplicationJsonSchemaDataItems" }, "type": "array" } }, "required": [ "data" ], "title": "worker-information_getGPWorkerBankGuide_Response_200", "type": "object" }, "worker-information_getGPWorkerBanks_Response_200": { "properties": { "data": { "items": { "$ref": "#/components/schemas/GpWorkersWorkerIdBanksGetResponsesContentApplicationJsonSchemaDataItems" }, "type": "array" } }, "required": [ "data" ], "title": "worker-information_getGPWorkerBanks_Response_200", "type": "object" }, "worker-information_updateGPWorkerAddress_Response_201": { "properties": { "data": { "$ref": "#/components/schemas/GpWorkersWorkerIdAddressPatchResponsesContentApplicationJsonSchemaData" } }, "required": [ "data" ], "title": "worker-information_updateGPWorkerAddress_Response_201", "type": "object" }, "worker-information_updateGPWorkerBank_Response_200": { "properties": { "data": { "$ref": "#/components/schemas/GpWorkersWorkerIdBanksBankIdPatchResponsesContentApplicationJsonSchemaData" } }, "required": [ "data" ], "title": "worker-information_updateGPWorkerBank_Response_200", "type": "object" }, "worker-information_updateGPWorkerCompensation_Response_200": { "properties": { "data": { "items": { "$ref": "#/components/schemas/GpWorkersWorkerIdCompensationPatchResponsesContentApplicationJsonSchemaDataItems" }, "type": "array" } }, "required": [ "data" ], "title": "worker-information_updateGPWorkerCompensation_Response_200", "type": "object" }, "worker-information_updateGPWorkerPTOPolicy_Response_200": { "properties": { "data": { "$ref": "#/components/schemas/GpWorkersWorkerIdPtoPolicyPatchResponsesContentApplicationJsonSchemaData" } }, "required": [ "data" ], "title": "worker-information_updateGPWorkerPTOPolicy_Response_200", "type": "object" }, "worker-relations_createWorkerRelationProfileByExternalId_Response_201": { "description": "Empty response body", "properties": {}, "title": "worker-relations_createWorkerRelationProfileByExternalId_Response_201", "type": "object" }, "worker-relations_createWorkerRelationProfile_Response_201": { "description": "Empty response body", "properties": {}, "title": "worker-relations_createWorkerRelationProfile_Response_201", "type": "object" }, "worker-relations_createWorkerRelationType_Response_201": { "properties": { "data": { "$ref": "#/components/schemas/HrisWorkerRelationsTypesPostResponsesContentApplicationJsonSchemaData" } }, "title": "worker-relations_createWorkerRelationType_Response_201", "type": "object" }, "worker-relations_getWorkerRelationProfileByExternalId_Response_200": { "properties": { "data": { "description": "An array containing the Worker Relations of the profile. It includes either the parent or child relations.", "items": { "$ref": "#/components/schemas/HrisWorkerRelationsProfileExternalProfileIdGetResponsesContentApplicationJsonSchemaDataItems" }, "type": "array" } }, "title": "worker-relations_getWorkerRelationProfileByExternalId_Response_200", "type": "object" }, "worker-relations_getWorkerRelationProfile_Response_200": { "properties": { "data": { "description": "An array containing the Worker Relations of the profile. It includes either the parent or child relations.", "items": { "$ref": "#/components/schemas/HrisWorkerRelationsProfileHrisProfileOidGetResponsesContentApplicationJsonSchemaDataItems" }, "type": "array" } }, "title": "worker-relations_getWorkerRelationProfile_Response_200", "type": "object" }, "worker-relations_getWorkerRelationTypes_Response_200": { "properties": { "data": { "items": { "$ref": "#/components/schemas/HrisWorkerRelationsTypesGetResponsesContentApplicationJsonSchemaDataItems" }, "type": "array" } }, "title": "worker-relations_getWorkerRelationTypes_Response_200", "type": "object" } }, "securitySchemes": { "deelToken": { "description": "## Authentication\nThe Deel API uses bearer tokens to authenticate requests. All API calls must be made over HTTPS — calls over plain HTTP or without authentication will fail.\n\n```curl\ncurl -X GET 'https://api.letsdeel.com/rest/v2/contracts' \\\n -H \"Authorization: Bearer ${DEEL_API_TOKEN}\"\n```\n\n[Learn more about authentication](/api/authentication)", "scheme": "bearer", "type": "http" }, "oauth2": { "description": "Standard OAuth2 security scheme based on https://swagger.io/docs/specification/authentication/", "scheme": "bearer", "type": "http" } } }, "info": { "title": "Deel API", "version": "1.0.0" }, "openapi": "3.1.0", "paths": { "/Users": { "get": { "description": "Retrieve a list of users in Deel's HRIS.\n\n **Token scopes**: `Users:read`", "operationId": "users_getUsers", "parameters": [ { "description": "Filter results using [SCIM's filtering syntax](https://datatracker.ietf.org/doc/html/rfc7644#section-3.4.2.2). Currently supports only `eq` operator and filtering by a user's email. Expected format 'email eq \"email@domain.com\"'.", "in": "query", "name": "filter", "required": false, "schema": { "$ref": "#/components/schemas/UsersGetParametersFilter" } }, { "description": "The 1-based index of the first result to return. Used for pagination. Minimum value is 1. Defaults to 1 if not provided.", "in": "query", "name": "startIndex", "required": false, "schema": { "pattern": "^[0-9]+$", "type": "string" } }, { "description": "The maximum number of results to return per page. Used for pagination. A value of 0 is treated as a special case and returns 1 result. Typically should be a positive integer.", "in": "query", "name": "count", "required": false, "schema": { "pattern": "^[0-9]+$", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Users_getUsers_Response_200" } } }, "description": "Successful response" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Operation failed." }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Operation failed." }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Operation failed." }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Operation failed." }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ListUsers-v2026-01-01RequestInternalServerError" } } }, "description": "Internal Server Error" } }, "security": [ { "deelToken": [] } ], "summary": "List users", "tags": [ "users" ] } }, "/Users/{hris_profile_id}": { "get": { "description": "Retrieve a single user by id.\n\n **Token scopes**: `Users:read`", "operationId": "users_getUserById", "parameters": [ { "description": "The unique identifier (OID) of the HRIS profile to retrieve.", "in": "path", "name": "hris_profile_id", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Users_getUserById_Response_200" } } }, "description": "Successful response" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Operation failed." }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Operation failed." }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Operation failed." }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RetrieveASingleUser-v2026-01-01RequestNotFoundError" } } }, "description": "Resource not found - The provided hrisProfileOid does not exist." }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Operation failed." } }, "security": [ { "deelToken": [] } ], "summary": "Retrieve a single User", "tags": [ "users" ] } }, "/accounts-payable/vendor-bills": { "post": { "description": "Creates a new vendor bill in accounts payable, associating it with your organization. Attachments can be added to the bill via a subsequent call using the returned id.\n\n **Token scopes**: `treasury-vendorbill:write`", "operationId": "treasury_createVendorBill-v2026-01-01", "requestBody": { "content": { "application/json": { "schema": { "properties": { "data": { "$ref": "#/components/schemas/AccountsPayableVendorBillsPostRequestBodyContentApplicationJsonSchemaData" } }, "required": [ "data" ], "type": "object" } } }, "description": "Create vendor bills from external invoice provider data" }, "responses": { "201": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Treasury_createVendorBill-v2026-01-01_Response_201" } } }, "description": "Vendor bill created successfully" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreateVendorBill-v2026-01-01RequestBadRequestError" } } }, "description": "Bad request - validation error" }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContainer" } } }, "description": "Operation failed." }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContainer" } } }, "description": "Operation failed." }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContainer" } } }, "description": "Operation failed." }, "409": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreateVendorBill-v2026-01-01RequestConflictError" } } }, "description": "Conflict - duplicate reference" }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreateVendorBill-v2026-01-01RequestInternalServerError" } } }, "description": "Internal server error" } }, "security": [ { "deelToken": [] } ], "summary": "Create Vendor Bill", "tags": [ "treasury" ] } }, "/accounts-payable/vendor-bills/{vendor_bill_id}/attachments": { "post": { "description": "Attaches a PDF invoice file to an existing vendor bill, submitted as multipart/form-data. The target bill must already exist before this call is made.\n\n **Token scopes**: `treasury-vendorbill:write`", "operationId": "treasury_uploadVendorBillAttachment-v2026-01-01", "parameters": [ { "description": "Vendor bill id to attach the file to", "in": "path", "name": "vendor_bill_id", "required": true, "schema": { "format": "uuid", "type": "string" } } ], "requestBody": { "content": { "multipart/form-data": { "schema": { "properties": { "data": { "$ref": "#/components/schemas/AccountsPayableVendorBillsVendorBillIdAttachmentsPostRequestBodyContentMultipartFormDataSchemaData" } }, "required": [ "data" ], "type": "object" } } } }, "responses": { "201": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Treasury_uploadVendorBillAttachment-v2026-01-01_Response_201" } } }, "description": "File uploaded successfully" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UploadVendorBillAttachment-v2026-01-01RequestBadRequestError" } } }, "description": "Bad request - validation error" }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContainer" } } }, "description": "Operation failed." }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContainer" } } }, "description": "Operation failed." }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UploadVendorBillAttachment-v2026-01-01RequestNotFoundError" } } }, "description": "Vendor bill not found" }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UploadVendorBillAttachment-v2026-01-01RequestInternalServerError" } } }, "description": "Internal server error" } }, "security": [ { "deelToken": [] } ], "summary": "Upload Vendor Bill Attachment", "tags": [ "treasury" ] } }, "/adjustments": { "post": { "description": "Create a payroll adjustment for a contract to add or correct a payment amount on an upcoming payment cycle. Use this endpoint when you need to programmatically apply one-off adjustments; each adjustment must reference a valid category from `GET /rest/adjustments/categories`, which determines its type and accounting treatment.\n\n **Token scopes**: `adjustments:write`", "operationId": "adjustments_createContractAdjustment", "requestBody": { "content": { "application/json": { "schema": { "properties": { "data": { "$ref": "#/components/schemas/AdjustmentsPostRequestBodyContentApplicationJsonSchemaData", "description": "Details of adjustment to create" } }, "required": [ "data" ], "type": "object" } } }, "description": "Creation data for a new adjustment" }, "responses": { "201": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/adjustments_createContractAdjustment_Response_201" } } }, "description": "Successful operation." }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreateANewAdjustment-v2026-01-01RequestBadRequestError" } } }, "description": "Bad Request – failed to create adjustments" }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContainer" } } }, "description": "Operation failed." }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContainer" } } }, "description": "Operation failed." }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContainer" } } }, "description": "Operation failed." }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContainer" } } }, "description": "Operation failed." } }, "security": [ { "deelToken": [] } ], "summary": "Create a new adjustment", "tags": [ "Adjustments" ] } }, "/adjustments/categories": { "get": { "description": "Returns the available adjustment categories, optionally filtered by contract type. Category IDs returned here are required when creating adjustments and define the type and accounting treatment applied.\n\n **Token scopes**: `adjustments:read`", "operationId": "adjustments_getAdjustmentCategories", "parameters": [ { "description": "array of contract types to filter categories", "in": "query", "name": "contract_types", "required": false, "schema": { "default": [ "eor" ], "items": { "$ref": "#/components/schemas/AdjustmentsCategoriesGetParametersContractTypesSchemaItems" }, "type": "array" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/adjustments_getAdjustmentCategories_Response_200" } } }, "description": "Successful operation." }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContainer" } } }, "description": "Operation failed." }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContainer" } } }, "description": "Operation failed." }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContainer" } } }, "description": "Operation failed." }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContainer" } } }, "description": "Operation failed." }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContainer" } } }, "description": "Operation failed." } }, "security": [ { "deelToken": [] } ], "summary": "Retrieve categories", "tags": [ "Adjustments" ] } }, "/adjustments/{id}": { "delete": { "description": "Permanently deletes an adjustment by its id.\n\n **Token scopes**: `adjustments:write`", "operationId": "adjustments_deleteContractAdjustment", "parameters": [ { "description": "Deel adjustment id.", "in": "path", "name": "id", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/adjustments_deleteContractAdjustment_Response_200" } } }, "description": "Successful operation." }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContainer" } } }, "description": "Operation failed." }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContainer" } } }, "description": "Operation failed." }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContainer" } } }, "description": "Operation failed." }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContainer" } } }, "description": "Operation failed." }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContainer" } } }, "description": "Operation failed." } }, "security": [ { "deelToken": [] } ], "summary": "Delete an adjustment", "tags": [ "Adjustments" ] }, "get": { "description": "Retrieves a single adjustment by its id. Use it to track an adjustment after creation: approval happens inside Deel rather than over the API, so polling `status` is how a caller learns the outcome. Requires the `adjustments:read` scope.\n\n **Token scopes**: `adjustments:read`", "operationId": "adjustments_getContractAdjustment", "parameters": [ { "description": "Deel adjustment id.", "in": "path", "name": "id", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/adjustments_getContractAdjustment_Response_200" } } }, "description": "Successful operation." }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RetrieveAnAdjustment-v2026-01-01RequestBadRequestError" } } }, "description": "Operation failed." }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContainer" } } }, "description": "Operation failed." }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContainer" } } }, "description": "Operation failed." }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContainer" } } }, "description": "Operation failed." }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContainer" } } }, "description": "Operation failed." } }, "security": [ { "deelToken": [] } ], "summary": "Retrieve an adjustment", "tags": [ "Adjustments" ] }, "patch": { "description": "Updates an existing payroll or EOR adjustment identified by its id. Use it when an adjustment that has already been created needs correcting, such as a wrong amount, date, category or receipt, so the record keeps its id instead of being deleted with `DELETE /rest/adjustments/{id}` and recreated. Applies a partial update: only fields included in the request body are modified, and omitted fields keep their current values. Requires the `adjustments:write` scope.\n\n **Token scopes**: `adjustments:write`", "operationId": "adjustments_updateContractAdjustment", "parameters": [ { "description": "Deel adjustment id.", "in": "path", "name": "id", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "multipart/form-data": { "schema": { "properties": { "data": { "$ref": "#/components/schemas/AdjustmentsIdPatchRequestBodyContentMultipartFormDataSchemaData", "description": "Details of adjustment to update" } }, "required": [ "data" ], "type": "object" } } }, "description": "Adjustment object that needs to be updated" }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/adjustments_updateContractAdjustment_Response_200" } } }, "description": "Successful operation." }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UpdateAdjustment-v2026-01-01RequestBadRequestError" } } }, "description": "Bad Request – failed to update adjustment" }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContainer" } } }, "description": "Operation failed." }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContainer" } } }, "description": "Operation failed." }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContainer" } } }, "description": "Operation failed." }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContainer" } } }, "description": "Operation failed." } }, "security": [ { "deelToken": [] } ], "summary": "Update an adjustment", "tags": [ "Adjustments" ] } }, "/ats/application-forms/{application_form_id}": { "get": { "description": "Retrieves a single ATS application form by its unique ID within the specified organization. Use it when you need the full form definition and metadata, such as its title, status, and the pages, sections, and questions of the underlying form builder configuration, to display or process an application.\n\n **Token scopes**: `ats:read`, `worker:read`", "operationId": "ats_retrieveAtsApplicationForm-v2026-01-01", "parameters": [ { "description": "Id of the application form", "in": "path", "name": "application_form_id", "required": true, "schema": { "format": "uuid", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ATS_retrieveAtsApplicationForm-v2026-01-01_Response_200" } } }, "description": "Successful response with application form data" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RetrieveAtsApplicationForm-v2026-01-01RequestBadRequestError" } } }, "description": "Operation failed." }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContainer" } } }, "description": "Operation failed." }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RetrieveAtsApplicationForm-v2026-01-01RequestForbiddenError" } } }, "description": "Forbidden. ATS is not enabled for this organization or insufficient permissions." }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContainer" } } }, "description": "Operation failed." }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RetrieveAtsApplicationForm-v2026-01-01RequestInternalServerError" } } }, "description": "Operation failed." } }, "security": [ { "deelToken": [] } ], "summary": "Retrieve ATS Application form", "tags": [ "ats" ] } }, "/ats/application-sources": { "get": { "description": "Returns a paginated list of the application sources configured in the ATS. Use it to discover the valid source slugs for the `source_slugs` filter when listing applications, and to interpret the `source_slug` returned on an application.\n\n **Token scopes**: `ats:read`, `worker:read`", "operationId": "atsApplicationSources_retrieveAListOfAtsApplicationSources", "parameters": [ { "description": "Cursor for pagination", "in": "query", "name": "cursor", "required": false, "schema": { "type": "string" } }, { "description": "Maximum number of records returned in one response", "in": "query", "name": "limit", "required": false, "schema": { "default": 20, "maximum": 100, "minimum": 1, "type": "integer" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ats-application-sources_retrieveAListOfAtsApplicationSources_Response_200" } } }, "description": "Successfully retrieved application sources" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RetrieveAListOfAtsApplicationSources-v2026-01-01RequestBadRequestError" } } }, "description": "Operation failed." }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContainer" } } }, "description": "Operation failed." }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RetrieveAListOfAtsApplicationSources-v2026-01-01RequestForbiddenError" } } }, "description": "Forbidden. ATS is not enabled for this organization or insufficient permissions." }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContainer" } } }, "description": "Operation failed." }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RetrieveAListOfAtsApplicationSources-v2026-01-01RequestInternalServerError" } } }, "description": "Operation failed." } }, "security": [ { "deelToken": [] } ], "summary": "Retrieve a list of ATS application sources", "tags": [ "atsApplicationSources" ] } }, "/ats/applications": { "get": { "description": "Use this endpoint to trace where candidates stand in the hiring pipeline and how they got there — every interview plan stage an application has reached and when it entered and left each one.\n\n **Token scopes**: `ats:read`, `worker:read`", "operationId": "atsApplications_retrieveAListOfAtsApplications-v2026-01-01", "parameters": [ { "description": "Cursor for pagination. Use the nextCursor value from the previous response to get the next page of results.", "in": "query", "name": "cursor", "required": false, "schema": { "maxLength": 1000, "type": "string" } }, { "description": "Maximum number of applications to return per page", "in": "query", "name": "limit", "required": false, "schema": { "default": 20, "maximum": 500, "minimum": 1, "type": "integer" } }, { "description": "Search text to filter applications", "in": "query", "name": "search_text", "required": false, "schema": { "maxLength": 500, "type": "string" } }, { "description": "Filter by job ID", "in": "query", "name": "job_id", "required": false, "schema": { "format": "uuid", "type": "string" } }, { "description": "Filter by the CURRENT interview plan stage IDs (comma-separated). Applications that have since moved to another stage are excluded — use reached_interview_plan_stage_ids for those.", "in": "query", "name": "interview_plan_stage_ids", "required": false, "schema": { "items": { "format": "uuid", "type": "string" }, "type": "array" } }, { "description": "Filter by interview plan stage IDs the application has EVER been in (comma-separated), including applications that have since advanced, been hired or been archived.", "in": "query", "name": "reached_interview_plan_stage_ids", "required": false, "schema": { "items": { "format": "uuid", "type": "string" }, "type": "array" } }, { "description": "Return only applications that moved to their current stage strictly before this ISO 8601 datetime (stalled candidates)", "in": "query", "name": "moved_to_current_stage_before", "required": false, "schema": { "format": "date-time", "type": "string" } }, { "description": "Filter by archivation reason IDs (comma-separated); see GET /rest/ats/reasons with reason_group_slug=CANDIDATE_ARCHIVATION", "in": "query", "name": "archivation_reason_ids", "required": false, "schema": { "items": { "format": "uuid", "type": "string" }, "type": "array" } }, { "description": "How candidate_tag_ids are combined: ANY (default) matches candidates with at least one of the tags, ALL requires every tag", "in": "query", "name": "candidate_tag_ids_operator", "required": false, "schema": { "$ref": "#/components/schemas/AtsApplicationsGetParametersCandidateTagIdsOperator" } }, { "description": "Optional expansions to embed on each item. STAGE_HISTORY adds the full stage timeline with entered/exited timestamps.", "in": "query", "name": "include", "required": false, "schema": { "items": { "$ref": "#/components/schemas/AtsApplicationsGetParametersIncludeSchemaItems" }, "type": "array" } }, { "description": "Filter by candidate tag IDs (comma-separated)", "in": "query", "name": "candidate_tag_ids", "required": false, "schema": { "items": { "format": "uuid", "type": "string" }, "type": "array" } }, { "description": "Filter by application source (comma-separated)", "in": "query", "name": "source_slugs", "required": false, "schema": { "items": { "type": "string" }, "type": "array" } }, { "description": "Filter applications by job criteria matching state", "in": "query", "name": "job_criterias_matchings", "required": false, "schema": { "items": { "$ref": "#/components/schemas/AtsApplicationsGetParametersJobCriteriasMatchingsSchemaItems" }, "type": "array" } }, { "description": "Filter applications by current stage category type slugs. Accepted values are lead, active and completed, in either case — the job list reports them uppercase and this filter accepts that form too.", "in": "query", "name": "current_stage_category_type_slugs", "required": false, "schema": { "items": { "maxLength": 50, "type": "string" }, "type": "array" } }, { "description": "Filter applications by current stage default type slugs (e.g. new_lead, application_review, offer, hired, archived), in either case. Use 'others' for custom stages.", "in": "query", "name": "current_stage_default_type_slugs", "required": false, "schema": { "items": { "maxLength": 50, "type": "string" }, "type": "array" } }, { "description": "Filter applications updated after this timestamp (ISO 8601 format)", "in": "query", "name": "updated_after", "required": false, "schema": { "format": "date-time", "type": "string" } }, { "description": "Field to sort applications by", "in": "query", "name": "sort_by", "required": false, "schema": { "$ref": "#/components/schemas/AtsApplicationsGetParametersSortBy" } }, { "description": "Sort order for applications", "in": "query", "name": "sort_order", "required": false, "schema": { "$ref": "#/components/schemas/AtsApplicationsGetParametersSortOrder" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ats-applications_retrieveAListOfAtsApplications-v2026-01-01_Response_200" } } }, "description": "Successfully retrieved applications" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RetrieveAListOfAtsApplications-v2026-01-01RequestBadRequestError" } } }, "description": "Operation failed." }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContainer" } } }, "description": "Operation failed." }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RetrieveAListOfAtsApplications-v2026-01-01RequestForbiddenError" } } }, "description": "Forbidden. ATS is not enabled for this organization or insufficient permissions." }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContainer" } } }, "description": "Operation failed." }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RetrieveAListOfAtsApplications-v2026-01-01RequestInternalServerError" } } }, "description": "Operation failed." } }, "security": [ { "deelToken": [] } ], "summary": "Retrieve a list of ATS applications", "tags": [ "atsApplications" ] }, "post": { "description": "Creates a new ATS application linking an existing candidate to an existing job. Both the candidate and job must exist prior to this call; the returned id can be used for subsequent operations such as adding notes or associating interview stages.\n\n **Token scopes**: `ats:write`, `worker:write`", "operationId": "atsApplications_createAtsApplication-v2026-01-01", "requestBody": { "content": { "application/json": { "schema": { "properties": { "data": { "$ref": "#/components/schemas/AtsApplicationsPostRequestBodyContentApplicationJsonSchemaData" } }, "required": [ "data" ], "type": "object" } } }, "description": "Create application request" }, "responses": { "201": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ats-applications_createAtsApplication-v2026-01-01_Response_201" } } }, "description": "Successful response with application data" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreateApplication-v2026-01-01RequestBadRequestError" } } }, "description": "Operation failed." }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContainer" } } }, "description": "Operation failed." }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreateApplication-v2026-01-01RequestForbiddenError" } } }, "description": "Forbidden. ATS is not enabled for this organization or insufficient permissions." }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContainer" } } }, "description": "Operation failed." }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreateApplication-v2026-01-01RequestInternalServerError" } } }, "description": "Operation failed." } }, "security": [ { "deelToken": [] } ], "summary": "Create ATS Application", "tags": [ "atsApplications" ] } }, "/ats/applications/{application_id}": { "get": { "description": "Retrieves one ATS application by application_id, including its full interview-stage timeline — when it entered and left each stage and who moved it — not just its current status. Use it to check where a candidate stands or to reconstruct how an application progressed.\n\n **Token scopes**: `ats:read`, `worker:read`", "operationId": "atsApplications_retrieveAtsApplication-v2026-01-01", "parameters": [ { "description": "Application ID", "in": "path", "name": "application_id", "required": true, "schema": { "format": "uuid", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ats-applications_retrieveAtsApplication-v2026-01-01_Response_200" } } }, "description": "Successfully retrieved application" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RetrieveAtsApplication-v2026-01-01RequestBadRequestError" } } }, "description": "Operation failed." }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContainer" } } }, "description": "Operation failed." }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RetrieveAtsApplication-v2026-01-01RequestForbiddenError" } } }, "description": "Forbidden. ATS is not enabled for this organization or insufficient permissions." }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContainer" } } }, "description": "Operation failed." }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RetrieveAtsApplication-v2026-01-01RequestInternalServerError" } } }, "description": "Operation failed." } }, "security": [ { "deelToken": [] } ], "summary": "Retrieve ATS application", "tags": [ "atsApplications" ] }, "patch": { "description": "Updates an existing application in the ATS. Currently supports updating the application source (source_slug), e.g. to mark an application as internally sourced or as an internal referral.\n\n **Token scopes**: `ats:write`, `worker:write`", "operationId": "ats_updateAtsApplication-v2026-09-17", "parameters": [ { "description": "Unique identifier of the application to update", "in": "path", "name": "application_id", "required": true, "schema": { "format": "uuid", "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "properties": { "data": { "$ref": "#/components/schemas/AtsApplicationsApplicationIdPatchRequestBodyContentApplicationJsonSchemaData" } }, "required": [ "data" ], "type": "object" } } }, "description": "Update application request" }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ATS_updateAtsApplication-v2026-09-17_Response_200" } } }, "description": "Successful response with the updated application data" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UpdateAtsApplication-v2026-09-17RequestBadRequestError" } } }, "description": "Operation failed." }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContainer" } } }, "description": "Operation failed." }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UpdateAtsApplication-v2026-09-17RequestForbiddenError" } } }, "description": "Forbidden. ATS is not enabled for this organization or insufficient permissions." }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContainer" } } }, "description": "Operation failed." }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UpdateAtsApplication-v2026-09-17RequestInternalServerError" } } }, "description": "Operation failed." } }, "security": [ { "deelToken": [] } ], "summary": "Update ATS Application", "tags": [ "ats" ] } }, "/ats/applications/{application_id}/feedbacks": { "get": { "description": "Retrieves the feedback a hiring panel has recorded against one application's interviews and evaluations. Use it to pull scorecards into an external reporting, analytics or compliance system, or to decide whether a candidate is ready to advance: only NOT_SUBMITTED is still outstanding, while DISMISSED and REVOKED are resolved outcomes that will never produce a submission and should not be waited on.\n\n **Token scopes**: `ats:read`, `worker:read`\n\n **Beta**: this version requires the `X-Beta: true` request header and its contract may change before it is promoted to stable. It is scheduled to become stable on 2027-01-23.", "operationId": "ats_listApplicationFeedbacks-v2026-07-02", "parameters": [ { "description": "Unique identifier of the application to retrieve feedbacks for.", "in": "path", "name": "application_id", "required": true, "schema": { "format": "uuid", "type": "string" } }, { "description": "Filter feedbacks by submission status.", "in": "query", "name": "status", "required": false, "schema": { "$ref": "#/components/schemas/AtsApplicationsApplicationIdFeedbacksGetParametersStatus" } }, { "description": "When true, form responses marked as sensitive are omitted from the response. Defaults to true.", "in": "query", "name": "should_hide_sensitive_fields", "required": false, "schema": { "type": "boolean" } }, { "description": "Pagination cursor returned by a previous response.", "in": "query", "name": "cursor", "required": false, "schema": { "type": "string" } }, { "description": "Maximum number of feedbacks to return per page.", "in": "query", "name": "limit", "required": false, "schema": { "maximum": 100, "minimum": 1, "type": "integer" } }, { "description": "Opts in to the beta version of this endpoint. Must be `true`.", "in": "header", "name": "X-Beta", "required": true, "schema": { "$ref": "#/components/schemas/AtsApplicationsApplicationIdFeedbacksGetParametersXBeta" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ATS_listApplicationFeedbacks-v2026-07-02_Response_200" } } }, "description": "Paginated list of application feedbacks." }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ListApplicationFeedbacks-v2026-07-02RequestBadRequestError" } } }, "description": "Operation failed." }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContainer" } } }, "description": "Operation failed." }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ListApplicationFeedbacks-v2026-07-02RequestForbiddenError" } } }, "description": "Forbidden. ATS is not enabled for this organization or insufficient permissions." }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContainer" } } }, "description": "Operation failed." }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ListApplicationFeedbacks-v2026-07-02RequestInternalServerError" } } }, "description": "Operation failed." } }, "security": [ { "deelToken": [] } ], "summary": "List feedbacks for an application", "tags": [ "ats" ] } }, "/ats/applications/{application_id}/interview-plan-stages": { "post": { "description": "Associates an application with a specific interview plan stage. Set `is_current_stage` to `true` to advance the application's active stage, or `false` to record a historical stage entry without changing the current stage. Pass `applicable_job_activities` to selectively trigger activities, omit it to trigger all, or pass an empty array to trigger none; if archiving the candidate, include `candidate_archivation_reason_id` and optionally `candidate_archivation_email_template_id` to send a rejection email.\n\n **Token scopes**: `ats:write`, `worker:write`", "operationId": "atsApplications_associateApplicationWithAnInterviewPlanStage-v2026-01-01", "parameters": [ { "description": "ID of the application to be associated with the interview plan stage", "in": "path", "name": "application_id", "required": true, "schema": { "format": "uuid", "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "properties": { "data": { "$ref": "#/components/schemas/AtsApplicationsApplicationIdInterviewPlanStagesPostRequestBodyContentApplicationJsonSchemaData" } }, "required": [ "data" ], "type": "object" } } } }, "responses": { "201": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ats-applications_associateApplicationWithAnInterviewPlanStage-v2026-01-01_Response_201" } } }, "description": "Application interview plan stage successfully created" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AssociateApplicationWithAnInterviewPlanStage-v2026-01-01RequestBadRequestError" } } }, "description": "Operation failed." }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContainer" } } }, "description": "Operation failed." }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AssociateApplicationWithAnInterviewPlanStage-v2026-01-01RequestForbiddenError" } } }, "description": "Forbidden. ATS is not enabled for this organization or insufficient permissions." }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContainer" } } }, "description": "Operation failed." }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AssociateApplicationWithAnInterviewPlanStage-v2026-01-01RequestInternalServerError" } } }, "description": "Operation failed." } }, "security": [ { "deelToken": [] } ], "summary": "Assign application to interview plan stage", "tags": [ "atsApplications" ] } }, "/ats/applications/{application_id}/notes": { "post": { "description": "Adds a note to a specific application. The `author_id` must correspond to a valid HRIS user.\n\n **Token scopes**: `ats:write`, `ats.applications.notes:write`", "operationId": "atsApplications_addNoteToAnApplication-v2026-01-01", "parameters": [ { "description": "Id of the application which the note will be added", "in": "path", "name": "application_id", "required": true, "schema": { "format": "uuid", "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "properties": { "data": { "$ref": "#/components/schemas/AtsApplicationsApplicationIdNotesPostRequestBodyContentApplicationJsonSchemaData" } }, "required": [ "data" ], "type": "object" } } } }, "responses": { "201": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ats-applications_addNoteToAnApplication-v2026-01-01_Response_201" } } }, "description": "Application note created successfully" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AddNoteToAnApplication-v2026-01-01RequestBadRequestError" } } }, "description": "Operation failed." }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContainer" } } }, "description": "Operation failed." }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AddNoteToAnApplication-v2026-01-01RequestForbiddenError" } } }, "description": "Forbidden. ATS is not enabled for this organization or insufficient permissions." }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContainer" } } }, "description": "Operation failed." }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AddNoteToAnApplication-v2026-01-01RequestInternalServerError" } } }, "description": "Operation failed." } }, "security": [ { "deelToken": [] } ], "summary": "Add note to an application", "tags": [ "atsApplications" ] } }, "/ats/attachments/{attachable_type_slug}/{attachable_id}/{attachment_type_slug}": { "get": { "description": "Lists the files attached to an ATS record, each with a time-limited download URL. Use it to read back or download documents uploaded earlier; to add a file, use `POST /rest/ats/attachments/{attachable_type_slug}/{attachable_id}/{attachment_type_slug}`.\n\n **Token scopes**: `ats:read`, `worker:read`", "operationId": "atsAttachments_retrievePaginatedListOfAtsAttachmentFiles-v2026-01-01", "parameters": [ { "description": "Type of the attachable entity", "in": "path", "name": "attachable_type_slug", "required": true, "schema": { "$ref": "#/components/schemas/AtsAttachmentsAttachableTypeSlugAttachableIdAttachmentTypeSlugGetParametersAttachableTypeSlug" } }, { "description": "Unique identifier for the attachable entity", "in": "path", "name": "attachable_id", "required": true, "schema": { "format": "uuid", "type": "string" } }, { "description": "Type of the attachment", "in": "path", "name": "attachment_type_slug", "required": true, "schema": { "$ref": "#/components/schemas/AtsAttachmentsAttachableTypeSlugAttachableIdAttachmentTypeSlugGetParametersAttachmentTypeSlug" } }, { "description": "The cursor for pagination", "in": "query", "name": "cursor", "required": false, "schema": { "maxLength": 1000, "type": "string" } }, { "description": "Maximum number of records returned in one response", "in": "query", "name": "limit", "required": false, "schema": { "default": 20, "maximum": 100, "minimum": 1, "type": "integer" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ats-attachments_retrievePaginatedListOfAtsAttachmentFiles-v2026-01-01_Response_200" } } }, "description": "Successful operation." }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RetrievePaginatedListOfAtsAttachmentFiles-v2026-01-01RequestBadRequestError" } } }, "description": "Operation failed." }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContainer" } } }, "description": "Operation failed." }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RetrievePaginatedListOfAtsAttachmentFiles-v2026-01-01RequestForbiddenError" } } }, "description": "Forbidden. ATS is not enabled for this organization or insufficient permissions." }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContainer" } } }, "description": "Operation failed." }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RetrievePaginatedListOfAtsAttachmentFiles-v2026-01-01RequestInternalServerError" } } }, "description": "Operation failed." } }, "security": [ { "deelToken": [] } ], "summary": "Retrieve paginated list of ATS attachment files", "tags": [ "atsAttachments" ] }, "post": { "description": "Uploads a file and attaches it to an ATS candidate, offer, or job activity. Use this in preference to POST /rest/ats/candidates/{candidate_id}/attachments, which only accepts a candidate CV, whenever you need to attach any other file type.\n\n **Token scopes**: `ats:write`, `worker:write`\n\n **Beta**: this version requires the `X-Beta: true` request header and its contract may change before it is promoted to stable. It is scheduled to become stable on 2026-12-29.", "operationId": "ats_createAtsAttachmentFile-v2026-01-01", "parameters": [ { "description": "Type of the entity the file is attached to", "in": "path", "name": "attachable_type_slug", "required": true, "schema": { "$ref": "#/components/schemas/AtsAttachmentsAttachableTypeSlugAttachableIdAttachmentTypeSlugPostParametersAttachableTypeSlug" } }, { "description": "Unique identifier of the entity the file is attached to", "in": "path", "name": "attachable_id", "required": true, "schema": { "format": "uuid", "type": "string" } }, { "description": "Type of the attachment being created", "in": "path", "name": "attachment_type_slug", "required": true, "schema": { "$ref": "#/components/schemas/AtsAttachmentsAttachableTypeSlugAttachableIdAttachmentTypeSlugPostParametersAttachmentTypeSlug" } }, { "description": "Opts in to the beta version of this endpoint. Must be `true`.", "in": "header", "name": "X-Beta", "required": true, "schema": { "$ref": "#/components/schemas/AtsAttachmentsAttachableTypeSlugAttachableIdAttachmentTypeSlugPostParametersXBeta" } } ], "requestBody": { "content": { "multipart/form-data": { "schema": { "properties": { "data": { "$ref": "#/components/schemas/AtsAttachmentsAttachableTypeSlugAttachableIdAttachmentTypeSlugPostRequestBodyContentMultipartFormDataSchemaData" } }, "required": [ "data" ], "type": "object" } } } }, "responses": { "201": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ATS_createAtsAttachmentFile-v2026-01-01_Response_201" } } }, "description": "Successful response with the created attachment data" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreateAtsAttachmentFile-v2026-01-01RequestBadRequestError" } } }, "description": "Operation failed." }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContainer" } } }, "description": "Operation failed." }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreateAtsAttachmentFile-v2026-01-01RequestForbiddenError" } } }, "description": "Forbidden. ATS is not enabled for this organization or insufficient permissions." }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContainer" } } }, "description": "Operation failed." }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreateAtsAttachmentFile-v2026-01-01RequestInternalServerError" } } }, "description": "Operation failed." } }, "security": [ { "deelToken": [] } ], "summary": "Upload an ATS attachment file", "tags": [ "ats" ] } }, "/ats/candidates": { "get": { "description": "Returns a paginated list of candidates, optionally filtered by job IDs, department IDs, tag IDs, current stage category or default type slugs, or a timestamp to return only records updated after a given point.\n\n **Token scopes**: `ats:read`", "operationId": "atsCandidates_retrievePaginatedListOfAtsCandidates-v2026-01-01", "parameters": [ { "description": "The cursor for pagination", "in": "query", "name": "cursor", "required": false, "schema": { "type": "string" } }, { "description": "Maximum number of records returned in one response", "in": "query", "name": "limit", "required": false, "schema": { "default": 20, "maximum": 100, "minimum": 1, "type": "integer" } }, { "description": "Search text for filtering candidates", "in": "query", "name": "search", "required": false, "schema": { "type": "string" } }, { "description": "Filter candidates by job IDs", "in": "query", "name": "job_ids", "required": false, "schema": { "items": { "format": "uuid", "type": "string" }, "type": "array" } }, { "description": "Filter candidates by department IDs", "in": "query", "name": "department_ids", "required": false, "schema": { "items": { "format": "uuid", "type": "string" }, "type": "array" } }, { "description": "Filter candidates by tag IDs", "in": "query", "name": "tag_ids", "required": false, "schema": { "items": { "format": "uuid", "type": "string" }, "type": "array" } }, { "description": "Filter candidates by current stage category type slugs", "in": "query", "name": "current_stage_category_type_slugs", "required": false, "schema": { "items": { "type": "string" }, "type": "array" } }, { "description": "Filter candidates by current stage default type slugs", "in": "query", "name": "current_stage_default_type_slugs", "required": false, "schema": { "items": { "type": "string" }, "type": "array" } }, { "description": "Filter applications updated after this timestamp (ISO 8601 format)", "in": "query", "name": "updated_after", "required": false, "schema": { "format": "date-time", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ats-candidates_retrievePaginatedListOfAtsCandidates-v2026-01-01_Response_200" } } }, "description": "Successful operation." }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RetrievePaginatedListOfAtsCandidates-v2026-01-01RequestBadRequestError" } } }, "description": "Operation failed." }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContainer" } } }, "description": "Operation failed." }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RetrievePaginatedListOfAtsCandidates-v2026-01-01RequestForbiddenError" } } }, "description": "Forbidden. ATS is not enabled for this organization or insufficient permissions." }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContainer" } } }, "description": "Operation failed." }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RetrievePaginatedListOfAtsCandidates-v2026-01-01RequestInternalServerError" } } }, "description": "Operation failed." } }, "security": [ { "deelToken": [] } ], "summary": "Retrieve paginated list of ATS Candidates", "tags": [ "atsCandidates" ] }, "post": { "description": "Creates a candidate record without creating a job application. Use it to add a person to the ATS before applying them to a job with `POST /rest/ats/applications`; to change an existing candidate use `PATCH /rest/ats/candidates/{candidate_id}`, and to add a CV to one use `POST /rest/ats/candidates/{candidate_id}/attachments`.\n\n **Token scopes**: `ats:write`, `worker:write`", "operationId": "atsCandidates_createAtsCandidate-v2026-01-01", "requestBody": { "content": { "application/json": { "schema": { "properties": { "data": { "$ref": "#/components/schemas/AtsCandidatesPostRequestBodyContentApplicationJsonSchemaData" } }, "required": [ "data" ], "type": "object" } } } }, "responses": { "201": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ats-candidates_createAtsCandidate-v2026-01-01_Response_201" } } }, "description": "Successful response with candidate data" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreateAtsCandidate-v2026-01-01RequestBadRequestError" } } }, "description": "Operation failed." }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContainer" } } }, "description": "Operation failed." }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreateAtsCandidate-v2026-01-01RequestForbiddenError" } } }, "description": "Forbidden. ATS is not enabled for this organization or insufficient permissions." }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContainer" } } }, "description": "Operation failed." }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreateAtsCandidate-v2026-01-01RequestInternalServerError" } } }, "description": "Operation failed." } }, "security": [ { "deelToken": [] } ], "summary": "Create ATS Candidate", "tags": [ "atsCandidates" ] } }, "/ats/candidates/{candidate_id}": { "get": { "description": "Retrieve the complete detail for a single candidate in one call rather than fetching each part separately. The applications included are limited to the jobs the authenticated caller is permitted to see, so the set returned can vary by caller.\n\n **Token scopes**: `ats:read`, `worker:read`", "operationId": "ats_retrieveAtsCandidate-v2026-09-18", "parameters": [ { "description": "Unique identifier of the candidate.", "in": "path", "name": "candidate_id", "required": true, "schema": { "format": "uuid", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ATS_retrieveAtsCandidate-v2026-09-18_Response_200" } } }, "description": "Candidate detail." }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RetrieveAtsCandidate-v2026-09-18RequestBadRequestError" } } }, "description": "Operation failed." }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContainer" } } }, "description": "Operation failed." }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RetrieveAtsCandidate-v2026-09-18RequestForbiddenError" } } }, "description": "Forbidden. ATS is not enabled for this organization or insufficient permissions." }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContainer" } } }, "description": "Operation failed." }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RetrieveAtsCandidate-v2026-09-18RequestInternalServerError" } } }, "description": "Operation failed." } }, "security": [ { "deelToken": [] } ], "summary": "Retrieve an ATS candidate", "tags": [ "ats" ] }, "patch": { "description": "Updates an existing candidate record in the ATS. All fields are optional — only the provided fields are updated. Use origin_source_slug to set or correct the candidate source (e.g. sourced_internally).\n\n **Token scopes**: `ats:write`, `worker:write`", "operationId": "ats_updateAtsCandidate-v2026-09-16", "parameters": [ { "description": "Unique identifier of the candidate to update", "in": "path", "name": "candidate_id", "required": true, "schema": { "format": "uuid", "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "properties": { "data": { "$ref": "#/components/schemas/AtsCandidatesCandidateIdPatchRequestBodyContentApplicationJsonSchemaData" } }, "required": [ "data" ], "type": "object" } } }, "description": "Update candidate request. At least one field must be provided." }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ATS_updateAtsCandidate-v2026-09-16_Response_200" } } }, "description": "Successful response with the updated candidate data" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UpdateAtsCandidate-v2026-09-16RequestBadRequestError" } } }, "description": "Operation failed." }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContainer" } } }, "description": "Operation failed." }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UpdateAtsCandidate-v2026-09-16RequestForbiddenError" } } }, "description": "Forbidden. ATS is not enabled for this organization or insufficient permissions." }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContainer" } } }, "description": "Operation failed." }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UpdateAtsCandidate-v2026-09-16RequestInternalServerError" } } }, "description": "Operation failed." } }, "security": [ { "deelToken": [] } ], "summary": "Update ATS Candidate", "tags": [ "ats" ] } }, "/ats/candidates/{candidate_id}/attachments": { "post": { "description": "Upload a CV file for an existing candidate. Use this endpoint after creating a candidate to attach their resume or CV document. This stores the file as the candidate's primary CV attachment for later retrieval and processing.\n\n **Token scopes**: `ats:write`, `worker:write`", "operationId": "ats_createAtsCandidateAttachment-v2026-09-16", "parameters": [ { "description": "Unique identifier of the candidate to attach the file to", "in": "path", "name": "candidate_id", "required": true, "schema": { "format": "uuid", "type": "string" } } ], "requestBody": { "content": { "multipart/form-data": { "schema": { "properties": { "data": { "$ref": "#/components/schemas/AtsCandidatesCandidateIdAttachmentsPostRequestBodyContentMultipartFormDataSchemaData" } }, "required": [ "data" ], "type": "object" } } } }, "responses": { "201": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ATS_createAtsCandidateAttachment-v2026-09-16_Response_201" } } }, "description": "Successful response with the created attachment data" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreateAtsCandidateAttachment-v2026-09-16RequestBadRequestError" } } }, "description": "Operation failed." }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContainer" } } }, "description": "Operation failed." }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreateAtsCandidateAttachment-v2026-09-16RequestForbiddenError" } } }, "description": "Forbidden. ATS is not enabled for this organization or insufficient permissions." }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContainer" } } }, "description": "Operation failed." }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreateAtsCandidateAttachment-v2026-09-16RequestInternalServerError" } } }, "description": "Operation failed." } }, "security": [ { "deelToken": [] } ], "summary": "Upload ATS Candidate CV", "tags": [ "ats" ] } }, "/ats/candidates/{candidate_id}/notes": { "post": { "description": "Adds a note to a candidate — the candidate-level counterpart to the application-notes endpoint. Use this when feedback applies to the candidate overall rather than to a single application; the note then stays visible across all of that candidate's applications.\n\n **Token scopes**: `ats:write`, `worker:write`\n\n **Beta**: this version requires the `X-Beta: true` request header and its contract may change before it is promoted to stable. It is scheduled to become stable on 2026-12-29.", "operationId": "ats_addNoteToACandidate-v2026-01-01", "parameters": [ { "description": "Id of the candidate which the note will be added", "in": "path", "name": "candidate_id", "required": true, "schema": { "format": "uuid", "type": "string" } }, { "description": "Opts in to the beta version of this endpoint. Must be `true`.", "in": "header", "name": "X-Beta", "required": true, "schema": { "$ref": "#/components/schemas/AtsCandidatesCandidateIdNotesPostParametersXBeta" } } ], "requestBody": { "content": { "application/json": { "schema": { "properties": { "data": { "$ref": "#/components/schemas/AtsCandidatesCandidateIdNotesPostRequestBodyContentApplicationJsonSchemaData" } }, "required": [ "data" ], "type": "object" } } } }, "responses": { "201": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ATS_addNoteToACandidate-v2026-01-01_Response_201" } } }, "description": "Candidate note created successfully" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AddNoteToACandidate-v2026-01-01RequestBadRequestError" } } }, "description": "Operation failed." }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContainer" } } }, "description": "Operation failed." }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AddNoteToACandidate-v2026-01-01RequestForbiddenError" } } }, "description": "Forbidden. ATS is not enabled for this organization or insufficient permissions." }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContainer" } } }, "description": "Operation failed." }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AddNoteToACandidate-v2026-01-01RequestInternalServerError" } } }, "description": "Operation failed." } }, "security": [ { "deelToken": [] } ], "summary": "Add note to a candidate", "tags": [ "ats" ] } }, "/ats/candidates/{candidate_id}/tags": { "post": { "deprecated": true, "description": "Replaces all existing tags on a candidate with the provided set of `tag_ids`. This is a full replacement — any tags not included in the request body will be removed.\n\n **Token scopes**: `ats:write`\n\n **Deprecated**: a newer version of this endpoint is available. This version is scheduled for removal on 2027-08-10.\n\n **Beta version available**: version `2026-08-10` of this endpoint is in beta. Send `X-Beta: true` to call it.", "operationId": "atsCandidates_createCandidateTags-v2026-02-27", "parameters": [ { "description": "The unique identifier of the candidate.", "in": "path", "name": "candidate_id", "required": true, "schema": { "format": "uuid", "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "properties": { "tag_ids": { "description": "List of tag IDs to associate with the candidate", "items": { "format": "uuid", "type": "string" }, "type": "array" } }, "required": [ "tag_ids" ], "type": "object" } } } }, "responses": { "201": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ats-candidates_createCandidateTags-v2026-02-27_Response_201" } } }, "description": "Successfully created" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreateCandidateTags-v2024-06-12RequestBadRequestError" } } }, "description": "Operation failed." }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContainer" } } }, "description": "Operation failed." }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreateCandidateTags-v2024-06-12RequestForbiddenError" } } }, "description": "Forbidden. ATS is not enabled for this organization or insufficient permissions." }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContainer" } } }, "description": "Operation failed." }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreateCandidateTags-v2024-06-12RequestInternalServerError" } } }, "description": "Operation failed." } }, "security": [ { "deelToken": [] } ], "summary": "Create candidate tags", "tags": [ "atsCandidates" ] } }, "/ats/departments": { "get": { "description": "Returns a paginated list of all departments configured in the organization's ATS. Use it to resolve the department IDs accepted by the `department_ids` filter when listing jobs and by job creation, and page through results with the `cursor` and `limit` query parameters.\n\n **Token scopes**: `ats:read`, `worker:read`", "operationId": "atsDepartments_retrieveAListOfAtsDepartments", "parameters": [ { "description": "Cursor for pagination to get the next set of results", "in": "query", "name": "cursor", "required": false, "schema": { "type": "string" } }, { "description": "Maximum number of records returned in one response", "in": "query", "name": "limit", "required": false, "schema": { "default": 20, "maximum": 100, "minimum": 1, "type": "integer" } }, { "description": "If true, archived departments are included in the response; they are excluded by default", "in": "query", "name": "include_archived", "required": false, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ats-departments_retrieveAListOfAtsDepartments_Response_200" } } }, "description": "Successful response with departments data" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RetrieveAListOfAtsDepartments-v2026-01-01RequestBadRequestError" } } }, "description": "Operation failed." }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContainer" } } }, "description": "Operation failed." }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RetrieveAListOfAtsDepartments-v2026-01-01RequestForbiddenError" } } }, "description": "Forbidden. ATS is not enabled for this organization or insufficient permissions." }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContainer" } } }, "description": "Operation failed." }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RetrieveAListOfAtsDepartments-v2026-01-01RequestInternalServerError" } } }, "description": "Operation failed." } }, "security": [ { "deelToken": [] } ], "summary": "Retrieve a list of ATS departments", "tags": [ "atsDepartments" ] } }, "/ats/email-templates": { "get": { "description": "Lists the published email templates of the organization. Use it to see which templates exist, or to keep a local copy in sync by fetching only those updated since your last check. Drafts and template bodies are not included.\n\n **Token scopes**: `ats:read`, `worker:read`", "operationId": "atsEmailTemplates_retrieveAListOfPublishedAtsEmailTemplates-v2026-02-11", "parameters": [ { "description": "Cursor for pagination. Use the nextCursor value from the previous response to get the next page of results.", "in": "query", "name": "cursor", "required": false, "schema": { "maxLength": 1000, "type": "string" } }, { "description": "Maximum number of email templates to return per page", "in": "query", "name": "limit", "required": false, "schema": { "default": 20, "maximum": 100, "minimum": 1, "type": "integer" } }, { "description": "Return only email templates that were updated after this timestamp (ISO 8601 format)", "in": "query", "name": "updated_after", "required": false, "schema": { "format": "date-time", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ats-email-templates_retrieveAListOfPublishedAtsEmailTemplates-v2026-02-11_Response_200" } } }, "description": "Successfully retrieved email templates" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RetrieveAListOfPublishedAtsEmailTemplates-v2026-02-11RequestBadRequestError" } } }, "description": "Invalid query parameters" }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContainer" } } }, "description": "Operation failed." }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RetrieveAListOfPublishedAtsEmailTemplates-v2026-02-11RequestForbiddenError" } } }, "description": "Forbidden. ATS is not enabled for this organization or insufficient permissions." }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContainer" } } }, "description": "Operation failed." }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RetrieveAListOfPublishedAtsEmailTemplates-v2026-02-11RequestInternalServerError" } } }, "description": "Operation failed." } }, "security": [ { "deelToken": [] } ], "summary": "Retrieve a list of published ATS email templates", "tags": [ "atsEmailTemplates" ] } }, "/ats/employment-types": { "get": { "description": "Returns a paginated list of employment types available in the organization's ATS. Use it to resolve the employment type IDs required when creating a job and accepted by the `employment_type_ids` filter when listing jobs.\n\n **Token scopes**: `ats:read`", "operationId": "atsEmploymentTypes_retrieveAListOfAtsEmploymentTypes", "parameters": [ { "description": "The cursor for pagination", "in": "query", "name": "cursor", "required": false, "schema": { "type": "string" } }, { "description": "Maximum number of records returned in one response", "in": "query", "name": "limit", "required": false, "schema": { "default": 20, "maximum": 100, "minimum": 1, "type": "integer" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ats-employment-types_retrieveAListOfAtsEmploymentTypes_Response_200" } } }, "description": "Successful response with employment types data" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RetrieveAListOfAtsEmploymentTypes-v2026-01-01RequestBadRequestError" } } }, "description": "Operation failed." }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContainer" } } }, "description": "Operation failed." }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RetrieveAListOfAtsEmploymentTypes-v2026-01-01RequestForbiddenError" } } }, "description": "Forbidden. ATS is not enabled for this organization or insufficient permissions." }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContainer" } } }, "description": "Operation failed." }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RetrieveAListOfAtsEmploymentTypes-v2026-01-01RequestInternalServerError" } } }, "description": "Operation failed." } }, "security": [ { "deelToken": [] } ], "summary": "Retrieve a list of ATS employment types", "tags": [ "atsEmploymentTypes" ] } }, "/ats/feedbacks": { "get": { "description": "Use this endpoint to pull organization-wide interview feedback when following up across candidates and jobs — for example, after filtering interviews or applications by stage, call this to see which reviewers still owe feedback (status=NOT_SUBMITTED) or what they recommended, without fetching each application individually.\n\n **Token scopes**: `ats:read`, `worker:read`", "operationId": "ats_listFeedbacks-v2026-09-18", "parameters": [ { "description": "Filter feedback by job IDs.", "in": "query", "name": "job_ids", "required": false, "schema": { "items": { "format": "uuid", "type": "string" }, "type": "array" } }, { "description": "Filter feedback by application IDs.", "in": "query", "name": "application_ids", "required": false, "schema": { "items": { "format": "uuid", "type": "string" }, "type": "array" } }, { "description": "Filter feedback by candidate IDs.", "in": "query", "name": "candidate_ids", "required": false, "schema": { "items": { "format": "uuid", "type": "string" }, "type": "array" } }, { "description": "Filter feedback by the HRIS organization user IDs of the reviewers (interviewers) who owe or submitted it.", "in": "query", "name": "reviewer_hris_organization_user_ids", "required": false, "schema": { "items": { "format": "uuid", "type": "string" }, "type": "array" } }, { "description": "Filter feedback by the interview plan stage of the activity it belongs to (stage ids from GET /rest/ats/jobs/{job_id}/interview-plan-stages).", "in": "query", "name": "interview_plan_stage_ids", "required": false, "schema": { "items": { "format": "uuid", "type": "string" }, "type": "array" } }, { "description": "Filter feedback by the scheduled interview it was collected for (ids from GET /rest/ats/interviews).", "in": "query", "name": "scheduled_interview_ids", "required": false, "schema": { "items": { "format": "uuid", "type": "string" }, "type": "array" } }, { "description": "SUBMITTED returns completed scorecards; NOT_SUBMITTED returns feedback still owed by a reviewer.", "in": "query", "name": "status", "required": false, "schema": { "$ref": "#/components/schemas/AtsFeedbacksGetParametersStatus" } }, { "description": "Filter by the kind of activity the feedback belongs to.", "in": "query", "name": "activity_type", "required": false, "schema": { "$ref": "#/components/schemas/AtsFeedbacksGetParametersActivityType" } }, { "description": "Return feedback submitted at or after this ISO 8601 datetime.", "in": "query", "name": "submitted_after", "required": false, "schema": { "format": "date-time", "type": "string" } }, { "description": "Return feedback submitted at or before this ISO 8601 datetime.", "in": "query", "name": "submitted_before", "required": false, "schema": { "format": "date-time", "type": "string" } }, { "description": "Return feedback updated strictly after this ISO 8601 datetime (incremental sync).", "in": "query", "name": "updated_after", "required": false, "schema": { "format": "date-time", "type": "string" } }, { "description": "Optional expansions. FORM_RESPONSES embeds the submitted scorecard answers (caps limit at 50).", "in": "query", "name": "include", "required": false, "schema": { "items": { "$ref": "#/components/schemas/AtsFeedbacksGetParametersIncludeSchemaItems" }, "type": "array" } }, { "description": "When true (default), form responses marked as sensitive are omitted.", "in": "query", "name": "should_hide_sensitive_fields", "required": false, "schema": { "type": "boolean" } }, { "description": "Order by feedback creation time.", "in": "query", "name": "sort_order", "required": false, "schema": { "$ref": "#/components/schemas/AtsFeedbacksGetParametersSortOrder" } }, { "description": "Pagination cursor returned by a previous response.", "in": "query", "name": "cursor", "required": false, "schema": { "type": "string" } }, { "description": "Maximum number of feedback records per page (1-100; 1-50 with include=FORM_RESPONSES).", "in": "query", "name": "limit", "required": false, "schema": { "maximum": 100, "minimum": 1, "type": "integer" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ATS_listFeedbacks-v2026-09-18_Response_200" } } }, "description": "Paginated list of feedback records." }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ListFeedbacks-v2026-09-18RequestBadRequestError" } } }, "description": "Operation failed." }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContainer" } } }, "description": "Operation failed." }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ListFeedbacks-v2026-09-18RequestForbiddenError" } } }, "description": "Forbidden. ATS is not enabled for this organization or insufficient permissions." }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContainer" } } }, "description": "Operation failed." }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ListFeedbacks-v2026-09-18RequestInternalServerError" } } }, "description": "Operation failed." } }, "security": [ { "deelToken": [] } ], "summary": "List interview and evaluation feedback across the organization", "tags": [ "ats" ] } }, "/ats/hires": { "get": { "description": "Maps ATS applications to the HRIS profiles they were hired into, oldest change first, with cursor pagination. To poll, set updated_after a few minutes before the updated_at of the last row you read: a row can commit late with an earlier updated_at. Rows then repeat, so upsert by application_id. The feed has inserts and updates only: the hire of a deleted application drops out with no marker, so run a full sync from time to time.\n\n **Token scopes**: `ats:read`, `worker:read`\n\n **Beta**: this version requires the `X-Beta: true` request header and its contract may change before it is promoted to stable. It is scheduled to become stable on 2027-01-01.", "operationId": "ats_retrieveAListOfAtsHires-v2026-10-01", "parameters": [ { "description": "Cursor for pagination. Use the next_cursor value from the previous response to get the next page of results.", "in": "query", "name": "cursor", "required": false, "schema": { "maxLength": 1000, "type": "string" } }, { "description": "Maximum number of records to return per page", "in": "query", "name": "limit", "required": false, "schema": { "default": 30, "maximum": 100, "minimum": 1, "type": "integer" } }, { "description": "Return only records updated strictly after this timestamp (ISO 8601 format). Use it to poll for changes.", "in": "query", "name": "updated_after", "required": false, "schema": { "format": "date-time", "type": "string" } }, { "description": "Opts in to the beta version of this endpoint. Must be `true`.", "in": "header", "name": "X-Beta", "required": true, "schema": { "$ref": "#/components/schemas/AtsHiresGetParametersXBeta" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ATS_retrieveAListOfAtsHires-v2026-10-01_Response_200" } } }, "description": "Successfully retrieved hires." }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RetrieveAListOfAtsHires-v2026-10-01RequestBadRequestError" } } }, "description": "Operation failed." }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContainer" } } }, "description": "Operation failed." }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RetrieveAListOfAtsHires-v2026-10-01RequestForbiddenError" } } }, "description": "Forbidden. ATS is not enabled for this organization or insufficient permissions." }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContainer" } } }, "description": "Operation failed." }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RetrieveAListOfAtsHires-v2026-10-01RequestInternalServerError" } } }, "description": "Operation failed." } }, "security": [ { "deelToken": [] } ], "summary": "Retrieve a list of ATS hires", "tags": [ "ats" ] } }, "/ats/hiring-members": { "get": { "description": "Returns all hiring members (recruiters, hiring managers, interviewers) configured in the organization, to support assigning screening tasks, scheduling interviews, and configuring hiring workflows.\n\n **Token scopes**: `ats:read`, `worker:read`", "operationId": "atsHiringMembers_retrieveAtsHiringMembers", "parameters": [ { "description": "The cursor for pagination", "in": "query", "name": "cursor", "required": false, "schema": { "type": "string" } }, { "description": "Maximum number of records returned in one response", "in": "query", "name": "limit", "required": false, "schema": { "default": 20, "maximum": 100, "minimum": 1, "type": "integer" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ats-hiring-members_retrieveAtsHiringMembers_Response_200" } } }, "description": "Successful operation." }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RetrieveAtsHiringMembers-v2026-01-01RequestBadRequestError" } } }, "description": "Operation failed." }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContainer" } } }, "description": "Operation failed." }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RetrieveAtsHiringMembers-v2026-01-01RequestForbiddenError" } } }, "description": "Forbidden. ATS is not enabled for this organization or insufficient permissions." }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContainer" } } }, "description": "Operation failed." }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RetrieveAtsHiringMembers-v2026-01-01RequestInternalServerError" } } }, "description": "Operation failed." } }, "security": [ { "deelToken": [] } ], "summary": "Retrieve ATS hiring members", "tags": [ "atsHiringMembers" ] } }, "/ats/interviews": { "get": { "description": "Lists interviews for review, including who interviewed and whether each took place or was cancelled. By default each application contributes only the interviews of the stage it is in now; filter by applications or interview stages to also get interviews from stages it has already passed. Results are limited to interviews the caller may see.\n\n **Token scopes**: `ats:read`, `worker:read`", "operationId": "ats_listInterviews-v2026-06-03", "parameters": [ { "description": "Filter interviews by interviewer HRIS organization user IDs.", "in": "query", "name": "interviewer_hou_ids", "required": false, "schema": { "items": { "format": "uuid", "type": "string" }, "type": "array" } }, { "description": "Filter interviews by job IDs.", "in": "query", "name": "job_ids", "required": false, "schema": { "items": { "format": "uuid", "type": "string" }, "type": "array" } }, { "description": "Filter interviews by status.", "in": "query", "name": "status", "required": false, "schema": { "items": { "$ref": "#/components/schemas/AtsInterviewsGetParametersStatusSchemaItems" }, "type": "array" } }, { "description": "Filter interviews by candidate IDs.", "in": "query", "name": "candidate_ids", "required": false, "schema": { "items": { "format": "uuid", "type": "string" }, "type": "array" } }, { "description": "Filter interviews by application IDs. When set, every interview of those applications is returned — past, cancelled and on stages the candidate has already moved past — and results default to latest meeting first.", "in": "query", "name": "application_ids", "required": false, "schema": { "items": { "format": "uuid", "type": "string" }, "type": "array" } }, { "description": "Filter interviews by the interview plan stage the interview belongs to (from GET /rest/ats/jobs interview_plan_stages). When set, every interview on those stages is returned regardless of the candidate's current stage, and results default to latest meeting first.", "in": "query", "name": "interview_plan_stage_ids", "required": false, "schema": { "items": { "format": "uuid", "type": "string" }, "type": "array" } }, { "description": "Lower bound of interview start time (ISO 8601).", "in": "query", "name": "date_range_start", "required": false, "schema": { "format": "date-time", "type": "string" } }, { "description": "Upper bound of interview start time (ISO 8601).", "in": "query", "name": "date_range_end", "required": false, "schema": { "format": "date-time", "type": "string" } }, { "description": "Return interviews updated strictly after this ISO 8601 datetime (incremental sync).", "in": "query", "name": "updated_after", "required": false, "schema": { "format": "date-time", "type": "string" } }, { "description": "Order interviews by upcoming-first, newest-first (by creation), oldest-first, or latest-meeting-first (most recent meeting time, for past-interview views).", "in": "query", "name": "sort_order", "required": false, "schema": { "$ref": "#/components/schemas/AtsInterviewsGetParametersSortOrder" } }, { "description": "Pagination cursor returned by a previous response.", "in": "query", "name": "cursor", "required": false, "schema": { "type": "string" } }, { "description": "Maximum number of interviews to return per page.", "in": "query", "name": "limit", "required": false, "schema": { "maximum": 100, "minimum": 1, "type": "integer" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ATS_listInterviews-v2026-06-03_Response_200" } } }, "description": "Paginated list of interviews" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ListInterviews-v2026-06-03RequestBadRequestError" } } }, "description": "Operation failed." }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContainer" } } }, "description": "Operation failed." }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ListInterviews-v2026-06-03RequestForbiddenError" } } }, "description": "Forbidden. ATS is not enabled for this organization or insufficient permissions." }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContainer" } } }, "description": "Operation failed." }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ListInterviews-v2026-06-03RequestInternalServerError" } } }, "description": "Operation failed." } }, "security": [ { "deelToken": [] } ], "summary": "List interviews", "tags": [ "ats" ] } }, "/ats/interviews/{interview_id}/transcript": { "get": { "description": "Returns the transcript of an interview as a paginated, ordered list of speaker segments. Only returned for organizations with Interview Assistant enabled, for interviews where the candidate consented to recording and transcription.\n\n **Token scopes**: `ats:read`, `worker:read`\n\n **Beta**: this version requires the `X-Beta: true` request header and its contract may change before it is promoted to stable. It is scheduled to become stable on 2027-01-16.", "operationId": "ats_getInterviewTranscript-v2026-10-16", "parameters": [ { "description": "Unique identifier of the interview to retrieve the transcript for.", "in": "path", "name": "interview_id", "required": true, "schema": { "format": "uuid", "type": "string" } }, { "description": "Pagination cursor returned by a previous response.", "in": "query", "name": "cursor", "required": false, "schema": { "type": "string" } }, { "description": "Maximum number of transcript segments to return per page.", "in": "query", "name": "limit", "required": false, "schema": { "maximum": 100, "minimum": 1, "type": "integer" } }, { "description": "Opts in to the beta version of this endpoint. Must be `true`.", "in": "header", "name": "X-Beta", "required": true, "schema": { "$ref": "#/components/schemas/AtsInterviewsInterviewIdTranscriptGetParametersXBeta" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ATS_getInterviewTranscript-v2026-10-16_Response_200" } } }, "description": "Paginated list of transcript segments, ordered by the time they were spoken." }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetInterviewTranscript-v2026-10-16RequestBadRequestError" } } }, "description": "Operation failed." }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContainer" } } }, "description": "Operation failed." }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetInterviewTranscript-v2026-10-16RequestForbiddenError" } } }, "description": "Forbidden. ATS is not enabled for this organization or insufficient permissions." }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetInterviewTranscript-v2026-10-16RequestNotFoundError" } } }, "description": "The interview does not exist, belongs to another organization, or is not visible to the caller." }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetInterviewTranscript-v2026-10-16RequestInternalServerError" } } }, "description": "Operation failed." } }, "security": [ { "deelToken": [] } ], "summary": "Get an interview transcript", "tags": [ "ats" ] } }, "/ats/job-boards": { "get": { "description": "Retrieves job boards configured on ATS for an organization. Use this to list available boards (internal, external, or LinkedIn) before selecting one for job postings or career-page configuration.\n\n **Token scopes**: `ats:read`, `worker:read`", "operationId": "ats_retrieveAListOfAtsJobBoards-v2026-02-09", "parameters": [ { "description": "Number of items to return", "in": "query", "name": "limit", "required": false, "schema": { "default": 20, "maximum": 100, "minimum": 1, "type": "integer" } }, { "description": "Cursor for pagination", "in": "query", "name": "cursor", "required": false, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ATS_retrieveAListOfAtsJobBoards-v2026-02-09_Response_200" } } }, "description": "Successfully retrieved job boards" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RetrieveAListOfAtsJobBoards-v2026-02-09RequestBadRequestError" } } }, "description": "Operation failed." }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContainer" } } }, "description": "Operation failed." }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RetrieveAListOfAtsJobBoards-v2026-02-09RequestForbiddenError" } } }, "description": "Forbidden. ATS is not enabled for this organization or insufficient permissions." }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContainer" } } }, "description": "Operation failed." }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RetrieveAListOfAtsJobBoards-v2026-02-09RequestInternalServerError" } } }, "description": "Operation failed." } }, "security": [ { "deelToken": [] } ], "summary": "Retrieve a list of ATS job boards", "tags": [ "ats" ] } }, "/ats/job-boards/{job_board_id}/job-postings": { "get": { "description": "Returns job postings for a specific job board, including publication status and nested job details, to monitor active postings on that board integration.\n\n **Token scopes**: `ats:read`, `worker:read`", "operationId": "atsJobPostings_retrieveAListOfAtsJobPostings", "parameters": [ { "description": "Job Board ID must be a valid UUID", "in": "path", "name": "job_board_id", "required": true, "schema": { "format": "uuid", "type": "string" } }, { "description": "The cursor for pagination (optional)", "in": "query", "name": "cursor", "required": false, "schema": { "type": "string" } }, { "description": "Maximum number of records returned in one response (optional)", "in": "query", "name": "limit", "required": false, "schema": { "default": 20, "maximum": 100, "minimum": 1, "type": "integer" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ats-job-postings_retrieveAListOfAtsJobPostings_Response_200" } } }, "description": "Successful operation." }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RetrieveAListOfAtsJobPostings-v2026-01-01RequestBadRequestError" } } }, "description": "Operation failed." }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContainer" } } }, "description": "Operation failed." }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RetrieveAListOfAtsJobPostings-v2026-01-01RequestForbiddenError" } } }, "description": "Forbidden. ATS is not enabled for this organization or insufficient permissions." }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContainer" } } }, "description": "Operation failed." }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RetrieveAListOfAtsJobPostings-v2026-01-01RequestInternalServerError" } } }, "description": "Operation failed." } }, "security": [ { "deelToken": [] } ], "summary": "Retrieve a list of ATS job postings", "tags": [ "atsJobPostings" ] } }, "/ats/job-postings": { "get": { "description": "List job postings across your organization, optionally filtered by job board or job ID. Omit filters to retrieve all postings; use the job-board-scoped endpoint instead for queries by board alone.\n\n **Token scopes**: `ats:read`", "operationId": "atsJobPostings_retrieveAtsJobPostings-v2026-04-10", "parameters": [ { "description": "Job board to list postings from (UUID).", "in": "query", "name": "job_board_id", "required": false, "schema": { "format": "uuid", "type": "string" } }, { "description": "When set, only postings for this job are returned (UUID).", "in": "query", "name": "job_id", "required": false, "schema": { "format": "uuid", "type": "string" } }, { "description": "Opaque cursor for pagination. Use the value from next_cursor of the previous response to fetch the next page.", "in": "query", "name": "cursor", "required": false, "schema": { "maxLength": 1000, "type": "string" } }, { "description": "Maximum number of job postings to return per page (min: 1, max: 100).", "in": "query", "name": "limit", "required": false, "schema": { "maximum": 100, "minimum": 1, "type": "integer" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ats-job-postings_retrieveAtsJobPostings-v2026-04-10_Response_200" } } }, "description": "Successful operation. Returns job postings for the requested job board (and optional job filter), with nested job details and publication state per board." }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RetrieveAtsJobPostings-v2026-04-10RequestBadRequestError" } } }, "description": "Operation failed." }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContainer" } } }, "description": "Operation failed." }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RetrieveAtsJobPostings-v2026-04-10RequestForbiddenError" } } }, "description": "Forbidden. ATS is not enabled for this organization or insufficient permissions." }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContainer" } } }, "description": "Operation failed." }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RetrieveAtsJobPostings-v2026-04-10RequestInternalServerError" } } }, "description": "Operation failed." } }, "security": [ { "deelToken": [] } ], "summary": "Retrieve ATS job postings", "tags": [ "atsJobPostings" ] } }, "/ats/job-postings/{job_posting_id}": { "get": { "description": "Look up a specific job posting when you have its ID. Retrieves the complete posting details including publication status across all job boards, associated job information, and application form configuration. Use the list endpoint for discovery and filtering.\n\n **Token scopes**: `ats:read`, `worker:read`", "operationId": "atsJobPostings_retrieveAtsJobPosting", "parameters": [ { "description": "Unique identifier of the job posting to retrieve", "in": "path", "name": "job_posting_id", "required": true, "schema": { "format": "uuid", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ats-job-postings_retrieveAtsJobPosting_Response_200" } } }, "description": "Successful operation." }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RetrieveAtsJobPosting-v2026-01-01RequestBadRequestError" } } }, "description": "Operation failed." }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContainer" } } }, "description": "Operation failed." }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RetrieveAtsJobPosting-v2026-01-01RequestForbiddenError" } } }, "description": "Forbidden. ATS is not enabled for this organization or insufficient permissions." }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContainer" } } }, "description": "Operation failed." }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RetrieveAtsJobPosting-v2026-01-01RequestInternalServerError" } } }, "description": "Operation failed." } }, "security": [ { "deelToken": [] } ], "summary": "Retrieve ATS job posting", "tags": [ "atsJobPostings" ] } }, "/ats/jobs": { "get": { "description": "Use this endpoint to resolve a job's interview plan stages: every stage of the plan is returned, and because stage names are customer-defined you look up a stage's id here before filtering applications or interviews by stage. Pass a set of job ids to resolve a known group of jobs in one call instead of paging the full list.\n\n **Token scopes**: `ats:read`, `worker:read`", "operationId": "atsJobs_retrieveAListOfAtsJobs", "parameters": [ { "description": "The cursor for pagination", "in": "query", "name": "cursor", "required": false, "schema": { "type": "string" } }, { "description": "Maximum number of records returned in one response", "in": "query", "name": "limit", "required": false, "schema": { "default": 20, "maximum": 100, "minimum": 1, "type": "integer" } }, { "description": "Text to search for in job records (optional)", "in": "query", "name": "search", "required": false, "schema": { "type": "string" } }, { "description": "Array of job UUIDs (optional). Returns only these jobs, so a caller holding job ids from another endpoint can resolve them in one request instead of paging the whole list. Omitting it leaves the result set unchanged.", "in": "query", "name": "job_ids", "required": false, "schema": { "items": { "format": "uuid", "type": "string" }, "type": "array" } }, { "description": "Interview plan UUID (optional)", "in": "query", "name": "interview_plan_id", "required": false, "schema": { "format": "uuid", "type": "string" } }, { "description": "Array of location UUIDs (optional)", "in": "query", "name": "location_ids", "required": false, "schema": { "items": { "format": "uuid", "type": "string" }, "type": "array" } }, { "description": "Array of team UUIDs (optional)", "in": "query", "name": "team_ids", "required": false, "schema": { "items": { "format": "uuid", "type": "string" }, "type": "array" } }, { "description": "Array of employment type UUIDs (optional)", "in": "query", "name": "employment_type_ids", "required": false, "schema": { "items": { "format": "uuid", "type": "string" }, "type": "array" } }, { "description": "Array of department UUIDs (optional)", "in": "query", "name": "department_ids", "required": false, "schema": { "items": { "format": "uuid", "type": "string" }, "type": "array" } }, { "description": "Filter jobs updated after this timestamp (ISO 8601 format)", "in": "query", "name": "updated_after", "required": false, "schema": { "format": "date-time", "type": "string" } }, { "description": "Array of job status values (optional)", "in": "query", "name": "status", "required": false, "schema": { "items": { "$ref": "#/components/schemas/AtsJobsGetParametersStatusSchemaItems" }, "type": "array" } }, { "description": "Array of work arrangement values to filter by (optional)", "in": "query", "name": "work_arrangements", "required": false, "schema": { "items": { "$ref": "#/components/schemas/AtsJobsGetParametersWorkArrangementsSchemaItems" }, "type": "array" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ats-jobs_retrieveAListOfAtsJobs_Response_200" } } }, "description": "Successful operation." }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RetrieveAListOfAtsJobs-v2026-01-01RequestBadRequestError" } } }, "description": "Operation failed." }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContainer" } } }, "description": "Operation failed." }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RetrieveAListOfAtsJobs-v2026-01-01RequestForbiddenError" } } }, "description": "Forbidden. ATS is not enabled for this organization or insufficient permissions." }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContainer" } } }, "description": "Operation failed." }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RetrieveAListOfAtsJobs-v2026-01-01RequestInternalServerError" } } }, "description": "Operation failed." } }, "security": [ { "deelToken": [] } ], "summary": "Retrieve a list of ATS jobs", "tags": [ "atsJobs" ] }, "post": { "description": "Creates a new job in the ATS once an interview plan, team, location, and employment type have been determined. Use this after those prerequisites are set; the response includes the job's id, initial status, and associated approval identifiers.\n\n **Token scopes**: `ats:write`", "operationId": "atsJobs_createAtsJob", "requestBody": { "content": { "application/json": { "schema": { "properties": { "data": { "$ref": "#/components/schemas/AtsJobsPostRequestBodyContentApplicationJsonSchemaData" } }, "required": [ "data" ], "type": "object" } } } }, "responses": { "201": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ats-jobs_createAtsJob_Response_201" } } }, "description": "Job successfully created" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreateAtsJob-v2026-01-01RequestBadRequestError" } } }, "description": "Operation failed." }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContainer" } } }, "description": "Operation failed." }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreateAtsJob-v2026-01-01RequestForbiddenError" } } }, "description": "Forbidden. ATS is not enabled for this organization or insufficient permissions." }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContainer" } } }, "description": "Operation failed." }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreateAtsJob-v2026-01-01RequestInternalServerError" } } }, "description": "Operation failed." } }, "security": [ { "deelToken": [] } ], "summary": "Create ATS Job", "tags": [ "atsJobs" ] } }, "/ats/jobs/{job_id}/interview-plan-stages": { "get": { "description": "Returns the interview plan of a job in pipeline order, with how many applications are in each stage now and how many have ever reached it. Use it to read a pipeline snapshot of the job or to find a stage before filtering `GET /rest/ats/applications` or `GET /rest/ats/interviews` by it. Counts cover only the applications the caller may see.\n\n **Token scopes**: `ats:read`, `worker:read`", "operationId": "ats_listJobInterviewPlanStages-v2026-09-18", "parameters": [ { "description": "Job whose interview plan stages to list.", "in": "path", "name": "job_id", "required": true, "schema": { "format": "uuid", "type": "string" } }, { "description": "Optional expansions. CURRENT_APPLICATIONS embeds the most recently moved applications currently sitting in each stage.", "in": "query", "name": "include", "required": false, "schema": { "items": { "$ref": "#/components/schemas/AtsJobsJobIdInterviewPlanStagesGetParametersIncludeSchemaItems" }, "type": "array" } }, { "description": "Maximum number of current applications embedded per stage when include=CURRENT_APPLICATIONS (1-25).", "in": "query", "name": "applications_per_stage_limit", "required": false, "schema": { "default": 10, "maximum": 25, "minimum": 1, "type": "integer" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ATS_listJobInterviewPlanStages-v2026-09-18_Response_200" } } }, "description": "Interview plan stages with pipeline counts." }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ListJobInterviewPlanStages-v2026-09-18RequestBadRequestError" } } }, "description": "Operation failed." }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContainer" } } }, "description": "Operation failed." }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ListJobInterviewPlanStages-v2026-09-18RequestForbiddenError" } } }, "description": "Forbidden. ATS is not enabled for this organization or insufficient permissions." }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContainer" } } }, "description": "Operation failed." }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ListJobInterviewPlanStages-v2026-09-18RequestInternalServerError" } } }, "description": "Operation failed." } }, "security": [ { "deelToken": [] } ], "summary": "List interview plan stages of a job with pipeline counts", "tags": [ "ats" ] } }, "/ats/locations": { "get": { "deprecated": true, "description": "Returns a paginated list of all work locations associated with the organization, suitable for use when constructing job postings or filtering by location.\n\n **Token scopes**: `ats:read`, `worker:read`\n\n **Deprecated**: a newer version of this endpoint is available. This version is scheduled for removal on 2027-09-01.\n\n **Beta version available**: version `2026-09-01` of this endpoint is in beta. Send `X-Beta: true` to call it.", "operationId": "atsLocations_retrieveAListOfAtsLocations-v2026-01-01", "parameters": [ { "description": "The cursor for pagination", "in": "query", "name": "cursor", "required": false, "schema": { "type": "string" } }, { "description": "Maximum number of records returned in one response", "in": "query", "name": "limit", "required": false, "schema": { "default": 20, "maximum": 100, "minimum": 1, "type": "integer" } }, { "description": "If true, archived locations are included in the response; they are excluded by default", "in": "query", "name": "include_archived", "required": false, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ats-locations_retrieveAListOfAtsLocations-v2026-01-01_Response_200" } } }, "description": "Successful response with locations data." }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RetrieveAListOfAtsLocations-v2026-01-01RequestBadRequestError" } } }, "description": "Operation failed." }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContainer" } } }, "description": "Operation failed." }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RetrieveAListOfAtsLocations-v2026-01-01RequestForbiddenError" } } }, "description": "Forbidden. ATS is not enabled for this organization or insufficient permissions." }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContainer" } } }, "description": "Operation failed." }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RetrieveAListOfAtsLocations-v2026-01-01RequestInternalServerError" } } }, "description": "Operation failed." } }, "security": [ { "deelToken": [] } ], "summary": "Retrieve a list of ATS locations", "tags": [ "atsLocations" ] } }, "/ats/offers": { "get": { "description": "Returns all offers associated with the organization, including worker type and offer status, to support pre-onboarding and contract creation workflows.\n\n **Token scopes**: `ats:read`, `worker:read`", "operationId": "atsOffers_retrieveAListOfAtsOffers-v2026-01-01", "parameters": [ { "description": "Filter offers by a specific application ID", "in": "query", "name": "application_id", "required": false, "schema": { "format": "uuid", "type": "string" } }, { "description": "Filter offers by the job IDs of their applications.", "in": "query", "name": "job_ids", "required": false, "schema": { "items": { "format": "uuid", "type": "string" }, "type": "array" } }, { "description": "Filter offers by status. Offers still awaiting an outcome are SENT (with the candidate), WAITING_FOR_APPROVAL and APPROVED (internal), CREATED (not yet sent); terminal statuses are ACCEPTED, REJECTED and EXPIRED.", "in": "query", "name": "offer_status", "required": false, "schema": { "items": { "$ref": "#/components/schemas/AtsOffersGetParametersOfferStatusSchemaItems" }, "type": "array" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ats-offers_retrieveAListOfAtsOffers-v2026-01-01_Response_200" } } }, "description": "Successful operation." }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ListOffers-v2026-01-01RequestBadRequestError" } } }, "description": "Operation failed." }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContainer" } } }, "description": "Operation failed." }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ListOffers-v2026-01-01RequestForbiddenError" } } }, "description": "Forbidden. ATS is not enabled for this organization or insufficient permissions." }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContainer" } } }, "description": "Operation failed." }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ListOffers-v2026-01-01RequestInternalServerError" } } }, "description": "Operation failed." } }, "security": [ { "deelToken": [] } ], "summary": "Retrieve a list of ATS offers", "tags": [ "atsOffers" ] } }, "/ats/openings": { "get": { "description": "Lists the headcount openings (requisitions), that is the positions that jobs are hiring for. Use it to review that headcount and to see which hire filled each opening. Callers with restricted access see only the openings they may view.\n\n **Token scopes**: `ats:read`, `worker:read`", "operationId": "ats_listOpenings-v2026-06-15", "parameters": [ { "description": "Pagination cursor returned by a previous response.", "in": "query", "name": "cursor", "required": false, "schema": { "type": "string" } }, { "description": "Maximum number of openings to return per page.", "in": "query", "name": "limit", "required": false, "schema": { "maximum": 100, "minimum": 1, "type": "integer" } }, { "description": "Filter openings by one or more statuses.", "in": "query", "name": "status", "required": false, "schema": { "items": { "$ref": "#/components/schemas/AtsOpeningsGetParametersStatusSchemaItems" }, "type": "array" } }, { "description": "Filter openings by team IDs.", "in": "query", "name": "team_ids", "required": false, "schema": { "items": { "format": "uuid", "type": "string" }, "type": "array" } }, { "description": "Filter openings by location IDs.", "in": "query", "name": "location_ids", "required": false, "schema": { "items": { "format": "uuid", "type": "string" }, "type": "array" } }, { "description": "Filter openings by linked job IDs.", "in": "query", "name": "job_ids", "required": false, "schema": { "items": { "format": "uuid", "type": "string" }, "type": "array" } }, { "description": "Filter openings by tag IDs.", "in": "query", "name": "tag_ids", "required": false, "schema": { "items": { "format": "uuid", "type": "string" }, "type": "array" } }, { "description": "Operator for tag_ids filter. 'ANY' returns openings with at least one matching tag; 'ALL' returns openings with all specified tags. Defaults to 'ANY'.", "in": "query", "name": "tag_ids_operator", "required": false, "schema": { "$ref": "#/components/schemas/AtsOpeningsGetParametersTagIdsOperator" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ATS_listOpenings-v2026-06-15_Response_200" } } }, "description": "Paginated list of job openings." }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ListOpenings-v2026-06-15RequestBadRequestError" } } }, "description": "Operation failed." }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContainer" } } }, "description": "Operation failed." }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ListOpenings-v2026-06-15RequestForbiddenError" } } }, "description": "Forbidden. ATS is not enabled for this organization or insufficient permissions." }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContainer" } } }, "description": "Operation failed." }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ListOpenings-v2026-06-15RequestInternalServerError" } } }, "description": "Operation failed." } }, "security": [ { "deelToken": [] } ], "summary": "List job openings", "tags": [ "ats" ] } }, "/ats/reasons": { "get": { "description": "Returns a paginated list of rejection and archivation reasons, filterable by `reason_group_slug` and `subgroup_slug`; when `include_counts` is true, each reason includes a usage count.\n\n **Token scopes**: `ats:read`, `worker:read`", "operationId": "atsReasons_retrievePaginatedListOfAtsRejectionArchivationReasons-v2026-01-01", "parameters": [ { "description": "The cursor for pagination", "in": "query", "name": "cursor", "required": false, "schema": { "maxLength": 1000, "type": "string" } }, { "description": "Maximum number of records returned in one response", "in": "query", "name": "limit", "required": false, "schema": { "default": 20, "maximum": 100, "minimum": 1, "type": "integer" } }, { "description": "Search text for filtering reasons", "in": "query", "name": "search", "required": false, "schema": { "maxLength": 500, "type": "string" } }, { "description": "Filter by reason group", "in": "query", "name": "reason_group_slug", "required": true, "schema": { "$ref": "#/components/schemas/AtsReasonsGetParametersReasonGroupSlug" } }, { "description": "If true, includes usage counts for each reason", "in": "query", "name": "include_counts", "required": false, "schema": { "type": "string" } }, { "description": "If true, archived reasons are included in the response; they are excluded by default", "in": "query", "name": "include_archived", "required": false, "schema": { "type": "string" } }, { "description": "Filter by reason subgroup", "in": "query", "name": "subgroup_slug", "required": false, "schema": { "$ref": "#/components/schemas/AtsReasonsGetParametersSubgroupSlug" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ats-reasons_retrievePaginatedListOfAtsRejectionArchivationReasons-v2026-01-01_Response_200" } } }, "description": "Successful operation." }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RetrievePaginatedListOfAtsRejectionArchivationReasons-v2026-01-01RequestBadRequestError" } } }, "description": "Operation failed." }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContainer" } } }, "description": "Operation failed." }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RetrievePaginatedListOfAtsRejectionArchivationReasons-v2026-01-01RequestForbiddenError" } } }, "description": "Forbidden. ATS is not enabled for this organization or insufficient permissions." }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContainer" } } }, "description": "Operation failed." }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RetrievePaginatedListOfAtsRejectionArchivationReasons-v2026-01-01RequestInternalServerError" } } }, "description": "Operation failed." } }, "security": [ { "deelToken": [] } ], "summary": "Retrieve paginated list of ATS Rejection/Archivation reasons", "tags": [ "atsReasons" ] } }, "/ats/tags": { "get": { "description": "Returns a paginated list of tags associated with the organization, filterable by label and `tag_group_slug`; when `include_counts` is true, each tag includes a count of associated candidates.\n\n **Token scopes**: `ats:read`, `worker:read`", "operationId": "atsTags_listTags-v2026-02-27", "parameters": [ { "description": "Filter tags by label (case-insensitive partial match)", "in": "query", "name": "search_text", "required": false, "schema": { "maxLength": 50, "type": "string" } }, { "description": "Filter by tag group. Use CANDIDATE for candidate tags.", "in": "query", "name": "tag_group_slug", "required": false, "schema": { "$ref": "#/components/schemas/AtsTagsGetParametersTagGroupSlug" } }, { "description": "If true, archived tags are included in the response; they are excluded by default.", "in": "query", "name": "include_archived", "required": false, "schema": { "type": "string" } }, { "description": "When true, each tag includes candidates_count (number of candidates with that tag)", "in": "query", "name": "include_counts", "required": false, "schema": { "$ref": "#/components/schemas/AtsTagsGetParametersIncludeCounts", "default": "false" } }, { "description": "Opaque cursor for pagination. Use the value from next_cursor of the previous response to fetch the next page.", "in": "query", "name": "cursor", "required": false, "schema": { "maxLength": 1000, "type": "string" } }, { "description": "Maximum number of tags to return per page (default: 20, max: 100).", "in": "query", "name": "limit", "required": false, "schema": { "default": 20, "maximum": 100, "minimum": 1, "type": "integer" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ats-tags_listTags-v2026-02-27_Response_200" } } }, "description": "Successful operation. Returns the list of tags for the organization." }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ListTags-v2026-01-01RequestBadRequestError" } } }, "description": "Operation failed." }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContainer" } } }, "description": "Operation failed." }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ListTags-v2026-01-01RequestForbiddenError" } } }, "description": "Forbidden. ATS is not enabled for this organization or insufficient permissions." }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContainer" } } }, "description": "Operation failed." }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ListTags-v2026-01-01RequestInternalServerError" } } }, "description": "Operation failed." } }, "security": [ { "deelToken": [] } ], "summary": "List tags", "tags": [ "atsTags" ] } }, "/ats/teams": { "get": { "description": "Lists the active teams in the Applicant Tracking System; archived teams are included only when requested. Use it to find the team ids to filter `GET /rest/ats/jobs` or `GET /rest/ats/openings` by team.\n\n **Token scopes**: `ats:read`, `worker:read`", "operationId": "ats_retrieveAListOfAtsTeams-v2026-06-24", "parameters": [ { "description": "The cursor for pagination", "in": "query", "name": "cursor", "required": false, "schema": { "type": "string" } }, { "description": "Maximum number of records returned in one response", "in": "query", "name": "limit", "required": false, "schema": { "default": 20, "maximum": 100, "minimum": 1, "type": "integer" } }, { "description": "If true, archived teams are included in the response; they are excluded by default", "in": "query", "name": "include_archived", "required": false, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ATS_retrieveAListOfAtsTeams-v2026-06-24_Response_200" } } }, "description": "Successful response with teams data" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RetrieveAListOfAtsTeams-v2026-06-24RequestBadRequestError" } } }, "description": "Operation failed." }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContainer" } } }, "description": "Operation failed." }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RetrieveAListOfAtsTeams-v2026-06-24RequestForbiddenError" } } }, "description": "Forbidden. ATS is not enabled for this organization or insufficient permissions." }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContainer" } } }, "description": "Operation failed." }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RetrieveAListOfAtsTeams-v2026-06-24RequestInternalServerError" } } }, "description": "Operation failed." } }, "security": [ { "deelToken": [] } ], "summary": "Retrieve a list of ATS teams", "tags": [ "ats" ] } }, "/ats/upsertions/bulk-tags": { "post": { "description": "Use this endpoint to keep an organization's tag vocabulary consistent — create the candidate, job and opening tags a hiring workflow needs, or rename ones already in use, in one call instead of one request per tag. It returns the tag ids the tagging endpoints expect, so an importing system can reconcile its own labels with Deel's before it tags any records.\n\n **Token scopes**: `ats:write`, `worker:write`", "operationId": "ats_bulkTagUpsertions-v2026-06-12", "requestBody": { "content": { "application/json": { "schema": { "properties": { "data": { "$ref": "#/components/schemas/AtsUpsertionsBulkTagsPostRequestBodyContentApplicationJsonSchemaData", "description": "At least one tag group must be provided. Include tag_id to update an existing tag label, or omit it to create or match case-insensitively." } }, "required": [ "data" ], "type": "object" } } } }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ATS_bulkTagUpsertions-v2026-06-12_Response_200" } } }, "description": "Tags upserted successfully." }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BulkTagUpsertions-v2026-06-12RequestBadRequestError" } } }, "description": "Operation failed." }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContainer" } } }, "description": "Operation failed." }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BulkTagUpsertions-v2026-06-12RequestForbiddenError" } } }, "description": "Forbidden. ATS is not enabled for this organization or insufficient permissions." }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContainer" } } }, "description": "Operation failed." }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BulkTagUpsertions-v2026-06-12RequestInternalServerError" } } }, "description": "Operation failed." } }, "security": [ { "deelToken": [] } ], "summary": "Set tags in bulk", "tags": [ "ats" ] } }, "/candidates": { "post": { "description": "Creates a candidate record for contractor onboarding outside of an ATS flow. The returned record can be used in subsequent contract creation calls.\n\n **Token scopes**: `candidates:write`", "operationId": "candidates_addCandidate-v2026-01-01", "requestBody": { "content": { "application/json": { "schema": { "properties": { "data": { "$ref": "#/components/schemas/CandidatesPostRequestBodyContentApplicationJsonSchemaData", "description": "Details of candidate to create" } }, "required": [ "data" ], "type": "object" } } }, "description": "Add a candidate to Deel" }, "responses": { "201": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Candidates_addCandidate-v2026-01-01_Response_201" } } }, "description": "Successful operation." }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContainer" } } }, "description": "Operation failed." }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContainer" } } }, "description": "Operation failed." }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContainer" } } }, "description": "Operation failed." }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContainer" } } }, "description": "Operation failed." }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContainer" } } }, "description": "Operation failed." } }, "security": [ { "deelToken": [] } ], "summary": "Add Candidate", "tags": [ "candidates" ] } }, "/consent_token": { "post": { "description": "Generates a time-bounded consent token used to authorize third-party service connections on behalf of an organization. The token expires at the time indicated by `expires_at` in the response.", "operationId": "consent_createConsentToken-v2026-01-01", "requestBody": { "content": { "application/json": { "schema": { "properties": { "data": { "$ref": "#/components/schemas/ConsentTokenPostRequestBodyContentApplicationJsonSchemaData" } }, "required": [ "data" ], "type": "object" } } } }, "responses": { "201": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Consent_createConsentToken-v2026-01-01_Response_201" } } }, "description": "Consent token created successfully" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreateConsentToken-v2026-01-01RequestBadRequestError" } } }, "description": "Validation error" }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContainer" } } }, "description": "Operation failed." }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContainer" } } }, "description": "Operation failed." }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContainer" } } }, "description": "Operation failed." }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreateConsentToken-v2026-01-01RequestInternalServerError" } } }, "description": "Internal server error" } }, "security": [ { "deelToken": [] } ], "summary": "Create a consent token", "tags": [ "consent" ] } }, "/contract-templates": { "get": { "description": "Returns all contract templates available to the organization, including fixed-rate, pay-as-you-go, and milestone-based types. Template identifiers returned here can be supplied when creating new contracts.\n\n **Token scopes**: `contracts:read`", "operationId": "contracts_getContractTemplates-v2026-01-01", "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Contracts_getContractTemplates-v2026-01-01_Response_200" } } }, "description": "A successful response containing contract templates." }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContainer" } } }, "description": "Operation failed." }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContainer" } } }, "description": "Operation failed." }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContainer" } } }, "description": "Operation failed." } }, "security": [ { "deelToken": [] } ], "summary": "Retrieve contract templates", "tags": [ "contracts" ] } }, "/contracts": { "get": { "description": "Returns a paginated list of contract summaries for the organization, with optional filtering by status, type, team, legal entity, country, currency, external ID, or a name search term. Use `GET /contracts/{contract_id}` to retrieve full details for a specific contract.\n\n **Token scopes**: `contracts:read`", "operationId": "contracts_getContracts", "parameters": [ { "description": "Return next page of results after the given cursor.", "in": "query", "name": "after_cursor", "required": false, "schema": { "type": "string" } }, { "description": "Return a page of results with the given number of records.", "in": "query", "name": "limit", "required": false, "schema": { "default": 50, "pattern": "^[0-9]+$", "type": "string" } }, { "description": "Order direction of results; ascending or descending.", "in": "query", "name": "order_direction", "required": false, "schema": { "$ref": "#/components/schemas/ContractsGetParametersOrderDirection" } }, { "description": "Filter contracts by type. A contract is included in the results if its type is in this list.", "in": "query", "name": "types", "required": false, "schema": { "items": { "$ref": "#/components/schemas/ContractsGetParametersTypesSchemaItems" }, "type": "array" } }, { "description": "Filter contracts by current status. A contract is included in the results if its status is in this list.", "in": "query", "name": "statuses", "required": false, "schema": { "items": { "$ref": "#/components/schemas/ContractsGetParametersStatusesSchemaItems" }, "type": "array" } }, { "description": "Filter contracts for the given team ID(s). A contract is included in the results if its team is in this list.", "in": "query", "name": "team_id", "required": false, "schema": { "$ref": "#/components/schemas/ContractsGetParametersTeamId" } }, { "description": "Filter contracts for the given legal entity ID(s). A contract is included in the results if its legal entity is in this list.", "in": "query", "name": "legal_entity_id", "required": false, "schema": { "$ref": "#/components/schemas/ContractsGetParametersLegalEntityId" } }, { "description": "Filter contracts for the given external ID.", "in": "query", "name": "external_id", "required": false, "schema": { "type": "string" } }, { "description": "Filter contracts by external ID presence. When true, returns contracts without an external ID. When false, returns contracts with an external ID. Cannot be used with external_id query param when set to true.", "in": "query", "name": "external_id_absent", "required": false, "schema": { "type": "string" } }, { "description": "Filter contracts by country codes.", "in": "query", "name": "countries", "required": false, "schema": { "items": { "maxLength": 2, "minLength": 2, "pattern": "^[A-Z]{2}$", "type": "string" }, "type": "array" } }, { "description": "Filter contracts by currency codes.", "in": "query", "name": "currencies", "required": false, "schema": { "items": { "maxLength": 3, "minLength": 3, "pattern": "^[A-Z]{3}$", "type": "string" }, "type": "array" } }, { "description": "Include a contract if its name or the contractor's name contains the given search term.", "in": "query", "name": "search", "required": false, "schema": { "type": "string" } }, { "description": "Sort contracts by the given field name.", "in": "query", "name": "sort_by", "required": false, "schema": { "$ref": "#/components/schemas/ContractsGetParametersSortBy" } }, { "description": "Include additional fields in the response. Multiple values can be passed as comma-separated list.", "in": "query", "name": "expand", "required": false, "schema": { "items": { "$ref": "#/components/schemas/ContractsGetParametersExpandSchemaItems" }, "type": "array" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/contracts_getContracts_Response_200" } } }, "description": "Successful operation." }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ListOfContracts-v2026-01-01RequestBadRequestError" } } }, "description": "Bad Request - Validation error or invalid parameters" }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContainer" } } }, "description": "Operation failed." }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContainer" } } }, "description": "Operation failed." }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContainer" } } }, "description": "Operation failed." }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContainer" } } }, "description": "Operation failed." } }, "security": [ { "deelToken": [] } ], "summary": "List of contracts", "tags": [ "contracts" ] }, "post": { "description": "Creates a new contractor contract and returns it with its assigned `id`. After creation, invite the contractor to sign via `POST /contracts/{contract_id}/invitations`.\n\n **Token scopes**: `contracts:write`", "operationId": "contracts_createICContract", "requestBody": { "content": { "application/json": { "schema": { "properties": { "data": { "$ref": "#/components/schemas/ContractsPostRequestBodyContentApplicationJsonSchemaData" } }, "required": [ "data" ], "type": "object" } } } }, "responses": { "201": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/contracts_createICContract_Response_201" } } }, "description": "Successful operation." }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreateANewContract-v2026-01-01RequestBadRequestError" } } }, "description": "Bad Request - Validation error or invalid parameters" }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContainer" } } }, "description": "Operation failed." }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContainer" } } }, "description": "Operation failed." }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContainer" } } }, "description": "Operation failed." }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContainer" } } }, "description": "Operation failed." } }, "security": [ { "deelToken": [] } ], "summary": "Create a new contract", "tags": [ "contracts" ] } }, "/contracts/custom_fields": { "get": { "description": "Returns the list of custom field definitions configured for contracts within the organization. The response includes field metadata, not specific contract field values. It provides definitions with contract placement for supported types such as text, list, multiselect, number, percentage, currency, date, and hyperlink.\n\n **Token scopes**: `contracts:read`", "operationId": "customFieldsContracts_listContractCustomFields", "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/custom-fields-contracts_listContractCustomFields_Response_200" } } }, "description": "Successful response" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContainer" } } }, "description": "Operation failed." }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContainer" } } }, "description": "Operation failed." }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContainer" } } }, "description": "Operation failed." }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContainer" } } }, "description": "Operation failed." }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ListAllCustomFields-v2026-01-01RequestInternalServerError" } } }, "description": "Internal server error" } }, "security": [ { "deelToken": [] } ], "summary": "List all custom fields", "tags": [ "customFieldsContracts" ] } }, "/contracts/custom_fields/{id}": { "get": { "description": "Retrieves a single custom field definition from a contract by its `id`, returning the field's name, type, settings, placement, and description.\n\n **Token scopes**: `contracts:read`", "operationId": "customFieldsContracts_getCustomField", "parameters": [ { "description": "Custom field id.", "in": "path", "name": "id", "required": true, "schema": { "format": "uuid", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/custom-fields-contracts_getCustomField_Response_200" } } }, "description": "Successful response" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContainer" } } }, "description": "Operation failed." }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContainer" } } }, "description": "Operation failed." }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContainer" } } }, "description": "Operation failed." }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContainer" } } }, "description": "Operation failed." }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetCustomFieldsFromContracts-v2026-01-01RequestInternalServerError" } } }, "description": "Internal Server Error" } }, "security": [ { "deelToken": [] } ], "summary": "Get custom fields from contracts", "tags": [ "customFieldsContracts" ] } }, "/contracts/gp": { "post": { "description": "Creates a new Global Payroll contract. Country-specific fields required in the request body vary by country and must be retrieved in advance from `GET /forms/gp/worker-additional-fields/{country_code}`. Returns the created contract including its unique `id`.\n\n **Token scopes**: `contracts:write`", "operationId": "gpHiring_createGPContract", "requestBody": { "content": { "application/json": { "schema": { "properties": { "data": { "$ref": "#/components/schemas/ContractsGpPostRequestBodyContentApplicationJsonSchemaData" } }, "required": [ "data" ], "type": "object" } } }, "description": "Global Payroll (GP) contract object that needs to be created." }, "responses": { "201": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/gp-hiring_createGPContract_Response_201" } } }, "description": "Successful operation." }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreateAGlobalPayrollGpContract-v2026-01-01RequestBadRequestError" } } }, "description": "Operation failed." }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContainer" } } }, "description": "Operation failed." }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContainer" } } }, "description": "Operation failed." }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContainer" } } }, "description": "Operation failed." }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreateAGlobalPayrollGpContract-v2026-01-01RequestInternalServerError" } } }, "description": "Operation failed." } }, "security": [ { "deelToken": [] } ], "summary": "Create a Global Payroll (GP) contract", "tags": [ "gpHiring" ] } }, "/contracts/termination-reasons": { "get": { "description": "Retrieves the standardized list of termination reasons to present when initiating a contract termination.\n\n **Token scopes**: `contracts:read`", "operationId": "contracts_listContractTerminationReasons-v2026-01-01", "parameters": [ { "description": "Number of items to return per page (default: 20, max: 100)", "in": "query", "name": "limit", "required": false, "schema": { "default": 20, "maximum": 100, "minimum": 1, "type": "integer" } }, { "description": "Cursor for pagination. Use the value from `next_cursor` in the previous response to fetch the next page.", "in": "query", "name": "cursor", "required": false, "schema": { "type": "string" } }, { "description": "Field to order results by", "in": "query", "name": "order_by", "required": false, "schema": { "$ref": "#/components/schemas/ContractsTerminationReasonsGetParametersOrderBy", "default": "frequency" } }, { "description": "Sort direction for results", "in": "query", "name": "order", "required": false, "schema": { "$ref": "#/components/schemas/ContractsTerminationReasonsGetParametersOrder", "default": "asc" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Contracts_listContractTerminationReasons-v2026-01-01_Response_200" } } }, "description": "Paginated list of termination reasons" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ListContractTerminationReasons-v2026-01-01RequestBadRequestError" } } }, "description": "Operation failed." }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContainer" } } }, "description": "Operation failed." }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContainer" } } }, "description": "Operation failed." }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContainer" } } }, "description": "Operation failed." }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ListContractTerminationReasons-v2026-01-01RequestInternalServerError" } } }, "description": "Operation failed." } }, "security": [ { "deelToken": [] } ], "summary": "List contract termination reasons", "tags": [ "contracts" ] } }, "/contracts/{contract_id}": { "get": { "description": "Retrieves the full record for a specific contract by `contract_id`, including status, compensation, worker details, and metadata. Pass `expand=cost_centers` or `expand=custom_fields` as a query parameter to include additional data in the response.\n\n **Token scopes**: `contracts:read`", "operationId": "contracts_getContract", "parameters": [ { "description": "Unique identifier of the contract.", "in": "path", "name": "contract_id", "required": true, "schema": { "type": "string" } }, { "description": "Include additional fields in the response. Multiple values can be passed as comma-separated list.", "in": "query", "name": "expand", "required": false, "schema": { "items": { "$ref": "#/components/schemas/ContractsContractIdGetParametersExpandSchemaItems" }, "type": "array" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/contracts_getContract_Response_200" } } }, "description": "Successful operation." }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContainer" } } }, "description": "Operation failed." }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContainer" } } }, "description": "Operation failed." }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContainer" } } }, "description": "Operation failed." }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RetrieveASingleContract-v2026-01-01RequestNotFoundError" } } }, "description": "Not found" }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContainer" } } }, "description": "Operation failed." } }, "security": [ { "deelToken": [] } ], "summary": "Retrieve a single contract", "tags": [ "contracts" ] }, "patch": { "description": "Sets an external identifier. Link your internal reference IDs, such as employee numbers or ERP keys, to a Deel worker. The external ID must be unique and, once set, can be used as a filter when listing contracts to directly look up Deel records from an external system.\n\n **Token scopes**: `contracts:write`", "operationId": "contracts_updateICContract", "parameters": [ { "description": "Deel contract id.", "in": "path", "name": "contract_id", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "properties": { "data": { "$ref": "#/components/schemas/ContractsContractIdPatchRequestBodyContentApplicationJsonSchemaData" } }, "required": [ "data" ], "type": "object" } } }, "description": "Contract object that needs to be created" }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/contracts_updateICContract_Response_200" } } }, "description": "Successful operation." }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContainer" } } }, "description": "Operation failed." }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContainer" } } }, "description": "Operation failed." }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContainer" } } }, "description": "Operation failed." }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AddExternalId-v2026-01-01RequestNotFoundError" } } }, "description": "Not found" }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContainer" } } }, "description": "Operation failed." } }, "security": [ { "deelToken": [] } ], "summary": "Add external Id", "tags": [ "contracts" ] } }, "/contracts/{contract_id}/additional-info": { "get": { "description": "Returns the values a worker submitted for the country-specific additional-information fields on a contract - details local law requires before payroll can run, such as local identifiers, demographic data and emergency contacts. The field set varies per country, so it is kept out of the core contract payload: call this to mirror those values into an external HRIS or payroll system, or to check what a worker supplied during onboarding. Use GET /contracts/{contract_id} for the contract terms. EOR and GP.\n\n **Token scopes**: `contracts:read`", "operationId": "globalPayroll_getContractAdditionalInfo-v2026-09-14", "parameters": [ { "description": "The unique identifier of the GP contract.", "in": "path", "name": "contract_id", "required": true, "schema": { "maxLength": 100, "pattern": "^(([a-z0-9]{6,})|([a-z0-9-_]{20,})|(-2[0-9]{2}))$", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Global_Payroll_getContractAdditionalInfo-v2026-09-14_Response_200" } } }, "description": "OK" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContainer" } } }, "description": "Operation failed." }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContainer" } } }, "description": "Operation failed." }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetContractAdditionalInfo-v2026-09-14RequestForbiddenError" } } }, "description": "403" }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetContractAdditionalInfo-v2026-09-14RequestNotFoundError" } } }, "description": "404" }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContainer" } } }, "description": "Operation failed." } }, "security": [ { "deelToken": [] } ], "summary": "Get additional info for a contract", "tags": [ "globalPayroll" ] } }, "/contracts/{contract_id}/adjustments": { "get": { "description": "Retrieves all adjustments associated with a specific contract, optionally scoped to a date range.\n\n **Token scopes**: `adjustments:read`", "operationId": "adjustments_getContractAdjustments", "parameters": [ { "description": "Deel adjustment id.", "in": "path", "name": "contract_id", "required": true, "schema": { "type": "string" } }, { "description": "Filter adjustments by start date.", "in": "query", "name": "from", "required": false, "schema": { "format": "date", "type": "string" } }, { "description": "Filter adjustments by end date.", "in": "query", "name": "to", "required": false, "schema": { "format": "date", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/adjustments_getContractAdjustments_Response_200" } } }, "description": "Successful operation." }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RetrieveAdjustments-v2026-01-01RequestBadRequestError" } } }, "description": "Operation failed." }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContainer" } } }, "description": "Operation failed." }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContainer" } } }, "description": "Operation failed." }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContainer" } } }, "description": "Operation failed." }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContainer" } } }, "description": "Operation failed." } }, "security": [ { "deelToken": [] } ], "summary": "Retrieve adjustments", "tags": [ "Adjustments" ] } }, "/contracts/{contract_id}/amendments": { "get": { "description": "Returns the amendments of a contract. For Individual Contractor contracts this may include several amendments; for Global Payroll contracts it returns only the current pending amendment, if any.\n\n **Token scopes**: `contracts:read`", "operationId": "contractorAmendments_getContractAmendments", "parameters": [ { "description": "Unique identifier of the contract", "in": "path", "name": "contract_id", "required": true, "schema": { "type": "string" } }, { "description": "Filter by work statement status.", "in": "query", "name": "statuses", "required": false, "schema": { "items": { "$ref": "#/components/schemas/ContractsContractIdAmendmentsGetParametersStatusesSchemaItems" }, "type": "array" } }, { "description": "Filter by work statement sign status.", "in": "query", "name": "sign_statuses", "required": false, "schema": { "items": { "$ref": "#/components/schemas/ContractsContractIdAmendmentsGetParametersSignStatusesSchemaItems" }, "type": "array" } }, { "description": "Maximum number of work statements to return.", "in": "query", "name": "limit", "required": false, "schema": { "default": 20, "maximum": 100, "minimum": 1, "type": "integer" } }, { "description": "Cursor for pagination.", "in": "query", "name": "cursor", "required": false, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/contractor-amendments_getContractAmendments_Response_200" } } }, "description": "Successful operation." }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ListContractAmendments-v2026-01-01RequestBadRequestError" } } }, "description": "Operation failed." }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContainer" } } }, "description": "Operation failed." }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContainer" } } }, "description": "Operation failed." }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContainer" } } }, "description": "Operation failed." }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ListContractAmendments-v2026-01-01RequestInternalServerError" } } }, "description": "Operation failed." } }, "security": [ { "deelToken": [] } ], "summary": "List contract amendments", "tags": [ "contractorAmendments" ] }, "post": { "description": "Submits an amendment to modify the details of an existing contract. If the contract is already signed or active, the amendment must be approved and re-signed before the changes take effect. For Global Payroll contracts, calling this again while an amendment is still pending updates it in place instead of creating a new one.\n\n **Token scopes**: `contracts:write`", "operationId": "contractorAmendments_createContractAmendment", "parameters": [ { "description": "The unique identifier of the employee contract.", "in": "path", "name": "contract_id", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "properties": { "data": { "$ref": "#/components/schemas/ContractsContractIdAmendmentsPostRequestBodyContentApplicationJsonSchemaData" } }, "required": [ "data" ], "type": "object" } } }, "description": "Contract object that needs to be amended" }, "responses": { "201": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/contractor-amendments_createContractAmendment_Response_201" } } }, "description": "Successful operation." }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AmendContract-v2026-01-01RequestBadRequestError" } } }, "description": "Invalid request parameters." }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContainer" } } }, "description": "Operation failed." }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContainer" } } }, "description": "Operation failed." }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContainer" } } }, "description": "Operation failed." }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AmendContract-v2026-01-01RequestInternalServerError" } } }, "description": "Internal server error." } }, "security": [ { "deelToken": [] } ], "summary": "Update contract", "tags": [ "contractorAmendments" ] } }, "/contracts/{contract_id}/amendments/{amendment_id}/sign": { "post": { "description": "Signs a pending Global Payroll amendment on the client's behalf, applying the change. amendment_id is the id returned by POST /contracts/{contract_id}/amendments. Global Payroll amendments only — IC contracts use POST /workers/amendments/{amendment_id}/sign instead.\n\n **Token scopes**: `contracts:write`\n\n **Beta**: this version requires the `X-Beta: true` request header and its contract may change before it is promoted to stable. It is scheduled to become stable on 2026-12-29.", "operationId": "contracts_signGlobalPayrollAmendment-v2026-09-29", "parameters": [ { "description": "The unique identifier of the Global Payroll contract.", "in": "path", "name": "contract_id", "required": true, "schema": { "type": "string" } }, { "description": "The unique identifier of the Global Payroll amendment to sign, as returned by POST /contracts/{contract_id}/amendments.", "in": "path", "name": "amendment_id", "required": true, "schema": { "format": "uuid", "type": "string" } }, { "description": "Opts in to the beta version of this endpoint. Must be `true`.", "in": "header", "name": "X-Beta", "required": true, "schema": { "$ref": "#/components/schemas/ContractsContractIdAmendmentsAmendmentIdSignPostParametersXBeta" } } ], "requestBody": { "content": { "application/json": { "schema": { "properties": { "data": { "$ref": "#/components/schemas/ContractsContractIdAmendmentsAmendmentIdSignPostRequestBodyContentApplicationJsonSchemaData" } }, "required": [ "data" ], "type": "object" } } } }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Contracts_signGlobalPayrollAmendment-v2026-09-29_Response_200" } } }, "description": "Amendment successfully signed." }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SignGlobalPayrollAmendment-v2026-09-29RequestBadRequestError" } } }, "description": "Invalid request parameters." }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContainer" } } }, "description": "Operation failed." }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContainer" } } }, "description": "Operation failed." }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SignGlobalPayrollAmendment-v2026-09-29RequestNotFoundError" } } }, "description": "Amendment not found." }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SignGlobalPayrollAmendment-v2026-09-29RequestInternalServerError" } } }, "description": "Internal server error." } }, "security": [ { "deelToken": [] } ], "summary": "Submit Global Payroll amendment signature", "tags": [ "contracts" ] } }, "/contracts/{contract_id}/cost-centers": { "post": { "description": "Assign cost centers to employment by contract id\n\n **Token scopes**: `contracts:write`", "operationId": "costCenters_assignCostCentersToAnEmploymentContract-v2026-01-01", "parameters": [ { "description": "Employment's contract ID", "in": "path", "name": "contract_id", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "properties": { "data": { "$ref": "#/components/schemas/ContractsContractIdCostCentersPostRequestBodyContentApplicationJsonSchemaData" } }, "required": [ "data" ], "type": "object" } } }, "description": "Cost center information to allocate to the contract" }, "responses": { "201": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Cost_Centers_assignCostCentersToAnEmploymentContract-v2026-01-01_Response_201" } } }, "description": "Cost center allocation was successfully added to the contract" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AssignCostCentersToAnEmploymentContract-v2026-01-01RequestBadRequestError" } } }, "description": "Operation failed." }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContainer" } } }, "description": "Operation failed." }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContainer" } } }, "description": "Operation failed." }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContainer" } } }, "description": "Operation failed." }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContainer" } } }, "description": "Operation failed." } }, "security": [ { "deelToken": [] } ], "summary": "Assign cost centers to an employment contract", "tags": [ "costCenters" ] } }, "/contracts/{contract_id}/custom_fields": { "get": { "description": "Returns all custom fields associated with the specified contract.\n\n **Token scopes**: `contracts:read`", "operationId": "customFieldsContracts_getContractCustomFields", "parameters": [ { "description": "Contract Id", "in": "path", "name": "contract_id", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/custom-fields-contracts_getContractCustomFields_Response_200" } } }, "description": "Successful response" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContainer" } } }, "description": "Operation failed." }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContainer" } } }, "description": "Operation failed." }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContainer" } } }, "description": "Operation failed." }, "404": { "content": { "application/json": { "schema": { "description": "Any type" } } }, "description": "Custom fields Not found" }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContainer" } } }, "description": "Operation failed." } }, "security": [ { "deelToken": [] } ], "summary": "Retrieve custom fields for a contract", "tags": [ "customFieldsContracts" ] }, "put": { "description": "Creates or updates custom field values on the specified contract. This is a full replacement operation — any custom field values not included in the request body will be removed.\n\n **Token scopes**: `contracts:write`", "operationId": "customFieldsContracts_putContractCustomField", "parameters": [ { "description": "Contract id.", "in": "path", "name": "contract_id", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "properties": { "data": { "$ref": "#/components/schemas/ContractsContractIdCustomFieldsPutRequestBodyContentApplicationJsonSchemaData" } }, "required": [ "data" ], "type": "object" } } } }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/custom-fields-contracts_putContractCustomField_Response_200" } } }, "description": "Successful response" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContainer" } } }, "description": "Operation failed." }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContainer" } } }, "description": "Operation failed." }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContainer" } } }, "description": "Operation failed." }, "404": { "content": { "application/json": { "schema": { "description": "Any type" } } }, "description": "Not found" }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContainer" } } }, "description": "Operation failed." } }, "security": [ { "deelToken": [] } ], "summary": "Update custom field value", "tags": [ "customFieldsContracts" ] } }, "/contracts/{contract_id}/custom_fields/{id}": { "delete": { "description": "Clears the value of a custom field on the specified contract, identified by the custom field `id`.\n\n **Token scopes**: `contracts:write`", "operationId": "customFieldsContracts_deleteContractCustomField", "parameters": [ { "description": "Custom field id.", "in": "path", "name": "id", "required": true, "schema": { "format": "uuid", "type": "string" } }, { "description": "Contract id.", "in": "path", "name": "contract_id", "required": true, "schema": { "format": "uuid", "type": "string" } } ], "responses": { "204": { "content": { "application/json": { "schema": { "properties": {}, "type": "object" } } }, "description": "Successful response" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContainer" } } }, "description": "Operation failed." }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContainer" } } }, "description": "Operation failed." }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContainer" } } }, "description": "Operation failed." }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContainer" } } }, "description": "Operation failed." }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContainer" } } }, "description": "Operation failed." } }, "security": [ { "deelToken": [] } ], "summary": "Delete Contract custom field by Id", "tags": [ "customFieldsContracts" ] } }, "/contracts/{contract_id}/documents": { "post": { "description": "Uploads a file and attaches it as a document to the specified contract by creating an amendment with the attachment. Only supported for ongoing_time_based, milestones, payg_tasks, time_based, pay_as_you_go_time_based, and eor contract types.\n\n **Token scopes**: `contracts:write`", "operationId": "contractorHiring_createContractDocument", "parameters": [ { "description": "Deel contract id.", "in": "path", "name": "contract_id", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "multipart/form-data": { "schema": { "properties": { "file": { "description": "Upload the file you want to attach to this entry.", "format": "binary", "type": "string" } }, "type": "object" } } }, "description": "A form to attach a file to contract document." }, "responses": { "201": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/contractor-hiring_createContractDocument_Response_201" } } }, "description": "Successful operation." }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContainer" } } }, "description": "Operation failed." }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContainer" } } }, "description": "Operation failed." }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContainer" } } }, "description": "Operation failed." }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContainer" } } }, "description": "Operation failed." }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContainer" } } }, "description": "Operation failed." } }, "security": [ { "deelToken": [] } ], "summary": "Attach a file to contract", "tags": [ "contractorHiring" ] } }, "/contracts/{contract_id}/ic-invoicing-taxes": { "get": { "description": "Retrieves the VAT and withholding tax settings configured for an independent contractor contract.\n\n **Token scopes**: `invoice-adjustments:read`", "operationId": "icInvoicingTaxes_getIcInvoicingTaxes-v2026-01-01", "parameters": [ { "description": "Deel Contract ID", "in": "path", "name": "contract_id", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/IC_invoicing_taxes_getIcInvoicingTaxes-v2026-01-01_Response_200" } } }, "description": "IC invoicing taxes response" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetIcInvoicingTaxes-v2026-01-01RequestBadRequestError" } } }, "description": "Operation failed." }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContainer" } } }, "description": "Operation failed." }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContainer" } } }, "description": "Operation failed." }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContainer" } } }, "description": "Operation failed." }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetIcInvoicingTaxes-v2026-01-01RequestInternalServerError" } } }, "description": "Operation failed." } }, "security": [ { "deelToken": [] } ], "summary": "Get IC invoicing taxes", "tags": [ "icInvoicingTaxes" ] }, "patch": { "description": "Applies a partial update to the invoicing tax for an independent contractor contract; accepts `tax_type` (WITHHOLDING_TAX or VAT) and `percentage` to modify how taxes are calculated on future invoices.\n\n **Token scopes**: `invoice-adjustments:write`", "operationId": "icInvoicingTaxes_updateIcInvoicingTax-v2026-01-01", "parameters": [ { "description": "Deel Contract ID", "in": "path", "name": "contract_id", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "properties": { "data": { "$ref": "#/components/schemas/ContractsContractIdIcInvoicingTaxesPatchRequestBodyContentApplicationJsonSchemaData", "description": "IC invoicing tax fields to update on the contract." } }, "type": "object" } } } }, "responses": { "204": { "content": { "application/json": { "schema": { "properties": {}, "type": "object" } } }, "description": "IC tax successfully updated" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UpdateIcInvoicingTax-v2026-01-01RequestBadRequestError" } } }, "description": "Bad Request - The request payload failed validation or violated a business rule for the IC invoicing tax." }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContainer" } } }, "description": "Operation failed." }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContainer" } } }, "description": "Operation failed." }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UpdateIcInvoicingTax-v2026-01-01RequestNotFoundError" } } }, "description": "Not Found - The specified contract does not exist." }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UpdateIcInvoicingTax-v2026-01-01RequestInternalServerError" } } }, "description": "Internal Server Error - The IC invoicing tax could not be updated due to an unexpected upstream or internal failure." } }, "security": [ { "deelToken": [] } ], "summary": "Update IC invoicing tax", "tags": [ "icInvoicingTaxes" ] }, "post": { "description": "Creates an invoicing tax entry for an independent contractor contract.\n\n **Token scopes**: `invoice-adjustments:write`", "operationId": "icInvoicingTaxes_createIcInvoicingTax-v2026-01-01", "parameters": [ { "description": "Deel Contract ID", "in": "path", "name": "contract_id", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "properties": { "data": { "$ref": "#/components/schemas/ContractsContractIdIcInvoicingTaxesPostRequestBodyContentApplicationJsonSchemaData" } }, "type": "object" } } } }, "responses": { "201": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/IC_invoicing_taxes_createIcInvoicingTax-v2026-01-01_Response_201" } } }, "description": "IC tax successfully created" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreateIcInvoicingTax-v2026-01-01RequestBadRequestError" } } }, "description": "Operation failed." }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContainer" } } }, "description": "Operation failed." }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContainer" } } }, "description": "Operation failed." }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContainer" } } }, "description": "Operation failed." }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreateIcInvoicingTax-v2026-01-01RequestInternalServerError" } } }, "description": "Operation failed." } }, "security": [ { "deelToken": [] } ], "summary": "Create IC invoicing tax", "tags": [ "icInvoicingTaxes" ] } }, "/contracts/{contract_id}/ic-invoicing-taxes/{tax_type}": { "delete": { "description": "Permanently removes the specified `tax_type` from the contract's invoicing tax configuration; this action is irreversible and takes effect on future invoices.\n\n **Token scopes**: `invoice-adjustments:write`", "operationId": "icInvoicingTaxes_deleteIcInvoicingTax-v2026-01-01", "parameters": [ { "description": "Deel Contract ID", "in": "path", "name": "contract_id", "required": true, "schema": { "type": "string" } }, { "description": "IC tax type", "in": "path", "name": "tax_type", "required": true, "schema": { "$ref": "#/components/schemas/ContractsContractIdIcInvoicingTaxesTaxTypeDeleteParametersTaxType" } } ], "responses": { "204": { "content": { "application/json": { "schema": { "properties": {}, "type": "object" } } }, "description": "IC tax successfully deleted" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DeleteIcInvoicingTax-v2026-01-01RequestBadRequestError" } } }, "description": "Bad Request - The request payload failed validation or violated a business rule for the IC invoicing tax." }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContainer" } } }, "description": "Operation failed." }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContainer" } } }, "description": "Operation failed." }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DeleteIcInvoicingTax-v2026-01-01RequestNotFoundError" } } }, "description": "Not Found - The specified contract does not exist." }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DeleteIcInvoicingTax-v2026-01-01RequestInternalServerError" } } }, "description": "Internal Server Error - The IC invoicing tax could not be deleted due to an unexpected upstream or internal failure." } }, "security": [ { "deelToken": [] } ], "summary": "Delete IC invoicing tax", "tags": [ "icInvoicingTaxes" ] } }, "/contracts/{contract_id}/invitations": { "delete": { "description": "Removes the active signing invitation from a contract to allow a new invitation to be issued to the worker.\n\n **Token scopes**: `contracts:write`", "operationId": "contractorHiring_getContractInvitations", "parameters": [ { "description": "Deel contract id.", "in": "path", "name": "contract_id", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/contractor-hiring_getContractInvitations_Response_200" } } }, "description": "Successful operation." }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContainer" } } }, "description": "Operation failed." }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContainer" } } }, "description": "Operation failed." }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContainer" } } }, "description": "Operation failed." }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContainer" } } }, "description": "Operation failed." }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContainer" } } }, "description": "Operation failed." } }, "security": [ { "deelToken": [] } ], "summary": "Remove invite", "tags": [ "contractorHiring" ] }, "post": { "description": "Sends a signing invitation email to a worker for the specified contract, setting their email as the expected signer. If the contract was previously rejected, resets its status back to a signing-eligible state. Can only be called if the worker has not already signed the contract.\n\n **Token scopes**: `contracts:write`", "operationId": "contractorHiring_createContractInvitation", "parameters": [ { "description": "Deel contract id.", "in": "path", "name": "contract_id", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "properties": { "data": { "$ref": "#/components/schemas/ContractsContractIdInvitationsPostRequestBodyContentApplicationJsonSchemaData" } }, "type": "object" } } } }, "responses": { "201": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/contractor-hiring_createContractInvitation_Response_201" } } }, "description": "Successful operation." }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContainer" } } }, "description": "Operation failed." }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContainer" } } }, "description": "Operation failed." }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContainer" } } }, "description": "Operation failed." }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContainer" } } }, "description": "Operation failed." }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContainer" } } }, "description": "Operation failed." } }, "security": [ { "deelToken": [] } ], "summary": "Send contract to worker", "tags": [ "contractorHiring" ] } }, "/contracts/{contract_id}/invite": { "get": { "description": "Retrieves the signing invitation link generated for the worker on a contract, with optional localization via the `locale` parameter.\n\n **Token scopes**: `contracts:read`", "operationId": "contractorHiring_getContractInvite", "parameters": [ { "description": "Deel contract id.", "in": "path", "name": "contract_id", "required": true, "schema": { "type": "string" } }, { "description": "Locale to use for the invite link.", "in": "query", "name": "locale", "required": false, "schema": { "maxLength": 5, "minLength": 2, "pattern": "^[a-z]{2,5}$", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/contractor-hiring_getContractInvite_Response_200" } } }, "description": "Successful operation." }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContainer" } } }, "description": "Operation failed." }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContainer" } } }, "description": "Operation failed." }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContainer" } } }, "description": "Operation failed." }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContainer" } } }, "description": "Operation failed." }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContainer" } } }, "description": "Operation failed." } }, "security": [ { "deelToken": [] } ], "summary": "Get worker invite link", "tags": [ "contractorHiring" ] } }, "/contracts/{contract_id}/invoice-adjustments": { "get": { "description": "Retrieves invoice line items (adjustments) associated with a given contract_id, with support for filtering by contract type, adjustment type, status, invoice, reporter, and submission date range.\n\n **Token scopes**: `invoice-adjustments:read`", "operationId": "invoiceAdjustments_getContractInvoiceAdjustments", "parameters": [ { "description": "Deel contract id.", "in": "path", "name": "contract_id", "required": true, "schema": { "type": "string" } }, { "description": "types of contracts to filter", "in": "query", "name": "contract_types", "required": false, "schema": { "items": { "$ref": "#/components/schemas/ContractsContractIdInvoiceAdjustmentsGetParametersContractTypesSchemaItems" }, "type": "array" } }, { "description": "types of invoice adjustments to filter", "in": "query", "name": "types", "required": false, "schema": { "items": { "$ref": "#/components/schemas/ContractsContractIdInvoiceAdjustmentsGetParametersTypesSchemaItems" }, "type": "array" } }, { "description": "statuses of invoice adjustment to filter", "in": "query", "name": "statuses", "required": false, "schema": { "items": { "$ref": "#/components/schemas/ContractsContractIdInvoiceAdjustmentsGetParametersStatusesSchemaItems" }, "type": "array" } }, { "description": "ID of an existing invoice", "in": "query", "name": "invoice_id", "required": false, "schema": { "type": "string" } }, { "description": "ID of an existing profile", "in": "query", "name": "reporter_id", "required": false, "schema": { "format": "uuid", "type": "string" } }, { "description": "To get invoice adjustments submitted on or after given start date (inclusive). Short date in format ISO-8601 (YYYY-MM-DD). For example: 2022-12-31.", "in": "query", "name": "date_from", "required": false, "schema": { "format": "date", "type": "string" } }, { "description": "To get invoice adjustments submitted before given end date (excludes records submitted on this date). Short date in format ISO-8601 (YYYY-MM-DD). For example: 2022-12-31.", "in": "query", "name": "date_to", "required": false, "schema": { "format": "date", "type": "string" } }, { "description": "Return a page of results with given number of records; NOTE: technically ALL query parameters are strings or array of strings", "in": "query", "name": "limit", "required": false, "schema": { "pattern": "^[1-9][0-9]?$|^100$", "type": "string" } }, { "description": "Return a page of results after given index of row; NOTE: technically ALL query parameters are strings or array of strings", "in": "query", "name": "offset", "required": false, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/invoice-adjustments_getContractInvoiceAdjustments_Response_200" } } }, "description": "Successful operation." }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/InvoiceLineItemsByContract-v2026-01-01RequestBadRequestError" } } }, "description": "Bad Request - Validation error or invalid parameters" }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContainer" } } }, "description": "Operation failed." }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContainer" } } }, "description": "Operation failed." }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContainer" } } }, "description": "Operation failed." }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContainer" } } }, "description": "Operation failed." } }, "security": [ { "deelToken": [] } ], "summary": "Invoice line items by contract", "tags": [ "invoiceAdjustments" ] } }, "/contracts/{contract_id}/milestones": { "get": { "description": "Retrieves all milestones associated with a specific contract, including each milestone's title, amount, status, relevant dates, and creator and reviewer information.\n\n **Token scopes**: `milestones:read`", "operationId": "milestones_getContractMilestones", "parameters": [ { "description": "The unique identifier of the Deel contract for which milestones are being retrieved.", "in": "path", "name": "contract_id", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/milestones_getContractMilestones_Response_200" } } }, "description": "A list of milestones for the specified contract." }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetMilestonesByContract-v2026-01-01RequestBadRequestError" } } }, "description": "Bad Request - The contract_id parameter failed validation." }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContainer" } } }, "description": "Operation failed." }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetMilestonesByContract-v2026-01-01RequestForbiddenError" } } }, "description": "Forbidden - The requesting token does not have access to this organization." }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetMilestonesByContract-v2026-01-01RequestNotFoundError" } } }, "description": "Not Found - The specified contract does not exist." }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetMilestonesByContract-v2026-01-01RequestInternalServerError" } } }, "description": "Internal Server Error - The contract milestones could not be retrieved due to an unexpected upstream or internal failure." } }, "security": [ { "deelToken": [] } ], "summary": "Retrieve Milestones by Contract", "tags": [ "Milestones" ] }, "post": { "description": "Creates a new payment milestone on a milestone-based contract. After creation, the milestone enters a review workflow before payment is processed.\n\n **Token scopes**: `milestones:write`", "operationId": "milestones_createContractMilestone", "parameters": [ { "description": "The unique identifier of the Deel contract where the milestone will be added.", "in": "path", "name": "contract_id", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "properties": { "data": { "$ref": "#/components/schemas/ContractsContractIdMilestonesPostRequestBodyContentApplicationJsonSchemaData" } }, "required": [ "data" ], "type": "object" } } }, "description": "The milestone object containing the required details to be added to the contract." }, "responses": { "201": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/milestones_createContractMilestone_Response_201" } } }, "description": "Milestone created successfully." }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreateMilestone-v2026-01-01RequestBadRequestError" } } }, "description": "Bad Request - The request payload failed validation or violated a business rule, such as the contract not supporting milestones." }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContainer" } } }, "description": "Operation failed." }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreateMilestone-v2026-01-01RequestForbiddenError" } } }, "description": "Forbidden - The requester does not own this contract." }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreateMilestone-v2026-01-01RequestNotFoundError" } } }, "description": "Not Found - The specified contract or an associated resource does not exist." }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreateMilestone-v2026-01-01RequestInternalServerError" } } }, "description": "Internal Server Error - The milestone could not be created due to an unexpected upstream or internal failure." } }, "security": [ { "deelToken": [] } ], "summary": "Create a Milestone", "tags": [ "Milestones" ] } }, "/contracts/{contract_id}/milestones/{milestone_id}": { "delete": { "description": "Permanently deletes a specific milestone from a contract. This operation is irreversible and removes all associated milestone data.\n\n **Token scopes**: `milestones:write`", "operationId": "milestones_deleteContractMilestone", "parameters": [ { "description": "The unique identifier of the Deel contract from which the milestone will be deleted.", "in": "path", "name": "contract_id", "required": true, "schema": { "type": "string" } }, { "description": "The unique identifier of the milestone that is to be deleted.", "in": "path", "name": "milestone_id", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/milestones_deleteContractMilestone_Response_200" } } }, "description": "Milestone successfully deleted." }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DeleteMilestoneById-v2026-01-01RequestBadRequestError" } } }, "description": "Bad Request - The milestone cannot be removed given its current status." }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContainer" } } }, "description": "Operation failed." }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DeleteMilestoneById-v2026-01-01RequestForbiddenError" } } }, "description": "Forbidden - The requester does not own this contract." }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DeleteMilestoneById-v2026-01-01RequestNotFoundError" } } }, "description": "Not Found - The specified contract or milestone does not exist." }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DeleteMilestoneById-v2026-01-01RequestInternalServerError" } } }, "description": "Internal Server Error - The milestone could not be deleted due to an unexpected upstream or internal failure." } }, "security": [ { "deelToken": [] } ], "summary": "Delete a Milestone", "tags": [ "Milestones" ] }, "get": { "description": "Retrieves a single milestone identified by milestone_id within a specific contract.\n\n **Token scopes**: `milestones:read`", "operationId": "milestones_getContractMilestoneById", "parameters": [ { "description": "Deel contract id.", "in": "path", "name": "contract_id", "required": true, "schema": { "type": "string" } }, { "description": "ID of milestone to return", "in": "path", "name": "milestone_id", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/milestones_getContractMilestoneById_Response_200" } } }, "description": "Successful operation." }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetMilestonesByContractAndId-v2026-01-01RequestBadRequestError" } } }, "description": "Bad Request - The contract_id or milestone_id parameter failed validation." }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContainer" } } }, "description": "Operation failed." }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContainer" } } }, "description": "Operation failed." }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetMilestonesByContractAndId-v2026-01-01RequestNotFoundError" } } }, "description": "Not Found - The specified contract or milestone does not exist." }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetMilestonesByContractAndId-v2026-01-01RequestInternalServerError" } } }, "description": "Internal Server Error - The milestone could not be retrieved due to an unexpected upstream or internal failure." } }, "security": [ { "deelToken": [] } ], "summary": "Retrieve a single milestone", "tags": [ "Milestones" ] } }, "/contracts/{contract_id}/off-cycle-payments": { "get": { "description": "Retrieves all off-cycle payments for a specified contract. Off-cycle payments represent payments made outside the regular payment schedule, such as exceptional or one-time expenses.\n\n **Token scopes**: `off-cycle-payments:read`", "operationId": "offCycle_getContractOffCyclePayments", "parameters": [ { "description": "The unique identifier (ID) of the Deel contract for which to retrieve off-cycle payments.", "in": "path", "name": "contract_id", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/off-cycle_getContractOffCyclePayments_Response_200" } } }, "description": "Successful retrieval of off-cycle payments." }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetOffCyclePaymentsByContract-v2026-01-01RequestBadRequestError" } } }, "description": "Bad Request - The contract_id parameter failed validation." }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContainer" } } }, "description": "Operation failed." }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetOffCyclePaymentsByContract-v2026-01-01RequestForbiddenError" } } }, "description": "Forbidden - The requesting token is not authorized to list off-cycle payments as a client." }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetOffCyclePaymentsByContract-v2026-01-01RequestNotFoundError" } } }, "description": "Not Found - The specified contract does not exist." }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetOffCyclePaymentsByContract-v2026-01-01RequestInternalServerError" } } }, "description": "Internal Server Error - The off-cycle payments could not be listed due to an unexpected upstream or internal failure." } }, "security": [ { "deelToken": [] } ], "summary": "List of off-cycle payments", "tags": [ "offCycle" ] }, "post": { "description": "Adds a one-off payment to a contract outside its regular payment cycle, such as a bonus, a reimbursement or a correction that the contractor should receive on top of the scheduled amount. Set is_auto_approved to skip the manual approval step. Use GET /contracts/{contract_id}/off-cycle-payments/{off_cycle_payment_id} to follow the payment afterwards.\n\n **Token scopes**: `off-cycle-payments:write`", "operationId": "offCycle_createContractOffCyclePayment", "parameters": [ { "description": "The unique identifier (ID) of the Deel contract for which the off-cycle payment is being created.", "in": "path", "name": "contract_id", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "properties": { "data": { "$ref": "#/components/schemas/ContractsContractIdOffCyclePaymentsPostRequestBodyContentApplicationJsonSchemaData", "description": "The off-cycle payment data to submit." } }, "type": "object" } } }, "description": "Details of the off-cycle payment to be created." }, "responses": { "201": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/off-cycle_createContractOffCyclePayment_Response_201" } } }, "description": "The off-cycle payment was successfully created." }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AddOffCyclePayment-v2026-01-01RequestBadRequestError" } } }, "description": "Bad Request - The request payload failed validation, the contract type does not support off-cycle payments, or payment_due_date is not a valid calendar date, is in the past or after the contract end date." }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContainer" } } }, "description": "Operation failed." }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AddOffCyclePayment-v2026-01-01RequestForbiddenError" } } }, "description": "Forbidden - The requesting token is not authorized to create off-cycle payments on this contract." }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AddOffCyclePayment-v2026-01-01RequestNotFoundError" } } }, "description": "Not Found - The specified contract does not exist." }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AddOffCyclePayment-v2026-01-01RequestInternalServerError" } } }, "description": "Internal Server Error - The off-cycle payment could not be created due to an unexpected upstream or internal failure." } }, "security": [ { "deelToken": [] } ], "summary": "Add off-cycle payment", "tags": [ "offCycle" ] } }, "/contracts/{contract_id}/off-cycle-payments/{id}": { "get": { "operationId": "offCycle_getContractOffCyclePaymentById", "parameters": [ { "in": "path", "name": "contract_id", "required": true, "schema": { "type": "string" } }, { "in": "path", "name": "id", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Successful response" } }, "summary": "Get Contract Off Cycle Payment By Id", "tags": [ "offCycle" ] } }, "/contracts/{contract_id}/off-cycle-payments/{off_cycle_payment_id}": { "get": { "description": "Retrieves a single off-cycle payment identified by id within a specific contract.\n\n **Token scopes**: `off-cycle-payments:read`", "operationId": "offCyclePayments_getOffCyclePaymentByContractAndId-v2026-01-01", "parameters": [ { "description": "Deel contract id.", "in": "path", "name": "contract_id", "required": true, "schema": { "type": "string" } }, { "description": "Deel off-cycle payment id.", "in": "path", "name": "off_cycle_payment_id", "required": true, "schema": { "format": "uuid", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Off-cycle_Payments_getOffCyclePaymentByContractAndId-v2026-01-01_Response_200" } } }, "description": "Successful operation." }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetOffCyclePaymentByContractAndId-v2026-01-01RequestBadRequestError" } } }, "description": "Bad Request - The contract_id parameter failed validation." }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContainer" } } }, "description": "Operation failed." }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetOffCyclePaymentByContractAndId-v2026-01-01RequestForbiddenError" } } }, "description": "Forbidden - The requesting token is not authorized to retrieve off-cycle payments as a client." }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetOffCyclePaymentByContractAndId-v2026-01-01RequestNotFoundError" } } }, "description": "Not Found - The specified contract does not exist." }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetOffCyclePaymentByContractAndId-v2026-01-01RequestInternalServerError" } } }, "description": "Internal Server Error - The off-cycle payment could not be retrieved due to an unexpected upstream or internal failure." } }, "security": [ { "deelToken": [] } ], "summary": "Retrieve a single off-cycle payment", "tags": [ "offCyclePayments" ] } }, "/contracts/{contract_id}/payment_cycles": { "get": { "description": "Retrieves only the payment cycles of a contract, without the rest of the contract record. Use it to find out when each cycle falls due and whether it has been completed.\n\n **Token scopes**: `contracts:read`", "operationId": "contractorHiring_getContractPaymentCycles", "parameters": [ { "description": "The Deel contract ID for which payment dates are being retrieved.", "in": "path", "name": "contract_id", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/contractor-hiring_getContractPaymentCycles_Response_200" } } }, "description": "A successful response containing contractor payment dates." }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContainer" } } }, "description": "Operation failed." }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContainer" } } }, "description": "Operation failed." } }, "security": [ { "deelToken": [] } ], "summary": "Retrieve contractor payment dates", "tags": [ "contractorHiring" ] } }, "/contracts/{contract_id}/platform-payment": { "patch": { "description": "Sets the payment type for an IC contract. Use `platform_payment_type_application_type` to control when the change takes effect on a signed contract.\n\n **Token scopes**: `contracts:write`", "operationId": "contracts_updateContractPlatformPaymentType-v2026-06-24", "parameters": [ { "description": "Unique identifier of the contract.", "in": "path", "name": "contract_id", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "properties": { "data": { "$ref": "#/components/schemas/ContractsContractIdPlatformPaymentPatchRequestBodyContentApplicationJsonSchemaData" } }, "required": [ "data" ], "type": "object" } } } }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Contracts_updateContractPlatformPaymentType-v2026-06-24_Response_200" } } }, "description": "Successful operation. Returns the updated contract." }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UpdateContractPlatformPaymentType-v2026-06-24RequestBadRequestError" } } }, "description": "Bad Request - Validation error or invalid parameters" }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContainer" } } }, "description": "Operation failed." }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContainer" } } }, "description": "Operation failed." }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UpdateContractPlatformPaymentType-v2026-06-24RequestNotFoundError" } } }, "description": "Not found" }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UpdateContractPlatformPaymentType-v2026-06-24RequestInternalServerError" } } }, "description": "Operation failed." } }, "security": [ { "deelToken": [] } ], "summary": "Update contract payment type", "tags": [ "contracts" ] } }, "/contracts/{contract_id}/preview": { "get": { "description": "Returns the rendered HTML content of an IC or EOR contract agreement for a given contract_id. If no templateId is provided, the default or currently assigned template is used. Global Payroll contract types are not supported.\n\n **Token scopes**: `contracts:read`, `worker:read`", "operationId": "contractorHiring_getContractPreview", "parameters": [ { "description": "Deel contract id.", "in": "path", "name": "contract_id", "required": true, "schema": { "type": "string" } }, { "description": "ID of an existing contract template.", "in": "query", "name": "templateId", "required": false, "schema": { "format": "uuid", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "properties": {}, "type": "object" } } }, "description": "Successful operation." }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContainer" } } }, "description": "Operation failed." }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContainer" } } }, "description": "Operation failed." }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContainer" } } }, "description": "Operation failed." }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContainer" } } }, "description": "Operation failed." }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContainer" } } }, "description": "Operation failed." } }, "security": [ { "deelToken": [] } ], "summary": "Preview a contract agreement", "tags": [ "contractorHiring" ] } }, "/contracts/{contract_id}/signatures": { "post": { "description": "Signs a contract on behalf of the client (employer), advancing the contract through the hiring workflow. When the contract is awaiting the client signature, it transitions to a pending-contractor-signature state. Can also be used to sign a pending amendment on an already active contract.\n\n **Token scopes**: `contracts:write`", "operationId": "contractorHiring_createContractSignature", "parameters": [ { "description": "Deel contract id.", "in": "path", "name": "contract_id", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "properties": { "data": { "$ref": "#/components/schemas/ContractsContractIdSignaturesPostRequestBodyContentApplicationJsonSchemaData" } }, "type": "object" } } } }, "responses": { "201": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/contractor-hiring_createContractSignature_Response_201" } } }, "description": "Successful operation." }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContainer" } } }, "description": "Operation failed." }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContainer" } } }, "description": "Operation failed." }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContainer" } } }, "description": "Operation failed." }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContainer" } } }, "description": "Operation failed." }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContainer" } } }, "description": "Operation failed." } }, "security": [ { "deelToken": [] } ], "summary": "Sign a contract", "tags": [ "contractorHiring" ] } }, "/contracts/{contract_id}/tasks": { "get": { "description": "Retrieves all tasks associated with a specific contract, including each task's ID, amount, submission date, status, and description.\n\n **Token scopes**: `contracts:read`", "operationId": "tasks_getContractTasks", "parameters": [ { "description": "The unique identifier for the Deel contract.", "in": "path", "name": "contract_id", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/tasks_getContractTasks_Response_200" } } }, "description": "Successful operation. A list of tasks associated with the specified contract." }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContainer" } } }, "description": "Operation failed." }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContainer" } } }, "description": "Operation failed." }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContainer" } } }, "description": "Operation failed." }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContainer" } } }, "description": "Operation failed." }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContainer" } } }, "description": "Operation failed." } }, "security": [ { "deelToken": [] } ], "summary": "List of tasks", "tags": [ "Tasks" ] }, "post": { "description": "Adds a new task to a contract. Use it to record new work; to change a task that already exists, use PATCH /tasks/{task_id}, and for a one-off payment that is not a task, use POST /contracts/{contract_id}/off-cycle-payments instead.\n\n **Token scopes**: `contracts:write`", "operationId": "tasks_createContractTask", "parameters": [ { "description": "The unique Deel contract ID associated with the task.", "in": "path", "name": "contract_id", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "properties": { "data": { "$ref": "#/components/schemas/ContractsContractIdTasksPostRequestBodyContentApplicationJsonSchemaData" } }, "type": "object" } } } }, "responses": { "201": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/tasks_createContractTask_Response_201" } } }, "description": "The task was successfully created." }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreateANewTask-v2026-01-01RequestBadRequestError" } } }, "description": "Bad request. Missing required fields or invalid data format." }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreateANewTask-v2026-01-01RequestUnauthorizedError" } } }, "description": "Unauthorized. Authentication credentials are missing or invalid." }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContainer" } } }, "description": "Operation failed." }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContainer" } } }, "description": "Operation failed." }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreateANewTask-v2026-01-01RequestInternalServerError" } } }, "description": "Internal server error. An unexpected error occurred while processing the request." } }, "security": [ { "deelToken": [] } ], "summary": "Create a new task", "tags": [ "Tasks" ] } }, "/contracts/{contract_id}/tasks/many/reviews": { "post": { "description": "Approves or declines multiple submitted tasks associated with a contract in a single request. Each task review must include a status of approved or declined, with an optional reason required when declining.\n\n **Token scopes**: `contracts:write`", "operationId": "tasks_reviewMultipleTasks-v2026-01-01", "parameters": [ { "description": "The unique Deel contract ID associated with the tasks.", "in": "path", "name": "contract_id", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "properties": { "data": { "$ref": "#/components/schemas/ContractsContractIdTasksManyReviewsPostRequestBodyContentApplicationJsonSchemaData" } }, "type": "object" } } } }, "responses": { "201": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Tasks_reviewMultipleTasks-v2026-01-01_Response_201" } } }, "description": "The task reviews were successfully processed." }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ReviewMultipleTasks-v2026-01-01RequestBadRequestError" } } }, "description": "Bad request. Missing required fields or invalid data format." }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ReviewMultipleTasks-v2026-01-01RequestUnauthorizedError" } } }, "description": "Unauthorized. Authentication credentials are missing or invalid." }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContainer" } } }, "description": "Operation failed." }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ReviewMultipleTasks-v2026-01-01RequestNotFoundError" } } }, "description": "Not found. One or more specified tasks or the contract was not found." }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ReviewMultipleTasks-v2026-01-01RequestInternalServerError" } } }, "description": "Internal server error. An unexpected error occurred while processing the request." } }, "security": [ { "deelToken": [] } ], "summary": "Review multiple tasks", "tags": [ "Tasks" ] } }, "/contracts/{contract_id}/tasks/{task_id}": { "delete": { "description": "Deletes a specific task from a contract. An optional `reason` can be supplied for audit or documentation purposes.\n\n **Token scopes**: `contracts:write`", "operationId": "tasks_deleteContractTask", "parameters": [ { "description": "The unique identifier of the Deel contract.", "in": "path", "name": "contract_id", "required": true, "schema": { "type": "string" } }, { "description": "The unique identifier of the task to be deleted.", "in": "path", "name": "task_id", "required": true, "schema": { "type": "string" } }, { "description": "The reason for deleting the task. This can be used for auditing purposes.", "in": "query", "name": "reason", "required": false, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/tasks_deleteContractTask_Response_200" } } }, "description": "The task was successfully deleted." }, "400": { "content": { "application/json": { "schema": { "description": "Any type" } } }, "description": "Invalid request. For example, missing required parameters or invalid format." }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContainer" } } }, "description": "Operation failed." }, "403": { "content": { "application/json": { "schema": { "description": "Any type" } } }, "description": "Permission denied. The user does not have the required access to delete the task." }, "404": { "content": { "application/json": { "schema": { "description": "Any type" } } }, "description": "The specified task or contract was not found." }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContainer" } } }, "description": "Operation failed." } }, "security": [ { "deelToken": [] } ], "summary": "Delete task", "tags": [ "Tasks" ] } }, "/contracts/{contract_id}/tasks/{task_id}/reviews": { "post": { "description": "Submits an approval or rejection review for a task associated with a contract. If the review status is declined, an optional reason may be included in the request body.\n\n **Token scopes**: `contracts:write`", "operationId": "tasks_createContractTaskReview", "parameters": [ { "description": "The unique Deel contract ID associated with the task.", "in": "path", "name": "contract_id", "required": true, "schema": { "type": "string" } }, { "description": "The unique ID of the task to be reviewed.", "in": "path", "name": "task_id", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "properties": { "data": { "$ref": "#/components/schemas/ContractsContractIdTasksTaskIdReviewsPostRequestBodyContentApplicationJsonSchemaData" } }, "type": "object" } } } }, "responses": { "201": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/tasks_createContractTaskReview_Response_201" } } }, "description": "The task review was successfully processed." }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ReviewASingleTask-v2026-01-01RequestBadRequestError" } } }, "description": "Bad request. Missing required fields or invalid data format." }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ReviewASingleTask-v2026-01-01RequestUnauthorizedError" } } }, "description": "Unauthorized. Authentication credentials are missing or invalid." }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContainer" } } }, "description": "Operation failed." }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ReviewASingleTask-v2026-01-01RequestNotFoundError" } } }, "description": "Not found. The specified task or contract was not found." }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ReviewASingleTask-v2026-01-01RequestInternalServerError" } } }, "description": "Internal server error. An unexpected error occurred while processing the request." } }, "security": [ { "deelToken": [] } ], "summary": "Review a single task", "tags": [ "Tasks" ] } }, "/contracts/{contract_id}/terminations": { "delete": { "description": "Cancels a pending termination request for the specified contract, reverting the contract to its pre-termination state. Only termination requests that have not yet reached their effective date can be cancelled.\n\n **Token scopes**: `contracts:write`", "operationId": "terminations_deleteContractTermination", "parameters": [ { "description": "Unique identifier for the contract", "in": "path", "name": "contract_id", "required": true, "schema": { "type": "string" } } ], "responses": { "204": { "content": { "application/json": { "schema": { "properties": {}, "type": "object" } } }, "description": "Successful response" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DeleteContractTerminationRequest-v2026-01-01RequestBadRequestError" } } }, "description": "Operation failed." }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContainer" } } }, "description": "Operation failed." }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContainer" } } }, "description": "Operation failed." }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContainer" } } }, "description": "Operation failed." }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DeleteContractTerminationRequest-v2026-01-01RequestInternalServerError" } } }, "description": "Operation failed." } }, "security": [ { "deelToken": [] } ], "summary": "Delete Contract Termination Request", "tags": [ "Terminations" ] }, "post": { "description": "Initiates termination of an active contract, recording the termination reason, effective date, and any final payment details. Can only be called on contracts that are currently active.\n\n **Token scopes**: `contracts:write`", "operationId": "terminations_createContractTermination", "parameters": [ { "description": "The unique identifier of the contractor contract", "in": "path", "name": "contract_id", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "properties": { "data": { "$ref": "#/components/schemas/ContractsContractIdTerminationsPostRequestBodyContentApplicationJsonSchemaData", "description": "Termination data. At minimum, you must provide either terminate_now: true (for immediate termination) OR completion_date (for scheduled termination)." } }, "required": [ "data" ], "type": "object" } } } }, "responses": { "201": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/terminations_createContractTermination_Response_201" } } }, "description": "Successful operation" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TerminateContract-v2026-01-01RequestBadRequestError" } } }, "description": "Validation or business-rule failure. Possible codes: invalid_parameter (Joi schema violation, e.g. missing completion_date when terminate_now is false); contract_not_active (contract is not in an active state and cannot be terminated); invalid_completion_date (completion_date is in the past or otherwise invalid); invalid_termination_reason (termination_reason_id does not exist or is not applicable)." }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TerminateContract-v2026-01-01RequestUnauthorizedError" } } }, "description": "Missing or invalid bearer token." }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TerminateContract-v2026-01-01RequestForbiddenError" } } }, "description": "Caller lacks permission to terminate this contract. Either the caller does not have the contracts.terminate permission, is not a CLIENT profile, or does not have access to the specified contract." }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TerminateContract-v2026-01-01RequestNotFoundError" } } }, "description": "No active contract was found for the provided contract_id, or the caller does not have access to it." }, "409": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TerminateContract-v2026-01-01RequestConflictError" } } }, "description": "A termination request already exists for this contract and cannot be duplicated." }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TerminateContract-v2026-01-01RequestInternalServerError" } } }, "description": "Unhandled server error or downstream service failure during contract termination. The transaction is rolled back and no termination is persisted." } }, "security": [ { "deelToken": [] } ], "summary": "Terminate contract", "tags": [ "Terminations" ] } }, "/contracts/{contract_id}/timesheets": { "get": { "description": "Returns timesheets associated with the specified contract, with optional filtering by contract type, status, reporter, and date range.\n\n **Token scopes**: `timesheets:read`", "operationId": "timesheets_getContractTimesheets", "parameters": [ { "description": "Deel contract id.", "in": "path", "name": "contract_id", "required": true, "schema": { "type": "string" } }, { "description": "Filter results to timesheets associated with the specified contract types.", "in": "query", "name": "contract_types", "required": false, "schema": { "items": { "$ref": "#/components/schemas/ContractsContractIdTimesheetsGetParametersContractTypesSchemaItems" }, "type": "array" } }, { "description": "Filter results to timesheets with the specified statuses.", "in": "query", "name": "statuses", "required": false, "schema": { "items": { "$ref": "#/components/schemas/ContractsContractIdTimesheetsGetParametersStatusesSchemaItems" }, "type": "array" } }, { "description": "Filter results to timesheets submitted by this user ID.", "in": "query", "name": "reporter_id", "required": false, "schema": { "format": "uuid", "type": "string" } }, { "description": "Filter results to timesheets submitted on or after this date (inclusive). Short date in format ISO-8601 (YYYY-MM-DD). For example: 2022-12-31.", "in": "query", "name": "date_from", "required": false, "schema": { "format": "date", "type": "string" } }, { "description": "Filter results to timesheets submitted before this date (exclusive). Short date in format ISO-8601 (YYYY-MM-DD). For example: 2022-12-31.", "in": "query", "name": "date_to", "required": false, "schema": { "format": "date", "type": "string" } }, { "description": "Maximum number of records to return per page. NOTE: query parameters are passed as strings.", "in": "query", "name": "limit", "required": false, "schema": { "type": "string" } }, { "description": "Number of records to skip before starting to return results. NOTE: query parameters are passed as strings.", "in": "query", "name": "offset", "required": false, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/timesheets_getContractTimesheets_Response_200" } } }, "description": "Successful operation." }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetTimesheetsByContract-v2026-01-01RequestBadRequestError" } } }, "description": "Bad Request - Validation error or invalid parameters." }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContainer" } } }, "description": "Operation failed." }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetTimesheetsByContract-v2026-01-01RequestForbiddenError" } } }, "description": "Forbidden - The requester does not have access to the specified contract." }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetTimesheetsByContract-v2026-01-01RequestNotFoundError" } } }, "description": "Not Found - The specified contract does not exist." }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetTimesheetsByContract-v2026-01-01RequestInternalServerError" } } }, "description": "Internal Server Error - The contract timesheets could not be listed due to an unexpected upstream or internal failure." } }, "security": [ { "deelToken": [] } ], "summary": "List of timesheets by contract", "tags": [ "timesheets" ] } }, "/contracts/{contract_id}/timesheets/presets": { "get": { "description": "Returns saved hourly report presets for the specified contract, optionally scoped to a work statement. Results support cursor-based pagination and can be ordered by title or creation date.\n\n **Token scopes**: `timesheets:read`", "operationId": "projects_getContractTimesheetsPresets", "parameters": [ { "description": "ID of the Deel contract", "in": "path", "name": "contract_id", "required": true, "schema": { "format": "uuid", "type": "string" } }, { "description": "ID of the work statement (optional)", "in": "query", "name": "work_statement_id", "required": false, "schema": { "format": "uuid", "type": "string" } }, { "description": "Field to order results by (title or created_at)", "in": "query", "name": "order_by", "required": false, "schema": { "default": "title", "type": "string" } }, { "description": "Direction of ordering (ASC or DESC)", "in": "query", "name": "order_direction", "required": false, "schema": { "default": "ASC", "type": "string" } }, { "description": "Pagination cursor for fetching next set of results", "in": "query", "name": "cursor", "required": false, "schema": { "type": "string" } }, { "description": "Number of results to return per page", "in": "query", "name": "limit", "required": false, "schema": { "default": 100, "maximum": 100, "minimum": 1, "type": "integer" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Projects_getContractTimesheetsPresets_Response_200" } } }, "description": "Successful operation." }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetHourlyReportPresets-v2026-01-01RequestBadRequestError" } } }, "description": "Bad Request - The contract_id or work_statement_id parameter failed validation." }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContainer" } } }, "description": "Operation failed." }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetHourlyReportPresets-v2026-01-01RequestForbiddenError" } } }, "description": "Forbidden - The requester does not have read access to the associated contract." }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetHourlyReportPresets-v2026-01-01RequestNotFoundError" } } }, "description": "Not Found - No matching work statement could be found for this contract." }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetHourlyReportPresets-v2026-01-01RequestInternalServerError" } } }, "description": "Internal Server Error - The hourly report presets could not be listed due to an unexpected upstream or internal failure." } }, "security": [ { "deelToken": [] } ], "summary": "Get Hourly Report Presets", "tags": [ "projects" ] } }, "/daas/banks/{bank_id}": { "patch": { "description": "Applies a partial update to the bank account details for an EOR employee. The request body accepts an array of field-level updates.\n\n **Token scopes**: `worker:write`", "operationId": "deelAsAService_patchEORBankAccount-v2026-01-01", "parameters": [ { "description": "Unique identifier for a bank in UUID format.", "in": "path", "name": "bank_id", "required": true, "schema": { "format": "uuid", "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "properties": { "data": { "description": "Array of key value properties of bank account", "items": { "$ref": "#/components/schemas/DaasBanksBankIdPatchRequestBodyContentApplicationJsonSchemaDataItems" }, "type": "array" } }, "required": [ "data" ], "type": "object" } } }, "description": "Bank Account object that needs to be modified" }, "responses": { "201": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Deel_As_a_Service_patchEORBankAccount-v2026-01-01_Response_201" } } }, "description": "Successful operation." }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContainer" } } }, "description": "Operation failed." }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContainer" } } }, "description": "Operation failed." }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContainer" } } }, "description": "Operation failed." }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContainer" } } }, "description": "Operation failed." }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContainer" } } }, "description": "Operation failed." } }, "security": [ { "deelToken": [] } ], "summary": "Modify bank account for an EOR employee", "tags": [ "deelAsAService" ] } }, "/daas/payslips": { "get": { "description": "Returns all payslips for an EOR employee.\n\n **Token scopes**: `worker:read`", "operationId": "deelAsAService_getEorEmployeePayslips-v2026-01-01", "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Deel_As_a_Service_getEorEmployeePayslips-v2026-01-01_Response_200" } } }, "description": "Payslip records successfully retrieved." }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContainer" } } }, "description": "Operation failed." }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContainer" } } }, "description": "Operation failed." }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContainer" } } }, "description": "Operation failed." }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContainer" } } }, "description": "Operation failed." }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContainer" } } }, "description": "Operation failed." } }, "security": [ { "deelToken": [] } ], "summary": "Get list of payslips for an EOR employee", "tags": [ "deelAsAService" ] } }, "/departments": { "get": { "description": "Returns the list of departments within the authenticated user's organization, including each department's identifier, name, and parent department where applicable.\n\n **Token scopes**: `organizations:read`", "operationId": "organizations_GetDepartments-v2026-01-01", "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Organizations_GetDepartments-v2026-01-01_Response_200" } } }, "description": "Successful retrieval of the list of departments." }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContainer" } } }, "description": "Operation failed." }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetDepartments-v2026-01-01RequestUnauthorizedError" } } }, "description": "Unauthorized. The request is missing authentication credentials or the credentials provided are invalid." }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContainer" } } }, "description": "Operation failed." }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetDepartments-v2026-01-01RequestNotFoundError" } } }, "description": "No departments found. There are no departments associated with the current organization." }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetDepartments-v2026-01-01RequestInternalServerError" } } }, "description": "Internal server error. An error occurred on the server while processing the request." } }, "security": [ { "deelToken": [] } ], "summary": "Retrieve Departments", "tags": [ "organizations" ] } }, "/employee-info/contract-types/{type}/countries/{country}": { "get": { "description": "Retrieves the template describing which additional information fields must be collected for a worker on a given contract type in a given country. Use this endpoint when building or validating an onboarding form so the correct country- and contract-type-specific fields are requested before submitting employee information.\n\n **Token scopes**: `contracts:read`", "operationId": "employeeInformation_employeeAdditionalInfoTemplate-v2026-01-01", "parameters": [ { "description": "The contract type. Must be 'eor' (Employer of Record) or 'gp' (Global Payroll).", "in": "path", "name": "type", "required": true, "schema": { "$ref": "#/components/schemas/EmployeeInfoContractTypesTypeCountriesCountryGetParametersType" } }, { "description": "ISO 3166-1 alpha-2 country code.", "in": "path", "name": "country", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Employee_Information_employeeAdditionalInfoTemplate-v2026-01-01_Response_200" } } }, "description": "Successful operation." }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EmployeeAdditionalInfoTemplate-v2026-01-01RequestBadRequestError" } } }, "description": "Invalid country code or contract type." }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EmployeeAdditionalInfoTemplate-v2026-01-01RequestUnauthorizedError" } } }, "description": "Authentication failed. The access token is missing, expired, or invalid." }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EmployeeAdditionalInfoTemplate-v2026-01-01RequestForbiddenError" } } }, "description": "Access denied. The authenticated user does not have the required contracts:read scope or contracts.view permission." }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EmployeeAdditionalInfoTemplate-v2026-01-01RequestNotFoundError" } } }, "description": "No additional info template exists for the given country and contract type combination in the Employee Data Management system." }, "429": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EmployeeAdditionalInfoTemplate-v2026-01-01RequestTooManyRequestsError" } } }, "description": "Rate limit exceeded. The client has sent too many requests in a given time window." }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EmployeeAdditionalInfoTemplate-v2026-01-01RequestInternalServerError" } } }, "description": "Internal server error. Returned when the Employee Data Management service is unreachable or an unexpected error occurs." } }, "security": [ { "deelToken": [] } ], "summary": "Retrieve employee additional info template", "tags": [ "employeeInformation" ] } }, "/engage/learning/actionable-journeys": { "get": { "description": "Use this endpoint to retrieve the Courses (ActionableJourneys) assigned to the authenticated worker, for building learning dashboards or reminder flows. Results are cursor-paginated. ActionableJourneys correspond to what the user interface labels as Courses. Learn more about [Learning Management](https://www.deel.com/hr/engage/learning-management-software/)\n\n **Token scopes**: `worker:read`", "operationId": "learning_retrieveWorkersActionableJourneys-v2026-01-01", "parameters": [ { "description": "Filter by Journey IDs.", "in": "query", "name": "journey_ids", "required": false, "schema": { "items": { "format": "uuid", "type": "string" }, "type": "array" } }, { "description": "Filter by JourneyAssignment IDs.", "in": "query", "name": "journey_assignment_ids", "required": false, "schema": { "items": { "format": "uuid", "type": "string" }, "type": "array" } }, { "description": "Return a page of results with given number of records.", "in": "query", "name": "limit", "required": false, "schema": { "default": 50, "maximum": 100, "minimum": 1, "type": "integer" } }, { "description": "Cursor to the next page of results. If not provided, the first page will be returned.", "in": "query", "name": "cursor", "required": false, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Learning_retrieveWorkersActionableJourneys-v2026-01-01_Response_200" } } }, "description": "Successful retrieval of actionable journeys" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RetrieveWorkersActionableJourneys-v2026-01-01RequestBadRequestError" } } }, "description": "Operation failed." }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContainer" } } }, "description": "Operation failed." }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContainer" } } }, "description": "Operation failed." }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContainer" } } }, "description": "Operation failed." }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContainer" } } }, "description": "Operation failed." } }, "security": [ { "deelToken": [] } ], "summary": "Retrieve worker's actionable journeys", "tags": [ "learning" ] } }, "/eor": { "post": { "description": "Submits details for an Employee of Record (EOR) contract and returns a quote. Deel processes the submitted information and returns pricing, compensation, and health plan details before the contract is activated.\n\n **Token scopes**: `contracts:write`", "operationId": "eorContract_createEORContract", "requestBody": { "content": { "application/json": { "schema": { "properties": { "data": { "$ref": "#/components/schemas/EorPostRequestBodyContentApplicationJsonSchemaData" } }, "required": [ "data" ], "type": "object" } } }, "description": "The details of the Employee (EOR) contract to be created." }, "responses": { "201": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/eor-contract_createEORContract_Response_201" } } }, "description": "Successfully created the EOR contract quote." }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContainer" } } }, "description": "Operation failed." }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContainer" } } }, "description": "Operation failed." }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContainer" } } }, "description": "Operation failed." } }, "security": [ { "deelToken": [] } ], "summary": "Create an EOR contract", "tags": [ "eorContract" ] } }, "/eor/additional-costs/{country}": { "get": { "description": "Returns the allowances and non-statutory additional costs available for inclusion in an EOR contract quote for the specified country.\n\n **Token scopes**: `contracts:read`", "operationId": "eorHiring_getAdditionalCosts", "parameters": [ { "description": "The two-letter ISO code of the country for which to retrieve the EOR additional costs.", "in": "path", "name": "country", "required": true, "schema": { "maxLength": 2, "minLength": 2, "pattern": "^[A-Z]{2}$", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/eor-hiring_getAdditionalCosts_Response_200" } } }, "description": "Successful operation." }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetEorAdditionalCosts-v2026-01-01RequestBadRequestError" } } }, "description": "Operation failed." }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContainer" } } }, "description": "Operation failed." }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContainer" } } }, "description": "Operation failed." }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContainer" } } }, "description": "Operation failed." }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContainer" } } }, "description": "Operation failed." } }, "security": [ { "deelToken": [] } ], "summary": "Get EOR Additional Costs", "tags": [ "eorHiring" ] } }, "/eor/benefits": { "get": { "description": "Returns benefits available in a specific country, scoped by work visa requirement, weekly work hours, employment type, team, and legal entity.\n\n **Token scopes**: `benefits:read`", "operationId": "eorHiring_getBenefits", "parameters": [ { "description": "Country code.", "in": "query", "name": "country_code", "required": true, "schema": { "maxLength": 2, "minLength": 2, "pattern": "^[A-Z]{2}$", "type": "string" } }, { "description": "Indicates if work visa is required.", "in": "query", "name": "work_visa", "required": true, "schema": { "type": "boolean" } }, { "description": "Working hours per week", "in": "query", "name": "work_hours_per_week", "required": true, "schema": { "format": "double", "maximum": 168, "minimum": 0, "type": "number" } }, { "description": "Type of employment", "in": "query", "name": "employment_type", "required": true, "schema": { "$ref": "#/components/schemas/EorBenefitsGetParametersEmploymentType" } }, { "description": "The ID of the team the worker belongs to.", "in": "query", "name": "team_id", "required": true, "schema": { "format": "uuid", "type": "string" } }, { "description": "The ID of the legal entity.", "in": "query", "name": "legal_entity_id", "required": true, "schema": { "format": "uuid", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/eor-hiring_getBenefits_Response_200" } } }, "description": "Successful operation." }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RetrieveBenefitsByCountry-v2026-01-01RequestBadRequestError" } } }, "description": "Operation failed." }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContainer" } } }, "description": "Operation failed." }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContainer" } } }, "description": "Operation failed." }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContainer" } } }, "description": "Operation failed." }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContainer" } } }, "description": "Operation failed." } }, "security": [ { "deelToken": [] } ], "summary": "Retrieve Benefits by Country", "tags": [ "eorHiring" ] } }, "/eor/contract/{contract_id}": { "patch": { "description": "Applies partial updates to mutable fields of an EOR contract, such as salary, job title, or benefits. Only fields included in the request body are modified; fields required for validation must still be present.\n\n **Token scopes**: `contracts:write`", "operationId": "eorContract_updateEORContract", "parameters": [ { "description": "The unique identifier of the employee contract.", "in": "path", "name": "contract_id", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "properties": { "data": { "$ref": "#/components/schemas/EorContractContractIdPatchRequestBodyContentApplicationJsonSchemaData" } }, "required": [ "data" ], "type": "object" } } }, "description": "Contract update request object" }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/eor-contract_updateEORContract_Response_200" } } }, "description": "Contract updated successfully" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UpdateEorContract-v2026-01-01RequestBadRequestError" } } }, "description": "Bad Request" }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContainer" } } }, "description": "Operation failed." }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UpdateEorContract-v2026-01-01RequestForbiddenError" } } }, "description": "Forbidden" }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UpdateEorContract-v2026-01-01RequestNotFoundError" } } }, "description": "Not Found" }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UpdateEorContract-v2026-01-01RequestInternalServerError" } } }, "description": "Internal Server Error" } }, "security": [ { "deelToken": [] } ], "summary": "Update EOR Contract", "tags": [ "eorContract" ] } }, "/eor/contract/{oid}/cancel": { "post": { "description": "Cancels the EOR contract identified by oid. The contract must be in an active or pending state to be eligible for cancellation.\n\n **Token scopes**: `contracts:write`", "operationId": "eorHiring_cancelContract", "parameters": [ { "description": "Contract oid", "in": "path", "name": "oid", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "properties": { "data": { "$ref": "#/components/schemas/EorContractOidCancelPostRequestBodyContentApplicationJsonSchemaData" } }, "required": [ "data" ], "type": "object" } } }, "description": "Cancel EOR Contract" }, "responses": { "204": { "content": { "application/json": { "schema": { "properties": {}, "type": "object" } } }, "description": "Contract cancelled successfully" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CancelEorContract-v2026-01-01RequestBadRequestError" } } }, "description": "Bad Request" }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContainer" } } }, "description": "Operation failed." }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContainer" } } }, "description": "Operation failed." }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CancelEorContract-v2026-01-01RequestNotFoundError" } } }, "description": "Contract not found" }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContainer" } } }, "description": "Operation failed." } }, "security": [ { "deelToken": [] } ], "summary": "Cancel EOR Contract", "tags": [ "eorHiring" ] } }, "/eor/contract/{oid}/delay-onboarding": { "patch": { "description": "Defers the scheduled onboarding start date for the EOR employee on the specified contract.\n\n **Token scopes**: `contracts:write`", "operationId": "eorHiring_delayOnboarding", "parameters": [ { "description": "Contract oid", "in": "path", "name": "oid", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "properties": { "data": { "$ref": "#/components/schemas/EorContractOidDelayOnboardingPatchRequestBodyContentApplicationJsonSchemaData" } }, "required": [ "data" ], "type": "object" } } }, "description": "Indicates if the employee onboarding is delayed" }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/eor-hiring_delayOnboarding_Response_200" } } }, "description": "Employee onboarding delay status updated successfully" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DelayEorEmployeeOnboarding-v2026-01-01RequestBadRequestError" } } }, "description": "Bad Request - Contract not found or invalid status" }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContainer" } } }, "description": "Operation failed." }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContainer" } } }, "description": "Operation failed." }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContainer" } } }, "description": "Operation failed." }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContainer" } } }, "description": "Operation failed." } }, "security": [ { "deelToken": [] } ], "summary": "Delay EOR employee onboarding", "tags": [ "eorHiring" ] } }, "/eor/contracts/amendments/data-points/configuration": { "get": { "description": "Returns amendment data points configuration per country. If no countries filter is provided, returns configuration for all available countries. If no configuration exists for a country, all data points are treated as enabled.\n\n **Token scopes**: `contracts:read`", "operationId": "eor_getAmendmentDataPointsConfigurationByCountry-v2026-05-06", "parameters": [ { "description": "Optional list of ISO 3166-1 alpha-2 country codes to filter results. Returns all countries if omitted.", "in": "query", "name": "countries", "required": false, "schema": { "items": { "maxLength": 2, "minLength": 2, "type": "string" }, "type": "array" } }, { "description": "When true, returns only enabled data points. A data point is enabled if at least one of its items is not DISABLED_AMENDMENTS.", "in": "query", "name": "enabled", "required": false, "schema": { "type": "boolean" } }, { "description": "Maximum number of results to return per page.", "in": "query", "name": "limit", "required": false, "schema": { "default": 20, "maximum": 100, "minimum": 1, "type": "integer" } }, { "description": "Cursor from a previous response to fetch the next page of results.", "in": "query", "name": "cursor", "required": false, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EOR_getAmendmentDataPointsConfigurationByCountry-v2026-05-06_Response_200" } } }, "description": "Data points configuration per country" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetAmendmentDataPointsConfigurationByCountry-v2026-05-06RequestBadRequestError" } } }, "description": "Bad Request. The request could not be understood or was missing required parameters." }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContainer" } } }, "description": "Operation failed." }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetAmendmentDataPointsConfigurationByCountry-v2026-05-06RequestForbiddenError" } } }, "description": "Forbidden. The caller does not have permission to perform this action." }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContainer" } } }, "description": "Operation failed." }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetAmendmentDataPointsConfigurationByCountry-v2026-05-06RequestInternalServerError" } } }, "description": "Internal server error." } }, "security": [ { "deelToken": [] } ], "summary": "Get amendment data points configuration by country", "tags": [ "eor" ] } }, "/eor/contracts/{contract_id}/amendments": { "get": { "description": "Retrieves all amendments associated with a given EOR contract, including each amendment's type, effective date, and current status, providing a full history of changes applied to the contract.\n\n **Token scopes**: `contracts:read`", "operationId": "eorAmendments_getContractAmendments", "parameters": [ { "description": "The unique identifier of EOR worker contract.", "in": "path", "name": "contract_id", "required": true, "schema": { "format": "alphanumeric", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/eor-amendments_getContractAmendments_Response_200" } } }, "description": "Amendment info. Returns the amendment flow details." }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ListAllAmendmentsForAnEorContract-v2026-01-01RequestBadRequestError" } } }, "description": "Bad Request. The request could not be understood or was missing required parameters." }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContainer" } } }, "description": "Operation failed." }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContainer" } } }, "description": "Operation failed." }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ListAllAmendmentsForAnEorContract-v2026-01-01RequestNotFoundError" } } }, "description": "Resource not found (e.g., contract, profile, amendment, change request)." }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ListAllAmendmentsForAnEorContract-v2026-01-01RequestInternalServerError" } } }, "description": "Internal server error." } }, "security": [ { "deelToken": [] } ], "summary": "Get amendments by contract", "tags": [ "eorAmendments" ] }, "post": { "description": "Creates a new amendment for an existing EOR contract, supporting changes to terms such as salary, currency, effective date, and other contract conditions. All requests are validated against applicable business and regulatory rules before the amendment is accepted.\n\n **Token scopes**: `contracts:write`", "operationId": "eorAmendments_createContractAmendment", "parameters": [ { "description": "The unique identifier of the EOR worker contract", "in": "path", "name": "contract_id", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "properties": { "data": { "$ref": "#/components/schemas/EorContractsContractIdAmendmentsPostRequestBodyContentApplicationJsonSchemaData" } }, "type": "object" } } } }, "responses": { "201": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/eor-amendments_createContractAmendment_Response_201" } } }, "description": "Amendment info" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreateAnEorContractAmendment-v2026-01-01RequestBadRequestError" } } }, "description": "Bad Request. The request could not be understood or was missing required parameters." }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContainer" } } }, "description": "Operation failed." }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreateAnEorContractAmendment-v2026-01-01RequestForbiddenError" } } }, "description": "Forbidden. The caller does not have permission to perform this action." }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreateAnEorContractAmendment-v2026-01-01RequestNotFoundError" } } }, "description": "Resource not found (e.g., contract, profile, amendment, change request)." }, "409": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreateAnEorContractAmendment-v2026-01-01RequestConflictError" } } }, "description": "Conflict error. Indicates that the requested operation conflicts with the current state of the resource." }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreateAnEorContractAmendment-v2026-01-01RequestUnprocessableEntityError" } } }, "description": "Validation errors or disabled amendments." }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreateAnEorContractAmendment-v2026-01-01RequestInternalServerError" } } }, "description": "Internal server error." } }, "security": [ { "deelToken": [] } ], "summary": "Create amendment", "tags": [ "eorAmendments" ] } }, "/eor/contracts/{contract_id}/amendments/validate": { "post": { "description": "Validates amendment data points for a given contract against any external validation rules before an amendment is submitted. This call should be made prior to creating an amendment to confirm that the proposed data points are acceptable.\n\n **Token scopes**: `contracts:write`", "operationId": "eorAmendments_validateEORAmendments", "parameters": [ { "description": "The unique identifier of the employee contract.", "in": "path", "name": "contract_id", "required": true, "schema": { "format": "alphanumeric", "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "properties": { "data": { "additionalProperties": { "description": "Any type" }, "description": "Dynamic object containing amendment fields. Supports flexible keys such as scope, job_title, or others.", "type": "object" } }, "type": "object" } } } }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/eor-amendments_validateEORAmendments_Response_200" } } }, "description": "Validation result" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ValidateAmendmentDataPoints-v2026-01-01RequestBadRequestError" } } }, "description": "Bad Request. The request could not be understood or was missing required parameters." }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContainer" } } }, "description": "Operation failed." }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContainer" } } }, "description": "Operation failed." }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ValidateAmendmentDataPoints-v2026-01-01RequestNotFoundError" } } }, "description": "Resource not found (e.g., contract, profile, amendment, change request)." }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ValidateAmendmentDataPoints-v2026-01-01RequestInternalServerError" } } }, "description": "Internal server error." } }, "security": [ { "deelToken": [] } ], "summary": "Validate amendment data points", "tags": [ "eorAmendments" ] } }, "/eor/contracts/{contract_id}/amendments/validation/settings": { "get": { "description": "Returns the validation settings for all available amendment data points on an EOR contract, optionally scoped to a specific employment state. Use these settings to determine which fields are editable and what constraints apply before constructing an amendment request.\n\n **Token scopes**: `contracts:read`", "operationId": "eorAmendments_getContractAmendmentsValidationSettings", "parameters": [ { "description": "The unique identifier of EOR worker contract.", "in": "path", "name": "contract_id", "required": true, "schema": { "format": "alphanumeric", "type": "string" } }, { "description": "The employment state of the EOR worker contract", "in": "query", "name": "employment_state", "required": false, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/eor-amendments_getContractAmendmentsValidationSettings_Response_200" } } }, "description": "Amendment settings response with additional_details included as optional." }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetAmendmentValidationSettingsForAnEorContract-v2026-01-01RequestBadRequestError" } } }, "description": "Bad Request. The request could not be understood or was missing required parameters." }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContainer" } } }, "description": "Operation failed." }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContainer" } } }, "description": "Operation failed." }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetAmendmentValidationSettingsForAnEorContract-v2026-01-01RequestNotFoundError" } } }, "description": "Resource not found (e.g., contract, profile, amendment, change request)." }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetAmendmentValidationSettingsForAnEorContract-v2026-01-01RequestInternalServerError" } } }, "description": "Internal server error." } }, "security": [ { "deelToken": [] } ], "summary": "Get amendment validation settings", "tags": [ "eorAmendments" ] } }, "/eor/contracts/{contract_id}/amendments/{amendment_id}": { "delete": { "description": "Cancels a pending EOR contract amendment, voiding the request and preventing it from being reviewed or applied to the contract.\n\n **Token scopes**: `contracts:write`", "operationId": "eorAmendments_deleteContractAmendment", "parameters": [ { "description": "The unique identifier of EOR worker contract.", "in": "path", "name": "contract_id", "required": true, "schema": { "format": "alphanumeric", "type": "string" } }, { "description": "A unique identifier for the employee contract amendment.", "in": "path", "name": "amendment_id", "required": true, "schema": { "format": "uuid", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/eor-amendments_deleteContractAmendment_Response_200" } } }, "description": "Successful response" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CancelAmendment-v2026-01-01RequestBadRequestError" } } }, "description": "Bad Request. The request could not be understood or was missing required parameters." }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContainer" } } }, "description": "Operation failed." }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContainer" } } }, "description": "Operation failed." }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CancelAmendment-v2026-01-01RequestNotFoundError" } } }, "description": "Resource not found (e.g., contract, profile, amendment, change request)." }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CancelAmendment-v2026-01-01RequestInternalServerError" } } }, "description": "Internal server error." } }, "security": [ { "deelToken": [] } ], "summary": "Cancel amendment", "tags": [ "eorAmendments" ] }, "get": { "description": "Retrieves the full details of a single amendment on an EOR contract by its ID, including its current status, requested changes, effective date, and rejection context. Use it to inspect an amendment after creating, updating, or acting on it.\n\n **Token scopes**: `contracts:read`", "operationId": "eorAmendments_getContractAmendmentById", "parameters": [ { "description": "The unique identifier of EOR worker contract.", "in": "path", "name": "contract_id", "required": true, "schema": { "format": "alphanumeric", "type": "string" } }, { "description": "A unique identifier for the employee contract amendment.", "in": "path", "name": "amendment_id", "required": true, "schema": { "format": "uuid", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/eor-amendments_getContractAmendmentById_Response_200" } } }, "description": "Amendment info" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ViewInformationAboutAmendment-v2026-01-01RequestBadRequestError" } } }, "description": "Bad Request. The request could not be understood or was missing required parameters." }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContainer" } } }, "description": "Operation failed." }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContainer" } } }, "description": "Operation failed." }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ViewInformationAboutAmendment-v2026-01-01RequestNotFoundError" } } }, "description": "Resource not found (e.g., contract, profile, amendment, change request)." }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ViewInformationAboutAmendment-v2026-01-01RequestInternalServerError" } } }, "description": "Internal server error." } }, "security": [ { "deelToken": [] } ], "summary": "Get amendment by ID", "tags": [ "eorAmendments" ] }, "patch": { "description": "Applies a partial update to a specific EOR contract amendment. The amendment must be in DRAFT status; updates to amendments in any other state will be rejected. This operation overwrites existing draft data and cannot be undone.\n\n **Token scopes**: `contracts:write`", "operationId": "eorAmendments_updateContractAmendment", "parameters": [ { "description": "The unique identifier of EOR worker contract.", "in": "path", "name": "contract_id", "required": true, "schema": { "format": "alphanumeric", "type": "string" } }, { "description": "A unique identifier for the employee contract amendment. This string is either supplied by the client or generated by the system and is used to uniquely identify the amendment during upsert operations.", "in": "path", "name": "amendment_id", "required": true, "schema": { "format": "uuid", "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "properties": { "data": { "$ref": "#/components/schemas/EorContractsContractIdAmendmentsAmendmentIdPatchRequestBodyContentApplicationJsonSchemaData" } }, "type": "object" } } } }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/eor-amendments_updateContractAmendment_Response_200" } } }, "description": "Amendment info" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UpdateASpecificEorContractAmendment-v2026-01-01RequestBadRequestError" } } }, "description": "Bad Request. The request could not be understood or was missing required parameters." }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContainer" } } }, "description": "Operation failed." }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContainer" } } }, "description": "Operation failed." }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UpdateASpecificEorContractAmendment-v2026-01-01RequestNotFoundError" } } }, "description": "Resource not found (e.g., contract, profile, amendment, change request)." }, "409": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UpdateASpecificEorContractAmendment-v2026-01-01RequestConflictError" } } }, "description": "Conflict error. Indicates that the requested operation conflicts with the current state of the resource." }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UpdateASpecificEorContractAmendment-v2026-01-01RequestUnprocessableEntityError" } } }, "description": "Validation errors or disabled amendments." }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UpdateASpecificEorContractAmendment-v2026-01-01RequestInternalServerError" } } }, "description": "Internal server error." } }, "security": [ { "deelToken": [] } ], "summary": "Update amendment", "tags": [ "eorAmendments" ] } }, "/eor/contracts/{contract_id}/amendments/{amendment_id}/accept": { "post": { "description": "Accepts a pending amendment on an EOR worker contract, formally approving the proposed modifications on the client's behalf. The amendment must already exist and be in a pending state before this operation can be called.\n\n **Token scopes**: `contracts:write`", "operationId": "eorAmendments_acceptContractAmendment", "parameters": [ { "description": "The unique identifier of EOR worker contract.", "in": "path", "name": "contract_id", "required": true, "schema": { "format": "alphanumeric", "type": "string" } }, { "description": "A unique identifier for the employee contract amendment.", "in": "path", "name": "amendment_id", "required": true, "schema": { "format": "uuid", "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "properties": {}, "type": "object" } } }, "description": "This operation does not require a request body. Provide an empty JSON object if required by the client." }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/eor-amendments_acceptContractAmendment_Response_200" } } }, "description": "Amendment info" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AcceptAContractAmendmentOnBehalfOfTheClient-v2026-01-01RequestBadRequestError" } } }, "description": "Bad Request. The request could not be understood or was missing required parameters." }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContainer" } } }, "description": "Operation failed." }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContainer" } } }, "description": "Operation failed." }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AcceptAContractAmendmentOnBehalfOfTheClient-v2026-01-01RequestNotFoundError" } } }, "description": "Resource not found (e.g., contract, profile, amendment, change request)." }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AcceptAContractAmendmentOnBehalfOfTheClient-v2026-01-01RequestInternalServerError" } } }, "description": "Internal server error." } }, "security": [ { "deelToken": [] } ], "summary": "Accept amendment", "tags": [ "eorAmendments" ] } }, "/eor/contracts/{contract_id}/amendments/{amendment_id}/confirm": { "post": { "description": "Confirms a draft amendment on an EOR contract and initiates the review process, routing it to Deel and the employee for acknowledgment and approval. The amendment must exist in a confirmable state prior to calling this endpoint.\n\n **Token scopes**: `contracts:write`", "operationId": "eorAmendments_confirmContractAmendment", "parameters": [ { "description": "The unique identifier of EOR worker contract.", "in": "path", "name": "contract_id", "required": true, "schema": { "format": "alphanumeric", "type": "string" } }, { "description": "A unique identifier for the employee contract amendment.", "in": "path", "name": "amendment_id", "required": true, "schema": { "format": "uuid", "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "properties": {}, "type": "object" } } }, "description": "This operation does not require a request body. Provide an empty JSON object if required by the client." }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/eor-amendments_confirmContractAmendment_Response_200" } } }, "description": "Amendment info" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConfirmAnExistingContractAmendment-v2026-01-01RequestBadRequestError" } } }, "description": "Bad Request. The request could not be understood or was missing required parameters." }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContainer" } } }, "description": "Operation failed." }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContainer" } } }, "description": "Operation failed." }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConfirmAnExistingContractAmendment-v2026-01-01RequestNotFoundError" } } }, "description": "Resource not found (e.g., contract, profile, amendment, change request)." }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConfirmAnExistingContractAmendment-v2026-01-01RequestInternalServerError" } } }, "description": "Internal server error." } }, "security": [ { "deelToken": [] } ], "summary": "Confirm amendment", "tags": [ "eorAmendments" ] } }, "/eor/contracts/{contract_id}/amendments/{amendment_id}/effective-date-limitations": { "get": { "description": "Returns validation rules for the effective date field within an EOR contract amendment flow.\n\n **Token scopes**: `contracts:read`", "operationId": "eorAmendments_getContractAmendmentEffectiveDateLimitations", "parameters": [ { "description": "The unique identifier of the EOR worker contract", "in": "path", "name": "contract_id", "required": true, "schema": { "type": "string" } }, { "description": "A unique identifier for the employee contract amendment", "in": "path", "name": "amendment_id", "required": true, "schema": { "format": "uuid", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/eor-amendments_getContractAmendmentEffectiveDateLimitations_Response_200" } } }, "description": "Returns the effective date limits for the amendment." }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RetrieveEffectiveDateLimitations-v2026-01-01RequestBadRequestError" } } }, "description": "Bad Request. The request could not be understood or was missing required parameters." }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContainer" } } }, "description": "Operation failed." }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RetrieveEffectiveDateLimitations-v2026-01-01RequestForbiddenError" } } }, "description": "Forbidden. The caller does not have permission to perform this action." }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RetrieveEffectiveDateLimitations-v2026-01-01RequestNotFoundError" } } }, "description": "Resource not found (e.g., contract, profile, amendment, change request)." }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RetrieveEffectiveDateLimitations-v2026-01-01RequestInternalServerError" } } }, "description": "Internal server error." } }, "security": [ { "deelToken": [] } ], "summary": "Retrieve Effective Date Limitations", "tags": [ "eorAmendments" ] } }, "/eor/contracts/{contract_id}/amendments/{amendment_id}/pdf": { "get": { "description": "Generates a secure, time-limited download URL for the PDF of a specific EOR contract amendment. The returned URL is valid for 15 minutes from the time of generation.\n\n **Token scopes**: `contracts:read`", "operationId": "eorAmendments_getContractAmendmentPdf", "parameters": [ { "description": "The unique identifier of EOR worker contract.", "in": "path", "name": "contract_id", "required": true, "schema": { "format": "alphanumeric", "type": "string" } }, { "description": "A unique identifier for the employee contract amendment.", "in": "path", "name": "amendment_id", "required": true, "schema": { "format": "uuid", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/eor-amendments_getContractAmendmentPdf_Response_200" } } }, "description": "URL of exported PDF(valid for 15m)" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetEorContractAmendmentPdfDownloadLinkForClientAndEmployee-v2026-01-01RequestBadRequestError" } } }, "description": "Bad Request. The request could not be understood or was missing required parameters." }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContainer" } } }, "description": "Operation failed." }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContainer" } } }, "description": "Operation failed." }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetEorContractAmendmentPdfDownloadLinkForClientAndEmployee-v2026-01-01RequestNotFoundError" } } }, "description": "Resource not found (e.g., contract, profile, amendment, change request)." }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetEorContractAmendmentPdfDownloadLinkForClientAndEmployee-v2026-01-01RequestInternalServerError" } } }, "description": "Internal server error." } }, "security": [ { "deelToken": [] } ], "summary": "Contract amendment PDF", "tags": [ "eorAmendments" ] } }, "/eor/contracts/{contract_id}/amendments/{amendment_id}/sign": { "post": { "description": "Records the employee's signature on a specific contract amendment, confirming acceptance of the amendment terms. Returns the updated amendment record upon successful signing.\n\n **Token scopes**: `worker:write`", "operationId": "eorAmendments_signEORAmendment", "parameters": [ { "description": "The unique identifier of EOR worker contract.", "in": "path", "name": "contract_id", "required": true, "schema": { "format": "alphanumeric", "type": "string" } }, { "description": "A unique identifier for the employee contract amendment.", "in": "path", "name": "amendment_id", "required": true, "schema": { "format": "uuid", "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "properties": {}, "type": "object" } } }, "description": "This operation does not require a request body. Provide an empty JSON object if required by the client." }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/eor-amendments_signEORAmendment_Response_200" } } }, "description": "Amendment info" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SignAContractAmendmentEmployee-v2026-01-01RequestBadRequestError" } } }, "description": "Bad Request. The request could not be understood or was missing required parameters." }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContainer" } } }, "description": "Operation failed." }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContainer" } } }, "description": "Operation failed." }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SignAContractAmendmentEmployee-v2026-01-01RequestNotFoundError" } } }, "description": "Resource not found (e.g., contract, profile, amendment, change request)." }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SignAContractAmendmentEmployee-v2026-01-01RequestInternalServerError" } } }, "description": "Internal server error." } }, "security": [ { "deelToken": [] } ], "summary": "Sign a contract amendment (employee)", "tags": [ "eorAmendments" ] } }, "/eor/contracts/{contract_id}/details": { "get": { "description": "Returns the full detail view for an Employer of Record (EOR) contract, including sensitive compensation and employment-cost information; access requires permission to view sensitive contract data.\n\n **Token scopes**: `contracts:read`", "operationId": "eorContract_getEORContractDetails", "parameters": [ { "description": "The unique identifier for the Deel contract", "in": "path", "name": "contract_id", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/eor-contract_getEORContractDetails_Response_200" } } }, "description": "Successful response" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContainer" } } }, "description": "Operation failed." }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContainer" } } }, "description": "Operation failed." }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RetrieveEorContractDetails-v2026-01-01RequestForbiddenError" } } }, "description": "Access denied" }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RetrieveEorContractDetails-v2026-01-01RequestNotFoundError" } } }, "description": "Not Found" }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RetrieveEorContractDetails-v2026-01-01RequestInternalServerError" } } }, "description": "Internal Server Error" } }, "security": [ { "deelToken": [] } ], "summary": "Retrieve EOR Contract Details", "tags": [ "eorContract" ] } }, "/eor/contracts/{contract_id}/documents": { "get": { "description": "Returns all documents associated with a specific EOR contract.\n\n **Token scopes**: `contracts:read`", "operationId": "eorContractDocuments_getEORContractDocuments", "parameters": [ { "description": "EOR contract ID", "in": "path", "name": "contract_id", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/eor-contract-documents_getEORContractDocuments_Response_200" } } }, "description": "The documents for the given EOR contract" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FetchEorContractDocuments-v2026-01-01RequestBadRequestError" } } }, "description": "Operation failed." }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContainer" } } }, "description": "Operation failed." }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContainer" } } }, "description": "Operation failed." }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContainer" } } }, "description": "Operation failed." }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContainer" } } }, "description": "Operation failed." } }, "security": [ { "deelToken": [] } ], "summary": "Fetch EOR contract documents", "tags": [ "eorContractDocuments" ] } }, "/eor/contracts/{contract_id}/documents/{type}": { "get": { "description": "Returns a specific document as a PDF for a given EOR contract. Currently only the `FRAMEWORK_AGREEMENT` document type is supported.\n\n **Token scopes**: `contracts:read`", "operationId": "eorContractDocuments_getEORContractDocumentByType", "parameters": [ { "description": "EOR contract ID", "in": "path", "name": "contract_id", "required": true, "schema": { "type": "string" } }, { "description": "The type of document. Currently only FRAMEWORK_AGREEMENT is supported.", "in": "path", "name": "type", "required": true, "schema": { "$ref": "#/components/schemas/EorContractsContractIdDocumentsTypeGetParametersType" } } ], "responses": { "200": { "content": { "application/octet-stream": { "schema": { "format": "binary", "type": "string" } } }, "description": "The document as a PDF" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FetchEorContractDocument-v2026-01-01RequestBadRequestError" } } }, "description": "Operation failed." }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContainer" } } }, "description": "Operation failed." }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContainer" } } }, "description": "Operation failed." }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContainer" } } }, "description": "Operation failed." }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContainer" } } }, "description": "Operation failed." } }, "security": [ { "deelToken": [] } ], "summary": "Fetch EOR contract document", "tags": [ "eorContractDocuments" ] } }, "/eor/contracts/{contract_id}/documents/{type}/sign": { "post": { "description": "Applies a signature and job title to a specified EOR contract document. Currently only the `FRAMEWORK_AGREEMENT` document type is supported.\n\n **Token scopes**: `contracts:write`", "operationId": "eorHiring_signContractDocument", "parameters": [ { "description": "EOR contract ID", "in": "path", "name": "contract_id", "required": true, "schema": { "type": "string" } }, { "description": "The type of document. Currently only FRAMEWORK_AGREEMENT is supported.", "in": "path", "name": "type", "required": true, "schema": { "$ref": "#/components/schemas/EorContractsContractIdDocumentsTypeSignPostParametersType" } } ], "requestBody": { "content": { "application/json": { "schema": { "properties": { "data": { "$ref": "#/components/schemas/EorContractsContractIdDocumentsTypeSignPostRequestBodyContentApplicationJsonSchemaData" } }, "type": "object" } } } }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/eor-hiring_signContractDocument_Response_200" } } }, "description": "The document has been signed" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SignEorContractDocument-v2026-01-01RequestBadRequestError" } } }, "description": "Operation failed." }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContainer" } } }, "description": "Operation failed." }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContainer" } } }, "description": "Operation failed." }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContainer" } } }, "description": "Operation failed." }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContainer" } } }, "description": "Operation failed." } }, "security": [ { "deelToken": [] } ], "summary": "Sign EOR contract document", "tags": [ "eorHiring" ] } }, "/eor/contracts/{contract_id}/employee-agreement-draft-preview": { "get": { "description": "Initiates or polls for async generation of an employee agreement template PDF draft. On first call (no task_id), kicks off generation and returns a task_id with is_processing: true. Poll with ?task_id= until is_processing is false, at which point url contains a signed download link valid for 15 minutes.\n\n **Token scopes**: `contracts:read`", "operationId": "eor_getEmployeeAgreementDraftPreview-v2026-01-01", "parameters": [ { "description": "The unique identifier of the EOR contract.", "in": "path", "name": "contract_id", "required": true, "schema": { "pattern": "^(([a-z0-9]{6,})|([a-z0-9-_]{20,})|(-2[0-9]{2}))$", "type": "string" } }, { "description": "Task ID from a previous response. Omit on first call. Provide on subsequent calls to poll for completion.", "in": "query", "name": "task_id", "required": false, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EOR_getEmployeeAgreementDraftPreview-v2026-01-01_Response_200" } } }, "description": "Draft preview initiated or ready." }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetEmployeeAgreementDraftPreview-v2026-01-01RequestBadRequestError" } } }, "description": "Generation failed." }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContainer" } } }, "description": "Operation failed." }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContainer" } } }, "description": "Operation failed." }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetEmployeeAgreementDraftPreview-v2026-01-01RequestNotFoundError" } } }, "description": "Contract or template not found." }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContainer" } } }, "description": "Operation failed." } }, "security": [ { "deelToken": [] } ], "summary": "Get employee agreement draft preview", "tags": [ "eor" ] } }, "/eor/contracts/{contract_id}/employee-information": { "patch": { "description": "Applies partial updates to employee information on an EOR contract. Only accepts documented fields — any undocumented fields will cause a validation error. Updates are permitted only when the contract has a status of `new`, `under_review`, `waiting_for_client_sign`, `waiting_for_eor_sign`, `waiting_for_employee_contract`, `waiting_for_employee_sign`, `awaiting_deposit_payment`, or `rejected`.\n\n **Token scopes**: `contracts:write`", "operationId": "eorHiring_updateContractEmployeeInformation", "parameters": [ { "description": "The unique identifier of the employee contract.", "in": "path", "name": "contract_id", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "properties": { "data": { "$ref": "#/components/schemas/EorContractsContractIdEmployeeInformationPatchRequestBodyContentApplicationJsonSchemaData" } }, "type": "object" } } } }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/eor-hiring_updateContractEmployeeInformation_Response_200" } } }, "description": "Employee information updated successfully" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UpdateEmployeeInformationForEorContract-v2026-01-01RequestBadRequestError" } } }, "description": "Operation failed." }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContainer" } } }, "description": "Operation failed." }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContainer" } } }, "description": "Operation failed." }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UpdateEmployeeInformationForEorContract-v2026-01-01RequestNotFoundError" } } }, "description": "Contract not found." }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UpdateEmployeeInformationForEorContract-v2026-01-01RequestInternalServerError" } } }, "description": "Operation failed." } }, "security": [ { "deelToken": [] } ], "summary": "Update Employee Information for EOR Contract", "tags": [ "eorHiring" ] } }, "/eor/contracts/{contract_id}/hrx-documents": { "get": { "description": "Returns a paginated list of HRX documents shared with an employee under a specific EOR contract.\n\n **Token scopes**: `worker:read`, `contracts:read`", "operationId": "hrxDocuments_retrieveHrxDocuments-v2026-01-01", "parameters": [ { "description": "The unique identifier of the employee contract.", "in": "path", "name": "contract_id", "required": true, "schema": { "type": "string" } }, { "description": "Cursor for pagination. Use the cursor from the previous response to get the next page of results.", "in": "query", "name": "cursor", "required": false, "schema": { "type": "string" } }, { "description": "Number of items to return per page. Maximum is 100, default is 20.", "in": "query", "name": "limit", "required": false, "schema": { "default": 20, "maximum": 100, "minimum": 1, "type": "integer" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HRX_Documents_retrieveHrxDocuments-v2026-01-01_Response_200" } } }, "description": "HRX documents successfully retrieved for EOR contract" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RetrieveHrxDocuments-v2026-01-01RequestBadRequestError" } } }, "description": "Bad Request" }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RetrieveHrxDocuments-v2026-01-01RequestUnauthorizedError" } } }, "description": "Unauthorized" }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContainer" } } }, "description": "Operation failed." }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContainer" } } }, "description": "Operation failed." }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RetrieveHrxDocuments-v2026-01-01RequestInternalServerError" } } }, "description": "Unauthorized" } }, "security": [ { "deelToken": [] } ], "summary": "Retrieve HRX documents", "tags": [ "hrxDocuments" ] } }, "/eor/contracts/{contract_id}/hrx-documents/{document_id}": { "get": { "description": "Generates a pre-signed URL for downloading a specific HRX document as a PDF associated with an EOR contract. The URL expires 15 minutes after generation.\n\n **Token scopes**: `contracts:read`, `worker:read`", "operationId": "hrxDocuments_downloadHrxDocuments-v2026-01-01", "parameters": [ { "description": "The unique identifier of the employee contract.", "in": "path", "name": "contract_id", "required": true, "schema": { "type": "string" } }, { "description": "The unique identifier of the document to download.", "in": "path", "name": "document_id", "required": true, "schema": { "format": "uuid", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HRX_Documents_downloadHrxDocuments-v2026-01-01_Response_200" } } }, "description": "Successfully generated pre-signed URL for HRX document download" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DownloadHrxDocuments-v2026-01-01RequestBadRequestError" } } }, "description": "Bad Request" }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DownloadHrxDocuments-v2026-01-01RequestUnauthorizedError" } } }, "description": "Unauthorized" }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContainer" } } }, "description": "Operation failed." }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContainer" } } }, "description": "Operation failed." }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContainer" } } }, "description": "Operation failed." } }, "security": [ { "deelToken": [] } ], "summary": "Download HRX documents", "tags": [ "hrxDocuments" ] } }, "/eor/contracts/{contract_id}/offboarding": { "get": { "description": "Retrieves the offboarding request associated with a specific EOR contract, including termination details, document review status, offboarding request data, and pending employee notification state.\n\n **Token scopes**: `contracts:read`, `worker:read`", "operationId": "eorOffboarding_getContractOffboarding", "parameters": [ { "description": "The unique identifier of the employee contract.", "in": "path", "name": "contract_id", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/eor-offboarding_getContractOffboarding_Response_200" } } }, "description": "Successful retrieval of the offboarding request." }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RetrieveOffboardingRequest-v2026-01-01RequestBadRequestError" } } }, "description": "Bad Request" }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RetrieveOffboardingRequest-v2026-01-01RequestUnauthorizedError" } } }, "description": "Unauthorized" }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RetrieveOffboardingRequest-v2026-01-01RequestForbiddenError" } } }, "description": "Forbidden" }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContainer" } } }, "description": "Operation failed." }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RetrieveOffboardingRequest-v2026-01-01RequestInternalServerError" } } }, "description": "Internal Server Error" } }, "security": [ { "deelToken": [] } ], "summary": "Retrieve Offboarding Request", "tags": [ "eorOffboarding" ] } }, "/eor/contracts/{contract_id}/offboarding/attachments/{attachment_id}": { "get": { "description": "Downloads the content of a specific attachment associated with the termination for a given contract.\n\n **Token scopes**: `contracts:read`", "operationId": "eorOffboarding_getContractOffboardingAttachmentById", "parameters": [ { "description": "The unique identifier of the employee contract.", "in": "path", "name": "contract_id", "required": true, "schema": { "type": "string" } }, { "description": "The unique identifier of the attachment to download.", "in": "path", "name": "attachment_id", "required": true, "schema": { "format": "uuid", "type": "string" } } ], "responses": { "200": { "content": { "application/octet-stream": { "schema": { "format": "binary", "type": "string" } } }, "description": "File download successful" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RetrieveOffboardingAttachment-v2026-01-01RequestBadRequestError" } } }, "description": "Bad Request" }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RetrieveOffboardingAttachment-v2026-01-01RequestUnauthorizedError" } } }, "description": "Unauthorized" }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RetrieveOffboardingAttachment-v2026-01-01RequestForbiddenError" } } }, "description": "Forbidden" }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContainer" } } }, "description": "Operation failed." }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RetrieveOffboardingAttachment-v2026-01-01RequestInternalServerError" } } }, "description": "Internal Server Error" } }, "security": [ { "deelToken": [] } ], "summary": "Retrieve offboarding attachment", "tags": [ "eorOffboarding" ] } }, "/eor/contracts/{contract_id}/offboarding/required-information": { "get": { "description": "Returns country-specific mandatory and optional questions, and identifies required supporting documents, that must be provided when initiating the offboarding process for a contract.\n\n **Token scopes**: `contracts:read`", "operationId": "eorOffboarding_getEORContractOffboardingRequiredInformation", "parameters": [ { "description": "The unique identifier of the employee contract.", "in": "path", "name": "contract_id", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/eor-offboarding_getEORContractOffboardingRequiredInformation_Response_200" } } }, "description": "Ok response" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetAdditionalInformationRequiredToRequestEmployeeTermination-v2026-01-01RequestBadRequestError" } } }, "description": "Bad Request" }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetAdditionalInformationRequiredToRequestEmployeeTermination-v2026-01-01RequestUnauthorizedError" } } }, "description": "Unauthorized" }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetAdditionalInformationRequiredToRequestEmployeeTermination-v2026-01-01RequestForbiddenError" } } }, "description": "Forbidden" }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContainer" } } }, "description": "Operation failed." }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetAdditionalInformationRequiredToRequestEmployeeTermination-v2026-01-01RequestInternalServerError" } } }, "description": "Internal Server Error" } }, "security": [ { "deelToken": [] } ], "summary": "Get additional information required to request employee termination", "tags": [ "eorOffboarding" ] } }, "/eor/contracts/{contract_id}/offboarding/resignation": { "post": { "description": "Initiates a resignation request for an EOR contract.\n\n **Token scopes**: `contracts:write`", "operationId": "eorWorkerOffboarding_createEmployeeResignation", "parameters": [ { "description": "The unique identifier of the employee contract.", "in": "path", "name": "contract_id", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "multipart/form-data": { "schema": { "properties": { "data": { "$ref": "#/components/schemas/EorContractsContractIdOffboardingResignationPostRequestBodyContentMultipartFormDataSchemaData" } }, "required": [ "data" ], "type": "object" } } } }, "responses": { "201": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/eor-worker-offboarding_createEmployeeResignation_Response_201" } } }, "description": "Resignation request submitted successfully." }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RequestContractResignation-v2026-01-01RequestBadRequestError" } } }, "description": "Bad Request" }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RequestContractResignation-v2026-01-01RequestUnauthorizedError" } } }, "description": "Unauthorized" }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RequestContractResignation-v2026-01-01RequestForbiddenError" } } }, "description": "Forbidden" }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContainer" } } }, "description": "Operation failed." }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RequestContractResignation-v2026-01-01RequestInternalServerError" } } }, "description": "Internal Server Error" } }, "security": [ { "deelToken": [] } ], "summary": "Request contract resignation", "tags": [ "eorWorkerOffboarding" ] } }, "/eor/contracts/{contract_id}/offboarding/resignations/review-pto": { "post": { "description": "Submits PTO details for a resignation request, triggers related notifications, and finalizes the PTO review step. Only callable when the resignation status is `AWAITING_PTO`.\n\n **Token scopes**: `contracts:write`", "operationId": "eorOffboarding_reviewEOROffboardingPTO", "parameters": [ { "description": "The unique identifier of the employee contract.", "in": "path", "name": "contract_id", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "properties": { "data": { "$ref": "#/components/schemas/EorContractsContractIdOffboardingResignationsReviewPtoPostRequestBodyContentApplicationJsonSchemaData" } }, "type": "object" } } } }, "responses": { "201": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/eor-offboarding_reviewEOROffboardingPTO_Response_201" } } }, "description": "PTO review submitted successfully." }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SubmitEmployeeResignationPtoReview-v2026-01-01RequestBadRequestError" } } }, "description": "Bad Request" }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SubmitEmployeeResignationPtoReview-v2026-01-01RequestUnauthorizedError" } } }, "description": "Unauthorized" }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SubmitEmployeeResignationPtoReview-v2026-01-01RequestForbiddenError" } } }, "description": "Forbidden" }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContainer" } } }, "description": "Operation failed." }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SubmitEmployeeResignationPtoReview-v2026-01-01RequestInternalServerError" } } }, "description": "Internal Server Error" } }, "security": [ { "deelToken": [] } ], "summary": "Submit employee resignation PTO review", "tags": [ "eorOffboarding" ] } }, "/eor/contracts/{contract_id}/offboarding/restricted-dates": { "get": { "description": "Returns country-specific dates unavailable for offboarding end-date selection—including weekends and public holidays—along with the earliest available end date; optionally filtered by termination type.\n\n **Token scopes**: `contracts:read`", "operationId": "eorOffboarding_getContractOffboardingRestrictedDates", "parameters": [ { "description": "The unique identifier of the employee contract.", "in": "path", "name": "contract_id", "required": true, "schema": { "type": "string" } }, { "description": "Type of offboarding.", "in": "query", "name": "termination_type", "required": false, "schema": { "$ref": "#/components/schemas/EorContractsContractIdOffboardingRestrictedDatesGetParametersTerminationType" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/eor-offboarding_getContractOffboardingRestrictedDates_Response_200" } } }, "description": "Successful retrieval of restricted dates." }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RetrieveRestrictedOffboardingDates-v2026-01-01RequestBadRequestError" } } }, "description": "Bad Request" }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RetrieveRestrictedOffboardingDates-v2026-01-01RequestUnauthorizedError" } } }, "description": "Unauthorized" }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RetrieveRestrictedOffboardingDates-v2026-01-01RequestForbiddenError" } } }, "description": "Forbidden" }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContainer" } } }, "description": "Operation failed." }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RetrieveRestrictedOffboardingDates-v2026-01-01RequestInternalServerError" } } }, "description": "Internal Server Error" } }, "security": [ { "deelToken": [] } ], "summary": "Retrieve restricted offboarding dates", "tags": [ "eorOffboarding" ] } }, "/eor/contracts/{contract_id}/offboarding/review-client-sign-offs": { "post": { "description": "Submits a client sign-off decision—approval or change request—for the offboarding documents of a specific contract during the client sign-off step.\n\n **Token scopes**: `contracts:write`", "operationId": "eorOffboarding_createEOROffboardingClientSignOff", "parameters": [ { "description": "The unique identifier of the employee contract.", "in": "path", "name": "contract_id", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "properties": { "data": { "$ref": "#/components/schemas/EorContractsContractIdOffboardingReviewClientSignOffsPostRequestBodyContentApplicationJsonSchemaData" } }, "required": [ "data" ], "type": "object" } } } }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/eor-offboarding_createEOROffboardingClientSignOff_Response_200" } } }, "description": "Approval submitted successfully." }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ReviewApproveOrRequestChangesToEorOffboardingDocuments-v2026-01-01RequestBadRequestError" } } }, "description": "Bad Request" }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ReviewApproveOrRequestChangesToEorOffboardingDocuments-v2026-01-01RequestUnauthorizedError" } } }, "description": "Unauthorized" }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ReviewApproveOrRequestChangesToEorOffboardingDocuments-v2026-01-01RequestForbiddenError" } } }, "description": "Forbidden" }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContainer" } } }, "description": "Operation failed." }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ReviewApproveOrRequestChangesToEorOffboardingDocuments-v2026-01-01RequestInternalServerError" } } }, "description": "Internal Server Error" } }, "security": [ { "deelToken": [] } ], "summary": "Create client sign off", "tags": [ "eorOffboarding" ] } }, "/eor/contracts/{contract_id}/offboarding/review-employee-sign-offs": { "post": { "description": "Records an employee's sign-off decision—approval or change request with feedback—for the offboarding document set of a contract.\n\n **Token scopes**: `worker:write`", "operationId": "eorOffboarding_reviewEOROffboardingEmployeeSignOffs", "parameters": [ { "description": "The unique identifier of the employee contract.", "in": "path", "name": "contract_id", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "properties": { "data": { "$ref": "#/components/schemas/EorContractsContractIdOffboardingReviewEmployeeSignOffsPostRequestBodyContentApplicationJsonSchemaData" } }, "type": "object" } } }, "description": "Ok response" }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/eor-offboarding_reviewEOROffboardingEmployeeSignOffs_Response_200" } } }, "description": "Approval submitted successfully." }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SubmitEmployeeSignOffReviewForOffboardingDocuments-v2026-01-01RequestBadRequestError" } } }, "description": "Bad Request" }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SubmitEmployeeSignOffReviewForOffboardingDocuments-v2026-01-01RequestUnauthorizedError" } } }, "description": "Unauthorized" }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SubmitEmployeeSignOffReviewForOffboardingDocuments-v2026-01-01RequestForbiddenError" } } }, "description": "Forbidden" }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContainer" } } }, "description": "Operation failed." }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SubmitEmployeeSignOffReviewForOffboardingDocuments-v2026-01-01RequestInternalServerError" } } }, "description": "Internal Server Error" } }, "security": [ { "deelToken": [] } ], "summary": "Submit employee sign-off review for offboarding documents", "tags": [ "eorOffboarding" ] } }, "/eor/contracts/{contract_id}/offboarding/termination": { "post": { "description": "Initiates a termination request for an EOR contract, beginning the offboarding process for the employee associated with the specified contract_id. The response captures the desired and confirmed end dates along with any termination documents generated at the time of the request.\n\n **Token scopes**: `contracts:write`", "operationId": "eorTerminations_createOffboardingTermination", "parameters": [ { "description": "The unique identifier of the employee contract.", "in": "path", "name": "contract_id", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "multipart/form-data": { "schema": { "properties": { "data": { "$ref": "#/components/schemas/EorContractsContractIdOffboardingTerminationPostRequestBodyContentMultipartFormDataSchemaData" } }, "required": [ "data" ], "type": "object" } } } }, "responses": { "201": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/eor-terminations_createOffboardingTermination_Response_201" } } }, "description": "Ok response" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/InitiateEorContractTerminationRequest-v2026-01-01RequestBadRequestError" } } }, "description": "Bad Request" }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/InitiateEorContractTerminationRequest-v2026-01-01RequestUnauthorizedError" } } }, "description": "Unauthorized" }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/InitiateEorContractTerminationRequest-v2026-01-01RequestForbiddenError" } } }, "description": "Forbidden" }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContainer" } } }, "description": "Operation failed." }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/InitiateEorContractTerminationRequest-v2026-01-01RequestInternalServerError" } } }, "description": "Internal Server Error" } }, "security": [ { "deelToken": [] } ], "summary": "Initiate EOR contract termination request", "tags": [ "eorTerminations" ] } }, "/eor/contracts/{contract_id}/offboarding/time-offs": { "get": { "description": "Returns time off entitlements, balances, and upcoming time offs for the employee on the specified contract, optionally scoped to a target end_date. The response includes policy settings and tracking configuration required to support completion of an offboarding request.\n\n **Token scopes**: `contracts:read`", "operationId": "eorOffboarding_getContractOffboardingTimeOffs", "parameters": [ { "description": "The unique identifier of the employee contract.", "in": "path", "name": "contract_id", "required": true, "schema": { "type": "string" } }, { "description": "Desired end date for offboarding", "in": "query", "name": "end_date", "required": false, "schema": { "format": "date", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/eor-offboarding_getContractOffboardingTimeOffs_Response_200" } } }, "description": "Successfully retrieved used time off information" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RetrieveEmployeeTimeOffDataForOffboarding-v2026-01-01RequestBadRequestError" } } }, "description": "Bad Request" }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RetrieveEmployeeTimeOffDataForOffboarding-v2026-01-01RequestUnauthorizedError" } } }, "description": "Unauthorized" }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RetrieveEmployeeTimeOffDataForOffboarding-v2026-01-01RequestForbiddenError" } } }, "description": "Forbidden" }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContainer" } } }, "description": "Operation failed." }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RetrieveEmployeeTimeOffDataForOffboarding-v2026-01-01RequestInternalServerError" } } }, "description": "Internal Server Error" } }, "security": [ { "deelToken": [] } ], "summary": "Retrieve Employee Time Off Data for Offboarding", "tags": [ "eorOffboarding" ] } }, "/eor/contracts/{contract_id}/project-assignment": { "get": { "description": "Returns the project assignment PDF for an EOR contract pending client approval. The optional version parameter allows callers to confirm the retrieved document matches an expected version before proceeding with acceptance.\n\n **Token scopes**: `contracts:read`", "operationId": "eorProjectAssignment_getProjectAssignment", "parameters": [ { "description": "The unique identifier of the employee contract.", "in": "path", "name": "contract_id", "required": true, "schema": { "type": "string" } }, { "description": "This field is to ensure that the latest version of the project assignment PDF matches the version received from the webhook. If it is not sent, the version validation is not performed and the endpoint returns the PDF. If it is sent, it is checked whether the current version is equal to the version sent; if not, a 409 error occurs, otherwise, the PDF is returned.", "in": "query", "name": "version", "required": false, "schema": { "maxLength": 20, "minLength": 20, "type": "string" } } ], "responses": { "200": { "content": { "application/octet-stream": { "schema": { "format": "binary", "type": "string" } } }, "description": "Successful response" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FetchEorProjectAssignmentPdf-v2026-01-01RequestBadRequestError" } } }, "description": "Bad Request. The request could not be understood or was missing required parameters." }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContainer" } } }, "description": "Operation failed." }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContainer" } } }, "description": "Operation failed." }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContainer" } } }, "description": "Operation failed." }, "409": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FetchEorProjectAssignmentPdf-v2026-01-01RequestConflictError" } } }, "description": "The requested version of the document mismatch the current version." }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FetchEorProjectAssignmentPdf-v2026-01-01RequestInternalServerError" } } }, "description": "Internal server error." } }, "security": [ { "deelToken": [] } ], "summary": "Fetch EOR project assignment PDF", "tags": [ "eorProjectAssignment" ] } }, "/eor/contracts/{contract_id}/project-assignment/accept": { "post": { "description": "Records client approval of a project assignment for an EOR contract, confirming that the terms have been reviewed and accepted.\n\n **Token scopes**: `contracts:write`", "operationId": "eorProjectAssignment_acceptProjectAssignment", "parameters": [ { "description": "The unique identifier of the employee contract.", "in": "path", "name": "contract_id", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "properties": { "data": { "$ref": "#/components/schemas/EorContractsContractIdProjectAssignmentAcceptPostRequestBodyContentApplicationJsonSchemaData" } }, "type": "object" } } } }, "responses": { "204": { "content": { "application/json": { "schema": { "properties": {}, "type": "object" } } }, "description": "The project assignment was accepted successfully." }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AcceptEorProjectAssignmentAsClient-v2026-01-01RequestBadRequestError" } } }, "description": "Bad Request. The request could not be understood or was missing required parameters." }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContainer" } } }, "description": "Operation failed." }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContainer" } } }, "description": "Operation failed." }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContainer" } } }, "description": "Operation failed." }, "409": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AcceptEorProjectAssignmentAsClient-v2026-01-01RequestConflictError" } } }, "description": "The requested version of the document mismatch the current version." }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AcceptEorProjectAssignmentAsClient-v2026-01-01RequestInternalServerError" } } }, "description": "Internal server error." } }, "security": [ { "deelToken": [] } ], "summary": "Accept EOR project assignment as client", "tags": [ "eorProjectAssignment" ] } }, "/eor/contracts/{contract_id}/project-assignment/checkin": { "get": { "description": "Returns the checkin questionnaire for a project assignment, including all sections and questions required for completion. The optional version parameter ensures the fetched questionnaire matches an expected version before it is rendered or submitted.\n\n **Token scopes**: `contracts:read`", "operationId": "eorProjectAssignment_getProjectAssignmentCheckin", "parameters": [ { "description": "The unique identifier of the contract.", "in": "path", "name": "contract_id", "required": true, "schema": { "type": "string" } }, { "description": "This field is to ensure that the latest version of the project assignment checkin matches the version received from the webhook. If it is not sent, the version validation is not performed. If it is sent, it is checked whether the current version is equal to the version sent; if not, a 409 error occurs, otherwise, the data is returned.", "in": "query", "name": "version", "required": false, "schema": { "maxLength": 20, "minLength": 20, "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/eor-project-assignment_getProjectAssignmentCheckin_Response_200" } } }, "description": "Successful response containing form configuration data." }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FetchProjectAssignmentCheckinQuestionnaireData-v2026-01-01RequestBadRequestError" } } }, "description": "Operation failed." }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContainer" } } }, "description": "Operation failed." }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContainer" } } }, "description": "Operation failed." }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContainer" } } }, "description": "Operation failed." }, "409": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FetchProjectAssignmentCheckinQuestionnaireData-v2026-01-01RequestConflictError" } } }, "description": "The requested version of the document mismatch the current version." }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FetchProjectAssignmentCheckinQuestionnaireData-v2026-01-01RequestInternalServerError" } } }, "description": "Operation failed." } }, "security": [ { "deelToken": [] } ], "summary": "Fetch Project Assignment Checkin Questionnaire Data", "tags": [ "eorProjectAssignment" ] }, "post": { "description": "Submits completed answers for a project assignment checkin questionnaire. All required questionnaire fields must be included; partial submissions are not accepted.\n\n **Token scopes**: `contracts:read`, `contracts:write`", "operationId": "eorProjectAssignment_checkinProjectAssignment", "parameters": [ { "description": "The unique identifier of the contract.", "in": "path", "name": "contract_id", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "properties": { "data": { "$ref": "#/components/schemas/EorContractsContractIdProjectAssignmentCheckinPostRequestBodyContentApplicationJsonSchemaData", "description": "Form submission payload containing respondent type, question answers, and optional version." } }, "type": "object" } } }, "description": "Payload for submitting employee or client form answers." }, "responses": { "204": { "content": { "application/json": { "schema": { "properties": {}, "type": "object" } } }, "description": "No content. The request was successful, but there is no response body." }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SubmitProjectAssignmentCheckinQuestionnaireData-v2026-01-01RequestBadRequestError" } } }, "description": "Operation failed." }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContainer" } } }, "description": "Operation failed." }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContainer" } } }, "description": "Operation failed." }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContainer" } } }, "description": "Operation failed." }, "409": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SubmitProjectAssignmentCheckinQuestionnaireData-v2026-01-01RequestConflictError" } } }, "description": "The requested version of the document mismatch the current version." }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SubmitProjectAssignmentCheckinQuestionnaireData-v2026-01-01RequestInternalServerError" } } }, "description": "Operation failed." } }, "security": [ { "deelToken": [] } ], "summary": "Submit Project Assignment Checkin Questionnaire Data", "tags": [ "eorProjectAssignment" ] } }, "/eor/contracts/{contract_id}/reject": { "patch": { "description": "Rejects the quote of an EOR contract. Rejection is only accepted while the contract is in one of `new`, `under_review`, `waiting_for_client_sign`, `waiting_for_eor_sign`, `waiting_for_employee_contract`, `waiting_for_employee_sign` or `awaiting_deposit_payment`. Rejection is terminal — there is no public endpoint to un-reject a contract, and a contract already in `rejected` cannot be rejected again. The token must hold the `contracts.edit` permission on the contract.\n\n **Token scopes**: `contracts:write`", "operationId": "eor_rejectEorQuote-v2026-09-10", "parameters": [ { "description": "The unique identifier of the EOR contract.", "in": "path", "name": "contract_id", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "properties": { "data": { "$ref": "#/components/schemas/EorContractsContractIdRejectPatchRequestBodyContentApplicationJsonSchemaData" } }, "required": [ "data" ], "type": "object" } } } }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EOR_rejectEorQuote-v2026-09-10_Response_200" } } }, "description": "The quote was rejected successfully." }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RejectEorQuote-v2026-09-10RequestBadRequestError" } } }, "description": "The payload is invalid or the contract is not in a status that allows quote rejection." }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContainer" } } }, "description": "Operation failed." }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RejectEorQuote-v2026-09-10RequestForbiddenError" } } }, "description": "The token does not have access to this contract, or the token is not a client token." }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RejectEorQuote-v2026-09-10RequestNotFoundError" } } }, "description": "No EOR contract matches the provided identifier." }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RejectEorQuote-v2026-09-10RequestInternalServerError" } } }, "description": "Operation failed." } }, "security": [ { "deelToken": [] } ], "summary": "Reject an EOR quote", "tags": [ "eor" ] } }, "/eor/employment_cost": { "post": { "description": "Calculates the total employment cost for an EOR arrangement in a specified country, returning a breakdown that includes employer costs, benefits, platform fees, and severance accrual.", "operationId": "costCalculator_getEmploymentCost", "requestBody": { "content": { "application/json": { "schema": { "properties": { "data": { "$ref": "#/components/schemas/EorEmploymentCostPostRequestBodyContentApplicationJsonSchemaData" } }, "required": [ "data" ], "type": "object" } } } }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/cost-calculator_getEmploymentCost_Response_200" } } }, "description": "Successfully calculated employee costs." }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContainer" } } }, "description": "Operation failed." }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContainer" } } }, "description": "Operation failed." }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContainer" } } }, "description": "Operation failed." } }, "security": [ { "deelToken": [] } ], "summary": "Calculate Employee Costs Globally", "tags": [ "costCalculator" ] } }, "/eor/job-scopes": { "get": { "description": "Returns predefined and custom job scope templates available for EOR contracts, optionally filtered to templates belonging to a specific team.\n\n **Token scopes**: `organizations:read`", "operationId": "eorJobScopes_getJobScopes", "parameters": [ { "description": "Team public id", "in": "query", "name": "team", "required": false, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "items": { "$ref": "#/components/schemas/EorJobScopesGetResponsesContentApplicationJsonSchemaItems" }, "type": "array" } } }, "description": "Successfull response" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContainer" } } }, "description": "Operation failed." }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContainer" } } }, "description": "Operation failed." }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContainer" } } }, "description": "Operation failed." }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ListOfJobScopeTemplatesForEorContracts-v2026-01-01RequestNotFoundError" } } }, "description": "Not Found - Organization not linked to profile or no teams found for the organization" }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContainer" } } }, "description": "Operation failed." } }, "security": [ { "deelToken": [] } ], "summary": "List of job scope templates for EOR contracts", "tags": [ "eorJobScopes" ] } }, "/eor/job-scopes/validate": { "post": { "description": "Validates a job scope description and returns any validation errors. When errors are present, the response also includes a `quote_validation_log_public_id` and pre-populated `data_for_corrected_job_scope_endpoint` to support subsequent correction.\n\n **Token scopes**: `contracts:write`", "operationId": "eorJobScopes_validateJobScope", "requestBody": { "content": { "application/json": { "schema": { "properties": { "data": { "$ref": "#/components/schemas/EorJobScopesValidatePostRequestBodyContentApplicationJsonSchemaData", "description": "details of job scope" } }, "required": [ "data" ], "type": "object" } } }, "description": "Run job scope validation" }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/eor-job-scopes_validateJobScope_Response_200" } } }, "description": "Successful operation." }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RequestJobScopeValidation-v2026-01-01RequestBadRequestError" } } }, "description": "Operation failed." }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContainer" } } }, "description": "Operation failed." }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContainer" } } }, "description": "Operation failed." }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContainer" } } }, "description": "Operation failed." }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContainer" } } }, "description": "Operation failed." } }, "security": [ { "deelToken": [] } ], "summary": "Request job scope validation", "tags": [ "eorJobScopes" ] } }, "/eor/mailboxes/change-password": { "post": { "description": "Changes the mailbox password for an EOR worker.\n\n **Token scopes**: `worker:write`", "operationId": "eorWorkerMailboxes_changePassword", "requestBody": { "content": { "application/json": { "schema": { "properties": { "data": { "$ref": "#/components/schemas/EorMailboxesChangePasswordPostRequestBodyContentApplicationJsonSchemaData" } }, "required": [ "data" ], "type": "object" } } }, "description": "The new password to be set" }, "responses": { "204": { "content": { "application/json": { "schema": { "properties": {}, "type": "object" } } }, "description": "Successful operation." }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ChangeEorMailboxPassword-v2026-01-01RequestBadRequestError" } } }, "description": "Operation failed." }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContainer" } } }, "description": "Operation failed." }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContainer" } } }, "description": "Operation failed." }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContainer" } } }, "description": "Operation failed." }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ChangeEorMailboxPassword-v2026-01-01RequestInternalServerError" } } }, "description": "Operation failed." } }, "security": [ { "deelToken": [] } ], "summary": "Change EOR Mailbox Password", "tags": [ "eorWorkerMailboxes" ] } }, "/eor/start-date": { "get": { "description": "Returns the earliest allowed start date for a new EOR contract quote based on the specified employment country, nationality, and visa requirements. The response also includes payroll timing parameters — `start_date_buffer`, `first_payroll_lock`, and `is_same_month_payment_country` — that govern when the contract can take effect.\n\n **Token scopes**: `contracts:read`", "operationId": "eorHiring_getStartDate", "parameters": [ { "description": "Employment country in ISO 3166-1 alpha-2 format", "in": "query", "name": "employment_country", "required": true, "schema": { "pattern": "^[A-Z]{2}$", "type": "string" } }, { "description": "Employee nationality in ISO 3166-1 alpha-2 format", "in": "query", "name": "employee_nationality", "required": false, "schema": { "pattern": "^[A-Z]{2}$", "type": "string" } }, { "description": "Whether a work visa is required", "in": "query", "name": "work_visa", "required": false, "schema": { "type": "boolean" } }, { "description": "Team ID", "in": "query", "name": "team_id", "required": true, "schema": { "type": "string" } }, { "description": "Legal entity ID", "in": "query", "name": "legal_entity_id", "required": false, "schema": { "type": "string" } }, { "description": "State or province of employment", "in": "query", "name": "employment_state", "required": false, "schema": { "type": "string" } }, { "description": "Special job ID (if applicable)", "in": "query", "name": "special_job_id", "required": false, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/eor-hiring_getStartDate_Response_200" } } }, "description": "Start date details" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FetchStartDateForEorContracts-v2026-01-01RequestBadRequestError" } } }, "description": "Operation failed." }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContainer" } } }, "description": "Operation failed." }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContainer" } } }, "description": "Operation failed." }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContainer" } } }, "description": "Operation failed." }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContainer" } } }, "description": "Operation failed." } }, "security": [ { "deelToken": [] } ], "summary": "Fetch Start Date for EOR Contracts", "tags": [ "eorHiring" ] } }, "/eor/validations/{country_code}": { "get": { "description": "Returns country-specific hiring guide data — including salary requirements, holidays, probation terms, health insurance, and currency — for use in creating and validating EOR contract quotes.\n\n **Token scopes**: `contracts:read`", "operationId": "eorHiring_getEORHiringGuideByCountry", "parameters": [ { "description": "The two-letter ISO code of the country for which to retrieve the hiring guide.", "in": "path", "name": "country_code", "required": true, "schema": { "maxLength": 2, "minLength": 2, "pattern": "^[A-Z]{2}$", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/eor-hiring_getEORHiringGuideByCountry_Response_200" } } }, "description": "The hiring guide data was successfully retrieved." }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContainer" } } }, "description": "Operation failed." }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContainer" } } }, "description": "Operation failed." }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContainer" } } }, "description": "Operation failed." } }, "security": [ { "deelToken": [] } ], "summary": "Retrieve detailed hiring guide for a country", "tags": [ "eorHiring" ] } }, "/eor/worker": { "post": { "description": "Creates an EOR worker record and returns the associated `user_id`, `profile_id`, and `hris_profile_id`.\n\n **Token scopes**: `people:write`", "operationId": "eorWorkerAccounts_createWorker", "requestBody": { "content": { "application/json": { "schema": { "properties": { "data": { "$ref": "#/components/schemas/EorWorkerPostRequestBodyContentApplicationJsonSchemaData" } }, "type": "object" } } } }, "responses": { "201": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/eor-worker-accounts_createWorker_Response_201" } } }, "description": "Successful operation." }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreateEorWorker-v2026-01-01RequestBadRequestError" } } }, "description": "Operation failed." }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContainer" } } }, "description": "Operation failed." }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContainer" } } }, "description": "Operation failed." }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContainer" } } }, "description": "Operation failed." }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContainer" } } }, "description": "Operation failed." } }, "security": [ { "deelToken": [] } ], "summary": "Create EOR Worker", "tags": [ "eorWorkerAccounts" ] } }, "/eor/worker/benefits": { "get": { "description": "Returns the benefits for the authenticated employee. The employee identity is inferred from the auth token, so this endpoint must be called with an employee-scoped token rather than a client token.\n\n **Token scopes**: `benefits:read`", "operationId": "eorWorkerBenefits_getEORWorkerBenefits", "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/eor-worker-benefits_getEORWorkerBenefits_Response_200" } } }, "description": "Successful operation." }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RetrieveBenefitsForEmployee-v2026-01-01RequestBadRequestError" } } }, "description": "Operation failed." }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContainer" } } }, "description": "Operation failed." }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContainer" } } }, "description": "Operation failed." }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContainer" } } }, "description": "Operation failed." }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContainer" } } }, "description": "Operation failed." } }, "security": [ { "deelToken": [] } ], "summary": "Retrieve Benefits for Employee", "tags": [ "eorWorkerBenefits" ] } }, "/eor/workers/banks": { "post": { "description": "Registers a bank account for an EOR employee. Returns the `id` of the newly created bank account record.\n\n **Token scopes**: `worker:write`", "operationId": "eorWorkerInformation_createEORWorkerBankAccount", "requestBody": { "content": { "application/json": { "schema": { "properties": { "data": { "description": "Array of key value properties of bank account", "items": { "$ref": "#/components/schemas/EorWorkersBanksPostRequestBodyContentApplicationJsonSchemaDataItems" }, "type": "array" } }, "required": [ "data" ], "type": "object" } } } }, "responses": { "201": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/eor-worker-information_createEORWorkerBankAccount_Response_201" } } }, "description": "Successful operation." }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContainer" } } }, "description": "Operation failed." }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContainer" } } }, "description": "Operation failed." }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContainer" } } }, "description": "Operation failed." }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContainer" } } }, "description": "Operation failed." }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContainer" } } }, "description": "Operation failed." } }, "security": [ { "deelToken": [] } ], "summary": "Add bank account", "tags": [ "eorWorkerInformation" ] } }, "/eor/workers/banks-guide/country/{country}/currency/{currency}": { "get": { "description": "Returns the bank account form guide for the specified `country` and `currency` combination, providing the field structure required to add a new bank account for an EOR employee.\n\n **Token scopes**: `worker:read`", "operationId": "eorWorkerBanks_getEORWorkerBankGuideByCountryAndCurrency", "parameters": [ { "description": "Country", "in": "path", "name": "country", "required": true, "schema": { "type": "string" } }, { "description": "Currency", "in": "path", "name": "currency", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/eor-worker-banks_getEORWorkerBankGuideByCountryAndCurrency_Response_200" } } }, "description": "Successful operation." }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RetrieveBankAccountGuide-v2026-01-01RequestBadRequestError" } } }, "description": "Operation failed." }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContainer" } } }, "description": "Operation failed." }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContainer" } } }, "description": "Operation failed." }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContainer" } } }, "description": "Operation failed." }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContainer" } } }, "description": "Operation failed." } }, "security": [ { "deelToken": [] } ], "summary": "Retrieve bank account guide", "tags": [ "eorWorkerBanks" ] } }, "/eor/workers/banks/guide": { "get": { "description": "Returns the bank account form guide for an EOR employee, providing the field structure required to add a new bank account.\n\n **Token scopes**: `worker:read`", "operationId": "eorWorkerBanks_getEORWorkerBankGuide", "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/eor-worker-banks_getEORWorkerBankGuide_Response_200" } } }, "description": "Successful operation." }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContainer" } } }, "description": "Operation failed." }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContainer" } } }, "description": "Operation failed." }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContainer" } } }, "description": "Operation failed." }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContainer" } } }, "description": "Operation failed." }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContainer" } } }, "description": "Operation failed." } }, "security": [ { "deelToken": [] } ], "summary": "Retrieve bank account guide", "tags": [ "eorWorkerBanks" ] } }, "/eor/workers/banks/{bank_id}": { "patch": { "description": "Modify bank account for an EOR employee by providing only those properties whose values you would like to adjust.\n\n **Token scopes**: `worker:write`", "operationId": "eor_modifyBankAccountForAnEorEmployee-v2026-08-19", "parameters": [ { "description": "Unique identifier for a bank in UUID format.", "in": "path", "name": "bank_id", "required": true, "schema": { "format": "uuid", "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "properties": { "data": { "additionalProperties": { "type": "string" }, "description": "An object where each property name represents a key of bank account property and its value is the field's value to set.", "type": "object" } }, "required": [ "data" ], "type": "object" } } }, "description": "Bank account fields to be modified, provided as key-value pairs." }, "responses": { "201": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EOR_modifyBankAccountForAnEorEmployee-v2026-08-19_Response_201" } } }, "description": "Successful operation." }, "400": { "content": { "application/json": { "schema": { "description": "Any type" } } }, "description": "Invalid request parameters." }, "401": { "content": { "application/json": { "schema": { "description": "Any type" } } }, "description": "Unauthorized." }, "403": { "content": { "application/json": { "schema": { "description": "Any type" } } }, "description": "Forbidden." }, "404": { "content": { "application/json": { "schema": { "description": "Any type" } } }, "description": "Bank account not found." }, "500": { "content": { "application/json": { "schema": { "description": "Any type" } } }, "description": "Internal server error." } }, "security": [ { "deelToken": [] } ], "summary": "Modify bank account for an EOR employee", "tags": [ "eor" ] } }, "/eor/workers/compliance-documents": { "get": { "description": "Returns the list of compliance documents associated with an EOR employee.\n\n **Token scopes**: `worker:read`", "operationId": "eorWorkerCompliance_getEORWorkerComplianceDocuments", "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/eor-worker-compliance_getEORWorkerComplianceDocuments_Response_200" } } }, "description": "Successful operation." }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContainer" } } }, "description": "Operation failed." }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ListOfEmployeeComplianceDocuments-v2026-01-01RequestUnauthorizedError" } } }, "description": "Authentication failed. The access token is missing, expired, or invalid." }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ListOfEmployeeComplianceDocuments-v2026-01-01RequestForbiddenError" } } }, "description": "Access denied. The authenticated user does not have the required worker:read scope or is not an employee profile." }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContainer" } } }, "description": "Operation failed." }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ListOfEmployeeComplianceDocuments-v2026-01-01RequestInternalServerError" } } }, "description": "Internal server error." } }, "security": [ { "deelToken": [] } ], "summary": "List of employee compliance documents", "tags": [ "eorWorkerCompliance" ] } }, "/eor/workers/compliance-documents/{document_id}": { "post": { "description": "Uploads a compliance document file against the specified `document_id` for an EOR employee.\n\n **Token scopes**: `worker:write`", "operationId": "eorWorkerCompliance_uploadEORWorkerComplianceDocument", "parameters": [ { "description": "Unique identifier for a compliance document in Deel.", "in": "path", "name": "document_id", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "multipart/form-data": { "schema": { "properties": { "file": { "description": "The employee compliance document to upload.", "format": "binary", "type": "string" } }, "type": "object" } } }, "description": "The employee compliance document data to upload" }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/eor-worker-compliance_uploadEORWorkerComplianceDocument_Response_200" } } }, "description": "Successful operation." }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContainer" } } }, "description": "Operation failed." }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContainer" } } }, "description": "Operation failed." }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContainer" } } }, "description": "Operation failed." }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContainer" } } }, "description": "Operation failed." }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContainer" } } }, "description": "Operation failed." } }, "security": [ { "deelToken": [] } ], "summary": "Upload employee compliance document", "tags": [ "eorWorkerCompliance" ] } }, "/eor/workers/compliance-documents/{document_id}/acknowledgement": { "post": { "description": "Submits the worker's consent acknowledgement for a compliance document that requires it. This operation is required before documents marked as needing acknowledgement are considered complete.\n\n **Token scopes**: `worker:write`", "operationId": "eorWorkerCompliance_createComplianceDocumentAcknowledgement", "parameters": [ { "description": "The unique identifier of the compliance document.", "in": "path", "name": "document_id", "required": true, "schema": { "type": "string" } } ], "responses": { "204": { "content": { "application/json": { "schema": { "properties": {}, "type": "object" } } }, "description": "Document was acknowledged successfully" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AcknowledgeAComplianceDocument-v2026-01-01RequestBadRequestError" } } }, "description": "Operation failed." }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContainer" } } }, "description": "Operation failed." }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContainer" } } }, "description": "Operation failed." }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContainer" } } }, "description": "Operation failed." }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AcknowledgeAComplianceDocument-v2026-01-01RequestInternalServerError" } } }, "description": "Operation failed." } }, "security": [ { "deelToken": [] } ], "summary": "Acknowledge a compliance document", "tags": [ "eorWorkerCompliance" ] } }, "/eor/workers/compliance-documents/{document_id}/download": { "get": { "description": "Returns a time-limited download URL for a submitted compliance document. The URL expires at the time indicated by `expires_at` in the response.\n\n **Token scopes**: `worker:read`", "operationId": "eorWorkerCompliance_downloadComplianceDocument", "parameters": [ { "description": "Unique identifier for a compliance document in Deel.", "in": "path", "name": "document_id", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/eor-worker-compliance_downloadComplianceDocument_Response_200" } } }, "description": "Successful operation." }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DownloadSubmittedComplianceDocument-v2026-01-01RequestBadRequestError" } } }, "description": "Operation failed." }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContainer" } } }, "description": "Operation failed." }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContainer" } } }, "description": "Operation failed." }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContainer" } } }, "description": "Operation failed." }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContainer" } } }, "description": "Operation failed." } }, "security": [ { "deelToken": [] } ], "summary": "Download submitted compliance document", "tags": [ "eorWorkerCompliance" ] } }, "/eor/workers/compliance-documents/{document_id}/templates/download": { "get": { "description": "Returns a time-limited download URL for the compliance document template associated with the given `document_id`, only if a template exists for that document.\n\n **Token scopes**: `worker:read`", "operationId": "eorWorkerCompliance_downloadComplianceDocumentTemplate", "parameters": [ { "description": "Unique identifier for a compliance document in Deel.", "in": "path", "name": "document_id", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/eor-worker-compliance_downloadComplianceDocumentTemplate_Response_200" } } }, "description": "Successful operation." }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContainer" } } }, "description": "Operation failed." }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContainer" } } }, "description": "Operation failed." }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContainer" } } }, "description": "Operation failed." }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DownloadEmployeeComplianceDocumentTemplate-v2026-01-01RequestNotFoundError" } } }, "description": "Compliance document or template not found." }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContainer" } } }, "description": "Operation failed." } }, "security": [ { "deelToken": [] } ], "summary": "Download employee compliance document template", "tags": [ "eorWorkerCompliance" ] } }, "/eor/workers/contracts/{contract_id}/additional-information": { "get": { "description": "Lets a worker review the additional information saved on their own EOR employee agreement — data that could previously only be written, not read back. Absent values are omitted from the response rather than returned as null.\n\n **Token scopes**: `worker:read`\n\n **Beta**: this version requires the `X-Beta: true` request header and its contract may change before it is promoted to stable. It is scheduled to become stable on 2027-01-05.", "operationId": "eor_getAdditionalInformation-v2026-09-18", "parameters": [ { "description": "Deel contract id.", "in": "path", "name": "contract_id", "required": true, "schema": { "type": "string" } }, { "description": "Opts in to the beta version of this endpoint. Must be `true`.", "in": "header", "name": "X-Beta", "required": true, "schema": { "$ref": "#/components/schemas/EorWorkersContractsContractIdAdditionalInformationGetParametersXBeta" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EOR_getAdditionalInformation-v2026-09-18_Response_200" } } }, "description": "Successful operation." }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetAdditionalInformation-v2026-09-18RequestBadRequestError" } } }, "description": "Bad request. Contract not found or contract is not EOR." }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetAdditionalInformation-v2026-09-18RequestUnauthorizedError" } } }, "description": "Authentication failed. Bearer token is missing, expired, or invalid." }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetAdditionalInformation-v2026-09-18RequestForbiddenError" } } }, "description": "Forbidden. The token lacks worker:read scope or the worker cannot access this contract." }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetAdditionalInformation-v2026-09-18RequestNotFoundError" } } }, "description": "Not found. The contract does not exist or does not belong to the caller." }, "429": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetAdditionalInformation-v2026-09-18RequestTooManyRequestsError" } } }, "description": "Rate limit exceeded." }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetAdditionalInformation-v2026-09-18RequestInternalServerError" } } }, "description": "Internal server error." } }, "security": [ { "deelToken": [] } ], "summary": "Get additional information", "tags": [ "eor" ] }, "patch": { "description": "Partially updates the additional information on an EOR employee agreement. This operation is only permitted when the contract status is `new`, `under_review`, or `waiting_for_employee_contract`; invoking it with any other status will result in an error.\n\n **Token scopes**: `worker:write`", "operationId": "eorWorkerInformation_updateEORWorkerAdditionalInformation", "parameters": [ { "description": "Deel contract id.", "in": "path", "name": "contract_id", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "properties": { "data": { "$ref": "#/components/schemas/EorWorkersContractsContractIdAdditionalInformationPatchRequestBodyContentApplicationJsonSchemaData", "description": "You can submit any subset of fields. Keys not listed above are treated as country/state-specific additional information fields. Those keys must match the fields returned by GET /forms/eor/worker-additional-fields/{country_code} (public keys)." } }, "required": [ "data" ], "type": "object" } } }, "description": "Patch additional information for an EOR employee contract." }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/eor-worker-information_updateEORWorkerAdditionalInformation_Response_200" } } }, "description": "Successful operation." }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UpdateAdditionalInformation-v2026-01-01RequestBadRequestError" } } }, "description": "Bad request. Contract not found, contract is not EOR, or additional information validation failed." }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UpdateAdditionalInformation-v2026-01-01RequestUnauthorizedError" } } }, "description": "Authentication failed. Bearer token is missing, expired, or invalid." }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UpdateAdditionalInformation-v2026-01-01RequestForbiddenError" } } }, "description": "Forbidden. The token lacks worker:write scope or the worker cannot update this contract." }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UpdateAdditionalInformation-v2026-01-01RequestNotFoundError" } } }, "description": "Not found. No additional info template exists for the employment country/state." }, "429": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UpdateAdditionalInformation-v2026-01-01RequestTooManyRequestsError" } } }, "description": "Rate limit exceeded." }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UpdateAdditionalInformation-v2026-01-01RequestInternalServerError" } } }, "description": "Internal server error." } }, "security": [ { "deelToken": [] } ], "summary": "Update additional information", "tags": [ "eorWorkerInformation" ] }, "post": { "description": "Adds supplemental information fields to an EOR employee's contract record.\n\n **Token scopes**: `worker:write`", "operationId": "eorWorkerInformation_createGPWorkerAdditionalInformation", "parameters": [ { "description": "Deel contract id.", "in": "path", "name": "contract_id", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "properties": { "data": { "$ref": "#/components/schemas/EorWorkersContractsContractIdAdditionalInformationPostRequestBodyContentApplicationJsonSchemaData", "description": "Additional fields are country/state-specific and validated against the worker additional fields form for the employment country." } }, "required": [ "data" ], "type": "object" } } }, "description": "Add additional information for an EOR employee." }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/eor-worker-information_createGPWorkerAdditionalInformation_Response_200" } } }, "description": "Successful operation." }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AddAdditionalInformation-v2026-01-01RequestBadRequestError" } } }, "description": "Bad request. Contract not found, contract is not EOR, required base fields are missing, or country-specific additional field validation failed." }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AddAdditionalInformation-v2026-01-01RequestUnauthorizedError" } } }, "description": "Authentication failed. Bearer token is missing, expired, or invalid." }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AddAdditionalInformation-v2026-01-01RequestForbiddenError" } } }, "description": "Forbidden. The token lacks worker:write scope or the worker cannot update this contract." }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AddAdditionalInformation-v2026-01-01RequestNotFoundError" } } }, "description": "Not found. No additional information template exists for the employment country/state." }, "429": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AddAdditionalInformation-v2026-01-01RequestTooManyRequestsError" } } }, "description": "Rate limit exceeded." }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AddAdditionalInformation-v2026-01-01RequestInternalServerError" } } }, "description": "Internal server error." } }, "security": [ { "deelToken": [] } ], "summary": "Add additional information", "tags": [ "eorWorkerInformation" ] } }, "/eor/workers/contracts/{contract_id}/employee-agreement/download": { "get": { "description": "Returns a time-limited download URL for the employee agreement PDF associated with the given `contract_id`. When the optional `version` parameter is supplied and a version mismatch is detected, behaviour diverges from the default resolution path.\n\n **Token scopes**: `worker:read`", "operationId": "eorWorkerAgreements_downloadWorkerEmployeeAgreement", "parameters": [ { "description": "The unique identifier of the employee contract.", "in": "path", "name": "contract_id", "required": true, "schema": { "type": "string" } }, { "description": "Optional version of the Employment Agreement to be signed. If informed and in the case of a mismatch, the API will return an error.", "in": "query", "name": "version", "required": false, "schema": { "maxLength": 20, "minLength": 20, "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/eor-worker-agreements_downloadWorkerEmployeeAgreement_Response_200" } } }, "description": "Successful operation." }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DownloadEmployeeAgreementPdf-v2026-01-01RequestBadRequestError" } } }, "description": "Invalid request: the contract was not found or is not an EOR contract." }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContainer" } } }, "description": "Operation failed." }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContainer" } } }, "description": "Operation failed." }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DownloadEmployeeAgreementPdf-v2026-01-01RequestNotFoundError" } } }, "description": "Employee agreement is not available yet for this contract." }, "409": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DownloadEmployeeAgreementPdf-v2026-01-01RequestConflictError" } } }, "description": "Employment Agreement version mismatch." }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContainer" } } }, "description": "Operation failed." } }, "security": [ { "deelToken": [] } ], "summary": "Download employee agreement PDF", "tags": [ "eorWorkerAgreements" ] } }, "/eor/workers/contracts/{contract_id}/hr-documents": { "get": { "description": "Returns all HR verification letters and documents associated with the employee contract.\n\n **Token scopes**: `worker:read`", "operationId": "eorWorkerDocuments_getEORWorkerHRDocuments", "parameters": [ { "description": "Deel contract id.", "in": "path", "name": "contract_id", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/eor-worker-documents_getEORWorkerHRDocuments_Response_200" } } }, "description": "Successful operation." }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContainer" } } }, "description": "Operation failed." }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContainer" } } }, "description": "Operation failed." }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContainer" } } }, "description": "Operation failed." }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContainer" } } }, "description": "Operation failed." }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContainer" } } }, "description": "Operation failed." } }, "security": [ { "deelToken": [] } ], "summary": "List HR verification letters and documents", "tags": [ "eorWorkerDocuments" ] } }, "/eor/workers/contracts/{contract_id}/offboarding": { "post": { "description": "Formally initiates the resignation process for the EOR contract by submitting a resignation request on behalf of the worker.\n\n **Token scopes**: `worker:write`", "operationId": "eorWorkerOffboarding_submitEORWorkerResignation", "parameters": [ { "description": "The unique identifier of the employee contract.", "in": "path", "name": "contract_id", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "multipart/form-data": { "schema": { "properties": { "data": { "$ref": "#/components/schemas/EorWorkersContractsContractIdOffboardingPostRequestBodyContentMultipartFormDataSchemaData" } }, "required": [ "data" ], "type": "object" } } } }, "responses": { "201": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/eor-worker-offboarding_submitEORWorkerResignation_Response_201" } } }, "description": "Ok response" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SubmitEorWorkerResignation-v2026-01-01RequestBadRequestError" } } }, "description": "Bad Request" }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SubmitEorWorkerResignation-v2026-01-01RequestUnauthorizedError" } } }, "description": "Unauthorized" }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SubmitEorWorkerResignation-v2026-01-01RequestForbiddenError" } } }, "description": "Forbidden" }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContainer" } } }, "description": "Operation failed." }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SubmitEorWorkerResignation-v2026-01-01RequestInternalServerError" } } }, "description": "Internal Server Error" } }, "security": [ { "deelToken": [] } ], "summary": "Submit EOR Worker Resignation", "tags": [ "eorWorkerOffboarding" ] } }, "/eor/workers/contracts/{contract_id}/offboarding/resignation-letter": { "get": { "description": "Returns a preview of the resignation letter for the EOR contract before the worker submits their signature.\n\n **Token scopes**: `worker:read`", "operationId": "eorWorkerOffboarding_downloadEmployeeResignationLetter", "parameters": [ { "description": "The unique identifier of the employee contract.", "in": "path", "name": "contract_id", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/octet-stream": { "schema": { "format": "binary", "type": "string" } } }, "description": "File download successful" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PreviewResignationLetter-v2026-01-01RequestBadRequestError" } } }, "description": "Bad Request" }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PreviewResignationLetter-v2026-01-01RequestUnauthorizedError" } } }, "description": "Unauthorized" }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PreviewResignationLetter-v2026-01-01RequestForbiddenError" } } }, "description": "Forbidden" }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContainer" } } }, "description": "Operation failed." }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PreviewResignationLetter-v2026-01-01RequestInternalServerError" } } }, "description": "Internal Server Error" } }, "security": [ { "deelToken": [] } ], "summary": "Preview Resignation Letter", "tags": [ "eorWorkerOffboarding" ] } }, "/eor/workers/contracts/{contract_id}/offboarding/resignation-letter/sign": { "post": { "description": "Records the worker's signature on the resignation letter for the contract, which is required to finalize the resignation process; upon successful submission, the signed letter is queued for PDF generation and further processing.\n\n **Token scopes**: `worker:write`", "operationId": "eorWorkerOffboarding_signEmployeeResignationLetter", "parameters": [ { "description": "The unique identifier of the employee contract.", "in": "path", "name": "contract_id", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "properties": { "data": { "$ref": "#/components/schemas/EorWorkersContractsContractIdOffboardingResignationLetterSignPostRequestBodyContentApplicationJsonSchemaData" } }, "required": [ "data" ], "type": "object" } } } }, "responses": { "201": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/eor-worker-offboarding_signEmployeeResignationLetter_Response_201" } } }, "description": "Resignation signed successfully." }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SignResignationLetter-v2026-01-01RequestBadRequestError" } } }, "description": "Bad Request" }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SignResignationLetter-v2026-01-01RequestUnauthorizedError" } } }, "description": "Unauthorized" }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SignResignationLetter-v2026-01-01RequestForbiddenError" } } }, "description": "Forbidden" }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContainer" } } }, "description": "Operation failed." }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SignResignationLetter-v2026-01-01RequestInternalServerError" } } }, "description": "Internal Server Error" } }, "security": [ { "deelToken": [] } ], "summary": "Sign Resignation Letter", "tags": [ "eorWorkerOffboarding" ] } }, "/eor/workers/contracts/{contract_id}/offer-letter": { "get": { "description": "Returns the job offer letter for an EOR contract in HTML format. IC and Global Payroll contract types are not supported and will not return a result.\n\n **Token scopes**: `worker:read`", "operationId": "eorWorkerAgreements_downloadWorkerOfferLetter", "parameters": [ { "description": "Deel contract id.", "in": "path", "name": "contract_id", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "properties": {}, "type": "object" } } }, "description": "Successful operation." }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContainer" } } }, "description": "Operation failed." }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContainer" } } }, "description": "Operation failed." }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContainer" } } }, "description": "Operation failed." }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContainer" } } }, "description": "Operation failed." }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContainer" } } }, "description": "Operation failed." } }, "security": [ { "deelToken": [] } ], "summary": "Preview job offer letter", "tags": [ "eorWorkerAgreements" ] } }, "/eor/workers/contracts/{contract_id}/project-assignment/acknowledge": { "post": { "description": "Employee acknowledges their assignment agreement as part of project initiation. Ensure all terms in the agreement are reviewed before acknowledgment.\n\n **Token scopes**: `worker:write`", "operationId": "eor_acknowledgeAssignmentAgreement-v2026-01-01", "parameters": [ { "description": "The unique identifier of the EOR contract.", "in": "path", "name": "contract_id", "required": true, "schema": { "format": "uuid", "type": "string" } } ], "responses": { "204": { "content": { "application/json": { "schema": { "properties": {}, "type": "object" } } }, "description": "Acknowledged successfully." }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AcknowledgeAssignmentAgreement-v2026-01-01RequestBadRequestError" } } }, "description": "Invalid input or HrisProfile not found." }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContainer" } } }, "description": "Operation failed." }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContainer" } } }, "description": "Operation failed." }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AcknowledgeAssignmentAgreement-v2026-01-01RequestNotFoundError" } } }, "description": "Contract not found." }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContainer" } } }, "description": "Operation failed." } }, "security": [ { "deelToken": [] } ], "summary": "Acknowledge assignment agreement", "tags": [ "eor" ] } }, "/eor/workers/contracts/{contract_id}/signatures": { "post": { "description": "Signs a contract on behalf of the contractor, transitioning contract status to active and completing the contractor onboarding workflow.\n\n **Token scopes**: `worker:write`", "operationId": "eorWorkerAgreements_signEORContractAsWorker", "parameters": [ { "description": "The unique identifier of the employee contract.", "in": "path", "name": "contract_id", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "properties": { "data": { "$ref": "#/components/schemas/EorWorkersContractsContractIdSignaturesPostRequestBodyContentApplicationJsonSchemaData" } }, "type": "object" } } } }, "responses": { "201": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/eor-worker-agreements_signEORContractAsWorker_Response_201" } } }, "description": "Successful operation." }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContainer" } } }, "description": "Operation failed." }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContainer" } } }, "description": "Operation failed." }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContainer" } } }, "description": "Operation failed." }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContainer" } } }, "description": "Operation failed." }, "409": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SignAContract-v2026-01-01RequestConflictError" } } }, "description": "Employment Agreement version mismatch." }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContainer" } } }, "description": "Operation failed." } }, "security": [ { "deelToken": [] } ], "summary": "Sign a contract ", "tags": [ "eorWorkerAgreements" ] } }, "/eor/workers/resignations": { "get": { "description": "Returns resignations submitted by EOR workers, optionally filtered by resignation letter status.\n\n **Token scopes**: `worker:read`", "operationId": "eorWorkerOffboarding_getEmployeeResignations", "parameters": [ { "description": "Filter by resignation letter status", "in": "query", "name": "status", "required": false, "schema": { "$ref": "#/components/schemas/EorWorkersResignationsGetParametersStatus" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/eor-worker-offboarding_getEmployeeResignations_Response_200" } } }, "description": "Successful operation." }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RetrieveWorkerResignations-v2026-01-01RequestBadRequestError" } } }, "description": "Bad Request" }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RetrieveWorkerResignations-v2026-01-01RequestUnauthorizedError" } } }, "description": "Unauthorized" }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RetrieveWorkerResignations-v2026-01-01RequestForbiddenError" } } }, "description": "Forbidden" }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContainer" } } }, "description": "Operation failed." }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RetrieveWorkerResignations-v2026-01-01RequestInternalServerError" } } }, "description": "Internal Server Error" } }, "security": [ { "deelToken": [] } ], "summary": "Retrieve worker resignations", "tags": [ "eorWorkerOffboarding" ] } }, "/eor/workers/tax-documents": { "get": { "description": "Returns tax documents for the authenticated worker.\n\n **Token scopes**: `worker:read`", "operationId": "eorWorkerInformation_getEORWorkerTaxDocuments", "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/eor-worker-information_getEORWorkerTaxDocuments_Response_200" } } }, "description": "Tax documents successfully retrieved." }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContainer" } } }, "description": "Operation failed." }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContainer" } } }, "description": "Operation failed." }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContainer" } } }, "description": "Operation failed." }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContainer" } } }, "description": "Operation failed." }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContainer" } } }, "description": "Operation failed." } }, "security": [ { "deelToken": [] } ], "summary": "List of tax documents for an employee", "tags": [ "eorWorkerInformation" ] } }, "/eor/workers/{worker_id}/payslips": { "get": { "description": "Returns a list of payslip records for the specified worker.\n\n **Token scopes**: `payslips:read`", "operationId": "eorPayslips_getWorkerPayslips", "parameters": [ { "description": "The ID of the worker whose payslips are being retrieved.", "in": "path", "name": "worker_id", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/eor-payslips_getWorkerPayslips_Response_200" } } }, "description": "Payslip records successfully retrieved." }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContainer" } } }, "description": "Operation failed." }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContainer" } } }, "description": "Operation failed." }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContainer" } } }, "description": "Operation failed." } }, "security": [ { "deelToken": [] } ], "summary": "Retrieve employee payslip records", "tags": [ "eorPayslips" ] } }, "/eor/workers/{worker_id}/payslips/{payslip_id}/download": { "get": { "description": "Returns a URL for downloading the specified payslip as a PDF.\n\n **Token scopes**: `payslips:read`", "operationId": "eorWorkerPayslips_getWorkerPayslipsDownload", "parameters": [ { "description": "The ID of the worker whose payslip download link is being requested.", "in": "path", "name": "worker_id", "required": true, "schema": { "type": "string" } }, { "description": "The ID of the specific payslip to download.", "in": "path", "name": "payslip_id", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/eor-worker-payslips_getWorkerPayslipsDownload_Response_200" } } }, "description": "Successfully retrieved the payslip download link." }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContainer" } } }, "description": "Operation failed." }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContainer" } } }, "description": "Operation failed." }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContainer" } } }, "description": "Operation failed." } }, "security": [ { "deelToken": [] } ], "summary": "Retrieve payslip PDF download link", "tags": [ "eorWorkerPayslips" ] } }, "/eor/{contract_id}/benefits": { "get": { "description": "Returns the worker's EOR benefits enrolment details. For organisations set up as white-label with Deel, the response also includes a short-lived link to redirect the worker, who doesn't use the Deel app, to complete enrolment and manage their benefits. Call this endpoint again for a fresh link after it expires.\n\n **Token scopes**: `contracts:read`, `benefits:read`", "operationId": "eorBenefits_getEORBenefitsByContractId", "parameters": [ { "description": "Deel contract ID.", "in": "path", "name": "contract_id", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/eor-benefits_getEORBenefitsByContractId_Response_200" } } }, "description": "Successfully retrieved the list of EOR contract benefits." }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContainer" } } }, "description": "Operation failed." }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContainer" } } }, "description": "Operation failed." }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContainer" } } }, "description": "Operation failed." } }, "security": [ { "deelToken": [] } ], "summary": "Retrieve Benefits for EOR Contract", "tags": [ "eorBenefits" ] } }, "/eor/{oid}/terminations/regular": { "post": { "description": "Submits a termination request for an EOR contract on behalf of a team member. Callers must hold group admin or people manager permissions.\n\n **Token scopes**: `contracts:read`, `contracts:write`", "operationId": "eorTerminations_createRegularTermination", "parameters": [ { "description": "Public contract id", "in": "path", "name": "oid", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "properties": { "data": { "$ref": "#/components/schemas/EorOidTerminationsRegularPostRequestBodyContentApplicationJsonSchemaData" } }, "required": [ "data" ], "type": "object" } } } }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/eor-terminations_createRegularTermination_Response_200" } } }, "description": "Ok response" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContainer" } } }, "description": "Operation failed." }, "401": { "content": { "application/json": { "schema": { "items": { "$ref": "#/components/schemas/EorOidTerminationsRegularPostResponsesContentApplicationJsonSchemaItems" }, "type": "array" } } }, "description": "Unauthorized response" }, "403": { "content": { "application/json": { "schema": { "items": { "$ref": "#/components/schemas/EorOidTerminationsRegularPostResponsesContentApplicationJsonSchemaItems" }, "type": "array" } } }, "description": "Forbidden response" }, "404": { "content": { "application/json": { "schema": { "items": { "$ref": "#/components/schemas/EorOidTerminationsRegularPostResponsesContentApplicationJsonSchemaItems" }, "type": "array" } } }, "description": "Not Found response" }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContainer" } } }, "description": "Operation failed." } }, "security": [ { "deelToken": [] } ], "summary": "Termination Request", "tags": [ "eorTerminations" ] } }, "/eor/{oid}/terminations/resignation": { "post": { "description": "Submits a resignation request for an EOR contract on behalf of a team member. Callers must hold group admin or people manager permissions.\n\n **Token scopes**: `contracts:read`, `contracts:write`", "operationId": "eorTerminations_createResignation", "parameters": [ { "description": "Public contract oid", "in": "path", "name": "oid", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "properties": { "data": { "$ref": "#/components/schemas/EorOidTerminationsResignationPostRequestBodyContentApplicationJsonSchemaData" } }, "required": [ "data" ], "type": "object" } } } }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/eor-terminations_createResignation_Response_200" } } }, "description": "Ok response" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContainer" } } }, "description": "Operation failed." }, "401": { "content": { "application/json": { "schema": { "items": { "$ref": "#/components/schemas/EorOidTerminationsResignationPostResponsesContentApplicationJsonSchemaItems" }, "type": "array" } } }, "description": "Unauthorized response" }, "403": { "content": { "application/json": { "schema": { "items": { "$ref": "#/components/schemas/EorOidTerminationsResignationPostResponsesContentApplicationJsonSchemaItems" }, "type": "array" } } }, "description": "Forbidden response" }, "404": { "content": { "application/json": { "schema": { "items": { "$ref": "#/components/schemas/EorOidTerminationsResignationPostResponsesContentApplicationJsonSchemaItems" }, "type": "array" } } }, "description": "Not Found response" }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContainer" } } }, "description": "Operation failed." } }, "security": [ { "deelToken": [] } ], "summary": "Request EOR Contract Resignation", "tags": [ "eorTerminations" ] } }, "/eor/{oid}/terminations/{terminationId}": { "get": { "description": "Returns termination data for the specified contract and termination record. Requires viewer permissions.\n\n **Token scopes**: `contracts:read`", "operationId": "eorTerminations_getTermination", "parameters": [ { "description": "Public contract oid", "in": "path", "name": "oid", "required": true, "schema": { "type": "string" } }, { "description": "Termination id", "in": "path", "name": "terminationId", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/eor-terminations_getTermination_Response_200" } } }, "description": "Ok response" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContainer" } } }, "description": "Operation failed." }, "401": { "content": { "application/json": { "schema": { "items": { "$ref": "#/components/schemas/EorOidTerminationsTerminationIdGetResponsesContentApplicationJsonSchemaItems" }, "type": "array" } } }, "description": "Unauthorized response" }, "403": { "content": { "application/json": { "schema": { "items": { "$ref": "#/components/schemas/EorOidTerminationsTerminationIdGetResponsesContentApplicationJsonSchemaItems" }, "type": "array" } } }, "description": "Forbidden response" }, "404": { "content": { "application/json": { "schema": { "items": { "$ref": "#/components/schemas/EorOidTerminationsTerminationIdGetResponsesContentApplicationJsonSchemaItems" }, "type": "array" } } }, "description": "Not Found response" }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContainer" } } }, "description": "Operation failed." } }, "security": [ { "deelToken": [] } ], "summary": "Get termination", "tags": [ "eorTerminations" ] } }, "/equities-tokens/tax-events": { "post": { "description": "Submits an equity or token tax event for an EOR worker enrolled in Equity & Token Services.\n\n **Token scopes**: `equities:write`", "operationId": "equityTokens_createEquityOrTokenTaxEvent-v2026-01-01", "requestBody": { "content": { "application/json": { "schema": { "properties": { "data": { "$ref": "#/components/schemas/EquitiesTokensTaxEventsPostRequestBodyContentApplicationJsonSchemaData" } }, "type": "object" } } } }, "responses": { "201": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Equity_Tokens_createEquityOrTokenTaxEvent-v2026-01-01_Response_201" } } }, "description": "Successful operation." }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreateEquityOrTokenTaxEvent-v2026-01-01RequestBadRequestError" } } }, "description": "Bad request" }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContainer" } } }, "description": "Operation failed." }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContainer" } } }, "description": "Operation failed." }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContainer" } } }, "description": "Operation failed." }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContainer" } } }, "description": "Operation failed." } }, "security": [ { "deelToken": [] } ], "summary": "Create equity or token tax event", "tags": [ "equityTokens" ] } }, "/equity-amortizations": { "get": { "description": "Retrieves the period-by-period amortization of share-based compensation expense per equity grant in an organization, as ingested from Shareworks. Use it to build an expense recognition schedule, or to forecast the expense still to be accrued on outstanding grants. Each record reflects the most recently ingested reporting period; earlier periods are overwritten, so this is not a period history. Requires the `equities.view` permission at the organization level.\n\n **Token scopes**: `equities:read`", "operationId": "equityTokens_listEquityAmortizations-v2026-09-09", "parameters": [ { "description": "Maximum number of records to return in this page.", "in": "query", "name": "limit", "required": false, "schema": { "default": 50, "maximum": 100, "minimum": 1, "type": "integer" } }, { "description": "Opaque pagination cursor returned as next_cursor by a previous response. Omit to fetch the first page.", "in": "query", "name": "cursor", "required": false, "schema": { "maxLength": 2048, "type": "string" } }, { "description": "Only return records for this exact Shareworks employee number.", "in": "query", "name": "employee_number", "required": false, "schema": { "maxLength": 64, "type": "string" } }, { "description": "Only return records for this exact Shareworks grant number.", "in": "query", "name": "employee_grant_number", "required": false, "schema": { "maxLength": 100, "type": "string" } }, { "description": "Only return records with a grant_date on or after this date (inclusive), in YYYY-MM-DD format.", "in": "query", "name": "grant_date_from", "required": false, "schema": { "format": "date", "type": "string" } }, { "description": "Only return records with a grant_date on or before this date (inclusive), in YYYY-MM-DD format.", "in": "query", "name": "grant_date_to", "required": false, "schema": { "format": "date", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Equity_Tokens_listEquityAmortizations-v2026-09-09_Response_200" } } }, "description": "List equity grant expense amortization records returned successfully." }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ListEquityAmortizations-v2026-09-09RequestBadRequestError" } } }, "description": "Bad request — invalid or missing parameters." }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ListEquityAmortizations-v2026-09-09RequestUnauthorizedError" } } }, "description": "Unauthorized — missing or invalid authentication token." }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ListEquityAmortizations-v2026-09-09RequestForbiddenError" } } }, "description": "Forbidden — caller lacks the equities.view permission, or the caller's organization is not permitted to access this endpoint." }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ListEquityAmortizations-v2026-09-09RequestNotFoundError" } } }, "description": "Not found — the requested resource does not exist." }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ListEquityAmortizations-v2026-09-09RequestInternalServerError" } } }, "description": "Internal server error." } }, "security": [ { "deelToken": [] } ], "summary": "List equity grant expense amortization records", "tags": [ "equityTokens" ] } }, "/equity-awards": { "get": { "description": "Retrieves the equity awards an organization has granted, as ingested from Shareworks, in ascending employee_number order. Use it to reconcile what was granted to whom, with the grant quantity, price and fair market value at the grant date. This dataset identifies a grant by name and date rather than by grant number, so several records can share one employee and grant name; occurrence_index separates them. Requires the `equities.view` permission at the organization level.\n\n **Token scopes**: `equities:read`", "operationId": "equityTokens_listEquityAwards-v2026-09-09", "parameters": [ { "description": "Maximum number of records to return in this page.", "in": "query", "name": "limit", "required": false, "schema": { "default": 50, "maximum": 100, "minimum": 1, "type": "integer" } }, { "description": "Opaque pagination cursor returned as next_cursor by a previous response. Omit to fetch the first page.", "in": "query", "name": "cursor", "required": false, "schema": { "maxLength": 2048, "type": "string" } }, { "description": "Only return records for this exact Shareworks employee number.", "in": "query", "name": "employee_number", "required": false, "schema": { "maxLength": 64, "type": "string" } }, { "description": "Only return records with a grant_date on or after this date (inclusive), in YYYY-MM-DD format.", "in": "query", "name": "grant_date_from", "required": false, "schema": { "format": "date", "type": "string" } }, { "description": "Only return records with a grant_date on or before this date (inclusive), in YYYY-MM-DD format.", "in": "query", "name": "grant_date_to", "required": false, "schema": { "format": "date", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Equity_Tokens_listEquityAwards-v2026-09-09_Response_200" } } }, "description": "List equity awards granted returned successfully." }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ListEquityAwards-v2026-09-09RequestBadRequestError" } } }, "description": "Bad request — invalid or missing parameters." }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ListEquityAwards-v2026-09-09RequestUnauthorizedError" } } }, "description": "Unauthorized — missing or invalid authentication token." }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ListEquityAwards-v2026-09-09RequestForbiddenError" } } }, "description": "Forbidden — caller lacks the equities.view permission, or the caller's organization is not permitted to access this endpoint." }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ListEquityAwards-v2026-09-09RequestNotFoundError" } } }, "description": "Not found — the requested resource does not exist." }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ListEquityAwards-v2026-09-09RequestInternalServerError" } } }, "description": "Internal server error." } }, "security": [ { "deelToken": [] } ], "summary": "List equity awards granted", "tags": [ "equityTokens" ] } }, "/equity-exercises": { "get": { "description": "Retrieves the equity exercises recorded for an organization, as ingested from Shareworks, in ascending exercise_date order. Use it to report realised option gains into payroll and tax withholding, or to reconcile exercise activity against a cap table. Each record carries the shares exercised, the strike price paid and the fair market value at exercise, so the gain can be recomputed rather than taken on trust. Requires the `equities.view` permission at the organization level.\n\n **Token scopes**: `equities:read`", "operationId": "equityTokens_listEquityShareworksExercises-v2026-09-09", "parameters": [ { "description": "Maximum number of exercise records to return in this page.", "in": "query", "name": "limit", "required": false, "schema": { "default": 50, "maximum": 100, "minimum": 1, "type": "integer" } }, { "description": "Opaque pagination cursor returned as next_cursor by a previous response. Omit to fetch the first page.", "in": "query", "name": "cursor", "required": false, "schema": { "maxLength": 2048, "type": "string" } }, { "description": "Only return exercises with an exercise_date on or after this date (inclusive), in YYYY-MM-DD format.", "in": "query", "name": "exercise_date_from", "required": false, "schema": { "format": "date", "type": "string" } }, { "description": "Only return exercises with an exercise_date on or before this date (inclusive), in YYYY-MM-DD format.", "in": "query", "name": "exercise_date_to", "required": false, "schema": { "format": "date", "type": "string" } }, { "description": "Only return exercises for this exact Shareworks employee number.", "in": "query", "name": "employee_number", "required": false, "schema": { "maxLength": 64, "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Equity_Tokens_listEquityShareworksExercises-v2026-09-09_Response_200" } } }, "description": "Shareworks equity exercises returned successfully." }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ListEquityShareworksExercises-v2026-09-09RequestBadRequestError" } } }, "description": "Bad request — invalid or missing parameters." }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ListEquityShareworksExercises-v2026-09-09RequestUnauthorizedError" } } }, "description": "Unauthorized — missing or invalid authentication token." }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ListEquityShareworksExercises-v2026-09-09RequestForbiddenError" } } }, "description": "Forbidden — caller lacks the equities.view permission, or the caller's organization is not permitted to access this endpoint." }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContainer" } } }, "description": "Operation failed." }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContainer" } } }, "description": "Operation failed." } }, "security": [ { "deelToken": [] } ], "summary": "List Shareworks equity exercises", "tags": [ "equityTokens" ] } }, "/equity-expenses": { "get": { "description": "Retrieves the total share-based compensation expense recognised per equity grant in an organization, as ingested from Shareworks. Use it at period close to tie the equity expense in the ledger back to the individual grants that produced it. Each record reflects the most recently ingested reporting period; earlier periods are overwritten, so this is not a period history. Requires the `equities.view` permission at the organization level.\n\n **Token scopes**: `equities:read`", "operationId": "equityTokens_listEquityExpenses-v2026-09-09", "parameters": [ { "description": "Maximum number of records to return in this page.", "in": "query", "name": "limit", "required": false, "schema": { "default": 50, "maximum": 100, "minimum": 1, "type": "integer" } }, { "description": "Opaque pagination cursor returned as next_cursor by a previous response. Omit to fetch the first page.", "in": "query", "name": "cursor", "required": false, "schema": { "maxLength": 2048, "type": "string" } }, { "description": "Only return records for this exact Shareworks employee number.", "in": "query", "name": "employee_number", "required": false, "schema": { "maxLength": 64, "type": "string" } }, { "description": "Only return records for this exact Shareworks grant number.", "in": "query", "name": "employee_grant_number", "required": false, "schema": { "maxLength": 100, "type": "string" } }, { "description": "Only return records with a grant_date on or after this date (inclusive), in YYYY-MM-DD format.", "in": "query", "name": "grant_date_from", "required": false, "schema": { "format": "date", "type": "string" } }, { "description": "Only return records with a grant_date on or before this date (inclusive), in YYYY-MM-DD format.", "in": "query", "name": "grant_date_to", "required": false, "schema": { "format": "date", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Equity_Tokens_listEquityExpenses-v2026-09-09_Response_200" } } }, "description": "List equity grant total expense records returned successfully." }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ListEquityExpenses-v2026-09-09RequestBadRequestError" } } }, "description": "Bad request — invalid or missing parameters." }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ListEquityExpenses-v2026-09-09RequestUnauthorizedError" } } }, "description": "Unauthorized — missing or invalid authentication token." }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ListEquityExpenses-v2026-09-09RequestForbiddenError" } } }, "description": "Forbidden — caller lacks the equities.view permission, or the caller's organization is not permitted to access this endpoint." }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ListEquityExpenses-v2026-09-09RequestNotFoundError" } } }, "description": "Not found — the requested resource does not exist." }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ListEquityExpenses-v2026-09-09RequestInternalServerError" } } }, "description": "Internal server error." } }, "security": [ { "deelToken": [] } ], "summary": "List equity grant total expense records", "tags": [ "equityTokens" ] } }, "/equity-grants": { "get": { "description": "Retrieves the equity grants for an organization, each including its vesting events and associated tax events. Requires the `equities.view` permission at the organization level.\n\n **Token scopes**: `equities:read`", "operationId": "equityTokens_listEquityGrantsWithTaxEvents-v2026-08-10", "parameters": [ { "description": "Maximum number of grants to return", "in": "query", "name": "limit", "required": false, "schema": { "default": 100, "maximum": 100, "minimum": 1, "type": "integer" } }, { "description": "Number of grants to skip before starting to return results", "in": "query", "name": "offset", "required": false, "schema": { "default": 0, "minimum": 0, "type": "integer" } }, { "description": "Free-text search across grant/worker name and email", "in": "query", "name": "search", "required": false, "schema": { "maxLength": 255, "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Equity_Tokens_listEquityGrantsWithTaxEvents-v2026-08-10_Response_200" } } }, "description": "A paginated list of equity grants, each including its vesting events and associated tax events." }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ListEquityGrantsWithTaxEvents-v2026-08-10RequestBadRequestError" } } }, "description": "One or more query parameters are invalid. See the errors array for detail." }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContainer" } } }, "description": "Operation failed." }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ListEquityGrantsWithTaxEvents-v2026-08-10RequestForbiddenError" } } }, "description": "The token does not grant `equities.view` at the organization level." }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContainer" } } }, "description": "Operation failed." }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContainer" } } }, "description": "Operation failed." } }, "security": [ { "deelToken": [] } ], "summary": "List equity grants with tax events", "tags": [ "equityTokens" ] } }, "/equity-option-ledger": { "get": { "description": "Retrieves the full option holder ledger for an organization, as ingested from Shareworks, in ascending employee_grant_number order. Use it as the per-grant system of record: it carries the vested, unvested, exercised, cancelled, expired and outstanding share counts for every grant, plus grant agreement and disqualification dates. Records carry direct identifiers, including a tax identifier and a home address. Requires the `equities.view` permission at the organization level.\n\n **Token scopes**: `equities:read`", "operationId": "equityTokens_listEquityOptionLedgerEntries-v2026-09-09", "parameters": [ { "description": "Maximum number of records to return in this page.", "in": "query", "name": "limit", "required": false, "schema": { "default": 50, "maximum": 100, "minimum": 1, "type": "integer" } }, { "description": "Opaque pagination cursor returned as next_cursor by a previous response. Omit to fetch the first page.", "in": "query", "name": "cursor", "required": false, "schema": { "maxLength": 2048, "type": "string" } }, { "description": "Only return records for this exact Shareworks employee number.", "in": "query", "name": "employee_number", "required": false, "schema": { "maxLength": 64, "type": "string" } }, { "description": "Only return records for this exact Shareworks grant number.", "in": "query", "name": "employee_grant_number", "required": false, "schema": { "maxLength": 100, "type": "string" } }, { "description": "Only return records with a grant_date on or after this date (inclusive), in YYYY-MM-DD format.", "in": "query", "name": "grant_date_from", "required": false, "schema": { "format": "date", "type": "string" } }, { "description": "Only return records with a grant_date on or before this date (inclusive), in YYYY-MM-DD format.", "in": "query", "name": "grant_date_to", "required": false, "schema": { "format": "date", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Equity_Tokens_listEquityOptionLedgerEntries-v2026-09-09_Response_200" } } }, "description": "List equity option ledger entries returned successfully." }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ListEquityOptionLedgerEntries-v2026-09-09RequestBadRequestError" } } }, "description": "Bad request — invalid or missing parameters." }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ListEquityOptionLedgerEntries-v2026-09-09RequestUnauthorizedError" } } }, "description": "Unauthorized — missing or invalid authentication token." }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ListEquityOptionLedgerEntries-v2026-09-09RequestForbiddenError" } } }, "description": "Forbidden — caller lacks the equities.view permission, or the caller's organization is not permitted to access this endpoint." }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ListEquityOptionLedgerEntries-v2026-09-09RequestNotFoundError" } } }, "description": "Not found — the requested resource does not exist." }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ListEquityOptionLedgerEntries-v2026-09-09RequestInternalServerError" } } }, "description": "Internal server error." } }, "security": [ { "deelToken": [] } ], "summary": "List equity option ledger entries", "tags": [ "equityTokens" ] } }, "/equity-participants": { "get": { "description": "Retrieves the people who hold equity in an organization, as ingested from Shareworks, in ascending employee_number order. Use it to reconcile equity participants against HRIS records, or to feed worker identity and residence data into equity tax calculations. Records carry direct identifiers, including a full Social Security Number where the source reports one. Requires the `equities.view` permission at the organization level.\n\n **Token scopes**: `equities:read`", "operationId": "equityTokens_listEquityParticipants-v2026-09-08", "parameters": [ { "description": "Maximum number of records to return in this page.", "in": "query", "name": "limit", "required": false, "schema": { "default": 50, "maximum": 100, "minimum": 1, "type": "integer" } }, { "description": "Opaque pagination cursor returned as next_cursor by a previous response. Omit to fetch the first page.", "in": "query", "name": "cursor", "required": false, "schema": { "maxLength": 2048, "type": "string" } }, { "description": "Only return records for this exact Shareworks employee number.", "in": "query", "name": "employee_number", "required": false, "schema": { "maxLength": 64, "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Equity_Tokens_listEquityParticipants-v2026-09-08_Response_200" } } }, "description": "List equity participants returned successfully." }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ListEquityParticipants-v2026-09-08RequestBadRequestError" } } }, "description": "Bad request — invalid or missing parameters." }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ListEquityParticipants-v2026-09-08RequestUnauthorizedError" } } }, "description": "Unauthorized — missing or invalid authentication token." }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ListEquityParticipants-v2026-09-08RequestForbiddenError" } } }, "description": "Forbidden — caller lacks the equities.view permission, or the caller's organization is not permitted to access this endpoint." }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ListEquityParticipants-v2026-09-08RequestNotFoundError" } } }, "description": "Not found — the requested resource does not exist." }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ListEquityParticipants-v2026-09-08RequestInternalServerError" } } }, "description": "Internal server error." } }, "security": [ { "deelToken": [] } ], "summary": "List equity participants", "tags": [ "equityTokens" ] } }, "/equity-valuations": { "get": { "description": "Retrieves the expense valuation inputs for each equity grant in an organization, as ingested from Shareworks, in ascending employee_grant_number order. Use it to reproduce or audit a grant expense figure: it carries the valuation model, amortization method, fair value per share, forfeiture rate, and the volatility, expected life, risk-free rate and dividend yield assumptions behind them. Requires the `equities.view` permission at the organization level.\n\n **Token scopes**: `equities:read`", "operationId": "equityTokens_listEquityValuations-v2026-09-09", "parameters": [ { "description": "Maximum number of records to return in this page.", "in": "query", "name": "limit", "required": false, "schema": { "default": 50, "maximum": 100, "minimum": 1, "type": "integer" } }, { "description": "Opaque pagination cursor returned as next_cursor by a previous response. Omit to fetch the first page.", "in": "query", "name": "cursor", "required": false, "schema": { "maxLength": 2048, "type": "string" } }, { "description": "Only return records for this exact Shareworks grant number.", "in": "query", "name": "employee_grant_number", "required": false, "schema": { "maxLength": 100, "type": "string" } }, { "description": "Only return records with a grant_date on or after this date (inclusive), in YYYY-MM-DD format.", "in": "query", "name": "grant_date_from", "required": false, "schema": { "format": "date", "type": "string" } }, { "description": "Only return records with a grant_date on or before this date (inclusive), in YYYY-MM-DD format.", "in": "query", "name": "grant_date_to", "required": false, "schema": { "format": "date", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Equity_Tokens_listEquityValuations-v2026-09-09_Response_200" } } }, "description": "List equity grant valuations returned successfully." }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ListEquityValuations-v2026-09-09RequestBadRequestError" } } }, "description": "Bad request — invalid or missing parameters." }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ListEquityValuations-v2026-09-09RequestUnauthorizedError" } } }, "description": "Unauthorized — missing or invalid authentication token." }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ListEquityValuations-v2026-09-09RequestForbiddenError" } } }, "description": "Forbidden — caller lacks the equities.view permission, or the caller's organization is not permitted to access this endpoint." }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ListEquityValuations-v2026-09-09RequestNotFoundError" } } }, "description": "Not found — the requested resource does not exist." }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ListEquityValuations-v2026-09-09RequestInternalServerError" } } }, "description": "Internal server error." } }, "security": [ { "deelToken": [] } ], "summary": "List equity grant valuations", "tags": [ "equityTokens" ] } }, "/equity/exercise": { "post": { "description": "Submits a new equity exercise request, associating the specified option grant and stakeholder details with a worker. The request is created in a pending state; employer approval is handled as a separate operation.\n\n **Token scopes**: `contracts:write`", "operationId": "contracts_createARequestToExerciseEquity-v2026-01-01", "requestBody": { "content": { "application/json": { "schema": { "properties": { "address_city": { "description": "The city of the address.", "type": "string" }, "address_country": { "description": "The country of the address.", "type": "string" }, "address_state": { "description": "The state of the address.", "type": "string" }, "address_street": { "description": "The street of the address.", "type": "string" }, "address_zip": { "description": "The zip code of the address.", "type": "string" }, "exercise_id": { "description": "The unique identifier of the exercise.", "format": "uuid", "type": "string" }, "fmv": { "description": "The fair market value of the equity.", "type": "string" }, "fmv_currency_code": { "description": "The currency code of the fair market value (ISO 4217).", "type": "string" }, "issuer_id": { "description": "The unique identifier of the issuer.", "type": "string" }, "option_grant_currency": { "description": "The currency of the option grant (ISO 4217).", "type": "string" }, "option_grant_expiry_date": { "description": "The expiry date of the option grant (ISO 8601 date).", "format": "date", "type": "string" }, "option_grant_id": { "description": "The numeric identifier of the option grant. Must contain only digits.", "type": "string" }, "option_grant_issue": { "description": "The issue of the option grant.", "type": "string" }, "option_grant_issue_date": { "description": "The issue date of the option grant (ISO 8601 date).", "format": "date", "type": "string" }, "option_grant_label": { "description": "The label of the option grant.", "type": "string" }, "option_grant_strike_price": { "description": "The strike price of the option grant.", "type": "string" }, "quantity": { "description": "The quantity of equity to exercise. Must be a positive number.", "format": "double", "type": "number" }, "stakeholder_email": { "description": "The email address of the stakeholder.", "format": "email", "type": "string" }, "stakeholder_id": { "description": "The unique identifier of the stakeholder.", "type": "string" }, "stakeholder_relationship": { "description": "The relationship of the stakeholder.", "type": "string" }, "worker_id": { "description": "The public UUID of the worker. Must correspond to an existing worker in the system.", "type": "string" } }, "required": [ "fmv", "quantity", "issuer_id", "worker_id", "address_zip", "exercise_id", "address_city", "address_state", "address_street", "stakeholder_id", "address_country", "option_grant_id", "fmv_currency_code", "stakeholder_email", "option_grant_issue", "option_grant_label", "option_grant_currency", "option_grant_issue_date", "option_grant_expiry_date", "stakeholder_relationship", "option_grant_strike_price" ], "type": "object" } } } }, "responses": { "201": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Contracts_createARequestToExerciseEquity-v2026-01-01_Response_201" } } }, "description": "Equity exercise request created successfully." }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreateARequestToExerciseEquity-v2026-01-01RequestBadRequestError" } } }, "description": "Request validation failed. A required field is missing, has an invalid format, or the worker is not eligible for equity exercise." }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreateARequestToExerciseEquity-v2026-01-01RequestUnauthorizedError" } } }, "description": "Authentication failed. The access token is missing, expired, or invalid." }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreateARequestToExerciseEquity-v2026-01-01RequestForbiddenError" } } }, "description": "Access denied. The authenticated user does not have the required contracts:write scope." }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreateARequestToExerciseEquity-v2026-01-01RequestNotFoundError" } } }, "description": "The worker profile associated with the given worker_id was not found." }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreateARequestToExerciseEquity-v2026-01-01RequestUnprocessableEntityError" } } }, "description": "A request with the same exercise_id already exists. Each exercise_id can only be used once." }, "429": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreateARequestToExerciseEquity-v2026-01-01RequestTooManyRequestsError" } } }, "description": "Rate limit exceeded." }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreateARequestToExerciseEquity-v2026-01-01RequestInternalServerError" } } }, "description": "Internal server error. Possible causes include missing EOR contract for the worker, FX rate service failure, or database errors." } }, "security": [ { "deelToken": [] } ], "summary": "Create a request to exercise equity.", "tags": [ "contracts" ] } }, "/equity/exercise/{public_id}": { "patch": { "description": "Updates the employer approval status for a pending equity exercise. This is a partial update — only `employer_approval` is accepted in the request body.\n\n **Token scopes**: `contracts:write`", "operationId": "contracts_approveAnEquityExercise-v2026-01-01", "parameters": [ { "description": "Equity exercise public ID.", "in": "path", "name": "public_id", "required": true, "schema": { "format": "uuid", "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "properties": { "employer_approval": { "description": "Approval decision by the employer for the equity exercise. Valid values: 'approved', 'rejected'.", "type": "string" } }, "required": [ "employer_approval" ], "type": "object" } } } }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Contracts_approveAnEquityExercise-v2026-01-01_Response_200" } } }, "description": "Successful operation" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContainer" } } }, "description": "Operation failed." }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApproveAnEquityExercise-v2026-01-01RequestUnauthorizedError" } } }, "description": "Authentication failed. The access token is missing, expired, or invalid." }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApproveAnEquityExercise-v2026-01-01RequestForbiddenError" } } }, "description": "Access denied. The authenticated user does not have the required contracts:write scope." }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApproveAnEquityExercise-v2026-01-01RequestNotFoundError" } } }, "description": "Resource not found. The equity exercise request does not exist, is not in the required status (APPROVED_BY_EMPLOYEE), or its associated worker profile was not found." }, "429": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApproveAnEquityExercise-v2026-01-01RequestTooManyRequestsError" } } }, "description": "Rate limit exceeded." }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApproveAnEquityExercise-v2026-01-01RequestInternalServerError" } } }, "description": "Internal server error. Occurs when an unexpected failure happens during approval processing (e.g., funding task creation failure). The exercise request status may be set to ERROR." } }, "security": [ { "deelToken": [] } ], "summary": "Approve an equity exercise", "tags": [ "contracts" ] } }, "/escalations/workers/me/hrx": { "get": { "description": "Retrieves the Human Resource Experience (HRX) Manager assigned to the authenticated worker, including contact details and a scheduling URL. Accessible only to workers with the appropriate permissions.\n\n **Token scopes**: `worker:read`", "operationId": "workerHr_getHrxManagerForWorker-v2026-01-01", "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Worker_HR_getHrxManagerForWorker-v2026-01-01_Response_200" } } }, "description": "Successful operation. Returns HRX representative information for the worker based on their country." }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContainer" } } }, "description": "Operation failed." }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContainer" } } }, "description": "Operation failed." }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetHrxManagerForWorker-v2026-01-01RequestForbiddenError" } } }, "description": "Forbidden - user is not authorized to access this resource. Only employees can access HRX information." }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetHrxManagerForWorker-v2026-01-01RequestNotFoundError" } } }, "description": "Not Found - There is no assignment of HRX Manager against this worker" }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetHrxManagerForWorker-v2026-01-01RequestInternalServerError" } } }, "description": "Internal server error - unexpected error occurred while processing the request." } }, "security": [ { "deelToken": [] } ], "summary": "Get HRX manager for worker", "tags": [ "workerHr" ] } }, "/files": { "post": { "description": "Register an upload and receive presigned S3 upload target(s) plus a file handle (file_id and one_time_secret). Use the returned upload target(s) to send the file directly, then pass the file handle to domain endpoints to claim ownership once the upload completes.\n\n **Token scopes**: `files:write`, `worker:write`", "operationId": "files_registerFileUpload-v2026-08-05", "parameters": [ { "description": "Declares the client is multipart-capable. The server returns a multipart response only when the declared size exceeds the configured multipart threshold (`MULTIPART_THRESHOLD`); otherwise the standard POST form.", "in": "header", "name": "x-upload-method", "required": false, "schema": { "$ref": "#/components/schemas/FilesPostParametersXUploadMethod" } } ], "requestBody": { "content": { "application/json": { "schema": { "properties": { "data": { "$ref": "#/components/schemas/FilesPostRequestBodyContentApplicationJsonSchemaData" } }, "required": [ "data" ], "type": "object" } } }, "description": "Upload registration parameters" }, "responses": { "201": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Files_registerFileUpload-v2026-08-05_Response_201" } } }, "description": "Upload registered successfully with presigned S3 upload target(s)" }, "400": { "content": { "application/json": { "schema": { "description": "Any type" } } }, "description": "Invalid input parameters" }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContainer" } } }, "description": "Operation failed." }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContainer" } } }, "description": "Operation failed." }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContainer" } } }, "description": "Operation failed." }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContainer" } } }, "description": "Operation failed." } }, "security": [ { "deelToken": [] } ], "summary": "Create a file upload", "tags": [ "files" ] } }, "/files/{fileid}/complete": { "post": { "description": "Finalize an S3 multipart upload started via POST /rest/files, after all parts have been uploaded.\n\n **Token scopes**: `files:write`, `worker:write`", "operationId": "files_completeFileUpload-v2026-08-05", "parameters": [ { "description": "File UUID from the register response.", "in": "path", "name": "fileid", "required": true, "schema": { "format": "uuid", "type": "string" } }, { "description": "One-time secret from the register response.", "in": "header", "name": "x-one-time-secret", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "properties": { "data": { "$ref": "#/components/schemas/FilesFileidCompletePostRequestBodyContentApplicationJsonSchemaData" } }, "required": [ "data" ], "type": "object" } } } }, "responses": { "204": { "content": { "application/json": { "schema": { "properties": {}, "type": "object" } } }, "description": "Multipart upload completed successfully" }, "400": { "content": { "application/json": { "schema": { "description": "Any type" } } }, "description": "Missing x-one-time-secret header or invalid body" }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContainer" } } }, "description": "Operation failed." }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContainer" } } }, "description": "Operation failed." }, "404": { "content": { "application/json": { "schema": { "description": "Any type" } } }, "description": "File not found or invalid one-time secret" }, "422": { "content": { "application/json": { "schema": { "description": "Any type" } } }, "description": "File is not in PENDING state or missing upload location" }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContainer" } } }, "description": "Operation failed." } }, "security": [ { "deelToken": [] } ], "summary": "Complete a multipart upload", "tags": [ "files" ] } }, "/files/{fileid}/status": { "get": { "description": "Poll the status of a file registered via the upload endpoint. Call this after uploading to check whether the file has cleared virus scanning: pending means the scan is still running, ready means it can be claimed, and failed means the upload was rejected.\n\n **Token scopes**: `files:read`, `worker:read`", "operationId": "files_getFileUploadStatus-v2026-08-05", "parameters": [ { "description": "File UUID from the register response.", "in": "path", "name": "fileid", "required": true, "schema": { "format": "uuid", "type": "string" } }, { "description": "One-time secret from the register response.", "in": "header", "name": "x-one-time-secret", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Files_getFileUploadStatus-v2026-08-05_Response_200" } } }, "description": "Current upload status" }, "400": { "content": { "application/json": { "schema": { "description": "Any type" } } }, "description": "Missing x-one-time-secret header" }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContainer" } } }, "description": "Operation failed." }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContainer" } } }, "description": "Operation failed." }, "404": { "content": { "application/json": { "schema": { "description": "Any type" } } }, "description": "File not found or invalid one-time secret" }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContainer" } } }, "description": "Operation failed." } }, "security": [ { "deelToken": [] } ], "summary": "Check file upload status", "tags": [ "files" ] } }, "/forms/eor/create-contract/definitions": { "post": { "description": "Retrieves paginated, versioned form definitions for creating EOR contracts across one or more specified countries. Always use the latest effective version from the response and handle pagination; this endpoint is not intended for reading or updating existing contracts.\n\n **Token scopes**: `forms:read`", "operationId": "forms_fetchMultipleEorContractForms-v2026-01-01", "parameters": [ { "description": "Maximum number of countries to return in a single response. Defaults to 10.", "in": "query", "name": "limit", "required": false, "schema": { "default": 10, "maximum": 10, "minimum": 1, "type": "integer" } }, { "description": "Pagination cursor for fetching subsequent pages of results.", "in": "query", "name": "cursor", "required": false, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "properties": { "data": { "$ref": "#/components/schemas/FormsEorCreateContractDefinitionsPostRequestBodyContentApplicationJsonSchemaData" } }, "required": [ "data" ], "type": "object" } } }, "description": "Request body containing countries and optional parameters for bulk quote form fetching." }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Forms_fetchMultipleEorContractForms-v2026-01-01_Response_200" } } }, "description": "Successful response containing multiple form configuration data." }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FetchMultipleEorContractForms-v2026-01-01RequestBadRequestError" } } }, "description": "Operation failed." }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContainer" } } }, "description": "Operation failed." }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContainer" } } }, "description": "Operation failed." }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContainer" } } }, "description": "Operation failed." }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FetchMultipleEorContractForms-v2026-01-01RequestInternalServerError" } } }, "description": "Operation failed." } }, "security": [ { "deelToken": [] } ], "summary": "Fetch multiple EOR Contract forms", "tags": [ "forms" ] } }, "/forms/eor/create-contract/{country_code}": { "get": { "description": "Returns the country-specific form definition for creating an EOR contract, including its fields, validation rules, and conditional logic, which vary because employment requirements differ by country. Supply the optional `state` parameter for countries that require a province/state to be specified.\n\n **Token scopes**: `forms:read`", "operationId": "eorHiring_getCreateContractForm", "parameters": [ { "description": "Two-letter country code in ISO 3166-1 alpha-2 format", "in": "path", "name": "country_code", "required": true, "schema": { "maxLength": 2, "minLength": 2, "pattern": "^[A-Z]{2}$", "type": "string" } }, { "description": "The selected state code of the contract. This is only required for countries that specify it.", "in": "query", "name": "state", "required": false, "schema": { "type": "string" } }, { "description": "The selected start date of the contract in ISO 8601 formatted date string.", "in": "query", "name": "start_date", "required": false, "schema": { "format": "date", "type": "string" } }, { "description": "The selected number of work hours per week.", "in": "query", "name": "work_hours_per_week", "required": false, "schema": { "maximum": 168, "minimum": 1, "type": "integer" } }, { "description": "The contract duration in days for definite contracts.", "in": "query", "name": "contract_duration_in_days", "required": false, "schema": { "minimum": 1, "type": "integer" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/eor-hiring_getCreateContractForm_Response_200" } } }, "description": "Successful response containing form configuration data." }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FetchEorContractForm-v2026-01-01RequestBadRequestError" } } }, "description": "Operation failed." }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContainer" } } }, "description": "Operation failed." }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContainer" } } }, "description": "Operation failed." }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FetchEorContractForm-v2026-01-01RequestNotFoundError" } } }, "description": "Country not found or EOR not available in the requested country." }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FetchEorContractForm-v2026-01-01RequestInternalServerError" } } }, "description": "Internal server error." } }, "security": [ { "deelToken": [] } ], "summary": "Fetch EOR Contract form", "tags": [ "eorHiring" ] } }, "/forms/eor/worker-additional-fields/{country_code}": { "get": { "description": "Retrieves the additional form fields required when onboarding EOR workers in the specified country.\n\n **Token scopes**: `forms:read`", "operationId": "forms_getWorkerAdditionalFieldsForEor-v2026-01-01", "parameters": [ { "description": "Country code", "in": "path", "name": "country_code", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Forms_getWorkerAdditionalFieldsForEor-v2026-01-01_Response_200" } } }, "description": "Successful operation." }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetWorkerAdditionalFieldsForEor-v2026-01-01RequestBadRequestError" } } }, "description": "Operation failed." }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContainer" } } }, "description": "Operation failed." }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContainer" } } }, "description": "Operation failed." }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContainer" } } }, "description": "Operation failed." }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetWorkerAdditionalFieldsForEor-v2026-01-01RequestInternalServerError" } } }, "description": "Operation failed." } }, "security": [ { "deelToken": [] } ], "summary": "Get worker additional fields for (EOR)", "tags": [ "forms" ] } }, "/forms/gp/worker-additional-fields/{country_code}": { "get": { "description": "Retrieves the country-specific additional fields a Global Payroll worker must provide to stay compliant with local regulations. Call this before creating a GP contract or submitting worker additional information via POST or PATCH `/gp/workers/contracts/{contract_id}/additional-information`, so you know which fields to include and whether each is required.\n\n **Token scopes**: `forms:read`", "operationId": "globalPayroll_retrieveAdditionalInformationFieldsForGpWorkersByCountry-v2026-01-01", "parameters": [ { "description": "ISO 3166-1 alpha-2 country code for which to retrieve GP worker additional fields.", "in": "path", "name": "country_code", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Global_Payroll_retrieveAdditionalInformationFieldsForGpWorkersByCountry-v2026-01-01_Response_200" } } }, "description": "Use this response to render dynamic form fields for GP worker onboarding. Contains field configuration, validation rules, display metadata, and dependency logic needed to build country-specific additional information forms." }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RetrieveAdditionalInformationFieldsForGpWorkersByCountry-v2026-01-01RequestBadRequestError" } } }, "description": "Returned when the country_code path parameter is not a recognized ISO 3166-1 alpha-2 code." }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RetrieveAdditionalInformationFieldsForGpWorkersByCountry-v2026-01-01RequestUnauthorizedError" } } }, "description": "Authentication failed. The access token is missing, expired, or invalid." }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RetrieveAdditionalInformationFieldsForGpWorkersByCountry-v2026-01-01RequestForbiddenError" } } }, "description": "Access denied. The authenticated user does not have the required forms:read scope." }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RetrieveAdditionalInformationFieldsForGpWorkersByCountry-v2026-01-01RequestNotFoundError" } } }, "description": "The country_code is a valid ISO code but no additional information template exists for it in the Employee Data Management system." }, "429": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RetrieveAdditionalInformationFieldsForGpWorkersByCountry-v2026-01-01RequestTooManyRequestsError" } } }, "description": "Rate limit exceeded. The client has sent too many requests in a given time window." }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RetrieveAdditionalInformationFieldsForGpWorkersByCountry-v2026-01-01RequestInternalServerError" } } }, "description": "Internal server error. Returned when the Employee Data Management service is unreachable, or an unexpected error occurs during field retrieval." } }, "security": [ { "deelToken": [] } ], "summary": "Retrieve additional information fields for GP workers by country", "tags": [ "globalPayroll" ] } }, "/gp/contracts/{contract_id}/banks": { "get": { "description": "Retrieves the bank accounts configured for a specific contract, including how each account's share of the salary is split via funds_distribution — use this when a worker has multiple accounts under one contract to see how pay is being distributed across them.\n\n **Token scopes**: `people:read`", "operationId": "globalPayroll_getGpContractBankAccounts-v2026-09-17", "parameters": [ { "description": "Unique identifier for a contract.", "in": "path", "name": "contract_id", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Global_Payroll_getGpContractBankAccounts-v2026-09-17_Response_200" } } }, "description": "Successful operation." }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetGpContractBankAccounts-v2026-09-17RequestBadRequestError" } } }, "description": "Invalid request parameters." }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContainer" } } }, "description": "Operation failed." }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContainer" } } }, "description": "Operation failed." }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContainer" } } }, "description": "Operation failed." }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContainer" } } }, "description": "Operation failed." } }, "security": [ { "deelToken": [] } ], "summary": "Retrieve bank accounts", "tags": [ "globalPayroll" ] }, "post": { "description": "Adds a bank account for the GP contract; country-specific field requirements must be retrieved from `GET /gp/contracts/{contract_id}/banks/guide` before submitting.\n\n **Token scopes**: `people:write`", "operationId": "globalPayroll_addGpContractBankAccount-v2026-09-17", "parameters": [ { "description": "Unique identifier for a contract.", "in": "path", "name": "contract_id", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "properties": { "data": { "$ref": "#/components/schemas/GpContractsContractIdBanksPostRequestBodyContentApplicationJsonSchemaData" } }, "required": [ "data" ], "type": "object" } } }, "description": "Request body containing the details of the bank account to be added." }, "responses": { "201": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Global_Payroll_addGpContractBankAccount-v2026-09-17_Response_201" } } }, "description": "Successful operation." }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AddGpContractBankAccount-v2026-09-17RequestBadRequestError" } } }, "description": "Invalid request parameters." }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContainer" } } }, "description": "Operation failed." }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContainer" } } }, "description": "Operation failed." }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContainer" } } }, "description": "Operation failed." }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContainer" } } }, "description": "Operation failed." } }, "security": [ { "deelToken": [] } ], "summary": "Add bank account", "tags": [ "globalPayroll" ] } }, "/gp/contracts/{contract_id}/banks/guide": { "get": { "description": "Call this endpoint before rendering a contract's bank account form, to determine which fields must be shown as required for that country.\n\n **Token scopes**: `people:read`", "operationId": "globalPayroll_getGpContractBankGuide-v2026-09-17", "parameters": [ { "description": "Unique identifier for a contract.", "in": "path", "name": "contract_id", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Global_Payroll_getGpContractBankGuide-v2026-09-17_Response_200" } } }, "description": "Successful operation." }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetGpContractBankGuide-v2026-09-17RequestBadRequestError" } } }, "description": "Invalid request parameters." }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContainer" } } }, "description": "Operation failed." }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContainer" } } }, "description": "Operation failed." }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContainer" } } }, "description": "Operation failed." }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContainer" } } }, "description": "Operation failed." } }, "security": [ { "deelToken": [] } ], "summary": "Retrieve bank guide", "tags": [ "globalPayroll" ] } }, "/gp/contracts/{contract_id}/banks/settings": { "patch": { "description": "Use this when a worker has multiple bank accounts under a single Global Payroll contract and you need to control what portion of their salary goes to each. Sets how the employee's salary is split across that contract's bank accounts, independently of the worker's other contracts. Each entry gives the percentage (0–100) paid to one account, and the percentages across the contract's accounts must add up to 100.\n\n **Token scopes**: `people:write`", "operationId": "globalPayroll_setGpContractBankSettings-v2026-09-17", "parameters": [ { "description": "Unique identifier for a contract.", "in": "path", "name": "contract_id", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "properties": { "data": { "$ref": "#/components/schemas/GpContractsContractIdBanksSettingsPatchRequestBodyContentApplicationJsonSchemaData" } }, "required": [ "data" ], "type": "object" } } } }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Global_Payroll_setGpContractBankSettings-v2026-09-17_Response_200" } } }, "description": "Successful operation." }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SetGpContractBankSettings-v2026-09-17RequestBadRequestError" } } }, "description": "Invalid request parameters." }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContainer" } } }, "description": "Operation failed." }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContainer" } } }, "description": "Operation failed." }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContainer" } } }, "description": "Operation failed." }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContainer" } } }, "description": "Operation failed." } }, "security": [ { "deelToken": [] } ], "summary": "Set salary split", "tags": [ "globalPayroll" ] } }, "/gp/contracts/{contract_id}/banks/{bank_id}": { "patch": { "description": "Updates the bank account details for a specific contract's bank record. Use this when a worker has multiple active Global Payroll contracts and needs to manage each contract's bank account and salary split independently, without affecting other contracts. Only the fields provided in the request body are updated.\n\n **Token scopes**: `people:write`", "operationId": "globalPayroll_patchGpContractBankAccount-v2026-09-17", "parameters": [ { "description": "Unique identifier for a contract.", "in": "path", "name": "contract_id", "required": true, "schema": { "type": "string" } }, { "description": "Unique identifier for the bank account in UUID format.", "in": "path", "name": "bank_id", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "properties": { "data": { "$ref": "#/components/schemas/GpContractsContractIdBanksBankIdPatchRequestBodyContentApplicationJsonSchemaData" } }, "required": [ "data" ], "type": "object" } } }, "description": "Request body to modify an existing bank account for an employee." }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Global_Payroll_patchGpContractBankAccount-v2026-09-17_Response_200" } } }, "description": "Successful operation." }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PatchGpContractBankAccount-v2026-09-17RequestBadRequestError" } } }, "description": "Invalid request parameters." }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContainer" } } }, "description": "Operation failed." }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContainer" } } }, "description": "Operation failed." }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContainer" } } }, "description": "Operation failed." }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContainer" } } }, "description": "Operation failed." } }, "security": [ { "deelToken": [] } ], "summary": "Update bank account", "tags": [ "globalPayroll" ] } }, "/gp/contracts/{contract_id}/employment-type": { "patch": { "description": "Changes the employment type of a Global Payroll contract (full-time, part-time or on leave) together with the share of full-time hours the worker is on, taking effect from a date you choose. Use it when a worker changes working pattern. To change the contract end date instead, use `PATCH /rest/gp/contracts/{contract_id}/end-date`.\n\n **Token scopes**: `contracts:write`", "operationId": "globalPayroll_updateEmploymentTypeForAContract-v2026-07-07", "parameters": [ { "description": "The unique identifier of the GP contract.", "in": "path", "name": "contract_id", "required": true, "schema": { "maxLength": 100, "pattern": "^(([a-z0-9]{6,})|([a-z0-9-_]{20,})|(-2[0-9]{2}))$", "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "properties": { "data": { "$ref": "#/components/schemas/GpContractsContractIdEmploymentTypePatchRequestBodyContentApplicationJsonSchemaData", "description": "Employment-type change details, including the effective date." } }, "required": [ "data" ], "type": "object" } } } }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Global_Payroll_updateEmploymentTypeForAContract-v2026-07-07_Response_200" } } }, "description": "OK" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContainer" } } }, "description": "Operation failed." }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContainer" } } }, "description": "Operation failed." }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UpdateEmploymentTypeForAContract-v2026-07-07RequestForbiddenError" } } }, "description": "403" }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContainer" } } }, "description": "Operation failed." }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContainer" } } }, "description": "Operation failed." } }, "security": [ { "deelToken": [] } ], "summary": "Update employment type for a contract", "tags": [ "globalPayroll" ] } }, "/gp/contracts/{contract_id}/end-date": { "patch": { "description": "Update the end date of a Global Payroll contract from the date the change takes effect. Setting an end date makes the contract fixed-term; sending null makes it open-ended. The contract term is derived from the end date. Each call adds an entry to the end date history of the contract.\n\n **Token scopes**: `contracts:write`\n\n **Beta**: this version requires the `X-Beta: true` request header and its contract may change before it is promoted to stable. It is scheduled to become stable on 2027-01-12.", "operationId": "globalPayroll_updateEndDateForAContract-v2026-10-12", "parameters": [ { "description": "The unique identifier of the GP contract.", "in": "path", "name": "contract_id", "required": true, "schema": { "maxLength": 100, "pattern": "^(([a-z0-9]{6,})|([a-z0-9-_]{20,})|(-2[0-9]{2}))$", "type": "string" } }, { "description": "Opts in to the beta version of this endpoint. Must be `true`.", "in": "header", "name": "X-Beta", "required": true, "schema": { "$ref": "#/components/schemas/GpContractsContractIdEndDatePatchParametersXBeta" } } ], "requestBody": { "content": { "application/json": { "schema": { "properties": { "data": { "$ref": "#/components/schemas/GpContractsContractIdEndDatePatchRequestBodyContentApplicationJsonSchemaData", "description": "End date change details, including the effective date." } }, "required": [ "data" ], "type": "object" } } } }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Global_Payroll_updateEndDateForAContract-v2026-10-12_Response_200" } } }, "description": "OK" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContainer" } } }, "description": "Operation failed." }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContainer" } } }, "description": "Operation failed." }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UpdateEndDateForAContract-v2026-10-12RequestForbiddenError" } } }, "description": "403" }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContainer" } } }, "description": "Operation failed." }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContainer" } } }, "description": "Operation failed." } }, "security": [ { "deelToken": [] } ], "summary": "Update end date for a contract", "tags": [ "globalPayroll" ] } }, "/gp/legal-entities/{legal_entity_id}/payroll-migration-imports": { "get": { "description": "Use this to check on the status of payroll migration imports for a legal entity before starting a new one — for example, to confirm previously submitted files have been reviewed, or to see files a partner already added before uploading more.\n\n **Token scopes**: `global-payroll:read`", "operationId": "globalPayroll_listPayrollMigrationImports-v2026-09-15", "parameters": [ { "description": "The unique identifier of the legal entity whose payroll migration imports to list.", "in": "path", "name": "legal_entity_id", "required": true, "schema": { "format": "uuid", "type": "string" } }, { "description": "The maximum number of imports to return, between 1 and 50. Defaults to 20.", "in": "query", "name": "limit", "required": false, "schema": { "default": 20, "maximum": 50, "minimum": 1, "type": "integer" } }, { "description": "An opaque cursor from the previous page's pagination.next_cursor. Omit it for the first page.", "in": "query", "name": "cursor", "required": false, "schema": { "maxLength": 255, "minLength": 1, "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Global_Payroll_listPayrollMigrationImports-v2026-09-15_Response_200" } } }, "description": "OK" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ListPayrollMigrationImports-v2026-09-15RequestBadRequestError" } } }, "description": "400" }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ListPayrollMigrationImports-v2026-09-15RequestUnauthorizedError" } } }, "description": "401" }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ListPayrollMigrationImports-v2026-09-15RequestForbiddenError" } } }, "description": "403" }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ListPayrollMigrationImports-v2026-09-15RequestNotFoundError" } } }, "description": "404" }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ListPayrollMigrationImports-v2026-09-15RequestInternalServerError" } } }, "description": "500" } }, "security": [ { "deelToken": [] } ], "summary": "List payroll migration imports for a legal entity", "tags": [ "globalPayroll" ] }, "post": { "description": "Attach year-to-date payroll files to a legal entity's payroll migration import, created on the first call. Upload each file to the Deel file service first and pass the id and secret it returns. The import stays IN_PROGRESS until submitted; attaching files to a submitted one reopens it. Atomic: one rejected file stores nothing.\n\n **Token scopes**: `global-payroll:write`", "operationId": "globalPayroll_importPayrollMigrationFiles-v2026-09-14", "parameters": [ { "description": "The unique identifier of the legal entity the payroll migration files belong to.", "in": "path", "name": "legal_entity_id", "required": true, "schema": { "format": "uuid", "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "properties": { "data": { "$ref": "#/components/schemas/GpLegalEntitiesLegalEntityIdPayrollMigrationImportsPostRequestBodyContentApplicationJsonSchemaData", "description": "The payroll migration files to attach to the import." } }, "required": [ "data" ], "type": "object" } } } }, "responses": { "201": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Global_Payroll_importPayrollMigrationFiles-v2026-09-14_Response_201" } } }, "description": "OK" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ImportPayrollMigrationFiles-v2026-09-14RequestBadRequestError" } } }, "description": "400" }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ImportPayrollMigrationFiles-v2026-09-14RequestUnauthorizedError" } } }, "description": "401" }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ImportPayrollMigrationFiles-v2026-09-14RequestForbiddenError" } } }, "description": "403" }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ImportPayrollMigrationFiles-v2026-09-14RequestNotFoundError" } } }, "description": "404" }, "409": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ImportPayrollMigrationFiles-v2026-09-14RequestConflictError" } } }, "description": "409" }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ImportPayrollMigrationFiles-v2026-09-14RequestInternalServerError" } } }, "description": "500" } }, "security": [ { "deelToken": [] } ], "summary": "Add payroll migration files to a legal entity", "tags": [ "globalPayroll" ] } }, "/gp/legal-entities/{legal_entity_id}/payroll-migration-imports/{import_id}": { "get": { "description": "Read back one payroll migration import: its state, when it was submitted, and the files attached to it. There is no webhook today, so this is how a caller follows a submission after submitting it.\n\n **Token scopes**: `global-payroll:read`", "operationId": "globalPayroll_getPayrollMigrationImport-v2026-09-15", "parameters": [ { "description": "The unique identifier of the legal entity the payroll migration import belongs to.", "in": "path", "name": "legal_entity_id", "required": true, "schema": { "format": "uuid", "type": "string" } }, { "description": "The unique identifier of the payroll migration import, as returned when it was submitted.", "in": "path", "name": "import_id", "required": true, "schema": { "format": "uuid", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Global_Payroll_getPayrollMigrationImport-v2026-09-15_Response_200" } } }, "description": "OK" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContainer" } } }, "description": "Operation failed." }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetPayrollMigrationImport-v2026-09-15RequestUnauthorizedError" } } }, "description": "401" }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetPayrollMigrationImport-v2026-09-15RequestForbiddenError" } } }, "description": "403" }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetPayrollMigrationImport-v2026-09-15RequestNotFoundError" } } }, "description": "404" }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetPayrollMigrationImport-v2026-09-15RequestInternalServerError" } } }, "description": "500" } }, "security": [ { "deelToken": [] } ], "summary": "Get a payroll migration import", "tags": [ "globalPayroll" ] } }, "/gp/legal-entities/{legal_entity_id}/payroll-migration-imports/{import_id}/submit": { "post": { "description": "Submit a payroll migration import for review, handing its files to the Deel Payroll Implementation Manager working on the legal entity. An import already submitted is refused rather than submitted twice - treat that as success. Attaching more files reopens an import, so it can be submitted again once it has changed.\n\n **Token scopes**: `global-payroll:write`", "operationId": "globalPayroll_submitPayrollMigrationImport-v2026-09-14", "parameters": [ { "description": "The unique identifier of the legal entity the payroll migration import belongs to.", "in": "path", "name": "legal_entity_id", "required": true, "schema": { "format": "uuid", "type": "string" } }, { "description": "The unique identifier of the payroll migration import to submit, as returned when its files were attached.", "in": "path", "name": "import_id", "required": true, "schema": { "format": "uuid", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Global_Payroll_submitPayrollMigrationImport-v2026-09-14_Response_200" } } }, "description": "OK" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContainer" } } }, "description": "Operation failed." }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SubmitPayrollMigrationImport-v2026-09-14RequestUnauthorizedError" } } }, "description": "401" }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SubmitPayrollMigrationImport-v2026-09-14RequestForbiddenError" } } }, "description": "403" }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SubmitPayrollMigrationImport-v2026-09-14RequestNotFoundError" } } }, "description": "404" }, "409": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SubmitPayrollMigrationImport-v2026-09-14RequestConflictError" } } }, "description": "409" }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SubmitPayrollMigrationImport-v2026-09-14RequestInternalServerError" } } }, "description": "500" } }, "security": [ { "deelToken": [] } ], "summary": "Submit a payroll migration import for review", "tags": [ "globalPayroll" ] } }, "/gp/legal-entities/{legal_entity_id}/reports": { "get": { "description": "Retrieves payroll events associated with the specified legal entity, suitable for preparing payroll reports or auditing pay cycles.\n\n **Token scopes**: `global-payroll:read`", "operationId": "reports_getGPLegalEntityReports", "parameters": [ { "description": "Unique identifier for the legal entity.", "in": "path", "name": "legal_entity_id", "required": true, "schema": { "format": "uuid", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/reports_getGPLegalEntityReports_Response_200" } } }, "description": "Successful operation." }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ListPayrollEventsByLegalEntity-v2026-01-01RequestBadRequestError" } } }, "description": "Operation failed." }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContainer" } } }, "description": "Operation failed." }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContainer" } } }, "description": "Operation failed." }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContainer" } } }, "description": "Operation failed." }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContainer" } } }, "description": "Operation failed." } }, "security": [ { "deelToken": [] } ], "summary": "List payroll events by legal entity", "tags": [ "reports" ] } }, "/gp/reports/{id}/gross_to_net": { "get": { "description": "Returns paginated gross-to-net calculation records for the specified payroll report, with optional currency conversion applied to the results.\n\n **Token scopes**: `global-payroll:read`", "operationId": "reports_getGPReportGrossToNet", "parameters": [ { "description": "Id of the gp payroll report.", "in": "path", "name": "id", "required": true, "schema": { "type": "string" } }, { "description": "Currency to be used in the report calculation.", "in": "query", "name": "currency", "required": false, "schema": { "type": "string" } }, { "description": "Maximum number of records to return.", "in": "query", "name": "limit", "required": false, "schema": { "format": "double", "maximum": 200, "type": "number" } }, { "description": "Offset/index of record for the next page of records to return.", "in": "query", "name": "offset", "required": false, "schema": { "format": "double", "type": "number" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/reports_getGPReportGrossToNet_Response_200" } } }, "description": "Successful operation." }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ListGrossToNetReport-v2026-01-01RequestBadRequestError" } } }, "description": "Operation failed." }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContainer" } } }, "description": "Operation failed." }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContainer" } } }, "description": "Operation failed." }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContainer" } } }, "description": "Operation failed." }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContainer" } } }, "description": "Operation failed." } }, "security": [ { "deelToken": [] } ], "summary": "List gross-to-net report.", "tags": [ "reports" ] } }, "/gp/reports/{id}/gross_to_net/csv": { "get": { "description": "Downloads the gross-to-net calculation report for the specified payroll report as a CSV file, with optional currency conversion applied.\n\n **Token scopes**: `global-payroll:read`", "operationId": "reports_getGPReportGrossToNetCSV", "parameters": [ { "description": "Id of the gp payroll report.", "in": "path", "name": "id", "required": true, "schema": { "type": "string" } }, { "description": "Currency to be used in the report calculation.", "in": "query", "name": "currency", "required": false, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "properties": {}, "type": "object" } } }, "description": "Successful operation." }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContainer" } } }, "description": "Operation failed." }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContainer" } } }, "description": "Operation failed." }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContainer" } } }, "description": "Operation failed." }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContainer" } } }, "description": "Operation failed." }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContainer" } } }, "description": "Operation failed." } }, "security": [ { "deelToken": [] } ], "summary": "Download gross to net report", "tags": [ "reports" ] } }, "/gp/workers": { "post": { "description": "Creates a Global Payroll worker and their contract in a single call, so API clients and partner integrations can onboard Global Payroll workers directly instead of using the legacy `POST /rest/contracts/gp` flow. No invitation email is sent to the worker unless the request asks for one.\n\n **Token scopes**: `contracts:write`\n\n **Beta**: this version requires the `X-Beta: true` request header and its contract may change before it is promoted to stable. It is scheduled to become stable on 2027-01-12.", "operationId": "globalPayroll_createGpWorker-v2026-10-01", "parameters": [ { "description": "Opts in to the beta version of this endpoint. Must be `true`.", "in": "header", "name": "X-Beta", "required": true, "schema": { "$ref": "#/components/schemas/GpWorkersPostParametersXBeta" } } ], "requestBody": { "content": { "application/json": { "schema": { "properties": { "data": { "$ref": "#/components/schemas/GpWorkersPostRequestBodyContentApplicationJsonSchemaData" } }, "required": [ "data" ], "type": "object" } } }, "description": "Worker, contract and compensation details." }, "responses": { "201": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Global_Payroll_createGpWorker-v2026-10-01_Response_201" } } }, "description": "The worker and their contract were created. `data.id` is the contract id; `data.employee.id` is the worker id to use with the other Global Payroll worker endpoints." }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreateGpWorker-v2026-10-01RequestBadRequestError" } } }, "description": "Bad request. Codes: validation_error (the body is invalid; field names the offending property), invalid_payroll_group (the payroll group is missing, inactive, not a Global Payroll group or in another legal entity), currency_not_allowed (not allowed for the legal entity country), work_location_required (US legal entities), contract_state_required (the country needs contract_state), entity_integration_active (the legal entity has an active HR integration)." }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreateGpWorker-v2026-10-01RequestUnauthorizedError" } } }, "description": "The authentication is missing or is invalid." }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreateGpWorker-v2026-10-01RequestForbiddenError" } } }, "description": "Forbidden. Codes: team_permission_denied (the caller cannot create contracts in the team), forbidden (the caller's organization cannot use this endpoint)." }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreateGpWorker-v2026-10-01RequestNotFoundError" } } }, "description": "Not found. Codes: legal_entity_not_found, team_not_found, entity_address_not_found. The referenced resource does not exist or does not belong to your organization." }, "409": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreateGpWorker-v2026-10-01RequestConflictError" } } }, "description": "Conflict. Codes: worker_already_exists (the external_id or the email already has a worker or active contract in this legal entity; details carry worker_id and contract_id), external_id_mismatch (the email belongs to a worker with a different external_id), employee_number_taken (the employee number is used in this legal entity), creation_in_progress (an identical create is still running, retry shortly)." }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreateGpWorker-v2026-10-01RequestInternalServerError" } } }, "description": "An unexpected error occurred while creating the worker." } }, "security": [ { "deelToken": [] } ], "summary": "Create a Global Payroll worker", "tags": [ "globalPayroll" ] } }, "/gp/workers/contracts/{contract_id}/additional-information": { "patch": { "description": "Use this endpoint to correct or change country-specific additional information already held on a Global Payroll worker contract, for example after the worker reports a new marital status or a tax identifier changes. Only the fields sent under `data` are modified; everything else is left untouched. Field keys must belong to the additional-information fields defined for the contract country (see `GET /rest/forms/gp/worker-additional-fields/{country_code}`). For fields the organization has configured as effective-dated, a date must be supplied in `effective_dates` (`YYYY-MM-DD`) whenever the value changes: today or a past date applies the change immediately, a future date schedules it and the current value stays in effect until then. Unchanged values and clears need no date. Changes are recorded in the contract history and may update the worker onboarding checklist. By default returns 204. Pass `?include_completion_status=true` to receive a 200 response with `is_additional_data_done` (true when all required fields for EDM onboarding are provided) and `missing_keys` (required fields still absent). Requires the `people:write` scope.\n\n **Token scopes**: `people:write`", "operationId": "workerInformation_getGPWorkerAdditionalInformation", "parameters": [ { "description": "The unique public identifier of the contract.", "in": "path", "name": "contract_id", "required": true, "schema": { "type": "string" } }, { "description": "Pass `true` to receive a 200 response with `is_additional_data_done` and `missing_keys` instead of the default 204 No Content.", "in": "query", "name": "include_completion_status", "required": false, "schema": { "type": "boolean" } } ], "requestBody": { "content": { "application/json": { "schema": { "properties": { "data": { "additionalProperties": { "$ref": "#/components/schemas/GpWorkersContractsContractIdAdditionalInformationPatchRequestBodyContentApplicationJsonSchemaData" }, "type": "object" }, "effective_dates": { "additionalProperties": { "format": "date", "pattern": "^\\d{4}-\\d{2}-\\d{2}$", "type": "string" }, "description": "Per-field effective date (YYYY-MM-DD), keyed like `data`. Only allowed for effective-dated fields, and required whenever such a field is set to a new value (unchanged values and clears need no date). Past dates apply immediately as corrections, future dates are scheduled.", "type": "object" } }, "required": [ "data" ], "type": "object" } } } }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/worker-information_getGPWorkerAdditionalInformation_Response_200" } } }, "description": "Returned only when `?include_completion_status=true` is passed. Contains completion status." }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UpdateGpWorkersAdditionalInformation-v2026-01-01RequestBadRequestError" } } }, "description": "Operation failed." }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UpdateGpWorkersAdditionalInformation-v2026-01-01RequestUnauthorizedError" } } }, "description": "Unauthorized — missing or invalid authentication token." }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UpdateGpWorkersAdditionalInformation-v2026-01-01RequestForbiddenError" } } }, "description": "Forbidden — caller lacks the people:write permission or cannot access this contract." }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UpdateGpWorkersAdditionalInformation-v2026-01-01RequestNotFoundError" } } }, "description": "Not found — the contract does not exist or is not accessible." }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UpdateGpWorkersAdditionalInformation-v2026-01-01RequestInternalServerError" } } }, "description": "Operation failed." } }, "security": [ { "deelToken": [] } ], "summary": "Update GP worker additional information", "tags": [ "workerInformation" ] }, "post": { "description": "Adds supplementary fields to the contract, with the extra data supplied under the `data` object in the request body.\n\n **Token scopes**: `people:write`", "operationId": "workerInformation_createGPWorkerAdditionalInformation", "parameters": [ { "description": "The unique public identifier of the contract.", "in": "path", "name": "contract_id", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "properties": { "data": { "additionalProperties": { "$ref": "#/components/schemas/GpWorkersContractsContractIdAdditionalInformationPostRequestBodyContentApplicationJsonSchemaData" }, "type": "object" } }, "required": [ "data" ], "type": "object" } } } }, "responses": { "201": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/worker-information_createGPWorkerAdditionalInformation_Response_201" } } }, "description": "Operation successful." }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AddGpWorkersAdditionalInformation-v2026-01-01RequestBadRequestError" } } }, "description": "Operation failed." }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContainer" } } }, "description": "Operation failed." }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContainer" } } }, "description": "Operation failed." }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContainer" } } }, "description": "Operation failed." }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AddGpWorkersAdditionalInformation-v2026-01-01RequestInternalServerError" } } }, "description": "Operation failed." } }, "security": [ { "deelToken": [] } ], "summary": "Add GP Workers Additional Information", "tags": [ "workerInformation" ] } }, "/gp/workers/creation-schema": { "get": { "description": "Returns the fields POST /rest/gp/workers accepts, with whether each is required, its permitted values and its validation rules. Pass country, or legal_entity_id and payroll_group_id, to get the rules that apply to that case: contract_state and its provinces, work_location for US entities, postal code format, allowed currencies and the employee_number requirement of a Payroll Connect group. Build the form from this response and the create will not reject it.\n\n **Token scopes**: `contracts:read`\n\n **Beta**: this version requires the `X-Beta: true` request header and its contract may change before it is promoted to stable. It is scheduled to become stable on 2027-01-12.", "operationId": "globalPayroll_retrieveGpWorkerCreationSchema-v2026-10-01", "parameters": [ { "description": "ISO 3166-1 alpha-2 country of the legal entity. Adds the country rules. Must match the legal entity when legal_entity_id is also given.", "in": "query", "name": "country", "required": false, "schema": { "maxLength": 2, "minLength": 2, "pattern": "^[A-Z]{2}$", "type": "string" } }, { "description": "Legal entity of your organization. Its country is used and the currencies it may pay in are returned.", "in": "query", "name": "legal_entity_id", "required": false, "schema": { "format": "uuid", "maxLength": 36, "minLength": 36, "type": "string" } }, { "description": "Payroll group of the legal entity. When it is a Payroll Connect (Soft GP) group, employee_number is reported as required. Requires legal_entity_id.", "in": "query", "name": "payroll_group_id", "required": false, "schema": { "maxLength": 100, "minLength": 1, "type": "string" } }, { "description": "Opts in to the beta version of this endpoint. Must be `true`.", "in": "header", "name": "X-Beta", "required": true, "schema": { "$ref": "#/components/schemas/GpWorkersCreationSchemaGetParametersXBeta" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Global_Payroll_retrieveGpWorkerCreationSchema-v2026-10-01_Response_200" } } }, "description": "The fields the create endpoint accepts for the given context." }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RetrieveGpWorkerCreationSchema-v2026-10-01RequestBadRequestError" } } }, "description": "Bad request. Codes: validation_error (a query parameter is invalid, or country does not match the legal entity country)." }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RetrieveGpWorkerCreationSchema-v2026-10-01RequestUnauthorizedError" } } }, "description": "The authentication is missing or is invalid." }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RetrieveGpWorkerCreationSchema-v2026-10-01RequestForbiddenError" } } }, "description": "The token does not grant the contracts:read scope." }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RetrieveGpWorkerCreationSchema-v2026-10-01RequestNotFoundError" } } }, "description": "The legal entity does not exist or does not belong to your organization." }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RetrieveGpWorkerCreationSchema-v2026-10-01RequestInternalServerError" } } }, "description": "An unexpected error occurred." } }, "security": [ { "deelToken": [] } ], "summary": "Retrieve the Global Payroll worker creation schema", "tags": [ "globalPayroll" ] } }, "/gp/workers/{id}/payslips": { "get": { "description": "Returns the payslip history for a GP employee, including each payslip's date range and status. Restricted to GP contract types. Each payslip in the response includes an `id` required by the payslip download endpoint.\n\n **Token scopes**: `payslips:read`, `worker:read`", "operationId": "payslips_getGPWorkerPayslips", "parameters": [ { "description": "Unique identifier for the worker.", "in": "path", "name": "id", "required": true, "schema": { "format": "uuid", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/payslips_getGPWorkerPayslips_Response_200" } } }, "description": "Successful operation." }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RetrieveEmployeePayslips-v2026-01-01RequestBadRequestError" } } }, "description": "Bad Request - Validation error or invalid parameters" }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContainer" } } }, "description": "Operation failed." }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContainer" } } }, "description": "Operation failed." }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContainer" } } }, "description": "Operation failed." }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContainer" } } }, "description": "Operation failed." } }, "security": [ { "deelToken": [] } ], "summary": "Retrieve employee payslips", "tags": [ "payslips" ] } }, "/gp/workers/{id}/payslips/{payslip_id}/download": { "get": { "description": "Returns a pre-signed download URL for a specific Global Payroll (GP) employee payslip PDF. Use this after calling Retrieve employee payslips to obtain the payslipId. Requires the worker id (UUID) and the payslipId from the list response. The returned URL is temporary and should be used promptly to download the file. Supports only GP contract types.\n\n **Token scopes**: `payslips:read`, `worker:read`", "operationId": "globalPayroll_downloadAGpWorkerPayslip-v2026-01-01", "parameters": [ { "description": "Unique identifier for the worker.", "in": "path", "name": "id", "required": true, "schema": { "format": "uuid", "type": "string" } }, { "description": "Unique identifier for the payslip.", "in": "path", "name": "payslipId", "required": true, "schema": { "format": "uuid", "type": "string" } }, { "description": "Unique identifier for the payslip.", "in": "path", "name": "payslip_id", "required": true, "schema": { "format": "uuid", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Global_Payroll_downloadAGpWorkerPayslip-v2026-01-01_Response_200" } } }, "description": "Successful operation." }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DownloadAGpWorkerPayslip-v2026-01-01RequestBadRequestError" } } }, "description": "Bad Request - Validation error or invalid parameters" }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContainer" } } }, "description": "Operation failed." }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContainer" } } }, "description": "Operation failed." }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContainer" } } }, "description": "Operation failed." }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContainer" } } }, "description": "Operation failed." } }, "security": [ { "deelToken": [] } ], "summary": "Download a GP worker payslip", "tags": [ "globalPayroll" ] } }, "/gp/workers/{worker_id}/address": { "patch": { "description": "Partially updates the address on record for the GP employee.\n\n **Token scopes**: `people:write`", "operationId": "workerInformation_updateGPWorkerAddress", "parameters": [ { "description": "Unique identifier for a worker in UUID format.", "in": "path", "name": "worker_id", "required": true, "schema": { "format": "uuid", "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "properties": { "data": { "$ref": "#/components/schemas/GpWorkersWorkerIdAddressPatchRequestBodyContentApplicationJsonSchemaData" } }, "required": [ "data" ], "type": "object" } } }, "description": "The desired address of the Global Payroll employee" }, "responses": { "201": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/worker-information_updateGPWorkerAddress_Response_201" } } }, "description": "Successful operation." }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContainer" } } }, "description": "Operation failed." }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContainer" } } }, "description": "Operation failed." }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContainer" } } }, "description": "Operation failed." }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContainer" } } }, "description": "Operation failed." }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContainer" } } }, "description": "Operation failed." } }, "security": [ { "deelToken": [] } ], "summary": "Update address", "tags": [ "workerInformation" ] } }, "/gp/workers/{worker_id}/banks": { "get": { "description": "Returns all bank accounts associated with the employee.\n\n **Token scopes**: `people:read`", "operationId": "workerInformation_getGPWorkerBanks", "parameters": [ { "description": "Unique identifier for a worker.", "in": "path", "name": "worker_id", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/worker-information_getGPWorkerBanks_Response_200" } } }, "description": "Successful operation." }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContainer" } } }, "description": "Operation failed." }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContainer" } } }, "description": "Operation failed." }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContainer" } } }, "description": "Operation failed." }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContainer" } } }, "description": "Operation failed." }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContainer" } } }, "description": "Operation failed." } }, "security": [ { "deelToken": [] } ], "summary": "Retrieve bank accounts", "tags": [ "workerInformation" ] }, "post": { "description": "Adds a bank account for the GP worker; country-specific field requirements must be retrieved from `GET /gp/workers/{worker_id}/banks/guide` before submitting.\n\n **Token scopes**: `people:write`", "operationId": "workerInformation_createGPWorkerBank", "parameters": [ { "description": "Unique identifier for a worker in UUID format.", "in": "path", "name": "worker_id", "required": true, "schema": { "format": "uuid", "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "properties": { "data": { "$ref": "#/components/schemas/GpWorkersWorkerIdBanksPostRequestBodyContentApplicationJsonSchemaData" } }, "required": [ "data" ], "type": "object" } } }, "description": "Request body containing the details of the bank account to be added." }, "responses": { "201": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/worker-information_createGPWorkerBank_Response_201" } } }, "description": "Successful operation." }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContainer" } } }, "description": "Operation failed." }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContainer" } } }, "description": "Operation failed." }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContainer" } } }, "description": "Operation failed." }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContainer" } } }, "description": "Operation failed." }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContainer" } } }, "description": "Operation failed." } }, "security": [ { "deelToken": [] } ], "summary": "Add bank account", "tags": [ "workerInformation" ] } }, "/gp/workers/{worker_id}/banks/guide": { "get": { "description": "Returns the country-specific field requirements for a worker's bank account form, which determines the fields required when adding a bank account.\n\n **Token scopes**: `people:read`", "operationId": "workerInformation_getGPWorkerBankGuide", "parameters": [ { "description": "Unique identifier for a worker in UUID format.", "in": "path", "name": "worker_id", "required": true, "schema": { "format": "uuid", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/worker-information_getGPWorkerBankGuide_Response_200" } } }, "description": "Successful operation." }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContainer" } } }, "description": "Operation failed." }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContainer" } } }, "description": "Operation failed." }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContainer" } } }, "description": "Operation failed." }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContainer" } } }, "description": "Operation failed." }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContainer" } } }, "description": "Operation failed." } }, "security": [ { "deelToken": [] } ], "summary": "Retrieve bank guide", "tags": [ "workerInformation" ] } }, "/gp/workers/{worker_id}/banks/{bank_id}": { "patch": { "description": "Partially updates the bank account for the worker; only fields provided in the request body are modified.\n\n **Token scopes**: `people:write`", "operationId": "workerInformation_updateGPWorkerBank", "parameters": [ { "description": "Unique identifier for a worker in UUID format.", "in": "path", "name": "worker_id", "required": true, "schema": { "format": "uuid", "type": "string" } }, { "description": "Unique identifier for the bank account in UUID format.", "in": "path", "name": "bank_id", "required": true, "schema": { "format": "uuid", "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "properties": { "account_number": { "description": "The user's bank account number.", "type": "string" }, "account_type": { "description": "Bank account type.", "type": "string" }, "ach_routing_number": { "description": "The ACH (Automated Clearing House) Routing Number.", "type": "string" }, "address_line1": { "description": "The primary address line.", "type": "string" }, "address_line2": { "description": "The secondary address line.", "type": "string" }, "bank_branch_name": { "description": "The name of the user's bank branch.", "type": "string" }, "bank_code": { "description": "The bank code.", "type": "string" }, "bank_country_code": { "description": "The country code where the bank is located.", "type": "string" }, "bank_name": { "description": "Name of the user's bank.", "type": "string" }, "branch_code": { "description": "The branch code of the user's bank.", "type": "string" }, "city": { "description": "The city of the user's address.", "type": "string" }, "country_code": { "description": "The country code of the user's address.", "type": "string" }, "currency_code": { "description": "The currency code for transactions.", "type": "string" }, "email": { "description": "The user's email address.", "type": "string" }, "full_name": { "description": "Full name of the user.", "type": "string" }, "iban": { "description": "The International Bank Account Number (IBAN).", "type": "string" }, "original_name": { "description": "The original name of the user.", "type": "string" }, "phone": { "description": "The user's phone number.", "type": "string" }, "postal": { "description": "The user's postal or ZIP code.", "type": "string" }, "province_state": { "description": "The state or province of the user's address.", "type": "string" }, "rib_number": { "description": "The RIB (Relevé d'Identité Bancaire).", "type": "string" }, "swift_bic": { "description": "SWIFT/BIC code for the bank.", "type": "string" }, "tax_id": { "description": "The user's tax identification number.", "type": "string" } }, "type": "object" } } }, "description": "Request body to modify an existing bank account for an employee." }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/worker-information_updateGPWorkerBank_Response_200" } } }, "description": "Successful operation." }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContainer" } } }, "description": "Operation failed." }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContainer" } } }, "description": "Operation failed." }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContainer" } } }, "description": "Operation failed." }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContainer" } } }, "description": "Operation failed." }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContainer" } } }, "description": "Operation failed." } }, "security": [ { "deelToken": [] } ], "summary": "Modify bank account", "tags": [ "workerInformation" ] } }, "/gp/workers/{worker_id}/compensation": { "patch": { "description": "Updates the compensation for the GP employee and returns the complete compensation history including the applied change.\n\n **Token scopes**: `people:write`", "operationId": "workerInformation_updateGPWorkerCompensation", "parameters": [ { "description": "Unique identifier for a worker in UUID format.", "in": "path", "name": "worker_id", "required": true, "schema": { "format": "uuid", "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "properties": { "data": { "$ref": "#/components/schemas/GpWorkersWorkerIdCompensationPatchRequestBodyContentApplicationJsonSchemaData" } }, "required": [ "data" ], "type": "object" } } }, "description": "Request body containing the data to update the compensation of the employee." }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/worker-information_updateGPWorkerCompensation_Response_200" } } }, "description": "Successful operation." }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContainer" } } }, "description": "Operation failed." }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContainer" } } }, "description": "Operation failed." }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContainer" } } }, "description": "Operation failed." }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContainer" } } }, "description": "Operation failed." }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContainer" } } }, "description": "Operation failed." } }, "security": [ { "deelToken": [] } ], "summary": "Update compensation", "tags": [ "workerInformation" ] } }, "/gp/workers/{worker_id}/employee-information": { "patch": { "description": "Partially updates personal details, tax information, and employment-related fields for the GP worker.\n\n **Token scopes**: `people:write`", "operationId": "workerInformation_updateGPWorkerEmployeeInformation", "parameters": [ { "description": "Unique identifier for a worker in UUID format.", "in": "path", "name": "worker_id", "required": true, "schema": { "format": "uuid", "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "properties": { "data": { "$ref": "#/components/schemas/GpWorkersWorkerIdEmployeeInformationPatchRequestBodyContentApplicationJsonSchemaData" } }, "required": [ "data" ], "type": "object" } } } }, "responses": { "202": { "content": { "application/json": { "schema": { "description": "Any type" } } }, "description": "Successful operation." }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContainer" } } }, "description": "Operation failed." }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContainer" } } }, "description": "Operation failed." }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContainer" } } }, "description": "Operation failed." }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContainer" } } }, "description": "Operation failed." }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContainer" } } }, "description": "Operation failed." } }, "security": [ { "deelToken": [] } ], "summary": "Update employee information", "tags": [ "workerInformation" ] } }, "/gp/workers/{worker_id}/pto-policy": { "patch": { "description": "Applies a partial update to the PTO policy assigned to a Global Payroll worker. Only fields included in the request body are modified; omitted fields retain their current values.\n\n **Token scopes**: `people:write`", "operationId": "workerInformation_updateGPWorkerPTOPolicy", "parameters": [ { "description": "Unique identifier for a worker in UUID format.", "in": "path", "name": "worker_id", "required": true, "schema": { "format": "uuid", "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "properties": { "data": { "$ref": "#/components/schemas/GpWorkersWorkerIdPtoPolicyPatchRequestBodyContentApplicationJsonSchemaData" } }, "required": [ "data" ], "type": "object" } } }, "description": "Contract object that needs to be amended." }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/worker-information_updateGPWorkerPTOPolicy_Response_200" } } }, "description": "Successful operation." }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContainer" } } }, "description": "Operation failed." }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContainer" } } }, "description": "Operation failed." }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContainer" } } }, "description": "Operation failed." }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContainer" } } }, "description": "Operation failed." }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContainer" } } }, "description": "Operation failed." } }, "security": [ { "deelToken": [] } ], "summary": "Update PTO policy", "tags": [ "workerInformation" ] } }, "/gp/workers/{worker_id}/terminations": { "post": { "description": "Initiates the termination process for a Global Payroll worker. A successful response confirms the request was accepted and the process has begun, but does not indicate that termination is complete.\n\n **Token scopes**: `global-payroll:write`", "operationId": "gpHiring_createGPWorkerTermination", "parameters": [ { "description": "Unique identifier for a worker in UUID format.", "in": "path", "name": "worker_id", "required": true, "schema": { "format": "uuid", "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "properties": { "data": { "$ref": "#/components/schemas/GpWorkersWorkerIdTerminationsPostRequestBodyContentApplicationJsonSchemaData" } }, "required": [ "data" ], "type": "object" } } }, "description": "Request body to request a termination for an employee." }, "responses": { "201": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/gp-hiring_createGPWorkerTermination_Response_201" } } }, "description": "Successful operation." }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContainer" } } }, "description": "Operation failed." }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContainer" } } }, "description": "Operation failed." }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContainer" } } }, "description": "Operation failed." }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContainer" } } }, "description": "Operation failed." }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContainer" } } }, "description": "Operation failed." } }, "security": [ { "deelToken": [] } ], "summary": "Request termination", "tags": [ "gpHiring" ] } }, "/groups": { "get": { "description": "Returns a paginated list of groups in the organization. Archived groups are included by default and can be excluded via the `include_archived_groups` parameter.\n\n **Token scopes**: `groups:read`", "operationId": "groups_getGroups", "parameters": [ { "description": "The maximum number of groups to return (between 1 and 100)", "in": "query", "name": "limit", "required": false, "schema": { "default": 100, "maximum": 100, "minimum": 1, "type": "integer" } }, { "description": "Sort the results in ascending (ASC) or descending (DESC) order based on the group name.", "in": "query", "name": "sort_order", "required": false, "schema": { "$ref": "#/components/schemas/GroupsGetParametersSortOrder", "default": "ASC" } }, { "description": "The encoded cursor for paginated results. This is an opaque string that allows fetching the next set of results.", "in": "query", "name": "cursor", "required": false, "schema": { "type": "string" } }, { "description": "Include archived groups (soft deleted records). Defaults to `true`.", "in": "query", "name": "include_archived_groups", "required": false, "schema": { "default": true, "type": "boolean" } }, { "description": "Extra information about the group.", "in": "query", "name": "external_metadata", "required": false, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/groups_getGroups_Response_200" } } }, "description": "A list of groups in the organization." }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetGroups-v2026-01-01RequestBadRequestError" } } }, "description": "Invalid request parameters." }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContainer" } } }, "description": "Operation failed." }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContainer" } } }, "description": "Operation failed." }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContainer" } } }, "description": "Operation failed." }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContainer" } } }, "description": "Operation failed." } }, "security": [ { "deelToken": [] } ], "summary": "Return list of groups", "tags": [ "Groups" ] }, "post": { "description": "Creates a new group within the organization and returns the created group record, including its assigned `id`.\n\n **Token scopes**: `groups:read`, `groups:write`", "operationId": "groups_createGroup", "requestBody": { "content": { "application/json": { "schema": { "properties": { "data": { "$ref": "#/components/schemas/GroupsPostRequestBodyContentApplicationJsonSchemaData" } }, "required": [ "data" ], "type": "object" } } } }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/groups_createGroup_Response_200" } } }, "description": "Group created successfully" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreateGroup-v2026-01-01RequestBadRequestError" } } }, "description": "Invalid request payload" }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContainer" } } }, "description": "Operation failed." }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContainer" } } }, "description": "Operation failed." }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContainer" } } }, "description": "Operation failed." }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContainer" } } }, "description": "Operation failed." } }, "security": [ { "deelToken": [] } ], "summary": "Create a group", "tags": [ "Groups" ] } }, "/groups/{id}": { "delete": { "description": "Soft-deletes a group by archiving it. The group is not permanently removed and the response includes the `archived_at` timestamp reflecting when the archive occurred.\n\n **Token scopes**: `groups:write`", "operationId": "groups_deleteGroup", "parameters": [ { "description": "Unique identifier of the group to be archived.", "in": "path", "name": "id", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/groups_deleteGroup_Response_200" } } }, "description": "Group archived successfully" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DeleteGroup-v2026-01-01RequestBadRequestError" } } }, "description": "Bad request" }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContainer" } } }, "description": "Operation failed." }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContainer" } } }, "description": "Operation failed." }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DeleteGroup-v2026-01-01RequestNotFoundError" } } }, "description": "Group not found" }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContainer" } } }, "description": "Operation failed." } }, "security": [ { "deelToken": [] } ], "summary": "Delete a group", "tags": [ "Groups" ] }, "patch": { "description": "Applies a partial update to an existing group's details. Only fields included in the request body are modified; omitted fields retain their current values.\n\n **Token scopes**: `groups:read`, `groups:write`", "operationId": "groups_updateGroup", "parameters": [ { "description": "Unique identifier of the group to be edited.", "in": "path", "name": "id", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "properties": { "data": { "$ref": "#/components/schemas/GroupsIdPatchRequestBodyContentApplicationJsonSchemaData" } }, "required": [ "data" ], "type": "object" } } } }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/groups_updateGroup_Response_200" } } }, "description": "Group updated successfully" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EditGroup-v2026-01-01RequestBadRequestError" } } }, "description": "Invalid request payload" }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContainer" } } }, "description": "Operation failed." }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContainer" } } }, "description": "Operation failed." }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContainer" } } }, "description": "Operation failed." }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContainer" } } }, "description": "Operation failed." } }, "security": [ { "deelToken": [] } ], "summary": "Edit a group", "tags": [ "Groups" ] } }, "/groups/{id}/clone": { "post": { "description": "Creates a new group by copying the structure and settings of an existing group. The cloned group is independent of the source after creation.\n\n **Token scopes**: `groups:write`", "operationId": "groups_cloneGroup", "parameters": [ { "description": "Unique identifier of the group to be cloned.", "in": "path", "name": "id", "required": true, "schema": { "format": "uuid", "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "properties": { "data": { "$ref": "#/components/schemas/GroupsIdClonePostRequestBodyContentApplicationJsonSchemaData" } }, "required": [ "data" ], "type": "object" } } } }, "responses": { "201": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/groups_cloneGroup_Response_201" } } }, "description": "Group cloned successfully" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CloneAGroup-v2026-01-01RequestBadRequestError" } } }, "description": "Operation failed." }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContainer" } } }, "description": "Operation failed." }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContainer" } } }, "description": "Operation failed." }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContainer" } } }, "description": "Operation failed." }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContainer" } } }, "description": "Operation failed." } }, "security": [ { "deelToken": [] } ], "summary": "Clone a Group", "tags": [ "Groups" ] } }, "/hris/organization-structures/teams/{team_id}/custom-fields": { "patch": { "operationId": "organizationStructure_updateTeamCustomFields", "parameters": [ { "in": "path", "name": "team_id", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Successful response" } }, "summary": "Update Team Custom Fields", "tags": [ "organizationStructure" ] } }, "/hris/organization_structures": { "get": { "description": "Returns the organization's hierarchical structure, including departments and teams, with offset-based pagination.\n\n **Token scopes**: `organizations:read`", "operationId": "organizationStructure_getOrganizationStructures", "parameters": [ { "description": "Return a page of results with given number of records.", "in": "query", "name": "offset", "required": false, "schema": { "default": 0, "format": "int64", "maximum": 999999999, "minimum": 0, "type": "integer" } }, { "description": "Return a page of results with given number of records.", "in": "query", "name": "limit", "required": false, "schema": { "format": "double", "maximum": 200, "minimum": 1, "type": "number" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/organization-structure_getOrganizationStructures_Response_200" } } }, "description": "Successful operation" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContainer" } } }, "description": "Operation failed." }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContainer" } } }, "description": "Operation failed." }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContainer" } } }, "description": "Operation failed." }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContainer" } } }, "description": "Operation failed." }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContainer" } } }, "description": "Operation failed." } }, "security": [ { "deelToken": [] } ], "summary": "Get Organization Structures", "tags": [ "organizationStructure" ] }, "post": { "description": "Creates a new organization structure within the HRIS, returning the created record including its assigned `id` and `organization_id`. The `is_multi_select` and `enable_roles` flags on the request body control whether the structure supports multiple team assignments and role management respectively.\n\n **Token scopes**: `organizations:write`", "operationId": "organizationStructure_createOrganizationStructure", "requestBody": { "content": { "application/json": { "schema": { "properties": { "data": { "$ref": "#/components/schemas/HrisOrganizationStructuresPostRequestBodyContentApplicationJsonSchemaData" } }, "type": "object" } } } }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/organization-structure_createOrganizationStructure_Response_200" } } }, "description": "Successful operation" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreateANewHrisOrganizationStructure-v2026-01-01RequestBadRequestError" } } }, "description": "Operation failed." }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContainer" } } }, "description": "Operation failed." }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContainer" } } }, "description": "Operation failed." }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContainer" } } }, "description": "Operation failed." }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreateANewHrisOrganizationStructure-v2026-01-01RequestInternalServerError" } } }, "description": "Operation failed." } }, "security": [ { "deelToken": [] } ], "summary": "Create a new HRIS Organization Structure.", "tags": [ "organizationStructure" ] } }, "/hris/organization_structures/external/{external_id}": { "delete": { "description": "Permanently removes an organization structure from the organization.\n\n **Token scopes**: `organizations:write`", "operationId": "organizationStructure_deleteOrganizationStructureByExternalId", "parameters": [ { "description": "External ID", "in": "path", "name": "external_id", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/organization-structure_deleteOrganizationStructureByExternalId_Response_200" } } }, "description": "Successfully deleted" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContainer" } } }, "description": "Operation failed." }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContainer" } } }, "description": "Operation failed." }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContainer" } } }, "description": "Operation failed." }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContainer" } } }, "description": "Operation failed." }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContainer" } } }, "description": "Operation failed." } }, "security": [ { "deelToken": [] } ], "summary": "Delete an Org Structure from the Organization by external ID", "tags": [ "organizationStructure" ] }, "get": { "description": "Fetches a single organization structure, returning associated roles and teams alongside structure metadata.\n\n **Token scopes**: `organizations:read`", "operationId": "organizationStructure_getOrganizationStructureByExternalId", "parameters": [ { "description": "External ID", "in": "path", "name": "external_id", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/organization-structure_getOrganizationStructureByExternalId_Response_200" } } }, "description": "Successful operation" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FetchAnOrgStructureFromTheOrganization-v2026-01-01RequestBadRequestError" } } }, "description": "Bad request - The provided hrisOrgStructureId is invalid." }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContainer" } } }, "description": "Operation failed." }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContainer" } } }, "description": "Operation failed." }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FetchAnOrgStructureFromTheOrganization-v2026-01-01RequestNotFoundError" } } }, "description": "Not found - No organization structure exists for the provided ID." }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContainer" } } }, "description": "Operation failed." } }, "security": [ { "deelToken": [] } ], "summary": "Get Organization Structure by External ID", "tags": [ "organizationStructure" ] }, "patch": { "description": "Applies a partial update to an existing organization structure. Only fields provided in the request body are modified; omitted fields retain their current values.\n\n **Token scopes**: `organizations:write`", "operationId": "organizationStructure_updateOrganizationStructureByExternalId", "parameters": [ { "description": "External ID", "in": "path", "name": "external_id", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "properties": { "data": { "$ref": "#/components/schemas/HrisOrganizationStructuresExternalExternalIdPatchRequestBodyContentApplicationJsonSchemaData" } }, "type": "object" } } } }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/organization-structure_updateOrganizationStructureByExternalId_Response_200" } } }, "description": "Successful operation" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UpdateAnExistingHrisOrgStructureByExternalId-v2026-01-01RequestBadRequestError" } } }, "description": "Bad request - The request body is invalid or missing required fields." }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContainer" } } }, "description": "Operation failed." }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContainer" } } }, "description": "Operation failed." }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UpdateAnExistingHrisOrgStructureByExternalId-v2026-01-01RequestNotFoundError" } } }, "description": "Not found - No organization structure exists for the provided externalId." }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContainer" } } }, "description": "Operation failed." } }, "security": [ { "deelToken": [] } ], "summary": "Update an existing HRIS Org Structure by external ID", "tags": [ "organizationStructure" ] } }, "/hris/organization_structures/{hris_org_structure_id}": { "delete": { "description": "Delete an Org Structure from the Organization. Use the force flag to bypass validation checks and remove the structure even when profiles are still assigned to it.\n\n **Token scopes**: `organizations:write`", "operationId": "organizationStructure_deleteOrganizationStructure", "parameters": [ { "description": "Org Structure", "in": "path", "name": "hris_org_structure_id", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/organization-structure_deleteOrganizationStructure_Response_200" } } }, "description": "Successfully deleted" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DeleteAnOrgStructureFromTheOrganization-v2026-01-01RequestBadRequestError" } } }, "description": "Operation failed." }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContainer" } } }, "description": "Operation failed." }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContainer" } } }, "description": "Operation failed." }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContainer" } } }, "description": "Operation failed." }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DeleteAnOrgStructureFromTheOrganization-v2026-01-01RequestInternalServerError" } } }, "description": "Operation failed." } }, "security": [ { "deelToken": [] } ], "summary": "Delete an Org Structure from the Organization", "tags": [ "organizationStructure" ] }, "get": { "description": "Retrieves detailed information about a specific organizational structure including its teams and roles.\n\n **Token scopes**: `organizations:read`", "operationId": "organizationStructure_getOrganizationStructure", "parameters": [ { "description": "HRIS Organization Structure ID", "in": "path", "name": "hris_org_structure_id", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/organization-structure_getOrganizationStructure_Response_200" } } }, "description": "Successful operation" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FetchAnOrgStructureFromTheOrganization-v2026-01-01RequestBadRequestError" } } }, "description": "Bad request - The provided hrisOrgStructureId is invalid." }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContainer" } } }, "description": "Operation failed." }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContainer" } } }, "description": "Operation failed." }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FetchAnOrgStructureFromTheOrganization-v2026-01-01RequestNotFoundError" } } }, "description": "Not found - No organization structure exists for the provided ID." }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContainer" } } }, "description": "Operation failed." } }, "security": [ { "deelToken": [] } ], "summary": "Get Organization Structure", "tags": [ "organizationStructure" ] }, "patch": { "description": "Update an existing HRIS Org Structure including its name, settings, and teams hierarchy.\n\n **Token scopes**: `organizations:write`", "operationId": "organizationStructure_updateOrganizationStructure", "parameters": [ { "description": "Org Structure", "in": "path", "name": "hris_org_structure_id", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "properties": { "data": { "$ref": "#/components/schemas/HrisOrganizationStructuresHrisOrgStructureIdPatchRequestBodyContentApplicationJsonSchemaData" } }, "type": "object" } } } }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/organization-structure_updateOrganizationStructure_Response_200" } } }, "description": "Successful operation" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UpdateAnExistingHrisOrgStructure-v2026-01-01RequestBadRequestError" } } }, "description": "Operation failed." }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContainer" } } }, "description": "Operation failed." }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContainer" } } }, "description": "Operation failed." }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContainer" } } }, "description": "Operation failed." }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UpdateAnExistingHrisOrgStructure-v2026-01-01RequestInternalServerError" } } }, "description": "Operation failed." } }, "security": [ { "deelToken": [] } ], "summary": "Update an existing HRIS Org Structure", "tags": [ "organizationStructure" ] } }, "/hris/positions/apply_changes": { "post": { "description": "Applies a batch of add, edit, and delete operations to positions within a single request. Multiple operation types may be submitted together; callers should ensure each operation in the batch targets a valid, existing position where applicable.\n\n **Token scopes**: `profile:write`", "operationId": "positions_applyPositionChanges", "requestBody": { "content": { "application/json": { "schema": { "properties": { "data": { "$ref": "#/components/schemas/HrisPositionsApplyChangesPostRequestBodyContentApplicationJsonSchemaData", "description": "The request payload containing the position changes to apply." } }, "type": "object" } } } }, "responses": { "204": { "content": { "application/json": { "schema": { "properties": {}, "type": "object" } } }, "description": "Successful operation" }, "400": { "content": { "application/json": { "schema": { "description": "Any type" } } }, "description": "Bad Request. Invalid input parameters." }, "401": { "content": { "application/json": { "schema": { "description": "Any type" } } }, "description": "Unauthorized. Invalid or expired token." }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContainer" } } }, "description": "Operation failed." }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContainer" } } }, "description": "Operation failed." }, "500": { "content": { "application/json": { "schema": { "description": "Any type" } } }, "description": "Internal Server Error. Could not process the request." } }, "security": [ { "deelToken": [] } ], "summary": "Apply changes to positions.", "tags": [ "Positions" ] } }, "/hris/positions/profile/{hris_profile_id}": { "get": { "description": "Retrieves all positions assigned to a given HRIS profile, including the associated role, team, and organization structure for each position.\n\n **Token scopes**: `profile:read`", "operationId": "positions_getPositionsByProfile", "parameters": [ { "description": "HRIS Profile ID", "in": "path", "name": "hris_profile_id", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/positions_getPositionsByProfile_Response_200" } } }, "description": "Successful operation" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FetchHrisPositionsFromAHrisProfile-v2026-01-01RequestBadRequestError" } } }, "description": "Bad request - The provided hrisProfileId or hrisOrgStructureId is invalid." }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContainer" } } }, "description": "Operation failed." }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContainer" } } }, "description": "Operation failed." }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FetchHrisPositionsFromAHrisProfile-v2026-01-01RequestNotFoundError" } } }, "description": "Not found - No HRIS profile exists for the provided ID." }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContainer" } } }, "description": "Operation failed." } }, "security": [ { "deelToken": [] } ], "summary": "Get Positions by Profile", "tags": [ "Positions" ] } }, "/hris/worker_relations/profile": { "post": { "description": "Establishes a hierarchical relationship between a worker and one or more subordinates. The request body must identify both the parent worker and the subordinate profiles to be linked.\n\n **Token scopes**: `profile:write`", "operationId": "workerRelations_createWorkerRelationProfile", "requestBody": { "content": { "application/json": { "schema": { "properties": { "data": { "$ref": "#/components/schemas/HrisWorkerRelationsProfilePostRequestBodyContentApplicationJsonSchemaData", "description": "The request payload containing the relationship details." } }, "type": "object" } } } }, "responses": { "201": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/worker-relations_createWorkerRelationProfile_Response_201" } } }, "description": "Successful operation" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreateAWorkerRelation-v2026-01-01RequestBadRequestError" } } }, "description": "Bad request - The request body is invalid, missing required fields, or a circular relationship was detected." }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContainer" } } }, "description": "Operation failed." }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContainer" } } }, "description": "Operation failed." }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreateAWorkerRelation-v2026-01-01RequestNotFoundError" } } }, "description": "Not found - The parent profile, child profile, or relationship type was not found." }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContainer" } } }, "description": "Operation failed." } }, "security": [ { "deelToken": [] } ], "summary": "Create a worker relation", "tags": [ "workerRelations" ] } }, "/hris/worker_relations/profile/external": { "post": { "description": "Creates a hierarchical worker relation between a worker and their subordinates, using external IDs to identify all parties. The request body must supply the external IDs of both the parent and child workers along with the relation type.\n\n **Token scopes**: `profile:write`", "operationId": "workerRelations_createWorkerRelationProfileByExternalId", "requestBody": { "content": { "application/json": { "schema": { "properties": { "data": { "$ref": "#/components/schemas/HrisWorkerRelationsProfileExternalPostRequestBodyContentApplicationJsonSchemaData" } }, "type": "object" } } } }, "responses": { "201": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/worker-relations_createWorkerRelationProfileByExternalId_Response_201" } } }, "description": "Successful operation" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContainer" } } }, "description": "Operation failed." }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContainer" } } }, "description": "Operation failed." }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContainer" } } }, "description": "Operation failed." }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContainer" } } }, "description": "Operation failed." }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContainer" } } }, "description": "Operation failed." } }, "security": [ { "deelToken": [] } ], "summary": "Create worker relation with external Ids", "tags": [ "workerRelations" ] } }, "/hris/worker_relations/profile/external/{profileId}": { "delete": { "description": "Removes the worker relation identified by the given external ID. This operation removes all hierarchical associations (parent and child) linked to that relation.\n\n **Token scopes**: `profile:write`", "operationId": "workerRelations_deleteWorkerRelationProfileByExternalId", "parameters": [ { "description": "Worker Relation external ID", "in": "path", "name": "profileId", "required": true, "schema": { "type": "string" } } ], "responses": { "204": { "content": { "application/json": { "schema": { "properties": {}, "type": "object" } } }, "description": "Successfully deleted" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContainer" } } }, "description": "Operation failed." }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContainer" } } }, "description": "Operation failed." }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContainer" } } }, "description": "Operation failed." }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContainer" } } }, "description": "Operation failed." }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContainer" } } }, "description": "Operation failed." } }, "security": [ { "deelToken": [] } ], "summary": "Delete a worker relation by external id", "tags": [ "workerRelations" ] } }, "/hris/worker_relations/profile/external/{profileId}/child": { "put": { "description": "Creates or replaces the child worker relation for the HrisProfile identified by the given external ID. If a child relation already exists for this profile, it is overwritten with the supplied data.\n\n **Token scopes**: `profile:write`", "operationId": "workerRelations_addWorkerRelationChildByExternalId", "parameters": [ { "description": "HrisProfile external ID", "in": "path", "name": "profileId", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "properties": { "data": { "$ref": "#/components/schemas/HrisWorkerRelationsProfileExternalProfileIdChildPutRequestBodyContentApplicationJsonSchemaData" } }, "type": "object" } } } }, "responses": { "204": { "content": { "application/json": { "schema": { "properties": {}, "type": "object" } } }, "description": "Successful operation" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContainer" } } }, "description": "Operation failed." }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContainer" } } }, "description": "Operation failed." }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContainer" } } }, "description": "Operation failed." }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContainer" } } }, "description": "Operation failed." }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContainer" } } }, "description": "Operation failed." } }, "security": [ { "deelToken": [] } ], "summary": "Create child worker relation with external Id", "tags": [ "workerRelations" ] } }, "/hris/worker_relations/profile/external/{profile_id}": { "get": { "description": "Retrieves all worker relationships for a given HRIS profile identified by its external identifier, including parent and child relationships.\n\n **Token scopes**: `profile:read`", "operationId": "workerRelations_getWorkerRelationProfileByExternalId", "parameters": [ { "description": "HrisProfile external ID", "in": "path", "name": "profile_id", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/worker-relations_getWorkerRelationProfileByExternalId_Response_200" } } }, "description": "Successful operation" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FetchWorkerRelationsOfAGivenHrisProfileByExternalId-v2026-01-01RequestBadRequestError" } } }, "description": "Bad request - The provided profileId parameter is invalid or missing." }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContainer" } } }, "description": "Operation failed." }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContainer" } } }, "description": "Operation failed." }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FetchWorkerRelationsOfAGivenHrisProfileByExternalId-v2026-01-01RequestNotFoundError" } } }, "description": "Not found - No HRIS profile exists for the provided externalId." }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContainer" } } }, "description": "Operation failed." } }, "security": [ { "deelToken": [] } ], "summary": "Fetch Worker Relations of a given HrisProfile by external id", "tags": [ "workerRelations" ] } }, "/hris/worker_relations/profile/external/{profile_id}/parent": { "put": { "description": "Sets or replaces the parent relationship for the specified HRIS profile, using external identifiers. Pass null as parent_profile_external_id to remove the existing parent relationship.\n\n **Token scopes**: `profile:write`", "operationId": "workerRelations_addWorkerRelationParentByExternalId", "parameters": [ { "description": "HrisProfile external ID", "in": "path", "name": "profile_id", "required": true, "schema": { "format": "uuid", "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "properties": { "data": { "$ref": "#/components/schemas/HrisWorkerRelationsProfileExternalProfileIdParentPutRequestBodyContentApplicationJsonSchemaData", "description": "The request payload containing parent relationship details." } }, "type": "object" } } } }, "responses": { "204": { "content": { "application/json": { "schema": { "properties": {}, "type": "object" } } }, "description": "Successful operation" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreateAParentWorkerRelationWithExternalId-v2026-01-01RequestBadRequestError" } } }, "description": "Bad request - The request body is invalid or missing required fields." }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContainer" } } }, "description": "Operation failed." }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContainer" } } }, "description": "Operation failed." }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreateAParentWorkerRelationWithExternalId-v2026-01-01RequestNotFoundError" } } }, "description": "Not found - The HRIS profile, relationship type, or parent profile was not found." }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContainer" } } }, "description": "Operation failed." } }, "security": [ { "deelToken": [] } ], "summary": "Create a parent worker relation with external id", "tags": [ "workerRelations" ] } }, "/hris/worker_relations/profile/{hrisProfileOid}": { "delete": { "description": "Removes the worker relation. This operation removes all hierarchical associations (parent and child) linked to that profile.\n\n **Token scopes**: `profile:write`", "operationId": "workerRelations_deleteWorkerRelationProfile", "parameters": [ { "description": "Worker Relation ID", "in": "path", "name": "hrisProfileOid", "required": true, "schema": { "format": "uuid", "type": "string" } } ], "responses": { "204": { "content": { "application/json": { "schema": { "properties": {}, "type": "object" } } }, "description": "Successfully deleted" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContainer" } } }, "description": "Operation failed." }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContainer" } } }, "description": "Operation failed." }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContainer" } } }, "description": "Operation failed." }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContainer" } } }, "description": "Operation failed." }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContainer" } } }, "description": "Operation failed." } }, "security": [ { "deelToken": [] } ], "summary": "Delete a worker relation", "tags": [ "workerRelations" ] }, "get": { "description": "Returns all worker relations associated with the HrisProfile, including both parent and child relationships.\n\n **Token scopes**: `profile:read`", "operationId": "workerRelations_getWorkerRelationProfile", "parameters": [ { "description": "HrisProfile ID", "in": "path", "name": "hrisProfileOid", "required": true, "schema": { "format": "uuid", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/worker-relations_getWorkerRelationProfile_Response_200" } } }, "description": "Successful operation" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContainer" } } }, "description": "Operation failed." }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContainer" } } }, "description": "Operation failed." }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContainer" } } }, "description": "Operation failed." }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContainer" } } }, "description": "Operation failed." }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContainer" } } }, "description": "Operation failed." } }, "security": [ { "deelToken": [] } ], "summary": "List of worker relations", "tags": [ "workerRelations" ] } }, "/hris/worker_relations/profile/{hrisProfileOid}/parent": { "put": { "description": "Creates or replaces the parent worker relation for the HrisProfile. If a parent relation already exists for this profile, it is overwritten with the supplied data.\n\n **Token scopes**: `profile:write`", "operationId": "workerRelations_addWorkerRelationParent", "parameters": [ { "description": "HrisProfile ID", "in": "path", "name": "hrisProfileOid", "required": true, "schema": { "format": "uuid", "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "properties": { "data": { "$ref": "#/components/schemas/HrisWorkerRelationsProfileHrisProfileOidParentPutRequestBodyContentApplicationJsonSchemaData" } }, "type": "object" } } } }, "responses": { "204": { "content": { "application/json": { "schema": { "properties": {}, "type": "object" } } }, "description": "Successful operation" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContainer" } } }, "description": "Operation failed." }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContainer" } } }, "description": "Operation failed." }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContainer" } } }, "description": "Operation failed." }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContainer" } } }, "description": "Operation failed." }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContainer" } } }, "description": "Operation failed." } }, "security": [ { "deelToken": [] } ], "summary": "Create a parent worker relation", "tags": [ "workerRelations" ] } }, "/hris/worker_relations/profile/{hris_profile_oid}/child": { "put": { "description": "Replaces all child relationships of a given type for the specified HRIS profile. Any existing child relationships of that type not included in the request will be removed.\n\n **Token scopes**: `profile:write`", "operationId": "workerRelations_addWorkerRelationChild", "parameters": [ { "description": "HrisProfile ID", "in": "path", "name": "hris_profile_oid", "required": true, "schema": { "format": "uuid", "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "properties": { "data": { "$ref": "#/components/schemas/HrisWorkerRelationsProfileHrisProfileOidChildPutRequestBodyContentApplicationJsonSchemaData" } }, "type": "object" } } } }, "responses": { "204": { "content": { "application/json": { "schema": { "properties": {}, "type": "object" } } }, "description": "Successful operation" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreateChildWorkerRelation-v2026-01-01RequestBadRequestError" } } }, "description": "Bad request - The request body is invalid or missing required fields." }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContainer" } } }, "description": "Operation failed." }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContainer" } } }, "description": "Operation failed." }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreateChildWorkerRelation-v2026-01-01RequestNotFoundError" } } }, "description": "Not found - The HRIS profile or relationship type was not found." }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContainer" } } }, "description": "Operation failed." } }, "security": [ { "deelToken": [] } ], "summary": "Create child worker relation", "tags": [ "workerRelations" ] } }, "/hris/worker_relations/types": { "get": { "description": "Returns all configured worker relation types available in the organization, which define the valid relationship categories that can be assigned when creating or upserting worker relations.\n\n **Token scopes**: `organizations:read`", "operationId": "workerRelations_getWorkerRelationTypes", "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/worker-relations_getWorkerRelationTypes_Response_200" } } }, "description": "Successful operation" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RetrieveAllWorkerRelationTypes-v2026-01-01RequestBadRequestError" } } }, "description": "Operation failed." }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContainer" } } }, "description": "Operation failed." }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContainer" } } }, "description": "Operation failed." }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContainer" } } }, "description": "Operation failed." }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RetrieveAllWorkerRelationTypes-v2026-01-01RequestInternalServerError" } } }, "description": "Operation failed." } }, "security": [ { "deelToken": [] } ], "summary": "Retrieve all worker relation types", "tags": [ "workerRelations" ] }, "post": { "description": "Creates a new worker relation type, defining a named parent–child relationship structure that can be applied to worker associations. The `is_default` flag on the response indicates whether the created type has been set as the default relation type.\n\n **Token scopes**: `organizations:write`", "operationId": "workerRelations_createWorkerRelationType", "requestBody": { "content": { "application/json": { "schema": { "properties": { "data": { "$ref": "#/components/schemas/HrisWorkerRelationsTypesPostRequestBodyContentApplicationJsonSchemaData" } }, "type": "object" } } } }, "responses": { "201": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/worker-relations_createWorkerRelationType_Response_201" } } }, "description": "Successful operation" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreateWorkerRelationType-v2026-01-01RequestBadRequestError" } } }, "description": "Operation failed." }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContainer" } } }, "description": "Operation failed." }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContainer" } } }, "description": "Operation failed." }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContainer" } } }, "description": "Operation failed." }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreateWorkerRelationType-v2026-01-01RequestInternalServerError" } } }, "description": "Operation failed." } }, "security": [ { "deelToken": [] } ], "summary": "Create worker relation type", "tags": [ "workerRelations" ] } }, "/hris/worker_relations/types/external/{externalId}": { "delete": { "description": "Permanently deletes the worker relation type.\n\n **Token scopes**: `organizations:write`", "operationId": "workerRelations_deleteWorkerRelationTypeByExternalId", "parameters": [ { "description": "Worker Relation Type external ID", "in": "path", "name": "externalId", "required": true, "schema": { "type": "string" } } ], "responses": { "204": { "content": { "application/json": { "schema": { "properties": {}, "type": "object" } } }, "description": "Successful operation" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContainer" } } }, "description": "Operation failed." }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContainer" } } }, "description": "Operation failed." }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContainer" } } }, "description": "Operation failed." }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContainer" } } }, "description": "Operation failed." }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContainer" } } }, "description": "Operation failed." } }, "security": [ { "deelToken": [] } ], "summary": "Delete a worker relation type by external id", "tags": [ "workerRelations" ] }, "patch": { "description": "Applies a partial update to a worker relation type. Only fields included in the request body are modified; omitted fields retain their current values.\n\n **Token scopes**: `organizations:write`", "operationId": "workerRelations_updateWorkerRelationTypeByExternalId", "parameters": [ { "description": "Worker Relation Type external ID", "in": "path", "name": "externalId", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "properties": { "data": { "$ref": "#/components/schemas/HrisWorkerRelationsTypesExternalExternalIdPatchRequestBodyContentApplicationJsonSchemaData" } }, "type": "object" } } } }, "responses": { "204": { "content": { "application/json": { "schema": { "properties": {}, "type": "object" } } }, "description": "Successful operation" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContainer" } } }, "description": "Operation failed." }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContainer" } } }, "description": "Operation failed." }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContainer" } } }, "description": "Operation failed." }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContainer" } } }, "description": "Operation failed." }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContainer" } } }, "description": "Operation failed." } }, "security": [ { "deelToken": [] } ], "summary": "Update a worker relation type by external id", "tags": [ "workerRelations" ] } }, "/hris/worker_relations/types/{typeId}": { "patch": { "description": "Applies a partial update to an existing worker relation type. Only fields provided in the request body are modified; omitted fields retain their current values.\n\n **Token scopes**: `organizations:write`", "operationId": "workerRelations_updateWorkerRelationType", "parameters": [ { "description": "Worker Relation Type id", "in": "path", "name": "typeId", "required": true, "schema": { "format": "uuid", "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "properties": { "data": { "$ref": "#/components/schemas/HrisWorkerRelationsTypesTypeIdPatchRequestBodyContentApplicationJsonSchemaData" } }, "type": "object" } } } }, "responses": { "204": { "content": { "application/json": { "schema": { "properties": {}, "type": "object" } } }, "description": "Successful operation" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContainer" } } }, "description": "Operation failed." }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContainer" } } }, "description": "Operation failed." }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContainer" } } }, "description": "Operation failed." }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContainer" } } }, "description": "Operation failed." }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContainer" } } }, "description": "Operation failed." } }, "security": [ { "deelToken": [] } ], "summary": "Update a worker relation type", "tags": [ "workerRelations" ] } }, "/hris/worker_relations/types/{type_id}": { "delete": { "description": "Deletes an existing worker relationship type.\n\n **Token scopes**: `organizations:write`", "operationId": "workerRelations_deleteWorkerRelationType", "parameters": [ { "description": "Worker Relation Type ID", "in": "path", "name": "type_id", "required": true, "schema": { "format": "uuid", "type": "string" } } ], "responses": { "204": { "content": { "application/json": { "schema": { "properties": {}, "type": "object" } } }, "description": "Successfully deleted" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DeleteAWorkerRelationType-v2026-01-01RequestBadRequestError" } } }, "description": "Operation failed." }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContainer" } } }, "description": "Operation failed." }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContainer" } } }, "description": "Operation failed." }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContainer" } } }, "description": "Operation failed." }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DeleteAWorkerRelationType-v2026-01-01RequestInternalServerError" } } }, "description": "Operation failed." } }, "security": [ { "deelToken": [] } ], "summary": "Delete a worker relation type", "tags": [ "workerRelations" ] } }, "/hris/workers/{worker_id}/banks": { "get": { "description": "Use this endpoint when processing payroll for an HRIS worker to retrieve the active bank account details needed for payment disbursement.\n\n **Token scopes**: `people:read`", "operationId": "globalPayroll_getHrisBankAccounts-v2026-09-21", "parameters": [ { "description": "Unique identifier for an HRIS worker.", "in": "path", "name": "worker_id", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Global_Payroll_getHrisBankAccounts-v2026-09-21_Response_200" } } }, "description": "Successful operation." }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContainer" } } }, "description": "Operation failed." }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContainer" } } }, "description": "Operation failed." }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContainer" } } }, "description": "Operation failed." }, "404": { "content": { "application/json": { "schema": { "description": "Any type" } } }, "description": "HrisProfile not found." }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContainer" } } }, "description": "Operation failed." } }, "security": [ { "deelToken": [] } ], "summary": "Retrieve HRIS worker bank accounts", "tags": [ "globalPayroll" ] } }, "/ic/workers/invoices/{invoice_id}": { "get": { "description": "This endpoint retrieves invoice information by ID. Use it to access detailed invoice data for reference or verification.\n\n **Token scopes**: `worker:read`", "operationId": "workers_getInvoiceDetailsById-v2026-04-27", "parameters": [ { "description": "Public invoice id for the invoice to return.", "in": "path", "name": "invoice_id", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Workers_getInvoiceDetailsById-v2026-04-27_Response_200" } } }, "description": "Invoice detail" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetInvoiceDetailsById-v2026-04-27RequestBadRequestError" } } }, "description": "Bad request (invalid query or path parameters)." }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetInvoiceDetailsById-v2026-04-27RequestUnauthorizedError" } } }, "description": "Unauthorized (missing or invalid worker token)." }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetInvoiceDetailsById-v2026-04-27RequestForbiddenError" } } }, "description": "Forbidden (invoice not found or not accessible to this worker)." }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContainer" } } }, "description": "Operation failed." }, "412": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetInvoiceDetailsById-v2026-04-27RequestPreconditionFailedError" } } }, "description": "Precondition failed (e.g. `icEmbeddedWorkerSetup` is not enabled for the organization)." }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetInvoiceDetailsById-v2026-04-27RequestInternalServerError" } } }, "description": "Internal server error." } }, "security": [ { "deelToken": [] } ], "summary": "Get invoice details by ID", "tags": [ "workers" ] } }, "/ic/workers/invoices/{invoice_id}/pdf": { "get": { "description": "This endpoint provides embedded worker flows access to download the PDF for a specific invoice, authenticated with a worker PAT token. It returns a signed, time-limited URL rather than the file itself.\n\n **Token scopes**: `worker:read`", "operationId": "workers_icWorkersInvoicesInvoiceIdPdf-v2026-01-01", "parameters": [ { "description": "Public invoice identifier (UUID) for the invoice whose PDF URL is returned.", "in": "path", "name": "invoice_id", "required": true, "schema": { "format": "uuid", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Workers_icWorkersInvoicesInvoiceIdPdf-v2026-01-01_Response_200" } } }, "description": "Signed PDF URL for download." }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/IcWorkersInvoicesInvoiceIdPdf-v2026-01-01RequestBadRequestError" } } }, "description": "Bad request (invalid query parameters)." }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/IcWorkersInvoicesInvoiceIdPdf-v2026-01-01RequestUnauthorizedError" } } }, "description": "Unauthorized (missing or invalid worker token)." }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/IcWorkersInvoicesInvoiceIdPdf-v2026-01-01RequestForbiddenError" } } }, "description": "Forbidden (invoice not found or not accessible to this worker)." }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContainer" } } }, "description": "Operation failed." }, "412": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/IcWorkersInvoicesInvoiceIdPdf-v2026-01-01RequestPreconditionFailedError" } } }, "description": "Precondition failed (e.g. icEmbeddedWorkerSetup is not enabled for the organization)." }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/IcWorkersInvoicesInvoiceIdPdf-v2026-01-01RequestInternalServerError" } } }, "description": "Internal server error." } }, "security": [ { "deelToken": [] } ], "summary": "Retrieve IC worker invoice PDF download link", "tags": [ "workers" ] } }, "/immigration/cases/{case_id}/timeline": { "get": { "description": "Retrieves the processes, steps and client or employee actions of a case, in order. Requires the case_id returned from the List cases endpoint.\n\n **Token scopes**: `immigration:read`\n\n **Beta**: this version requires the `X-Beta: true` request header and its contract may change before it is promoted to stable. It is scheduled to become stable on 2027-01-14.", "operationId": "immigration_getCaseTimeline-v2026-10-14", "parameters": [ { "description": "The unique identifier of the case whose timeline should be returned.", "in": "path", "name": "case_id", "required": true, "schema": { "format": "uuid", "type": "string" } }, { "description": "Opts in to the beta version of this endpoint. Must be `true`.", "in": "header", "name": "X-Beta", "required": true, "schema": { "$ref": "#/components/schemas/ImmigrationCasesCaseIdTimelineGetParametersXBeta" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Immigration_getCaseTimeline-v2026-10-14_Response_200" } } }, "description": "Successful response with the case timeline." }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetCaseTimeline-v2026-10-14RequestBadRequestError" } } }, "description": "Operation failed." }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContainer" } } }, "description": "Operation failed." }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContainer" } } }, "description": "Operation failed." }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContainer" } } }, "description": "Operation failed." }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetCaseTimeline-v2026-10-14RequestInternalServerError" } } }, "description": "Operation failed." } }, "security": [ { "deelToken": [] } ], "summary": "Get case timeline", "tags": [ "immigration" ] } }, "/immigration/client/cases": { "get": { "description": "Use this endpoint to track the progress of your organization's immigration cases and identify ones that need attention, such as those currently on hold.\n\n **Token scopes**: `immigration:read`", "operationId": "immigration_getClientCases", "parameters": [ { "description": "Search by applicant name or code", "in": "query", "name": "search", "required": false, "schema": { "maxLength": 100, "minLength": 3, "type": "string" } }, { "description": "Filter by case type IDs", "in": "query", "name": "case_type_ids", "required": false, "schema": { "items": { "format": "uuid", "type": "string" }, "type": "array" } }, { "description": "Filter by case status", "in": "query", "name": "statuses", "required": false, "schema": { "items": { "$ref": "#/components/schemas/ImmigrationClientCasesGetParametersStatusesSchemaItems" }, "type": "array" } }, { "description": "Filter by country. Uses ISO 3166-1 alpha-2 codes (https://www.iban.com/country-codes).", "in": "query", "name": "countries", "required": false, "schema": { "items": { "maxLength": 2, "minLength": 2, "pattern": "^[A-Z]{2}$", "type": "string" }, "type": "array" } }, { "description": "Pagination cursor for fetching next set of results", "in": "query", "name": "cursor", "required": false, "schema": { "type": "string" } }, { "description": "Max number of results to return", "in": "query", "name": "limit", "required": false, "schema": { "default": 20, "maximum": 100, "type": "integer" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/immigration_getClientCases_Response_200" } } }, "description": "Successful operation." }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ListOfImmigrationCases-v2026-01-01RequestBadRequestError" } } }, "description": "Operation failed." }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContainer" } } }, "description": "Operation failed." }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContainer" } } }, "description": "Operation failed." }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContainer" } } }, "description": "Operation failed." }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ListOfImmigrationCases-v2026-01-01RequestInternalServerError" } } }, "description": "Operation failed." } }, "security": [ { "deelToken": [] } ], "summary": "List of immigration cases", "tags": [ "immigration" ] }, "post": { "description": "Creates a new immigration case for a worker. The appropriate visa type must be determined before calling this endpoint.\n\n **Token scopes**: `immigration:write`", "operationId": "immigration_createClientCase", "requestBody": { "content": { "application/json": { "schema": { "properties": { "data": { "$ref": "#/components/schemas/ImmigrationClientCasesPostRequestBodyContentApplicationJsonSchemaData" } }, "type": "object" } } } }, "responses": { "201": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/immigration_createClientCase_Response_201" } } }, "description": "Successful operation." }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreateAnImmigrationCase-v2026-01-01RequestBadRequestError" } } }, "description": "Operation failed." }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContainer" } } }, "description": "Operation failed." }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContainer" } } }, "description": "Operation failed." }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContainer" } } }, "description": "Operation failed." }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreateAnImmigrationCase-v2026-01-01RequestInternalServerError" } } }, "description": "Operation failed." } }, "security": [ { "deelToken": [] } ], "summary": "Create an immigration case", "tags": [ "immigration" ] } }, "/immigration/client/cases/{id}": { "get": { "description": "Retrieves the details of an immigration case by its case ID.\n\n **Token scopes**: `immigration:read`", "operationId": "immigration_getClientCase", "parameters": [ { "description": "Immigration case id", "in": "path", "name": "id", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/immigration_getClientCase_Response_200" } } }, "description": "Successful operation." }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetImmigrationCaseDetails-v2026-01-01RequestBadRequestError" } } }, "description": "Operation failed." }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContainer" } } }, "description": "Operation failed." }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContainer" } } }, "description": "Operation failed." }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContainer" } } }, "description": "Operation failed." }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetImmigrationCaseDetails-v2026-01-01RequestInternalServerError" } } }, "description": "Operation failed." } }, "security": [ { "deelToken": [] } ], "summary": "Get immigration case details", "tags": [ "immigration" ] } }, "/immigration/documents/{id}": { "get": { "description": "Retrieves the details of an immigration case document by its document `id`.\n\n **Token scopes**: `immigration:read`", "operationId": "immigration_getDocument", "parameters": [ { "description": "Immigration case document id ", "in": "path", "name": "id", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/immigration_getDocument_Response_200" } } }, "description": "Successful operation." }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ImmigrationDocument-v2026-01-01RequestBadRequestError" } } }, "description": "Operation failed." }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContainer" } } }, "description": "Operation failed." }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContainer" } } }, "description": "Operation failed." }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContainer" } } }, "description": "Operation failed." }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ImmigrationDocument-v2026-01-01RequestInternalServerError" } } }, "description": "Operation failed." } }, "security": [ { "deelToken": [] } ], "summary": "Immigration document", "tags": [ "immigration" ] } }, "/immigration/invoices": { "get": { "description": "Retrieves the invoices issued to the organization for a case, earliest due first. Requires the case_id returned from the List cases endpoint.\n\n **Token scopes**: `immigration:read`\n\n **Beta**: this version requires the `X-Beta: true` request header and its contract may change before it is promoted to stable. It is scheduled to become stable on 2027-01-14.", "operationId": "immigration_listCaseInvoices-v2026-10-14", "parameters": [ { "description": "The unique identifier of the case whose invoices should be listed.", "in": "query", "name": "case_id", "required": true, "schema": { "format": "uuid", "type": "string" } }, { "description": "Opaque pagination cursor returned as next_cursor from a previous response. Omit to fetch the first page.", "in": "query", "name": "cursor", "required": false, "schema": { "type": "string" } }, { "description": "Maximum number of invoices to return. Capped at 100.", "in": "query", "name": "limit", "required": false, "schema": { "default": 20, "maximum": 100, "minimum": 1, "type": "integer" } }, { "description": "Opts in to the beta version of this endpoint. Must be `true`.", "in": "header", "name": "X-Beta", "required": true, "schema": { "$ref": "#/components/schemas/ImmigrationInvoicesGetParametersXBeta" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Immigration_listCaseInvoices-v2026-10-14_Response_200" } } }, "description": "Successful response with the case's invoices." }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ListCaseInvoices-v2026-10-14RequestBadRequestError" } } }, "description": "Operation failed." }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContainer" } } }, "description": "Operation failed." }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContainer" } } }, "description": "Operation failed." }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContainer" } } }, "description": "Operation failed." }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ListCaseInvoices-v2026-10-14RequestInternalServerError" } } }, "description": "Operation failed." } }, "security": [ { "deelToken": [] } ], "summary": "List case invoices", "tags": [ "immigration" ] } }, "/immigration/notes": { "get": { "description": "Retrieves the externally-visible notes for a case, most recent first. Requires the case_id returned from the List cases endpoint.\n\n **Token scopes**: `immigration:read`", "operationId": "immigration_listCaseNotes-v2026-08-10", "parameters": [ { "description": "The unique identifier of the case whose notes should be listed.", "in": "query", "name": "case_id", "required": true, "schema": { "format": "uuid", "type": "string" } }, { "description": "Opaque pagination cursor returned as next_cursor from a previous response. Omit to fetch the first page.", "in": "query", "name": "cursor", "required": false, "schema": { "type": "string" } }, { "description": "Maximum number of notes to return. Capped at 100.", "in": "query", "name": "limit", "required": false, "schema": { "default": 20, "maximum": 100, "type": "integer" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Immigration_listCaseNotes-v2026-08-10_Response_200" } } }, "description": "Successful response with the case's externally-visible notes." }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ListCaseNotes-v2026-08-10RequestBadRequestError" } } }, "description": "Operation failed." }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContainer" } } }, "description": "Operation failed." }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContainer" } } }, "description": "Operation failed." }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContainer" } } }, "description": "Operation failed." }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ListCaseNotes-v2026-08-10RequestInternalServerError" } } }, "description": "Operation failed." } }, "security": [ { "deelToken": [] } ], "summary": "List case notes", "tags": [ "immigration" ] } }, "/immigration/visa-application-quotes": { "get": { "description": "Retrieves the visa application quote Deel proposed on an eligibility check case, with all its fees. Returns an empty list when the case has none. Requires the case_id returned from the List cases endpoint.\n\n **Token scopes**: `immigration:read`\n\n **Beta**: this version requires the `X-Beta: true` request header and its contract may change before it is promoted to stable. It is scheduled to become stable on 2027-01-14.", "operationId": "immigration_listCaseVisaApplicationQuotes-v2026-10-14", "parameters": [ { "description": "The unique identifier of the eligibility check case.", "in": "query", "name": "case_id", "required": true, "schema": { "format": "uuid", "type": "string" } }, { "description": "Opts in to the beta version of this endpoint. Must be `true`.", "in": "header", "name": "X-Beta", "required": true, "schema": { "$ref": "#/components/schemas/ImmigrationVisaApplicationQuotesGetParametersXBeta" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Immigration_listCaseVisaApplicationQuotes-v2026-10-14_Response_200" } } }, "description": "Successful response with the case's visa application quotes." }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ListCaseVisaApplicationQuotes-v2026-10-14RequestBadRequestError" } } }, "description": "Operation failed." }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContainer" } } }, "description": "Operation failed." }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContainer" } } }, "description": "Operation failed." }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContainer" } } }, "description": "Operation failed." }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ListCaseVisaApplicationQuotes-v2026-10-14RequestInternalServerError" } } }, "description": "Operation failed." } }, "security": [ { "deelToken": [] } ], "summary": "List case visa application quotes", "tags": [ "immigration" ] } }, "/immigration/visa-application-quotes/{visa_application_quote_id}/approve": { "post": { "description": "Approves a visa application quote in IN_REVIEW and opens the visa application case, returned as generated_case_id. An approved visa application quote cannot be approved again. Requires the visa application quote id returned from the List case visa application quotes endpoint.\n\n **Token scopes**: `immigration:write`\n\n **Beta**: this version requires the `X-Beta: true` request header and its contract may change before it is promoted to stable. It is scheduled to become stable on 2027-01-14.", "operationId": "immigration_approveVisaApplicationQuote-v2026-10-14", "parameters": [ { "description": "The unique identifier of the visa application quote to approve.", "in": "path", "name": "visa_application_quote_id", "required": true, "schema": { "format": "uuid", "type": "string" } }, { "description": "Opts in to the beta version of this endpoint. Must be `true`.", "in": "header", "name": "X-Beta", "required": true, "schema": { "$ref": "#/components/schemas/ImmigrationVisaApplicationQuotesVisaApplicationQuoteIdApprovePostParametersXBeta" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Immigration_approveVisaApplicationQuote-v2026-10-14_Response_200" } } }, "description": "Successful response with the approved visa application quote." }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApproveVisaApplicationQuote-v2026-10-14RequestBadRequestError" } } }, "description": "Operation failed." }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContainer" } } }, "description": "Operation failed." }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContainer" } } }, "description": "Operation failed." }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContainer" } } }, "description": "Operation failed." }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApproveVisaApplicationQuote-v2026-10-14RequestInternalServerError" } } }, "description": "Operation failed." } }, "security": [ { "deelToken": [] } ], "summary": "Approve a visa application quote", "tags": [ "immigration" ] } }, "/immigration/visa-requirement/business": { "get": { "description": "Analyzes a traveller's nationality, residence country, destination, and trip dates to return the available business visa options along with their fees, estimated timelines, and qualification criteria. An optional `second_nationality` may be provided to expand eligibility assessment.\n\n **Token scopes**: `immigration:read`", "operationId": "immigration_getBusinessVisaRequirement", "parameters": [ { "description": "The destination country code of the trip in ISO 3166-1 alpha-2 format", "in": "query", "name": "destination_country", "required": true, "schema": { "pattern": "^[A-Z]{2}$", "type": "string" } }, { "description": "The nationality country code of the person in ISO 3166-1 alpha-2 format", "in": "query", "name": "nationality", "required": true, "schema": { "pattern": "^[A-Z]{2}$", "type": "string" } }, { "description": "The residence country code of the person in ISO 3166-1 alpha-2 format", "in": "query", "name": "residence_country", "required": true, "schema": { "pattern": "^[A-Z]{2}$", "type": "string" } }, { "description": "The trip start date in ISO 8601 format (YYYY-MM-DD)", "in": "query", "name": "trip_start_date", "required": true, "schema": { "format": "date", "type": "string" } }, { "description": "The trip end date in ISO 8601 format (YYYY-MM-DD)", "in": "query", "name": "trip_end_date", "required": true, "schema": { "format": "date", "type": "string" } }, { "description": "The reason for the trip", "in": "query", "name": "trip_reason", "required": true, "schema": { "$ref": "#/components/schemas/ImmigrationVisaRequirementBusinessGetParametersTripReason" } }, { "description": "The second nationality country code of the person in ISO 3166-1 alpha-2 format (optional)", "in": "query", "name": "second_nationality", "required": false, "schema": { "pattern": "^[A-Z]{2}$", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/immigration_getBusinessVisaRequirement_Response_200" } } }, "description": "Successful operation." }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetBusinessVisaEligibilityAndRequirements-v2026-01-01RequestBadRequestError" } } }, "description": "Operation failed." }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContainer" } } }, "description": "Operation failed." }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContainer" } } }, "description": "Operation failed." }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContainer" } } }, "description": "Operation failed." }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetBusinessVisaEligibilityAndRequirements-v2026-01-01RequestInternalServerError" } } }, "description": "Operation failed." } }, "security": [ { "deelToken": [] } ], "summary": "Get business visa eligibility and requirements", "tags": [ "immigration" ] } }, "/immigration/visa-types/{country_code}": { "get": { "description": "Returns the visa types supported for immigration processing in a country, identified by its Alpha-2 country code.\n\n **Token scopes**: `immigration:read`", "operationId": "immigration_getVisaTypes", "parameters": [ { "description": "Alpha 2 country code", "in": "path", "name": "country_code", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/immigration_getVisaTypes_Response_200" } } }, "description": "Successful operation." }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContainer" } } }, "description": "Operation failed." }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContainer" } } }, "description": "Operation failed." }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContainer" } } }, "description": "Operation failed." }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContainer" } } }, "description": "Operation failed." }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContainer" } } }, "description": "Operation failed." } }, "security": [ { "deelToken": [] } ], "summary": "Immigration visa types", "tags": [ "immigration" ] } }, "/immigration/workers/cases": { "get": { "description": "Retrieves a paginated list of immigration cases with filters for applicant name, case type, status, and country. Returns case details including type, status, process, timestamps, and optional closure information.\n\n **Token scopes**: `worker:read`", "operationId": "immigration_getWorkerCases", "parameters": [ { "description": "Search by applicant name or code", "in": "query", "name": "search", "required": false, "schema": { "maxLength": 100, "minLength": 3, "type": "string" } }, { "description": "Filter by case type IDs", "in": "query", "name": "case_type_ids", "required": false, "schema": { "items": { "format": "uuid", "type": "string" }, "type": "array" } }, { "description": "Filter by case status", "in": "query", "name": "statuses", "required": false, "schema": { "items": { "$ref": "#/components/schemas/ImmigrationWorkersCasesGetParametersStatusesSchemaItems" }, "type": "array" } }, { "description": "Filter by country. Uses ISO 3166-1 alpha-2 codes (https://www.iban.com/country-codes).", "in": "query", "name": "countries", "required": false, "schema": { "items": { "maxLength": 2, "minLength": 2, "pattern": "^[A-Z]{2}$", "type": "string" }, "type": "array" } }, { "description": "Pagination cursor for fetching next set of results", "in": "query", "name": "cursor", "required": false, "schema": { "type": "string" } }, { "description": "Max number of results to return", "in": "query", "name": "limit", "required": false, "schema": { "default": 20, "maximum": 100, "type": "integer" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/immigration_getWorkerCases_Response_200" } } }, "description": "Successful operation." }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ListOfImmigrationCasesForWorkers-v2026-04-02RequestBadRequestError" } } }, "description": "Operation failed." }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContainer" } } }, "description": "Operation failed." }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContainer" } } }, "description": "Operation failed." }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContainer" } } }, "description": "Operation failed." }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ListOfImmigrationCasesForWorkers-v2026-04-02RequestInternalServerError" } } }, "description": "Operation failed." } }, "security": [ { "deelToken": [] } ], "summary": "List of immigration cases for workers", "tags": [ "immigration" ] } }, "/immigration/workers/cases/{case_id}": { "get": { "description": "Get detailed information for a specific immigration case. Use this to check case status and track process progress. The id path parameter is the case UUID returned from the 'Create Client Case' endpoint. Response is enriched with applicant profile, visa type, case status, estimated completion date, process details, and compliance document details.\n\n **Token scopes**: `worker:read`", "operationId": "immigration_getWorkerCase", "parameters": [ { "description": "Filter by case ID", "in": "path", "name": "case_id", "required": true, "schema": { "format": "uuid", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/immigration_getWorkerCase_Response_200" } } }, "description": "Successful operation." }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetSpecificImmigrationCaseDetails-v2026-04-02RequestBadRequestError" } } }, "description": "Operation failed." }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContainer" } } }, "description": "Operation failed." }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContainer" } } }, "description": "Operation failed." }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContainer" } } }, "description": "Operation failed." }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetSpecificImmigrationCaseDetails-v2026-04-02RequestInternalServerError" } } }, "description": "Operation failed." } }, "security": [ { "deelToken": [] } ], "summary": "Get specific immigration case details ", "tags": [ "immigration" ] } }, "/immigration/workers/{worker_id}/cases/{case_id}/required-document": { "get": { "description": "Retrieves the details of a specific document requirement within a worker's immigration case, including the requirement's current status and information about any previously rejected document.\n\n **Token scopes**: `worker:read`", "operationId": "immigration_getWorkerCaseRequiredDocument", "parameters": [ { "description": "The hris profile oid (public id) of the worker.", "in": "path", "name": "worker_id", "required": true, "schema": { "type": "string" } }, { "description": "The unique identifier of the case for which the required document is being requested.", "in": "path", "name": "case_id", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/immigration_getWorkerCaseRequiredDocument_Response_200" } } }, "description": "Successful operation." }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContainer" } } }, "description": "Operation failed." }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContainer" } } }, "description": "Operation failed." }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContainer" } } }, "description": "Operation failed." }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContainer" } } }, "description": "Operation failed." }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContainer" } } }, "description": "Operation failed." } }, "security": [ { "deelToken": [] } ], "summary": "Retrieve a required document for a case", "tags": [ "immigration" ] } }, "/immigration/workers/{worker_id}/cases/{case_id}/required-document/{document_request_id}": { "post": { "description": "Uploads a document against a specific case document requirement and submits it for review.\n\n **Token scopes**: `worker:write`", "operationId": "immigration_createWorkerCaseRequiredDocument", "parameters": [ { "description": "The hris profile oid (public id) of the worker.", "in": "path", "name": "worker_id", "required": true, "schema": { "type": "string" } }, { "description": "The unique identifier of the case for which the required document is being requested.", "in": "path", "name": "case_id", "required": true, "schema": { "type": "string" } }, { "description": "The unique identifier of the document request fo which this document is being uplodaded", "in": "path", "name": "document_request_id", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "multipart/form-data": { "schema": { "properties": { "data": { "$ref": "#/components/schemas/ImmigrationWorkersWorkerIdCasesCaseIdRequiredDocumentDocumentRequestIdPostRequestBodyContentMultipartFormDataSchemaData", "description": "Details of immigration document upload" } }, "required": [ "data" ], "type": "object" } } }, "description": "Upload of immigration document" }, "responses": { "201": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/immigration_createWorkerCaseRequiredDocument_Response_201" } } }, "description": "Document uploaded." }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContainer" } } }, "description": "Operation failed." }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContainer" } } }, "description": "Operation failed." }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContainer" } } }, "description": "Operation failed." }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContainer" } } }, "description": "Operation failed." }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContainer" } } }, "description": "Operation failed." } }, "security": [ { "deelToken": [] } ], "summary": "Upload a required immigration document", "tags": [ "immigration" ] } }, "/immigration/workers/{worker_id}/onboarding-case": { "get": { "description": "Returns the right-to-work onboarding case for a worker, including any associated documents; returns an empty response if no open case exists. When a worker is associated with multiple contracts, supply `contract_id` to target a specific contract.\n\n **Token scopes**: `worker:read`", "operationId": "immigration_getWorkerOnboardingCase", "parameters": [ { "description": "The hris profile oid (public id) of the worker.", "in": "path", "name": "worker_id", "required": true, "schema": { "type": "string" } }, { "description": "Filters the worker's onboarding case to a specific contract. If the worker has multiple contracts and this parameter is omitted, the response may return a case from any associated contract; the response includes contract.id to indicate which contract was used. Provide this parameter for deterministic results.", "in": "query", "name": "contract_id", "required": false, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/immigration_getWorkerOnboardingCase_Response_200" } } }, "description": "Successful operation." }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RetrieveOnboardingRightToWorkCaseForAWorker-v2026-01-01RequestBadRequestError" } } }, "description": "Operation failed." }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContainer" } } }, "description": "Operation failed." }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContainer" } } }, "description": "Operation failed." }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RetrieveOnboardingRightToWorkCaseForAWorker-v2026-01-01RequestNotFoundError" } } }, "description": "Case not found." }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RetrieveOnboardingRightToWorkCaseForAWorker-v2026-01-01RequestInternalServerError" } } }, "description": "Operation failed." } }, "security": [ { "deelToken": [] } ], "summary": "Retrieve the legacy onboarding right-to-work case for a worker", "tags": [ "immigration" ] } }, "/industries": { "get": { "description": "Lists industry subcategories with their parent category details and NAICS codes, supporting cursor-based pagination and sorting by category or subcategory name.\n\n **Token scopes**: `legal-entity:read`", "operationId": "legalEntities_getIndustries", "parameters": [ { "description": "Maximum number of items to return per page.", "in": "query", "name": "limit", "required": false, "schema": { "minimum": 1, "type": "integer" } }, { "description": "Sorting order of the results.", "in": "query", "name": "order", "required": false, "schema": { "$ref": "#/components/schemas/IndustriesGetParametersOrder", "default": "ASC" } }, { "description": "Field used to sort the results.", "in": "query", "name": "sort_by", "required": false, "schema": { "$ref": "#/components/schemas/IndustriesGetParametersSortBy", "default": "categoryName" } }, { "description": "Cursor used for paginating to the next page of results.", "in": "query", "name": "cursor", "required": false, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/legal-entities_getIndustries_Response_200" } } }, "description": "List of industry subcategories." }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ListAllIndustrySubcategories-v2026-01-01RequestBadRequestError" } } }, "description": "Operation failed." }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContainer" } } }, "description": "Operation failed." }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContainer" } } }, "description": "Operation failed." }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContainer" } } }, "description": "Operation failed." }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContainer" } } }, "description": "Operation failed." } }, "security": [ { "deelToken": [] } ], "summary": "List all industry subcategories", "tags": [ "legalEntities" ] } }, "/integrations/consent": { "get": { "description": "Retrieves the OAuth consent record for the authenticated user or organization, including its current status, granted scope, and expiry.", "operationId": "integrations_getIntegrationConsent-v2026-01-01", "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Integrations_getIntegrationConsent-v2026-01-01_Response_200" } } }, "description": "Successful operation." }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContainer" } } }, "description": "Operation failed." }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContainer" } } }, "description": "Operation failed." }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContainer" } } }, "description": "Operation failed." }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContainer" } } }, "description": "Operation failed." }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContainer" } } }, "description": "Operation failed." } }, "security": [ { "deelToken": [] } ], "summary": "Get integration consent", "tags": [ "integrations" ] } }, "/invoice-adjustments": { "get": { "description": "Returns invoice adjustments, optionally filtered by contract, adjustment type, status, invoice, reporter, or submission date range.\n\n **Token scopes**: `invoice-adjustments:read`", "operationId": "invoiceAdjustments_getInvoiceAdjustments", "parameters": [ { "description": "Id of an Deel contract.", "in": "query", "name": "contract_id", "required": false, "schema": { "type": "string" } }, { "description": "types of contracts to filter", "in": "query", "name": "contract_types", "required": false, "schema": { "items": { "$ref": "#/components/schemas/InvoiceAdjustmentsGetParametersContractTypesSchemaItems" }, "type": "array" } }, { "description": "types of invoice adjustments to filter", "in": "query", "name": "types", "required": false, "schema": { "items": { "$ref": "#/components/schemas/InvoiceAdjustmentsGetParametersTypesSchemaItems" }, "type": "array" } }, { "description": "statuses of invoice adjustment to filter", "in": "query", "name": "statuses", "required": false, "schema": { "items": { "$ref": "#/components/schemas/InvoiceAdjustmentsGetParametersStatusesSchemaItems" }, "type": "array" } }, { "description": "ID of an existing invoice", "in": "query", "name": "invoice_id", "required": false, "schema": { "type": "string" } }, { "description": "ID of an existing profile", "in": "query", "name": "reporter_id", "required": false, "schema": { "format": "uuid", "type": "string" } }, { "description": "To get invoice adjustments submitted on or after given start date (inclusive). Short date in format ISO-8601 (YYYY-MM-DD). For example: 2022-12-31.", "in": "query", "name": "date_from", "required": false, "schema": { "format": "date", "type": "string" } }, { "description": "To get invoice adjustments submitted before given end date (excludes records submitted on this date). Short date in format ISO-8601 (YYYY-MM-DD). For example: 2022-12-31.", "in": "query", "name": "date_to", "required": false, "schema": { "format": "date", "type": "string" } }, { "description": "Return a page of results with given number of records; NOTE: technically ALL query parameters are strings or array of strings", "in": "query", "name": "limit", "required": false, "schema": { "pattern": "^[1-9][0-9]?$|^100$", "type": "string" } }, { "description": "Return a page of results after given index of row; NOTE: technically ALL query parameters are strings or array of strings", "in": "query", "name": "offset", "required": false, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/invoice-adjustments_getInvoiceAdjustments_Response_200" } } }, "description": "Successful operation." }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ListInvoiceAdjustments-v2026-01-01RequestBadRequestError" } } }, "description": "Bad Request" }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContainer" } } }, "description": "Operation failed." }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContainer" } } }, "description": "Operation failed." }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContainer" } } }, "description": "Operation failed." }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContainer" } } }, "description": "Operation failed." } }, "security": [ { "deelToken": [] } ], "summary": "List invoice adjustments", "tags": [ "invoiceAdjustments" ] }, "post": { "description": "Creates an invoice adjustment — such as a bonus, commission, VAT percentage, or deduction — against a contract. Pass the `recurring` query parameter to apply the adjustment automatically to future invoices.\n\n **Token scopes**: `invoice-adjustments:write`, `worker:write`", "operationId": "invoiceAdjustments_createInvoiceAdjustment", "parameters": [ { "description": "Add this invoice adjustment as recurring", "in": "query", "name": "recurring", "required": false, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "properties": { "data": { "$ref": "#/components/schemas/InvoiceAdjustmentsPostRequestBodyContentApplicationJsonSchemaData", "description": "Payload attributes required to create one invoice adjustment with optional approval, preset, and grouping metadata." } }, "required": [ "data" ], "type": "object" } } }, "description": "InvoiceAdjustment object that needs to be created" }, "responses": { "201": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/invoice-adjustments_createInvoiceAdjustment_Response_201" } } }, "description": "Successful operation." }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreateAnInvoiceAdjustment-v2026-01-01RequestBadRequestError" } } }, "description": "Bad Request - The request payload failed validation or violated a business rule for invoice adjustments." }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContainer" } } }, "description": "Operation failed." }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContainer" } } }, "description": "Operation failed." }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContainer" } } }, "description": "Operation failed." }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreateAnInvoiceAdjustment-v2026-01-01RequestInternalServerError" } } }, "description": "Internal Server Error - The invoice adjustment could not be created due to an unexpected upstream or internal failure." } }, "security": [ { "deelToken": [] } ], "summary": "Create an invoice adjustment", "tags": [ "invoiceAdjustments" ] } }, "/invoice-adjustments/{id}": { "delete": { "description": "Permanently removes an invoice adjustment by its `id`.\n\n **Token scopes**: `invoice-adjustments:write`", "operationId": "invoiceAdjustments_deleteInvoiceAdjustment", "parameters": [ { "description": "Invoice adjustment id.", "in": "path", "name": "id", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/invoice-adjustments_deleteInvoiceAdjustment_Response_200" } } }, "description": "Successful operation." }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContainer" } } }, "description": "Operation failed." }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContainer" } } }, "description": "Operation failed." }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContainer" } } }, "description": "Operation failed." }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContainer" } } }, "description": "Operation failed." }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContainer" } } }, "description": "Operation failed." } }, "security": [ { "deelToken": [] } ], "summary": "Delete adjustment", "tags": [ "invoiceAdjustments" ] }, "get": { "description": "Retrieves a single invoice line item by its `id`.\n\n **Token scopes**: `invoice-adjustments:read`, `worker:read`", "operationId": "invoiceAdjustments_getInvoiceAdjustmentById", "parameters": [ { "description": "ID of an existing invoice", "in": "path", "name": "id", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/invoice-adjustments_getInvoiceAdjustmentById_Response_200" } } }, "description": "Successful operation." }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/InvoiceLineItemById-v2026-01-01RequestBadRequestError" } } }, "description": "Fetch failed." }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContainer" } } }, "description": "Operation failed." }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContainer" } } }, "description": "Operation failed." }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContainer" } } }, "description": "Operation failed." }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContainer" } } }, "description": "Operation failed." } }, "security": [ { "deelToken": [] } ], "summary": "Invoice line item by Id", "tags": [ "invoiceAdjustments" ] }, "patch": { "description": "Updates an existing invoice adjustment in place. Use it when an adjustment needs correcting instead of deleting it and creating a new one. VAT adjustments cannot be edited and must be deleted and created again, and work adjustments can be edited only on ongoing time-based or pay-as-you-go time-based contracts, since other contracts manage them through timesheets.\n\n **Token scopes**: `invoice-adjustments:write`, `worker:write`", "operationId": "invoiceAdjustments_updateInvoiceAdjustment", "parameters": [ { "description": "Invoice adjustment id.", "in": "path", "name": "id", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "properties": { "data": { "$ref": "#/components/schemas/InvoiceAdjustmentsIdPatchRequestBodyContentApplicationJsonSchemaData", "description": "Details of adjustment to update" } }, "required": [ "data" ], "type": "object" } } } }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/invoice-adjustments_updateInvoiceAdjustment_Response_200" } } }, "description": "Successful operation." }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UpdateAnInvoiceAdjustment-v2026-01-01RequestBadRequestError" } } }, "description": "Bad Request - The request payload failed validation or violated a business rule for the invoice adjustment." }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContainer" } } }, "description": "Operation failed." }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UpdateAnInvoiceAdjustment-v2026-01-01RequestForbiddenError" } } }, "description": "Forbidden - The requester does not have access to the specified invoice adjustment." }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UpdateAnInvoiceAdjustment-v2026-01-01RequestNotFoundError" } } }, "description": "Not Found - The specified invoice adjustment does not exist." }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UpdateAnInvoiceAdjustment-v2026-01-01RequestInternalServerError" } } }, "description": "Internal Server Error - The invoice adjustment could not be updated due to an unexpected upstream or internal failure." } }, "security": [ { "deelToken": [] } ], "summary": "Update an invoice adjustment", "tags": [ "invoiceAdjustments" ] } }, "/invoice-adjustments/{id}/reviews": { "post": { "description": "Submits an approve or decline review decision for a single invoice adjustment.\n\n **Token scopes**: `invoice-adjustments:write`", "operationId": "invoiceAdjustments_createInvoiceAdjustmentReview", "parameters": [ { "description": "ID of an existing invoice adjustment.", "in": "path", "name": "id", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "properties": { "data": { "$ref": "#/components/schemas/InvoiceAdjustmentsIdReviewsPostRequestBodyContentApplicationJsonSchemaData" } }, "required": [ "data" ], "type": "object" } } } }, "responses": { "201": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/invoice-adjustments_createInvoiceAdjustmentReview_Response_201" } } }, "description": "Successful operation." }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UpdateInvoiceAdjustmentById-v2026-01-01RequestBadRequestError" } } }, "description": "Bad Request - The request payload failed validation or violated a business rule for the invoice adjustment review." }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContainer" } } }, "description": "Operation failed." }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContainer" } } }, "description": "Operation failed." }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UpdateInvoiceAdjustmentById-v2026-01-01RequestNotFoundError" } } }, "description": "Not Found - The specified invoice adjustment could not be found for review." }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UpdateInvoiceAdjustmentById-v2026-01-01RequestInternalServerError" } } }, "description": "Internal Server Error - The invoice adjustment review could not be processed due to an unexpected upstream or internal failure." } }, "security": [ { "deelToken": [] } ], "summary": "Review a single invoice adjustment", "tags": [ "invoiceAdjustments" ] } }, "/invoices": { "get": { "description": "Returns a paginated list of invoices; by default only paid invoices are returned, but passing `status=all` returns invoices in all statuses. Supports both offset- and cursor-based pagination.\n\n **Token scopes**: `accounting:read`", "operationId": "accounting_retrieveInvoices-v2026-01-01", "parameters": [ { "description": "Filter invoices issued on or after the specified date.", "in": "query", "name": "issued_from_date", "required": false, "schema": { "type": "string" } }, { "description": "Filter invoices issued before the specified date.", "in": "query", "name": "issued_to_date", "required": false, "schema": { "type": "string" } }, { "description": "If status query has value of all, all invoices will be returned. Otherwise only paid invoices will be fetched.", "in": "query", "name": "status", "required": false, "schema": { "$ref": "#/components/schemas/InvoicesGetParametersStatus" } }, { "description": "Number of records to retrieve per page.", "in": "query", "name": "limit", "required": false, "schema": { "default": 25, "format": "double", "maximum": 50, "minimum": 1, "type": "number" } }, { "description": "Index of the first record to return.", "in": "query", "name": "offset", "required": false, "schema": { "default": 0, "format": "int64", "maximum": 999999999, "minimum": 0, "type": "integer" } }, { "description": "Return next page of results after the given cursor.", "in": "query", "name": "cursor", "required": false, "schema": { "type": "string" } }, { "description": "Will include invoices from COR workers in the response.", "in": "query", "name": "include", "required": false, "schema": { "$ref": "#/components/schemas/InvoicesGetParametersInclude" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Accounting_retrieveInvoices-v2026-01-01_Response_200" } } }, "description": "Successful operation." }, "400": { "content": { "application/json": { "schema": { "items": { "$ref": "#/components/schemas/InvoicesGetResponsesContentApplicationJsonSchemaItems" }, "type": "array" } } }, "description": "Operation failed." }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContainer" } } }, "description": "Operation failed." }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContainer" } } }, "description": "Operation failed." }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContainer" } } }, "description": "Operation failed." }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContainer" } } }, "description": "Operation failed." } }, "security": [ { "deelToken": [] } ], "summary": "Retrieve invoices", "tags": [ "accounting" ] } }, "/invoices/deel": { "get": { "description": "Returns a paginated list of invoices for Deel platform fees.\n\n **Token scopes**: `accounting:read`", "operationId": "accounting_retrieveDeelInvoices-v2026-01-01", "parameters": [ { "description": "Return a page of results with given number of records; NOTE technically ALL query parameters are strings or array of strings", "in": "query", "name": "limit", "required": false, "schema": { "type": "string" } }, { "description": "Return a page of results after given index of row; NOTE technically ALL query parameters are strings or array of strings'", "in": "query", "name": "offset", "required": false, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Accounting_retrieveDeelInvoices-v2026-01-01_Response_200" } } }, "description": "Successful response" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RetrieveDeelInvoices-v2026-01-01RequestBadRequestError" } } }, "description": "Validation error" }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContainer" } } }, "description": "Operation failed." }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContainer" } } }, "description": "Operation failed." }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContainer" } } }, "description": "Operation failed." }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContainer" } } }, "description": "Operation failed." } }, "security": [ { "deelToken": [] } ], "summary": "Retrieve Deel invoices", "tags": [ "accounting" ] } }, "/invoices/{id}/download": { "get": { "description": "Returns a temporary download URL for an invoice PDF. Use this endpoint when a caller needs to fetch or display the PDF for a specific invoice; the URL expires at the time indicated by `expires_at` in the response, after which it must be re-requested.\n\n **Token scopes**: `accounting:read`", "operationId": "accounting_getBillingInvoiceDownloadLink-v2026-01-01", "parameters": [ { "description": "The invoice ID used to identify the invoice to be downloaded.", "in": "path", "name": "id", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Accounting_getBillingInvoiceDownloadLink-v2026-01-01_Response_200" } } }, "description": "Successful operation." }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContainer" } } }, "description": "Operation failed." }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContainer" } } }, "description": "Operation failed." }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContainer" } } }, "description": "Operation failed." }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetBillingInvoiceDownloadLink-v2026-01-01RequestNotFoundError" } } }, "description": "Invoice not found" }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContainer" } } }, "description": "Operation failed." } }, "security": [ { "deelToken": [] } ], "summary": "Download invoice PDF", "tags": [ "accounting" ] } }, "/invoices/{invoice_id}": { "get": { "description": "Retrieves the details of a single invoice by `invoice_id`.\n\n **Token scopes**: `accounting:read`", "operationId": "accounting_getInvoiceById-v2026-01-01", "parameters": [ { "description": "The invoice ID used to identify the invoice to be retrieved.", "in": "path", "name": "invoice_id", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Accounting_getInvoiceById-v2026-01-01_Response_200" } } }, "description": "The invoice resource returned" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContainer" } } }, "description": "Operation failed." }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContainer" } } }, "description": "Operation failed." }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContainer" } } }, "description": "Operation failed." }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetInvoiceById-v2026-01-01RequestNotFoundError" } } }, "description": "Invoice not found" }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContainer" } } }, "description": "Operation failed." } }, "security": [ { "deelToken": [] } ], "summary": "Get invoice by id", "tags": [ "accounting" ] } }, "/it/agreements": { "get": { "description": "Lists the rental agreements your organization holds with Deel, each with its current store-and-reuse state. Call this to find agreements whose device is free to hand to a different worker — an agreement in `store_and_reuse.status = READY` can be reassigned via `POST /rest/it/agreements/{agreement_id}/reassign`.\n\n **Token scopes**: `it-agreements:read`\n\n **Beta**: this version requires the `X-Beta: true` request header and its contract may change before it is promoted to stable. It is scheduled to become stable on 2026-12-15.", "operationId": "itAgreements_listItAgreements-v2026-09-15", "parameters": [ { "description": "Indicates where the next page of results starts, as returned in a paginated list response", "in": "query", "name": "cursor", "required": false, "schema": { "type": "string" } }, { "description": "Return a page of results with given number of records", "in": "query", "name": "limit", "required": false, "schema": { "default": 20, "maximum": 100, "minimum": 1, "type": "integer" } }, { "description": "Filter agreements by status. Repeat the key to filter on multiple values.", "in": "query", "name": "status", "required": false, "schema": { "$ref": "#/components/schemas/ItAgreementsGetParametersStatus" } }, { "description": "Filter agreements by type. Repeat the key to filter on multiple values.", "in": "query", "name": "type", "required": false, "schema": { "$ref": "#/components/schemas/ItAgreementsGetParametersType" } }, { "description": "Filter rentals by store-and-reuse status. Repeat the key to filter on multiple values.", "in": "query", "name": "store_and_reuse_status", "required": false, "schema": { "$ref": "#/components/schemas/ItAgreementsGetParametersStoreAndReuseStatus" } }, { "description": "Filter by the HRIS profile id currently holding the agreement.", "in": "query", "name": "hris_profile_id", "required": false, "schema": { "format": "uuid", "type": "string" } }, { "description": "Opts in to the beta version of this endpoint. Must be `true`.", "in": "header", "name": "X-Beta", "required": true, "schema": { "$ref": "#/components/schemas/ItAgreementsGetParametersXBeta" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/IT_agreements_listItAgreements-v2026-09-15_Response_200" } } }, "description": "OK" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ListItAgreements-v2026-09-15RequestBadRequestError" } } }, "description": "Bad Request" }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContainer" } } }, "description": "Operation failed." }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContainer" } } }, "description": "Operation failed." }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContainer" } } }, "description": "Operation failed." }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ListItAgreements-v2026-09-15RequestInternalServerError" } } }, "description": "Internal Server Error" } }, "security": [ { "deelToken": [] } ], "summary": "List agreements", "tags": [ "itAgreements" ] } }, "/it/agreements/{agreement_id}": { "get": { "description": "Retrieves one rental agreement, including the reuse context needed to reassign it: `actions.reuse.details.reusable_variants` lists the device variants the next holder can receive. Call this before `POST /rest/it/agreements/{agreement_id}/reassign` to pick a `variant_id`.\n\n **Token scopes**: `it-agreements:read`\n\n **Beta**: this version requires the `X-Beta: true` request header and its contract may change before it is promoted to stable. It is scheduled to become stable on 2026-12-15.", "operationId": "itAgreements_retrieveAnItAgreement-v2026-09-15", "parameters": [ { "description": "Unique identifier of the agreement", "in": "path", "name": "agreement_id", "required": true, "schema": { "format": "uuid", "type": "string" } }, { "description": "Opts in to the beta version of this endpoint. Must be `true`.", "in": "header", "name": "X-Beta", "required": true, "schema": { "$ref": "#/components/schemas/ItAgreementsAgreementIdGetParametersXBeta" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/IT_agreements_retrieveAnItAgreement-v2026-09-15_Response_200" } } }, "description": "OK" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RetrieveAnItAgreement-v2026-09-15RequestBadRequestError" } } }, "description": "Bad Request" }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContainer" } } }, "description": "Operation failed." }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContainer" } } }, "description": "Operation failed." }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RetrieveAnItAgreement-v2026-09-15RequestNotFoundError" } } }, "description": "Not Found" }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RetrieveAnItAgreement-v2026-09-15RequestInternalServerError" } } }, "description": "Internal Server Error" } }, "security": [ { "deelToken": [] } ], "summary": "Retrieve an agreement", "tags": [ "itAgreements" ] } }, "/it/agreements/{agreement_id}/reassign": { "post": { "description": "Use this when a worker leaves and their rented device should pass to a new joiner rather than return to Deel. Reassigns a rental agreement to a new HRIS profile via store-and-reuse. The caller picks a `variant_id` from `actions.reuse.details.reusable_variants` on `GET /rest/it/agreements/{agreement_id}` and supplies the new holder's delivery address. Transitions `store_and_reuse.status` from `READY` to `IN_PROGRESS` and returns the updated agreement.\n\n **Token scopes**: `it-service-requests:write`\n\n **Beta**: this version requires the `X-Beta: true` request header and its contract may change before it is promoted to stable. It is scheduled to become stable on 2026-12-17.", "operationId": "itAgreements_reassignItAgreement-v2026-09-17", "parameters": [ { "description": "Unique identifier of the agreement", "in": "path", "name": "agreement_id", "required": true, "schema": { "format": "uuid", "type": "string" } }, { "description": "Opts in to the beta version of this endpoint. Must be `true`.", "in": "header", "name": "X-Beta", "required": true, "schema": { "$ref": "#/components/schemas/ItAgreementsAgreementIdReassignPostParametersXBeta" } } ], "requestBody": { "content": { "application/json": { "schema": { "properties": { "data": { "$ref": "#/components/schemas/ItAgreementsAgreementIdReassignPostRequestBodyContentApplicationJsonSchemaData", "description": "Reassignment payload." } }, "required": [ "data" ], "type": "object" } } }, "description": "Reassignment details" }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/IT_agreements_reassignItAgreement-v2026-09-17_Response_200" } } }, "description": "OK" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ReassignItAgreement-v2026-09-17RequestBadRequestError" } } }, "description": "Bad Request" }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ReassignItAgreement-v2026-09-17RequestUnauthorizedError" } } }, "description": "Unauthorized" }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ReassignItAgreement-v2026-09-17RequestForbiddenError" } } }, "description": "Forbidden" }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ReassignItAgreement-v2026-09-17RequestNotFoundError" } } }, "description": "Not Found" }, "409": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ReassignItAgreement-v2026-09-17RequestConflictError" } } }, "description": "Conflict" }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ReassignItAgreement-v2026-09-17RequestInternalServerError" } } }, "description": "Internal Server Error" } }, "security": [ { "deelToken": [] } ], "summary": "Assign agreement to a new worker", "tags": [ "itAgreements" ] } }, "/it/assets": { "get": { "description": "Lists the IT assets your organization owns or rents, current and historical, with status and assignment metadata. Use it to reconcile Deel's inventory against your own MDM or CMDB, filtering by holder, location, category, or status.\n\n **Token scopes**: `it-assets:read`", "operationId": "itAssets_listItAssets-v2026-01-01", "parameters": [ { "description": "Indicates where the next page of results starts, as returned in a paginated list response", "in": "query", "name": "cursor", "required": false, "schema": { "type": "string" } }, { "description": "Return a page of results with given number of records", "in": "query", "name": "limit", "required": false, "schema": { "default": 20, "maximum": 100, "minimum": 1, "type": "integer" } }, { "description": "Filter assets by assigned worker with given HRIS Profile ID", "in": "query", "name": "hris_profile_id", "required": false, "schema": { "format": "uuid", "type": "string" } }, { "description": "Filter assets by their location", "in": "query", "name": "location", "required": false, "schema": { "$ref": "#/components/schemas/ItAssetsGetParametersLocation" } }, { "description": "Filter assets by their product category", "in": "query", "name": "category", "required": false, "schema": { "$ref": "#/components/schemas/ItAssetsGetParametersCategory" } }, { "description": "Filter assets by their status", "in": "query", "name": "status", "required": false, "schema": { "$ref": "#/components/schemas/ItAssetsGetParametersStatus" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/IT_assets_listItAssets-v2026-01-01_Response_200" } } }, "description": "OK" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ListItAssets-v2026-01-01RequestBadRequestError" } } }, "description": "Bad Request" }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContainer" } } }, "description": "Operation failed." }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContainer" } } }, "description": "Operation failed." }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContainer" } } }, "description": "Operation failed." }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ListItAssets-v2026-01-01RequestInternalServerError" } } }, "description": "Internal Server Error" } }, "security": [ { "deelToken": [] } ], "summary": "List IT assets", "tags": [ "itAssets" ] }, "post": { "description": "Creates a new IT asset in your organization. The asset is either assigned to a worker (WITH_USER) or stored at one of your organization warehouses (AT_WAREHOUSE). A product and product variant are created behind the scenes for this asset. Device categories (laptops, desktops, mobile devices, tablets) require a serial number, and require an operating system when the category supports one.\n\n **Token scopes**: `it-assets:write`\n\n **Beta**: this version requires the `X-Beta: true` request header and its contract may change before it is promoted to stable. It is scheduled to become stable on 2026-12-15.", "operationId": "itAssets_createAsset-v2026-09-15", "parameters": [ { "description": "Opts in to the beta version of this endpoint. Must be `true`.", "in": "header", "name": "X-Beta", "required": true, "schema": { "$ref": "#/components/schemas/ItAssetsPostParametersXBeta" } } ], "requestBody": { "content": { "application/json": { "schema": { "properties": { "data": { "$ref": "#/components/schemas/ItAssetsPostRequestBodyContentApplicationJsonSchemaData" } }, "required": [ "data" ], "type": "object" } } }, "description": "Asset to create" }, "responses": { "201": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/IT_assets_createAsset-v2026-09-15_Response_201" } } }, "description": "Created" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreateAsset-v2026-09-15RequestBadRequestError" } } }, "description": "Bad Request" }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreateAsset-v2026-09-15RequestUnauthorizedError" } } }, "description": "Unauthorized" }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreateAsset-v2026-09-15RequestForbiddenError" } } }, "description": "Forbidden" }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreateAsset-v2026-09-15RequestNotFoundError" } } }, "description": "Not Found" }, "409": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreateAsset-v2026-09-15RequestConflictError" } } }, "description": "Conflict" }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreateAsset-v2026-09-15RequestInternalServerError" } } }, "description": "Internal Server Error" } }, "security": [ { "deelToken": [] } ], "summary": "Create an IT asset", "tags": [ "itAssets" ] } }, "/it/assets/{asset_id}": { "get": { "description": "Retrieves details of a single IT asset. Use it to reconcile a device against your own inventory record, or to pull asset details into a procurement or support tool.\n\n **Token scopes**: `it-assets:read`", "operationId": "itAssets_retrieveAnItAsset-v2026-01-01", "parameters": [ { "description": "Unique identifier of the IT asset", "in": "path", "name": "asset_id", "required": true, "schema": { "format": "uuid", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/IT_assets_retrieveAnItAsset-v2026-01-01_Response_200" } } }, "description": "OK" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RetrieveAnItAsset-v2026-01-01RequestBadRequestError" } } }, "description": "Bad Request" }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContainer" } } }, "description": "Operation failed." }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContainer" } } }, "description": "Operation failed." }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContainer" } } }, "description": "Operation failed." }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RetrieveAnItAsset-v2026-01-01RequestInternalServerError" } } }, "description": "Internal Server Error" } }, "security": [ { "deelToken": [] } ], "summary": "Retrieve an IT asset", "tags": [ "itAssets" ] }, "patch": { "description": "Updates the detail fields of an asset owned by the calling organization. Only the fields present in the request body are changed; a field the caller omits keeps its current value, so there is no way to clear a field back to empty. Changing `serial_number` unenrolls the asset from MDM device management. Assets whose detail fields are locked — archived or Deel-owned assets, or assets covered by an active service package — are rejected.\n\n **Token scopes**: `it-assets:write`\n\n **Beta**: this version requires the `X-Beta: true` request header and its contract may change before it is promoted to stable. It is scheduled to become stable on 2026-12-29.", "operationId": "itAssets_updateAsset-v2026-09-29", "parameters": [ { "description": "Unique identifier of the IT asset", "in": "path", "name": "asset_id", "required": true, "schema": { "format": "uuid", "type": "string" } }, { "description": "Opts in to the beta version of this endpoint. Must be `true`.", "in": "header", "name": "X-Beta", "required": true, "schema": { "$ref": "#/components/schemas/ItAssetsAssetIdPatchParametersXBeta" } } ], "requestBody": { "content": { "application/json": { "schema": { "properties": { "data": { "$ref": "#/components/schemas/ItAssetsAssetIdPatchRequestBodyContentApplicationJsonSchemaData" } }, "required": [ "data" ], "type": "object" } } }, "description": "Asset fields to update" }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/IT_assets_updateAsset-v2026-09-29_Response_200" } } }, "description": "OK" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UpdateAsset-v2026-09-29RequestBadRequestError" } } }, "description": "Bad Request" }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UpdateAsset-v2026-09-29RequestUnauthorizedError" } } }, "description": "Unauthorized" }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UpdateAsset-v2026-09-29RequestForbiddenError" } } }, "description": "Forbidden" }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UpdateAsset-v2026-09-29RequestNotFoundError" } } }, "description": "Not Found" }, "409": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UpdateAsset-v2026-09-29RequestConflictError" } } }, "description": "Conflict" }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UpdateAsset-v2026-09-29RequestInternalServerError" } } }, "description": "Internal Server Error" } }, "security": [ { "deelToken": [] } ], "summary": "Update asset", "tags": [ "itAssets" ] } }, "/it/assets/{asset_id}/addons/{addon_id}/assign": { "post": { "description": "Use this to add a Deel IT service, such as device lifecycle management, to an asset your organization already tracks in Deel IT, for example right after registering it from your MDM, inventory or procurement tool, so the device is covered without enrolling it manually in the Deel IT UI. The addon must be available to your organization, and the service starts on the day of the call and is billed under your organization's addon terms.\n\n **Token scopes**: `it-assets:write`\n\n **Beta**: this version requires the `X-Beta: true` request header and its contract may change before it is promoted to stable. It is scheduled to become stable on 2027-01-09.", "operationId": "itAssets_enrolAssetIntoAddon-v2026-10-09", "parameters": [ { "description": "Unique identifier of the IT asset", "in": "path", "name": "asset_id", "required": true, "schema": { "format": "uuid", "type": "string" } }, { "description": "Unique identifier of the addon", "in": "path", "name": "addon_id", "required": true, "schema": { "format": "uuid", "type": "string" } }, { "description": "Opts in to the beta version of this endpoint. Must be `true`.", "in": "header", "name": "X-Beta", "required": true, "schema": { "$ref": "#/components/schemas/ItAssetsAssetIdAddonsAddonIdAssignPostParametersXBeta" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/IT_assets_enrolAssetIntoAddon-v2026-10-09_Response_200" } } }, "description": "OK" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EnrolAssetIntoAddon-v2026-10-09RequestBadRequestError" } } }, "description": "Bad Request" }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EnrolAssetIntoAddon-v2026-10-09RequestUnauthorizedError" } } }, "description": "Unauthorized" }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EnrolAssetIntoAddon-v2026-10-09RequestForbiddenError" } } }, "description": "Forbidden" }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EnrolAssetIntoAddon-v2026-10-09RequestNotFoundError" } } }, "description": "Not Found" }, "409": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EnrolAssetIntoAddon-v2026-10-09RequestConflictError" } } }, "description": "Conflict" }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EnrolAssetIntoAddon-v2026-10-09RequestInternalServerError" } } }, "description": "Internal Server Error" } }, "security": [ { "deelToken": [] } ], "summary": "Assign an addon to an IT asset", "tags": [ "itAssets" ] } }, "/it/assets/{asset_id}/archive": { "post": { "description": "Archives an IT asset that has left active use, so an external inventory or MDM/CMDB tool can keep Deel IT in sync. Archiving also removes the asset's host record, if any, and ends any contract add-ons it carries. To restore an archived asset, use `POST /rest/it/assets/{asset_id}/unarchive`; it brings back the asset's active status and location, but not the host or the add-ons.\n\n **Token scopes**: `it-assets:write`\n\n **Beta**: this version requires the `X-Beta: true` request header and its contract may change before it is promoted to stable. It is scheduled to become stable on 2026-12-17.", "operationId": "itAssets_archiveAsset-v2026-09-17", "parameters": [ { "description": "Unique identifier of the IT asset", "in": "path", "name": "asset_id", "required": true, "schema": { "format": "uuid", "type": "string" } }, { "description": "Opts in to the beta version of this endpoint. Must be `true`.", "in": "header", "name": "X-Beta", "required": true, "schema": { "$ref": "#/components/schemas/ItAssetsAssetIdArchivePostParametersXBeta" } } ], "requestBody": { "content": { "application/json": { "schema": { "properties": { "data": { "$ref": "#/components/schemas/ItAssetsAssetIdArchivePostRequestBodyContentApplicationJsonSchemaData" } }, "required": [ "data" ], "type": "object" } } }, "description": "Archive details" }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/IT_assets_archiveAsset-v2026-09-17_Response_200" } } }, "description": "OK" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ArchiveAsset-v2026-09-17RequestBadRequestError" } } }, "description": "Bad Request" }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ArchiveAsset-v2026-09-17RequestUnauthorizedError" } } }, "description": "Unauthorized" }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ArchiveAsset-v2026-09-17RequestForbiddenError" } } }, "description": "Forbidden" }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContainer" } } }, "description": "Operation failed." }, "409": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ArchiveAsset-v2026-09-17RequestConflictError" } } }, "description": "Conflict" }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ArchiveAsset-v2026-09-17RequestInternalServerError" } } }, "description": "Internal Server Error" } }, "security": [ { "deelToken": [] } ], "summary": "Archive an IT asset", "tags": [ "itAssets" ] } }, "/it/assets/{asset_id}/clear": { "post": { "description": "Retires a device at end of life, for resale value or certified data erasure. Creates a clearance request for the given asset so it can be recovered, resold, or written off. The referenced manager is recorded as the requester and receives lifecycle notifications. Clearance must be enabled for the organization.\n\n **Token scopes**: `it-service-requests:write`\n\n **Beta**: this version requires the `X-Beta: true` request header and its contract may change before it is promoted to stable. It is scheduled to become stable on 2026-12-17.", "operationId": "clearanceRequests_clearItAsset-v2026-09-17", "parameters": [ { "description": "Unique identifier of the IT asset", "in": "path", "name": "asset_id", "required": true, "schema": { "format": "uuid", "type": "string" } }, { "description": "Opts in to the beta version of this endpoint. Must be `true`.", "in": "header", "name": "X-Beta", "required": true, "schema": { "$ref": "#/components/schemas/ItAssetsAssetIdClearPostParametersXBeta" } } ], "requestBody": { "content": { "application/json": { "schema": { "properties": { "data": { "$ref": "#/components/schemas/ItAssetsAssetIdClearPostRequestBodyContentApplicationJsonSchemaData" } }, "required": [ "data" ], "type": "object" } } }, "description": "Clearance request details" }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Clearance_requests_clearItAsset-v2026-09-17_Response_200" } } }, "description": "OK" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ClearItAsset-v2026-09-17RequestBadRequestError" } } }, "description": "Bad Request" }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ClearItAsset-v2026-09-17RequestUnauthorizedError" } } }, "description": "Unauthorized" }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ClearItAsset-v2026-09-17RequestForbiddenError" } } }, "description": "Forbidden" }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ClearItAsset-v2026-09-17RequestNotFoundError" } } }, "description": "Not Found" }, "409": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ClearItAsset-v2026-09-17RequestConflictError" } } }, "description": "Conflict" }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ClearItAsset-v2026-09-17RequestInternalServerError" } } }, "description": "Internal Server Error" } }, "security": [ { "deelToken": [] } ], "summary": "Create a clearance request for an asset", "tags": [ "clearanceRequests" ] } }, "/it/assets/{asset_id}/collect": { "post": { "description": "Recovers a device from a worker at offboarding, or to send it on for reuse, repair, or clearance. Picks a customer-owned asset up from its current location and routes it to a warehouse or a Deel-managed reuse location. Exactly one of `warehouse_id` or `store_and_reuse_location` must be supplied.\n\n **Token scopes**: `it-service-requests:write`\n\n **Beta**: this version requires the `X-Beta: true` request header and its contract may change before it is promoted to stable. It is scheduled to become stable on 2026-12-15.", "operationId": "itAssets_collectItAsset-v2026-09-15", "parameters": [ { "description": "Unique identifier of the IT asset", "in": "path", "name": "asset_id", "required": true, "schema": { "format": "uuid", "type": "string" } }, { "description": "Opts in to the beta version of this endpoint. Must be `true`.", "in": "header", "name": "X-Beta", "required": true, "schema": { "$ref": "#/components/schemas/ItAssetsAssetIdCollectPostParametersXBeta" } } ], "requestBody": { "content": { "application/json": { "schema": { "properties": { "data": { "$ref": "#/components/schemas/ItAssetsAssetIdCollectPostRequestBodyContentApplicationJsonSchemaData" } }, "required": [ "data" ], "type": "object" } } }, "description": "Collection details" }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/IT_assets_collectItAsset-v2026-09-15_Response_200" } } }, "description": "OK" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CollectItAsset-v2026-09-15RequestBadRequestError" } } }, "description": "Bad Request" }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CollectItAsset-v2026-09-15RequestUnauthorizedError" } } }, "description": "Unauthorized" }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CollectItAsset-v2026-09-15RequestForbiddenError" } } }, "description": "Forbidden" }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CollectItAsset-v2026-09-15RequestNotFoundError" } } }, "description": "Not Found" }, "409": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CollectItAsset-v2026-09-15RequestConflictError" } } }, "description": "Conflict" }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CollectItAsset-v2026-09-15RequestInternalServerError" } } }, "description": "Internal Server Error" } }, "security": [ { "deelToken": [] } ], "summary": "Create a collection for an IT asset", "tags": [ "itAssets" ] } }, "/it/assets/{asset_id}/deliver": { "post": { "description": "Create a delivery request to ship an asset from a warehouse to a worker (HRIS profile), with Deel operations executing the logistics. If you only need to record a location change without using Deel IT services, use `POST /rest/it/assets/{asset_id}/location`.\n\n **Token scopes**: `it-service-requests:write`\n\n **Beta**: this version requires the `X-Beta: true` request header and its contract may change before it is promoted to stable. It is scheduled to become stable on 2026-12-15.", "operationId": "itAssets_deliverItAsset-v2026-09-15", "parameters": [ { "description": "Unique identifier of the IT asset", "in": "path", "name": "asset_id", "required": true, "schema": { "format": "uuid", "type": "string" } }, { "description": "Opts in to the beta version of this endpoint. Must be `true`.", "in": "header", "name": "X-Beta", "required": true, "schema": { "$ref": "#/components/schemas/ItAssetsAssetIdDeliverPostParametersXBeta" } } ], "requestBody": { "content": { "application/json": { "schema": { "properties": { "data": { "$ref": "#/components/schemas/ItAssetsAssetIdDeliverPostRequestBodyContentApplicationJsonSchemaData" } }, "required": [ "data" ], "type": "object" } } }, "description": "Delivery details" }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/IT_assets_deliverItAsset-v2026-09-15_Response_200" } } }, "description": "OK" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DeliverItAsset-v2026-09-15RequestBadRequestError" } } }, "description": "Bad Request" }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DeliverItAsset-v2026-09-15RequestUnauthorizedError" } } }, "description": "Unauthorized" }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DeliverItAsset-v2026-09-15RequestForbiddenError" } } }, "description": "Forbidden" }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DeliverItAsset-v2026-09-15RequestNotFoundError" } } }, "description": "Not Found" }, "409": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DeliverItAsset-v2026-09-15RequestConflictError" } } }, "description": "Conflict" }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DeliverItAsset-v2026-09-15RequestInternalServerError" } } }, "description": "Internal Server Error" } }, "security": [ { "deelToken": [] } ], "summary": "Create a delivery request for an IT asset", "tags": [ "itAssets" ] } }, "/it/assets/{asset_id}/location": { "post": { "description": "Records that the asset moved to a new location without triggering Deel logistics or invoicing. Use this to reflect a self-serve transfer between HRIS profiles (target `location = WITH_USER` with a different `hris_profile_id`), a delivery from your organization storage location to a worker (from `AT_WAREHOUSE` to `WITH_USER`), or a collection from a worker back to your storage location (from `WITH_USER` to `AT_WAREHOUSE`).\n\n **Token scopes**: `it-assets:write`\n\n **Beta**: this version requires the `X-Beta: true` request header and its contract may change before it is promoted to stable. It is scheduled to become stable on 2026-12-15.", "operationId": "itAssets_updateAssetLocation-v2026-09-15", "parameters": [ { "description": "Unique identifier of the IT asset", "in": "path", "name": "asset_id", "required": true, "schema": { "format": "uuid", "type": "string" } }, { "description": "Opts in to the beta version of this endpoint. Must be `true`.", "in": "header", "name": "X-Beta", "required": true, "schema": { "$ref": "#/components/schemas/ItAssetsAssetIdLocationPostParametersXBeta" } } ], "requestBody": { "content": { "application/json": { "schema": { "properties": { "data": { "$ref": "#/components/schemas/ItAssetsAssetIdLocationPostRequestBodyContentApplicationJsonSchemaData" } }, "required": [ "data" ], "type": "object" } } }, "description": "Target location details" }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/IT_assets_updateAssetLocation-v2026-09-15_Response_200" } } }, "description": "OK" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UpdateAssetLocation-v2026-09-15RequestBadRequestError" } } }, "description": "Bad Request" }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UpdateAssetLocation-v2026-09-15RequestUnauthorizedError" } } }, "description": "Unauthorized" }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UpdateAssetLocation-v2026-09-15RequestForbiddenError" } } }, "description": "Forbidden" }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UpdateAssetLocation-v2026-09-15RequestNotFoundError" } } }, "description": "Not Found" }, "409": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UpdateAssetLocation-v2026-09-15RequestConflictError" } } }, "description": "Conflict" }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UpdateAssetLocation-v2026-09-15RequestInternalServerError" } } }, "description": "Internal Server Error" } }, "security": [ { "deelToken": [] } ], "summary": "Update asset location", "tags": [ "itAssets" ] } }, "/it/assets/{asset_id}/transfer": { "post": { "description": "Hands a device directly from one worker to another, with Deel moving it. Reassigns a customer-owned asset to a new HRIS profile with Deel operations handling the physical logistics (pick, ship, receive). For a state-change-only alternative that skips Deel logistics, use `POST /rest/it/assets/{asset_id}/location`.\n\n **Token scopes**: `it-service-requests:write`\n\n **Beta**: this version requires the `X-Beta: true` request header and its contract may change before it is promoted to stable. It is scheduled to become stable on 2026-12-17.", "operationId": "itAssets_transferItAsset-v2026-09-17", "parameters": [ { "description": "Unique identifier of the IT asset", "in": "path", "name": "asset_id", "required": true, "schema": { "format": "uuid", "type": "string" } }, { "description": "Opts in to the beta version of this endpoint. Must be `true`.", "in": "header", "name": "X-Beta", "required": true, "schema": { "$ref": "#/components/schemas/ItAssetsAssetIdTransferPostParametersXBeta" } } ], "requestBody": { "content": { "application/json": { "schema": { "properties": { "data": { "$ref": "#/components/schemas/ItAssetsAssetIdTransferPostRequestBodyContentApplicationJsonSchemaData" } }, "required": [ "data" ], "type": "object" } } }, "description": "Transfer details" }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/IT_assets_transferItAsset-v2026-09-17_Response_200" } } }, "description": "OK" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TransferItAsset-v2026-09-17RequestBadRequestError" } } }, "description": "Bad Request" }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TransferItAsset-v2026-09-17RequestUnauthorizedError" } } }, "description": "Unauthorized" }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TransferItAsset-v2026-09-17RequestForbiddenError" } } }, "description": "Forbidden" }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TransferItAsset-v2026-09-17RequestNotFoundError" } } }, "description": "Not Found" }, "409": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TransferItAsset-v2026-09-17RequestConflictError" } } }, "description": "Conflict" }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TransferItAsset-v2026-09-17RequestInternalServerError" } } }, "description": "Internal Server Error" } }, "security": [ { "deelToken": [] } ], "summary": "Assign asset to new holder", "tags": [ "itAssets" ] } }, "/it/assets/{asset_id}/unarchive": { "post": { "description": "Use this to undo an archive recorded in error. Restores a previously archived asset back to ACTIVE. Reciprocal of `POST /rest/it/assets/{asset_id}/archive`. The asset is placed back into the location it occupied before it was archived when that state can be recovered, otherwise it is placed at the organization warehouse.\n\n **Token scopes**: `it-assets:write`\n\n **Beta**: this version requires the `X-Beta: true` request header and its contract may change before it is promoted to stable. It is scheduled to become stable on 2026-12-17.", "operationId": "itAssets_unarchiveAsset-v2026-09-17", "parameters": [ { "description": "Unique identifier of the IT asset", "in": "path", "name": "asset_id", "required": true, "schema": { "format": "uuid", "type": "string" } }, { "description": "Opts in to the beta version of this endpoint. Must be `true`.", "in": "header", "name": "X-Beta", "required": true, "schema": { "$ref": "#/components/schemas/ItAssetsAssetIdUnarchivePostParametersXBeta" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/IT_assets_unarchiveAsset-v2026-09-17_Response_200" } } }, "description": "OK" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UnarchiveAsset-v2026-09-17RequestBadRequestError" } } }, "description": "Bad Request" }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UnarchiveAsset-v2026-09-17RequestUnauthorizedError" } } }, "description": "Unauthorized" }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UnarchiveAsset-v2026-09-17RequestForbiddenError" } } }, "description": "Forbidden" }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContainer" } } }, "description": "Operation failed." }, "409": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UnarchiveAsset-v2026-09-17RequestConflictError" } } }, "description": "Conflict" }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UnarchiveAsset-v2026-09-17RequestInternalServerError" } } }, "description": "Internal Server Error" } }, "security": [ { "deelToken": [] } ], "summary": "Restore an archived IT asset", "tags": [ "itAssets" ] } }, "/it/clearance-requests": { "get": { "description": "Lists the clearance requests your organization has raised to retire devices for resale value or certified data erasure. Use it to find requests waiting on you — those in `PENDING_DECISION` need a response via `POST /rest/it/clearance-requests/{clearance_request_id}/decide` before their assets move on to collection.\n\n **Token scopes**: `it-service-requests:read`\n\n **Beta**: this version requires the `X-Beta: true` request header and its contract may change before it is promoted to stable. It is scheduled to become stable on 2026-12-16.", "operationId": "clearanceRequests_listClearanceRequests-v2026-09-16", "parameters": [ { "description": "Indicates where the next page of results starts, as returned in a paginated list response", "in": "query", "name": "cursor", "required": false, "schema": { "type": "string" } }, { "description": "Return a page of results with given number of records", "in": "query", "name": "limit", "required": false, "schema": { "default": 20, "maximum": 100, "minimum": 1, "type": "integer" } }, { "description": "Filter clearance requests by their status. Repeat the key to filter on multiple values.", "in": "query", "name": "status", "required": false, "schema": { "$ref": "#/components/schemas/ItClearanceRequestsGetParametersStatus" } }, { "description": "Opts in to the beta version of this endpoint. Must be `true`.", "in": "header", "name": "X-Beta", "required": true, "schema": { "$ref": "#/components/schemas/ItClearanceRequestsGetParametersXBeta" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Clearance_requests_listClearanceRequests-v2026-09-16_Response_200" } } }, "description": "OK" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ListClearanceRequests-v2026-09-16RequestBadRequestError" } } }, "description": "Bad Request" }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ListClearanceRequests-v2026-09-16RequestUnauthorizedError" } } }, "description": "Unauthorized" }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ListClearanceRequests-v2026-09-16RequestForbiddenError" } } }, "description": "Forbidden" }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContainer" } } }, "description": "Operation failed." }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ListClearanceRequests-v2026-09-16RequestInternalServerError" } } }, "description": "Internal Server Error" } }, "security": [ { "deelToken": [] } ], "summary": "List clearance requests", "tags": [ "clearanceRequests" ] } }, "/it/clearance-requests/{clearance_request_id}": { "get": { "description": "Retrieves one clearance request with the status of each item being cleared. Call this once a quote lands to review what each asset is worth before approving or rejecting items via `POST /rest/it/clearance-requests/{clearance_request_id}/decide`.\n\n **Token scopes**: `it-service-requests:read`\n\n **Beta**: this version requires the `X-Beta: true` request header and its contract may change before it is promoted to stable. It is scheduled to become stable on 2026-12-15.", "operationId": "clearanceRequests_retrieveAClearanceRequest-v2026-09-15", "parameters": [ { "description": "Unique identifier of the clearance request", "in": "path", "name": "clearance_request_id", "required": true, "schema": { "format": "uuid", "type": "string" } }, { "description": "Opts in to the beta version of this endpoint. Must be `true`.", "in": "header", "name": "X-Beta", "required": true, "schema": { "$ref": "#/components/schemas/ItClearanceRequestsClearanceRequestIdGetParametersXBeta" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Clearance_requests_retrieveAClearanceRequest-v2026-09-15_Response_200" } } }, "description": "OK" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RetrieveAClearanceRequest-v2026-09-15RequestBadRequestError" } } }, "description": "Bad Request" }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RetrieveAClearanceRequest-v2026-09-15RequestUnauthorizedError" } } }, "description": "Unauthorized" }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RetrieveAClearanceRequest-v2026-09-15RequestForbiddenError" } } }, "description": "Forbidden" }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RetrieveAClearanceRequest-v2026-09-15RequestNotFoundError" } } }, "description": "Not Found" }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RetrieveAClearanceRequest-v2026-09-15RequestInternalServerError" } } }, "description": "Internal Server Error" } }, "security": [ { "deelToken": [] } ], "summary": "Retrieve a clearance request", "tags": [ "clearanceRequests" ] } }, "/it/clearance-requests/{clearance_request_id}/cancel": { "post": { "description": "Cancels a clearance request belonging to your organization. Only clearance requests in `PENDING_QUOTE` or `PENDING_DECISION` status can be cancelled. Cancelling reverts every associated asset back to active tracking.\n\n **Token scopes**: `it-service-requests:write`\n\n **Beta**: this version requires the `X-Beta: true` request header and its contract may change before it is promoted to stable. It is scheduled to become stable on 2026-12-15.", "operationId": "clearanceRequests_cancelAClearanceRequest-v2026-09-15", "parameters": [ { "description": "Unique identifier of the clearance request", "in": "path", "name": "clearance_request_id", "required": true, "schema": { "format": "uuid", "type": "string" } }, { "description": "Opts in to the beta version of this endpoint. Must be `true`.", "in": "header", "name": "X-Beta", "required": true, "schema": { "$ref": "#/components/schemas/ItClearanceRequestsClearanceRequestIdCancelPostParametersXBeta" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Clearance_requests_cancelAClearanceRequest-v2026-09-15_Response_200" } } }, "description": "OK" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CancelAClearanceRequest-v2026-09-15RequestBadRequestError" } } }, "description": "Bad Request" }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CancelAClearanceRequest-v2026-09-15RequestUnauthorizedError" } } }, "description": "Unauthorized" }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CancelAClearanceRequest-v2026-09-15RequestForbiddenError" } } }, "description": "Forbidden" }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CancelAClearanceRequest-v2026-09-15RequestNotFoundError" } } }, "description": "Not Found" }, "409": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CancelAClearanceRequest-v2026-09-15RequestConflictError" } } }, "description": "Conflict" }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CancelAClearanceRequest-v2026-09-15RequestInternalServerError" } } }, "description": "Internal Server Error" } }, "security": [ { "deelToken": [] } ], "summary": "Cancel a clearance request", "tags": [ "clearanceRequests" ] } }, "/it/clearance-requests/{clearance_request_id}/decide": { "post": { "description": "Approves or rejects each item in a clearance request that is `PENDING_DECISION`. Every request item currently in the clearance request must be included in the payload. When every item is rejected the clearance request is cancelled. Accepted items move on to collection and hand-off to the clearance partner.\n\n **Token scopes**: `it-service-requests:write`\n\n **Beta**: this version requires the `X-Beta: true` request header and its contract may change before it is promoted to stable. It is scheduled to become stable on 2026-12-17.", "operationId": "clearanceRequests_decideAClearanceRequest-v2026-09-17", "parameters": [ { "description": "Unique identifier of the clearance request", "in": "path", "name": "clearance_request_id", "required": true, "schema": { "format": "uuid", "type": "string" } }, { "description": "Opts in to the beta version of this endpoint. Must be `true`.", "in": "header", "name": "X-Beta", "required": true, "schema": { "$ref": "#/components/schemas/ItClearanceRequestsClearanceRequestIdDecidePostParametersXBeta" } } ], "requestBody": { "content": { "application/json": { "schema": { "properties": { "data": { "$ref": "#/components/schemas/ItClearanceRequestsClearanceRequestIdDecidePostRequestBodyContentApplicationJsonSchemaData" } }, "required": [ "data" ], "type": "object" } } }, "description": "Per-item decisions for the clearance request" }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Clearance_requests_decideAClearanceRequest-v2026-09-17_Response_200" } } }, "description": "OK" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DecideAClearanceRequest-v2026-09-17RequestBadRequestError" } } }, "description": "Bad Request" }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DecideAClearanceRequest-v2026-09-17RequestUnauthorizedError" } } }, "description": "Unauthorized" }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DecideAClearanceRequest-v2026-09-17RequestForbiddenError" } } }, "description": "Forbidden" }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DecideAClearanceRequest-v2026-09-17RequestNotFoundError" } } }, "description": "Not Found" }, "409": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DecideAClearanceRequest-v2026-09-17RequestConflictError" } } }, "description": "Conflict" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DecideAClearanceRequest-v2026-09-17RequestUnprocessableEntityError" } } }, "description": "Unprocessable Entity" }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DecideAClearanceRequest-v2026-09-17RequestInternalServerError" } } }, "description": "Internal Server Error" } }, "security": [ { "deelToken": [] } ], "summary": "Approve or reject quotes on a clearance request", "tags": [ "clearanceRequests" ] } }, "/it/orders": { "get": { "description": "Lists your organization's IT equipment orders with their current fulfilment status. Use it to surface order progress — pending, approved, shipped, delivered — inside your own service desk or onboarding workflow, so a worker can be told where their device is without logging into Deel.\n\n **Token scopes**: `it-orders:read`", "operationId": "itOrders_listItOrders-v2026-01-01", "parameters": [ { "description": "Indicates where the next page of results starts, as returned in a paginated list response", "in": "query", "name": "cursor", "required": false, "schema": { "type": "string" } }, { "description": "Return a page of results with given number of records", "in": "query", "name": "limit", "required": false, "schema": { "default": 20, "maximum": 100, "minimum": 1, "type": "integer" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/IT_orders_listItOrders-v2026-01-01_Response_200" } } }, "description": "OK" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ListItOrders-v2026-01-01RequestBadRequestError" } } }, "description": "Bad Request" }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContainer" } } }, "description": "Operation failed." }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContainer" } } }, "description": "Operation failed." }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContainer" } } }, "description": "Operation failed." }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ListItOrders-v2026-01-01RequestInternalServerError" } } }, "description": "Internal Server Error" } }, "security": [ { "deelToken": [] } ], "summary": "List IT orders", "tags": [ "itOrders" ] }, "post": { "description": "Creates a pre-approved IT equipment order for a worker so it can be raised directly from an onboarding or procurement workflow instead of a separate approval step.\n\n **Token scopes**: `it-orders:write`\n\n **Beta**: this version requires the `X-Beta: true` request header and its contract may change before it is promoted to stable. It is scheduled to become stable on 2026-12-17.", "operationId": "itOrders_createItOrder-v2026-09-17", "parameters": [ { "description": "Opts in to the beta version of this endpoint. Must be `true`.", "in": "header", "name": "X-Beta", "required": true, "schema": { "$ref": "#/components/schemas/ItOrdersPostParametersXBeta" } } ], "requestBody": { "content": { "application/json": { "schema": { "properties": { "data": { "$ref": "#/components/schemas/ItOrdersPostRequestBodyContentApplicationJsonSchemaData" } }, "required": [ "data" ], "type": "object" } } }, "description": "Order to create" }, "responses": { "201": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/IT_orders_createItOrder-v2026-09-17_Response_201" } } }, "description": "Created" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreateItOrder-v2026-09-17RequestBadRequestError" } } }, "description": "Bad Request" }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreateItOrder-v2026-09-17RequestUnauthorizedError" } } }, "description": "Unauthorized" }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreateItOrder-v2026-09-17RequestForbiddenError" } } }, "description": "Forbidden" }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreateItOrder-v2026-09-17RequestNotFoundError" } } }, "description": "Not Found" }, "409": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreateItOrder-v2026-09-17RequestConflictError" } } }, "description": "Conflict" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreateItOrder-v2026-09-17RequestUnprocessableEntityError" } } }, "description": "Unprocessable Entity" }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreateItOrder-v2026-09-17RequestInternalServerError" } } }, "description": "Internal Server Error" } }, "security": [ { "deelToken": [] } ], "summary": "Create an IT order", "tags": [ "itOrders" ] } }, "/it/orders/{order_id}": { "get": { "description": "Retrieves one order with its fulfilment status, shipping details, and the product ordered. Call this to answer \"where is my device?\" for a specific worker, or to poll a single order through to delivery.\n\n **Token scopes**: `it-orders:read`", "operationId": "itOrders_retrieveAnItOrder-v2026-01-01", "parameters": [ { "description": "Unique identifier of the IT order", "in": "path", "name": "order_id", "required": true, "schema": { "format": "uuid", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/IT_orders_retrieveAnItOrder-v2026-01-01_Response_200" } } }, "description": "OK" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RetrieveAnItOrder-v2026-01-01RequestBadRequestError" } } }, "description": "Bad Request" }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContainer" } } }, "description": "Operation failed." }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContainer" } } }, "description": "Operation failed." }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RetrieveAnItOrder-v2026-01-01RequestNotFoundError" } } }, "description": "Not Found" }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RetrieveAnItOrder-v2026-01-01RequestInternalServerError" } } }, "description": "Internal Server Error" } }, "security": [ { "deelToken": [] } ], "summary": "Retrieve an IT order", "tags": [ "itOrders" ] } }, "/it/orders/{order_id}/approve": { "post": { "description": "Approves an order that is currently awaiting approval, moving it to approved status, creating assignments for its approved items, and starting fulfilment. Use this once an order has been submitted and is pending manager approval, before fulfilment can begin.\n\n **Token scopes**: `it-orders:write`\n\n **Beta**: this version requires the `X-Beta: true` request header and its contract may change before it is promoted to stable. It is scheduled to become stable on 2026-12-30.", "operationId": "itOrders_approveItOrder-v2026-09-30", "parameters": [ { "description": "Unique identifier of the IT order", "in": "path", "name": "order_id", "required": true, "schema": { "format": "uuid", "type": "string" } }, { "description": "Opts in to the beta version of this endpoint. Must be `true`.", "in": "header", "name": "X-Beta", "required": true, "schema": { "$ref": "#/components/schemas/ItOrdersOrderIdApprovePostParametersXBeta" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/IT_orders_approveItOrder-v2026-09-30_Response_200" } } }, "description": "OK" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApproveItOrder-v2026-09-30RequestBadRequestError" } } }, "description": "Bad Request" }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApproveItOrder-v2026-09-30RequestUnauthorizedError" } } }, "description": "Unauthorized" }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApproveItOrder-v2026-09-30RequestForbiddenError" } } }, "description": "Forbidden" }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApproveItOrder-v2026-09-30RequestNotFoundError" } } }, "description": "Not Found" }, "409": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApproveItOrder-v2026-09-30RequestConflictError" } } }, "description": "Conflict" }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApproveItOrder-v2026-09-30RequestInternalServerError" } } }, "description": "Internal Server Error" } }, "security": [ { "deelToken": [] } ], "summary": "Approve an IT order", "tags": [ "itOrders" ] } }, "/it/orders/{order_id}/cancel": { "post": { "description": "Cancels an order that is still pre-shipment with a reason. On success the order plus its related sales order are cancelled. Cancellation is rejected if the order is paid, in payment, or already shipped.\n\n **Token scopes**: `it-orders:write`\n\n **Beta**: this version requires the `X-Beta: true` request header and its contract may change before it is promoted to stable. It is scheduled to become stable on 2026-12-15.", "operationId": "itOrders_cancelItOrder-v2026-09-15", "parameters": [ { "description": "Unique identifier of the IT order", "in": "path", "name": "order_id", "required": true, "schema": { "format": "uuid", "type": "string" } }, { "description": "Opts in to the beta version of this endpoint. Must be `true`.", "in": "header", "name": "X-Beta", "required": true, "schema": { "$ref": "#/components/schemas/ItOrdersOrderIdCancelPostParametersXBeta" } } ], "requestBody": { "content": { "application/json": { "schema": { "properties": { "data": { "$ref": "#/components/schemas/ItOrdersOrderIdCancelPostRequestBodyContentApplicationJsonSchemaData" } }, "required": [ "data" ], "type": "object" } } }, "description": "Cancellation details" }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/IT_orders_cancelItOrder-v2026-09-15_Response_200" } } }, "description": "OK" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CancelItOrder-v2026-09-15RequestBadRequestError" } } }, "description": "Bad Request" }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CancelItOrder-v2026-09-15RequestUnauthorizedError" } } }, "description": "Unauthorized" }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CancelItOrder-v2026-09-15RequestForbiddenError" } } }, "description": "Forbidden" }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CancelItOrder-v2026-09-15RequestNotFoundError" } } }, "description": "Not Found" }, "409": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CancelItOrder-v2026-09-15RequestConflictError" } } }, "description": "Conflict" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CancelItOrder-v2026-09-15RequestUnprocessableEntityError" } } }, "description": "Unprocessable Entity" }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CancelItOrder-v2026-09-15RequestInternalServerError" } } }, "description": "Internal Server Error" } }, "security": [ { "deelToken": [] } ], "summary": "Cancel an IT order", "tags": [ "itOrders" ] } }, "/it/orders/{order_id}/decline": { "post": { "description": "Declines an order that is awaiting approval, moving it to a final DECLINED status and leaving every item unapproved with no fulfilment started. Use this when a service desk needs to reject an order before approval instead of going through the Deel IT UI. This decision cannot be reversed.\n\n **Token scopes**: `it-orders:write`\n\n **Beta**: this version requires the `X-Beta: true` request header and its contract may change before it is promoted to stable. It is scheduled to become stable on 2026-12-30.", "operationId": "itOrders_declineItOrder-v2026-09-30", "parameters": [ { "description": "Unique identifier of the IT order", "in": "path", "name": "order_id", "required": true, "schema": { "format": "uuid", "type": "string" } }, { "description": "Opts in to the beta version of this endpoint. Must be `true`.", "in": "header", "name": "X-Beta", "required": true, "schema": { "$ref": "#/components/schemas/ItOrdersOrderIdDeclinePostParametersXBeta" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/IT_orders_declineItOrder-v2026-09-30_Response_200" } } }, "description": "OK" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DeclineItOrder-v2026-09-30RequestBadRequestError" } } }, "description": "Bad Request" }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DeclineItOrder-v2026-09-30RequestUnauthorizedError" } } }, "description": "Unauthorized" }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DeclineItOrder-v2026-09-30RequestForbiddenError" } } }, "description": "Forbidden" }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DeclineItOrder-v2026-09-30RequestNotFoundError" } } }, "description": "Not Found" }, "409": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DeclineItOrder-v2026-09-30RequestConflictError" } } }, "description": "Conflict" }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DeclineItOrder-v2026-09-30RequestInternalServerError" } } }, "description": "Internal Server Error" } }, "security": [ { "deelToken": [] } ], "summary": "Reject an IT order", "tags": [ "itOrders" ] } }, "/it/policies": { "get": { "description": "Lists your organization's IT hardware policies, which cap what equipment each worker is eligible to order. Call this to resolve a worker's policy and the products it allows before raising an equipment request on their behalf.\n\n **Token scopes**: `it-policies:read`", "operationId": "itPolicies_listItHardwarePolicies-v2026-01-01", "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/IT_policies_listItHardwarePolicies-v2026-01-01_Response_200" } } }, "description": "OK" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ListItHardwarePolicies-v2026-01-01RequestBadRequestError" } } }, "description": "Bad Request" }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContainer" } } }, "description": "Operation failed." }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContainer" } } }, "description": "Operation failed." }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContainer" } } }, "description": "Operation failed." }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ListItHardwarePolicies-v2026-01-01RequestInternalServerError" } } }, "description": "Internal Server Error" } }, "security": [ { "deelToken": [] } ], "summary": "List IT hardware policies", "tags": [ "itPolicies" ] } }, "/it/policies/{it_policy_id}/assign": { "post": { "description": "Use this from onboarding or HRIS automations to put workers on the IT hardware policy that governs what equipment they can order; resolve the policy id via `GET /rest/it/policies`. Assigns the listed workers, identified by their Deel HRIS profile ids, to this policy. Accepts between 1 and 100 ids per call. The call is all-or-nothing: if any id is not found in your organization the whole request fails and no worker is moved. Workers already on the policy are left unchanged; for per-seat organizations, seat allocation follows your organization's seat assignment setting.\n\n **Token scopes**: `it-policies:write`\n\n **Beta**: this version requires the `X-Beta: true` request header and its contract may change before it is promoted to stable. It is scheduled to become stable on 2026-12-17.", "operationId": "itPolicies_assignWorkersToItHardwarePolicy-v2026-09-17", "parameters": [ { "description": "Unique identifier of the IT policy", "in": "path", "name": "it_policy_id", "required": true, "schema": { "format": "uuid", "type": "string" } }, { "description": "Opts in to the beta version of this endpoint. Must be `true`.", "in": "header", "name": "X-Beta", "required": true, "schema": { "$ref": "#/components/schemas/ItPoliciesItPolicyIdAssignPostParametersXBeta" } } ], "requestBody": { "content": { "application/json": { "schema": { "properties": { "data": { "$ref": "#/components/schemas/ItPoliciesItPolicyIdAssignPostRequestBodyContentApplicationJsonSchemaData", "description": "Workers to assign to the IT policy." } }, "required": [ "data" ], "type": "object" } } }, "description": "Workers to assign" }, "responses": { "204": { "content": { "application/json": { "schema": { "properties": {}, "type": "object" } } }, "description": "No Content" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AssignWorkersToItHardwarePolicy-v2026-09-17RequestBadRequestError" } } }, "description": "Bad Request" }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AssignWorkersToItHardwarePolicy-v2026-09-17RequestUnauthorizedError" } } }, "description": "Unauthorized" }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AssignWorkersToItHardwarePolicy-v2026-09-17RequestForbiddenError" } } }, "description": "Forbidden" }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AssignWorkersToItHardwarePolicy-v2026-09-17RequestNotFoundError" } } }, "description": "Not Found" }, "409": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AssignWorkersToItHardwarePolicy-v2026-09-17RequestConflictError" } } }, "description": "Conflict" }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AssignWorkersToItHardwarePolicy-v2026-09-17RequestInternalServerError" } } }, "description": "Internal Server Error" } }, "security": [ { "deelToken": [] } ], "summary": "Assign workers to an IT hardware policy", "tags": [ "itPolicies" ] } }, "/it/policies/{policy_id}/seats": { "get": { "description": "Lists the workers assigned to one of your organization's IT hardware policies. Use it to resolve which workers a policy applies to before raising equipment requests on their behalf, or to audit policy membership.\n\n **Token scopes**: `it-policies:read`\n\n **Beta**: this version requires the `X-Beta: true` request header and its contract may change before it is promoted to stable. It is scheduled to become stable on 2026-12-25.", "operationId": "itPolicies_listItPolicyUsers-v2026-09-25", "parameters": [ { "description": "IT policy identifier", "in": "path", "name": "policy_id", "required": true, "schema": { "format": "uuid", "type": "string" } }, { "description": "Indicates where the next page of results starts, as returned in a paginated list response", "in": "query", "name": "cursor", "required": false, "schema": { "type": "string" } }, { "description": "Return a page of results with given number of records", "in": "query", "name": "limit", "required": false, "schema": { "default": 20, "maximum": 100, "minimum": 1, "type": "integer" } }, { "description": "Filter by the worker's HRIS Profile ID, to find which policy a specific worker is attached to. Repeat the key to filter on multiple values.", "in": "query", "name": "hris_profile_id", "required": false, "schema": { "format": "uuid", "type": "string" } }, { "description": "Opts in to the beta version of this endpoint. Must be `true`.", "in": "header", "name": "X-Beta", "required": true, "schema": { "$ref": "#/components/schemas/ItPoliciesPolicyIdSeatsGetParametersXBeta" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/IT_policies_listItPolicyUsers-v2026-09-25_Response_200" } } }, "description": "OK" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ListItPolicyUsers-v2026-09-25RequestBadRequestError" } } }, "description": "Bad Request" }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContainer" } } }, "description": "Operation failed." }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContainer" } } }, "description": "Operation failed." }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ListItPolicyUsers-v2026-09-25RequestNotFoundError" } } }, "description": "Not Found" }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ListItPolicyUsers-v2026-09-25RequestInternalServerError" } } }, "description": "Internal Server Error" } }, "security": [ { "deelToken": [] } ], "summary": "List users assigned to an IT policy", "tags": [ "itPolicies" ] } }, "/it/policies/{policy_id}/users": { "get": { "description": "Lists the workers assigned to one of your organization's IT hardware policies. Use it to resolve which workers a policy applies to before raising equipment requests on their behalf, or to audit policy membership. Results are cursor-paginated.\n\n **Token scopes**: `it-policies:read`\n\n **Beta**: this version requires the `X-Beta: true` request header and its contract may change before it is promoted to stable. It is scheduled to become stable on 2026-12-17.", "operationId": "itPolicies_listItPolicyUsers-v2026-09-17", "parameters": [ { "description": "IT policy identifier", "in": "path", "name": "policy_id", "required": true, "schema": { "format": "uuid", "type": "string" } }, { "description": "Indicates where the next page of results starts, as returned in a paginated list response", "in": "query", "name": "cursor", "required": false, "schema": { "type": "string" } }, { "description": "Return a page of results with given number of records", "in": "query", "name": "limit", "required": false, "schema": { "default": 20, "maximum": 100, "minimum": 1, "type": "integer" } }, { "description": "Filter by the worker's HRIS Profile ID, to find which policy a specific worker is attached to. Repeat the key to filter on multiple values.", "in": "query", "name": "hris_profile_id", "required": false, "schema": { "format": "uuid", "type": "string" } }, { "description": "Opts in to the beta version of this endpoint. Must be `true`.", "in": "header", "name": "X-Beta", "required": true, "schema": { "$ref": "#/components/schemas/ItPoliciesPolicyIdUsersGetParametersXBeta" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/IT_policies_listItPolicyUsers-v2026-09-17_Response_200" } } }, "description": "OK" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ListItPolicyUsers-v2026-09-17RequestBadRequestError" } } }, "description": "Bad Request" }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContainer" } } }, "description": "Operation failed." }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContainer" } } }, "description": "Operation failed." }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ListItPolicyUsers-v2026-09-17RequestNotFoundError" } } }, "description": "Not Found" }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ListItPolicyUsers-v2026-09-17RequestInternalServerError" } } }, "description": "Internal Server Error" } }, "security": [ { "deelToken": [] } ], "summary": "List users assigned to an IT policy", "tags": [ "itPolicies" ] } }, "/it/products": { "get": { "description": "Browse the Deel IT catalog to see which devices are available for purchase or rent before creating an order, filtered by country and other criteria. Returns product metadata only — no pricing, taxes, fees, or contract settings.\n\n **Token scopes**: `it-products:read`\n\n **Beta**: this version requires the `X-Beta: true` request header and its contract may change before it is promoted to stable. It is scheduled to become stable on 2026-12-17.", "operationId": "itProducts_listItProducts-v2026-09-17", "parameters": [ { "description": "Indicates where the next page of results starts, as returned in a paginated list response", "in": "query", "name": "cursor", "required": false, "schema": { "type": "string" } }, { "description": "Return a page of results with given number of records", "in": "query", "name": "limit", "required": false, "schema": { "default": 20, "maximum": 100, "minimum": 1, "type": "integer" } }, { "description": "ISO 3166 alpha-2 country code. Restricts results to products whose variants ship to this country.", "in": "query", "name": "country", "required": false, "schema": { "type": "string" } }, { "description": "Filter by stock condition. Omit to include products of any stock condition.", "in": "query", "name": "stock_condition", "required": false, "schema": { "$ref": "#/components/schemas/ItProductsGetParametersStockCondition" } }, { "description": "Restrict results to products offering at least one of these acquisition types (RENTAL, PURCHASE, REUSE). REUSE represents BYOD (customer-owned) stock. Omit to include all acquisition types the organization is entitled to.", "in": "query", "name": "acquisition_types", "required": false, "schema": { "items": { "$ref": "#/components/schemas/ItProductsGetParametersAcquisitionTypesSchemaItems" }, "type": "array" } }, { "description": "Return products whose name or brand contains this text. Case-insensitive, and partial words match, so 'book' finds 'MacBook Pro'. Only the name and brand are searched — not the description or hardware specification. Use brands for an exact manufacturer match.", "in": "query", "name": "search", "required": false, "schema": { "type": "string" } }, { "description": "Filter by product category", "in": "query", "name": "category", "required": false, "schema": { "$ref": "#/components/schemas/ItProductsGetParametersCategory" } }, { "description": "Filter by operating system — repeat for OR semantics", "in": "query", "name": "operating_systems", "required": false, "schema": { "items": { "$ref": "#/components/schemas/ItProductsGetParametersOperatingSystemsSchemaItems" }, "type": "array" } }, { "description": "Filter by keyboard layout — repeat for OR semantics", "in": "query", "name": "keyboard_layouts", "required": false, "schema": { "items": { "$ref": "#/components/schemas/ItProductsGetParametersKeyboardLayoutsSchemaItems" }, "type": "array" } }, { "description": "Filter by manufacturer — exact and case-insensitive, repeat for OR semantics. Unlike search it does not substring-match.", "in": "query", "name": "brands", "required": false, "schema": { "items": { "type": "string" }, "type": "array" } }, { "description": "Restrict results to products approved by any of these IT policies, to see what workers on those policies can order. Repeat for OR semantics. A policy id your organization does not own matches nothing.", "in": "query", "name": "it_policy_ids", "required": false, "schema": { "items": { "format": "uuid", "type": "string" }, "type": "array" } }, { "description": "Filter by marketplace sourcing. Organizations without marketplace access never see marketplace products, and the filter is ignored for them rather than emptying the catalog.", "in": "query", "name": "is_marketplace", "required": false, "schema": { "type": "boolean" } }, { "description": "Opts in to the beta version of this endpoint. Must be `true`.", "in": "header", "name": "X-Beta", "required": true, "schema": { "$ref": "#/components/schemas/ItProductsGetParametersXBeta" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/IT_products_listItProducts-v2026-09-17_Response_200" } } }, "description": "OK" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ListItProducts-v2026-09-17RequestBadRequestError" } } }, "description": "Bad Request" }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContainer" } } }, "description": "Operation failed." }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContainer" } } }, "description": "Operation failed." }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContainer" } } }, "description": "Operation failed." }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ListItProducts-v2026-09-17RequestInternalServerError" } } }, "description": "Internal Server Error" } }, "security": [ { "deelToken": [] } ], "summary": "List products in the catalog", "tags": [ "itProducts" ] } }, "/it/products/{product_id}": { "get": { "description": "Returns catalog data for a single product — variants, images, hardware spec, and available addons. Variants are filtered to those the organization's allowed acquisition types cover, and (when country is supplied) to those shipping to that country. No pricing, taxes, fees, contract-setting-derived values, or stock counts are returned. Use this after listing products to pull a specific product's variant and addon options before creating an order.\n\n **Token scopes**: `it-products:read`\n\n **Beta**: this version requires the `X-Beta: true` request header and its contract may change before it is promoted to stable. It is scheduled to become stable on 2026-12-17.", "operationId": "itProducts_retrieveAnItProduct-v2026-09-17", "parameters": [ { "description": "Unique identifier of the product", "in": "path", "name": "product_id", "required": true, "schema": { "format": "uuid", "type": "string" } }, { "description": "ISO 3166 alpha-2 country code. When set, restricts returned variants to those shipping to this country.", "in": "query", "name": "country", "required": false, "schema": { "type": "string" } }, { "description": "Opts in to the beta version of this endpoint. Must be `true`.", "in": "header", "name": "X-Beta", "required": true, "schema": { "$ref": "#/components/schemas/ItProductsProductIdGetParametersXBeta" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/IT_products_retrieveAnItProduct-v2026-09-17_Response_200" } } }, "description": "OK" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RetrieveAnItProduct-v2026-09-17RequestBadRequestError" } } }, "description": "Bad Request" }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContainer" } } }, "description": "Operation failed." }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContainer" } } }, "description": "Operation failed." }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RetrieveAnItProduct-v2026-09-17RequestNotFoundError" } } }, "description": "Not Found" }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RetrieveAnItProduct-v2026-09-17RequestInternalServerError" } } }, "description": "Internal Server Error" } }, "security": [ { "deelToken": [] } ], "summary": "Retrieve a product's catalog details", "tags": [ "itProducts" ] } }, "/it/seats": { "get": { "description": "Use this endpoint to let HRIS and finance automations audit which worker holds each IT seat and reconcile seat usage, instead of checking the seat list manually in the Deel IT UI. Only available to organizations on a per-seat plan.\n\n **Token scopes**: `it-seats:read`\n\n **Beta**: this version requires the `X-Beta: true` request header and its contract may change before it is promoted to stable. It is scheduled to become stable on 2026-12-25.", "operationId": "itSeats_listItSeats-v2026-09-25", "parameters": [ { "description": "Indicates where the next page of results starts, as returned in a paginated list response", "in": "query", "name": "cursor", "required": false, "schema": { "type": "string" } }, { "description": "Return a page of results with given number of records", "in": "query", "name": "limit", "required": false, "schema": { "default": 20, "maximum": 100, "minimum": 1, "type": "integer" } }, { "description": "Filter seats by their status — repeat the key for OR semantics. Omit to include seats of any status.", "in": "query", "name": "status", "required": false, "schema": { "items": { "$ref": "#/components/schemas/ItSeatsGetParametersStatusSchemaItems" }, "type": "array" } }, { "description": "Filter seats by the HRIS profile holding them — repeat the key for OR semantics. Ids not found in your organization match nothing. Omit to include seats of any worker.", "in": "query", "name": "hris_profile_id", "required": false, "schema": { "items": { "format": "uuid", "type": "string" }, "type": "array" } }, { "description": "Opts in to the beta version of this endpoint. Must be `true`.", "in": "header", "name": "X-Beta", "required": true, "schema": { "$ref": "#/components/schemas/ItSeatsGetParametersXBeta" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/IT_seats_listItSeats-v2026-09-25_Response_200" } } }, "description": "OK" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ListItSeats-v2026-09-25RequestBadRequestError" } } }, "description": "Bad Request" }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ListItSeats-v2026-09-25RequestUnauthorizedError" } } }, "description": "Unauthorized" }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ListItSeats-v2026-09-25RequestForbiddenError" } } }, "description": "Forbidden" }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ListItSeats-v2026-09-25RequestNotFoundError" } } }, "description": "Not Found" }, "409": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ListItSeats-v2026-09-25RequestConflictError" } } }, "description": "Conflict" }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ListItSeats-v2026-09-25RequestInternalServerError" } } }, "description": "Internal Server Error" } }, "security": [ { "deelToken": [] } ], "summary": "List IT seats", "tags": [ "itSeats" ] } }, "/it/seats/assign": { "post": { "description": "Use this from onboarding or HRIS automations to give workers an IT seat on your organization's IT-seat subscription. Assigns a seat to each listed worker, identified by their Deel HRIS profile id. Accepts between 1 and 100 ids per call. The call is all-or-nothing: if any id is not found in your organization, or the seats cannot be assigned, the whole request fails and nothing changes. Workers already holding a seat are left unchanged and workers whose seat is pending approval have it approved. If the subscription has fewer free seats than the workers need, the request fails with a conflict unless is_accepting_new_seat_subscription is true, in which case the missing seats are added to the subscription at its monthly seat price and billed to your organization; check the available seats and the monthly seat price via `GET /rest/it/seats/status` before accepting. Only organizations on a per-seat plan with an active IT-seat subscription can use this endpoint.\n\n **Token scopes**: `it-seats:write`\n\n **Beta**: this version requires the `X-Beta: true` request header and its contract may change before it is promoted to stable. It is scheduled to become stable on 2026-12-24.", "operationId": "itSeats_assignWorkersToItSeats-v2026-09-24", "parameters": [ { "description": "Opts in to the beta version of this endpoint. Must be `true`.", "in": "header", "name": "X-Beta", "required": true, "schema": { "$ref": "#/components/schemas/ItSeatsAssignPostParametersXBeta" } } ], "requestBody": { "content": { "application/json": { "schema": { "properties": { "data": { "$ref": "#/components/schemas/ItSeatsAssignPostRequestBodyContentApplicationJsonSchemaData", "description": "Workers to give an IT seat." } }, "required": [ "data" ], "type": "object" } } }, "description": "Workers to give an IT seat" }, "responses": { "204": { "content": { "application/json": { "schema": { "properties": {}, "type": "object" } } }, "description": "No Content" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AssignWorkersToItSeats-v2026-09-24RequestBadRequestError" } } }, "description": "Bad Request" }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AssignWorkersToItSeats-v2026-09-24RequestUnauthorizedError" } } }, "description": "Unauthorized" }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AssignWorkersToItSeats-v2026-09-24RequestForbiddenError" } } }, "description": "Forbidden" }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AssignWorkersToItSeats-v2026-09-24RequestNotFoundError" } } }, "description": "Not Found" }, "409": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AssignWorkersToItSeats-v2026-09-24RequestConflictError" } } }, "description": "Conflict" }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AssignWorkersToItSeats-v2026-09-24RequestInternalServerError" } } }, "description": "Internal Server Error" } }, "security": [ { "deelToken": [] } ], "summary": "Assign workers to IT seats", "tags": [ "itSeats" ] } }, "/it/seats/status": { "get": { "description": "Reports your organization's IT-seat subscription so HRIS and finance automations can see how many seats are paid for, how many are already taken, how many are free and what one more seat costs per month — before assigning workers via `POST /rest/it/seats/assign`. Returns the subscription in force today; if your organization is between subscriptions, the most recent one is returned with its status, so an expired subscription is still visible. Only organizations on a per-seat plan can use this endpoint.\n\n **Token scopes**: `it-seats:read`\n\n **Beta**: this version requires the `X-Beta: true` request header and its contract may change before it is promoted to stable. It is scheduled to become stable on 2026-12-25.", "operationId": "itSeats_retrieveTheItSeatContract-v2026-09-25", "parameters": [ { "description": "Opts in to the beta version of this endpoint. Must be `true`.", "in": "header", "name": "X-Beta", "required": true, "schema": { "$ref": "#/components/schemas/ItSeatsStatusGetParametersXBeta" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/IT_seats_retrieveTheItSeatContract-v2026-09-25_Response_200" } } }, "description": "OK" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RetrieveTheItSeatContract-v2026-09-25RequestBadRequestError" } } }, "description": "Bad Request" }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RetrieveTheItSeatContract-v2026-09-25RequestUnauthorizedError" } } }, "description": "Unauthorized" }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RetrieveTheItSeatContract-v2026-09-25RequestForbiddenError" } } }, "description": "Forbidden" }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RetrieveTheItSeatContract-v2026-09-25RequestNotFoundError" } } }, "description": "Not Found" }, "409": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RetrieveTheItSeatContract-v2026-09-25RequestConflictError" } } }, "description": "Conflict" }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RetrieveTheItSeatContract-v2026-09-25RequestInternalServerError" } } }, "description": "Internal Server Error" } }, "security": [ { "deelToken": [] } ], "summary": "Retrieve the IT seat subscription", "tags": [ "itSeats" ] } }, "/it/seats/unassign": { "post": { "description": "Use this from offboarding or HRIS automations to release the IT seats of workers who no longer need one. Releases the seat of each listed worker, identified by their Deel HRIS profile id, on your organization's IT-seat subscription: released seats become available to assign to another worker, and the number of paid seats is unchanged. The call is all-or-nothing: if any id is not found in your organization the whole request fails and no seat is released. Workers without a seat are left unchanged. A seat whose paid feature is already in use cannot be released; the whole request then fails with a conflict and no seat is released. The worker's IT policy is not changed. Only organizations on a per-seat plan with an active IT-seat subscription can use this endpoint.\n\n **Token scopes**: `it-seats:write`\n\n **Beta**: this version requires the `X-Beta: true` request header and its contract may change before it is promoted to stable. It is scheduled to become stable on 2026-12-25.", "operationId": "itSeats_unassignWorkersFromItSeats-v2026-09-25", "parameters": [ { "description": "Opts in to the beta version of this endpoint. Must be `true`.", "in": "header", "name": "X-Beta", "required": true, "schema": { "$ref": "#/components/schemas/ItSeatsUnassignPostParametersXBeta" } } ], "requestBody": { "content": { "application/json": { "schema": { "properties": { "data": { "$ref": "#/components/schemas/ItSeatsUnassignPostRequestBodyContentApplicationJsonSchemaData", "description": "Workers whose IT seat to release." } }, "required": [ "data" ], "type": "object" } } }, "description": "Workers whose IT seat to release" }, "responses": { "204": { "content": { "application/json": { "schema": { "properties": {}, "type": "object" } } }, "description": "No Content" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UnassignWorkersFromItSeats-v2026-09-25RequestBadRequestError" } } }, "description": "Bad Request" }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UnassignWorkersFromItSeats-v2026-09-25RequestUnauthorizedError" } } }, "description": "Unauthorized" }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UnassignWorkersFromItSeats-v2026-09-25RequestForbiddenError" } } }, "description": "Forbidden" }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UnassignWorkersFromItSeats-v2026-09-25RequestNotFoundError" } } }, "description": "Not Found" }, "409": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UnassignWorkersFromItSeats-v2026-09-25RequestConflictError" } } }, "description": "Conflict" }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UnassignWorkersFromItSeats-v2026-09-25RequestInternalServerError" } } }, "description": "Internal Server Error" } }, "security": [ { "deelToken": [] } ], "summary": "Unassign workers from IT seats", "tags": [ "itSeats" ] } }, "/it/warehouses": { "get": { "description": "Lists your organization's storage locations — your own offices and any Deel-managed warehouses. Use it to resolve a `warehouse_id` before routing a collection or an asset location update, and to enumerate sites alongside `GET /rest/it/assets`.\n\n **Token scopes**: `it-assets:read`\n\n **Beta**: this version requires the `X-Beta: true` request header and its contract may change before it is promoted to stable. It is scheduled to become stable on 2026-12-15.", "operationId": "itWarehouses_listItWarehouses-v2026-09-15", "parameters": [ { "description": "Indicates where the next page of results starts, as returned in a paginated list response", "in": "query", "name": "cursor", "required": false, "schema": { "type": "string" } }, { "description": "Return a page of results with given number of records", "in": "query", "name": "limit", "required": false, "schema": { "default": 20, "maximum": 100, "minimum": 1, "type": "integer" } }, { "description": "Free-text search on warehouse name", "in": "query", "name": "search", "required": false, "schema": { "type": "string" } }, { "description": "Filter by warehouse country (ISO 3166 alpha-2). Repeat the key to filter on multiple values.", "in": "query", "name": "country", "required": false, "schema": { "type": "string" } }, { "description": "Filter by organization warehouse type. Repeat the key to filter on multiple values.", "in": "query", "name": "type", "required": false, "schema": { "$ref": "#/components/schemas/ItWarehousesGetParametersType" } }, { "description": "Opts in to the beta version of this endpoint. Must be `true`.", "in": "header", "name": "X-Beta", "required": true, "schema": { "$ref": "#/components/schemas/ItWarehousesGetParametersXBeta" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/IT_warehouses_listItWarehouses-v2026-09-15_Response_200" } } }, "description": "OK" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ListItWarehouses-v2026-09-15RequestBadRequestError" } } }, "description": "Bad Request" }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContainer" } } }, "description": "Operation failed." }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContainer" } } }, "description": "Operation failed." }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContainer" } } }, "description": "Operation failed." }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ListItWarehouses-v2026-09-15RequestInternalServerError" } } }, "description": "Internal Server Error" } }, "security": [ { "deelToken": [] } ], "summary": "List warehouses", "tags": [ "itWarehouses" ] } }, "/it/warehouses/{warehouse_id}": { "get": { "description": "Retrieves one storage location with its address and type. Call this to confirm a warehouse's delivery address before routing a collection or an asset location update to it.\n\n **Token scopes**: `it-assets:read`\n\n **Beta**: this version requires the `X-Beta: true` request header and its contract may change before it is promoted to stable. It is scheduled to become stable on 2026-12-15.", "operationId": "itWarehouses_retrieveAnItWarehouse-v2026-09-15", "parameters": [ { "description": "Unique identifier of the warehouse", "in": "path", "name": "warehouse_id", "required": true, "schema": { "format": "uuid", "type": "string" } }, { "description": "Opts in to the beta version of this endpoint. Must be `true`.", "in": "header", "name": "X-Beta", "required": true, "schema": { "$ref": "#/components/schemas/ItWarehousesWarehouseIdGetParametersXBeta" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/IT_warehouses_retrieveAnItWarehouse-v2026-09-15_Response_200" } } }, "description": "OK" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RetrieveAnItWarehouse-v2026-09-15RequestBadRequestError" } } }, "description": "Bad Request" }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContainer" } } }, "description": "Operation failed." }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContainer" } } }, "description": "Operation failed." }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RetrieveAnItWarehouse-v2026-09-15RequestNotFoundError" } } }, "description": "Not Found" }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RetrieveAnItWarehouse-v2026-09-15RequestInternalServerError" } } }, "description": "Internal Server Error" } }, "security": [ { "deelToken": [] } ], "summary": "Retrieve a warehouse", "tags": [ "itWarehouses" ] } }, "/knowledge-hub/country-guide/{country_code}": { "get": { "description": "Returns country guides segmented by audience and contract type for the specified `country_code`.\n\n **Token scopes**: `knowledge-hub:read`", "operationId": "knowledgeHub_getKnowledgeHubCountryGuidesByCountryCode-v2026-01-01", "parameters": [ { "description": "Country code for which we need to fetch the country guides", "in": "path", "name": "country_code", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Knowledge_Hub_getKnowledgeHubCountryGuidesByCountryCode-v2026-01-01_Response_200" } } }, "description": "Successful response containing audiences, their contract types, and associated categories, fields, and articles." }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetKnowledgeHubCountryGuidesByCountryCode-v2026-01-01RequestBadRequestError" } } }, "description": "Operation failed." }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContainer" } } }, "description": "Operation failed." }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContainer" } } }, "description": "Operation failed." }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContainer" } } }, "description": "Operation failed." }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetKnowledgeHubCountryGuidesByCountryCode-v2026-01-01RequestInternalServerError" } } }, "description": "Operation failed." } }, "security": [ { "deelToken": [] } ], "summary": "Get Knowledge Hub Country Guides by Country Code", "tags": [ "knowledgeHub" ] } }, "/legal-entities": { "get": { "description": "Lists the legal entities under the calling organization so an integration can resolve which entity a worker, contract, payroll cycle or invoice belongs to. The ids returned are the legal entity ids other Deel endpoints expect; use the single-entity endpoint when you already hold an id and need the full record.\n\n **Token scopes**: `organizations:read`, `accounting:read`", "operationId": "legalEntities_getLegalEntities", "parameters": [ { "description": "The number of results to return per page.", "in": "query", "name": "limit", "required": false, "schema": { "default": 100, "maximum": 100, "minimum": 1, "type": "integer" } }, { "description": "Sorting order of the results.", "in": "query", "name": "sort_order", "required": false, "schema": { "$ref": "#/components/schemas/LegalEntitiesGetParametersSortOrder", "default": "ASC" } }, { "description": "Cursor for pagination.", "in": "query", "name": "cursor", "required": false, "schema": { "type": "string" } }, { "description": "Whether to include archived legal entities in the results.", "in": "query", "name": "include_archived", "required": false, "schema": { "default": true, "type": "boolean" } }, { "description": "Filter by specific legal entity ID.", "in": "query", "name": "legal_entity_id", "required": false, "schema": { "type": "string" } }, { "description": "Filter by global payroll flag.", "in": "query", "name": "global_payroll", "required": false, "schema": { "type": "boolean" } }, { "description": "Filter by entity type.", "in": "query", "name": "type", "required": false, "schema": { "type": "string" } }, { "description": "Filter by country.", "in": "query", "name": "country", "required": false, "schema": { "type": "string" } }, { "description": "Whether to include payroll settings in the response.", "in": "query", "name": "include_payroll_settings", "required": false, "schema": { "type": "boolean" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/legal-entities_getLegalEntities_Response_200" } } }, "description": "Successful operation." }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ListOfLegalEntities-v2026-01-01RequestBadRequestError" } } }, "description": "Operation failed." }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContainer" } } }, "description": "Operation failed." }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContainer" } } }, "description": "Operation failed." }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContainer" } } }, "description": "Operation failed." }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContainer" } } }, "description": "Operation failed." } }, "security": [ { "deelToken": [] } ], "summary": "List of legal entities", "tags": [ "legalEntities" ] }, "post": { "description": "Creates a new legal entity under the organization and returns the entity record including its assigned id.\n\n **Token scopes**: `legal-entity:write`, `legal-entity:read`", "operationId": "legalEntities_createLegalEntity", "requestBody": { "content": { "application/json": { "schema": { "properties": { "data": { "$ref": "#/components/schemas/LegalEntitiesPostRequestBodyContentApplicationJsonSchemaData" } }, "type": "object" } } } }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/legal-entities_createLegalEntity_Response_200" } } }, "description": "Successfully created legal entity." }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreateLegalEntity-v2026-01-01RequestBadRequestError" } } }, "description": "Invalid request parameters." }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContainer" } } }, "description": "Operation failed." }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreateLegalEntity-v2026-01-01RequestForbiddenError" } } }, "description": "Permission denied. User must have the `entities.manage` permission." }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContainer" } } }, "description": "Operation failed." }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContainer" } } }, "description": "Operation failed." } }, "security": [ { "deelToken": [] } ], "summary": "Create a new legal entity", "tags": [ "legalEntities" ] } }, "/legal-entities/country-fields/{country_code}": { "get": { "description": "Retrieve which registration and tax identifier fields a country requires before you submit a legal entity to Deel, so you can collect the right values ahead of the entity-creation call. Each field returns its name, kind (`registration_id`/`tax_id`), an optional validation regex, and a requirement level (`mandatory`/`optional`/`bypass`).\n\n **Token scopes**: `legal-entity:read`", "operationId": "legalEntities_getCountryFieldsForALegalEntity-v2026-09-11", "parameters": [ { "description": "ISO 3166-1 alpha-2 country code. Case-insensitive.", "in": "path", "name": "country_code", "required": true, "schema": { "pattern": "^[A-Za-z]{2}$", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Legal_Entities_getCountryFieldsForALegalEntity-v2026-09-11_Response_200" } } }, "description": "Registration/tax identifier fields for the given country." }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetCountryFieldsForALegalEntity-v2026-09-11RequestBadRequestError" } } }, "description": "Malformed country code (not two ASCII letters)." }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContainer" } } }, "description": "Operation failed." }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContainer" } } }, "description": "Operation failed." }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetCountryFieldsForALegalEntity-v2026-09-11RequestNotFoundError" } } }, "description": "Well-formed country code that is not a recognized ISO 3166-1 alpha-2 country." }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContainer" } } }, "description": "Operation failed." } }, "security": [ { "deelToken": [] } ], "summary": "Get registration/tax identifier fields for a country", "tags": [ "legalEntities" ] } }, "/legal-entities/registration-documents": { "get": { "description": "Lists the registration documents required across every legal entity in the organization, in one call. Use this to see what is still outstanding organization-wide — to drive an onboarding status dashboard, or to reconcile records — rather than requesting each legal entity in turn. Pass `legal_entity_id` to narrow to specific entities. Requirements that have not been answered yet are included with a null `id`.\n\n **Token scopes**: `legal-entity:read`", "operationId": "documents_listOrganizationRegistrationDocuments-v2026-08-17", "parameters": [ { "description": "Maximum number of results to return per page.", "in": "query", "name": "limit", "required": false, "schema": { "default": 20, "maximum": 100, "minimum": 1, "type": "integer" } }, { "description": "Pagination cursor returned as `next_cursor` by the previous response. Omit for the first page.", "in": "query", "name": "cursor", "required": false, "schema": { "maxLength": 2048, "pattern": "^[A-Za-z0-9_-]+$", "type": "string" } }, { "description": "Narrow to specific legal entities. Repeat the parameter to pass several values. Omit for every entity you can access.", "in": "query", "name": "legal_entity_id", "required": false, "schema": { "items": { "format": "uuid", "type": "string" }, "type": "array" } }, { "description": "Free-text search on the requirement name.", "in": "query", "name": "search", "required": false, "schema": { "maxLength": 255, "type": "string" } }, { "description": "Filter by submission status. Repeat the parameter to pass several values.", "in": "query", "name": "status", "required": false, "schema": { "items": { "$ref": "#/components/schemas/LegalEntitiesRegistrationDocumentsGetParametersStatusSchemaItems" }, "type": "array" } }, { "description": "Filter by the product the requirement applies to. Repeat the parameter to pass several values.", "in": "query", "name": "product_type", "required": false, "schema": { "items": { "$ref": "#/components/schemas/LegalEntitiesRegistrationDocumentsGetParametersProductTypeSchemaItems" }, "type": "array" } }, { "description": "Filter to specific requirements. Repeat the parameter to pass several values.", "in": "query", "name": "requirement_id", "required": false, "schema": { "items": { "format": "uuid", "type": "string" }, "type": "array" } }, { "description": "Return superseded submissions instead of the current ones.", "in": "query", "name": "only_archived", "required": false, "schema": { "default": false, "type": "boolean" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Documents_listOrganizationRegistrationDocuments-v2026-08-17_Response_200" } } }, "description": "Registration documents returned successfully." }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ListOrganizationRegistrationDocuments-v2026-08-17RequestBadRequestError" } } }, "description": "Bad request — invalid or missing parameters." }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ListOrganizationRegistrationDocuments-v2026-08-17RequestUnauthorizedError" } } }, "description": "Unauthorized — missing or invalid authentication token." }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ListOrganizationRegistrationDocuments-v2026-08-17RequestForbiddenError" } } }, "description": "Forbidden — the token lacks access to this legal entity." }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ListOrganizationRegistrationDocuments-v2026-08-17RequestNotFoundError" } } }, "description": "Not found." }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContainer" } } }, "description": "Operation failed." } }, "security": [ { "deelToken": [] } ], "summary": "List Organization Registration Documents", "tags": [ "documents" ] } }, "/legal-entities/{id}": { "delete": { "description": "Archives the legal entity identified by id, marking it as inactive without permanently removing it; the response includes the archived_at timestamp.\n\n **Token scopes**: `legal-entity:read`, `legal-entity:write`", "operationId": "legalEntities_deleteLegalEntity", "parameters": [ { "description": "The ID of the legal entity to archive.", "in": "path", "name": "id", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/legal-entities_deleteLegalEntity_Response_200" } } }, "description": "Successfully archived the legal entity." }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DeleteLegalEntity-v2026-01-01RequestBadRequestError" } } }, "description": "Invalid request parameters." }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContainer" } } }, "description": "Operation failed." }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DeleteLegalEntity-v2026-01-01RequestForbiddenError" } } }, "description": "Permission denied." }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContainer" } } }, "description": "Operation failed." }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContainer" } } }, "description": "Operation failed." } }, "security": [ { "deelToken": [] } ], "summary": "Delete a legal entity", "tags": [ "legalEntities" ] }, "patch": { "description": "Applies a partial update to an existing legal entity identified by id; only fields included in the request body are modified.\n\n **Token scopes**: `legal-entity:write`", "operationId": "legalEntities_updateLegalEntity", "parameters": [ { "description": "The ID of the legal entity to update.", "in": "path", "name": "id", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "properties": { "data": { "$ref": "#/components/schemas/LegalEntitiesIdPatchRequestBodyContentApplicationJsonSchemaData" } }, "type": "object" } } } }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/legal-entities_updateLegalEntity_Response_200" } } }, "description": "Successfully updated the legal entity." }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EditALegalEntity-v2026-01-01RequestBadRequestError" } } }, "description": "Invalid request parameters." }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContainer" } } }, "description": "Operation failed." }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EditALegalEntity-v2026-01-01RequestForbiddenError" } } }, "description": "Permission denied." }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContainer" } } }, "description": "Operation failed." }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContainer" } } }, "description": "Operation failed." } }, "security": [ { "deelToken": [] } ], "summary": "Edit a legal entity", "tags": [ "legalEntities" ] } }, "/legal-entities/{legal_entity_id}": { "get": { "description": "Returns the full record for a single legal entity by id: registration and tax identifiers, address, industry, incorporation date and lifecycle status. `cdd_status` carries the raw Customer Due Diligence value (coalesced to `PENDING` when CDD is required, `NOT_REQUIRED` for Tier-0/SaaS entities before verification starts) and `status` the mapped lifecycle status, so integrations can poll entity clearance.\n\n **Token scopes**: `legal-entity:read`", "operationId": "legalEntities_getLegalEntity-v2026-09-09", "parameters": [ { "description": "The ID of the legal entity to retrieve.", "in": "path", "name": "legal_entity_id", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Legal_Entities_getLegalEntity-v2026-09-09_Response_200" } } }, "description": "Successful operation." }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetLegalEntity-v2026-09-09RequestBadRequestError" } } }, "description": "Invalid request parameters." }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContainer" } } }, "description": "Operation failed." }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetLegalEntity-v2026-09-09RequestForbiddenError" } } }, "description": "The legal entity belongs to another organization." }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetLegalEntity-v2026-09-09RequestNotFoundError" } } }, "description": "Legal entity not found." }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContainer" } } }, "description": "Operation failed." } }, "security": [ { "deelToken": [] } ], "summary": "Retrieve a legal entity", "tags": [ "legalEntities" ] } }, "/legal-entities/{legal_entity_id}/cost-centers": { "get": { "description": "Returns all cost centers associated with the specified legal_entity_id.\n\n **Token scopes**: `legal-entity:read`", "operationId": "costCenters_getLegalEntityCostCenters", "parameters": [ { "description": "Legal entity id", "in": "path", "name": "legal_entity_id", "required": true, "schema": { "format": "uuid", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/cost-centers_getLegalEntityCostCenters_Response_200" } } }, "description": "Cost center data was successfully fetched" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetCostCentersByLegalEntity-v2026-01-01RequestBadRequestError" } } }, "description": "Operation failed." }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContainer" } } }, "description": "Operation failed." }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContainer" } } }, "description": "Operation failed." }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContainer" } } }, "description": "Operation failed." }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContainer" } } }, "description": "Operation failed." } }, "security": [ { "deelToken": [] } ], "summary": "Get cost centers by legal entity", "tags": [ "costCenters" ] } }, "/legal-entities/{legal_entity_id}/cost-centers/synchronize": { "post": { "description": "Update legal entity cost center's data to replicate the data provided on the request\n\n **Token scopes**: `legal-entity:write`", "operationId": "costCenters_syncCostCentersForLegalEntity-v2026-01-01", "parameters": [ { "description": "Legal entity id", "in": "path", "name": "legal_entity_id", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "properties": { "data": { "items": { "$ref": "#/components/schemas/LegalEntitiesLegalEntityIdCostCentersSynchronizePostRequestBodyContentApplicationJsonSchemaDataItems" }, "type": "array" } }, "required": [ "data" ], "type": "object" } } }, "description": "Cost center data to overwrite current configuration" }, "responses": { "201": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Cost_Centers_syncCostCentersForLegalEntity-v2026-01-01_Response_201" } } }, "description": "Cost center data was successfully updated" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SyncCostCentersForLegalEntity-v2026-01-01RequestBadRequestError" } } }, "description": "Cannot define legal entity cost centers as the provided data." }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContainer" } } }, "description": "Operation failed." }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContainer" } } }, "description": "Operation failed." }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContainer" } } }, "description": "Operation failed." }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SyncCostCentersForLegalEntity-v2026-01-01RequestInternalServerError" } } }, "description": "Unexpected error" } }, "security": [ { "deelToken": [] } ], "summary": "Sync cost centers for legal entity", "tags": [ "costCenters" ] } }, "/legal-entities/{legal_entity_id}/kyb": { "get": { "description": "Returns the Know Your Business (entity verification) state of a legal entity: the verification status, whether the client must act, the outstanding requirements including Proof of Authority, which company documents have been supplied, the declared persons of significant control, when the entity was rejected, and the open enhanced due diligence (EDD) request with its questions while the entity is in EDD. Use it to drive an automated verification flow instead of finishing KYB in the Deel app.\n\n **Token scopes**: `legal-entity:read`\n\n **Beta**: this version requires the `X-Beta: true` request header and its contract may change before it is promoted to stable. It is scheduled to become stable on 2027-01-01.", "operationId": "legalEntities_getLegalEntityKybState-v2026-10-01", "parameters": [ { "description": "Public id of the legal entity. The entity must belong to the authenticated organization; any other id answers 404.", "in": "path", "name": "legal_entity_id", "required": true, "schema": { "format": "uuid", "type": "string" } }, { "description": "Opts in to the beta version of this endpoint. Must be `true`.", "in": "header", "name": "X-Beta", "required": true, "schema": { "$ref": "#/components/schemas/LegalEntitiesLegalEntityIdKybGetParametersXBeta" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Legal_Entities_getLegalEntityKybState-v2026-10-01_Response_200" } } }, "description": "The KYB state of the legal entity." }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContainer" } } }, "description": "Operation failed." }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetLegalEntityKybState-v2026-10-01RequestUnauthorizedError" } } }, "description": "Unauthorized. The request token is missing or invalid. The API gateway rejects an unauthenticated call before it reaches Deel; a call that reaches Deel without a valid session is rejected by the access middleware, whose error item carries a message and no code." }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetLegalEntityKybState-v2026-10-01RequestForbiddenError" } } }, "description": "Forbidden. The token lacks the `legal-entity:read` scope or the actor cannot view entities of this organization." }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetLegalEntityKybState-v2026-10-01RequestNotFoundError" } } }, "description": "Not found. The legal entity does not exist or does not belong to the authenticated organization. The two cases are deliberately indistinguishable." }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContainer" } } }, "description": "Operation failed." } }, "security": [ { "deelToken": [] } ], "summary": "Retrieve the KYB state of a legal entity", "tags": [ "legalEntities" ] }, "post": { "description": "Submits the Know Your Business (entity verification) information for a legal entity — company facts, required declarations, documents, and declared persons of significant control. Only accepted while the entity is `PENDING` or `DRAFT`; refused once it is `REJECTED`, already under review, approved, or when verification isn't required. Returns the resulting KYB state after submission.\n\n **Token scopes**: `legal-entity:write`\n\n **Beta**: this version requires the `X-Beta: true` request header and its contract may change before it is promoted to stable. It is scheduled to become stable on 2027-01-12.", "operationId": "legalEntities_submitLegalEntityKyb-v2026-10-12", "parameters": [ { "description": "Public id of the legal entity. The entity must belong to the authenticated organization; any other id answers 404.", "in": "path", "name": "legal_entity_id", "required": true, "schema": { "format": "uuid", "type": "string" } }, { "description": "Opts in to the beta version of this endpoint. Must be `true`.", "in": "header", "name": "X-Beta", "required": true, "schema": { "$ref": "#/components/schemas/LegalEntitiesLegalEntityIdKybPostParametersXBeta" } } ], "requestBody": { "content": { "application/json": { "schema": { "properties": { "data": { "$ref": "#/components/schemas/LegalEntitiesLegalEntityIdKybPostRequestBodyContentApplicationJsonSchemaData" } }, "required": [ "data" ], "type": "object" } } }, "description": "The verification information for the legal entity." }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Legal_Entities_submitLegalEntityKyb-v2026-10-12_Response_200" } } }, "description": "The submission was accepted. The KYB state after the submission." }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SubmitLegalEntityKyb-v2026-10-12RequestBadRequestError" } } }, "description": "Bad request. Codes: VALIDATION_ERROR (the request body failed validation; the error item also carries a details object naming the offending key), GENERIC_ERROR (the submitted domain could not be normalised, or the authenticated organization is not set up for deal registration). The API gateway rejects a schema-invalid request body before it reaches Deel; each error item of that response carries a path field and no code, and the body also carries a request object that describes the failed call." }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SubmitLegalEntityKyb-v2026-10-12RequestUnauthorizedError" } } }, "description": "Unauthorized. The request token is missing or invalid. The API gateway rejects an unauthenticated call before it reaches Deel; a call that reaches Deel without a valid session is rejected by the access middleware, whose error item carries a message and no code." }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SubmitLegalEntityKyb-v2026-10-12RequestForbiddenError" } } }, "description": "Forbidden. Codes: GENERIC_ERROR (the token lacks the `legal-entity:write` scope, or the actor cannot submit verification for this organization), KYB_SERVICE_ACCOUNT_MISSING (the organization has no service account to act as; contact Deel support)." }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SubmitLegalEntityKyb-v2026-10-12RequestNotFoundError" } } }, "description": "Not found. The legal entity does not exist or does not belong to the authenticated organization. The two cases are deliberately indistinguishable." }, "409": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SubmitLegalEntityKyb-v2026-10-12RequestConflictError" } } }, "description": "Conflict. Codes: KYB_SUBMISSION_IN_REVIEW (a submission is under review; poll the KYB state or subscribe to the `legal-entity.kyb.changed` webhook), KYB_ALREADY_APPROVED, KYB_NOT_REQUIRED, KYB_ENTITY_REJECTED (the verification was rejected; resubmission after a rejection is not yet supported over the public API)." }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SubmitLegalEntityKyb-v2026-10-12RequestUnprocessableEntityError" } } }, "description": "Unprocessable. Codes: KYB_DOCUMENT_REFERENCE_INVALID (`details.keys` names every offending field; nothing was submitted), KYB_SUBMISSION_REJECTED (the verification service rejected the record; `details.reason` carries its message when available, and the document handles remain usable)." }, "429": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SubmitLegalEntityKyb-v2026-10-12RequestTooManyRequestsError" } } }, "description": "Too many requests. The verification service is rate-limiting submissions; nothing was submitted. Retry after a delay." }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContainer" } } }, "description": "Operation failed." }, "503": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SubmitLegalEntityKyb-v2026-10-12RequestServiceUnavailableError" } } }, "description": "Service unavailable. The verification status could not be read, so the submission was not attempted. Retry later." } }, "security": [ { "deelToken": [] } ], "summary": "Submit KYB information for a legal entity", "tags": [ "legalEntities" ] } }, "/legal-entities/{legal_entity_id}/kyb/documents": { "post": { "description": "Stores one KYB document (a company document, a Proof of Authority, or one side of an identity document or selfie for a person of significant control) for a legal entity and returns an opaque handle. Reference the handle from `POST /rest/legal-entities/{legal_entity_id}/kyb`. Handles are bound to the legal entity, usable once, and expire after 24 hours if unused. The file itself is never returned.\n\n **Token scopes**: `legal-entity:write`\n\n **Beta**: this version requires the `X-Beta: true` request header and its contract may change before it is promoted to stable. It is scheduled to become stable on 2027-01-02.", "operationId": "legalEntities_uploadLegalEntityKybDocument-v2026-10-02", "parameters": [ { "description": "Public id of the legal entity. The entity must belong to the authenticated organization; any other id answers 404.", "in": "path", "name": "legal_entity_id", "required": true, "schema": { "format": "uuid", "type": "string" } }, { "description": "Opts in to the beta version of this endpoint. Must be `true`.", "in": "header", "name": "X-Beta", "required": true, "schema": { "$ref": "#/components/schemas/LegalEntitiesLegalEntityIdKybDocumentsPostParametersXBeta" } } ], "requestBody": { "content": { "multipart/form-data": { "schema": { "properties": { "data": { "$ref": "#/components/schemas/LegalEntitiesLegalEntityIdKybDocumentsPostRequestBodyContentMultipartFormDataSchemaData" } }, "required": [ "data" ], "type": "object" } } }, "description": "One KYB document and the type it should be recorded as." }, "responses": { "201": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Legal_Entities_uploadLegalEntityKybDocument-v2026-10-02_Response_201" } } }, "description": "The document was stored and registered for verification. Use the returned handle in a KYB submission." }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UploadLegalEntityKybDocument-v2026-10-02RequestBadRequestError" } } }, "description": "Bad request. No file was uploaded, or the multipart body could not be processed." }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UploadLegalEntityKybDocument-v2026-10-02RequestUnauthorizedError" } } }, "description": "Unauthorized. The request token is missing or invalid. The API gateway rejects an unauthenticated call before it reaches Deel; a call that reaches Deel without a valid session is rejected by the access middleware, whose error item carries a message and no code." }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UploadLegalEntityKybDocument-v2026-10-02RequestForbiddenError" } } }, "description": "Forbidden. Codes: GENERIC_ERROR (the token lacks the `legal-entity:write` scope, or the actor cannot submit verification for this organization), KYB_SERVICE_ACCOUNT_MISSING (the organization has no service account to act as; contact Deel support)." }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UploadLegalEntityKybDocument-v2026-10-02RequestNotFoundError" } } }, "description": "Not found. The legal entity does not exist or does not belong to the authenticated organization. The two cases are deliberately indistinguishable." }, "415": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UploadLegalEntityKybDocument-v2026-10-02RequestUnsupportedMediaTypeError" } } }, "description": "Unsupported media type. The file content type is not accepted for the given document type; `details.allowed` lists the accepted types." }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UploadLegalEntityKybDocument-v2026-10-02RequestUnprocessableEntityError" } } }, "description": "Unprocessable. Codes: KYB_DOCUMENT_TYPE_INVALID (unknown `document_type`; `details.allowed` lists the accepted values), KYB_DOCUMENT_CLAIM_FAILED (the verification service refused the file; upload it again)." }, "429": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UploadLegalEntityKybDocument-v2026-10-02RequestTooManyRequestsError" } } }, "description": "Too many requests. Either the per-organization upload rate limit was hit, or the legal entity already has 200 uploaded documents that no submission has used yet (code KYB_DOCUMENT_LIMIT_REACHED)." }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContainer" } } }, "description": "Operation failed." } }, "security": [ { "deelToken": [] } ], "summary": "Upload a KYB document for a legal entity", "tags": [ "legalEntities" ] } }, "/legal-entities/{legal_entity_id}/kyb/edd": { "post": { "description": "Answers the open enhanced due diligence (EDD) request of a legal entity with one answer per question listed in the `edd` block of the KYB state. The request then shows as `ANSWERED` in the KYB state until Deel resumes the review. Refused when the entity has no open EDD request, when the request is not the one the KYB state lists, and when the form cannot be answered over the API. Returns the KYB state after the answers.\n\n **Token scopes**: `legal-entity:write`\n\n **Beta**: this version requires the `X-Beta: true` request header and its contract may change before it is promoted to stable. It is scheduled to become stable on 2027-01-16.", "operationId": "legalEntities_answerLegalEntityKybEdd-v2026-10-16", "parameters": [ { "description": "Public id of the legal entity. The entity must belong to the authenticated organization; any other id answers 404.", "in": "path", "name": "legal_entity_id", "required": true, "schema": { "format": "uuid", "type": "string" } }, { "description": "Opts in to the beta version of this endpoint. Must be `true`.", "in": "header", "name": "X-Beta", "required": true, "schema": { "$ref": "#/components/schemas/LegalEntitiesLegalEntityIdKybEddPostParametersXBeta" } } ], "requestBody": { "content": { "application/json": { "schema": { "properties": { "data": { "$ref": "#/components/schemas/LegalEntitiesLegalEntityIdKybEddPostRequestBodyContentApplicationJsonSchemaData" } }, "required": [ "data" ], "type": "object" } } }, "description": "The answers to the open EDD request." }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Legal_Entities_answerLegalEntityKybEdd-v2026-10-16_Response_200" } } }, "description": "The answers were recorded. The KYB state after the answers." }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AnswerLegalEntityKybEdd-v2026-10-16RequestBadRequestError" } } }, "description": "Bad request. Codes: VALIDATION_ERROR (the body failed validation), KYB_EDD_ANSWERS_INVALID (an answer is missing, does not match its question, or names an unknown question; `details.keys` lists the question keys). Nothing was recorded." }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AnswerLegalEntityKybEdd-v2026-10-16RequestUnauthorizedError" } } }, "description": "Unauthorized. The request token is missing or invalid. The API gateway rejects an unauthenticated call before it reaches Deel; a call that reaches Deel without a valid session is rejected by the access middleware, whose error item carries a message and no code." }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AnswerLegalEntityKybEdd-v2026-10-16RequestForbiddenError" } } }, "description": "Forbidden. Codes: GENERIC_ERROR (the token lacks the `legal-entity:write` scope, or the actor cannot submit verification for this organization), KYB_SERVICE_ACCOUNT_MISSING (the organization has no service account to act as; contact Deel support)." }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AnswerLegalEntityKybEdd-v2026-10-16RequestNotFoundError" } } }, "description": "Not found. The legal entity does not exist or does not belong to the authenticated organization. The two cases are deliberately indistinguishable." }, "409": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AnswerLegalEntityKybEdd-v2026-10-16RequestConflictError" } } }, "description": "Conflict. Codes: KYB_EDD_NOT_OPEN (the entity is not in EDD, or the request was already answered), KYB_EDD_REQUEST_MISMATCH (`edd_request_id` is not the open request; read the KYB state again), KYB_EDD_NOT_ANSWERABLE (the form has a required unsupported question, or it is addressed to another submitter, such as a person who submitted verification in the Deel app; `details.keys` lists blocking question keys when any)." }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AnswerLegalEntityKybEdd-v2026-10-16RequestUnprocessableEntityError" } } }, "description": "Unprocessable. Codes: KYB_EDD_ANSWERS_REJECTED (the form service did not record the answers; the request stays open; `details.reason` carries the form service's reason when it gave one and does not name the question), KYB_EDD_DOCUMENT_REFERENCE_INVALID (a document handle is unknown, expired, already used, belongs to another legal entity or EDD request, answers a different question, or is used for more than one field; `details.keys` lists the question keys). Nothing was recorded and the other handles stay usable." }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContainer" } } }, "description": "Operation failed." }, "503": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AnswerLegalEntityKybEdd-v2026-10-16RequestServiceUnavailableError" } } }, "description": "Service unavailable. The EDD request or its form could not be read or written. Read the KYB state before retrying." } }, "security": [ { "deelToken": [] } ], "summary": "Submit EDD request answers for a legal entity", "tags": [ "legalEntities" ] } }, "/legal-entities/{legal_entity_id}/kyb/edd/documents": { "post": { "description": "Stores one document answering a `DOCUMENT_UPLOAD` question of the open enhanced due diligence (EDD) request of a legal entity, and returns an opaque handle. Reference the handle from `POST /rest/legal-entities/{legal_entity_id}/kyb/edd`. Handles are bound to the legal entity, the EDD request and the question, usable once, and expire after 24 hours if unused. The file itself is never returned.\n\n **Token scopes**: `legal-entity:write`\n\n **Beta**: this version requires the `X-Beta: true` request header and its contract may change before it is promoted to stable. It is scheduled to become stable on 2027-01-14.", "operationId": "legalEntities_uploadLegalEntityKybEddDocument-v2026-10-14", "parameters": [ { "description": "Public id of the legal entity. The entity must belong to the authenticated organization; any other id answers 404.", "in": "path", "name": "legal_entity_id", "required": true, "schema": { "format": "uuid", "type": "string" } }, { "description": "Opts in to the beta version of this endpoint. Must be `true`.", "in": "header", "name": "X-Beta", "required": true, "schema": { "$ref": "#/components/schemas/LegalEntitiesLegalEntityIdKybEddDocumentsPostParametersXBeta" } } ], "requestBody": { "content": { "multipart/form-data": { "schema": { "properties": { "data": { "$ref": "#/components/schemas/LegalEntitiesLegalEntityIdKybEddDocumentsPostRequestBodyContentMultipartFormDataSchemaData" } }, "required": [ "data" ], "type": "object" } } }, "description": "One document answering a DOCUMENT_UPLOAD question of the open EDD request." }, "responses": { "201": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Legal_Entities_uploadLegalEntityKybEddDocument-v2026-10-14_Response_201" } } }, "description": "The document was stored. Use the returned handle in an EDD answer." }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UploadLegalEntityKybEddDocument-v2026-10-14RequestBadRequestError" } } }, "description": "Bad request. No file was uploaded, or the multipart body could not be processed." }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UploadLegalEntityKybEddDocument-v2026-10-14RequestUnauthorizedError" } } }, "description": "Unauthorized. The request token is missing or invalid. The API gateway rejects an unauthenticated call before it reaches Deel; a call that reaches Deel without a valid session is rejected by the access middleware, whose error item carries a message and no code." }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UploadLegalEntityKybEddDocument-v2026-10-14RequestForbiddenError" } } }, "description": "Forbidden. Codes: GENERIC_ERROR (the token lacks the `legal-entity:write` scope, or the actor cannot submit verification for this organization), KYB_SERVICE_ACCOUNT_MISSING (the organization has no service account to act as; contact Deel support)." }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UploadLegalEntityKybEddDocument-v2026-10-14RequestNotFoundError" } } }, "description": "Not found. The legal entity does not exist or does not belong to the authenticated organization. The two cases are deliberately indistinguishable." }, "409": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UploadLegalEntityKybEddDocument-v2026-10-14RequestConflictError" } } }, "description": "Conflict. Codes: KYB_EDD_NOT_OPEN (the entity is not in EDD, or the request was already answered), KYB_EDD_REQUEST_MISMATCH (`edd_request_id` is not the open request; read the KYB state again)." }, "415": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UploadLegalEntityKybEddDocument-v2026-10-14RequestUnsupportedMediaTypeError" } } }, "description": "Unsupported media type. The file content type is not accepted; `details.allowed` lists the accepted types (application/pdf, image/jpeg, image/png)." }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UploadLegalEntityKybEddDocument-v2026-10-14RequestUnprocessableEntityError" } } }, "description": "Unprocessable. Codes: KYB_EDD_DOCUMENT_QUESTION_INVALID (`question_key` is not a `DOCUMENT_UPLOAD` question of the open EDD request), KYB_EDD_DOCUMENT_CLAIM_FAILED (the verification service refused the file; upload it again)." }, "429": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UploadLegalEntityKybEddDocument-v2026-10-14RequestTooManyRequestsError" } } }, "description": "Too many requests. Either the per-organization upload rate limit was hit, or the EDD request already has 500 uploaded documents that no answer has used yet (code KYB_EDD_DOCUMENT_LIMIT_REACHED)." }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContainer" } } }, "description": "Operation failed." }, "503": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UploadLegalEntityKybEddDocument-v2026-10-14RequestServiceUnavailableError" } } }, "description": "Service unavailable. The EDD request or its form could not be read, so the question could not be checked. The file was not stored; retry later." } }, "security": [ { "deelToken": [] } ], "summary": "Upload a document for an EDD request of a legal entity", "tags": [ "legalEntities" ] } }, "/legal-entities/{legal_entity_id}/payroll-events": { "get": { "description": "Returns a paginated list of payroll events for the specified legal entity, optionally filtered by a date range; date_start must not be earlier than 5 years ago and date_end must not exceed 5 years in the future.\n\n **Token scopes**: `legal-entity:read`", "operationId": "listCycles_listPayrollCycles-v2026-01-01", "parameters": [ { "description": "The unique identifier (public ID) for the legal entity.", "in": "path", "name": "legal_entity_id", "required": true, "schema": { "format": "uuid", "type": "string" } }, { "description": "Start date in the format 'YYYY-MM-DD'. Must not be earlier than 5 years ago.", "in": "query", "name": "date_start", "required": false, "schema": { "format": "date", "type": "string" } }, { "description": "End date in the format 'YYYY-MM-DD'. Must not exceed 5 years in the future.", "in": "query", "name": "date_end", "required": false, "schema": { "format": "date", "type": "string" } }, { "description": "Maximum number of items to return.", "in": "query", "name": "limit", "required": false, "schema": { "default": 20, "maximum": 100, "minimum": 1, "type": "integer" } }, { "description": "Pagination cursor, CUID or UUID format.", "in": "query", "name": "cursor", "required": false, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/List_Cycles_listPayrollCycles-v2026-01-01_Response_200" } } }, "description": "Successful operation." }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ListPayrollCycles-v2026-01-01RequestBadRequestError" } } }, "description": "Validation error or bad input." }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContainer" } } }, "description": "Operation failed." }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContainer" } } }, "description": "Operation failed." }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContainer" } } }, "description": "Operation failed." }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ListPayrollCycles-v2026-01-01RequestInternalServerError" } } }, "description": "Internal server error." } }, "security": [ { "deelToken": [] } ], "summary": "List payroll cycles", "tags": [ "listCycles" ] } }, "/legal-entities/{legal_entity_id}/registration-documents": { "get": { "description": "Lists the registration documents required from a legal entity, together with what has been submitted and how far through review it is. Use this to find out what is still outstanding before a first payroll, or to reconcile submission status. Requirements that have not been answered yet are included with a null `id`.\n\n **Token scopes**: `legal-entity:read`", "operationId": "documents_listLegalEntityRegistrationDocuments-v2026-08-17", "parameters": [ { "description": "Public UUID of the legal entity.", "in": "path", "name": "legal_entity_id", "required": true, "schema": { "format": "uuid", "type": "string" } }, { "description": "Maximum number of results to return per page.", "in": "query", "name": "limit", "required": false, "schema": { "default": 20, "maximum": 100, "minimum": 1, "type": "integer" } }, { "description": "Pagination cursor returned as `next_cursor` by the previous response. Omit for the first page.", "in": "query", "name": "cursor", "required": false, "schema": { "maxLength": 2048, "pattern": "^[A-Za-z0-9_-]+$", "type": "string" } }, { "description": "Free-text search on the requirement name.", "in": "query", "name": "search", "required": false, "schema": { "maxLength": 255, "type": "string" } }, { "description": "Filter by submission status. Repeat the parameter to pass several values.", "in": "query", "name": "status", "required": false, "schema": { "items": { "$ref": "#/components/schemas/LegalEntitiesLegalEntityIdRegistrationDocumentsGetParametersStatusSchemaItems" }, "type": "array" } }, { "description": "Filter by the product the requirement applies to. Repeat the parameter to pass several values.", "in": "query", "name": "product_type", "required": false, "schema": { "items": { "$ref": "#/components/schemas/LegalEntitiesLegalEntityIdRegistrationDocumentsGetParametersProductTypeSchemaItems" }, "type": "array" } }, { "description": "Filter to specific requirements. Repeat the parameter to pass several values.", "in": "query", "name": "requirement_id", "required": false, "schema": { "items": { "format": "uuid", "type": "string" }, "type": "array" } }, { "description": "Return superseded submissions instead of the current ones.", "in": "query", "name": "only_archived", "required": false, "schema": { "default": false, "type": "boolean" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Documents_listLegalEntityRegistrationDocuments-v2026-08-17_Response_200" } } }, "description": "Documents returned successfully." }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ListLegalEntityRegistrationDocuments-v2026-08-17RequestBadRequestError" } } }, "description": "Bad request — invalid or missing parameters." }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ListLegalEntityRegistrationDocuments-v2026-08-17RequestUnauthorizedError" } } }, "description": "Unauthorized — missing or invalid authentication token." }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ListLegalEntityRegistrationDocuments-v2026-08-17RequestForbiddenError" } } }, "description": "Forbidden — the token lacks access to this legal entity." }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ListLegalEntityRegistrationDocuments-v2026-08-17RequestNotFoundError" } } }, "description": "Not found." }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContainer" } } }, "description": "Operation failed." } }, "security": [ { "deelToken": [] } ], "summary": "List Legal Entity Registration Documents", "tags": [ "documents" ] }, "post": { "description": "Submits one or more documents for a legal entity, each answering a document requirement. Upload the file contents to the File Service first, then reference each file by its `file_id` and `one_time_secret`. A requirement that needs approval enters review as `AWAITING_REVIEW`; other submissions are accepted as `COMPLETED`. Read `requirement.is_approval_required`, then poll the get-document endpoint. A new submission supersedes a rejected attempt for the same requirement.\n\n **Token scopes**: `legal-entity:write`", "operationId": "documents_submitLegalEntityRegistrationDocuments-v2026-08-17", "parameters": [ { "description": "Public UUID of the legal entity.", "in": "path", "name": "legal_entity_id", "required": true, "schema": { "format": "uuid", "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "properties": { "data": { "$ref": "#/components/schemas/LegalEntitiesLegalEntityIdRegistrationDocumentsPostRequestBodyContentApplicationJsonSchemaData" } }, "required": [ "data" ], "type": "object" } } } }, "responses": { "201": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Documents_submitLegalEntityRegistrationDocuments-v2026-08-17_Response_201" } } }, "description": "Documents submitted successfully." }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SubmitLegalEntityRegistrationDocuments-v2026-08-17RequestBadRequestError" } } }, "description": "Bad request — invalid or missing parameters." }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SubmitLegalEntityRegistrationDocuments-v2026-08-17RequestUnauthorizedError" } } }, "description": "Unauthorized — missing or invalid authentication token." }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SubmitLegalEntityRegistrationDocuments-v2026-08-17RequestForbiddenError" } } }, "description": "Forbidden — the token lacks access to this legal entity." }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SubmitLegalEntityRegistrationDocuments-v2026-08-17RequestNotFoundError" } } }, "description": "Not found." }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SubmitLegalEntityRegistrationDocuments-v2026-08-17RequestUnprocessableEntityError" } } }, "description": "Unprocessable entity — a file has an unsupported type or its content does not match its extension." }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContainer" } } }, "description": "Operation failed." } }, "security": [ { "deelToken": [] } ], "summary": "Submit Legal Entity Registration Documents", "tags": [ "documents" ] } }, "/legal-entities/{legal_entity_id}/registration-documents/{document_id}": { "delete": { "description": "Withdraws a document submission and removes its files. Use this when something was submitted in error — against the wrong requirement or for the wrong entity. Deletion is permanent: the submission and its files cannot be recovered, and the underlying requirement returns to being outstanding.\n\n **Token scopes**: `legal-entity:write`", "operationId": "documents_deleteLegalEntityRegistrationDocument-v2026-08-17", "parameters": [ { "description": "Public UUID of the legal entity.", "in": "path", "name": "legal_entity_id", "required": true, "schema": { "format": "uuid", "type": "string" } }, { "description": "Public UUID of the document submission.", "in": "path", "name": "document_id", "required": true, "schema": { "format": "uuid", "type": "string" } } ], "responses": { "204": { "content": { "application/json": { "schema": { "properties": {}, "type": "object" } } }, "description": "Document deleted successfully." }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DeleteLegalEntityRegistrationDocument-v2026-08-17RequestBadRequestError" } } }, "description": "Bad request — invalid or missing parameters." }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DeleteLegalEntityRegistrationDocument-v2026-08-17RequestUnauthorizedError" } } }, "description": "Unauthorized — missing or invalid authentication token." }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DeleteLegalEntityRegistrationDocument-v2026-08-17RequestForbiddenError" } } }, "description": "Forbidden — the token lacks access to this legal entity." }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DeleteLegalEntityRegistrationDocument-v2026-08-17RequestNotFoundError" } } }, "description": "Not found." }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContainer" } } }, "description": "Operation failed." } }, "security": [ { "deelToken": [] } ], "summary": "Delete Legal Entity Registration Document", "tags": [ "documents" ] }, "get": { "description": "Returns a single document submission, including its review status, attached files and any superseded revisions. Use this to poll one submission after uploading, rather than re-listing every document for the entity. Archived submissions are returned by this endpoint as well as active ones.\n\n **Token scopes**: `legal-entity:read`", "operationId": "documents_getLegalEntityRegistrationDocument-v2026-08-17", "parameters": [ { "description": "Public UUID of the legal entity.", "in": "path", "name": "legal_entity_id", "required": true, "schema": { "format": "uuid", "type": "string" } }, { "description": "Public UUID of the document submission.", "in": "path", "name": "document_id", "required": true, "schema": { "format": "uuid", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Documents_getLegalEntityRegistrationDocument-v2026-08-17_Response_200" } } }, "description": "Document returned successfully." }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetLegalEntityRegistrationDocument-v2026-08-17RequestBadRequestError" } } }, "description": "Bad request — invalid or missing parameters." }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetLegalEntityRegistrationDocument-v2026-08-17RequestUnauthorizedError" } } }, "description": "Unauthorized — missing or invalid authentication token." }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetLegalEntityRegistrationDocument-v2026-08-17RequestForbiddenError" } } }, "description": "Forbidden — the token lacks access to this legal entity." }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetLegalEntityRegistrationDocument-v2026-08-17RequestNotFoundError" } } }, "description": "Not found." }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContainer" } } }, "description": "Operation failed." } }, "security": [ { "deelToken": [] } ], "summary": "Get Legal Entity Registration Document", "tags": [ "documents" ] }, "patch": { "description": "Attaches more files to an existing submission, keeping the files already on it. Use this when a document was submitted incomplete — a missing page or an extra supporting file — and it is still awaiting review. To replace a rejected submission outright, use the replace-files endpoint instead.\n\n **Token scopes**: `legal-entity:write`", "operationId": "documents_addLegalEntityRegistrationDocumentFiles-v2026-08-17", "parameters": [ { "description": "Public UUID of the legal entity.", "in": "path", "name": "legal_entity_id", "required": true, "schema": { "format": "uuid", "type": "string" } }, { "description": "Public UUID of the document submission.", "in": "path", "name": "document_id", "required": true, "schema": { "format": "uuid", "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "properties": { "data": { "$ref": "#/components/schemas/LegalEntitiesLegalEntityIdRegistrationDocumentsDocumentIdPatchRequestBodyContentApplicationJsonSchemaData" } }, "required": [ "data" ], "type": "object" } } } }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Documents_addLegalEntityRegistrationDocumentFiles-v2026-08-17_Response_200" } } }, "description": "Files added successfully." }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AddLegalEntityRegistrationDocumentFiles-v2026-08-17RequestBadRequestError" } } }, "description": "Bad request — invalid or missing parameters." }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AddLegalEntityRegistrationDocumentFiles-v2026-08-17RequestUnauthorizedError" } } }, "description": "Unauthorized — missing or invalid authentication token." }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AddLegalEntityRegistrationDocumentFiles-v2026-08-17RequestForbiddenError" } } }, "description": "Forbidden — the token lacks access to this legal entity." }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AddLegalEntityRegistrationDocumentFiles-v2026-08-17RequestNotFoundError" } } }, "description": "Not found." }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AddLegalEntityRegistrationDocumentFiles-v2026-08-17RequestUnprocessableEntityError" } } }, "description": "Unprocessable entity — a file has an unsupported type or its content does not match its extension." }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContainer" } } }, "description": "Operation failed." } }, "security": [ { "deelToken": [] } ], "summary": "Add Files To Legal Entity Registration Document", "tags": [ "documents" ] }, "put": { "description": "Replaces the files on a legal entity document with newly uploaded ones, typically after the document was rejected. The previous submission is archived rather than deleted, so the review history is preserved, and a new submission id is returned. Use the add-files endpoint instead when attaching a missing page to a document that is still under review.\n\n **Token scopes**: `legal-entity:write`", "operationId": "documents_resubmitLegalEntityRegistrationDocument-v2026-08-17", "parameters": [ { "description": "Public UUID of the legal entity.", "in": "path", "name": "legal_entity_id", "required": true, "schema": { "format": "uuid", "type": "string" } }, { "description": "Public UUID of the document submission.", "in": "path", "name": "document_id", "required": true, "schema": { "format": "uuid", "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "properties": { "data": { "$ref": "#/components/schemas/LegalEntitiesLegalEntityIdRegistrationDocumentsDocumentIdPutRequestBodyContentApplicationJsonSchemaData" } }, "required": [ "data" ], "type": "object" } } } }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Documents_resubmitLegalEntityRegistrationDocument-v2026-08-17_Response_200" } } }, "description": "Document resubmitted successfully." }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResubmitLegalEntityRegistrationDocument-v2026-08-17RequestBadRequestError" } } }, "description": "Bad request — invalid or missing parameters." }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResubmitLegalEntityRegistrationDocument-v2026-08-17RequestUnauthorizedError" } } }, "description": "Unauthorized — missing or invalid authentication token." }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResubmitLegalEntityRegistrationDocument-v2026-08-17RequestForbiddenError" } } }, "description": "Forbidden — the token lacks access to this legal entity." }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResubmitLegalEntityRegistrationDocument-v2026-08-17RequestNotFoundError" } } }, "description": "Not found." }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResubmitLegalEntityRegistrationDocument-v2026-08-17RequestUnprocessableEntityError" } } }, "description": "Unprocessable entity — a file has an unsupported type or its content does not match its extension." }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContainer" } } }, "description": "Operation failed." } }, "security": [ { "deelToken": [] } ], "summary": "Update Legal Entity Registration Document Files", "tags": [ "documents" ] } }, "/legal-entities/{legal_entity_id}/registration-documents/{document_id}/files": { "delete": { "description": "Removes specific files from a submission while leaving the submission itself in place. Use this to drop a page that was uploaded by mistake without withdrawing the whole document. Removal is permanent — the files cannot be recovered. Removing every file leaves the submission with none attached, so delete the submission instead when that is the intent.\n\n **Token scopes**: `legal-entity:write`", "operationId": "documents_deleteLegalEntityRegistrationDocumentFiles-v2026-08-17", "parameters": [ { "description": "Public UUID of the legal entity.", "in": "path", "name": "legal_entity_id", "required": true, "schema": { "format": "uuid", "type": "string" } }, { "description": "Public UUID of the document submission.", "in": "path", "name": "document_id", "required": true, "schema": { "format": "uuid", "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "properties": { "data": { "$ref": "#/components/schemas/LegalEntitiesLegalEntityIdRegistrationDocumentsDocumentIdFilesDeleteRequestBodyContentApplicationJsonSchemaData" } }, "required": [ "data" ], "type": "object" } } } }, "responses": { "204": { "content": { "application/json": { "schema": { "properties": {}, "type": "object" } } }, "description": "Files deleted successfully." }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DeleteLegalEntityRegistrationDocumentFiles-v2026-08-17RequestBadRequestError" } } }, "description": "Bad request — invalid or missing parameters." }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DeleteLegalEntityRegistrationDocumentFiles-v2026-08-17RequestUnauthorizedError" } } }, "description": "Unauthorized — missing or invalid authentication token." }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DeleteLegalEntityRegistrationDocumentFiles-v2026-08-17RequestForbiddenError" } } }, "description": "Forbidden — the token lacks access to this legal entity." }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DeleteLegalEntityRegistrationDocumentFiles-v2026-08-17RequestNotFoundError" } } }, "description": "Not found." }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContainer" } } }, "description": "Operation failed." } }, "security": [ { "deelToken": [] } ], "summary": "Delete Legal Entity Registration Document Files", "tags": [ "documents" ] } }, "/legal-entities/{legal_entity_id}/registration-documents/{document_id}/files/{file_id}/download": { "get": { "description": "Issues a time-limited download URL for one file attached to a submission. Use this to retrieve a document already on file — for an audit, or to re-file it in your own system. The URL expires shortly after it is issued, so fetch it rather than storing it; request a new one when it lapses.\n\n **Token scopes**: `legal-entity:read`", "operationId": "documents_downloadLegalEntityRegistrationDocumentFile-v2026-08-17", "parameters": [ { "description": "Public UUID of the legal entity.", "in": "path", "name": "legal_entity_id", "required": true, "schema": { "format": "uuid", "type": "string" } }, { "description": "Public UUID of the document submission.", "in": "path", "name": "document_id", "required": true, "schema": { "format": "uuid", "type": "string" } }, { "description": "Public UUID of a file attached to the submission.", "in": "path", "name": "file_id", "required": true, "schema": { "format": "uuid", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Documents_downloadLegalEntityRegistrationDocumentFile-v2026-08-17_Response_200" } } }, "description": "Download URL issued successfully." }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DownloadLegalEntityRegistrationDocumentFile-v2026-08-17RequestBadRequestError" } } }, "description": "Bad request — invalid or missing parameters." }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DownloadLegalEntityRegistrationDocumentFile-v2026-08-17RequestUnauthorizedError" } } }, "description": "Unauthorized — missing or invalid authentication token." }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DownloadLegalEntityRegistrationDocumentFile-v2026-08-17RequestForbiddenError" } } }, "description": "Forbidden — the token lacks access to this legal entity." }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DownloadLegalEntityRegistrationDocumentFile-v2026-08-17RequestNotFoundError" } } }, "description": "Not found." }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContainer" } } }, "description": "Operation failed." } }, "security": [ { "deelToken": [] } ], "summary": "Download Legal Entity Registration Document File", "tags": [ "documents" ] } }, "/legal-entities/{legal_entity_id}/settings": { "post": { "description": "Controls whether employees under this legal entity can access the Deel employee app for self-service tasks such as viewing payslips and managing personal information. Use this endpoint after you have finished configuring a Global Payroll legal entity and its workforce and are ready to grant or revoke employee app access. Set value to \"true\" to allow employees to log in to the app, or \"false\" to block access — for example, during a compliance review or when offboarding a cohort.\n\n **Token scopes**: `legal-entity:write`", "operationId": "legalEntities_updateLegalEntitySetting-v2026-09-02", "parameters": [ { "description": "The ID of the legal entity.", "in": "path", "name": "legal_entity_id", "required": true, "schema": { "format": "uuid", "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "properties": { "data": { "$ref": "#/components/schemas/LegalEntitiesLegalEntityIdSettingsPostRequestBodyContentApplicationJsonSchemaData" } }, "required": [ "data" ], "type": "object" } } } }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Legal_Entities_updateLegalEntitySetting-v2026-09-02_Response_200" } } }, "description": "Successfully updated the setting." }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UpdateLegalEntitySetting-v2026-09-02RequestBadRequestError" } } }, "description": "Invalid request parameters." }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContainer" } } }, "description": "Operation failed." }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContainer" } } }, "description": "Operation failed." }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContainer" } } }, "description": "Operation failed." }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContainer" } } }, "description": "Operation failed." } }, "security": [ { "deelToken": [] } ], "summary": "Update GP employee app access for a legal entity", "tags": [ "legalEntities" ] } }, "/lookups": { "get": { "description": "Returns reference data of the type specified by the `documents` query parameter; supported values are `currencies`, `countries`, `entity_types`, and `sic`.\n\n **Token scopes**: `legal-entity:read`", "operationId": "lookups_getLookups-v2026-01-01", "parameters": [ { "description": "The type of lookup data to retrieve. Options are `currencies`, `countries`, `entity_types`, and `sic_numbers`.", "in": "query", "name": "documents", "required": true, "schema": { "$ref": "#/components/schemas/LookupsGetParametersDocuments" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Lookups_getLookups-v2026-01-01_Response_200" } } }, "description": "A list of lookup information based on the requested type." }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetLookups-v2026-01-01RequestBadRequestError" } } }, "description": "Invalid request parameters." }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContainer" } } }, "description": "Operation failed." }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContainer" } } }, "description": "Operation failed." }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContainer" } } }, "description": "Operation failed." }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContainer" } } }, "description": "Operation failed." } }, "security": [ { "deelToken": [] } ], "summary": "Retrieve lookup information for currencies, countries, entity types, etc", "tags": [ "Lookups" ] } }, "/lookups/countries": { "get": { "description": "Returns all countries supported by the platform, including each country's visa support status, Employer of Record availability, sub-territories, and classification.", "operationId": "lookups_getCountries", "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/lookups_getCountries_Response_200" } } }, "description": "Successful operation." }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContainer" } } }, "description": "Operation failed." }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContainer" } } }, "description": "Operation failed." }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContainer" } } }, "description": "Operation failed." }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContainer" } } }, "description": "Operation failed." }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContainer" } } }, "description": "Operation failed." } }, "security": [ { "deelToken": [] } ], "summary": "Retrieve Country List", "tags": [ "Lookups" ] } }, "/lookups/currencies": { "get": { "description": "Returns all currencies supported by the platform, including their ISO codes and names.", "operationId": "lookups_getCurrencies", "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/lookups_getCurrencies_Response_200" } } }, "description": "Successful operation." }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContainer" } } }, "description": "Operation failed." }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContainer" } } }, "description": "Operation failed." }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContainer" } } }, "description": "Operation failed." }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContainer" } } }, "description": "Operation failed." }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContainer" } } }, "description": "Operation failed." } }, "security": [ { "deelToken": [] } ], "summary": "Retrieve Supported Currency List", "tags": [ "Lookups" ] } }, "/lookups/job-titles": { "get": { "description": "Returns the platform's catalogue of predefined job titles. Results are paginated using cursor-based navigation via `after_cursor`.", "operationId": "lookups_getJobTitles", "parameters": [ { "description": "Cursor for pagination. Use this to retrieve the next page of results.", "in": "query", "name": "after_cursor", "required": false, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/lookups_getJobTitles_Response_200" } } }, "description": "Successful operation." }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContainer" } } }, "description": "Operation failed." }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContainer" } } }, "description": "Operation failed." }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContainer" } } }, "description": "Operation failed." }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContainer" } } }, "description": "Operation failed." }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContainer" } } }, "description": "Operation failed." } }, "security": [ { "deelToken": [] } ], "summary": "Job titles list", "tags": [ "Lookups" ] } }, "/lookups/seniorities": { "get": { "description": "Returns predefined seniority levels including their names, hierarchical positions, and identifiers. When `is_eor_contract` is `true`, C-level seniorities are excluded from the response.", "operationId": "lookups_getSeniorityLevels", "parameters": [ { "description": "when `true`, exclude C-level seniorities for EOR contracts. Set to `false` to return all seniorities", "in": "query", "name": "is_eor_contract", "required": false, "schema": { "default": true, "type": "boolean" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/lookups_getSeniorityLevels_Response_200" } } }, "description": "Successful operation." }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContainer" } } }, "description": "Operation failed." }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContainer" } } }, "description": "Operation failed." }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContainer" } } }, "description": "Operation failed." }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContainer" } } }, "description": "Operation failed." }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContainer" } } }, "description": "Operation failed." } }, "security": [ { "deelToken": [] } ], "summary": "Retrieve Seniority Levels", "tags": [ "Lookups" ] } }, "/lookups/time-off-types": { "get": { "description": "Returns the predefined time-off types available for registration on the platform.", "operationId": "lookups_getTimeOffTypes", "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/lookups_getTimeOffTypes_Response_200" } } }, "description": "Successful operation." }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContainer" } } }, "description": "Operation failed." }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContainer" } } }, "description": "Operation failed." }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContainer" } } }, "description": "Operation failed." }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RetrieveTimeOffTypes-v2026-01-01RequestNotFoundError" } } }, "description": "Resource not found." }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContainer" } } }, "description": "Operation failed." } }, "security": [ { "deelToken": [] } ], "summary": "Retrieve Time-Off Types", "tags": [ "Lookups" ] } }, "/magic-link": { "post": { "description": "Generates a time-limited magic link for password-free worker authentication. The link and its expiry timestamp are returned in the response.\n\n **Token scopes**: `worker:read`", "operationId": "magicLink_createMagicLink", "requestBody": { "content": { "application/json": { "schema": { "properties": { "data": { "$ref": "#/components/schemas/MagicLinkPostRequestBodyContentApplicationJsonSchemaData" } }, "type": "object" } } }, "description": "Details for magic link generation." }, "responses": { "201": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/magic-link_createMagicLink_Response_201" } } }, "description": "Magic link generated successfully" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContainer" } } }, "description": "Operation failed." }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreateMagicLink-v2026-01-01RequestUnauthorizedError" } } }, "description": "Unauthorized - Invalid or missing authentication token" }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContainer" } } }, "description": "Operation failed." }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContainer" } } }, "description": "Operation failed." }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreateMagicLink-v2026-01-01RequestInternalServerError" } } }, "description": "Internal Server Error" } }, "security": [ { "deelToken": [] } ], "summary": "Create magic link", "tags": [ "magicLink" ] } }, "/managers": { "get": { "description": "Returns a paginated list of all managers in the organization.\n\n **Token scopes**: `organizations:read`", "operationId": "managers_getManagers", "parameters": [ { "description": "The number of records to return in the response.", "in": "query", "name": "limit", "required": false, "schema": { "minimum": 1, "type": "integer" } }, { "description": "The offset or starting point for pagination.", "in": "query", "name": "offset", "required": false, "schema": { "minimum": 0, "type": "integer" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/managers_getManagers_Response_200" } } }, "description": "Successful operation." }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContainer" } } }, "description": "Operation failed." }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetManagers-v2026-01-01RequestUnauthorizedError" } } }, "description": "Unauthorized. The request is missing authentication credentials or the credentials provided are invalid." }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContainer" } } }, "description": "Operation failed." }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetManagers-v2026-01-01RequestNotFoundError" } } }, "description": "No managers found. There are no managers associated with the current organization." }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetManagers-v2026-01-01RequestInternalServerError" } } }, "description": "Internal server error. An error occurred on the server while processing the request." } }, "security": [ { "deelToken": [] } ], "summary": "Retrieve List of Managers", "tags": [ "managers" ] }, "post": { "description": "Creates a new manager in the organization and returns the created manager's identity fields, including the assigned `id`.\n\n **Token scopes**: `organizations:write`", "operationId": "managers_createManager", "requestBody": { "content": { "application/json": { "schema": { "properties": { "data": { "$ref": "#/components/schemas/ManagersPostRequestBodyContentApplicationJsonSchemaData" } }, "required": [ "data" ], "type": "object" } } }, "description": "Details of the new manager to be created." }, "responses": { "201": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/managers_createManager_Response_201" } } }, "description": "Manager created successfully." }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreateManager-v2026-01-01RequestBadRequestError" } } }, "description": "Invalid request. The input data did not meet the required validation rules." }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContainer" } } }, "description": "Operation failed." }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContainer" } } }, "description": "Operation failed." }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContainer" } } }, "description": "Operation failed." }, "409": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreateManager-v2026-01-01RequestConflictError" } } }, "description": "Conflict. A manager with the provided email already exists." }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContainer" } } }, "description": "Operation failed." } }, "security": [ { "deelToken": [] } ], "summary": "Create a Manager", "tags": [ "managers" ] } }, "/managers/magic-links": { "post": { "description": "Generates a single-use magic link that authenticates a manager into the platform without credentials. The target manager must belong to the requesting organization and cannot be an organization admin; this operation is restricted to White Label–enabled organizations, Partners, and Child organizations. The link expires 5 minutes after creation.\n\n **Token scopes**: `auth:write`", "operationId": "managers_generateMagicLinkForManagerLogin-v2026-01-01", "requestBody": { "content": { "application/json": { "schema": { "properties": { "data": { "$ref": "#/components/schemas/ManagersMagicLinksPostRequestBodyContentApplicationJsonSchemaData" } }, "required": [ "data" ], "type": "object" } } }, "description": "Details for magic link for managers generation." }, "responses": { "201": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Managers_generateMagicLinkForManagerLogin-v2026-01-01_Response_201" } } }, "description": "Magic link generated successfully" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContainer" } } }, "description": "Operation failed." }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GenerateMagicLinkForManagerLogin-v2026-01-01RequestUnauthorizedError" } } }, "description": "Unauthorized - Invalid or missing authentication token" }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GenerateMagicLinkForManagerLogin-v2026-01-01RequestForbiddenError" } } }, "description": "Forbidden - Not allowed to generate magic link for this manager" }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GenerateMagicLinkForManagerLogin-v2026-01-01RequestNotFoundError" } } }, "description": "Not Found - Manager does not exist or is not in organization" }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GenerateMagicLinkForManagerLogin-v2026-01-01RequestInternalServerError" } } }, "description": "Internal Server Error" } }, "security": [ { "deelToken": [] } ], "summary": "Generate magic link for manager login", "tags": [ "managers" ] } }, "/offboarding/tracker": { "get": { "description": "Returns a list of contracts currently in the offboarding process. By default, results are scoped to a 45-day date range; set `ignore_date_range` to `true` to retrieve all terminations regardless of date.\n\n **Token scopes**: `contracts:read`, `people:read`", "operationId": "offboarding_retrieveOffboardingList-v2026-01-01", "parameters": [ { "description": "Search term to filter contracts by name or other attributes", "in": "query", "name": "search", "required": false, "schema": { "type": "string" } }, { "description": "Filter by hiring type.", "in": "query", "name": "hiring_types", "required": false, "schema": { "default": [], "items": { "$ref": "#/components/schemas/OffboardingTrackerGetParametersHiringTypesSchemaItems" }, "type": "array" } }, { "description": "Filter by offboarding progress status.", "in": "query", "name": "progress_statuses", "required": false, "schema": { "default": [], "items": { "$ref": "#/components/schemas/OffboardingTrackerGetParametersProgressStatusesSchemaItems" }, "type": "array" } }, { "description": "Number of results to return per page (maximum 100; values above this are silently clamped to 100)", "in": "query", "name": "limit", "required": false, "schema": { "default": 20, "maximum": 100, "minimum": 1, "type": "integer" } }, { "description": "Field to sort by", "in": "query", "name": "sort_by", "required": false, "schema": { "$ref": "#/components/schemas/OffboardingTrackerGetParametersSortBy", "default": "progressStatusWeight" } }, { "description": "Sorting order", "in": "query", "name": "sort_order", "required": false, "schema": { "$ref": "#/components/schemas/OffboardingTrackerGetParametersSortOrder", "default": "ASC" } }, { "deprecated": true, "description": "Deprecated. Use `cursor` instead.", "in": "query", "name": "pagination", "required": false, "schema": { "$ref": "#/components/schemas/OffboardingTrackerGetParametersPagination" } }, { "description": "Opaque pagination cursor from the previous response's `page.cursor`. Pass it back verbatim to fetch the next page; omit it for the first page.", "in": "query", "name": "cursor", "required": false, "schema": { "maxLength": 2048, "type": "string" } }, { "description": "Include an overview of the contract", "in": "query", "name": "include_overview", "required": false, "schema": { "default": false, "type": "boolean" } }, { "description": "Ignore the default 45-day date range and retrieve all terminations", "in": "query", "name": "ignore_date_range", "required": false, "schema": { "default": false, "type": "boolean" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Offboarding_retrieveOffboardingList-v2026-01-01_Response_200" } } }, "description": "Successfully retrieved list of offboarding" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RetrieveOffboardingList-v2026-01-01RequestBadRequestError" } } }, "description": "Bad request — invalid or malformed query parameters." }, "401": { "content": { "application/json": { "schema": { "description": "Any type" } } }, "description": "Unauthorized — missing or invalid authentication token." }, "403": { "content": { "application/json": { "schema": { "description": "Any type" } } }, "description": "Forbidden — caller lacks permission to view offboarding data." }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContainer" } } }, "description": "Operation failed." }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContainer" } } }, "description": "Operation failed." } }, "security": [ { "deelToken": [] } ], "summary": "Retrieve offboarding list", "tags": [ "offboarding" ] } }, "/offboarding/tracker/hris_profile/{oid}": { "get": { "description": "Returns termination details for a contract identified by its HRIS profile `oid`.\n\n **Token scopes**: `contracts:read`, `people:read`", "operationId": "offboarding_retrieveTerminationDetailsByHrisProfileIdentifier-v2026-01-01", "parameters": [ { "description": "Unique hris profile oid", "in": "path", "name": "oid", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Offboarding_retrieveTerminationDetailsByHrisProfileIdentifier-v2026-01-01_Response_200" } } }, "description": "Successfully retrieved offboarding details" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContainer" } } }, "description": "Operation failed." }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContainer" } } }, "description": "Operation failed." }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContainer" } } }, "description": "Operation failed." }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContainer" } } }, "description": "Operation failed." }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContainer" } } }, "description": "Operation failed." } }, "security": [ { "deelToken": [] } ], "summary": "Retrieve termination details by HRIS profile identifier", "tags": [ "offboarding" ] } }, "/offboarding/tracker/{id}": { "get": { "description": "Returns termination details for a contract identified by its offboarding tracker `id`.\n\n **Token scopes**: `contracts:read`, `people:read`", "operationId": "offboarding_retrieveTerminationDetails-v2026-01-01", "parameters": [ { "description": "Unique onboarding tracker identifier", "in": "path", "name": "id", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Offboarding_retrieveTerminationDetails-v2026-01-01_Response_200" } } }, "description": "Successfully retrieved offboarding details" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContainer" } } }, "description": "Operation failed." }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContainer" } } }, "description": "Operation failed." }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContainer" } } }, "description": "Operation failed." }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContainer" } } }, "description": "Operation failed." }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RetrieveTerminationDetails-v2026-01-01RequestInternalServerError" } } }, "description": "Operation failed." } }, "security": [ { "deelToken": [] } ], "summary": "Retrieve termination details", "tags": [ "offboarding" ] } }, "/on-demand-payroll/contract/{contract_id}": { "post": { "description": "Creates an On-Demand Payroll for the given contract from existing eligible entries and/or a salary advance amount.\n\n **Token scopes**: `on-demand-payroll:write`", "operationId": "onDemandPayroll_createOnDemandPayroll-v2026-07-28", "parameters": [ { "description": "Public ID (oid) of the contract.", "in": "path", "name": "contract_id", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "properties": { "data": { "$ref": "#/components/schemas/OnDemandPayrollContractContractIdPostRequestBodyContentApplicationJsonSchemaData" } }, "required": [ "data" ], "type": "object" } } }, "description": "Entries and/or salary advance to include in the new On-Demand Payroll." }, "responses": { "201": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/On-Demand_Payroll_createOnDemandPayroll-v2026-07-28_Response_201" } } }, "description": "The created On-Demand Payroll." }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreateOnDemandPayroll-v2026-07-28RequestBadRequestError" } } }, "description": "Invalid request." }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreateOnDemandPayroll-v2026-07-28RequestUnauthorizedError" } } }, "description": "Authentication is required or has failed." }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreateOnDemandPayroll-v2026-07-28RequestForbiddenError" } } }, "description": "The caller is not allowed to perform this action." }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContainer" } } }, "description": "Operation failed." }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContainer" } } }, "description": "Operation failed." } }, "security": [ { "deelToken": [] } ], "summary": "Create On-Demand Payroll", "tags": [ "onDemandPayroll" ] } }, "/on-demand-payroll/contract/{contract_id}/current": { "get": { "description": "Retrieves the active On-Demand Payroll for the given contract, including its status, SLAs, invoice and attached entries.\n\n **Token scopes**: `on-demand-payroll:read`", "operationId": "onDemandPayroll_retrieveCurrentOnDemandPayroll-v2026-07-16", "parameters": [ { "description": "Public ID (oid) of the contract.", "in": "path", "name": "contract_id", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/On-Demand_Payroll_retrieveCurrentOnDemandPayroll-v2026-07-16_Response_200" } } }, "description": "The active On-Demand Payroll for the contract." }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RetrieveCurrentOnDemandPayroll-v2026-07-16RequestBadRequestError" } } }, "description": "Invalid request." }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RetrieveCurrentOnDemandPayroll-v2026-07-16RequestUnauthorizedError" } } }, "description": "Authentication is required or has failed." }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RetrieveCurrentOnDemandPayroll-v2026-07-16RequestForbiddenError" } } }, "description": "The caller is not allowed to perform this action." }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RetrieveCurrentOnDemandPayroll-v2026-07-16RequestNotFoundError" } } }, "description": "No active On-Demand Payroll for the contract." }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContainer" } } }, "description": "Operation failed." } }, "security": [ { "deelToken": [] } ], "summary": "Retrieve current On-Demand Payroll", "tags": [ "onDemandPayroll" ] } }, "/on-demand-payroll/contract/{contract_id}/entries": { "get": { "description": "Use this endpoint to discover which adjustments are currently eligible for On-Demand Payroll on a contract, together with the contract's eligibility details and limits. Call it before creating an On-Demand Payroll or attaching entries to an existing one: the returned entry IDs are the values you pass as existing_entry_ids.\n\n **Token scopes**: `on-demand-payroll:read`", "operationId": "onDemandPayroll_listOnDemandPayrollEntries-v2026-07-16", "parameters": [ { "description": "Public ID (oid) of the contract.", "in": "path", "name": "contract_id", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/On-Demand_Payroll_listOnDemandPayrollEntries-v2026-07-16_Response_200" } } }, "description": "Eligible entries grouped by contract." }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ListOnDemandPayrollEntries-v2026-07-16RequestBadRequestError" } } }, "description": "Invalid request." }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ListOnDemandPayrollEntries-v2026-07-16RequestUnauthorizedError" } } }, "description": "Authentication is required or has failed." }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ListOnDemandPayrollEntries-v2026-07-16RequestForbiddenError" } } }, "description": "The caller is not allowed to perform this action." }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContainer" } } }, "description": "Operation failed." }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContainer" } } }, "description": "Operation failed." } }, "security": [ { "deelToken": [] } ], "summary": "List On-Demand Payroll entries", "tags": [ "onDemandPayroll" ] } }, "/on-demand-payroll/{odp_id}/cancel": { "post": { "description": "Cancels an On-Demand Payroll, optionally keeping the specified entries available for a future regular payroll cycle.\n\n **Token scopes**: `on-demand-payroll:write`", "operationId": "onDemandPayroll_cancelOnDemandPayroll-v2026-07-31", "parameters": [ { "description": "Public ID of the On-Demand Payroll.", "in": "path", "name": "odp_id", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "properties": { "data": { "$ref": "#/components/schemas/OnDemandPayrollOdpIdCancelPostRequestBodyContentApplicationJsonSchemaData" } }, "type": "object" } } }, "description": "Optionally, the entries to keep when cancelling the ODP." }, "responses": { "204": { "content": { "application/json": { "schema": { "properties": {}, "type": "object" } } }, "description": "On-Demand Payroll cancelled successfully." }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CancelOnDemandPayroll-v2026-07-31RequestBadRequestError" } } }, "description": "Invalid request." }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CancelOnDemandPayroll-v2026-07-31RequestUnauthorizedError" } } }, "description": "Authentication is required or has failed." }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CancelOnDemandPayroll-v2026-07-31RequestForbiddenError" } } }, "description": "The caller is not allowed to perform this action." }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CancelOnDemandPayroll-v2026-07-31RequestNotFoundError" } } }, "description": "On-Demand Payroll not found." }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContainer" } } }, "description": "Operation failed." } }, "security": [ { "deelToken": [] } ], "summary": "Cancel On-Demand Payroll", "tags": [ "onDemandPayroll" ] } }, "/on-demand-payroll/{odp_id}/entries/attach": { "patch": { "description": "Attaches existing eligible entries to an On-Demand Payroll that is awaiting client review before submission.\n\n **Token scopes**: `on-demand-payroll:write`", "operationId": "onDemandPayroll_attachOnDemandPayrollEntries-v2026-07-31", "parameters": [ { "description": "Public ID of the On-Demand Payroll.", "in": "path", "name": "odp_id", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "properties": { "data": { "$ref": "#/components/schemas/OnDemandPayrollOdpIdEntriesAttachPatchRequestBodyContentApplicationJsonSchemaData" } }, "required": [ "data" ], "type": "object" } } }, "description": "Existing entries to attach to the On-Demand Payroll." }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/On-Demand_Payroll_attachOnDemandPayrollEntries-v2026-07-31_Response_200" } } }, "description": "The updated On-Demand Payroll." }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AttachOnDemandPayrollEntries-v2026-07-31RequestBadRequestError" } } }, "description": "Invalid request." }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AttachOnDemandPayrollEntries-v2026-07-31RequestUnauthorizedError" } } }, "description": "Authentication is required or has failed." }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AttachOnDemandPayrollEntries-v2026-07-31RequestForbiddenError" } } }, "description": "The caller is not allowed to perform this action." }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AttachOnDemandPayrollEntries-v2026-07-31RequestNotFoundError" } } }, "description": "On-Demand Payroll not found." }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContainer" } } }, "description": "Operation failed." } }, "security": [ { "deelToken": [] } ], "summary": "Attach entries to On-Demand Payroll", "tags": [ "onDemandPayroll" ] } }, "/on-demand-payroll/{odp_id}/entries/detach": { "patch": { "description": "Detaches entries from an On-Demand Payroll, keeping or removing the specified entries before the ODP is submitted.\n\n **Token scopes**: `on-demand-payroll:write`", "operationId": "onDemandPayroll_detachOnDemandPayrollEntries-v2026-07-31", "parameters": [ { "description": "Public ID of the On-Demand Payroll.", "in": "path", "name": "odp_id", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "properties": { "data": { "$ref": "#/components/schemas/OnDemandPayrollOdpIdEntriesDetachPatchRequestBodyContentApplicationJsonSchemaData" } }, "required": [ "data" ], "type": "object" } } }, "description": "Entries to keep and/or to delete from the On-Demand Payroll." }, "responses": { "204": { "content": { "application/json": { "schema": { "properties": {}, "type": "object" } } }, "description": "Entries detached successfully." }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DetachOnDemandPayrollEntries-v2026-07-31RequestBadRequestError" } } }, "description": "Invalid request." }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DetachOnDemandPayrollEntries-v2026-07-31RequestUnauthorizedError" } } }, "description": "Authentication is required or has failed." }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DetachOnDemandPayrollEntries-v2026-07-31RequestForbiddenError" } } }, "description": "The caller is not allowed to perform this action." }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DetachOnDemandPayrollEntries-v2026-07-31RequestNotFoundError" } } }, "description": "On-Demand Payroll not found." }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContainer" } } }, "description": "Operation failed." } }, "security": [ { "deelToken": [] } ], "summary": "Detach entries from On-Demand Payroll", "tags": [ "onDemandPayroll" ] } }, "/on-demand-payroll/{odp_id}/submit": { "post": { "description": "Submits an On-Demand Payroll for Deel processing after the client has reviewed and approved all of its entries.\n\n **Token scopes**: `on-demand-payroll:write`", "operationId": "onDemandPayroll_submitOnDemandPayroll-v2026-07-17", "parameters": [ { "description": "Public ID of the On-Demand Payroll.", "in": "path", "name": "odp_id", "required": true, "schema": { "type": "string" } } ], "responses": { "204": { "content": { "application/json": { "schema": { "properties": {}, "type": "object" } } }, "description": "On-Demand Payroll submitted successfully." }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SubmitOnDemandPayroll-v2026-07-17RequestBadRequestError" } } }, "description": "Invalid request." }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SubmitOnDemandPayroll-v2026-07-17RequestUnauthorizedError" } } }, "description": "Authentication is required or has failed." }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SubmitOnDemandPayroll-v2026-07-17RequestForbiddenError" } } }, "description": "The caller is not allowed to perform this action." }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SubmitOnDemandPayroll-v2026-07-17RequestNotFoundError" } } }, "description": "On-Demand Payroll not found." }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContainer" } } }, "description": "Operation failed." } }, "security": [ { "deelToken": [] } ], "summary": "Submit On-Demand Payroll", "tags": [ "onDemandPayroll" ] } }, "/onboarding/tracker": { "get": { "description": "Use this endpoint to monitor workers as they progress through onboarding and identify onboarding records that require follow-up.\n\n **Token scopes**: `contracts:read`, `people:read`", "operationId": "onboarding_listOnboardingEmployees-v2026-01-01", "parameters": [ { "description": "Search term to filter contracts by name or other attributes", "in": "query", "name": "search", "required": false, "schema": { "maxLength": 255, "type": "string" } }, { "description": "Search attribute to filter onboarding list by contract id", "in": "query", "name": "contractOid", "required": false, "schema": { "default": [], "items": { "type": "string" }, "type": "array" } }, { "description": "Search attribute to filter onboarding list by hiring type", "in": "query", "name": "hiringTypes", "required": false, "schema": { "default": [], "items": { "$ref": "#/components/schemas/OnboardingTrackerGetParametersHiringTypesSchemaItems" }, "type": "array" } }, { "description": "Search attribute to filter onboarding list by progress status", "in": "query", "name": "progressStatuses", "required": false, "schema": { "default": [], "items": { "$ref": "#/components/schemas/OnboardingTrackerGetParametersProgressStatusesSchemaItems" }, "type": "array" } }, { "description": "Filter by contract country. Uses ISO 3166-1 alpha-2 codes.", "in": "query", "name": "countries", "required": false, "schema": { "default": [], "items": { "type": "string" }, "type": "array" } }, { "description": "Search attribute to filter onboarding list by team", "in": "query", "name": "teams", "required": false, "schema": { "default": [], "items": { "type": "string" }, "type": "array" } }, { "description": "Search attribute to filter onboarding list by legal entity", "in": "query", "name": "legalEntities", "required": false, "schema": { "default": [], "items": { "type": "string" }, "type": "array" } }, { "description": "Search attribute to filter onboarding list by HRIS direct manager. Expects the manager's HRIS profile ID, as returned by `GET /people` in `employments[].team.direct_manager_id` — not a worker or contract ID.", "in": "query", "name": "hrisDirectManagers", "required": false, "schema": { "default": [], "items": { "format": "uuid", "type": "string" }, "type": "array" } }, { "description": "Start date for filtering contracts", "in": "query", "name": "fromDate", "required": false, "schema": { "format": "date-time", "type": "string" } }, { "description": "End date for filtering contracts", "in": "query", "name": "toDate", "required": false, "schema": { "format": "date-time", "type": "string" } }, { "description": "Filter by whether the onboarding is waiting on an action from the client", "in": "query", "name": "actions", "required": false, "schema": { "default": [], "items": { "$ref": "#/components/schemas/OnboardingTrackerGetParametersActionsSchemaItems" }, "type": "array" } }, { "description": "Filter by lifecycle status, the same value each item returns in `progress.lifecycle_status`", "in": "query", "name": "lifecycleStatuses", "required": false, "schema": { "default": [], "items": { "$ref": "#/components/schemas/OnboardingTrackerGetParametersLifecycleStatusesSchemaItems" }, "type": "array" } }, { "description": "Filter by the party the onboarding is waiting on, the same value each item returns in `progress.waiting_on`", "in": "query", "name": "waitingOnParties", "required": false, "schema": { "default": [], "items": { "$ref": "#/components/schemas/OnboardingTrackerGetParametersWaitingOnPartiesSchemaItems" }, "type": "array" } }, { "description": "Narrow the list to the workers one filter card counts. `STARTING_THIS_WEEK` also needs `weekFromDate` and `weekToDate`.", "in": "query", "name": "card", "required": false, "schema": { "$ref": "#/components/schemas/OnboardingTrackerGetParametersCard" } }, { "description": "First day of the week the `STARTING_THIS_WEEK` card counts, in the caller's timezone", "in": "query", "name": "weekFromDate", "required": false, "schema": { "format": "date", "type": "string" } }, { "description": "Last day of the week the `STARTING_THIS_WEEK` card counts, in the caller's timezone. On or after `weekFromDate`", "in": "query", "name": "weekToDate", "required": false, "schema": { "format": "date", "type": "string" } }, { "description": "Number of results to return per page. Ignored when `cursor` is supplied — a cursor already carries the page size and filters of the request that produced it.", "in": "query", "name": "limit", "required": false, "schema": { "default": 20, "maximum": 200, "minimum": 1, "type": "integer" } }, { "description": "Field to sort by", "in": "query", "name": "sort_by", "required": false, "schema": { "$ref": "#/components/schemas/OnboardingTrackerGetParametersSortBy", "default": "progressStatusWeight" } }, { "description": "Sorting order", "in": "query", "name": "sort_order", "required": false, "schema": { "$ref": "#/components/schemas/OnboardingTrackerGetParametersSortOrder", "default": "ASC" } }, { "description": "Cursor for pagination, taken from `page.cursor` of the previous response. It replaces the other query parameters, which are carried over from the request that produced it.", "in": "query", "name": "cursor", "required": false, "schema": { "type": "string" } }, { "description": "Include an overview of the contract", "in": "query", "name": "include_overview", "required": false, "schema": { "default": false, "type": "boolean" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Onboarding_listOnboardingEmployees-v2026-01-01_Response_200" } } }, "description": "A list of onboarding and their details" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ListOnboardingEmployees-v2026-01-01RequestBadRequestError" } } }, "description": "Bad Request. A query parameter outside its declared values, format or length returns `errors` as a list, one item per failing parameter. A combination of parameters the endpoint rejects, such as `card=STARTING_THIS_WEEK` without `weekFromDate`, returns `errors.errors`. A cursor that cannot be read returns `errors` as a list" }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContainer" } } }, "description": "Operation failed." }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContainer" } } }, "description": "Operation failed." }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContainer" } } }, "description": "Operation failed." }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContainer" } } }, "description": "Operation failed." } }, "security": [ { "deelToken": [] } ], "summary": "List onboarding employees", "tags": [ "onboarding" ] } }, "/onboarding/tracker/hris_profile/{hris_profile_id}": { "get": { "description": "Use this endpoint to see where one worker is in onboarding and what is needed next, when you hold their HRIS profile ID, for example from `GET /people` or `hris_profile.oid` on the onboarding tracker list. It covers the worker's main contract and lists their other contracts.\n\n **Token scopes**: `contracts:read`, `people:read`", "operationId": "onboarding_getOnboardingDetailsByEmployeeHrisProfileId-v2026-01-01", "parameters": [ { "description": "The unique identifier of the employee HRIS profile.", "in": "path", "name": "hris_profile_id", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Onboarding_getOnboardingDetailsByEmployeeHrisProfileId-v2026-01-01_Response_200" } } }, "description": "Onboarding overview" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetOnboardingDetailsByEmployeeHrisProfileId-v2026-01-01RequestBadRequestError" } } }, "description": "Bad Request. The HRIS profile ID is not a valid HRIS profile ID, returned as `errors.errors`" }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContainer" } } }, "description": "Operation failed." }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContainer" } } }, "description": "Operation failed." }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetOnboardingDetailsByEmployeeHrisProfileId-v2026-01-01RequestNotFoundError" } } }, "description": "Not Found - No onboarding exists for the provided HRIS profile ID" }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContainer" } } }, "description": "Operation failed." } }, "security": [ { "deelToken": [] } ], "summary": "Get onboarding details by employee HRIS profile ID", "tags": [ "onboarding" ] } }, "/onboarding/tracker/{tracker_id}": { "get": { "description": "Use this endpoint to see where one worker is in onboarding and what is needed next, when you hold their tracker ID, the `unique_id` of a row on the onboarding tracker list. It covers the contract that row is about and lists the worker's other contracts.\n\n **Token scopes**: `contracts:read`, `people:read`", "operationId": "onboarding_getOnboardingDetailsByOnboardingTrackerId-v2026-01-01", "parameters": [ { "description": "The unique identifier of the onboarding tracker.", "in": "path", "name": "tracker_id", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Onboarding_getOnboardingDetailsByOnboardingTrackerId-v2026-01-01_Response_200" } } }, "description": "Onboarding overview" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetOnboardingDetailsByOnboardingTrackerId-v2026-01-01RequestBadRequestError" } } }, "description": "Bad Request. The tracker ID cannot be read, returned as `errors.errors`" }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContainer" } } }, "description": "Operation failed." }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContainer" } } }, "description": "Operation failed." }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetOnboardingDetailsByOnboardingTrackerId-v2026-01-01RequestNotFoundError" } } }, "description": "Not Found - No onboarding exists for the provided onboarding tracker ID" }, "412": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetOnboardingDetailsByOnboardingTrackerId-v2026-01-01RequestPreconditionFailedError" } } }, "description": "Precondition Failed. The tracker ID can be read but is not one the tracker returns" }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContainer" } } }, "description": "Operation failed." } }, "security": [ { "deelToken": [] } ], "summary": "Get onboarding details by onboarding tracker ID", "tags": [ "onboarding" ] } }, "/onboarding/workers/individual": { "post": { "description": "Complete the profile setup for independent contractors including address, tax details, and legal status in a single call during the IC-embedded onboarding flow. This operation requires a worker session token obtained via the worker session endpoint.\n\n **Token scopes**: `worker:write`", "operationId": "workers_completeIndividualContractorProfileSetup-v2026-01-01", "requestBody": { "content": { "application/json": { "schema": { "properties": { "data": { "$ref": "#/components/schemas/OnboardingWorkersIndividualPostRequestBodyContentApplicationJsonSchemaData" } }, "required": [ "data" ], "type": "object" } } }, "description": "Individual contractor setup details including address, tax information, and legal status." }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Workers_completeIndividualContractorProfileSetup-v2026-01-01_Response_200" } } }, "description": "Individual profile setup completed successfully." }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CompleteIndividualContractorProfileSetup-v2026-01-01RequestBadRequestError" } } }, "description": "Operation failed." }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContainer" } } }, "description": "Operation failed." }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContainer" } } }, "description": "Operation failed." }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContainer" } } }, "description": "Operation failed." }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CompleteIndividualContractorProfileSetup-v2026-01-01RequestInternalServerError" } } }, "description": "Operation failed." } }, "security": [ { "deelToken": [] } ], "summary": "Complete individual contractor profile setup", "tags": [ "workers" ] } }, "/organizations": { "get": { "description": "Returns details of the organization associated with the authentication token; the organization is resolved automatically from the token and requires no additional identifier.\n\n **Token scopes**: `organizations:read`", "operationId": "organizations_getOrganizations", "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/organizations_getOrganizations_Response_200" } } }, "description": "Successful retrieval of the organization details." }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContainer" } } }, "description": "Operation failed." }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetOrganizations-v2026-01-01RequestUnauthorizedError" } } }, "description": "Unauthorized. The request is missing authentication credentials or the credentials provided are invalid." }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContainer" } } }, "description": "Operation failed." }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetOrganizations-v2026-01-01RequestNotFoundError" } } }, "description": "Organization not found. The current organization associated with the authentication token could not be found." }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetOrganizations-v2026-01-01RequestInternalServerError" } } }, "description": "Internal server error. An error occurred on the server while processing the request." } }, "security": [ { "deelToken": [] } ], "summary": "Get Current Organization", "tags": [ "organizations" ] } }, "/organizations/children": { "post": { "description": "Creates a child organization under the authenticated parent organization. Use it to provision child organizations from your own systems instead of the Partner Portal create form. The `token` field in the response holds the child organization's API token. It is returned only once and cannot be retrieved later, so store it on receipt.\n\n **Token scopes**: `organizations:write`", "operationId": "organizations_createOrganizationChild", "requestBody": { "content": { "application/json": { "schema": { "properties": { "data": { "$ref": "#/components/schemas/OrganizationsChildrenPostRequestBodyContentApplicationJsonSchemaData", "description": "The request payload." } }, "required": [ "data" ], "type": "object" } } } }, "responses": { "201": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/organizations_createOrganizationChild_Response_201" } } }, "description": "Operation successful. The child organization was created successfully." }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreateChildOrganization-v2026-01-01RequestBadRequestError" } } }, "description": "Bad request. The request body failed validation, admin_email or a parent_admin_emails entry is not an admin of the parent organization, parent_admin_emails or child_admins is sent while multiple admins are not enabled for the parent organization, or the parent organization cannot create child organizations. When the API gateway rejects the request body before it reaches Deel, each error item carries a path field instead of code, and the body also carries a request object that describes the failed call." }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContainer" } } }, "description": "Operation failed." }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContainer" } } }, "description": "Operation failed." }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContainer" } } }, "description": "Operation failed." }, "409": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreateChildOrganization-v2026-01-01RequestConflictError" } } }, "description": "Conflict - an organization with this name is currently being created." }, "429": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreateChildOrganization-v2026-01-01RequestTooManyRequestsError" } } }, "description": "Too Many Requests - retry limit exceeded for creating this organization." }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreateChildOrganization-v2026-01-01RequestInternalServerError" } } }, "description": "Operation failed." } }, "security": [ { "deelToken": [] } ], "summary": "Create child organization", "tags": [ "organizations" ] } }, "/organizations/children/admins": { "post": { "description": "Add multiple admins to child organizations in one call (e.g., when a new team member joins). Provide the admins and target child organizations: people who are not members yet are invited by email, and existing members are made admins. People who are already admins are left unchanged and get no new invitation. The response shows results for each admin-organization pair.\n\n **Token scopes**: `organizations:write`\n\n **Beta**: this version requires the `X-Beta: true` request header and its contract may change before it is promoted to stable. It is scheduled to become stable on 2027-01-12.", "operationId": "organizations_addChildOrganizationAdmins-v2026-10-12", "parameters": [ { "description": "Opts in to the beta version of this endpoint. Must be `true`.", "in": "header", "name": "X-Beta", "required": true, "schema": { "$ref": "#/components/schemas/OrganizationsChildrenAdminsPostParametersXBeta" } } ], "requestBody": { "content": { "application/json": { "schema": { "properties": { "data": { "$ref": "#/components/schemas/OrganizationsChildrenAdminsPostRequestBodyContentApplicationJsonSchemaData", "description": "The request payload." } }, "required": [ "data" ], "type": "object" } } }, "description": "The people to add as admins and the child organizations to add them to." }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Organizations_addChildOrganizationAdmins-v2026-10-12_Response_200" } } }, "description": "The outcome for every admin and child organization pair." }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AddChildOrganizationAdmins-v2026-10-12RequestBadRequestError" } } }, "description": "Bad request. Nothing is written. Codes: VALIDATION_ERROR (the request body failed validation, for example a malformed email, an email or child organization id listed twice, or an empty list; the error item also carries a details object naming the offending key), GENERIC_ERROR (the number of admins multiplied by the number of child organizations is above 100). The API gateway rejects a schema-invalid request body before it reaches Deel; each error item of that response carries a path field and no code." }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AddChildOrganizationAdmins-v2026-10-12RequestUnauthorizedError" } } }, "description": "Unauthorized. The request token is missing or invalid. The API gateway rejects an unauthenticated call before it reaches Deel; a call that reaches Deel without a valid session is rejected by the access middleware, whose error item carries a message and no code." }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AddChildOrganizationAdmins-v2026-10-12RequestForbiddenError" } } }, "description": "Forbidden. The caller lacks the permission to manage child organizations, or at least one submitted id is not a direct child organization of the authenticated organization. The message lists every rejected id. Nothing is written." }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContainer" } } }, "description": "Operation failed." }, "429": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AddChildOrganizationAdmins-v2026-10-12RequestTooManyRequestsError" } } }, "description": "Too many requests. Each partner organization can call this endpoint at most 20 times per hour, with up to 100 admin and child organization pairs per call. Nothing is written; retry once the hour has passed." }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AddChildOrganizationAdmins-v2026-10-12RequestInternalServerError" } } }, "description": "An unexpected error occurred before any admin and child organization pair was processed. Nothing is written, and the same request can be retried." } }, "security": [ { "deelToken": [] } ], "summary": "Add admins to child organizations", "tags": [ "organizations" ] } }, "/organizations/children/{child_organization_id}/session": { "post": { "description": "Issues a short-lived session token (valid 6 hours) for a child organisation. If an active session token with more than one hour of remaining validity already exists, that token is returned. Otherwise the prior session token is invalidated and a new 6-hour token is issued. Session tokens do not affect the child organisation’s original permanent token.\n\n **Token scopes**: `organizations:write`", "operationId": "organizations_createChildOrgSessionToken-v2026-07-14", "parameters": [ { "description": "The public UUID of the child organisation for which to issue a session token.", "in": "path", "name": "child_organization_id", "required": true, "schema": { "format": "uuid", "type": "string" } } ], "responses": { "201": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Organizations_createChildOrgSessionToken-v2026-07-14_Response_201" } } }, "description": "Session token issued successfully." }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreateChildOrgSessionToken-v2026-07-14RequestBadRequestError" } } }, "description": "Bad Request. The request was malformed or failed validation." }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreateChildOrgSessionToken-v2026-07-14RequestUnauthorizedError" } } }, "description": "Unauthorized. Authentication credentials were missing or invalid." }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreateChildOrgSessionToken-v2026-07-14RequestForbiddenError" } } }, "description": "Forbidden. The caller does not have the required scope or permission to access this resource." }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreateChildOrgSessionToken-v2026-07-14RequestNotFoundError" } } }, "description": "Not Found. The child organisation does not exist or is missing a service account." }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContainer" } } }, "description": "Operation failed." } }, "security": [ { "deelToken": [] } ], "summary": "Create a session token for a child organization", "tags": [ "organizations" ] } }, "/organizations/deal-registrations": { "post": { "description": "Registers a prospective end client against the authenticated partner organization. An approved registration protects the partner claim on that client for a fixed period. It stops Deel and other partners from pursuing the same account.\n\n **Token scopes**: `organizations:write`\n\n **Beta**: this version requires the `X-Beta: true` request header and its contract may change before it is promoted to stable. It is scheduled to become stable on 2026-12-30.", "operationId": "organizations_createDealRegistration-v2026-09-30", "parameters": [ { "description": "Opts in to the beta version of this endpoint. Must be `true`.", "in": "header", "name": "X-Beta", "required": true, "schema": { "$ref": "#/components/schemas/OrganizationsDealRegistrationsPostParametersXBeta" } } ], "requestBody": { "content": { "application/json": { "schema": { "properties": { "data": { "$ref": "#/components/schemas/OrganizationsDealRegistrationsPostRequestBodyContentApplicationJsonSchemaData", "description": "The request payload." } }, "required": [ "data" ], "type": "object" } } }, "description": "The end client the partner wants to register." }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Organizations_createDealRegistration-v2026-09-30_Response_200" } } }, "description": "The deal registration outcome." }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreateDealRegistration-v2026-09-30RequestBadRequestError" } } }, "description": "Bad request. Codes: VALIDATION_ERROR (the request body failed validation; the error item also carries a details object naming the offending key), GENERIC_ERROR (the submitted domain could not be normalised, or the authenticated organization is not set up for deal registration). The API gateway rejects a schema-invalid request body before it reaches Deel; each error item of that response carries a path field and no code, and the body also carries a request object that describes the failed call." }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreateDealRegistration-v2026-09-30RequestUnauthorizedError" } } }, "description": "Unauthorized. The request token is missing or invalid. The API gateway rejects an unauthenticated call before it reaches Deel; a call that reaches Deel without a valid session is rejected by the access middleware, whose error item carries a message and no code." }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreateDealRegistration-v2026-09-30RequestForbiddenError" } } }, "description": "Deal registration is not enabled for the authenticated organization, or the caller lacks the required permission." }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContainer" } } }, "description": "Operation failed." }, "429": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreateDealRegistration-v2026-09-30RequestTooManyRequestsError" } } }, "description": "The caller exceeded the deal registration rate limit for its organization." }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreateDealRegistration-v2026-09-30RequestInternalServerError" } } }, "description": "An unexpected error occurred. The outcome is not confirmed. Retry the same payload — retries are idempotent." } }, "security": [ { "deelToken": [] } ], "summary": "Create a deal registration", "tags": [ "organizations" ] } }, "/organizations/secure-vault/files": { "post": { "description": "Uploads one or more files to the Organization Secure Vault root. Files are stored in the organization's \"Other Files\" folder. To upload into a specific folder, use the folder-scoped upload endpoint instead. Upload the file contents to the File Service first, then reference each file here by its `file_id` and `one_time_secret`.\n\n **Token scopes**: `organizations:write`", "operationId": "documents_uploadOrganizationSecureVaultFiles-v2026-08-05", "requestBody": { "content": { "application/json": { "schema": { "properties": { "data": { "$ref": "#/components/schemas/OrganizationsSecureVaultFilesPostRequestBodyContentApplicationJsonSchemaData", "description": "The files to attach to the Organization Secure Vault." } }, "required": [ "data" ], "type": "object" } } } }, "responses": { "201": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Documents_uploadOrganizationSecureVaultFiles-v2026-08-05_Response_201" } } }, "description": "Files uploaded successfully." }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UploadOrganizationSecureVaultFiles-v2026-08-05RequestBadRequestError" } } }, "description": "Bad request — invalid or missing parameters." }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UploadOrganizationSecureVaultFiles-v2026-08-05RequestUnauthorizedError" } } }, "description": "Unauthorized — missing or invalid authentication token." }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UploadOrganizationSecureVaultFiles-v2026-08-05RequestForbiddenError" } } }, "description": "Forbidden — the token lacks access to this resource." }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UploadOrganizationSecureVaultFiles-v2026-08-05RequestNotFoundError" } } }, "description": "Not found." }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UploadOrganizationSecureVaultFiles-v2026-08-05RequestUnprocessableEntityError" } } }, "description": "Unprocessable entity — a file has an unsupported type or its content does not match its extension." }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContainer" } } }, "description": "Operation failed." } }, "security": [ { "deelToken": [] } ], "summary": "Upload Organization Secure Vault Files", "tags": [ "documents" ] } }, "/organizations/secure-vault/files/{file_id}": { "delete": { "description": "Deletes a single file from the Organization Secure Vault, such as an obsolete draft or duplicate that is no longer needed. This action is permanent and the file cannot be recovered.\n\n **Token scopes**: `organizations:write`", "operationId": "documents_deleteOrganizationSecureVaultFile-v2026-08-05", "parameters": [ { "description": "Public UUID of the Organization Secure Vault file.", "in": "path", "name": "file_id", "required": true, "schema": { "format": "uuid", "type": "string" } } ], "responses": { "204": { "content": { "application/json": { "schema": { "properties": {}, "type": "object" } } }, "description": "File deleted successfully." }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DeleteOrganizationSecureVaultFile-v2026-08-05RequestBadRequestError" } } }, "description": "Bad request — invalid or missing parameters." }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DeleteOrganizationSecureVaultFile-v2026-08-05RequestUnauthorizedError" } } }, "description": "Unauthorized — missing or invalid authentication token." }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DeleteOrganizationSecureVaultFile-v2026-08-05RequestForbiddenError" } } }, "description": "Forbidden — the token lacks access to this resource." }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DeleteOrganizationSecureVaultFile-v2026-08-05RequestNotFoundError" } } }, "description": "Not found." }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContainer" } } }, "description": "Operation failed." } }, "security": [ { "deelToken": [] } ], "summary": "Delete Organization Secure Vault File", "tags": [ "documents" ] } }, "/organizations/secure-vault/folders": { "post": { "description": "Creates a folder in the Organization Secure Vault. Omit `parent_folder_id` to create a root folder, or provide it to create a sub-folder.\n\n **Token scopes**: `organizations:write`", "operationId": "documents_createOrganizationSecureVaultFolder-v2026-08-05", "requestBody": { "content": { "application/json": { "schema": { "properties": { "data": { "$ref": "#/components/schemas/OrganizationsSecureVaultFoldersPostRequestBodyContentApplicationJsonSchemaData", "description": "The folder to create." } }, "required": [ "data" ], "type": "object" } } } }, "responses": { "201": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Documents_createOrganizationSecureVaultFolder-v2026-08-05_Response_201" } } }, "description": "Folder created successfully." }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreateOrganizationSecureVaultFolder-v2026-08-05RequestBadRequestError" } } }, "description": "Bad request — invalid or missing parameters." }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreateOrganizationSecureVaultFolder-v2026-08-05RequestUnauthorizedError" } } }, "description": "Unauthorized — missing or invalid authentication token." }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreateOrganizationSecureVaultFolder-v2026-08-05RequestForbiddenError" } } }, "description": "Forbidden — the token lacks access to this resource." }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreateOrganizationSecureVaultFolder-v2026-08-05RequestNotFoundError" } } }, "description": "Not found." }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContainer" } } }, "description": "Operation failed." } }, "security": [ { "deelToken": [] } ], "summary": "Create Organization Secure Vault Folder", "tags": [ "documents" ] } }, "/organizations/secure-vault/folders/{folder_id}": { "delete": { "description": "Deletes an Organization Secure Vault folder that is no longer needed, such as a temporary or misfiled folder structure, along with all of its sub-folders. Files that can be deleted are permanently removed and cannot be recovered; files that cannot be deleted (e.g. signed documents) are moved into the \"Other Files\" folder instead. The system-managed \"Other Files\" folder cannot be deleted.\n\n **Token scopes**: `organizations:write`", "operationId": "documents_deleteOrganizationSecureVaultFolder-v2026-08-05", "parameters": [ { "description": "Public UUID of the folder.", "in": "path", "name": "folder_id", "required": true, "schema": { "format": "uuid", "type": "string" } } ], "responses": { "204": { "content": { "application/json": { "schema": { "properties": {}, "type": "object" } } }, "description": "Folder deleted successfully." }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DeleteOrganizationSecureVaultFolder-v2026-08-05RequestBadRequestError" } } }, "description": "Bad request — invalid or missing parameters." }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DeleteOrganizationSecureVaultFolder-v2026-08-05RequestUnauthorizedError" } } }, "description": "Unauthorized — missing or invalid authentication token." }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DeleteOrganizationSecureVaultFolder-v2026-08-05RequestForbiddenError" } } }, "description": "Forbidden — the token lacks access to this resource." }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DeleteOrganizationSecureVaultFolder-v2026-08-05RequestNotFoundError" } } }, "description": "Not found." }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContainer" } } }, "description": "Operation failed." } }, "security": [ { "deelToken": [] } ], "summary": "Delete Organization Secure Vault Folder", "tags": [ "documents" ] }, "get": { "description": "Returns a single Organization Secure Vault folder, including its ancestor chain from the root folder down to its parent.\n\n **Token scopes**: `organizations:read`", "operationId": "documents_getOrganizationSecureVaultFolder-v2026-08-05", "parameters": [ { "description": "Public UUID of the folder.", "in": "path", "name": "folder_id", "required": true, "schema": { "format": "uuid", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Documents_getOrganizationSecureVaultFolder-v2026-08-05_Response_200" } } }, "description": "Folder returned successfully." }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetOrganizationSecureVaultFolder-v2026-08-05RequestBadRequestError" } } }, "description": "Bad request — invalid or missing parameters." }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetOrganizationSecureVaultFolder-v2026-08-05RequestUnauthorizedError" } } }, "description": "Unauthorized — missing or invalid authentication token." }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetOrganizationSecureVaultFolder-v2026-08-05RequestForbiddenError" } } }, "description": "Forbidden — the token lacks access to this resource." }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetOrganizationSecureVaultFolder-v2026-08-05RequestNotFoundError" } } }, "description": "Not found." }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContainer" } } }, "description": "Operation failed." } }, "security": [ { "deelToken": [] } ], "summary": "Get Organization Secure Vault Folder", "tags": [ "documents" ] }, "patch": { "description": "Renames an Organization Secure Vault folder and updates its description. The system-managed \"Other Files\" folder cannot be modified.\n\n **Token scopes**: `organizations:write`", "operationId": "documents_updateOrganizationSecureVaultFolder-v2026-08-05", "parameters": [ { "description": "Public UUID of the folder.", "in": "path", "name": "folder_id", "required": true, "schema": { "format": "uuid", "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "properties": { "data": { "$ref": "#/components/schemas/OrganizationsSecureVaultFoldersFolderIdPatchRequestBodyContentApplicationJsonSchemaData", "description": "Fields to update on the folder." } }, "required": [ "data" ], "type": "object" } } } }, "responses": { "204": { "content": { "application/json": { "schema": { "properties": {}, "type": "object" } } }, "description": "Folder updated successfully." }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UpdateOrganizationSecureVaultFolder-v2026-08-05RequestBadRequestError" } } }, "description": "Bad request — invalid or missing parameters." }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UpdateOrganizationSecureVaultFolder-v2026-08-05RequestUnauthorizedError" } } }, "description": "Unauthorized — missing or invalid authentication token." }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UpdateOrganizationSecureVaultFolder-v2026-08-05RequestForbiddenError" } } }, "description": "Forbidden — the token lacks access to this resource." }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UpdateOrganizationSecureVaultFolder-v2026-08-05RequestNotFoundError" } } }, "description": "Not found." }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContainer" } } }, "description": "Operation failed." } }, "security": [ { "deelToken": [] } ], "summary": "Update Organization Secure Vault Folder", "tags": [ "documents" ] } }, "/organizations/secure-vault/folders/{folder_id}/files": { "post": { "description": "Uploads one or more files into a specific folder of the Organization Secure Vault. Upload the file contents to the File Service first, then reference each file here by its `file_id` and `one_time_secret`.\n\n **Token scopes**: `organizations:write`", "operationId": "documents_uploadOrganizationSecureVaultFilesToFolder-v2026-08-05", "parameters": [ { "description": "Public UUID of the folder.", "in": "path", "name": "folder_id", "required": true, "schema": { "format": "uuid", "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "properties": { "data": { "$ref": "#/components/schemas/OrganizationsSecureVaultFoldersFolderIdFilesPostRequestBodyContentApplicationJsonSchemaData", "description": "The files to attach to the Organization Secure Vault." } }, "required": [ "data" ], "type": "object" } } } }, "responses": { "201": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Documents_uploadOrganizationSecureVaultFilesToFolder-v2026-08-05_Response_201" } } }, "description": "Files uploaded successfully." }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UploadOrganizationSecureVaultFilesToFolder-v2026-08-05RequestBadRequestError" } } }, "description": "Bad request — invalid or missing parameters." }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UploadOrganizationSecureVaultFilesToFolder-v2026-08-05RequestUnauthorizedError" } } }, "description": "Unauthorized — missing or invalid authentication token." }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UploadOrganizationSecureVaultFilesToFolder-v2026-08-05RequestForbiddenError" } } }, "description": "Forbidden — the token lacks access to this resource." }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UploadOrganizationSecureVaultFilesToFolder-v2026-08-05RequestNotFoundError" } } }, "description": "Not found." }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UploadOrganizationSecureVaultFilesToFolder-v2026-08-05RequestUnprocessableEntityError" } } }, "description": "Unprocessable entity — a file has an unsupported type or its content does not match its extension." }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContainer" } } }, "description": "Operation failed." } }, "security": [ { "deelToken": [] } ], "summary": "Upload Organization Secure Vault Files To Folder", "tags": [ "documents" ] } }, "/organizations/secure-vault/folders/{folder_id}/items": { "get": { "description": "Lists the files and sub-folders contained in a specific Organization Secure Vault folder. Use this endpoint to browse or paginate the contents of a single folder; to list items at the vault root instead, use the root-listing endpoint.\n\n **Token scopes**: `organizations:read`", "operationId": "documents_listOrganizationSecureVaultFolderItems-v2026-08-05", "parameters": [ { "description": "Public UUID of the folder.", "in": "path", "name": "folder_id", "required": true, "schema": { "format": "uuid", "type": "string" } }, { "description": "Maximum number of results to return per page.", "in": "query", "name": "limit", "required": false, "schema": { "default": 20, "maximum": 100, "minimum": 1, "type": "integer" } }, { "description": "Pagination cursor returned by a previous response.", "in": "query", "name": "cursor", "required": false, "schema": { "maxLength": 2048, "type": "string" } }, { "description": "Free-text search on folder and file names.", "in": "query", "name": "search", "required": false, "schema": { "maxLength": 255, "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Documents_listOrganizationSecureVaultFolderItems-v2026-08-05_Response_200" } } }, "description": "Folder items returned successfully." }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ListOrganizationSecureVaultFolderItems-v2026-08-05RequestBadRequestError" } } }, "description": "Bad request — invalid or missing parameters." }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ListOrganizationSecureVaultFolderItems-v2026-08-05RequestUnauthorizedError" } } }, "description": "Unauthorized — missing or invalid authentication token." }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ListOrganizationSecureVaultFolderItems-v2026-08-05RequestForbiddenError" } } }, "description": "Forbidden — the token lacks access to this resource." }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ListOrganizationSecureVaultFolderItems-v2026-08-05RequestNotFoundError" } } }, "description": "Not found." }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContainer" } } }, "description": "Operation failed." } }, "security": [ { "deelToken": [] } ], "summary": "List Organization Secure Vault Folder Items", "tags": [ "documents" ] } }, "/organizations/tasks": { "get": { "description": "Returns a paginated list of all tasks for the current organization, not limited to those assigned to the caller; intended for callers with the `organization.manage` permission. Supports both offset/limit and cursor-based pagination, which are mutually exclusive — do not supply `cursor` together with an offset parameter.\n\n **Token scopes**: `tasks:read`", "operationId": "organizationTasks_listOrganizationTasks-v2026-03-03", "parameters": [ { "description": "Filter by task statuses.", "in": "query", "name": "statuses", "required": false, "schema": { "default": [ "PENDING" ], "items": { "$ref": "#/components/schemas/OrganizationsTasksGetParametersStatusesSchemaItems" }, "type": "array" } }, { "description": "Filter by task category.", "in": "query", "name": "category", "required": false, "schema": { "$ref": "#/components/schemas/OrganizationsTasksGetParametersCategory" } }, { "description": "Search string for task display name or description.", "in": "query", "name": "search", "required": false, "schema": { "type": "string" } }, { "description": "Filter by external ID (for tasks created with an external reference).", "in": "query", "name": "external_id", "required": false, "schema": { "type": "string" } }, { "description": "Opaque cursor for cursor-based pagination. When provided, use with limit only (do not use offset).", "in": "query", "name": "cursor", "required": false, "schema": { "type": "string" } }, { "description": "Maximum number of records to return (1-100).", "in": "query", "name": "limit", "required": false, "schema": { "default": 20, "maximum": 100, "minimum": 1, "type": "integer" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Organization_Tasks_listOrganizationTasks-v2026-03-03_Response_200" } } }, "description": "Successful response. Returns tasks for the organization" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ListOrganizationTasks-v2026-03-03RequestBadRequestError" } } }, "description": "Bad request Error" }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ListOrganizationTasks-v2026-03-03RequestUnauthorizedError" } } }, "description": "Invalid, expired, or missing API token." }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ListOrganizationTasks-v2026-03-03RequestForbiddenError" } } }, "description": "User does not have permission Error" }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContainer" } } }, "description": "Operation failed." }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ListOrganizationTasks-v2026-03-03RequestUnprocessableEntityError" } } }, "description": "Validation error" }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ListOrganizationTasks-v2026-03-03RequestInternalServerError" } } }, "description": "Internal server error." } }, "security": [ { "deelToken": [] } ], "summary": "List organization tasks", "tags": [ "organizationTasks" ] } }, "/payments": { "get": { "description": "Returns a cursor-paginated list of payment statements to Deel, including status, totals, currency, and payment method. Child invoices and per-worker details are no longer included in this response; use `GET /rest/payments/{payment_id}/breakdown` to retrieve them. Use the `next_cursor` value from the response to retrieve subsequent pages.\n\n **Token scopes**: `accounting:read`", "operationId": "accounting_retrievePaymentReceipts-v2027-01-01", "parameters": [ { "description": "Filters results to include payments created on or after this date (in ISO 8601 format).", "in": "query", "name": "date_from", "required": false, "schema": { "format": "date", "type": "string" } }, { "description": "Filters results to include payments created before this date (in ISO 8601 format).", "in": "query", "name": "date_to", "required": false, "schema": { "format": "date", "type": "string" } }, { "description": "A cursor for pagination. Use the value returned in the 'next_cursor' field to get the next page of results.", "in": "query", "name": "cursor", "required": false, "schema": { "type": "string" } }, { "description": "Filters payments by their currency codes. Can be a single currency code or an array of codes.", "in": "query", "name": "currencies", "required": false, "schema": { "items": { "maxLength": 3, "minLength": 3, "pattern": "^[A-Z]{3}$", "type": "string" }, "type": "array" } }, { "description": "Filters payments by legal entity type (e.g., 'individual' or 'company'). Can be a single entity type or an array.", "in": "query", "name": "entities", "required": false, "schema": { "items": { "$ref": "#/components/schemas/PaymentsGetParametersEntitiesSchemaItems" }, "type": "array" } }, { "description": "Filters payments by their status (e.g., 'paid' or 'processing'). Can be a single status type or an array.", "in": "query", "name": "statuses", "required": false, "schema": { "items": { "$ref": "#/components/schemas/PaymentsGetParametersStatusesSchemaItems" }, "type": "array" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Accounting_retrievePaymentReceipts-v2027-01-01_Response_200" } } }, "description": "Successful operation." }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContainer" } } }, "description": "Operation failed." }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContainer" } } }, "description": "Operation failed." }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContainer" } } }, "description": "Operation failed." }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContainer" } } }, "description": "Operation failed." }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RetrievePaymentReceipts-v2027-01-01RequestInternalServerError" } } }, "description": "Internal server error." } }, "security": [ { "deelToken": [] } ], "summary": "Retrieve payment receipts", "tags": [ "accounting" ] } }, "/payments/statements": { "post": { "description": "Creates a payment statement for the requested invoices and pays it by bank transfer in a single call, instead of creating and paying in two separate steps. Use it when all invoices belong in one statement, grouped by statement type and legal entity. Every invoice must also be pending and not already locked in another payment. Submit invoices that span more than one statement in separate calls.\n\n **Token scopes**: `payment-statements:write`", "operationId": "payments_createPaymentStatement-v2026-07-23", "parameters": [ { "description": "Unique key that makes the request idempotent. Replaying the same key returns the original response without creating a duplicate statement. Reusing a key with a different body returns 409 idempotency_conflict.", "in": "header", "name": "Idempotency-Key", "required": true, "schema": { "maxLength": 64, "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "properties": { "data": { "$ref": "#/components/schemas/PaymentsStatementsPostRequestBodyContentApplicationJsonSchemaData" } }, "required": [ "data" ], "type": "object" } } }, "description": "Invoices and settlement options for the payment statement." }, "responses": { "201": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Payments_createPaymentStatement-v2026-07-23_Response_201" } } }, "description": "Successfully created and initiated payment of the statement." }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreatePaymentStatement-v2026-07-23RequestBadRequestError" } } }, "description": "Bad request. Codes: too_many_invoices (invoice_ids exceeds the maximum of 100), currency_not_supported (the requested country does not support the requested currency for bank transfer), invalid_parameter (request validation failed), INVALID_IDEMPOTENCY_KEY (the Idempotency-Key header is missing, empty, or longer than 64 characters)." }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreatePaymentStatement-v2026-07-23RequestUnauthorizedError" } } }, "description": "The authentication is missing or is invalid." }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreatePaymentStatement-v2026-07-23RequestForbiddenError" } } }, "description": "The organization is not permitted to use this endpoint." }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreatePaymentStatement-v2026-07-23RequestNotFoundError" } } }, "description": "One or more referenced resources could not be found." }, "409": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreatePaymentStatement-v2026-07-23RequestConflictError" } } }, "description": "Conflict. Codes: invoices_not_payable (some invoices are already in a statement or not pending), invoices_locked (invoices are in an active payment process), no_payable_invoices (none of the invoices are payable), cor_preparation_failed (shielded/contract-of-record preparation failed), idempotency_conflict (the Idempotency-Key was reused with a different request body), multiple_statements (the invoices resolve to more than one statement — submit each group separately), payment_failed (the statement was created but the synchronous payment could not be completed)." }, "429": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreatePaymentStatement-v2026-07-23RequestTooManyRequestsError" } } }, "description": "Too many requests. Another request with the same Idempotency-Key is currently in progress." }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreatePaymentStatement-v2026-07-23RequestInternalServerError" } } }, "description": "An unexpected error occurred while creating and paying the payment statement." } }, "security": [ { "deelToken": [] } ], "summary": "Create and pay a payment statement", "tags": [ "payments" ] } }, "/payments/statements/{payment_statement_id}": { "get": { "description": "Retrieves a payment statement's status and settlement details. Use it to check whether a statement has been paid, to see which invoices it covers, including any invoices Deel added automatically, and, for bank transfers, to get the exact beneficiary account to send funds to.\n\n **Token scopes**: `payment-statements:read`", "operationId": "payments_getPaymentStatement-v2026-07-23", "parameters": [ { "description": "Unique identifier of the payment statement to retrieve.", "in": "path", "name": "payment_statement_id", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Payments_getPaymentStatement-v2026-07-23_Response_200" } } }, "description": "Successfully retrieved the payment statement." }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContainer" } } }, "description": "Operation failed." }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetPaymentStatement-v2026-07-23RequestUnauthorizedError" } } }, "description": "The authentication is missing or is invalid." }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetPaymentStatement-v2026-07-23RequestForbiddenError" } } }, "description": "The organization is not permitted to use this endpoint." }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetPaymentStatement-v2026-07-23RequestNotFoundError" } } }, "description": "The payment statement does not exist or is not accessible to the caller." }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetPaymentStatement-v2026-07-23RequestInternalServerError" } } }, "description": "An unexpected error occurred while retrieving the payment statement." } }, "security": [ { "deelToken": [] } ], "summary": "Retrieve a payment statement", "tags": [ "payments" ] } }, "/payments/{payment_id}/breakdown": { "get": { "description": "Returns a breakdown of a payment made to Deel, with individual invoices and the Deel fee included as discrete line items.\n\n **Token scopes**: `accounting:read`", "operationId": "accounting_retrieveAPaymentBreakdown-v2026-01-01", "parameters": [ { "description": "Unique identifier for the payment to retrieve the breakdown.", "in": "path", "name": "payment_id", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Accounting_retrieveAPaymentBreakdown-v2026-01-01_Response_200" } } }, "description": "Successful operation." }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContainer" } } }, "description": "Operation failed." }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContainer" } } }, "description": "Operation failed." }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContainer" } } }, "description": "Operation failed." }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContainer" } } }, "description": "Operation failed." }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RetrieveAPaymentBreakdown-v2026-01-01RequestInternalServerError" } } }, "description": "Internal server error." } }, "security": [ { "deelToken": [] } ], "summary": "Retrieve a payment breakdown", "tags": [ "accounting" ] } }, "/payouts/auto-withdrawal-setting": { "get": { "description": "Returns the current auto-withdrawal configuration for the authenticated worker, including whether auto-withdrawal is enabled and the identifier of the selected withdrawal method.\n\n **Token scopes**: `worker:read`", "operationId": "payouts_getTheAutoWithdrawalSetting-v2026-01-01", "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Payouts_getTheAutoWithdrawalSetting-v2026-01-01_Response_200" } } }, "description": "Auto-withdrawal setting result" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContainer" } } }, "description": "Operation failed." }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContainer" } } }, "description": "Operation failed." }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContainer" } } }, "description": "Operation failed." }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContainer" } } }, "description": "Operation failed." } }, "security": [ { "deelToken": [] } ], "summary": "Get the auto-withdrawal setting", "tags": [ "payouts" ] }, "patch": { "description": "Partially updates the auto-withdrawal configuration, allowing callers to enable or disable auto-withdrawal and change the target withdrawal method.\n\n **Token scopes**: `worker:write`", "operationId": "payouts_changeTheAutoWithdrawalSetting-v2026-01-01", "requestBody": { "content": { "application/json": { "schema": { "properties": { "data": { "$ref": "#/components/schemas/PayoutsAutoWithdrawalSettingPatchRequestBodyContentApplicationJsonSchemaData" } }, "type": "object" } } }, "description": "Change the auto withdrawal setting" }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Payouts_changeTheAutoWithdrawalSetting-v2026-01-01_Response_200" } } }, "description": "Successfully update auto-withdrawal settings" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContainer" } } }, "description": "Operation failed." }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContainer" } } }, "description": "Operation failed." }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContainer" } } }, "description": "Operation failed." } }, "security": [ { "deelToken": [] } ], "summary": "Change the auto-withdrawal setting", "tags": [ "payouts" ] } }, "/payouts/balances": { "get": { "description": "Returns the total available balances for the authenticated contractor, broken down by currency and aggregated into a single cross-currency total.\n\n **Token scopes**: `worker:read`", "operationId": "payouts_listContractorBalances-v2026-01-01", "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Payouts_listContractorBalances-v2026-01-01_Response_200" } } }, "description": "Successful operation. Returns the contractor's balances." }, "400": { "content": { "application/json": { "schema": { "items": { "$ref": "#/components/schemas/PayoutsBalancesGetResponsesContentApplicationJsonSchemaItems" }, "type": "array" } } }, "description": "Operation failed." }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContainer" } } }, "description": "Operation failed." }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContainer" } } }, "description": "Operation failed." }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContainer" } } }, "description": "Operation failed." }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContainer" } } }, "description": "Operation failed." } }, "security": [ { "deelToken": [] } ], "summary": "List Contractor Balances", "tags": [ "payouts" ] } }, "/payouts/contractors/methods": { "get": { "description": "Returns all payout methods associated with the authenticated account, with optional filtering to return only the default method.\n\n **Token scopes**: `worker:read`, `worker:write`", "operationId": "payouts_fetchAllPayoutMethods-v2026-01-01", "parameters": [ { "description": "Filter by whether the method is default. If true, only default methods will be returned.", "in": "query", "name": "is_default", "required": false, "schema": { "type": "boolean" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Payouts_fetchAllPayoutMethods-v2026-01-01_Response_200" } } }, "description": "List of payout methods retrieved successfully." }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FetchAllPayoutMethods-v2026-01-01RequestBadRequestError" } } }, "description": "Invalid request parameters." }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContainer" } } }, "description": "Operation failed." }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContainer" } } }, "description": "Operation failed." }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContainer" } } }, "description": "Operation failed." }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContainer" } } }, "description": "Operation failed." } }, "security": [ { "deelToken": [] } ], "summary": "Fetch all payout methods", "tags": [ "payouts" ] }, "post": { "description": "Registers a new bank transfer payout method; the request payload structure is dynamic and determined by the selected option, so callers should retrieve field requirements before submitting.\n\n **Token scopes**: `worker:read`, `worker:write`", "operationId": "payouts_createABankTransferMethod-v2026-01-01", "requestBody": { "content": { "application/json": { "schema": { "properties": { "data": { "$ref": "#/components/schemas/PayoutsContractorsMethodsPostRequestBodyContentApplicationJsonSchemaData" } }, "required": [ "data" ], "type": "object" } } } }, "responses": { "201": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Payouts_createABankTransferMethod-v2026-01-01_Response_201" } } }, "description": "Bank transfer method created successfully." }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreateABankTransferMethod-v2026-01-01RequestBadRequestError" } } }, "description": "Invalid request parameters." }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContainer" } } }, "description": "Operation failed." }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContainer" } } }, "description": "Operation failed." }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContainer" } } }, "description": "Operation failed." }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContainer" } } }, "description": "Operation failed." } }, "security": [ { "deelToken": [] } ], "summary": "Create a bank transfer method", "tags": [ "payouts" ] } }, "/payouts/contractors/methods/bank_transfers/requirements": { "get": { "description": "Call this endpoint before creating a bank transfer payout method to determine the required input fields for the given country and currency, along with a fee preview for the specified amount (defaulting to 100.00 when none is provided). The returned fields map directly to the payload expected by the bank transfer method creation endpoint.\n\n **Token scopes**: `worker:read`", "operationId": "payouts_getBankTransferRequirements-v2026-01-01", "parameters": [ { "description": "Country code", "in": "query", "name": "country", "required": true, "schema": { "maxLength": 2, "minLength": 2, "pattern": "^[A-Z]{2}$", "type": "string" } }, { "description": "Currency code", "in": "query", "name": "currency", "required": true, "schema": { "maxLength": 3, "minLength": 3, "pattern": "^[A-Z]{3}$", "type": "string" } }, { "description": "Amount for calculating fees, if not provided, the default amount of 100.00 is used", "in": "query", "name": "amount", "required": false, "schema": { "format": "double", "type": "number" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Payouts_getBankTransferRequirements-v2026-01-01_Response_200" } } }, "description": "Successful operation." }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetBankTransferRequirements-v2026-01-01RequestBadRequestError" } } }, "description": "Invalid request parameters." }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContainer" } } }, "description": "Operation failed." }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContainer" } } }, "description": "Operation failed." }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContainer" } } }, "description": "Operation failed." }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContainer" } } }, "description": "Operation failed." } }, "security": [ { "deelToken": [] } ], "summary": "Get bank transfer requirements", "tags": [ "payouts" ] } }, "/payouts/contractors/methods/bank_transfers/supported_routes": { "get": { "description": "Returns all bank transfer routes available to the authenticated contractor.\n\n **Token scopes**: `worker:read`, `worker:write`", "operationId": "payouts_getBankTransferSupportedRoutes-v2026-01-01", "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Payouts_getBankTransferSupportedRoutes-v2026-01-01_Response_200" } } }, "description": "Successful operation." }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContainer" } } }, "description": "Operation failed." }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContainer" } } }, "description": "Operation failed." }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContainer" } } }, "description": "Operation failed." }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContainer" } } }, "description": "Operation failed." }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContainer" } } }, "description": "Operation failed." } }, "security": [ { "deelToken": [] } ], "summary": "Get bank transfer supported routes for contractor", "tags": [ "payouts" ] } }, "/payouts/contractors/methods/{id}": { "put": { "description": "Updates an existing bank transfer payout method. This performs a full replacement of the method rather than a partial update.\n\n **Token scopes**: `worker:write`", "operationId": "payouts_updateABankTransferMethod-v2026-01-01", "parameters": [ { "description": "Method unique identifier", "in": "path", "name": "id", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "properties": { "data": { "$ref": "#/components/schemas/PayoutsContractorsMethodsIdPutRequestBodyContentApplicationJsonSchemaData" } }, "required": [ "data" ], "type": "object" } } } }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Payouts_updateABankTransferMethod-v2026-01-01_Response_200" } } }, "description": "Bank transfer method created successfully." }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UpdateABankTransferMethod-v2026-01-01RequestBadRequestError" } } }, "description": "Invalid request parameters." }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContainer" } } }, "description": "Operation failed." }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContainer" } } }, "description": "Operation failed." }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContainer" } } }, "description": "Operation failed." }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContainer" } } }, "description": "Operation failed." } }, "security": [ { "deelToken": [] } ], "summary": "Update a bank transfer method", "tags": [ "payouts" ] } }, "/payouts/contractors/settings/auto_withdraw": { "post": { "description": "Updates the auto-withdrawal configuration for the authenticated contractor.\n\n **Token scopes**: `worker:read`, `worker:write`", "operationId": "payouts_updateAutoWithdrawSetting-v2026-01-01", "requestBody": { "content": { "application/json": { "schema": { "properties": { "data": { "$ref": "#/components/schemas/PayoutsContractorsSettingsAutoWithdrawPostRequestBodyContentApplicationJsonSchemaData" } }, "required": [ "data" ], "type": "object" } } } }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Payouts_updateAutoWithdrawSetting-v2026-01-01_Response_200" } } }, "description": "Auto withdraw setting updated successfully" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContainer" } } }, "description": "Operation failed." }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContainer" } } }, "description": "Operation failed." }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContainer" } } }, "description": "Operation failed." }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContainer" } } }, "description": "Operation failed." }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContainer" } } }, "description": "Operation failed." } }, "security": [ { "deelToken": [] } ], "summary": "Update auto withdraw setting for contractor", "tags": [ "payouts" ] } }, "/payouts/employees/methods": { "get": { "description": "Retrieves the configured bank payout methods for an employee.\n\n **Token scopes**: `worker:read`, `worker:write`", "operationId": "payouts_getBankDetails-v2026-01-01", "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Payouts_getBankDetails-v2026-01-01_Response_200" } } }, "description": "Get Bank Details" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContainer" } } }, "description": "Operation failed." }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContainer" } } }, "description": "Operation failed." }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContainer" } } }, "description": "Operation failed." }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContainer" } } }, "description": "Operation failed." }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContainer" } } }, "description": "Operation failed." } }, "security": [ { "deelToken": [] } ], "summary": "Get Bank Details", "tags": [ "payouts" ] }, "post": { "description": "Creates or updates an employee's bank payout method. If a method already exists, the existing record is superseded and the response includes a version identifier and activation status reflecting the updated state.\n\n **Token scopes**: `worker:read`, `worker:write`", "operationId": "payouts_addEditBankDetails-v2026-01-01", "requestBody": { "content": { "application/json": { "schema": { "properties": { "data": { "$ref": "#/components/schemas/PayoutsEmployeesMethodsPostRequestBodyContentApplicationJsonSchemaData", "description": "Request data" } }, "type": "object" } } } }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Payouts_addEditBankDetails-v2026-01-01_Response_200" } } }, "description": "Add Bank Details / Edit Bank Details" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContainer" } } }, "description": "Operation failed." }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContainer" } } }, "description": "Operation failed." }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContainer" } } }, "description": "Operation failed." }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContainer" } } }, "description": "Operation failed." }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContainer" } } }, "description": "Operation failed." } }, "security": [ { "deelToken": [] } ], "summary": "Add/Edit Bank Details", "tags": [ "payouts" ] } }, "/payouts/employees/methods/bank-transfers/requirements": { "get": { "description": "Returns the static bank transfer requirements for a bank country and currency, as resolved for employee payouts: the preferred transfer type (BTS, then local bank account, IBAN or SWIFT) with its input fields and validation rules. Needs no employee or contract context, so organization tokens can call it. Returns no fees and does not re-evaluate requirements as values change; for that, use `POST /payouts/employees/methods/bank_transfers/requirements`.\n\n **Token scopes**: `payments:read`", "operationId": "payouts_getStaticEmployeeBankTransferRequirements-v2026-09-28", "parameters": [ { "description": "Bank country as an ISO 3166-1 alpha-2 code.", "in": "query", "name": "country", "required": true, "schema": { "maxLength": 2, "minLength": 2, "pattern": "^[A-Z]{2}$", "type": "string" } }, { "description": "Payout currency as an ISO 4217 code.", "in": "query", "name": "currency", "required": true, "schema": { "maxLength": 3, "minLength": 3, "pattern": "^[A-Z]{3}$", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Payouts_getStaticEmployeeBankTransferRequirements-v2026-09-28_Response_200" } } }, "description": "Successful operation." }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetStaticEmployeeBankTransferRequirements-v2026-09-28RequestBadRequestError" } } }, "description": "Invalid request: missing, unsupported or malformed `country` or `currency`, or an unknown query parameter." }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContainer" } } }, "description": "Operation failed." }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContainer" } } }, "description": "Operation failed." }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContainer" } } }, "description": "Operation failed." }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetStaticEmployeeBankTransferRequirements-v2026-09-28RequestInternalServerError" } } }, "description": "Unexpected failure while resolving the requirements." }, "503": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetStaticEmployeeBankTransferRequirements-v2026-09-28RequestServiceUnavailableError" } } }, "description": "The bank transfer requirements provider is temporarily unavailable; retry later." } }, "security": [ { "deelToken": [] } ], "summary": "Get static employee bank transfer requirements", "tags": [ "payouts" ] } }, "/payouts/employees/methods/bank_transfers/requirements": { "post": { "description": "Returns the progressive field requirements needed to configure a bank transfer payout method, based on the data provided in the request. The `is_final` flag in the response indicates whether all requirements have been satisfied; callers should continue submitting updated data until `is_final` is `true` before calling `POST /payouts/employees/methods`.\n\n **Token scopes**: `worker:read`, `worker:write`", "operationId": "payouts_dynamicRequirements-v2026-01-01", "requestBody": { "content": { "application/json": { "schema": { "properties": { "data": { "$ref": "#/components/schemas/PayoutsEmployeesMethodsBankTransfersRequirementsPostRequestBodyContentApplicationJsonSchemaData", "description": "Request data" } }, "type": "object" } } } }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Payouts_dynamicRequirements-v2026-01-01_Response_200" } } }, "description": "Dynamic Requirements" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DynamicRequirements-v2026-01-01RequestBadRequestError" } } }, "description": "Invalid request parameters." }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContainer" } } }, "description": "Operation failed." }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContainer" } } }, "description": "Operation failed." }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContainer" } } }, "description": "Operation failed." }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContainer" } } }, "description": "Operation failed." } }, "security": [ { "deelToken": [] } ], "summary": "Get dynamic bank transfer requirements", "tags": [ "payouts" ] } }, "/payouts/employees/methods/{id}": { "delete": { "description": "Permanently removes the bank payout method identified by the given method `id`.\n\n **Token scopes**: `worker:read`, `worker:write`", "operationId": "payouts_deleteBankDetails-v2026-01-01", "parameters": [ { "description": "method ID", "in": "path", "name": "id", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Payouts_deleteBankDetails-v2026-01-01_Response_200" } } }, "description": "Delete Bank Details" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContainer" } } }, "description": "Operation failed." }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContainer" } } }, "description": "Operation failed." }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContainer" } } }, "description": "Operation failed." }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContainer" } } }, "description": "Operation failed." }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContainer" } } }, "description": "Operation failed." } }, "security": [ { "deelToken": [] } ], "summary": "Delete Bank Details", "tags": [ "payouts" ] } }, "/payouts/withdrawals": { "post": { "description": "Initiates a withdrawal of available funds to the employee's configured payout method. The operation is asynchronous; the outcome is delivered via webhook rather than the synchronous response.\n\n **Token scopes**: `worker:write`", "operationId": "payouts_requestToWithdrawFunds-v2026-01-01", "requestBody": { "content": { "application/json": { "schema": { "properties": { "data": { "$ref": "#/components/schemas/PayoutsWithdrawalsPostRequestBodyContentApplicationJsonSchemaData" } }, "required": [ "data" ], "type": "object" } } } }, "responses": { "201": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Payouts_requestToWithdrawFunds-v2026-01-01_Response_201" } } }, "description": "Withdrawal successfully initiated" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContainer" } } }, "description": "Operation failed." }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContainer" } } }, "description": "Operation failed." }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContainer" } } }, "description": "Operation failed." }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContainer" } } }, "description": "Operation failed." }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RequestToWithdrawFunds-v2026-01-01RequestInternalServerError" } } }, "description": "Internal server error" } }, "security": [ { "deelToken": [] } ], "summary": "Request to withdraw funds", "tags": [ "payouts" ] } }, "/payroll-activations": { "get": { "description": "Returns whether a legal entity has reached payroll activation readiness, giving clients and partners a self-serve signal they can check over the public API instead of asking Deel support. Call it before starting a step that requires payroll to already be active for the legal entity, and gate that step on the result. A legal entity whose activation is still in progress, or that has none yet, is reported as not ready.\n\n **Token scopes**: `global-payroll:read`\n\n **Beta**: this version requires the `X-Beta: true` request header and its contract may change before it is promoted to stable. It is scheduled to become stable on 2027-01-12.", "operationId": "globalPayroll_getPayrollActivations-v2026-10-12", "parameters": [ { "description": "The unique identifier of the legal entity whose payroll readiness should be returned.", "in": "query", "name": "legal_entity_id", "required": true, "schema": { "format": "uuid", "type": "string" } }, { "description": "Opts in to the beta version of this endpoint. Must be `true`.", "in": "header", "name": "X-Beta", "required": true, "schema": { "$ref": "#/components/schemas/PayrollActivationsGetParametersXBeta" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Global_Payroll_getPayrollActivations-v2026-10-12_Response_200" } } }, "description": "OK" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContainer" } } }, "description": "Operation failed." }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetPayrollActivations-v2026-10-12RequestUnauthorizedError" } } }, "description": "401" }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetPayrollActivations-v2026-10-12RequestForbiddenError" } } }, "description": "403" }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetPayrollActivations-v2026-10-12RequestNotFoundError" } } }, "description": "404" }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetPayrollActivations-v2026-10-12RequestInternalServerError" } } }, "description": "500" } }, "security": [ { "deelToken": [] } ], "summary": "Get payroll activation readiness for a legal entity", "tags": [ "globalPayroll" ] } }, "/payroll-groups": { "get": { "description": "Lists the active payroll groups of a legal entity, with the REGULAR payroll calendars of each group that start in the chosen year (the current year by default). Use it to find the payroll groups of a legal entity and their calendars for a given year; leave the calendars out when you only need the groups.\n\n **Token scopes**: `global-payroll:read`", "operationId": "globalPayroll_listPayrollGroups-v2026-09-08", "parameters": [ { "description": "Public UUID of the legal entity whose payroll groups to retrieve.", "in": "query", "name": "legalEntityId", "required": true, "schema": { "format": "uuid", "type": "string" } }, { "description": "Calendar year to filter payroll cycles by. Defaults to the current year.", "in": "query", "name": "calendarYear", "required": false, "schema": { "maximum": 2035, "minimum": 2020, "type": "integer" } }, { "description": "Whether to include REGULAR payroll calendars for each group. Defaults to true. Set to false to skip calendar fetching for a faster response.", "in": "query", "name": "includePayrollCalendar", "required": false, "schema": { "default": true, "type": "boolean" } }, { "description": "Cursor-based pagination parameters. limit: max items per page (1-15, default 10). cursor: opaque string from the previous response's pagination.nextCursor field.", "in": "query", "name": "pagination", "required": false, "schema": { "$ref": "#/components/schemas/PayrollGroupsGetParametersPagination", "default": { "limit": 10 } } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Global_Payroll_listPayrollGroups-v2026-09-08_Response_200" } } }, "description": "OK" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContainer" } } }, "description": "Operation failed." }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContainer" } } }, "description": "Operation failed." }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ListPayrollGroups-v2026-09-08RequestForbiddenError" } } }, "description": "403" }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ListPayrollGroups-v2026-09-08RequestNotFoundError" } } }, "description": "404" }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ListPayrollGroups-v2026-09-08RequestInternalServerError" } } }, "description": "500" } }, "security": [ { "deelToken": [] } ], "summary": "List payroll groups for a legal entity", "tags": [ "globalPayroll" ] } }, "/people": { "get": { "deprecated": true, "description": "Returns a paginated list of people records in the organization. Supports filtering by search term, teams, custom fields, and other query parameters. Build people directories, sync HR data, or power search interfaces across your workforce records.\n\n **Token scopes**: `people:read`\n\n **Deprecated**: a newer version of this endpoint is available. This version is scheduled for removal on 2027-09-30.\n\n **Beta version available**: version `2026-09-30` of this endpoint is in beta. Send `X-Beta: true` to call it.", "operationId": "people_getPeople", "parameters": [ { "description": "Return a page of results with given number of records.", "in": "query", "name": "offset", "required": false, "schema": { "default": 0, "maximum": 999999999, "minimum": 0, "type": "integer" } }, { "description": "Return a page of results with given number of records.", "in": "query", "name": "limit", "required": false, "schema": { "maximum": 200, "minimum": 1, "type": "integer" } }, { "description": "Include a contract if by name or contractor name contains given search term.", "in": "query", "name": "search", "required": false, "schema": { "type": "string" } }, { "description": "Filter the results based on the team(group) the users contract is associated with", "in": "query", "name": "teams", "required": false, "schema": { "items": { "format": "uuid", "type": "string" }, "type": "array" } }, { "description": "Pick the fields you want to see in the response in order to avoid a bloated people list output. Supports dot notation (e.g., 'employments[0].contract_status') to access nested fields.", "in": "query", "name": "fields", "required": false, "schema": { "items": { "$ref": "#/components/schemas/PeopleGetParametersFieldsSchemaItems" }, "type": "array" } }, { "description": "Sort people by given field name.", "in": "query", "name": "sort_by", "required": false, "schema": { "$ref": "#/components/schemas/PeopleGetParametersSortBy" } }, { "description": "Order direction of results; ascending or descending.", "in": "query", "name": "sort_order", "required": false, "schema": { "$ref": "#/components/schemas/PeopleGetParametersSortOrder" } }, { "description": "Employee's current hiring status.", "in": "query", "name": "hiring_statuses", "required": false, "schema": { "items": { "$ref": "#/components/schemas/PeopleGetParametersHiringStatusesSchemaItems" }, "type": "array" } }, { "description": "Employee's current band placement.", "in": "query", "name": "band_placements", "required": false, "schema": { "items": { "$ref": "#/components/schemas/PeopleGetParametersBandPlacementsSchemaItems" }, "type": "array" } }, { "description": "Employee's minimum band placement", "in": "query", "name": "comparative_ratios_from", "required": false, "schema": { "title": "float", "type": "string" } }, { "description": "Employee's maximum band placement", "in": "query", "name": "comparative_ratios_to", "required": false, "schema": { "title": "float", "type": "string" } }, { "description": "Filter people by hiring types", "in": "query", "name": "hiring_types", "required": false, "schema": { "items": { "$ref": "#/components/schemas/PeopleGetParametersHiringTypesSchemaItems" }, "type": "array" } }, { "description": "Filter people by person (worker profile) lifecycle status.", "in": "query", "name": "person_statuses", "required": false, "schema": { "items": { "$ref": "#/components/schemas/PeopleGetParametersPersonStatusesSchemaItems" }, "type": "array" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/people_getPeople_Response_200" } } }, "description": "Successful response" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContainer" } } }, "description": "Operation failed." }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContainer" } } }, "description": "Operation failed." }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContainer" } } }, "description": "Operation failed." }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContainer" } } }, "description": "Operation failed." }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ListOfPeople-v2026-01-01RequestInternalServerError" } } }, "description": "Internal Server Error" } }, "security": [ { "deelToken": [] } ], "summary": "List of People", "tags": [ "People" ] }, "post": { "description": "Creates a direct employee record in Deel's HRIS, hired under the organization's own legal entity. Provisions both a person and an associated employment contract. Applicable when onboarding employees managed through your own payroll providers. It can support downstream integrations, such as IT equipment orders.\n\n **Token scopes**: `people:write`", "operationId": "people_createADirectEmployee-v2026-01-01", "requestBody": { "content": { "application/json": { "schema": { "properties": { "data": { "$ref": "#/components/schemas/PeoplePostRequestBodyContentApplicationJsonSchemaData" } }, "required": [ "data" ], "type": "object" } } } }, "responses": { "201": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/People_createADirectEmployee-v2026-01-01_Response_201" } } }, "description": "Successful operation." }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreateADirectEmployee-v2026-01-01RequestBadRequestError" } } }, "description": "Operation failed." }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContainer" } } }, "description": "Operation failed." }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContainer" } } }, "description": "Operation failed." }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContainer" } } }, "description": "Operation failed." }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreateADirectEmployee-v2026-01-01RequestInternalServerError" } } }, "description": "Operation failed." } }, "security": [ { "deelToken": [] } ], "summary": "Create a direct employee", "tags": [ "People" ] } }, "/people/custom_fields": { "get": { "description": "Returns the list of custom field definitions configured for people within the organization. The response includes field metadata, not specific person field values. It provides definitions with people placement for supported types such as text, list, multiselect, number, percentage, currency, date, and hyperlink.\n\n **Token scopes**: `people:read`", "operationId": "customFieldsPeople_getCustomFields", "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/custom-fields-people_getCustomFields_Response_200" } } }, "description": "Successful response" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContainer" } } }, "description": "Operation failed." }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContainer" } } }, "description": "Operation failed." }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContainer" } } }, "description": "Operation failed." }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContainer" } } }, "description": "Operation failed." }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ListAllPeopleCustomFields-v2026-01-01RequestInternalServerError" } } }, "description": "Internal Server Error" } }, "security": [ { "deelToken": [] } ], "summary": "List all people custom fields", "tags": [ "customFieldsPeople" ] } }, "/people/custom_fields/{id}": { "get": { "description": "\"Retrieves a single person custom field definition by its `id`.\n\n **Token scopes**: `people:read`", "operationId": "customFieldsPeople_getPersonCustomField", "parameters": [ { "description": "Custom field id.", "in": "path", "name": "id", "required": true, "schema": { "format": "uuid", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/custom-fields-people_getPersonCustomField_Response_200" } } }, "description": "Successful response" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContainer" } } }, "description": "Operation failed." }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContainer" } } }, "description": "Operation failed." }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContainer" } } }, "description": "Operation failed." }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContainer" } } }, "description": "Operation failed." }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContainer" } } }, "description": "Operation failed." } }, "security": [ { "deelToken": [] } ], "summary": "Get custom field from people by id", "tags": [ "customFieldsPeople" ] } }, "/people/external/{worker_id}/personal": { "get": { "description": "Retrieves a worker profile record using a system-wide external worker identifier.\n\n **Token scopes**: `people:read`", "operationId": "personalInformation_getPersonPersonalInfoExternalID", "parameters": [ { "description": "System-wide external identifier for a worker record.", "in": "path", "name": "worker_id", "required": true, "schema": { "type": "string" } } ], "responses": { "204": { "content": { "application/json": { "schema": { "properties": {}, "type": "object" } } }, "description": "Successful response" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContainer" } } }, "description": "Operation failed." }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContainer" } } }, "description": "Operation failed." }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContainer" } } }, "description": "Operation failed." }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContainer" } } }, "description": "Operation failed." }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContainer" } } }, "description": "Operation failed." } }, "security": [ { "deelToken": [] } ], "summary": "Get worker profile by external ID", "tags": [ "personalInformation" ] }, "patch": { "description": "Partially updates a worker's personal information using an external identifier. Only fields included in the request body are modified.\n\n **Token scopes**: `people:write`", "operationId": "personalInformation_updatePersonPersonalInfoExternalID", "parameters": [ { "description": "Unique identifier for a worker (External ID).", "in": "path", "name": "worker_id", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "properties": { "data": { "$ref": "#/components/schemas/PeopleExternalWorkerIdPersonalPatchRequestBodyContentApplicationJsonSchemaData" } }, "required": [ "data" ], "type": "object" } } } }, "responses": { "204": { "content": { "application/json": { "schema": { "properties": {}, "type": "object" } } }, "description": "Successful response" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContainer" } } }, "description": "Operation failed." }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContainer" } } }, "description": "Operation failed." }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContainer" } } }, "description": "Operation failed." }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContainer" } } }, "description": "Operation failed." }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContainer" } } }, "description": "Operation failed." } }, "security": [ { "deelToken": [] } ], "summary": "Update personal information by external id", "tags": [ "personalInformation" ] } }, "/people/me": { "get": { "description": "Returns the profile of the currently authenticated user, including identity, organizational membership, and integration identifiers for connected services such as Slack.\n\n **Token scopes**: `worker:read`, `people:read`", "operationId": "people_getMyCurrentPersonalProfile-v2026-01-01", "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/People_getMyCurrentPersonalProfile-v2026-01-01_Response_200" } } }, "description": "Successful operation." }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContainer" } } }, "description": "Operation failed." }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetMyCurrentPersonalProfile-v2026-01-01RequestUnauthorizedError" } } }, "description": "Unauthorized. Missing or invalid authentication credentials." }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContainer" } } }, "description": "Operation failed." }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContainer" } } }, "description": "Operation failed." }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContainer" } } }, "description": "Operation failed." } }, "security": [ { "deelToken": [] } ], "summary": "Get my current personal profile", "tags": [ "People" ] } }, "/people/{hris_profile_id}": { "get": { "deprecated": true, "description": "Returns detailed information about a single person in the organization by their public ID. Returns personal details, employment information, organizational structure, person status, direct manager, custom fields, and related data.\n\n **Token scopes**: `people:read`\n\n **Deprecated**: a newer version of this endpoint is available. This version is scheduled for removal on 2027-10-12.\n\n **Beta version available**: version `2026-10-12` of this endpoint is in beta. Send `X-Beta: true` to call it.", "operationId": "people_getPersonById", "parameters": [ { "description": "Unique identifier for the person.", "in": "path", "name": "hris_profile_id", "required": true, "schema": { "format": "uuid", "type": "string" } }, { "description": "Include custom fields in the response.", "in": "query", "name": "include_custom_fields", "required": false, "schema": { "type": "boolean" } }, { "description": "Include worker relations in the response.", "in": "query", "name": "include_worker_relations", "required": false, "schema": { "type": "boolean" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/people_getPersonById_Response_200" } } }, "description": "Successful response" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContainer" } } }, "description": "Operation failed." }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContainer" } } }, "description": "Operation failed." }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContainer" } } }, "description": "Operation failed." }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContainer" } } }, "description": "Operation failed." }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RetrieveASinglePerson-v2026-01-01RequestInternalServerError" } } }, "description": "Internal Server Error" } }, "security": [ { "deelToken": [] } ], "summary": "Retrieve a single person", "tags": [ "People" ] } }, "/people/{id}/department": { "put": { "description": "Assigns a worker to a department by their HRIS profile ID. By default the new assignment appends to existing positions; set `replace_other_positions` to true to replace all current positions instead.\n\n **Token scopes**: `people:write`", "operationId": "organizationStructure_updatePersonDepartment", "parameters": [ { "description": "Hris profile ID", "in": "path", "name": "id", "required": true, "schema": { "type": "string" } }, { "description": "Indicates if this department position should replace all other positions or only append to the existing ones.", "in": "query", "name": "replace_other_positions", "required": false, "schema": { "type": "boolean" } } ], "requestBody": { "content": { "application/json": { "schema": { "properties": { "data": { "$ref": "#/components/schemas/PeopleIdDepartmentPutRequestBodyContentApplicationJsonSchemaData" } }, "required": [ "data" ], "type": "object" } } } }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/organization-structure_updatePersonDepartment_Response_200" } } }, "description": "Successful operation." }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContainer" } } }, "description": "Operation failed." }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContainer" } } }, "description": "Operation failed." }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContainer" } } }, "description": "Operation failed." }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContainer" } } }, "description": "Operation failed." }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContainer" } } }, "description": "Operation failed." } }, "security": [ { "deelToken": [] } ], "summary": "Update organization structure", "tags": [ "organizationStructure" ] } }, "/people/{id}/working-location": { "put": { "description": "Sets the working location for a worker identified by their HRIS profile ID.\n\n **Token scopes**: `people:write`", "operationId": "people_updatePersonWorkingLocation", "parameters": [ { "description": "Hris profile ID", "in": "path", "name": "id", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "properties": { "data": { "$ref": "#/components/schemas/PeopleIdWorkingLocationPutRequestBodyContentApplicationJsonSchemaData" } }, "required": [ "data" ], "type": "object" } } } }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/people_updatePersonWorkingLocation_Response_200" } } }, "description": "Successful operation." }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContainer" } } }, "description": "Operation failed." }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContainer" } } }, "description": "Operation failed." }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContainer" } } }, "description": "Operation failed." }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContainer" } } }, "description": "Operation failed." }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContainer" } } }, "description": "Operation failed." } }, "security": [ { "deelToken": [] } ], "summary": "Update working location", "tags": [ "People" ] } }, "/people/{worker_id}/custom_fields": { "get": { "description": "Returns all custom field values currently set for the specified worker.\n\n **Token scopes**: `people:read`", "operationId": "customFieldsPeople_getPersonCustomFields", "parameters": [ { "description": "Worker id.", "in": "path", "name": "worker_id", "required": true, "schema": { "format": "uuid", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/custom-fields-people_getPersonCustomFields_Response_200" } } }, "description": "Successful response" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContainer" } } }, "description": "Operation failed." }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContainer" } } }, "description": "Operation failed." }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContainer" } } }, "description": "Operation failed." }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RetrieveCustomFieldsForAWorker-v2026-01-01RequestNotFoundError" } } }, "description": "Worker not found" }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContainer" } } }, "description": "Operation failed." } }, "security": [ { "deelToken": [] } ], "summary": "Retrieve custom fields for a worker", "tags": [ "customFieldsPeople" ] }, "put": { "description": "Creates or updates a custom field value for a worker; if a value for the specified field already exists it is overwritten.\n\n **Token scopes**: `people:write`", "operationId": "customFieldsPeople_putPersonCustomField", "parameters": [ { "description": "Worker id.", "in": "path", "name": "worker_id", "required": true, "schema": { "format": "uuid", "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "properties": { "data": { "$ref": "#/components/schemas/PeopleWorkerIdCustomFieldsPutRequestBodyContentApplicationJsonSchemaData" } }, "required": [ "data" ], "type": "object" } } } }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/custom-fields-people_putPersonCustomField_Response_200" } } }, "description": "Successful response" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContainer" } } }, "description": "Operation failed." }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContainer" } } }, "description": "Operation failed." }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContainer" } } }, "description": "Operation failed." }, "404": { "content": { "application/json": { "schema": { "description": "Any type" } } }, "description": "Not found" }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContainer" } } }, "description": "Operation failed." } }, "security": [ { "deelToken": [] } ], "summary": "Update custom field value", "tags": [ "customFieldsPeople" ] } }, "/people/{worker_id}/custom_fields/{id}": { "delete": { "description": "Removes a specific custom field value from a worker record by the custom field's ID.\n\n **Token scopes**: `people:write`", "operationId": "customFieldsPeople_deletePersonCustomField", "parameters": [ { "description": "Custom field id.", "in": "path", "name": "id", "required": true, "schema": { "format": "uuid", "type": "string" } }, { "description": "Worker id.", "in": "path", "name": "worker_id", "required": true, "schema": { "format": "uuid", "type": "string" } } ], "responses": { "204": { "content": { "application/json": { "schema": { "properties": {}, "type": "object" } } }, "description": "Successful response" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContainer" } } }, "description": "Operation failed." }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContainer" } } }, "description": "Operation failed." }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContainer" } } }, "description": "Operation failed." }, "404": { "content": { "application/json": { "schema": { "description": "Any type" } } }, "description": "Not found" }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContainer" } } }, "description": "Operation failed." } }, "security": [ { "deelToken": [] } ], "summary": "Delete the custom field value from Worker by Id", "tags": [ "customFieldsPeople" ] } }, "/people/{worker_id}/personal": { "get": { "description": "Returns personal information for a worker by their worker ID.\n\n **Token scopes**: `people:read`", "operationId": "personalInformation_getPersonPersonalInfo", "parameters": [ { "description": "Unique identifier for a worker (External ID).", "in": "path", "name": "worker_id", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/personal-information_getPersonPersonalInfo_Response_200" } } }, "description": "Successful response" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContainer" } } }, "description": "Operation failed." }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContainer" } } }, "description": "Operation failed." }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContainer" } } }, "description": "Operation failed." }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContainer" } } }, "description": "Operation failed." }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetPersonalInformationById-v2026-01-01RequestInternalServerError" } } }, "description": "Internal Server Error" } }, "security": [ { "deelToken": [] } ], "summary": "Get personal information by id", "tags": [ "personalInformation" ] }, "patch": { "description": "Partially updates personal information for a worker by their worker ID; only fields included in the request body are modified.\n\n **Token scopes**: `people:write`", "operationId": "personalInformation_updatePersonPersonalInfo", "parameters": [ { "description": "Unique identifier for a worker.", "in": "path", "name": "worker_id", "required": true, "schema": { "format": "uuid", "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "properties": { "data": { "$ref": "#/components/schemas/PeopleWorkerIdPersonalPatchRequestBodyContentApplicationJsonSchemaData" } }, "required": [ "data" ], "type": "object" } } } }, "responses": { "204": { "content": { "application/json": { "schema": { "properties": {}, "type": "object" } } }, "description": "Successful response" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContainer" } } }, "description": "Operation failed." }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContainer" } } }, "description": "Operation failed." }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContainer" } } }, "description": "Operation failed." }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContainer" } } }, "description": "Operation failed." }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContainer" } } }, "description": "Operation failed." } }, "security": [ { "deelToken": [] } ], "summary": "Update personal information", "tags": [ "personalInformation" ] } }, "/profiles": { "patch": { "description": "Applies a partial update to the authenticated user's profile, modifying only the fields supplied in the request body.\n\n **Token scopes**: `profile:write`, `profile:read`", "operationId": "personalInformation_updateProfile", "requestBody": { "content": { "application/json": { "schema": { "properties": { "data": { "$ref": "#/components/schemas/ProfilesPatchRequestBodyContentApplicationJsonSchemaData" } }, "required": [ "data" ], "type": "object" } } }, "description": "Update profile information for the authenticated user" }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/personal-information_updateProfile_Response_200" } } }, "description": "Successfully updated profile." }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Profiles-v2026-01-01RequestBadRequestError" } } }, "description": "Invalid request parameters." }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContainer" } } }, "description": "Operation failed." }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContainer" } } }, "description": "Operation failed." }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContainer" } } }, "description": "Operation failed." }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContainer" } } }, "description": "Operation failed." } }, "security": [ { "deelToken": [] } ], "summary": "Profiles", "tags": [ "personalInformation" ] } }, "/pwac": { "post": { "description": "Adds a person record in Deel's HRIS without an associated employment contract. It creates a people-only record, allowing you to track individuals in your organization's directory before or without formalizing an employment or agreement. Suitable for pre-boarding, contingent workers, or other scenarios where a contract is not yet applicable.\n\n **Token scopes**: `people:write`", "operationId": "people_createPersonWithoutContract", "requestBody": { "content": { "application/json": { "schema": { "properties": { "data": { "$ref": "#/components/schemas/PwacPostRequestBodyContentApplicationJsonSchemaData" } }, "required": [ "data" ], "type": "object" } } } }, "responses": { "201": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/people_createPersonWithoutContract_Response_201" } } }, "description": "Successful operation." }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreateAPersonWithoutAContract-v2026-01-01RequestBadRequestError" } } }, "description": "Operation failed." }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContainer" } } }, "description": "Operation failed." }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContainer" } } }, "description": "Operation failed." }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContainer" } } }, "description": "Operation failed." }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreateAPersonWithoutAContract-v2026-01-01RequestInternalServerError" } } }, "description": "Operation failed." } }, "security": [ { "deelToken": [] } ], "summary": "Create a person without a contract", "tags": [ "People" ] } }, "/refund-statements": { "get": { "description": "Use this endpoint to retrieve a list of refund statements. This allows review of past transactions and reconciliation of accounts.\n\n **Token scopes**: `accounting:read`", "operationId": "accounting_retrieveRefundStatements-v2026-04-30", "parameters": [ { "description": "Filters results to include payments created on or after this date (in ISO 8601 format).", "in": "query", "name": "date_from", "required": false, "schema": { "format": "date", "type": "string" } }, { "description": "Filters results to include payments created before this date (in ISO 8601 format).", "in": "query", "name": "date_to", "required": false, "schema": { "format": "date", "type": "string" } }, { "description": "A cursor for pagination. Use the value returned in the 'next_cursor' field to get the next page of results.", "in": "query", "name": "cursor", "required": false, "schema": { "type": "string" } }, { "description": "Filters payments by their currency codes. Can be a single currency code or an array of codes.", "in": "query", "name": "currencies", "required": false, "schema": { "items": { "maxLength": 3, "minLength": 3, "pattern": "^[A-Z]{3}$", "type": "string" }, "type": "array" } }, { "description": "Filters payments by legal entity type (e.g., 'individual' or 'company'). Can be a single entity type or an array.", "in": "query", "name": "entities", "required": false, "schema": { "items": { "$ref": "#/components/schemas/RefundStatementsGetParametersEntitiesSchemaItems" }, "type": "array" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Accounting_retrieveRefundStatements-v2026-04-30_Response_200" } } }, "description": "Successfully retrieved refund statements." }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RetrieveRefundStatements-v2026-04-30RequestBadRequestError" } } }, "description": "Operation failed." }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContainer" } } }, "description": "Operation failed." }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RetrieveRefundStatements-v2026-04-30RequestForbiddenError" } } }, "description": "Operation failed." }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContainer" } } }, "description": "Operation failed." }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RetrieveRefundStatements-v2026-04-30RequestInternalServerError" } } }, "description": "Operation failed." } }, "security": [ { "deelToken": [] } ], "summary": "Retrieve refund statements", "tags": [ "accounting" ] } }, "/refund-statements/{refund_statement_id}/breakdown": { "get": { "description": "Use this endpoint to retrieve a detailed breakdown of credit notes associated with a specific refund statement. It provides comprehensive details for financial tracking and reconciliation.\n\n **Token scopes**: `accounting:read`", "operationId": "refundStatements_retrieveRefundStatementCreditNoteBreakdown-v2026-05-11", "parameters": [ { "description": "Public id (`invoice_id`) of the refund statement root invoice.", "in": "path", "name": "refund_statement_id", "required": true, "schema": { "minLength": 1, "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Refund_Statements_retrieveRefundStatementCreditNoteBreakdown-v2026-05-11_Response_200" } } }, "description": "Breakdown succeeded. `data` contains zero or more rows (empty array when there are no child credit notes)." }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RetrieveRefundStatementCreditNoteBreakdown-v2026-05-11RequestBadRequestError" } } }, "description": "Bad request: missing organization context, or request validation failed (e.g. invalid path id format, invalid query types)." }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RetrieveRefundStatementCreditNoteBreakdown-v2026-05-11RequestUnauthorizedError" } } }, "description": "Unauthorized: caller is not authenticated (e.g. missing or invalid session or bearer token)." }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RetrieveRefundStatementCreditNoteBreakdown-v2026-05-11RequestForbiddenError" } } }, "description": "Forbidden (role or feature flag)." }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RetrieveRefundStatementCreditNoteBreakdown-v2026-05-11RequestNotFoundError" } } }, "description": "Statement not found or not accessible." }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RetrieveRefundStatementCreditNoteBreakdown-v2026-05-11RequestInternalServerError" } } }, "description": "Unexpected server failure." } }, "security": [ { "deelToken": [] } ], "summary": "Retrieve refund statement credit-note breakdown", "tags": [ "refundStatements" ] } }, "/registration-document-requirements/{requirement_id}/template": { "get": { "description": "Issues a time-limited download URL for the blank template provided for a document requirement. Some requirements must be submitted on a supplied form; this returns that form so it can be completed and submitted back. Check `requirement.has_template` on a document before calling this endpoint.\n\n **Token scopes**: `legal-entity:read`", "operationId": "documents_downloadLegalEntityRegistrationDocumentRequirementTemplate-v2026-08-17", "parameters": [ { "description": "Public UUID of the document requirement.", "in": "path", "name": "requirement_id", "required": true, "schema": { "format": "uuid", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Documents_downloadLegalEntityRegistrationDocumentRequirementTemplate-v2026-08-17_Response_200" } } }, "description": "Template download URL issued successfully." }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DownloadLegalEntityRegistrationDocumentRequirementTemplate-v2026-08-17RequestBadRequestError" } } }, "description": "Bad request — invalid or missing parameters." }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DownloadLegalEntityRegistrationDocumentRequirementTemplate-v2026-08-17RequestUnauthorizedError" } } }, "description": "Unauthorized — missing or invalid authentication token." }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DownloadLegalEntityRegistrationDocumentRequirementTemplate-v2026-08-17RequestForbiddenError" } } }, "description": "Forbidden — the token lacks access to this legal entity." }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DownloadLegalEntityRegistrationDocumentRequirementTemplate-v2026-08-17RequestNotFoundError" } } }, "description": "Not found." }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContainer" } } }, "description": "Operation failed." } }, "security": [ { "deelToken": [] } ], "summary": "Download Legal Entity Registration Document Requirement Template", "tags": [ "documents" ] } }, "/reports/payroll/cycles/{cycle_id}/gross-to-net": { "get": { "description": "Returns categorized gross-to-net data — including category group, category, sub-category, and label — for each contract within the payroll cycle identified by `cycle_id`.\n\n **Token scopes**: `payslips:read`", "operationId": "reports_getsG2NReportDataForAGivenPayrollCycleByItsId-v2026-01-01", "parameters": [ { "description": "The unique identifier for the payroll event.", "in": "path", "name": "cycle_id", "required": true, "schema": { "format": "uuid", "type": "string" } }, { "description": "Maximum number of items to return. Defaults to 20.", "in": "query", "name": "limit", "required": false, "schema": { "default": 20, "maximum": 100, "minimum": 1, "type": "integer" } }, { "description": "Cursor for pagination of results.", "in": "query", "name": "cursor", "required": false, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Reports_getsG2NReportDataForAGivenPayrollCycleByItsId-v2026-01-01_Response_200" } } }, "description": "Successful operation." }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetsG2NReportDataForAGivenPayrollCycleByItsId-v2026-01-01RequestBadRequestError" } } }, "description": "Bad Request." }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContainer" } } }, "description": "Operation failed." }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContainer" } } }, "description": "Operation failed." }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetsG2NReportDataForAGivenPayrollCycleByItsId-v2026-01-01RequestNotFoundError" } } }, "description": "Resource not found." }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetsG2NReportDataForAGivenPayrollCycleByItsId-v2026-01-01RequestInternalServerError" } } }, "description": "Internal Server Error." } }, "security": [ { "deelToken": [] } ], "summary": "Gets G2N report data for a given payroll cycle by it's ID.", "tags": [ "reports" ] } }, "/roles": { "get": { "description": "Retrieves all roles defined within the current organization.\n\n **Token scopes**: `organizations:read`", "operationId": "organizations_getTheRolesOfTheCurrentOrganization-v2026-01-01", "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Organizations_getTheRolesOfTheCurrentOrganization-v2026-01-01_Response_200" } } }, "description": "Successful retrieval of the organization roles." }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetTheRolesOfTheCurrentOrganization-v2026-01-01RequestBadRequestError" } } }, "description": "Bad request. The request was malformed or missing required parameters." }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetTheRolesOfTheCurrentOrganization-v2026-01-01RequestUnauthorizedError" } } }, "description": "Unauthorized. The request is missing authentication credentials or the credentials provided are invalid." }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContainer" } } }, "description": "Operation failed." }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContainer" } } }, "description": "Operation failed." }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetTheRolesOfTheCurrentOrganization-v2026-01-01RequestInternalServerError" } } }, "description": "Internal server error. An error occurred while processing the request." } }, "security": [ { "deelToken": [] } ], "summary": "Get the roles of the current organization.", "tags": [ "organizations" ] }, "post": { "description": "Creates a new custom role within the current organization.\n\n **Token scopes**: `organizations:write`", "operationId": "organizations_CreateOrganizationRole-v2026-01-01", "requestBody": { "content": { "application/json": { "schema": { "properties": { "data": { "$ref": "#/components/schemas/RolesPostRequestBodyContentApplicationJsonSchemaData" } }, "type": "object" } } } }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Organizations_CreateOrganizationRole-v2026-01-01_Response_200" } } }, "description": "Successful operation" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContainer" } } }, "description": "Operation failed." }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContainer" } } }, "description": "Operation failed." }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContainer" } } }, "description": "Operation failed." }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContainer" } } }, "description": "Operation failed." }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContainer" } } }, "description": "Operation failed." } }, "security": [ { "deelToken": [] } ], "summary": "Create organization custom role.", "tags": [ "organizations" ] } }, "/roles/{roleId}": { "patch": { "description": "Applies a partial update to the custom role, modifying only the fields supplied in the request body.\n\n **Token scopes**: `organizations:write`", "operationId": "organizations_UpdateOrganizationRole-v2026-01-01", "parameters": [ { "description": "ID of the role", "in": "path", "name": "roleId", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "properties": { "data": { "$ref": "#/components/schemas/RolesRoleIdPatchRequestBodyContentApplicationJsonSchemaData" } }, "type": "object" } } } }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Organizations_UpdateOrganizationRole-v2026-01-01_Response_200" } } }, "description": "Successful operation" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContainer" } } }, "description": "Operation failed." }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContainer" } } }, "description": "Operation failed." }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContainer" } } }, "description": "Operation failed." }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContainer" } } }, "description": "Operation failed." }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContainer" } } }, "description": "Operation failed." } }, "security": [ { "deelToken": [] } ], "summary": "Update organization custom role", "tags": [ "organizations" ] } }, "/screenings/aml/{entity_type}/{entity_id}": { "get": { "description": "Returns the most recent AML screening result for the specified entity. The `entity_type` must be one of `profile`, `hris_profile`, or `legal_entity`.\n\n **Token scopes**: `screenings:read`", "operationId": "screenings_getAMLDetails", "parameters": [ { "description": "The type of entity to screen. Only 'profile', 'hris_profile', 'legal_entity' are accepted.", "in": "path", "name": "entity_type", "required": true, "schema": { "$ref": "#/components/schemas/ScreeningsAmlEntityTypeEntityIdGetParametersEntityType" } }, { "description": "UUID v4 of the entity", "in": "path", "name": "entity_id", "required": true, "schema": { "format": "uuid", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/screenings_getAMLDetails_Response_200" } } }, "description": "Details of the screening request for the specified entity type and ID." }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AmlApiForWhitelabelDataRetrieval-v2026-01-01RequestBadRequestError" } } }, "description": "Bad request" }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContainer" } } }, "description": "Operation failed." }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContainer" } } }, "description": "Operation failed." }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AmlApiForWhitelabelDataRetrieval-v2026-01-01RequestNotFoundError" } } }, "description": "Entity not found" }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContainer" } } }, "description": "Operation failed." } }, "security": [ { "deelToken": [] } ], "summary": "Get entity screening details", "tags": [ "Screenings" ] } }, "/screenings/kyc/details": { "get": { "description": "Retrieves KYC verification details for a worker identified by `worker_profile_id` or `profile_id`; these two parameters are mutually exclusive. `contract_id` is required when multiple profiles are associated with the worker.\n\n **Token scopes**: `screenings:read`", "operationId": "screenings_getKYCDetails", "parameters": [ { "description": "Worker's HRIS profile public ID client requests to fetch KYC details for. This parameter is mutually exclusive with profile_id", "in": "query", "name": "worker_profile_id", "required": false, "schema": { "format": "uuid", "type": "string" } }, { "description": "Worker's contract ID. This parameter is required in case there are multiple profiles associated to the target worker. For example, when worker used to work for the former company he had another profile ID. So we need contract ID to properly resolve profile's KYC details. In case this parameter is not provided and multiple associated profiles are found, exception with 409 status code will be thrown", "in": "query", "name": "contract_id", "required": false, "schema": { "maxLength": 100, "type": "string" } }, { "description": "Worker's profile public ID client requests to fetch KYC details for, This parameter is mutually exclusive with worker_profile_id ", "in": "query", "name": "profile_id", "required": false, "schema": { "format": "uuid", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/screenings_getKYCDetails_Response_200" } } }, "description": "KYC details retrieved successfully" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetWorkersKycDetails-v2026-01-01RequestBadRequestError" } } }, "description": "Bad request - Invalid worker profile ID" }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContainer" } } }, "description": "Operation failed." }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetWorkersKycDetails-v2026-01-01RequestForbiddenError" } } }, "description": "Forbidden - User not authorized to access this resource" }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetWorkersKycDetails-v2026-01-01RequestNotFoundError" } } }, "description": "Not Found - We could not extract any profile by the provided hris profile" }, "409": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetWorkersKycDetails-v2026-01-01RequestConflictError" } } }, "description": "Conflict - We found multiple profiles for the provided worker ID. Please provide the contract id to resolve KYC details" }, "412": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetWorkersKycDetails-v2026-01-01RequestPreconditionFailedError" } } }, "description": "Precondition Failed - Could not extract contractor ID from the contract" }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContainer" } } }, "description": "Operation failed." } }, "security": [ { "deelToken": [] } ], "summary": "Get worker's KYC details", "tags": [ "Screenings" ] } }, "/screenings/kyc/external": { "post": { "description": "Submits an external KYC record that combines automated Live ID verification (IDV) with a manual review workflow to satisfy identity verification and compliance requirements.\n\n **Token scopes**: `worker:write`", "operationId": "screenings_submitExternalKyc-v2026-01-01", "requestBody": { "content": { "multipart/form-data": { "schema": { "properties": { "data": { "$ref": "#/components/schemas/ScreeningsKycExternalPostRequestBodyContentMultipartFormDataSchemaData" } }, "required": [ "data" ], "type": "object" } } } }, "responses": { "201": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Screenings_submitExternalKyc-v2026-01-01_Response_201" } } }, "description": "KYC data successfully received" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SubmitExternalKyc-v2026-01-01RequestBadRequestError" } } }, "description": "Operation failed." }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContainer" } } }, "description": "Operation failed." }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContainer" } } }, "description": "Operation failed." }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContainer" } } }, "description": "Operation failed." }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContainer" } } }, "description": "Operation failed." } }, "security": [ { "deelToken": [] } ], "summary": "Submit external KYC", "tags": [ "Screenings" ] } }, "/screenings/manual-verification": { "post": { "description": "Creates a manual identity verification submission as a fallback when automated verification has failed multiple times or when the document's country of issue is not supported by the automated solution.\n\n **Token scopes**: `worker:write`", "operationId": "screenings_createManualVerification", "requestBody": { "content": { "multipart/form-data": { "schema": { "properties": { "additional": { "description": "An additional document", "format": "binary", "type": "string" }, "back": { "description": "The back side of the document", "format": "binary", "type": "string" }, "document_country": { "description": "The issuing country code of the document to be verified (ISO 3166-1 alpha-2)", "maxLength": 2, "minLength": 2, "type": "string" }, "document_type": { "$ref": "#/components/schemas/ScreeningsManualVerificationPostRequestBodyContentMultipartFormDataSchemaDocumentType", "description": "The type of document to be verified" }, "front": { "description": "The front side of the document", "format": "binary", "type": "string" }, "operation_type": { "$ref": "#/components/schemas/ScreeningsManualVerificationPostRequestBodyContentMultipartFormDataSchemaOperationType", "description": "The type of KYC operation to perform" }, "proof_of_residence": { "description": "A proof of residence document", "format": "binary", "type": "string" }, "selfie_with_id": { "description": "A selfie of the user holding the ID document", "format": "binary", "type": "string" }, "translation_required": { "description": "Indicates whether the document requires translation", "type": "boolean" } }, "required": [ "front", "document_type", "operation_type", "selfie_with_id", "translation_required" ], "type": "object" } } } }, "responses": { "201": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/screenings_createManualVerification_Response_201" } } }, "description": "Successful operation" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreateManualVerificationScreening-v2026-01-01RequestBadRequestError" } } }, "description": "Bad Request - Validation error" }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContainer" } } }, "description": "Operation failed." }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContainer" } } }, "description": "Operation failed." }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContainer" } } }, "description": "Operation failed." }, "409": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreateManualVerificationScreening-v2026-01-01RequestConflictError" } } }, "description": "Conflict - There is an existing name change screening pending" }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContainer" } } }, "description": "Operation failed." } }, "security": [ { "deelToken": [] } ], "summary": "Create manual verification screening", "tags": [ "Screenings" ] } }, "/screenings/verification-method": { "get": { "description": "Returns the KYC verification method supported for a given combination of issuing country and document type.\n\n **Token scopes**: `screenings:read`, `worker:read`", "operationId": "screenings_getVerificationMethod", "parameters": [ { "description": "The document's issuing country code (ISO 3166-1 alpha-2)", "in": "query", "name": "country", "required": true, "schema": { "maxLength": 2, "minLength": 2, "type": "string" } }, { "description": "The document to be provided during KYC", "in": "query", "name": "document_type", "required": true, "schema": { "$ref": "#/components/schemas/ScreeningsVerificationMethodGetParametersDocumentType" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/screenings_getVerificationMethod_Response_200" } } }, "description": "Successful operation" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContainer" } } }, "description": "Operation failed." }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContainer" } } }, "description": "Operation failed." }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContainer" } } }, "description": "Operation failed." }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContainer" } } }, "description": "Operation failed." }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContainer" } } }, "description": "Operation failed." } }, "security": [ { "deelToken": [] } ], "summary": "Get verification method", "tags": [ "Screenings" ] } }, "/tasks/{task_id}": { "patch": { "description": "Applies a partial update to the specified task and returns whether the update was successful.\n\n **Token scopes**: `tasks:write`", "operationId": "tasks_updateTaskById-v2026-01-01", "parameters": [ { "description": "The id of an existing task", "in": "path", "name": "task_id", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "properties": { "data": { "$ref": "#/components/schemas/TasksTaskIdPatchRequestBodyContentApplicationJsonSchemaData" } }, "required": [ "data" ], "type": "object" } } }, "description": "Task update object containing fields to modify." }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Tasks_updateTaskById-v2026-01-01_Response_200" } } }, "description": "The task was successfully updated." }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UpdateTaskById-v2026-01-01RequestBadRequestError" } } }, "description": "Operation failed." }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContainer" } } }, "description": "Operation failed." }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContainer" } } }, "description": "Operation failed." }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContainer" } } }, "description": "Operation failed." }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UpdateTaskById-v2026-01-01RequestInternalServerError" } } }, "description": "Operation failed." } }, "security": [ { "deelToken": [] } ], "summary": "Update Task By ID", "tags": [ "Tasks" ] } }, "/teams": { "get": { "description": "Returns the list of teams within the authenticated user's organization, with each entry including the team's ID and name.\n\n **Token scopes**: `organizations:read`", "operationId": "organizations_getTeams-v2026-01-01", "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Organizations_getTeams-v2026-01-01_Response_200" } } }, "description": "Successful retrieval of the teams in the organization." }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContainer" } } }, "description": "Operation failed." }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetTeams-v2026-01-01RequestUnauthorizedError" } } }, "description": "Unauthorized. The request is missing authentication credentials or the credentials provided are invalid." }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContainer" } } }, "description": "Operation failed." }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetTeams-v2026-01-01RequestNotFoundError" } } }, "description": "No teams found. There are no teams associated with the current organization." }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetTeams-v2026-01-01RequestInternalServerError" } } }, "description": "Internal server error. An error occurred on the server while processing the request." } }, "security": [ { "deelToken": [] } ], "summary": "Get Teams", "tags": [ "organizations" ] } }, "/time-offs/policy": { "get": { "description": "Look up an organization's time-off policies, most commonly to resolve a policy_id for use with Get Profiles Assigned to Policy, or to audit policy configuration (allowances, tracking rules) before assigning workers or reviewing compliance. Filter by policy_type to narrow results to the leave categories relevant to your integration; each result's assigned profile count lets you spot unused or over-assigned policies without an extra call.\n\n **Token scopes**: `time-off:read`", "operationId": "timeOff_getPoliciesForOrganization-v2026-09-09", "parameters": [ { "description": "Filter by policy type names", "in": "query", "name": "policy_type", "required": false, "schema": { "items": { "$ref": "#/components/schemas/TimeOffsPolicyGetParametersPolicyTypeSchemaItems" }, "type": "array" } }, { "description": "Filter by policy name (case-insensitive search)", "in": "query", "name": "policy_name", "required": false, "schema": { "type": "string" } }, { "description": "Filter by country codes", "in": "query", "name": "country", "required": false, "schema": { "items": { "type": "string" }, "type": "array" } }, { "description": "Filter by state/region codes", "in": "query", "name": "state_or_region", "required": false, "schema": { "items": { "type": "string" }, "type": "array" } }, { "description": "Filter by worker types", "in": "query", "name": "worker_types_assigned", "required": false, "schema": { "items": { "type": "string" }, "type": "array" } }, { "description": "Filter by assignment status", "in": "query", "name": "has_workers_assigned", "required": false, "schema": { "type": "boolean" } }, { "description": "Items per page (max 50)", "in": "query", "name": "page_size", "required": false, "schema": { "maximum": 50, "minimum": 1, "type": "integer" } }, { "description": "Pagination token from the previous response (next)", "in": "query", "name": "next", "required": false, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Time_Off_getPoliciesForOrganization-v2026-09-09_Response_200" } } }, "description": "Paginated list of policies." }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetPoliciesForOrganization-v2026-09-09RequestBadRequestError" } } }, "description": "Bad request (invalid page_size or query parameters)." }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetPoliciesForOrganization-v2026-09-09RequestUnauthorizedError" } } }, "description": "Unauthorized (missing or invalid token)." }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetPoliciesForOrganization-v2026-09-09RequestForbiddenError" } } }, "description": "Forbidden (insufficient permissions)." }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContainer" } } }, "description": "Operation failed." }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetPoliciesForOrganization-v2026-09-09RequestInternalServerError" } } }, "description": "Server error." } }, "security": [ { "deelToken": [] } ], "summary": "Get Policies for Organization", "tags": [ "timeOff" ] } }, "/time-offs/policy/{policy_id}/assignments": { "get": { "description": "Use this after resolving a policy_id via Get All Policies to see which workers are covered by a specific time-off policy — for example, to verify coverage before running payroll, audit compliance, or reconcile assignments following a policy change. Paginate through large populations with page_size and the next cursor.\n\n **Token scopes**: `time-off:read`", "operationId": "timeOff_getProfilesAssignedToPolicy-v2026-09-09", "parameters": [ { "description": "Policy UID, as returned by the Get Policies for Organization endpoint", "in": "path", "name": "policy_id", "required": true, "schema": { "format": "uuid", "type": "string" } }, { "description": "Items per page (max 100)", "in": "query", "name": "page_size", "required": false, "schema": { "maximum": 100, "minimum": 1, "type": "integer" } }, { "description": "Pagination cursor", "in": "query", "name": "next", "required": false, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Time_Off_getProfilesAssignedToPolicy-v2026-09-09_Response_200" } } }, "description": "Paginated list of profiles assigned to the policy." }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetProfilesAssignedToPolicy-v2026-09-09RequestBadRequestError" } } }, "description": "Bad request (invalid policy ID format or page_size)." }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetProfilesAssignedToPolicy-v2026-09-09RequestUnauthorizedError" } } }, "description": "Unauthorized (missing or invalid token)." }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetProfilesAssignedToPolicy-v2026-09-09RequestForbiddenError" } } }, "description": "Forbidden (insufficient permissions)." }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetProfilesAssignedToPolicy-v2026-09-09RequestNotFoundError" } } }, "description": "Not found (policy not found for this organization)." }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetProfilesAssignedToPolicy-v2026-09-09RequestInternalServerError" } } }, "description": "Server error." } }, "security": [ { "deelToken": [] } ], "summary": "Get Profiles Assigned to Policy", "tags": [ "timeOff" ] } }, "/time-tracking/timesheets/upload-url": { "post": { "description": "Accepts timesheet file metadata and returns a pre-signed `upload_url` together with a new timesheet record `id`. Currently limited to EOR contracts.\n\n **Token scopes**: `time-tracking:write`", "operationId": "timeTracking_getTimeTrackingTimesheetsUploadUrl", "requestBody": { "content": { "application/json": { "schema": { "properties": { "data": { "$ref": "#/components/schemas/TimeTrackingTimesheetsUploadUrlPostRequestBodyContentApplicationJsonSchemaData" } }, "required": [ "data" ], "type": "object" } } }, "description": "timesheet information needed for uploading timesheet file" }, "responses": { "201": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/time-tracking_getTimeTrackingTimesheetsUploadUrl_Response_201" } } }, "description": "Timesheet created successfully. Returns upload URL, upload form fields, and timesheet ID." }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GenerateTimesheetUploadUrl-v2026-01-01RequestBadRequestError" } } }, "description": "Bad request. Validation or business rule violation (e.g., non-EOR contract, invalid date range)." }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContainer" } } }, "description": "Operation failed." }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContainer" } } }, "description": "Operation failed." }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GenerateTimesheetUploadUrl-v2026-01-01RequestNotFoundError" } } }, "description": "Resource not found." }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GenerateTimesheetUploadUrl-v2026-01-01RequestUnprocessableEntityError" } } }, "description": "Unprocessable entity. Business logic constraint violation." }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContainer" } } }, "description": "Operation failed." } }, "security": [ { "deelToken": [] } ], "summary": "Generate timesheet upload url", "tags": [ "timeTracking" ] } }, "/time-tracking/timesheets/{timesheet_id}": { "get": { "description": "Retrieves a timesheet by `timesheet_id`, including its submission, review, and processing status. Pass `expand=file_data` to include file name and download URL in the response.\n\n **Token scopes**: `time-tracking:read`", "operationId": "timeTracking_getTimeTrackingTimesheetById", "parameters": [ { "description": "ID of the timesheet to fetch file for", "in": "path", "name": "timesheet_id", "required": true, "schema": { "format": "uuid", "type": "string" } }, { "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.", "in": "query", "name": "extend", "required": false, "schema": { "maxLength": 100, "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/time-tracking_getTimeTrackingTimesheetById_Response_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." }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContainer" } } }, "description": "Operation failed." }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContainer" } } }, "description": "Operation failed." }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContainer" } } }, "description": "Operation failed." }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RetrieveATimesheet-v2026-01-01RequestNotFoundError" } } }, "description": "Timesheet not found." }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContainer" } } }, "description": "Operation failed." } }, "security": [ { "deelToken": [] } ], "summary": "Retrieve a timesheet", "tags": [ "timeTracking" ] } }, "/time-tracking/timesheets/{timesheet_id}/review": { "post": { "description": "Approves or rejects a submitted timesheet; only timesheets in `PENDING_REVIEW` status are eligible, and all associated hours are approved or rejected as a single operation.\n\n **Token scopes**: `time-tracking:write`", "operationId": "timeTracking_reviewTimeTrackingTimesheet", "parameters": [ { "description": "ID of the timesheet to review", "in": "path", "name": "timesheet_id", "required": true, "schema": { "format": "uuid", "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "properties": { "data": { "$ref": "#/components/schemas/TimeTrackingTimesheetsTimesheetIdReviewPostRequestBodyContentApplicationJsonSchemaData" } }, "required": [ "data" ], "type": "object" } } }, "description": "Review information for the timesheet. review_reason is required when review_status is REJECTED." }, "responses": { "201": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/time-tracking_reviewTimeTrackingTimesheet_Response_201" } } }, "description": "Timesheet reviewed successfully. Returns updated timesheet details with review status and review timestamp." }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContainer" } } }, "description": "Operation failed." }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContainer" } } }, "description": "Operation failed." }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContainer" } } }, "description": "Operation failed." }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ReviewASubmittedTimesheet-v2026-01-01RequestNotFoundError" } } }, "description": "Timesheet not found." }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ReviewASubmittedTimesheet-v2026-01-01RequestUnprocessableEntityError" } } }, "description": "Unprocessable entity. Timesheet cannot be reviewed in its current state." }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContainer" } } }, "description": "Operation failed." } }, "security": [ { "deelToken": [] } ], "summary": "Review a submitted timesheet", "tags": [ "timeTracking" ] } }, "/time_offs": { "get": { "description": "Returns time-off requests across the entire authenticated organization; to list a single worker's requests, use GET /rest/time_offs/profile/{hris_profile_id} instead. Intended for bulk synchronization or auditing into an external HRIS, payroll, or reporting system. Only requests belonging to workers with an active primary employment are returned, and pending requests are included alongside approved and closed ones unless you filter by status.\n\n **Token scopes**: `time-off:read`", "operationId": "timeOff_listTimeOffRequestsForOrganization-v2026-01-01", "parameters": [ { "description": "Time off status", "in": "query", "name": "status", "required": false, "schema": { "items": { "$ref": "#/components/schemas/TimeOffsGetParametersStatusSchemaItems" }, "type": "array" } }, { "description": "Time off ids", "in": "query", "name": "time_off_ids", "required": false, "schema": { "items": { "format": "uuid", "type": "string" }, "type": "array" } }, { "description": "Start date of time off", "in": "query", "name": "start_date", "required": false, "schema": { "format": "date-time", "type": "string" } }, { "description": "End date of time off", "in": "query", "name": "end_date", "required": false, "schema": { "format": "date-time", "type": "string" } }, { "description": "Approval start date", "in": "query", "name": "approval_start_date", "required": false, "schema": { "format": "date-time", "type": "string" } }, { "description": "Approval end date", "in": "query", "name": "approval_end_date", "required": false, "schema": { "format": "date-time", "type": "string" } }, { "description": "Updated start date", "in": "query", "name": "updated_start_date", "required": false, "schema": { "format": "date-time", "type": "string" } }, { "description": "Updated end date", "in": "query", "name": "updated_end_date", "required": false, "schema": { "format": "date-time", "type": "string" } }, { "description": "Page size", "in": "query", "name": "page_size", "required": false, "schema": { "maximum": 200, "minimum": 5, "type": "integer" } }, { "description": "Policy types", "in": "query", "name": "policy_types", "required": false, "schema": { "items": { "format": "uuid", "type": "string" }, "type": "array" } }, { "description": "Filter by policy type names. When omitted, Work Location time-offs are excluded by default. Pass policy_type_names=Work+Location to retrieve only Work Location entries.", "in": "query", "name": "policy_type_names", "required": false, "schema": { "items": { "$ref": "#/components/schemas/TimeOffsGetParametersPolicyTypeNamesSchemaItems" }, "type": "array" } }, { "description": "Next page", "in": "query", "name": "next", "required": false, "schema": { "type": "string" } }, { "description": "When true, includes soft-deleted time-off records in the response. Deleted records will have a deleted_at timestamp and status DELETED.", "in": "query", "name": "include_deleted_time_offs", "required": false, "schema": { "default": false, "type": "boolean" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Time_Off_listTimeOffRequestsForOrganization-v2026-01-01_Response_200" } } }, "description": "Successful operation time offs returned" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ListTimeOffRequestsForOrganization-v2026-01-01RequestBadRequestError" } } }, "description": "Bad request (invalid query parameters or validation error)." }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ListTimeOffRequestsForOrganization-v2026-01-01RequestUnauthorizedError" } } }, "description": "Unauthorized (missing or invalid token)." }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ListTimeOffRequestsForOrganization-v2026-01-01RequestForbiddenError" } } }, "description": "Forbidden (insufficient permissions)." }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ListTimeOffRequestsForOrganization-v2026-01-01RequestNotFoundError" } } }, "description": "Not found (organization or HRIS profile not found)." }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ListTimeOffRequestsForOrganization-v2026-01-01RequestInternalServerError" } } }, "description": "Internal server error." } }, "security": [ { "deelToken": [] } ], "summary": "List time-off requests for Organization", "tags": [ "timeOff" ] }, "post": { "description": "Submits a new time-off request for a worker under a given policy. Use `POST /rest/time_offs/validate` first to confirm eligibility, balances, and any required custom-field answers, since the request must satisfy the policy's validation rules to succeed. Requests stay in `REQUESTED` status until approved or rejected via `POST /rest/time_offs/review` — unless `use_deel_approval_flow` is set to `true`, which routes the request through Deel's own approval flow instead.\n\n **Token scopes**: `time-off:write`, `worker:write`", "operationId": "timeOff_createTimeOffRequest", "requestBody": { "content": { "application/json": { "schema": { "properties": { "data": { "$ref": "#/components/schemas/TimeOffsPostRequestBodyContentApplicationJsonSchemaData", "description": "The time off request data" } }, "type": "object" } } }, "description": "The time off request data" }, "responses": { "201": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/time-off_createTimeOffRequest_Response_201" } } }, "description": "Time off creation data" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreateTimeOffRequest-v2026-01-01RequestBadRequestError" } } }, "description": "Bad Request" }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContainer" } } }, "description": "Operation failed." }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreateTimeOffRequest-v2026-01-01RequestForbiddenError" } } }, "description": "Forbidden" }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreateTimeOffRequest-v2026-01-01RequestNotFoundError" } } }, "description": "Not Found" }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContainer" } } }, "description": "Operation failed." } }, "security": [ { "deelToken": [] } ], "summary": "Create time-off request", "tags": [ "timeOff" ] } }, "/time_offs/attachments/{attachment_id}/download": { "get": { "description": "Returns a short-lived presigned URL to download a time-off attachment. The attachment_id is the id field returned in the attachments array of time-off responses.\n\n **Token scopes**: `time-off:read`", "operationId": "timeOff_getTimeOffAttachmentDownloadUrl-v2026-07-31", "parameters": [ { "description": "Time-off attachment id (the id field from the attachments array in time-off responses)", "in": "path", "name": "attachment_id", "required": true, "schema": { "format": "uuid", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Time_Off_getTimeOffAttachmentDownloadUrl-v2026-07-31_Response_200" } } }, "description": "Presigned download URL for the time-off attachment" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContainer" } } }, "description": "Operation failed." }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContainer" } } }, "description": "Operation failed." }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetTimeOffAttachmentDownloadUrl-v2026-07-31RequestForbiddenError" } } }, "description": "Forbidden — caller is not the recipient, direct manager, or an approver for this time off" }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetTimeOffAttachmentDownloadUrl-v2026-07-31RequestNotFoundError" } } }, "description": "Attachment not found or not in the caller's organization" }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContainer" } } }, "description": "Operation failed." } }, "security": [ { "deelToken": [] } ], "summary": "Get time-off attachment download URL", "tags": [ "timeOff" ] } }, "/time_offs/dailies": { "get": { "description": "Returns holidays, work schedule entries, and time-off dailies for a given date range, scoped to one or more HRIS profile IDs or countries.\n\n **Token scopes**: `time-off:read`", "operationId": "timeOff_getTimeOffDailies", "parameters": [ { "description": "Start date of non working days date range", "in": "query", "name": "start_date", "required": false, "schema": { "format": "date", "type": "string" } }, { "description": "End date of non working days date range", "in": "query", "name": "end_date", "required": false, "schema": { "format": "date", "type": "string" } }, { "description": "HRIS profile ids", "in": "query", "name": "hris_profile_ids", "required": false, "schema": { "items": { "format": "uuid", "type": "string" }, "type": "array" } }, { "description": "List of countries to be fetched", "in": "query", "name": "countries", "required": false, "schema": { "items": { "maxLength": 2, "minLength": 2, "pattern": "^[A-Z]{2}$", "type": "string" }, "type": "array" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/time-off_getTimeOffDailies_Response_200" } } }, "description": "Successful operation." }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetWorkScheduleAndHolidays-v2026-01-01RequestBadRequestError" } } }, "description": "Operation failed." }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContainer" } } }, "description": "Operation failed." }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContainer" } } }, "description": "Operation failed." }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContainer" } } }, "description": "Operation failed." }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContainer" } } }, "description": "Operation failed." } }, "security": [ { "deelToken": [] } ], "summary": "Get Work Schedule and Holidays", "tags": [ "timeOff" ] } }, "/time_offs/global-payroll/sync": { "post": { "description": "Synchronizes time-off requests from an external HRIS into Deel for Global Payroll contracts only. Each record is upserted or deleted based on its external ID — records carrying `deleted: true` are removed while all others are inserted or updated — and Deel calculates the payroll cycle impact of each operation.\n\n **Token scopes**: `time-off:write`", "operationId": "timeOff_syncTimeOffGlobalPayroll", "requestBody": { "content": { "application/json": { "schema": { "properties": { "data": { "$ref": "#/components/schemas/TimeOffsGlobalPayrollSyncPostRequestBodyContentApplicationJsonSchemaData" } }, "type": "object" } } } }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/time-off_syncTimeOffGlobalPayroll_Response_200" } } }, "description": "Successful operation time offs returned" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ExternalHrTimeOffSynchronization-v2026-01-01RequestBadRequestError" } } }, "description": "Operation failed." }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContainer" } } }, "description": "Operation failed." }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContainer" } } }, "description": "Operation failed." }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContainer" } } }, "description": "Operation failed." }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContainer" } } }, "description": "Operation failed." } }, "security": [ { "deelToken": [] } ], "summary": "Process time-off requests from an external HRIS", "tags": [ "timeOff" ] } }, "/time_offs/policy-validation-templates": { "get": { "description": "Returns policy validation templates and policy types for one or more countries, specified as ISO 3166-1 alpha-2 codes. Policy types in the response are unique across the result set.\n\n **Token scopes**: `time-off:read`", "operationId": "timeOff_getTimeOffPolicyValidationTemplates", "parameters": [ { "description": "List of countries (ISO 3166-1 alpha-2 codes) to fetch policy templates and types for.", "in": "query", "name": "countries", "required": true, "schema": { "items": { "maxLength": 2, "minLength": 2, "pattern": "^[A-Z]{2}$", "type": "string" }, "type": "array" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/time-off_getTimeOffPolicyValidationTemplates_Response_200" } } }, "description": "Successful operation." }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RetrievePolicyValidationTemplates-v2026-01-01RequestBadRequestError" } } }, "description": "Operation failed." }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContainer" } } }, "description": "Operation failed." }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContainer" } } }, "description": "Operation failed." }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContainer" } } }, "description": "Operation failed." }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContainer" } } }, "description": "Operation failed." } }, "security": [ { "deelToken": [] } ], "summary": "Retrieve policy validation templates", "tags": [ "timeOff" ] } }, "/time_offs/profile/{hris_profile_id}": { "get": { "description": "Use this endpoint to retrieve a specific worker's time-off history or upcoming requests — e.g. to build a worker-facing view, check availability before scheduling, or reconcile attendance during payroll. Unlike GET /rest/time_offs, which lists requests org-wide, this scopes to a single hris_profile_id. Combine the status, policy, and date-range filters to narrow results, and page through history with page_size and next.\n\n **Token scopes**: `time-off:read`", "operationId": "timeOff_getTimeOffProfile", "parameters": [ { "description": "HRIS profile id", "in": "path", "name": "hris_profile_id", "required": true, "schema": { "format": "uuid", "type": "string" } }, { "description": "Time off status", "in": "query", "name": "status", "required": false, "schema": { "items": { "$ref": "#/components/schemas/TimeOffsProfileHrisProfileIdGetParametersStatusSchemaItems" }, "type": "array" } }, { "description": "Time off ids", "in": "query", "name": "time_off_ids", "required": false, "schema": { "items": { "format": "uuid", "type": "string" }, "type": "array" } }, { "description": "Start date of time off", "in": "query", "name": "start_date", "required": false, "schema": { "format": "date-time", "type": "string" } }, { "description": "End date of time off", "in": "query", "name": "end_date", "required": false, "schema": { "format": "date-time", "type": "string" } }, { "description": "Approval start date", "in": "query", "name": "approval_start_date", "required": false, "schema": { "format": "date-time", "type": "string" } }, { "description": "Approval end date", "in": "query", "name": "approval_end_date", "required": false, "schema": { "format": "date-time", "type": "string" } }, { "description": "Updated start date", "in": "query", "name": "updated_start_date", "required": false, "schema": { "format": "date-time", "type": "string" } }, { "description": "Updated end date", "in": "query", "name": "updated_end_date", "required": false, "schema": { "format": "date-time", "type": "string" } }, { "description": "Page size", "in": "query", "name": "page_size", "required": false, "schema": { "maximum": 200, "minimum": 5, "type": "integer" } }, { "description": "Policy types", "in": "query", "name": "policy_types", "required": false, "schema": { "items": { "format": "uuid", "type": "string" }, "type": "array" } }, { "description": "Filter by policy type names. When omitted, Work Location time-offs are excluded by default. Pass policy_type_names=Work+Location to retrieve only Work Location entries.", "in": "query", "name": "policy_type_names", "required": false, "schema": { "items": { "$ref": "#/components/schemas/TimeOffsProfileHrisProfileIdGetParametersPolicyTypeNamesSchemaItems" }, "type": "array" } }, { "description": "Next page", "in": "query", "name": "next", "required": false, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/time-off_getTimeOffProfile_Response_200" } } }, "description": "Successful operation time offs returned" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ListTimeOffRequests-v2026-01-01RequestBadRequestError" } } }, "description": "Operation failed." }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContainer" } } }, "description": "Operation failed." }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContainer" } } }, "description": "Operation failed." }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContainer" } } }, "description": "Operation failed." }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContainer" } } }, "description": "Operation failed." } }, "security": [ { "deelToken": [] } ], "summary": "List time-off requests", "tags": [ "timeOff" ] } }, "/time_offs/profile/{hris_profile_id}/entitlements": { "get": { "description": "Use this endpoint to check a worker's current leave balance — total entitlement granted, days used, and days remaining — across all active policies for a given tracking period. Call it before approving a leave request to verify available balance, to surface entitlement data in an HR portal, or to sync leave balances to an external system. Filter by `policy_type_name` to scope results to a specific leave category, or pass `tracking_period_date` to retrieve the balance as of a past tracking period.\n\n **Token scopes**: `time-off:read`", "operationId": "timeOff_getTimeOffEntitlements", "parameters": [ { "description": "HRIS profile ID", "in": "path", "name": "hris_profile_id", "required": true, "schema": { "format": "uuid", "type": "string" } }, { "description": "Policy type name", "in": "query", "name": "policy_type_name", "required": false, "schema": { "$ref": "#/components/schemas/TimeOffsProfileHrisProfileIdEntitlementsGetParametersPolicyTypeName" } }, { "description": "Tracking period date", "in": "query", "name": "tracking_period_date", "required": false, "schema": { "format": "date", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/time-off_getTimeOffEntitlements_Response_200" } } }, "description": "Successful response" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetProfileEntitlements-v2026-01-01RequestBadRequestError" } } }, "description": "Operation failed." }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContainer" } } }, "description": "Operation failed." }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContainer" } } }, "description": "Operation failed." }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContainer" } } }, "description": "Operation failed." }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContainer" } } }, "description": "Operation failed." } }, "security": [ { "deelToken": [] } ], "summary": "Get Profile Entitlements", "tags": [ "timeOff" ] } }, "/time_offs/profile/{hris_profile_id}/policies": { "get": { "description": "Returns the time-off policies assigned to the specified hris_profile_id, including policy details such as allowed types, accrual rules, balances and required attachments or custom fields. Use this before creating a time-off request so you know upfront whether the request needs custom field values.\n\n **Token scopes**: `time-off:read`", "operationId": "timeOff_getTimeOffPolicies", "parameters": [ { "description": "hrisProfileId id.", "in": "path", "name": "hris_profile_id", "required": true, "schema": { "format": "uuid", "type": "string" } }, { "description": "Policy type name.", "in": "query", "name": "policy_type_name", "required": false, "schema": { "$ref": "#/components/schemas/TimeOffsProfileHrisProfileIdPoliciesGetParametersPolicyTypeName" } }, { "description": "policy type id", "in": "query", "name": "policy_type_id", "required": false, "schema": { "format": "uuid", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/time-off_getTimeOffPolicies_Response_200" } } }, "description": "Successful operation." }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContainer" } } }, "description": "Operation failed." }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContainer" } } }, "description": "Operation failed." }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContainer" } } }, "description": "Operation failed." }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ListPolicies-v2026-01-01RequestNotFoundError" } } }, "description": "Not Found - Resource not found" }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContainer" } } }, "description": "Operation failed." } }, "security": [ { "deelToken": [] } ], "summary": "List policies", "tags": [ "timeOff" ] } }, "/time_offs/review": { "post": { "description": "Approves or rejects a batch of time-off requests in a single call. The desired status must be either APPROVED or REJECTED for each entry. Only time-offs currently in REQUESTED status can be reviewed; entries in any other status are returned as not reviewed. Rejecting a time-off request is irreversible: once rejected, its status cannot be changed through this API. The response distinguishes successfully processed requests from those that encountered errors.\n\n **Token scopes**: `time-off:write`", "operationId": "timeOff_reviewTimeOffRequest", "requestBody": { "content": { "application/json": { "schema": { "properties": { "data": { "description": "Array of time-offs to be reviewed", "items": { "$ref": "#/components/schemas/TimeOffsReviewPostRequestBodyContentApplicationJsonSchemaDataItems" }, "type": "array" } }, "required": [ "data" ], "type": "object" } } } }, "responses": { "201": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/time-off_reviewTimeOffRequest_Response_201" } } }, "description": "Review process completed successfully" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApproveRejectTimeOffRequests-v2026-01-01RequestBadRequestError" } } }, "description": "Operation failed." }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContainer" } } }, "description": "Operation failed." }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContainer" } } }, "description": "Operation failed." }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContainer" } } }, "description": "Operation failed." }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContainer" } } }, "description": "Operation failed." } }, "security": [ { "deelToken": [] } ], "summary": "Approve or reject time-off requests", "tags": [ "timeOff" ] } }, "/time_offs/time-off-events": { "get": { "description": "Returns time-off events for a worker profile identified by hris_profile_id, with optional filtering by time_off_type_id or policy_id.\n\n **Token scopes**: `time-off:read`", "operationId": "timeOff_getTimeOffEvents", "parameters": [ { "description": "Worker hris profile id", "in": "query", "name": "hris_profile_id", "required": true, "schema": { "format": "uuid", "type": "string" } }, { "description": "Time off type id", "in": "query", "name": "time_off_type_id", "required": false, "schema": { "format": "uuid", "type": "string" } }, { "description": "Policy id", "in": "query", "name": "policy_id", "required": false, "schema": { "format": "uuid", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/time-off_getTimeOffEvents_Response_200" } } }, "description": "List of time off events for the profile" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetTimeOffEventsForProfile-v2026-01-01RequestBadRequestError" } } }, "description": "Operation failed." }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContainer" } } }, "description": "Operation failed." }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContainer" } } }, "description": "Operation failed." }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContainer" } } }, "description": "Operation failed." }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContainer" } } }, "description": "Operation failed." } }, "security": [ { "deelToken": [] } ], "summary": "Get Time Off Events for Profile", "tags": [ "timeOff" ] } }, "/time_offs/validate": { "post": { "description": "Validates a time-off request against policy compliance, available balance, blackout dates, and other rules before the request is created. Call this ahead of submitting the actual time-off request to catch validation errors early and avoid a failed creation attempt.\n\n **Token scopes**: `time-off:read`", "operationId": "timeOff_validateTimeOff", "requestBody": { "content": { "application/json": { "schema": { "properties": { "data": { "$ref": "#/components/schemas/TimeOffsValidatePostRequestBodyContentApplicationJsonSchemaData", "description": "Time off request data" } }, "type": "object" } } }, "description": "Time off request data" }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/time-off_validateTimeOff_Response_200" } } }, "description": "Time off request validation result" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ValidateTimeOffRequest-v2026-01-01RequestBadRequestError" } } }, "description": "Operation failed." }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContainer" } } }, "description": "Operation failed." }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContainer" } } }, "description": "Operation failed." }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContainer" } } }, "description": "Operation failed." }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContainer" } } }, "description": "Operation failed." } }, "security": [ { "deelToken": [] } ], "summary": "Validate time-off request", "tags": [ "timeOff" ] } }, "/time_offs/{time_off_id}": { "delete": { "description": "Cancels the time-off request identified by time_off_id. Use this when a previously submitted or approved time off needs to be withdrawn. This action immediately sets the request to CANCELED regardless of its current status and cannot be reversed.\n\n **Token scopes**: `time-off:write`, `worker:write`", "operationId": "timeOff_deleteTimeOffRequest", "parameters": [ { "description": "Time off request id", "in": "path", "name": "time_off_id", "required": true, "schema": { "format": "uuid", "type": "string" } } ], "responses": { "204": { "content": { "application/json": { "schema": { "properties": {}, "type": "object" } } }, "description": "time off deleted" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContainer" } } }, "description": "Operation failed." }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContainer" } } }, "description": "Operation failed." }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContainer" } } }, "description": "Operation failed." }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CancelTimeOffRequest-v2026-01-01RequestNotFoundError" } } }, "description": "Not Found" }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContainer" } } }, "description": "Operation failed." } }, "security": [ { "deelToken": [] } ], "summary": "Cancel time-off request", "tags": [ "timeOff" ] }, "patch": { "description": "Corrects details of an existing time-off request, such as its dates, amount, reason, or time-off type, without requiring the worker to cancel and resubmit it. Applies a partial update identified by time_off_id; only fields included in the request body are modified.\n\n **Token scopes**: `time-off:write`, `worker:write`", "operationId": "timeOff_updateTimeOffRequest", "parameters": [ { "description": "Time off request id", "in": "path", "name": "time_off_id", "required": true, "schema": { "format": "uuid", "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "properties": { "data": { "$ref": "#/components/schemas/TimeOffsTimeOffIdPatchRequestBodyContentApplicationJsonSchemaData", "description": "Time off update request data" } }, "type": "object" } } }, "description": "Time off update request data" }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/time-off_updateTimeOffRequest_Response_200" } } }, "description": "Time off updated" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UpdateTimeOffRequest-v2026-01-01RequestBadRequestError" } } }, "description": "Bad Request" }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContainer" } } }, "description": "Operation failed." }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContainer" } } }, "description": "Operation failed." }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContainer" } } }, "description": "Operation failed." }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContainer" } } }, "description": "Operation failed." } }, "security": [ { "deelToken": [] } ], "summary": "Update time-off request", "tags": [ "timeOff" ] } }, "/time_tracking/shift_rates/{external_id}": { "delete": { "description": "Deletes a shift rate identified by its external_id, which is the custom identifier assigned at creation time. Deletion is blocked if the shift rate is currently associated with any active shift.\n\n **Token scopes**: `time-tracking:write`", "operationId": "timeTracking_deleteTimeTrackingShiftRateByExternalId", "parameters": [ { "description": "external ID", "in": "path", "name": "external_id", "required": true, "schema": { "type": "string" } } ], "responses": { "204": { "content": { "application/json": { "schema": { "properties": {}, "type": "object" } } }, "description": "Successfully deleted" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContainer" } } }, "description": "Operation failed." }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContainer" } } }, "description": "Operation failed." }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContainer" } } }, "description": "Operation failed." }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContainer" } } }, "description": "Operation failed." } }, "security": [ { "deelToken": [] } ], "summary": "Delete a Shift Rate by external ID", "tags": [ "timeTracking" ] }, "get": { "description": "Retrieves a shift rate.\n\n **Token scopes**: `time-tracking:read`", "operationId": "timeTracking_getTimeTrackingShiftRateByExternalId", "parameters": [ { "description": "The unique external identifier of the shift rate to retrieve.", "in": "path", "name": "external_id", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/time-tracking_getTimeTrackingShiftRateByExternalId_Response_200" } } }, "description": "Shift rate retrieved successfully." }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContainer" } } }, "description": "Operation failed." }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContainer" } } }, "description": "Operation failed." } }, "security": [ { "deelToken": [] } ], "summary": "Retrieve a Shift Rate by External ID", "tags": [ "timeTracking" ] }, "patch": { "description": "Updates the name, type, or value of an existing shift rate. This is rejected once the rate is referenced by any shift — remove or reassign those shifts first.\n\n **Token scopes**: `time-tracking:write`", "operationId": "timeTracking_updateTimeTrackingShiftRateByExternalId", "parameters": [ { "description": "Unique identifier of the shift rate to be updated.", "in": "path", "name": "external_id", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "properties": { "data": { "$ref": "#/components/schemas/TimeTrackingShiftRatesExternalIdPatchRequestBodyContentApplicationJsonSchemaData" } }, "required": [ "data" ], "type": "object" } } }, "description": "Update an existing shift rate policy" }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/time-tracking_updateTimeTrackingShiftRateByExternalId_Response_200" } } }, "description": "Shift rate updated successfully" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UpdateAShiftRate-v2026-01-01RequestBadRequestError" } } }, "description": "Invalid request payload" }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContainer" } } }, "description": "Operation failed." }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContainer" } } }, "description": "Operation failed." }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContainer" } } }, "description": "Operation failed." }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContainer" } } }, "description": "Operation failed." } }, "security": [ { "deelToken": [] } ], "summary": "Update a Shift Rate", "tags": [ "timeTracking" ] } }, "/time_tracking/shifts/{external_id}": { "delete": { "description": "Permanently deletes a shift identified by its external_id. Once deleted, the shift cannot be retrieved or modified. Deletion is blocked once the payroll cycle the shift belongs to has closed.\n\n **Token scopes**: `time-tracking:write`", "operationId": "timeTrackingShifts_deleteTimeTrackingShiftByExternalId", "parameters": [ { "description": "The unique external identifier of the shift to be deleted.", "in": "path", "name": "external_id", "required": true, "schema": { "type": "string" } } ], "responses": { "204": { "content": { "application/json": { "schema": { "properties": {}, "type": "object" } } }, "description": "Shift deleted successfully. No content is returned." }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContainer" } } }, "description": "Operation failed." } }, "security": [ { "deelToken": [] } ], "summary": "Delete a Shift by External ID", "tags": [ "timeTrackingShifts" ] }, "get": { "description": "Retrieves the details of a specific shift.\n\n **Token scopes**: `time-tracking:read`", "operationId": "timeTrackingShifts_getTimeTrackingShiftByExternalId", "parameters": [ { "description": "Unique identifier of the shift to retrieve.", "in": "path", "name": "external_id", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/time-tracking-shifts_getTimeTrackingShiftByExternalId_Response_200" } } }, "description": "Shift details retrieved successfully" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetShiftDetails-v2026-01-01RequestBadRequestError" } } }, "description": "Invalid request parameters" }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContainer" } } }, "description": "Operation failed." }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContainer" } } }, "description": "Operation failed." }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContainer" } } }, "description": "Operation failed." }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContainer" } } }, "description": "Operation failed." } }, "security": [ { "deelToken": [] } ], "summary": "Get Shift details", "tags": [ "timeTrackingShifts" ] }, "patch": { "description": "Applies a partial update to an existing shift, modifying only the fields supplied in the request body. Fields omitted from the request are left unchanged. Correction shifts cannot be updated through this endpoint, the update is blocked once the payroll cycle the shift belongs to has closed, and `summary.shift_rate_external_id` cannot be repointed to a shift rate of a different type than the shift currently has.\n\n **Token scopes**: `time-tracking:write`", "operationId": "timeTrackingShifts_updateTimeTrackingShiftByExternalId", "parameters": [ { "description": "Unique identifier of the shift to be updated.", "in": "path", "name": "external_id", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "properties": { "data": { "$ref": "#/components/schemas/TimeTrackingShiftsExternalIdPatchRequestBodyContentApplicationJsonSchemaData" } }, "required": [ "data" ], "type": "object" } } }, "description": "Request body for updating a shift" }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/time-tracking-shifts_updateTimeTrackingShiftByExternalId_Response_200" } } }, "description": "Shift updated successfully." }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContainer" } } }, "description": "Operation failed." }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContainer" } } }, "description": "Operation failed." } }, "security": [ { "deelToken": [] } ], "summary": "Update a shift", "tags": [ "timeTrackingShifts" ] } }, "/timesheets": { "get": { "description": "Returns a paginated list of timesheets in the account, optionally filtered by contract_id, contract_types, statuses, reporter_id, or date range.\n\n **Token scopes**: `timesheets:read`", "operationId": "timesheets_getTimesheets", "parameters": [ { "description": "Filter results to timesheets belonging to this Deel contract ID.", "in": "query", "name": "contract_id", "required": false, "schema": { "type": "string" } }, { "description": "Filter results to timesheets associated with the specified contract types.", "in": "query", "name": "contract_types", "required": false, "schema": { "items": { "$ref": "#/components/schemas/TimesheetsGetParametersContractTypesSchemaItems" }, "type": "array" } }, { "description": "Filter results to timesheets with the specified statuses.", "in": "query", "name": "statuses", "required": false, "schema": { "items": { "$ref": "#/components/schemas/TimesheetsGetParametersStatusesSchemaItems" }, "type": "array" } }, { "description": "Filter results to timesheets submitted by this user ID.", "in": "query", "name": "reporter_id", "required": false, "schema": { "format": "uuid", "type": "string" } }, { "description": "Filter results to timesheets submitted on or after this date (inclusive). Short date in format ISO-8601 (YYYY-MM-DD). For example: 2022-12-31.", "in": "query", "name": "date_from", "required": false, "schema": { "format": "date", "type": "string" } }, { "description": "Filter results to timesheets submitted before this date (exclusive). Short date in format ISO-8601 (YYYY-MM-DD). For example: 2022-12-31.", "in": "query", "name": "date_to", "required": false, "schema": { "format": "date", "type": "string" } }, { "description": "Maximum number of records to return per page. NOTE: query parameters are passed as strings.", "in": "query", "name": "limit", "required": false, "schema": { "pattern": "^[0-9]+$", "type": "string" } }, { "description": "Number of records to skip before starting to return results. NOTE: query parameters are passed as strings.", "in": "query", "name": "offset", "required": false, "schema": { "pattern": "^[0-9]+$", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/timesheets_getTimesheets_Response_200" } } }, "description": "Successful operation." }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ListOfTimesheets-v2026-01-01RequestBadRequestError" } } }, "description": "Bad Request - Validation error or invalid parameters" }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContainer" } } }, "description": "Operation failed." }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContainer" } } }, "description": "Operation failed." }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContainer" } } }, "description": "Operation failed." }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContainer" } } }, "description": "Operation failed." } }, "security": [ { "deelToken": [] } ], "summary": "List of timesheets", "tags": [ "timesheets" ] }, "post": { "description": "Creates a timesheet entry for an hourly contractor, recording the contract, date, hours worked, and an optional description. The entry is immediately placed into a review workflow upon creation.\n\n **Token scopes**: `timesheets:write`", "operationId": "timesheets_createTimesheet", "requestBody": { "content": { "application/json": { "schema": { "properties": { "data": { "$ref": "#/components/schemas/TimesheetsPostRequestBodyContentApplicationJsonSchemaData", "description": "Payload attributes required to create one timesheet entry with optional approval, preset, and grouping metadata." } }, "required": [ "data" ], "type": "object" } } }, "description": "Timesheet object that needs to be created" }, "responses": { "201": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/timesheets_createTimesheet_Response_201" } } }, "description": "Successful operation." }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreateATimesheetEntry-v2026-01-01RequestBadRequestError" } } }, "description": "Bad Request - The request payload failed validation or violated a business rule for timesheet entries." }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContainer" } } }, "description": "Operation failed." }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContainer" } } }, "description": "Operation failed." }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContainer" } } }, "description": "Operation failed." }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreateATimesheetEntry-v2026-01-01RequestInternalServerError" } } }, "description": "Internal Server Error - The timesheet entry could not be created due to an unexpected upstream or internal failure." } }, "security": [ { "deelToken": [] } ], "summary": "Create a timesheet entry", "tags": [ "timesheets" ] } }, "/timesheets/many/reviews": { "post": { "description": "Review a batch of timesheets to approve or reject submitted work.\n\n **Token scopes**: `timesheets:write`", "operationId": "timesheets_createtimesheetreviews-v2026-01-01", "requestBody": { "content": { "application/json": { "schema": { "properties": { "data": { "$ref": "#/components/schemas/TimesheetsManyReviewsPostRequestBodyContentApplicationJsonSchemaData" } }, "required": [ "data" ], "type": "object" } } }, "description": "Timesheet review objects that need to be created" }, "responses": { "201": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Timesheets_createtimesheetreviews-v2026-01-01_Response_201" } } }, "description": "Successful operation." }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Createtimesheetreviews-v2026-01-01RequestBadRequestError" } } }, "description": "Bad Request - The request payload failed validation or violated a business rule for the timesheet reviews." }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContainer" } } }, "description": "Operation failed." }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Createtimesheetreviews-v2026-01-01RequestForbiddenError" } } }, "description": "Forbidden - The caller does not hold a client role on this organization (bare text/html body), or has no access to the contract (JSON error envelope)." }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Createtimesheetreviews-v2026-01-01RequestNotFoundError" } } }, "description": "Not Found - None of the supplied ids has a pending approval request to review." }, "409": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Createtimesheetreviews-v2026-01-01RequestConflictError" } } }, "description": "Conflict - A previous batch approval for this approver is still being processed." }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Createtimesheetreviews-v2026-01-01RequestInternalServerError" } } }, "description": "Internal Server Error - The timesheet reviews could not be processed due to an unexpected upstream or internal failure." } }, "security": [ { "deelToken": [] } ], "summary": "Review multiple timesheets", "tags": [ "timesheets" ] } }, "/timesheets/presets": { "post": { "description": "Creates a new hourly report preset, returning the assigned id upon success.\n\n **Token scopes**: `timesheets:write`", "operationId": "projects_createTimesheetsPreset", "requestBody": { "content": { "application/json": { "schema": { "properties": { "data": { "$ref": "#/components/schemas/TimesheetsPresetsPostRequestBodyContentApplicationJsonSchemaData" } }, "required": [ "data" ], "type": "object" } } } }, "responses": { "201": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Projects_createTimesheetsPreset_Response_201" } } }, "description": "Successful operation." }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreateHourlyReportPreset-v2026-01-01RequestBadRequestError" } } }, "description": "Bad Request" }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContainer" } } }, "description": "Operation failed." }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreateHourlyReportPreset-v2026-01-01RequestForbiddenError" } } }, "description": "Forbidden" }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContainer" } } }, "description": "Operation failed." }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContainer" } } }, "description": "Operation failed." } }, "security": [ { "deelToken": [] } ], "summary": "Create Hourly Report Preset", "tags": [ "projects" ] } }, "/timesheets/presets/{id}": { "delete": { "description": "Permanently deletes an hourly report preset identified by id.\n\n **Token scopes**: `timesheets:write`", "operationId": "projects_deleteTimesheetsPreset", "parameters": [ { "description": "The unique identifier of the hourly report preset to delete", "in": "path", "name": "id", "required": true, "schema": { "format": "uuid", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Projects_deleteTimesheetsPreset_Response_200" } } }, "description": "Successful operation." }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DeleteHourlyReportPreset-v2026-01-01RequestBadRequestError" } } }, "description": "Bad Request" }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContainer" } } }, "description": "Operation failed." }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DeleteHourlyReportPreset-v2026-01-01RequestForbiddenError" } } }, "description": "Forbidden" }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DeleteHourlyReportPreset-v2026-01-01RequestNotFoundError" } } }, "description": "Not Found" }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContainer" } } }, "description": "Operation failed." } }, "security": [ { "deelToken": [] } ], "summary": "Delete Hourly Report Preset", "tags": [ "projects" ] }, "get": { "description": "Retrieves a single hourly report preset by its id.\n\n **Token scopes**: `timesheets:read`", "operationId": "projects_getTimesheetsPresetById", "parameters": [ { "description": "The unique identifier of the hourly report preset to retrieve", "in": "path", "name": "id", "required": true, "schema": { "format": "uuid", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Projects_getTimesheetsPresetById_Response_200" } } }, "description": "Successful operation." }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContainer" } } }, "description": "Operation failed." }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContainer" } } }, "description": "Operation failed." }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetHourlyReportPresetById-v2026-01-01RequestForbiddenError" } } }, "description": "Forbidden" }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetHourlyReportPresetById-v2026-01-01RequestNotFoundError" } } }, "description": "Not Found" }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContainer" } } }, "description": "Operation failed." } }, "security": [ { "deelToken": [] } ], "summary": "Get Hourly Report Preset by ID", "tags": [ "projects" ] }, "patch": { "description": "Applies a partial update to an existing hourly report preset identified by id. Only fields included in the request body are modified.\n\n **Token scopes**: `timesheets:write`", "operationId": "projects_updateTimesheetsPreset", "parameters": [ { "description": "The unique identifier of the hourly report preset to update", "in": "path", "name": "id", "required": true, "schema": { "format": "uuid", "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "properties": { "data": { "$ref": "#/components/schemas/TimesheetsPresetsIdPatchRequestBodyContentApplicationJsonSchemaData" } }, "required": [ "data" ], "type": "object" } } } }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Projects_updateTimesheetsPreset_Response_200" } } }, "description": "Successful operation." }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UpdateHourlyReportPreset-v2026-01-01RequestBadRequestError" } } }, "description": "Bad Request" }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContainer" } } }, "description": "Operation failed." }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UpdateHourlyReportPreset-v2026-01-01RequestForbiddenError" } } }, "description": "Forbidden" }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UpdateHourlyReportPreset-v2026-01-01RequestNotFoundError" } } }, "description": "Not Found" }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContainer" } } }, "description": "Operation failed." } }, "security": [ { "deelToken": [] } ], "summary": "Update Hourly Report Preset", "tags": [ "projects" ] } }, "/timesheets/root-presets": { "get": { "description": "Returns a cursor-paginated list of hourly report root presets, with optional filtering by work_statement_statuses and result ordering.\n\n **Token scopes**: `timesheets:read`", "operationId": "projects_getHourlyReportRootPresets-v2026-01-01", "parameters": [ { "description": "Maximum number of items to return per page (max: 100)", "in": "query", "name": "limit", "required": false, "schema": { "default": 10, "maximum": 100, "type": "integer" } }, { "description": "Field to order the results by", "in": "query", "name": "order_by", "required": false, "schema": { "$ref": "#/components/schemas/TimesheetsRootPresetsGetParametersOrderBy", "default": "created_at" } }, { "description": "Direction to order the results (ascending or descending)", "in": "query", "name": "order_direction", "required": false, "schema": { "$ref": "#/components/schemas/TimesheetsRootPresetsGetParametersOrderDirection", "default": "DESC" } }, { "description": "Filter results by work statement status", "in": "query", "name": "work_statement_statuses", "required": false, "schema": { "default": [ "ACTIVE", "PENDING", "INITIAL" ], "items": { "type": "string" }, "type": "array" } }, { "description": "Pagination cursor for fetching the next page of results", "in": "query", "name": "cursor", "required": false, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Projects_getHourlyReportRootPresets-v2026-01-01_Response_200" } } }, "description": "Successful operation." }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetHourlyReportRootPresets-v2026-01-01RequestBadRequestError" } } }, "description": "Bad Request" }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContainer" } } }, "description": "Operation failed." }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContainer" } } }, "description": "Operation failed." }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContainer" } } }, "description": "Operation failed." }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContainer" } } }, "description": "Operation failed." } }, "security": [ { "deelToken": [] } ], "summary": "Get Hourly Report Root Presets", "tags": [ "projects" ] }, "post": { "description": "Creates a new hourly report root preset and initiates asynchronous processing; the response includes an async_task object that can be used to track completion.\n\n **Token scopes**: `timesheets:write`", "operationId": "projects_createRootTimesheetsPreset", "requestBody": { "content": { "application/json": { "schema": { "properties": { "description": { "description": "Detailed description of the root preset's purpose and usage (maximum 30000 characters)", "maxLength": 30000, "type": "string" }, "file": { "description": "Optional file attachment for the root preset", "format": "binary", "type": [ "string", "null" ] }, "hourly_report_presets": { "default": [], "description": "Array of preset configurations to be created along with the root preset", "items": { "$ref": "#/components/schemas/TimesheetsRootPresetsPostRequestBodyContentApplicationJsonSchemaHourlyReportPresetsItems" }, "type": "array" }, "hourly_report_presets_processing_type": { "$ref": "#/components/schemas/TimesheetsRootPresetsPostRequestBodyContentApplicationJsonSchemaHourlyReportPresetsProcessingType", "default": "SYNC", "description": "Determines whether presets should be processed synchronously or asynchronously" }, "title": { "description": "The title of the hourly report root preset (maximum 255 characters)", "maxLength": 255, "type": "string" }, "type": { "$ref": "#/components/schemas/TimesheetsRootPresetsPostRequestBodyContentApplicationJsonSchemaType", "description": "The type of preset, RATE – indicates a preset that overrides the default contract rate, TRACKING - used exclusively for tracking, applying the default contract rate" } }, "required": [ "title" ], "type": "object" } } } }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Projects_createRootTimesheetsPreset_Response_200" } } }, "description": "Successful operation." }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreateHourlyReportRootPreset-v2026-01-01RequestBadRequestError" } } }, "description": "Bad Request" }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContainer" } } }, "description": "Operation failed." }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContainer" } } }, "description": "Operation failed." }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContainer" } } }, "description": "Operation failed." }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContainer" } } }, "description": "Operation failed." } }, "security": [ { "deelToken": [] } ], "summary": "Create Hourly Report Root Preset", "tags": [ "projects" ] } }, "/timesheets/root-presets/{id}": { "get": { "description": "Retrieves a single hourly report root preset by its id, including its current status.\n\n **Token scopes**: `timesheets:read`", "operationId": "projects_getHourlyReportRootPresetById-v2026-01-01", "parameters": [ { "description": "The unique identifier of the hourly report root preset to retrieve", "in": "path", "name": "id", "required": true, "schema": { "format": "uuid", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Projects_getHourlyReportRootPresetById-v2026-01-01_Response_200" } } }, "description": "Successful operation." }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetHourlyReportRootPresetById-v2026-01-01RequestBadRequestError" } } }, "description": "Bad Request" }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContainer" } } }, "description": "Operation failed." }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContainer" } } }, "description": "Operation failed." }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetHourlyReportRootPresetById-v2026-01-01RequestNotFoundError" } } }, "description": "Not Found" }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContainer" } } }, "description": "Operation failed." } }, "security": [ { "deelToken": [] } ], "summary": "Get Hourly Report Root Preset by ID", "tags": [ "projects" ] } }, "/timesheets/{id}": { "get": { "operationId": "timesheets_getTimesheetById", "parameters": [ { "in": "path", "name": "id", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Successful response" } }, "summary": "Get Timesheet By Id", "tags": [ "timesheets" ] }, "patch": { "operationId": "timesheets_updateTimesheet", "parameters": [ { "in": "path", "name": "id", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Successful response" } }, "summary": "Update Timesheet", "tags": [ "timesheets" ] } }, "/timesheets/{id}/reviews": { "post": { "operationId": "timesheets_createTimesheetReview", "parameters": [ { "in": "path", "name": "id", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Successful response" } }, "summary": "Create Timesheet Review", "tags": [ "timesheets" ] } }, "/timesheets/{timesheet_id}": { "delete": { "description": "Permanently deletes a timesheet entry. An optional `reason` query parameter may be provided to record the rationale for deletion.\n\n **Token scopes**: `timesheets:write`", "operationId": "timesheets_deleteTimesheetById-v2026-01-01", "parameters": [ { "description": "ID of an existing timesheet", "in": "path", "name": "timesheet_id", "required": true, "schema": { "type": "string" } }, { "description": "Reason for deleting an existing task", "in": "query", "name": "reason", "required": false, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Timesheets_deleteTimesheetById-v2026-01-01_Response_200" } } }, "description": "Successful operation." }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DeleteTimesheetById-v2026-01-01RequestBadRequestError" } } }, "description": "Bad Request - The timesheet cannot be deleted given its current status." }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContainer" } } }, "description": "Operation failed." }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DeleteTimesheetById-v2026-01-01RequestForbiddenError" } } }, "description": "Forbidden - The specified timesheet does not exist or the requester does not have access to it." }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DeleteTimesheetById-v2026-01-01RequestNotFoundError" } } }, "description": "Not Found - The specified timesheet does not exist." }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DeleteTimesheetById-v2026-01-01RequestInternalServerError" } } }, "description": "Internal Server Error - The timesheet could not be deleted due to an unexpected upstream or internal failure." } }, "security": [ { "deelToken": [] } ], "summary": "Delete a timesheet entry", "tags": [ "timesheets" ] }, "get": { "description": "Returns a single timesheet entry.\n\n **Token scopes**: `timesheets:read`", "operationId": "timesheets_getTimesheetById-v2026-01-01", "parameters": [ { "description": "ID of an existing timesheet", "in": "path", "name": "timesheet_id", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Timesheets_getTimesheetById-v2026-01-01_Response_200" } } }, "description": "Successful operation." }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetTimesheetById-v2026-01-01RequestBadRequestError" } } }, "description": "Bad Request - The id parameter failed validation." }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContainer" } } }, "description": "Operation failed." }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetTimesheetById-v2026-01-01RequestForbiddenError" } } }, "description": "Forbidden - The specified timesheet does not exist or the requester does not have access to it." }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContainer" } } }, "description": "Operation failed." }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetTimesheetById-v2026-01-01RequestInternalServerError" } } }, "description": "Internal Server Error - The timesheet could not be retrieved due to an unexpected upstream or internal failure." } }, "security": [ { "deelToken": [] } ], "summary": "Retrieve a single timesheet entry", "tags": [ "timesheets" ] }, "patch": { "description": "Partially updates an existing timesheet entry; only fields supplied in the request body are modified. Both clients and contractors may perform this operation.\n\n **Token scopes**: `timesheets:write`", "operationId": "timesheets_updateATimesheetEntry-v2026-01-01", "parameters": [ { "description": "ID of an existing timesheet.", "in": "path", "name": "timesheet_id", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "properties": { "data": { "$ref": "#/components/schemas/TimesheetsTimesheetIdPatchRequestBodyContentApplicationJsonSchemaData", "description": "Fields to update on the existing timesheet entry." } }, "required": [ "data" ], "type": "object" } } }, "description": "Details of the timesheet to update. Both a client or a contractor may update a timesheet." }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Timesheets_updateATimesheetEntry-v2026-01-01_Response_200" } } }, "description": "Successful operation." }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UpdateATimesheetEntry-v2026-01-01RequestBadRequestError" } } }, "description": "Bad Request - The request payload failed validation or violated a business rule for the timesheet entry." }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContainer" } } }, "description": "Operation failed." }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UpdateATimesheetEntry-v2026-01-01RequestForbiddenError" } } }, "description": "Forbidden - The specified timesheet does not exist or the requester does not have access to it." }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UpdateATimesheetEntry-v2026-01-01RequestNotFoundError" } } }, "description": "Not Found - The specified timesheet does not exist." }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UpdateATimesheetEntry-v2026-01-01RequestInternalServerError" } } }, "description": "Internal Server Error - The timesheet could not be updated due to an unexpected upstream or internal failure." } }, "security": [ { "deelToken": [] } ], "summary": "Update a timesheet entry", "tags": [ "timesheets" ] } }, "/timesheets/{timesheet_id}/reviews": { "post": { "description": "Submits an approve or reject decision for a timesheet entry. Approved timesheets are queued for inclusion in the next payment cycle.\n\n **Token scopes**: `timesheets:write`", "operationId": "timesheets_createTimesheetReview-v2026-01-01", "parameters": [ { "description": "ID of an existing timesheet", "in": "path", "name": "timesheet_id", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "properties": { "data": { "$ref": "#/components/schemas/TimesheetsTimesheetIdReviewsPostRequestBodyContentApplicationJsonSchemaData", "description": "Review decision payload to apply to the timesheet entry." } }, "required": [ "data" ], "type": "object" } } } }, "responses": { "201": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Timesheets_createTimesheetReview-v2026-01-01_Response_201" } } }, "description": "Successful operation." }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreateTimesheetReview-v2026-01-01RequestBadRequestError" } } }, "description": "Bad Request - The request payload failed validation or violated a business rule for the timesheet review." }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContainer" } } }, "description": "Operation failed." }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContainer" } } }, "description": "Operation failed." }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreateTimesheetReview-v2026-01-01RequestNotFoundError" } } }, "description": "Not Found - The specified timesheet id could not be found for review." }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreateTimesheetReview-v2026-01-01RequestInternalServerError" } } }, "description": "Internal Server Error - The timesheet review could not be processed due to an unexpected upstream or internal failure." } }, "security": [ { "deelToken": [] } ], "summary": "Review a single timesheet", "tags": [ "timesheets" ] } }, "/v2/time_tracking/shift_rates": { "get": { "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\n **Token scopes**: `time-tracking:read`", "operationId": "timeTracking_getTimeTrackingShiftRates", "parameters": [ { "description": "Limit the number of results", "in": "query", "name": "limit", "required": false, "schema": { "exclusiveMinimum": 0, "maximum": 200, "type": "integer" } }, { "description": "Offset for pagination", "in": "query", "name": "offset", "required": false, "schema": { "minimum": 0, "type": "integer" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/time-tracking_getTimeTrackingShiftRates_Response_200" } } }, "description": "Paginated list of shift rates retrieved successfully." }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContainer" } } }, "description": "Operation failed." }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContainer" } } }, "description": "Operation failed." }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContainer" } } }, "description": "Operation failed." } }, "security": [ { "deelToken": [] } ], "summary": "Retrieve a Paginated List of Shift Rates", "tags": [ "timeTracking" ] }, "post": { "description": "Create a new shift rate with the specified attributes such as name, type, value, and a unique external identifier.\n\n **Token scopes**: `time-tracking:write`", "operationId": "timeTracking_createTimeTrackingShiftRate", "requestBody": { "content": { "application/json": { "schema": { "properties": { "data": { "$ref": "#/components/schemas/V2TimeTrackingShiftRatesPostRequestBodyContentApplicationJsonSchemaData" } }, "required": [ "data" ], "type": "object" } } }, "description": "Details of the shift rate to create." }, "responses": { "201": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/time-tracking_createTimeTrackingShiftRate_Response_201" } } }, "description": "Shift rate created successfully." }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContainer" } } }, "description": "Operation failed." }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContainer" } } }, "description": "Operation failed." }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContainer" } } }, "description": "Operation failed." } }, "security": [ { "deelToken": [] } ], "summary": "Create a New Shift Rate", "tags": [ "timeTracking" ] } }, "/v2/time_tracking/shifts": { "get": { "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\n **Token scopes**: `time-tracking:read`", "operationId": "timeTrackingShifts_getTimeTrackingShifts", "parameters": [ { "description": "Limit the number of results", "in": "query", "name": "limit", "required": false, "schema": { "exclusiveMinimum": 0, "maximum": 200, "type": "integer" } }, { "description": "Offset for pagination", "in": "query", "name": "offset", "required": false, "schema": { "minimum": 0, "type": "integer" } }, { "description": "Filter shifts from this date (YYYY-MM-DD)", "in": "query", "name": "from_date", "required": false, "schema": { "pattern": "^\\d{4}-\\d{2}-\\d{2}$", "type": "string" } }, { "description": "Filter shifts until this date (YYYY-MM-DD)", "in": "query", "name": "to_date", "required": false, "schema": { "pattern": "^\\d{4}-\\d{2}-\\d{2}$", "type": "string" } }, { "description": "Filter shifts by one or more contract IDs", "in": "query", "name": "contract_id", "required": false, "schema": { "items": { "type": "string" }, "type": "array" } }, { "description": "Filter shifts by one or more contract IDs.", "in": "query", "name": "contract_id[]", "required": false, "schema": { "items": { "type": "string" }, "type": "array" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/time-tracking-shifts_getTimeTrackingShifts_Response_200" } } }, "description": "Successful response with paginated shifts." }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContainer" } } }, "description": "Operation failed." }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContainer" } } }, "description": "Operation failed." }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContainer" } } }, "description": "Operation failed." }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContainer" } } }, "description": "Operation failed." } }, "security": [ { "deelToken": [] } ], "summary": "List of shifts", "tags": [ "timeTrackingShifts" ] }, "post": { "description": "Creates multiple time tracking shifts for a contract, supporting both regular shift submissions and corrections that adjust hours for previously processed shifts. The contract must be a Global Payroll contract. A correction shift must reference, via `shift_reference_id`, an already-exported regular shift on the same contract; only one correction per referenced shift is allowed, and a correction cannot be submitted once the payroll cycle it falls in has closed.\n\n **Token scopes**: `time-tracking:write`", "operationId": "timeTrackingShifts_createTimeTrackingShifts", "requestBody": { "content": { "application/json": { "schema": { "properties": { "data": { "$ref": "#/components/schemas/V2TimeTrackingShiftsPostRequestBodyContentApplicationJsonSchemaData" } }, "required": [ "data" ], "type": "object" } } }, "description": "Request body to create time tracking shifts supporting regular shifts and correction shifts." }, "responses": { "201": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/time-tracking-shifts_createTimeTrackingShifts_Response_201" } } }, "description": "Successful operation." }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContainer" } } }, "description": "Operation failed." }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContainer" } } }, "description": "Operation failed." }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContainer" } } }, "description": "Operation failed." } }, "security": [ { "deelToken": [] } ], "summary": "Create shifts", "tags": [ "timeTrackingShifts" ] } }, "/v2/time_tracking/shifts/bulk-delete": { "post": { "description": "Permanently deletes multiple shifts in a single call using their external IDs; once deleted, the shifts cannot be retrieved or modified. Deletion is blocked once the payroll cycle a shift belongs to has closed. The call is all-or-nothing: if any referenced shift has a closed payroll cycle or cannot be found, no shifts are deleted and the request fails.\n\n **Token scopes**: `time-tracking:write`", "operationId": "timeTrackingShifts_deleteMultipleShiftsByExternalId-v2026-01-01", "requestBody": { "content": { "application/json": { "schema": { "properties": { "data": { "$ref": "#/components/schemas/V2TimeTrackingShiftsBulkDeletePostRequestBodyContentApplicationJsonSchemaData" } }, "required": [ "data" ], "type": "object" } } }, "description": "Request body to bulk delete shifts by their external IDs." }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Time_Tracking_Shifts_deleteMultipleShiftsByExternalId-v2026-01-01_Response_200" } } }, "description": "Shifts deleted successfully" }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContainer" } } }, "description": "Operation failed." }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContainer" } } }, "description": "Operation failed." } }, "security": [ { "deelToken": [] } ], "summary": "Delete multiple shifts by External ID", "tags": [ "timeTrackingShifts" ] } }, "/v2/time_tracking/shifts/raw": { "post": { "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\n **Token scopes**: `time-tracking:write`", "operationId": "timeTrackingShifts_createTimeTrackingShiftsRaw", "requestBody": { "content": { "application/json": { "schema": { "properties": { "data": { "$ref": "#/components/schemas/V2TimeTrackingShiftsRawPostRequestBodyContentApplicationJsonSchemaData" } }, "required": [ "data" ], "type": "object" } } }, "description": "Request body for creating raw shifts" }, "responses": { "201": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/time-tracking-shifts_createTimeTrackingShiftsRaw_Response_201" } } }, "description": "Successful operation." }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContainer" } } }, "description": "Operation failed." }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContainer" } } }, "description": "Operation failed." }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContainer" } } }, "description": "Operation failed." }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContainer" } } }, "description": "Operation failed." } }, "security": [ { "deelToken": [] } ], "summary": "Create raw time tracking shifts", "tags": [ "timeTrackingShifts" ] } }, "/veriff/session": { "post": { "description": "Initiates an identity verification session via Veriff, returning a URL to which the worker must be redirected to complete the verification flow.\n\n **Token scopes**: `screenings:write`, `worker:write`", "operationId": "screenings_createVeriffSession", "requestBody": { "content": { "application/json": { "schema": { "properties": { "data": { "$ref": "#/components/schemas/VeriffSessionPostRequestBodyContentApplicationJsonSchemaData" } }, "required": [ "data" ], "type": "object" } } } }, "responses": { "201": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/screenings_createVeriffSession_Response_201" } } }, "description": "Successful operation" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContainer" } } }, "description": "Operation failed." }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContainer" } } }, "description": "Operation failed." }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContainer" } } }, "description": "Operation failed." }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContainer" } } }, "description": "Operation failed." }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContainer" } } }, "description": "Operation failed." } }, "security": [ { "deelToken": [] } ], "summary": "Create Veriff session", "tags": [ "Screenings" ] } }, "/vms/requisitions": { "get": { "description": "Returns a cursor-paginated list of Deel Talent job requests for the organization. Use filters to find requests by hiring criteria or approval status, then use the results to populate a dashboard, synchronize an external system, or identify requests needing follow-up. Pass the cursor from each response to retrieve the next page.\n\n **Token scopes**: `talents:read`", "operationId": "talent_listRequisitions-v2026-09-10", "parameters": [ { "description": "Free-text search over the job request title.", "in": "query", "name": "search", "required": false, "schema": { "maxLength": 150, "type": "string" } }, { "description": "Filter by talent partner identifiers. The reserved value `external_provider` matches job requests whose candidates were sourced from an external provider rather than a Deel talent partner.", "in": "query", "name": "vendor_ids", "required": false, "schema": { "items": { "type": "string" }, "type": "array" } }, { "description": "Filter by contract type.", "in": "query", "name": "contract_type", "required": false, "schema": { "items": { "$ref": "#/components/schemas/VmsRequisitionsGetParametersContractTypeSchemaItems" }, "type": "array" } }, { "description": "Filter by the rate scale of the job request.", "in": "query", "name": "rate_scale", "required": false, "schema": { "$ref": "#/components/schemas/VmsRequisitionsGetParametersRateScale" } }, { "description": "Filter by ISO 3166-1 alpha-2 country codes.", "in": "query", "name": "locations", "required": false, "schema": { "items": { "maxLength": 2, "type": "string" }, "type": "array" } }, { "description": "Filter by work mode.", "in": "query", "name": "work_mode", "required": false, "schema": { "$ref": "#/components/schemas/VmsRequisitionsGetParametersWorkMode" } }, { "description": "Filter by job request status.", "in": "query", "name": "status", "required": false, "schema": { "items": { "$ref": "#/components/schemas/VmsRequisitionsGetParametersStatusSchemaItems" }, "type": "array" } }, { "description": "Filter by approval status.", "in": "query", "name": "approval_status", "required": false, "schema": { "items": { "$ref": "#/components/schemas/VmsRequisitionsGetParametersApprovalStatusSchemaItems" }, "type": "array" } }, { "description": "Only return job requests whose start date is on or after this date.", "in": "query", "name": "start_date_from", "required": false, "schema": { "format": "date-time", "type": "string" } }, { "description": "Only return job requests whose start date is on or before this date. Must not be earlier than `start_date_from`.", "in": "query", "name": "start_date_to", "required": false, "schema": { "format": "date-time", "type": "string" } }, { "description": "Only return job requests whose end date is on or after this date.", "in": "query", "name": "end_date_from", "required": false, "schema": { "format": "date-time", "type": "string" } }, { "description": "Only return job requests whose end date is on or before this date. Must not be earlier than `end_date_from`.", "in": "query", "name": "end_date_to", "required": false, "schema": { "format": "date-time", "type": "string" } }, { "description": "Only return job requests created on or after this date.", "in": "query", "name": "created_at_from", "required": false, "schema": { "format": "date-time", "type": "string" } }, { "description": "Only return job requests created on or before this date. Must not be earlier than `created_at_from`.", "in": "query", "name": "created_at_to", "required": false, "schema": { "format": "date-time", "type": "string" } }, { "description": "Use `PENDING_TASKS` to return only the job requests awaiting an action from the token owner.", "in": "query", "name": "request_type", "required": false, "schema": { "$ref": "#/components/schemas/VmsRequisitionsGetParametersRequestType", "default": "GENERAL" } }, { "description": "Field to sort by.", "in": "query", "name": "sort_by", "required": false, "schema": { "$ref": "#/components/schemas/VmsRequisitionsGetParametersSortBy", "default": "created_at" } }, { "description": "Sort direction.", "in": "query", "name": "sort_order", "required": false, "schema": { "$ref": "#/components/schemas/VmsRequisitionsGetParametersSortOrder", "default": "ASC" } }, { "description": "Opaque cursor returned by the previous page. Omit to retrieve the first page.", "in": "query", "name": "cursor", "required": false, "schema": { "type": "string" } }, { "description": "Maximum number of records to return.", "in": "query", "name": "limit", "required": false, "schema": { "default": 10, "maximum": 100, "minimum": 1, "type": "integer" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Talent_listRequisitions-v2026-09-10_Response_200" } } }, "description": "Successful operation." }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ListRequisitions-v2026-09-10RequestBadRequestError" } } }, "description": "Invalid request parameters." }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ListRequisitions-v2026-09-10RequestUnauthorizedError" } } }, "description": "Unauthorized." }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ListRequisitions-v2026-09-10RequestForbiddenError" } } }, "description": "Forbidden." }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContainer" } } }, "description": "Operation failed." }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ListRequisitions-v2026-09-10RequestInternalServerError" } } }, "description": "Internal server error." } }, "security": [ { "deelToken": [] } ], "summary": "List job requests", "tags": [ "talent" ] } }, "/webhooks": { "get": { "description": "Lists every webhook subscription configured for the organization. Use this to find the id of a specific subscription before retrieving, updating, or deleting it, or to audit which events are currently wired up.\n\n **Token scopes**: `webhooks:read`", "operationId": "webhooks_getWebhooks", "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/webhooks_getWebhooks_Response_200" } } }, "description": "successful operation" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetAllWebhooks-v2026-01-01RequestBadRequestError" } } }, "description": "Bad Request. The request could not be understood or was missing required parameters." }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetAllWebhooks-v2026-01-01RequestUnauthorizedError" } } }, "description": "Unauthorized. Authentication credentials were missing or invalid." }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetAllWebhooks-v2026-01-01RequestForbiddenError" } } }, "description": "Forbidden. You do not have permission to access this resource." }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetAllWebhooks-v2026-01-01RequestNotFoundError" } } }, "description": "Not Found. The requested resource could not be found." }, "405": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetAllWebhooks-v2026-01-01RequestMethodNotAllowedError" } } }, "description": "Method Not Allowed. The HTTP method is not supported for this resource." }, "429": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetAllWebhooks-v2026-01-01RequestTooManyRequestsError" } } }, "description": "Too Many Requests. The rate limit has been exceeded." }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetAllWebhooks-v2026-01-01RequestInternalServerError" } } }, "description": "Internal Server Error. An unexpected error occurred." } }, "security": [ { "deelToken": [] } ], "summary": "List webhooks", "tags": [ "Webhooks" ] }, "post": { "description": "Creates a new webhook subscription with the specified URL, events, and configuration. Returns the created webhook, including its signing key for verifying incoming event payloads.\n\n **Token scopes**: `webhooks:write`", "operationId": "webhooks_createWebhook", "requestBody": { "content": { "application/json": { "schema": { "properties": { "api_version": { "default": "v2", "description": "Deel API version. Only v2 is accepted.", "type": "string" }, "description": { "description": "Webhook subscription description.", "type": [ "string", "null" ] }, "events": { "description": "The list of events to enable for this subscription.", "items": { "type": "string" }, "type": "array" }, "include_child_orgs": { "description": "When true, the webhook will also receive events from child organizations.", "type": [ "boolean", "null" ] }, "name": { "description": "Webhook subscription name.", "type": [ "string", "null" ] }, "signing_key": { "description": "The webhook's signing key, used to generate webhook signatures. Auto-generated if omitted.", "maxLength": 128, "minLength": 32, "type": [ "string", "null" ] }, "status": { "$ref": "#/components/schemas/WebhooksPostRequestBodyContentApplicationJsonSchemaStatus", "description": "Status of webhook." }, "url": { "description": "Endpoint to receive webhook.", "type": "string" } }, "required": [ "url", "name", "events", "status", "api_version", "description" ], "type": "object" } } } }, "responses": { "201": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/webhooks_createWebhook_Response_201" } } }, "description": "successful operation" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreateWebhook-v2026-01-01RequestBadRequestError" } } }, "description": "Bad Request. The request could not be understood or was missing required parameters." }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreateWebhook-v2026-01-01RequestUnauthorizedError" } } }, "description": "Unauthorized. Authentication credentials were missing or invalid." }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreateWebhook-v2026-01-01RequestForbiddenError" } } }, "description": "Forbidden. You do not have permission to access this resource." }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreateWebhook-v2026-01-01RequestNotFoundError" } } }, "description": "Not Found. The requested resource could not be found." }, "405": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreateWebhook-v2026-01-01RequestMethodNotAllowedError" } } }, "description": "Method Not Allowed. The HTTP method is not supported for this resource." }, "429": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreateWebhook-v2026-01-01RequestTooManyRequestsError" } } }, "description": "Too Many Requests. The rate limit has been exceeded." }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreateWebhook-v2026-01-01RequestInternalServerError" } } }, "description": "Internal Server Error. An unexpected error occurred." } }, "security": [ { "deelToken": [] } ], "summary": "Create a webhook", "tags": [ "Webhooks" ] } }, "/webhooks/events/types": { "get": { "description": "Lists the catalog of webhook event types available on the platform. Use this to discover valid event identifiers before populating the events array when creating a webhook via POST /rest/webhooks or updating one via PATCH /rest/webhooks/{id}\n\n **Token scopes**: `webhooks:read`", "operationId": "webhooks_getWebhookEvents", "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/webhooks_getWebhookEvents_Response_200" } } }, "description": "successful operation" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetAllWebhookEventTypes-v2026-01-01RequestBadRequestError" } } }, "description": "Bad Request. The request could not be understood or was missing required parameters." }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetAllWebhookEventTypes-v2026-01-01RequestUnauthorizedError" } } }, "description": "Unauthorized. Authentication credentials were missing or invalid." }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetAllWebhookEventTypes-v2026-01-01RequestForbiddenError" } } }, "description": "Forbidden. You do not have permission to access this resource." }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetAllWebhookEventTypes-v2026-01-01RequestNotFoundError" } } }, "description": "Not Found. The requested resource could not be found." }, "405": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetAllWebhookEventTypes-v2026-01-01RequestMethodNotAllowedError" } } }, "description": "Method Not Allowed. The HTTP method is not supported for this resource." }, "429": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetAllWebhookEventTypes-v2026-01-01RequestTooManyRequestsError" } } }, "description": "Too Many Requests. The rate limit has been exceeded." }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetAllWebhookEventTypes-v2026-01-01RequestInternalServerError" } } }, "description": "Internal Server Error. An unexpected error occurred." } }, "security": [ { "deelToken": [] } ], "summary": "List webhook event types", "tags": [ "Webhooks" ] } }, "/webhooks/{id}": { "delete": { "description": "Permanently deletes the specified webhook subscription by its unique identifier. This action cannot be undone.\n\n **Token scopes**: `webhooks:write`", "operationId": "webhooks_deleteWebhook", "parameters": [ { "description": "Unique identifier of the webhook subscription.", "in": "path", "name": "id", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/webhooks_deleteWebhook_Response_200" } } }, "description": "Successful operation." }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DeleteWebhookById-v2026-01-01RequestBadRequestError" } } }, "description": "Bad Request. The request could not be understood or was missing required parameters." }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DeleteWebhookById-v2026-01-01RequestUnauthorizedError" } } }, "description": "Unauthorized. Authentication credentials were missing or invalid." }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DeleteWebhookById-v2026-01-01RequestForbiddenError" } } }, "description": "Forbidden. You do not have permission to access this resource." }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DeleteWebhookById-v2026-01-01RequestNotFoundError" } } }, "description": "Not Found. The requested resource could not be found." }, "405": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DeleteWebhookById-v2026-01-01RequestMethodNotAllowedError" } } }, "description": "Method Not Allowed. The HTTP method is not supported for this resource." }, "429": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DeleteWebhookById-v2026-01-01RequestTooManyRequestsError" } } }, "description": "Too Many Requests. The rate limit has been exceeded." }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DeleteWebhookById-v2026-01-01RequestInternalServerError" } } }, "description": "Internal Server Error. An unexpected error occurred." } }, "security": [ { "deelToken": [] } ], "summary": "Delete a webhook", "tags": [ "Webhooks" ] }, "get": { "description": "Retrieves the full configuration of a single webhook subscription by its id, including its signing key for verifying incoming payload signatures. Use this to check the current status and events of a subscription before updating it via PATCH or deleting it via DELETE /rest/webhooks/{id}.\n\n **Token scopes**: `webhooks:read`", "operationId": "webhooks_getWebhook", "parameters": [ { "description": "Unique identifier of the webhook subscription.", "in": "path", "name": "id", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/webhooks_getWebhook_Response_200" } } }, "description": "successful operation" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetWebhookById-v2026-01-01RequestBadRequestError" } } }, "description": "Bad Request. The request could not be understood or was missing required parameters." }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetWebhookById-v2026-01-01RequestUnauthorizedError" } } }, "description": "Unauthorized. Authentication credentials were missing or invalid." }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetWebhookById-v2026-01-01RequestForbiddenError" } } }, "description": "Forbidden. You do not have permission to access this resource." }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetWebhookById-v2026-01-01RequestNotFoundError" } } }, "description": "Not Found. The requested resource could not be found." }, "405": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetWebhookById-v2026-01-01RequestMethodNotAllowedError" } } }, "description": "Method Not Allowed. The HTTP method is not supported for this resource." }, "429": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetWebhookById-v2026-01-01RequestTooManyRequestsError" } } }, "description": "Too Many Requests. The rate limit has been exceeded." }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetWebhookById-v2026-01-01RequestInternalServerError" } } }, "description": "Internal Server Error. An unexpected error occurred." } }, "security": [ { "deelToken": [] } ], "summary": "Retrieve a single webhook", "tags": [ "Webhooks" ] }, "patch": { "description": "Updates one or more fields of an existing webhook subscription without recreating it — for example, enabling or disabling delivery, changing the events it is subscribed to, or opting it in to also receive events from child organizations. Use this after creating a webhook via POST /rest/webhooks whenever its configuration needs to change.\n\n **Token scopes**: `webhooks:write`", "operationId": "webhooks_updateWebhook", "parameters": [ { "description": "Unique identifier of the webhook subscription.", "in": "path", "name": "id", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "properties": { "description": { "description": "Webhook subscription description.", "type": [ "string", "null" ] }, "events": { "description": "Replaces the list of events enabled for this subscription. Retries scheduled for removed events are cancelled.", "items": { "type": "string" }, "type": "array" }, "include_child_orgs": { "description": "When true, the webhook will also receive events from child organizations.", "type": [ "boolean", "null" ] }, "name": { "description": "Webhook subscription name.", "maxLength": 128, "type": "string" }, "status": { "$ref": "#/components/schemas/WebhooksIdPatchRequestBodyContentApplicationJsonSchemaStatus", "description": "Status of webhook." }, "url": { "description": "Endpoint to receive webhook. Must use https.", "type": "string" } }, "type": "object" } } } }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/webhooks_updateWebhook_Response_200" } } }, "description": "successful operation" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UpdateWebhookById-v2026-01-01RequestBadRequestError" } } }, "description": "Bad Request. The request could not be understood or was missing required parameters." }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UpdateWebhookById-v2026-01-01RequestUnauthorizedError" } } }, "description": "Unauthorized. Authentication credentials were missing or invalid." }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UpdateWebhookById-v2026-01-01RequestForbiddenError" } } }, "description": "Forbidden. You do not have permission to access this resource." }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UpdateWebhookById-v2026-01-01RequestNotFoundError" } } }, "description": "Not Found. The requested resource could not be found." }, "405": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UpdateWebhookById-v2026-01-01RequestMethodNotAllowedError" } } }, "description": "Method Not Allowed. The HTTP method is not supported for this resource." }, "429": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UpdateWebhookById-v2026-01-01RequestTooManyRequestsError" } } }, "description": "Too Many Requests. The rate limit has been exceeded." }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UpdateWebhookById-v2026-01-01RequestInternalServerError" } } }, "description": "Internal Server Error. An unexpected error occurred." } }, "security": [ { "deelToken": [] } ], "summary": "Update a webhook", "tags": [ "Webhooks" ] } }, "/work-statement-payment-policies": { "get": { "description": "Use this endpoint to discover the payment policies configured for the authenticated organization and to pick the policy ID to reference when creating a contract. A payment policy is a reusable payment cycle configuration — when a cycle ends, when payment falls due, and whether payment moves earlier when the due date lands on a weekend.\n\n\n **Token scopes**: `contracts:read`", "operationId": "contracts_getWorkStatementPaymentPolicies-v2026-09-07", "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Contracts_getWorkStatementPaymentPolicies-v2026-09-07_Response_200" } } }, "description": "Returns the organization's work statement payment policies." }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetWorkStatementPaymentPolicies-v2026-09-07RequestBadRequestError" } } }, "description": "Operation failed." }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContainer" } } }, "description": "Operation failed." }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContainer" } } }, "description": "Operation failed." }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContainer" } } }, "description": "Operation failed." }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetWorkStatementPaymentPolicies-v2026-09-07RequestInternalServerError" } } }, "description": "Operation failed." } }, "security": [ { "deelToken": [] } ], "summary": "List work statement payment policies", "tags": [ "contracts" ] }, "post": { "description": "Use this endpoint to define a payment cycle once and reuse it, rather than repeating the same cycle fields on every contract you create. The returned policy ID can be referenced when creating contracts. Both the policy name and the combination of cycle settings must be unique within the organization.\n\n\n **Token scopes**: `contracts:write`", "operationId": "contracts_createWorkStatementPaymentPolicy-v2026-09-07", "requestBody": { "content": { "application/json": { "schema": { "properties": { "data": { "$ref": "#/components/schemas/WorkStatementPaymentPoliciesPostRequestBodyContentApplicationJsonSchemaData" } }, "required": [ "data" ], "type": "object" } } }, "description": "The work statement payment policy to create." }, "responses": { "201": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Contracts_createWorkStatementPaymentPolicy-v2026-09-07_Response_201" } } }, "description": "The work statement payment policy was created." }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreateWorkStatementPaymentPolicy-v2026-09-07RequestBadRequestError" } } }, "description": "Operation failed." }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContainer" } } }, "description": "Operation failed." }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContainer" } } }, "description": "Operation failed." }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContainer" } } }, "description": "Operation failed." }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreateWorkStatementPaymentPolicy-v2026-09-07RequestInternalServerError" } } }, "description": "Operation failed." } }, "security": [ { "deelToken": [] } ], "summary": "Create a work statement payment policy", "tags": [ "contracts" ] } }, "/worker": { "post": { "description": "Use this endpoint to provision a new worker in a white-label DaaS setup. Provide the worker's personal details, contract association, profile type, and company information. On success, the response returns the `user_id`, `profile_id`, and `contract_id` identifiers needed for subsequent operations such as generating consent tokens or magic links.", "operationId": "workers_createWorker-v2026-01-01", "requestBody": { "content": { "application/json": { "schema": { "properties": { "data": { "$ref": "#/components/schemas/WorkerPostRequestBodyContentApplicationJsonSchemaData" } }, "required": [ "data" ], "type": "object" } } } }, "responses": { "201": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Workers_createWorker-v2026-01-01_Response_201" } } }, "description": "Worker created successfully" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreateWorker-v2026-01-01RequestBadRequestError" } } }, "description": "Validation error" }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContainer" } } }, "description": "Operation failed." }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContainer" } } }, "description": "Operation failed." }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContainer" } } }, "description": "Operation failed." }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreateWorker-v2026-01-01RequestInternalServerError" } } }, "description": "Internal server error" } }, "security": [ { "deelToken": [] } ], "summary": "Create a new worker", "tags": [ "workers" ] } }, "/workers/amendments/{amendment_id}/sign": { "post": { "description": "Records the worker's signature on a pending amendment identified by amendment_id. Once signed, the amendment's status change is reflected in the associated contract.\n\n **Token scopes**: `worker:read`, `worker:write`, `benefits:read`", "operationId": "contracts_signAmendment-v2026-01-01", "parameters": [ { "description": "The unique identifier of the amendment to sign", "in": "path", "name": "amendment_id", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "properties": { "data": { "$ref": "#/components/schemas/WorkersAmendmentsAmendmentIdSignPostRequestBodyContentApplicationJsonSchemaData" } }, "type": "object" } } } }, "responses": { "201": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Contracts_signAmendment-v2026-01-01_Response_201" } } }, "description": "Amendment successfully signed." }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SignAmendment-v2026-01-01RequestBadRequestError" } } }, "description": "Operation failed." }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContainer" } } }, "description": "Operation failed." }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContainer" } } }, "description": "Operation failed." }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContainer" } } }, "description": "Operation failed." }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContainer" } } }, "description": "Operation failed." } }, "security": [ { "deelToken": [] } ], "summary": "Sign Amendment", "tags": [ "contracts" ] } }, "/workers/compliance-documents": { "get": { "description": "Lists the compliance document requirements for the authenticated worker, grouped by country, with their current submission status. Deprecated for independent contractor and Global Payroll workers, who should use GET /workers/contracts/{contract_id}/compliance-documents instead. That endpoint does not yet serve EOR employees.\n\n **Token scopes**: `worker:read`", "operationId": "workers_listOfWorkerComplianceDocuments-v2026-01-01", "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Workers_listOfWorkerComplianceDocuments-v2026-01-01_Response_200" } } }, "description": "Successful operation." }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContainer" } } }, "description": "Operation failed." }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContainer" } } }, "description": "Operation failed." }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ListOfWorkerComplianceDocuments-v2026-01-01RequestForbiddenError" } } }, "description": "Forbidden. The caller does not have the required profile type (employee or contractor)." }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContainer" } } }, "description": "Operation failed." }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ListOfWorkerComplianceDocuments-v2026-01-01RequestInternalServerError" } } }, "description": "Internal server error." } }, "security": [ { "deelToken": [] } ], "summary": "List of worker compliance documents", "tags": [ "workers" ] } }, "/workers/contracts/{contract_id}/compliance-documents": { "get": { "description": "Lists the compliance documents the authenticated worker has to satisfy on one of their Global Payroll contracts, together with what has already been submitted against each one. Use it to see what is still outstanding before payroll. Requirements with nothing submitted are included, with an empty `filenames` array and null timestamps. Retired requirements are excluded, except a retired I9, which stays listed while it can still be submitted. Only Global Payroll contracts are supported.\n\n **Token scopes**: `worker:read`", "operationId": "workers_listWorkerContractComplianceDocuments-v2026-08-25", "parameters": [ { "description": "Public id of the Global Payroll contract the documents belong to.", "in": "path", "name": "contract_id", "required": true, "schema": { "maxLength": 64, "minLength": 1, "type": "string" } }, { "description": "Maximum number of documents to return per page.", "in": "query", "name": "limit", "required": false, "schema": { "default": 20, "maximum": 100, "minimum": 1, "type": "integer" } }, { "description": "Opaque `next_cursor` value from the previous response, passed back unchanged. Omit for the first page.", "in": "query", "name": "cursor", "required": false, "schema": { "maxLength": 512, "minLength": 1, "pattern": "^[A-Za-z0-9_-]+$", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Workers_listWorkerContractComplianceDocuments-v2026-08-25_Response_200" } } }, "description": "Compliance documents returned successfully. `created_at` and `updated_at` come from the submission; `created_at` carries the same value as `uploaded_at`, and all three are null until something is submitted against the requirement. The language of `name` and `description` follows the language preference of the authenticated worker. It cannot be selected per request, and the same document may read differently for two workers of the same organization. Text falls back to English when no published translation exists for that language. `total_count`, `has_more` and `next_cursor` always describe the whole set of requirements for the contract rather than an estimate. `next_cursor` is an opaque token: pass it back unchanged and never construct or parse one. The set is small — expect tens of documents for one contract, not thousands." }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ListWorkerContractComplianceDocuments-v2026-08-25RequestBadRequestError" } } }, "description": "Bad request — `limit` is outside 1 to 100, or `cursor` is not a token a previous response handed out." }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ListWorkerContractComplianceDocuments-v2026-08-25RequestUnauthorizedError" } } }, "description": "Unauthorized — the access token is missing, expired or invalid." }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ListWorkerContractComplianceDocuments-v2026-08-25RequestForbiddenError" } } }, "description": "Forbidden — the worker does not hold this contract, or the token lacks the required scope." }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ListWorkerContractComplianceDocuments-v2026-08-25RequestNotFoundError" } } }, "description": "Not found — no contract of the authenticated worker matches `contract_id`." }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ListWorkerContractComplianceDocuments-v2026-08-25RequestUnprocessableEntityError" } } }, "description": "Unprocessable entity — the contract is not a Global Payroll contract, so compliance documents are not available on this endpoint. The error code is `WORKER_TYPE_NOT_SUPPORTED`." }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContainer" } } }, "description": "Operation failed." } }, "security": [ { "deelToken": [] } ], "summary": "List compliance documents of a worker contract", "tags": [ "workers" ] } }, "/workers/contracts/{contract_id}/compliance-documents/{document_id}": { "delete": { "description": "Deletes what the authenticated worker submitted against a compliance document of one of their Global Payroll contracts. This removes EVERY file of the requirement, not one file: there is no per-file delete on this endpoint. The action is permanent and the files cannot be recovered. The requirement itself is not removed — after the delete it is still listed, as a requirement with nothing submitted, and it can be submitted again. The response carries no body. Only Global Payroll contracts are supported.\n\n **Token scopes**: `worker:write`", "operationId": "workers_deleteWorkerContractComplianceDocumentSubmission-v2026-08-25", "parameters": [ { "description": "Public id of the Global Payroll contract the documents belong to.", "in": "path", "name": "contract_id", "required": true, "schema": { "maxLength": 64, "minLength": 1, "type": "string" } }, { "description": "Public UUID of the compliance document requirement, as returned in `id` by the list endpoint.", "in": "path", "name": "document_id", "required": true, "schema": { "format": "uuid", "type": "string" } } ], "responses": { "204": { "content": { "application/json": { "schema": { "properties": {}, "type": "object" } } }, "description": "Submission deleted successfully. No response body." }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DeleteWorkerContractComplianceDocumentSubmission-v2026-08-25RequestBadRequestError" } } }, "description": "Bad request — the requirement has nothing submitted against it, so there is nothing to delete." }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DeleteWorkerContractComplianceDocumentSubmission-v2026-08-25RequestUnauthorizedError" } } }, "description": "Unauthorized — the access token is missing, expired or invalid." }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DeleteWorkerContractComplianceDocumentSubmission-v2026-08-25RequestForbiddenError" } } }, "description": "Forbidden — the worker does not hold this contract, or the token lacks the required scope." }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DeleteWorkerContractComplianceDocumentSubmission-v2026-08-25RequestNotFoundError" } } }, "description": "Not found — `document_id` is not part of the contract." }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DeleteWorkerContractComplianceDocumentSubmission-v2026-08-25RequestUnprocessableEntityError" } } }, "description": "Unprocessable entity — the contract is not a Global Payroll contract, so compliance documents are not available on this endpoint. The error code is `WORKER_TYPE_NOT_SUPPORTED`." }, "429": { "content": { "application/json": { "schema": { "description": "Any type" } } }, "description": "Too many deletions from this worker in a short window. Deletions are rate limited per authenticated worker, on a budget separate from submissions: back off and retry rather than looping." }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContainer" } } }, "description": "Operation failed." } }, "security": [ { "deelToken": [] } ], "summary": "Delete the submission of one compliance document of a worker contract", "tags": [ "workers" ] }, "get": { "description": "Returns a single compliance document of one of the authenticated worker Global Payroll contracts, in the same shape the list endpoint returns. Use it to poll one requirement after a submission instead of fetching the whole list. Only Global Payroll contracts are supported.\n\n **Token scopes**: `worker:read`", "operationId": "workers_getWorkerContractComplianceDocument-v2026-08-25", "parameters": [ { "description": "Public id of the Global Payroll contract the documents belong to.", "in": "path", "name": "contract_id", "required": true, "schema": { "maxLength": 64, "minLength": 1, "type": "string" } }, { "description": "Public UUID of the compliance document requirement, as returned in `id` by the list endpoint.", "in": "path", "name": "document_id", "required": true, "schema": { "format": "uuid", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Workers_getWorkerContractComplianceDocument-v2026-08-25_Response_200" } } }, "description": "Compliance document returned successfully. `created_at` and `updated_at` come from the submission; `created_at` carries the same value as `uploaded_at`, and all three are null until something is submitted against the requirement. The language of `name` and `description` follows the language preference of the authenticated worker. It cannot be selected per request, and the same document may read differently for two workers of the same organization. Text falls back to English when no published translation exists for that language." }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetWorkerContractComplianceDocument-v2026-08-25RequestBadRequestError" } } }, "description": "Bad request — invalid or missing parameters." }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetWorkerContractComplianceDocument-v2026-08-25RequestUnauthorizedError" } } }, "description": "Unauthorized — the access token is missing, expired or invalid." }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetWorkerContractComplianceDocument-v2026-08-25RequestForbiddenError" } } }, "description": "Forbidden — the worker does not hold this contract, or the token lacks the required scope." }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetWorkerContractComplianceDocument-v2026-08-25RequestNotFoundError" } } }, "description": "Not found — `document_id` is not part of the contract, or it is a requirement that no longer applies to it." }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetWorkerContractComplianceDocument-v2026-08-25RequestUnprocessableEntityError" } } }, "description": "Unprocessable entity — the contract is not a Global Payroll contract, so compliance documents are not available on this endpoint. The error code is `WORKER_TYPE_NOT_SUPPORTED`." }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContainer" } } }, "description": "Operation failed." } }, "security": [ { "deelToken": [] } ], "summary": "Retrieve one compliance document of a worker contract", "tags": [ "workers" ] }, "post": { "description": "Submits one or more files against a compliance document of one of the authenticated worker Global Payroll contracts. Upload the bytes to the File Service first, then reference each file here by `file_id` and its `one_time_secret`; the Files endpoints of this API issue both. Side effects: the files replace whatever was previously submitted against the requirement, and the previous version is archived when document versioning is enabled for the organization. Only Global Payroll contracts are supported.\n\n **Token scopes**: `worker:write`", "operationId": "workers_submitWorkerContractComplianceDocumentFiles-v2026-08-25", "parameters": [ { "description": "Public id of the Global Payroll contract the documents belong to.", "in": "path", "name": "contract_id", "required": true, "schema": { "maxLength": 64, "minLength": 1, "type": "string" } }, { "description": "Public UUID of the compliance document requirement, as returned in `id` by the list endpoint.", "in": "path", "name": "document_id", "required": true, "schema": { "format": "uuid", "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "properties": { "data": { "$ref": "#/components/schemas/WorkersContractsContractIdComplianceDocumentsDocumentIdPostRequestBodyContentApplicationJsonSchemaData" } }, "required": [ "data" ], "type": "object" } } } }, "responses": { "204": { "content": { "application/json": { "schema": { "properties": {}, "type": "object" } } }, "description": "Files submitted successfully. No response body — read the document back through the list or the single document endpoint to confirm the filenames, where `submission_status` can read `REVIEWING` until the submission is final." }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SubmitWorkerContractComplianceDocumentFiles-v2026-08-25RequestBadRequestError" } } }, "description": "Bad request — an unusable `file_id` or `one_time_secret`, or a file type outside pdf, png, jpg, jpeg and heic. Multipart bodies and raw storage keys are not accepted." }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SubmitWorkerContractComplianceDocumentFiles-v2026-08-25RequestUnauthorizedError" } } }, "description": "Unauthorized — the access token is missing, expired or invalid." }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SubmitWorkerContractComplianceDocumentFiles-v2026-08-25RequestForbiddenError" } } }, "description": "Forbidden — the requirement is not open for submission, the worker does not hold this contract, or the token lacks the required scope." }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SubmitWorkerContractComplianceDocumentFiles-v2026-08-25RequestNotFoundError" } } }, "description": "Not found — `document_id` is not part of the contract." }, "412": { "content": { "application/json": { "schema": { "description": "Any type" } } }, "description": "The files could not be stored against the requirement. Nothing was submitted, so the request can be retried." }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SubmitWorkerContractComplianceDocumentFiles-v2026-08-25RequestUnprocessableEntityError" } } }, "description": "Unprocessable entity — the contract is not a Global Payroll contract, so compliance documents are not available on this endpoint. The error code is `WORKER_TYPE_NOT_SUPPORTED`." }, "429": { "content": { "application/json": { "schema": { "description": "Any type" } } }, "description": "Too many submissions from this worker in a short window. Submissions are rate limited per authenticated worker: back off and retry rather than looping." }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContainer" } } }, "description": "Operation failed." } }, "security": [ { "deelToken": [] } ], "summary": "Submit files for one compliance document of a worker contract", "tags": [ "workers" ] } }, "/workers/contracts/{contract_id}/compliance-documents/{document_id}/download": { "get": { "description": "Returns a short-lived URL for the file submitted against a compliance document of one of the authenticated worker Global Payroll contracts. The URL is valid for about 15 minutes: fetch the file with it rather than storing the URL. Pass `file` to pick a specific file when several were submitted; the first file is returned by default. Documents in the `PASSPORT_OR_NATIONAL_ID` category are never downloadable through this API, for any token type. Only Global Payroll contracts are supported.\n\n **Token scopes**: `worker:read`", "operationId": "workers_downloadWorkerContractComplianceDocument-v2026-08-25", "parameters": [ { "description": "Public id of the Global Payroll contract the documents belong to.", "in": "path", "name": "contract_id", "required": true, "schema": { "maxLength": 64, "minLength": 1, "type": "string" } }, { "description": "Public UUID of the compliance document requirement, as returned in `id` by the list endpoint.", "in": "path", "name": "document_id", "required": true, "schema": { "format": "uuid", "type": "string" } }, { "description": "Zero-based index of the submitted file to download. Defaults to the first file.", "in": "query", "name": "file", "required": false, "schema": { "default": 0, "minimum": 0, "type": "integer" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Workers_downloadWorkerContractComplianceDocument-v2026-08-25_Response_200" } } }, "description": "Download URL returned successfully." }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DownloadWorkerContractComplianceDocument-v2026-08-25RequestBadRequestError" } } }, "description": "Bad request — invalid or missing parameters." }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DownloadWorkerContractComplianceDocument-v2026-08-25RequestUnauthorizedError" } } }, "description": "Unauthorized — the access token is missing, expired or invalid." }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DownloadWorkerContractComplianceDocument-v2026-08-25RequestForbiddenError" } } }, "description": "Forbidden — the document is in the `PASSPORT_OR_NATIONAL_ID` category, the worker does not hold this contract, or the token lacks the required scope." }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DownloadWorkerContractComplianceDocument-v2026-08-25RequestNotFoundError" } } }, "description": "Not found — `document_id` is not part of the contract." }, "412": { "content": { "application/json": { "schema": { "description": "Any type" } } }, "description": "Nothing is submitted against this requirement, or the requested `file` index is beyond the submitted files." }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DownloadWorkerContractComplianceDocument-v2026-08-25RequestUnprocessableEntityError" } } }, "description": "Unprocessable entity — the contract is not a Global Payroll contract, so compliance documents are not available on this endpoint. The error code is `WORKER_TYPE_NOT_SUPPORTED`." }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContainer" } } }, "description": "Operation failed." } }, "security": [ { "deelToken": [] } ], "summary": "Get a download URL for one compliance document of a worker contract", "tags": [ "workers" ] } }, "/workers/contracts/{contract_id}/pdf": { "get": { "description": "Returns a secure, time-limited URL for downloading the PDF version of the contract identified by contract_id. The URL is accessible only to the authenticated worker associated with that contract.\n\n **Token scopes**: `worker:read`", "operationId": "contracts_retrieveContractPdfDownloadLink-v2026-01-01", "parameters": [ { "description": "The unique public identifier of the contract.", "in": "path", "name": "contract_id", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Contracts_retrieveContractPdfDownloadLink-v2026-01-01_Response_200" } } }, "description": "Successful operation." }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RetrieveContractPdfDownloadLink-v2026-01-01RequestBadRequestError" } } }, "description": "Operation failed." }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContainer" } } }, "description": "Operation failed." }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContainer" } } }, "description": "Operation failed." }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContainer" } } }, "description": "Operation failed." }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RetrieveContractPdfDownloadLink-v2026-01-01RequestInternalServerError" } } }, "description": "Operation failed." } }, "security": [ { "deelToken": [] } ], "summary": "Retrieve contract PDF download link", "tags": [ "contracts" ] } }, "/workers/contracts/{contract_id}/reject": { "post": { "description": "Rejects a contract identified by contract_id, provided it is currently in a pending, unsigned state. Contracts that have already been signed or previously rejected are not eligible for this operation.\n\n **Token scopes**: `worker:write`", "operationId": "contracts_rejectContract-v2026-01-01", "parameters": [ { "description": "The unique public identifier of the contract to reject. This is the contract's public ID that can be used to identify the specific contract in the system.", "in": "path", "name": "contract_id", "required": true, "schema": { "type": "string" } } ], "responses": { "204": { "content": { "application/json": { "schema": { "properties": {}, "type": "object" } } }, "description": "No Content" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RejectContract-v2026-01-01RequestBadRequestError" } } }, "description": "Operation failed." }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContainer" } } }, "description": "Operation failed." }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContainer" } } }, "description": "Operation failed." }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContainer" } } }, "description": "Operation failed." }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RejectContract-v2026-01-01RequestInternalServerError" } } }, "description": "Operation failed." } }, "security": [ { "deelToken": [] } ], "summary": "Reject contract", "tags": [ "contracts" ] } }, "/workers/contracts/{contract_id}/signatures": { "post": { "description": "Records the worker's signature on the contract identified by contract_id. Only contracts in an unsigned, pending state can be signed.\n\n **Token scopes**: `worker:write`", "operationId": "contracts_signWorkerContract-v2026-01-01", "parameters": [ { "description": "The unique identifier of the contract.", "in": "path", "name": "contract_id", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "properties": { "data": { "$ref": "#/components/schemas/WorkersContractsContractIdSignaturesPostRequestBodyContentApplicationJsonSchemaData" } }, "required": [ "data" ], "type": "object" } } }, "description": "worker signature object that needs to be submitted" }, "responses": { "201": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Contracts_signWorkerContract-v2026-01-01_Response_201" } } }, "description": "Contract successfully signed." }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SignWorkerContract-v2026-01-01RequestBadRequestError" } } }, "description": "Operation failed." }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContainer" } } }, "description": "Operation failed." }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContainer" } } }, "description": "Operation failed." }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContainer" } } }, "description": "Operation failed." }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SignWorkerContract-v2026-01-01RequestInternalServerError" } } }, "description": "Operation failed." } }, "security": [ { "deelToken": [] } ], "summary": "Sign worker contract", "tags": [ "contracts" ] } }, "/workers/session": { "post": { "description": "Issues a scoped access token granting a worker access to worker-side API endpoints. The response includes the token value and its expiry timestamp.\n\n **Token scopes**: `admin:worker`", "operationId": "workerSession_createWorkerAccessToken-v2026-01-01", "requestBody": { "content": { "application/json": { "schema": { "properties": { "data": { "$ref": "#/components/schemas/WorkersSessionPostRequestBodyContentApplicationJsonSchemaData" } }, "required": [ "data" ], "type": "object" } } } }, "responses": { "201": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Worker_Session_createWorkerAccessToken-v2026-01-01_Response_201" } } }, "description": "Successful operation" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContainer" } } }, "description": "Operation failed." }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContainer" } } }, "description": "Operation failed." }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContainer" } } }, "description": "Operation failed." }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContainer" } } }, "description": "Operation failed." }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContainer" } } }, "description": "Operation failed." } }, "security": [ { "deelToken": [] } ], "summary": "Create worker access token", "tags": [ "workerSession" ] } }, "/workers/tax-forms": { "get": { "description": "List the tax forms of the worker resolved from the access token, ordered by creation date descending, using cursor pagination (limit + cursor). Each item contains the resource fields (id, created_at, updated_at, client_legal_entity_id, pdf_url) and the full form data in the same public shape the create endpoint accepts; the fields present depend on the item's form_type. Each form appears once, carrying its current data. Tax identification numbers are unmasked because the authenticated worker owns the data.\n\n **Token scopes**: `worker:read`", "operationId": "workers_listTaxFormsForAWorker-v2026-01-01", "parameters": [ { "description": "Maximum number of tax forms to return per page (1-100).", "in": "query", "name": "limit", "required": false, "schema": { "default": 20, "maximum": 100, "minimum": 1, "type": "integer" } }, { "description": "Opaque pagination cursor returned as next_cursor by a previous page. Omit to fetch the first page.", "in": "query", "name": "cursor", "required": false, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Workers_listTaxFormsForAWorker-v2026-01-01_Response_200" } } }, "description": "A page of the worker's tax forms." }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ListTaxFormsForAWorker-v2026-01-01RequestBadRequestError" } } }, "description": "Validation failed — for example the cursor is malformed or the limit is out of range." }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContainer" } } }, "description": "Operation failed." }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContainer" } } }, "description": "Operation failed." }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ListTaxFormsForAWorker-v2026-01-01RequestNotFoundError" } } }, "description": "The authenticated worker was not found in the calling organization, or has no contractor profile." }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ListTaxFormsForAWorker-v2026-01-01RequestInternalServerError" } } }, "description": "Internal server error." } }, "security": [ { "deelToken": [] } ], "summary": "List tax forms for the authenticated worker", "tags": [ "workers" ] }, "post": { "description": "Submit a new US tax form for the authenticated worker against a specific client legal entity, typically during onboarding or when a fresh form must be recorded for a worker/legal-entity pair. The worker is resolved from the access token; the target legal entity is set via client_legal_entity_id. Select the form type based on the worker's US tax status: W-9 for US individuals or entities, W-8BEN for non-US individuals, W-8BEN-E for non-US entities. The worker must have an active (non-terminated) contract with the legal entity, and only one tax form may exist per worker/legal-entity pair.\n\n **Token scopes**: `worker:write`", "operationId": "workers_createATaxFormForAWorker-v2026-01-01", "requestBody": { "content": { "application/json": { "schema": { "properties": { "data": { "$ref": "#/components/schemas/WorkersTaxFormsPostRequestBodyContentApplicationJsonSchemaData" } }, "required": [ "data" ], "type": "object" } } } }, "responses": { "201": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Workers_createATaxFormForAWorker-v2026-01-01_Response_201" } } }, "description": "Tax form created successfully." }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreateATaxFormForAWorker-v2026-01-01RequestBadRequestError" } } }, "description": "Validation failed — for example a request body field is missing or malformed, the client_legal_entity_id does not exist, or the form_type does not match the contractor's tax residency (e.g. a W-8BEN submitted for a US contractor)." }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContainer" } } }, "description": "Operation failed." }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreateATaxFormForAWorker-v2026-01-01RequestForbiddenError" } } }, "description": "No live contract exists between the contractor and the specified client legal entity. A tax form can only be submitted for a contractor who has a non-terminated contract with that legal entity." }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreateATaxFormForAWorker-v2026-01-01RequestNotFoundError" } } }, "description": "The authenticated worker was not found in the calling organization, or has no contractor profile." }, "409": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreateATaxFormForAWorker-v2026-01-01RequestConflictError" } } }, "description": "A tax form already exists for this contractor and client legal entity. Only one tax form can exist per contractor/legal-entity pair." }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreateATaxFormForAWorker-v2026-01-01RequestInternalServerError" } } }, "description": "Internal server error." } }, "security": [ { "deelToken": [] } ], "summary": "Create a tax form for the authenticated worker", "tags": [ "workers" ] } }, "/workers/tax-forms/{tax_form_id}": { "put": { "description": "Replace the authenticated worker's existing tax form with a corrected version, for example to fix a mistyped tax identification number, legal name or address. The worker is resolved from the access token and only their own forms are addressable. The body is the complete form rather than a partial update: an optional field left out is cleared, except contractor_signature, which keeps the value already on file when omitted — it must be supplied when the stored form carries no signature. client_legal_entity_id is not accepted — the legal entity is part of the form's uniqueness key and can never be reassigned. The worker must have an active (non-terminated) contract with the form's legal entity. Editing a form whose 1099 has already been filed with the IRS is permitted but does not refile it.\n\n **Token scopes**: `worker:write`", "operationId": "workers_replaceATaxFormForAWorker-v2026-01-01", "parameters": [ { "description": "Public ID (UUID) of the tax form to replace, as returned by the create or list endpoints.", "in": "path", "name": "tax_form_id", "required": true, "schema": { "format": "uuid", "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "properties": { "data": { "$ref": "#/components/schemas/WorkersTaxFormsTaxFormIdPutRequestBodyContentApplicationJsonSchemaData" } }, "required": [ "data" ], "type": "object" } } } }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Workers_replaceATaxFormForAWorker-v2026-01-01_Response_200" } } }, "description": "Tax form replaced successfully." }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ReplaceATaxFormForAWorker-v2026-01-01RequestBadRequestError" } } }, "description": "Validation failed — for example a request body field is missing or malformed, client_legal_entity_id was supplied (the legal entity cannot be reassigned), contractor_signature was omitted for a form that has no signature on record, or the form_type does not match the contractor's tax residency (e.g. a W-8BEN submitted for a US contractor)." }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContainer" } } }, "description": "Operation failed." }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ReplaceATaxFormForAWorker-v2026-01-01RequestForbiddenError" } } }, "description": "No live contract exists between the contractor and the tax form's client legal entity. A tax form can only be edited while the contractor has a non-terminated contract with that legal entity." }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ReplaceATaxFormForAWorker-v2026-01-01RequestNotFoundError" } } }, "description": "The tax form does not exist or does not belong to the authenticated worker, or the worker was not found in the calling organization or has no contractor profile." }, "409": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ReplaceATaxFormForAWorker-v2026-01-01RequestConflictError" } } }, "description": "The tax form was replaced by another request while this one was in flight. Fetch the current version and retry the edit." }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ReplaceATaxFormForAWorker-v2026-01-01RequestInternalServerError" } } }, "description": "Internal server error." } }, "security": [ { "deelToken": [] } ], "summary": "Update a tax form for the authenticated worker", "tags": [ "workers" ] } }, "/workers/{worker_id}/session": { "delete": { "description": "Immediately revokes the active access token for the worker identified by worker_id, terminating all API access granted by that token.\n\n **Token scopes**: `admin:worker`", "operationId": "workerSession_deleteWorkerAccessToken-v2026-01-01", "parameters": [ { "description": "The ID of the worker whose access token you want to delete.", "in": "path", "name": "worker_id", "required": true, "schema": { "type": "string" } } ], "responses": { "204": { "content": { "application/json": { "schema": { "properties": {}, "type": "object" } } }, "description": "Successful operation." }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContainer" } } }, "description": "Operation failed." }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContainer" } } }, "description": "Operation failed." }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContainer" } } }, "description": "Operation failed." }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContainer" } } }, "description": "Operation failed." }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContainer" } } }, "description": "Operation failed." } }, "security": [ { "deelToken": [] } ], "summary": "Delete worker access token", "tags": [ "workerSession" ] } }, "/working-locations": { "get": { "description": "Returns the list of available work location labels for the organization. Populate options when creating or editing people or contract records.\n\n **Token scopes**: `organizations:read`", "operationId": "organizations_retrieveWorkingLocations-v2026-01-01", "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Organizations_retrieveWorkingLocations-v2026-01-01_Response_200" } } }, "description": "Successful operation." }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContainer" } } }, "description": "Operation failed." }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContainer" } } }, "description": "Operation failed." }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContainer" } } }, "description": "Operation failed." }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContainer" } } }, "description": "Operation failed." }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContainer" } } }, "description": "Operation failed." } }, "security": [ { "deelToken": [] } ], "summary": "Retrieve working locations", "tags": [ "organizations" ] } } }, "servers": [ { "description": "Production", "url": "https://api.letsdeel.com/rest" }, { "description": "Demo", "url": "https://api-staging.letsdeel.com/rest" }, { "description": "Production", "url": "https://api.letsdeel.com/scim/v2" }, { "description": "Demo", "url": "https://api-staging.letsdeel.com/scim/v2" } ], "tags": [ { "name": "accounting" }, { "description": "API endpoints related to Adjustments.", "name": "Adjustments" }, { "description": "API endpoints related to ATS.", "name": "ats" }, { "name": "atsApplicationSources" }, { "name": "atsApplications" }, { "name": "atsAttachments" }, { "name": "atsCandidates" }, { "name": "atsDepartments" }, { "name": "atsEmailTemplates" }, { "name": "atsEmploymentTypes" }, { "name": "atsHiringMembers" }, { "name": "atsJobPostings" }, { "name": "atsJobs" }, { "name": "atsLocations" }, { "name": "atsOffers" }, { "name": "atsReasons" }, { "name": "atsTags" }, { "description": "API endpoints related to Candidates.", "name": "candidates" }, { "description": "API endpoints related to Clearance requests.", "name": "clearanceRequests" }, { "description": "API endpoints related to Consent.", "name": "consent" }, { "name": "contractorAmendments" }, { "name": "contractorHiring" }, { "name": "contracts" }, { "name": "costCalculator" }, { "description": "API endpoints related to Cost Centers.", "name": "costCenters" }, { "name": "customFieldsContracts" }, { "name": "customFieldsPeople" }, { "name": "deelAsAService" }, { "description": "API endpoints related to Documents.", "name": "documents" }, { "description": "API endpoints related to Employee Information.", "name": "employeeInformation" }, { "name": "eor" }, { "name": "eorAmendments" }, { "name": "eorBenefits" }, { "name": "eorContract" }, { "name": "eorContractDocuments" }, { "name": "eorHiring" }, { "name": "eorJobScopes" }, { "name": "eorOffboarding" }, { "name": "eorPayslips" }, { "name": "eorProjectAssignment" }, { "name": "eorTerminations" }, { "name": "eorWorkerAccounts" }, { "name": "eorWorkerAgreements" }, { "name": "eorWorkerBanks" }, { "name": "eorWorkerBenefits" }, { "name": "eorWorkerCompliance" }, { "name": "eorWorkerDocuments" }, { "name": "eorWorkerInformation" }, { "name": "eorWorkerMailboxes" }, { "name": "eorWorkerOffboarding" }, { "name": "eorWorkerPayslips" }, { "description": "API endpoints related to Equity Tokens.", "name": "equityTokens" }, { "description": "API endpoints related to Files.", "name": "files" }, { "description": "API endpoints related to Forms.", "name": "forms" }, { "name": "globalPayroll" }, { "name": "gpHiring" }, { "description": "API endpoints related to Groups.", "name": "Groups" }, { "description": "API endpoints related to HRX Documents.", "name": "hrxDocuments" }, { "description": "API endpoints related to IC invoicing taxes.", "name": "icInvoicingTaxes" }, { "name": "immigration" }, { "description": "API endpoints related to Integrations.", "name": "integrations" }, { "name": "invoiceAdjustments" }, { "description": "API endpoints related to IT agreements.", "name": "itAgreements" }, { "name": "itAssets" }, { "description": "API endpoints related to IT orders.", "name": "itOrders" }, { "description": "API endpoints related to IT policies.", "name": "itPolicies" }, { "description": "API endpoints related to IT products.", "name": "itProducts" }, { "description": "API endpoints related to IT seats.", "name": "itSeats" }, { "description": "API endpoints related to IT warehouses.", "name": "itWarehouses" }, { "description": "API endpoints related to Knowledge Hub.", "name": "knowledgeHub" }, { "description": "API endpoints related to Learning.", "name": "learning" }, { "name": "legalEntities" }, { "description": "API endpoints related to List Cycles.", "name": "listCycles" }, { "name": "Lookups" }, { "name": "magicLink" }, { "description": "API endpoints related to Managers.", "name": "managers" }, { "description": "API endpoints related to Milestones.", "name": "Milestones" }, { "name": "offCycle" }, { "description": "API endpoints related to Off-cycle Payments.", "name": "offCyclePayments" }, { "name": "offboarding" }, { "description": "API endpoints related to On-Demand Payroll.", "name": "onDemandPayroll" }, { "description": "API endpoints related to Onboarding.", "name": "onboarding" }, { "description": "API endpoints related to Organization structure.", "name": "organizationStructure" }, { "description": "API endpoints related to Organization Tasks.", "name": "organizationTasks" }, { "name": "organizations" }, { "description": "API endpoints related to Payments.", "name": "payments" }, { "name": "payouts" }, { "name": "payslips" }, { "description": "API endpoints related to People.", "name": "People" }, { "name": "personalInformation" }, { "description": "API endpoints related to Positions.", "name": "Positions" }, { "name": "projects" }, { "description": "API endpoints related to Refund Statements.", "name": "refundStatements" }, { "description": "API endpoints related to Reports.", "name": "reports" }, { "description": "API endpoints related to Screenings.", "name": "Screenings" }, { "description": "API endpoints related to Talent.", "name": "talent" }, { "description": "API endpoints related to Tasks.", "name": "Tasks" }, { "description": "API endpoints related to Terminations.", "name": "Terminations" }, { "description": "API endpoints related to Time Off.", "name": "timeOff" }, { "name": "timeTracking" }, { "description": "API endpoints related to Time Tracking Shifts.", "name": "timeTrackingShifts" }, { "description": "API endpoints related to Timesheets.", "name": "timesheets" }, { "description": "API endpoints related to Treasury.", "name": "treasury" }, { "name": "users" }, { "name": "Webhooks" }, { "description": "API endpoints related to Worker HR.", "name": "workerHr" }, { "name": "workerInformation" }, { "description": "API endpoints related to Worker Relations.", "name": "workerRelations" }, { "description": "API endpoints related to Worker Session.", "name": "workerSession" }, { "name": "workers" } ], "webhooks": { "atsApplications_webhookAtsApplicationCreated": { "post": { "description": "Triggered when a candidate application is created in Deel ATS. The payload includes the application, candidate, and job context, including the initial interview stage and source.", "operationId": "atsApplications_webhookAtsApplicationCreated", "requestBody": { "content": { "application/json": { "schema": { "properties": { "data": { "$ref": "#/components/schemas/WebhooksEventsAtsApplicationCreatedPostPayloadContentApplicationJsonSchemaData" }, "timestamp": { "type": "string" } }, "type": "object" } } } }, "responses": { "200": { "description": "Webhook received successfully" } }, "summary": "Event: ATS Application Created" } }, "atsApplications_webhookAtsApplicationTransitioned": { "post": { "description": "Triggered when a candidate application moves between interview stages. The payload includes the previous and current stage.", "operationId": "atsApplications_webhookAtsApplicationTransitioned", "requestBody": { "content": { "application/json": { "schema": { "properties": { "data": { "$ref": "#/components/schemas/WebhooksEventsAtsApplicationTransitionedPostPayloadContentApplicationJsonSchemaData" }, "timestamp": { "type": "string" } }, "type": "object" } } } }, "responses": { "200": { "description": "Webhook received successfully" } }, "summary": "Event: ATS Application Transitioned" } }, "atsJobPostings_webhookAtsJobPostingCreated": { "post": { "description": "Triggered when a job posting is created in Deel ATS, ahead of any job-board publication. The payload includes the posting `id`, `job_id`, title, and `status`.", "operationId": "atsJobPostings_webhookAtsJobPostingCreated", "requestBody": { "content": { "application/json": { "schema": { "properties": { "data": { "$ref": "#/components/schemas/WebhooksEventsAtsJobPostingCreatedPostPayloadContentApplicationJsonSchemaData" }, "timestamp": { "type": "string" } }, "type": "object" } } } }, "responses": { "200": { "description": "Webhook received successfully" } }, "summary": "Event: ATS Job Posting Created" } }, "atsJobPostings_webhookAtsJobPostingPublicationCreated": { "post": { "description": "Triggered when a job posting begins publication to a specific job board.", "operationId": "atsJobPostings_webhookAtsJobPostingPublicationCreated", "requestBody": { "content": { "application/json": { "schema": { "properties": { "data": { "$ref": "#/components/schemas/WebhooksEventsAtsJobPostingPublicationCreatedPostPayloadContentApplicationJsonSchemaData" }, "timestamp": { "type": "string" } }, "type": "object" } } } }, "responses": { "200": { "description": "Webhook received successfully" } }, "summary": "Event: ATS Job Posting Publication Created" } }, "atsJobPostings_webhookAtsJobPostingPublicationUpdated": { "post": { "description": "Triggered when a job-board publication is updated. The payload includes the publication's current `state_slug`, along with the external reference and URL once the board has processed it.", "operationId": "atsJobPostings_webhookAtsJobPostingPublicationUpdated", "requestBody": { "content": { "application/json": { "schema": { "properties": { "data": { "$ref": "#/components/schemas/WebhooksEventsAtsJobPostingPublicationUpdatedPostPayloadContentApplicationJsonSchemaData" }, "timestamp": { "type": "string" } }, "type": "object" } } } }, "responses": { "200": { "description": "Webhook received successfully" } }, "summary": "Event: ATS Job Posting Publication Updated" } }, "atsJobPostings_webhookAtsJobPostingUpdated": { "post": { "description": "Triggered when a job posting is updated. The payload reflects the posting's current state.", "operationId": "atsJobPostings_webhookAtsJobPostingUpdated", "requestBody": { "content": { "application/json": { "schema": { "properties": { "data": { "$ref": "#/components/schemas/WebhooksEventsAtsJobPostingUpdatedPostPayloadContentApplicationJsonSchemaData" }, "timestamp": { "type": "string" } }, "type": "object" } } } }, "responses": { "200": { "description": "Webhook received successfully" } }, "summary": "Event: ATS Job Posting Updated" } }, "contracts_webhookContractAmended": { "post": { "description": "Triggered when a contract amendment is applied. The payload describes the contract and its updated state, covering changes such as compensation, seniority, reporting line, or scope of work.", "operationId": "contracts_webhookContractAmended", "requestBody": { "content": { "application/json": { "schema": { "properties": { "data": { "$ref": "#/components/schemas/WebhooksEventsContractAmendedPostPayloadContentApplicationJsonSchemaData" }, "timestamp": { "type": "string" } }, "type": "object" } } } }, "responses": { "200": { "description": "Webhook received successfully" } }, "summary": "Event: Contract Amended" } }, "contracts_webhookContractCreated": { "post": { "description": "Triggered when a contractor or EOR contract is created.", "operationId": "contracts_webhookContractCreated", "requestBody": { "content": { "application/json": { "schema": { "properties": { "data": { "$ref": "#/components/schemas/WebhooksEventsContractCreatedPostPayloadContentApplicationJsonSchemaData" }, "timestamp": { "type": "string" } }, "type": "object" } } } }, "responses": { "200": { "description": "Webhook received successfully" } }, "summary": "Event: Contract Created" } }, "contracts_webhookContractDuplicated": { "post": { "description": "Triggered when a contract is duplicated. The payload describes the new contract and contract `id`.", "operationId": "contracts_webhookContractDuplicated", "requestBody": { "content": { "application/json": { "schema": { "properties": { "data": { "$ref": "#/components/schemas/WebhooksEventsContractDuplicatedPostPayloadContentApplicationJsonSchemaData" }, "timestamp": { "type": "string" } }, "type": "object" } } } }, "responses": { "200": { "description": "Webhook received successfully" } }, "summary": "Event: Contract Duplicated" } }, "contracts_webhookContractSignTeamMemberInvited": { "post": { "description": "Triggered when a team member is invited into a contract-signing flow. The payload includes the `contract_oid`, `contract_name`, `invitee_id`, and `invitee_name`.", "operationId": "contracts_webhookContractSignTeamMemberInvited", "requestBody": { "content": { "application/json": { "schema": { "properties": { "data": { "$ref": "#/components/schemas/WebhooksEventsContractSignTeamMemberInvitedPostPayloadContentApplicationJsonSchemaData" }, "timestamp": { "type": "string" } }, "type": "object" } } } }, "responses": { "200": { "description": "Webhook received successfully" } }, "summary": "Event: Contract Sign Team Member Invited" } }, "contracts_webhookContractStatusUpdated": { "post": { "description": "Triggered whenever a contract's status changes. The payload includes the contract's new `status`.", "operationId": "contracts_webhookContractStatusUpdated", "requestBody": { "content": { "application/json": { "schema": { "properties": { "data": { "$ref": "#/components/schemas/WebhooksEventsContractStatusUpdatedPostPayloadContentApplicationJsonSchemaData" }, "timestamp": { "type": "string" } }, "type": "object" } } } }, "responses": { "200": { "description": "Webhook received successfully" } }, "summary": "Event: Contract Status Updated" } }, "eorAmendments_webhookEorAmendmentStatusUpdated": { "post": { "description": "Triggered when an EOR amendment's status changes. The payload includes the amendment flow `id`, contract `id`, and the amendment's new `status`.", "operationId": "eorAmendments_webhookEorAmendmentStatusUpdated", "requestBody": { "content": { "application/json": { "schema": { "properties": { "data": { "$ref": "#/components/schemas/WebhooksEventsEorAmendmentStatusUpdatedPostPayloadContentApplicationJsonSchemaData" }, "timestamp": { "type": "string" } }, "type": "object" } } } }, "responses": { "200": { "description": "Webhook received successfully" } }, "summary": "Event: EOR Amendment Status Updated" } }, "eorPayslips_webhookEorPayslipsAvailable": { "post": { "description": "Triggered when one or more EOR payslips become available. Each payslip includes the worker `id`, pay period, and `status`.", "operationId": "eorPayslips_webhookEorPayslipsAvailable", "requestBody": { "content": { "application/json": { "schema": { "properties": { "data": { "$ref": "#/components/schemas/WebhooksEventsEorPayslipsAvailablePostPayloadContentApplicationJsonSchemaData" }, "timestamp": { "type": "string" } }, "type": "object" } } } }, "responses": { "200": { "description": "Webhook received successfully" } }, "summary": "Event: EOR Payslips Available" } }, "eor_webhookEorProjectAssignmentCheckinCreated": { "post": { "description": "Triggered when a recurring check-in for an EOR project assignment is created and becomes available to complete. The payload includes the contract `id`, check-in `type`, and `project_assignment_checkin_version`.", "operationId": "eor_webhookEorProjectAssignmentCheckinCreated", "requestBody": { "content": { "application/json": { "schema": { "properties": { "data": { "$ref": "#/components/schemas/WebhooksEventsEorProjectAssignmentCheckinCreatedPostPayloadContentApplicationJsonSchemaData" }, "timestamp": { "type": "string" } }, "type": "object" } } } }, "responses": { "200": { "description": "Webhook received successfully" } }, "summary": "Event: EOR Project Assignment Checkin Created" } }, "eor_webhookEorProjectAssignmentCreated": { "post": { "description": "Triggered when a project assignment for an EOR contract is created and ready for the client to review. The payload includes the contract context and `project_assignment_version`.", "operationId": "eor_webhookEorProjectAssignmentCreated", "requestBody": { "content": { "application/json": { "schema": { "properties": { "data": { "$ref": "#/components/schemas/WebhooksEventsEorProjectAssignmentCreatedPostPayloadContentApplicationJsonSchemaData" }, "timestamp": { "type": "string" } }, "type": "object" } } } }, "responses": { "200": { "description": "Webhook received successfully" } }, "summary": "Event: EOR Project Assignment Created" } }, "eor_webhookEorQuoteCreated": { "post": { "description": "Triggered when an EOR quote is created. The payload includes the quote's cost details: salary, employer costs, and currency, tied to the contract.", "operationId": "eor_webhookEorQuoteCreated", "requestBody": { "content": { "application/json": { "schema": { "properties": { "data": { "$ref": "#/components/schemas/WebhooksEventsEorQuoteCreatedPostPayloadContentApplicationJsonSchemaData" }, "timestamp": { "type": "string" } }, "type": "object" } } } }, "responses": { "200": { "description": "Webhook received successfully" } }, "summary": "Event: EOR Quote Created" } }, "globalPayroll_webhookGpPayslipsAvailable": { "post": { "description": "Triggered when one or more Global Payroll payslips become available. Each payslip includes the worker `id`, pay period, and `status`.", "operationId": "globalPayroll_webhookGpPayslipsAvailable", "requestBody": { "content": { "application/json": { "schema": { "properties": { "data": { "$ref": "#/components/schemas/WebhooksEventsGpPayslipsAvailablePostPayloadContentApplicationJsonSchemaData" }, "timestamp": { "type": "string" } }, "type": "object" } } } }, "responses": { "200": { "description": "Webhook received successfully" } }, "summary": "Event: GP Payslips Available" } }, "globalPayroll_webhookGpTerminationConfirmed": { "post": { "description": "Triggered when a Global Payroll termination is confirmed. The payload includes the worker and contract context.", "operationId": "globalPayroll_webhookGpTerminationConfirmed", "requestBody": { "content": { "application/json": { "schema": { "properties": { "data": { "$ref": "#/components/schemas/WebhooksEventsGpTerminationConfirmedPostPayloadContentApplicationJsonSchemaData" }, "timestamp": { "type": "string" } }, "type": "object" } } } }, "responses": { "200": { "description": "Webhook received successfully" } }, "summary": "Event: GP Termination Confirmed" } }, "hris_webhookEmployeeCreatedContractor": { "post": { "description": "Triggered when a contractor's contract has been signed and the worker record has been created. The payload includes the worker's name, email, country, and contract `id`.", "operationId": "hris_webhookEmployeeCreatedContractor", "requestBody": { "content": { "application/json": { "schema": { "properties": { "data": { "$ref": "#/components/schemas/WebhooksEventsEmployeeCreatedContractorPostPayloadContentApplicationJsonSchemaData" }, "timestamp": { "type": "string" } }, "type": "object" } } } }, "responses": { "200": { "description": "Webhook received successfully" } }, "summary": "Event: Employee Created Contractor" } }, "hris_webhookEmployeeCreatedDirect": { "post": { "description": "Triggered when a direct employee record is created. The payload identifies the employee by HRIS profile `id`.", "operationId": "hris_webhookEmployeeCreatedDirect", "requestBody": { "content": { "application/json": { "schema": { "properties": { "data": { "$ref": "#/components/schemas/WebhooksEventsEmployeeCreatedDirectPostPayloadContentApplicationJsonSchemaData" }, "timestamp": { "type": "string" } }, "type": "object" } } } }, "responses": { "200": { "description": "Webhook received successfully" } }, "summary": "Event: Employee Created Direct" } }, "hris_webhookEmployeeCreatedEor": { "post": { "description": "Triggered when an EOR employee record is created. Onboarding progress is reported as `onboarding.status.updated` events.", "operationId": "hris_webhookEmployeeCreatedEor", "requestBody": { "content": { "application/json": { "schema": { "properties": { "data": { "$ref": "#/components/schemas/WebhooksEventsEmployeeCreatedEorPostPayloadContentApplicationJsonSchemaData" }, "timestamp": { "type": "string" } }, "type": "object" } } } }, "responses": { "200": { "description": "Webhook received successfully" } }, "summary": "Event: Employee Created EOR" } }, "hris_webhookEmployeeUpdatedDirect": { "post": { "description": "Triggered when direct employee information is updated. The payload reflects the employee's current state, covering whichever personal, job, or employment details changed.", "operationId": "hris_webhookEmployeeUpdatedDirect", "requestBody": { "content": { "application/json": { "schema": { "properties": { "data": { "$ref": "#/components/schemas/WebhooksEventsEmployeeUpdatedDirectPostPayloadContentApplicationJsonSchemaData" }, "timestamp": { "type": "string" } }, "type": "object" } } } }, "responses": { "200": { "description": "Webhook received successfully" } }, "summary": "Event: Employee Updated Direct" } }, "hris_webhookWorkerCreated": { "post": { "description": "Triggered when a worker record is created through SCIM provisioning. The payload follows SCIM conventions, including `schemas`, SCIM extension URNs, `user_name`, and `user_type`.", "operationId": "hris_webhookWorkerCreated", "requestBody": { "content": { "application/json": { "schema": { "properties": { "data": { "$ref": "#/components/schemas/WebhooksEventsWorkerCreatedPostPayloadContentApplicationJsonSchemaData" }, "timestamp": { "type": "string" } }, "type": "object" } } } }, "responses": { "200": { "description": "Webhook received successfully" } }, "summary": "Event: Worker Created (SCIM)" } }, "hris_webhookWorkerV2Created": { "post": { "description": "Triggered when a worker profile is created. The payload includes the profile `id`.", "operationId": "hris_webhookWorkerV2Created", "requestBody": { "content": { "application/json": { "schema": { "properties": { "data": { "$ref": "#/components/schemas/WebhooksEventsWorkerV2CreatedPostPayloadContentApplicationJsonSchemaData" }, "timestamp": { "type": "string" } }, "type": "object" } } } }, "responses": { "200": { "description": "Webhook received successfully" } }, "summary": "Event: Worker V2 Created" } }, "hris_webhookWorkerV2Deleted": { "post": { "description": "Triggered when a worker profile is deleted. The payload includes the profile `id`.", "operationId": "hris_webhookWorkerV2Deleted", "requestBody": { "content": { "application/json": { "schema": { "properties": { "data": { "$ref": "#/components/schemas/WebhooksEventsWorkerV2DeletedPostPayloadContentApplicationJsonSchemaData" }, "timestamp": { "type": "string" } }, "type": "object" } } } }, "responses": { "200": { "description": "Webhook received successfully" } }, "summary": "Event: Worker V2 Deleted" } }, "hris_webhookWorkerV2Updated": { "post": { "description": "Triggered when a worker profile's data changes, covering profile, contract, compensation, address, phone, custom fields, or position. The payload includes the profile `id`.", "operationId": "hris_webhookWorkerV2Updated", "requestBody": { "content": { "application/json": { "schema": { "properties": { "data": { "$ref": "#/components/schemas/WebhooksEventsWorkerV2UpdatedPostPayloadContentApplicationJsonSchemaData" }, "timestamp": { "type": "string" } }, "type": "object" } } } }, "responses": { "200": { "description": "Webhook received successfully" } }, "summary": "Event: Worker V2 Updated" } }, "immigration_webhookImmigrationCaseProcessStatusUpdate": { "post": { "description": "Triggered when an immigration case process's status changes. The payload includes the case, its process, and the process's new `status`.", "operationId": "immigration_webhookImmigrationCaseProcessStatusUpdate", "requestBody": { "content": { "application/json": { "schema": { "properties": { "data": { "$ref": "#/components/schemas/WebhooksEventsImmigrationCaseProcessStatusUpdatePostPayloadContentApplicationJsonSchemaData" }, "timestamp": { "type": "string" } }, "type": "object" } } } }, "responses": { "200": { "description": "Webhook received successfully" } }, "summary": "Event: Immigration Case Process Status Update" } }, "immigration_webhookImmigrationCaseRenewalCreated": { "post": { "description": "Triggered when an expiring immigration document causes a renewal case to be created automatically. The payload includes the applicant, the contract, and the `expiring_document`.", "operationId": "immigration_webhookImmigrationCaseRenewalCreated", "requestBody": { "content": { "application/json": { "schema": { "properties": { "data": { "$ref": "#/components/schemas/WebhooksEventsImmigrationCaseRenewalCreatedPostPayloadContentApplicationJsonSchemaData" }, "timestamp": { "type": "string" } }, "type": "object" } } } }, "responses": { "200": { "description": "Webhook received successfully" } }, "summary": "Event: Immigration Case Renewal Created" } }, "invoiceAdjustments_webhookInvoiceAdjustmentCreated": { "post": { "description": "Triggered when an invoice adjustment is created, covering categories such as bonus, commission, deduction, expense, overtime, time off, and VAT. The payload includes the adjustment and its `status`.", "operationId": "invoiceAdjustments_webhookInvoiceAdjustmentCreated", "requestBody": { "content": { "application/json": { "schema": { "properties": { "data": { "$ref": "#/components/schemas/WebhooksEventsInvoiceAdjustmentCreatedPostPayloadContentApplicationJsonSchemaData" }, "timestamp": { "type": "string" } }, "type": "object" } } } }, "responses": { "200": { "description": "Webhook received successfully" } }, "summary": "Event: Invoice Adjustment Created" } }, "invoiceAdjustments_webhookInvoiceAdjustmentPendingForApproval": { "post": { "description": "Triggered when an invoice adjustment requires approval. The payload includes the adjustment and its list of `approvers`.", "operationId": "invoiceAdjustments_webhookInvoiceAdjustmentPendingForApproval", "requestBody": { "content": { "application/json": { "schema": { "properties": { "data": { "$ref": "#/components/schemas/WebhooksEventsInvoiceAdjustmentPendingForApprovalPostPayloadContentApplicationJsonSchemaData" }, "timestamp": { "type": "string" } }, "type": "object" } } } }, "responses": { "200": { "description": "Webhook received successfully" } }, "summary": "Event: Invoice Adjustment Pending For Approval" } }, "invoiceAdjustments_webhookInvoiceAdjustmentReviewed": { "post": { "description": "Triggered when an invoice adjustment is reviewed. The payload includes the review outcome in its `status`, either approved or denied.", "operationId": "invoiceAdjustments_webhookInvoiceAdjustmentReviewed", "requestBody": { "content": { "application/json": { "schema": { "properties": { "data": { "$ref": "#/components/schemas/WebhooksEventsInvoiceAdjustmentReviewedPostPayloadContentApplicationJsonSchemaData" }, "timestamp": { "type": "string" } }, "type": "object" } } } }, "responses": { "200": { "description": "Webhook received successfully" } }, "summary": "Event: Invoice Adjustment Reviewed" } }, "itAssets_webhookItAssetArchived": { "post": { "description": "Triggered when an IT asset is archived, removing it from active assignment.", "operationId": "itAssets_webhookItAssetArchived", "requestBody": { "content": { "application/json": { "schema": { "properties": { "data": { "$ref": "#/components/schemas/WebhooksEventsItAssetArchivedPostPayloadContentApplicationJsonSchemaData" }, "timestamp": { "type": "string" } }, "type": "object" } } } }, "responses": { "200": { "description": "Webhook received successfully" } }, "summary": "Event: IT Asset Archived" } }, "itAssets_webhookItAssetCreated": { "post": { "description": "Triggered when an IT asset is created. The payload includes the asset details, including purchase date and value where supplied.", "operationId": "itAssets_webhookItAssetCreated", "requestBody": { "content": { "application/json": { "schema": { "properties": { "data": { "$ref": "#/components/schemas/WebhooksEventsItAssetCreatedPostPayloadContentApplicationJsonSchemaData" }, "timestamp": { "type": "string" } }, "type": "object" } } } }, "responses": { "200": { "description": "Webhook received successfully" } }, "summary": "Event: IT Asset Created" } }, "itAssets_webhookItAssetLocationUpdated": { "post": { "description": "Triggered when an IT asset's location changes. The payload includes the previous and new location in `from` and `to`.", "operationId": "itAssets_webhookItAssetLocationUpdated", "requestBody": { "content": { "application/json": { "schema": { "properties": { "data": { "$ref": "#/components/schemas/WebhooksEventsItAssetLocationUpdatedPostPayloadContentApplicationJsonSchemaData" }, "timestamp": { "type": "string" } }, "type": "object" } } } }, "responses": { "200": { "description": "Webhook received successfully" } }, "summary": "Event: IT Asset Location Updated" } }, "itOrders_webhookItOrderCreated": { "post": { "description": "Triggered when an IT order is created. The payload includes the order `id` and `status`.", "operationId": "itOrders_webhookItOrderCreated", "requestBody": { "content": { "application/json": { "schema": { "properties": { "data": { "$ref": "#/components/schemas/WebhooksEventsItOrderCreatedPostPayloadContentApplicationJsonSchemaData" }, "timestamp": { "type": "string" } }, "type": "object" } } } }, "responses": { "200": { "description": "Webhook received successfully" } }, "summary": "Event: IT Order Created" } }, "itOrders_webhookItOrderUpdated": { "post": { "description": "Triggered when an IT order is updated. The payload reflects the order's current state.", "operationId": "itOrders_webhookItOrderUpdated", "requestBody": { "content": { "application/json": { "schema": { "properties": { "data": { "$ref": "#/components/schemas/WebhooksEventsItOrderUpdatedPostPayloadContentApplicationJsonSchemaData" }, "timestamp": { "type": "string" } }, "type": "object" } } } }, "responses": { "200": { "description": "Webhook received successfully" } }, "summary": "Event: IT Order Updated" } }, "learning_webhookEngageLearningJourneysAssignmentsCreated": { "post": { "description": "Triggered when a learning-journey assignment is created. The payload includes the assignment details, including `due_at` where one is set.", "operationId": "learning_webhookEngageLearningJourneysAssignmentsCreated", "requestBody": { "content": { "application/json": { "schema": { "properties": { "data": { "$ref": "#/components/schemas/WebhooksEventsEngageLearningJourneysAssignmentsCreatedPostPayloadContentApplicationJsonSchemaData" }, "timestamp": { "type": "string" } }, "type": "object" } } } }, "responses": { "200": { "description": "Webhook received successfully" } }, "summary": "Event: Engage Learning Journeys Assignments Created" } }, "learning_webhookEngageLearningJourneysAssignmentsReminded": { "post": { "description": "Triggered when a reminder is sent for a learning-journey assignment. The payload includes the assignment details.", "operationId": "learning_webhookEngageLearningJourneysAssignmentsReminded", "requestBody": { "content": { "application/json": { "schema": { "properties": { "data": { "$ref": "#/components/schemas/WebhooksEventsEngageLearningJourneysAssignmentsRemindedPostPayloadContentApplicationJsonSchemaData" }, "timestamp": { "type": "string" } }, "type": "object" } } } }, "responses": { "200": { "description": "Webhook received successfully" } }, "summary": "Event: Engage Learning Journeys Assignments Reminded" } }, "oauth_webhookOauth2TokenRevoked": { "post": { "description": "Triggered when an OAuth 2.0 token is revoked. The payload includes the `client_id`, scope, and token `status`.", "operationId": "oauth_webhookOauth2TokenRevoked", "requestBody": { "content": { "application/json": { "schema": { "properties": { "data": { "$ref": "#/components/schemas/WebhooksEventsOauth2TokenRevokedPostPayloadContentApplicationJsonSchemaData" }, "timestamp": { "type": "string" } }, "type": "object" } } } }, "responses": { "200": { "description": "Webhook received successfully" } }, "summary": "Event: Oauth2 Token Revoked" } }, "onboarding_webhookOnboardingChecklistUpdated": { "post": { "description": "Triggered when an individual onboarding checklist step changes status. The payload includes the `step_id`, `old_status`, and new `status`; a single onboarding process produces one event per step.", "operationId": "onboarding_webhookOnboardingChecklistUpdated", "requestBody": { "content": { "application/json": { "schema": { "properties": { "data": { "$ref": "#/components/schemas/WebhooksEventsOnboardingChecklistUpdatedPostPayloadContentApplicationJsonSchemaData" }, "timestamp": { "type": "string" } }, "type": "object" } } } }, "responses": { "200": { "description": "Webhook received successfully" } }, "summary": "Event: Onboarding Checklist Updated" } }, "onboarding_webhookOnboardingStatusUpdated": { "post": { "description": "Triggered when a worker's overall onboarding status changes, for example moving from invited, to onboarding, to complete. The payload includes the `old_status` and new `status`, along with the `hiring_type`.", "operationId": "onboarding_webhookOnboardingStatusUpdated", "requestBody": { "content": { "application/json": { "schema": { "properties": { "data": { "$ref": "#/components/schemas/WebhooksEventsOnboardingStatusUpdatedPostPayloadContentApplicationJsonSchemaData" }, "timestamp": { "type": "string" } }, "type": "object" } } } }, "responses": { "200": { "description": "Webhook received successfully" } }, "summary": "Event: Onboarding Status Updated" } }, "payments_webhookPaymentStatementInitiated": { "post": { "description": "Triggered when a payment statement is initiated. The payload includes the associated invoices.", "operationId": "payments_webhookPaymentStatementInitiated", "requestBody": { "content": { "application/json": { "schema": { "properties": { "data": { "$ref": "#/components/schemas/WebhooksEventsPaymentStatementInitiatedPostPayloadContentApplicationJsonSchemaData" }, "timestamp": { "type": "string" } }, "type": "object" } } } }, "responses": { "200": { "description": "Webhook received successfully" } }, "summary": "Event: Payment Statement Initiated" } }, "payments_webhookPaymentStatementMarkPaid": { "post": { "description": "Triggered when a payment statement is marked as paid. The payload includes the associated invoices.", "operationId": "payments_webhookPaymentStatementMarkPaid", "requestBody": { "content": { "application/json": { "schema": { "properties": { "data": { "$ref": "#/components/schemas/WebhooksEventsPaymentStatementMarkPaidPostPayloadContentApplicationJsonSchemaData" }, "timestamp": { "type": "string" } }, "type": "object" } } } }, "responses": { "200": { "description": "Webhook received successfully" } }, "summary": "Event: Payment Statement Mark Paid" } }, "payslips_webhookPayslipDocumentDeleted": { "post": { "description": "Triggered when a published payslip document is deleted. The payload includes the document `id` under its associated contract.", "operationId": "payslips_webhookPayslipDocumentDeleted", "requestBody": { "content": { "application/json": { "schema": { "properties": { "data": { "$ref": "#/components/schemas/WebhooksEventsPayslipDocumentDeletedPostPayloadContentApplicationJsonSchemaData" }, "timestamp": { "type": "string" } }, "type": "object" } } } }, "responses": { "200": { "description": "Webhook received successfully" } }, "summary": "Event: Payslip Document Deleted" } }, "profile_webhookProfileKycChanged": { "post": { "description": "Triggered when a profile's KYC status changes. The payload includes the new `kyc_status` and the profile's identity fields.", "operationId": "profile_webhookProfileKycChanged", "requestBody": { "content": { "application/json": { "schema": { "properties": { "data": { "$ref": "#/components/schemas/WebhooksEventsProfileKycChangedPostPayloadContentApplicationJsonSchemaData" }, "timestamp": { "type": "string" } }, "type": "object" } } } }, "responses": { "200": { "description": "Webhook received successfully" } }, "summary": "Event: Profile KYC Changed" } }, "screenings_webhookBgcheckResultAvailable": { "post": { "description": "Triggered when a background-check result becomes available. The payload includes the result under its associated contract `id`.", "operationId": "screenings_webhookBgcheckResultAvailable", "requestBody": { "content": { "application/json": { "schema": { "properties": { "data": { "$ref": "#/components/schemas/WebhooksEventsBgcheckResultAvailablePostPayloadContentApplicationJsonSchemaData" }, "timestamp": { "type": "string" } }, "type": "object" } } } }, "responses": { "200": { "description": "Webhook received successfully" } }, "summary": "Event: Background Check Result Available" } }, "taxDocuments_webhookTaxDocumentAvailable": { "post": { "description": "Triggered when a tax document is published. The payload includes the document along with its country, period, and `type`.", "operationId": "taxDocuments_webhookTaxDocumentAvailable", "requestBody": { "content": { "application/json": { "schema": { "properties": { "data": { "$ref": "#/components/schemas/WebhooksEventsTaxDocumentAvailablePostPayloadContentApplicationJsonSchemaData" }, "timestamp": { "type": "string" } }, "type": "object" } } } }, "responses": { "200": { "description": "Webhook received successfully" } }, "summary": "Event: Tax Document Available" } }, "taxDocuments_webhookTaxDocumentDeleted": { "post": { "description": "Triggered when a published tax document is deleted. The payload includes the document along with its country, period, and `type`.", "operationId": "taxDocuments_webhookTaxDocumentDeleted", "requestBody": { "content": { "application/json": { "schema": { "properties": { "data": { "$ref": "#/components/schemas/WebhooksEventsTaxDocumentDeletedPostPayloadContentApplicationJsonSchemaData" }, "timestamp": { "type": "string" } }, "type": "object" } } } }, "responses": { "200": { "description": "Webhook received successfully" } }, "summary": "Event: Tax Document Deleted" } }, "terminations_webhookContractTerminated": { "post": { "description": "Triggered when a contract termination is completed, for contractor, EOR, and Global Payroll contracts. The payload includes the contract `id` and `completion_date`.", "operationId": "terminations_webhookContractTerminated", "requestBody": { "content": { "application/json": { "schema": { "properties": { "data": { "$ref": "#/components/schemas/WebhooksEventsContractTerminatedPostPayloadContentApplicationJsonSchemaData" }, "timestamp": { "type": "string" } }, "type": "object" } } } }, "responses": { "200": { "description": "Webhook received successfully" } }, "summary": "Event: Contract Terminated" } }, "timeOff_webhookTimeOffCreated": { "post": { "description": "Triggered when a time-off request is created. The payload includes the request under its contract `id`.", "operationId": "timeOff_webhookTimeOffCreated", "requestBody": { "content": { "application/json": { "schema": { "properties": { "data": { "$ref": "#/components/schemas/WebhooksEventsTimeOffCreatedPostPayloadContentApplicationJsonSchemaData" }, "timestamp": { "type": "string" } }, "type": "object" } } } }, "responses": { "200": { "description": "Webhook received successfully" } }, "summary": "Event: Time Off Created" } }, "timeOff_webhookTimeOffDeleted": { "post": { "description": "Triggered when a time-off request is deleted. The payload includes the `time_off_id`.", "operationId": "timeOff_webhookTimeOffDeleted", "requestBody": { "content": { "application/json": { "schema": { "properties": { "data": { "$ref": "#/components/schemas/WebhooksEventsTimeOffDeletedPostPayloadContentApplicationJsonSchemaData" }, "timestamp": { "type": "string" } }, "type": "object" } } } }, "responses": { "200": { "description": "Webhook received successfully" } }, "summary": "Event: Time Off Deleted" } }, "timeOff_webhookTimeOffReviewed": { "post": { "description": "Triggered when a time-off request is reviewed. The payload includes the review outcome in its `status`, either approved or denied.", "operationId": "timeOff_webhookTimeOffReviewed", "requestBody": { "content": { "application/json": { "schema": { "properties": { "data": { "$ref": "#/components/schemas/WebhooksEventsTimeOffReviewedPostPayloadContentApplicationJsonSchemaData" }, "timestamp": { "type": "string" } }, "type": "object" } } } }, "responses": { "200": { "description": "Webhook received successfully" } }, "summary": "Event: Time Off Reviewed" } }, "timeOff_webhookTimeOffUpdated": { "post": { "description": "Triggered when a time-off request is updated. The payload reflects the request's current state, keyed by contract `id`.", "operationId": "timeOff_webhookTimeOffUpdated", "requestBody": { "content": { "application/json": { "schema": { "properties": { "data": { "$ref": "#/components/schemas/WebhooksEventsTimeOffUpdatedPostPayloadContentApplicationJsonSchemaData" }, "timestamp": { "type": "string" } }, "type": "object" } } } }, "responses": { "200": { "description": "Webhook received successfully" } }, "summary": "Event: Time Off Updated" } }, "timesheets_webhookTimesheetCreated": { "post": { "description": "Triggered when a timesheet is created. The payload includes the timesheet `id` and `status`.", "operationId": "timesheets_webhookTimesheetCreated", "requestBody": { "content": { "application/json": { "schema": { "properties": { "data": { "$ref": "#/components/schemas/WebhooksEventsTimesheetCreatedPostPayloadContentApplicationJsonSchemaData" }, "timestamp": { "type": "string" } }, "type": "object" } } } }, "responses": { "200": { "description": "Webhook received successfully" } }, "summary": "Event: Timesheet Created" } }, "timesheets_webhookTimesheetReviewed": { "post": { "description": "Triggered when a timesheet is reviewed. The payload includes the review outcome in its `status`, either approved or denied.", "operationId": "timesheets_webhookTimesheetReviewed", "requestBody": { "content": { "application/json": { "schema": { "properties": { "data": { "$ref": "#/components/schemas/WebhooksEventsTimesheetReviewedPostPayloadContentApplicationJsonSchemaData" }, "timestamp": { "type": "string" } }, "type": "object" } } } }, "responses": { "200": { "description": "Webhook received successfully" } }, "summary": "Event: Timesheet Reviewed" } } } }